import { BaseEntity } from "../interfaces/models/base-entity"; import { Currency } from "./currency"; import { SalesChannel } from "./sales-channel"; export declare class Store extends BaseEntity { name: string; default_currency_code: string; default_currency: Currency; currencies: Currency[]; swap_link_template: string | null; payment_link_template: string | null; invite_link_template: string | null; default_location_id: string; metadata: Record | null; default_sales_channel_id: string | null; default_sales_channel: SalesChannel; private beforeInsert; } /** * @schema Store * title: "Store" * description: "A store holds the main settings of the commerce shop. By default, only one store is created and used within the Medusa backend. It holds settings related to the name of the store, available currencies, and more." * type: object * required: * - created_at * - default_currency_code * - default_location_id * - id * - invite_link_template * - metadata * - name * - payment_link_template * - swap_link_template * - updated_at * properties: * id: * description: The store's ID * type: string * example: store_01G1G5V21KADXNGH29BJMAJ4B4 * name: * description: The name of the Store - this may be displayed to the Customer. * type: string * example: Medusa Store * default_currency_code: * description: The 3 character currency code that is the default of the store. * type: string * example: usd * externalDocs: * url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes * description: See a list of codes. * default_currency: * description: The details of the store's default currency. * x-expandable: "default_currency" * nullable: true * $ref: "#/components/schemas/Currency" * currencies: * description: The details of the enabled currencies in the store. * type: array * x-expandable: "currencies" * items: * $ref: "#/components/schemas/Currency" * swap_link_template: * description: A template to generate Swap links from. Use {{cart_id}} to include the Swap's `cart_id` in the link. * nullable: true * type: string * example: null * payment_link_template: * description: A template to generate Payment links from. Use {{cart_id}} to include the payment's `cart_id` in the link. * nullable: true * type: string * example: null * invite_link_template: * description: A template to generate Invite links from * nullable: true * type: string * example: null * default_location_id: * description: The location ID the store is associated with. * nullable: true * type: string * example: null * default_sales_channel_id: * description: The ID of the store's default sales channel. * nullable: true * type: string * example: null * default_sales_channel: * description: The details of the store's default sales channel. * x-expandable: "default_sales_channel" * nullable: true * $ref: "#/components/schemas/SalesChannel" * created_at: * description: The date with timezone at which the resource was created. * type: string * format: date-time * updated_at: * description: The date with timezone at which the resource was updated. * type: string * format: date-time * metadata: * description: An optional key-value map with additional details * nullable: true * type: object * example: {car: "white"} * externalDocs: * description: "Learn about the metadata attribute, and how to delete and update it." * url: "https://docs.medusajs.com/development/entities/overview#metadata-attribute" */