@gofynd/fdk-client-javascript 1.4.8-beta.2 → 1.4.8

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

@@ -8,12 +8,12 @@ export = WebhookPlatformModel;
  */
 /**
  * @typedef EventProcessRequest
- * @property {string} search_text
+ * @property {string} [search_text]
  * @property {string} end_date
  * @property {string} start_date
- * @property {number[]} subscriber_ids
- * @property {string} status
- * @property {Event[]} event
+ * @property {number[]} [subscriber_ids]
+ * @property {string} [status]
+ * @property {Event[]} [event]
  */
 /**
  * @typedef DownloadReportResponse
@@ -41,13 +41,13 @@ export = WebhookPlatformModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 /**
  * @typedef PingWebhook
@@ -200,7 +200,7 @@ export = WebhookPlatformModel;
  */
 /**
  * @typedef SubscriberConfigPostRequestV2
- * @property {string} [name]
+ * @property {string} name
  * @property {string} [webhook_url]
  * @property {string} provider
  * @property {Association} association
@@ -208,7 +208,7 @@ export = WebhookPlatformModel;
  * @property {SubscriberStatus} status
  * @property {string} email_id
  * @property {AuthMeta} [auth_meta]
- * @property {Events[]} [events]
+ * @property {Events[]} events
  */
 /**
  * @typedef SubscriberConfigUpdateRequestV2
@@ -216,16 +216,16 @@ export = WebhookPlatformModel;
  * @property {string} [name]
  * @property {string} [webhook_url]
  * @property {string} provider
- * @property {Association} association
+ * @property {Association} [association]
  * @property {Object} [custom_headers]
  * @property {SubscriberStatus} status
- * @property {string} email_id
+ * @property {string} [email_id]
  * @property {AuthMeta} [auth_meta]
  * @property {Events[]} [events]
  */
 /**
  * @typedef SubscriberConfigPost
- * @property {string} [name]
+ * @property {string} name
  * @property {string} webhook_url
  * @property {Association} association
  * @property {Object} [custom_headers]
@@ -238,11 +238,11 @@ export = WebhookPlatformModel;
  * @typedef SubscriberConfigUpdate
  * @property {number} id
  * @property {string} [name]
- * @property {string} webhook_url
- * @property {Association} association
+ * @property {string} [webhook_url]
+ * @property {Association} [association]
  * @property {Object} [custom_headers]
- * @property {SubscriberStatus} status
- * @property {string} email_id
+ * @property {SubscriberStatus} [status]
+ * @property {string} [email_id]
  * @property {AuthMeta} [auth_meta]
  * @property {number[]} event_id
  */
