@voucherify/sdk 2.4.0 → 2.6.0

package/dist/types/Rewards.d.ts

@@ -16,6 +16,7 @@ export interface RewardsResponse {
     object: 'reward';
 }
 export declare type RewardsCreateResponse = RewardsResponse & RewardsTypeResponse;
+export declare type RewardsGetResponse = RewardsResponse & RewardsTypeResponse;
 export interface RewardsListResponse {
     object: 'list';
     total: number;
@@ -69,7 +70,6 @@ interface RewardsTypeCoin {
 export declare type RewardsType = RewardsTypeCampaign | RewardsTypeCoin | RewardsTypeMaterial;
 export declare type RewardsTypeResponse = Required<RewardsTypeCampaignResponse> | Required<RewardsTypeCoin> | Required<RewardsTypeMaterial>;
 export declare type RewardsCreate = Rewards & RewardsType;
-export declare type RewardsGetResponse = RewardsCreateResponse;
 export declare type RewardsUpdate = Omit<RewardsCreate, 'type'> & {
     id: string;
 };
@@ -116,4 +116,104 @@ export interface RewardRedemptionParams {
     assignment_id?: string;
     id?: string;
 }
+export declare type Reward = {
+    id: string;
+    name?: string;
+    stock?: string;
+    redeemed?: string;
+    attributes?: {
+        image_url?: string;
+        description?: string;
+    };
+    created_at: string;
+    updated_at?: string;
+    object: 'reward';
+} & RewardType;
+export interface RewardTypeCampaign {
+    type: 'CAMPAIGN';
+    parameters: {
+        campaign: {
+            id: string;
+            balance?: number;
+            type: 'DISCOUNT_COUPONS' | 'PROMOTION' | 'GIFT_VOUCHERS' | 'REFERRAL_PROGRAM';
+        };
+    };
+}
+export interface RewardTypeCoin {
+    type: 'COIN';
+    parameters: {
+        coin: {
+            exchange_ratio: number;
+            points_ratio?: number;
+        };
+    };
+}
+export interface RewardTypeMaterial {
+    type: 'MATERIAL';
+    parameters: {
+        product: {
+            id: string;
+            sku: string | null;
+        };
+    };
+}
+export declare type RewardType = RewardTypeCampaign | RewardTypeCoin | RewardTypeMaterial;
+export declare type RewardAssignment = RewardsAssignmentCoinReward | RewardsAssignmentCampaignOrMaterialReward;
+export interface RewardsAssignmentCoinReward {
+    id: string;
+    reward_id: 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;
+        };
+    };
+    id: string;
+}
+export declare type RewardsUpdateAssignmentResponseBody = RewardAssignment;
 export {};

package/dist/types/UtilityTypes.d.ts

@@ -0,0 +1,3 @@
+export declare type WithRequiredProperty<Type, Key extends keyof Type> = Type & {
+    [Property in Key]-?: Type[Property];
+};

package/dist/types/ValidationRules.d.ts

@@ -69,3 +69,24 @@ export interface ValidationRulesListAssignmentsResponse {
     data_ref: 'data';
     data: ValidationRulesCreateAssignmentResponse[];
 }
+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[];
+}

package/dist/types/Vouchers.d.ts

@@ -1,6 +1,7 @@
 import { OrdersGetResponse } from './Orders';
 import { SimpleCustomer } from './Customers';
 import { DiscountUnit, DiscountAmount, DiscountPercent, DiscountFixed } from './DiscountVoucher';
