@acmekit/types 2.13.2 → 2.13.3

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

@@ -1,214 +0,0 @@
-import { BaseFilterable, OperatorMap } from "../../dal";
-import { CreateCampaignDTO } from "../mutations";
-import { ApplicationMethodDTO, CreateApplicationMethodDTO, UpdateApplicationMethodDTO } from "./application-method";
-import { CampaignDTO, FilterableCampaignProps } from "./campaign";
-import { CreatePromotionRuleDTO, PromotionRuleDTO } from "./promotion-rule";
-/**
- * The promotion's possible types.
- */
-export type PromotionTypeValues = "standard" | "buyget";
-/**
- * The promotion's possible types.
- */
-export type PromotionStatusValues = "draft" | "active" | "inactive";
-/**
- * The promotion's possible rule types.
- */
-export type RuleTypeValues = "rules" | "buy-rules" | "target-rules";
-/**
- * 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;
-    /**
-     * The status of the promotion:
-     *
-     * - `active` promotion is available for user to consume
-     * - `inactive` promotion is no longer available to the user
-     * - `draft` promotion is currently being prepared
-     */
-    status?: PromotionStatusValues;
-    /**
-     * Whether the promotion is applied automatically.
-     */
-    is_automatic?: boolean;
-    /**
-     * Whether the promotion is tax inclusive.
-     */
-    is_tax_inclusive?: boolean;
-    /**
-     * The maximum number of times this promotion can be used across all orders.
-     */
-    limit?: number | null;
-    /**
-     * The number of times this promotion has been used in completed orders.
-     */
-    used?: number;
-    /**
-     * The associated application method.
-     */
-    application_method?: ApplicationMethodDTO;
-    /**
-     * The rules of the promotion.
-     */
-    rules?: PromotionRuleDTO[];
-    /**
-     * The associated campaign.
-     */
-    campaign_id?: string | null;
-    /**
-     * 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;
-    /**
-     * The status of the promotion:
-     *
-     * - `draft` indicates that a promotion is currently being prepared
-     * - `active` indicates that a promotion is active
-     * - `inactive` indicates that a promotion is no longer active
-     */
-    status: PromotionStatusValues;
-    /**
-     * Whether the promotion is applied automatically.
-     */
-    is_automatic?: boolean;
-    /**
-     * Whether the promotion is tax inclusive.
-     */
-    is_tax_inclusive?: boolean;
-    /**
-     * The maximum number of times this promotion can be used.
-     */
-    limit?: number | null;
-    /**
-     * 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;
-    /**
-     * Whether the promotion is tax inclusive.
-     */
-    is_tax_inclusive?: boolean;
-    /**
-     * The maximum number of times this promotion can be used.
-     */
-    limit?: number | null;
-    /**
-     * The status of the promotion:
-     *
-     * - `draft` indicates that a promotion is currently being prepared
-     * - `active` indicates that a promotion is active
-     * - `inactive` indicates that a promotion is no longer active
-     */
-    status?: PromotionStatusValues;
-    /**
-     * The associated application method.
-     */
-    application_method?: Omit<UpdateApplicationMethodDTO, "id">;
-    /**
-     * The associated campaign's ID.
-     */
-    campaign_id?: string | null;
-}
-/**
- * The filters to apply on the retrieved promotions.
- */
-export interface FilterablePromotionProps extends BaseFilterable<FilterablePromotionProps> {
-    /**
-     * The IDs to filter the promotions by.
-     */
-    q?: string;
-    /**
-     * 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[];
-    /**
-     * Filter promotions by their status.
-     */
-    status?: PromotionStatusValues[];
-    /**
-     * Filter promotions by their campaign
-     */
-    campaign?: FilterableCampaignProps;
-}
-//# sourceMappingURL=promotion.d.ts.map

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

@@ -1 +0,0 @@
-{"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,uBAAuB,EAAE,MAAM,YAAY,CAAA;AACjE,OAAO,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAE3E;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,UAAU,GAAG,QAAQ,CAAA;AAEvD;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,OAAO,GAAG,QAAQ,GAAG,UAAU,CAAA;AAEnE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,WAAW,GAAG,cAAc,CAAA;AAEnE;;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;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAA;IAE9B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,kBAAkB,CAAC,EAAE,oBAAoB,CAAA;IAEzC;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,EAAE,CAAA;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B;;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;;;;;;OAMG;IACH,MAAM,EAAE,qBAAqB,CAAA;IAE7B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,kBAAkB,EAAE,0BAA0B,CAAA;IAE9C;;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,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,qBAAqB,CAAA;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,IAAI,CAAC,0BAA0B,EAAE,IAAI,CAAC,CAAA;IAE3D;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,wBACf,SAAQ,cAAc,CAAC,wBAAwB,CAAC;IAChD;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IAEV;;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;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,qBAAqB,EAAE,CAAA;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,uBAAuB,CAAA;CACnC"}

