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

package/sdk/platform/Webhook/WebhookPlatformClient.js

@@ -20,8 +20,9 @@ class Webhook {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<WebhookPlatformModel.CancelResponse>} - Success response
    * @name cancelJobByName
-   * @summary: Cancel a report export
-   * @description: Cancel the export of a specific report for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
+   * @summary: Cancel a report export.
+   * @description: Cancel the export of a specific report for a company.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
    */
   async cancelJobByName(
     { filename, requestHeaders } = { requestHeaders: {} },
@@ -97,10 +98,11 @@ class Webhook {
    * @param {WebhookPlatformValidator.DownloadDeliveryReportParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<Object>} - Success response
+   * @returns {Promise<WebhookPlatformModel.DownloadReportResponse>} - Success response
    * @name downloadDeliveryReport
-   * @summary: Download processed events report for a company
-   * @description: Download reports for a specific company based on the provided filters. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/downloadDeliveryReport/).
+   * @summary: Download processed events report for a company.
+   * @description: Download reports for a specific company based on the provided filters.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/downloadDeliveryReport/).
    */
   async downloadDeliveryReport(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -153,7 +155,9 @@ class Webhook {
       responseData = response[0];
     }
 
-    const { error: res_error } = Joi.any().validate(responseData, {
+    const {
+      error: res_error,
+    } = WebhookPlatformModel.DownloadReportResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -176,10 +180,11 @@ class Webhook {
    * @param {WebhookPlatformValidator.FetchAllEventConfigurationsParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<WebhookPlatformModel.EventConfigResponse>} - Success response
+   * @returns {Promise<Object>} - Success response
    * @name fetchAllEventConfigurations
-   * @summary:
-   * @description: Get All Webhook Events - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
+   * @summary: Get All Webhook Events.
+   * @description: To fetch all webhook events.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
    */
   async fetchAllEventConfigurations(
     { requestHeaders } = { requestHeaders: {} },
@@ -228,9 +233,7 @@ class Webhook {
       responseData = response[0];
     }
 
-    const {
-      error: res_error,
-    } = WebhookPlatformModel.EventConfigResponse().validate(responseData, {
+    const { error: res_error } = Joi.any().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -255,8 +258,9 @@ class Webhook {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<WebhookPlatformModel.EventProcessReports>} - Success response
    * @name getDeliveryReports
-   * @summary: Get processed events report for a company
-   * @description: Retrieve a list of processed events for a specific company based on the provided filters. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getDeliveryReports/).
+   * @summary: Get processed events report for a company.
+   * @description: Retrieve a list of processed events for a specific company based on the provided filters.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getDeliveryReports/).
    */
   async getDeliveryReports(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -332,9 +336,7 @@ class Webhook {
    * @param {WebhookPlatformValidator.GetEventCountsParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<WebhookPlatformModel.FailedEventsCountSuccessResponse>}
-   *   - Success response
-   *
+   * @returns {Promise<WebhookPlatformModel.RetryCountResponse>} - Success response
    * @name getEventCounts
    * @summary: Get the count of failed events for a company within a specified date range.
    * @description: Retrieves the count of failed events for a specific company within the specified date range. The user can filter the count based on specific event types if provided.
@@ -391,10 +393,10 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPlatformModel.FailedEventsCountSuccessResponse().validate(
-      responseData,
-      { abortEarly: false, allowUnknown: true }
-    );
+    } = WebhookPlatformModel.RetryCountResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -416,8 +418,9 @@ class Webhook {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<WebhookPlatformModel.HistoryResponse>} - Success response
    * @name getHistoricalReports
-   * @summary: Get report download history
-   * @description: Retrieve history reports for a specific company based on the provided filters. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getHistoricalReports/).
+   * @summary: Get report download history.
+   * @description: Retrieve history reports for a specific company based on the provided filters.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getHistoricalReports/).
    */
   async getHistoricalReports(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -569,10 +572,11 @@ class Webhook {
    * @param {WebhookPlatformValidator.GetReportFiltersParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<WebhookPlatformModel.ReportFilterResponse>} - Success response
+   * @returns {Promise<WebhookPlatformModel.ReportFilterResponse[]>} - Success response
    * @name getReportFilters
-   * @summary: Get filters for a company
-   * @description: Retrieve filters for a specific company based on the provided subscriber IDs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getReportFilters/).
+   * @summary: Get filters for a company.
+   * @description: Retrieve filters for a specific company based on the provided subscriber IDs.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getReportFilters/).
    */
   async getReportFilters(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -623,12 +627,9 @@ class Webhook {
       responseData = response[0];
     }
 
-    const {
-      error: res_error,
-    } = WebhookPlatformModel.ReportFilterResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
+    const { error: res_error } = Joi.array()
+      .items(WebhookPlatformModel.ReportFilterResponse())
+      .validate(responseData, { abortEarly: false, allowUnknown: true });
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -727,10 +728,11 @@ class Webhook {
    * @param {WebhookPlatformValidator.GetSubscribersByCompanyParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<WebhookPlatformModel.SubscriberResponse>} - Success response
+   * @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
    * @name getSubscribersByCompany
-   * @summary: Get Subscribers By Company ID
-   * @description: Get Subscribers By CompanyId - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
+   * @summary: Get Subscribers By CompanyId.
+   * @description: Get Subscribers By Company ID.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
    */
   async getSubscribersByCompany(
     { pageNo, pageSize, extensionId, requestHeaders } = { requestHeaders: {} },
@@ -778,7 +780,7 @@ class Webhook {
     const response = await PlatformAPIClient.execute(
       this.config,
       "get",
-      `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber`,
+      `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber/`,
       query_params,
       undefined,
       { ...xHeaders, ...requestHeaders },
@@ -792,7 +794,7 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPlatformModel.SubscriberResponse().validate(responseData, {
+    } = WebhookPlatformModel.SubscriberConfigList().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -865,7 +867,7 @@ class Webhook {
     const response = await PlatformAPIClient.execute(
       this.config,
       "get",
-      `/service/platform/webhook/v1.0/company/${this.config.companyId}/extension/${extensionId}/subscriber`,
+      `/service/platform/webhook/v1.0/company/${this.config.companyId}/extension/${extensionId}/subscriber/`,
       query_params,
       undefined,
       { ...xHeaders, ...requestHeaders },
@@ -902,7 +904,7 @@ class Webhook {
    * @param {WebhookPlatformValidator.ManualRetryCancelParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<WebhookPlatformModel.EventSuccessResponse>} - Success response
+   * @returns {Promise<string>} - Success response
    * @name manualRetryCancel
    * @summary: Cancel the active manual retry for a company's failed events.
    * @description: Cancels the active manual retry for a specific company's failed events. If a manual retry is currently in progress, it will be cancelled.
@@ -953,12 +955,9 @@ class Webhook {
       responseData = response[0];
     }
 
-    const {
-      error: res_error,
-    } = WebhookPlatformModel.EventSuccessResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
+    const { error: res_error } = Joi.string()
+      .allow("")
+      .validate(responseData, { abortEarly: false, allowUnknown: true });
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -978,8 +977,7 @@ class Webhook {
    * @param {WebhookPlatformValidator.ManualRetryOfFailedEventParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<WebhookPlatformModel.EventProcessedSuccessResponse>} -
-   *   Success response
+   * @returns {Promise<WebhookPlatformModel.RetrySuccessResponse>} - Success response
    * @name manualRetryOfFailedEvent
    * @summary: Initiate a manual retry for event processing.
    * @description: Initiates a manual retry for event processing for a specific company. This endpoint allows the user to specify the date range (start_date and end_date) within which the events should be retried.
@@ -1038,10 +1036,10 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPlatformModel.EventProcessedSuccessResponse().validate(
-      responseData,
-      { abortEarly: false, allowUnknown: true }
-    );
+    } = WebhookPlatformModel.RetrySuccessResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -1063,8 +1061,9 @@ class Webhook {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<WebhookPlatformModel.PingWebhookResponse>} - Success response
    * @name pingWebhook
-   * @summary: Ping and validate webhook url
-   * @description: Ping and validate webhook url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
+   * @summary: Ping and validate webhook url.
+   * @description: Ping and validate webhook url.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
    */
   async pingWebhook(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1138,10 +1137,12 @@ class Webhook {
    * @param {WebhookPlatformValidator.RegisterSubscriberToEventParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<WebhookPlatformModel.SubscriberConfig>} - Success response
+   * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
+   *   Success response
    * @name registerSubscriberToEvent
-   * @summary: Register Subscriber
-   * @description: Register Subscriber - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEvent/).
+   * @summary: Register Subscriber.
+   * @description: Register Subscriber.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEvent/).
    */
   async registerSubscriberToEvent(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1182,7 +1183,7 @@ class Webhook {
     const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber`,
+      `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber/`,
       query_params,
       body,
       { ...xHeaders, ...requestHeaders },
@@ -1196,7 +1197,7 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPlatformModel.SubscriberConfig().validate(responseData, {
+    } = WebhookPlatformModel.SubscriberConfigResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -1219,7 +1220,8 @@ class Webhook {
    * @param {WebhookPlatformValidator.UpdateSubscriberConfigParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<WebhookPlatformModel.SubscriberConfig>} - Success response
+   * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
+   *   Success response
    * @name updateSubscriberConfig
    * @summary: Update Subscriber
    * @description: Update Subscriber - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
@@ -1263,7 +1265,7 @@ class Webhook {
     const response = await PlatformAPIClient.execute(
       this.config,
       "put",
-      `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber`,
+      `/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber/`,
       query_params,
       body,
       { ...xHeaders, ...requestHeaders },
@@ -1277,7 +1279,7 @@ class Webhook {
 
     const {
       error: res_error,
-    } = WebhookPlatformModel.SubscriberConfig().validate(responseData, {
+    } = WebhookPlatformModel.SubscriberConfigResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });