@voucherify/sdk 2.0.3 → 2.0.6

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 {};

package/dist/types/ValidateSession.d.ts

@@ -0,0 +1,17 @@
+export declare type ValidationSessionType = 'LOCK';
+export declare type ValidationSessionTTLUnit = 'DAYS' | 'HOURS' | 'MICROSECONDS' | 'MILLISECONDS' | 'MINUTES' | 'NANOSECONDS' | 'SECONDS';
+export interface ValidationSessionParams {
+    key?: string;
+    type?: ValidationSessionType;
+    ttl?: number;
+    ttl_unit?: ValidationSessionTTLUnit;
+}
+export interface ValidationSessionResponse {
+    key: string;
+    type: ValidationSessionType;
+    ttl: number;
+    ttl_unit: ValidationSessionTTLUnit;
+}
+export interface ValidationSessionReleaseParams {
+    key: string;
+}

package/dist/types/ValidationRules.d.ts

@@ -1,3 +1,4 @@
+import { ApplicableToResultList } from './ApplicableTo';
 export interface ValidationRulesCreate {
     name: string;
     error?: {
@@ -25,11 +26,7 @@ export interface ValidationRulesCreateResponse {
 export interface ValidationRulesValidateResponse {
     valid: boolean;
     rule_id: string;
-    applicable_to: {
-        data: any[];
-        object: 'list';
-        total: number;
-    };
+    applicable_to: ApplicableToResultList;
 }
 export declare type ValidationRulesGetResponse = ValidationRulesCreateResponse & {
     assignments_count?: string;

package/dist/types/Validations.d.ts

@@ -1,5 +1,9 @@
-import { DiscountAmount, DiscountPercent, DiscountUnit } from './Vouchers';
-import { OrdersItem } from './Orders';
+import { DiscountAmount, DiscountPercent, DiscountUnit } from './DiscountVoucher';
+import { CustomersCreateBody } from './Customers';
+import { StackableOptions, StackableRedeemableParams, StackableRedeemableResponse } from './Stackable';
+import { ValidationSessionParams, ValidationSessionResponse } from './ValidateSession';
+import { ApplicableToResultList } from './ApplicableTo';
+import { OrdersItem, OrdersCreate, OrdersCreateResponse } from './Orders';
 import { PromotionsValidateParams } from './Promotions';
 export interface ValidationsValidateVoucherParams {
     customer?: {
@@ -23,23 +27,10 @@ export interface ValidationsValidateVoucherParams {
     reward?: {
         id: string;
     };
-    session?: {
-        type: 'LOCK';
-        key?: string;
-        ttl?: number;
-        ttl_unit?: 'MILLISECONDS' | 'SECONDS' | 'MINUTES' | 'HOURS' | 'DAYS';
-    };
+    session?: ValidationSessionParams;
 }
 export interface ValidationsValidateVoucherResponse {
-    applicable_to?: {
-        object: 'list';
-        total: number;
-        data?: {
-            id: string;
-            object: 'product';
-            source_id?: string;
-        }[];
-    };
+    applicable_to?: ApplicableToResultList;
     campaign?: string;
     campaign_id?: string;
     metadata?: Record<string, any>;
@@ -62,5 +53,20 @@ export interface ValidationsValidateVoucherResponse {
     };
     tracking_id: string;
 }
+export interface ValidationsValidateStackableParams {
+    options?: StackableOptions;
+    redeemables: StackableRedeemableParams[];
+    session?: ValidationSessionParams;
+    order?: OrdersCreate;
+    customer?: CustomersCreateBody;
+    metadata?: Record<string, any>;
+}
+export interface ValidationValidateStackableResponse {
+    valid: boolean;
+    tracking_id?: string;
+    session?: ValidationSessionResponse;
+    order?: OrdersCreateResponse;
+    redeemables?: StackableRedeemableResponse[];
+}
 export declare type ValidationsValidateCode = PromotionsValidateParams;
 export declare type ValidationsValidateContext = ValidationsValidateVoucherParams;

package/dist/types/Vouchers.d.ts

@@ -1,5 +1,6 @@
 import { OrdersGetResponse } from './Orders';
 import { SimpleCustomer } from './Customers';
+import { DiscountUnit, DiscountAmount, DiscountPercent } from './DiscountVoucher';
 export declare type VoucherType = 'GIFT' | 'DISCOUNT' | 'LOYALTY_CARD' | 'LUCKY_DRAW';
 export interface SimpleVoucher {
     code_config?: {
@@ -20,21 +21,6 @@ export interface SimpleVoucher {
         quantity: number;
     };
 }
-export interface DiscountUnit {
-    type?: 'UNIT';
-    unit_off?: number;
-    effect?: 'ADD_MISSING_ITEMS' | 'ADD_NEW_ITEMS';
-    unit_type?: string;
-}
-export interface DiscountAmount {
-    type?: 'AMOUNT';
-    amount_off?: number;
-}
-export interface DiscountPercent {
-    type?: 'PERCENT';
-    percent_off?: number;
-    amount_limit?: number;
-}
 export interface VouchersResponse {
     id: string;
     code: string;

package/dist/types/index.d.ts

@@ -17,3 +17,8 @@ export * from './Exports';
 export * from './Orders';
 export * from './Consents';
 export * from './Events';
+export * from './Stackable';
+export * from './Gift';
+export * from './ValidateSession';
+export * from './ApplicableTo';
+export * from './DiscountVoucher';

package/dist/voucherifysdk.esm.js

@@ -1,6 +1,15 @@
 import axios from 'axios';
 import Qs from 'qs';
 
+var DiscountVouchersTypesEnum;
+
+(function (DiscountVouchersTypesEnum) {
+  DiscountVouchersTypesEnum["AMOUNT"] = "AMOUNT";
+  DiscountVouchersTypesEnum["PERCENT"] = "PERCENT";
+  DiscountVouchersTypesEnum["UNIT"] = "UNIT";
+  DiscountVouchersTypesEnum["FIXED"] = "FIXED";
+})(DiscountVouchersTypesEnum || (DiscountVouchersTypesEnum = {}));
+
 /**
  * @internal
  */
@@ -35,9 +44,13 @@ class RequestController {
     this.basePath = void 0;
     this.headers = void 0;
     this.request = void 0;
+    this.lastResponseHeaders = void 0;
+    this.isLastResponseHeadersSet = void 0;
     this.basePath = basePath;
     this.baseURL = baseURL;
     this.headers = headers;
+    this.lastResponseHeaders = {};
+    this.isLastResponseHeadersSet = false;
     this.request = axios.create({
       baseURL: `${this.baseURL}/${this.basePath}/`,
       headers: this.headers,
@@ -57,6 +70,19 @@ class RequestController {
     });
   }
 
+  isLastReponseHeadersSet() {
+    return this.isLastResponseHeadersSet;
+  }
+
+  getLastResponseHeaders() {
+    return this.lastResponseHeaders;
+  }
+
+  setLastResponseHeaders(headers) {
+    this.lastResponseHeaders = headers;
+    this.isLastResponseHeadersSet = true;
+  }
+
   setBaseUrl(baseURL) {
     this.baseURL = baseURL;
     this.request.defaults.baseURL = `${baseURL}/${this.basePath}/`;
@@ -69,6 +95,7 @@ class RequestController {
         return Qs.stringify(params);
       }
     });
+    this.setLastResponseHeaders(response.headers);
     return response.data;
   }
 
@@ -80,6 +107,7 @@ class RequestController {
       },
       headers
     });
+    this.setLastResponseHeaders(response.headers);
     return response.data;
   }
 
@@ -87,6 +115,7 @@ class RequestController {
     const response = await this.request.put(path, body, {
       params
     });
+    this.setLastResponseHeaders(response.headers);
     return response.data;
   }
 
@@ -94,6 +123,7 @@ class RequestController {
     const response = await this.request.delete(path, {
       params
     });
+    this.setLastResponseHeaders(response.headers);
     return response.data;
   }
 
@@ -502,6 +532,14 @@ class Validations {
 
     return this.validateVoucher(code, context);
   }
+  /**
+   * @see https://docs.voucherify.io/reference/validate-stacked-discounts-1
+   */
+
+
+  validateStackable(params) {
+    return this.client.post(`/validations`, params);
+  }
 
 }
 
@@ -518,6 +556,14 @@ class Redemptions {
   redeem(code, body = {}) {
     return this.client.post(`/vouchers/${encode(code)}/redemption`, body);
   }
+  /**
+   * @see https://docs.voucherify.io/reference/redeem-stacked-discounts
+   */
+
+
+  redeemStackable(params) {
+    return this.client.post(`/redemptions`, params);
+  }
   /**
    * @see https://docs.voucherify.io/reference/get-redemption
    */
@@ -570,6 +616,15 @@ class Redemptions {
 
     return this.client.post(`/redemptions/${encode(redemptionId)}/rollback`, payload, queryParams);
   }
+  /**
+   * @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, params, queryParams) {
+    return this.client.post(`/redemptions/${encode(parentRedemptionId)}/rollbacks`, params, queryParams);
+  }
 
 }
 
@@ -1273,12 +1328,60 @@ class Segments {
 
 }
 
+class ApiLimitsHandler {
+  constructor(requestController) {
+    this.requestController = void 0;
+    this.requestController = requestController;
+  }
+
+  getLastResponseHeadersFromController() {
+    return this.requestController.getLastResponseHeaders();
+  }
+
+  areLimitsAvailable() {
+    return this.requestController.isLastReponseHeadersSet();
+  }
+
+  getRateLimit() {
+    var _this$getLastResponse;
+
+    const rateLimit = (_this$getLastResponse = this.getLastResponseHeadersFromController()['x-rate-limit-limit']) != null ? _this$getLastResponse : 0;
+    return parseInt(rateLimit, 10);
+  }
+
+  getRateLimitRemaining() {
+    var _this$getLastResponse2;
+
+    const rateLimitRemaining = (_this$getLastResponse2 = this.getLastResponseHeadersFromController()['x-rate-limit-remaining']) != null ? _this$getLastResponse2 : 0;
+    return parseInt(rateLimitRemaining, 10);
+  }
+
+}
+
+class MetadataSchemas {
+  constructor(client) {
+    this.client = void 0;
+    this.client = client;
+  }
+
+  list() {
+    return this.client.get('/metadata-schemas');
+  }
+
+  get(schemaName) {
+    return this.client.get(`/metadata-schemas/${encode(schemaName)}`);
+  }
+
+}
+
+//  apiLimitsHandler: ApiLimitsHandler
 // 	campaigns: Campaigns
 // 	consents: Consents
 // 	customers: Customers
 // 	distributions: Distributions
 // 	events: Events
 // 	loyalties: Loyalties
+//  metadataSchemas: MetadataSchemas
 // 	orders: Orders
 // 	products: Products
 // 	promotions: Promotions
@@ -1301,7 +1404,7 @@ function VoucherifyServerSide(options) {
   let headers = {
     'X-App-Id': options.applicationId,
     'X-App-Token': options.secretKey,
-    'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.0.3"}`,
+    'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.0.6"}`,
     'Content-Type': 'application/json'
   };
 
@@ -1347,6 +1450,8 @@ function VoucherifyServerSide(options) {
   const loyalties = new Loyalties(client);
   const segments = new Segments(client);
   const validationRules = new ValidationRules(client);
+  const apiLimitsHandler = new ApiLimitsHandler(client);
+  const metadataSchemas = new MetadataSchemas(client);
   return {
     vouchers,
     campaigns,
@@ -1363,7 +1468,9 @@ function VoucherifyServerSide(options) {
     segments,
     validationRules,
     events,
-    asyncActions
+    asyncActions,
+    apiLimitsHandler,
+    metadataSchemas
   };
 }
 
@@ -1516,6 +1623,22 @@ class ClientSide {
   updateConsents(idOrSourceId, consents) {
     return this.client.put(`/customers/${encode(idOrSourceId)}/consents`, consents);
   }
+  /**
+   * @see https://docs.voucherify.io/reference/validate-stackable-discounts-client-side
+   */
+
+
+  validateStackable(params) {
+    return this.client.post(`/validations`, params);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/redeem-stackable-discounts-client-side
+   */
+
+
+  redeemStackable(params) {
+    return this.client.post(`/redemptions`, params);
+  }
 
 }
 
@@ -1530,7 +1653,7 @@ function VoucherifyClientSide(options) {
   let headers = {
     'X-Client-Application-Id': options.clientApplicationId,
     'X-Client-Token': options.clientSecretKey,
-    'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.0.3"}`
+    'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.0.6"}`
   };
 
   if (environment().startsWith('Node')) {
@@ -1550,5 +1673,5 @@ function VoucherifyClientSide(options) {
   return new ClientSide(client, options.trackingId);
 }
 
-export { VoucherifyClientSide, VoucherifyServerSide };
+export { DiscountVouchersTypesEnum, VoucherifyClientSide, VoucherifyServerSide };
 //# sourceMappingURL=voucherifysdk.esm.js.map