+import { LoyaltyCardTransaction } from './Loyalties';
 export declare type VoucherType = 'GIFT_VOUCHER' | 'DISCOUNT_VOUCHER' | 'LOYALTY_CARD' | 'LUCKY_DRAW';
 export interface SimpleVoucher {
     code_config?: {
@@ -214,3 +215,140 @@ export declare type VouchersBulkUpdateMetadataResponse = {
 export declare type VouchersBulkUpdateResponse = {
     async_action_id: string;
 };
+export declare type GiftCardTransaction = GiftCardTransactionBase & GiftCardTransactionDetails;
+export interface GiftCardTransactionBase {
+    id: string;
+    source_id: string | null;
+    voucher_id: string;
+    campaign_id: string | null;
+    related_transaction_id: string | null;
+    reason: string | null;
+    created_at: string;
+}
+export declare type GiftCardTransactionDetails = GiftCardTransactionRedemptionDetails | GiftCardTransactionRefundDetails | GiftCardTransactionAdditionDetails | GiftCardTransactionRemovalDetails;
+export interface GiftCardTransactionRedemptionDetails {
+    source: null;
+    type: 'CREDITS_REDEMPTION';
+    details: {
+        balance: {
+            type: 'gift_voucher';
+            total: number;
+            amount: number;
+            object: 'balance';
+            balance: number;
+            related_object: {
+                id: string;
+                type: 'voucher';
+            };
+        };
+        order: {
+            id: string;
+            source_id: string | null;
+        };
+        redemption: {
+            id: string;
+        };
+    };
+}
+export interface GiftCardTransactionRefundDetails {
+    source: null;
+    type: 'CREDITS_REFUND';
+    details: {
+        balance: {
+            type: 'gift_voucher';
+            total: number;
+            amount: number;
+            object: 'balance';
+            balance: number;
+            related_object: {
+                id: string;
+                type: 'voucher';
+            };
+        };
+        order: {
+            id: string;
+            source_id: string | null;
+        };
+        redemption: {
+            id: string;
+        };
+        rollback: {
+            id: string;
+        };
+    };
+}
+export interface GiftCardTransactionAdditionDetails {
+    source: 'voucherify-web-ui' | 'API';
+    type: 'CREDITS_ADDITION';
+    details: {
+        balance: {
+            type: 'gift_voucher';
+            total: number;
+            amount: number;
+            object: 'balance';
+            balance: number;
+            operation_type: 'MANUAL' | 'AUTOMATIC';
+            related_object: {
+                id: string;
+                type: 'voucher';
+            };
+        };
+    };
+}
+export interface GiftCardTransactionRemovalDetails {
+    source: 'voucherify-web-ui' | 'API';
+    type: 'CREDITS_REMOVAL';
+    details: {
+        balance: {
+            type: 'gift_voucher';
+            total: number;
+            amount: number;
+            object: 'balance';
+            balance: number;
+            operation_type: 'MANUAL' | 'AUTOMATIC';
+            related_object: {
+                id: string;
+                type: 'voucher';
+            };
+        };
+    };
+}
+export declare type VoucherTransaction = GiftCardTransaction | LoyaltyCardTransaction;
+export declare type VoucherTransactionsExportFields = 'id' | 'campaign_id' | 'voucher_id' | 'type' | 'source_id' | 'reason' | 'source' | 'balance' | 'amount' | 'related_transaction_id' | 'created_at' | 'details';
+export interface VouchersListTransactionsRequestQuery {
+    limit?: number;
+    page?: number;
+}
+export interface VouchersListTransactionsResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: VoucherTransaction[];
+    has_more: boolean;
+}
+export interface VouchersExportTransactionsRequestBody {
+    parameters?: {
+        order?: '-created_at' | 'created_at';
+        fields?: VoucherTransactionsExportFields[];
+    };
+}
+export interface VouchersExportTransactionsResponseBody {
+    id: string;
+    status: 'SCHEDULED';
+    channel: string;
+    parameters: {
+        order?: string;
+        fields?: VoucherTransactionsExportFields[];
+        filters: {
+            voucher_id: {
+                conditions: {
+                    $in: [string];
+                };
+            };
+        };
+    };
+    result: null;
+    user_id: string | null;
+    exported_object: 'voucher_transactions';
+    object: 'export';
+    created_at: string;
+}

package/dist/voucherifysdk.esm.js

@@ -393,6 +393,14 @@ class Exports {
   create(exportResource) {
     return this.client.post('/exports', exportResource);
   }
+  /**
+   * @see https://docs.voucherify.io/reference/list-exports
+   */
+
+
+  list(query = {}) {
+    return this.client.get('/exports', query);
+  }
   /**
    * @see https://docs.voucherify.io/reference/get-export
    */
@@ -578,6 +586,22 @@ class Vouchers {
     form.append('file', fileStream);
     return this.client.post('/vouchers/importCSV', form);
   }
+  /**
+   * @see https://docs.voucherify.io/reference/list-voucher-transactions
+   */
+
+
+  listTransactions(code, params) {
+    return this.client.get(`/vouchers/${encode(code)}/transactions`, params);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/export-voucher-transactions
+   */
+
+
+  exportTransactions(code, body) {
+    return this.client.post(`/vouchers/${encode(code)}/transactions/export`, body);
+  }
 
 }
 
@@ -765,11 +789,13 @@ class PromotionTiers {
 }
 
 class Promotions {
-  constructor(client, tiers) {
+  constructor(client, tiers, stack) {
     this.client = void 0;
     this.tiers = void 0;
+    this.stack = void 0;
     this.client = client;
     this.tiers = tiers;
+    this.stack = stack;
   }
   /**
    * @see https://docs.voucherify.io/reference/create-promotion-campaign
@@ -1172,6 +1198,14 @@ class Rewards {
   delete(rewardId) {
     return this.client.delete(`/rewards/${encode(rewardId)}`);
   }
+  /**
+   * @see https://docs.voucherify.io/reference/get-reward-assignment
+   */
+
+
+  getAssignment(rewardId, assignmentId) {
+    return this.client.get(`/rewards/${encode(rewardId)}/assignments/${encode(assignmentId)}`);
+  }
   /**
    * @see https://docs.voucherify.io/reference/list-reward-assignments
    */
@@ -1280,6 +1314,14 @@ class Loyalties {
   deleteRewardAssignment(campaignId, assignmentId) {
     return this.client.delete(`/loyalties/${encode(campaignId)}/rewards/${assignmentId}`);
   }
+  /**
+   * @see https://docs.voucherify.io/reference/get-reward-assignment-2
+   */
+
+
+  getRewardAssignment(campaignId, assignmentId) {
+    return this.client.get(`/loyalties/${encode(campaignId)}/rewards/${encode(assignmentId)}`);
+  }
   /**
    * @see https://docs.voucherify.io/reference/list-earning-rules
    */
@@ -1354,28 +1396,63 @@ class Loyalties {
   }
   /**
    * @see https://docs.voucherify.io/reference/get-member
+   * @see https://docs.voucherify.io/reference/get-member-1
    */
 
 
   getMember(campaignId, memberId) {
-    return this.client.get(`/loyalties/${encode(campaignId)}/members/${memberId}`);
+    return this.client.get(campaignId ? `/loyalties/${encode(campaignId)}/members/${memberId}` : `/loyalties/members/${memberId}`);
   }
   /**
    * @see https://docs.voucherify.io/reference/get-member-activities
+   * @see https://docs.voucherify.io/reference/get-member-activities-1
    */
 
 
   getMemberActivities(campaignId, memberId) {
-    return this.client.get(`/loyalties/${encode(campaignId)}/members/${memberId}/activities`);
+    return this.client.get(campaignId ? `/loyalties/${encode(campaignId)}/members/${memberId}/activities` : `/loyalties/members/${memberId}/activities`);
   }
   /**
-   * @see https://docs.voucherify.io/reference/add-loyalty-card-balance
+   * @see https://docs.voucherify.io/reference/list-member-rewards
+   */
+
+
+  listMemberRewards(memberId, params) {
+    return this.client.get(`/loyalties/members/${encode(memberId)}/rewards`, params);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance
+   * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1
+   */
+
+
+  addOrRemoveCardBalance(memberId, balance, campaignId) {
+    return this.client.post(campaignId ? `/loyalties/${encode(campaignId)}/members/${memberId}/balance` : `/loyalties/members/${memberId}/balance`, balance);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/add-remove-loyalty-card-balance-1
    */
 
 
   addPoints(campaignId, memberId, balance) {
     return this.client.post(`/loyalties/${encode(campaignId)}/members/${memberId}/balance`, balance);
   }
+  /**
+   * @see https://docs.voucherify.io/reference/transfer-points
+   */
+
+
+  transferPoints(campaignId, memberId, loyaltiesTransferPoints) {
+    return this.client.post(`/loyalties/${encode(campaignId)}/members/${encode(memberId)}/transfers`, loyaltiesTransferPoints);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/get-points-expiration
+   */
+
+
+  getPointsExpiration(campaignId, memberId, params) {
+    return this.client.get(`/loyalties/${encode(campaignId)}/members/${memberId}/points-expiration`, params);
+  }
   /**
    * @see https://docs.voucherify.io/reference/redeem-loyalty-card
    */
@@ -1384,6 +1461,80 @@ class Loyalties {
   redeemReward(campaignId, memberId, params) {
     return this.client.post(`/loyalties/${encode(campaignId)}/members/${encode(memberId)}/redemption`, params);
   }
+  /**
+   * @see https://docs.voucherify.io/reference/list-loyalty-tier-rewards
+   */
+
+
+  listLoyaltyTierRewards(campaignId, tierId) {
+    return this.client.get(`/loyalties/${encode(campaignId)}/tiers/${encode(tierId)}/rewards`);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/list-loyalty-card-transactions
+   * @see https://docs.voucherify.io/reference/list-loyalty-card-transactions-1
+   */
+
+
+  listCardTransactions(memberId, campaignId, params) {
+    return this.client.get(campaignId ? `/loyalties/${encode(campaignId)}/members/${encode(memberId)}/transactions` : `/loyalties/members/${encode(memberId)}/transactions`, params);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/export-loyalty-card-transactions
+   * @see https://docs.voucherify.io/reference/export-loyalty-card-transactions-1
+   */
+
+
+  exportCardTransactions(memberId, campaignId, params = {}) {
+    return this.client.post(campaignId ? `/loyalties/${encode(campaignId)}/members/${encode(memberId)}/transactions/export` : `/loyalties/members/${encode(memberId)}/transactions/export`, params);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/get-reward-details
+   */
+
+
+  getRewardDetails(campaignId, assignmentId) {
+    return this.client.get(`/loyalties/${encode(campaignId)}/reward-assignments/${encode(assignmentId)}/reward`);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/list-loyalty-tiers
+   */
+
+
+  listTiers(campaignId, params) {
+    return this.client.get(`/loyalties/${encode(campaignId)}/tiers`, params);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/get-loyalty-tier
+   */
+
+
+  getTier(campaignId, tierId) {
+    return this.client.get(`/loyalties/${encode(campaignId)}/tiers/${encode(tierId)}`);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/create-loyalty-tiers
+   */
+
+
+  createTiers(campaignId, tiers) {
+    return this.client.post(`/loyalties/${encode(campaignId)}/tiers`, tiers);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/list-loyalty-tier-earning-rules
+   */
+
+
+  listLoyaltyTierEarningRules(campaignId, tierId, params) {
+    return this.client.get(`/loyalties/${encode(campaignId)}/tiers/${encode(tierId)}/earning-rules`, params);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/get-member-loyalty-tier
+   */
+
+
+  listMemberLoyaltyTiers(memberId) {
+    return this.client.get(`/loyalties/members/${encode(memberId)}/tiers`);
+  }
 
 }
 
@@ -1452,6 +1603,14 @@ class ValidationRules {
   list(params = {}) {
     return this.client.get('/validation-rules', params);
   }
+  /**
+   * @see https://docs.voucherify.io/reference/list-validation-rules-assignments
+   */
+
+
+  listRulesAssignments(params = {}) {
+    return this.client.get(`/validation-rules-assignments`, params);
+  }
   /**
    * @see https://docs.voucherify.io/reference/list-validation-rule-assignments
    */
@@ -1574,8 +1733,8 @@ class Categories {
    */
 
 
-  list() {
-    return this.client.get('/categories');
+  list(params = {}) {
+    return this.client.get('/categories', params);
   }
   /**
    * @see https://docs.voucherify.io/reference/create-category
@@ -1612,6 +1771,110 @@ class Categories {
 
 }
 
+class PromotionsStacks {
+  constructor(client) {
+    this.client = void 0;
+    this.client = client;
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/list-promotion-stacks-in-campaign
+   */
+
+
+  listInCampaign(campaignId) {
+    return this.client.get(`/promotions/${campaignId}/stacks`);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/list-promotion-stacks-in-campaign
+   */
+
+
+  createInCampaign(campaignId, body) {
+    return this.client.post(`/promotions/${campaignId}/stacks`, body);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/delete-promotion-stack
+   */
+
+
+  delete(campaignId, stackId) {
+    return this.client.delete(`/promotions/${campaignId}/stacks/${stackId}`);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/get-promotion-stack
+   */
+
+
+  get(campaignId, stackId) {
+    return this.client.get(`/promotions/${campaignId}/stacks/${stackId}`);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/update-promotion-stack
+   */
+
+
+  update(campaignId, stackId, body) {
+    return this.client.put(`/promotions/${campaignId}/stacks/${stackId}`, body);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/list-promotion-stacks-in-campaign
+   */
+
+
+  list(params) {
+    return this.client.get(`/promotions/stacks`, params);
+  }
+
+}
+
+class ProductCollections {
+  constructor(client) {
+    this.client = void 0;
+    this.client = client;
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/create-product-collection
+   */
+
+
+  create(productCollection) {
+    return this.client.post(`/product-collections`, productCollection);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/list-product-collections
+   */
+
+
+  list(params) {
+    return this.client.get(`/product-collections`, params);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/delete-product-collection
+   */
+
+
+  delete(productCollectionId) {
+    return this.client.delete(`/product-collections/${encode(productCollectionId)}`);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/get-product-collection
+   */
+
+
+  get(productCollectionId) {
+    return this.client.get(`/product-collections/${encode(productCollectionId)}`);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/list-products-in-collection
+   */
+
+
+  listProducts(productCollectionId, params) {
+    return this.client.get(`/product-collections/${encode(productCollectionId)}/products`, params);
+  }
+
+}
+
 //  apiLimitsHandler: ApiLimitsHandler
 // 	campaigns: Campaigns
 // 	consents: Consents
@@ -1642,7 +1905,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.4.0"}`,
+    'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.6.0"}`,
     'Content-Type': 'application/json'
   };
 
@@ -1680,13 +1943,15 @@ function VoucherifyServerSide(options) {
   const events = new Events(client);
   const distributions = new Distributions(client, exportsNamespace);
   const promotionTiers = new PromotionTiers(client);
-  const promotions = new Promotions(client, promotionTiers);
+  const promotionStack = new PromotionsStacks(client);
+  const promotions = new Promotions(client, promotionTiers, promotionStack);
   const validations = new Validations(client, promotions);
   const redemptions = new Redemptions(client);
   const customers = new Customers(client);
   const consents = new Consents(client);
   const orders = new Orders(client);
   const products = new Products(client);
+  const productCollections = new ProductCollections(client);
   const rewards = new Rewards(client);
   const loyalties = new Loyalties(client);
   const segments = new Segments(client);
@@ -1705,6 +1970,7 @@ function VoucherifyServerSide(options) {
     consents,
     orders,
     products,
+    productCollections,
     rewards,
     loyalties,
     segments,
@@ -1895,7 +2161,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.4.0"}`
+    'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.6.0"}`
   };
 
   if (environment().startsWith('Node')) {