import { SoftDeletableEntity } from "../interfaces"; import { SalesChannelLocation } from "./sales-channel-location"; export declare class SalesChannel extends SoftDeletableEntity { name: string; description: string | null; is_disabled: boolean; metadata: Record | null; locations: SalesChannelLocation[]; private beforeInsert; } /** * @schema SalesChannel * title: "Sales Channel" * description: "A Sales Channel is a method a business offers its products for purchase for the customers. For example, a Webshop can be a sales channel, and a mobile app can be another." * type: object * required: * - created_at * - deleted_at * - description * - id * - is_disabled * - name * - updated_at * properties: * id: * description: The sales channel's ID * type: string * example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A * name: * description: The name of the sales channel. * type: string * example: Market * description: * description: The description of the sales channel. * nullable: true * type: string * example: Multi-vendor market * is_disabled: * description: Specify if the sales channel is enabled or disabled. * type: boolean * default: false * locations: * description: The details of the stock locations related to the sales channel. * type: array * x-expandable: "locations" * items: * $ref: "#/components/schemas/SalesChannelLocation" * 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 * deleted_at: * description: The date with timezone at which the resource was deleted. * nullable: true * 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" */