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

package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts

@@ -1,7 +1,7 @@
 export = WebhookPlatformValidator;
 /**
  * @typedef CancelJobByNameParam
- * @property {string} filename - Filename of the specific report export to cancel.
+ * @property {string} filename
  */
 /**
  * @typedef DownloadDeliveryReportParam
@@ -14,7 +14,7 @@ export = WebhookPlatformValidator;
  */
 /**
  * @typedef GetEventCountsParam
- * @property {WebhookPlatformModel.EventProcessRequest} body
+ * @property {WebhookPlatformModel.RetryEventRequest} body
  */
 /**
  * @typedef GetHistoricalReportsParam
@@ -39,12 +39,12 @@ export = WebhookPlatformValidator;
  * @typedef GetSubscribersByExtensionIdParam
  * @property {number} [pageNo] - Page Number
  * @property {number} [pageSize] - Page Size
- * @property {string} extensionId - Extension id
+ * @property {string} extensionId - Extension_id
  */
 /** @typedef ManualRetryCancelParam */
 /**
  * @typedef ManualRetryOfFailedEventParam
- * @property {WebhookPlatformModel.EventProcessRequest} body
+ * @property {WebhookPlatformModel.RetryEventRequest} body
  */
 /**
  * @typedef PingWebhookParam
@@ -96,9 +96,6 @@ declare namespace WebhookPlatformValidator {
     export { CancelJobByNameParam, DownloadDeliveryReportParam, FetchAllEventConfigurationsParam, GetDeliveryReportsParam, GetEventCountsParam, GetHistoricalReportsParam, GetManualRetryStatusParam, GetReportFiltersParam, GetSubscriberByIdParam, GetSubscribersByCompanyParam, GetSubscribersByExtensionIdParam, ManualRetryCancelParam, ManualRetryOfFailedEventParam, PingWebhookParam, RegisterSubscriberToEventParam, UpdateSubscriberConfigParam };
 }
 type CancelJobByNameParam = {
-    /**
-     * - Filename of the specific report export to cancel.
-     */
     filename: string;
 };
 type DownloadDeliveryReportParam = {
@@ -108,7 +105,7 @@ type GetDeliveryReportsParam = {
     body: WebhookPlatformModel.EventProcessRequest;
 };
 type GetEventCountsParam = {
-    body: WebhookPlatformModel.EventProcessRequest;
+    body: WebhookPlatformModel.RetryEventRequest;
 };
 type GetHistoricalReportsParam = {
     body: WebhookPlatformModel.HistoryPayload;
@@ -146,12 +143,12 @@ type GetSubscribersByExtensionIdParam = {
      */
     pageSize?: number;
     /**
-     * - Extension id
+     * - Extension_id
      */
     extensionId: string;
 };
 type ManualRetryOfFailedEventParam = {
-    body: WebhookPlatformModel.EventProcessRequest;
+    body: WebhookPlatformModel.RetryEventRequest;
 };
 type PingWebhookParam = {
     body: WebhookPlatformModel.PingWebhook;

package/sdk/platform/Webhook/WebhookPlatformValidator.js

@@ -4,7 +4,7 @@ const WebhookPlatformModel = require("./WebhookPlatformModel");
 
 /**
  * @typedef CancelJobByNameParam
- * @property {string} filename - Filename of the specific report export to cancel.
+ * @property {string} filename
  */
 
 /**
@@ -21,7 +21,7 @@ const WebhookPlatformModel = require("./WebhookPlatformModel");
 
 /**
  * @typedef GetEventCountsParam
- * @property {WebhookPlatformModel.EventProcessRequest} body
+ * @property {WebhookPlatformModel.RetryEventRequest} body
  */
 
 /**
@@ -52,14 +52,14 @@ const WebhookPlatformModel = require("./WebhookPlatformModel");
  * @typedef GetSubscribersByExtensionIdParam
  * @property {number} [pageNo] - Page Number
  * @property {number} [pageSize] - Page Size
- * @property {string} extensionId - Extension id
+ * @property {string} extensionId - Extension_id
  */
 
 /** @typedef ManualRetryCancelParam */
 
 /**
  * @typedef ManualRetryOfFailedEventParam
- * @property {WebhookPlatformModel.EventProcessRequest} body
+ * @property {WebhookPlatformModel.RetryEventRequest} body
  */
 
 /**
@@ -107,7 +107,7 @@ class WebhookPlatformValidator {
   /** @returns {GetEventCountsParam} */
   static getEventCounts() {
     return Joi.object({
-      body: WebhookPlatformModel.EventProcessRequest().required(),
+      body: WebhookPlatformModel.RetryEventRequest().required(),
     }).required();
   }
 
@@ -163,7 +163,7 @@ class WebhookPlatformValidator {
   /** @returns {ManualRetryOfFailedEventParam} */
   static manualRetryOfFailedEvent() {
     return Joi.object({
-      body: WebhookPlatformModel.EventProcessRequest().required(),
+      body: WebhookPlatformModel.RetryEventRequest().required(),
     }).required();
   }
 

package/sdk/platform/index.d.ts

@@ -15,11 +15,11 @@ export namespace PlatformModel {
     const FinancePlatformModel: typeof import("./Finance/FinancePlatformModel");
     const InventoryPlatformModel: typeof import("./Inventory/InventoryPlatformModel");
     const LeadPlatformModel: typeof import("./Lead/LeadPlatformModel");
+    const ServiceabilityPlatformModel: typeof import("./Serviceability/ServiceabilityPlatformModel");
     const OrderPlatformModel: typeof import("./Order/OrderPlatformModel");
     const PartnerPlatformModel: typeof import("./Partner/PartnerPlatformModel");
     const PaymentPlatformModel: typeof import("./Payment/PaymentPlatformModel");
     const RewardsPlatformModel: typeof import("./Rewards/RewardsPlatformModel");
-    const ServiceabilityPlatformModel: typeof import("./Serviceability/ServiceabilityPlatformModel");
     const SharePlatformModel: typeof import("./Share/SharePlatformModel");
     const ThemePlatformModel: typeof import("./Theme/ThemePlatformModel");
     const UserPlatformModel: typeof import("./User/UserPlatformModel");

package/sdk/platform/index.js

@@ -30,6 +30,8 @@ module.exports = {
 
     LeadPlatformModel: require("./Lead/LeadPlatformModel"),
 
+    ServiceabilityPlatformModel: require("./Serviceability/ServiceabilityPlatformModel"),
+
     OrderPlatformModel: require("./Order/OrderPlatformModel"),
 
     PartnerPlatformModel: require("./Partner/PartnerPlatformModel"),
@@ -38,8 +40,6 @@ module.exports = {
 
     RewardsPlatformModel: require("./Rewards/RewardsPlatformModel"),
 
-    ServiceabilityPlatformModel: require("./Serviceability/ServiceabilityPlatformModel"),
-
     SharePlatformModel: require("./Share/SharePlatformModel"),
 
     ThemePlatformModel: require("./Theme/ThemePlatformModel"),

package/sdk/public/Billing/BillingPublicClient.d.ts

@@ -0,0 +1,23 @@
+export = Billing;
+declare class Billing {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        getStandardPlans: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {BillingPublicValidator.GetStandardPlansParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<BillingPublicModel.DetailList>} - Success response
+     * @name getStandardPlans
+     * @summary: Get Standard/Public Plans
+     * @description: Get Standard/Public Plans.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/billing/getStandardPlans/).
+     */
+    getStandardPlans({ platformType, requestHeaders }?: BillingPublicValidator.GetStandardPlansParam, { responseHeaders }?: object): Promise<BillingPublicModel.DetailList>;
+}
+import BillingPublicValidator = require("./BillingPublicValidator");
+import BillingPublicModel = require("./BillingPublicModel");

package/sdk/public/Billing/BillingPublicClient.js

@@ -0,0 +1,116 @@
+const PublicAPIClient = require("../PublicAPIClient");
+const {
+  FDKClientValidationError,
+  FDKResponseValidationError,
+} = require("../../common/FDKError");
+const constructUrl = require("../constructUrl");
+const Paginator = require("../../common/Paginator");
+const BillingPublicValidator = require("./BillingPublicValidator");
+const BillingPublicModel = require("./BillingPublicModel");
+const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
+
+class Billing {
+  constructor(_conf) {
+    this._conf = _conf;
+    this._relativeUrls = {
+      getStandardPlans: "/service/public/billing/v1.0/plan/detailed-list",
+    };
+    this._urls = Object.entries(this._relativeUrls).reduce(
+      (urls, [method, relativeUrl]) => {
+        urls[method] = `${_conf.domain}${relativeUrl}`;
+        return urls;
+      },
+      {}
+    );
+  }
+
+  updateUrls(urls) {
+    this._urls = {
+      ...this._urls,
+      ...urls,
+    };
+  }
+
+  /**
+   * @param {BillingPublicValidator.GetStandardPlansParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PublicAPIClient").Options} - Options
+   * @returns {Promise<BillingPublicModel.DetailList>} - Success response
+   * @name getStandardPlans
+   * @summary: Get Standard/Public Plans
+   * @description: Get Standard/Public Plans.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/billing/getStandardPlans/).
+   */
+  async getStandardPlans(
+    { platformType, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = BillingPublicValidator.getStandardPlans().validate(
+      { platformType },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = BillingPublicValidator.getStandardPlans().validate(
+      { platformType },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for public > Billing > getStandardPlans \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+    query_params["platform_type"] = platformType;
+
+    const xHeaders = {};
+
+    const response = await PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getStandardPlans"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = BillingPublicModel.DetailList().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 > Billing > getStandardPlans \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+}
+
+module.exports = Billing;

package/sdk/public/Billing/BillingPublicModel.d.ts

@@ -0,0 +1,92 @@
+export = BillingPublicModel;
+/**
+ * @typedef DetailList
+ * @property {string[]} [component_groups]
+ * @property {Plan[]} [plans]
+ * @property {Plan} [trial_plan]
+ */
+/**
+ * @typedef InternalServerError
+ * @property {string} [code] - Error code
+ * @property {string} [message] - Internal server Server error
+ */
+/**
+ * @typedef Plan
+ * @property {string} [_id]
+ * @property {string[]} [addons]
+ * @property {number} [amount]
+ * @property {string} [country]
+ * @property {string} [created_at]
+ * @property {string} [currency]
+ * @property {string} [description]
+ * @property {boolean} [is_active]
+ * @property {boolean} [is_trial_plan]
+ * @property {boolean} [is_visible]
+ * @property {string} [modified_at]
+ * @property {string} [name]
+ * @property {string} [plan_group]
+ * @property {string} [product_suite_id]
+ * @property {PlanRecurring} [recurring]
+ * @property {string[]} [tag_lines]
+ * @property {string[]} [tags]
+ * @property {number} [trial_period]
+ * @property {string} [type]
+ */
+/**
+ * @typedef PlanRecurring
+ * @property {string} [interval]
+ * @property {number} [interval_count]
+ */
+declare class BillingPublicModel {
+}
+declare namespace BillingPublicModel {
+    export { DetailList, InternalServerError, Plan, PlanRecurring };
+}
+/** @returns {DetailList} */
+declare function DetailList(): DetailList;
+type DetailList = {
+    component_groups?: string[];
+    plans?: Plan[];
+    trial_plan?: Plan;
+};
+/** @returns {InternalServerError} */
+declare function InternalServerError(): InternalServerError;
+type InternalServerError = {
+    /**
+     * - Error code
+     */
+    code?: string;
+    /**
+     * - Internal server Server error
+     */
+    message?: string;
+};
+/** @returns {Plan} */
+declare function Plan(): Plan;
+type Plan = {
+    _id?: string;
+    addons?: string[];
+    amount?: number;
+    country?: string;
+    created_at?: string;
+    currency?: string;
+    description?: string;
+    is_active?: boolean;
+    is_trial_plan?: boolean;
+    is_visible?: boolean;
+    modified_at?: string;
+    name?: string;
+    plan_group?: string;
+    product_suite_id?: string;
+    recurring?: PlanRecurring;
+    tag_lines?: string[];
+    tags?: string[];
+    trial_period?: number;
+    type?: string;
+};
+/** @returns {PlanRecurring} */
+declare function PlanRecurring(): PlanRecurring;
+type PlanRecurring = {
+    interval?: string;
+    interval_count?: number;
+};

package/sdk/public/Billing/BillingPublicModel.js

@@ -0,0 +1,96 @@
+const Joi = require("joi");
+
+/**
+ * @typedef DetailList
+ * @property {string[]} [component_groups]
+ * @property {Plan[]} [plans]
+ * @property {Plan} [trial_plan]
+ */
+
+/**
+ * @typedef InternalServerError
+ * @property {string} [code] - Error code
+ * @property {string} [message] - Internal server Server error
+ */
+
+/**
+ * @typedef Plan
+ * @property {string} [_id]
+ * @property {string[]} [addons]
+ * @property {number} [amount]
+ * @property {string} [country]
+ * @property {string} [created_at]
+ * @property {string} [currency]
+ * @property {string} [description]
+ * @property {boolean} [is_active]
+ * @property {boolean} [is_trial_plan]
+ * @property {boolean} [is_visible]
+ * @property {string} [modified_at]
+ * @property {string} [name]
+ * @property {string} [plan_group]
+ * @property {string} [product_suite_id]
+ * @property {PlanRecurring} [recurring]
+ * @property {string[]} [tag_lines]
+ * @property {string[]} [tags]
+ * @property {number} [trial_period]
+ * @property {string} [type]
+ */
+
+/**
+ * @typedef PlanRecurring
+ * @property {string} [interval]
+ * @property {number} [interval_count]
+ */
+
+class BillingPublicModel {
+  /** @returns {DetailList} */
+  static DetailList() {
+    return Joi.object({
+      component_groups: Joi.array().items(Joi.string().allow("")),
+      plans: Joi.array().items(BillingPublicModel.Plan()),
+      trial_plan: BillingPublicModel.Plan(),
+    });
+  }
+
+  /** @returns {InternalServerError} */
+  static InternalServerError() {
+    return Joi.object({
+      code: Joi.string().allow(""),
+      message: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {Plan} */
+  static Plan() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      addons: Joi.array().items(Joi.string().allow("")),
+      amount: Joi.number(),
+      country: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
+      currency: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+      is_active: Joi.boolean(),
+      is_trial_plan: Joi.boolean(),
+      is_visible: Joi.boolean(),
+      modified_at: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      plan_group: Joi.string().allow(""),
+      product_suite_id: Joi.string().allow(""),
+      recurring: BillingPublicModel.PlanRecurring(),
+      tag_lines: Joi.array().items(Joi.string().allow("")),
+      tags: Joi.array().items(Joi.string().allow("")),
+      trial_period: Joi.number(),
+      type: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {PlanRecurring} */
+  static PlanRecurring() {
+    return Joi.object({
+      interval: Joi.string().allow(""),
+      interval_count: Joi.number(),
+    });
+  }
+}
+module.exports = BillingPublicModel;

package/sdk/public/Billing/BillingPublicValidator.d.ts

@@ -0,0 +1,18 @@
+export = BillingPublicValidator;
+/**
+ * @typedef GetStandardPlansParam
+ * @property {string} platformType - The type of platform for which plans are requested.
+ */
+declare class BillingPublicValidator {
+    /** @returns {GetStandardPlansParam} */
+    static getStandardPlans(): GetStandardPlansParam;
+}
+declare namespace BillingPublicValidator {
+    export { GetStandardPlansParam };
+}
+type GetStandardPlansParam = {
+    /**
+     * - The type of platform for which plans are requested.
+     */
+    platformType: string;
+};

package/sdk/public/Billing/BillingPublicValidator.js

@@ -0,0 +1,19 @@
+const Joi = require("joi");
+
+const BillingPublicModel = require("./BillingPublicModel");
+
+/**
+ * @typedef GetStandardPlansParam
+ * @property {string} platformType - The type of platform for which plans are requested.
+ */
+
+class BillingPublicValidator {
+  /** @returns {GetStandardPlansParam} */
+  static getStandardPlans() {
+    return Joi.object({
+      platformType: Joi.string().allow("").required(),
+    }).required();
+  }
+}
+
+module.exports = BillingPublicValidator;

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

@@ -0,0 +1,22 @@
+export = Content;
+declare class Content {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        getCredentialsByEntity: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {ContentPublicValidator.GetCredentialsByEntityParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<ContentPublicModel.CredentialsSchema>} - Success response
+     * @name getCredentialsByEntity
+     * @summary: Get credentials to power chat support systems
+     * @description: Get credentials for support system - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getCredentialsByEntity/).
+     */
+    getCredentialsByEntity({ entity, requestHeaders }?: ContentPublicValidator.GetCredentialsByEntityParam, { responseHeaders }?: object): Promise<ContentPublicModel.CredentialsSchema>;
+}
+import ContentPublicValidator = require("./ContentPublicValidator");
+import ContentPublicModel = require("./ContentPublicModel");

package/sdk/public/Content/ContentPublicClient.js

@@ -0,0 +1,114 @@
+const PublicAPIClient = require("../PublicAPIClient");
+const {
+  FDKClientValidationError,
+  FDKResponseValidationError,
+} = require("../../common/FDKError");
+const constructUrl = require("../constructUrl");
+const Paginator = require("../../common/Paginator");
+const ContentPublicValidator = require("./ContentPublicValidator");
+const ContentPublicModel = require("./ContentPublicModel");
+const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
+
+class Content {
+  constructor(_conf) {
+    this._conf = _conf;
+    this._relativeUrls = {
+      getCredentialsByEntity: "/service/public/content/credentials/{entity}",
+    };
+    this._urls = Object.entries(this._relativeUrls).reduce(
+      (urls, [method, relativeUrl]) => {
+        urls[method] = `${_conf.domain}${relativeUrl}`;
+        return urls;
+      },
+      {}
+    );
+  }
+
+  updateUrls(urls) {
+    this._urls = {
+      ...this._urls,
+      ...urls,
+    };
+  }
+
+  /**
+   * @param {ContentPublicValidator.GetCredentialsByEntityParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PublicAPIClient").Options} - Options
+   * @returns {Promise<ContentPublicModel.CredentialsSchema>} - Success response
+   * @name getCredentialsByEntity
+   * @summary: Get credentials to power chat support systems
+   * @description: Get credentials for support system - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getCredentialsByEntity/).
+   */
+  async getCredentialsByEntity(
+    { entity, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ContentPublicValidator.getCredentialsByEntity().validate(
+      { entity },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ContentPublicValidator.getCredentialsByEntity().validate(
+      { entity },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for public > Content > getCredentialsByEntity \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getCredentialsByEntity"],
+        params: { entity },
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = ContentPublicModel.CredentialsSchema().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 > Content > getCredentialsByEntity \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+}
+
+module.exports = Content;