@voucherify/sdk 2.3.0 → 2.5.0

package/dist/types/ProductCollections.d.ts

@@ -0,0 +1,95 @@
+import { WithRequiredProperty } from './UtilityTypes';
+export interface ProductIdentity {
+    id?: string;
+    object?: 'product';
+}
+export interface SkuIdentity {
+    id?: string;
+    product_id?: string;
+    object?: 'sku';
+}
+export interface ProductBase {
+    name?: string | null;
+    price?: number | null;
+    attributes?: string[];
+    metadata?: Record<string, unknown>;
+}
+export interface SkuBase {
+    sku?: string | null;
+    price?: number | null;
+    attributes?: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+    product?: Required<ProductIdentity> & Required<ProductBase> & {
+        source_id: string | null;
+        object: 'product';
+    };
+    image_url?: string | null;
+}
+export interface ProductSaved {
+    created_at?: string;
+    updated_at?: string | null;
+    image_url?: string | null;
+    object?: 'product';
+}
+export interface SkuSaved {
+    created_at?: string;
+    updated_at?: string | null;
+    image_url?: string | null;
+    object?: 'sku';
+}
+export declare type ProductOrSkuIdentity = Required<SkuIdentity> | Required<ProductIdentity>;
+export interface ProductCollectionIdentity {
+    id?: string;
+}
+export interface ProductCollectionSaved {
+    created_at?: string;
+    object?: 'products_collection';
+}
+export declare type ProductCollectionBase = StaticProductCollectionBase | DynamicProductCollectionBase;
+export interface StaticProductCollectionBase {
+    name?: string;
+    type?: 'STATIC';
+    products?: ProductOrSkuIdentity[];
+}
+export interface DynamicProductCollectionBase {
+    name?: string;
+    type?: 'AUTO_UPDATE';
+    filter?: Filter;
+}
+export declare type ProductCollection = ProductCollectionBase & ProductCollectionIdentity & ProductCollectionSaved;
+export declare type Filter = {
+    junction: Junction;
+} & Partial<Record<AllowedFiltersKeys, {
+    conditions: Partial<Record<FiltersCondition, unknown>>;
+}>>;
+export declare type Junction = 'and' | 'AND' | 'or' | 'OR';
+export declare type AllowedFiltersKeys = 'id' | 'name' | 'attributes' | 'source_id' | 'price' | 'image_url' | 'product_id' | 'skus' | 'created_at' | 'updated_at' | 'object' | `metadata.${string}`;
+export declare type FiltersCondition = '$in' | '$not_in' | '$is' | '$is_days_ago' | '$is_days_in_future' | '$is_not' | '$has_value' | '$is_unknown' | '$contains' | '$not_contain' | '$starts_with' | '$ends_with' | '$more_than' | '$less_than' | '$more_than_ago' | '$less_than_ago' | '$more_than_future' | '$less_than_future' | '$more_than_equal' | '$less_than_equal' | '$after' | '$before' | '$count' | '$count_less' | '$count_more';
+export declare type ProductCollectionsCreateRequestBody = WithRequiredProperty<StaticProductCollectionBase, 'name' | 'type'> | Required<DynamicProductCollectionBase>;
+export declare type ProductCollectionsCreateResponseBody = Required<ProductCollectionBase> & Required<ProductCollectionIdentity> & Required<ProductCollectionSaved>;
+export interface ProductCollectionsListRequestQuery {
+    limit?: number;
+    page?: number;
+    order?: 'created_at' | '-created_at';
+}
+export interface ProductCollectionsListResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: Required<ProductCollection>[];
+    total: number;
+}
+export declare type ProductCollectionsGetResponseBody = Required<ProductCollection>;
+export interface ProductCollectionsListProductsRequestQuery {
+    limit?: number;
+    page?: number;
+}
+export interface ProductCollectionsListProductsResponseBody {
+    object: 'list';
+    data_ref: 'data';
+    data: ((Required<SkuIdentity> & Required<SkuSaved> & Required<SkuBase> & {
+        source_id: string | null;
+    }) | (Required<ProductIdentity> & Required<ProductSaved> & Required<ProductBase> & {
+        source_id: string | null;
+    }))[];
+    total: number;
+}

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,60 @@ 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 interface RewardAssignment {
+    id: string;
+    reward_id: string;
+    related_object_id?: string;
+    related_object_type?: string;
+    parameters?: {
+        loyalty?: {
+            points: number;
+        };
+    };
+    created_at: string;
+    updated_at?: string;
+    object: 'reward_assignment';
+}
 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/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
    */
