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

package/dist/http/customer-group/admin/queries.d.ts

@@ -1,31 +1,86 @@
 import { BaseFilterable, OperatorMap } from "../../../dal";
 import { FindParams, SelectParams } from "../../common";
 export interface AdminCustomerInGroupFilters {
+    /**
+     * Filter by customer ID(s).
+     */
     id?: string | string[];
+    /**
+     * Filter by email(s).
+     */
     email?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter by IDs of default billing addresses to retrieve
+     * their associated customers.
+     */
     default_billing_address_id?: string | string[];
+    /**
+     * Filter by IDs of default shipping addresses to retrieve
+     * their associated customers.
+     */
     default_shipping_address_id?: string | string[];
+    /**
+     * Filter by company name(s).
+     */
     company_name?: string | string[];
+    /**
+     * Filter by first name(s).
+     */
     first_name?: string | string[];
+    /**
+     * Filter by last name(s).
+     */
     last_name?: string | string[];
+    /**
+     * Filter by user IDs to retrieve the customers they created.
+     */
     created_by?: string | string[];
+    /**
+     * Apply filters on the customer's creation date.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Apply filters on the customer's update date.
+     */
     updated_at?: OperatorMap<string>;
+    /**
+     * Apply filters on the customer's deletion date.
+     */
     deleted_at?: OperatorMap<string>;
 }
 export interface AdminGetCustomerGroupsParams extends FindParams, BaseFilterable<AdminGetCustomerGroupsParams> {
-    limit?: number;
-    offset?: number;
+    /**
+     * Query or keywords to search the customer group's searchable fields.
+     */
     q?: string;
+    /**
+     * Filter by customer group ID(s).
+     */
     id?: string | string[];
+    /**
+     * Filter by name(s).
+     */
     name?: string | string[];
+    /**
+     * Filter by customers to retrieve their associated groups.
+     */
     customers?: string | string[] | AdminCustomerInGroupFilters;
+    /**
+     * Filter by IDs of users to retrieve the groups they created.
+     */
     created_by?: string | string[];
+    /**
+     * Apply filters on the group's creation date.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Apply filters on the group's update date.
+     */
     updated_at?: OperatorMap<string>;
+    /**
+     * Apply filters on the group's deletion date.
+     */
     deleted_at?: OperatorMap<string>;
-    $and?: AdminGetCustomerGroupsParams[];
-    $or?: AdminGetCustomerGroupsParams[];
 }
 export interface AdminGetCustomerGroupParams extends SelectParams {
 }

package/dist/http/customer-group/admin/queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/customer-group/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAEvD,MAAM,WAAW,2BAA2B;IAC1C,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC/C,0BAA0B,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC9C,2BAA2B,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/C,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAChC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC9B,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC7B,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC9B,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;AAED,MAAM,WAAW,4BACf,SAAQ,UAAU,EAChB,cAAc,CAAC,4BAA4B,CAAC;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,2BAA2B,CAAA;IAC3D,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC9B,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,4BAA4B,EAAE,CAAA;IACrC,GAAG,CAAC,EAAE,4BAA4B,EAAE,CAAA;CACrC;AAED,MAAM,WAAW,2BAA4B,SAAQ,YAAY;CAAG"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/customer-group/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAEvD,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC/C;;;OAGG;IACH,0BAA0B,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC9C;;;OAGG;IACH,2BAA2B,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/C;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAChC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC9B;;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;AAED,MAAM,WAAW,4BACf,SAAQ,UAAU,EAChB,cAAc,CAAC,4BAA4B,CAAC;IAC9C;;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;IACxB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,2BAA2B,CAAA;IAC3D;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC9B;;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;AAED,MAAM,WAAW,2BAA4B,SAAQ,YAAY;CAAG"}

package/dist/http/customer-group/admin/responses.d.ts