package/dist/promotion/common/promotion.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=promotion.js.map

package/dist/promotion/common/promotion.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"promotion.js","sourceRoot":"","sources":["../../../src/promotion/common/promotion.ts"],"names":[],"mappings":""}

package/dist/promotion/http.d.ts

@@ -1,16 +0,0 @@
-export type AdminGetPromotionRulesRes = {
-    id?: string;
-    attribute: string;
-    attribute_label: string;
-    field_type?: string;
-    operator: string;
-    hydrate: boolean;
-    operator_label: string;
-    values: {
-        label?: string;
-        value?: string;
-    }[];
-    disguised?: boolean;
-    required?: boolean;
-}[];
-//# sourceMappingURL=http.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../src/promotion/http.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,yBAAyB,GAAG;IACtC,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;IACjB,eAAe,EAAE,MAAM,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,cAAc,EAAE,MAAM,CAAA;IACtB,MAAM,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;IAC5C,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACnB,EAAE,CAAA"}

package/dist/promotion/http.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=http.js.map

package/dist/promotion/http.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"http.js","sourceRoot":"","sources":["../../src/promotion/http.ts"],"names":[],"mappings":""}

package/dist/promotion/index.d.ts

@@ -1,6 +0,0 @@
-export * from "./common";
-export * from "./http";
-export * from "./mutations";
-export * from "./service";
-export * from "./workflows";
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/promotion/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,QAAQ,CAAA;AACtB,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,aAAa,CAAA"}

package/dist/promotion/index.js

@@ -1,22 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./common"), exports);
-__exportStar(require("./http"), exports);
-__exportStar(require("./mutations"), exports);
-__exportStar(require("./service"), exports);
-__exportStar(require("./workflows"), exports);
-//# sourceMappingURL=index.js.map

package/dist/promotion/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/promotion/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB;AACxB,yCAAsB;AACtB,8CAA2B;AAC3B,4CAAyB;AACzB,8CAA2B"}

package/dist/promotion/mutations.d.ts

@@ -1,140 +0,0 @@
-import { CampaignBudgetTypeValues } 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 currency of the campaign.
-     */
-    currency_code?: string | null;
-    /**
-     * The attribute that the budget limit is applied to. By default,
-     * the budget is applied globally. If the type is `use_by_attribute`, this field indicates the
-     * attribute the budget is tracked by. For example, `customer_id` means the budget is tracked per customer.
-     *
-     * @example
-     * customer_id
-     * @since 2.11.0
-     */
-    attribute?: string | null;
-}
-/**
- * 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;
-    /**
-     * The limit of the campaign budget.
-     */
-    currency_code?: string | 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 | null;
-    /**
-     * The campaign identifier of the campaign.
-     */
-    campaign_identifier: string;
-    /**
-     * The start date of the campaign.
-     */
-    starts_at?: Date | null;
-    /**
-     * The end date of the campaign.
-     */
-    ends_at?: Date | null;
-    /**
-     * The associated campaign budget.
-     */
-    budget?: CreateCampaignBudgetDTO | null;
-}
-/**
- * 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 | null;
-    /**
-     * The campaign identifier of the campaign.
-     */
-    campaign_identifier?: string;
-    /**
-     * The start date of the campaign.
-     */
-    starts_at?: Date | null;
-    /**
-     * The end date of the campaign.
-     */
-    ends_at?: Date | null;
-    /**
-     * The budget of the campaign.
-     */
-    budget?: Omit<UpdateCampaignBudgetDTO, "id">;
-}
-export interface AddPromotionsToCampaignDTO {
-    /**
-     * The ID of the campaign.
-     */
-    id: string;
-    /**
-     * Ids of promotions to add
-     */
-    promotion_ids: string[];
-}
-export interface RemovePromotionsFromCampaignDTO {
-    /**
-     * The ID of the campaign.
-     */
-    id: string;
-    /**
-     * Ids of promotions to add
-     */
-    promotion_ids: string[];
-}
-//# sourceMappingURL=mutations.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/promotion/mutations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,UAAU,CAAA;AAEnD;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;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;IAEb;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE7B;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC1B;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,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE7B;;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,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAA;IAE3B;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,uBAAuB,GAAG,IAAI,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,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAA;IAErB;;OAEG;IACH,MAAM,CAAC,EAAE,IAAI,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAA;CAC7C;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAA;CACxB;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAA;CACxB"}

package/dist/promotion/mutations.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=mutations.js.map

package/dist/promotion/mutations.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"mutations.js","sourceRoot":"","sources":["../../src/promotion/mutations.ts"],"names":[],"mappings":""}