@@ -869,6 +877,22 @@ class Customers {
     const customerWithoutId = omit(customer, ['id']);
     return this.client.put(`/customers/${encode(id)}`, customerWithoutId);
   }
+  /**
+   * @see https://docs.voucherify.io/reference/update-customers-in-bulk
+   */
+
+
+  updateInBulk(customers) {
+    return this.client.post(`/customers/bulk/async`, customers);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/update-customers-metadata-in-bulk
+   */
+
+
+  updateMetadataInBulk(sourceIdsAndMetadata) {
+    return this.client.post(`/customers/metadata/async`, sourceIdsAndMetadata);
+  }
   /**
    * @see https://docs.voucherify.io/reference/delete-customer
    */
@@ -877,6 +901,14 @@ class Customers {
   delete(customerId) {
     return this.client.delete(`/customers/${encode(customerId)}`);
   }
+  /**
+   * @see https://docs.voucherify.io/reference/delete-customer-permanently
+   */
+
+
+  deletePermanently(customerId) {
+    return this.client.post(`/customers/${encode(customerId)}/permanent-deletion`, {});
+  }
   /**
    * @see https://docs.voucherify.io/reference/update-customers-consents
    */
@@ -1288,6 +1320,30 @@ class Loyalties {
   deleteEarningRule(campaignId, earningRuleId) {
     return this.client.delete(`/loyalties/${encode(campaignId)}/earning-rules/${earningRuleId}`);
   }
+  /**
+   * @see https://docs.voucherify.io/reference/get-earning-rule
+   */
+
+
+  getEarningRule(campaignId, earningRuleId) {
+    return this.client.get(`/loyalties/${encode(campaignId)}/earning-rules/${encode(earningRuleId)}`);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/enable-earning-rule
+   */
+
+
+  enableEarningRule(campaignId, earningRuleId) {
+    return this.client.post(`/loyalties/${encode(campaignId)}/earning-rules/${earningRuleId}/enable`, {});
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/disable-earning-rule
+   */
+
+
+  disableEarningRule(campaignId, earningRuleId) {
+    return this.client.post(`/loyalties/${encode(campaignId)}/earning-rules/${earningRuleId}/disable`, {});
+  }
   /**
    * @see https://docs.voucherify.io/reference/list-members
    */
@@ -1306,28 +1362,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
    */
@@ -1336,6 +1427,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-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-assignment-1
+   */
+
+
+  getRewardAssignment(campaignId, assignmentId) {
+    return this.client.get(`/loyalties/${encode(campaignId)}/reward-assignments/${encode(assignmentId)}`);
+  }
+  /**
+   * @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`);
+  }
 
 }
 
@@ -1564,6 +1729,54 @@ class Categories {
 
 }
 
+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
@@ -1594,7 +1807,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.3.0"}`,
+    'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.5.0"}`,
     'Content-Type': 'application/json'
   };
 
@@ -1639,6 +1852,7 @@ function VoucherifyServerSide(options) {
   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);
@@ -1657,6 +1871,7 @@ function VoucherifyServerSide(options) {
     consents,
     orders,
     products,
+    productCollections,
     rewards,
     loyalties,
     segments,
@@ -1847,7 +2062,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.3.0"}`
+    'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.5.0"}`
   };
 
   if (environment().startsWith('Node')) {