@voucherify/sdk 2.0.2 → 2.0.5

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @voucherify/sdk
 
+## 2.0.5
+
+### Patch Changes
+
+- [`a7811e7`](https://github.com/voucherifyio/voucherify-js-sdk/commit/a7811e7e2939efe7a4c59c004dbc9591fcd73030) [#121](https://github.com/voucherifyio/voucherify-js-sdk/pull/121) Thanks [@jkaliszuk](https://github.com/jkaliszuk)! - Added logic that allow to storage lastResponseHeaders data and get apiLimit through ApiLimitsHandler
+
+## 2.0.4
+
+### Patch Changes
+
+- [`f411c1a`](https://github.com/voucherifyio/voucherify-js-sdk/commit/f411c1a56085d80560fdca634e5fdc059a556091) [#119](https://github.com/voucherifyio/voucherify-js-sdk/pull/119) Thanks [@darekg11](https://github.com/darekg11)! - Added support for stackable API methods - validation, redemptions, rollback for both Server Side and Client Side SDKs. Added some missing fields in already existing types definitions and cleaned up other definitions by reusing interfaces
+
+## 2.0.3
+
+### Patch Changes
+
+- [`da9e103`](https://github.com/voucherifyio/voucherify-js-sdk/commit/da9e103a43590b55cb80d64e1743f7ede1e09946) [#117](https://github.com/voucherifyio/voucherify-js-sdk/pull/117) Thanks [@darekg11](https://github.com/darekg11)! - Added support for listing customer activities by customerId. Additionally user can pass query params allowing for better filtering. API Reference: https://docs.voucherify.io/reference/get-customer-activities
+
 ## 2.0.2
 
 ### Patch Changes

package/README.md

@@ -66,6 +66,8 @@ Server side:
 <a href="#events">Events</a>
 |
 <a href="#async-actions">Async Actions</a>
+|
+<a href="#api-limits-handler">Api Limits Handler</a>
 </p>
 
 <p align="center">
@@ -362,6 +364,7 @@ Methods are provided within `client.validations.*` or `client.promotions.*` name
 
 - [Validate Voucher](#validate-voucher)
 - [Validate Promotion Campaign](#validate-promotion-campaign)
+- [Validate Stackable](#validate-stackable)
 
 #### [Validate Voucher](https://docs.voucherify.io/reference/validate-voucher)
 
@@ -389,6 +392,11 @@ Other possibility
 client.validations.validate(params)
 ```
 
+#### [Validate Stackable](https://docs.voucherify.io/reference/validate-stacked-discounts-1)
+```javascript
+client.validations.validateStackable(params)
+```
+
 ---
 
 ### Redemptions
@@ -396,12 +404,14 @@ client.validations.validate(params)
 Methods are provided within `client.redemptions.*` namespace.
 
 - [Redeem Voucher](#redeem-voucher)
+- [Redeem Stackable](#redeem-stackable)
 - [Get Redemption](#get-redemption)
 - [Redeem Promotion's Tier](#redeem-promotions-tier)
 - [Redeem Loyalty Card](#redeem-loyalty-card)
 - [List Redemptions](#list-redemptions)
 - [Get Voucher's Redemptions](#get-vouchers-redemptions)
 - [Rollback Redemption](#rollback-redemption)
+- [Rollback Stackable](#rollback-stackable)
 
 #### [Redeem Voucher](https://docs.voucherify.io/reference/redeem-voucher)
 
@@ -410,6 +420,11 @@ client.redemptions.redeem(code)
 client.redemptions.redeem(code, params)
 ```
 
+#### [Redeem Stackable](https://docs.voucherify.io/reference/redeem-stacked-discounts)
+```javascript
+client.redemptions.redeemStackable(params)
+```
+
 #### [Get Redemption](https://docs.voucherify.io/reference/get-redemption)
 
 ```javascript
@@ -436,6 +451,12 @@ client.redemptions.rollback(redemptionId)
 client.redemptions.rollback(redemptionId, params)
 ```
 
+#### [Rollback Stackable](https://docs.voucherify.io/reference/rollback-stackable-redemptions)
+```javascript
+client.redemptions.rollbackStackable(parentRedemptionId)
+client.redemptions.rollbackStackable(parentRedemptionId, params, queryParams)
+```
+
 Check [redemption rollback object](https://docs.voucherify.io/reference/the-redemption-rollback-object).
 
 ---
@@ -514,6 +535,7 @@ Methods are provided within `client.customers.*` namespace.
 - [Delete Customer](#delete-customer)
 - [List Customers](#list-customers)
 - [Update Customer's Consents](#update-customers-consents)
+- [List Customer's Activities](#list-customers-activities)
 
 #### [Create Customer](https://docs.voucherify.io/reference/create-customer)
 
@@ -588,6 +610,13 @@ Keep in mind this operation may drain your API call limits fairly quickly - each
 client.customers.updateConsents(customer, consents)
 ```
 
+#### [List Customers Activities](https://docs.voucherify.io/reference/get-customer-activities)
+
+```javascript
+client.customers.listActivities(customerId)
+client.customers.listActivities(customerId, params)
+```
+
 ---
 
 ### Consents
@@ -1097,6 +1126,37 @@ client.asyncActions.list()
 client.asyncActions.list(params)
 ```
 
+--- 
+
+### Api Limits Handler
+
+Methods are provided within `client.apiLimitsHandler.*` namespace.
+
+- [Are Limits Available](#are-limits-available)
+- [Get Rate Limit](#get-rate-limit)
+- [Get Rate Limit Remaining](#get-rate-limit-remaining)
+
+#### Are Limits Available
+```javascript
+client.apiLimitsHandler.areLimitsAvailable()
+```
+
+This method should be called each time beforehand [Get Rate Limit](#get-rate-limit) or [Get Rate Limit Remaining](#get-rate-limit-remaining) to ensure limit data are available.
+
+#### Get Rate Limit
+```javascript
+if(client.apiLimitsHandler.areLimitsAvailable()){
+  client.apiLimitsHandler.getRateLimit()
+}
+```
+
+#### Get Rate Limit Remaining
+```javascript
+if(client.apiLimitsHandler.areLimitsAvailable()){
+  client.apiLimitsHandler.getRateLimitRemaining()
+}
+```
+
 ---
 
 # 💅 Client Side
@@ -1129,7 +1189,9 @@ Methods are provided within `client.*` namespace.
 
 - [Set Identity](#set-identity)
 - [Validate](#validate)
+- [Validate Stackable](#validate-stackable-client-side)
 - [Redeem](#redeem)
+- [Redeem Stackable](#redeem-stackable-client-side)
 - [Publish](#publish)
 - [List vouchers](#list-vouchers)
 - [Create customer](#create-customer)
@@ -1149,12 +1211,24 @@ client.setIdentity(trackingId)
 client.validate(params)
 ```
 
+#### [Validate Stackable Client Side](https://docs.voucherify.io/reference/validate-stackable-discounts-client-side)
+
+```javascript
+client.validateStackable(params)
+```
+
 #### [Redeem](https://docs.voucherify.io/reference/redeem-voucher-client-side)
 
 ```javascript
 client.redeem(code, payload)
 ```
 
+#### [Redeem Stackable Client Side](https://docs.voucherify.io/reference/redeem-stackable-discounts-client-side)
+
+```javascript
+client.redeemStackable(params)
+```
+
 #### Publish
 
 ```javascript

package/dist/ApiLimitsHandler.d.ts

@@ -0,0 +1,9 @@
+import { RequestController } from './RequestController';
+export declare class ApiLimitsHandler {
+    private readonly requestController;
+    constructor(requestController: RequestController);
+    private getLastResponseHeadersFromController;
+    areLimitsAvailable(): boolean;
+    getRateLimit(): number;
+    getRateLimitRemaining(): number;
+}

package/dist/ClientSide.d.ts

@@ -37,4 +37,12 @@ export declare class ClientSide {
      * @see https://docs.voucherify.io/reference/update-customers-consents-client
      */
     updateConsents(idOrSourceId: string, consents: T.ClientSideCustomersUpdateConsentsBody): Promise<undefined>;
+    /**
+     * @see https://docs.voucherify.io/reference/validate-stackable-discounts-client-side
+     */
+    validateStackable(params: T.ClientSideValidationsValidateStackableParams): Promise<import("./types").ValidationValidateStackableResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/redeem-stackable-discounts-client-side
+     */
+    redeemStackable(params: T.ClientSideRedemptionsRedeemStackableParams): Promise<import("./types").RedemptionsRedeemStackableResponse>;
 }

package/dist/Customers.d.ts

@@ -39,5 +39,9 @@ declare class Customers {
      * @see https://docs.voucherify.io/reference/update-customers-consents
      */
     updateConsents(idOrSourceId: string, consents: T.CustomersUpdateConsentsBody): Promise<undefined>;
+    /**
+     * @see https://docs.voucherify.io/reference/get-customer-activities
+     */
+    listActivities(customerId: string, params?: T.CustomerActivitiesListQueryParams): Promise<T.CustomerActivitiesListResponse>;
 }
 export { Customers };

package/dist/Redemptions.d.ts

@@ -7,6 +7,10 @@ export declare class Redemptions {
      * @see https://docs.voucherify.io/reference/redeem-voucher
      */
     redeem(code: string, body?: T.RedemptionsRedeemBody): Promise<T.RedemptionsRedeemResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/redeem-stacked-discounts
+     */
+    redeemStackable(params: T.RedemptionsRedeemStackableParams): Promise<T.RedemptionsRedeemStackableResponse>;
     /**
      * @see https://docs.voucherify.io/reference/get-redemption
      */
@@ -23,4 +27,9 @@ export declare class Redemptions {
      * @see https://docs.voucherify.io/reference/rollback-redemption
      */
     rollback(redemptionId: string, params?: T.RedemptionsRollbackParams): Promise<T.RedemptionsRollbackResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/rollback-stackable-redemptions
+     * Types of params and queryParams WILL be changed in future - please do not depend on it!
+     */
+    rollbackStackable(parentRedemptionId: string, params?: any, queryParams?: any): Promise<T.RedemptionsRollbackStackableResponse>;
 }

package/dist/RequestController.d.ts

@@ -11,7 +11,12 @@ export declare class RequestController {
     private basePath;
     private headers;
     private request;
+    private lastResponseHeaders;
+    private isLastResponseHeadersSet;
     constructor({ basePath, baseURL, headers }: RequestControllerOptions);
+    isLastReponseHeadersSet(): boolean;
+    getLastResponseHeaders(): Record<string, string>;
+    private setLastResponseHeaders;
     setBaseUrl(baseURL: string): void;
     get<T>(path: string, params?: Record<string, any>): Promise<T>;
     post<T>(path: string, body: Record<string, any>, params?: Record<string, any>, headers?: Record<string, any>): Promise<T>;

package/dist/Validations.d.ts

@@ -10,4 +10,8 @@ export declare class Validations {
      */
     validateVoucher(code: string, params?: T.ValidationsValidateVoucherParams): Promise<T.ValidationsValidateVoucherResponse>;
     validate(code: string | T.ValidationsValidateCode, context?: T.ValidationsValidateContext): Promise<T.ValidationsValidateVoucherResponse> | Promise<import("./types").PromotionsValidateResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/validate-stacked-discounts-1
+     */
+    validateStackable(params: T.ValidationsValidateStackableParams): Promise<T.ValidationValidateStackableResponse>;
 }

package/dist/VoucherifyServerSide.d.ts

@@ -14,6 +14,7 @@ import { Rewards } from './Rewards';
 import { Loyalties } from './Loyalties';
 import { ValidationRules } from './ValidationRules';
 import { Segments } from './Segments';
+import { ApiLimitsHandler } from './ApiLimitsHandler';
 export interface VoucherifyServerSideOptions {
     /**
      * Optionally, you can add `apiUrl` to the client options if you want to use Voucherify running in a specific region.
@@ -108,4 +109,5 @@ export declare function VoucherifyServerSide(options: VoucherifyServerSideOption
     validationRules: ValidationRules;
     events: Events;
     asyncActions: AsyncActions;
+    apiLimitsHandler: ApiLimitsHandler;
 };

package/dist/types/ApplicableTo.d.ts

@@ -0,0 +1,15 @@
+export declare type ApplicableToEffect = 'APPLY_TO_EVERY' | 'APPLY_TO_CHEAPEST' | 'APPLY_TO_MOST_EXPENSIVE';
+export interface ApplicableTo {
+    object: 'product' | 'sku' | 'products_collection';
+    id: string;
+    source_id?: string;
+    strict: boolean;
+    price?: number;
+    price_formula?: number;
+    effect: ApplicableToEffect;
+}
+export interface ApplicableToResultList {
+    object: 'list';
+    total: number;
+    data: ApplicableTo[];
+}

package/dist/types/ClientSide.d.ts

@@ -1,9 +1,14 @@
 import { CustomerRequest, CustomersCreateBody, CustomersCreateResponse, CustomersUpdateConsentsBody } from './Customers';
-import { DiscountAmount, DiscountPercent, DiscountUnit, VouchersListParams, VouchersResponse } from './Vouchers';
+import { VouchersListParams, VouchersResponse } from './Vouchers';
+import { DiscountAmount, DiscountPercent, DiscountUnit } from './DiscountVoucher';
 import { OrdersCreateResponse, OrdersItem } from './Orders';
 import { ConsentsListResponse } from './Consents';
 import { DistributionsPublicationsCreateResponse } from './Distributions';
 import { SimplePromotionTier } from './PromotionTiers';
+import { ValidationSessionReleaseParams } from './ValidateSession';
+import { ApplicableToResultList } from './ApplicableTo';
+import { ValidationsValidateStackableParams, ValidationValidateStackableResponse } from './Validations';
+import { RedemptionsRedeemStackableParams, RedemptionsRedeemStackableResponse } from './Redemptions';
 declare type ClientSideItem = Pick<OrdersItem, 'source_id' | 'sku_id' | 'product_id' | 'sku' | 'quantity' | 'related_object' | 'amount'>;
 export declare type ClientSideCustomersUpdateConsentsBody = CustomersUpdateConsentsBody;
 export declare type ClientSideCustomersCreateParams = CustomersCreateBody;
@@ -36,15 +41,7 @@ export interface ClientSideValidateResponse {
     code?: string;
     valid: boolean;
     discount?: DiscountUnit | DiscountAmount | DiscountPercent;
-    applicable_to?: {
-        object: 'list';
-        total: number;
-        data?: {
-            id: string;
-            object: 'product';
-            source_id?: string;
-        }[];
-    };
+    applicable_to?: ApplicableToResultList;
     order?: {
         amount: number;
         discount_amount: number;
@@ -71,9 +68,7 @@ export interface ClientSideRedeemPayload {
     reward?: {
         id: string;
     };
-    session?: {
-        key: string;
-    };
+    session?: ValidationSessionReleaseParams;
 }
 export interface ClientSideRedeemResponse {
     id: string;
@@ -132,4 +127,8 @@ export interface ClientSideRedeemWidgetPayload {
 }
 export declare type ClientSideTrackCustomer = CustomerRequest;
 export declare type ClientSideConsentsListResponse = ConsentsListResponse;
+export declare type ClientSideValidationsValidateStackableParams = ValidationsValidateStackableParams;
+export declare type ClientSideValidationValidateStackableResponse = ValidationValidateStackableResponse;
+export declare type ClientSideRedemptionsRedeemStackableParams = RedemptionsRedeemStackableParams;
+export declare type ClientSideRedemptionsRedeemStackableResponse = RedemptionsRedeemStackableResponse;
 export {};

package/dist/types/Customers.d.ts

@@ -94,6 +94,20 @@ export interface CustomersCommonListResponse {
     customers: CustomerObject[];
     has_more?: boolean;
 }
+export interface CustomerActivitiesListQueryParams {
+    limit?: number;
+    order?: 'created_at' | '-created_at';
+    starting_after?: string;
+    starting_after_id?: string;
+    campaign_type?: 'LOYALTY_PROGRAM' | 'PROMOTION' | 'DISCOUNT_COUPONS' | 'GIFT_VOUCHERS' | 'REFERRAL_PROGRAM';
+    campaign_id?: string;
+}
+export interface CustomerActivitiesListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'data';
+    data: Record<string, any>[];
+}
 export declare type CustomersCreateBody = CustomerRequest;
 export declare type CustomersCreateResponse = CustomerObject | CustomerUnconfirmed;
 export declare type CustomersGetResponse = CustomerObject | CustomerUnconfirmed;

package/dist/types/DiscountVoucher.d.ts

@@ -0,0 +1,27 @@
+export declare type DiscountVouchersTypes = 'AMOUNT' | 'PERCENT' | 'UNIT' | 'FIXED';
+export declare enum DiscountVouchersTypesEnum {
+    AMOUNT = "AMOUNT",
+    PERCENT = "PERCENT",
+    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 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 DiscountPercentVouchersEffectTypes = 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS';
+export declare type DiscountFixedVouchersEffectTypes = 'APPLY_TO_ORDER' | 'APPLY_TO_ITEMS';
+export interface DiscountUnit {
+    type?: DiscountVouchersTypesEnum.UNIT;
+    unit_off?: number;
+    effect?: DiscountUnitVouchersEffectTypes;
+    unit_type?: string;
+}
+export interface DiscountAmount {
+    type?: DiscountVouchersTypesEnum.AMOUNT;
+    amount_off?: number;
+}
+export interface DiscountPercent {
+    type?: DiscountVouchersTypesEnum.PERCENT;
+    percent_off?: number;
+    amount_limit?: number;
+}

package/dist/types/Gift.d.ts

@@ -0,0 +1,3 @@
+export interface GiftRedemptionParams {
+    credits?: number;
+}

package/dist/types/Loyalties.d.ts

@@ -459,4 +459,8 @@ export interface LoyaltiesRedeemRewardResponse {
         };
     };
 }
+export interface LoyaltyPointsTransfer {
+    code: string;
+    points: number;
+}
 export {};

package/dist/types/Orders.d.ts

@@ -18,8 +18,11 @@ export interface OrdersItem {
     };
 }
 export interface OrdersCreate {
+    source_id?: string;
+    status?: 'CREATED' | 'PAID' | 'CANCELLED' | 'FULFILLED';
     customer?: CustomerRequest;
     amount?: number;
+    discount_amount?: number;
     items?: OrdersItem[];
     metadata?: Record<string, any>;
 }
@@ -30,7 +33,13 @@ export interface OrdersCreateResponse {
     updated_at?: string;
     status?: 'CREATED' | 'PAID' | 'PROCESSING' | 'CANCELED' | 'FULFILLED';
     amount?: number;
+    initial_amount?: number;
     discount_amount?: number;
+    items_discount_amount?: number;
+    total_discount_amount?: number;
+    applied_discount_amount?: number;
+    items_applied_discount_amount?: number;
+    total_applied_discount_amount?: number;
     items?: OrdersItem[];
     metadata?: Record<string, any>;
     customer?: CustomerRequest;
@@ -43,6 +52,7 @@ export interface OrdersUpdate {
     status?: 'CREATED' | 'PAID' | 'CANCELLED' | 'FULFILLED';
     items?: OrdersItem[];
     amount?: number;
+    discount_amount?: number;
     metadata?: Record<string, any>;
     customer?: {
         id: string;

package/dist/types/Products.d.ts

@@ -93,3 +93,13 @@ export interface ProductsListSkus {
     total: number;
     skus: ProductsGetSkuResponse[];
 }
+export interface SimpleProduct {
+    id: string;
+    source_id?: string;
+    name?: string;
+}
+export interface SimpleSku {
+    id: string;
+    source_id?: string;
+    sku?: string;
+}

package/dist/types/PromotionTiers.d.ts

@@ -1,7 +1,8 @@
-import { DiscountAmount, DiscountPercent, DiscountUnit } from './Vouchers';
+import { DiscountAmount, DiscountPercent, DiscountUnit } from './DiscountVoucher';
 import { OrdersCreateResponse, OrdersItem } from './Orders';
 import { SimpleCustomer } from './Customers';
 import { ValidationRulesListAssignmentsResponse } from './ValidationRules';
+import { ValidationSessionReleaseParams } from './ValidateSession';
 export interface SimplePromotionTier {
     tracking_id: string;
     metadata?: Record<string, any>;
@@ -66,9 +67,7 @@ export interface PromotionTiersRedeemParams {
         metadata?: Record<string, any>;
     };
     metadata?: Record<string, any>;
-    session?: {
-        key: string;
-    };
+    session?: ValidationSessionReleaseParams;
 }
 export interface PromotionTiersRedeemResponse {
     id: string;

package/dist/types/Promotions.d.ts

@@ -1,4 +1,4 @@
-import { DiscountAmount, DiscountPercent, DiscountUnit } from './Vouchers';
+import { DiscountAmount, DiscountPercent, DiscountUnit } from './DiscountVoucher';
 import { OrdersItem } from './Orders';
 import { PromotionTier } from './PromotionTiers';
 import { SimpleCustomer } from './Customers';

package/dist/types/Redemptions.d.ts

@@ -1,7 +1,10 @@
-import { OrdersCreateResponse } from './Orders';
-import { RewardsCreateResponse } from './Rewards';
-import { SimpleCustomer } from './Customers';
+import { OrdersCreateResponse, OrdersCreate } from './Orders';
+import { RewardsCreateResponse, RewardRedemptionParams } from './Rewards';
+import { CustomersCreateBody, SimpleCustomer } from './Customers';
 import { VouchersResponse } from './Vouchers';
+import { GiftRedemptionParams } from './Gift';
+import { ValidationSessionParams, ValidationSessionReleaseParams } from './ValidateSession';
+import { StackableOptions, StackableRedeemableParams } from './Stackable';
 export interface RedemptionsRedeemBody {
     tracking_id?: string;
     customer?: SimpleCustomer & {
@@ -9,16 +12,9 @@ export interface RedemptionsRedeemBody {
     };
     order?: Pick<Partial<OrdersCreateResponse>, 'id' | 'source_id' | 'amount' | 'items' | 'status' | 'metadata'>;
     metadata?: Record<string, any>;
-    reward?: {
-        id?: string;
-        points?: number;
-    };
-    gift?: {
-        credits: number;
-    };
-    session?: {
-        key: string;
-    };
+    reward?: RewardRedemptionParams;
+    gift?: GiftRedemptionParams;
+    session?: ValidationSessionReleaseParams;
 }
 export interface RedemptionsRedeemResponse {
     id: string;
@@ -148,3 +144,57 @@ export declare type SimpleRollback = Pick<RedemptionsRollbackResponse, 'id' | 'o
         points: number;
     };
 };
+export interface RedemptionsRedeemStackableParams {
+    options?: StackableOptions;
+    redeemables: StackableRedeemableParams[];
+    session?: ValidationSessionParams;
+    order?: OrdersCreate;
+    customer?: CustomersCreateBody;
+    metadata?: Record<string, any>;
+}
+export declare type RedemptionsRedeemStackableRedemptionResult = RedemptionsRedeemResponse & {
+    redemption: string;
+};
+export declare type RedemptionsRedeemStackableOrderResponse = OrdersCreateResponse & {
+    redemptions?: Record<string, {
+        date: string;
+        rollback_id?: string;
+        rollback_date?: string;
+        related_object_type: 'redemption';
+        related_object_id: string;
+        stacked: string[];
+        rollback_stacked?: string[];
+    }>;
+};
+export interface RedemptionsRedeemStackableResponse {
+    redemptions: RedemptionsRedeemStackableRedemptionResult[];
+    parent_redemption: {
+        id: string;
+        object: 'redemption';
+        date: string;
+        customer_id?: string;
+        tracking_id?: string;
+        metadata?: Record<string, any>;
+        result: 'SUCCESS' | 'FAILURE';
+        order?: RedemptionsRedeemStackableOrderResponse;
+        customer?: SimpleCustomer;
+        related_object_type: 'redemption';
+        related_object_id: string;
+    };
+    order?: RedemptionsRedeemStackableOrderResponse;
+}
+export interface RedemptionsRollbackStackableResponse {
+    rollbacks: RedemptionsRedeemStackableRedemptionResult[];
+    parent_rollback: {
+        id: string;
+        date: string;
+        customer_id?: string;
+        tracking_id?: string;
+        metadata?: Record<string, any>;
+        result: 'SUCCESS' | 'FAILURE';
+        order?: OrdersCreateResponse;
+        customer?: SimpleCustomer;
+        redemption: string;
+    };
+    order?: RedemptionsRedeemStackableOrderResponse;
+}

package/dist/types/Rewards.d.ts

@@ -111,4 +111,9 @@ export declare type RewardsUpdateAssignment = RewardsCreateAssignment & {
     id: string;
 };
 export declare type RewardsUpdateAssignmentResponse = RewardsAssignmentObject;
+export interface RewardRedemptionParams {
+    points?: number;
+    assignment_id?: string;
+    id?: string;
+}
 export {};

package/dist/types/Stackable.d.ts

@@ -0,0 +1,63 @@
+import { RewardRedemptionParams } from './Rewards';
+import { GiftRedemptionParams } from './Gift';
+import { OrdersCreateResponse } from './Orders';
+import { ApplicableToResultList } from './ApplicableTo';
+import { DiscountVouchersTypes, DiscountVouchersEffectTypes, DiscountUnitVouchersEffectTypes } from './DiscountVoucher';
+import { SimpleProduct, SimpleSku } from './Products';
+import { LoyaltyPointsTransfer } from './Loyalties';
+declare type ExpandOption = 'order' | 'redeemable' | 'redemption';
+export interface StackableOptions {
+    expand: ExpandOption[];
+}
+export declare type StackableRedeemableObject = 'promotion_stack' | 'promotion_tier' | 'voucher';
+export interface StackableRedeemableParams {
+    object: StackableRedeemableObject;
+    id: string;
+    reward?: RewardRedemptionParams;
+    gift?: GiftRedemptionParams;
+}
+export declare type StackableRedeemableResponseStatus = 'APPLICABLE' | 'INAPPLICABLE' | 'SKIPPED';
+export interface StackableRedeemableResultDiscountUnit {
+    effect: DiscountUnitVouchersEffectTypes;
+    unit_off: number;
+    unit_type: string;
+    sku?: SimpleSku;
+    product?: SimpleProduct;
+}
+export interface StackableRedeemableResultDiscount {
+    type: DiscountVouchersTypes;
+    effect: DiscountVouchersEffectTypes;
+    amount_off?: number;
+    percent_off?: number;
+    amount_limit?: number;
+    fixed_amount?: number;
+    unit_off?: number;
+    unit_type?: string;
+    sku?: SimpleSku;
+    product?: SimpleProduct;
+    units?: StackableRedeemableResultDiscountUnit[];
+}
+export interface StackableRedeemableResultGift {
+    credits?: number;
+}
+export interface StackableRedeemableResultLoyaltyCard {
+    points?: number;
+    transfers?: LoyaltyPointsTransfer[];
+}
+export interface StackableRedeemableResultResponse {
+    discount?: StackableRedeemableResultDiscount;
+    gift?: StackableRedeemableResultGift;
+    loyalty_card?: StackableRedeemableResultLoyaltyCard;
+    error?: any;
+}
+export interface StackableRedeemableResponse {
+    status: StackableRedeemableResponseStatus;
+    id: string;
+    object: StackableRedeemableObject;
+    order?: OrdersCreateResponse;
+    applicable_to?: ApplicableToResultList;
+    inapplicable_to?: ApplicableToResultList;
+    result?: StackableRedeemableResultResponse;
+    metadata?: Record<string, any>;
+}
+export {};