@voucherify/sdk 2.6.0 → 2.7.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @voucherify/sdk
 
+## 2.7.1
+
+### Patch Changes
+
+- [`25c3f13`](https://github.com/voucherifyio/voucherify-js-sdk/commit/25c3f13d10cd8ed4a6eee50082f302efd18e1268) [#260](https://github.com/voucherifyio/voucherify-js-sdk/pull/260) Thanks [@jkaliszuk](https://github.com/jkaliszuk)! - Added `error` object in `VoucherifyError`. Added `validation_rules` in VouchersCreateParameters.
+
+## 2.7.0
+
+### Minor Changes
+
+- [`32fa44a`](https://github.com/voucherifyio/voucherify-js-sdk/commit/32fa44ab17b21bda9daf953eaf4969d528c2d707) [#255](https://github.com/voucherifyio/voucherify-js-sdk/pull/255) Thanks [@awilczek](https://github.com/awilczek)! - Update axios to 1.6.5 in SDK package
+
+* [`8df2fed`](https://github.com/voucherifyio/voucherify-js-sdk/commit/8df2fed2b4319f681d0ff17b9bb15e6bbf80dd7c) [#254](https://github.com/voucherifyio/voucherify-js-sdk/pull/254) Thanks [@p-zielinski](https://github.com/p-zielinski)! - Add support for few endpoints of Loyalties API.
+  - Added support for new endpoints: `POST /v1/qualifications`, `POST /client/v1/qualifications` [(examples of usage available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md)
+  - New exported types/interfaces: `InapplicableTo`, `Referrer`, `ReferrerWithSummaryLoyaltyReferrals`, `Customer`, `CustomerWithSummaryLoyaltyReferrals`, `CustomerSummary`, `CustomerSummaryRedemptions`, `CustomerSummaryOrders`, `CustomerLoyalty`, `CustomerReferrals`, `Discount`, `DiscountAmount_`, `DiscountUnit_`, `DiscountUnitBase_`, `DiscountUnitMultiple_`, `DiscountPercent_`, `DiscountFixed_`, `Order`, `OrderItem`, `OrderCalculated`, `OrderRedemptions`, `OrderItemCalculated`, `QualificationsCheckEligibilityRequestBody`, `QualificationsCheckEligibilityResponseBody`, `QualificationsFiltersFields`, `QualificationsFiltersCondition`, `QualificationsFieldConditions`, `QualificationsRedeemablesResponse`, `QualificationsStackingRulesResponse`, `QualificationsRedeemable`, `QualificationsRedeemableBase`, `RedeemableSingleResultResponse`, `ValidationRulesAssignmentsList`,
+  - Added optional properties to `ApplicableTo`: `product_id`, `product_source_id`, `quantity_limit`, `aggregated_quantity_limit`, `amount_limit`, `aggregated_amount_limit`, `order_item_indices`
+  - Added required property: `data_ref: 'data'` to `ApplicableToResultList` // NOTE: as this type is only used in responses, this is not a breaking change.
+  - Added optional properties to `CustomerRequest`: `birthday` and `birthdate`
+
 ## 2.6.0
 
 ### Minor Changes

package/README.md

@@ -450,6 +450,20 @@ client.categories.list()
 
 ---
 
+### Qualifications
+
+Methods are provided within `client.qualifications.*` or `client.promotions.*` namespace.
+
+- [Check Eligibility](#Check-Eligibility)
+
+#### [Check Eligibility](https://docs.voucherify.io/reference/check-eligibility)
+
+```javascript
+client.qualifications.checkEligibility(body)
+```
+
+---
+
 ### Validations
 
 Methods are provided within `client.validations.*` or `client.promotions.*` namespace.
@@ -1606,6 +1620,7 @@ Methods are provided within `client.*` namespace.
 - [List consents](#list-consents)
 - [Update consents](#update-consents)
 - [Track custom events](#track-custom-events)
+- [Qualifications](#Qualifications)
 
 #### Set Identity
 
@@ -1678,6 +1693,12 @@ client.updateConsents(idOrSourceId, consents)
 client.track(eventName, metadata, customer)
 ```
 
+#### [Qualifications](https://docs.voucherify.io/reference/check-eligibility-client-side)
+
+```javascript
+client.qualifications(body)
+```
+
 # <a name="snippet"></a>🏎 Marketer-ready Voucherify snippet
 
 Go [here](./examples/sdk/with-html) for more HTML-based examples

package/dist/ClientSide.d.ts

@@ -1,4 +1,5 @@
 import * as T from './types/ClientSide';
+import * as TQ from './types/Qualifications';
 import type { RequestController } from './RequestController';
 export declare class ClientSide {
     private client;
@@ -45,4 +46,8 @@ export declare class ClientSide {
      * @see https://docs.voucherify.io/reference/redeem-stackable-discounts-client-side
      */
     redeemStackable(params: T.ClientSideRedemptionsRedeemStackableParams): Promise<import("./types").RedemptionsRedeemStackableResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/check-eligibility
+     */
+    qualifications(body: TQ.QualificationsCheckEligibilityRequestBody): Promise<TQ.QualificationsCheckEligibilityResponseBody>;
 }

package/dist/Qualifications.d.ts

@@ -0,0 +1,10 @@
+import * as T from './types/Qualifications';
+import type { RequestController } from './RequestController';
+export declare class Qualifications {
+    private client;
+    constructor(client: RequestController);
+    /**
+     * @see https://docs.voucherify.io/reference/check-eligibility
+     */
+    checkEligibility(body: T.QualificationsCheckEligibilityRequestBody): Promise<T.QualificationsCheckEligibilityResponseBody>;
+}

package/dist/VoucherifyError.d.ts

@@ -12,6 +12,9 @@ export declare class VoucherifyError extends Error {
     related_object_ids?: string[];
     related_object_type?: string;
     related_object_total?: number;
+    error?: {
+        message: string;
+    };
     cause?: AxiosError;
     constructor(statusCode: number, body?: unknown, axiosError?: AxiosError);
 }

package/dist/VoucherifyServerSide.d.ts

@@ -18,6 +18,7 @@ import { ApiLimitsHandler } from './ApiLimitsHandler';
 import { MetadataSchemas } from './MetadataSchemas';
 import { Categories } from './Categories';
 import { ProductCollections } from './ProductCollections';
+import { Qualifications } from './Qualifications';
 export interface VoucherifyServerSideOptions {
     /**
      * Optionally, you can add `apiUrl` to the client options if you want to use Voucherify running in a specific region.
@@ -118,6 +119,7 @@ export declare function VoucherifyServerSide(options: VoucherifyServerSideOption
     orders: Orders;
     products: Products;
     productCollections: ProductCollections;
+    qualifications: Qualifications;
     rewards: Rewards;
     loyalties: Loyalties;
     segments: Segments;

package/dist/index.d.ts

@@ -22,3 +22,4 @@ export type { ValidationRules } from './ValidationRules';
 export type { Validations } from './Validations';
 export type { VoucherifyError } from './VoucherifyError';
 export type { Vouchers } from './Vouchers';
+export type { Qualifications } from './Qualifications';

package/dist/types/ApplicableTo.d.ts

@@ -3,13 +3,28 @@ export interface ApplicableTo {
     object: 'product' | 'sku' | 'products_collection';
     id: string;
     source_id?: string;
+    product_id?: string;
+    product_source_id?: string;
     strict: boolean;
     price?: number;
     price_formula?: number;
     effect: ApplicableToEffect;
+    quantity_limit?: number;
+    aggregated_quantity_limit?: number;
+    amount_limit?: number;
+    aggregated_amount_limit?: number;
+    order_item_indices?: number[];
 }
 export interface ApplicableToResultList {
     object: 'list';
     total: number;
     data: ApplicableTo[];
+    data_ref: 'data';
 }
+export declare type InapplicableToResultList = {
+    data: InapplicableTo[];
+    total: number;
+    object: 'list';
+    data_ref: string;
+};
+export declare type InapplicableTo = ApplicableTo;

package/dist/types/Customers.d.ts

@@ -65,9 +65,11 @@ export interface CustomerRequest {
     id?: string;
     source_id?: string;
     name?: string;
-    email?: string;
-    metadata?: Record<string, any>;
     description?: string;
+    email?: string;
+    phone?: string;
+    birthday?: string;
+    birthdate?: string;
     address?: {
         city?: string;
         state?: string;
@@ -76,7 +78,7 @@ export interface CustomerRequest {
         country?: string;
         postal_code?: string;
     };
-    phone?: string;
+    metadata?: Record<string, any>;
 }
 export interface CustomersCommonListRequest {
     limit?: number;
@@ -142,6 +144,89 @@ declare type CustomerAddress = {
         postal_code?: string | null;
     } | null;
 };
+export declare type Referrer = CustomerRequest;
+export declare type Customer = CustomerRequest;
+export declare type ReferrerWithSummaryLoyaltyReferrals = CustomerWithSummaryLoyaltyReferrals;
+export declare type CustomerId = {
+    id: string;
+    object: 'customer';
+};
+export declare type ReferrerId = CustomerId;
+export declare type CustomerWithSummaryLoyaltyReferrals = {
+    id?: string;
+    source_id?: string;
+    name?: string;
+    description?: string;
+    email?: string;
+    phone?: string;
+    birthday?: string;
+    birthdate?: string;
+    address: {
+        city?: string;
+        state?: string;
+        line_1?: string;
+        line_2?: string;
+        country?: string;
+        postal_code?: string;
+    } | null;
+    metadata?: Record<string, any>;
+    summary: CustomerSummary;
+    loyalty: CustomerLoyalty;
+    referrals: CustomerReferrals;
+    system_metadata: Record<string, unknown>;
+    created_at: string;
+    updated_at?: string;
+    assets?: {
+        cockpit_url?: string;
+    };
+    object: 'customer';
+};
+export declare type CustomerSummary = {
+    redemptions: CustomerSummaryRedemptions;
+    orders: CustomerSummaryOrders;
+};
+export declare type CustomerSummaryRedemptions = {
+    total_redeemed: number;
+    total_failed: number;
+    total_succeeded: number;
+    total_rolled_back: number;
+    total_rollback_failed: number;
+    total_rollback_succeeded: number;
+    gift: {
+        redeemed_amount: number;
+        amount_to_go: number;
+    };
+    loyalty_card: {
+        redeemed_points: number;
+        points_to_go: number;
+    };
+};
+export declare type CustomerSummaryOrders = {
+    total_amount: number;
+    total_count: number;
+    average_amount: number;
+    last_order_amount: number;
+    last_order_date: string;
+};
+export declare type CustomerLoyalty = {
+    points: number;
+    referred_customers: number;
+    campaigns: Record<string, {
+        points: number;
+        loyalty_tier: string;
+        referred_customers: number;
+    }>;
+};
+export declare type CustomerReferrals = {
+    total: number;
+    campaigns: {
+        campaign_id: string;
+        referrer_id: string;
+        related_object_id: string;
+        related_object_type: string;
+        date: string;
+    }[];
+};
 export declare type CustomersUpdateInBulkRequestBody = (CustomerBase & CustomerAddress & {
     source_id: string | null;
 })[];

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/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/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/ValidationRules.d.ts

@@ -69,6 +69,7 @@ export interface ValidationRulesListAssignmentsResponse {
     data_ref: 'data';
     data: ValidationRulesCreateAssignmentResponse[];
 }
+export declare type ValidationRulesAssignmentsList = ValidationRulesListResponse;
 export interface ValidationRulesAssignment {
     id: string;
     rule_id: string;

package/dist/types/Vouchers.d.ts

@@ -128,6 +128,7 @@ export interface VouchersCreateParameters {
     redemption?: {
         quantity: number;
     };
+    validation_rules?: string[];
 }
 export declare type VouchersCreate = VouchersCreateParameters & Pick<VouchersResponse, 'type' | 'discount' | 'gift' | 'category' | 'additional_info' | 'start_date' | 'expiration_date' | 'metadata'>;
 export declare type VouchersCreateResponse = Omit<VouchersResponse, 'validation_rules_assignments'>;

package/dist/types/index.d.ts

@@ -22,3 +22,4 @@ export * from './Gift';
 export * from './ValidateSession';
 export * from './ApplicableTo';
 export * from './DiscountVoucher';
+export * from './Qualifications';