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

package/dist/http/shipping-option/admin/payloads.d.ts

@@ -1,68 +1,249 @@
 import { RuleOperatorType } from "../../../common";
 import { ShippingOptionPriceType } from "../../../fulfillment";
 export interface AdminCreateShippingOptionRule {
+    /**
+     * The operator of the shipping option rule.
+     */
     operator: RuleOperatorType;
+    /**
+     * The attribute of the shipping option rule.
+     *
+     * @example
+     * `enabled_in_store`
+     */
     attribute: string;
+    /**
+     * The value of the shipping option rule.
+     *
+     * @example
+     * `true`
+     */
     value: string | string[];
 }
 export interface AdminCreateShippingOptionType {
+    /**
+     * The label of the shipping option type.
+     */
     label: string;
+    /**
+     * The description of the shipping option type.
+     */
     description: string;
+    /**
+     * The code of the shipping option type.
+     */
     code: string;
 }
 interface AdminShippingOptionPriceRulePayload {
+    /**
+     * The operator of the shipping option price rule.
+     *
+     * @example
+     * "eq"
+     */
     operator: string;
+    /**
+     * The attribute of the shipping option price rule.
+     *
+     * @example
+     * "region_id"
+     */
     attribute: string;
+    /**
+     * The value of the shipping option price rule.
+     *
+     * @example
+     * "region_123"
+     */
     value: string | string[] | number;
 }
 interface AdminShippingOptionPriceWithRules {
+    /**
+     * The rules of the shipping option price that
+     * indicate when the price should be applied.
+     */
     rules?: AdminShippingOptionPriceRulePayload[];
 }
 export interface AdminCreateShippingOptionPriceWithCurrency extends AdminShippingOptionPriceWithRules {
+    /**
+     * The currency code of the shipping option price.
+     *
+     * @example
+     * "usd"
+     */
     currency_code: string;
+    /**
+     * The amount of the shipping option price.
+     */
     amount: number;
 }
 export interface AdminCreateShippingOptionPriceWithRegion extends AdminShippingOptionPriceWithRules {
+    /**
+     * The ID of the region that the shipping option price belongs to.
+     */
     region_id: string;
+    /**
+     * The amount of the shipping option price.
+     */
     amount: number;
 }
 export interface AdminCreateShippingOption {
+    /**
+     * The name of the shipping option. Customers can
+     * view this name during checkout.
+     *
+     * @example
+     * "Standard Shipping"
+     */
     name: string;
+    /**
+     * The ID of the service zone that the shipping option belongs to.
+     *
+     * Learn more in the [Shipping Options](https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#service-zone-restrictions)
+     * documentation.
+     */
     service_zone_id: string;
+    /**
+     * The ID of the shipping profile that the shipping option belongs to.
+     *
+     * Learn more in the [Shipping Options](https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#shipping-profile-and-types)
+     * documentation.
+     */
     shipping_profile_id: string;
+    /**
+     * Additional data that is useful for third-party fulfillment providers
+     * that process fulfillments for the shipping option.
+     *
+     * Learn more in the [Shipping Options](https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property)
+     * documentation.
+     */
     data?: Record<string, unknown>;
+    /**
+     * The type of shipping option's price.
+     */
     price_type: ShippingOptionPriceType;
+    /**
+     * The ID of the fulfillment provider that the shipping option belongs to.
+     */
     provider_id: string;
+    /**
+     * The type of shipping option.
+     *
+     * Learn more in the [Shipping Option](https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#shipping-profile-and-types)
+     * documentation.
+     */
     type: AdminCreateShippingOptionType;
+    /**
+     * The prices of the shipping option.
+     */
     prices: (AdminCreateShippingOptionPriceWithCurrency | AdminCreateShippingOptionPriceWithRegion)[];
+    /**
+     * The rules of the shipping option.
+     *
+     * Learn more in the [Shipping Option Rules](https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#shipping-option-rules)
+     * documentation.
+     */
     rules?: AdminCreateShippingOptionRule[];
 }
 export interface AdminUpdateShippingOptionRule extends AdminCreateShippingOptionRule {
+    /**
+     * The ID of the shipping option rule that is being updated.
+     */
     id: string;
 }
 export interface AdminUpdateShippingOptionPriceWithCurrency extends AdminShippingOptionPriceWithRules {
+    /**
+     * The ID of the shipping option price that is being updated.
+     * If not provided, a new shipping option price will be created.
+     */
     id?: string;
+    /**
+     * The currency code of the shipping option price.
+     *
+     * @example
+     * "usd"
+     */
     currency_code?: string;
+    /**
+     * The amount of the shipping option price.
+     */
     amount?: number;
 }
 export interface AdminUpdateShippingOptionPriceWithRegion extends AdminShippingOptionPriceWithRules {
+    /**
+     * The ID of the shipping option price that is being updated.
+     * If not provided, a new shipping option price will be created.
+     */
     id?: string;
+    /**
+     * The ID of the region that the shipping option price belongs to.
+     */
     region_id?: string;
+    /**
+     * The amount of the shipping option price.
+     */
     amount?: number;
 }
 export interface AdminUpdateShippingOption {
+    /**
+     * The name of the shipping option. Customers can
+     * view this name during checkout.
+     *
+     * @example
+     * "Standard Shipping"
+     */
     name?: string;
+    /**
+     * Additional data that is useful for third-party fulfillment providers
+     * that process fulfillments for the shipping option.
+     */
     data?: Record<string, unknown>;
+    /**
+     * The type of shipping option's price.
+     */
     price_type?: ShippingOptionPriceType;
+    /**
+     * The ID of the fulfillment provider that the shipping option belongs to.
+     */
     provider_id?: string;
+    /**
+     * The ID of the shipping profile that the shipping option belongs to.
+     *
+     * Learn more in the [Shipping Options](https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#shipping-profile-and-types)
+     * documentation.
+     */
     shipping_profile_id?: string;
+    /**
+     * The type of shipping option.
+     *
+     * Learn more in the [Shipping Options](https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#shipping-profile-and-types)
+     * documentation.
+     */
     type?: AdminCreateShippingOptionType;
+    /**
+     * The prices of the shipping option.
+     */
     prices?: (AdminUpdateShippingOptionPriceWithCurrency | AdminUpdateShippingOptionPriceWithRegion)[];
+    /**
+     * The rules of the shipping option.
+     *
+     * Learn more in the [Shipping Option Rules](https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#shipping-option-rules)
+     * documentation.
+     */
     rules?: (AdminUpdateShippingOptionRule | AdminCreateShippingOptionRule)[];
 }
 export interface AdminUpdateShippingOptionRules {
+    /**
+     * The rules to create.
+     */
     create?: any[];
+    /**
+     * The rules to update.
+     */
     update?: any[];
+    /**
+     * The rules to delete.
+     */
     delete?: string[];
 }
 export {};

