@gofynd/fdk-client-javascript 1.4.2-beta.6 → 1.4.3
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 +5 -3
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationAPIClient.js +0 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +25 -25
- package/sdk/application/Cart/CartApplicationClient.js +25 -25
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +40 -40
- package/sdk/application/Catalog/CatalogApplicationClient.js +40 -40
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +10 -10
- package/sdk/application/Content/ContentApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
- package/sdk/application/Content/ContentApplicationModel.js +26 -26
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +12 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +7 -7
- package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
- package/sdk/application/Lead/LeadApplicationModel.js +42 -52
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +13 -13
- package/sdk/application/Order/OrderApplicationClient.js +16 -12
- package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -0
- package/sdk/application/Order/OrderApplicationValidator.js +3 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +47 -47
- package/sdk/application/Payment/PaymentApplicationClient.js +52 -52
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +27 -27
- package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationClient.js +6 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
- package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
- package/sdk/application/User/UserApplicationClient.d.ts +28 -28
- package/sdk/application/User/UserApplicationClient.js +28 -28
- package/sdk/application/User/UserApplicationModel.d.ts +44 -13
- package/sdk/application/User/UserApplicationModel.js +17 -13
- package/sdk/common/AxiosHelper.d.ts +1 -1
- package/sdk/common/AxiosHelper.js +38 -17
- package/sdk/common/Clickstream.js +33 -19
- package/sdk/common/curlHelper.js +1 -3
- package/sdk/common/utils.d.ts +15 -0
- package/sdk/common/utils.js +30 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +2 -2
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +1 -1
- package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +4 -4
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
- package/sdk/partner/OAuthClient.d.ts +3 -3
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerAPIClient.js +0 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +19 -19
- package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
- package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +4 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +17 -17
- package/sdk/platform/Billing/BillingPlatformClient.js +17 -17
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +49 -49
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +49 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +60 -60
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +62 -62
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +87 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.js +87 -87
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
- package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +58 -58
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +58 -58
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +16 -16
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +18 -18
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +57 -57
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +63 -63
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +3 -3
- package/sdk/platform/Content/ContentPlatformClient.js +9 -9
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
- package/sdk/platform/Content/ContentPlatformModel.js +26 -26
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +23 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +27 -27
- package/sdk/platform/Finance/FinancePlatformClient.js +27 -27
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
- package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +2 -2
- package/sdk/platform/Order/OrderPlatformClient.d.ts +43 -43
- package/sdk/platform/Order/OrderPlatformClient.js +55 -44
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -2
- package/sdk/platform/Order/OrderPlatformModel.js +8 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +14 -0
- package/sdk/platform/Order/OrderPlatformValidator.js +6 -0
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +38 -38
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +38 -38
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.js +0 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +9 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +15 -15
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +28 -28
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +28 -28
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformClient.js +3 -3
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
- package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/User/UserPlatformApplicationClient.js +16 -16
- package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
- package/sdk/platform/User/UserPlatformModel.js +21 -13
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +16 -16
- package/sdk/platform/Webhook/WebhookPlatformClient.js +16 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +5 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -50
- package/sdk/public/Billing/BillingPublicClient.d.ts +1 -1
- package/sdk/public/Billing/BillingPublicClient.js +4 -4
- package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
- package/sdk/public/Billing/BillingPublicValidator.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
- package/sdk/public/Content/ContentPublicValidator.js +3 -3
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
- package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
|
@@ -242,6 +242,7 @@ const Joi = require("joi");
|
|
|
242
242
|
* @property {string} username
|
|
243
243
|
* @property {Object} [meta]
|
|
244
244
|
* @property {string} [external_id]
|
|
245
|
+
* @property {string} [rr_id]
|
|
245
246
|
*/
|
|
246
247
|
|
|
247
248
|
/**
|
|
@@ -445,6 +446,7 @@ const Joi = require("joi");
|
|
|
445
446
|
* @property {string} [last_name]
|
|
446
447
|
* @property {string} [gender]
|
|
447
448
|
* @property {string} [external_id]
|
|
449
|
+
* @property {string} [rr_id]
|
|
448
450
|
* @property {Object} [meta]
|
|
449
451
|
* @property {UserPhoneNumbers[]} [phone_numbers]
|
|
450
452
|
* @property {UserEmails[]} [emails]
|
|
@@ -486,6 +488,7 @@ const Joi = require("joi");
|
|
|
486
488
|
* @property {string} [created_at]
|
|
487
489
|
* @property {string} [updated_at]
|
|
488
490
|
* @property {string} [external_id]
|
|
491
|
+
* @property {string} [rr_id]
|
|
489
492
|
*/
|
|
490
493
|
|
|
491
494
|
/**
|
|
@@ -507,25 +510,26 @@ const Joi = require("joi");
|
|
|
507
510
|
* @property {string} [created_at]
|
|
508
511
|
* @property {string} [updated_at]
|
|
509
512
|
* @property {string} [external_id]
|
|
513
|
+
* @property {string} [rr_id]
|
|
510
514
|
* @property {boolean} [archive]
|
|
511
515
|
* @property {string} [status]
|
|
512
516
|
*/
|
|
513
517
|
|
|
514
518
|
/**
|
|
515
519
|
* @typedef PhoneNumber
|
|
516
|
-
* @property {
|
|
517
|
-
* @property {
|
|
518
|
-
* @property {boolean} [
|
|
519
|
-
* @property {
|
|
520
|
-
* @property {
|
|
520
|
+
* @property {string} [phone] - Phone number
|
|
521
|
+
* @property {number} [country_code] - Country code
|
|
522
|
+
* @property {boolean} [active] - Is the phone number active
|
|
523
|
+
* @property {boolean} [primary] - Is it a primary phone number
|
|
524
|
+
* @property {boolean} [verified] - Is the phone number verified
|
|
521
525
|
*/
|
|
522
526
|
|
|
523
527
|
/**
|
|
524
528
|
* @typedef Email
|
|
525
|
-
* @property {
|
|
526
|
-
* @property {boolean} [
|
|
527
|
-
* @property {
|
|
528
|
-
* @property {boolean} [
|
|
529
|
+
* @property {string} [email] - Email address
|
|
530
|
+
* @property {boolean} [active] - Is the email active
|
|
531
|
+
* @property {boolean} [primary] - Is it a primary email
|
|
532
|
+
* @property {boolean} [verified] - Is the email verified
|
|
529
533
|
*/
|
|
530
534
|
|
|
531
535
|
class UserPlatformModel {
|
|
@@ -827,6 +831,7 @@ class UserPlatformModel {
|
|
|
827
831
|
username: Joi.string().allow("").required(),
|
|
828
832
|
meta: Joi.any(),
|
|
829
833
|
external_id: Joi.string().allow(""),
|
|
834
|
+
rr_id: Joi.string().allow(""),
|
|
830
835
|
});
|
|
831
836
|
}
|
|
832
837
|
|
|
@@ -1078,6 +1083,7 @@ class UserPlatformModel {
|
|
|
1078
1083
|
last_name: Joi.string().allow(""),
|
|
1079
1084
|
gender: Joi.string().allow(""),
|
|
1080
1085
|
external_id: Joi.string().allow(""),
|
|
1086
|
+
rr_id: Joi.string().allow(""),
|
|
1081
1087
|
meta: Joi.any(),
|
|
1082
1088
|
phone_numbers: Joi.array().items(UserPlatformModel.UserPhoneNumbers()),
|
|
1083
1089
|
emails: Joi.array().items(UserPlatformModel.UserEmails()),
|
|
@@ -1125,6 +1131,7 @@ class UserPlatformModel {
|
|
|
1125
1131
|
created_at: Joi.string().allow(""),
|
|
1126
1132
|
updated_at: Joi.string().allow(""),
|
|
1127
1133
|
external_id: Joi.string().allow(""),
|
|
1134
|
+
rr_id: Joi.string().allow(""),
|
|
1128
1135
|
});
|
|
1129
1136
|
}
|
|
1130
1137
|
|
|
@@ -1148,6 +1155,7 @@ class UserPlatformModel {
|
|
|
1148
1155
|
created_at: Joi.string().allow(""),
|
|
1149
1156
|
updated_at: Joi.string().allow(""),
|
|
1150
1157
|
external_id: Joi.string().allow(""),
|
|
1158
|
+
rr_id: Joi.string().allow(""),
|
|
1151
1159
|
archive: Joi.boolean(),
|
|
1152
1160
|
status: Joi.string().allow(""),
|
|
1153
1161
|
});
|
|
@@ -1156,21 +1164,21 @@ class UserPlatformModel {
|
|
|
1156
1164
|
/** @returns {PhoneNumber} */
|
|
1157
1165
|
static PhoneNumber() {
|
|
1158
1166
|
return Joi.object({
|
|
1167
|
+
phone: Joi.string().allow(""),
|
|
1168
|
+
country_code: Joi.number(),
|
|
1159
1169
|
active: Joi.boolean(),
|
|
1160
1170
|
primary: Joi.boolean(),
|
|
1161
1171
|
verified: Joi.boolean(),
|
|
1162
|
-
phone: Joi.string().allow(""),
|
|
1163
|
-
country_code: Joi.number(),
|
|
1164
1172
|
});
|
|
1165
1173
|
}
|
|
1166
1174
|
|
|
1167
1175
|
/** @returns {Email} */
|
|
1168
1176
|
static Email() {
|
|
1169
1177
|
return Joi.object({
|
|
1170
|
-
primary: Joi.boolean(),
|
|
1171
|
-
verified: Joi.boolean(),
|
|
1172
1178
|
email: Joi.string().allow(""),
|
|
1173
1179
|
active: Joi.boolean(),
|
|
1180
|
+
primary: Joi.boolean(),
|
|
1181
|
+
verified: Joi.boolean(),
|
|
1174
1182
|
});
|
|
1175
1183
|
}
|
|
1176
1184
|
}
|
|
@@ -8,7 +8,7 @@ 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 job by name
|
|
11
|
+
* @summary: Cancel job by name
|
|
12
12
|
* @description: Cancel a specific job by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
|
|
13
13
|
*/
|
|
14
14
|
cancelJobByName({ filename, requestHeaders }?: WebhookPlatformValidator.CancelJobByNameParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.CancelResponse>;
|
|
@@ -18,7 +18,7 @@ declare class Webhook {
|
|
|
18
18
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
19
|
* @returns {Promise<WebhookPlatformModel.DownloadReportResponse>} - Success response
|
|
20
20
|
* @name downloadDeliveryReport
|
|
21
|
-
* @summary: Download delivery report
|
|
21
|
+
* @summary: Download delivery report
|
|
22
22
|
* @description: Download detailed delivery reports for events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/downloadDeliveryReport/).
|
|
23
23
|
*/
|
|
24
24
|
downloadDeliveryReport({ body, requestHeaders }?: WebhookPlatformValidator.DownloadDeliveryReportParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.DownloadReportResponse>;
|
|
@@ -28,7 +28,7 @@ declare class Webhook {
|
|
|
28
28
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
29
|
* @returns {Promise<WebhookPlatformModel.EventConfigResponse>} - Success response
|
|
30
30
|
* @name fetchAllEventConfigurations
|
|
31
|
-
* @summary: Fetch all event configurations
|
|
31
|
+
* @summary: Fetch all event configurations
|
|
32
32
|
* @description: Retrieve all configurations for event handling. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
|
|
33
33
|
*/
|
|
34
34
|
fetchAllEventConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventConfigResponse>;
|
|
@@ -38,7 +38,7 @@ declare class Webhook {
|
|
|
38
38
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
39
|
* @returns {Promise<WebhookPlatformModel.EventProcessReports>} - Success response
|
|
40
40
|
* @name getDeliveryReports
|
|
41
|
-
* @summary: Get delivery reports
|
|
41
|
+
* @summary: Get delivery reports
|
|
42
42
|
* @description: Retrieve reports on the delivery status of events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getDeliveryReports/).
|
|
43
43
|
*/
|
|
44
44
|
getDeliveryReports({ body, requestHeaders }?: WebhookPlatformValidator.GetDeliveryReportsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventProcessReports>;
|
|
@@ -48,7 +48,7 @@ declare class Webhook {
|
|
|
48
48
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
49
49
|
* @returns {Promise<WebhookPlatformModel.RetryCountResponse>} - Success response
|
|
50
50
|
* @name getEventCounts
|
|
51
|
-
* @summary: Get event counts
|
|
51
|
+
* @summary: Get event counts
|
|
52
52
|
* @description: Retrieve the counts of events based on their status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getEventCounts/).
|
|
53
53
|
*/
|
|
54
54
|
getEventCounts({ body, requestHeaders }?: WebhookPlatformValidator.GetEventCountsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.RetryCountResponse>;
|
|
@@ -58,7 +58,7 @@ declare class Webhook {
|
|
|
58
58
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
59
59
|
* @returns {Promise<WebhookPlatformModel.HistoryResponse>} - Success response
|
|
60
60
|
* @name getHistoricalReports
|
|
61
|
-
* @summary: Get historical reports
|
|
61
|
+
* @summary: Get historical reports
|
|
62
62
|
* @description: Retrieve historical reports of webhook events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getHistoricalReports/).
|
|
63
63
|
*/
|
|
64
64
|
getHistoricalReports({ body, requestHeaders }?: WebhookPlatformValidator.GetHistoricalReportsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.HistoryResponse>;
|
|
@@ -68,7 +68,7 @@ declare class Webhook {
|
|
|
68
68
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
69
69
|
* @returns {Promise<WebhookPlatformModel.RetryStatusResponse>} - Success response
|
|
70
70
|
* @name getManualRetryStatus
|
|
71
|
-
* @summary: Get manual retry status
|
|
71
|
+
* @summary: Get manual retry status
|
|
72
72
|
* @description: Check the status of a manual retry operation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getManualRetryStatus/).
|
|
73
73
|
*/
|
|
74
74
|
getManualRetryStatus({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.RetryStatusResponse>;
|
|
@@ -78,7 +78,7 @@ declare class Webhook {
|
|
|
78
78
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
79
79
|
* @returns {Promise<WebhookPlatformModel.ReportFilterResponse[]>} - Success response
|
|
80
80
|
* @name getReportFilters
|
|
81
|
-
* @summary: Get report filters
|
|
81
|
+
* @summary: Get report filters
|
|
82
82
|
* @description: Retrieve filters used for generating reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getReportFilters/).
|
|
83
83
|
*/
|
|
84
84
|
getReportFilters({ body, requestHeaders }?: WebhookPlatformValidator.GetReportFiltersParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.ReportFilterResponse[]>;
|
|
@@ -88,7 +88,7 @@ declare class Webhook {
|
|
|
88
88
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
89
89
|
* @returns {Promise<WebhookPlatformModel.SubscriberResponse>} - Success response
|
|
90
90
|
* @name getSubscriberById
|
|
91
|
-
* @summary: Get subscriber by ID
|
|
91
|
+
* @summary: Get subscriber by ID
|
|
92
92
|
* @description: Retrieve a subscriber's details by their unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscriberById/).
|
|
93
93
|
*/
|
|
94
94
|
getSubscriberById({ subscriberId, requestHeaders }?: WebhookPlatformValidator.GetSubscriberByIdParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberResponse>;
|
|
@@ -98,7 +98,7 @@ declare class Webhook {
|
|
|
98
98
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
99
99
|
* @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
|
|
100
100
|
* @name getSubscribersByCompany
|
|
101
|
-
* @summary: Get subscribers by company
|
|
101
|
+
* @summary: Get subscribers by company
|
|
102
102
|
* @description: Retrieve subscribers associated with a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
|
|
103
103
|
*/
|
|
104
104
|
getSubscribersByCompany({ pageNo, pageSize, extensionId, requestHeaders }?: WebhookPlatformValidator.GetSubscribersByCompanyParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigList>;
|
|
@@ -108,7 +108,7 @@ declare class Webhook {
|
|
|
108
108
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
109
109
|
* @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
|
|
110
110
|
* @name getSubscribersByExtensionId
|
|
111
|
-
* @summary: Get subscribers by extension ID
|
|
111
|
+
* @summary: Get subscribers by extension ID
|
|
112
112
|
* @description: Retrieve subscribers associated with a specific extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByExtensionId/).
|
|
113
113
|
*/
|
|
114
114
|
getSubscribersByExtensionId({ extensionId, pageNo, pageSize, requestHeaders }?: WebhookPlatformValidator.GetSubscribersByExtensionIdParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigList>;
|
|
@@ -118,7 +118,7 @@ declare class Webhook {
|
|
|
118
118
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
119
119
|
* @returns {Promise<string>} - Success response
|
|
120
120
|
* @name manualRetryCancel
|
|
121
|
-
* @summary: Manual retry cancellation
|
|
121
|
+
* @summary: Manual retry cancellation
|
|
122
122
|
* @description: Cancel a manual retry operation for a failed event. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryCancel/).
|
|
123
123
|
*/
|
|
124
124
|
manualRetryCancel({ requestHeaders }?: any, { responseHeaders }?: object): Promise<string>;
|
|
@@ -128,7 +128,7 @@ declare class Webhook {
|
|
|
128
128
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
129
129
|
* @returns {Promise<WebhookPlatformModel.RetrySuccessResponse>} - Success response
|
|
130
130
|
* @name manualRetryOfFailedEvent
|
|
131
|
-
* @summary: Manual retry of failed event
|
|
131
|
+
* @summary: Manual retry of failed event
|
|
132
132
|
* @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/).
|
|
133
133
|
*/
|
|
134
134
|
manualRetryOfFailedEvent({ body, requestHeaders }?: WebhookPlatformValidator.ManualRetryOfFailedEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.RetrySuccessResponse>;
|
|
@@ -138,7 +138,7 @@ declare class Webhook {
|
|
|
138
138
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
139
139
|
* @returns {Promise<WebhookPlatformModel.PingWebhookResponse>} - Success response
|
|
140
140
|
* @name pingWebhook
|
|
141
|
-
* @summary: Ping webhook
|
|
141
|
+
* @summary: Ping webhook
|
|
142
142
|
* @description: Send a test ping to a webhook for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
|
|
143
143
|
*/
|
|
144
144
|
pingWebhook({ body, requestHeaders }?: WebhookPlatformValidator.PingWebhookParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.PingWebhookResponse>;
|
|
@@ -149,7 +149,7 @@ declare class Webhook {
|
|
|
149
149
|
* @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
|
|
150
150
|
* Success response
|
|
151
151
|
* @name registerSubscriberToEvent
|
|
152
|
-
* @summary: Register subscriber to event
|
|
152
|
+
* @summary: Register subscriber to event
|
|
153
153
|
* @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/).
|
|
154
154
|
*/
|
|
155
155
|
registerSubscriberToEvent({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
|
|
@@ -160,7 +160,7 @@ declare class Webhook {
|
|
|
160
160
|
* @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
|
|
161
161
|
* Success response
|
|
162
162
|
* @name updateSubscriberConfig
|
|
163
|
-
* @summary: Update subscriber config
|
|
163
|
+
* @summary: Update subscriber config
|
|
164
164
|
* @description: Modify and update subscriber configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
|
|
165
165
|
*/
|
|
166
166
|
updateSubscriberConfig({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberConfigParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
|
|
@@ -20,7 +20,7 @@ class Webhook {
|
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
21
|
* @returns {Promise<WebhookPlatformModel.CancelResponse>} - Success response
|
|
22
22
|
* @name cancelJobByName
|
|
23
|
-
* @summary: Cancel job by name
|
|
23
|
+
* @summary: Cancel job by name
|
|
24
24
|
* @description: Cancel a specific job by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
|
|
25
25
|
*/
|
|
26
26
|
async cancelJobByName(
|
|
@@ -99,7 +99,7 @@ class Webhook {
|
|
|
99
99
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
100
100
|
* @returns {Promise<WebhookPlatformModel.DownloadReportResponse>} - Success response
|
|
101
101
|
* @name downloadDeliveryReport
|
|
102
|
-
* @summary: Download delivery report
|
|
102
|
+
* @summary: Download delivery report
|
|
103
103
|
* @description: Download detailed delivery reports for events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/downloadDeliveryReport/).
|
|
104
104
|
*/
|
|
105
105
|
async downloadDeliveryReport(
|
|
@@ -180,7 +180,7 @@ class Webhook {
|
|
|
180
180
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
181
181
|
* @returns {Promise<WebhookPlatformModel.EventConfigResponse>} - Success response
|
|
182
182
|
* @name fetchAllEventConfigurations
|
|
183
|
-
* @summary: Fetch all event configurations
|
|
183
|
+
* @summary: Fetch all event configurations
|
|
184
184
|
* @description: Retrieve all configurations for event handling. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
|
|
185
185
|
*/
|
|
186
186
|
async fetchAllEventConfigurations(
|
|
@@ -257,7 +257,7 @@ class Webhook {
|
|
|
257
257
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
258
258
|
* @returns {Promise<WebhookPlatformModel.EventProcessReports>} - Success response
|
|
259
259
|
* @name getDeliveryReports
|
|
260
|
-
* @summary: Get delivery reports
|
|
260
|
+
* @summary: Get delivery reports
|
|
261
261
|
* @description: Retrieve reports on the delivery status of events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getDeliveryReports/).
|
|
262
262
|
*/
|
|
263
263
|
async getDeliveryReports(
|
|
@@ -336,7 +336,7 @@ class Webhook {
|
|
|
336
336
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
337
337
|
* @returns {Promise<WebhookPlatformModel.RetryCountResponse>} - Success response
|
|
338
338
|
* @name getEventCounts
|
|
339
|
-
* @summary: Get event counts
|
|
339
|
+
* @summary: Get event counts
|
|
340
340
|
* @description: Retrieve the counts of events based on their status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getEventCounts/).
|
|
341
341
|
*/
|
|
342
342
|
async getEventCounts(
|
|
@@ -415,7 +415,7 @@ class Webhook {
|
|
|
415
415
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
416
416
|
* @returns {Promise<WebhookPlatformModel.HistoryResponse>} - Success response
|
|
417
417
|
* @name getHistoricalReports
|
|
418
|
-
* @summary: Get historical reports
|
|
418
|
+
* @summary: Get historical reports
|
|
419
419
|
* @description: Retrieve historical reports of webhook events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getHistoricalReports/).
|
|
420
420
|
*/
|
|
421
421
|
async getHistoricalReports(
|
|
@@ -494,7 +494,7 @@ class Webhook {
|
|
|
494
494
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
495
495
|
* @returns {Promise<WebhookPlatformModel.RetryStatusResponse>} - Success response
|
|
496
496
|
* @name getManualRetryStatus
|
|
497
|
-
* @summary: Get manual retry status
|
|
497
|
+
* @summary: Get manual retry status
|
|
498
498
|
* @description: Check the status of a manual retry operation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getManualRetryStatus/).
|
|
499
499
|
*/
|
|
500
500
|
async getManualRetryStatus(
|
|
@@ -569,7 +569,7 @@ class Webhook {
|
|
|
569
569
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
570
570
|
* @returns {Promise<WebhookPlatformModel.ReportFilterResponse[]>} - Success response
|
|
571
571
|
* @name getReportFilters
|
|
572
|
-
* @summary: Get report filters
|
|
572
|
+
* @summary: Get report filters
|
|
573
573
|
* @description: Retrieve filters used for generating reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getReportFilters/).
|
|
574
574
|
*/
|
|
575
575
|
async getReportFilters(
|
|
@@ -645,7 +645,7 @@ class Webhook {
|
|
|
645
645
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
646
646
|
* @returns {Promise<WebhookPlatformModel.SubscriberResponse>} - Success response
|
|
647
647
|
* @name getSubscriberById
|
|
648
|
-
* @summary: Get subscriber by ID
|
|
648
|
+
* @summary: Get subscriber by ID
|
|
649
649
|
* @description: Retrieve a subscriber's details by their unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscriberById/).
|
|
650
650
|
*/
|
|
651
651
|
async getSubscriberById(
|
|
@@ -724,7 +724,7 @@ class Webhook {
|
|
|
724
724
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
725
725
|
* @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
|
|
726
726
|
* @name getSubscribersByCompany
|
|
727
|
-
* @summary: Get subscribers by company
|
|
727
|
+
* @summary: Get subscribers by company
|
|
728
728
|
* @description: Retrieve subscribers associated with a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByCompany/).
|
|
729
729
|
*/
|
|
730
730
|
async getSubscribersByCompany(
|
|
@@ -812,7 +812,7 @@ class Webhook {
|
|
|
812
812
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
813
813
|
* @returns {Promise<WebhookPlatformModel.SubscriberConfigList>} - Success response
|
|
814
814
|
* @name getSubscribersByExtensionId
|
|
815
|
-
* @summary: Get subscribers by extension ID
|
|
815
|
+
* @summary: Get subscribers by extension ID
|
|
816
816
|
* @description: Retrieve subscribers associated with a specific extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByExtensionId/).
|
|
817
817
|
*/
|
|
818
818
|
async getSubscribersByExtensionId(
|
|
@@ -899,7 +899,7 @@ class Webhook {
|
|
|
899
899
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
900
900
|
* @returns {Promise<string>} - Success response
|
|
901
901
|
* @name manualRetryCancel
|
|
902
|
-
* @summary: Manual retry cancellation
|
|
902
|
+
* @summary: Manual retry cancellation
|
|
903
903
|
* @description: Cancel a manual retry operation for a failed event. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryCancel/).
|
|
904
904
|
*/
|
|
905
905
|
async manualRetryCancel(
|
|
@@ -971,7 +971,7 @@ class Webhook {
|
|
|
971
971
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
972
972
|
* @returns {Promise<WebhookPlatformModel.RetrySuccessResponse>} - Success response
|
|
973
973
|
* @name manualRetryOfFailedEvent
|
|
974
|
-
* @summary: Manual retry of failed event
|
|
974
|
+
* @summary: Manual retry of failed event
|
|
975
975
|
* @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/).
|
|
976
976
|
*/
|
|
977
977
|
async manualRetryOfFailedEvent(
|
|
@@ -1052,7 +1052,7 @@ class Webhook {
|
|
|
1052
1052
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1053
1053
|
* @returns {Promise<WebhookPlatformModel.PingWebhookResponse>} - Success response
|
|
1054
1054
|
* @name pingWebhook
|
|
1055
|
-
* @summary: Ping webhook
|
|
1055
|
+
* @summary: Ping webhook
|
|
1056
1056
|
* @description: Send a test ping to a webhook for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
|
|
1057
1057
|
*/
|
|
1058
1058
|
async pingWebhook(
|
|
@@ -1130,7 +1130,7 @@ class Webhook {
|
|
|
1130
1130
|
* @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
|
|
1131
1131
|
* Success response
|
|
1132
1132
|
* @name registerSubscriberToEvent
|
|
1133
|
-
* @summary: Register subscriber to event
|
|
1133
|
+
* @summary: Register subscriber to event
|
|
1134
1134
|
* @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/).
|
|
1135
1135
|
*/
|
|
1136
1136
|
async registerSubscriberToEvent(
|
|
@@ -1212,7 +1212,7 @@ class Webhook {
|
|
|
1212
1212
|
* @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
|
|
1213
1213
|
* Success response
|
|
1214
1214
|
* @name updateSubscriberConfig
|
|
1215
|
-
* @summary: Update subscriber config
|
|
1215
|
+
* @summary: Update subscriber config
|
|
1216
1216
|
* @description: Modify and update subscriber configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
|
|
1217
1217
|
*/
|
|
1218
1218
|
async updateSubscriberConfig(
|
|
@@ -74,7 +74,7 @@ export = WebhookPlatformModel;
|
|
|
74
74
|
* @property {string} [event_name] - The name of the processed event.
|
|
75
75
|
* @property {number} [response_code] - The response code of the event.
|
|
76
76
|
* @property {string} [response_message] - The response message of the event.
|
|
77
|
-
* @property {
|
|
77
|
+
* @property {string} [data] - The data associated with the event.
|
|
78
78
|
* @property {number} [attempt] - The attempt number of the event.
|
|
79
79
|
* @property {number} [last_attempted_on] - The timestamp of the last attempted event.
|
|
80
80
|
* @property {string} [status] - The status of the event (e.g., "FAILED").
|
|
@@ -113,6 +113,7 @@ export = WebhookPlatformModel;
|
|
|
113
113
|
* @property {string} [event_name]
|
|
114
114
|
* @property {string} [event_type]
|
|
115
115
|
* @property {string} [event_category]
|
|
116
|
+
* @property {SubscriberEventMapping} [subscriber_event_mapping]
|
|
116
117
|
* @property {Object} [event_schema]
|
|
117
118
|
* @property {string} [version]
|
|
118
119
|
* @property {string} [display_name]
|
|
@@ -203,26 +204,6 @@ export = WebhookPlatformModel;
|
|
|
203
204
|
* @property {string} [type]
|
|
204
205
|
* @property {string} [secret]
|
|
205
206
|
*/
|
|
206
|
-
/**
|
|
207
|
-
* @typedef SubscriberFailureResponse
|
|
208
|
-
* @property {string} [message]
|
|
209
|
-
* @property {string} [code]
|
|
210
|
-
* @property {string} [stack]
|
|
211
|
-
*/
|
|
212
|
-
/**
|
|
213
|
-
* @typedef EventConfigs
|
|
214
|
-
* @property {number} [id]
|
|
215
|
-
* @property {string} [event_name]
|
|
216
|
-
* @property {string} [event_type]
|
|
217
|
-
* @property {string} [event_category]
|
|
218
|
-
* @property {Object} [event_schema]
|
|
219
|
-
* @property {string} [version]
|
|
220
|
-
* @property {string} [display_name]
|
|
221
|
-
* @property {string} [description]
|
|
222
|
-
* @property {string} [created_on]
|
|
223
|
-
* @property {string} [updated_on]
|
|
224
|
-
* @property {SubscriberEventMapping} [subscriber_event_mapping]
|
|
225
|
-
*/
|
|
226
207
|
/**
|
|
227
208
|
* @typedef SubscriberEventMapping
|
|
228
209
|
* @property {number} [id]
|
|
@@ -283,7 +264,7 @@ export = WebhookPlatformModel;
|
|
|
283
264
|
declare class WebhookPlatformModel {
|
|
284
265
|
}
|
|
285
266
|
declare namespace WebhookPlatformModel {
|
|
286
|
-
export { Error, Event, RetryEventRequest, Item, RetryCountResponse, RetrySuccessResponse, Err, RetryFailureResponse, RetryStatusResponse, EventProcessRequest, DownloadReportResponse, EventProcessReports, EventProcessReportObject, Page, PingWebhook, PingWebhookResponse, EventConfig, EventConfigResponse, ReportFiltersPayload, ReportFilterResponse, HistoryPayload, HistoryFilters, Url, CdnObject, UploadServiceObject, HistoryAssociation, HistoryItems, HistoryResponse, CancelResponse, Association, AuthMeta,
|
|
267
|
+
export { Error, Event, RetryEventRequest, Item, RetryCountResponse, RetrySuccessResponse, Err, RetryFailureResponse, RetryStatusResponse, EventProcessRequest, DownloadReportResponse, EventProcessReports, EventProcessReportObject, Page, PingWebhook, PingWebhookResponse, EventConfig, EventConfigResponse, ReportFiltersPayload, ReportFilterResponse, HistoryPayload, HistoryFilters, Url, CdnObject, UploadServiceObject, HistoryAssociation, HistoryItems, HistoryResponse, CancelResponse, Association, AuthMeta, SubscriberEventMapping, SubscriberResponse, SubscriberConfig, SubscriberConfigResponse, SubscriberConfigList, SubscriberStatus };
|
|
287
268
|
}
|
|
288
269
|
/** @returns {Error} */
|
|
289
270
|
declare function Error(): Error;
|
|
@@ -400,7 +381,7 @@ type EventProcessReportObject = {
|
|
|
400
381
|
/**
|
|
401
382
|
* - The data associated with the event.
|
|
402
383
|
*/
|
|
403
|
-
data?:
|
|
384
|
+
data?: string;
|
|
404
385
|
/**
|
|
405
386
|
* - The attempt number of the event.
|
|
406
387
|
*/
|
|
@@ -479,6 +460,7 @@ type EventConfig = {
|
|
|
479
460
|
event_name?: string;
|
|
480
461
|
event_type?: string;
|
|
481
462
|
event_category?: string;
|
|
463
|
+
subscriber_event_mapping?: SubscriberEventMapping;
|
|
482
464
|
event_schema?: any;
|
|
483
465
|
version?: string;
|
|
484
466
|
display_name?: string;
|
|
@@ -637,28 +619,6 @@ type AuthMeta = {
|
|
|
637
619
|
type?: string;
|
|
638
620
|
secret?: string;
|
|
639
621
|
};
|
|
640
|
-
/** @returns {SubscriberFailureResponse} */
|
|
641
|
-
declare function SubscriberFailureResponse(): SubscriberFailureResponse;
|
|
642
|
-
type SubscriberFailureResponse = {
|
|
643
|
-
message?: string;
|
|
644
|
-
code?: string;
|
|
645
|
-
stack?: string;
|
|
646
|
-
};
|
|
647
|
-
/** @returns {EventConfigs} */
|
|
648
|
-
declare function EventConfigs(): EventConfigs;
|
|
649
|
-
type EventConfigs = {
|
|
650
|
-
id?: number;
|
|
651
|
-
event_name?: string;
|
|
652
|
-
event_type?: string;
|
|
653
|
-
event_category?: string;
|
|
654
|
-
event_schema?: any;
|
|
655
|
-
version?: string;
|
|
656
|
-
display_name?: string;
|
|
657
|
-
description?: string;
|
|
658
|
-
created_on?: string;
|
|
659
|
-
updated_on?: string;
|
|
660
|
-
subscriber_event_mapping?: SubscriberEventMapping;
|
|
661
|
-
};
|
|
662
622
|
/** @returns {SubscriberEventMapping} */
|
|
663
623
|
declare function SubscriberEventMapping(): SubscriberEventMapping;
|
|
664
624
|
type SubscriberEventMapping = {
|
|
@@ -87,7 +87,7 @@ const Joi = require("joi");
|
|
|
87
87
|
* @property {string} [event_name] - The name of the processed event.
|
|
88
88
|
* @property {number} [response_code] - The response code of the event.
|
|
89
89
|
* @property {string} [response_message] - The response message of the event.
|
|
90
|
-
* @property {
|
|
90
|
+
* @property {string} [data] - The data associated with the event.
|
|
91
91
|
* @property {number} [attempt] - The attempt number of the event.
|
|
92
92
|
* @property {number} [last_attempted_on] - The timestamp of the last attempted event.
|
|
93
93
|
* @property {string} [status] - The status of the event (e.g., "FAILED").
|
|
@@ -130,6 +130,7 @@ const Joi = require("joi");
|
|
|
130
130
|
* @property {string} [event_name]
|
|
131
131
|
* @property {string} [event_type]
|
|
132
132
|
* @property {string} [event_category]
|
|
133
|
+
* @property {SubscriberEventMapping} [subscriber_event_mapping]
|
|
133
134
|
* @property {Object} [event_schema]
|
|
134
135
|
* @property {string} [version]
|
|
135
136
|
* @property {string} [display_name]
|
|
@@ -235,28 +236,6 @@ const Joi = require("joi");
|
|
|
235
236
|
* @property {string} [secret]
|
|
236
237
|
*/
|
|
237
238
|
|
|
238
|
-
/**
|
|
239
|
-
* @typedef SubscriberFailureResponse
|
|
240
|
-
* @property {string} [message]
|
|
241
|
-
* @property {string} [code]
|
|
242
|
-
* @property {string} [stack]
|
|
243
|
-
*/
|
|
244
|
-
|
|
245
|
-
/**
|
|
246
|
-
* @typedef EventConfigs
|
|
247
|
-
* @property {number} [id]
|
|
248
|
-
* @property {string} [event_name]
|
|
249
|
-
* @property {string} [event_type]
|
|
250
|
-
* @property {string} [event_category]
|
|
251
|
-
* @property {Object} [event_schema]
|
|
252
|
-
* @property {string} [version]
|
|
253
|
-
* @property {string} [display_name]
|
|
254
|
-
* @property {string} [description]
|
|
255
|
-
* @property {string} [created_on]
|
|
256
|
-
* @property {string} [updated_on]
|
|
257
|
-
* @property {SubscriberEventMapping} [subscriber_event_mapping]
|
|
258
|
-
*/
|
|
259
|
-
|
|
260
239
|
/**
|
|
261
240
|
* @typedef SubscriberEventMapping
|
|
262
241
|
* @property {number} [id]
|
|
@@ -432,7 +411,7 @@ class WebhookPlatformModel {
|
|
|
432
411
|
event_name: Joi.string().allow(""),
|
|
433
412
|
response_code: Joi.number(),
|
|
434
413
|
response_message: Joi.string().allow(""),
|
|
435
|
-
data: Joi.
|
|
414
|
+
data: Joi.string().allow(""),
|
|
436
415
|
attempt: Joi.number(),
|
|
437
416
|
last_attempted_on: Joi.number(),
|
|
438
417
|
status: Joi.string().allow(""),
|
|
@@ -482,6 +461,7 @@ class WebhookPlatformModel {
|
|
|
482
461
|
event_name: Joi.string().allow(""),
|
|
483
462
|
event_type: Joi.string().allow(""),
|
|
484
463
|
event_category: Joi.string().allow(""),
|
|
464
|
+
subscriber_event_mapping: WebhookPlatformModel.SubscriberEventMapping(),
|
|
485
465
|
event_schema: Joi.object().pattern(/\S/, Joi.any()),
|
|
486
466
|
version: Joi.string().allow(""),
|
|
487
467
|
display_name: Joi.string().allow(""),
|
|
@@ -612,32 +592,6 @@ class WebhookPlatformModel {
|
|
|
612
592
|
});
|
|
613
593
|
}
|
|
614
594
|
|
|
615
|
-
/** @returns {SubscriberFailureResponse} */
|
|
616
|
-
static SubscriberFailureResponse() {
|
|
617
|
-
return Joi.object({
|
|
618
|
-
message: Joi.string().allow(""),
|
|
619
|
-
code: Joi.string().allow(""),
|
|
620
|
-
stack: Joi.string().allow(""),
|
|
621
|
-
});
|
|
622
|
-
}
|
|
623
|
-
|
|
624
|
-
/** @returns {EventConfigs} */
|
|
625
|
-
static EventConfigs() {
|
|
626
|
-
return Joi.object({
|
|
627
|
-
id: Joi.number(),
|
|
628
|
-
event_name: Joi.string().allow(""),
|
|
629
|
-
event_type: Joi.string().allow(""),
|
|
630
|
-
event_category: Joi.string().allow(""),
|
|
631
|
-
event_schema: Joi.object().pattern(/\S/, Joi.any()),
|
|
632
|
-
version: Joi.string().allow(""),
|
|
633
|
-
display_name: Joi.string().allow(""),
|
|
634
|
-
description: Joi.string().allow(""),
|
|
635
|
-
created_on: Joi.string().allow(""),
|
|
636
|
-
updated_on: Joi.string().allow(""),
|
|
637
|
-
subscriber_event_mapping: WebhookPlatformModel.SubscriberEventMapping(),
|
|
638
|
-
});
|
|
639
|
-
}
|
|
640
|
-
|
|
641
595
|
/** @returns {SubscriberEventMapping} */
|
|
642
596
|
static SubscriberEventMapping() {
|
|
643
597
|
return Joi.object({
|
|
@@ -17,7 +17,7 @@ declare class Billing {
|
|
|
17
17
|
* @description: Get Standard/Public Plans.
|
|
18
18
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/billing/getStandardPlans/).
|
|
19
19
|
*/
|
|
20
|
-
getStandardPlans({
|
|
20
|
+
getStandardPlans({ platform, requestHeaders }?: BillingPublicValidator.GetStandardPlansParam, { responseHeaders }?: object): Promise<BillingPublicModel.DetailList>;
|
|
21
21
|
}
|
|
22
22
|
import BillingPublicValidator = require("./BillingPublicValidator");
|
|
23
23
|
import BillingPublicModel = require("./BillingPublicModel");
|
|
@@ -43,11 +43,11 @@ class Billing {
|
|
|
43
43
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/billing/getStandardPlans/).
|
|
44
44
|
*/
|
|
45
45
|
async getStandardPlans(
|
|
46
|
-
{
|
|
46
|
+
{ platform, requestHeaders } = { requestHeaders: {} },
|
|
47
47
|
{ responseHeaders } = { responseHeaders: false }
|
|
48
48
|
) {
|
|
49
49
|
const { error } = BillingPublicValidator.getStandardPlans().validate(
|
|
50
|
-
{
|
|
50
|
+
{ platform },
|
|
51
51
|
{ abortEarly: false, allowUnknown: true }
|
|
52
52
|
);
|
|
53
53
|
if (error) {
|
|
@@ -58,7 +58,7 @@ class Billing {
|
|
|
58
58
|
const {
|
|
59
59
|
error: warrning,
|
|
60
60
|
} = BillingPublicValidator.getStandardPlans().validate(
|
|
61
|
-
{
|
|
61
|
+
{ platform },
|
|
62
62
|
{ abortEarly: false, allowUnknown: false }
|
|
63
63
|
);
|
|
64
64
|
if (warrning) {
|
|
@@ -69,7 +69,7 @@ class Billing {
|
|
|
69
69
|
}
|
|
70
70
|
|
|
71
71
|
const query_params = {};
|
|
72
|
-
query_params["
|
|
72
|
+
query_params["platform"] = platform;
|
|
73
73
|
|
|
74
74
|
const xHeaders = {};
|
|
75
75
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export = BillingPublicValidator;
|
|
2
2
|
/**
|
|
3
3
|
* @typedef GetStandardPlansParam
|
|
4
|
-
* @property {string}
|
|
4
|
+
* @property {string} platform - The type of platform for which plans are requested.
|
|
5
5
|
*/
|
|
6
6
|
declare class BillingPublicValidator {
|
|
7
7
|
/** @returns {GetStandardPlansParam} */
|
|
@@ -14,5 +14,5 @@ type GetStandardPlansParam = {
|
|
|
14
14
|
/**
|
|
15
15
|
* - The type of platform for which plans are requested.
|
|
16
16
|
*/
|
|
17
|
-
|
|
17
|
+
platform: string;
|
|
18
18
|
};
|