@gofynd/fdk-client-javascript 1.3.11-beta.7 → 1.3.11-beta.8

package/sdk/public/Content/ContentPublicModel.d.ts

@@ -0,0 +1,53 @@
+export = ContentPublicModel;
+/**
+ * @typedef ContentAPIError
+ * @property {string} [code]
+ * @property {string} [exception]
+ * @property {string} [info]
+ * @property {string} [message]
+ * @property {Object} [meta]
+ * @property {string} [request_id]
+ * @property {string} [stack_trace]
+ * @property {number} [status]
+ */
+/**
+ * @typedef CredentialSchema
+ * @property {Object} [configuration]
+ * @property {string} [entity_type]
+ * @property {boolean} [is_enable]
+ * @property {string} [type]
+ */
+/**
+ * @typedef CredentialsSchema
+ * @property {CredentialSchema[]} [items]
+ */
+declare class ContentPublicModel {
+}
+declare namespace ContentPublicModel {
+    export { ContentAPIError, CredentialSchema, CredentialsSchema };
+}
+/** @returns {ContentAPIError} */
+declare function ContentAPIError(): ContentAPIError;
+type ContentAPIError = {
+    code?: string;
+    exception?: string;
+    info?: string;
+    message?: string;
+    meta?: any;
+    request_id?: string;
+    stack_trace?: string;
+    status?: number;
+};
+/** @returns {CredentialSchema} */
+declare function CredentialSchema(): CredentialSchema;
+type CredentialSchema = {
+    configuration?: any;
+    entity_type?: string;
+    is_enable?: boolean;
+    type?: string;
+};
+/** @returns {CredentialsSchema} */
+declare function CredentialsSchema(): CredentialsSchema;
+type CredentialsSchema = {
+    items?: CredentialSchema[];
+};

package/sdk/public/Content/ContentPublicModel.js