package/dist/http/shipping-option/admin/payloads.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-option/admin/payloads.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAE9D,MAAM,WAAW,6BAA6B;IAC5C,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CACzB;AAED,MAAM,WAAW,6BAA6B;IAC5C,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,UAAU,mCAAmC;IAC3C,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,CAAA;CAClC;AAED,UAAU,iCAAiC;IACzC,KAAK,CAAC,EAAE,mCAAmC,EAAE,CAAA;CAC9C;AAED,MAAM,WAAW,0CACf,SAAQ,iCAAiC;IACzC,aAAa,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,wCACf,SAAQ,iCAAiC;IACzC,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe,EAAE,MAAM,CAAA;IACvB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B,UAAU,EAAE,uBAAuB,CAAA;IACnC,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,6BAA6B,CAAA;IACnC,MAAM,EAAE,CACJ,0CAA0C,GAC1C,wCAAwC,CAC3C,EAAE,CAAA;IACH,KAAK,CAAC,EAAE,6BAA6B,EAAE,CAAA;CACxC;AAED,MAAM,WAAW,6BACf,SAAQ,6BAA6B;IACrC,EAAE,EAAE,MAAM,CAAA;CACX;AAED,MAAM,WAAW,0CACf,SAAQ,iCAAiC;IACzC,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,wCACf,SAAQ,iCAAiC;IACzC,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B,UAAU,CAAC,EAAE,uBAAuB,CAAA;IACpC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,IAAI,CAAC,EAAE,6BAA6B,CAAA;IACpC,MAAM,CAAC,EAAE,CACL,0CAA0C,GAC1C,wCAAwC,CAC3C,EAAE,CAAA;IACH,KAAK,CAAC,EAAE,CAAC,6BAA6B,GAAG,6BAA6B,CAAC,EAAE,CAAA;CAC1E;AAED,MAAM,WAAW,8BAA8B;IAC7C,MAAM,CAAC,EAAE,GAAG,EAAE,CAAA;IACd,MAAM,CAAC,EAAE,GAAG,EAAE,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB"}
+{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-option/admin/payloads.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAE9D,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAA;IAC1B;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;;;OAKG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CACzB;AAED,MAAM,WAAW,6BAA6B;IAC5C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED,UAAU,mCAAmC;IAC3C;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;;;OAKG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,MAAM,CAAA;CAClC;AAED,UAAU,iCAAiC;IACzC;;;OAGG;IACH,KAAK,CAAC,EAAE,mCAAmC,EAAE,CAAA;CAC9C;AAED,MAAM,WAAW,0CACf,SAAQ,iCAAiC;IACzC;;;;;OAKG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,wCACf,SAAQ,iCAAiC;IACzC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,yBAAyB;IACxC;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;;;OAKG;IACH,eAAe,EAAE,MAAM,CAAA;IACvB;;;;;OAKG;IACH,mBAAmB,EAAE,MAAM,CAAA;IAC3B;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B;;OAEG;IACH,UAAU,EAAE,uBAAuB,CAAA;IACnC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;;;OAKG;IACH,IAAI,EAAE,6BAA6B,CAAA;IACnC;;OAEG;IACH,MAAM,EAAE,CACJ,0CAA0C,GAC1C,wCAAwC,CAC3C,EAAE,CAAA;IACH;;;;;OAKG;IACH,KAAK,CAAC,EAAE,6BAA6B,EAAE,CAAA;CACxC;AAED,MAAM,WAAW,6BACf,SAAQ,6BAA6B;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX;AAED,MAAM,WAAW,0CACf,SAAQ,iCAAiC;IACzC;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IACX;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,wCACf,SAAQ,iCAAiC;IACzC;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,yBAAyB;IACxC;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B;;OAEG;IACH,UAAU,CAAC,EAAE,uBAAuB,CAAA;IACpC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;;OAKG;IACH,IAAI,CAAC,EAAE,6BAA6B,CAAA;IACpC;;OAEG;IACH,MAAM,CAAC,EAAE,CACL,0CAA0C,GAC1C,wCAAwC,CAC3C,EAAE,CAAA;IACH;;;;;OAKG;IACH,KAAK,CAAC,EAAE,CAAC,6BAA6B,GAAG,6BAA6B,CAAC,EAAE,CAAA;CAC1E;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,MAAM,CAAC,EAAE,GAAG,EAAE,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,GAAG,EAAE,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB"}

package/dist/http/shipping-option/admin/queries.d.ts

@@ -1,17 +1,53 @@
 import { OperatorMap } from "../../../dal";
 import { FindParams } from "../../common";
 export interface AdminShippingOptionListParams extends FindParams {
+    /**
+     * Filter by shipping option ID(s),
+     */
     id?: string | string[];
+    /**
+     * Query or keywords to search the shipping option's searchable fields.
+     */
     q?: string;
+    /**
+     * Filter by the ID of the service zone(s) to retrieve the shipping options for.
+     */
     service_zone_id?: string | string[];
+    /**
+     * Filter by the ID of the stock location(s) to retrieve the shipping options for.
+     */
     stock_location_id?: string | string[];
+    /**
+     * Filter by whether the shipping option is a return shipping option.
+     */
     is_return?: boolean;
+    /**
+     * Filter by whether the shipping option is only available to admins.
+     */
     admin_only?: boolean;
+    /**
+     * Filter by the ID of the shipping profile(s) to retrieve the shipping options for.
+     */
     shipping_profile_id?: string | string[];
+    /**
+     * Filter by the ID of the provider(s) to retrieve the shipping options for.
+     */
     provider_id?: string | string[];
+    /**
+     * Filter by the ID of the shipping option type(s) to retrieve the shipping options for.
+     */
     shipping_option_type_id?: string | string[];
+    /**
+     * Filter by the date the shipping option was created.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Filter by the date the shipping option was updated.
+     */
     updated_at?: OperatorMap<string>;
+    /**
+     * Filter by the date the shipping option was deleted.
+     */
     deleted_at?: OperatorMap<string>;
 }
 //# sourceMappingURL=queries.d.ts.map

package/dist/http/shipping-option/admin/queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-option/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,MAAM,WAAW,6BAA8B,SAAQ,UAAU;IAC/D,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACnC,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACrC,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,mBAAmB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACvC,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/B,uBAAuB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC3C,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/shipping-option/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,MAAM,WAAW,6BAA8B,SAAQ,UAAU;IAC/D;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACnC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACrC;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACvC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/B;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC3C;;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/shipping-option/admin/responses.d.ts

@@ -1,9 +1,15 @@
 import { BatchResponse, DeleteResponse, PaginatedResponse } from "../../common";
 import { AdminShippingOption, AdminShippingOptionRule } from "./entities";
 export interface AdminShippingOptionResponse {
+    /**
+     * The shipping option's details.
+     */
     shipping_option: AdminShippingOption;
 }
 export type AdminShippingOptionListResponse = PaginatedResponse<{
+    /**
+     * The list of shipping options.
+     */
     shipping_options: AdminShippingOption[];
 }>;
 export interface AdminShippingOptionDeleteResponse extends DeleteResponse<"shipping_option"> {

package/dist/http/shipping-option/admin/responses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-option/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAC/E,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAA;AAEzE,MAAM,WAAW,2BAA2B;IAC1C,eAAe,EAAE,mBAAmB,CAAA;CACrC;AAED,MAAM,MAAM,+BAA+B,GAAG,iBAAiB,CAAC;IAC9D,gBAAgB,EAAE,mBAAmB,EAAE,CAAA;CACxC,CAAC,CAAA;AAEF,MAAM,WAAW,iCACf,SAAQ,cAAc,CAAC,iBAAiB,CAAC;CAAG;AAE9C,MAAM,MAAM,sCAAsC,GAChD,aAAa,CAAC,uBAAuB,CAAC,CAAA"}
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-option/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAC/E,OAAO,EAAE,mBAAmB,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAA;AAEzE,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,eAAe,EAAE,mBAAmB,CAAA;CACrC;AAED,MAAM,MAAM,+BAA+B,GAAG,iBAAiB,CAAC;IAC9D;;OAEG;IACH,gBAAgB,EAAE,mBAAmB,EAAE,CAAA;CACxC,CAAC,CAAA;AAEF,MAAM,WAAW,iCACf,SAAQ,cAAc,CAAC,iBAAiB,CAAC;CAAG;AAE9C,MAAM,MAAM,sCAAsC,GAChD,aAAa,CAAC,uBAAuB,CAAC,CAAA"}

package/dist/http/shipping-option/store/payloads.d.ts

@@ -1,5 +1,17 @@
+/**
+ * The details of the price calculation.
+ */
 export type StoreCalculateShippingOptionPrice = {
+    /**
+     * The ID of the cart to calculate the price for.
+     */
     cart_id: string;
+    /**
+     * Additional data passed to the shipping option's fulfillment provider. This is useful
+     * if the third-party fulfillment provider requires additional data to calculate the price.
+     *
+     * Learn more in the [Shipping Option documentation](https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#data-property).
+     */
     data?: Record<string, unknown>;
 };
 //# sourceMappingURL=payloads.d.ts.map

package/dist/http/shipping-option/store/payloads.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-option/store/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,iCAAiC,GAAG;IAC9C,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B,CAAA"}
+{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-option/store/payloads.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC/B,CAAA"}

package/dist/http/shipping-option/store/responses.d.ts

@@ -1,8 +1,20 @@
 import { StoreCartShippingOption } from "../../fulfillment";
+/**
+ * The response of listing the shipping options for a cart.
+ */
 export interface StoreShippingOptionListResponse {
+    /**
+     * The shipping options for the cart.
+     */
     shipping_options: StoreCartShippingOption[];
 }
+/**
+ * The response of calculating the price of a shipping option.
+ */
 export interface StoreShippingOptionResponse {
+    /**
+     * The shipping option's details.
+     */
     shipping_option: StoreCartShippingOption;
 }
 //# sourceMappingURL=responses.d.ts.map

package/dist/http/shipping-option/store/responses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-option/store/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAA;AAE3D,MAAM,WAAW,+BAA+B;IAC9C,gBAAgB,EAAE,uBAAuB,EAAE,CAAA;CAC5C;AAED,MAAM,WAAW,2BAA2B;IAC1C,eAAe,EAAE,uBAAuB,CAAA;CACzC"}
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-option/store/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,mBAAmB,CAAA;AAE3D;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,gBAAgB,EAAE,uBAAuB,EAAE,CAAA;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,eAAe,EAAE,uBAAuB,CAAA;CACzC"}

package/dist/http/shipping-profile/admin/entities.d.ts

@@ -1,10 +1,31 @@
 export interface AdminShippingProfile {
+    /**
+     * The ID of the shipping profile.
+     */
     id: string;
+    /**
+     * The name of the shipping profile.
+     */
     name: string;
+    /**
+     * The type of the shipping profile.
+     */
     type: string;
+    /**
+     * Custom key-value pairs that can be added to the shipping profile.
+     */
     metadata: Record<string, unknown> | null;
+    /**
+     * The date when the shipping profile was created.
+     */
     created_at: string;
+    /**
+     * The date when the shipping profile was updated.
+     */
     updated_at: string;
+    /**
+     * The date when the shipping profile was deleted.
+     */
     deleted_at: string | null;
 }
 //# sourceMappingURL=entities.d.ts.map

package/dist/http/shipping-profile/admin/entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-profile/admin/entities.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B"}
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-profile/admin/entities.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;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,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B"}

package/dist/http/shipping-profile/admin/payloads.d.ts

@@ -1,11 +1,29 @@
 export interface AdminCreateShippingProfile {
+    /**
+     * The name of the shipping profile.
+     */
     name: string;
+    /**
+     * The type of the shipping profile.
+     */
     type: string;
+    /**
+     * Custom key-value pairs that can be added to the shipping profile.
+     */
     metadata?: Record<string, unknown>;
 }
 export interface AdminUpdateShippingProfile {
+    /**
+     * The name of the shipping profile.
+     */
     name?: string;
+    /**
+     * The type of the shipping profile.
+     */
     type?: string;
+    /**
+     * Custom key-value pairs that can be added to the shipping profile.
+     */
     metadata?: Record<string, unknown> | null;
 }
 //# sourceMappingURL=payloads.d.ts.map

package/dist/http/shipping-profile/admin/payloads.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-profile/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C"}
+{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-profile/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C"}

package/dist/http/shipping-profile/admin/queries.d.ts

@@ -1,14 +1,41 @@
 import { OperatorMap } from "../../../dal";
 import { FindParams } from "../../common";
 export interface AdminShippingProfileListParams extends FindParams {
+    /**
+     * Filter by shipping profile ID(s).
+     */
     id?: string | string[];
+    /**
+     * Query or keywords to search the shipping profile's searchable fields.
+     */
     q?: string;
+    /**
+     * Filter by shipping profile type.
+     */
     type?: string;
+    /**
+     * Filter by shipping profile name.
+     */
     name?: string;
+    /**
+     * Filter by the date the shipping profile was created.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Filter by the date the shipping profile was updated.
+     */
     updated_at?: OperatorMap<string>;
+    /**
+     * Filter by the date the shipping profile was deleted.
+     */
     deleted_at?: OperatorMap<string>;
+    /**
+     * An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.
+     */
     $and?: AdminShippingProfileListParams[];
+    /**
+     * An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.
+     */
     $or?: AdminShippingProfileListParams[];
 }
 //# sourceMappingURL=queries.d.ts.map

package/dist/http/shipping-profile/admin/queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-profile/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,MAAM,WAAW,8BAA+B,SAAQ,UAAU;IAChE,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,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;IAChC,IAAI,CAAC,EAAE,8BAA8B,EAAE,CAAA;IACvC,GAAG,CAAC,EAAE,8BAA8B,EAAE,CAAA;CACvC"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-profile/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,MAAM,WAAW,8BAA+B,SAAQ,UAAU;IAChE;;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,CAAA;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;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;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,8BAA8B,EAAE,CAAA;IACvC;;OAEG;IACH,GAAG,CAAC,EAAE,8BAA8B,EAAE,CAAA;CACvC"}

package/dist/http/shipping-profile/admin/responses.d.ts

@@ -1,9 +1,15 @@
 import { DeleteResponse, PaginatedResponse } from "../../common";
 import { AdminShippingProfile } from "./entities";
 export interface AdminShippingProfileResponse {
+    /**
+     * The shipping profile's details.
+     */
     shipping_profile: AdminShippingProfile;
 }
 export type AdminShippingProfileListResponse = PaginatedResponse<{
+    /**
+     * The list of shipping profiles.
+     */
     shipping_profiles: AdminShippingProfile[];
 }>;
 export interface AdminShippingProfileDeleteResponse extends DeleteResponse<"shipping_profile"> {

package/dist/http/shipping-profile/admin/responses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-profile/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAEjD,MAAM,WAAW,4BAA4B;IAC3C,gBAAgB,EAAE,oBAAoB,CAAA;CACvC;AAED,MAAM,MAAM,gCAAgC,GAAG,iBAAiB,CAAC;IAC/D,iBAAiB,EAAE,oBAAoB,EAAE,CAAA;CAC1C,CAAC,CAAA;AAEF,MAAM,WAAW,kCACf,SAAQ,cAAc,CAAC,kBAAkB,CAAC;CAAG"}
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-profile/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAEjD,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,gBAAgB,EAAE,oBAAoB,CAAA;CACvC;AAED,MAAM,MAAM,gCAAgC,GAAG,iBAAiB,CAAC;IAC/D;;OAEG;IACH,iBAAiB,EAAE,oBAAoB,EAAE,CAAA;CAC1C,CAAC,CAAA;AAEF,MAAM,WAAW,kCACf,SAAQ,cAAc,CAAC,kBAAkB,CAAC;CAAG"}

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

@@ -13,12 +13,33 @@ export interface AdminStockLocationAddress {
     province: string | null;
 }
 export interface AdminStockLocation {
+    /**
+     * The ID of the stock location.
+     */
     id: string;
+    /**
+     * The name of the stock location.
+     */
     name: string;
+    /**
+     * The ID of the address associated with the stock location.
+     */
     address_id: string;
+    /**
+     * The address associated with the stock location.
+     */
     address?: AdminStockLocationAddress;
+    /**
+     * The sales channels associated with the stock location.
+     */
     sales_channels?: AdminSalesChannel[];
+    /**
+     * The fulfillment providers associated with the stock location.
+     */
     fulfillment_providers?: AdminFulfillmentProvider[];
+    /**
+     * The fulfillment sets associated with the stock location.
+     */
     fulfillment_sets?: AdminFulfillmentSet[];
 }
 //# sourceMappingURL=entities.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/stock-locations/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAEvD,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,YAAY,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,yBAAyB,CAAA;IACnC,cAAc,CAAC,EAAE,iBAAiB,EAAE,CAAA;IACpC,qBAAqB,CAAC,EAAE,wBAAwB,EAAE,CAAA;IAClD,gBAAgB,CAAC,EAAE,mBAAmB,EAAE,CAAA;CACzC"}
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/stock-locations/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AAEvD,MAAM,WAAW,yBAAyB;IACxC,EAAE,EAAE,MAAM,CAAA;IACV,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,YAAY,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,yBAAyB,CAAA;IACnC;;OAEG;IACH,cAAc,CAAC,EAAE,iBAAiB,EAAE,CAAA;IACpC;;OAEG;IACH,qBAAqB,CAAC,EAAE,wBAAwB,EAAE,CAAA;IAClD;;OAEG;IACH,gBAAgB,CAAC,EAAE,mBAAmB,EAAE,CAAA;CACzC"}