@voucherify/sdk 2.0.8 → 2.0.11

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @voucherify/sdk
 
+## 2.0.11
+
+### Patch Changes
+
+- [`ae6110b`](https://github.com/voucherifyio/voucherify-js-sdk/commit/ae6110b1ec8022c80a8f05f16e5c9de0e6cae180) [#137](https://github.com/voucherifyio/voucherify-js-sdk/pull/137) Thanks [@darekg11](https://github.com/darekg11)! - Added support for orders import API
+
+## 2.0.10
+
+### Patch Changes
+
+- [`e03db27`](https://github.com/voucherifyio/voucherify-js-sdk/commit/e03db276226a579e7d886a8acb5db58b703a6989) [#136](https://github.com/voucherifyio/voucherify-js-sdk/pull/136) Thanks [@darekg11](https://github.com/darekg11)! - Added documentation links to MetadataSchemas API methods
+
+* [`a8557d1`](https://github.com/voucherifyio/voucherify-js-sdk/commit/a8557d1c70f0732c6996175d3b1e917c29986cee) [#134](https://github.com/voucherifyio/voucherify-js-sdk/pull/134) Thanks [@salzhrani](https://github.com/salzhrani)! - add metadata property to ProductsCreateResponse
+
+## 2.0.9
+
+### Patch Changes
+
+- [`e52b787`](https://github.com/voucherifyio/voucherify-js-sdk/commit/e52b787f48a5aa763d2aaa61b3d28a701548d3cc) [#131](https://github.com/voucherifyio/voucherify-js-sdk/pull/131) Thanks [@tomek-lochmanczyk-rspective](https://github.com/tomek-lochmanczyk-rspective)! - Add function which return "Retry-After" header from response. The purpose is to get information how long it's needed to wait until new requests can be made, when api limits are reached. This ddition is backward compatible so no changes are needed to be made in older code
+
 ## 2.0.8
 
 ### Patch Changes

package/README.md

@@ -645,6 +645,7 @@ Methods are provided within `client.orders.*` namespace.
 - [Get Order](#get-order)
 - [Update Order](#update-order)
 - [List Orders](#list-orders)
+- [Import Orders](#import-orders)
 
 #### [Create Order](https://docs.voucherify.io/reference/create-order)
 
@@ -675,6 +676,11 @@ client.orders.list()
 client.orders.list(params)
 ```
 
+#### [Import Orders](https://docs.voucherify.io/reference/import-orders)
+```javascript
+client.orders.import(orders)
+```
+
 ---
 
 ### Products
@@ -1155,13 +1161,14 @@ Methods are provided within `client.apiLimitsHandler.*` namespace.
 - [Are Limits Available](#are-limits-available)
 - [Get Rate Limit](#get-rate-limit)
 - [Get Rate Limit Remaining](#get-rate-limit-remaining)
+- [Get Retry After](#get-retry-after)
 
 #### Are Limits Available
 ```javascript
 client.apiLimitsHandler.areLimitsAvailable()
 ```
 
-This method should be called each time beforehand [Get Rate Limit](#get-rate-limit) or [Get Rate Limit Remaining](#get-rate-limit-remaining) to ensure limit data are available.
+This method should be called each time beforehand [Get Rate Limit](#get-rate-limit) or [Get Rate Limit Remaining](#get-rate-limit-remaining) or [Get Retry After](#get-retry-after) to ensure limit data are available.
 
 #### Get Rate Limit
 ```javascript
@@ -1177,6 +1184,13 @@ if(client.apiLimitsHandler.areLimitsAvailable()){
 }
 ```
 
+#### Get Retry After
+```javascript
+if(client.apiLimitsHandler.areLimitsAvailable()){
+  client.apiLimitsHandler.getRetryAfter()
+}
+```
+
 ---
 
 # 💅 Client Side

package/dist/ApiLimitsHandler.d.ts

@@ -6,4 +6,5 @@ export declare class ApiLimitsHandler {
     areLimitsAvailable(): boolean;
     getRateLimit(): number;
     getRateLimitRemaining(): number;
+    getRetryAfter(): number;
 }

package/dist/MetadataSchemas.d.ts

@@ -3,6 +3,12 @@ import type { RequestController } from './RequestController';
 export declare class MetadataSchemas {
     private client;
     constructor(client: RequestController);
+    /**
+     * @see https://docs.voucherify.io/reference/list-metadata-schemas
+     */
     list(): Promise<T.MetadataSchemasListResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/get-metadata-schema
+     */
     get(schemaName: string): Promise<T.MetadataSchema>;
 }

package/dist/Orders.d.ts

@@ -1,4 +1,5 @@
 import * as T from './types/Orders';
+import * as AAT from './types/AsyncActions';
 import type { RequestController } from './RequestController';
 export declare class Orders {
     private client;
@@ -19,4 +20,8 @@ export declare class Orders {
      * @see https://docs.voucherify.io/reference/list-orders
      */
     list(params?: T.OrdersListParams): Promise<T.OrdersListResponse>;
+    /**
+     * @see https://docs.voucherify.io/reference/import-orders
+     */
+    import(orders: T.OrdersCreate[]): Promise<AAT.AsyncActionCreateResponse>;
 }

package/dist/types/AsyncActions.d.ts

@@ -15,4 +15,7 @@ export interface AsyncActionsListResponse {
     data_ref: 'async_actions';
     async_actions: Omit<AsyncActionsResponse, 'result'>[];
 }
+export interface AsyncActionCreateResponse {
+    async_action_id: string;
+}
 export declare type AsyncActionsGetResponse = AsyncActionsResponse;

package/dist/types/Products.d.ts

@@ -22,6 +22,7 @@ export interface ProductsCreateResponse {
     attributes?: string[];
     created_at: string;
     image_url?: string;
+    metadata?: Record<string, any>;
 }
 export declare type ProductsGetResponse = ProductsCreateResponse & ProductsGetResponseSkus;
 export declare type ProductsUpdate = {

package/dist/voucherifysdk.esm.js

@@ -869,6 +869,14 @@ class Orders {
   list(params = {}) {
     return this.client.get('/orders', params);
   }
+  /**
+   * @see https://docs.voucherify.io/reference/import-orders
+   */
+
+
+  import(orders) {
+    return this.client.post('/orders/import', orders);
+  }
 
 }
 
@@ -1356,6 +1364,13 @@ class ApiLimitsHandler {
     return parseInt(rateLimitRemaining, 10);
   }
 
+  getRetryAfter() {
+    var _this$getLastResponse3;
+
+    const retryAfter = (_this$getLastResponse3 = this.getLastResponseHeadersFromController()['retry-after']) != null ? _this$getLastResponse3 : 0;
+    return parseInt(retryAfter, 10);
+  }
+
 }
 
 class MetadataSchemas {
@@ -1363,10 +1378,18 @@ class MetadataSchemas {
     this.client = void 0;
     this.client = client;
   }
+  /**
+   * @see https://docs.voucherify.io/reference/list-metadata-schemas
+   */
+
 
   list() {
     return this.client.get('/metadata-schemas');
   }
+  /**
+   * @see https://docs.voucherify.io/reference/get-metadata-schema
+   */
+
 
   get(schemaName) {
     return this.client.get(`/metadata-schemas/${encode(schemaName)}`);
@@ -1404,7 +1427,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.0.8"}`,
+    'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.0.11"}`,
     'Content-Type': 'application/json'
   };
 
@@ -1653,7 +1676,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.0.8"}`
+    'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.0.11"}`
   };
 
   if (environment().startsWith('Node')) {