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

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

@@ -1,9 +1,29 @@
 import { ApplicationMethodAllocationValues, ApplicationMethodTargetTypeValues, ApplicationMethodTypeValues, PromotionRuleOperatorValues, PromotionStatusValues, PromotionTypeValues } from "../../../promotion";
 import { AdminCreateCampaign } from "../../campaign";
 export interface AdminCreatePromotionRule {
+    /**
+     * The operator used to check whether the buy rule applies on a cart.
+     * For example, `eq` means that the cart's value for the specified attribute
+     * must match the specified value.
+     */
     operator: PromotionRuleOperatorValues;
+    /**
+     * The description of the promotion rule.
+     */
     description?: string | null;
+    /**
+     * The attribute to compare against when checking whether a promotion can be applied on a cart.
+     *
+     * @example
+     * items.product_id
+     */
     attribute: string;
+    /**
+     * The value to compare against when checking whether a promotion can be applied on a cart.
+     *
+     * @example
+     * prod_123
+     */
     values: string | string[];
 }
 export interface AdminUpdatePromotionRule {
@@ -14,57 +34,193 @@ export interface AdminUpdatePromotionRule {
     values: string | string[];
 }
 export interface AdminCreateApplicationMethod {
+    /**
+     * The description of the application method.
+     */
     description?: string | null;
+    /**
+     * The value of the application method.
+     */
     value: number;
+    /**
+     * The currency code of the application method.
+     *
+     * @example
+     * usd
+     */
     currency_code?: string | null;
+    /**
+     * The max quantity allowed in the cart for the associated promotion to be applied.
+     */
     max_quantity?: number | null;
+    /**
+     * The type of the application method.
+     */
     type: ApplicationMethodTypeValues;
+    /**
+     * The target type of the application method indicating whether the associated promotion is applied
+     * to the cart's items, shipping methods, or the whole order.
+     */
     target_type: ApplicationMethodTargetTypeValues;
+    /**
+     * The allocation value that indicates whether the associated promotion is applied on each
+     * item in a cart or split between the items in the cart.
+     */
     allocation?: ApplicationMethodAllocationValues;
+    /**
+     * The target rules of the application method.
+     */
     target_rules?: AdminCreatePromotionRule[];
+    /**
+     * The buy rules of the application method.
+     */
     buy_rules?: AdminCreatePromotionRule[];
+    /**
+     * The quantity of the application method.
+     */
     apply_to_quantity?: number | null;
+    /**
+     * The minimum quantity required for a `buyget` promotion to be applied. For example,
+     * if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is 2.
+     */
     buy_rules_min_quantity?: number | null;
 }
 export interface AdminUpdateApplicationMethod {
+    /**
+     * The description of the application method.
+     */
     description?: string | null;
+    /**
+     * The value of the application method.
+     */
     value?: number;
+    /**
+     * The max quantity allowed in the cart for the associated promotion to be applied.
+     */
     max_quantity?: number | null;
+    /**
+     * The currency code of the application method.
+     *
+     * @example
+     * usd
+     */
     currency_code?: string | null;
+    /**
+     * The type of the application method.
+     */
     type?: ApplicationMethodTypeValues;
+    /**
+     * The target type of the application method indicating whether the associated promotion is applied
+     * to the cart's items, shipping methods, or the whole order.
+     */
     target_type?: ApplicationMethodTargetTypeValues;
+    /**
+     * The allocation value that indicates whether the associated promotion is applied on each
+     * item in a cart or split between the items in the cart.
+     */
     allocation?: ApplicationMethodAllocationValues;
+    /**
+     * The target rules of the application method.
+     */
     target_rules?: AdminCreatePromotionRule[];
+    /**
+     * The buy rules of the application method.
+     */
     buy_rules?: AdminCreatePromotionRule[];
+    /**
+     * The quantity of the application method.
+     */
     apply_to_quantity?: number | null;
+    /**
+     * The minimum quantity required for a `buyget` promotion to be applied. For example,
+     * if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is 2.
+     */
     buy_rules_min_quantity?: number | null;
 }
 export interface AdminCreatePromotion {
+    /**
+     * The promotion's code.
+     */
     code: string;
+    /**
+     * Whether the promotion is applied automatically
+     * or requires the customer to manually apply it
+     * by entering the code at checkout.
+     */
     is_automatic?: boolean;
+    /**
+     * The type of promotion.
+     */
     type: PromotionTypeValues;
+    /**
+     * The ID of the campaign that the promotion belongs to.
+     */
     campaign_id?: string | null;
+    /**
+     * The campaign that the promotion belongs to.
+     */
     campaign?: AdminCreateCampaign;
+    /**
+     * The application method of the promotion.
+     */
     application_method: AdminCreateApplicationMethod;
+    /**
+     * The rules of the promotion.
+     */
     rules?: AdminCreatePromotionRule[];
 }
 export interface AdminUpdatePromotion {
+    /**
+     * The promotion's code.
+     */
     code?: string;
+    /**
+     * Whether the promotion is applied automatically
+     * or requires the customer to manually apply it
+     * by entering the code at checkout.
+     */
     is_automatic?: boolean;
+    /**
+     * The type of promotion.
+     */
     type?: PromotionTypeValues;
+    /**
+     * The status of the promotion.
+     */
     status?: PromotionStatusValues;
+    /**
+     * The ID of the campaign that the promotion belongs to.
+     */
     campaign_id?: string | null;
+    /**
+     * The campaign that the promotion belongs to.
+     */
     campaign?: AdminCreateCampaign;
+    /**
+     * The application method of the promotion.
+     */
     application_method?: AdminUpdateApplicationMethod;
+    /**
+     * The rules of the promotion.
+     */
     rules?: AdminCreatePromotionRule[];
 }
 export interface BatchAddPromotionRulesReq {
+    /**
+     * The rules to add.
+     */
     rules: AdminCreatePromotionRule[];
 }
 export interface BatchRemovePromotionRulesReq {
+    /**
+     * The IDs of the rules to remove.
+     */
     rule_ids: string[];
 }
 export interface BatchUpdatePromotionRulesReq {
+    /**
+     * The rules to update.
+     */
     rules: AdminUpdatePromotionRule[];
 }
 //# sourceMappingURL=payloads.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/promotion/admin/payloads.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iCAAiC,EACjC,iCAAiC,EACjC,2BAA2B,EAC3B,2BAA2B,EAC3B,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAEpD,MAAM,WAAW,wBAAwB;IACvC,QAAQ,EAAE,2BAA2B,CAAA;IACrC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,SAAS,EAAE,MAAM,CAAA;IACjB,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC1B;AAED,MAAM,WAAW,wBAAwB;IACvC,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,CAAC,EAAE,2BAA2B,CAAA;IACtC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC1B;AAED,MAAM,WAAW,4BAA4B;IAC3C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,KAAK,EAAE,MAAM,CAAA;IACb,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,IAAI,EAAE,2BAA2B,CAAA;IACjC,WAAW,EAAE,iCAAiC,CAAA;IAC9C,UAAU,CAAC,EAAE,iCAAiC,CAAA;IAC9C,YAAY,CAAC,EAAE,wBAAwB,EAAE,CAAA;IACzC,SAAS,CAAC,EAAE,wBAAwB,EAAE,CAAA;IACtC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACvC;AAED,MAAM,WAAW,4BAA4B;IAC3C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B,IAAI,CAAC,EAAE,2BAA2B,CAAA;IAClC,WAAW,CAAC,EAAE,iCAAiC,CAAA;IAC/C,UAAU,CAAC,EAAE,iCAAiC,CAAA;IAC9C,YAAY,CAAC,EAAE,wBAAwB,EAAE,CAAA;IACzC,SAAS,CAAC,EAAE,wBAAwB,EAAE,CAAA;IACtC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACvC;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,IAAI,EAAE,mBAAmB,CAAA;IACzB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,QAAQ,CAAC,EAAE,mBAAmB,CAAA;IAC9B,kBAAkB,EAAE,4BAA4B,CAAA;IAChD,KAAK,CAAC,EAAE,wBAAwB,EAAE,CAAA;CACnC;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,IAAI,CAAC,EAAE,mBAAmB,CAAA;IAC1B,MAAM,CAAC,EAAE,qBAAqB,CAAA;IAC9B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,QAAQ,CAAC,EAAE,mBAAmB,CAAA;IAC9B,kBAAkB,CAAC,EAAE,4BAA4B,CAAA;IACjD,KAAK,CAAC,EAAE,wBAAwB,EAAE,CAAA;CACnC;AAED,MAAM,WAAW,yBAAyB;IACxC,KAAK,EAAE,wBAAwB,EAAE,CAAA;CAClC;AAED,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,EAAE,MAAM,EAAE,CAAA;CACnB;AAED,MAAM,WAAW,4BAA4B;IAC3C,KAAK,EAAE,wBAAwB,EAAE,CAAA;CAClC"}
+{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/promotion/admin/payloads.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iCAAiC,EACjC,iCAAiC,EACjC,2BAA2B,EAC3B,2BAA2B,EAC3B,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAA;AAEpD,MAAM,WAAW,wBAAwB;IACvC;;;;OAIG;IACH,QAAQ,EAAE,2BAA2B,CAAA;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;;;OAKG;IACH,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC1B;AAED,MAAM,WAAW,wBAAwB;IACvC,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,CAAC,EAAE,2BAA2B,CAAA;IACtC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC1B;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B;;OAEG;IACH,IAAI,EAAE,2BAA2B,CAAA;IACjC;;;OAGG;IACH,WAAW,EAAE,iCAAiC,CAAA;IAC9C;;;OAGG;IACH,UAAU,CAAC,EAAE,iCAAiC,CAAA;IAC9C;;OAEG;IACH,YAAY,CAAC,EAAE,wBAAwB,EAAE,CAAA;IACzC;;OAEG;IACH,SAAS,CAAC,EAAE,wBAAwB,EAAE,CAAA;IACtC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACvC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,IAAI,CAAC,EAAE,2BAA2B,CAAA;IAClC;;;OAGG;IACH,WAAW,CAAC,EAAE,iCAAiC,CAAA;IAC/C;;;OAGG;IACH,UAAU,CAAC,EAAE,iCAAiC,CAAA;IAC9C;;OAEG;IACH,YAAY,CAAC,EAAE,wBAAwB,EAAE,CAAA;IACzC;;OAEG;IACH,SAAS,CAAC,EAAE,wBAAwB,EAAE,CAAA;IACtC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC;;;OAGG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CACvC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,IAAI,EAAE,mBAAmB,CAAA;IACzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,mBAAmB,CAAA;IAC9B;;OAEG;IACH,kBAAkB,EAAE,4BAA4B,CAAA;IAChD;;OAEG;IACH,KAAK,CAAC,EAAE,wBAAwB,EAAE,CAAA;CACnC;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAA;IAC1B;;OAEG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAA;IAC9B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;OAEG;IACH,QAAQ,CAAC,EAAE,mBAAmB,CAAA;IAC9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,4BAA4B,CAAA;IACjD;;OAEG;IACH,KAAK,CAAC,EAAE,wBAAwB,EAAE,CAAA;CACnC;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,wBAAwB,EAAE,CAAA;CAClC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAA;CACnB;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,KAAK,EAAE,wBAAwB,EAAE,CAAA;CAClC"}

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

@@ -3,16 +3,54 @@ import { FindParams, SelectParams } from "../../common";
 export interface AdminGetPromotionParams extends SelectParams {
 }
 export interface AdminGetPromotionsParams extends FindParams, BaseFilterable<AdminGetPromotionsParams> {
+    /**
+     * Search for a promotion by its searchable
+     */
     q?: string;
-    code?: string | string[];
+    /**
+     * Filter by promotion code.
+     */
+    code?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter by campaign ID to retrieve promotions by campaign.
+     */
     campaign_id?: string | string[];
+    /**
+     * Filter by the promotion's application method.
+     */
     application_method?: {
+        /**
+         * Filter by the promotion's application method currency code.
+         */
         currency_code?: string | string[];
     };
+    /**
+     * Filter by the promotion's currency code.
+     */
+    currency_code?: string | string[];
+    /**
+     * Filter by the promotion's created date.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Filter by the promotion's updated date.
+     */
     updated_at?: OperatorMap<string>;
+    /**
+     * Filter by the promotion's deleted date.
+     */
     deleted_at?: OperatorMap<string>;
+    /**
+     * Filter by the promotion's application method type.
+     */
+    application_method_type?: string | string[];
+    /**
+     * An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.
+     */
     $and?: AdminGetPromotionsParams[];
+    /**
+     * An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.
+     */
     $or?: AdminGetPromotionsParams[];
 }
 export interface AdminGetPromotionRuleParams {
@@ -24,7 +62,13 @@ export interface AdminGetPromotionRuleTypeParams extends SelectParams {
     application_method_type?: string;
 }
 export interface AdminGetPromotionsRuleValueParams extends FindParams {
+    /**
+     * Search for a rule value by its searchable
+     */
     q?: string;
+    /**
+     * Filter by rule value.
+     */
     value?: string | string[];
 }
 //# sourceMappingURL=queries.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/promotion/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,uBAAwB,SAAQ,YAAY;CAAG;AAEhE,MAAM,WAAW,wBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,wBAAwB,CAAC;IAC1C,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/B,kBAAkB,CAAC,EAAE;QACnB,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAClC,CAAA;IACD,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,wBAAwB,EAAE,CAAA;IACjC,GAAG,CAAC,EAAE,wBAAwB,EAAE,CAAA;CACjC;AAED,MAAM,WAAW,2BAA2B;IAC1C,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,uBAAuB,CAAC,EAAE,MAAM,CAAA;CACjC;AAED,MAAM,WAAW,+BAAgC,SAAQ,YAAY;IACnE,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,uBAAuB,CAAC,EAAE,MAAM,CAAA;CACjC;AAED,MAAM,WAAW,iCAAkC,SAAQ,UAAU;IACnE,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC1B"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/promotion/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,uBAAwB,SAAQ,YAAY;CAAG;AAEhE,MAAM,WAAW,wBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,wBAAwB,CAAC;IAC1C;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC9C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC/B;;OAEG;IACH,kBAAkB,CAAC,EAAE;QACnB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;KAClC,CAAA;IACD;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACjC;;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,uBAAuB,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAC3C;;OAEG;IACH,IAAI,CAAC,EAAE,wBAAwB,EAAE,CAAA;IACjC;;OAEG;IACH,GAAG,CAAC,EAAE,wBAAwB,EAAE,CAAA;CACjC;AAED,MAAM,WAAW,2BAA2B;IAC1C,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,uBAAuB,CAAC,EAAE,MAAM,CAAA;CACjC;AAED,MAAM,WAAW,+BAAgC,SAAQ,YAAY;IACnE,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,uBAAuB,CAAC,EAAE,MAAM,CAAA;CACjC;AAED,MAAM,WAAW,iCAAkC,SAAQ,UAAU;IACnE;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC1B"}

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

@@ -1,21 +1,33 @@
 import { BatchResponse, DeleteResponse, PaginatedResponse } from "../../common";
 import { AdminPromotion, AdminPromotionRule, AdminRuleAttributeOption, AdminRuleOperatorOption, AdminRuleValueOption } from "./entities";
 export interface AdminPromotionResponse {
+    /**
+     * The promotion's details.
+     */
     promotion: AdminPromotion;
 }
 export type AdminPromotionListResponse = PaginatedResponse<{
+    /**
+     * The list of promotions.
+     */
     promotions: AdminPromotion[];
 }>;
 export interface PromotionRuleResponse {
     rule: AdminPromotionRule;
 }
 export type AdminPromotionRuleListResponse = {
+    /**
+     * The list of promotion rules.
+     */
     rules: AdminPromotionRule[];
 };
 export interface RuleAttributeOptionsResponse {
     attribute: AdminRuleAttributeOption[];
 }
 export type AdminRuleAttributeOptionsListResponse = {
+    /**
+     * The list of rule attribute options.
+     */
     attributes: AdminRuleAttributeOption[];
 };
 export interface RuleOperatorOptionsResponse {
@@ -33,9 +45,12 @@ export interface RuleValueOptionsResponse {
 /**
  * @experimental
  */
-export type AdminRuleValueOptionsListResponse = {
+export type AdminRuleValueOptionsListResponse = PaginatedResponse<{
+    /**
+     * The list of rule value options.
+     */
     values: AdminRuleValueOption[];
-};
+}>;
 export type AdminPromotionRuleBatchResponse = BatchResponse<AdminPromotionRule>;
 export type AdminPromotionDeleteResponse = DeleteResponse<"promotion">;
 //# sourceMappingURL=responses.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/promotion/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAC/E,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,wBAAwB,EACxB,uBAAuB,EACvB,oBAAoB,EACrB,MAAM,YAAY,CAAA;AAEnB,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,cAAc,CAAA;CAC1B;AAED,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,CAAC;IACzD,UAAU,EAAE,cAAc,EAAE,CAAA;CAC7B,CAAC,CAAA;AAEF,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,kBAAkB,CAAA;CACzB;AAED,MAAM,MAAM,8BAA8B,GAAG;IAC3C,KAAK,EAAE,kBAAkB,EAAE,CAAA;CAC5B,CAAA;AAED,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,wBAAwB,EAAE,CAAA;CACtC;AAED,MAAM,MAAM,qCAAqC,GAAG;IAClD,UAAU,EAAE,wBAAwB,EAAE,CAAA;CACvC,CAAA;AAED,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,EAAE,uBAAuB,CAAA;CAClC;AAED,MAAM,MAAM,oCAAoC,GAAG,iBAAiB,CAAC;IACnE,SAAS,EAAE,uBAAuB,EAAE,CAAA;CACrC,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,oBAAoB,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C,MAAM,EAAE,oBAAoB,EAAE,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,+BAA+B,GAAG,aAAa,CAAC,kBAAkB,CAAC,CAAA;AAE/E,MAAM,MAAM,4BAA4B,GAAG,cAAc,CAAC,WAAW,CAAC,CAAA"}
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/promotion/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAC/E,OAAO,EACL,cAAc,EACd,kBAAkB,EAClB,wBAAwB,EACxB,uBAAuB,EACvB,oBAAoB,EACrB,MAAM,YAAY,CAAA;AAEnB,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,SAAS,EAAE,cAAc,CAAA;CAC1B;AAED,MAAM,MAAM,0BAA0B,GAAG,iBAAiB,CAAC;IACzD;;OAEG;IACH,UAAU,EAAE,cAAc,EAAE,CAAA;CAC7B,CAAC,CAAA;AAEF,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,kBAAkB,CAAA;CACzB;AAED,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;OAEG;IACH,KAAK,EAAE,kBAAkB,EAAE,CAAA;CAC5B,CAAA;AAED,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,wBAAwB,EAAE,CAAA;CACtC;AAED,MAAM,MAAM,qCAAqC,GAAG;IAClD;;OAEG;IACH,UAAU,EAAE,wBAAwB,EAAE,CAAA;CACvC,CAAA;AAED,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,EAAE,uBAAuB,CAAA;CAClC;AAED,MAAM,MAAM,oCAAoC,GAAG,iBAAiB,CAAC;IACnE,SAAS,EAAE,uBAAuB,EAAE,CAAA;CACrC,CAAC,CAAA;AAEF;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,KAAK,EAAE,oBAAoB,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,MAAM,iCAAiC,GAAG,iBAAiB,CAAC;IAChE;;OAEG;IACH,MAAM,EAAE,oBAAoB,EAAE,CAAA;CAC/B,CAAC,CAAA;AAEF,MAAM,MAAM,+BAA+B,GAAG,aAAa,CAAC,kBAAkB,CAAC,CAAA;AAE/E,MAAM,MAAM,4BAA4B,GAAG,cAAc,CAAC,WAAW,CAAC,CAAA"}

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

@@ -1,10 +1,36 @@
 import { ApplicationMethodAllocationValues, ApplicationMethodTargetTypeValues, ApplicationMethodTypeValues, PromotionRuleOperatorValues, PromotionStatusValues, PromotionTypeValues } from "../../promotion";
 import { AdminCampaign } from "../campaign";
 export interface BasePromotionRule {
+    /**
+     * The rule's ID.
+     */
     id: string;
+    /**
+     * The rule's description.
+     */
     description?: string | null;
+    /**
+     * The attribute to compare against when checking whether a promotion can be applied on a cart.
+     *
+     * @example
+     * items.product_id
+     */
     attribute?: string;
+    /**
+     * The operator used to check whether the buy rule applies on a cart.
+     * For example, `eq` means that the cart's value for the specified attribute
+     * must match the specified value.
+     *
+     * @example
+     * eq
+     */
     operator?: PromotionRuleOperatorValues;
+    /**
+     * The values to compare against when checking whether a promotion can be applied on a cart.
+     *
+     * @example
+     * prod_123
+     */
     values: BasePromotionRuleValue[];
 }
 export interface BaseApplicationMethod {
@@ -36,12 +62,27 @@ export interface BasePromotion {
     deleted_at: string | null;
 }
 export interface BasePromotionRuleValue {
+    /**
+     * The rule value's ID.
+     */
     id: string;
+    /**
+     * The rule value's value.
+     */
     value?: string;
 }
 export interface BaseRuleAttributeOptions {
+    /**
+     * The rule attribute option's ID.
+     */
     id: string;
+    /**
+     * The rule attribute option's value.
+     */
     value: string;
+    /**
+     * The rule attribute option's label.
+     */
     label: string;
     /**
      * @ignore
@@ -59,11 +100,23 @@ export interface BaseRuleAttributeOptions {
      * @ignore
      */
     hydrate?: boolean;
+    /**
+     * The attribute option's operators.
+     */
     operators: BaseRuleOperatorOptions[];
 }
 export interface BaseRuleOperatorOptions {
+    /**
+     * The operator option's ID.
+     */
     id: string;
+    /**
+     * The operator option's value.
+     */
     value: string;
+    /**
+     * The operator option's label.
+     */
     label: string;
 }
 export interface BaseRuleValueOptions {

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

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/promotion/common.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iCAAiC,EACjC,iCAAiC,EACjC,2BAA2B,EAC3B,2BAA2B,EAC3B,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAE3C,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,2BAA2B,CAAA;IACtC,MAAM,EAAE,sBAAsB,EAAE,CAAA;CACjC;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,2BAA2B,CAAA;IAClC,WAAW,CAAC,EAAE,iCAAiC,CAAA;IAC/C,UAAU,CAAC,EAAE,iCAAiC,CAAA;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,SAAS,CAAC,EAAE,aAAa,CAAA;IACzB,YAAY,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAClC,SAAS,CAAC,EAAE,iBAAiB,EAAE,CAAA;CAChC;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,mBAAmB,CAAA;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,kBAAkB,CAAC,EAAE,qBAAqB,CAAA;IAC1C,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAC3B,MAAM,CAAC,EAAE,qBAAqB,CAAA;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,wBAAwB;IACvC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,SAAS,EAAE,uBAAuB,EAAE,CAAA;CACrC;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/http/promotion/common.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iCAAiC,EACjC,iCAAiC,EACjC,2BAA2B,EAC3B,2BAA2B,EAC3B,qBAAqB,EACrB,mBAAmB,EACpB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAE3C,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAA;IACtC;;;;;OAKG;IACH,MAAM,EAAE,sBAAsB,EAAE,CAAA;CACjC;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,2BAA2B,CAAA;IAClC,WAAW,CAAC,EAAE,iCAAiC,CAAA;IAC/C,UAAU,CAAC,EAAE,iCAAiC,CAAA;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC5B,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,iBAAiB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACjC,SAAS,CAAC,EAAE,aAAa,CAAA;IACzB,YAAY,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAClC,SAAS,CAAC,EAAE,iBAAiB,EAAE,CAAA;CAChC;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,mBAAmB,CAAA;IAC1B,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,kBAAkB,CAAC,EAAE,qBAAqB,CAAA;IAC1C,KAAK,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAC3B,MAAM,CAAC,EAAE,qBAAqB,CAAA;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,aAAa,CAAA;IACxB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,CAAA;IAClB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAClB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,SAAS,EAAE,uBAAuB,EAAE,CAAA;CACrC;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;CACd"}

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

@@ -1,5 +1,8 @@
 import { BaseRegion, BaseRegionCountry } from "../common";
 export interface AdminRegion extends Omit<BaseRegion, "countries"> {
+    /**
+     * The countries in the region.
+     */
     countries?: AdminRegionCountry[];
 }
 export interface AdminRegionCountry extends BaseRegionCountry {

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

@@ -1 +1 @@
-{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/region/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAEzD,MAAM,WAAW,WAAY,SAAQ,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC;IAChE,SAAS,CAAC,EAAE,kBAAkB,EAAE,CAAA;CACjC;AACD,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;CAAG"}
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../../../src/http/region/admin/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAA;AAEzD,MAAM,WAAW,WAAY,SAAQ,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC;IAChE;;OAEG;IACH,SAAS,CAAC,EAAE,kBAAkB,EAAE,CAAA;CACjC;AACD,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;CAAG"}

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

@@ -1,19 +1,87 @@
 export interface AdminCreateRegion {
+    /**
+     * The name of the region.
+     */
     name: string;
+    /**
+     * The currency code of the region.
+     *
+     * @example
+     * "usd"
+     */
     currency_code: string;
+    /**
+     * The 2 ISO code of the countries in the region.
+     *
+     * @example
+     * ["us", "ca"]
+     */
     countries?: string[];
+    /**
+     * Whether taxes are automatically calculated during checkout
+     * for this region.
+     */
     automatic_taxes?: boolean;
+    /**
+     * Whether prices in this region include taxes by default.
+     *
+     * Learn more in the [tax-inclusive pricing](https://docs.medusajs.com/resources/commerce-modules/pricing/tax-inclusive-pricing#content) documentation.
+     */
     is_tax_inclusive?: boolean;
+    /**
+     * The IDs of the payment providers that are available in this region. The IDs are
+     * of the format `pp_{identifier}_{id}`.
+     *
+     * @example
+     * ["pp_stripe_stripe", "pp_system_default"]
+     */
     payment_providers?: string[];
+    /**
+     * Custom key-value pairs that can be added to the region.
+     */
     metadata?: Record<string, any> | null;
 }
 export interface AdminUpdateRegion {
+    /**
+     * The name of the region.
+     */
     name?: string;
+    /**
+     * The currency code of the region.
+     *
+     * @example
+     * "usd"
+     */
     currency_code?: string;
+    /**
+     * The 2 ISO code of the countries in the region.
+     *
+     * @example
+     * ["us", "ca"]
+     */
     countries?: string[];
+    /**
+     * Whether taxes are automatically calculated during checkout
+     * for this region.
+     */
     automatic_taxes?: boolean;
+    /**
+     * Whether prices in this region include taxes by default.
+     *
+     * Learn more in the [tax-inclusive pricing](https://docs.medusajs.com/resources/commerce-modules/pricing/tax-inclusive-pricing#content) documentation.
+     */
     is_tax_inclusive?: boolean;
+    /**
+     * The IDs of the payment providers that are available in this region. The IDs are
+     * of the format `pp_{identifier}_{id}`.
+     *
+     * @example
+     * ["pp_stripe_stripe", "pp_system_default"]
+     */
     payment_providers?: string[];
+    /**
+     * Custom key-value pairs that can be added to the region.
+     */
     metadata?: Record<string, any> | null;
 }
 //# sourceMappingURL=payloads.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/region/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,MAAM,CAAA;IACrB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;CACtC;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;CACtC"}
+{"version":3,"file":"payloads.d.ts","sourceRoot":"","sources":["../../../../src/http/region/admin/payloads.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;;;OAKG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;CACtC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IACpB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAA;CACtC"}

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

@@ -2,12 +2,33 @@ import { BaseFilterable, OperatorMap } from "../../../dal";
 import { FindParams } from "../../common";
 import { BaseRegionCountryFilters } from "../common";
 export interface AdminRegionFilters extends FindParams, BaseFilterable<AdminRegionFilters> {
+    /**
+     * Query or keywords to search the region's searchable fields.
+     */
     q?: string;
+    /**
+     * Filter by region ID(s).
+     */
     id?: string | string[];
+    /**
+     * Filter by currency code(s).
+     */
     currency_code?: string | string[];
+    /**
+     * Filter by region name(s).
+     */
     name?: string | string[];
+    /**
+     * Apply filters on the region's creation date.
+     */
     created_at?: OperatorMap<string>;
+    /**
+     * Apply filters on the region's update date.
+     */
     updated_at?: OperatorMap<string>;
+    /**
+     * Apply filters on the region's deletion date.
+     */
     deleted_at?: OperatorMap<string>;
 }
 export interface AdminRegionCountryFilters extends BaseRegionCountryFilters {

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

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/region/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAA;AAEpD,MAAM,WAAW,kBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,kBAAkB,CAAC;IACpC,CAAC,CAAC,EAAE,MAAM,CAAA;IACV,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACjC,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB,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;AACD,MAAM,WAAW,yBAA0B,SAAQ,wBAAwB;CAAG"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../../../src/http/region/admin/queries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,cAAc,CAAA;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EAAE,wBAAwB,EAAE,MAAM,WAAW,CAAA;AAEpD,MAAM,WAAW,kBACf,SAAQ,UAAU,EAChB,cAAc,CAAC,kBAAkB,CAAC;IACpC;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACxB;;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;AACD,MAAM,WAAW,yBAA0B,SAAQ,wBAAwB;CAAG"}

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

@@ -1,9 +1,15 @@
 import { DeleteResponse, PaginatedResponse } from "../../common";
 import { AdminRegion } from "./entities";
 export interface AdminRegionResponse {
+    /**
+     * The region's details.
+     */
     region: AdminRegion;
 }
 export type AdminRegionListResponse = PaginatedResponse<{
+    /**
+     * The list of regions.
+     */
     regions: AdminRegion[];
 }>;
 export type AdminRegionDeleteResponse = DeleteResponse<"region">;

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

@@ -1 +1 @@
-{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/region/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAExC,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;IACtD,OAAO,EAAE,WAAW,EAAE,CAAA;CACvB,CAAC,CAAA;AAEF,MAAM,MAAM,yBAAyB,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAA"}
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../../../src/http/region/admin/responses.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAExC,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,MAAM,EAAE,WAAW,CAAA;CACpB;AAED,MAAM,MAAM,uBAAuB,GAAG,iBAAiB,CAAC;IACtD;;OAEG;IACH,OAAO,EAAE,WAAW,EAAE,CAAA;CACvB,CAAC,CAAA;AAEF,MAAM,MAAM,yBAAyB,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAA"}