@medusajs/types 1.12.0-snapshot-20240405070935 → 1.12.0-snapshot-20240406075900

package/dist/promotion/common/compute-actions.d.ts

@@ -1,54 +1,189 @@
+/**
+ * @interface
+ *
+ * A compute action informs you what adjustment must be made to a cart item or shipping method.
+ */
 export type ComputeActions = AddItemAdjustmentAction | RemoveItemAdjustmentAction | AddShippingMethodAdjustment | RemoveShippingMethodAdjustment | CampaignBudgetExceededAction;
+/**
+ * @interface
+ *
+ * These computed action types can affect a campaign's budget.
+ */
 export type UsageComputedActions = AddShippingMethodAdjustment | AddItemAdjustmentAction;
+/**
+ * This action indicates that the promotions within a campaign can no longer be used
+ * as the campaign budget has been exceeded.
+ */
 export interface CampaignBudgetExceededAction {
+    /**
+     * The type of action.
+     */
     action: "campaignBudgetExceeded";
+    /**
+     * The promotion's code.
+     */
     code: string;
 }
+/**
+ * This action indicates that an adjustment must be made to an item. For example, removing $5 off its amount.
+ */
 export interface AddItemAdjustmentAction {
+    /**
+     * The type of action.
+     */
     action: "addItemAdjustment";
+    /**
+     * The associated item's ID.
+     */
     item_id: string;
+    /**
+     * The amount to remove off the item's total.
+     */
     amount: number;
+    /**
+     * The promotion's code.
+     */
     code: string;
+    /**
+     * The promotion's description.
+     */
     description?: string;
 }
+/**
+ * This action indicates that an adjustment must be removed from a line item. For example, remove the $5 discount applied before.
+ */
 export interface RemoveItemAdjustmentAction {
+    /**
+     * The type of action.
+     */
     action: "removeItemAdjustment";
+    /**
+     * The associated adjustment's ID.
+     */
     adjustment_id: string;
+    /**
+     * The promotion's description.
+     */
     description?: string;
+    /**
+     * The promotion's code.
+     */
     code: string;
 }
+/**
+ * This action indicates that an adjustment must be made on a shipping method. For example, make the shipping method free.
+ */
 export interface AddShippingMethodAdjustment {
+    /**
+     * The type of action.
+     */
     action: "addShippingMethodAdjustment";
+    /**
+     * The associated shipping method's ID.
+     */
     shipping_method_id: string;
+    /**
+     * The amount to remove off the shipping method's total.
+     */
     amount: number;
+    /**
+     * The promotion's code.
+     */
     code: string;
+    /**
+     * The promotion's description.
+     */
     description?: string;
 }
+/**
+ * This action indicates that an adjustment must be removed from a shipping method. For example, remove the free shipping discount applied before.
+ */
 export interface RemoveShippingMethodAdjustment {
+    /**
+     * The type of action
+     */
     action: "removeShippingMethodAdjustment";
+    /**
+     * The associated adjustment's ID.
+     */
     adjustment_id: string;
+    /**
+     * The promotion's code.
+     */
     code: string;
 }
+/**
+ * An action's adjustment line.
+ */
 export interface ComputeActionAdjustmentLine extends Record<string, unknown> {
+    /**
+     * The ID of the compute action's adjustment line.
+     */
     id: string;
+    /**
+     * The promotion's code.
+     */
     code: string;
 }
+/**
+ * A cart's line item passed in the context when computing actions.
+ */
 export interface ComputeActionItemLine extends Record<string, unknown> {
+    /**
+     * The ID of the item line.
+     */
     id: string;
+    /**
+     * The quantity of the line item.
+     */
     quantity: number;
+    /**
+     * The subtotal of the line item.
+     */
     subtotal: number;
+    /**
+     * The adjustments applied before on the line item.
+     */
     adjustments?: ComputeActionAdjustmentLine[];
 }
+/**
+ * A cart's shipping method passed in the content when computing actions.
+ */
 export interface ComputeActionShippingLine extends Record<string, unknown> {
+    /**
+     * The ID of the shipping method.
+     */
     id: string;
+    /**
+     * The subtotal of the shipping method.
+     */
     subtotal: number;
+    /**
+     * The adjustments applied before on the shipping method.
+     */
     adjustments?: ComputeActionAdjustmentLine[];
 }
