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

package/dist/http/return-reason/admin/queries.d.ts

@@ -2,6 +2,9 @@ import { BaseFilterable, OperatorMap } from "../../../dal";
 import { SelectParams } from "../../common";
 import { BaseReturnReasonListParams } from "../common";
 export interface AdminReturnReasonListParams extends BaseReturnReasonListParams, BaseFilterable<AdminReturnReasonListParams> {
+    /**
+     * Apply filters on the return reason's deletion date.
+     */
     deleted_at?: OperatorMap<string>;
 }
 export interface AdminReturnReasonParams extends SelectParams {

package/dist/http/return-reason/admin/queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/return-reason/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAA;AAEtD,MAAM,WAAW,2BACf,SAAQ,0BAA0B,EAChC,cAAc,CAAC,2BAA2B,CAAC;IAC7C,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,uBAAwB,SAAQ,YAAY;CAAG"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/return-reason/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAC3C,OAAO,EAAE,0BAA0B,EAAE,MAAM,WAAW,CAAA;AAEtD,MAAM,WAAW,2BACf,SAAQ,0BAA0B,EAChC,cAAc,CAAC,2BAA2B,CAAC;IAC7C;;OAEG;IACH,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,uBAAwB,SAAQ,YAAY;CAAG"}

package/dist/http/return-reason/admin/responses.d.ts

@@ -1,9 +1,15 @@
 import { DeleteResponse, PaginatedResponse } from "../../common";
 import { AdminReturnReason } from "../admin";
 export interface AdminReturnReasonResponse {
+    /**
+     * The return reason's details.
+     */
     return_reason: AdminReturnReason;
 }
 export interface AdminReturnReasonListResponse extends PaginatedResponse<{
+    /**
+     * The list of return reasons.
+     */
     return_reasons: AdminReturnReason[];
 }> {
 }

package/dist/http/return-reason/admin/responses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/return-reason/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAE5C,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,iBAAiB,CAAA;CACjC;AAED,MAAM,WAAW,6BACf,SAAQ,iBAAiB,CAAC;IACxB,cAAc,EAAE,iBAAiB,EAAE,CAAA;CACpC,CAAC;CAAG;AAEP,MAAM,WAAW,+BACf,SAAQ,cAAc,CAAC,eAAe,CAAC;CAAG"}
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/return-reason/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAE5C,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAA;CACjC;AAED,MAAM,WAAW,6BACf,SAAQ,iBAAiB,CAAC;IACxB;;OAEG;IACH,cAAc,EAAE,iBAAiB,EAAE,CAAA;CACpC,CAAC;CAAG;AAEP,MAAM,WAAW,+BACf,SAAQ,cAAc,CAAC,eAAe,CAAC;CAAG"}

package/dist/http/return-reason/common.d.ts

