@gofynd/fdk-client-javascript 1.4.16-beta.2 → 1.4.16-beta.4
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 +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -68
- package/sdk/application/Cart/CartApplicationClient.js +27 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
- package/sdk/application/Catalog/CatalogApplicationClient.js +29 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +30 -51
- package/sdk/application/Content/ContentApplicationClient.js +56 -161
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -9
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
- package/sdk/application/Logistic/LogisticApplicationClient.js +8 -101
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
- package/sdk/application/Order/OrderApplicationClient.js +8 -56
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +2 -4
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/common/Utility.js +6 -3
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +21 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +16 -121
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +20 -126
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +167 -1200
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +160 -571
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -121
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +37 -96
- package/sdk/partner/Theme/ThemePartnerModel.js +36 -90
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +115 -419
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -121
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1294 -5068
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1992
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -209
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +400 -457
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +142 -185
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +78 -96
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +117 -154
- package/sdk/platform/Catalog/CatalogPlatformClient.js +172 -292
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1647 -6389
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1681 -3222
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +24 -50
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
- package/sdk/platform/Common/CommonPlatformClient.js +2 -3
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +131 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +97 -219
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -204
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +475 -1073
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -253
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -256
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +403 -1375
- package/sdk/platform/Content/ContentPlatformModel.js +394 -631
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
- package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
- package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +39 -95
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +63 -462
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +22 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +24 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +104 -313
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +6 -17
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +7 -85
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +24 -95
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +19 -39
- package/sdk/platform/Order/OrderPlatformClient.d.ts +96 -153
- package/sdk/platform/Order/OrderPlatformClient.js +198 -416
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1286 -7619
- package/sdk/platform/Order/OrderPlatformModel.js +1265 -3922
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +109 -270
- package/sdk/platform/Order/OrderPlatformValidator.js +77 -135
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +105 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +141 -129
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +319 -333
- package/sdk/platform/Payment/PaymentPlatformModel.js +278 -288
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +36 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +41 -132
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +14 -34
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +68 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +49 -45
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +30 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -3
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +7 -46
- package/sdk/platform/Share/SharePlatformModel.js +6 -31
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +11 -37
- package/sdk/platform/Theme/ThemePlatformModel.js +15 -33
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
- package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -6
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
- package/sdk/public/Content/ContentPublicClient.js +6 -810
- package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
- package/sdk/public/Content/ContentPublicModel.js +3 -649
- package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
- package/sdk/public/Content/ContentPublicValidator.js +2 -88
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -111
|
@@ -254,7 +254,7 @@ class User {
|
|
|
254
254
|
*
|
|
255
255
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
256
256
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
257
|
-
* @returns {Promise<UserPlatformModel.
|
|
257
|
+
* @returns {Promise<UserPlatformModel.UserAttributeDefinitionResponse>} -
|
|
258
258
|
* Success response
|
|
259
259
|
* @name createUserAttributeDefinition
|
|
260
260
|
* @summary: Create a User Attribute Definition
|
|
@@ -311,7 +311,7 @@ class User {
|
|
|
311
311
|
|
|
312
312
|
const {
|
|
313
313
|
error: res_error,
|
|
314
|
-
} = UserPlatformModel.
|
|
314
|
+
} = UserPlatformModel.UserAttributeDefinitionResponse().validate(
|
|
315
315
|
responseData,
|
|
316
316
|
{ abortEarly: false, allowUnknown: true }
|
|
317
317
|
);
|
|
@@ -664,7 +664,7 @@ class User {
|
|
|
664
664
|
* @param {UserPlatformApplicationValidator.DeleteUserAttributeParam} arg - Arg object
|
|
665
665
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
666
666
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
667
|
-
* @returns {Promise<UserPlatformModel.
|
|
667
|
+
* @returns {Promise<UserPlatformModel.SuccessMessageResponse>} - Success response
|
|
668
668
|
* @name deleteUserAttribute
|
|
669
669
|
* @summary: Delete User Attribute
|
|
670
670
|
* @description: Delete User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttribute/).
|
|
@@ -716,7 +716,7 @@ class User {
|
|
|
716
716
|
|
|
717
717
|
const {
|
|
718
718
|
error: res_error,
|
|
719
|
-
} = UserPlatformModel.
|
|
719
|
+
} = UserPlatformModel.SuccessMessageResponse().validate(responseData, {
|
|
720
720
|
abortEarly: false,
|
|
721
721
|
allowUnknown: true,
|
|
722
722
|
});
|
|
@@ -741,7 +741,7 @@ class User {
|
|
|
741
741
|
*
|
|
742
742
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
743
743
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
744
|
-
* @returns {Promise<UserPlatformModel.
|
|
744
|
+
* @returns {Promise<UserPlatformModel.SuccessMessageResponse>} - Success response
|
|
745
745
|
* @name deleteUserAttributeDefinitionById
|
|
746
746
|
* @summary: Delete User Attribute Definition
|
|
747
747
|
* @description: Delete a user attribute definition by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttributeDefinitionById/).
|
|
@@ -793,7 +793,7 @@ class User {
|
|
|
793
793
|
|
|
794
794
|
const {
|
|
795
795
|
error: res_error,
|
|
796
|
-
} = UserPlatformModel.
|
|
796
|
+
} = UserPlatformModel.SuccessMessageResponse().validate(responseData, {
|
|
797
797
|
abortEarly: false,
|
|
798
798
|
allowUnknown: true,
|
|
799
799
|
});
|
|
@@ -1055,7 +1055,7 @@ class User {
|
|
|
1055
1055
|
* @param {UserPlatformApplicationValidator.GetUserAttributeParam} arg - Arg object
|
|
1056
1056
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1057
1057
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1058
|
-
* @returns {Promise<UserPlatformModel.
|
|
1058
|
+
* @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
|
|
1059
1059
|
* @name getUserAttribute
|
|
1060
1060
|
* @summary: Get User Attribute
|
|
1061
1061
|
* @description: Get User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttribute/).
|
|
@@ -1107,7 +1107,7 @@ class User {
|
|
|
1107
1107
|
|
|
1108
1108
|
const {
|
|
1109
1109
|
error: res_error,
|
|
1110
|
-
} = UserPlatformModel.
|
|
1110
|
+
} = UserPlatformModel.UserAttributeResponse().validate(responseData, {
|
|
1111
1111
|
abortEarly: false,
|
|
1112
1112
|
allowUnknown: true,
|
|
1113
1113
|
});
|
|
@@ -1132,7 +1132,7 @@ class User {
|
|
|
1132
1132
|
*
|
|
1133
1133
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1134
1134
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1135
|
-
* @returns {Promise<UserPlatformModel.
|
|
1135
|
+
* @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
|
|
1136
1136
|
* @name getUserAttributeById
|
|
1137
1137
|
* @summary: Get User Attribute
|
|
1138
1138
|
* @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeById/).
|
|
@@ -1184,7 +1184,7 @@ class User {
|
|
|
1184
1184
|
|
|
1185
1185
|
const {
|
|
1186
1186
|
error: res_error,
|
|
1187
|
-
} = UserPlatformModel.
|
|
1187
|
+
} = UserPlatformModel.UserAttributeResponse().validate(responseData, {
|
|
1188
1188
|
abortEarly: false,
|
|
1189
1189
|
allowUnknown: true,
|
|
1190
1190
|
});
|
|
@@ -1987,7 +1987,7 @@ class User {
|
|
|
1987
1987
|
* @param {UserPlatformApplicationValidator.UpdateUserAttributeParam} arg - Arg object
|
|
1988
1988
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1989
1989
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1990
|
-
* @returns {Promise<UserPlatformModel.
|
|
1990
|
+
* @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
|
|
1991
1991
|
* @name updateUserAttribute
|
|
1992
1992
|
* @summary: Update Or Create User Attribute
|
|
1993
1993
|
* @description: Update Or Create User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserAttribute/).
|
|
@@ -2049,7 +2049,7 @@ class User {
|
|
|
2049
2049
|
|
|
2050
2050
|
const {
|
|
2051
2051
|
error: res_error,
|
|
2052
|
-
} = UserPlatformModel.
|
|
2052
|
+
} = UserPlatformModel.UserAttributeResponse().validate(responseData, {
|
|
2053
2053
|
abortEarly: false,
|
|
2054
2054
|
allowUnknown: true,
|
|
2055
2055
|
});
|
|
@@ -133,7 +133,7 @@ export = UserPlatformApplicationValidator;
|
|
|
133
133
|
* @property {string} attributeDefId - The unique identifier of the attribute
|
|
134
134
|
* definition to update.
|
|
135
135
|
* @property {string} userId - The unique identifier of the user to update.
|
|
136
|
-
* @property {UserPlatformModel.
|
|
136
|
+
* @property {UserPlatformModel.CreateUserAttributeRequest} body
|
|
137
137
|
*/
|
|
138
138
|
/**
|
|
139
139
|
* @typedef UpdateUserAttributeDefinitionParam
|
|
@@ -447,7 +447,7 @@ type UpdateUserAttributeParam = {
|
|
|
447
447
|
* - The unique identifier of the user to update.
|
|
448
448
|
*/
|
|
449
449
|
userId: string;
|
|
450
|
-
body: UserPlatformModel.
|
|
450
|
+
body: UserPlatformModel.CreateUserAttributeRequest;
|
|
451
451
|
};
|
|
452
452
|
type UpdateUserAttributeDefinitionParam = {
|
|
453
453
|
/**
|
|
@@ -160,7 +160,7 @@ const UserPlatformModel = require("./UserPlatformModel");
|
|
|
160
160
|
* @property {string} attributeDefId - The unique identifier of the attribute
|
|
161
161
|
* definition to update.
|
|
162
162
|
* @property {string} userId - The unique identifier of the user to update.
|
|
163
|
-
* @property {UserPlatformModel.
|
|
163
|
+
* @property {UserPlatformModel.CreateUserAttributeRequest} body
|
|
164
164
|
*/
|
|
165
165
|
|
|
166
166
|
/**
|
|
@@ -383,7 +383,7 @@ class UserPlatformApplicationValidator {
|
|
|
383
383
|
attributeDefId: Joi.string().allow("").required(),
|
|
384
384
|
userId: Joi.string().allow("").required(),
|
|
385
385
|
|
|
386
|
-
body: UserPlatformModel.
|
|
386
|
+
body: UserPlatformModel.CreateUserAttributeRequest().required(),
|
|
387
387
|
}).required();
|
|
388
388
|
}
|
|
389
389
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export = UserPlatformModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
3
|
+
* @typedef SuccessMessageResponse
|
|
4
4
|
* @property {string} [success]
|
|
5
5
|
*/
|
|
6
6
|
/**
|
|
@@ -23,7 +23,7 @@ export = UserPlatformModel;
|
|
|
23
23
|
* @property {number} [__v] - The version number of the attribute.
|
|
24
24
|
*/
|
|
25
25
|
/**
|
|
26
|
-
* @typedef
|
|
26
|
+
* @typedef UserAttributeDefinitionResponse
|
|
27
27
|
* @property {string} [_id] - The unique identifier for the attribute definition.
|
|
28
28
|
* @property {string} [name] - The attribute name.
|
|
29
29
|
* @property {string} [slug] - The attribute key.
|
|
@@ -49,19 +49,19 @@ export = UserPlatformModel;
|
|
|
49
49
|
* @property {Object} [value] - The validation value.
|
|
50
50
|
*/
|
|
51
51
|
/**
|
|
52
|
-
* @typedef
|
|
52
|
+
* @typedef UserAttributeResponse
|
|
53
53
|
* @property {string} [_id] - The unique identifier for the attribute definition.
|
|
54
54
|
* @property {string} [name] - The name of user attribute definition.
|
|
55
55
|
* @property {string} [user_id] - The unique identifier for the user.
|
|
56
56
|
* @property {string} [application_id] - The application ID.
|
|
57
57
|
* @property {string} [type] - The attribute type.
|
|
58
|
-
* @property {boolean} [
|
|
58
|
+
* @property {boolean} [customer_overriden] - Whether the attribute is customer-editable.
|
|
59
59
|
* @property {Object} [attribute]
|
|
60
60
|
* @property {string} [updated_by]
|
|
61
61
|
*/
|
|
62
62
|
/**
|
|
63
|
-
* @typedef
|
|
64
|
-
* @property {boolean} [
|
|
63
|
+
* @typedef CreateUserAttributeRequest
|
|
64
|
+
* @property {boolean} [customer_overriden]
|
|
65
65
|
* @property {Object} [attribute]
|
|
66
66
|
*/
|
|
67
67
|
/**
|
|
@@ -473,11 +473,11 @@ export = UserPlatformModel;
|
|
|
473
473
|
declare class UserPlatformModel {
|
|
474
474
|
}
|
|
475
475
|
declare namespace UserPlatformModel {
|
|
476
|
-
export {
|
|
476
|
+
export { SuccessMessageResponse, UserAttributeDefinition, UserAttributeDefinitionResponse, UserAttributeDefinitionValidation, UserAttributeResponse, CreateUserAttributeRequest, CreateUserAttributeDefinition, BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, APIError, SessionListResponseInfo, Conditions, UserResponseErrorSchema, UserGroupResponseSchema, UserGroupListResponseSchema, ConditionsSchema, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, PlatformSchema, LookAndFeel, Login, MetaSchema, Social, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, Facebook, Accountkit, Google, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserSchema, UserSearchSchema, PhoneNumber, Email };
|
|
477
477
|
}
|
|
478
|
-
/** @returns {
|
|
479
|
-
declare function
|
|
480
|
-
type
|
|
478
|
+
/** @returns {SuccessMessageResponse} */
|
|
479
|
+
declare function SuccessMessageResponse(): SuccessMessageResponse;
|
|
480
|
+
type SuccessMessageResponse = {
|
|
481
481
|
success?: string;
|
|
482
482
|
};
|
|
483
483
|
/** @returns {UserAttributeDefinition} */
|
|
@@ -545,9 +545,9 @@ type UserAttributeDefinition = {
|
|
|
545
545
|
*/
|
|
546
546
|
__v?: number;
|
|
547
547
|
};
|
|
548
|
-
/** @returns {
|
|
549
|
-
declare function
|
|
550
|
-
type
|
|
548
|
+
/** @returns {UserAttributeDefinitionResponse} */
|
|
549
|
+
declare function UserAttributeDefinitionResponse(): UserAttributeDefinitionResponse;
|
|
550
|
+
type UserAttributeDefinitionResponse = {
|
|
551
551
|
/**
|
|
552
552
|
* - The unique identifier for the attribute definition.
|
|
553
553
|
*/
|
|
@@ -627,9 +627,9 @@ type UserAttributeDefinitionValidation = {
|
|
|
627
627
|
*/
|
|
628
628
|
value?: any;
|
|
629
629
|
};
|
|
630
|
-
/** @returns {
|
|
631
|
-
declare function
|
|
632
|
-
type
|
|
630
|
+
/** @returns {UserAttributeResponse} */
|
|
631
|
+
declare function UserAttributeResponse(): UserAttributeResponse;
|
|
632
|
+
type UserAttributeResponse = {
|
|
633
633
|
/**
|
|
634
634
|
* - The unique identifier for the attribute definition.
|
|
635
635
|
*/
|
|
@@ -653,14 +653,14 @@ type UserAttribute = {
|
|
|
653
653
|
/**
|
|
654
654
|
* - Whether the attribute is customer-editable.
|
|
655
655
|
*/
|
|
656
|
-
|
|
656
|
+
customer_overriden?: boolean;
|
|
657
657
|
attribute?: any;
|
|
658
658
|
updated_by?: string;
|
|
659
659
|
};
|
|
660
|
-
/** @returns {
|
|
661
|
-
declare function
|
|
662
|
-
type
|
|
663
|
-
|
|
660
|
+
/** @returns {CreateUserAttributeRequest} */
|
|
661
|
+
declare function CreateUserAttributeRequest(): CreateUserAttributeRequest;
|
|
662
|
+
type CreateUserAttributeRequest = {
|
|
663
|
+
customer_overriden?: boolean;
|
|
664
664
|
attribute?: any;
|
|
665
665
|
};
|
|
666
666
|
/** @returns {CreateUserAttributeDefinition} */
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @typedef
|
|
4
|
+
* @typedef SuccessMessageResponse
|
|
5
5
|
* @property {string} [success]
|
|
6
6
|
*/
|
|
7
7
|
|
|
@@ -26,7 +26,7 @@ const Joi = require("joi");
|
|
|
26
26
|
*/
|
|
27
27
|
|
|
28
28
|
/**
|
|
29
|
-
* @typedef
|
|
29
|
+
* @typedef UserAttributeDefinitionResponse
|
|
30
30
|
* @property {string} [_id] - The unique identifier for the attribute definition.
|
|
31
31
|
* @property {string} [name] - The attribute name.
|
|
32
32
|
* @property {string} [slug] - The attribute key.
|
|
@@ -54,20 +54,20 @@ const Joi = require("joi");
|
|
|
54
54
|
*/
|
|
55
55
|
|
|
56
56
|
/**
|
|
57
|
-
* @typedef
|
|
57
|
+
* @typedef UserAttributeResponse
|
|
58
58
|
* @property {string} [_id] - The unique identifier for the attribute definition.
|
|
59
59
|
* @property {string} [name] - The name of user attribute definition.
|
|
60
60
|
* @property {string} [user_id] - The unique identifier for the user.
|
|
61
61
|
* @property {string} [application_id] - The application ID.
|
|
62
62
|
* @property {string} [type] - The attribute type.
|
|
63
|
-
* @property {boolean} [
|
|
63
|
+
* @property {boolean} [customer_overriden] - Whether the attribute is customer-editable.
|
|
64
64
|
* @property {Object} [attribute]
|
|
65
65
|
* @property {string} [updated_by]
|
|
66
66
|
*/
|
|
67
67
|
|
|
68
68
|
/**
|
|
69
|
-
* @typedef
|
|
70
|
-
* @property {boolean} [
|
|
69
|
+
* @typedef CreateUserAttributeRequest
|
|
70
|
+
* @property {boolean} [customer_overriden]
|
|
71
71
|
* @property {Object} [attribute]
|
|
72
72
|
*/
|
|
73
73
|
|
|
@@ -532,8 +532,8 @@ const Joi = require("joi");
|
|
|
532
532
|
*/
|
|
533
533
|
|
|
534
534
|
class UserPlatformModel {
|
|
535
|
-
/** @returns {
|
|
536
|
-
static
|
|
535
|
+
/** @returns {SuccessMessageResponse} */
|
|
536
|
+
static SuccessMessageResponse() {
|
|
537
537
|
return Joi.object({
|
|
538
538
|
success: Joi.string().allow(""),
|
|
539
539
|
});
|
|
@@ -561,8 +561,8 @@ class UserPlatformModel {
|
|
|
561
561
|
});
|
|
562
562
|
}
|
|
563
563
|
|
|
564
|
-
/** @returns {
|
|
565
|
-
static
|
|
564
|
+
/** @returns {UserAttributeDefinitionResponse} */
|
|
565
|
+
static UserAttributeDefinitionResponse() {
|
|
566
566
|
return Joi.object({
|
|
567
567
|
_id: Joi.string().allow(""),
|
|
568
568
|
name: Joi.string().allow(""),
|
|
@@ -594,25 +594,25 @@ class UserPlatformModel {
|
|
|
594
594
|
});
|
|
595
595
|
}
|
|
596
596
|
|
|
597
|
-
/** @returns {
|
|
598
|
-
static
|
|
597
|
+
/** @returns {UserAttributeResponse} */
|
|
598
|
+
static UserAttributeResponse() {
|
|
599
599
|
return Joi.object({
|
|
600
600
|
_id: Joi.string().allow(""),
|
|
601
601
|
name: Joi.string().allow(""),
|
|
602
602
|
user_id: Joi.string().allow(""),
|
|
603
603
|
application_id: Joi.string().allow(""),
|
|
604
604
|
type: Joi.string().allow(""),
|
|
605
|
-
|
|
606
|
-
attribute: Joi.
|
|
605
|
+
customer_overriden: Joi.boolean(),
|
|
606
|
+
attribute: Joi.any(),
|
|
607
607
|
updated_by: Joi.string().allow(""),
|
|
608
608
|
});
|
|
609
609
|
}
|
|
610
610
|
|
|
611
|
-
/** @returns {
|
|
612
|
-
static
|
|
611
|
+
/** @returns {CreateUserAttributeRequest} */
|
|
612
|
+
static CreateUserAttributeRequest() {
|
|
613
613
|
return Joi.object({
|
|
614
|
-
|
|
615
|
-
attribute: Joi.
|
|
614
|
+
customer_overriden: Joi.boolean(),
|
|
615
|
+
attribute: Joi.any(),
|
|
616
616
|
});
|
|
617
617
|
}
|
|
618
618
|
|
|
@@ -736,7 +736,7 @@ class UserPlatformModel {
|
|
|
736
736
|
info: Joi.string().allow(""),
|
|
737
737
|
request_id: Joi.string().allow(""),
|
|
738
738
|
error: Joi.string().allow(""),
|
|
739
|
-
meta: Joi.
|
|
739
|
+
meta: Joi.any(),
|
|
740
740
|
authenticated: Joi.boolean(),
|
|
741
741
|
});
|
|
742
742
|
}
|
|
@@ -828,7 +828,7 @@ class UserPlatformModel {
|
|
|
828
828
|
last_name: Joi.string().allow(""),
|
|
829
829
|
gender: Joi.string().allow(""),
|
|
830
830
|
username: Joi.string().allow("").required(),
|
|
831
|
-
meta: Joi.
|
|
831
|
+
meta: Joi.any(),
|
|
832
832
|
external_id: Joi.string().allow(""),
|
|
833
833
|
rr_id: Joi.string().allow(""),
|
|
834
834
|
});
|
|
@@ -1082,7 +1082,7 @@ class UserPlatformModel {
|
|
|
1082
1082
|
gender: Joi.string().allow(""),
|
|
1083
1083
|
external_id: Joi.string().allow(""),
|
|
1084
1084
|
rr_id: Joi.string().allow(""),
|
|
1085
|
-
meta: Joi.
|
|
1085
|
+
meta: Joi.any(),
|
|
1086
1086
|
phone_numbers: Joi.array().items(UserPlatformModel.UserPhoneNumbers()),
|
|
1087
1087
|
emails: Joi.array().items(UserPlatformModel.UserEmails()),
|
|
1088
1088
|
});
|
|
@@ -1115,7 +1115,7 @@ class UserPlatformModel {
|
|
|
1115
1115
|
application_id: Joi.string().allow(""),
|
|
1116
1116
|
user_id: Joi.string().allow(""),
|
|
1117
1117
|
first_name: Joi.string().allow(""),
|
|
1118
|
-
meta: Joi.
|
|
1118
|
+
meta: Joi.any(),
|
|
1119
1119
|
last_name: Joi.string().allow(""),
|
|
1120
1120
|
phone_numbers: Joi.array().items(UserPlatformModel.PhoneNumber()),
|
|
1121
1121
|
emails: Joi.array().items(UserPlatformModel.Email()),
|
|
@@ -1139,7 +1139,7 @@ class UserPlatformModel {
|
|
|
1139
1139
|
application_id: Joi.string().allow(""),
|
|
1140
1140
|
user_id: Joi.string().allow(""),
|
|
1141
1141
|
first_name: Joi.string().allow(""),
|
|
1142
|
-
meta: Joi.
|
|
1142
|
+
meta: Joi.any(),
|
|
1143
1143
|
last_name: Joi.string().allow(""),
|
|
1144
1144
|
phone_numbers: Joi.array().items(UserPlatformModel.PhoneNumber()),
|
|
1145
1145
|
emails: Joi.array().items(UserPlatformModel.Email()),
|
|
@@ -2,26 +2,77 @@ export = Webhook;
|
|
|
2
2
|
declare class Webhook {
|
|
3
3
|
constructor(config: any);
|
|
4
4
|
config: any;
|
|
5
|
+
/**
|
|
6
|
+
* @param {WebhookPlatformValidator.CancelJobByNameParam} arg - Arg object
|
|
7
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
|
+
* @returns {Promise<WebhookPlatformModel.CancelResponse>} - Success response
|
|
10
|
+
* @name cancelJobByName
|
|
11
|
+
* @summary: Cancel job by name
|
|
12
|
+
* @description: It will cancel export job triggerd by user in order to fetch
|
|
13
|
+
* historical delivery summery - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/cancelJobByName/).
|
|
14
|
+
*/
|
|
15
|
+
cancelJobByName({ filename, requestHeaders }?: WebhookPlatformValidator.CancelJobByNameParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.CancelResponse>;
|
|
16
|
+
/**
|
|
17
|
+
* @param {WebhookPlatformValidator.DownloadDeliveryReportParam} arg - Arg object
|
|
18
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
19
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
20
|
+
* @returns {Promise<WebhookPlatformModel.DownloadReportResponse>} - Success response
|
|
21
|
+
* @name downloadDeliveryReport
|
|
22
|
+
* @summary: Download delivery report
|
|
23
|
+
* @description: Download detailed delivery reports for events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/downloadDeliveryReport/).
|
|
24
|
+
*/
|
|
25
|
+
downloadDeliveryReport({ body, requestHeaders }?: WebhookPlatformValidator.DownloadDeliveryReportParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.DownloadReportResponse>;
|
|
5
26
|
/**
|
|
6
27
|
* @param {WebhookPlatformValidator.FetchAllEventConfigurationsParam} arg - Arg object
|
|
7
28
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
29
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
|
-
* @returns {Promise<WebhookPlatformModel.
|
|
30
|
+
* @returns {Promise<WebhookPlatformModel.EventConfigResponse>} - Success response
|
|
10
31
|
* @name fetchAllEventConfigurations
|
|
11
32
|
* @summary: List event configurations
|
|
12
33
|
* @description: Retrieve all configurations for event handling. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/fetchAllEventConfigurations/).
|
|
13
34
|
*/
|
|
14
|
-
fetchAllEventConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.
|
|
35
|
+
fetchAllEventConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventConfigResponse>;
|
|
36
|
+
/**
|
|
37
|
+
* @param {WebhookPlatformValidator.GetDeliveryReportsParam} arg - Arg object
|
|
38
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
39
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
40
|
+
* @returns {Promise<WebhookPlatformModel.EventProcessReports>} - Success response
|
|
41
|
+
* @name getDeliveryReports
|
|
42
|
+
* @summary: Get delivery reports
|
|
43
|
+
* @description: Retrieve reports on the delivery status of events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getDeliveryReports/).
|
|
44
|
+
*/
|
|
45
|
+
getDeliveryReports({ body, requestHeaders }?: WebhookPlatformValidator.GetDeliveryReportsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventProcessReports>;
|
|
46
|
+
/**
|
|
47
|
+
* @param {WebhookPlatformValidator.GetHistoricalReportsParam} arg - Arg object
|
|
48
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
49
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
50
|
+
* @returns {Promise<WebhookPlatformModel.HistoryResponse>} - Success response
|
|
51
|
+
* @name getHistoricalReports
|
|
52
|
+
* @summary: Get historical reports
|
|
53
|
+
* @description: Retrieve historical reports of webhook events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getHistoricalReports/).
|
|
54
|
+
*/
|
|
55
|
+
getHistoricalReports({ body, requestHeaders }?: WebhookPlatformValidator.GetHistoricalReportsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.HistoryResponse>;
|
|
56
|
+
/**
|
|
57
|
+
* @param {WebhookPlatformValidator.GetReportFiltersParam} arg - Arg object
|
|
58
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
59
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
60
|
+
* @returns {Promise<WebhookPlatformModel.ReportFilterResponse[]>} - Success response
|
|
61
|
+
* @name getReportFilters
|
|
62
|
+
* @summary: Get report filters
|
|
63
|
+
* @description: Retrieve filters used for generating reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getReportFilters/).
|
|
64
|
+
*/
|
|
65
|
+
getReportFilters({ body, requestHeaders }?: WebhookPlatformValidator.GetReportFiltersParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.ReportFilterResponse[]>;
|
|
15
66
|
/**
|
|
16
67
|
* @param {WebhookPlatformValidator.GetSubscriberByIdParam} arg - Arg object
|
|
17
68
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
18
69
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
|
-
* @returns {Promise<WebhookPlatformModel.
|
|
70
|
+
* @returns {Promise<WebhookPlatformModel.SubscriberResponse>} - Success response
|
|
20
71
|
* @name getSubscriberById
|
|
21
72
|
* @summary: Get a subscriber
|
|
22
73
|
* @description: Retrieve a subscriber's details by their unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscriberById/).
|
|
23
74
|
*/
|
|
24
|
-
getSubscriberById({ subscriberId, requestHeaders }?: WebhookPlatformValidator.GetSubscriberByIdParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.
|
|
75
|
+
getSubscriberById({ subscriberId, requestHeaders }?: WebhookPlatformValidator.GetSubscriberByIdParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberResponse>;
|
|
25
76
|
/**
|
|
26
77
|
* @param {WebhookPlatformValidator.GetSubscribersByCompanyParam} arg - Arg object
|
|
27
78
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -42,60 +93,62 @@ declare class Webhook {
|
|
|
42
93
|
* @description: Retrieve subscribers associated with a specific extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByExtensionId/).
|
|
43
94
|
*/
|
|
44
95
|
getSubscribersByExtensionId({ extensionId, pageNo, pageSize, requestHeaders }?: WebhookPlatformValidator.GetSubscribersByExtensionIdParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigList>;
|
|
96
|
+
/**
|
|
97
|
+
* @param {WebhookPlatformValidator.PingWebhookParam} arg - Arg object
|
|
98
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
99
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
100
|
+
* @returns {Promise<WebhookPlatformModel.PingWebhookResponse>} - Success response
|
|
101
|
+
* @name pingWebhook
|
|
102
|
+
* @summary: Ping webhook
|
|
103
|
+
* @description: Send a test ping to a webhook for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/pingWebhook/).
|
|
104
|
+
*/
|
|
105
|
+
pingWebhook({ body, requestHeaders }?: WebhookPlatformValidator.PingWebhookParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.PingWebhookResponse>;
|
|
45
106
|
/**
|
|
46
107
|
* @param {WebhookPlatformValidator.RegisterSubscriberToEventParam} arg - Arg object
|
|
47
108
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
48
109
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
49
|
-
* @returns {Promise<WebhookPlatformModel.
|
|
110
|
+
* @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
|
|
111
|
+
* Success response
|
|
50
112
|
* @name registerSubscriberToEvent
|
|
51
113
|
* @summary: Register subscriber to event
|
|
52
114
|
* @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/).
|
|
53
115
|
*/
|
|
54
|
-
registerSubscriberToEvent({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.
|
|
116
|
+
registerSubscriberToEvent({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
|
|
55
117
|
/**
|
|
56
118
|
* @param {WebhookPlatformValidator.RegisterSubscriberToEventV2Param} arg - Arg object
|
|
57
119
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
58
120
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
59
|
-
* @returns {Promise<WebhookPlatformModel.
|
|
121
|
+
* @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
|
|
122
|
+
* Success response
|
|
60
123
|
* @name registerSubscriberToEventV2
|
|
61
124
|
* @summary: Register Subscriber.
|
|
62
125
|
* @description: Register Subscriber.
|
|
63
126
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEventV2/).
|
|
64
127
|
*/
|
|
65
|
-
registerSubscriberToEventV2({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventV2Param, { responseHeaders }?: object): Promise<WebhookPlatformModel.
|
|
128
|
+
registerSubscriberToEventV2({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventV2Param, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
|
|
66
129
|
/**
|
|
67
130
|
* @param {WebhookPlatformValidator.UpdateSubscriberConfigParam} arg - Arg object
|
|
68
131
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
69
132
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
70
|
-
* @returns {Promise<WebhookPlatformModel.
|
|
133
|
+
* @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
|
|
134
|
+
* Success response
|
|
71
135
|
* @name updateSubscriberConfig
|
|
72
136
|
* @summary: Update a subscriber config
|
|
73
137
|
* @description: Modify and update subscriber configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
|
|
74
138
|
*/
|
|
75
|
-
updateSubscriberConfig({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberConfigParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.
|
|
139
|
+
updateSubscriberConfig({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberConfigParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
|
|
76
140
|
/**
|
|
77
141
|
* @param {WebhookPlatformValidator.UpdateSubscriberV2Param} arg - Arg object
|
|
78
142
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
79
143
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
80
|
-
* @returns {Promise<WebhookPlatformModel.
|
|
144
|
+
* @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
|
|
145
|
+
* Success response
|
|
81
146
|
* @name updateSubscriberV2
|
|
82
147
|
* @summary: Update Subscriber.
|
|
83
148
|
* @description: Update Subscriber.
|
|
84
149
|
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberV2/).
|
|
85
150
|
*/
|
|
86
|
-
updateSubscriberV2({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberV2Param, { responseHeaders }?: object): Promise<WebhookPlatformModel.
|
|
87
|
-
/**
|
|
88
|
-
* @param {WebhookPlatformValidator.UpsertSubscriberEventParam} arg - Arg object
|
|
89
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
90
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
91
|
-
* @returns {Promise<WebhookPlatformModel.UpsertSubscriberConfigResult>} -
|
|
92
|
-
* Success response
|
|
93
|
-
* @name upsertSubscriberEvent
|
|
94
|
-
* @summary: Register Subscriber.
|
|
95
|
-
* @description: Register Subscriber.
|
|
96
|
-
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/upsertSubscriberEvent/).
|
|
97
|
-
*/
|
|
98
|
-
upsertSubscriberEvent({ body, requestHeaders }?: WebhookPlatformValidator.UpsertSubscriberEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.UpsertSubscriberConfigResult>;
|
|
151
|
+
updateSubscriberV2({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberV2Param, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
|
|
99
152
|
}
|
|
100
|
-
import WebhookPlatformModel = require("./WebhookPlatformModel");
|
|
101
153
|
import WebhookPlatformValidator = require("./WebhookPlatformValidator");
|
|
154
|
+
import WebhookPlatformModel = require("./WebhookPlatformModel");
|