@medusajs/types 3.0.0-preview-20250211091350 → 3.0.0-preview-20250406180144

package/dist/http/stock-locations/admin/payloads.d.ts

@@ -1,31 +1,100 @@
 interface AdminUpsertStockLocationAddress {
+    /**
+     * The first line of the address.
+     */
     address_1: string;
+    /**
+     * The second line of the address.
+     */
     address_2?: string;
+    /**
+     * The company name associated with the address.
+     */
     company?: string;
+    /**
+     * The country code of the address.
+     *
+     * @example
+     * "us"
+     */
     country_code: string;
+    /**
+     * The city of the address.
+     */
     city?: string;
+    /**
+     * The phone number of the address.
+     */
     phone?: string;
+    /**
+     * The postal or zip code of the address.
+     */
     postal_code?: string;
+    /**
+     * The province or state of the address.
+     */
     province?: string;
 }
 export interface AdminCreateStockLocation {
+    /**
+     * The name of the stock location.
+     */
     name: string;
+    /**
+     * The ID of the address to associate with the stock location.
+     * If you provide an `address`, you don't need to provide this property.
+     */
     address_id?: string;
+    /**
+     * The address to create or update for the stock location.
+     * If you provide an `address_id`, you don't need
+     * to provide this property.
+     */
     address?: AdminUpsertStockLocationAddress;
+    /**
+     * Custom key-value pairs that can be added to the stock location.
+     */
     metadata?: Record<string, unknown>;
 }
 export interface AdminUpdateStockLocation {
+    /**
+     * The name of the stock location.
+     */
     name?: string;
+    /**
+     * The ID of the address to associate with the stock location.
+     * If you provide an `address`, you don't need to provide this property.
+     */
     address_id?: string;
+    /**
+     * The address to create or update for the stock location.
+     * If you provide an `address_id`, you don't need
+     * to provide this property.
+     */
     address?: AdminUpsertStockLocationAddress;
+    /**
+     * Custom key-value pairs that can be added to the stock location.
+     */
     metadata?: Record<string, unknown>;
 }
 export interface AdminUpdateStockLocationSalesChannels {
+    /**
+     * The IDs of the sales channels to add to the stock location.
+     */
     add?: string[];
+    /**
+     * The IDs of the sales channels to remove from the stock location.
+     */
     remove?: string[];
 }
 export interface AdminCreateStockLocationFulfillmentSet {
+    /**
+     * The name of the fulfillment set.
+     */
     name: string;
+    /**
+     * The type of the fulfillment set.
+     */
     type: string;
 }
 export {};

