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

package/sdk/platform/Webhook/WebhookPlatformClient.js

@@ -331,85 +331,6 @@ class Webhook {
     return response;
   }
 
-  /**
-   * @param {WebhookPlatformValidator.GetEventCountsParam} arg - Arg object
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<WebhookPlatformModel.RetryCountResponse>} - Success response
-   * @name getEventCounts
-   * @summary: Get event counts
-   * @description: Retrieve the counts of events based on their status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getEventCounts/).
-   */
-  async getEventCounts(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const { error } = WebhookPlatformValidator.getEventCounts().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,
-    } = WebhookPlatformValidator.getEventCounts().validate(
-      {
-        body,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Webhook > getEventCounts \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "post",
-      `/service/platform/webhook/v1.0/company/${this.config.companyId}/retry/events/counts`,
-      query_params,
-      body,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = WebhookPlatformModel.RetryCountResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for platform > Webhook > getEventCounts \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
   /**
    * @param {WebhookPlatformValidator.GetHistoricalReportsParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -489,81 +410,6 @@ class Webhook {
     return response;
   }
 
-  /**
-   * @param {WebhookPlatformValidator.GetManualRetryStatusParam} arg - Arg object
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<WebhookPlatformModel.RetryStatusResponse>} - Success response
-   * @name getManualRetryStatus
-   * @summary: Get manual retry status
-   * @description: Check the status of a manual retry operation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getManualRetryStatus/).
-   */
-  async getManualRetryStatus(
-    { requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const { error } = WebhookPlatformValidator.getManualRetryStatus().validate(
-      {},
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = WebhookPlatformValidator.getManualRetryStatus().validate(
-      {},
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for platform > Webhook > getManualRetryStatus \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await PlatformAPIClient.execute(
-      this.config,
-      "get",
-      `/service/platform/webhook/v1.0/company/${this.config.companyId}/retry/status`,
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = WebhookPlatformModel.RetryStatusResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for platform > Webhook > getManualRetryStatus \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
   /**
    * @param {WebhookPlatformValidator.GetReportFiltersParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -895,20 +741,22 @@ class Webhook {
   }
 
   /**
-   * @param {WebhookPlatformValidator.ManualRetryCancelParam} arg - Arg object
+   * @param {WebhookPlatformValidator.PingWebhookParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<string>} - Success response
-   * @name manualRetryCancel
-   * @summary: Manual retry cancellation
-   * @description: Cancel a manual retry operation for a failed event. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryCancel/).
+   * @returns {Promise<WebhookPlatformModel.PingWebhookResponse>} - Success response
+   * @name pingWebhook
+   * @summary: Ping webhook
+   * @description: Send a test ping to a webhook for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
    */
-  async manualRetryCancel(
-    { requestHeaders } = { requestHeaders: {} },
+  async pingWebhook(
+    { body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    const { error } = WebhookPlatformValidator.manualRetryCancel().validate(
-      {},
+    const { error } = WebhookPlatformValidator.pingWebhook().validate(
+      {
+        body,
+      },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -916,16 +764,16 @@ class Webhook {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = WebhookPlatformValidator.manualRetryCancel().validate(
-      {},
+    const { error: warrning } = WebhookPlatformValidator.pingWebhook().validate(
+      {
+        body,
+      },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: `Parameter Validation warrnings for platform > Webhook > manualRetryCancel \n ${warrning}`,
+        message: `Parameter Validation warrnings for platform > Webhook > pingWebhook \n ${warrning}`,
       });
     }
 
@@ -935,10 +783,10 @@ class Webhook {
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "delete",
-      `/service/platform/webhook/v1.0/company/${this.config.companyId}/retry/cancel`,
+      "post",
+      `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber/ping`,
       query_params,
-      undefined,
+      body,
       { ...xHeaders, ...requestHeaders },
       { responseHeaders }
     );
@@ -948,9 +796,12 @@ class Webhook {
       responseData = response[0];
     }
 
-    const { error: res_error } = Joi.string()
-      .allow("")
-      .validate(responseData, { abortEarly: false, allowUnknown: true });
+    const {
+      error: res_error,
+    } = WebhookPlatformModel.PingWebhookResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -958,7 +809,7 @@ class Webhook {
       } else {
         Logger({
           level: "WARN",
-          message: `Response Validation Warnings for platform > Webhook > manualRetryCancel \n ${res_error}`,
+          message: `Response Validation Warnings for platform > Webhook > pingWebhook \n ${res_error}`,
         });
       }
     }
@@ -967,21 +818,22 @@ class Webhook {
   }
 
   /**
-   * @param {WebhookPlatformValidator.ManualRetryOfFailedEventParam} arg - Arg object
+   * @param {WebhookPlatformValidator.RegisterSubscriberToEventParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<WebhookPlatformModel.RetrySuccessResponse>} - Success response
-   * @name manualRetryOfFailedEvent
-   * @summary: Manual retry of failed event
-   * @description: Trigger a manual retry for an event that failed to deliver. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryOfFailedEvent/).
+   * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
+   *   Success response
+   * @name registerSubscriberToEvent
+   * @summary: Register subscriber to event
+   * @description: Add a subscriber to receive events of a specific type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEvent/).
    */
-  async manualRetryOfFailedEvent(
+  async registerSubscriberToEvent(
     { body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const {
       error,
-    } = WebhookPlatformValidator.manualRetryOfFailedEvent().validate(
+    } = WebhookPlatformValidator.registerSubscriberToEvent().validate(
       {
         body,
       },
@@ -994,7 +846,7 @@ class Webhook {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = WebhookPlatformValidator.manualRetryOfFailedEvent().validate(
+    } = WebhookPlatformValidator.registerSubscriberToEvent().validate(
       {
         body,
       },
@@ -1003,7 +855,7 @@ class Webhook {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: `Parameter Validation warrnings for platform > Webhook > manualRetryOfFailedEvent \n ${warrning}`,
+        message: `Parameter Validation warrnings for platform > Webhook > registerSubscriberToEvent \n ${warrning}`,
       });
     }
 
@@ -1014,7 +866,7 @@ class Webhook {
     const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/webhook/v1.0/company/${this.config.companyId}/retry`,
+      `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber/`,
       query_params,
       body,
       { ...xHeaders, ...requestHeaders },
@@ -1028,7 +880,7 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPlatformModel.RetrySuccessResponse().validate(responseData, {
+    } = WebhookPlatformModel.SubscriberConfigResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -1039,7 +891,7 @@ class Webhook {
       } else {
         Logger({
           level: "WARN",
-          message: `Response Validation Warnings for platform > Webhook > manualRetryOfFailedEvent \n ${res_error}`,
+          message: `Response Validation Warnings for platform > Webhook > registerSubscriberToEvent \n ${res_error}`,
         });
       }
     }
@@ -1048,19 +900,23 @@ class Webhook {
   }
 
   /**
-   * @param {WebhookPlatformValidator.PingWebhookParam} arg - Arg object
+   * @param {WebhookPlatformValidator.RegisterSubscriberToEventV2Param} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<WebhookPlatformModel.PingWebhookResponse>} - Success response
-   * @name pingWebhook
-   * @summary: Ping webhook
-   * @description: Send a test ping to a webhook for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
+   * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
+   *   Success response
+   * @name registerSubscriberToEventV2
+   * @summary: Register Subscriber.
+   * @description: Register Subscriber.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEventV2/).
    */
-  async pingWebhook(
+  async registerSubscriberToEventV2(
     { body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    const { error } = WebhookPlatformValidator.pingWebhook().validate(
+    const {
+      error,
+    } = WebhookPlatformValidator.registerSubscriberToEventV2().validate(
       {
         body,
       },
@@ -1071,7 +927,9 @@ class Webhook {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = WebhookPlatformValidator.pingWebhook().validate(
+    const {
+      error: warrning,
+    } = WebhookPlatformValidator.registerSubscriberToEventV2().validate(
       {
         body,
       },
@@ -1080,7 +938,7 @@ class Webhook {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: `Parameter Validation warrnings for platform > Webhook > pingWebhook \n ${warrning}`,
+        message: `Parameter Validation warrnings for platform > Webhook > registerSubscriberToEventV2 \n ${warrning}`,
       });
     }
 
@@ -1091,7 +949,7 @@ class Webhook {
     const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber/ping`,
+      `/service/platform/webhook/v2.0/company/${this.config.companyId}/subscriber/`,
       query_params,
       body,
       { ...xHeaders, ...requestHeaders },
@@ -1105,7 +963,7 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPlatformModel.PingWebhookResponse().validate(responseData, {
+    } = WebhookPlatformModel.SubscriberConfigResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -1116,7 +974,7 @@ class Webhook {
       } else {
         Logger({
           level: "WARN",
-          message: `Response Validation Warnings for platform > Webhook > pingWebhook \n ${res_error}`,
+          message: `Response Validation Warnings for platform > Webhook > registerSubscriberToEventV2 \n ${res_error}`,
         });
       }
     }
@@ -1125,22 +983,22 @@ class Webhook {
   }
 
   /**
-   * @param {WebhookPlatformValidator.RegisterSubscriberToEventParam} arg - Arg object
+   * @param {WebhookPlatformValidator.UpdateSubscriberConfigParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
    *   Success response
-   * @name registerSubscriberToEvent
-   * @summary: Register subscriber to event
-   * @description: Add a subscriber to receive events of a specific type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEvent/).
+   * @name updateSubscriberConfig
+   * @summary: Update a subscriber config
+   * @description: Modify and update subscriber configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
    */
-  async registerSubscriberToEvent(
+  async updateSubscriberConfig(
     { body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const {
       error,
-    } = WebhookPlatformValidator.registerSubscriberToEvent().validate(
+    } = WebhookPlatformValidator.updateSubscriberConfig().validate(
       {
         body,
       },
@@ -1153,7 +1011,7 @@ class Webhook {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = WebhookPlatformValidator.registerSubscriberToEvent().validate(
+    } = WebhookPlatformValidator.updateSubscriberConfig().validate(
       {
         body,
       },
@@ -1162,7 +1020,7 @@ class Webhook {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: `Parameter Validation warrnings for platform > Webhook > registerSubscriberToEvent \n ${warrning}`,
+        message: `Parameter Validation warrnings for platform > Webhook > updateSubscriberConfig \n ${warrning}`,
       });
     }
 
@@ -1172,7 +1030,7 @@ class Webhook {
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "post",
+      "put",
       `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber/`,
       query_params,
       body,
@@ -1198,7 +1056,7 @@ class Webhook {
       } else {
         Logger({
           level: "WARN",
-          message: `Response Validation Warnings for platform > Webhook > registerSubscriberToEvent \n ${res_error}`,
+          message: `Response Validation Warnings for platform > Webhook > updateSubscriberConfig \n ${res_error}`,
         });
       }
     }
@@ -1207,22 +1065,21 @@ class Webhook {
   }
 
   /**
-   * @param {WebhookPlatformValidator.UpdateSubscriberConfigParam} arg - Arg object
+   * @param {WebhookPlatformValidator.UpdateSubscriberV2Param} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
    *   Success response
-   * @name updateSubscriberConfig
-   * @summary: Update a subscriber config
-   * @description: Modify and update subscriber configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
+   * @name updateSubscriberV2
+   * @summary: Update Subscriber.
+   * @description: Update Subscriber.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberV2/).
    */
-  async updateSubscriberConfig(
+  async updateSubscriberV2(
     { body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    const {
-      error,
-    } = WebhookPlatformValidator.updateSubscriberConfig().validate(
+    const { error } = WebhookPlatformValidator.updateSubscriberV2().validate(
       {
         body,
       },
@@ -1235,7 +1092,7 @@ class Webhook {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = WebhookPlatformValidator.updateSubscriberConfig().validate(
+    } = WebhookPlatformValidator.updateSubscriberV2().validate(
       {
         body,
       },
@@ -1244,7 +1101,7 @@ class Webhook {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: `Parameter Validation warrnings for platform > Webhook > updateSubscriberConfig \n ${warrning}`,
+        message: `Parameter Validation warrnings for platform > Webhook > updateSubscriberV2 \n ${warrning}`,
       });
     }
 
@@ -1255,7 +1112,7 @@ class Webhook {
     const response = await PlatformAPIClient.execute(
       this.config,
       "put",
-      `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber/`,
+      `/service/platform/webhook/v2.0/company/${this.config.companyId}/subscriber/`,
       query_params,
       body,
       { ...xHeaders, ...requestHeaders },
@@ -1280,7 +1137,7 @@ class Webhook {
       } else {
         Logger({
           level: "WARN",
-          message: `Response Validation Warnings for platform > Webhook > updateSubscriberConfig \n ${res_error}`,
+          message: `Response Validation Warnings for platform > Webhook > updateSubscriberV2 \n ${res_error}`,
         });
       }
     }