@voucherify/sdk 2.0.5 → 2.0.6

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @voucherify/sdk
 
+## 2.0.6
+
+### Patch Changes
+
+- [`f8241b7`](https://github.com/voucherifyio/voucherify-js-sdk/commit/f8241b709097f53e29427ba4f4260073375ec91c) [#125](https://github.com/voucherifyio/voucherify-js-sdk/pull/125) Thanks [@darekg11](https://github.com/darekg11)! - Added support for metadata-schemas API. Allowing to list all metadata schemas in project or retrieve single one via get method by providing schema name
+
 ## 2.0.5
 
 ### Patch Changes

package/README.md

@@ -67,6 +67,8 @@ Server side:
 |
 <a href="#async-actions">Async Actions</a>
 |
+<a href="#metadata-schemas">Metadata Schemas</a>
+|
 <a href="#api-limits-handler">Api Limits Handler</a>
 </p>
 
@@ -1110,6 +1112,7 @@ Check [customer object](https://docs.voucherify.io/v1/reference#the-customer-obj
 
 
 ### Async Actions
+
 Methods are provided within `client.asyncActions.*` namespace.
 
 - [Get Async Action](#get-async-action)
@@ -1128,6 +1131,23 @@ client.asyncActions.list(params)
 
 --- 
 
+### Metadata Schemas
+
+Methods are provided within `client.metadataSchemas.*` namespace.
+
+- [List Metadata Schemas](#list-metadata-schemas)
+- [Get Metadata Schema by schema name](#get-metadata-schema-by-schema-name)
+
+#### List Metadata Schemas
+```javascript
+client.metadataSchemas.list()
+```
+
+#### Get Metadata Schema by schema name
+```javascript
+client.metadataSchemas.get(schemaName)
+```
+
 ### Api Limits Handler
 
 Methods are provided within `client.apiLimitsHandler.*` namespace.

package/dist/MetadataSchemas.d.ts

@@ -0,0 +1,8 @@
+import * as T from './types/MetadataSchemas';
+import type { RequestController } from './RequestController';
+export declare class MetadataSchemas {
+    private client;
+    constructor(client: RequestController);
+    list(): Promise<T.MetadataSchemasListResponse>;
+    get(schemaName: string): Promise<T.MetadataSchema>;
+}

package/dist/VoucherifyServerSide.d.ts

@@ -15,6 +15,7 @@ import { Loyalties } from './Loyalties';
 import { ValidationRules } from './ValidationRules';
 import { Segments } from './Segments';
 import { ApiLimitsHandler } from './ApiLimitsHandler';
+import { MetadataSchemas } from './MetadataSchemas';
 export interface VoucherifyServerSideOptions {
     /**
      * Optionally, you can add `apiUrl` to the client options if you want to use Voucherify running in a specific region.
@@ -110,4 +111,5 @@ export declare function VoucherifyServerSide(options: VoucherifyServerSideOption
     events: Events;
     asyncActions: AsyncActions;
     apiLimitsHandler: ApiLimitsHandler;
+    metadataSchemas: MetadataSchemas;
 };

package/dist/types/MetadataSchemas.d.ts

@@ -0,0 +1,33 @@
+interface MetadataSchemaProperty {
+    type: string;
+    array: boolean;
+    deleted?: boolean;
+    optional: boolean;
+    objectType?: string;
+    eq?: (string | number)[];
+    ne?: (string | number)[];
+    lt?: number;
+    lte?: number;
+    gt?: number;
+    gte?: number;
+    minLength?: number;
+    maxLength?: number;
+    exactLength?: number;
+}
+export interface MetadataSchema {
+    id: string;
+    related_object: string;
+    properties: Record<string, MetadataSchemaProperty>;
+    allow_defined_only?: boolean;
+    created_at: string;
+    updated_at?: string;
+    object: 'metadata_schema';
+}
+export interface MetadataSchemasListResponse {
+    object: 'list';
+    total: number;
+    data_ref: 'schemas';
+    schemas: MetadataSchema[];
+}
+export declare type MetadataSchemasGetResponse = MetadataSchema;
+export {};

package/dist/voucherifysdk.esm.js

@@ -1358,12 +1358,30 @@ class ApiLimitsHandler {
 
 }
 
+class MetadataSchemas {
+  constructor(client) {
+    this.client = void 0;
+    this.client = client;
+  }
+
+  list() {
+    return this.client.get('/metadata-schemas');
+  }
+
+  get(schemaName) {
+    return this.client.get(`/metadata-schemas/${encode(schemaName)}`);
+  }
+
+}
+
+//  apiLimitsHandler: ApiLimitsHandler
 // 	campaigns: Campaigns
 // 	consents: Consents
 // 	customers: Customers
 // 	distributions: Distributions
 // 	events: Events
 // 	loyalties: Loyalties
+//  metadataSchemas: MetadataSchemas
 // 	orders: Orders
 // 	products: Products
 // 	promotions: Promotions
@@ -1386,7 +1404,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.5"}`,
+    'X-Voucherify-Channel': options.channel || `${environment()}-SDK-v${"2.0.6"}`,
     'Content-Type': 'application/json'
   };
 
@@ -1433,6 +1451,7 @@ function VoucherifyServerSide(options) {
   const segments = new Segments(client);
   const validationRules = new ValidationRules(client);
   const apiLimitsHandler = new ApiLimitsHandler(client);
+  const metadataSchemas = new MetadataSchemas(client);
   return {
     vouchers,
     campaigns,
@@ -1450,7 +1469,8 @@ function VoucherifyServerSide(options) {
     validationRules,
     events,
     asyncActions,
-    apiLimitsHandler
+    apiLimitsHandler,
+    metadataSchemas
   };
 }
 
@@ -1633,7 +1653,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.5"}`
+    'X-Voucherify-Channel': `${environment()}-ClientSide-SDK-v${"2.0.6"}`
   };
 
   if (environment().startsWith('Node')) {