@gofynd/fdk-client-javascript 3.3.5 → 3.4.0

package/sdk/partner/Webhook/WebhookPartnerModel.d.ts

@@ -249,7 +249,7 @@ export = WebhookPartnerModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @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.
@@ -307,6 +307,7 @@ export = WebhookPartnerModel;
  * @property {string} [name] - The name of the item.
  * @property {string} [webhook_url] - The URL of the webhook associated with the item.
  * @property {string} [provider] - The provider of the item.
+ * @property {string} [source] - Source that subscriber belongs to.
  * @property {Association} [association]
  * @property {Object} [custom_headers] - Custom headers associated with the item, if any.
  * @property {string} [status] - The current status of the item.
@@ -906,7 +907,7 @@ type EventProcessReportObject = {
 declare function Page(): Page;
 type Page = {
     /**
-     * - The total number of items on the page.
+     * - The total number of all items across all pages.
      */
     item_total?: number;
     /**
@@ -1062,6 +1063,10 @@ type ItemSchema = {
      * - The provider of the item.
      */
     provider?: string;
+    /**
+     * - Source that subscriber belongs to.
+     */
+    source?: string;
     association?: Association;
     /**
      * - Custom headers associated with the item, if any.

package/sdk/partner/Webhook/WebhookPartnerModel.js

@@ -277,7 +277,7 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @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.
@@ -341,6 +341,7 @@ const Joi = require("joi");
  * @property {string} [name] - The name of the item.
  * @property {string} [webhook_url] - The URL of the webhook associated with the item.
  * @property {string} [provider] - The provider of the item.
+ * @property {string} [source] - Source that subscriber belongs to.
  * @property {Association} [association]
  * @property {Object} [custom_headers] - Custom headers associated with the item, if any.
  * @property {string} [status] - The current status of the item.
@@ -703,6 +704,7 @@ class WebhookPartnerModel {
       name: Joi.string().allow(""),
       webhook_url: Joi.string().allow(""),
       provider: Joi.string().allow(""),
+      source: Joi.string().allow("").allow(null),
       association: WebhookPartnerModel.Association(),
       custom_headers: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
       status: Joi.string().allow(""),

package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts

@@ -12,7 +12,7 @@ declare class Analytics {
      * @returns {Promise<AnalyticsPlatformModel.JobStatus>} - Success response
      * @name checkJobStatusByNameV2
      * @summary: Checks download job status
-     * @description: Takes job name in path param to check the status of job Returns file URL if downloading is done else returns status of job - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/analytics/checkJobStatusByNameV2/).
+     * @description: Takes job name in path param to check the status of job Returns file URL if downloading is done else returns status of job - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/checkJobStatusByNameV2/).
      */
     checkJobStatusByNameV2({ fileName, requestHeaders }?: AnalyticsPlatformApplicationValidator.CheckJobStatusByNameV2Param, { responseHeaders }?: object): Promise<AnalyticsPlatformModel.JobStatus>;
     /**
@@ -24,7 +24,7 @@ declare class Analytics {
      * @returns {Promise<AnalyticsPlatformModel.JobExecutionResult>} - Success response
      * @name executeJobForProvidedParametersV2
      * @summary: Executes given sql(Base64 Encoded) query
-     * @description: Query click events data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/analytics/executeJobForProvidedParametersV2/).
+     * @description: Query click events data - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/executeJobForProvidedParametersV2/).
      */
     executeJobForProvidedParametersV2({ body, requestHeaders }?: AnalyticsPlatformApplicationValidator.ExecuteJobForProvidedParametersV2Param, { responseHeaders }?: object): Promise<AnalyticsPlatformModel.JobExecutionResult>;
     /**
@@ -36,7 +36,7 @@ declare class Analytics {
      * @returns {Promise<Object>} - Success response
      * @name startDownloadForQueryV2
      * @summary: Initiates download job
-     * @description: Initiates download job and returns job name - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/analytics/startDownloadForQueryV2/).
+     * @description: Initiates download job and returns job name - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/startDownloadForQueryV2/).
      */
     startDownloadForQueryV2({ exportType, body, requestHeaders }?: AnalyticsPlatformApplicationValidator.StartDownloadForQueryV2Param, { responseHeaders }?: object): Promise<any>;
 }

package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js

@@ -24,7 +24,7 @@ class Analytics {
    * @returns {Promise<AnalyticsPlatformModel.JobStatus>} - Success response
    * @name checkJobStatusByNameV2
    * @summary: Checks download job status
-   * @description: Takes job name in path param to check the status of job Returns file URL if downloading is done else returns status of job - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/analytics/checkJobStatusByNameV2/).
+   * @description: Takes job name in path param to check the status of job Returns file URL if downloading is done else returns status of job - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/checkJobStatusByNameV2/).
    */
   async checkJobStatusByNameV2(
     { fileName, requestHeaders } = { requestHeaders: {} },
@@ -105,7 +105,7 @@ class Analytics {
    * @returns {Promise<AnalyticsPlatformModel.JobExecutionResult>} - Success response
    * @name executeJobForProvidedParametersV2
    * @summary: Executes given sql(Base64 Encoded) query
-   * @description: Query click events data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/analytics/executeJobForProvidedParametersV2/).
+   * @description: Query click events data - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/executeJobForProvidedParametersV2/).
    */
   async executeJobForProvidedParametersV2(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -186,7 +186,7 @@ class Analytics {
    * @returns {Promise<Object>} - Success response
    * @name startDownloadForQueryV2
    * @summary: Initiates download job
-   * @description: Initiates download job and returns job name - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/analytics/startDownloadForQueryV2/).
+   * @description: Initiates download job and returns job name - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/analytics/startDownloadForQueryV2/).
    */
   async startDownloadForQueryV2(
     { exportType, body, requestHeaders } = { requestHeaders: {} },

package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts

@@ -1,7 +1,7 @@
 export = AnalyticsPlatformModel;
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @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.
@@ -45,7 +45,7 @@ declare namespace AnalyticsPlatformModel {
 declare function Page(): Page;
 type Page = {
     /**
-     * - The total number of items on the page.
+     * - The total number of all items across all pages.
      */
     item_total?: number;
     /**

package/sdk/platform/Analytics/AnalyticsPlatformModel.js

@@ -2,7 +2,7 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @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.

package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts

@@ -9,7 +9,7 @@ declare class AuditTrail {
      * @returns {Promise<AuditTrailPlatformModel.CreateLogResp>} - Success response
      * @name createAuditLog
      * @summary: Create an audit log
-     * @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/createAuditLog/).
+     * @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/audittrail/createAuditLog/).
      */
     createAuditLog({ body, requestHeaders }?: AuditTrailPlatformValidator.CreateAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.CreateLogResp>;
 }

package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js

@@ -21,7 +21,7 @@ class AuditTrail {
    * @returns {Promise<AuditTrailPlatformModel.CreateLogResp>} - Success response
    * @name createAuditLog
    * @summary: Create an audit log
-   * @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/createAuditLog/).
+   * @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/audittrail/createAuditLog/).
    */
   async createAuditLog(
     { body, requestHeaders } = { requestHeaders: {} },

package/sdk/platform/Billing/BillingPlatformClient.d.ts

@@ -9,7 +9,7 @@ declare class Billing {
      * @returns {Promise<BillingPlatformModel.SubscriptionChargeRes>} - Success response
      * @name cancelSubscriptionCharge
      * @summary: Cancel the extension subscription
-     * @description: Cancel an ongoing extension subscription for the company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionCharge/).
+     * @description: Cancel an ongoing extension subscription for the company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/cancelSubscriptionCharge/).
      */
     cancelSubscriptionCharge({ extensionId, subscriptionId, requestHeaders }?: BillingPlatformValidator.CancelSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionChargeRes>;
     /**
@@ -21,7 +21,7 @@ declare class Billing {
      *
      * @name createOneTimeCharge
      * @summary: Generate a one-time charge
-     * @description: Generate a one-time charge for specific services or products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createOneTimeCharge/).
+     * @description: Generate a one-time charge for specific services or products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/createOneTimeCharge/).
      */
     createOneTimeCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateOneTimeChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateOneTimeChargeResponseSchemas>;
     /**
@@ -31,7 +31,7 @@ declare class Billing {
      * @returns {Promise<BillingPlatformModel.CreateSubscription>} - Success response
      * @name createSubscriptionCharge
      * @summary: Initiate subscription billing
-     * @description: Initiates and registers a subscription charge for a specific extension for a given company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createSubscriptionCharge/).
+     * @description: Initiates and registers a subscription charge for a specific extension for a given company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/createSubscriptionCharge/).
      */
     createSubscriptionCharge({ extensionId, body, requestHeaders }?: BillingPlatformValidator.CreateSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.CreateSubscription>;
     /**
@@ -41,7 +41,7 @@ declare class Billing {
      * @returns {Promise<BillingPlatformModel.ChargeDetails>} - Success response
      * @name getChargeDetails
      * @summary: Obtain charge details
-     * @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getChargeDetails/).
+     * @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/getChargeDetails/).
      */
     getChargeDetails({ extensionId, chargeId, requestHeaders }?: BillingPlatformValidator.GetChargeDetailsParam, { responseHeaders }?: object): Promise<BillingPlatformModel.ChargeDetails>;
     /**
@@ -51,7 +51,7 @@ declare class Billing {
      * @returns {Promise<BillingPlatformModel.SubscriptionChargeRes>} - Success response
      * @name getSubscriptionCharge
      * @summary: Retrieve subscription charge details
-     * @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscriptionCharge/).
+     * @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/getSubscriptionCharge/).
      */
     getSubscriptionCharge({ extensionId, subscriptionId, requestHeaders }?: BillingPlatformValidator.GetSubscriptionChargeParam, { responseHeaders }?: object): Promise<BillingPlatformModel.SubscriptionChargeRes>;
 }

package/sdk/platform/Billing/BillingPlatformClient.js

@@ -21,7 +21,7 @@ class Billing {
    * @returns {Promise<BillingPlatformModel.SubscriptionChargeRes>} - Success response
    * @name cancelSubscriptionCharge
    * @summary: Cancel the extension subscription
-   * @description: Cancel an ongoing extension subscription for the company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/cancelSubscriptionCharge/).
+   * @description: Cancel an ongoing extension subscription for the company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/cancelSubscriptionCharge/).
    */
   async cancelSubscriptionCharge(
     { extensionId, subscriptionId, requestHeaders } = { requestHeaders: {} },
@@ -106,7 +106,7 @@ class Billing {
    *
    * @name createOneTimeCharge
    * @summary: Generate a one-time charge
-   * @description: Generate a one-time charge for specific services or products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createOneTimeCharge/).
+   * @description: Generate a one-time charge for specific services or products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/createOneTimeCharge/).
    */
   async createOneTimeCharge(
     { extensionId, body, requestHeaders } = { requestHeaders: {} },
@@ -187,7 +187,7 @@ class Billing {
    * @returns {Promise<BillingPlatformModel.CreateSubscription>} - Success response
    * @name createSubscriptionCharge
    * @summary: Initiate subscription billing
-   * @description: Initiates and registers a subscription charge for a specific extension for a given company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/createSubscriptionCharge/).
+   * @description: Initiates and registers a subscription charge for a specific extension for a given company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/createSubscriptionCharge/).
    */
   async createSubscriptionCharge(
     { extensionId, body, requestHeaders } = { requestHeaders: {} },
@@ -270,7 +270,7 @@ class Billing {
    * @returns {Promise<BillingPlatformModel.ChargeDetails>} - Success response
    * @name getChargeDetails
    * @summary: Obtain charge details
-   * @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getChargeDetails/).
+   * @description: Retrieve comprehensive details about a specific billing charge. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/getChargeDetails/).
    */
   async getChargeDetails(
     { extensionId, chargeId, requestHeaders } = { requestHeaders: {} },
@@ -351,7 +351,7 @@ class Billing {
    * @returns {Promise<BillingPlatformModel.SubscriptionChargeRes>} - Success response
    * @name getSubscriptionCharge
    * @summary: Retrieve subscription charge details
-   * @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/billing/getSubscriptionCharge/).
+   * @description: Retrieve detailed information about subscription charges using this API. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/billing/getSubscriptionCharge/).
    */
   async getSubscriptionCharge(
     { extensionId, subscriptionId, requestHeaders } = { requestHeaders: {} },