@gofynd/fdk-client-javascript 1.4.2-beta.1 → 1.4.2-beta.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +3 -2
- package/sdk/application/ApplicationClient.js +20 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +1 -1
- package/sdk/application/Cart/CartApplicationClient.js +3 -5
- package/sdk/application/Cart/CartApplicationModel.d.ts +1634 -1742
- package/sdk/application/Cart/CartApplicationModel.js +1388 -1464
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -4
- package/sdk/application/Cart/CartApplicationValidator.js +0 -4
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +6 -3
- package/sdk/application/Catalog/CatalogApplicationClient.js +20 -7
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
- package/sdk/application/Catalog/CatalogApplicationModel.js +1613 -1613
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +14 -0
- package/sdk/application/Catalog/CatalogApplicationValidator.js +6 -0
- package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
- package/sdk/application/Common/CommonApplicationModel.js +172 -172
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
- package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1492 -1626
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1038 -1180
- package/sdk/application/Content/ContentApplicationClient.d.ts +0 -36
- package/sdk/application/Content/ContentApplicationClient.js +0 -246
- package/sdk/application/Content/ContentApplicationModel.d.ts +546 -753
- package/sdk/application/Content/ContentApplicationModel.js +565 -817
- package/sdk/application/Content/ContentApplicationValidator.d.ts +1 -40
- package/sdk/application/Content/ContentApplicationValidator.js +0 -41
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
- package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
- package/sdk/application/Lead/LeadApplicationModel.js +301 -301
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +0 -67
- package/sdk/application/Logistic/LogisticApplicationClient.js +0 -547
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +257 -712
- package/sdk/application/Logistic/LogisticApplicationModel.js +267 -755
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -211
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -131
- package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
- package/sdk/application/Order/OrderApplicationClient.js +8 -32
- package/sdk/application/Order/OrderApplicationModel.d.ts +845 -853
- package/sdk/application/Order/OrderApplicationModel.js +816 -824
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -20
- package/sdk/application/Order/OrderApplicationValidator.js +0 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +2 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +10 -341
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +1892 -2199
- package/sdk/application/Payment/PaymentApplicationModel.js +1235 -1506
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +14 -59
- package/sdk/application/Payment/PaymentApplicationValidator.js +10 -64
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1396 -1429
- package/sdk/application/PosCart/PosCartApplicationModel.js +1233 -1257
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
- package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
- package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
- package/sdk/application/Share/ShareApplicationModel.js +121 -121
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.js +3 -7
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +783 -969
- package/sdk/application/Theme/ThemeApplicationModel.js +571 -867
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -10
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -4
- package/sdk/application/User/UserApplicationClient.d.ts +0 -33
- package/sdk/application/User/UserApplicationClient.js +0 -239
- package/sdk/application/User/UserApplicationModel.d.ts +753 -768
- package/sdk/application/User/UserApplicationModel.js +731 -755
- package/sdk/application/User/UserApplicationValidator.d.ts +1 -34
- package/sdk/application/User/UserApplicationValidator.js +0 -36
- package/sdk/common/Clickstream.d.ts +1 -0
- package/sdk/common/Clickstream.js +254 -0
- package/sdk/common/Utility.js +1 -4
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +72 -60
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +70 -58
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +0 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +0 -80
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1178 -1153
- package/sdk/partner/Theme/ThemePartnerModel.js +830 -974
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +0 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +0 -9
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +1 -11
- package/sdk/platform/Billing/BillingPlatformClient.js +3 -110
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +734 -800
- package/sdk/platform/Billing/BillingPlatformModel.js +732 -810
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +4 -43
- package/sdk/platform/Billing/BillingPlatformValidator.js +2 -29
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +11 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +81 -7
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +13 -5
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +12 -4
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3223 -3328
- package/sdk/platform/Cart/CartPlatformModel.js +2875 -2946
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +11 -15
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +21 -52
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +0 -27
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +0 -11
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +15 -27
- package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -189
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +617 -920
- package/sdk/platform/Catalog/CatalogPlatformModel.js +584 -919
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +27 -41
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +19 -31
- package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
- package/sdk/platform/Common/CommonPlatformModel.js +187 -187
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +37 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +52 -737
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +3 -133
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +1 -113
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1079 -1228
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1090 -1262
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +2 -8
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +4 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +629 -658
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +641 -675
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +0 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +0 -6
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2992 -3231
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2092 -2303
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -391
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1074 -3656
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -351
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -410
- package/sdk/platform/Content/ContentPlatformModel.d.ts +972 -2071
- package/sdk/platform/Content/ContentPlatformModel.js +1039 -2355
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +174 -259
- package/sdk/platform/Discount/DiscountPlatformModel.js +163 -257
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +6 -16
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +8 -117
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -55
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -39
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +821 -892
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +833 -901
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -33
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -240
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +910 -1056
- package/sdk/platform/Finance/FinancePlatformModel.js +884 -1070
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -38
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -38
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
- package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +28 -38
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +56 -137
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +29 -41
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +21 -33
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +601 -610
- package/sdk/platform/Lead/LeadPlatformModel.js +457 -471
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +1 -11
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +1 -93
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
- package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -143
- package/sdk/platform/Order/OrderPlatformClient.js +160 -1190
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4451 -5275
- package/sdk/platform/Order/OrderPlatformModel.js +4039 -4994
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +21 -257
- package/sdk/platform/Order/OrderPlatformValidator.js +15 -216
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
- package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +13 -119
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +40 -750
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -143
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +6 -133
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2067 -2929
- package/sdk/platform/Payment/PaymentPlatformModel.js +1427 -2090
- package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/PlatformApplicationClient.js +4 -4
- package/sdk/platform/PlatformClient.d.ts +2 -4
- package/sdk/platform/PlatformClient.js +4 -8
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
- package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +66 -142
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +147 -645
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +63 -131
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +47 -126
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +105 -217
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +349 -1138
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +989 -1588
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +977 -1695
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +133 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +102 -266
- package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
- package/sdk/platform/Share/SharePlatformModel.js +139 -139
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +1 -11
- package/sdk/platform/Theme/ThemePlatformClient.js +3 -87
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +765 -1133
- package/sdk/platform/Theme/ThemePlatformModel.js +561 -1009
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +4 -28
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -21
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +1 -116
- package/sdk/platform/User/UserPlatformApplicationClient.js +86 -932
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -224
- package/sdk/platform/User/UserPlatformApplicationValidator.js +5 -173
- package/sdk/platform/User/UserPlatformModel.d.ts +428 -765
- package/sdk/platform/User/UserPlatformModel.js +428 -679
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +37 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +57 -61
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +403 -448
- package/sdk/platform/Webhook/WebhookPlatformModel.js +309 -369
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
- package/sdk/platform/index.d.ts +1 -1
- package/sdk/platform/index.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
- package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
- package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
- package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
- package/sdk/public/Partner/PartnerPublicModel.js +113 -113
- package/sdk/public/PublicClient.d.ts +0 -4
- package/sdk/public/PublicClient.js +0 -8
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +0 -33
- package/sdk/public/Webhook/WebhookPublicClient.js +0 -242
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +15 -161
- package/sdk/public/Webhook/WebhookPublicModel.js +13 -189
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -23
- package/sdk/public/Webhook/WebhookPublicValidator.js +0 -31
- package/sdk/public/index.d.ts +0 -2
- package/sdk/public/index.js +0 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +0 -125
- package/sdk/partner/Lead/LeadPartnerClient.js +0 -785
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +0 -1127
- package/sdk/partner/Lead/LeadPartnerModel.js +0 -896
- package/sdk/partner/Lead/LeadPartnerValidator.d.ts +0 -12
- package/sdk/partner/Lead/LeadPartnerValidator.js +0 -67
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +0 -155
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +0 -1195
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +0 -372
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +0 -442
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -16
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +0 -123
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +0 -99
- package/sdk/partner/Webhook/WebhookPartnerClient.js +0 -753
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +0 -566
- package/sdk/partner/Webhook/WebhookPartnerModel.js +0 -583
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -12
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +0 -74
- package/sdk/platform/Content/ContentPlatformClient.d.ts +0 -277
- package/sdk/platform/Content/ContentPlatformClient.js +0 -2011
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +0 -247
- package/sdk/platform/Content/ContentPlatformValidator.js +0 -319
- package/sdk/public/Billing/BillingPublicClient.d.ts +0 -23
- package/sdk/public/Billing/BillingPublicClient.js +0 -116
- package/sdk/public/Billing/BillingPublicModel.d.ts +0 -92
- package/sdk/public/Billing/BillingPublicModel.js +0 -96
- package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -18
- package/sdk/public/Billing/BillingPublicValidator.js +0 -19
- package/sdk/public/Content/ContentPublicClient.d.ts +0 -22
- package/sdk/public/Content/ContentPublicClient.js +0 -114
- package/sdk/public/Content/ContentPublicModel.d.ts +0 -53
- package/sdk/public/Content/ContentPublicModel.js +0 -60
- package/sdk/public/Content/ContentPublicValidator.d.ts +0 -18
- package/sdk/public/Content/ContentPublicValidator.js +0 -19
|
@@ -8,31 +8,28 @@ declare class Webhook {
|
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
9
|
* @returns {Promise<WebhookPlatformModel.CancelResponse>} - Success response
|
|
10
10
|
* @name cancelJobByName
|
|
11
|
-
* @summary: Cancel a report export
|
|
12
|
-
* @description: Cancel the export of a specific report for a company.
|
|
13
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
|
|
11
|
+
* @summary: Cancel a report export
|
|
12
|
+
* @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/).
|
|
14
13
|
*/
|
|
15
14
|
cancelJobByName({ filename, requestHeaders }?: WebhookPlatformValidator.CancelJobByNameParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.CancelResponse>;
|
|
16
15
|
/**
|
|
17
16
|
* @param {WebhookPlatformValidator.DownloadDeliveryReportParam} arg - Arg object
|
|
18
17
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
19
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
|
-
* @returns {Promise<
|
|
19
|
+
* @returns {Promise<Object>} - Success response
|
|
21
20
|
* @name downloadDeliveryReport
|
|
22
|
-
* @summary: Download processed events report for a company
|
|
23
|
-
* @description: Download reports for a specific company based on the provided filters.
|
|
24
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/downloadDeliveryReport/).
|
|
21
|
+
* @summary: Download processed events report for a company
|
|
22
|
+
* @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/).
|
|
25
23
|
*/
|
|
26
|
-
downloadDeliveryReport({ body, requestHeaders }?: WebhookPlatformValidator.DownloadDeliveryReportParam, { responseHeaders }?: object): Promise<
|
|
24
|
+
downloadDeliveryReport({ body, requestHeaders }?: WebhookPlatformValidator.DownloadDeliveryReportParam, { responseHeaders }?: object): Promise<any>;
|
|
27
25
|
/**
|
|
28
26
|
* @param {WebhookPlatformValidator.FetchAllEventConfigurationsParam} arg - Arg object
|
|
29
27
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
30
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
31
29
|
* @returns {Promise<WebhookPlatformModel.EventConfigResponse>} - Success response
|
|
32
30
|
* @name fetchAllEventConfigurations
|
|
33
|
-
* @summary:
|
|
34
|
-
* @description:
|
|
35
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
|
|
31
|
+
* @summary:
|
|
32
|
+
* @description: Get All Webhook Events - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
|
|
36
33
|
*/
|
|
37
34
|
fetchAllEventConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventConfigResponse>;
|
|
38
35
|
/**
|
|
@@ -41,31 +38,31 @@ declare class Webhook {
|
|
|
41
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
42
39
|
* @returns {Promise<WebhookPlatformModel.EventProcessReports>} - Success response
|
|
43
40
|
* @name getDeliveryReports
|
|
44
|
-
* @summary: Get processed events report for a company
|
|
45
|
-
* @description: Retrieve a list of processed events for a specific company based on the provided filters.
|
|
46
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getDeliveryReports/).
|
|
41
|
+
* @summary: Get processed events report for a company
|
|
42
|
+
* @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/).
|
|
47
43
|
*/
|
|
48
44
|
getDeliveryReports({ body, requestHeaders }?: WebhookPlatformValidator.GetDeliveryReportsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventProcessReports>;
|
|
49
45
|
/**
|
|
50
46
|
* @param {WebhookPlatformValidator.GetEventCountsParam} arg - Arg object
|
|
51
47
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
52
48
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
53
|
-
* @returns {Promise<WebhookPlatformModel.
|
|
49
|
+
* @returns {Promise<WebhookPlatformModel.FailedEventsCountSuccessResponse>}
|
|
50
|
+
* - Success response
|
|
51
|
+
*
|
|
54
52
|
* @name getEventCounts
|
|
55
53
|
* @summary: Get the count of failed events for a company within a specified date range.
|
|
56
54
|
* @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.
|
|
57
55
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getEventCounts/).
|
|
58
56
|
*/
|
|
59
|
-
getEventCounts({ body, requestHeaders }?: WebhookPlatformValidator.GetEventCountsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.
|
|
57
|
+
getEventCounts({ body, requestHeaders }?: WebhookPlatformValidator.GetEventCountsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.FailedEventsCountSuccessResponse>;
|
|
60
58
|
/**
|
|
61
59
|
* @param {WebhookPlatformValidator.GetHistoricalReportsParam} arg - Arg object
|
|
62
60
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
63
61
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
64
62
|
* @returns {Promise<WebhookPlatformModel.HistoryResponse>} - Success response
|
|
65
63
|
* @name getHistoricalReports
|
|
66
|
-
* @summary: Get report download history
|
|
67
|
-
* @description: Retrieve history reports for a specific company based on the provided filters.
|
|
68
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getHistoricalReports/).
|
|
64
|
+
* @summary: Get report download history
|
|
65
|
+
* @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/).
|
|
69
66
|
*/
|
|
70
67
|
getHistoricalReports({ body, requestHeaders }?: WebhookPlatformValidator.GetHistoricalReportsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.HistoryResponse>;
|
|
71
68
|
/**
|
|
@@ -83,13 +80,12 @@ declare class Webhook {
|
|
|
83
80
|
* @param {WebhookPlatformValidator.GetReportFiltersParam} arg - Arg object
|
|
84
81
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
85
82
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
86
|
-
* @returns {Promise<WebhookPlatformModel.ReportFilterResponse
|
|
83
|
+
* @returns {Promise<WebhookPlatformModel.ReportFilterResponse>} - Success response
|
|
87
84
|
* @name getReportFilters
|
|
88
|
-
* @summary: Get filters for a company
|
|
89
|
-
* @description: Retrieve filters for a specific company based on the provided subscriber IDs.
|
|
90
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getReportFilters/).
|
|
85
|
+
* @summary: Get filters for a company
|
|
86
|
+
* @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/).
|
|
91
87
|
*/
|
|
92
|
-
getReportFilters({ body, requestHeaders }?: WebhookPlatformValidator.GetReportFiltersParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.ReportFilterResponse
|
|
88
|
+
getReportFilters({ body, requestHeaders }?: WebhookPlatformValidator.GetReportFiltersParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.ReportFilterResponse>;
|
|
93
89
|
/**
|
|
94
90
|
* @param {WebhookPlatformValidator.GetSubscriberByIdParam} arg - Arg object
|
|
95
91
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -104,13 +100,12 @@ declare class Webhook {
|
|
|
104
100
|
* @param {WebhookPlatformValidator.GetSubscribersByCompanyParam} arg - Arg object
|
|
105
101
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
106
102
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
107
|
-
* @returns {Promise<WebhookPlatformModel.
|
|
103
|
+
* @returns {Promise<WebhookPlatformModel.SubscriberResponse>} - Success response
|
|
108
104
|
* @name getSubscribersByCompany
|
|
109
|
-
* @summary: Get Subscribers By
|
|
110
|
-
* @description: Get Subscribers By
|
|
111
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
|
|
105
|
+
* @summary: Get Subscribers By Company ID
|
|
106
|
+
* @description: Get Subscribers By CompanyId - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
|
|
112
107
|
*/
|
|
113
|
-
getSubscribersByCompany({ pageNo, pageSize, extensionId, requestHeaders }?: WebhookPlatformValidator.GetSubscribersByCompanyParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.
|
|
108
|
+
getSubscribersByCompany({ pageNo, pageSize, extensionId, requestHeaders }?: WebhookPlatformValidator.GetSubscribersByCompanyParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberResponse>;
|
|
114
109
|
/**
|
|
115
110
|
* @param {WebhookPlatformValidator.GetSubscribersByExtensionIdParam} arg - Arg object
|
|
116
111
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -125,58 +120,55 @@ declare class Webhook {
|
|
|
125
120
|
* @param {WebhookPlatformValidator.ManualRetryCancelParam} arg - Arg object
|
|
126
121
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
127
122
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
128
|
-
* @returns {Promise<
|
|
123
|
+
* @returns {Promise<WebhookPlatformModel.EventSuccessResponse>} - Success response
|
|
129
124
|
* @name manualRetryCancel
|
|
130
125
|
* @summary: Cancel the active manual retry for a company's failed events.
|
|
131
126
|
* @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.
|
|
132
127
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryCancel/).
|
|
133
128
|
*/
|
|
134
|
-
manualRetryCancel({ requestHeaders }?: any, { responseHeaders }?: object): Promise<
|
|
129
|
+
manualRetryCancel({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventSuccessResponse>;
|
|
135
130
|
/**
|
|
136
131
|
* @param {WebhookPlatformValidator.ManualRetryOfFailedEventParam} arg - Arg object
|
|
137
132
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
138
133
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
139
|
-
* @returns {Promise<WebhookPlatformModel.
|
|
134
|
+
* @returns {Promise<WebhookPlatformModel.EventProcessedSuccessResponse>} -
|
|
135
|
+
* Success response
|
|
140
136
|
* @name manualRetryOfFailedEvent
|
|
141
137
|
* @summary: Initiate a manual retry for event processing.
|
|
142
138
|
* @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.
|
|
143
139
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryOfFailedEvent/).
|
|
144
140
|
*/
|
|
145
|
-
manualRetryOfFailedEvent({ body, requestHeaders }?: WebhookPlatformValidator.ManualRetryOfFailedEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.
|
|
141
|
+
manualRetryOfFailedEvent({ body, requestHeaders }?: WebhookPlatformValidator.ManualRetryOfFailedEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventProcessedSuccessResponse>;
|
|
146
142
|
/**
|
|
147
143
|
* @param {WebhookPlatformValidator.PingWebhookParam} arg - Arg object
|
|
148
144
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
149
145
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
150
146
|
* @returns {Promise<WebhookPlatformModel.PingWebhookResponse>} - Success response
|
|
151
147
|
* @name pingWebhook
|
|
152
|
-
* @summary: Ping and validate webhook url
|
|
153
|
-
* @description: Ping and validate webhook url.
|
|
154
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
|
|
148
|
+
* @summary: Ping and validate webhook url
|
|
149
|
+
* @description: Ping and validate webhook url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
|
|
155
150
|
*/
|
|
156
151
|
pingWebhook({ body, requestHeaders }?: WebhookPlatformValidator.PingWebhookParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.PingWebhookResponse>;
|
|
157
152
|
/**
|
|
158
153
|
* @param {WebhookPlatformValidator.RegisterSubscriberToEventParam} arg - Arg object
|
|
159
154
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
160
155
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
161
|
-
* @returns {Promise<WebhookPlatformModel.
|
|
162
|
-
* Success response
|
|
156
|
+
* @returns {Promise<WebhookPlatformModel.SubscriberConfig>} - Success response
|
|
163
157
|
* @name registerSubscriberToEvent
|
|
164
|
-
* @summary: Register Subscriber
|
|
165
|
-
* @description: Register Subscriber.
|
|
166
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEvent/).
|
|
158
|
+
* @summary: Register Subscriber
|
|
159
|
+
* @description: Register Subscriber - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEvent/).
|
|
167
160
|
*/
|
|
168
|
-
registerSubscriberToEvent({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.
|
|
161
|
+
registerSubscriberToEvent({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfig>;
|
|
169
162
|
/**
|
|
170
163
|
* @param {WebhookPlatformValidator.UpdateSubscriberConfigParam} arg - Arg object
|
|
171
164
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
172
165
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
173
|
-
* @returns {Promise<WebhookPlatformModel.
|
|
174
|
-
* Success response
|
|
166
|
+
* @returns {Promise<WebhookPlatformModel.SubscriberConfig>} - Success response
|
|
175
167
|
* @name updateSubscriberConfig
|
|
176
168
|
* @summary: Update Subscriber
|
|
177
169
|
* @description: Update Subscriber - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
|
|
178
170
|
*/
|
|
179
|
-
updateSubscriberConfig({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberConfigParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.
|
|
171
|
+
updateSubscriberConfig({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberConfigParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfig>;
|
|
180
172
|
}
|
|
181
173
|
import WebhookPlatformValidator = require("./WebhookPlatformValidator");
|
|
182
174
|
import WebhookPlatformModel = require("./WebhookPlatformModel");
|
|
@@ -20,9 +20,8 @@ class Webhook {
|
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<WebhookPlatformModel.CancelResponse>} - Success response
|
|
22
22
|
* @name cancelJobByName
|
|
23
|
-
* @summary: Cancel a report export
|
|
24
|
-
* @description: Cancel the export of a specific report for a company.
|
|
25
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
|
|
23
|
+
* @summary: Cancel a report export
|
|
24
|
+
* @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/).
|
|
26
25
|
*/
|
|
27
26
|
async cancelJobByName(
|
|
28
27
|
{ filename, requestHeaders } = { requestHeaders: {} },
|
|
@@ -98,11 +97,10 @@ class Webhook {
|
|
|
98
97
|
* @param {WebhookPlatformValidator.DownloadDeliveryReportParam} arg - Arg object
|
|
99
98
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
100
99
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
101
|
-
* @returns {Promise<
|
|
100
|
+
* @returns {Promise<Object>} - Success response
|
|
102
101
|
* @name downloadDeliveryReport
|
|
103
|
-
* @summary: Download processed events report for a company
|
|
104
|
-
* @description: Download reports for a specific company based on the provided filters.
|
|
105
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/downloadDeliveryReport/).
|
|
102
|
+
* @summary: Download processed events report for a company
|
|
103
|
+
* @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/).
|
|
106
104
|
*/
|
|
107
105
|
async downloadDeliveryReport(
|
|
108
106
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -155,9 +153,7 @@ class Webhook {
|
|
|
155
153
|
responseData = response[0];
|
|
156
154
|
}
|
|
157
155
|
|
|
158
|
-
const {
|
|
159
|
-
error: res_error,
|
|
160
|
-
} = WebhookPlatformModel.DownloadReportResponse().validate(responseData, {
|
|
156
|
+
const { error: res_error } = Joi.any().validate(responseData, {
|
|
161
157
|
abortEarly: false,
|
|
162
158
|
allowUnknown: true,
|
|
163
159
|
});
|
|
@@ -182,9 +178,8 @@ class Webhook {
|
|
|
182
178
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
183
179
|
* @returns {Promise<WebhookPlatformModel.EventConfigResponse>} - Success response
|
|
184
180
|
* @name fetchAllEventConfigurations
|
|
185
|
-
* @summary:
|
|
186
|
-
* @description:
|
|
187
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
|
|
181
|
+
* @summary:
|
|
182
|
+
* @description: Get All Webhook Events - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
|
|
188
183
|
*/
|
|
189
184
|
async fetchAllEventConfigurations(
|
|
190
185
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -260,9 +255,8 @@ class Webhook {
|
|
|
260
255
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
261
256
|
* @returns {Promise<WebhookPlatformModel.EventProcessReports>} - Success response
|
|
262
257
|
* @name getDeliveryReports
|
|
263
|
-
* @summary: Get processed events report for a company
|
|
264
|
-
* @description: Retrieve a list of processed events for a specific company based on the provided filters.
|
|
265
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getDeliveryReports/).
|
|
258
|
+
* @summary: Get processed events report for a company
|
|
259
|
+
* @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/).
|
|
266
260
|
*/
|
|
267
261
|
async getDeliveryReports(
|
|
268
262
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -338,7 +332,9 @@ class Webhook {
|
|
|
338
332
|
* @param {WebhookPlatformValidator.GetEventCountsParam} arg - Arg object
|
|
339
333
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
340
334
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
341
|
-
* @returns {Promise<WebhookPlatformModel.
|
|
335
|
+
* @returns {Promise<WebhookPlatformModel.FailedEventsCountSuccessResponse>}
|
|
336
|
+
* - Success response
|
|
337
|
+
*
|
|
342
338
|
* @name getEventCounts
|
|
343
339
|
* @summary: Get the count of failed events for a company within a specified date range.
|
|
344
340
|
* @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.
|
|
@@ -395,10 +391,10 @@ class Webhook {
|
|
|
395
391
|
|
|
396
392
|
const {
|
|
397
393
|
error: res_error,
|
|
398
|
-
} = WebhookPlatformModel.
|
|
399
|
-
|
|
400
|
-
allowUnknown: true
|
|
401
|
-
|
|
394
|
+
} = WebhookPlatformModel.FailedEventsCountSuccessResponse().validate(
|
|
395
|
+
responseData,
|
|
396
|
+
{ abortEarly: false, allowUnknown: true }
|
|
397
|
+
);
|
|
402
398
|
|
|
403
399
|
if (res_error) {
|
|
404
400
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -420,9 +416,8 @@ class Webhook {
|
|
|
420
416
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
421
417
|
* @returns {Promise<WebhookPlatformModel.HistoryResponse>} - Success response
|
|
422
418
|
* @name getHistoricalReports
|
|
423
|
-
* @summary: Get report download history
|
|
424
|
-
* @description: Retrieve history reports for a specific company based on the provided filters.
|
|
425
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getHistoricalReports/).
|
|
419
|
+
* @summary: Get report download history
|
|
420
|
+
* @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/).
|
|
426
421
|
*/
|
|
427
422
|
async getHistoricalReports(
|
|
428
423
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -574,11 +569,10 @@ class Webhook {
|
|
|
574
569
|
* @param {WebhookPlatformValidator.GetReportFiltersParam} arg - Arg object
|
|
575
570
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
576
571
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
577
|
-
* @returns {Promise<WebhookPlatformModel.ReportFilterResponse
|
|
572
|
+
* @returns {Promise<WebhookPlatformModel.ReportFilterResponse>} - Success response
|
|
578
573
|
* @name getReportFilters
|
|
579
|
-
* @summary: Get filters for a company
|
|
580
|
-
* @description: Retrieve filters for a specific company based on the provided subscriber IDs.
|
|
581
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getReportFilters/).
|
|
574
|
+
* @summary: Get filters for a company
|
|
575
|
+
* @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/).
|
|
582
576
|
*/
|
|
583
577
|
async getReportFilters(
|
|
584
578
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -629,9 +623,12 @@ class Webhook {
|
|
|
629
623
|
responseData = response[0];
|
|
630
624
|
}
|
|
631
625
|
|
|
632
|
-
const {
|
|
633
|
-
|
|
634
|
-
|
|
626
|
+
const {
|
|
627
|
+
error: res_error,
|
|
628
|
+
} = WebhookPlatformModel.ReportFilterResponse().validate(responseData, {
|
|
629
|
+
abortEarly: false,
|
|
630
|
+
allowUnknown: true,
|
|
631
|
+
});
|
|
635
632
|
|
|
636
633
|
if (res_error) {
|
|
637
634
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -730,11 +727,10 @@ class Webhook {
|
|
|
730
727
|
* @param {WebhookPlatformValidator.GetSubscribersByCompanyParam} arg - Arg object
|
|
731
728
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
732
729
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
733
|
-
* @returns {Promise<WebhookPlatformModel.
|
|
730
|
+
* @returns {Promise<WebhookPlatformModel.SubscriberResponse>} - Success response
|
|
734
731
|
* @name getSubscribersByCompany
|
|
735
|
-
* @summary: Get Subscribers By
|
|
736
|
-
* @description: Get Subscribers By
|
|
737
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
|
|
732
|
+
* @summary: Get Subscribers By Company ID
|
|
733
|
+
* @description: Get Subscribers By CompanyId - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
|
|
738
734
|
*/
|
|
739
735
|
async getSubscribersByCompany(
|
|
740
736
|
{ pageNo, pageSize, extensionId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -782,7 +778,7 @@ class Webhook {
|
|
|
782
778
|
const response = await PlatformAPIClient.execute(
|
|
783
779
|
this.config,
|
|
784
780
|
"get",
|
|
785
|
-
`/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber
|
|
781
|
+
`/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber`,
|
|
786
782
|
query_params,
|
|
787
783
|
undefined,
|
|
788
784
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -796,7 +792,7 @@ class Webhook {
|
|
|
796
792
|
|
|
797
793
|
const {
|
|
798
794
|
error: res_error,
|
|
799
|
-
} = WebhookPlatformModel.
|
|
795
|
+
} = WebhookPlatformModel.SubscriberResponse().validate(responseData, {
|
|
800
796
|
abortEarly: false,
|
|
801
797
|
allowUnknown: true,
|
|
802
798
|
});
|
|
@@ -869,7 +865,7 @@ class Webhook {
|
|
|
869
865
|
const response = await PlatformAPIClient.execute(
|
|
870
866
|
this.config,
|
|
871
867
|
"get",
|
|
872
|
-
`/service/platform/webhook/v1.0/company/${this.config.companyId}/extension/${extensionId}/subscriber
|
|
868
|
+
`/service/platform/webhook/v1.0/company/${this.config.companyId}/extension/${extensionId}/subscriber`,
|
|
873
869
|
query_params,
|
|
874
870
|
undefined,
|
|
875
871
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -906,7 +902,7 @@ class Webhook {
|
|
|
906
902
|
* @param {WebhookPlatformValidator.ManualRetryCancelParam} arg - Arg object
|
|
907
903
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
908
904
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
909
|
-
* @returns {Promise<
|
|
905
|
+
* @returns {Promise<WebhookPlatformModel.EventSuccessResponse>} - Success response
|
|
910
906
|
* @name manualRetryCancel
|
|
911
907
|
* @summary: Cancel the active manual retry for a company's failed events.
|
|
912
908
|
* @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.
|
|
@@ -957,9 +953,12 @@ class Webhook {
|
|
|
957
953
|
responseData = response[0];
|
|
958
954
|
}
|
|
959
955
|
|
|
960
|
-
const {
|
|
961
|
-
|
|
962
|
-
|
|
956
|
+
const {
|
|
957
|
+
error: res_error,
|
|
958
|
+
} = WebhookPlatformModel.EventSuccessResponse().validate(responseData, {
|
|
959
|
+
abortEarly: false,
|
|
960
|
+
allowUnknown: true,
|
|
961
|
+
});
|
|
963
962
|
|
|
964
963
|
if (res_error) {
|
|
965
964
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -979,7 +978,8 @@ class Webhook {
|
|
|
979
978
|
* @param {WebhookPlatformValidator.ManualRetryOfFailedEventParam} arg - Arg object
|
|
980
979
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
981
980
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
982
|
-
* @returns {Promise<WebhookPlatformModel.
|
|
981
|
+
* @returns {Promise<WebhookPlatformModel.EventProcessedSuccessResponse>} -
|
|
982
|
+
* Success response
|
|
983
983
|
* @name manualRetryOfFailedEvent
|
|
984
984
|
* @summary: Initiate a manual retry for event processing.
|
|
985
985
|
* @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 +1038,10 @@ class Webhook {
|
|
|
1038
1038
|
|
|
1039
1039
|
const {
|
|
1040
1040
|
error: res_error,
|
|
1041
|
-
} = WebhookPlatformModel.
|
|
1042
|
-
|
|
1043
|
-
allowUnknown: true
|
|
1044
|
-
|
|
1041
|
+
} = WebhookPlatformModel.EventProcessedSuccessResponse().validate(
|
|
1042
|
+
responseData,
|
|
1043
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1044
|
+
);
|
|
1045
1045
|
|
|
1046
1046
|
if (res_error) {
|
|
1047
1047
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1063,9 +1063,8 @@ class Webhook {
|
|
|
1063
1063
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1064
1064
|
* @returns {Promise<WebhookPlatformModel.PingWebhookResponse>} - Success response
|
|
1065
1065
|
* @name pingWebhook
|
|
1066
|
-
* @summary: Ping and validate webhook url
|
|
1067
|
-
* @description: Ping and validate webhook url.
|
|
1068
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
|
|
1066
|
+
* @summary: Ping and validate webhook url
|
|
1067
|
+
* @description: Ping and validate webhook url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
|
|
1069
1068
|
*/
|
|
1070
1069
|
async pingWebhook(
|
|
1071
1070
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1139,12 +1138,10 @@ class Webhook {
|
|
|
1139
1138
|
* @param {WebhookPlatformValidator.RegisterSubscriberToEventParam} arg - Arg object
|
|
1140
1139
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1141
1140
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1142
|
-
* @returns {Promise<WebhookPlatformModel.
|
|
1143
|
-
* Success response
|
|
1141
|
+
* @returns {Promise<WebhookPlatformModel.SubscriberConfig>} - Success response
|
|
1144
1142
|
* @name registerSubscriberToEvent
|
|
1145
|
-
* @summary: Register Subscriber
|
|
1146
|
-
* @description: Register Subscriber.
|
|
1147
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEvent/).
|
|
1143
|
+
* @summary: Register Subscriber
|
|
1144
|
+
* @description: Register Subscriber - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEvent/).
|
|
1148
1145
|
*/
|
|
1149
1146
|
async registerSubscriberToEvent(
|
|
1150
1147
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1185,7 +1182,7 @@ class Webhook {
|
|
|
1185
1182
|
const response = await PlatformAPIClient.execute(
|
|
1186
1183
|
this.config,
|
|
1187
1184
|
"post",
|
|
1188
|
-
`/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber
|
|
1185
|
+
`/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber`,
|
|
1189
1186
|
query_params,
|
|
1190
1187
|
body,
|
|
1191
1188
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -1199,7 +1196,7 @@ class Webhook {
|
|
|
1199
1196
|
|
|
1200
1197
|
const {
|
|
1201
1198
|
error: res_error,
|
|
1202
|
-
} = WebhookPlatformModel.
|
|
1199
|
+
} = WebhookPlatformModel.SubscriberConfig().validate(responseData, {
|
|
1203
1200
|
abortEarly: false,
|
|
1204
1201
|
allowUnknown: true,
|
|
1205
1202
|
});
|
|
@@ -1222,8 +1219,7 @@ class Webhook {
|
|
|
1222
1219
|
* @param {WebhookPlatformValidator.UpdateSubscriberConfigParam} arg - Arg object
|
|
1223
1220
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1224
1221
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1225
|
-
* @returns {Promise<WebhookPlatformModel.
|
|
1226
|
-
* Success response
|
|
1222
|
+
* @returns {Promise<WebhookPlatformModel.SubscriberConfig>} - Success response
|
|
1227
1223
|
* @name updateSubscriberConfig
|
|
1228
1224
|
* @summary: Update Subscriber
|
|
1229
1225
|
* @description: Update Subscriber - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
|
|
@@ -1267,7 +1263,7 @@ class Webhook {
|
|
|
1267
1263
|
const response = await PlatformAPIClient.execute(
|
|
1268
1264
|
this.config,
|
|
1269
1265
|
"put",
|
|
1270
|
-
`/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber
|
|
1266
|
+
`/service/platform/webhook/v1.0/company/${this.config.companyId}/subscriber`,
|
|
1271
1267
|
query_params,
|
|
1272
1268
|
body,
|
|
1273
1269
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -1281,7 +1277,7 @@ class Webhook {
|
|
|
1281
1277
|
|
|
1282
1278
|
const {
|
|
1283
1279
|
error: res_error,
|
|
1284
|
-
} = WebhookPlatformModel.
|
|
1280
|
+
} = WebhookPlatformModel.SubscriberConfig().validate(responseData, {
|
|
1285
1281
|
abortEarly: false,
|
|
1286
1282
|
allowUnknown: true,
|
|
1287
1283
|
});
|