@@ -0,0 +1,60 @@
+const Joi = require("joi");
+
+/**
+ * @typedef ContentAPIError
+ * @property {string} [code]
+ * @property {string} [exception]
+ * @property {string} [info]
+ * @property {string} [message]
+ * @property {Object} [meta]
+ * @property {string} [request_id]
+ * @property {string} [stack_trace]
+ * @property {number} [status]
+ */
+
+/**
+ * @typedef CredentialSchema
+ * @property {Object} [configuration]
+ * @property {string} [entity_type]
+ * @property {boolean} [is_enable]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef CredentialsSchema
+ * @property {CredentialSchema[]} [items]
+ */
+
+class ContentPublicModel {
+  /** @returns {ContentAPIError} */
+  static ContentAPIError() {
+    return Joi.object({
+      code: Joi.string().allow(""),
+      exception: Joi.string().allow(""),
+      info: Joi.string().allow(""),
+      message: Joi.string().allow(""),
+      meta: Joi.any(),
+      request_id: Joi.string().allow(""),
+      stack_trace: Joi.string().allow(""),
+      status: Joi.number(),
+    });
+  }
+
+  /** @returns {CredentialSchema} */
+  static CredentialSchema() {
+    return Joi.object({
+      configuration: Joi.any(),
+      entity_type: Joi.string().allow(""),
+      is_enable: Joi.boolean(),
+      type: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {CredentialsSchema} */
+  static CredentialsSchema() {
+    return Joi.object({
+      items: Joi.array().items(ContentPublicModel.CredentialSchema()),
+    });
+  }
+}
+module.exports = ContentPublicModel;

package/sdk/public/Content/ContentPublicValidator.d.ts

@@ -0,0 +1,18 @@
+export = ContentPublicValidator;
+/**
+ * @typedef GetCredentialsByEntityParam
+ * @property {string} [entity] - Server Type
+ */
+declare class ContentPublicValidator {
+    /** @returns {GetCredentialsByEntityParam} */
+    static getCredentialsByEntity(): GetCredentialsByEntityParam;
+}
+declare namespace ContentPublicValidator {
+    export { GetCredentialsByEntityParam };
+}
+type GetCredentialsByEntityParam = {
+    /**
+     * - Server Type
+     */
+    entity?: string;
+};

package/sdk/public/Content/ContentPublicValidator.js

@@ -0,0 +1,19 @@
+const Joi = require("joi");
+
+const ContentPublicModel = require("./ContentPublicModel");
+
+/**
+ * @typedef GetCredentialsByEntityParam
+ * @property {string} [entity] - Server Type
+ */
+
+class ContentPublicValidator {
+  /** @returns {GetCredentialsByEntityParam} */
+  static getCredentialsByEntity() {
+    return Joi.object({
+      entity: Joi.string().allow(""),
+    });
+  }
+}
+
+module.exports = ContentPublicValidator;

package/sdk/public/PublicClient.d.ts

@@ -12,7 +12,9 @@ declare class PublicClient {
      */
     constructor(config: import("./PublicConfig"));
     config: import("./PublicConfig");
+    billing: Billing;
     configuration: Configuration;
+    content: Content;
     inventory: Inventory;
     partner: Partner;
     webhook: Webhook;
@@ -24,7 +26,9 @@ declare class PublicClient {
      */
     setExtraHeaders(header: object): void;
 }
+import Billing = require("./Billing/BillingPublicClient");
 import Configuration = require("./Configuration/ConfigurationPublicClient");
+import Content = require("./Content/ContentPublicClient");
 import Inventory = require("./Inventory/InventoryPublicClient");
 import Partner = require("./Partner/PartnerPublicClient");
 import Webhook = require("./Webhook/WebhookPublicClient");

package/sdk/public/PublicClient.js

@@ -1,5 +1,9 @@
+const Billing = require("./Billing/BillingPublicClient");
+
 const Configuration = require("./Configuration/ConfigurationPublicClient");
 
+const Content = require("./Content/ContentPublicClient");
+
 const Inventory = require("./Inventory/InventoryPublicClient");
 
 const Partner = require("./Partner/PartnerPublicClient");
@@ -22,8 +26,12 @@ class PublicClient {
   constructor(config) {
     this.config = config;
 
+    this.billing = new Billing(config);
+
     this.configuration = new Configuration(config);
 
+    this.content = new Content(config);
+
     this.inventory = new Inventory(config);
 
     this.partner = new Partner(config);

package/sdk/public/Webhook/WebhookPublicClient.d.ts

@@ -4,7 +4,10 @@ declare class Webhook {
     _conf: any;
     _relativeUrls: {
         fetchAllWebhookEvents: string;
+        notifyDepricatedEvent: string;
         queryWebhookEventDetails: string;
+        testHandlerTransformation: string;
+        validateSchema: string;
     };
     _urls: {};
     updateUrls(urls: any): void;
@@ -18,6 +21,16 @@ declare class Webhook {
      * @description: Get All Webhook Events - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/fetchAllWebhookEvents/).
      */
     fetchAllWebhookEvents({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPublicModel.EventConfigResponse>;
+    /**
+     * @param {WebhookPublicValidator.NotifyDepricatedEventParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<WebhookPublicModel.EventNotifier>} - Success response
+     * @name notifyDepricatedEvent
+     * @summary: Notifies all the events that are going to depricate
+     * @description: Notifies all the events that are subscribed and are going to deprecate or new version is available for those events - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/notifyDepricatedEvent/).
+     */
+    notifyDepricatedEvent({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPublicModel.EventNotifier>;
     /**
      * @param {WebhookPublicValidator.QueryWebhookEventDetailsParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -28,6 +41,26 @@ declare class Webhook {
      * @description: Get Webhook Event Details for provided events - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/queryWebhookEventDetails/).
      */
     queryWebhookEventDetails({ body, requestHeaders }?: WebhookPublicValidator.QueryWebhookEventDetailsParam, { responseHeaders }?: object): Promise<WebhookPublicModel.EventConfigResponse>;
+    /**
+     * @param {WebhookPublicValidator.TestHandlerTransformationParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<WebhookPublicModel.TransformEventResponse>} - Success response
+     * @name testHandlerTransformation
+     * @summary: Test transformation of handler
+     * @description: Test transformation of handler - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/testHandlerTransformation/).
+     */
+    testHandlerTransformation({ body, requestHeaders }?: WebhookPublicValidator.TestHandlerTransformationParam, { responseHeaders }?: object): Promise<WebhookPublicModel.TransformEventResponse>;
+    /**
+     * @param {WebhookPublicValidator.ValidateSchemaParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<WebhookPublicModel.ValidateSchemaResponse>} - Success response
+     * @name validateSchema
+     * @summary: Validate Schema for an event
+     * @description: Validate Schema for an event - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/validateSchema/).
+     */
+    validateSchema({ body, requestHeaders }?: WebhookPublicValidator.ValidateSchemaParam, { responseHeaders }?: object): Promise<WebhookPublicModel.ValidateSchemaResponse>;
 }
 import WebhookPublicModel = require("./WebhookPublicModel");
 import WebhookPublicValidator = require("./WebhookPublicValidator");

package/sdk/public/Webhook/WebhookPublicClient.js

@@ -15,8 +15,14 @@ class Webhook {
     this._conf = _conf;
     this._relativeUrls = {
       fetchAllWebhookEvents: "/service/common/webhook/v1.0/events",
+      notifyDepricatedEvent:
+        "/service/common/webhook/v1.0/events/depricated-event-notifier",
       queryWebhookEventDetails:
         "/service/common/webhook/v1.0/events/query-event-details",
+      testHandlerTransformation:
+        "/service/common/webhook/v1.0/events/transform-event",
+      validateSchema:
+        "/service/common/webhook/v1.0/events/validate-event-schema",
     };
     this._urls = Object.entries(this._relativeUrls).reduce(
       (urls, [method, relativeUrl]) => {
@@ -112,6 +118,84 @@ class Webhook {
     return response;
   }
 
+  /**
+   * @param {WebhookPublicValidator.NotifyDepricatedEventParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PublicAPIClient").Options} - Options
+   * @returns {Promise<WebhookPublicModel.EventNotifier>} - Success response
+   * @name notifyDepricatedEvent
+   * @summary: Notifies all the events that are going to depricate
+   * @description: Notifies all the events that are subscribed and are going to deprecate or new version is available for those events - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/notifyDepricatedEvent/).
+   */
+  async notifyDepricatedEvent(
+    { requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = WebhookPublicValidator.notifyDepricatedEvent().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = WebhookPublicValidator.notifyDepricatedEvent().validate(
+      {},
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for public > Webhook > notifyDepricatedEvent \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["notifyDepricatedEvent"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = WebhookPublicModel.EventNotifier().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this._conf.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for public > Webhook > notifyDepricatedEvent \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {WebhookPublicValidator.QueryWebhookEventDetailsParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -191,6 +275,164 @@ class Webhook {
 
     return response;
   }
+
+  /**
+   * @param {WebhookPublicValidator.TestHandlerTransformationParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PublicAPIClient").Options} - Options
+   * @returns {Promise<WebhookPublicModel.TransformEventResponse>} - Success response
+   * @name testHandlerTransformation
+   * @summary: Test transformation of handler
+   * @description: Test transformation of handler - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/testHandlerTransformation/).
+   */
+  async testHandlerTransformation(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = WebhookPublicValidator.testHandlerTransformation().validate(
+      { body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = WebhookPublicValidator.testHandlerTransformation().validate(
+      { body },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for public > Webhook > testHandlerTransformation \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PublicAPIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["testHandlerTransformation"],
+        params: {},
+      }),
+      query_params,
+      body,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = WebhookPublicModel.TransformEventResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this._conf.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for public > Webhook > testHandlerTransformation \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {WebhookPublicValidator.ValidateSchemaParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PublicAPIClient").Options} - Options
+   * @returns {Promise<WebhookPublicModel.ValidateSchemaResponse>} - Success response
+   * @name validateSchema
+   * @summary: Validate Schema for an event
+   * @description: Validate Schema for an event - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/webhook/validateSchema/).
+   */
+  async validateSchema(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = WebhookPublicValidator.validateSchema().validate(
+      { body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = WebhookPublicValidator.validateSchema().validate(
+      { body },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for public > Webhook > validateSchema \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PublicAPIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["validateSchema"],
+        params: {},
+      }),
+      query_params,
+      body,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = WebhookPublicModel.ValidateSchemaResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this._conf.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for public > Webhook > validateSchema \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
 }
 
 module.exports = Webhook;

package/sdk/public/Webhook/WebhookPublicModel.d.ts

@@ -6,8 +6,10 @@ export = WebhookPublicModel;
  * @property {string} [display_name]
  * @property {string} [event_category]
  * @property {string} [event_name]
+ * @property {Object} [event_schema]
  * @property {string} [event_type]
  * @property {number} [id]
+ * @property {string} [updated_on]
  * @property {string} [version]
  */
 /**
@@ -21,10 +23,76 @@ export = WebhookPublicModel;
  * @typedef EventConfigResponse
  * @property {EventConfig[]} [event_configs]
  */
+/**
+ * @typedef EventNotifier
+ * @property {string[]} [emails]
+ * @property {string} [message]
+ */
+/**
+ * @typedef EventSchema
+ * @property {Object} [meta]
+ * @property {Object} [payload]
+ */
+/**
+ * @typedef InternalTransformEvent
+ * @property {number} [created_timestamp]
+ * @property {string} [name]
+ * @property {string[]} [trace_id]
+ * @property {string} [type]
+ * @property {string} [version]
+ */
+/**
+ * @typedef TransformEventAssociation
+ * @property {number} [company_id]
+ */
+/**
+ * @typedef TransformEventData
+ * @property {number} [company_id]
+ * @property {string[]} [contains]
+ * @property {InternalTransformEvent} [event]
+ * @property {Object} [payload]
+ */
+/**
+ * @typedef TransformEventRequest
+ * @property {EventSchema} [event]
+ * @property {string} [event_category]
+ * @property {string} [event_name]
+ * @property {string} [event_type]
+ * @property {string} [event_version]
+ */
+/**
+ * @typedef TransformEventResponse
+ * @property {TransformEventAssociation} [association]
+ * @property {TransformEventData} [data]
+ * @property {string} [event_name]
+ * @property {string[]} [event_trace_id]
+ * @property {string} [event_type]
+ * @property {TransformEventServiceMeta} [service_meta]
+ * @property {boolean} [status]
+ * @property {string} [version]
+ */
+/**
+ * @typedef TransformEventServiceMeta
+ * @property {string} [name]
+ */
+/**
+ * @typedef ValidateSchemaRequest
+ * @property {EventSchema} [event]
+ * @property {string} [event_category]
+ * @property {string} [event_name]
+ * @property {Object} [event_schema]
+ * @property {string} [event_type]
+ * @property {string} [event_version]
+ */
+/**
+ * @typedef ValidateSchemaResponse
+ * @property {string} [message]
+ * @property {boolean} [status]
+ */
 declare class WebhookPublicModel {
 }
 declare namespace WebhookPublicModel {
-    export { EventConfig, EventConfigBase, EventConfigResponse };
+    export { EventConfig, EventConfigBase, EventConfigResponse, EventNotifier, EventSchema, InternalTransformEvent, TransformEventAssociation, TransformEventData, TransformEventRequest, TransformEventResponse, TransformEventServiceMeta, ValidateSchemaRequest, ValidateSchemaResponse };
 }
 /** @returns {EventConfig} */
 declare function EventConfig(): EventConfig;
@@ -34,8 +102,10 @@ type EventConfig = {
     display_name?: string;
     event_category?: string;
     event_name?: string;
+    event_schema?: any;
     event_type?: string;
     id?: number;
+    updated_on?: string;
     version?: string;
 };
 /** @returns {EventConfigBase} */
@@ -51,3 +121,79 @@ declare function EventConfigResponse(): EventConfigResponse;
 type EventConfigResponse = {
     event_configs?: EventConfig[];
 };
+/** @returns {EventNotifier} */
+declare function EventNotifier(): EventNotifier;
+type EventNotifier = {
+    emails?: string[];
+    message?: string;
+};
+/** @returns {EventSchema} */
+declare function EventSchema(): EventSchema;
+type EventSchema = {
+    meta?: any;
+    payload?: any;
+};
+/** @returns {InternalTransformEvent} */
+declare function InternalTransformEvent(): InternalTransformEvent;
+type InternalTransformEvent = {
+    created_timestamp?: number;
+    name?: string;
+    trace_id?: string[];
+    type?: string;
+    version?: string;
+};
+/** @returns {TransformEventAssociation} */
+declare function TransformEventAssociation(): TransformEventAssociation;
+type TransformEventAssociation = {
+    company_id?: number;
+};
+/** @returns {TransformEventData} */
+declare function TransformEventData(): TransformEventData;
+type TransformEventData = {
+    company_id?: number;
+    contains?: string[];
+    event?: InternalTransformEvent;
+    payload?: any;
+};
+/** @returns {TransformEventRequest} */
+declare function TransformEventRequest(): TransformEventRequest;
+type TransformEventRequest = {
+    event?: EventSchema;
+    event_category?: string;
+    event_name?: string;
+    event_type?: string;
+    event_version?: string;
+};
+/** @returns {TransformEventResponse} */
+declare function TransformEventResponse(): TransformEventResponse;
+type TransformEventResponse = {
+    association?: TransformEventAssociation;
+    data?: TransformEventData;
+    event_name?: string;
+    event_trace_id?: string[];
+    event_type?: string;
+    service_meta?: TransformEventServiceMeta;
+    status?: boolean;
+    version?: string;
+};
+/** @returns {TransformEventServiceMeta} */
+declare function TransformEventServiceMeta(): TransformEventServiceMeta;
+type TransformEventServiceMeta = {
+    name?: string;
+};
+/** @returns {ValidateSchemaRequest} */
+declare function ValidateSchemaRequest(): ValidateSchemaRequest;
+type ValidateSchemaRequest = {
+    event?: EventSchema;
+    event_category?: string;
+    event_name?: string;
+    event_schema?: any;
+    event_type?: string;
+    event_version?: string;
+};
+/** @returns {ValidateSchemaResponse} */
+declare function ValidateSchemaResponse(): ValidateSchemaResponse;
+type ValidateSchemaResponse = {
+    message?: string;
+    status?: boolean;
+};