@voucherify/sdk 2.7.1 → 2.7.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @voucherify/sdk
 
+## 2.7.3
+
+### Patch Changes
+
+- [`d532cc4`](https://github.com/voucherifyio/voucherify-js-sdk/commit/d532cc4dd6ccc1ea6cab120b8a3cec7d86598ffd) [#270](https://github.com/voucherifyio/voucherify-js-sdk/pull/270) Thanks [@p-zielinski](https://github.com/p-zielinski)! - Type support for partial redemptions. General update to responses of /validations and /redemptions endpoints.
+
+## 2.7.2
+
+### Patch Changes
+
+- [`3d23881`](https://github.com/voucherifyio/voucherify-js-sdk/commit/3d23881738f317903dae3373642cc7151159ca26) [#268](https://github.com/voucherifyio/voucherify-js-sdk/pull/268) Thanks [@darekg11](https://github.com/darekg11)! - New endpoint support - `customer-redeemable`
+
 ## 2.7.1
 
 ### Patch Changes

package/README.md

@@ -654,6 +654,7 @@ Methods are provided within `client.customers.*` namespace.
 - [Update Customers in bulk](#update-customers-in-bulk)
 - [Update Customers' Metadata in bulk](#update-customers-metadata-in-bulk)
 - [Import and Update Customers using CSV](#import-and-update-customers-using-csv)
+- [List Redeemables](#list-redeemables)
 
 #### [Create Customer](https://docs.voucherify.io/reference/create-customer)
 
@@ -759,6 +760,12 @@ client.customers.updateInBulk(customers)
 client.customers.updateMetadataInBulk(sourceIdsAndMetadata)
 ```
 
+#### [List Redeemables](https://docs.voucherify.io/reference/list-customer-redeemables)
+
+```javascript
+client.customers.listRedeemables(id, params)
+```
+
 ---
 
 ### Consents

package/dist/Customers.d.ts

@@ -60,5 +60,9 @@ declare class Customers {
      * @see https://docs.voucherify.io/reference/import-customers-using-csv
      */
     importCSV(filePath: string): Promise<AAT.AsyncActionCreateResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/list-customer-redeemables
+     */
+    listRedeemables(id: string, params?: T.CustomerRedeemablesListQueryParams): Promise<T.CustomerRedeemablesListResponse>;
 }
 export { Customers };

package/dist/types/Categories.d.ts

@@ -30,6 +30,7 @@ export declare type Category = {
     created_at: string;
     updated_at?: string;
     object: 'category';
+    stacking_rules_type?: 'JOINT' | 'EXCLUSIVE';
 };
 export declare type CategoriesListRequestQuery = {
     limit?: number;

package/dist/types/Customers.d.ts

@@ -1,3 +1,4 @@
+import { DiscountUnit, DiscountAmount, DiscountPercent, DiscountFixed } from './DiscountVoucher';
 export interface SimpleCustomer {
     id: string;
     name?: string;
@@ -110,6 +111,94 @@ export interface CustomerActivitiesListResponse {
     data_ref: 'data';
     data: Record<string, any>[];
 }
+export interface CustomerRedeemablesListQueryParams {
+    limit?: number;
+    order?: 'created_at' | '-created_at' | 'id' | '-id';
+    starting_after_id?: string;
+    filters?: Record<string, any>;
+}
+export interface CustomerRedeemablesListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'data';
+    data: CustomerRedeemablesListItemResponse[];
+    has_more: boolean;
+    more_starting_after?: string;
+}
+export interface CustomerRedeemablesListItemResponse {
+    id: string;
+    created_at: string;
+    redeemable_id: string;
+    redeemable_object: string;
+    customer_id: string;
+    holder_role: 'OWNER' | 'REFERRER' | 'REFEREE';
+    campaign_id: string;
+    campaign_type: 'LOYALTY_PROGRAM' | 'PROMOTION' | 'DISCOUNT_COUPONS' | 'GIFT_VOUCHERS' | 'REFERRAL_PROGRAM';
+    voucher_type: 'GIFT_VOUCHER' | 'DISCOUNT_VOUCHER' | 'LOYALTY_CARD';
+    redeemable: CustomerRedeemablesListItemContainerResponse;
+}
+export interface CustomerRedeemablesListItemContainerVoucherResponse {
+    id: string;
+    code: string;
+    campaign?: string;
+    camapign_id?: string;
+    category_id?: string;
+    type: 'GIFT_VOUCHER' | 'DISCOUNT_VOUCHER' | 'LOYALTY_CARD';
+    discount?: DiscountAmount | DiscountPercent | DiscountUnit | DiscountFixed;
+    gift?: {
+        amount: number;
+        balance: number;
+        effect: string;
+    };
+    loyalty_card?: {
+        points: number;
+        balance: number;
+        next_expiration_date?: string;
+        next_expiration_points?: number;
+    };
+    start_date?: string;
+    expiration_date?: string;
+    validity_timeframe?: {
+        interval: string;
+        duration: string;
+    };
+    validity_day_of_week?: number[];
+    publish?: {
+        object: 'list';
+        count: number;
+        url: string;
+    };
+    redemption?: {
+        object: 'list';
+        quantity?: number;
+        redeemed_quantity: number;
+        url: string;
+        redeemed_points?: number;
+    };
+    active?: boolean;
+    additional_info?: string;
+    metadata?: Record<string, any>;
+    assets: {
+        qr: {
+            id: string;
+            url: string;
+        };
+        barcode: {
+            id: string;
+            url: string;
+        };
+    };
+    is_referral_code: boolean;
+    holder_id?: string;
+    updated_at?: string;
+    created_at: string;
+    object: 'voucher';
+}
+export interface CustomerRedeemablesListItemContainerResponse {
+    type: 'voucher';
+    voucher?: CustomerRedeemablesListItemContainerVoucherResponse;
+    status: 'ACTIVE' | 'USED' | 'DISABLED' | 'NOT_ACTIVE_YET' | 'EXPIRED' | 'NO_BALANCE';
+}
 export declare type CustomersCreateBody = CustomerRequest;
 export declare type CustomersCreateResponse = CustomerObject | CustomerUnconfirmed;
 export declare type CustomersGetResponse = CustomerObject | CustomerUnconfirmed;

package/dist/types/Redemptions.d.ts

@@ -4,7 +4,7 @@ import { CustomersCreateBody, SimpleCustomer } from './Customers';
 import { VouchersResponse } from './Vouchers';
 import { GiftRedemptionParams } from './Gift';
 import { ValidationSessionParams, ValidationSessionReleaseParams } from './ValidateSession';
-import { StackableOptions, StackableRedeemableParams } from './Stackable';
+import { StackableOptions, StackableRedeemableInapplicableResponse, StackableRedeemableParams, StackableRedeemableSkippedResponse } from './Stackable';
 import { PromotionTierRedeemDetailsSimple, PromotionTierRedeemDetails } from './PromotionTiers';
 export interface RedemptionsRedeemBody {
     tracking_id?: string;
@@ -185,6 +185,8 @@ export interface RedemptionsRedeemStackableResponse {
         related_object_id: string;
     };
     order?: RedemptionsRedeemStackableOrderResponse;
+    skipped_redeemables?: StackableRedeemableSkippedResponse;
+    inapplicable_redeemables?: StackableRedeemableInapplicableResponse;
 }
 export interface RedemptionsRollbackStackableResponse {
     rollbacks: RedemptionsRedeemStackableRedemptionResult[];

package/dist/types/Stackable.d.ts

@@ -6,6 +6,7 @@ import { DiscountVouchersTypes, DiscountVouchersEffectTypes, DiscountUnitVoucher
 import { SimpleProduct, SimpleSku } from './Products';
 import { LoyaltyPointsTransfer } from './Loyalties';
 import { ValidationError } from './ValidationError';
+import { Category } from './Categories';
 declare type ExpandOption = 'order' | 'redeemable' | 'redemption';
 export interface StackableOptions {
     expand: ExpandOption[];
@@ -54,6 +55,10 @@ export interface StackableRedeemableResultResponse {
     gift?: StackableRedeemableResultGift;
     loyalty_card?: StackableRedeemableResultLoyaltyCard;
     error?: ValidationError;
+    details?: {
+        key?: string;
+        message?: string;
+    };
 }
 export interface StackableRedeemableResponse {
     status: StackableRedeemableResponseStatus;
@@ -64,5 +69,33 @@ export interface StackableRedeemableResponse {
     inapplicable_to?: ApplicableToResultList;
     result?: StackableRedeemableResultResponse;
     metadata?: Record<string, any>;
+    categories?: Category[];
 }
+export declare type StackableRedeemableInapplicableResponse = {
+    status: 'INAPPLICABLE';
+    id: string;
+    object: 'voucher' | 'promotion_tier';
+    result: {
+        error?: ValidationError;
+        details?: {
+            key?: string;
+            message?: string;
+        };
+    };
+    metadata?: Record<string, unknown>;
+    categories?: Category[];
+};
+export declare type StackableRedeemableSkippedResponse = {
+    status: 'SKIPPED';
+    id: string;
+    object: 'voucher' | 'promotion_tier';
+    result: {
+        details?: {
+            key?: string;
+            message?: string;
+        };
+    };
+    metadata?: Record<string, unknown>;
+    categories?: Category[];
+};
 export {};

package/dist/types/Validations.d.ts

@@ -1,6 +1,6 @@
 import { DiscountAmount, DiscountPercent, DiscountUnit, DiscountFixed } from './DiscountVoucher';
 import { CustomersCreateBody } from './Customers';
-import { StackableOptions, StackableRedeemableParams, StackableRedeemableResponse } from './Stackable';
+import { StackableOptions, StackableRedeemableInapplicableResponse, StackableRedeemableParams, StackableRedeemableResponse, StackableRedeemableSkippedResponse } from './Stackable';
 import { ValidationSessionParams, ValidationSessionResponse } from './ValidateSession';
 import { ApplicableToResultList } from './ApplicableTo';
 import { ValidationError } from './ValidationError';
@@ -79,6 +79,20 @@ export interface ValidationValidateStackableResponse {
     session?: ValidationSessionResponse;
     order?: OrdersCreateResponse;
     redeemables?: StackableRedeemableResponse[];
+    skipped_redeemables?: StackableRedeemableSkippedResponse;
+    inapplicable_redeemables?: StackableRedeemableInapplicableResponse;
+    stacking_rules: ValidationsStackingRules;
 }
+export declare type ValidationsStackingRules = {
+    redeemables_limit: number;
+    applicable_redeemables_limit: number;
+    applicable_redeemables_per_category_limit?: number;
+    applicable_exclusive_redeemables_limit: number;
+    applicable_exclusive_redeemables_per_category_limit?: number;
+    exclusive_categories: string[];
+    joint_categories: string[];
+    redeemables_application_mode: 'ALL' | 'PARTIAL';
+    redeemables_sorting_rule: 'CATEGORY_HIERARCHY' | 'REQUESTED_ORDER';
+};
 export declare type ValidationsValidateCode = PromotionsValidateParams;
 export declare type ValidationsValidateContext = ValidationsValidateVoucherParams;

package/dist/voucherifysdk.esm.js

@@ -973,6 +973,14 @@ class Customers {
     };
     return this.client.post(`/customers/importCSV`, form, undefined, headers);
   }
+  /**
+   * @see https://docs.voucherify.io/reference/list-customer-redeemables
+   */
+
+
+  listRedeemables(id, params) {
+    return this.client.get(`/customers/${encode(id)}/redeemables`, params);
+  }
 
 }
 
@@ -1944,7 +1952,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.7.1"}`,
+    'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.7.3"}`,
     'Content-Type': 'application/json'
   };
 
@@ -2210,7 +2218,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.7.1"}`
+    'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.7.3"}`
   };
 
   if (environment().startsWith('Node')) {