@voucherify/sdk 2.3.0 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @voucherify/sdk
 
+## 2.4.0
+
+### Minor Changes
+
+- [`b11ce2c`](https://github.com/voucherifyio/voucherify-js-sdk/commit/b11ce2c6410c7441bd48fbbf33377b98c77af072) [#241](https://github.com/voucherifyio/voucherify-js-sdk/pull/241) Thanks [@p-zielinski](https://github.com/p-zielinski)! - Add support for 3 missing endpoints in loyalties api. Corrected a typo in one of loyalties api method.
+  - Added support for new endpoints: `GET /loyalties/{campaignId}/earning-rules/{earningRuleId}`, `POST /loyalties/{campaignId}/earning-rules/{earningRuleId}/enable` and `POST /loyalties/{campaignId}/earning-rules/{earningRuleId}/disable` [(examples available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md)
+  - New exported types/interfaces: `LoyaltiesGetEarningRuleResponseBody`, `LoyaltiesEnableEarningRulesResponseBody`, `LoyaltiesDisableEarningRulesResponseBody`, `EarningRuleEvent`, `EarningRuleBase`, `EarningRuleFixed`, `EarningRuleProportionalOrder`, `EarningRuleProportionalOrderAmount`, `EarningRuleProportionalOrderTotalAmount`, `EarningRuleProportionalOrderMetadata`, `EarningRuleProportionalOrderItems`, `EarningRuleProportionalOrderItemsQuantity`, `EarningRuleProportionalOrderItemsAmount`, `EarningRuleProportionalOrderItemsSubtotalAmount`, `EarningRuleProportionalCustomerMetadata`, `EarningRuleProportionalCustomEvent`, `EarningRuleProportional`
+  - Added optional parameter `calculation_type` to `LoyaltyProportional`
+
+* [`5bb69da`](https://github.com/voucherifyio/voucherify-js-sdk/commit/5bb69daf95c1e16c48eb5070149b88f11bfe1a30) [#229](https://github.com/voucherifyio/voucherify-js-sdk/pull/229) Thanks [@marcin-slezak](https://github.com/marcin-slezak)! - Add missing methods covering Customers API.
+  - Added support for new endpoints:
+    - `POST /customers/{customerId}/permanent-deletion`,
+    - `POST /customers/bulk/async`,
+    - `POST /customers/metadata/async` [(examples of usage available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md)
+  - New domain types:
+    - `CustomerBase`
+    - `CustomerAddress`
+  - New exported types/interfaces:
+    - `CustomersUpdateInBulkRequestBody`,
+    - `CustomersUpdateMetadataInBulkRequestBody`,
+    - `CustomersDeletePermanentlyResponseBody`
+
 ## 2.3.0
 
 ### Minor Changes

package/README.md

@@ -130,7 +130,7 @@ const client = VoucherifyServerSide({
 	apiUrl: 'https://<region>.api.voucherify.io', // optional
 	apiVersion: 'v2018-08-01', // optional
 	channel: 'e-commerce', // optional
-	customHeaders: { "MY_CUSTOM_HEADER": "my_value" } // optional
+	customHeaders: { "MY_CUSTOM_HEADER": "my_value" }, // optional
 	timeoutMs: 10000 // optional
 })
 ```
@@ -574,7 +574,7 @@ Check [promotion's tier object](https://docs.voucherify.io/reference/the-promoti
 
 ```javascript
 client.promotions.tiers.listAll()
-client.promotions.tiers.listAll(params})
+client.promotions.tiers.listAll(params)
 ```
 
 #### [Add Promotion Tier to Campaign](https://docs.voucherify.io/reference/add-promotion-tier-to-campaign)
@@ -611,9 +611,12 @@ Methods are provided within `client.customers.*` namespace.
 - [Get Customer](#get-customer)
 - [Update Customer](#update-customer)
 - [Delete Customer](#delete-customer)
+- [Delete Customer Permanently](#delete-customer-permanently)
 - [List Customers](#list-customers)
 - [Update Customer's Consents](#update-customers-consents)
 - [List Customer's Activities](#list-customers-activities)
+- [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)
 
 #### [Create Customer](https://docs.voucherify.io/reference/create-customer)
@@ -644,6 +647,12 @@ client.customers.update(customer)
 client.customers.delete(customerId)
 ```
 
+#### [Delete Customer Permanently](https://docs.voucherify.io/reference/delete-customer-permanently)
+
+```javascript
+client.customers.deletePermanently(customerId)
+```
+
 #### [List Customers](https://docs.voucherify.io/reference/list-customers)
 
 ```javascript
@@ -702,6 +711,18 @@ client.customers.listActivities(customerId, params)
 client.customers.importCSV(filePath)
 ```
 
+#### [Update Customers in bulk](https://docs.voucherify.io/reference/update-customers-in-bulk)
+
+```javascript
+client.customers.updateInBulk(customers)
+```
+
+#### [Update Customers' Metadata in bulk](https://docs.voucherify.io/reference/update-customers-metadata-in-bulk)
+
+```javascript
+client.customers.updateMetadataInBulk(sourceIdsAndMetadata)
+```
+
 ---
 
 ### Consents
@@ -963,6 +984,9 @@ Methods are provided within `client.loyalties.*` namespace.
 - [Create Loyalty Program Earning Rules](#create-loyalty-program-earning-rules)
 - [Update Loyalty Program Earning Rule](#update-loyalty-program-earning-rule)
 - [Delete Loyalty Program Earning Rule](#delete-loyalty-program-earning-rule)
+- [Get Loyalty Program Earning Rule](#get-loyalty-program-earning-rule)
+- [Enable Loyalty Program Earning Rule](#enable-loyalty-program-earning-rule)
+- [Disable Loyalty Program Earning Rule](#disable-loyalty-program-earning-rule)
 - [List Loyalty Program Earning Rules](#list-loyalty-program-earning-rules)
 - [Create Loyalty Program Member](#create-loyalty-program-member)
 - [Get Loyalty Program Member](#get-loyalty-program-member)
@@ -1045,6 +1069,24 @@ client.loyalties.updateEarningRule(campaignId, earningRule)
 client.loyalties.deleteEarningRule(campaignId, earningRuleId)
 ```
 
+#### [Get Loyalty Program Earning Rule](https://docs.voucherify.io/reference/get-earning-rule)
+
+```javascript
+client.loyalties.getEarningRule(campaignId, earningRuleId)
+```
+
+#### [Enable Loyalty Program Earning Rule](https://docs.voucherify.io/reference/enable-earning-rule)
+
+```javascript
+client.loyalties.enableEarningRule(campaignId, earningRuleId)
+```
+
+#### [Disable Loyalty Program Earning Rule](https://docs.voucherify.io/reference/disable-earning-rule)
+
+```javascript
+client.loyalties.disableEarningRule(campaignId, earningRuleId)
+```
+
 #### [List Loyalty Program Earning Rules](https://docs.voucherify.io/reference/list-earning-rules)
 
 ```javascript

package/dist/Customers.d.ts

@@ -32,10 +32,22 @@ declare class Customers {
      * @see https://docs.voucherify.io/reference/update-customer
      */
     update(customer: T.CustomersUpdateParams): Promise<T.CustomersCreateResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/update-customers-in-bulk
+     */
+    updateInBulk(customers: T.CustomersUpdateInBulkRequestBody): Promise<AAT.AsyncActionCreateResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/update-customers-metadata-in-bulk
+     */
+    updateMetadataInBulk(sourceIdsAndMetadata: T.CustomersUpdateMetadataInBulkRequestBody): Promise<AAT.AsyncActionCreateResponse>;
     /**
      * @see https://docs.voucherify.io/reference/delete-customer
      */
     delete(customerId: string): Promise<undefined>;
+    /**
+     * @see https://docs.voucherify.io/reference/delete-customer-permanently
+     */
+    deletePermanently(customerId: string): Promise<T.CustomersDeletePermanentlyResponseBody>;
     /**
      * @see https://docs.voucherify.io/reference/update-customers-consents
      */

package/dist/Loyalties.d.ts

@@ -55,6 +55,18 @@ export declare class Loyalties {
      * @see https://docs.voucherify.io/reference/delete-earning-rule
      */
     deleteEarningRule(campaignId: string, earningRuleId: string): Promise<unknown>;
+    /**
+     * @see https://docs.voucherify.io/reference/get-earning-rule
+     */
+    getEarningRule(campaignId: string, earningRuleId: string): Promise<T.LoyaltiesGetEarningRuleResponseBody>;
+    /**
+     * @see https://docs.voucherify.io/reference/enable-earning-rule
+     */
+    enableEarningRule(campaignId: string, earningRuleId: string): Promise<T.LoyaltiesEnableEarningRulesResponseBody>;
+    /**
+     * @see https://docs.voucherify.io/reference/disable-earning-rule
+     */
+    disableEarningRule(campaignId: string, earningRuleId: string): Promise<T.LoyaltiesDisableEarningRulesResponseBody>;
     /**
      * @see https://docs.voucherify.io/reference/list-members
      */

package/dist/types/Customers.d.ts

@@ -124,4 +124,46 @@ declare type IdOrSourceId = {
 export declare type CustomersUpdateParams = CustomerRequest & IdOrSourceId;
 export declare type CustomersUpdateResponse = CustomerObject | CustomerUnconfirmed;
 export declare type CustomersUpdateConsentsBody = Record<string, boolean>;
+declare type CustomerBase = {
+    name?: string | null;
+    description?: string | null;
+    email?: string | null;
+    phone?: string | null;
+    birthdate?: string | null;
+    metadata?: Record<string, unknown> | null;
+};
+declare type CustomerAddress = {
+    address?: {
+        city?: string | null;
+        state?: string | null;
+        line_1?: string | null;
+        line_2?: string | null;
+        country?: string | null;
+        postal_code?: string | null;
+    } | null;
+};
+export declare type CustomersUpdateInBulkRequestBody = (CustomerBase & CustomerAddress & {
+    source_id: string | null;
+})[];
+export interface CustomersUpdateMetadataInBulkRequestBody {
+    source_ids: string[];
+    metadata: Record<string, unknown>;
+}
+export interface CustomersDeletePermanentlyResponseBody {
+    id: string;
+    created_at: string;
+    related_object_id: string;
+    related_object: 'customer';
+    status: 'DONE';
+    data_json: {
+        events: number;
+        customer_events: number;
+        daily_events: number;
+        segments: number;
+        orders: number;
+        order_events: number;
+        customer: 1;
+    };
+    object: 'pernament_deletion';
+}
 export {};

package/dist/types/Loyalties.d.ts

@@ -154,6 +154,7 @@ export interface LoyaltyFixed {
 }
 export interface LoyaltyProportional {
     type: 'PROPORTIONAL';
+    calculation_type?: 'ORDER_AMOUNT' | 'ORDER_TOTAL_AMOUNT' | 'ORDER_METADATA' | 'ORDER_ITEMS_QUANTITY' | 'ORDER_ITEMS_AMOUNT' | 'ORDER_ITEMS_SUBTOTAL_AMOUNT' | 'CUSTOMER_METADATA' | 'CUSTOM_EVENT_METADATA';
     order?: {
         amount: {
             every: number;
@@ -464,4 +465,144 @@ export interface LoyaltyPointsTransfer {
     code: string;
     points: number;
 }
+export declare type LoyaltiesGetEarningRuleResponseBody = EarningRuleBase & {
+    validation_rule_id: string | null;
+    updated_at: string | null;
+    active: boolean;
+};
+export declare type LoyaltiesEnableEarningRulesResponseBody = EarningRuleBase & {
+    updated_at: string | null;
+    active: true;
+};
+export declare type LoyaltiesDisableEarningRulesResponseBody = EarningRuleBase & {
+    updated_at: string | null;
+    active: false;
+};
+export interface EarningRuleBase {
+    id: string;
+    created_at: string;
+    loyalty: EarningRuleFixed | EarningRuleProportional;
+    event?: EarningRuleEvent;
+    custom_event?: {
+        schema_id: string;
+    };
+    segment?: {
+        id: string;
+    };
+    source: {
+        banner?: string;
+        object_id: string;
+        object_type: 'campaign';
+    };
+    loyalty_tier?: {
+        id: string;
+    };
+    object: 'earning_rule';
+    automation_id: string;
+    start_date?: string;
+    expiration_date?: string;
+    validity_timeframe?: {
+        duration: string;
+        interval: string;
+    };
+    validity_day_of_week?: number[];
+    metadata: Record<string, unknown>;
+}
+export declare type EarningRuleEvent = 'order.paid' | 'customer.segment.entered' | 'custom_event' | 'customer.loyalty.tier.upgraded' | 'customer.loyalty.tier.downgraded' | 'customer.loyalty.tier.prolonged' | 'customer.loyalty.tier.joined' | 'customer.loyalty.tier.left';
+export interface EarningRuleFixed {
+    type: 'FIXED';
+    points: number;
+}
+export declare type EarningRuleProportionalOrder = EarningRuleProportionalOrderAmount | EarningRuleProportionalOrderTotalAmount | EarningRuleProportionalOrderMetadata;
+export interface EarningRuleProportionalOrderAmount {
+    type: 'PROPORTIONAL';
+    calculation_type: 'ORDER_AMOUNT';
+    order: {
+        amount: {
+            every: number;
+            points: number;
+        };
+    };
+}
+export interface EarningRuleProportionalOrderTotalAmount {
+    type: 'PROPORTIONAL';
+    calculation_type: 'ORDER_TOTAL_AMOUNT';
+    order: {
+        total_amount: {
+            every: number;
+            points: number;
+        };
+    };
+}
+export interface EarningRuleProportionalOrderMetadata {
+    type: 'PROPORTIONAL';
+    calculation_type: 'ORDER_METADATA';
+    order: {
+        metadata: {
+            every: number;
+            points: number;
+            property: string;
+        };
+    };
+}
+export declare type EarningRuleProportional = EarningRuleProportionalOrder | EarningRuleProportionalOrderItems | EarningRuleProportionalCustomerMetadata | EarningRuleProportionalCustomEvent;
+export declare type EarningRuleProportionalOrderItems = EarningRuleProportionalOrderItemsQuantity | EarningRuleProportionalOrderItemsAmount | EarningRuleProportionalOrderItemsSubtotalAmount;
+export interface EarningRuleProportionalOrderItemsQuantity {
+    type: 'PROPORTIONAL';
+    calculation_type: 'ORDER_ITEMS_QUANTITY';
+    order_items: {
+        quantity: {
+            every: number;
+            points: number;
+            object: `products_collection` | `product` | `sku`;
+            id: string;
+        };
+    };
+}
+export interface EarningRuleProportionalOrderItemsAmount {
+    type: 'PROPORTIONAL';
+    calculation_type: 'ORDER_ITEMS_AMOUNT';
+    order_items: {
+        amount: {
+            every: number;
+            points: number;
+            object: `products_collection` | `product` | `sku`;
+            id: string;
+        };
+    };
+}
+export interface EarningRuleProportionalOrderItemsSubtotalAmount {
+    type: 'PROPORTIONAL';
+    calculation_type: 'ORDER_ITEMS_SUBTOTAL_AMOUNT';
+    order_items: {
+        subtotal_amount: {
+            every: number;
+            points: number;
+            object: `products_collection` | `product` | `sku`;
+            id: string;
+        };
+    };
+}
+export interface EarningRuleProportionalCustomerMetadata {
+    type: 'PROPORTIONAL';
+    calculation_type: 'CUSTOMER_METADATA';
+    customer: {
+        metadata: {
+            every: number;
+            points: number;
+            property: string;
+        };
+    };
+}
+export interface EarningRuleProportionalCustomEvent {
+    type: 'PROPORTIONAL';
+    calculation_type: 'CUSTOM_EVENT_METADATA';
+    custom_event: {
+        metadata: {
+            every: number;
+            points: number;
+            property: string;
+        };
+    };
+}
 export {};

package/dist/voucherifysdk.esm.js

@@ -869,6 +869,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 +893,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 +1312,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
    */
@@ -1594,7 +1642,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.4.0"}`,
     'Content-Type': 'application/json'
   };
 
@@ -1847,7 +1895,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.4.0"}`
   };
 
   if (environment().startsWith('Node')) {