@voucherify/sdk 2.2.6 → 2.3.0

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @voucherify/sdk
 
+## 2.3.0
+
+### Minor Changes
+
+- [`644aa84`](https://github.com/voucherifyio/voucherify-js-sdk/commit/644aa8479843b8625192aa295eb07aa19ba651d7) [#227](https://github.com/voucherifyio/voucherify-js-sdk/pull/227) Thanks [@marcin-slezak](https://github.com/marcin-slezak)! - Added support for missing CSV import endpoints ([(examples of usage available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md)):
+  - `POST /skus/importCSV`
+  - `POST /products/importCSV`
+  - `POST /vouchers/importCSV`
+  - `POST /customers/importCSV`
+  - `POST /campaigns/campaignId/importCSV`
+  - Added form-data `4.0.0` to SDK package
+
+* [`7720e31`](https://github.com/voucherifyio/voucherify-js-sdk/commit/7720e31baea0db19a7543ae12661fab77176e5ff) [#228](https://github.com/voucherifyio/voucherify-js-sdk/pull/228) Thanks [@marcin-slezak](https://github.com/marcin-slezak)! - Add missing methods covering Categories and Campaigns API.
+  - Added support for new endpoints [(examples of usage available in readme.md)](..%2F..%2Fpackages%2Fsdk%2FREADME.md):
+    - `POST /campaigns/campaignId/enable`,
+    - `POST /campaigns/campaignId/disable`,
+    - `GET, POST DELETE /categories`,
+    - `GET PUT /categories/id`.
+  - New exported types/interfaces in `Categories.ts`:
+    - `ListCategories`,
+    - `CategoryObject`,
+    - `CreateCategory`,
+    - `ResponseCreateCategory`,
+    - `ResponseUpdateCategory`,
+    - `UpdateCategoryRequest`.
+
+- [`52e7f5e`](https://github.com/voucherifyio/voucherify-js-sdk/commit/52e7f5e8d4ea6be4ba1b9d0550cba3ec3d893672) [#221](https://github.com/voucherifyio/voucherify-js-sdk/pull/221) Thanks [@p-zielinski](https://github.com/p-zielinski)! - Implementing the following changes:
+  - Update axios from `0.21.4` to `0.27.2` in SDK package
+  - Added dotenv `16.3.1` to SDK package dev dependencies.
+  - Added frame for integration tests [(more info available in README.md, section "🧪 SDK Tests")](..%2F..%2FREADME.md)
+
 ## 2.2.6
 
 ### Patch Changes

package/README.md

@@ -154,6 +154,7 @@ Methods are provided within `client.vouchers.*` namespace.
 - [Update Vouchers Metadata in bulk](#update-vouchers-metadata-in-bulk)
 - [Update Vouchers in bulk](#update-vouchers-in-bulk)
 - [Release Validation Session](#release-validation-session)
+- [Import Vouchers using CSV](#import-vouchers-using-csv)
 
 #### [Create Voucher](https://docs.voucherify.io/reference/create-voucher)
 
@@ -237,6 +238,12 @@ client.vouchers.bulkUpdate(vouchers)
 client.vouchers.releaseValidationSession(code, sessionKey)
 ```
 
+#### [Import Vouchers using CSV](https://docs.voucherify.io/reference/import-vouchers-using-csv)
+
+```javascript
+client.vouchers.importCSV(filePath)
+```
+
 ---
 
 ### Campaigns
@@ -249,7 +256,10 @@ Methods are provided within `client.campaigns.*` namespace.
 - [Add Voucher to Campaign](#add-voucher-to-campaign)
 - [Import Vouchers to Campaign](#import-vouchers-to-campaign)
 - [List Campaigns](#list-campaigns)
+- [Import Vouchers using CSV](#import-vouchers-using-csv)
 - [Examine Campaigns Qualification](#examine-campaigns-qualification)
+- [Enable campaign](#enable-campaign)
+- [Disable campaign](#disable-campaign)
 
 #### [Create Campaign](https://docs.voucherify.io/reference/create-campaign)
 
@@ -307,13 +317,30 @@ client.campaigns.list()
 client.campaigns.list(params)
 ```
 
+#### [Import Vouchers to Campaign by CSV](https://docs.voucherify.io/reference/import-vouchers-to-campaign-using-csv)
+
+```javascript
+client.campaigns.importVouchersCSV(campaignId, filePath)
+```
+
+#### [Enable campaign](https://docs.voucherify.io/reference/enable-campaign)
+
+```javascript
+client.campaigns.enable(campaignId)
+```
+
+#### [Disable campaign](https://docs.voucherify.io/reference/disable-campaign)
+
+```javascript
+client.campaigns.disable(campaignId)
+```
+
 #### [Examine Campaigns Qualification](https://docs.voucherify.io/reference/create-qualification-request)
 
 ```javascript
 client.campaigns.qualifications.examine(body)
 client.campaigns.qualifications.examine(body, params)
 ```
-
 ---
 
 ### Distributions
@@ -359,6 +386,46 @@ client.distributions.publications.list(params)
 client.distributions.publications.create(params)
 ```
 
+### Categories
+
+Methods are provided within `client.categories.*` namespace.
+
+- [Create Category](#create-category)
+- [Update Category](#update-category)
+- [Get Category](#get-category)
+- [Delete Category](#delete-category)
+- [List Categories](#list-categories)
+
+#### [Create Category](https://docs.voucherify.io/reference/create-category)
+
+```javascript
+client.categories.create(params)
+```
+
+#### [Update Category](https://docs.voucherify.io/reference/update-category)
+
+```javascript
+client.categories.update(categoryId, params)
+```
+
+#### [Get Category](https://docs.voucherify.io/reference/get-category)
+
+```javascript
+client.categories.get(categoryId)
+```
+
+#### [Delete Category](https://docs.voucherify.io/reference/delete-category)
+
+```javascript
+client.categories.delete(categoryId)
+```
+
+#### [List Categories](https://docs.voucherify.io/reference/list-categories)
+
+```javascript
+client.categories.list()
+```
+
 ---
 
 ### Validations
@@ -547,6 +614,7 @@ Methods are provided within `client.customers.*` namespace.
 - [List Customers](#list-customers)
 - [Update Customer's Consents](#update-customers-consents)
 - [List Customer's Activities](#list-customers-activities)
+- [Import and Update Customers using CSV](#import-and-update-customers-using-csv)
 
 #### [Create Customer](https://docs.voucherify.io/reference/create-customer)
 
@@ -628,6 +696,12 @@ client.customers.listActivities(customerId)
 client.customers.listActivities(customerId, params)
 ```
 
+#### [Import and Update Customers using CSV](https://docs.voucherify.io/reference/import-customers-using-csv)
+
+```javascript
+client.customers.importCSV(filePath)
+```
+
 ---
 
 ### Consents
@@ -707,6 +781,8 @@ Methods are provided within `client.products.*` namespace.
 - [Update SKU](#update-sku)
 - [Delete SKU](#delete-sku)
 - [List all product SKUs](#list-all-product-skus)
+- [Import SKUs using CSV](#import-skus-using-csv)
+- [Import Products using CSV](#import-products-using-csv)
 
 #### [Create Product](https://docs.voucherify.io/reference/create-product)
 
@@ -781,6 +857,18 @@ client.products.deleteSku(productId, skuId, { force: true })
 client.products.listSkus(productId)
 ```
 
+#### [Import SKUs using CSV](https://docs.voucherify.io/reference/import-skus-using-csv)
+
+```javascript
+client.products.importSkusCSV(filePath)
+```
+
+#### [Import Products using CSV](https://docs.voucherify.io/reference/import-products-using-csv)
+
+```javascript
+client.products.importCSV(filePath)
+```
+
 ---
 
 ### Rewards

package/dist/Campaigns.d.ts

@@ -1,4 +1,5 @@
 import * as T from './types/Campaigns';
+import * as AAT from './types/AsyncActions';
 import type { RequestController } from './RequestController';
 declare class CampaignsQualifications {
     private client;
@@ -41,5 +42,17 @@ export declare class Campaigns {
      * @see https://docs.voucherify.io/reference/list-campaigns
      */
     list(params?: T.CampaignsListParams): Promise<T.CampaignsListResponse>;
+    /**
+     * @see https://api.voucherify.io/v1/campaigns/{campaignId}/importCSV
+     */
+    importVouchersCSV(campaignId: string, filePath: string): Promise<AAT.AsyncActionCreateResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/enable-campaign
+     */
+    enable(campaignId: string): Promise<{}>;
+    /**
+     * @see https://docs.voucherify.io/reference/disable-campaign
+     */
+    disable(campaignId: string): Promise<{}>;
 }
 export {};

package/dist/Categories.d.ts

@@ -0,0 +1,26 @@
+import * as T from './types/Categories';
+import type { RequestController } from './RequestController';
+export declare class Categories {
+    private client;
+    constructor(client: RequestController);
+    /**
+     * @see https://docs.voucherify.io/reference/list-categories
+     */
+    list(): Promise<T.ListCategories>;
+    /**
+     * @see https://docs.voucherify.io/reference/create-category
+     */
+    create(createCategory: T.CreateCategory): Promise<T.ResponseCreateCategory>;
+    /**
+     * @see https://docs.voucherify.io/reference/get-category
+     */
+    get(categoryId: string): Promise<T.CategoryObject>;
+    /**
+     * @see https://docs.voucherify.io/reference/delete-category
+     */
+    delete(categoryId: string): Promise<{}>;
+    /**
+     * @see https://docs.voucherify.io/reference/update-category
+     */
+    update(categoryId: string, updateCategory: T.UpdateCategoryRequest): Promise<T.ResponseUpdateCategory>;
+}

package/dist/Customers.d.ts

@@ -1,4 +1,5 @@
 import * as T from './types/Customers';
+import * as AAT from './types/AsyncActions';
 import type { RequestController } from './RequestController';
 declare class Customers {
     private client;
@@ -43,5 +44,9 @@ declare class Customers {
      * @see https://docs.voucherify.io/reference/get-customer-activities
      */
     listActivities(customerId: string, params?: T.CustomerActivitiesListQueryParams): Promise<T.CustomerActivitiesListResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/import-customers-using-csv
+     */
+    importCSV(filePath: string): Promise<AAT.AsyncActionCreateResponse>;
 }
 export { Customers };

package/dist/Products.d.ts

@@ -1,4 +1,5 @@
 import * as T from './types/Products';
+import * as AAT from './types/AsyncActions';
 import type { RequestController } from './RequestController';
 export declare class Products {
     private client;
@@ -51,4 +52,12 @@ export declare class Products {
      * @see https://docs.voucherify.io/reference/list-skus
      */
     listSkus(productId: string): Promise<T.ProductsListSkus>;
+    /**
+     * @see https://docs.voucherify.io/reference/import-skus-using-csv
+     */
+    importSkusCSV(filePath: string): Promise<AAT.AsyncActionCreateResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/import-products-using-csv
+     */
+    importCSV(filePath: string): Promise<AAT.AsyncActionCreateResponse>;
 }

package/dist/VoucherifyServerSide.d.ts

@@ -16,6 +16,7 @@ import { ValidationRules } from './ValidationRules';
 import { Segments } from './Segments';
 import { ApiLimitsHandler } from './ApiLimitsHandler';
 import { MetadataSchemas } from './MetadataSchemas';
+import { Categories } from './Categories';
 export interface VoucherifyServerSideOptions {
     /**
      * Optionally, you can add `apiUrl` to the client options if you want to use Voucherify running in a specific region.
@@ -106,6 +107,7 @@ export interface VoucherifyServerSideOptions {
 export declare function VoucherifyServerSide(options: VoucherifyServerSideOptions): {
     vouchers: Vouchers;
     campaigns: Campaigns;
+    categories: Categories;
     distributions: Distributions;
     validations: Validations;
     redemptions: Redemptions;

package/dist/Vouchers.d.ts

@@ -1,4 +1,5 @@
 import * as T from './types/Vouchers';
+import * as AAT from './types/AsyncActions';
 import type { RequestController } from './RequestController';
 import type { Balance } from './Balance';
 declare class VouchersQualification {
@@ -61,5 +62,9 @@ export declare class Vouchers {
      * @see https://docs.voucherify.io/reference/release-validation-session
      */
     releaseValidationSession(code: string, sessionKey: string): Promise<unknown>;
+    /**
+     * @see https://docs.voucherify.io/reference/import-vouchers-using-csv
+     */
+    importCSV(filePath: string): Promise<AAT.AsyncActionCreateResponse>;
 }
 export {};

package/dist/types/Categories.d.ts

@@ -0,0 +1,24 @@
+export interface ListCategories {
+    object: 'list';
+    data_ref: 'data';
+    data: CategoryObject[];
+    total: number;
+}
+export declare type CategoryObject = ResponseCreateCategory & {
+    updated_at?: string;
+};
+export interface CreateCategory {
+    name: string;
+    hierarchy: number;
+}
+export interface ResponseCreateCategory {
+    id: string;
+    name: string;
+    hierarchy: number;
+    created_at: string;
+    object: 'category';
+}
+export declare type ResponseUpdateCategory = ResponseCreateCategory & {
+    updated_at: string;
+};
+export declare type UpdateCategoryRequest = CreateCategory;

package/dist/voucherifysdk.esm.js

@@ -1,5 +1,6 @@
 import axios from 'axios';
 import Qs from 'qs';
+import FormData from 'form-data';
 
 var DiscountVouchersTypesEnum;
 
@@ -311,6 +312,35 @@ class Campaigns {
   list(params = {}) {
     return this.client.get('/campaigns', params);
   }
+  /**
+   * @see https://api.voucherify.io/v1/campaigns/{campaignId}/importCSV
+   */
+
+
+  async importVouchersCSV(campaignId, filePath) {
+    assert(environment().startsWith('Node'), `Method "client.campaigns.importVouchersCSV(campaignId, filePath)" is only for Node environment`);
+    const fs = (await import('fs')).default;
+    const fileStream = fs.createReadStream(filePath);
+    const form = new FormData();
+    form.append('file', fileStream);
+    return this.client.post(`/campaigns/${campaignId}/importCSV`, form);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/enable-campaign
+   */
+
+
+  enable(campaignId) {
+    return this.client.post(`/campaigns/${encode(campaignId)}/enable`, {});
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/disable-campaign
+   */
+
+
+  disable(campaignId) {
+    return this.client.post(`/campaigns/${encode(campaignId)}/disable`, {});
+  }
 
 }
 
@@ -535,6 +565,19 @@ class Vouchers {
   releaseValidationSession(code, sessionKey) {
     return this.client.delete(`/vouchers/${encode(code)}/sessions/${encode(sessionKey)}`);
   }
+  /**
+   * @see https://docs.voucherify.io/reference/import-vouchers-using-csv
+   */
+
+
+  async importCSV(filePath) {
+    assert(environment().startsWith('Node'), `Method "client.vouchers.importCSV(filePath)" is only for Node environment`);
+    const fs = (await import('fs')).default;
+    const fileStream = fs.createReadStream(filePath);
+    const form = new FormData();
+    form.append('file', fileStream);
+    return this.client.post('/vouchers/importCSV', form);
+  }
 
 }
 
@@ -850,6 +893,19 @@ class Customers {
   listActivities(customerId, params) {
     return this.client.get(`/customers/${encode(customerId)}/activities`, params);
   }
+  /**
+   * @see https://docs.voucherify.io/reference/import-customers-using-csv
+   */
+
+
+  async importCSV(filePath) {
+    assert(environment().startsWith('Node'), `Method "client.customers.importCSV(filePath)" is only for Node environment`);
+    const fs = (await import('fs')).default;
+    const fileStream = fs.createReadStream(filePath);
+    const form = new FormData();
+    form.append('file', fileStream);
+    return this.client.post(`/customers/importCSV`, form);
+  }
 
 }
 
@@ -1018,6 +1074,32 @@ class Products {
   listSkus(productId) {
     return this.client.get(`/products/${encode(productId)}/skus`);
   }
+  /**
+   * @see https://docs.voucherify.io/reference/import-skus-using-csv
+   */
+
+
+  async importSkusCSV(filePath) {
+    assert(environment().startsWith('Node'), `Method "client.products.importSkusCSV(filePath)" is only for Node environment`);
+    const fs = (await import('fs')).default;
+    const fileStream = fs.createReadStream(filePath);
+    const form = new FormData();
+    form.append('file', fileStream);
+    return this.client.post(`/skus/importCSV`, form);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/import-products-using-csv
+   */
+
+
+  async importCSV(filePath) {
+    assert(environment().startsWith('Node'), `Method "client.products.importCSV(filePath)" is only for Node environment`);
+    const fs = (await import('fs')).default;
+    const fileStream = fs.createReadStream(filePath);
+    const form = new FormData();
+    form.append('file', fileStream);
+    return this.client.post(`/products/importCSV`, form);
+  }
 
 }
 
@@ -1434,6 +1516,54 @@ class MetadataSchemas {
 
 }
 
+class Categories {
+  constructor(client) {
+    this.client = void 0;
+    this.client = client;
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/list-categories
+   */
+
+
+  list() {
+    return this.client.get('/categories');
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/create-category
+   */
+
+
+  create(createCategory) {
+    return this.client.post('/categories', createCategory);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/get-category
+   */
+
+
+  get(categoryId) {
+    return this.client.get(`/categories/${encode(categoryId)}`);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/delete-category
+   */
+
+
+  delete(categoryId) {
+    return this.client.delete(`/categories/${encode(categoryId)}`);
+  }
+  /**
+   * @see https://docs.voucherify.io/reference/update-category
+   */
+
+
+  update(categoryId, updateCategory) {
+    return this.client.put(`/categories/${encode(categoryId)}`, updateCategory);
+  }
+
+}
+
 //  apiLimitsHandler: ApiLimitsHandler
 // 	campaigns: Campaigns
 // 	consents: Consents
@@ -1464,7 +1594,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.2.6"}`,
+    'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.3.0"}`,
     'Content-Type': 'application/json'
   };
 
@@ -1497,6 +1627,7 @@ function VoucherifyServerSide(options) {
   const balance = new Balance(client);
   const vouchers = new Vouchers(client, balance);
   const campaigns = new Campaigns(client);
+  const categories = new Categories(client);
   const exportsNamespace = new Exports(client);
   const events = new Events(client);
   const distributions = new Distributions(client, exportsNamespace);
@@ -1517,6 +1648,7 @@ function VoucherifyServerSide(options) {
   return {
     vouchers,
     campaigns,
+    categories,
     distributions,
     validations,
     redemptions,
@@ -1715,7 +1847,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.2.6"}`
+    'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.3.0"}`
   };
 
   if (environment().startsWith('Node')) {