@medusajs/types
Version:
Medusa Types definition
326 lines • 16.2 kB
TypeScript
import { FindConfig } from "../common/common";
import { RestoreReturn, SoftDeleteReturn } from "../dal";
import { IModuleService } from "../modules-sdk";
import { Context } from "../shared-context";
import { CreateStockLocationInput, FilterableStockLocationAddressProps, FilterableStockLocationProps, StockLocationAddressDTO, StockLocationDTO, UpdateStockLocationInput, UpsertStockLocationAddressInput, UpsertStockLocationInput } from "./common";
/**
* The main service interface for the Stock Location Module.
*/
export interface IStockLocationService extends IModuleService {
/**
* This method retrieves a paginated list of stock locations based on optional filters and configuration.
*
* @param {FilterableStockLocationProps} selector - The filters to apply on the retrieved stock locations.
* @param {FindConfig<StockLocationDTO>} config - The configurations determining how the stock location is retrieved. Its properties, such as `select` or `relations`, accept the
* attributes or relations associated with a stock location.
* @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
* @returns {Promise<StockLocationDTO[]>} The list of stock locations.
*
* @example
* To retrieve a list of stock locations using their IDs:
*
* ```ts
* const stockLocations = await stockLocationModuleService.listStockLocations({
* id: ["sloc_123", "sloc_321"],
* })
* ```
*
* To specify relations that should be retrieved within the stock locations:
*
* :::note
*
* You can only retrieve data models defined in the same module. To retrieve linked data models
* from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
*
* :::
*
* ```ts
* const stockLocations = await stockLocationModuleService.listStockLocations(
* {
* id: ["sloc_123", "sloc_321"],
* },
* {
* relations: ["address"],
* }
* )
* ```
*
* 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
* const stockLocations = await stockLocationModuleService.listStockLocations(
* {
* id: ["sloc_123", "sloc_321"],
* },
* {
* relations: ["address"],
* take: 20,
* skip: 2,
* }
* )
* ```
*/
listStockLocations(selector: FilterableStockLocationProps, config?: FindConfig<StockLocationDTO>, context?: Context): Promise<StockLocationDTO[]>;
/**
* This method retrieves a paginated list of stock locations along with the total count of available stock locations satisfying the provided filters.
*
* @param {FilterableStockLocationProps} selector - The filters to apply on the retrieved stock locations.
* @param {FindConfig<StockLocationDTO>} config - The configurations determining how the stock location is retrieved. Its properties, such as `select` or `relations`, accept the
* attributes or relations associated with a stock location.
* @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
* @returns {Promise<[StockLocationDTO[], number]>} The list of stock locations along with their total count.
*
* @example
* To retrieve a list of stock locations using their IDs:
*
* ```ts
* const [stockLocations, count] =
* await stockLocationModuleService.listandCountStockLocations({
* id: ["sloc_123", "sloc_321"],
* })
* ```
*
* To specify relations that should be retrieved within the stock locations:
*
* :::note
*
* You can only retrieve data models defined in the same module. To retrieve linked data models
* from other modules, use [Query](https://docs.medusajs.com/learn/fundamentals/module-links/query) instead.
*
* :::
*
* ```ts
* const [stockLocations, count] =
* await stockLocationModuleService.listandCountStockLocations(
* {
* id: ["sloc_123", "sloc_321"],
* },
* {
* relations: ["address"],
* }
* )
* ```
*
* 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
* const [stockLocations, count] =
* await stockLocationModuleService.listandCountStockLocations(
* {
* id: ["sloc_123", "sloc_321"],
* },
* {
* relations: ["address"],
* take: 20,
* skip: 2,
* }
* )
* ```
*/
listAndCountStockLocations(selector: FilterableStockLocationProps, config?: FindConfig<StockLocationDTO>, context?: Context): Promise<[StockLocationDTO[], number]>;
/**
* This method retrieves a stock location by its ID.
*
* @param {string} id - The ID of the stock location.
* @param {FindConfig<StockLocationDTO>} config - The configurations determining how the stock location is retrieved. Its properties, such as `select` or `relations`, accept the
* attributes or relations associated with a stock location.
* @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
* @returns {Promise<StockLocationDTO>} The retrieved stock location.
*
* @example
* const stockLocation =
* await stockLocationModuleService.retrieveStockLocation("sloc_123")
*/
retrieveStockLocation(id: string, config?: FindConfig<StockLocationDTO>, context?: Context): Promise<StockLocationDTO>;
/**
* This method creates a stock location.
*
* @param {CreateStockLocationInput} input - The stock location to create.
* @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
* @returns {Promise<StockLocationDTO>} The created stock location.
*
* @example
* const stockLocation = await stockLocationModuleService.createStockLocations(
* {
* name: "Warehouse",
* address: {
* address_1: "1855 Powder Mill Rd",
* country_code: "us",
* },
* }
* )
*/
createStockLocations(input: CreateStockLocationInput, context?: Context): Promise<StockLocationDTO>;
/**
* This method creates stock locations.
*
* @param {CreateStockLocationInput[]} input - The stock locations to create.
* @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
* @returns {Promise<StockLocationDTO[]>} The created stock locations.
*
* @example
* const stockLocations =
* await stockLocationModuleService.createStockLocations([
* {
* name: "Warehouse",
* address: {
* address_1: "1855 Powder Mill Rd",
* country_code: "us",
* },
* },
* {
* name: "Warehouse 2",
* address_id: "laddr_123",
* },
* ])
*/
createStockLocations(input: CreateStockLocationInput[], context?: Context): Promise<StockLocationDTO[]>;
/**
* This method updates or creates stock location service nexts if they don't exist.
*
* @param {Partial<UpdateStockLocationInput>[]} data - The list of Make all properties in t optional
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
* @returns {Promise<StockLocationDTO[]>} The created or updated stock location service nexts.
*
* @example
* {example-code}
*/
upsertStockLocations(data: UpsertStockLocationInput[], sharedContext?: Context): Promise<StockLocationDTO[]>;
/**
* This method updates or creates a stock location service next if it doesn't exist.
*
* @param {Partial<UpdateStockLocationInput>} data - Make all properties in T optional
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
* @returns {Promise<StockLocationDTO>} The created or updated stock location service next.
*
* @example
* {example-code}
*/
upsertStockLocations(data: UpsertStockLocationInput, sharedContext?: Context): Promise<StockLocationDTO>;
/**
* This method updates existing stock locations.
*
* @param {UpdateStockLocationInput[]} input - The attributes to update in the stock locations.
* @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
* @returns {Promise<StockLocationDTO[]>} The updated stock locations.
*
* @example
* const stockLocations =
* await stockLocationModuleService.updateStockLocations([
* {
* id: "sloc_123",
* name: "Warehouse",
* },
* {
* id: "sloc_321",
* address_id: "laddr_123",
* },
* ])
*/
updateStockLocations(id: string, input: UpdateStockLocationInput, context?: Context): Promise<StockLocationDTO>;
/**
* This method updates existing stock locations matching the specified filters.
*
* @param {FilterableStockLocationProps} selector - The filters specifying which stock locations to update.
* @param {UpdateStockLocationInput} input - The attributes to update in the stock locations.
* @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
* @returns {Promise<StockLocationDTO[]>} The updated stock locations.
*
* @example
* const stockLocations =
* await stockLocationModuleService.updateStockLocations(
* {
* name: "Warehouse",
* },
* {
* address_id: "laddr_123",
* }
* )
*/
updateStockLocations(selector: FilterableStockLocationProps, input: UpdateStockLocationInput, context?: Context): Promise<StockLocationDTO[]>;
/**
* This method deletes a stock location by its ID.
*
* @param {string} id - The ID of the stock location.
* @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
* @returns {Promise<void>} Resolves when the stock location is deleted successfully.
*
* @example
* await stockLocationModuleService.deleteStockLocations("sloc_123")
*/
deleteStockLocations(id: string | string[], context?: Context): Promise<void>;
/**
* This method soft deletes stock locations by their IDs.
*
* @param {string[]} stockLocationIds - The IDs of the stock locations.
* @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, such as the ID of the associated address.
* The object's keys are the ID attribute names of the stock location entity's relations, such as `address_id`, and its value is an array of strings, each being the ID of a record associated
* with the stock location through this relation, such as the IDs of associated address.
*
* If there are no related records, the promise resolves to `void`.
*
* @example
* await stockLocationModuleService.softDeleteStockLocations([
* "sloc_123",
* "sloc_321",
* ])
*/
softDeleteStockLocations<TReturnableLinkableKeys extends string = string>(stockLocationIds: string[], config?: SoftDeleteReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
/**
* This method restores soft deleted stock locations by their IDs.
*
* @param {string[]} stockLocationIds - The IDs of the stock locations.
* @param {RestoreReturn<TReturnableLinkableKeys>} config - Configurations determining which relations to restore along with each of the stock location. You can pass to its `returnLinkableKeys`
* property any of the stock location's relation attribute names, such as `address`.
* @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, such as the ID of associated address.
* The object's keys are the ID attribute names of the stock location entity's relations, such as `address_id`,
* and its value is an array of strings, each being the ID of the record associated with the stock location through this relation,
* such as the ID of associated address.
*
* If there are no related records restored, the promise resolves to `void`.
*
* @example
* await stockLocationModuleService.restoreStockLocations([
* "sloc_123",
* "sloc_321",
* ])
*/
restoreStockLocations<TReturnableLinkableKeys extends string = string>(stockLocationIds: string[], config?: RestoreReturn<TReturnableLinkableKeys>, sharedContext?: Context): Promise<Record<string, string[]> | void>;
/**
* This method retrieves a paginated list of stock location addresses based on optional filters and configuration.
*
* @param {FilterableStockLocationAddressProps} selector - The filters to apply on the retrieved stock location address.
* @param {FindConfig<StockLocationAddressDTO>} config - The configurations determining how the stock location address is retrieved. Its properties, such as `select` or `relations`, accept the
* attributes or relations associated with a stock location address.
* @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
* @returns {Promise<StockLocationAddressDTO[]>} The list of stock location addressess.
*
*/
listStockLocationAddresses(selector: FilterableStockLocationAddressProps, config?: FindConfig<StockLocationAddressDTO>, context?: Context): Promise<StockLocationAddressDTO[]>;
/**
* This method updates or creates stock location addresses
*
* @param {Partial<UpsertStockLocationAddressInput>[]} data - The list of Make all properties in t optional
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
* @returns {Promise<StockLocationAddressDTO[]>} The created or updated stock location address
*
* @example
* {example-code}
*/
upsertStockLocationAddresses(data: UpsertStockLocationAddressInput[], sharedContext?: Context): Promise<StockLocationAddressDTO[]>;
/**
* This method deletes a stock location address by its ID.
*
* @param {string} id - The ID of the stock location address.
* @param {Context} context - A context used to share resources, such as transaction manager, between the application and the module.
* @returns {Promise<void>} Resolves when the stock location address is deleted successfully.
*
* @example
* await stockLocationModuleService.deleteStockLocationAddresses("sla_123")
*/
deleteStockLocationAddresses(id: string | string[], context?: Context): Promise<void>;
}
//# sourceMappingURL=service.d.ts.map