@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15
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 +23 -26
- package/package.json +5 -1
- package/sdk/application/ApplicationClient.d.ts +5 -6
- package/sdk/application/ApplicationClient.js +24 -20
- package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
- package/sdk/application/Cart/CartApplicationClient.js +444 -76
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
- package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
- package/sdk/application/Content/ContentApplicationClient.js +274 -111
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +6 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
- package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
- package/sdk/application/Order/OrderApplicationClient.js +217 -17
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
- package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
- package/sdk/application/User/UserApplicationClient.d.ts +103 -53
- package/sdk/application/User/UserApplicationClient.js +308 -49
- package/sdk/common/AxiosHelper.js +11 -4
- package/sdk/common/Constant.d.ts +27 -4
- package/sdk/common/Constant.js +33 -6
- package/sdk/common/utils.d.ts +10 -0
- package/sdk/common/utils.js +24 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
- package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
- package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
- package/sdk/partner/PartnerClient.d.ts +5 -2
- package/sdk/partner/PartnerClient.js +21 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
- package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
- package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
- package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
- package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
- package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
- package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9571 -2674
- package/sdk/platform/Catalog/CatalogPlatformModel.js +5081 -2019
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
- package/sdk/platform/Common/CommonPlatformModel.js +25 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
- package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
- package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
- package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
- package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
- package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
- package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
- package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
- package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
- package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
- package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
- package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
- package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/PlatformClient.d.ts +5 -4
- package/sdk/platform/PlatformClient.js +32 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
- package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
- package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
- package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
- package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
- package/sdk/platform/User/UserPlatformModel.js +607 -46
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
- package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
- package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -2
- package/sdk/platform/index.js +0 -4
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
- package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
- package/sdk/public/Content/ContentPublicClient.js +1067 -17
- package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
- package/sdk/public/Content/ContentPublicModel.js +751 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
- package/sdk/public/Content/ContentPublicValidator.js +119 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +5 -2
- package/sdk/public/PublicClient.js +16 -6
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
- package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/utility.d.ts +3 -0
- package/utility.js +7 -0
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
- package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
- package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
|
@@ -2,29 +2,24 @@ const Joi = require("joi");
|
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* @typedef CategoryL1
|
|
5
|
-
* @property {string} [
|
|
6
|
-
* @property {string} [
|
|
7
|
-
* @property {number} [level]
|
|
8
|
-
* @property {string} [logo]
|
|
9
|
-
* @property {string} [slug]
|
|
10
|
-
* @property {string} [value]
|
|
11
|
-
* @property {string} [_id]
|
|
5
|
+
* @property {string} [slug] - URL-friendly identifier for the category.
|
|
6
|
+
* @property {string} [_id] - Unique identifier for the level 1 category.
|
|
12
7
|
*/
|
|
13
8
|
|
|
14
9
|
/**
|
|
15
10
|
* @typedef CategoryL2
|
|
16
|
-
* @property {string} [parent]
|
|
17
|
-
*
|
|
18
|
-
* @property {
|
|
19
|
-
* @property {string} [
|
|
20
|
-
* @property {string} [value]
|
|
21
|
-
* @property {string} [_id]
|
|
11
|
+
* @property {string} [parent] - ID of the parent category (Level 1) to which
|
|
12
|
+
* this category belongs.
|
|
13
|
+
* @property {string} [slug] - URL-friendly identifier for the category.
|
|
14
|
+
* @property {string} [_id] - Unique identifier for the level 2 category.
|
|
22
15
|
*/
|
|
23
16
|
|
|
24
17
|
/**
|
|
25
18
|
* @typedef CategoryCommon
|
|
26
|
-
* @property {CategoryL1[]} [
|
|
27
|
-
*
|
|
19
|
+
* @property {CategoryL1[]} [categories_l1] - Array of level 1 categories
|
|
20
|
+
* associated with an extension.
|
|
21
|
+
* @property {CategoryL2[]} [categories_l2] - Array of level 2 categories
|
|
22
|
+
* associated with an extension.
|
|
28
23
|
*/
|
|
29
24
|
|
|
30
25
|
/**
|
|
@@ -32,108 +27,117 @@ const Joi = require("joi");
|
|
|
32
27
|
* @property {Support} [support]
|
|
33
28
|
*/
|
|
34
29
|
|
|
30
|
+
/**
|
|
31
|
+
* @typedef CommingSoon
|
|
32
|
+
* @property {boolean} [is_coming_soon] - Flag indicating whether the extension
|
|
33
|
+
* is marked as "coming soon."
|
|
34
|
+
* @property {number} [upvote_count] - Number of upvotes for the "coming soon" extension.
|
|
35
|
+
*/
|
|
36
|
+
|
|
35
37
|
/**
|
|
36
38
|
* @typedef ExtensionUsingSlug
|
|
37
39
|
* @property {CategoryCommon} [category]
|
|
38
40
|
* @property {ContactInfo} [contact_info]
|
|
39
|
-
* @property {string} [created_at]
|
|
40
|
-
* @property {string} [current_status]
|
|
41
|
+
* @property {string} [created_at] - Timestamp indicating when the extension was created.
|
|
42
|
+
* @property {string} [current_status] - Current status of the extension.
|
|
41
43
|
* @property {Details} [details]
|
|
42
|
-
* @property {string} [extension_id]
|
|
43
|
-
* @property {
|
|
44
|
+
* @property {string} [extension_id] - Unique identifier for the extension.
|
|
45
|
+
* @property {CommingSoon} [coming_soon]
|
|
44
46
|
* @property {ListingInfo} [listing_info]
|
|
45
|
-
* @property {string} [modified_at]
|
|
47
|
+
* @property {string} [modified_at] - Timestamp indicating when the extension
|
|
48
|
+
* was last modified.
|
|
46
49
|
* @property {Organization} [organization]
|
|
47
|
-
* @property {string} [organization_id]
|
|
48
|
-
*
|
|
49
|
-
* @property {
|
|
50
|
-
*
|
|
51
|
-
* @property {
|
|
52
|
-
* @property {string
|
|
53
|
-
* @property {string} [
|
|
54
|
-
*
|
|
50
|
+
* @property {string} [organization_id] - Unique identifier for the organization
|
|
51
|
+
* where the extension is created.
|
|
52
|
+
* @property {string} [plan_type] - Type of pricing plan for the extension
|
|
53
|
+
* (e.g., free, one-time, recurring).
|
|
54
|
+
* @property {Plans[]} [plans] - Array of pricing plans associated with the extension.
|
|
55
|
+
* @property {string} [plans_url] - URL to access detailed pricing plan information.
|
|
56
|
+
* @property {string[]} [scope] - Array of permissions or scopes required by the
|
|
57
|
+
* extension.
|
|
58
|
+
* @property {string} [slug] - URL-friendly identifier for the extension.
|
|
59
|
+
* @property {string} [_id] - Unique identifier for the extension.
|
|
55
60
|
*/
|
|
56
61
|
|
|
57
62
|
/**
|
|
58
63
|
* @typedef Organization
|
|
59
|
-
* @property {string} [name]
|
|
60
|
-
* @property {string} [slug]
|
|
64
|
+
* @property {string} [name] - Name of the organization.
|
|
65
|
+
* @property {string} [slug] - URL-friendly identifier for the organization.
|
|
61
66
|
*/
|
|
62
67
|
|
|
63
68
|
/**
|
|
64
69
|
* @typedef ListingInfo
|
|
65
|
-
* @property {string} [icon]
|
|
66
|
-
* @property {string[]} [keywords]
|
|
67
|
-
* @property {string} [name]
|
|
68
|
-
* @property {string} [tagline]
|
|
70
|
+
* @property {string} [icon] - URL for the extension's icon.
|
|
71
|
+
* @property {string[]} [keywords] - Array of keywords associated with the extension.
|
|
72
|
+
* @property {string} [name] - Display name of the extension.
|
|
73
|
+
* @property {string} [tagline] - Short tagline summarizing the extension's purpose.
|
|
69
74
|
*/
|
|
70
75
|
|
|
71
76
|
/**
|
|
72
77
|
* @typedef Benefits
|
|
73
|
-
* @property {string} [title]
|
|
74
|
-
* @property {string} [description]
|
|
78
|
+
* @property {string} [title] - Title of the benefit offered by the extension.
|
|
79
|
+
* @property {string} [description] - Detailed explanation of the benefit.
|
|
75
80
|
*/
|
|
76
81
|
|
|
77
82
|
/**
|
|
78
83
|
* @typedef Screenshots
|
|
79
|
-
* @property {string[]} [desktop]
|
|
80
|
-
* @property {string[]} [mobile]
|
|
84
|
+
* @property {string[]} [desktop] - Array of URLs for desktop screenshots.
|
|
85
|
+
* @property {string[]} [mobile] - Array of URLs for mobile screenshots.
|
|
81
86
|
*/
|
|
82
87
|
|
|
83
88
|
/**
|
|
84
89
|
* @typedef Details
|
|
85
|
-
* @property {Benefits[]} [benefits]
|
|
86
|
-
* @property {string} [demo_url]
|
|
87
|
-
* @property {string} [description]
|
|
88
|
-
* @property {string[]} [integration]
|
|
89
|
-
*
|
|
90
|
-
* @property {
|
|
90
|
+
* @property {Benefits[]} [benefits] - Array of benefits provided by the extension.
|
|
91
|
+
* @property {string} [demo_url] - URL for a demo or preview of the extension.
|
|
92
|
+
* @property {string} [description] - Detailed description of the extension.
|
|
93
|
+
* @property {string[]} [integration] - Array of integration points supported by
|
|
94
|
+
* the extension.
|
|
95
|
+
* @property {Object[]} [video_url] - Array of video URLs showcasing the extension.
|
|
96
|
+
* @property {string[]} [youtube] - Array of YouTube video URLs about the extension.
|
|
91
97
|
* @property {Screenshots} [screenshots]
|
|
92
98
|
*/
|
|
93
99
|
|
|
94
100
|
/**
|
|
95
101
|
* @typedef Support
|
|
96
|
-
* @property {string} [email]
|
|
97
|
-
* @property {string} [faq_url]
|
|
98
|
-
* @property {string} [phone]
|
|
99
|
-
* @property {string} [privacy_policy_url]
|
|
100
|
-
* @property {string} [website_url]
|
|
102
|
+
* @property {string} [email] - Support email address.
|
|
103
|
+
* @property {string} [faq_url] - URL for the FAQ page.
|
|
104
|
+
* @property {string} [phone] - Support phone number.
|
|
105
|
+
* @property {string} [privacy_policy_url] - URL for the privacy policy.
|
|
106
|
+
* @property {string} [website_url] - Official website URL.
|
|
107
|
+
* @property {string} [terms_of_service] - URL for the terms of service.
|
|
108
|
+
* @property {string} [country_code] - The dialing code for the country, used
|
|
109
|
+
* with mobile numbers.
|
|
101
110
|
*/
|
|
102
111
|
|
|
103
112
|
/**
|
|
104
113
|
* @typedef Price
|
|
105
|
-
* @property {number} [amount]
|
|
106
|
-
* @property {string} [currency]
|
|
114
|
+
* @property {number} [amount] - Amount for the pricing.
|
|
115
|
+
* @property {string} [currency] - Currency in which the price is specified.
|
|
107
116
|
*/
|
|
108
117
|
|
|
109
118
|
/**
|
|
110
119
|
* @typedef Plans
|
|
111
|
-
* @property {string} [additional_charges]
|
|
112
|
-
* @property {string} [features]
|
|
113
|
-
* @property {string} [name]
|
|
114
|
-
* @property {number} [trial_days]
|
|
115
|
-
* @property {string} [type]
|
|
120
|
+
* @property {string} [additional_charges] - Additional charges applicable to the plan.
|
|
121
|
+
* @property {string} [features] - Features included in the plan.
|
|
122
|
+
* @property {string} [name] - Name of the plan.
|
|
123
|
+
* @property {number} [trial_days] - Number of trial days offered with the plan.
|
|
124
|
+
* @property {string} [type] - Type of plan (e.g., free, recurring, one-time).
|
|
116
125
|
* @property {Price} [price]
|
|
117
126
|
* @property {Recurring} [recurring]
|
|
118
127
|
*/
|
|
119
128
|
|
|
120
129
|
/**
|
|
121
130
|
* @typedef Recurring
|
|
122
|
-
* @property {number} [recurring_time]
|
|
123
|
-
* @property {number} [yearly_amount]
|
|
124
|
-
* @property {string} [type]
|
|
131
|
+
* @property {number} [recurring_time] - Frequency of the recurring charge in days.
|
|
132
|
+
* @property {number} [yearly_amount] - Total yearly amount for the recurring plan.
|
|
133
|
+
* @property {string} [type] - Type of recurring plan (e.g., monthly, yearly).
|
|
125
134
|
*/
|
|
126
135
|
|
|
127
136
|
class PartnerPublicModel {
|
|
128
137
|
/** @returns {CategoryL1} */
|
|
129
138
|
static CategoryL1() {
|
|
130
139
|
return Joi.object({
|
|
131
|
-
description: Joi.string().allow(""),
|
|
132
|
-
display: Joi.string().allow(""),
|
|
133
|
-
level: Joi.number(),
|
|
134
|
-
logo: Joi.string().allow(""),
|
|
135
140
|
slug: Joi.string().allow(""),
|
|
136
|
-
value: Joi.string().allow(""),
|
|
137
141
|
_id: Joi.string().allow(""),
|
|
138
142
|
});
|
|
139
143
|
}
|
|
@@ -142,10 +146,7 @@ class PartnerPublicModel {
|
|
|
142
146
|
static CategoryL2() {
|
|
143
147
|
return Joi.object({
|
|
144
148
|
parent: Joi.string().allow(""),
|
|
145
|
-
display: Joi.string().allow(""),
|
|
146
|
-
level: Joi.number(),
|
|
147
149
|
slug: Joi.string().allow(""),
|
|
148
|
-
value: Joi.string().allow(""),
|
|
149
150
|
_id: Joi.string().allow(""),
|
|
150
151
|
});
|
|
151
152
|
}
|
|
@@ -153,8 +154,8 @@ class PartnerPublicModel {
|
|
|
153
154
|
/** @returns {CategoryCommon} */
|
|
154
155
|
static CategoryCommon() {
|
|
155
156
|
return Joi.object({
|
|
156
|
-
|
|
157
|
-
|
|
157
|
+
categories_l1: Joi.array().items(PartnerPublicModel.CategoryL1()),
|
|
158
|
+
categories_l2: Joi.array().items(PartnerPublicModel.CategoryL2()),
|
|
158
159
|
});
|
|
159
160
|
}
|
|
160
161
|
|
|
@@ -165,6 +166,14 @@ class PartnerPublicModel {
|
|
|
165
166
|
});
|
|
166
167
|
}
|
|
167
168
|
|
|
169
|
+
/** @returns {CommingSoon} */
|
|
170
|
+
static CommingSoon() {
|
|
171
|
+
return Joi.object({
|
|
172
|
+
is_coming_soon: Joi.boolean(),
|
|
173
|
+
upvote_count: Joi.number(),
|
|
174
|
+
});
|
|
175
|
+
}
|
|
176
|
+
|
|
168
177
|
/** @returns {ExtensionUsingSlug} */
|
|
169
178
|
static ExtensionUsingSlug() {
|
|
170
179
|
return Joi.object({
|
|
@@ -174,7 +183,7 @@ class PartnerPublicModel {
|
|
|
174
183
|
current_status: Joi.string().allow(""),
|
|
175
184
|
details: PartnerPublicModel.Details(),
|
|
176
185
|
extension_id: Joi.string().allow(""),
|
|
177
|
-
|
|
186
|
+
coming_soon: PartnerPublicModel.CommingSoon(),
|
|
178
187
|
listing_info: PartnerPublicModel.ListingInfo(),
|
|
179
188
|
modified_at: Joi.string().allow(""),
|
|
180
189
|
organization: PartnerPublicModel.Organization(),
|
|
@@ -182,7 +191,6 @@ class PartnerPublicModel {
|
|
|
182
191
|
plan_type: Joi.string().allow(""),
|
|
183
192
|
plans: Joi.array().items(PartnerPublicModel.Plans()),
|
|
184
193
|
plans_url: Joi.string().allow(""),
|
|
185
|
-
review_instructions: Joi.string().allow(""),
|
|
186
194
|
scope: Joi.array().items(Joi.string().allow("")),
|
|
187
195
|
slug: Joi.string().allow(""),
|
|
188
196
|
_id: Joi.string().allow(""),
|
|
@@ -244,6 +252,8 @@ class PartnerPublicModel {
|
|
|
244
252
|
phone: Joi.string().allow(""),
|
|
245
253
|
privacy_policy_url: Joi.string().allow(""),
|
|
246
254
|
website_url: Joi.string().allow(""),
|
|
255
|
+
terms_of_service: Joi.string().allow(""),
|
|
256
|
+
country_code: Joi.string().allow(""),
|
|
247
257
|
});
|
|
248
258
|
}
|
|
249
259
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export = PartnerPublicValidator;
|
|
2
2
|
/**
|
|
3
3
|
* @typedef GetPanelExtensionDetailsParam
|
|
4
|
-
* @property {string} slug -
|
|
4
|
+
* @property {string} slug - Slug of the extension
|
|
5
5
|
*/
|
|
6
6
|
declare class PartnerPublicValidator {
|
|
7
7
|
/** @returns {GetPanelExtensionDetailsParam} */
|
|
@@ -12,7 +12,7 @@ declare namespace PartnerPublicValidator {
|
|
|
12
12
|
}
|
|
13
13
|
type GetPanelExtensionDetailsParam = {
|
|
14
14
|
/**
|
|
15
|
-
* -
|
|
15
|
+
* - Slug of the extension
|
|
16
16
|
*/
|
|
17
17
|
slug: string;
|
|
18
18
|
};
|
|
@@ -10,8 +10,9 @@ declare class PublicClient {
|
|
|
10
10
|
*
|
|
11
11
|
* @param {import("./PublicConfig")} config - The configuration for the public client.
|
|
12
12
|
*/
|
|
13
|
-
constructor(config: import("./PublicConfig"));
|
|
14
|
-
config:
|
|
13
|
+
constructor(config: import("./PublicConfig"), options: any);
|
|
14
|
+
config: PublicConfig;
|
|
15
|
+
catalog: Catalog;
|
|
15
16
|
configuration: Configuration;
|
|
16
17
|
content: Content;
|
|
17
18
|
partner: Partner;
|
|
@@ -24,6 +25,8 @@ declare class PublicClient {
|
|
|
24
25
|
*/
|
|
25
26
|
setExtraHeaders(header: object): void;
|
|
26
27
|
}
|
|
28
|
+
import PublicConfig = require("./PublicConfig");
|
|
29
|
+
import Catalog = require("./Catalog/CatalogPublicClient");
|
|
27
30
|
import Configuration = require("./Configuration/ConfigurationPublicClient");
|
|
28
31
|
import Content = require("./Content/ContentPublicClient");
|
|
29
32
|
import Partner = require("./Partner/PartnerPublicClient");
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
const Catalog = require("./Catalog/CatalogPublicClient");
|
|
2
|
+
|
|
1
3
|
const Configuration = require("./Configuration/ConfigurationPublicClient");
|
|
2
4
|
|
|
3
5
|
const Content = require("./Content/ContentPublicClient");
|
|
@@ -7,6 +9,7 @@ const Partner = require("./Partner/PartnerPublicClient");
|
|
|
7
9
|
const Webhook = require("./Webhook/WebhookPublicClient");
|
|
8
10
|
|
|
9
11
|
const { FDKClientValidationError } = require("../common/FDKError");
|
|
12
|
+
const PublicConfig = require("./PublicConfig");
|
|
10
13
|
|
|
11
14
|
/**
|
|
12
15
|
* Represents the client for the public APIs.
|
|
@@ -19,16 +22,23 @@ class PublicClient {
|
|
|
19
22
|
*
|
|
20
23
|
* @param {import("./PublicConfig")} config - The configuration for the public client.
|
|
21
24
|
*/
|
|
22
|
-
constructor(config) {
|
|
23
|
-
|
|
25
|
+
constructor(config, options) {
|
|
26
|
+
if (config instanceof PublicConfig) {
|
|
27
|
+
this.config = config;
|
|
28
|
+
} else {
|
|
29
|
+
let publicConfig = new PublicConfig(config, options);
|
|
30
|
+
this.config = publicConfig;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
this.catalog = new Catalog(this.config);
|
|
24
34
|
|
|
25
|
-
this.configuration = new Configuration(config);
|
|
35
|
+
this.configuration = new Configuration(this.config);
|
|
26
36
|
|
|
27
|
-
this.content = new Content(config);
|
|
37
|
+
this.content = new Content(this.config);
|
|
28
38
|
|
|
29
|
-
this.partner = new Partner(config);
|
|
39
|
+
this.partner = new Partner(this.config);
|
|
30
40
|
|
|
31
|
-
this.webhook = new Webhook(config);
|
|
41
|
+
this.webhook = new Webhook(this.config);
|
|
32
42
|
}
|
|
33
43
|
|
|
34
44
|
/**
|
|
@@ -15,12 +15,12 @@ declare class Webhook {
|
|
|
15
15
|
* @param {WebhookPublicValidator.FetchAllWebhookEventsParam} arg - Arg object.
|
|
16
16
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
17
17
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
18
|
-
* @returns {Promise<WebhookPublicModel.
|
|
18
|
+
* @returns {Promise<WebhookPublicModel.EventDetails>} - Success response
|
|
19
19
|
* @name fetchAllWebhookEvents
|
|
20
20
|
* @summary: Fetch all webhook events.
|
|
21
|
-
* @description: Retrieve a list of all webhook events in the public server setup. - Check out [method documentation](https://
|
|
21
|
+
* @description: Retrieve a list of all webhook events in the public server setup. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/public/webhook/fetchAllWebhookEvents/).
|
|
22
22
|
*/
|
|
23
|
-
fetchAllWebhookEvents({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPublicModel.
|
|
23
|
+
fetchAllWebhookEvents({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPublicModel.EventDetails>;
|
|
24
24
|
/**
|
|
25
25
|
* @param {WebhookPublicValidator.NotifyDepricatedEventParam} arg - Arg object.
|
|
26
26
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -28,39 +28,39 @@ declare class Webhook {
|
|
|
28
28
|
* @returns {Promise<WebhookPublicModel.EventNotifier>} - Success response
|
|
29
29
|
* @name notifyDepricatedEvent
|
|
30
30
|
* @summary: Notifies all the events that are going to depricate
|
|
31
|
-
* @description: Notifies all the events that are subscribed and are going to deprecate or new version is available for those events - Check out [method documentation](https://
|
|
31
|
+
* @description: Notifies all the events that are subscribed and are going to deprecate or new version is available for those events - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/public/webhook/notifyDepricatedEvent/).
|
|
32
32
|
*/
|
|
33
33
|
notifyDepricatedEvent({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPublicModel.EventNotifier>;
|
|
34
34
|
/**
|
|
35
35
|
* @param {WebhookPublicValidator.QueryWebhookEventDetailsParam} arg - Arg object.
|
|
36
36
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
37
37
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
38
|
-
* @returns {Promise<WebhookPublicModel.
|
|
38
|
+
* @returns {Promise<WebhookPublicModel.EventDetails>} - Success response
|
|
39
39
|
* @name queryWebhookEventDetails
|
|
40
40
|
* @summary: Query webhook event details.
|
|
41
|
-
* @description: Query and obtain detailed information about webhook events in the public server configurations. - Check out [method documentation](https://
|
|
41
|
+
* @description: Query and obtain detailed information about webhook events in the public server configurations. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/public/webhook/queryWebhookEventDetails/).
|
|
42
42
|
*/
|
|
43
|
-
queryWebhookEventDetails({ body, requestHeaders }?: WebhookPublicValidator.QueryWebhookEventDetailsParam, { responseHeaders }?: object): Promise<WebhookPublicModel.
|
|
43
|
+
queryWebhookEventDetails({ body, requestHeaders }?: WebhookPublicValidator.QueryWebhookEventDetailsParam, { responseHeaders }?: object): Promise<WebhookPublicModel.EventDetails>;
|
|
44
44
|
/**
|
|
45
45
|
* @param {WebhookPublicValidator.TestHandlerTransformationParam} arg - Arg object.
|
|
46
46
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
47
47
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
48
|
-
* @returns {Promise<WebhookPublicModel.
|
|
48
|
+
* @returns {Promise<WebhookPublicModel.TransformEventResult>} - Success response
|
|
49
49
|
* @name testHandlerTransformation
|
|
50
50
|
* @summary: Test transformation of handler
|
|
51
|
-
* @description: Test transformation of handler - Check out [method documentation](https://
|
|
51
|
+
* @description: Test transformation of handler - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/public/webhook/testHandlerTransformation/).
|
|
52
52
|
*/
|
|
53
|
-
testHandlerTransformation({ body, requestHeaders }?: WebhookPublicValidator.TestHandlerTransformationParam, { responseHeaders }?: object): Promise<WebhookPublicModel.
|
|
53
|
+
testHandlerTransformation({ body, requestHeaders }?: WebhookPublicValidator.TestHandlerTransformationParam, { responseHeaders }?: object): Promise<WebhookPublicModel.TransformEventResult>;
|
|
54
54
|
/**
|
|
55
55
|
* @param {WebhookPublicValidator.ValidateSchemaParam} arg - Arg object.
|
|
56
56
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
57
57
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
58
|
-
* @returns {Promise<WebhookPublicModel.
|
|
58
|
+
* @returns {Promise<WebhookPublicModel.ValidateSchemaResult>} - Success response
|
|
59
59
|
* @name validateSchema
|
|
60
60
|
* @summary: Validate Schema for an event
|
|
61
|
-
* @description: Validate Schema for an event - Check out [method documentation](https://
|
|
61
|
+
* @description: Validate Schema for an event - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/public/webhook/validateSchema/).
|
|
62
62
|
*/
|
|
63
|
-
validateSchema({ body, requestHeaders }?: WebhookPublicValidator.ValidateSchemaParam, { responseHeaders }?: object): Promise<WebhookPublicModel.
|
|
63
|
+
validateSchema({ body, requestHeaders }?: WebhookPublicValidator.ValidateSchemaParam, { responseHeaders }?: object): Promise<WebhookPublicModel.ValidateSchemaResult>;
|
|
64
64
|
}
|
|
65
65
|
import WebhookPublicModel = require("./WebhookPublicModel");
|
|
66
66
|
import WebhookPublicValidator = require("./WebhookPublicValidator");
|
|
@@ -47,10 +47,10 @@ class Webhook {
|
|
|
47
47
|
* @param {WebhookPublicValidator.FetchAllWebhookEventsParam} arg - Arg object.
|
|
48
48
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
49
49
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
50
|
-
* @returns {Promise<WebhookPublicModel.
|
|
50
|
+
* @returns {Promise<WebhookPublicModel.EventDetails>} - Success response
|
|
51
51
|
* @name fetchAllWebhookEvents
|
|
52
52
|
* @summary: Fetch all webhook events.
|
|
53
|
-
* @description: Retrieve a list of all webhook events in the public server setup. - Check out [method documentation](https://
|
|
53
|
+
* @description: Retrieve a list of all webhook events in the public server setup. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/public/webhook/fetchAllWebhookEvents/).
|
|
54
54
|
*/
|
|
55
55
|
async fetchAllWebhookEvents(
|
|
56
56
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -102,7 +102,7 @@ class Webhook {
|
|
|
102
102
|
|
|
103
103
|
const {
|
|
104
104
|
error: res_error,
|
|
105
|
-
} = WebhookPublicModel.
|
|
105
|
+
} = WebhookPublicModel.EventDetails().validate(responseData, {
|
|
106
106
|
abortEarly: false,
|
|
107
107
|
allowUnknown: true,
|
|
108
108
|
});
|
|
@@ -128,7 +128,7 @@ class Webhook {
|
|
|
128
128
|
* @returns {Promise<WebhookPublicModel.EventNotifier>} - Success response
|
|
129
129
|
* @name notifyDepricatedEvent
|
|
130
130
|
* @summary: Notifies all the events that are going to depricate
|
|
131
|
-
* @description: Notifies all the events that are subscribed and are going to deprecate or new version is available for those events - Check out [method documentation](https://
|
|
131
|
+
* @description: Notifies all the events that are subscribed and are going to deprecate or new version is available for those events - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/public/webhook/notifyDepricatedEvent/).
|
|
132
132
|
*/
|
|
133
133
|
async notifyDepricatedEvent(
|
|
134
134
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -203,10 +203,10 @@ class Webhook {
|
|
|
203
203
|
* @param {WebhookPublicValidator.QueryWebhookEventDetailsParam} arg - Arg object.
|
|
204
204
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
205
205
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
206
|
-
* @returns {Promise<WebhookPublicModel.
|
|
206
|
+
* @returns {Promise<WebhookPublicModel.EventDetails>} - Success response
|
|
207
207
|
* @name queryWebhookEventDetails
|
|
208
208
|
* @summary: Query webhook event details.
|
|
209
|
-
* @description: Query and obtain detailed information about webhook events in the public server configurations. - Check out [method documentation](https://
|
|
209
|
+
* @description: Query and obtain detailed information about webhook events in the public server configurations. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/public/webhook/queryWebhookEventDetails/).
|
|
210
210
|
*/
|
|
211
211
|
async queryWebhookEventDetails(
|
|
212
212
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -260,7 +260,7 @@ class Webhook {
|
|
|
260
260
|
|
|
261
261
|
const {
|
|
262
262
|
error: res_error,
|
|
263
|
-
} = WebhookPublicModel.
|
|
263
|
+
} = WebhookPublicModel.EventDetails().validate(responseData, {
|
|
264
264
|
abortEarly: false,
|
|
265
265
|
allowUnknown: true,
|
|
266
266
|
});
|
|
@@ -283,10 +283,10 @@ class Webhook {
|
|
|
283
283
|
* @param {WebhookPublicValidator.TestHandlerTransformationParam} arg - Arg object.
|
|
284
284
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
285
285
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
286
|
-
* @returns {Promise<WebhookPublicModel.
|
|
286
|
+
* @returns {Promise<WebhookPublicModel.TransformEventResult>} - Success response
|
|
287
287
|
* @name testHandlerTransformation
|
|
288
288
|
* @summary: Test transformation of handler
|
|
289
|
-
* @description: Test transformation of handler - Check out [method documentation](https://
|
|
289
|
+
* @description: Test transformation of handler - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/public/webhook/testHandlerTransformation/).
|
|
290
290
|
*/
|
|
291
291
|
async testHandlerTransformation(
|
|
292
292
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -340,7 +340,7 @@ class Webhook {
|
|
|
340
340
|
|
|
341
341
|
const {
|
|
342
342
|
error: res_error,
|
|
343
|
-
} = WebhookPublicModel.
|
|
343
|
+
} = WebhookPublicModel.TransformEventResult().validate(responseData, {
|
|
344
344
|
abortEarly: false,
|
|
345
345
|
allowUnknown: true,
|
|
346
346
|
});
|
|
@@ -363,10 +363,10 @@ class Webhook {
|
|
|
363
363
|
* @param {WebhookPublicValidator.ValidateSchemaParam} arg - Arg object.
|
|
364
364
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
365
365
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
366
|
-
* @returns {Promise<WebhookPublicModel.
|
|
366
|
+
* @returns {Promise<WebhookPublicModel.ValidateSchemaResult>} - Success response
|
|
367
367
|
* @name validateSchema
|
|
368
368
|
* @summary: Validate Schema for an event
|
|
369
|
-
* @description: Validate Schema for an event - Check out [method documentation](https://
|
|
369
|
+
* @description: Validate Schema for an event - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/public/webhook/validateSchema/).
|
|
370
370
|
*/
|
|
371
371
|
async validateSchema(
|
|
372
372
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -418,7 +418,7 @@ class Webhook {
|
|
|
418
418
|
|
|
419
419
|
const {
|
|
420
420
|
error: res_error,
|
|
421
|
-
} = WebhookPublicModel.
|
|
421
|
+
} = WebhookPublicModel.ValidateSchemaResult().validate(responseData, {
|
|
422
422
|
abortEarly: false,
|
|
423
423
|
allowUnknown: true,
|
|
424
424
|
});
|