@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-beta.1

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

@@ -2,26 +2,77 @@ export = Webhook;
 declare class Webhook {
     constructor(config: any);
     config: any;
+    /**
+     * @param {WebhookPlatformValidator.CancelJobByNameParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<WebhookPlatformModel.CancelResponse>} - Success response
+     * @name cancelJobByName
+     * @summary: Cancel job by name
+     * @description: It will cancel export job triggerd by user in order to fetch
+     * historical delivery summery - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
+     */
+    cancelJobByName({ filename, requestHeaders }?: WebhookPlatformValidator.CancelJobByNameParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.CancelResponse>;
+    /**
+     * @param {WebhookPlatformValidator.DownloadDeliveryReportParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<WebhookPlatformModel.DownloadReportResponse>} - Success response
+     * @name downloadDeliveryReport
+     * @summary: Download delivery report
+     * @description: Download detailed delivery reports for events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/downloadDeliveryReport/).
+     */
+    downloadDeliveryReport({ body, requestHeaders }?: WebhookPlatformValidator.DownloadDeliveryReportParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.DownloadReportResponse>;
     /**
      * @param {WebhookPlatformValidator.FetchAllEventConfigurationsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<WebhookPlatformModel.EventConfigResult>} - Success response
+     * @returns {Promise<WebhookPlatformModel.EventConfigResponse>} - Success response
      * @name fetchAllEventConfigurations
      * @summary: List event configurations
      * @description: Retrieve all configurations for event handling. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
      */
-    fetchAllEventConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventConfigResult>;
+    fetchAllEventConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventConfigResponse>;
+    /**
+     * @param {WebhookPlatformValidator.GetDeliveryReportsParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<WebhookPlatformModel.EventProcessReports>} - Success response
+     * @name getDeliveryReports
+     * @summary: Get delivery reports
+     * @description: Retrieve reports on the delivery status of events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getDeliveryReports/).
+     */
+    getDeliveryReports({ body, requestHeaders }?: WebhookPlatformValidator.GetDeliveryReportsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventProcessReports>;
+    /**
+     * @param {WebhookPlatformValidator.GetHistoricalReportsParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<WebhookPlatformModel.HistoryResponse>} - Success response
+     * @name getHistoricalReports
+     * @summary: Get historical reports
+     * @description: Retrieve historical reports of webhook events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getHistoricalReports/).
+     */
+    getHistoricalReports({ body, requestHeaders }?: WebhookPlatformValidator.GetHistoricalReportsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.HistoryResponse>;
+    /**
+     * @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
+     * @name getReportFilters
+     * @summary: Get report filters
+     * @description: Retrieve filters used for generating reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getReportFilters/).
+     */
+    getReportFilters({ body, requestHeaders }?: WebhookPlatformValidator.GetReportFiltersParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.ReportFilterResponse[]>;
     /**
      * @param {WebhookPlatformValidator.GetSubscriberByIdParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<WebhookPlatformModel.SubscriberDetails>} - Success response
+     * @returns {Promise<WebhookPlatformModel.SubscriberResponse>} - Success response
      * @name getSubscriberById
      * @summary: Get a subscriber
      * @description: Retrieve a subscriber's details by their unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscriberById/).
      */
-    getSubscriberById({ subscriberId, requestHeaders }?: WebhookPlatformValidator.GetSubscriberByIdParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberDetails>;
+    getSubscriberById({ subscriberId, requestHeaders }?: WebhookPlatformValidator.GetSubscriberByIdParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberResponse>;
     /**
      * @param {WebhookPlatformValidator.GetSubscribersByCompanyParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -42,60 +93,62 @@ declare class Webhook {
      * @description: Retrieve subscribers associated with a specific extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByExtensionId/).
      */
     getSubscribersByExtensionId({ extensionId, pageNo, pageSize, requestHeaders }?: WebhookPlatformValidator.GetSubscribersByExtensionIdParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigList>;
+    /**
+     * @param {WebhookPlatformValidator.PingWebhookParam} 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/).
+     */
+    pingWebhook({ body, requestHeaders }?: WebhookPlatformValidator.PingWebhookParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.PingWebhookResponse>;
     /**
      * @param {WebhookPlatformValidator.RegisterSubscriberToEventParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<WebhookPlatformModel.SubscriberConfigResult>} - Success response
+     * @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/).
      */
-    registerSubscriberToEvent({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResult>;
+    registerSubscriberToEvent({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
     /**
      * @param {WebhookPlatformValidator.RegisterSubscriberToEventV2Param} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<WebhookPlatformModel.SubscriberConfigResult>} - Success response
+     * @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/).
      */
-    registerSubscriberToEventV2({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventV2Param, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResult>;
+    registerSubscriberToEventV2({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventV2Param, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
     /**
      * @param {WebhookPlatformValidator.UpdateSubscriberConfigParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<WebhookPlatformModel.SubscriberConfigResult>} - Success response
+     * @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/).
      */
-    updateSubscriberConfig({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberConfigParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResult>;
+    updateSubscriberConfig({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberConfigParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
     /**
      * @param {WebhookPlatformValidator.UpdateSubscriberV2Param} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<WebhookPlatformModel.SubscriberConfigResult>} - Success response
+     * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
+     *   Success response
      * @name updateSubscriberV2
      * @summary: Update Subscriber.
      * @description: Update Subscriber.
      *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberV2/).
      */
-    updateSubscriberV2({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberV2Param, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResult>;
-    /**
-     * @param {WebhookPlatformValidator.UpsertSubscriberEventParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<WebhookPlatformModel.UpsertSubscriberConfigResult>} -
-     *   Success response
-     * @name upsertSubscriberEvent
-     * @summary: Register Subscriber.
-     * @description: Register Subscriber.
-     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/upsertSubscriberEvent/).
-     */
-    upsertSubscriberEvent({ body, requestHeaders }?: WebhookPlatformValidator.UpsertSubscriberEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.UpsertSubscriberConfigResult>;
+    updateSubscriberV2({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberV2Param, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
 }
-import WebhookPlatformModel = require("./WebhookPlatformModel");
 import WebhookPlatformValidator = require("./WebhookPlatformValidator");
+import WebhookPlatformModel = require("./WebhookPlatformModel");