package/dist/http/stock-locations/admin/payloads.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/stock-locations/admin/payloads.ts"],"names":[],"mappings":"AAAA,UAAU,+BAA+B;IACvC,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,+BAA+B,CAAA;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,+BAA+B,CAAA;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,qCAAqC;IACpD,GAAG,CAAC,EAAE,MAAM,EAAE,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,sCAAsC;IACrD,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;CACb"}
+{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/stock-locations/admin/payloads.ts"],"names":[],"mappings":"AAAA,UAAU,+BAA+B;IACvC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,OAAO,CAAC,EAAE,+BAA+B,CAAA;IACzC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,OAAO,CAAC,EAAE,+BAA+B,CAAA;IACzC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,qCAAqC;IACpD;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,EAAE,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,sCAAsC;IACrD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb"}

package/dist/http/stock-locations/admin/queries.d.ts

@@ -1,15 +1,37 @@
 import { BaseFilterable, OperatorMap } from "../../../dal";
 import { FindParams } from "../../common";
 export interface AdminStockLocationListParams extends FindParams, BaseFilterable<AdminStockLocationListParams> {
+    /**
+     * Filter by stock location ID(s).
+     */
     id?: string | string[];
+    /**
+     * Query or keywords to search the stock location's searchable fields.
+     */
     q?: string;
+    /**
+     * Filter by stock location name.
+     */
     name?: string | string[];
+    /**
+     * Filter by stock location address ID(s).
+     */
     address_id?: string | string[];
+    /**
+     * Filter by sales channel ID(s) to retrieve the stock locations for.
+     */
     sales_channel_id?: string | string[];
-    $and?: AdminStockLocationListParams[];
-    $or?: AdminStockLocationListParams[];
+    /**
+     * Filter by the date the stock location was created.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Filter by the date the stock location was updated.
+     */
     updated_at?: OperatorMap<string>;
+    /**
+     * Filter by the date the stock location was deleted.
+     */
     deleted_at?: OperatorMap<string>;
 }
 //# sourceMappingURL=queries.d.ts.map

package/dist/http/stock-locations/admin/queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/stock-locations/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,MAAM,WAAW,4BACf,SAAQ,UAAU,EAChB,cAAc,CAAC,4BAA4B,CAAC;IAC9C,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC9B,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACpC,IAAI,CAAC,EAAE,4BAA4B,EAAE,CAAA;IACrC,GAAG,CAAC,EAAE,4BAA4B,EAAE,CAAA;IACpC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/stock-locations/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,MAAM,WAAW,4BACf,SAAQ,UAAU,EAChB,cAAc,CAAC,4BAA4B,CAAC;IAC9C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC9B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACpC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC"}

package/dist/http/stock-locations/admin/responses.d.ts

@@ -1,9 +1,15 @@
 import { DeleteResponse, PaginatedResponse } from "../../common";
 import { AdminStockLocation } from "./entities";
 export interface AdminStockLocationResponse {
+    /**
+     * The stock location's details.
+     */
     stock_location: AdminStockLocation;
 }
 export interface AdminStockLocationListResponse extends PaginatedResponse<{
+    /**
+     * The list of stock locations.
+     */
     stock_locations: AdminStockLocation[];
 }> {
 }

package/dist/http/stock-locations/admin/responses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/stock-locations/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAE/C,MAAM,WAAW,0BAA0B;IACzC,cAAc,EAAE,kBAAkB,CAAA;CACnC;AAED,MAAM,WAAW,8BACf,SAAQ,iBAAiB,CAAC;IACxB,eAAe,EAAE,kBAAkB,EAAE,CAAA;CACtC,CAAC;CAAG;AAEP,MAAM,WAAW,gCACf,SAAQ,cAAc,CAAC,gBAAgB,CAAC;CAAG"}
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/stock-locations/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAE/C,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAA;CACnC;AAED,MAAM,WAAW,8BACf,SAAQ,iBAAiB,CAAC;IACxB;;OAEG;IACH,eAAe,EAAE,kBAAkB,EAAE,CAAA;CACtC,CAAC;CAAG;AAEP,MAAM,WAAW,gCACf,SAAQ,cAAc,CAAC,gBAAgB,CAAC;CAAG"}

package/dist/http/store/admin/entities.d.ts

@@ -1,23 +1,77 @@
 import { AdminCurrency } from "../../currency";
 export interface AdminStoreCurrency {
+    /**
+     * The currency's ID.
+     */
     id: string;
+    /**
+     * The currency code.
+     *
+     * @example
+     * "usd"
+     */
     currency_code: string;
+    /**
+     * The ID of the store that the currency belongs to.
+     */
     store_id: string;
+    /**
+     * Whether the currency is the default currency for the store.
+     */
     is_default: boolean;
+    /**
+     * The currency's details.
+     */
     currency: AdminCurrency;
+    /**
+     * The date the currency was created.
+     */
     created_at: string;
+    /**
+     * The date the currency was updated.
+     */
     updated_at: string;
+    /**
+     * The date the currency was deleted.
+     */
     deleted_at: string | null;
 }
 export interface AdminStore {
+    /**
+     * The store's ID.
+     */
     id: string;
+    /**
+     * The store's name.
+     */
     name: string;
+    /**
+     * The store's supported currencies.
+     */
     supported_currencies: AdminStoreCurrency[];
+    /**
+     * The store's default sales channel ID.
+     */
     default_sales_channel_id: string | null;
+    /**
+     * The store's default region ID.
+     */
     default_region_id: string | null;
+    /**
+     * The store's default location ID.
+     */
     default_location_id: string | null;
+    /**
+     * Custom key-value pairs that can be added to the store.
+     */
     metadata: Record<string, any> | null;
+    /**
+     * The date the store was created.
+     */
     created_at: string;
+    /**
+     * The date the store was updated.
+     */
     updated_at: string;
 }
 //# sourceMappingURL=entities.d.ts.map

package/dist/http/store/admin/entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/store/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAE9C,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,aAAa,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,OAAO,CAAA;IACnB,QAAQ,EAAE,aAAa,CAAA;IACvB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,oBAAoB,EAAE,kBAAkB,EAAE,CAAA;IAC1C,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAA;IACvC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;IACpC,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;CACnB"}
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/store/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AAE9C,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;;;;OAKG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAA;IACvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,oBAAoB,EAAE,kBAAkB,EAAE,CAAA;IAC1C;;OAEG;IACH,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAA;IACvC;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC;;OAEG;IACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;IACpC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;CACnB"}

package/dist/http/store/admin/queries.d.ts

@@ -1,8 +1,17 @@
 import { BaseFilterable } from "../../../dal";
 import { FindParams, SelectParams } from "../../common";
 export interface AdminStoreListParams extends BaseFilterable<AdminStoreListParams>, FindParams {
+    /**
+     * Query or keywords to search the store's searchable fields.
+     */
     q?: string;
+    /**
+     * Filter by store ID(s).
+     */
     id?: string | string[];
+    /**
+     * Filter by store name.
+     */
     name?: string | string[];
 }
 export interface AdminStoreParams extends SelectParams {

package/dist/http/store/admin/queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/store/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAEvD,MAAM,WAAW,oBACf,SAAQ,cAAc,CAAC,oBAAoB,CAAC,EAC1C,UAAU;IACZ,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CACzB;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY;CAAG"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/store/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAC7C,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAEvD,MAAM,WAAW,oBACf,SAAQ,cAAc,CAAC,oBAAoB,CAAC,EAC1C,UAAU;IACZ;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CACzB;AAED,MAAM,WAAW,gBAAiB,SAAQ,YAAY;CAAG"}

package/dist/http/store/admin/responses.d.ts

@@ -1,9 +1,15 @@
 import { PaginatedResponse } from "../../common";
 import { AdminStore } from "./entities";
 export interface AdminStoreResponse {
+    /**
+     * The store's details.
+     */
     store: AdminStore;
 }
 export interface AdminStoreListResponse extends PaginatedResponse<{
+    /**
+     * The list of stores.
+     */
     stores: AdminStore[];
 }> {
 }

package/dist/http/store/admin/responses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/store/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAEvC,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,WAAW,sBACf,SAAQ,iBAAiB,CAAC;IACxB,MAAM,EAAE,UAAU,EAAE,CAAA;CACrB,CAAC;CAAG"}
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/store/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAEvC,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,KAAK,EAAE,UAAU,CAAA;CAClB;AAED,MAAM,WAAW,sBACf,SAAQ,iBAAiB,CAAC;IACxB;;OAEG;IACH,MAAM,EAAE,UAAU,EAAE,CAAA;CACrB,CAAC;CAAG"}

package/dist/http/tax-rate/admin/entities.d.ts

@@ -1,22 +1,76 @@
 import { AdminTaxRegion } from "../../tax-region";
 export interface AdminTaxRateRule {
+    /**
+     * The name of the table that the rule references.
+     *
+     * @example
+     * "product_type"
+     */
     reference: string;
+    /**
+     * The ID of the record in the table that the rule references.
+     *
+     * @example
+     * "protyp_123"
+     */
     reference_id: string;
 }
 export interface AdminTaxRate {
+    /**
+     * The tax rate's ID.
+     */
     id: string;
+    /**
+     * The tax rate's percentage rate.
+     */
     rate: number | null;
+    /**
+     * The tax rate's code.
+     */
     code: string;
+    /**
+     * The tax rate's name.
+     */
     name: string;
+    /**
+     * Custom key-value pairs that can be added to the tax rate.
+     */
     metadata: Record<string, unknown> | null;
+    /**
+     * The ID of the tax region associated with the tax rate.
+     */
     tax_region_id: string;
+    /**
+     * Whether the tax rate is combinable with other tax rates.
+     */
     is_combinable: boolean;
+    /**
+     * Whether the tax rate is the default tax rate in its tax region.
+     */
     is_default: boolean;
+    /**
+     * The date the tax rate was created.
+     */
     created_at: string;
+    /**
+     * The date the tax rate was updated.
+     */
     updated_at: string;
+    /**
+     * The date the tax rate was deleted.
+     */
     deleted_at: null;
+    /**
+     * The ID of the user who created the tax rate.
+     */
     created_by: string | null;
+    /**
+     * The tax region associated with the tax rate.
+     */
     tax_region: AdminTaxRegion;
+    /**
+     * The rules associated with the tax rate.
+     */
     rules: AdminTaxRateRule[];
 }
 //# sourceMappingURL=entities.d.ts.map

package/dist/http/tax-rate/admin/entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/tax-rate/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAEjD,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC,aAAa,EAAE,MAAM,CAAA;IACrB,aAAa,EAAE,OAAO,CAAA;IACtB,UAAU,EAAE,OAAO,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,cAAc,CAAA;IAC1B,KAAK,EAAE,gBAAgB,EAAE,CAAA;CAC1B"}
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/tax-rate/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAEjD,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,aAAa,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAChB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,UAAU,EAAE,cAAc,CAAA;IAC1B;;OAEG;IACH,KAAK,EAAE,gBAAgB,EAAE,CAAA;CAC1B"}

package/dist/http/tax-rate/admin/payloads.d.ts

@@ -1,24 +1,81 @@
 interface AdminCreateTaxRateRule {
+    /**
+     * The name of the table that the rule references.
+     *
+     * @example
+     * "product_type"
+     */
     reference: string;
+    /**
+     * The ID of the record in the table that the rule references.
+     *
+     * @example
+     * "protyp_123"
+     */
     reference_id: string;
 }
 export interface AdminCreateTaxRate {
+    /**
+     * The name of the tax rate.
+     */
     name: string;
+    /**
+     * The ID of the tax region associated with the tax rate.
+     */
     tax_region_id: string;
+    /**
+     * The rate of the tax rate.
+     */
     rate?: number;
+    /**
+     * The code of the tax rate.
+     */
     code: string;
+    /**
+     * The rules of the tax rate.
+     */
     rules?: AdminCreateTaxRateRule[];
+    /**
+     * Whether the tax rate is the default tax rate in its tax region.
+     */
     is_default?: boolean;
+    /**
+     * Whether the tax rate is combinable with other tax rates.
+     */
     is_combinable?: boolean;
+    /**
+     * Custom key-value pairs that can be added to the tax rate.
+     */
     metadata?: Record<string, unknown>;
 }
 export interface AdminUpdateTaxRate {
+    /**
+     * The name of the tax rate.
+     */
     name?: string;
+    /**
+     * The percentage rate of the tax rate.
+     */
     rate?: number;
+    /**
+     * The code of the tax rate.
+     */
     code: string;
+    /**
+     * The rules of the tax rate.
+     */
     rules?: AdminCreateTaxRateRule[];
+    /**
+     * Whether the tax rate is the default tax rate in its tax region.
+     */
     is_default?: boolean;
+    /**
+     * Whether the tax rate is combinable with other tax rates.
+     */
     is_combinable?: boolean;
+    /**
+     * Custom key-value pairs that can be added to the tax rate.
+     */
     metadata?: Record<string, unknown>;
 }
 export {};

package/dist/http/tax-rate/admin/payloads.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/tax-rate/admin/payloads.ts"],"names":[],"mappings":"AAAA,UAAU,sBAAsB;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,MAAM,CAAA;IACrB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,sBAAsB,EAAE,CAAA;IAChC,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,sBAAsB,EAAE,CAAA;IAChC,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC"}
+{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/tax-rate/admin/payloads.ts"],"names":[],"mappings":"AAAA,UAAU,sBAAsB;IAC9B;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,KAAK,CAAC,EAAE,sBAAsB,EAAE,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,KAAK,CAAC,EAAE,sBAAsB,EAAE,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC"}

package/dist/http/tax-rate/admin/queries.d.ts

@@ -1,15 +1,45 @@
 import { BaseFilterable, OperatorMap } from "../../../dal";
 import { FindParams } from "../../common";
 export interface AdminTaxRateListParams extends FindParams, BaseFilterable<AdminTaxRateListParams> {
+    /**
+     * Query or keywords to search the tax rate's searchable fields.
+     */
     q?: string;
+    /**
+     * Filter by tax region ID(s).
+     */
     tax_region_id?: string | string[] | OperatorMap<string | string[]>;
+    /**
+     * Filter by whether the tax rate is the default tax rate in its tax region.
+     */
     is_default?: "true" | "false";
+    /**
+     * Filter by service zone ID(s) to retrieve tax rates that are associated with the service zones.
+     */
     service_zone_id?: string;
+    /**
+     * Filter by shipping profile ID(s) to retrieve tax rates that are associated with the shipping profiles.
+     */
     shipping_profile_id?: string;
+    /**
+     * Filter by tax provider ID(s) to retrieve tax rates that are associated with the providers.
+     */
     provider_id?: string;
+    /**
+     * Filter by shipping option type ID(s) to retrieve tax rates that are associated with the shipping option types.
+     */
     shipping_option_type_id?: string;
+    /**
+     * Filter by the date the tax rate was created.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Filter by the date the tax rate was updated.
+     */
     updated_at?: OperatorMap<string>;
+    /**
+     * Filter by the date the tax rate was deleted.
+     */
     deleted_at?: OperatorMap<string>;
 }
 //# sourceMappingURL=queries.d.ts.map

package/dist/http/tax-rate/admin/queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/tax-rate/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,MAAM,WAAW,sBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,sBAAsB,CAAC;IACxC,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAClE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC7B,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/tax-rate/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,MAAM,WAAW,sBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,sBAAsB,CAAC;IACxC;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAClE;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAC7B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC"}

package/dist/http/tax-rate/admin/responses.d.ts

@@ -1,9 +1,15 @@
 import { DeleteResponse, DeleteResponseWithParent, PaginatedResponse } from "../../common";
 import { AdminTaxRate } from "./entities";
 export interface AdminTaxRateResponse {
+    /**
+     * The tax rate's details.
+     */
     tax_rate: AdminTaxRate;
 }
 export type AdminTaxRateListResponse = PaginatedResponse<{
+    /**
+     * The list of tax rates.
+     */
     tax_rates: AdminTaxRate[];
 }>;
 export interface AdminTaxRateDeleteResponse extends DeleteResponse<"tax_rate"> {

package/dist/http/tax-rate/admin/responses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/tax-rate/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,wBAAwB,EACxB,iBAAiB,EAClB,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAEzC,MAAM,WAAW,oBAAoB;IACnC,QAAQ,EAAE,YAAY,CAAA;CACvB;AAED,MAAM,MAAM,wBAAwB,GAAG,iBAAiB,CAAC;IACvD,SAAS,EAAE,YAAY,EAAE,CAAA;CAC1B,CAAC,CAAA;AAEF,MAAM,WAAW,0BACf,SAAQ,cAAc,CAAC,UAAU,CAAC;CAAG;AAEvC,MAAM,MAAM,8BAA8B,GAAG,wBAAwB,CACnE,eAAe,EACf,YAAY,CACb,CAAA"}
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/tax-rate/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,wBAAwB,EACxB,iBAAiB,EAClB,MAAM,cAAc,CAAA;AACrB,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAA;AAEzC,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,QAAQ,EAAE,YAAY,CAAA;CACvB;AAED,MAAM,MAAM,wBAAwB,GAAG,iBAAiB,CAAC;IACvD;;OAEG;IACH,SAAS,EAAE,YAAY,EAAE,CAAA;CAC1B,CAAC,CAAA;AAEF,MAAM,WAAW,0BACf,SAAQ,cAAc,CAAC,UAAU,CAAC;CAAG;AAEvC,MAAM,MAAM,8BAA8B,GAAG,wBAAwB,CACnE,eAAe,EACf,YAAY,CACb,CAAA"}

package/dist/http/tax-region/admin/entities.d.ts

@@ -1,16 +1,58 @@
 import { AdminTaxRate } from "../../tax-rate";
 export interface AdminTaxRegion {
+    /**
+     * The tax region's ID.
+     */
     id: string;
+    /**
+     * The tax region's country code.
+     *
+     * @example
+     * "us"
+     */
     country_code: string | null;
+    /**
+     * The tax region's province or state code.
+     *
+     * @example
+     * "ca"
+     */
     province_code: string | null;
+    /**
+     * Custom key-value pairs that can be added to the tax region.
+     */
     metadata: Record<string, unknown> | null;
+    /**
+     * The ID of the parent tax region.
+     */
     parent_id: string | null;
+    /**
+     * The date the tax region was created.
+     */
     created_at: string;
+    /**
+     * The date the tax region was updated.
+     */
     updated_at: string;
+    /**
+     * The date the tax region was deleted.
+     */
     deleted_at: string | null;
+    /**
+     * The ID of the user who created the tax region.
+     */
     created_by: string | null;
+    /**
+     * The tax rates associated with the tax region.
+     */
     tax_rates: AdminTaxRate[];
+    /**
+     * The parent tax region.
+     */
     parent: AdminTaxRegion | null;
+    /**
+     * The child tax regions.
+     */
     children: AdminTaxRegion[];
 }
 //# sourceMappingURL=entities.d.ts.map

package/dist/http/tax-region/admin/entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/tax-region/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7C,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,YAAY,EAAE,CAAA;IACzB,MAAM,EAAE,cAAc,GAAG,IAAI,CAAA;IAC7B,QAAQ,EAAE,cAAc,EAAE,CAAA;CAC3B"}
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/tax-region/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAE7C,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;;;;OAKG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;;;;OAKG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,SAAS,EAAE,YAAY,EAAE,CAAA;IACzB;;OAEG;IACH,MAAM,EAAE,cAAc,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,QAAQ,EAAE,cAAc,EAAE,CAAA;CAC3B"}

package/dist/http/tax-region/admin/payloads.d.ts

@@ -1,14 +1,44 @@
 export interface AdminCreateTaxRegion {
+    /**
+     * The country code of the tax region.
+     */
     country_code: string;
+    /**
+     * The province code of the tax region.
+     */
     province_code?: string;
+    /**
+     * The ID of the parent tax region.
+     */
     parent_id?: string;
+    /**
+     * The default tax rate of the tax region.
+     */
     default_tax_rate?: {
+        /**
+         * The percentage rate of the default tax rate.
+         */
         rate?: number;
+        /**
+         * The code of the default tax rate.
+         */
         code: string;
+        /**
+         * The name of the default tax rate.
+         */
         name: string;
+        /**
+         * Whether the default tax rate is combinable with other tax rates.
+         */
         is_combinable?: boolean;
+        /**
+         * Custom key-value pairs that can be added to the default tax rate.
+         */
         metadata?: Record<string, unknown>;
     };
+    /**
+     * Custom key-value pairs that can be added to the tax region.
+     */
     metadata?: Record<string, unknown>;
 }
 //# sourceMappingURL=payloads.d.ts.map