@medusajs/types 2.0.0-rc-20241018141633 → 2.0.0-rc-20241022152047

package/dist/http/fulfillment/admin/entitites.d.ts

@@ -1,15 +1,48 @@
 import { AdminFulfillmentProvider } from "../../fulfillment-provider";
 export interface AdminFulfillmentItem {
+    /**
+     * The fulfillment item's ID.
+     */
     id: string;
+    /**
+     * The fulfillment item's title.
+     */
     title: string;
+    /**
+     * The fulfillment item's quantity.
+     */
     quantity: number;
+    /**
+     * The fulfillment item's SKU.
+     */
     sku: string;
+    /**
+     * The fulfillment item's barcode.
+     */
     barcode: string;
+    /**
+     * The ID of the associated line item in an order.
+     */
     line_item_id: string | null;
+    /**
+     * The ID of the associated inventory item.
+     */
     inventory_item_id: string | null;
+    /**
+     * The ID of the fulfillment that the item belongs to.
+     */
     fulfillment_id: string;
+    /**
+     * The date the fulfillment item was created.
+     */
     created_at: string;
+    /**
+     * The date the fulfillment item was updated.
+     */
     updated_at: string;
+    /**
+     * The date the fulfillment item was deleted.
+     */
     deleted_at: string | null;
 }
 export interface AdminFulfillmentLabel {
@@ -23,40 +56,146 @@ export interface AdminFulfillmentLabel {
     deleted_at: string | null;
 }
 export interface AdminFulfillmentAddress {
+    /**
+     * The address's ID.
+     */
     id: string;
+    /**
+     * The ID of the fulfillment this address belongs to.
+     */
     fulfillment_id: string | null;
+    /**
+     * The address's company.
+     */
     company: string | null;
+    /**
+     * The address's first name.
+     */
     first_name: string | null;
+    /**
+     * The address's last name.
+     */
     last_name: string | null;
+    /**
+     * The address's first line.
+     */
     address_1: string | null;
+    /**
+     * The address's last line.
+     */
     address_2: string | null;
+    /**
+     * The address's city.
+     */
     city: string | null;
+    /**
+     * The address's country code.
+     *
+     * @example
+     * us
+     */
     country_code: string | null;
+    /**
+     * The address's province.
+     */
     province: string | null;
+    /**
+     * The address's postal code.
+     */
     postal_code: string | null;
+    /**
+     * The address's phone number.
+     */
     phone: string | null;
+    /**
+     * Key-value pairs of custom data.
+     */
     metadata: Record<string, unknown> | null;
+    /**
+     * The date the address was created.
+     */
     created_at: string;
+    /**
+     * The date the address was updated.
+     */
     updated_at: string;
+    /**
+     * The date the address was deleted.
+     */
     deleted_at: string | null;
 }
 export interface AdminFulfillment {
+    /**
+     * The fulfillment's ID.
+     */
     id: string;
+    /**
+     * The ID of the stock location the items
+     * are delivered from.
+     */
     location_id: string;
+    /**
+     * The ID of the fulfillment provider
+     * handling the fulfillment.
+     */
     provider_id: string;
+    /**
+     * The ID of the associated shipping option.
+     */
     shipping_option_id: string | null;
+    /**
+     * The associated fulfillment provider's details.
+     */
     provider: AdminFulfillmentProvider;
+    /**
+     * The address to deliver the items to.
+     */
     delivery_address: AdminFulfillmentAddress;
+    /**
+     * The items to fulfill.
+     */
     items: AdminFulfillmentItem[];
+    /**
+     * The fulfillment's labels.
+     */
     labels: AdminFulfillmentLabel[];
+    /**
+     * The date the fulfillment items were packed.
+     */
     packed_at: string | null;
+    /**
+     * The date the fulfillment items were shipped.
+     */
     shipped_at: string | null;
+    /**
+     * The date the fulfillment items were delivered.
+     */
     delivered_at: string | null;
+    /**
+     * The date the fulfillment was canceled.
+     */
     canceled_at: string | null;
+    /**
+     * Data useful for the fulfillment provider handling the fulfillment.
+     *
+     * Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment#data-property).
+     */
     data: Record<string, unknown> | null;
+    /**
+     * Key-value pairs of custom data.
+     */
     metadata: Record<string, unknown> | null;
+    /**
+     * The date the fulfillment was created.
+     */
     created_at: string;
+    /**
+     * The date the fulfillment was updated.
+     */
     updated_at: string;
+    /**
+     * The date the fulfillment was deleted.
+     */
     deleted_at: string | null;
 }
 //# sourceMappingURL=entitites.d.ts.map

package/dist/http/fulfillment/admin/entitites.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entitites.d.ts","sourceRoot":"","sources":["../../../../src/http/fulfillment/admin/entitites.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAErE,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,MAAM,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAA;IACV,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,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;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,QAAQ,EAAE,wBAAwB,CAAA;IAClC,gBAAgB,EAAE,uBAAuB,CAAA;IACzC,KAAK,EAAE,oBAAoB,EAAE,CAAA;IAC7B,MAAM,EAAE,qBAAqB,EAAE,CAAA;IAC/B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACpC,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":"entitites.d.ts","sourceRoot":"","sources":["../../../../src/http/fulfillment/admin/entitites.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AAErE,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAA;IAChC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAA;IACtB;;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,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;IACjB,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB;;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;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;OAEG;IACH,QAAQ,EAAE,wBAAwB,CAAA;IAClC;;OAEG;IACH,gBAAgB,EAAE,uBAAuB,CAAA;IACzC;;OAEG;IACH,KAAK,EAAE,oBAAoB,EAAE,CAAA;IAC7B;;OAEG;IACH,MAAM,EAAE,qBAAqB,EAAE,CAAA;IAC/B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACpC;;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/fulfillment/admin/payloads.d.ts

@@ -1,40 +1,152 @@
 interface AdminCreateFulfillmentItem {
+    /**
+     * The item's name.
+     */
     title: string;
+    /**
+     * The item's SKU.
+     */
     sku: string;
+    /**
+     * The item's quantity.
+     */
     quantity: number;
+    /**
+     * The item's barcode.
+     */
     barcode: string;
+    /**
+     * The ID of the associated line item in an order.
+     */
     line_item_id?: string;
+    /**
+     * The ID of the associated inventory item.
+     */
     inventory_item_id?: string;
 }
 interface AdminCreateFulfillmentLabel {
+    /**
+     * The tracking number of the fulfillment's shipment.
+     */
     tracking_number: string;
+    /**
+     * The tracking URL of the fulfillment's shipment.
+     */
     tracking_url: string;
+    /**
+     * The label URL of the fulfillment's shipment.
+     */
     label_url: string;
 }
 interface AdminFulfillmentDeliveryAddress {
+    /**
+     * The address's first name.
+     */
     first_name?: string;
+    /**
+     * The address's last name.
+     */
     last_name?: string;
+    /**
+     * The address's phone number.
+     */
     phone?: string;
+    /**
+     * The address's company.
+     */
     company?: string;
+    /**
+     * The address's first line.
+     */
     address_1?: string;
+    /**
+     * The address's second line.
+     */
     address_2?: string;
+    /**
+     * The address's city.
+     */
     city?: string;
+    /**
+     * The address's country code.
+     *
+     * @example
+     * us
+     */
     country_code?: string;
+    /**
+     * The address's province.
+     */
     province?: string;
+    /**
+     * The address's postal code.
+     */
     postal_code?: string;
+    /**
+     * Key-value pairs of custom data.
+     */
     metadata?: Record<string, string> | null;
 }
 export interface AdminCreateFulfillment {
+    /**
+     * The ID of the location the items are fulfilled from.
+     */
     location_id: string;
+    /**
+     * The ID of the fulfillment provider used to handle the fulfillment.
+     */
     provider_id: string;
+    /**
+     * The address to deliver items to.
+     */
     delivery_address: AdminFulfillmentDeliveryAddress;
+    /**
+     * The items to fulfill.
+     */
     items: AdminCreateFulfillmentItem[];
+    /**
+     * The fulfillment's shipment labels.
+     */
     labels: AdminCreateFulfillmentLabel[];
-    order: Record<string, unknown>;
+    /**
+     * The ID of the order the fulfillment is created for.
+     */
     order_id: string;
+    /**
+     * The ID of the associated shipping option.
+     */
+    shipping_option_id?: string | null;
+    /**
+     * Data useful for the fulfillment provider handling the fulfillment.
+     *
+     * Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment#data-property).
+     */
+    data?: Record<string, unknown> | null;
+    /**
+     * The date the fulfillment items were packed.
+     */
+    packed_at?: Date | null;
+    /**
+     * The date the fulfillment items were shipped.
+     */
+    shipped_at?: Date | null;
+    /**
+     * The date the fulfillment items were delivered.
+     */
+    delivered_at?: Date | null;
+    /**
+     * The date the fulfillment was canceled.
+     */
+    canceled_at?: Date | null;
+    /**
+     * Key-value pairs of custom data.
+     */
     metadata?: Record<string, unknown> | null;
 }
 export interface AdminCreateFulfillmentShipment {
+    /**
+     * The shipment's labels.
+     */
     labels: AdminCreateFulfillmentLabel[];
 }
 export {};

package/dist/http/fulfillment/admin/payloads.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/fulfillment/admin/payloads.ts"],"names":[],"mappings":"AAAA,UAAU,0BAA0B;IAClC,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED,UAAU,2BAA2B;IACnC,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,UAAU,+BAA+B;IACvC,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAA;CACzC;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,gBAAgB,EAAE,+BAA+B,CAAA;IACjD,KAAK,EAAE,0BAA0B,EAAE,CAAA;IACnC,MAAM,EAAE,2BAA2B,EAAE,CAAA;IAIrC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,2BAA2B,EAAE,CAAA;CACtC"}
+{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/fulfillment/admin/payloads.ts"],"names":[],"mappings":"AAAA,UAAU,0BAA0B;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;CAC3B;AAED,UAAU,2BAA2B;IACnC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,UAAU,+BAA+B;IACvC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAA;CACzC;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,gBAAgB,EAAE,+BAA+B,CAAA;IACjD;;OAEG;IACH,KAAK,EAAE,0BAA0B,EAAE,CAAA;IACnC;;OAEG;IACH,MAAM,EAAE,2BAA2B,EAAE,CAAA;IACrC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAClC;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACrC;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACvB;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAC1B;;OAEG;IACH,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,MAAM,EAAE,2BAA2B,EAAE,CAAA;CACtC"}

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

@@ -1,5 +1,8 @@
 import { AdminFulfillment } from "./entitites";
 export interface AdminFulfillmentResponse {
+    /**
+     * The fulfillment's details.
+     */
     fulfillment: AdminFulfillment;
 }
 //# sourceMappingURL=responses.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/fulfillment/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAE9C,MAAM,WAAW,wBAAwB;IACvC,WAAW,EAAE,gBAAgB,CAAA;CAC9B"}
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/fulfillment/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAE9C,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,WAAW,EAAE,gBAAgB,CAAA;CAC9B"}

package/dist/http/fulfillment/store/index.d.ts

@@ -1,21 +1,74 @@
+import { ShippingOptionPriceType } from "../../../fulfillment";
 export interface StoreCartShippingOption {
+    /**
+     * The shipping option's ID.
+     */
     id: string;
+    /**
+     * The shipping option's name.
+     */
     name: string;
-    price_type: string;
+    /**
+     * The type of the shipping option's price. `flat` means the price
+     * is fixed, whereas `calculated` means the price is calculated by the
+     * associated fulfillment provider.
+     */
+    price_type: ShippingOptionPriceType;
+    /**
+     * The ID of the associated service zone.
+     */
     service_zone_id: string;
+    /**
+     * The ID of the associated shipping profile.
+     */
     shipping_profile_id: string;
+    /**
+     * The ID of the fulfillment provider used to handle shipping.
+     */
     provider_id: string;
+    /**
+     * The data useful for the fulfillment provider when handling the shipment and fulfillment.
+     *
+     * Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property).
+     */
     data: Record<string, unknown> | null;
+    /**
+     * The shipping option's type.
+     */
     type: {
+        /**
+         * The type's ID.
+         */
         id: string;
+        /**
+         * The type's label.
+         */
         label: string;
+        /**
+         * The type's description.
+         */
         description: string;
+        /**
+         * The type's code.
+         */
         code: string;
     };
+    /**
+     * The details of the associated fulfillment provider.
+     */
     provider: {
+        /**
+         * The fulfillment provider's ID.
+         */
         id: string;
+        /**
+         * Whether the fulfillment provider is enabled.
+         */
         is_enabled: boolean;
     };
+    /**
+     * The shipping option's amount.
+     */
     amount: number;
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/http/fulfillment/store/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/http/fulfillment/store/index.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,MAAM,CAAA;IAClB,eAAe,EAAE,MAAM,CAAA;IACvB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACpC,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAA;QACV,KAAK,EAAE,MAAM,CAAA;QACb,WAAW,EAAE,MAAM,CAAA;QACnB,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;IACD,QAAQ,EAAE;QACR,EAAE,EAAE,MAAM,CAAA;QACV,UAAU,EAAE,OAAO,CAAA;KACpB,CAAA;IACD,MAAM,EAAE,MAAM,CAAA;CACf"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/http/fulfillment/store/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAI9D,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;;OAIG;IACH,UAAU,EAAE,uBAAuB,CAAA;IACnC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAA;IAC3B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACpC;;OAEG;IACH,IAAI,EAAE;QACJ;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;QACV;;WAEG;QACH,KAAK,EAAE,MAAM,CAAA;QACb;;WAEG;QACH,WAAW,EAAE,MAAM,CAAA;QACnB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;IACD;;OAEG;IACH,QAAQ,EAAE;QACR;;WAEG;QACH,EAAE,EAAE,MAAM,CAAA;QACV;;WAEG;QACH,UAAU,EAAE,OAAO,CAAA;KACpB,CAAA;IACD;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf"}

package/dist/http/fulfillment-provider/admin/queries.d.ts

@@ -1,8 +1,21 @@
 import { FindParams } from "../../common";
 export interface AdminFulfillmentProviderListParams extends FindParams {
+    /**
+     * Filter by provider ID(s).
+     */
     id?: string | string[];
+    /**
+     * Query or keywords to filter the provider's searchable fields.
+     */
     q?: string;
+    /**
+     * Filter by whether the provider is enabled.
+     */
     is_enabled?: boolean;
+    /**
+     * Filter by stock location ID(s) to retrieve their associated
+     * fulfillment providers.
+     */
     stock_location_id?: string | string[];
 }
 //# sourceMappingURL=queries.d.ts.map

package/dist/http/fulfillment-provider/admin/queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/fulfillment-provider/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,MAAM,WAAW,kCAAmC,SAAQ,UAAU;IACpE,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CACtC"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/fulfillment-provider/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AAEzC,MAAM,WAAW,kCAAmC,SAAQ,UAAU;IACpE;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CACtC"}

package/dist/http/fulfillment-provider/admin/responses.d.ts

@@ -1,6 +1,9 @@
 import { PaginatedResponse } from "../../common";
 import { AdminFulfillmentProvider } from "./entities";
 export interface AdminFulfillmentProviderListResponse extends PaginatedResponse<{
+    /**
+     * The list of fulfillment providers.
+     */
     fulfillment_providers: AdminFulfillmentProvider[];
 }> {
 }

package/dist/http/fulfillment-provider/admin/responses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/fulfillment-provider/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAA;AAErD,MAAM,WAAW,oCACf,SAAQ,iBAAiB,CAAC;IACxB,qBAAqB,EAAE,wBAAwB,EAAE,CAAA;CAClD,CAAC;CAAG"}
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/fulfillment-provider/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAA;AAErD,MAAM,WAAW,oCACf,SAAQ,iBAAiB,CAAC;IACxB;;OAEG;IACH,qBAAqB,EAAE,wBAAwB,EAAE,CAAA;CAClD,CAAC;CAAG"}

package/dist/http/fulfillment-provider/common.d.ts

@@ -1,5 +1,11 @@
 export interface BaseFulfillmentProvider {
+    /**
+     * The fulfillment provider's ID.
+     */
     id: string;
+    /**
+     * Whether the fulfillment provider is enabled.
+     */
     is_enabled: boolean;
 }
 //# sourceMappingURL=common.d.ts.map

package/dist/http/fulfillment-provider/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/fulfillment-provider/common.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,OAAO,CAAA;CACpB"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/fulfillment-provider/common.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,UAAU,EAAE,OAAO,CAAA;CACpB"}

