@acmekit/types 2.13.2 → 2.13.3

package/dist/sales-channel/service.d.ts

@@ -1,239 +0,0 @@
-import { FindConfig } from "../common";
-import { RestoreReturn, SoftDeleteReturn } from "../dal";
-import { IModuleService } from "../modules-sdk";
-import { Context } from "../shared-context";
-import { FilterableSalesChannelProps, SalesChannelDTO } from "./common";
-import { CreateSalesChannelDTO, UpdateSalesChannelDTO, UpsertSalesChannelDTO } from "./mutations";
-/**
- * The main service interface for the Sales Channel Module.
- */
-export interface ISalesChannelModuleService extends IModuleService {
-    /**
-     * This method creates sales channels.
-     *
-     * @param {CreateSalesChannelDTO[]} data - The sales channels to be created.
-     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<SalesChannelDTO[]>} The created sales channels.
-     *
-     * @example
-     * const salesChannels = await salesChannelModuleService.createSalesChannels([
-     *   {
-     *     name: "B2B",
-     *   },
-     * ])
-     */
-    createSalesChannels(data: CreateSalesChannelDTO[], sharedContext?: Context): Promise<SalesChannelDTO[]>;
-    /**
-     * This method creates a sales channel.
-     *
-     * @param {CreateSalesChannelDTO} data - The sales channel to be created.
-     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<SalesChannelDTO>} The created sales channel.
-     *
-     * @example
-     * const salesChannel = await salesChannelModuleService.createSalesChannels({
-     *   name: "B2B",
-     * })
-     */
-    createSalesChannels(data: CreateSalesChannelDTO, sharedContext?: Context): Promise<SalesChannelDTO>;
-    /**
-     * This method updates an existing sales channel.
-     *
-     * @param {string} channelId - The sales channel's ID.
-     * @param {UpdateSalesChannelDTO} data - The attributes to update in the sales channel.
-     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<SalesChannelDTO>} The updated sales channel.
-     *
-     * @example
-     * const salesChannel = await salesChannelModuleService.updateSalesChannels(
-     *   "sc_123",
-     *   {
-     *     description: "Sales channel for B2B customers",
-     *   }
-     * )
-     */
-    updateSalesChannels(channelId: string, data: UpdateSalesChannelDTO, sharedContext?: Context): Promise<SalesChannelDTO>;
-    /**
-     * This method updates existing sales channels matching the specified filters
-     *
-     * @param {FilterableSalesChannelProps} selector - The filters specifying which sales channels to update.
-     * @param {UpdateSalesChannelDTO} data - The attributes to update in the sales channel.
-     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<SalesChannelDTO[]>} The updated sales channels.
-     *
-     * @example
-     * const salesChannels = await salesChannelModuleService.updateSalesChannels(
-     *   {
-     *     name: "B2B",
-     *   },
-     *   {
-     *     description: "Sales channel for B2B customers",
-     *   }
-     * )
-     */
-    updateSalesChannels(selector: FilterableSalesChannelProps, data: UpdateSalesChannelDTO, sharedContext?: Context): Promise<SalesChannelDTO[]>;
-    /**
-     * This method updates or creates a sales channel if it doesn't exist.
-     *
-     * @param {UpsertSalesChannelDTO} data - The attributes in the sales channel to be created or updated.
-     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<SalesChannelDTO>} The created or updated sales channel.
-     *
-     * @example
-     * const salesChannel = await salesChannelModuleService.upsertSalesChannels({
-     *   name: "B2B",
-     * })
-     */
-    upsertSalesChannels(data: UpsertSalesChannelDTO, sharedContext?: Context): Promise<SalesChannelDTO>;
-    /**
-     * This method updates or creates sales channels if they don't exist.
-     *
-     * @param {UpsertSalesChannelDTO[]} data - The attributes in the sales channels to be created or updated.
-     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<SalesChannelDTO[]>} The created or updated sales channels.
-     *
-     * @example
-     * const salesChannels = await salesChannelModuleService.upsertSalesChannels([
-     *   {
-     *     name: "B2B",
-     *   },
-     *   {
-     *     id: "sc_123",
-     *     description: "Sales channel for B2B customers",
-     *   },
-     * ])
-     */
-    upsertSalesChannels(data: UpsertSalesChannelDTO[], sharedContext?: Context): Promise<SalesChannelDTO[]>;
-    /**
-     * This method deletes sales channel by their IDs.
-     *
-     * @param {string[]} ids - The IDs of the sales channel.
-     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<void>} Resolves when the sales channels are deleted successfully.
-     *
-     * @example
-     * await salesChannelModuleService.deleteSalesChannels(["sc_123", "sc_321"])
-     */
-    deleteSalesChannels(ids: string[], sharedContext?: Context): Promise<void>;
-    /**
-     * This method deletes a sales channel by its ID.
-     *
-     * @param {string} id - The ID of the sales channel.
-     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<void>} Resolves when the sales channel is deleted successfully.
-     *
-     * @example
-     * await salesChannelModuleService.deleteSalesChannels("sc_123")
-     */
-    deleteSalesChannels(id: string, sharedContext?: Context): Promise<void>;
-    /**
-     * This method retrieves a sales channel by its ID.
-     *
-     * @param {string} id - The ID of the sales channel.
-     * @param {FindConfig<SalesChannelDTO>} config - The configurations determining how the sales channel is retrieved. Its properties, such as `select` or `relations`, accept the
-     * attributes or relations associated with a sales channel.
-     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<SalesChannelDTO>} The retrieved sales channel.
-     *
-     * @example
-     * const salesChannel =
-     *   await salesChannelModuleService.retrieveSalesChannel("sc_123")
-     */
-    retrieveSalesChannel(id: string, config?: FindConfig<SalesChannelDTO>, sharedContext?: Context): Promise<SalesChannelDTO>;
-    /**
-     * This method retrieves a paginated list of sales channels based on optional filters and configuration.
-     *
-     * @param {FilterableSalesChannelProps} filters - The filters to apply on the retrieved sales channels.
-     * @param {FindConfig<SalesChannelDTO>} config - The configurations determining how the sales channel is retrieved. Its properties, such as `select` or `relations`, accept the
-     * attributes or relations associated with a sales channel.
-     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<SalesChannelDTO[]>} The list of sales channels.
-     *
-     * @example
-     * To retrieve a list of sales channels using their IDs:
-     *
-     * ```ts
-     * const salesChannels = await salesChannelModuleService.listSalesChannels({
-     *   id: ["sc_123", "sc_321"],
-     * })
-     * ```
-     *
-     * 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
-     * const salesChannels = await salesChannelModuleService.listSalesChannels(
-     *   {
-     *     id: ["sc_123", "sc_321"],
-     *   },
-     *   {
-     *     take: 20,
-     *     skip: 2,
-     *   }
-     * )
-     * ```
-     */
-    listSalesChannels(filters?: FilterableSalesChannelProps, config?: FindConfig<SalesChannelDTO>, sharedContext?: Context): Promise<SalesChannelDTO[]>;
-    /**
-     * This method retrieves a paginated list of sales channels along with the total count of available sales channels satisfying the provided filters.
-     *
-     * @param {FilterableSalesChannelProps} filters - The filters to apply on the retrieved sales channels.
-     * @param {FindConfig<SalesChannelDTO>} config - The configurations determining how the sales channel is retrieved. Its properties, such as `select` or `relations`, accept the
-     * attributes or relations associated with a sales channel.
-     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<[SalesChannelDTO[], number]>} The list of sales channels along with their total count.
-     *
-     * @example
-     * To retrieve a list of sales channels using their IDs:
-     *
-     * ```ts
-     * const [salesChannels, count] =
-     *   await salesChannelModuleService.listAndCountSalesChannels({
-     *     id: ["sc_123", "sc_321"],
-     *   })
-     * ```
-     *
-     * 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
-     * const [salesChannels, count] =
-     *   await salesChannelModuleService.listAndCountSalesChannels(
-     *     {
-     *       id: ["sc_123", "sc_321"],
-     *     },
-     *     {
-     *       take: 20,
-     *       skip: 2,
-     *     }
-     *   )
-     * ```
-     */
-    listAndCountSalesChannels(filters?: FilterableSalesChannelProps, config?: FindConfig<SalesChannelDTO>, sharedContext?: Context): Promise<[SalesChannelDTO[], number]>;
-    /**
-     * This method soft deletes sales channels by their IDs.
-     *
-     * @param {string[]} salesChannelIds - The sales channels' ID.
-     * @param {SoftDeleteReturn<TReturnableLinkableKeys>} config - An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.
-     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were also soft deleted.
-     * If there are no related records, the promise resolves to `void`.
-     *
-     * @example
-     * await salesChannelModuleService.softDeleteSalesChannels(["sc_123", "sc_321"])
-     */
-    softDeleteSalesChannels<TReturnableLinkableKeys extends string = string>(salesChannelIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
-    /**
-     * This method restores a soft deleted sales channel by its IDs.
-     *
-     * @param {string[]} salesChannelIds - The list of {summary}
-     * @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the sales channel. You can pass to its `returnLinkableKeys`
-     * property any of the sales channel's relation attribute names.
-     * @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
-     * @returns {Promise<void | Record<string, string[]>>} An object that includes the IDs of related records that were restored.
-     * If there are no related records restored, the promise resolves to `void`.
-     *
-     * @example
-     * await salesChannelModuleService.restoreSalesChannels(["sc_123", "sc_321"])
-     */
-    restoreSalesChannels<TReturnableLinkableKeys extends string = string>(salesChannelIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
-}
-//# sourceMappingURL=service.d.ts.map

package/dist/sales-channel/service.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../../src/sales-channel/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAA;AACxD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAE,2BAA2B,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AACvE,OAAO,EACL,qBAAqB,EACrB,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,aAAa,CAAA;AAEpB;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,cAAc;IAChE;;;;;;;;;;;;;OAaG;IACH,mBAAmB,CACjB,IAAI,EAAE,qBAAqB,EAAE,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAE7B;;;;;;;;;;;OAWG;IACH,mBAAmB,CACjB,IAAI,EAAE,qBAAqB,EAC3B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,CAAA;IAE3B;;;;;;;;;;;;;;;OAeG;IACH,mBAAmB,CACjB,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,qBAAqB,EAC3B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,CAAA;IAE3B;;;;;;;;;;;;;;;;;OAiBG;IACH,mBAAmB,CACjB,QAAQ,EAAE,2BAA2B,EACrC,IAAI,EAAE,qBAAqB,EAC3B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAE7B;;;;;;;;;;;OAWG;IACH,mBAAmB,CACjB,IAAI,EAAE,qBAAqB,EAC3B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,CAAA;IAE3B;;;;;;;;;;;;;;;;;OAiBG;IACH,mBAAmB,CACjB,IAAI,EAAE,qBAAqB,EAAE,EAC7B,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAE7B;;;;;;;;;OASG;IACH,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE1E;;;;;;;;;OASG;IACH,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,aAAa,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEvE;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAClB,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC,EACpC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,CAAC,CAAA;IAE3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,iBAAiB,CACf,OAAO,CAAC,EAAE,2BAA2B,EACrC,MAAM,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC,EACpC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,eAAe,EAAE,CAAC,CAAA;IAE7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,yBAAyB,CACvB,OAAO,CAAC,EAAE,2BAA2B,EACrC,MAAM,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC,EACpC,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAEvC;;;;;;;;;;;OAWG;IACH,uBAAuB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EACrE,eAAe,EAAE,MAAM,EAAE,EACzB,MAAM,CAAC,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,EAClD,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;IAE3C;;;;;;;;;;;;OAYG;IACH,oBAAoB,CAAC,uBAAuB,SAAS,MAAM,GAAG,MAAM,EAClE,eAAe,EAAE,MAAM,EAAE,EACzB,MAAM,CAAC,EAAE,aAAa,CAAC,uBAAuB,CAAC,EAC/C,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;CAC5C"}

package/dist/sales-channel/service.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=service.js.map

package/dist/sales-channel/service.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"service.js","sourceRoot":"","sources":["../../src/sales-channel/service.ts"],"names":[],"mappings":""}

package/dist/stock-location/common.d.ts

@@ -1,430 +0,0 @@
-import { MetadataType } from "../common";
-import { BaseFilterable, OperatorMap } from "../dal";
-import { FulfillmentSetDTO } from "../fulfillment";
-/**
- * @schema StockLocationAddressDTO
- * title: "Stock Location Address"
- * description: "Represents a Stock Location Address"
- * type: object
- * required:
- *   - address_1
- *   - country_code
- *   - created_at
- *   - updated_at
- * properties:
- *   id:
- *     type: string
- *     description: The stock location address' ID
- *     example: laddr_51G4ZW853Y6TFXWPG5ENJ81X42
- *   address_1:
- *     type: string
- *     description: Stock location address
- *     example: 35, Jhon Doe Ave
- *   address_2:
- *     type: string
- *     description: Stock location address' complement
- *     example: apartment 4432
- *   company:
- *     type: string
- *     description: Stock location company' name
- *     example: AcmeKit
- *   city:
- *     type: string
- *     description: Stock location address' city
- *     example: Mexico city
- *   country_code:
- *     type: string
- *     description: Stock location address' country
- *     example: MX
- *   phone:
- *     type: string
- *     description: Stock location address' phone number
- *     example: +1 555 61646
- *   postal_code:
- *     type: string
- *     description: Stock location address' postal code
- *     example: HD3-1G8
- *   province:
- *     type: string
- *     description: Stock location address' province
- *     example: Sinaloa
- *   created_at:
- *     type: string
- *     description: "The date with timezone at which the resource was created."
- *     format: date-time
- *   updated_at:
- *     type: string
- *     description: "The date with timezone at which the resource was updated."
- *     format: date-time
- *   deleted_at:
- *     type: string
- *     description: "The date with timezone at which the resource was deleted."
- *     format: date-time
- *   metadata:
- *     type: object
- *     description: An optional key-value map with additional details
- *     example: {car: "white"}
- */
-export type StockLocationAddressDTO = {
-    /**
-     * The ID of the stock location address.
-     */
-    id?: string;
-    /**
-     * The address 1 of the stock location address.
-     */
-    address_1: string;
-    /**
-     * The address 2 of the stock location address.
-     */
-    address_2?: string | null;
-    /**
-     * The company of the stock location address.
-     */
-    company?: string | null;
-    /**
-     * The country code of the stock location address.
-     */
-    country_code: string;
-    /**
-     * The city of the stock location address.
-     */
-    city?: string | null;
-    /**
-     * The phone of the stock location address.
-     */
-    phone?: string | null;
-    /**
-     * The postal code of the stock location address.
-     */
-    postal_code?: string | null;
-    /**
-     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the stock location address.
-     */
-    province?: string | null;
-    /**
-     * Holds custom data in key-value pairs.
-     */
-    metadata?: MetadataType;
-    /**
-     * The creation date of the stock location address.
-     */
-    created_at: string | Date;
-    /**
-     * The update date of the stock location address.
-     */
-    updated_at: string | Date;
-    /**
-     * The deletion date of the stock location address.
-     */
-    deleted_at: string | Date | null;
-};
-/**
- * @schema StockLocationDTO
- * title: "Stock Location"
- * description: "Represents a Stock Location"
- * type: object
- * required:
- *   - id
- *   - name
- *   - address_id
- *   - created_at
- *   - updated_at
- * properties:
- *   id:
- *     type: string
- *     description: The stock location's ID
- *     example: sloc_51G4ZW853Y6TFXWPG5ENJ81X42
- *   address_id:
- *     type: string
- *     description: Stock location address' ID
- *     example: laddr_05B2ZE853Y6FTXWPW85NJ81A44
- *   name:
- *     type: string
- *     description: The name of the stock location
- *     example: Main Warehouse
- *   address:
- *     description: "The Address of the Stock Location"
- *     allOf:
- *       - $ref: "#/components/schemas/StockLocationAddressDTO"
- *       - type: object
- *   metadata:
- *     type: object
- *     description: An optional key-value map with additional details
- *     example: {car: "white"}
- *   created_at:
- *     type: string
- *     description: "The date with timezone at which the resource was created."
- *     format: date-time
- *   updated_at:
- *     type: string
- *     description: "The date with timezone at which the resource was updated."
- *     format: date-time
- *   deleted_at:
- *     type: string
- *     description: "The date with timezone at which the resource was deleted."
- *     format: date-time
- */
-export type StockLocationDTO = {
-    /**
-     * The ID of the stock location.
-     */
-    id: string;
-    /**
-     * The name of the stock location.
-     */
-    name: string;
-    /**
-     * Holds custom data in key-value pairs.
-     */
-    metadata: Record<string, unknown> | null;
-    /**
-     * The associated address's ID.
-     */
-    address_id: string;
-    /**
-     * The address of the stock location.
-     */
-    address?: StockLocationAddressDTO;
-    /**
-     * Fulfillment sets for the location
-     */
-    fulfillment_sets: FulfillmentSetDTO[];
-    /**
-     * The creation date of the stock location.
-     */
-    created_at: string | Date;
-    /**
-     * The update date of the stock location.
-     */
-    updated_at: string | Date;
-    /**
-     * The deletion date of the stock location.
-     */
-    deleted_at: string | Date | null;
-};
-/**
- * @schema StockLocationExpandedDTO
- * allOf:
- *   - $ref: "#/components/schemas/StockLocationDTO"
- *   - type: object
- *     properties:
- *       sales_channels:
- *         description: "The associated sales channels."
- *         $ref: "#/components/schemas/SalesChannel"
- */
-export type StockLocationExpandedDTO = StockLocationDTO & {
-    /**
-     * The list of sales channels.
-     */
-    sales_channels?: any[];
-};
-/**
- * @interface
- *
- * The filters to apply on the retrieved stock locations.
- */
-export interface FilterableStockLocationProps extends BaseFilterable<FilterableStockLocationProps> {
-    /**
-     * Search parameter for stock location names
-     */
-    q?: string;
-    /**
-     * The IDs to filter stock locations by.
-     */
-    id?: string | string[];
-    /**
-     * The names to filter stock locations by.
-     */
-    name?: string | string[] | OperatorMap<string>;
-}
-/**
- * @schema StockLocationAddressInput
- * title: "Stock Location Address Input"
- * description: "Represents a Stock Location Address Input"
- * type: object
- * required:
- *   - address_1
- *   - country_code
- * properties:
- *   address_1:
- *     type: string
- *     description: Stock location address
- *     example: 35, Jhon Doe Ave
- *   address_2:
- *     type: string
- *     description: Stock location address' complement
- *     example: apartment 4432
- *   city:
- *     type: string
- *     description: Stock location address' city
- *     example: Mexico city
- *   country_code:
- *     type: string
- *     description: Stock location address' country
- *     example: MX
- *   phone:
- *     type: string
- *     description: Stock location address' phone number
- *     example: +1 555 61646
- *   postal_code:
- *     type: string
- *     description: Stock location address' postal code
- *     example: HD3-1G8
- *   province:
- *     type: string
- *     description: Stock location address' lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province
- *     example: us-ca
- *   metadata:
- *     type: object
- *     description: An optional key-value map with additional details
- *     example: {car: "white"}
- */
-export type StockLocationAddressInput = {
-    /**
-     * The first line of the stock location address.
-     */
-    address_1: string;
-    /**
-     * The second line of the stock location address.
-     */
-    address_2?: string | null;
-    /**
-     * The country code of the stock location address.
-     */
-    country_code: string;
-    /**
-     * The city of the stock location address.
-     */
-    city?: string | null;
-    /**
-     * The phone of the stock location address.
-     */
-    phone?: string | null;
-    /**
-     * The lower-case [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) province of the stock location address.
-     */
-    province?: string | null;
-    /**
-     * The postal code of the stock location address.
-     */
-    postal_code?: string | null;
-    /**
-     * Holds custom data in key-value pairs.
-     */
-    metadata?: MetadataType;
-};
-/**
- * @schema CreateStockLocationInput
- * title: "Create Stock Location Input"
- * description: "Represents the Input to create a Stock Location"
- * type: object
- * required:
- *   - name
- * properties:
- *   name:
- *     type: string
- *     description: The stock location name
- *   address_id:
- *     type: string
- *     description: The Stock location address ID
- *   address:
- *     description: Stock location address object
- *     allOf:
- *       - $ref: "#/components/schemas/StockLocationAddressInput"
- *       - type: object
- *   metadata:
- *     type: object
- *     description: An optional key-value map with additional details
- *     example: {car: "white"}
- */
-export type CreateStockLocationInput = {
-    /**
-     * The name of the stock location.
-     */
-    name: string;
-    /**
-     * The associated address's ID.
-     */
-    address_id?: string | null;
-    /**
-     * The associated address.
-     */
-    address?: string | StockLocationAddressInput;
-    /**
-     * Holds custom data in key-value pairs.
-     */
-    metadata?: MetadataType;
-};
-/**
- * @schema UpdateStockLocationInput
- * title: "Update Stock Location Input"
- * description: "Represents the Input to update a Stock Location"
- * type: object
- * properties:
- *   name:
- *     type: string
- *     description: The stock location name
- *   address_id:
- *     type: string
- *     description: The Stock location address ID
- *   address:
- *     description: Stock location address object
- *     allOf:
- *       - $ref: "#/components/schemas/StockLocationAddressInput"
- *       - type: object
- *   metadata:
- *     type: object
- *     description: An optional key-value map with additional details
- *     example: {car: "white"}
- */
-export type UpdateStockLocationInput = {
-    /**
-     * The name of the stock location.
-     */
-    name?: string;
-    /**
-     * The associated address's ID.
-     */
-    address_id?: string | null;
-    /**
-     * The associated address's details.
-     */
-    address?: StockLocationAddressInput;
-    /**
-     * Holds custom data in key-value pairs.
-     */
-    metadata?: MetadataType;
-};
-/**
- * @interface
- *
- * A stock location to create or update. If the `id` property isn't provided,
- * the stock location is created. In that case, the `name` property is required.
- */
-export type UpsertStockLocationInput = Partial<UpdateStockLocationInput> & {
-    /**
-     * The ID of the stock location, if updating.
-     */
-    id?: string;
-};
-export type UpdateStockLocationAddressInput = StockLocationAddressInput & {
-    id: string;
-};
-/**
- * The stock location address to create or update. If the `id` property isn't provided,
- * the stock location address is created. In that case, the `address_1` property is required.
- */
-export type UpsertStockLocationAddressInput = StockLocationAddressInput & {
-    /**
-     * The ID of the stock location address, if updating.
-     */
-    id?: string;
-};
-export interface FilterableStockLocationAddressProps extends BaseFilterable<FilterableStockLocationAddressProps> {
-    /**
-     * The IDs to filter stock location's address by.
-     */
-    id?: string | string[];
-}
-//# sourceMappingURL=common.d.ts.map

package/dist/stock-location/common.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/stock-location/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AACxC,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAA;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+DG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAA;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CACjC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IAExC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,uBAAuB,CAAA;IAEjC;;OAEG;IACH,gBAAgB,EAAE,iBAAiB,EAAE,CAAA;IAErC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CACjC,CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,wBAAwB,GAAG,gBAAgB,GAAG;IACxD;;OAEG;IACH,cAAc,CAAC,EAAE,GAAG,EAAE,CAAA;CACvB,CAAA;AAED;;;;GAIG;AACH,MAAM,WAAW,4BACf,SAAQ,cAAc,CAAC,4BAA4B,CAAC;IACpD;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;CAC/C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAExB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAA;CACxB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,yBAAyB,CAAA;IAE5C;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAA;CACxB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE,yBAAyB,CAAA;IAEnC;;OAEG;IACH,QAAQ,CAAC,EAAE,YAAY,CAAA;CACxB,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,GAAG,OAAO,CAAC,wBAAwB,CAAC,GAAG;IACzE;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,MAAM,+BAA+B,GAAG,yBAAyB,GAAG;IACxE,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,+BAA+B,GAAG,yBAAyB,GAAG;IACxE;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;CACZ,CAAA;AAED,MAAM,WAAW,mCACf,SAAQ,cAAc,CAAC,mCAAmC,CAAC;IAC3D;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CACvB"}

package/dist/stock-location/common.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=common.js.map