+/**
+ * The context provided when computing actions of promotions.
+ */
 export interface ComputeActionContext extends Record<string, unknown> {
+    /**
+     * The cart's line items.
+     */
     items?: ComputeActionItemLine[];
+    /**
+     * The cart's shipping methods.
+     */
     shipping_methods?: ComputeActionShippingLine[];
 }
+/**
+ * Options to configure how actions are computed.
+ */
 export interface ComputeActionOptions {
+    /**
+     * Whether to apply promotions having their `is_automatic` field enabled
+     * automatically. If not provided, the automatic promotions are applied.
+     */
     prevent_auto_promotions?: boolean;
 }
 //# sourceMappingURL=compute-actions.d.ts.map

package/dist/promotion/common/compute-actions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"compute-actions.d.ts","sourceRoot":"","sources":["../../../src/promotion/common/compute-actions.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,cAAc,GACtB,uBAAuB,GACvB,0BAA0B,GAC1B,2BAA2B,GAC3B,8BAA8B,GAC9B,4BAA4B,CAAA;AAEhC,MAAM,MAAM,oBAAoB,GAC5B,2BAA2B,GAC3B,uBAAuB,CAAA;AAE3B,MAAM,WAAW,4BAA4B;IAC3C,MAAM,EAAE,wBAAwB,CAAA;IAChC,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,mBAAmB,CAAA;IAC3B,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,0BAA0B;IACzC,MAAM,EAAE,sBAAsB,CAAA;IAC9B,aAAa,EAAE,MAAM,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,6BAA6B,CAAA;IACrC,kBAAkB,EAAE,MAAM,CAAA;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,8BAA8B;IAC7C,MAAM,EAAE,gCAAgC,CAAA;IACxC,aAAa,EAAE,MAAM,CAAA;IACrB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,2BAA4B,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC1E,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,qBAAsB,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACpE,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,2BAA2B,EAAE,CAAA;CAC5C;AAED,MAAM,WAAW,yBAA0B,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACxE,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,2BAA2B,EAAE,CAAA;CAC5C;AAED,MAAM,WAAW,oBAAqB,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACnE,KAAK,CAAC,EAAE,qBAAqB,EAAE,CAAA;IAC/B,gBAAgB,CAAC,EAAE,yBAAyB,EAAE,CAAA;CAC/C;AAED,MAAM,WAAW,oBAAoB;IACnC,uBAAuB,CAAC,EAAE,OAAO,CAAA;CAClC"}
+{"version":3,"file":"compute-actions.d.ts","sourceRoot":"","sources":["../../../src/promotion/common/compute-actions.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACtB,uBAAuB,GACvB,0BAA0B,GAC1B,2BAA2B,GAC3B,8BAA8B,GAC9B,4BAA4B,CAAA;AAEhC;;;;GAIG;AACH,MAAM,MAAM,oBAAoB,GAC5B,2BAA2B,GAC3B,uBAAuB,CAAA;AAE3B;;;GAGG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,MAAM,EAAE,wBAAwB,CAAA;IAEhC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAA;IAE3B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,MAAM,EAAE,sBAAsB,CAAA;IAE9B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,MAAM,EAAE,6BAA6B,CAAA;IAErC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,MAAM,EAAE,gCAAgC,CAAA;IAExC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC1E;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACpE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,2BAA2B,EAAE,CAAA;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACxE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,2BAA2B,EAAE,CAAA;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACnE;;OAEG;IACH,KAAK,CAAC,EAAE,qBAAqB,EAAE,CAAA;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,yBAAyB,EAAE,CAAA;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAA;CAClC"}

package/dist/promotion/common/promotion-rule-value.d.ts

@@ -1,17 +1,47 @@
 import { BaseFilterable } from "../../dal";
 import { PromotionRuleDTO } from "./promotion-rule";
+/**
+ * The promotion rule value details.
+ */
 export interface PromotionRuleValueDTO {
+    /**
+     * The ID of the promotion rule value.
+     */
     id: string;
+    /**
+     * The value of the promotion rule value.
+     */
     value?: string;
 }
+/**
+ * The promotion rule value to be created.
+ */
 export interface CreatePromotionRuleValueDTO {
+    /**
+     * The value of the promotion rule value.
+     */
     value: string;
+    /**
+     * The associated promotion rule.
+     */
     promotion_rule: PromotionRuleDTO;
 }
+/**
+ * The attributes to update in the promotion rule value.
+ */
 export interface UpdatePromotionRuleValueDTO {
+    /**
+     * The ID of the promotion rule value.
+     */
     id: string;
 }
+/**
+ * The filters to apply on the retrieved promotion rule values.
+ */
 export interface FilterablePromotionRuleValueProps extends BaseFilterable<FilterablePromotionRuleValueProps> {
+    /**
+     * The IDs to filter the promotion rule values by.
+     */
     id?: string[];
 }
 //# sourceMappingURL=promotion-rule-value.d.ts.map

package/dist/promotion/common/promotion-rule-value.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"promotion-rule-value.d.ts","sourceRoot":"","sources":["../../../src/promotion/common/promotion-rule-value.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAEnD,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,2BAA2B;IAC1C,KAAK,EAAE,MAAM,CAAA;IACb,cAAc,EAAE,gBAAgB,CAAA;CACjC;AAED,MAAM,WAAW,2BAA2B;IAC1C,EAAE,EAAE,MAAM,CAAA;CACX;AAED,MAAM,WAAW,iCACf,SAAQ,cAAc,CAAC,iCAAiC,CAAC;IACzD,EAAE,CAAC,EAAE,MAAM,EAAE,CAAA;CACd"}
+{"version":3,"file":"promotion-rule-value.d.ts","sourceRoot":"","sources":["../../../src/promotion/common/promotion-rule-value.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC1C,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAEnD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,cAAc,EAAE,gBAAgB,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,iCACf,SAAQ,cAAc,CAAC,iCAAiC,CAAC;IACzD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,EAAE,CAAA;CACd"}

package/dist/promotion/common/promotion-rule.d.ts

@@ -1,31 +1,108 @@
 import { BaseFilterable } from "../../dal";
 import { PromotionRuleValueDTO } from "./promotion-rule-value";
+/**
+ * @interface
+ *
+ * The possible operators to use in a promotion rule.
+ */
 export type PromotionRuleOperatorValues = "gt" | "lt" | "eq" | "ne" | "in" | "lte" | "gte";
+/**
+ * The promotion rule details.
+ */
 export interface PromotionRuleDTO {
+    /**
+     * The ID of the promotion rule.
+     */
     id: string;
+    /**
+     * The description of the promotion rule.
+     */
     description?: string | null;
+    /**
+     * The attribute of the promotion rule.
+     */
     attribute?: string;
+    /**
+     * The operator of the promotion rule.
+     */
     operator?: PromotionRuleOperatorValues;
+    /**
+     * The values of the promotion rule.
+     */
     values: PromotionRuleValueDTO[];
 }
+/**
+ * The promotion rule to be created.
+ */
 export interface CreatePromotionRuleDTO {
+    /**
+     * The description of the promotion rule.
+     */
     description?: string | null;
+    /**
+     * The attribute of the promotion rule.
+     */
     attribute: string;
+    /**
+     * The operator of the promotion rule.
+     */
     operator: PromotionRuleOperatorValues;
+    /**
+     * The values of the promotion rule.
+     * When provided, `PromotionRuleValue` records are
+     * created and associated with the promotion rule.
+     */
     values: string[] | string;
 }
+/**
+ * The attributes to update in the promotion rule.
+ */
 export interface UpdatePromotionRuleDTO {
+    /**
+     * The ID of the promotion rule.
+     */
     id: string;
+    /**
+     * The description of the promotion rule.
+     */
     description?: string | null;
+    /**
+     * The attribute of the promotion rule.
+     */
     attribute?: string;
+    /**
+     * The operator of the promotion rule.
+     */
     operator?: PromotionRuleOperatorValues;
+    /**
+     * The values of the promotion rule.
+     * When provided, `PromotionRuleValue` records are
+     * created and associated with the promotion rule.
+     */
     values?: string[] | string;
 }
+/**
+ * The details required when removing a promotion rule.
+ */
 export interface RemovePromotionRuleDTO {
+    /**
+     * The ID of the promotion rule to remove.
+     */
     id: string;
 }
+/**
+ * The filters to apply on the retrieved promotion rules.
+ */
 export interface FilterablePromotionRuleProps extends BaseFilterable<FilterablePromotionRuleProps> {
+    /**
+     * The IDs to filter the promotion rules by.
+     */
     id?: string[];
 }
+/**
+ * @interface
+ *
+ * The promotion rule's possible types.
+ */
 export type PromotionRuleTypes = "buy_rules" | "target_rules" | "rules";
 //# sourceMappingURL=promotion-rule.d.ts.map

package/dist/promotion/common/promotion-rule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"promotion-rule.d.ts","sourceRoot":"","sources":["../../../src/promotion/common/promotion-rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC1C,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAA;AAE9D,MAAM,MAAM,2BAA2B,GACnC,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,KAAK,CAAA;AAET,MAAM,WAAW,gBAAgB;IAC/B,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,qBAAqB,EAAE,CAAA;CAChC;AAED,MAAM,WAAW,sBAAsB;IACrC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,2BAA2B,CAAA;IACrC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;CAC1B;AAED,MAAM,WAAW,sBAAsB;IACrC,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,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;CAC3B;AAED,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAA;CACX;AAED,MAAM,WAAW,4BACf,SAAQ,cAAc,CAAC,4BAA4B,CAAC;IACpD,EAAE,CAAC,EAAE,MAAM,EAAE,CAAA;CACd;AAED,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,cAAc,GAAG,OAAO,CAAA"}
+{"version":3,"file":"promotion-rule.d.ts","sourceRoot":"","sources":["../../../src/promotion/common/promotion-rule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC1C,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAA;AAE9D;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GACnC,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,KAAK,GACL,KAAK,CAAA;AAET;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAA;IAEtC;;OAEG;IACH,MAAM,EAAE,qBAAqB,EAAE,CAAA;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,QAAQ,EAAE,2BAA2B,CAAA;IAErC;;;;OAIG;IACH,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,2BAA2B,CAAA;IAEtC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,GAAG,MAAM,CAAA;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,4BACf,SAAQ,cAAc,CAAC,4BAA4B,CAAC;IACpD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,EAAE,CAAA;CACd;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,cAAc,GAAG,OAAO,CAAA"}

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

@@ -3,38 +3,138 @@ import { CreateCampaignDTO } from "../mutations";
 import { ApplicationMethodDTO, CreateApplicationMethodDTO, UpdateApplicationMethodDTO } from "./application-method";
 import { CampaignDTO } from "./campaign";
 import { CreatePromotionRuleDTO, PromotionRuleDTO } from "./promotion-rule";
+/**
+ * @interface
+ *
+ * The promotion's possible types.
+ */
 export type PromotionTypeValues = "standard" | "buyget";
+/**
+ * The promotion details.
+ */
 export interface PromotionDTO {
+    /**
+     * The ID of the promotion.
+     */
     id: string;
+    /**
+     * The code of the promotion.
+     */
     code?: string;
+    /**
+     * The type of the promotion:
+     *
+     * - `standard` indicates that a promotion is a standard one applied with conditions.
+     * - `buyget` indicates that a promotion is a "Buy X get Y" promotion.
+     *
+     */
     type?: PromotionTypeValues;
+    /**
+     * Whether the promotion is applied automatically.
+     */
     is_automatic?: boolean;
+    /**
+     * The associated application method.
+     */
     application_method?: ApplicationMethodDTO;
+    /**
+     * The rules of the promotion.
+     */
     rules?: PromotionRuleDTO[];
+    /**
+     * The associated campaign.
+     */
     campaign?: CampaignDTO;
 }
+/**
+ * The promotion to be created.
+ */
 export interface CreatePromotionDTO {
+    /**
+     * The code of the promotion.
+     */
     code: string;
+    /**
+     * The type of the promotion:
+     *
+     * - `standard` indicates that a promotion is a standard one applied with conditions.
+     * - `buyget` indicates that a promotion is a "Buy X get Y" promotion.
+     *
+     */
     type: PromotionTypeValues;
+    /**
+     * Whether the promotion is applied automatically.
+     */
     is_automatic?: boolean;
+    /**
+     * The associated application method.
+     */
     application_method?: CreateApplicationMethodDTO;
+    /**
+     * The rules of the promotion.
+     */
     rules?: CreatePromotionRuleDTO[];
+    /**
+     * The associated campaign.
+     */
     campaign?: CreateCampaignDTO;
+    /**
+     * The associated campaign's ID.
+     */
     campaign_id?: string;
 }
+/**
+ * The attributes to update in the promotion.
+ */
 export interface UpdatePromotionDTO {
+    /**
+     * The ID of the promotion.
+     */
     id: string;
+    /**
+     * Whether the promotion is applied automatically.
+     */
     is_automatic?: boolean;
+    /**
+     * The code of the promotion.
+     */
     code?: string;
+    /**
+     * The type of the promotion.
+     */
     type?: PromotionTypeValues;
+    /**
+     * The associated application method.
+     */
     application_method?: UpdateApplicationMethodDTO;
+    /**
+     * The associated campaign's ID.
+     */
     campaign_id?: string;
 }
+/**
+ * The filters to apply on the retrieved promotions.
+ */
 export interface FilterablePromotionProps extends BaseFilterable<FilterablePromotionProps> {
+    /**
+     * The IDs to filter the promotions by.
+     */
     id?: string | string[];
+    /**
+     * Filter promotions by their code.
+     */
     code?: string | string[] | OperatorMap<string>;
+    /**
+     * Filter promotions by the ID of their associated campaign budget.
+     */
     budget_id?: string[] | OperatorMap<string>;
+    /**
+     * Filter promotions by whether they're applied automatically.
+     */
     is_automatic?: boolean;
+    /**
+     * Filter promotions by their type.
+     */
     type?: PromotionTypeValues[];
 }
 //# sourceMappingURL=promotion.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"promotion.d.ts","sourceRoot":"","sources":["../../../src/promotion/common/promotion.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EACL,oBAAoB,EACpB,0BAA0B,EAC1B,0BAA0B,EAC3B,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACxC,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAE3E,MAAM,MAAM,mBAAmB,GAAG,UAAU,GAAG,QAAQ,CAAA;AAEvD,MAAM,WAAW,YAAY;IAC3B,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,oBAAoB,CAAA;IACzC,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAC1B,QAAQ,CAAC,EAAE,WAAW,CAAA;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,mBAAmB,CAAA;IACzB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,kBAAkB,CAAC,EAAE,0BAA0B,CAAA;IAC/C,KAAK,CAAC,EAAE,sBAAsB,EAAE,CAAA;IAChC,QAAQ,CAAC,EAAE,iBAAiB,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,mBAAmB,CAAA;IAC1B,kBAAkB,CAAC,EAAE,0BAA0B,CAAA;IAC/C,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,wBACf,SAAQ,cAAc,CAAC,wBAAwB,CAAC;IAChD,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACtB,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC9C,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAC1C,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,IAAI,CAAC,EAAE,mBAAmB,EAAE,CAAA;CAC7B"}
+{"version":3,"file":"promotion.d.ts","sourceRoot":"","sources":["../../../src/promotion/common/promotion.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EACL,oBAAoB,EACpB,0BAA0B,EAC1B,0BAA0B,EAC3B,MAAM,sBAAsB,CAAA;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AACxC,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAE3E;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,UAAU,GAAG,QAAQ,CAAA;AAEvD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAA;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,kBAAkB,CAAC,EAAE,oBAAoB,CAAA;IAEzC;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;;;;;OAMG;IACH,IAAI,EAAE,mBAAmB,CAAA;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,kBAAkB,CAAC,EAAE,0BAA0B,CAAA;IAE/C;;OAEG;IACH,KAAK,CAAC,EAAE,sBAAsB,EAAE,CAAA;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAA;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAA;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,0BAA0B,CAAA;IAE/C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,wBACf,SAAQ,cAAc,CAAC,wBAAwB,CAAC;IAChD;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE9C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,CAAC,CAAA;IAE1C;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,EAAE,CAAA;CAC7B"}

package/dist/promotion/mutations.d.ts

@@ -1,34 +1,118 @@
 import { CampaignBudgetTypeValues, PromotionDTO } from "./common";
+/**
+ * The campaign budget to be created.
+ */
 export interface CreateCampaignBudgetDTO {
+    /**
+     * The type of the campaign budget.
+     */
     type: CampaignBudgetTypeValues;
+    /**
+     * The limit of the campaign budget.
+     */
     limit: number | null;
+    /**
+     * How much is used of the campaign budget.
+     */
     used?: number;
 }
+/**
+ * The attributes to update in the campaign budget.
+ */
 export interface UpdateCampaignBudgetDTO {
+    /**
+     * The ID of the campaign budget.
+     */
     id: string;
+    /**
+     * The type of the campaign budget.
+     */
     type?: CampaignBudgetTypeValues;
+    /**
+     * The limit of the campaign budget.
+     */
     limit?: number | null;
+    /**
+     * How much is used of the campaign budget.
+     */
     used?: number;
 }
+/**
+ * The campaign to be created.
+ */
 export interface CreateCampaignDTO {
+    /**
+     * The name of the campaign.
+     */
     name: string;
+    /**
+     * The description of the campaign.
+     */
     description?: string;
+    /**
+     * The currency of the campaign.
+     */
     currency?: string;
+    /**
+     * The campaign identifier of the campaign.
+     */
     campaign_identifier: string;
+    /**
+     * The start date of the campaign.
+     */
     starts_at: Date;
+    /**
+     * The end date of the campaign.
+     */
     ends_at: Date;
+    /**
+     * The associated campaign budget.
+     */
     budget?: CreateCampaignBudgetDTO;
+    /**
+     * The promotions of the campaign.
+     */
     promotions?: Pick<PromotionDTO, "id">[];
 }
+/**
+ * The attributes to update in the campaign.
+ */
 export interface UpdateCampaignDTO {
+    /**
+     * The ID of the campaign.
+     */
     id: string;
+    /**
+     * The name of the campaign.
+     */
     name?: string;
+    /**
+     * The description of the campaign.
+     */
     description?: string;
+    /**
+     * The currency of the campaign.
+     */
     currency?: string;
+    /**
+     * The campaign identifier of the campaign.
+     */
     campaign_identifier?: string;
+    /**
+     * The start date of the campaign.
+     */
     starts_at?: Date;
+    /**
+     * The end date of the campaign.
+     */
     ends_at?: Date;
+    /**
+     * The budget of the campaign.
+     */
     budget?: Omit<UpdateCampaignBudgetDTO, "id">;
+    /**
+     * The promotions of the campaign.
+     */
     promotions?: Pick<PromotionDTO, "id">[];
 }
 //# sourceMappingURL=mutations.d.ts.map

package/dist/promotion/mutations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/promotion/mutations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAEjE,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,wBAAwB,CAAA;IAC9B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,wBAAwB,CAAA;IAC/B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,SAAS,EAAE,IAAI,CAAA;IACf,OAAO,EAAE,IAAI,CAAA;IACb,MAAM,CAAC,EAAE,uBAAuB,CAAA;IAChC,UAAU,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,EAAE,CAAA;CACxC;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,SAAS,CAAC,EAAE,IAAI,CAAA;IAChB,OAAO,CAAC,EAAE,IAAI,CAAA;IACd,MAAM,CAAC,EAAE,IAAI,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAA;IAC5C,UAAU,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,EAAE,CAAA;CACxC"}
+{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/promotion/mutations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAEjE;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,IAAI,EAAE,wBAAwB,CAAA;IAE9B;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,CAAC,EAAE,wBAAwB,CAAA;IAE/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAA;IAE3B;;OAEG;IACH,SAAS,EAAE,IAAI,CAAA;IAEf;;OAEG;IACH,OAAO,EAAE,IAAI,CAAA;IAEb;;OAEG;IACH,MAAM,CAAC,EAAE,uBAAuB,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,EAAE,CAAA;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,IAAI,CAAA;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAA;IAE5C;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,EAAE,CAAA;CACxC"}