@@ -285,12 +285,12 @@ type Event = {
 /** @returns {EventProcessRequest} */
 declare function EventProcessRequest(): EventProcessRequest;
 type EventProcessRequest = {
-    search_text: string;
+    search_text?: string;
     end_date: string;
     start_date: string;
-    subscriber_ids: number[];
-    status: string;
-    event: Event[];
+    subscriber_ids?: number[];
+    status?: string;
+    event?: Event[];
 };
 /** @returns {DownloadReportResponse} */
 declare function DownloadReportResponse(): DownloadReportResponse;
@@ -352,12 +352,33 @@ type EventProcessReportObject = {
 /** @returns {Page} */
 declare function Page(): Page;
 type Page = {
+    /**
+     * - The total number of items on the page.
+     */
     item_total?: number;
+    /**
+     * - The identifier for the next page.
+     */
     next_id?: string;
+    /**
+     * - Indicates whether there is a previous page.
+     */
     has_previous?: boolean;
+    /**
+     * - Indicates whether there is a next page.
+     */
     has_next?: boolean;
+    /**
+     * - The current page number.
+     */
     current?: number;
+    /**
+     * - The type of the page, such as 'PageType'.
+     */
     type: string;
+    /**
+     * - The number of items per page.
+     */
     size?: number;
 };
 /** @returns {PingWebhook} */
@@ -608,7 +629,7 @@ type Events = {
 /** @returns {SubscriberConfigPostRequestV2} */
 declare function SubscriberConfigPostRequestV2(): SubscriberConfigPostRequestV2;
 type SubscriberConfigPostRequestV2 = {
-    name?: string;
+    name: string;
     webhook_url?: string;
     provider: string;
     association: Association;
@@ -616,7 +637,7 @@ type SubscriberConfigPostRequestV2 = {
     status: SubscriberStatus;
     email_id: string;
     auth_meta?: AuthMeta;
-    events?: Events[];
+    events: Events[];
 };
 /** @returns {SubscriberConfigUpdateRequestV2} */
 declare function SubscriberConfigUpdateRequestV2(): SubscriberConfigUpdateRequestV2;
@@ -625,17 +646,17 @@ type SubscriberConfigUpdateRequestV2 = {
     name?: string;
     webhook_url?: string;
     provider: string;
-    association: Association;
+    association?: Association;
     custom_headers?: any;
     status: SubscriberStatus;
-    email_id: string;
+    email_id?: string;
     auth_meta?: AuthMeta;
     events?: Events[];
 };
 /** @returns {SubscriberConfigPost} */
 declare function SubscriberConfigPost(): SubscriberConfigPost;
 type SubscriberConfigPost = {
-    name?: string;
+    name: string;
     webhook_url: string;
     association: Association;
     custom_headers?: any;
@@ -649,11 +670,11 @@ declare function SubscriberConfigUpdate(): SubscriberConfigUpdate;
 type SubscriberConfigUpdate = {
     id: number;
     name?: string;
-    webhook_url: string;
-    association: Association;
+    webhook_url?: string;
+    association?: Association;
     custom_headers?: any;
-    status: SubscriberStatus;
-    email_id: string;
+    status?: SubscriberStatus;
+    email_id?: string;
     auth_meta?: AuthMeta;
     event_id: number[];
 };

package/sdk/platform/Webhook/WebhookPlatformModel.js

@@ -10,12 +10,12 @@ const Joi = require("joi");
 
 /**
  * @typedef EventProcessRequest
- * @property {string} search_text
+ * @property {string} [search_text]
  * @property {string} end_date
  * @property {string} start_date
- * @property {number[]} subscriber_ids
- * @property {string} status
- * @property {Event[]} event
+ * @property {number[]} [subscriber_ids]
+ * @property {string} [status]
+ * @property {Event[]} [event]
  */
 
 /**
@@ -47,13 +47,13 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 
 /**
@@ -228,7 +228,7 @@ const Joi = require("joi");
 
 /**
  * @typedef SubscriberConfigPostRequestV2
- * @property {string} [name]
+ * @property {string} name
  * @property {string} [webhook_url]
  * @property {string} provider
  * @property {Association} association
@@ -236,7 +236,7 @@ const Joi = require("joi");
  * @property {SubscriberStatus} status
  * @property {string} email_id
  * @property {AuthMeta} [auth_meta]
- * @property {Events[]} [events]
+ * @property {Events[]} events
  */
 
 /**
@@ -245,17 +245,17 @@ const Joi = require("joi");
  * @property {string} [name]
  * @property {string} [webhook_url]
  * @property {string} provider
- * @property {Association} association
+ * @property {Association} [association]
  * @property {Object} [custom_headers]
  * @property {SubscriberStatus} status
- * @property {string} email_id
+ * @property {string} [email_id]
  * @property {AuthMeta} [auth_meta]
  * @property {Events[]} [events]
  */
 
 /**
  * @typedef SubscriberConfigPost
- * @property {string} [name]
+ * @property {string} name
  * @property {string} webhook_url
  * @property {Association} association
  * @property {Object} [custom_headers]
@@ -269,11 +269,11 @@ const Joi = require("joi");
  * @typedef SubscriberConfigUpdate
  * @property {number} id
  * @property {string} [name]
- * @property {string} webhook_url
- * @property {Association} association
+ * @property {string} [webhook_url]
+ * @property {Association} [association]
  * @property {Object} [custom_headers]
- * @property {SubscriberStatus} status
- * @property {string} email_id
+ * @property {SubscriberStatus} [status]
+ * @property {string} [email_id]
  * @property {AuthMeta} [auth_meta]
  * @property {number[]} event_id
  */
@@ -318,12 +318,12 @@ class WebhookPlatformModel {
   /** @returns {EventProcessRequest} */
   static EventProcessRequest() {
     return Joi.object({
-      search_text: Joi.string().allow("").required(),
+      search_text: Joi.string().allow(""),
       end_date: Joi.string().allow("").required(),
       start_date: Joi.string().allow("").required(),
-      subscriber_ids: Joi.array().items(Joi.number()).required(),
-      status: Joi.string().allow("").required(),
-      event: Joi.array().items(WebhookPlatformModel.Event()).required(),
+      subscriber_ids: Joi.array().items(Joi.number()),
+      status: Joi.string().allow(""),
+      event: Joi.array().items(WebhookPlatformModel.Event()),
     });
   }
 
@@ -582,7 +582,7 @@ class WebhookPlatformModel {
   /** @returns {SubscriberConfigPostRequestV2} */
   static SubscriberConfigPostRequestV2() {
     return Joi.object({
-      name: Joi.string().allow(""),
+      name: Joi.string().allow("").required(),
       webhook_url: Joi.string().allow(""),
       provider: Joi.string().allow("").required(),
       association: WebhookPlatformModel.Association().required(),
@@ -590,7 +590,7 @@ class WebhookPlatformModel {
       status: WebhookPlatformModel.SubscriberStatus().required(),
       email_id: Joi.string().allow("").required(),
       auth_meta: WebhookPlatformModel.AuthMeta(),
-      events: Joi.array().items(WebhookPlatformModel.Events()),
+      events: Joi.array().items(WebhookPlatformModel.Events()).required(),
     });
   }
 
@@ -601,10 +601,10 @@ class WebhookPlatformModel {
       name: Joi.string().allow(""),
       webhook_url: Joi.string().allow(""),
       provider: Joi.string().allow("").required(),
-      association: WebhookPlatformModel.Association().required(),
+      association: WebhookPlatformModel.Association(),
       custom_headers: Joi.any(),
       status: WebhookPlatformModel.SubscriberStatus().required(),
-      email_id: Joi.string().allow("").required(),
+      email_id: Joi.string().allow(""),
       auth_meta: WebhookPlatformModel.AuthMeta(),
       events: Joi.array().items(WebhookPlatformModel.Events()),
     });
@@ -613,7 +613,7 @@ class WebhookPlatformModel {
   /** @returns {SubscriberConfigPost} */
   static SubscriberConfigPost() {
     return Joi.object({
-      name: Joi.string().allow(""),
+      name: Joi.string().allow("").required(),
       webhook_url: Joi.string().allow("").required(),
       association: WebhookPlatformModel.Association().required(),
       custom_headers: Joi.any(),
@@ -629,11 +629,11 @@ class WebhookPlatformModel {
     return Joi.object({
       id: Joi.number().required(),
       name: Joi.string().allow(""),
-      webhook_url: Joi.string().allow("").required(),
-      association: WebhookPlatformModel.Association().required(),
+      webhook_url: Joi.string().allow(""),
+      association: WebhookPlatformModel.Association(),
       custom_headers: Joi.any(),
-      status: WebhookPlatformModel.SubscriberStatus().required(),
-      email_id: Joi.string().allow("").required(),
+      status: WebhookPlatformModel.SubscriberStatus(),
+      email_id: Joi.string().allow(""),
       auth_meta: WebhookPlatformModel.AuthMeta(),
       event_id: Joi.array().items(Joi.number()).required(),
     });

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

@@ -5,6 +5,7 @@ declare class Billing {
     _relativeUrls: {
         getPlanDetails: string;
         getStandardPlans: string;
+        getTenureConfig: string;
         planList: string;
     };
     _urls: {};
@@ -30,6 +31,16 @@ declare class Billing {
      * @description: Get Standard/Public Plans. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/billing/getStandardPlans/).
      */
     getStandardPlans({ platform, requestHeaders }?: BillingPublicValidator.GetStandardPlansParam, { responseHeaders }?: object): Promise<BillingPublicModel.DetailList>;
+    /**
+     * @param {BillingPublicValidator.GetTenureConfigParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<BillingPublicModel.TenureConfigResponse>} - Success response
+     * @name getTenureConfig
+     * @summary: Get Tenure Configuration
+     * @description: Retrieve the tenure configuration for a specific country. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/billing/getTenureConfig/).
+     */
+    getTenureConfig({ countryCode, requestHeaders }?: BillingPublicValidator.GetTenureConfigParam, { responseHeaders }?: object): Promise<BillingPublicModel.TenureConfigResponse>;
     /**
      * @param {BillingPublicValidator.PlanListParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/public/Billing/BillingPublicClient.js

@@ -16,6 +16,8 @@ class Billing {
     this._relativeUrls = {
       getPlanDetails: "/service/public/billing/v1.0/plan/details/{plan_id}",
       getStandardPlans: "/service/public/billing/v1.0/plan/detailed-list/",
+      getTenureConfig:
+        "/service/public/billing/v1.0/tenure-config/{country_code}",
       planList: "/service/public/billing/v1.0/plan/list",
     };
     this._urls = Object.entries(this._relativeUrls).reduce(
@@ -192,6 +194,84 @@ class Billing {
     return response;
   }
 
+  /**
+   * @param {BillingPublicValidator.GetTenureConfigParam} arg - Arg object.
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PublicAPIClient").Options} - Options
+   * @returns {Promise<BillingPublicModel.TenureConfigResponse>} - Success response
+   * @name getTenureConfig
+   * @summary: Get Tenure Configuration
+   * @description: Retrieve the tenure configuration for a specific country. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/billing/getTenureConfig/).
+   */
+  async getTenureConfig(
+    { countryCode, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = BillingPublicValidator.getTenureConfig().validate(
+      { countryCode },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = BillingPublicValidator.getTenureConfig().validate(
+      { countryCode },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for public > Billing > getTenureConfig \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PublicAPIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getTenureConfig"],
+        params: { countryCode },
+      }),
+      query_params,
+      undefined,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = BillingPublicModel.TenureConfigResponse().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 > getTenureConfig \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {BillingPublicValidator.PlanListParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`