@@ -1,12 +1,39 @@
 import { OperatorMap } from "../../dal";
 import { FindParams } from "../common";
 export interface BaseReturnReason {
+    /**
+     * The return reason's ID.
+     */
     id: string;
+    /**
+     * The return reason's value.
+     *
+     * @example
+     * "refund"
+     */
     value: string;
+    /**
+     * The return reason's label.
+     *
+     * @example
+     * "Refund"
+     */
     label: string;
+    /**
+     * The return reason's description.
+     */
     description?: string | null;
+    /**
+     * Custom key-value pairs that can be added to the return reason.
+     */
     metadata?: Record<string, any> | null;
+    /**
+     * The date that the return reason was created.
+     */
     created_at: string;
+    /**
+     * The date that the return reason was updated.
+     */
     updated_at: string;
 }
 export interface BaseReturnReasonListParams extends FindParams {

package/dist/http/return-reason/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/return-reason/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAEtC,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;IACrC,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,0BAA2B,SAAQ,UAAU;IAC5D,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACpC,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACpC,WAAW,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC1C,uBAAuB,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACjE,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/return-reason/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAEtC,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;IACrC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,0BAA2B,SAAQ,UAAU;IAC5D,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACpC,KAAK,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IACpC,WAAW,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC1C,uBAAuB,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACjE,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;IAChC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC"}

package/dist/http/sales-channel/admin/entities.d.ts

@@ -1,11 +1,35 @@
 export interface AdminSalesChannel {
+    /**
+     * The sales channel's ID.
+     */
     id: string;
+    /**
+     * The sales channel's name.
+     */
     name: string;
+    /**
+     * The sales channel's description.
+     */
     description: string | null;
+    /**
+     * Whether the sales channel is disabled.
+     */
     is_disabled: boolean;
+    /**
+     * Custom key-value pairs that can be added to the sales channel.
+     */
     metadata: Record<string, unknown> | null;
+    /**
+     * The sales channel's creation date.
+     */
     created_at: string;
+    /**
+     * The sales channel's last updated date.
+     */
     updated_at: string;
+    /**
+     * The sales channel's deletion date.
+     */
     deleted_at: string | null;
 }
 //# sourceMappingURL=entities.d.ts.map

package/dist/http/sales-channel/admin/entities.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/sales-channel/admin/entities.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,WAAW,EAAE,OAAO,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"}
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/sales-channel/admin/entities.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B;;OAEG;IACH,WAAW,EAAE,OAAO,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"}

package/dist/http/sales-channel/admin/payloads.d.ts

@@ -1,17 +1,49 @@
 export interface AdminCreateSalesChannel {
+    /**
+     * The sales channel's name.
+     */
     name: string;
+    /**
+     * The sales channel's description.
+     */
     description?: string;
+    /**
+     * Whether the sales channel is disabled.
+     *
+     * @defaultValue `false`
+     */
     is_disabled?: boolean;
+    /**
+     * Custom key-value pairs that can be added to the sales channel.
+     */
     metadata?: Record<string, unknown>;
 }
 export interface AdminUpdateSalesChannel {
+    /**
+     * The sales channel's name.
+     */
     name?: string;
+    /**
+     * The sales channel's description.
+     */
     description?: string | null;
+    /**
+     * Whether the sales channel is disabled.
+     */
     is_disabled?: boolean;
+    /**
+     * Custom key-value pairs that can be added to the sales channel.
+     */
     metadata?: Record<string, unknown>;
 }
 export interface AdminUpdateSalesChannelProducts {
+    /**
+     * The IDs of the products to add to the sales channel.
+     */
     add?: string[];
+    /**
+     * The IDs of the products to remove from the sales channel.
+     */
     remove?: string[];
 }
 //# sourceMappingURL=payloads.d.ts.map

package/dist/http/sales-channel/admin/payloads.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/sales-channel/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,uBAAuB;IACtC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,+BAA+B;IAC9C,GAAG,CAAC,EAAE,MAAM,EAAE,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB"}
+{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/sales-channel/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,EAAE,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB"}

package/dist/http/sales-channel/admin/queries.d.ts

@@ -1,15 +1,47 @@
 import { BaseFilterable, OperatorMap } from "../../../dal";
 import { FindParams } from "../../common";
 export interface AdminSalesChannelListParams extends FindParams, BaseFilterable<AdminSalesChannelListParams> {
+    /**
+     * Filter by sales channel ID(s).
+     */
     id?: string | string[];
+    /**
+     * Query or keywords to search the sales channel's searchable fields.
+     */
     q?: string;
+    /**
+     * Filter by sales channel name.
+     */
     name?: string | string[];
+    /**
+     * Filter by sales channel description.
+     */
     description?: string;
+    /**
+     * Filter by whether the sales channel is disabled.
+     */
     is_disabled?: boolean;
+    /**
+     * Filter by the ID(s) of the location(s) to retrieve the
+     * sales channels for.
+     */
     location_id?: string | string[];
+    /**
+     * Filter by the ID(s) of the publishable key(s) to retrieve the
+     * sales channels for.
+     */
     publishable_key_id?: string | string[];
+    /**
+     * Filter by the date when the sales channel was created.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Filter by the date when the sales channel was updated.
+     */
     updated_at?: OperatorMap<string>;
+    /**
+     * Filter by the date when the sales channel was deleted.
+     */
     deleted_at?: OperatorMap<string>;
 }
 //# sourceMappingURL=queries.d.ts.map

package/dist/http/sales-channel/admin/queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/sales-channel/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,2BACf,SAAQ,UAAU,EAChB,cAAc,CAAC,2BAA2B,CAAC;IAC7C,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/B,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtC,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/sales-channel/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,2BACf,SAAQ,UAAU,EAChB,cAAc,CAAC,2BAA2B,CAAC;IAC7C;;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,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/B;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtC;;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/sales-channel/admin/responses.d.ts

@@ -1,9 +1,15 @@
 import { DeleteResponse, PaginatedResponse } from "../../common";
 import { AdminSalesChannel } from "./entities";
 export interface AdminSalesChannelResponse {
+    /**
+     * The sales channel's details.
+     */
     sales_channel: AdminSalesChannel;
 }
 export type AdminSalesChannelListResponse = PaginatedResponse<{
+    /**
+     * The list of sales channels.
+     */
     sales_channels: AdminSalesChannel[];
 }>;
 export interface AdminSalesChannelDeleteResponse extends DeleteResponse<"sales-channel"> {

package/dist/http/sales-channel/admin/responses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/sales-channel/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAE9C,MAAM,WAAW,yBAAyB;IACxC,aAAa,EAAE,iBAAiB,CAAA;CACjC;AAED,MAAM,MAAM,6BAA6B,GAAG,iBAAiB,CAAC;IAC5D,cAAc,EAAE,iBAAiB,EAAE,CAAA;CACpC,CAAC,CAAA;AAEF,MAAM,WAAW,+BACf,SAAQ,cAAc,CAAC,eAAe,CAAC;CAAG"}
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/sales-channel/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAE9C,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAA;CACjC;AAED,MAAM,MAAM,6BAA6B,GAAG,iBAAiB,CAAC;IAC5D;;OAEG;IACH,cAAc,EAAE,iBAAiB,EAAE,CAAA;CACpC,CAAC,CAAA;AAEF,MAAM,WAAW,+BACf,SAAQ,cAAc,CAAC,eAAe,CAAC;CAAG"}

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

@@ -5,58 +5,245 @@ import { AdminServiceZone } from "../../fulfillment-set";
 import { AdminPrice } from "../../pricing";
 import { AdminShippingProfile } from "../../shipping-profile";
 export interface AdminShippingOptionType {
+    /**
+     * The ID of the shipping option type.
+     */
     id: string;
+    /**
+     * 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;
+    /**
+     * The ID of the shipping option that this type is created for.
+     */
     shipping_option_id: string;
+    /**
+     * The date when the shipping option type was created.
+     */
     created_at: string;
+    /**
+     * The date when the shipping option type was updated.
+     */
     updated_at: string;
+    /**
+     * The date when the shipping option type was deleted.
+     */
     deleted_at: string | null;
 }
 export interface AdminShippingOptionRule {
+    /**
+     * The ID of the shipping option rule.
+     */
     id: string;
+    /**
+     * The attribute of the shipping option rule.
+     *
+     * @example
+     * "enabled_in_store"
+     */
     attribute: string;
+    /**
+     * The operator of the shipping option rule.
+     *
+     * @example
+     * "eq"
+     */
     operator: RuleOperatorType;
+    /**
+     * The value of the shipping option rule.
+     *
+     * @example
+     * "true"
+     */
     value: string | string[] | null;
+    /**
+     * The ID of the shipping option that this rule is created for.
+     */
     shipping_option_id: string;
+    /**
+     * The date when the shipping option rule was created.
+     */
     created_at: string;
+    /**
+     * The date when the shipping option rule was updated.
+     */
     updated_at: string;
+    /**
+     * The date when the shipping option rule was deleted.
+     */
     deleted_at: string | null;
 }
+/**
+ * @privateRemarks
+ *
+ * TODO: This type is complete, but it's not clear what the `rules` field is supposed to return in all cases.
+ */
 export interface AdminShippingOptionPriceRule {
+    /**
+     * The ID of the shipping option price rule.
+     */
     id: string;
+    /**
+     * The value of the shipping option price rule.
+     *
+     * @example
+     * "region_123"
+     */
     value: string | number;
+    /**
+     * The operator of the shipping option price rule.
+     *
+     * @example
+     * "eq"
+     */
     operator: RuleOperatorType;
+    /**
+     * The attribute of the shipping option price rule.
+     *
+     * @example
+     * "region_id"
+     */
     attribute: string;
+    /**
+     * The ID of the shipping option price that this rule is created for.
+     */
     price_id: string;
+    /**
+     * The priority of the shipping option price rule.
+     */
     priority: number;
+    /**
+     * The date when the shipping option price rule was created.
+     */
     created_at: string;
+    /**
+     * The date when the shipping option price rule was updated.
+     */
     updated_at: string;
+    /**
+     * The date when the shipping option price rule was deleted.
+     */
     deleted_at: string | null;
 }
 export interface AdminShippingOptionPrice extends AdminPrice {
+    /**
+     * The rules of the shipping option price.
+     */
     price_rules: AdminShippingOptionPriceRule[];
+    /**
+     * The number of rules of the shipping option price.
+     */
     rules_count: number;
 }
 export interface AdminShippingOption {
+    /**
+     * The shipping option's ID.
+     */
     id: string;
+    /**
+     * The shipping option's name. Customers can
+     * see this name during checkout.
+     *
+     * @example
+     * "Standard Shipping"
+     */
     name: string;
+    /**
+     * The type of shipping option's price.
+     */
     price_type: ShippingOptionPriceType;
+    /**
+     * 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 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: AdminServiceZone;
+    /**
+     * The ID of the fulfillment provider that the shipping option belongs to.
+     */
     provider_id: string;
+    /**
+     * The fulfillment provider that the shipping option belongs to.
+     */
     provider: AdminFulfillmentProvider;
+    /**
+     * The ID of the shipping option's type.
+     *
+     * Learn more in the [Shipping Options](https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#shipping-profile-and-types)
+     * documentation.
+     */
     shipping_option_type_id: string | null;
+    /**
+     * The shipping option's type.
+     *
+     * Learn more in the [Shipping Options](https://docs.medusajs.com/resources/commerce-modules/fulfillment/shipping-option#shipping-profile-and-types)
+     * documentation.
+     */
     type: AdminShippingOptionType;
+    /**
+     * 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 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: AdminShippingProfile;
+    /**
+     * 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: AdminShippingOptionRule[];
+    /**
+     * The prices of the shipping option.
+     */
     prices: AdminShippingOptionPrice[];
+    /**
+     * 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> | null;
+    /**
+     * Custom key-value pairs that can be added to the shipping option.
+     */
     metadata: Record<string, unknown> | null;
+    /**
+     * The date when the shipping option was created.
+     */
     created_at: Date;
+    /**
+     * The date when the shipping option was updated.
+     */
     updated_at: Date;
+    /**
+     * The date when the shipping option was deleted.
+     */
     deleted_at: Date | null;
 }
 //# sourceMappingURL=entities.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-option/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAE7D,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,kBAAkB,EAAE,MAAM,CAAA;IAC1B,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,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;IAC/B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAGD,MAAM,WAAW,4BAA4B;IAC3C,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB,QAAQ,EAAE,gBAAgB,CAAA;IAC1B,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,wBAAyB,SAAQ,UAAU;IAC1D,WAAW,EAAE,4BAA4B,EAAE,CAAA;IAC3C,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,uBAAuB,CAAA;IACnC,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,gBAAgB,CAAA;IAC9B,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,wBAAwB,CAAA;IAClC,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,IAAI,EAAE,uBAAuB,CAAA;IAC7B,mBAAmB,EAAE,MAAM,CAAA;IAC3B,gBAAgB,EAAE,oBAAoB,CAAA;IACtC,KAAK,EAAE,uBAAuB,EAAE,CAAA;IAChC,MAAM,EAAE,wBAAwB,EAAE,CAAA;IAClC,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,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,CAAA;IAChB,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB"}
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/shipping-option/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAClD,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAA;AAC9D,OAAO,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAA;AACrE,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAC1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAA;AAE7D,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAC1B;;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,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;;;OAKG;IACH,QAAQ,EAAE,gBAAgB,CAAA;IAC1B;;;;;OAKG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;IAC/B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAC1B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;;;;OAKG;IACH,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;IACtB;;;;;OAKG;IACH,QAAQ,EAAE,gBAAgB,CAAA;IAC1B;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;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,wBAAyB,SAAQ,UAAU;IAC1D;;OAEG;IACH,WAAW,EAAE,4BAA4B,EAAE,CAAA;IAC3C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;;;;;OAMG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;OAEG;IACH,UAAU,EAAE,uBAAuB,CAAA;IACnC;;;;;OAKG;IACH,eAAe,EAAE,MAAM,CAAA;IACvB;;;;;OAKG;IACH,YAAY,EAAE,gBAAgB,CAAA;IAC9B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,QAAQ,EAAE,wBAAwB,CAAA;IAClC;;;;;OAKG;IACH,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC;;;;;OAKG;IACH,IAAI,EAAE,uBAAuB,CAAA;IAC7B;;;;;OAKG;IACH,mBAAmB,EAAE,MAAM,CAAA;IAC3B;;;;;OAKG;IACH,gBAAgB,EAAE,oBAAoB,CAAA;IACtC;;;;;OAKG;IACH,KAAK,EAAE,uBAAuB,EAAE,CAAA;IAChC;;OAEG;IACH,MAAM,EAAE,wBAAwB,EAAE,CAAA;IAClC;;;;;;OAMG;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,IAAI,CAAA;IAChB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAChB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB"}