@@ -1,9 +1,15 @@
 import { PaginatedResponse } from "../../common";
 import { AdminCustomerGroup } from "./entities";
 export interface AdminCustomerGroupResponse {
+    /**
+     * The customer group's details.
+     */
     customer_group: AdminCustomerGroup;
 }
 export type AdminCustomerGroupListResponse = PaginatedResponse<{
+    /**
+     * The list of customer groups.
+     */
     customer_groups: AdminCustomerGroup[];
 }>;
 //# sourceMappingURL=responses.d.ts.map

package/dist/http/customer-group/admin/responses.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/customer-group/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAE/C,MAAM,WAAW,0BAA0B;IACzC,cAAc,EAAE,kBAAkB,CAAA;CACnC;AAED,MAAM,MAAM,8BAA8B,GAAG,iBAAiB,CAAC;IAC7D,eAAe,EAAE,kBAAkB,EAAE,CAAA;CACtC,CAAC,CAAA"}
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/customer-group/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAE/C,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,cAAc,EAAE,kBAAkB,CAAA;CACnC;AAED,MAAM,MAAM,8BAA8B,GAAG,iBAAiB,CAAC;IAC7D;;OAEG;IACH,eAAe,EAAE,kBAAkB,EAAE,CAAA;CACtC,CAAC,CAAA"}

package/dist/http/customer-group/common.d.ts

@@ -1,10 +1,28 @@
 import { BaseCustomer } from "../customer/common";
 export interface BaseCustomerGroup {
+    /**
+     * The customer group's ID.
+     */
     id: string;
+    /**
+     * The customer group's name.
+     */
     name: string | null;
+    /**
+     * The customers in the group.
+     */
     customers: BaseCustomer[];
+    /**
+     * Key-value pairs of custom data.
+     */
     metadata: Record<string, unknown> | null;
+    /**
+     * The date the customer group was created.
+     */
     created_at: string;
+    /**
+     * The date the customer group was updated.
+     */
     updated_at: string;
 }
 //# sourceMappingURL=common.d.ts.map

package/dist/http/customer-group/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/customer-group/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEjD,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,SAAS,EAAE,YAAY,EAAE,CAAA;IACzB,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACxC,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;CACnB"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/customer-group/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAEjD,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB;;OAEG;IACH,SAAS,EAAE,YAAY,EAAE,CAAA;IACzB;;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;CACnB"}

package/dist/http/exchange/admin/payloads.d.ts

@@ -5,43 +5,106 @@ declare enum ExchangeReason {
     OTHER = "other"
 }
 interface AdminExchangeAddItems {
+    /**
+     * The items to add to the exchange.
+     */
     items: {
+        /**
+         * If you're adding an inbound item, this is the ID of the order item returned.
+         * If you're adding an outbound item, this is the ID of the variant to add.
+         */
         id: string;
+        /**
+         * The item's quantity.
+         */
         quantity: number;
+        /**
+         * The reason the item is being returned / sent to the customer.
+         */
         reason?: ExchangeReason;
+        /**
+         * The item's description.
+         */
         description?: string;
+        /**
+         * An internal note viewed by admin users only.
+         */
         internal_note?: string;
     }[];
 }
 interface AdminExchangeUpdateItem {
+    /**
+     * The item's quantity.
+     */
     quantity?: number;
+    /**
+     * The ID of the associated return reason.
+     */
     reason_id?: string | null;
+    /**
+     * The item's description.
+     */
     description?: string;
+    /**
+     * An internal note viewed by admin users only.
+     */
     internal_note?: string | null;
 }
 interface AdminExchangeAddShippingMethod {
+    /**
+     * The ID of the shipping option the method is created from.
+     */
     shipping_option_id: string;
+    /**
+     * A custom amount for the shipping method. If not specified,
+     * the shipping option's amount is used.
+     */
     custom_amount?: number;
+    /**
+     * The shipping method's description.
+     */
     description?: string;
+    /**
+     * An internal note viewed by admin users only.
+     */
     internal_note?: string;
+    /**
+     * Key-value pairs of custom data.
+     */
     metadata?: Record<string, unknown> | null;
 }
 interface AdminExchangeUpdateShippingMethod {
+    /**
+     * A custom amount for the shipping method.
+     */
     custom_amount?: number | null;
+    /**
+     * An internal note viewed by admin users only.
+     */
     internal_note?: string;
+    /**
+     * Key-value pairs of custom data.
+     */
     metadata?: Record<string, unknown> | null;
 }
 export interface AdminCreateExchange {
-    type: "refund" | "replace";
+    /**
+     * The ID of the order the exchange is created for.
+     */
     order_id: string;
+    /**
+     * The exchange's description.
+     */
     description?: string;
+    /**
+     * An internal note viewed by admin users only.
+     */
     internal_note?: string;
+    /**
+     * Key-value pairs of custom data.
+     */
     metadata?: Record<string, unknown> | null;
 }