package/dist/http/fulfillment-set/admin/entities.d.ts

@@ -2,35 +2,119 @@ import { GeoZoneType } from "../../../fulfillment";
 import { AdminShippingOption } from "../../shipping-option";
 import { AdminStockLocation } from "../../stock-locations";
 export interface AdminGeoZone {
+    /**
+     * The geo zone's ID.
+     */
     id: string;
+    /**
+     * The geo zone's type.
+     */
     type: GeoZoneType;
+    /**
+     * The geo zone's country code.
+     *
+     * @example
+     * us
+     */
     country_code: string;
+    /**
+     * The geo zone's province code.
+     */
     province_code: string | null;
+    /**
+     * The geo zone's city.
+     */
     city: string | null;
+    /**
+     * The geo zone's postal expression.
+     */
     postal_expression: Record<string, unknown> | null;
+    /**
+     * The date the geo zone was created.
+     */
     created_at: string;
+    /**
+     * The date the geo zone was updated.
+     */
     updated_at: string;
+    /**
+     * The date the geo zone was deleted.
+     */
     deleted_at: string | null;
 }
 export interface AdminServiceZone {
+    /**
+     * The service zone's ID.
+     */
     id: string;
+    /**
+     * The service zone's name.
+     */
     name: string;
+    /**
+     * The ID of the fulfillment set this service zone belongs to.
+     */
     fulfillment_set_id: string;
+    /**
+     * The fulfillment set this service zone belongs to.
+     */
     fulfillment_set: AdminFulfillmentSet;
+    /**
+     * The service zone's geo zones.
+     */
     geo_zones: AdminGeoZone[];
+    /**
+     * The shipping options that can be used in this service zone.
+     */
     shipping_options: AdminShippingOption[];
+    /**
+     * The date the service zone is created.
+     */
     created_at: string;
+    /**
+     * The date the service zone is updated.
+     */
     updated_at: string;
+    /**
+     * The date the service zone is deleted.
+     */
     deleted_at: string | null;
 }
 export interface AdminFulfillmentSet {
+    /**
+     * The fulfillment set's ID.
+     */
     id: string;
+    /**
+     * The fulfillment set's name.
+     */
     name: string;
+    /**
+     * The fulfillment set's type.
+     *
+     * @example
+     * delivery
+     */
     type: string;
+    /**
+     * The stock location associated with this fulfillment set.
+     */
     location: AdminStockLocation;
+    /**
+     * The fulfillment set's service zones.
+     */
     service_zones: AdminServiceZone[];
+    /**
+     * The date the fulfillment set is created.
+     */
     created_at: string;
+    /**
+     * The date the fulfillment set is updated.
+     */
     updated_at: string;
+    /**
+     * The date the fulfillment set is deleted.
+     */
     deleted_at: string | null;
 }
 //# sourceMappingURL=entities.d.ts.map

package/dist/http/fulfillment-set/admin/entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/fulfillment-set/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAE1D,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,WAAW,CAAA;IACjB,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACjD,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,kBAAkB,EAAE,MAAM,CAAA;IAC1B,eAAe,EAAE,mBAAmB,CAAA;IACpC,SAAS,EAAE,YAAY,EAAE,CAAA;IACzB,gBAAgB,EAAE,mBAAmB,EAAE,CAAA;IACvC,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,kBAAkB,CAAA;IAC5B,aAAa,EAAE,gBAAgB,EAAE,CAAA;IACjC,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/fulfillment-set/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAA;AAClD,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAE1D,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,EAAE,WAAW,CAAA;IACjB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACjD;;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,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAC1B;;OAEG;IACH,eAAe,EAAE,mBAAmB,CAAA;IACpC;;OAEG;IACH,SAAS,EAAE,YAAY,EAAE,CAAA;IACzB;;OAEG;IACH,gBAAgB,EAAE,mBAAmB,EAAE,CAAA;IACvC;;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,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,QAAQ,EAAE,kBAAkB,CAAA;IAC5B;;OAEG;IACH,aAAa,EAAE,gBAAgB,EAAE,CAAA;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B"}