@voucherify/sdk 2.5.0 → 2.7.0

package/dist/types/DiscountVoucher.d.ts

@@ -5,9 +5,9 @@ export declare enum DiscountVouchersTypesEnum {
     UNIT = "UNIT",
     FIXED = "FIXED"
 }
-export declare type DiscountVouchersEffectTypes = 'ADD_MISSING_ITEMS' | 'ADD_NEW_ITEMS' | 'ADD_MANY_ITEMS' | 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS' | 'APPLY_TO_ITEMS_PROPORTIONALLY' | 'APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY';
+export declare type DiscountVouchersEffectTypes = 'ADD_MISSING_ITEMS' | 'ADD_NEW_ITEMS' | 'ADD_MANY_ITEMS' | 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS' | 'APPLY_TO_ITEMS_PROPORTIONALLY' | 'APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY' | 'APPLY_TO_ITEMS_BY_QUANTITY';
 export declare type DiscountUnitVouchersEffectTypes = 'ADD_MISSING_ITEMS' | 'ADD_NEW_ITEMS' | 'ADD_MANY_ITEMS';
-export declare type DiscountAmountVouchersEffectTypes = 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS' | 'APPLY_TO_ITEMS_PROPORTIONALLY' | 'APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY';
+export declare type DiscountAmountVouchersEffectTypes = 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS' | 'APPLY_TO_ITEMS_PROPORTIONALLY' | 'APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY' | 'APPLY_TO_ITEMS_BY_QUANTITY';
 export declare type DiscountPercentVouchersEffectTypes = 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS';
 export declare type DiscountFixedVouchersEffectTypes = 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS';
 interface SimpleSkuDiscountUnit {
@@ -48,4 +48,46 @@ export interface DiscountFixed {
     fixed_amount_formula?: string;
     effect?: DiscountFixedVouchersEffectTypes;
 }
+export declare type Discount = DiscountAmount_ | DiscountUnit_ | DiscountUnitMultiple_ | DiscountPercent_ | DiscountFixed_;
+export declare type DiscountAmount_ = {
+    type: 'AMOUNT';
+    amount_off?: number;
+    amount_off_formula?: string;
+    aggregated_amount_limit?: number;
+    effect?: DiscountAmountVouchersEffectTypes;
+    is_dynamic?: boolean;
+};
+export declare type DiscountUnit_ = {
+    type: 'UNIT';
+} & DiscountUnitBase_;
+export declare type DiscountUnitBase_ = {
+    unit_off?: number;
+    unit_off_formula?: string;
+    unit_type: string;
+    product?: SimpleProductDiscountUnit;
+    sku?: SimpleSkuDiscountUnit;
+    effect?: 'ADD_MISSING_ITEMS' | 'ADD_NEW_ITEMS';
+    is_dynamic?: boolean;
+};
+export declare type DiscountUnitMultiple_ = {
+    type: 'UNIT';
+    effect: 'ADD_MANY_ITEMS';
+    units: DiscountUnitBase_[];
+};
+export declare type DiscountPercent_ = {
+    type: 'PERCENT';
+    percent_off?: number;
+    percent_off_formula?: string;
+    amount_limit?: number;
+    aggregated_amount_limit?: number;
+    effect?: DiscountPercentVouchersEffectTypes;
+    is_dynamic?: boolean;
+};
+export declare type DiscountFixed_ = {
+    type: 'FIXED';
+    fixed_amount?: number;
+    fixed_amount_formula?: string;
+    effect?: DiscountFixedVouchersEffectTypes;
+    is_dynamic?: boolean;
+};
 export {};

package/dist/types/Loyalties.d.ts

@@ -2,7 +2,7 @@ import { OrdersCreateResponse, OrdersItem } from './Orders';
 import { ProductsCreateResponse, ProductsCreateSkuResponse } from './Products';
 import { SimpleCustomer } from './Customers';
 import { ValidationRulesCreateAssignmentResponse } from './ValidationRules';
-import { VouchersResponse } from './Vouchers';
+import { VouchersExportTransactionsRequestBody, VouchersExportTransactionsResponseBody, VouchersResponse } from './Vouchers';
 import { Reward, RewardAssignment } from './Rewards';
 import { Category } from './Categories';
 interface LoyaltiesVoucher {
@@ -559,31 +559,7 @@ export interface LoyaltiesListCardTransactionsResponseBody {
     data: LoyaltyCardTransaction[];
     has_more: boolean;
 }
-export interface LoyaltiesExportCardTransactionsRequestBody {
-    order?: 'created_at' | '-created_at';
-    fields?: LoyaltyCardTransactionsFields[];
-}
-export interface LoyaltiesExportCardTransactionsResponseBody {
-    id: string;
-    object: 'export';
-    created_at: string;
-    status: 'SCHEDULED';
-    channel: string;
-    exported_object: 'voucher_transactions';
-    parameters: {
-        order?: string;
-        fields?: LoyaltyCardTransactionsFields[];
-        filters: {
-            voucher_id: {
-                conditions: {
-                    $in: [string];
-                };
-            };
-        };
-    };
-    result: null;
-    user_id: null | string;
-}
+export declare type LoyaltiesExportCardTransactionsRequestBody = VouchersExportTransactionsRequestBody;
 export interface LoyaltiesAddOrRemoveCardBalanceRequestBody {
     points: number;
     expiration_date?: string;
@@ -608,7 +584,6 @@ export declare type LoyaltiesCreateTiersRequestBody = (LoyaltyTierBase & {
     metadata?: Record<string, unknown>;
 })[];
 export declare type LoyaltiesCreateTiersResponseBody = LoyaltyTier[];
-export declare type LoyaltiesGetRewardAssignmentResponseBody = RewardAssignment;
 export declare type LoyaltiesGetRewardDetailsResponseBody = Reward;
 export interface LoyaltiesListTiersRequestQuery {
     limit?: number;
@@ -679,31 +654,7 @@ export interface LoyaltiesListCardTransactionsResponseBody {
     data: LoyaltyCardTransaction[];
     has_more: boolean;
 }
-export interface LoyaltiesExportCardTransactionsRequestBody {
-    order?: 'created_at' | '-created_at';
-    fields?: LoyaltyCardTransactionsFields[];
-}
-export interface LoyaltiesExportCardTransactionsResponseBody {
-    id: string;
-    object: 'export';
-    created_at: string;
-    status: 'SCHEDULED';
-    channel: string;
-    exported_object: 'voucher_transactions';
-    parameters: {
-        order?: string;
-        fields?: LoyaltyCardTransactionsFields[];
-        filters: {
-            voucher_id: {
-                conditions: {
-                    $in: [string];
-                };
-            };
-        };
-    };
-    result: null;
-    user_id: null | string;
-}
+export declare type LoyaltiesExportCardTransactionsResponseBody = VouchersExportTransactionsResponseBody;
 export interface LoyaltiesAddOrRemoveCardBalanceRequestBody {
     points: number;
     expiration_date?: string;
@@ -739,6 +690,30 @@ export declare type LoyaltiesListLoyaltyTierEarningRulesResponseBody = {
     data: EarningRule[];
     total: number;
 };
+export declare type LoyaltiesGetRewardAssignmentResponseBody = RewardAssignment;
+export interface LoyaltiesListLoyaltyTierRewardsResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    total: number;
+    data: {
+        reward: {
+            id: string;
+            name: string;
+            stock: number | null;
+            redeemed: number | null;
+            attributes?: {
+                image_url?: string;
+                description?: string;
+            };
+            metadata: Record<string, undefined>;
+            created_at: string;
+            updated_at: string | null;
+            object: 'reward';
+        } & LoyaltyTierRewardItemParameters;
+        assignment: RewardAssignment;
+        object: 'loyalty_tier_reward';
+    }[];
+}
 export interface LoyaltyTierBase {
     name: string;
     earning_rules?: Record<string, MappingMultiply | MappingFixed>;
@@ -779,72 +754,6 @@ interface MappingFixed {
     type: 'CUSTOM';
     points: number;
 }
-export interface LoyaltyCardTransaction {
-    id: string;
-    source_id: string | null;
-    voucher_id: string;
-    campaign_id: string;
-    source: string | null;
-    reason: string | null;
-    type: LoyaltyCardTransactionsType;
-    details: {
-        balance: {
-            type: 'loyalty_card';
-            total: number;
-            object: 'balance';
-            points: number;
-            balance: number;
-            related_object: {
-                id: string;
-                type: 'voucher';
-            };
-        };
-        order?: {
-            id: string;
-            source_id: string;
-        };
-        event?: {
-            id: string;
-            type: string;
-        };
-        earning_rule?: {
-            id: string;
-            source: {
-                banner: string;
-            };
-        };
-        segment?: {
-            id: string;
-            name: string;
-        };
-        loyalty_tier?: {
-            id: string;
-            name: string;
-        };
-        redemption?: {
-            id: string;
-        };
-        rollback?: {
-            id: string;
-        };
-        reward?: {
-            id: string;
-            name: string;
-        };
-        custom_event?: {
-            id: string;
-            type: string;
-        };
-        event_schema?: {
-            id: string;
-            name: string;
-        };
-        source_voucher?: SimpleLoyaltyVoucher;
-        destination_voucher?: SimpleLoyaltyVoucher;
-    };
-    related_transaction_id: string | null;
-    created_at: string;
-}
 export interface SimpleLoyaltyVoucher {
     id: string;
     code: string;
@@ -1094,4 +1003,38 @@ export interface EarningRuleProportionalCustomEvent {
         };
     };
 }
+export declare type LoyaltyTierRewardItemParameters = LoyaltyTierRewardItemCampaignParameters | LoyaltyTierRewardItemCoinParameters | LoyaltyTierRewardItemMaterialParameters;
+export interface LoyaltyTierRewardItemCampaignParameters {
+    type: 'CAMPAIGN';
+    parameters: {
+        campaign: LoyaltyTierRewardItemCampaignDiscountCoupons | LoyaltyTierRewardItemCampaignGiftVouchersAndLoyaltyProgram;
+    };
+}
+export interface LoyaltyTierRewardItemCoinParameters {
+    type: 'COIN';
+    parameters: {
+        coin: {
+            exchange_ratio: number;
+            points_ratio: number;
+        };
+    };
+}
+export interface LoyaltyTierRewardItemMaterialParameters {
+    type: 'MATERIAL';
+    parameters: {
+        product: {
+            id: string;
+            sku_id: string | null;
+        };
+    };
+}
+export interface LoyaltyTierRewardItemCampaignDiscountCoupons {
+    id: string;
+    type: string;
+}
+export interface LoyaltyTierRewardItemCampaignGiftVouchersAndLoyaltyProgram {
+    id: string;
+    balance: number;
+    type: string;
+}
 export {};

package/dist/types/Orders.d.ts

@@ -1,4 +1,4 @@
-import { CustomerRequest } from './Customers';
+import { Customer, CustomerId, CustomerRequest, CustomerWithSummaryLoyaltyReferrals, Referrer, ReferrerId, ReferrerWithSummaryLoyaltyReferrals } from './Customers';
 export interface OrdersItem {
     sku_id?: string;
     product_id?: string;
@@ -84,3 +84,112 @@ export interface OrdersListResponse {
     data_ref: 'orders';
     orders: OrdersGetResponse[];
 }
+export declare type Order = {
+    id?: string;
+    source_id?: string;
+    status?: 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED';
+    amount?: number;
+    discount_amount?: number;
+    initial_amount?: number;
+    items?: OrderItem[];
+    customer?: Customer;
+    customer_id?: string;
+    referrer?: Referrer;
+    referrer_id?: string;
+    metadata?: Record<string, any>;
+};
+export declare type OrderItem = {
+    sku_id?: string;
+    product_id?: string;
+    related_object?: 'product' | 'sku';
+    source_id?: string;
+    quantity?: number;
+    discount_quantity?: number;
+    initial_quantity?: number;
+    amount?: number;
+    discount_amount?: number;
+    initial_amount?: number;
+    price?: number;
+    product?: {
+        id?: string;
+        source_id?: string;
+        override?: boolean;
+        name?: string;
+        metadata?: Record<string, any>;
+        price?: number;
+    };
+    sku?: {
+        id?: string;
+        source_id?: string;
+        override?: boolean;
+        sku?: string;
+        price?: number;
+    };
+    metadata?: Record<string, any>;
+};
+export declare type OrderCalculated = {
+    id?: string;
+    source_id?: string | null;
+    created_at?: string;
+    updated_at?: string | null;
+    status?: 'CREATED' | 'PAID' | 'CANCELED' | 'FULFILLED';
+    amount?: number;
+    initial_amount?: number;
+    discount_amount?: number;
+    items_discount_amount?: number;
+    total_discount_amount?: number;
+    total_amount?: number;
+    applied_discount_amount?: number;
+    items_applied_discount_amount?: number;
+    total_applied_discount_amount?: number;
+    items?: OrderItemCalculated[];
+    metadata: Record<string, unknown>;
+    customer?: CustomerId | CustomerWithSummaryLoyaltyReferrals;
+    customer_id: string | null;
+    referrer?: ReferrerId | ReferrerWithSummaryLoyaltyReferrals;
+    referrer_id: string | null;
+    object: 'order';
+    redemptions?: Record<string, OrderRedemptions>;
+};
+export declare type OrderRedemptions = {
+    date?: string;
+    rollback_id?: string;
+    rollback_date?: string;
+    related_object_type?: string;
+    related_object_id?: string;
+    related_object_parent_id?: string;
+    stacked?: string[];
+    rollback_stacked?: string[];
+};
+export declare type OrderItemCalculated = {
+    sku_id?: string;
+    product_id?: string;
+    related_object?: 'product' | 'sku';
+    source_id?: string;
+    quantity?: number;
+    discount_quantity?: number;
+    initial_quantity?: number;
+    amount?: number;
+    discount_amount?: number;
+    initial_amount?: number;
+    total_applied_discount_amount?: number;
+    price?: number;
+    subtotal_amount?: number;
+    product?: {
+        id?: string;
+        source_id?: string;
+        override?: boolean;
+        name?: string;
+        metadata?: Record<string, any>;
+        price?: number;
+    };
+    sku?: {
+        id?: string;
+        source_id?: string;
+        override?: boolean;
+        sku?: string;
+        price?: number;
+    };
+    object: 'order_item';
+    metadata?: Record<string, any>;
+};

package/dist/types/PromotionsStacks.d.ts

@@ -0,0 +1,71 @@
+import { Category } from './Categories';
+export interface PromotionsStacksListInCampaignResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: PromotionStack[];
+    total: number;
+}
+export interface PromotionsStacksListResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: PromotionStack[];
+    total: number;
+}
+export interface PromotionsStacksListRequestQuery {
+    limit?: number;
+    page?: number;
+    order?: 'created_at' | '-created_at' | 'updated_at' | '-updated_at' | 'name' | '-name';
+    created_at?: {
+        before?: string;
+        after?: string;
+    };
+    updated_at?: {
+        before?: string;
+        after?: string;
+    };
+}
+export declare type PromotionsStacksGetResponseBody = PromotionStack;
+export declare type PromotionsStacksUpdateRequestBody = {
+    name: string;
+    tiers?: {
+        ids?: string[];
+        hierarchy_mode?: 'MANUAL';
+    };
+    category_id?: string;
+};
+export declare type PromotionsStacksUpdateResponseBody = PromotionStackBase & {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    campaign_id: string;
+    object: 'promotion_stack';
+    category_id: string | null;
+    categories: Category[];
+};
+export declare type PromotionsStacksCreateInCampaignRequestBody = PromotionStackBase & {
+    category_id?: string;
+};
+export declare type PromotionsStacksCreateInCampaignResponseBody = PromotionStackBase & {
+    id: string;
+    created_at: string;
+    campaign_id: string;
+    object: 'promotion_stack';
+    category_id: string | null;
+    categories: Category[];
+};
+export interface PromotionStackBase {
+    name: string;
+    tiers: {
+        ids: string[];
+        hierarchy_mode?: 'MANUAL';
+    };
+}
+export declare type PromotionStack = PromotionStackBase & {
+    id: string;
+    created_at: string;
+    updated_at?: string;
+    campaign_id: string;
+    object: 'promotion_stack';
+    category_id: string | null;
+    categories: Category[];
+};

package/dist/types/Qualifications.d.ts

@@ -0,0 +1,86 @@
+import { CustomerRequest } from './Customers';
+import { Junction } from './Exports';
+import { Order, OrderCalculated } from './Orders';
+import { ApplicableToResultList, InapplicableToResultList } from './ApplicableTo';
+import { Category } from './Categories';
+import { Discount } from './DiscountVoucher';
+import { LoyaltiesTransferPoints } from './Loyalties';
+import { ValidationRulesAssignmentsList } from './ValidationRules';
+export declare type QualificationsCheckEligibilityRequestBody = {
+    customer?: CustomerRequest;
+    order?: Order;
+    mode?: 'BASIC' | 'ADVANCED';
+    tracking_id?: string;
+    scenario?: 'ALL' | 'CUSTOMER_WALLET' | 'AUDIENCE_ONLY' | 'PRODUCTS' | 'PRODUCTS_DISCOUNT' | 'PROMOTION_STACKS' | 'PRODUCTS_BY_CUSTOMER' | 'PRODUCTS_DISCOUNT_BY_CUSTOMER';
+    options?: {
+        limit?: number;
+        starting_after?: string;
+        filters?: {
+            junction?: Junction;
+        } & Partial<Record<QualificationsFiltersFields, QualificationsFieldConditions>>;
+        expand?: ('redeemable' | 'category' | 'validation_rules')[];
+        sorting_rule?: 'BEST_DEAL' | 'LEAST_DEAL' | 'DEFAULT';
+    };
+    metadata?: Record<string, any>;
+};
+export declare type QualificationsCheckEligibilityResponseBody = {
+    redeemables: QualificationsRedeemableList;
+    tracking_id?: string;
+    order?: OrderCalculated;
+    stacking_rules: QualificationsStackingRules;
+};
+export declare type QualificationsFiltersFields = 'category_id' | 'campaign_id' | 'resource_id' | 'resource_type' | 'voucher_type' | 'code';
+export declare type QualificationsFiltersCondition = '$in' | '$not_in' | '$is' | '$is_not' | '$has_value' | '$is_unknown';
+export declare type QualificationsFieldConditions = {
+    conditions?: Partial<Record<QualificationsFiltersCondition, any>>;
+};
+export declare type QualificationsRedeemableList = {
+    object: 'list';
+    data_ref: 'data';
+    data: QualificationsRedeemable[];
+    total: number;
+    has_more: boolean;
+    more_starting_after?: string;
+};
+export declare type QualificationsStackingRules = {
+    redeemables_limit: number;
+    applicable_redeemables_limit: number;
+    applicable_exclusive_redeemables_limit: number;
+    exclusive_categories: string[];
+    joint_categories: string[];
+};
+export declare type QualificationsRedeemable = QualificationsRedeemableBase & {
+    redeemables?: QualificationsRedeemableBase[];
+};
+export declare type QualificationsRedeemableBase = {
+    id: string;
+    object: 'campaign' | 'promotion_tier' | 'promotion_stack' | 'voucher';
+    created_at: string;
+    result: RedeemableResult;
+    order?: OrderCalculated;
+    validation_rule_id?: string;
+    applicable_to: ApplicableToResultList;
+    inapplicable_to: InapplicableToResultList;
+    metadata: Record<string, unknown> | null;
+    categories: Category[];
+    banner?: string;
+    name?: string;
+    campaign_name?: string;
+    campaign_id?: string;
+    validation_rules_assignments?: ValidationRulesAssignmentsList;
+};
+export declare type RedeemableResult = {
+    discount?: Discount;
+    gift?: {
+        balance: number;
+        credits: number;
+    };
+    loyalty_card?: {
+        points?: number;
+        balance?: number;
+        exchange_ratio?: number;
+        points_ratio?: number;
+        transfers?: LoyaltiesTransferPoints[];
+    };
+    error?: Error;
+};

package/dist/types/Rewards.d.ts

@@ -158,18 +158,62 @@ export interface RewardTypeMaterial {
     };
 }
 export declare type RewardType = RewardTypeCampaign | RewardTypeCoin | RewardTypeMaterial;
-export interface RewardAssignment {
+export declare type RewardAssignment = RewardsAssignmentCoinReward | RewardsAssignmentCampaignOrMaterialReward;
+export interface RewardsAssignmentCoinReward {
     id: string;
     reward_id: string;
-    related_object_id?: string;
-    related_object_type?: string;
+    related_object_id: string;
+    related_object_type: 'campaign';
+    created_at: string;
+    updated_at: string | null;
+    object: 'reward-assignment';
+}
+export interface RewardsAssignmentCampaignOrMaterialReward {
+    id: string;
+    reward_id: string;
+    related_object_id: string;
+    related_object_type: 'campaign';
+    created_at: string;
+    updated_at: string | null;
+    object: 'reward-assignment';
+    parameters: {
+        loyalty: {
+            points?: number;
+        };
+    };
+}
+export declare type RewardsGetAssignmentResponseBody = RewardAssignment;
+export interface RewardsListAssignmentsRequestQuery {
+    limit?: number;
+    page?: number;
+}
+export interface RewardsListAssignmentsResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: RewardAssignment[];
+    total: number;
+}
+export declare type RewardsCreateAssignmentRequestBody = RewardsCreateAssignmentCoinRewardRequestBody | RewardsCreateAssignmentCampaignOrMaterialRewardRequestBody;
+export interface RewardsCreateAssignmentCoinRewardRequestBody {
+    campaign: string;
+    validation_rules?: string[];
+}
+export interface RewardsCreateAssignmentCampaignOrMaterialRewardRequestBody {
+    campaign: string;
+    parameters: {
+        loyalty: {
+            points?: number;
+        };
+    };
+}
+export declare type RewardsCreateAssignmentResponseBody = RewardAssignment;
+export interface RewardsUpdateAssignmentRequestBody {
     parameters?: {
         loyalty?: {
-            points: number;
+            points?: number;
         };
     };
-    created_at: string;
-    updated_at?: string;
-    object: 'reward_assignment';
+    id: string;
 }
+export declare type RewardsUpdateAssignmentResponseBody = RewardAssignment;
 export {};

package/dist/types/ValidationRules.d.ts

@@ -69,3 +69,25 @@ export interface ValidationRulesListAssignmentsResponse {
     data_ref: 'data';
     data: ValidationRulesCreateAssignmentResponse[];
 }
+export declare type ValidationRulesAssignmentsList = ValidationRulesListResponse;
+export interface ValidationRulesAssignment {
+    id: string;
+    rule_id: string;
+    related_object_id: string;
+    related_object_type: string;
+    created_at: string;
+    object: 'validation_rules_assignment';
+}
+export interface ValidationRulesListRulesAssignmentsRequestQuery {
+    related_object_id?: string;
+    rule?: string;
+    page?: number;
+    limit?: number;
+    order?: 'created_at' | '-created_at';
+}
+export interface ValidationRulesListRulesAssignmentsResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    total: number;
+    data: ValidationRulesAssignment[];
+}