-export interface AdminAddExchangeItems extends AdminExchangeAddItems {
-}
-export interface AdminUpdateExchangeItem extends AdminExchangeUpdateItem {
-}
 export interface AdminAddExchangeInboundItems extends AdminExchangeAddItems {
 }
 export interface AdminUpdateExchangeInboundItem extends AdminExchangeUpdateItem {
@@ -59,6 +122,9 @@ export interface AdminExchangeAddOutboundShipping extends AdminExchangeAddShippi
 export interface AdminExchangeUpdateOutboundShipping extends AdminExchangeUpdateShippingMethod {
 }
 export interface AdminRequestExchange {
+    /**
+     * Whether to send the customer a notification.
+     */
     no_notification?: boolean;
 }
 export interface AdminCancelExchange {

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

@@ -1 +1 @@
-{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/exchange/admin/payloads.ts"],"names":[],"mappings":"AAAA,aAAK,cAAc;IACjB,YAAY,iBAAiB;IAC7B,UAAU,eAAe;IACzB,kBAAkB,uBAAuB;IACzC,KAAK,UAAU;CAChB;AAED,UAAU,qBAAqB;IAC7B,KAAK,EAAE;QACL,EAAE,EAAE,MAAM,CAAA;QACV,QAAQ,EAAE,MAAM,CAAA;QAChB,MAAM,CAAC,EAAE,cAAc,CAAA;QACvB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB,EAAE,CAAA;CACJ;AAED,UAAU,uBAAuB;IAC/B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC9B;AAED,UAAU,8BAA8B;IACtC,kBAAkB,EAAE,MAAM,CAAA;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,UAAU,iCAAiC;IACzC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,QAAQ,GAAG,SAAS,CAAA;IAC1B,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,qBAAsB,SAAQ,qBAAqB;CAAG;AACvE,MAAM,WAAW,uBAAwB,SAAQ,uBAAuB;CAAG;AAE3E,MAAM,WAAW,4BAA6B,SAAQ,qBAAqB;CAAG;AAC9E,MAAM,WAAW,8BACf,SAAQ,uBAAuB;CAAG;AAEpC,MAAM,WAAW,6BAA8B,SAAQ,qBAAqB;CAAG;AAC/E,MAAM,WAAW,+BACf,SAAQ,uBAAuB;CAAG;AAEpC,MAAM,WAAW,+BACf,SAAQ,8BAA8B;CAAG;AAC3C,MAAM,WAAW,kCACf,SAAQ,iCAAiC;CAAG;AAE9C,MAAM,WAAW,gCACf,SAAQ,8BAA8B;CAAG;AAC3C,MAAM,WAAW,mCACf,SAAQ,iCAAiC;CAAG;AAE9C,MAAM,WAAW,oBAAoB;IACnC,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B"}
+{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/exchange/admin/payloads.ts"],"names":[],"mappings":"AAAA,aAAK,cAAc;IACjB,YAAY,iBAAiB;IAC7B,UAAU,eAAe;IACzB,kBAAkB,uBAAuB;IACzC,KAAK,UAAU;CAChB;AAED,UAAU,qBAAqB;IAC7B;;OAEG;IACH,KAAK,EAAE;QACL;;;WAGG;QACH,EAAE,EAAE,MAAM,CAAA;QACV;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAA;QAChB;;WAEG;QACH,MAAM,CAAC,EAAE,cAAc,CAAA;QACvB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB,EAAE,CAAA;CACJ;AAED,UAAU,uBAAuB;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC9B;AAED,UAAU,8BAA8B;IACtC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAC1B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,UAAU,iCAAiC;IACzC;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;CAC1C;AAED,MAAM,WAAW,4BAA6B,SAAQ,qBAAqB;CAAG;AAC9E,MAAM,WAAW,8BACf,SAAQ,uBAAuB;CAAG;AAEpC,MAAM,WAAW,6BAA8B,SAAQ,qBAAqB;CAAG;AAC/E,MAAM,WAAW,+BACf,SAAQ,uBAAuB;CAAG;AAEpC,MAAM,WAAW,+BACf,SAAQ,8BAA8B;CAAG;AAC3C,MAAM,WAAW,kCACf,SAAQ,iCAAiC;CAAG;AAE9C,MAAM,WAAW,gCACf,SAAQ,8BAA8B;CAAG;AAC3C,MAAM,WAAW,mCACf,SAAQ,iCAAiC;CAAG;AAE9C,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC,eAAe,CAAC,EAAE,OAAO,CAAA;CAC1B"}

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

@@ -1,11 +1,8 @@
-import { BaseFilterable, OperatorMap } from "../../../dal";
+import { OperatorMap } from "../../../dal";
 import { SelectParams } from "../../common";
-import { BaseExchangeListParams } from "../common";
-export interface AdminExchangeListParams extends BaseExchangeListParams, BaseFilterable<AdminExchangeListParams> {
-    deleted_at?: OperatorMap<string>;
-}
-export interface AdminExchangeParams extends SelectParams {
+export interface AdminExchangeListParams extends SelectParams {
     id?: string | string[];
+    order_id?: string | string[];
     status?: string | string[];
     created_at?: OperatorMap<string>;
     updated_at?: OperatorMap<string>;

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

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/exchange/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,sBAAsB,EAAE,MAAM,WAAW,CAAA;AAElD,MAAM,WAAW,uBACf,SAAQ,sBAAsB,EAC5B,cAAc,CAAC,uBAAuB,CAAC;IACzC,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAA;CACjC;AAED,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B,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/exchange/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAA;AAE3C,MAAM,WAAW,uBAAwB,SAAQ,YAAY;IAC3D,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B,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"}

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

@@ -4,9 +4,15 @@ import { AdminOrderPreview } from "../../order";
 import { AdminReturn } from "../../return";
 import { AdminExchange } from "./entities";
 export interface AdminExchangeResponse {
+    /**
+     * The exchange's details.
+     */
     exchange: AdminExchange;
 }
 export type AdminExchangeListResponse = PaginatedResponse<{
+    /**
+     * This list of exchanges.
+     */
     exchanges: AdminExchange[];
 }>;
 export interface AdminExchangeOrderResponse {
@@ -14,14 +20,29 @@ export interface AdminExchangeOrderResponse {
     exchange: AdminExchange;
 }
 export interface AdminExchangePreviewResponse {
+    /**
+     * The preview of the order when the exchange is applied.
+     */
     order_preview: AdminOrderPreview;
+    /**
+     * The exchange's details.
+     */
     exchange: AdminExchange;
 }
 export interface AdminExchangeRequestResponse extends AdminExchangePreviewResponse {
+    /**
+     * The return associated with the exchange.
+     */
     return: AdminReturn;
 }
 export interface AdminExchangeReturnResponse {
+    /**
+     * A preview of the order when the exchange is confirmed.
+     */
     order_preview: AdminOrderPreview;
+    /**
+     * The return associated with the exchange.
+     */
     return: AdminReturn;
 }
 export interface AdminExchangeDeleteResponse extends DeleteResponse<"exchange"> {

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

@@ -1 +1 @@
-{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/exchange/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAE1C,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,aAAa,CAAA;CACxB;AAED,MAAM,MAAM,yBAAyB,GAAG,iBAAiB,CAAC;IACxD,SAAS,EAAE,aAAa,EAAE,CAAA;CAC3B,CAAC,CAAA;AAEF,MAAM,WAAW,0BAA0B;IACzC,KAAK,EAAE,QAAQ,CAAA;IACf,QAAQ,EAAE,aAAa,CAAA;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C,aAAa,EAAE,iBAAiB,CAAA;IAChC,QAAQ,EAAE,aAAa,CAAA;CACxB;AAED,MAAM,WAAW,4BACf,SAAQ,4BAA4B;IACpC,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C,aAAa,EAAE,iBAAiB,CAAA;IAChC,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,WAAW,2BACf,SAAQ,cAAc,CAAC,UAAU,CAAC;CAAG"}
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/exchange/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAA;AAC/C,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAA;AAE1C,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAA;CACxB;AAED,MAAM,MAAM,yBAAyB,GAAG,iBAAiB,CAAC;IACxD;;OAEG;IACH,SAAS,EAAE,aAAa,EAAE,CAAA;CAC3B,CAAC,CAAA;AAEF,MAAM,WAAW,0BAA0B;IACzC,KAAK,EAAE,QAAQ,CAAA;IACf,QAAQ,EAAE,aAAa,CAAA;CACxB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAA;IAChC;;OAEG;IACH,QAAQ,EAAE,aAAa,CAAA;CACxB;AAED,MAAM,WAAW,4BACf,SAAQ,4BAA4B;IACpC;;OAEG;IACH,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,aAAa,EAAE,iBAAiB,CAAA;IAChC;;OAEG;IACH,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,WAAW,2BACf,SAAQ,cAAc,CAAC,UAAU,CAAC;CAAG"}

package/dist/http/exchange/common.d.ts

@@ -3,44 +3,153 @@ import { FindParams } from "../common";
 import { BaseOrder, BaseOrderShippingMethod, BaseOrderTransaction } from "../order/common";
 import { AdminReturn, AdminReturnItem } from "../return";
 export interface BaseExchangeItem {
+    /**
+     * The exchange item's ID.
+     */
     id: string;
+    /**
+     * The ID of the exchange this item belongs to.
+     */
     exchange_id: string;
+    /**
+     * The ID of the associated order.
+     */
     order_id: string;
+    /**
+     * The ID of the order item, which is added
+     * to the order when the exchange is confirmed.
+     */
     item_id: string;
+    /**
+     * The item's quantity.
+     */
     quantity: number;
+    /**
+     * Key-value pairs of custom data.
+     */
     metadata?: Record<string, unknown>;
+    /**
+     * The date the exchange item was created.
+     */
     created_at: string | null;
+    /**
+     * The date the exchange item was updated.
+     */
     updated_at: string | null;
 }
 export interface BaseExchange {
+    /**
+     * The exchange's ID.
+     */
     id: string;
+    /**
+     * The ID of the order this exchange is created for.
+     */
     order_id: string;
+    /**
+     * The ID of the associated return.
+     */
     return_id?: string;
+    /**
+     * The exchange's display ID.
+     */
     display_id?: string;
+    /**
+     * The version of the order when the exchange is applied.
+     */
     order_version?: string;
+    /**
+     * The ID of the user that created the exchange.
+     */
     created_by?: string;
+    /**
+     * The date the exchange was created.
+     */
     created_at: Date | string;
+    /**
+     * The date the exchange was updated.
+     */
     updated_at: Date | string;
+    /**
+     * The date the exchange was canceled.
+     */
     canceled_at: Date | string;
+    /**
+     * The date the exchange was deleted.
+     */
     deleted_at: Date | string;
+    /**
+     * The exchange's new (outbound) items.
+     */
     additional_items: BaseExchangeItem[];
+    /**
+     * The exchange's returned (inbound) items.
+     */
     return_items: AdminReturnItem[];
+    /**
+     * Whether to notify the customer about changes in the exchange.
+     */
     no_notification?: boolean;
+    /**
+     * The exchange's difference amount due, either to the customer or the merchant.
+     *
+     * If the value is positive, the customer owes the merchant additional payment of this amount.
+     * If negative, the merchant owes the customer a refund of this amount.
+     */
     difference_due?: number;
+    /**
+     * The associated return.
+     */
     return?: AdminReturn;
+    /**
+     * The associated order.
+     */
     order?: BaseOrder;
+    /**
+     * Whether out-of-stock variants can be added as new items.
+     */
     allow_backorder?: boolean;
+    /**
+     * The shipping methods used to send the outbound items.
+     */
     shipping_methods?: BaseOrderShippingMethod[];
+    /**
+     * The exchange's transactions.
+     */
     transactions?: BaseOrderTransaction[];
+    /**
+     * Key-value pairs of custom data.
+     */
     metadata?: Record<string, unknown>;
 }
 export interface BaseExchangeListParams extends FindParams {
+    /**
+     * Query or keywords to search the exchange's searchable fields.
+     */
     q?: string;
+    /**
+     * Filter by exchange ID(s).
+     */
     id?: string | string[];
+    /**
+     * Filter by order IDs to retrieve their exchanges.
+     */
     order_id?: string | string[];
+    /**
+     * Filter by status(es).
+     */
     status?: string | string[];
+    /**
+     * Apply filters on the exchange's creation date.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Apply filters on the exchange's update date.
+     */
     updated_at?: OperatorMap<string>;
+    /**
+     * Apply filters on the exchange's deletion date.
+     */
     deleted_at?: OperatorMap<string>;
 }
 //# sourceMappingURL=common.d.ts.map

package/dist/http/exchange/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/exchange/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EACL,SAAS,EACT,uBAAuB,EACvB,oBAAoB,EACrB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAExD,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAA;IACV,WAAW,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,IAAI,GAAG,MAAM,CAAA;IACzB,UAAU,EAAE,IAAI,GAAG,MAAM,CAAA;IACzB,WAAW,EAAE,IAAI,GAAG,MAAM,CAAA;IAC1B,UAAU,EAAE,IAAI,GAAG,MAAM,CAAA;IACzB,gBAAgB,EAAE,gBAAgB,EAAE,CAAA;IACpC,YAAY,EAAE,eAAe,EAAE,CAAA;IAC/B,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,gBAAgB,CAAC,EAAE,uBAAuB,EAAE,CAAA;IAC5C,YAAY,CAAC,EAAE,oBAAoB,EAAE,CAAA;IACrC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,sBAAuB,SAAQ,UAAU;IACxD,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC5B,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B,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":"common.d.ts","sourceRoot":"","sources":["../../../src/http/exchange/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AACtC,OAAO,EACL,SAAS,EACT,uBAAuB,EACvB,oBAAoB,EACrB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAExD,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,MAAM,CAAA;IACzB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,MAAM,CAAA;IACzB;;OAEG;IACH,WAAW,EAAE,IAAI,GAAG,MAAM,CAAA;IAC1B;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,MAAM,CAAA;IACzB;;OAEG;IACH,gBAAgB,EAAE,gBAAgB,EAAE,CAAA;IACpC;;OAEG;IACH,YAAY,EAAE,eAAe,EAAE,CAAA;IAC/B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,uBAAuB,EAAE,CAAA;IAC5C;;OAEG;IACH,YAAY,CAAC,EAAE,oBAAoB,EAAE,CAAA;IACrC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED,MAAM,WAAW,sBAAuB,SAAQ,UAAU;IACxD;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC1B;;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"}