@gofynd/fdk-client-javascript 1.4.15-beta.14 → 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 +9573 -2678
- package/sdk/platform/Catalog/CatalogPlatformModel.js +5033 -1973
- 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
|
@@ -17,7 +17,7 @@ const Joi = require("joi");
|
|
|
17
17
|
*/
|
|
18
18
|
|
|
19
19
|
/**
|
|
20
|
-
* @typedef
|
|
20
|
+
* @typedef DraftExtensionSection
|
|
21
21
|
* @property {string} [extension_id]
|
|
22
22
|
* @property {string} [bundle_name]
|
|
23
23
|
* @property {string} [organization_id]
|
|
@@ -28,12 +28,12 @@ const Joi = require("joi");
|
|
|
28
28
|
*/
|
|
29
29
|
|
|
30
30
|
/**
|
|
31
|
-
* @typedef
|
|
32
|
-
* @property {
|
|
31
|
+
* @typedef ExtensionSectionDraft
|
|
32
|
+
* @property {Sections} [sections]
|
|
33
33
|
*/
|
|
34
34
|
|
|
35
35
|
/**
|
|
36
|
-
* @typedef
|
|
36
|
+
* @typedef Sections
|
|
37
37
|
* @property {boolean} [acknowledged]
|
|
38
38
|
* @property {number} [matched_count]
|
|
39
39
|
* @property {number} [modified_count]
|
|
@@ -64,7 +64,7 @@ const Joi = require("joi");
|
|
|
64
64
|
*/
|
|
65
65
|
|
|
66
66
|
/**
|
|
67
|
-
* @typedef
|
|
67
|
+
* @typedef PublishExtensionSection
|
|
68
68
|
* @property {string} [extension_id]
|
|
69
69
|
* @property {string} [bundle_name]
|
|
70
70
|
* @property {string} [organization_id]
|
|
@@ -75,19 +75,19 @@ const Joi = require("joi");
|
|
|
75
75
|
*/
|
|
76
76
|
|
|
77
77
|
/**
|
|
78
|
-
* @typedef
|
|
78
|
+
* @typedef PreviewExtension
|
|
79
79
|
* @property {string} [application_id] - Application ID
|
|
80
80
|
* @property {string} [section_preview_hash] - Hash for the section preview
|
|
81
81
|
*/
|
|
82
82
|
|
|
83
83
|
/**
|
|
84
|
-
* @typedef
|
|
84
|
+
* @typedef ExtensionPreview
|
|
85
85
|
* @property {string} [message]
|
|
86
86
|
*/
|
|
87
87
|
|
|
88
88
|
/**
|
|
89
|
-
* @typedef
|
|
90
|
-
* @property {
|
|
89
|
+
* @typedef ExtensionSectionPublish
|
|
90
|
+
* @property {Sections} [sections]
|
|
91
91
|
*/
|
|
92
92
|
|
|
93
93
|
/**
|
|
@@ -144,7 +144,16 @@ const Joi = require("joi");
|
|
|
144
144
|
* @property {Object[]} [blocks]
|
|
145
145
|
* @property {Object} [preset]
|
|
146
146
|
* @property {AvailablePagePredicate} [predicate]
|
|
147
|
-
* @property {
|
|
147
|
+
* @property {SectionSource} [__source]
|
|
148
|
+
*/
|
|
149
|
+
|
|
150
|
+
/**
|
|
151
|
+
* @typedef SectionSource
|
|
152
|
+
* @property {string} [id] - The source id specifying the source of the section.
|
|
153
|
+
* @property {string} [bundle_name] - This is the extension binding name
|
|
154
|
+
* containing this section.
|
|
155
|
+
* @property {string} [type] - This is source type. It will either be
|
|
156
|
+
* themeBundle or extension.
|
|
148
157
|
*/
|
|
149
158
|
|
|
150
159
|
/**
|
|
@@ -313,13 +322,29 @@ const Joi = require("joi");
|
|
|
313
322
|
* @property {string} admin_id - The ID of the admin who rejected the theme
|
|
314
323
|
* @property {string} user_id - The ID of the user who submitted the theme
|
|
315
324
|
* @property {string} status - The status of the theme (e.g., rejected)
|
|
316
|
-
* @property {
|
|
325
|
+
* @property {RejectedMessages} rejection_reasons
|
|
317
326
|
* @property {string} [created_at] - The date and time when the theme rejection
|
|
318
327
|
* reasons object was created
|
|
319
328
|
* @property {string} [updated_at] - The date and time when the theme rejection
|
|
320
329
|
* reasons object was last updated
|
|
321
330
|
*/
|
|
322
331
|
|
|
332
|
+
/**
|
|
333
|
+
* @typedef RejectedMessages
|
|
334
|
+
* @property {ThemeReviewRequestMessage} [theme_file]
|
|
335
|
+
* @property {ThemeReviewRequestMessage} [theme_details]
|
|
336
|
+
* @property {ThemeReviewRequestMessage} [theme_value_proposition]
|
|
337
|
+
* @property {ThemeReviewRequestMessage} [theme_attributes]
|
|
338
|
+
* @property {ThemeReviewRequestMessage} [theme_variations]
|
|
339
|
+
* @property {ThemeReviewRequestMessage} [theme_docs]
|
|
340
|
+
* @property {ThemeReviewRequestMessage} [theme_review]
|
|
341
|
+
*/
|
|
342
|
+
|
|
343
|
+
/**
|
|
344
|
+
* @typedef ThemeReviewRequestMessage
|
|
345
|
+
* @property {string} [message] - Message Explaining what the issue is
|
|
346
|
+
*/
|
|
347
|
+
|
|
323
348
|
/**
|
|
324
349
|
* @typedef AllAvailablePageSchema
|
|
325
350
|
* @property {AvailablePageSchema[]} [pages]
|
|
@@ -550,7 +575,17 @@ const Joi = require("joi");
|
|
|
550
575
|
|
|
551
576
|
/**
|
|
552
577
|
* @typedef GlobalSchema
|
|
553
|
-
* @property {
|
|
578
|
+
* @property {Prop[]} [props]
|
|
579
|
+
*/
|
|
580
|
+
|
|
581
|
+
/**
|
|
582
|
+
* @typedef Prop
|
|
583
|
+
* @property {string} [type] - The type of the property
|
|
584
|
+
* @property {string} [category] - The category of the property
|
|
585
|
+
* @property {string} [value] - The value of the property
|
|
586
|
+
* @property {string} [id] - The ID of the property
|
|
587
|
+
* @property {string} [label] - The label of the property
|
|
588
|
+
* @property {string} [info] - Additional information about the property
|
|
554
589
|
*/
|
|
555
590
|
|
|
556
591
|
/**
|
|
@@ -711,8 +746,8 @@ const Joi = require("joi");
|
|
|
711
746
|
* | "profile-order-shipment"
|
|
712
747
|
* | "profile-basic"
|
|
713
748
|
* | "profile-company"
|
|
714
|
-
* | "profile-
|
|
715
|
-
* | "profile-
|
|
749
|
+
* | "profile-email"
|
|
750
|
+
* | "profile-phone"
|
|
716
751
|
* | "rate-us"
|
|
717
752
|
* | "refer-earn"
|
|
718
753
|
* | "settings"
|
|
@@ -730,7 +765,10 @@ const Joi = require("joi");
|
|
|
730
765
|
* | "shipping-policy"
|
|
731
766
|
* | "return-policy"
|
|
732
767
|
* | "order-status"
|
|
733
|
-
* | "locate-us"
|
|
768
|
+
* | "locate-us"
|
|
769
|
+
* | "single-page-checkout"
|
|
770
|
+
* | "request-reattempt"
|
|
771
|
+
* | "files"} PageType
|
|
734
772
|
*/
|
|
735
773
|
|
|
736
774
|
class ThemePartnerModel {
|
|
@@ -756,8 +794,8 @@ class ThemePartnerModel {
|
|
|
756
794
|
});
|
|
757
795
|
}
|
|
758
796
|
|
|
759
|
-
/** @returns {
|
|
760
|
-
static
|
|
797
|
+
/** @returns {DraftExtensionSection} */
|
|
798
|
+
static DraftExtensionSection() {
|
|
761
799
|
return Joi.object({
|
|
762
800
|
extension_id: Joi.string().allow(""),
|
|
763
801
|
bundle_name: Joi.string().allow(""),
|
|
@@ -769,15 +807,15 @@ class ThemePartnerModel {
|
|
|
769
807
|
});
|
|
770
808
|
}
|
|
771
809
|
|
|
772
|
-
/** @returns {
|
|
773
|
-
static
|
|
810
|
+
/** @returns {ExtensionSectionDraft} */
|
|
811
|
+
static ExtensionSectionDraft() {
|
|
774
812
|
return Joi.object({
|
|
775
|
-
sections: ThemePartnerModel.
|
|
813
|
+
sections: ThemePartnerModel.Sections(),
|
|
776
814
|
});
|
|
777
815
|
}
|
|
778
816
|
|
|
779
|
-
/** @returns {
|
|
780
|
-
static
|
|
817
|
+
/** @returns {Sections} */
|
|
818
|
+
static Sections() {
|
|
781
819
|
return Joi.object({
|
|
782
820
|
acknowledged: Joi.boolean(),
|
|
783
821
|
matched_count: Joi.number(),
|
|
@@ -815,8 +853,8 @@ class ThemePartnerModel {
|
|
|
815
853
|
});
|
|
816
854
|
}
|
|
817
855
|
|
|
818
|
-
/** @returns {
|
|
819
|
-
static
|
|
856
|
+
/** @returns {PublishExtensionSection} */
|
|
857
|
+
static PublishExtensionSection() {
|
|
820
858
|
return Joi.object({
|
|
821
859
|
extension_id: Joi.string().allow(""),
|
|
822
860
|
bundle_name: Joi.string().allow(""),
|
|
@@ -828,32 +866,32 @@ class ThemePartnerModel {
|
|
|
828
866
|
});
|
|
829
867
|
}
|
|
830
868
|
|
|
831
|
-
/** @returns {
|
|
832
|
-
static
|
|
869
|
+
/** @returns {PreviewExtension} */
|
|
870
|
+
static PreviewExtension() {
|
|
833
871
|
return Joi.object({
|
|
834
872
|
application_id: Joi.string().allow(""),
|
|
835
873
|
section_preview_hash: Joi.string().allow(""),
|
|
836
874
|
});
|
|
837
875
|
}
|
|
838
876
|
|
|
839
|
-
/** @returns {
|
|
840
|
-
static
|
|
877
|
+
/** @returns {ExtensionPreview} */
|
|
878
|
+
static ExtensionPreview() {
|
|
841
879
|
return Joi.object({
|
|
842
880
|
message: Joi.string().allow(""),
|
|
843
881
|
});
|
|
844
882
|
}
|
|
845
883
|
|
|
846
|
-
/** @returns {
|
|
847
|
-
static
|
|
884
|
+
/** @returns {ExtensionSectionPublish} */
|
|
885
|
+
static ExtensionSectionPublish() {
|
|
848
886
|
return Joi.object({
|
|
849
|
-
sections: ThemePartnerModel.
|
|
887
|
+
sections: ThemePartnerModel.Sections(),
|
|
850
888
|
});
|
|
851
889
|
}
|
|
852
890
|
|
|
853
891
|
/** @returns {AvailablePageSectionMetaAttributes} */
|
|
854
892
|
static AvailablePageSectionMetaAttributes() {
|
|
855
893
|
return Joi.object({
|
|
856
|
-
attributes: Joi.any(),
|
|
894
|
+
attributes: Joi.object().pattern(/\S/, Joi.any()),
|
|
857
895
|
});
|
|
858
896
|
}
|
|
859
897
|
|
|
@@ -915,11 +953,20 @@ class ThemePartnerModel {
|
|
|
915
953
|
return Joi.object({
|
|
916
954
|
name: Joi.string().allow(""),
|
|
917
955
|
label: Joi.string().allow(""),
|
|
918
|
-
props: Joi.any(),
|
|
956
|
+
props: Joi.object().pattern(/\S/, Joi.any()),
|
|
919
957
|
blocks: Joi.array().items(Joi.any()),
|
|
920
|
-
preset: Joi.any(),
|
|
958
|
+
preset: Joi.object().pattern(/\S/, Joi.any()),
|
|
921
959
|
predicate: ThemePartnerModel.AvailablePagePredicate(),
|
|
922
|
-
|
|
960
|
+
__source: ThemePartnerModel.SectionSource(),
|
|
961
|
+
});
|
|
962
|
+
}
|
|
963
|
+
|
|
964
|
+
/** @returns {SectionSource} */
|
|
965
|
+
static SectionSource() {
|
|
966
|
+
return Joi.object({
|
|
967
|
+
id: Joi.string().allow(""),
|
|
968
|
+
bundle_name: Joi.string().allow(""),
|
|
969
|
+
type: Joi.string().allow(""),
|
|
923
970
|
});
|
|
924
971
|
}
|
|
925
972
|
|
|
@@ -945,7 +992,7 @@ class ThemePartnerModel {
|
|
|
945
992
|
return Joi.object({
|
|
946
993
|
selected: Joi.string().allow(""),
|
|
947
994
|
exact_url: Joi.string().allow(""),
|
|
948
|
-
query: Joi.any(),
|
|
995
|
+
query: Joi.object().pattern(/\S/, Joi.any()),
|
|
949
996
|
});
|
|
950
997
|
}
|
|
951
998
|
|
|
@@ -1130,12 +1177,32 @@ class ThemePartnerModel {
|
|
|
1130
1177
|
admin_id: Joi.string().allow("").required(),
|
|
1131
1178
|
user_id: Joi.string().allow("").required(),
|
|
1132
1179
|
status: Joi.string().allow("").required(),
|
|
1133
|
-
rejection_reasons:
|
|
1180
|
+
rejection_reasons: ThemePartnerModel.RejectedMessages().required(),
|
|
1134
1181
|
created_at: Joi.string().allow(""),
|
|
1135
1182
|
updated_at: Joi.string().allow(""),
|
|
1136
1183
|
});
|
|
1137
1184
|
}
|
|
1138
1185
|
|
|
1186
|
+
/** @returns {RejectedMessages} */
|
|
1187
|
+
static RejectedMessages() {
|
|
1188
|
+
return Joi.object({
|
|
1189
|
+
theme_file: ThemePartnerModel.ThemeReviewRequestMessage(),
|
|
1190
|
+
theme_details: ThemePartnerModel.ThemeReviewRequestMessage(),
|
|
1191
|
+
theme_value_proposition: ThemePartnerModel.ThemeReviewRequestMessage(),
|
|
1192
|
+
theme_attributes: ThemePartnerModel.ThemeReviewRequestMessage(),
|
|
1193
|
+
theme_variations: ThemePartnerModel.ThemeReviewRequestMessage(),
|
|
1194
|
+
theme_docs: ThemePartnerModel.ThemeReviewRequestMessage(),
|
|
1195
|
+
theme_review: ThemePartnerModel.ThemeReviewRequestMessage(),
|
|
1196
|
+
});
|
|
1197
|
+
}
|
|
1198
|
+
|
|
1199
|
+
/** @returns {ThemeReviewRequestMessage} */
|
|
1200
|
+
static ThemeReviewRequestMessage() {
|
|
1201
|
+
return Joi.object({
|
|
1202
|
+
message: Joi.string().allow(""),
|
|
1203
|
+
});
|
|
1204
|
+
}
|
|
1205
|
+
|
|
1139
1206
|
/** @returns {AllAvailablePageSchema} */
|
|
1140
1207
|
static AllAvailablePageSchema() {
|
|
1141
1208
|
return Joi.object({
|
|
@@ -1183,7 +1250,7 @@ class ThemePartnerModel {
|
|
|
1183
1250
|
name: Joi.string().allow(""),
|
|
1184
1251
|
template_theme_id: Joi.string().allow(""),
|
|
1185
1252
|
version: Joi.string().allow(""),
|
|
1186
|
-
styles: Joi.any(),
|
|
1253
|
+
styles: Joi.object().pattern(/\S/, Joi.any()),
|
|
1187
1254
|
created_at: Joi.string().allow(""),
|
|
1188
1255
|
updated_at: Joi.string().allow(""),
|
|
1189
1256
|
assets: ThemePartnerModel.Assets(),
|
|
@@ -1237,7 +1304,7 @@ class ThemePartnerModel {
|
|
|
1237
1304
|
static ThemeConfiguration() {
|
|
1238
1305
|
return Joi.object({
|
|
1239
1306
|
name: Joi.string().allow(""),
|
|
1240
|
-
global_config: Joi.any(),
|
|
1307
|
+
global_config: Joi.object().pattern(/\S/, Joi.any()),
|
|
1241
1308
|
page: Joi.array().items(ThemePartnerModel.ThemeConfigListPage()),
|
|
1242
1309
|
});
|
|
1243
1310
|
}
|
|
@@ -1289,7 +1356,7 @@ class ThemePartnerModel {
|
|
|
1289
1356
|
/** @returns {ThemeConfigListPageSettingsProps} */
|
|
1290
1357
|
static ThemeConfigListPageSettingsProps() {
|
|
1291
1358
|
return Joi.object({
|
|
1292
|
-
props: Joi.any(),
|
|
1359
|
+
props: Joi.object().pattern(/\S/, Joi.any()),
|
|
1293
1360
|
});
|
|
1294
1361
|
}
|
|
1295
1362
|
|
|
@@ -1418,7 +1485,19 @@ class ThemePartnerModel {
|
|
|
1418
1485
|
/** @returns {GlobalSchema} */
|
|
1419
1486
|
static GlobalSchema() {
|
|
1420
1487
|
return Joi.object({
|
|
1421
|
-
props: Joi.array().items(
|
|
1488
|
+
props: Joi.array().items(ThemePartnerModel.Prop()),
|
|
1489
|
+
});
|
|
1490
|
+
}
|
|
1491
|
+
|
|
1492
|
+
/** @returns {Prop} */
|
|
1493
|
+
static Prop() {
|
|
1494
|
+
return Joi.object({
|
|
1495
|
+
type: Joi.string().allow(""),
|
|
1496
|
+
category: Joi.string().allow(""),
|
|
1497
|
+
value: Joi.string().allow(""),
|
|
1498
|
+
id: Joi.string().allow(""),
|
|
1499
|
+
label: Joi.string().allow(""),
|
|
1500
|
+
info: Joi.string().allow(""),
|
|
1422
1501
|
});
|
|
1423
1502
|
}
|
|
1424
1503
|
|
|
@@ -1660,9 +1739,9 @@ class ThemePartnerModel {
|
|
|
1660
1739
|
|
|
1661
1740
|
"profile-company",
|
|
1662
1741
|
|
|
1663
|
-
"profile-
|
|
1742
|
+
"profile-email",
|
|
1664
1743
|
|
|
1665
|
-
"profile-
|
|
1744
|
+
"profile-phone",
|
|
1666
1745
|
|
|
1667
1746
|
"rate-us",
|
|
1668
1747
|
|
|
@@ -1698,7 +1777,13 @@ class ThemePartnerModel {
|
|
|
1698
1777
|
|
|
1699
1778
|
"order-status",
|
|
1700
1779
|
|
|
1701
|
-
"locate-us"
|
|
1780
|
+
"locate-us",
|
|
1781
|
+
|
|
1782
|
+
"single-page-checkout",
|
|
1783
|
+
|
|
1784
|
+
"request-reattempt",
|
|
1785
|
+
|
|
1786
|
+
"files"
|
|
1702
1787
|
);
|
|
1703
1788
|
}
|
|
1704
1789
|
}
|
|
@@ -142,28 +142,28 @@ class ThemeValidator {
|
|
|
142
142
|
static createExtensionSectionDraft() {
|
|
143
143
|
return Joi.object({
|
|
144
144
|
extensionId: Joi.string().allow("").required(),
|
|
145
|
-
body: ThemeModel.
|
|
145
|
+
body: ThemeModel.DraftExtensionSection().required(),
|
|
146
146
|
}).required();
|
|
147
147
|
}
|
|
148
148
|
|
|
149
149
|
static publishExtensionSections() {
|
|
150
150
|
return Joi.object({
|
|
151
151
|
extensionId: Joi.string().allow("").required(),
|
|
152
|
-
body: ThemeModel.
|
|
152
|
+
body: ThemeModel.PublishExtensionSection().required(),
|
|
153
153
|
}).required();
|
|
154
154
|
}
|
|
155
155
|
|
|
156
156
|
static applyExtensionPreview() {
|
|
157
157
|
return Joi.object({
|
|
158
158
|
extensionSectionId: Joi.string().allow("").required(),
|
|
159
|
-
body: ThemeModel.
|
|
159
|
+
body: ThemeModel.PreviewExtension().required(),
|
|
160
160
|
}).required();
|
|
161
161
|
}
|
|
162
162
|
|
|
163
163
|
static removeExtensionPreview() {
|
|
164
164
|
return Joi.object({
|
|
165
165
|
extensionSectionId: Joi.string().allow("").required(),
|
|
166
|
-
body: ThemeModel.
|
|
166
|
+
body: ThemeModel.PreviewExtension().required(),
|
|
167
167
|
}).required();
|
|
168
168
|
}
|
|
169
169
|
|
|
@@ -2,98 +2,154 @@ export = Webhook;
|
|
|
2
2
|
declare class Webhook {
|
|
3
3
|
constructor(config: any);
|
|
4
4
|
config: any;
|
|
5
|
+
/**
|
|
6
|
+
* @param {WebhookPartnerValidator.ResponseTimeSummaryParam} arg - Arg object.
|
|
7
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
|
+
* @param {import("../PartnerAPIClient").Options} - Options
|
|
9
|
+
* @returns {Promise<WebhookPartnerModel.ResponseTimeTs>} - Success response
|
|
10
|
+
* @name responseTimeSummary
|
|
11
|
+
* @summary: Response time summary
|
|
12
|
+
* @description: Response time summary - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/responseTimeSummary/).
|
|
13
|
+
*/
|
|
14
|
+
responseTimeSummary({ extensionId, startDate, endDate, requestHeaders }?: WebhookPartnerValidator.ResponseTimeSummaryParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.ResponseTimeTs>;
|
|
5
15
|
/**
|
|
6
16
|
* @param {WebhookPartnerValidator.FetchDeliverySummaryParam} arg - Arg object.
|
|
7
17
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
18
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
9
|
-
* @returns {Promise<WebhookPartnerModel.
|
|
19
|
+
* @returns {Promise<WebhookPartnerModel.DeliverySummaryResult>} - Success response
|
|
10
20
|
* @name fetchDeliverySummary
|
|
11
21
|
* @summary: Webhook delivery summary
|
|
12
|
-
* @description: Webhook delivery summary - Check out [method documentation](https://
|
|
22
|
+
* @description: Webhook delivery summary - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/fetchDeliverySummary/).
|
|
13
23
|
*/
|
|
14
|
-
fetchDeliverySummary({ extensionId, startDate, endDate, requestHeaders }?: WebhookPartnerValidator.FetchDeliverySummaryParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.
|
|
24
|
+
fetchDeliverySummary({ extensionId, startDate, endDate, requestHeaders }?: WebhookPartnerValidator.FetchDeliverySummaryParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.DeliverySummaryResult>;
|
|
15
25
|
/**
|
|
16
26
|
* @param {WebhookPartnerValidator.GetDeliveryDetailInsightsParam} arg - Arg object.
|
|
17
27
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
18
28
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
19
|
-
* @returns {Promise<WebhookPartnerModel.
|
|
29
|
+
* @returns {Promise<WebhookPartnerModel.DeliveryDetailsResult>} - Success response
|
|
20
30
|
* @name getDeliveryDetailInsights
|
|
21
31
|
* @summary: Get the insights of delivery details of the events that was pushed to subscribers
|
|
22
|
-
* @description: Get the delivery details insights - Check out [method documentation](https://
|
|
32
|
+
* @description: Get the delivery details insights - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/getDeliveryDetailInsights/).
|
|
23
33
|
*/
|
|
24
|
-
getDeliveryDetailInsights({ extensionId, body, requestHeaders }?: WebhookPartnerValidator.GetDeliveryDetailInsightsParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.
|
|
34
|
+
getDeliveryDetailInsights({ extensionId, body, requestHeaders }?: WebhookPartnerValidator.GetDeliveryDetailInsightsParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.DeliveryDetailsResult>;
|
|
25
35
|
/**
|
|
26
36
|
* @param {WebhookPartnerValidator.FetchDeliveryTsParam} arg - Arg object.
|
|
27
37
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
28
38
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
29
|
-
* @returns {Promise<WebhookPartnerModel.
|
|
39
|
+
* @returns {Promise<WebhookPartnerModel.DeliveryTsResult>} - Success response
|
|
30
40
|
* @name fetchDeliveryTs
|
|
31
41
|
* @summary: Webhook delivery ts
|
|
32
|
-
* @description: Webhook delivery ts - Check out [method documentation](https://
|
|
42
|
+
* @description: Webhook delivery ts - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/fetchDeliveryTs/).
|
|
33
43
|
*/
|
|
34
|
-
fetchDeliveryTs({ extensionId, startDate, endDate, requestHeaders }?: WebhookPartnerValidator.FetchDeliveryTsParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.
|
|
44
|
+
fetchDeliveryTs({ extensionId, startDate, endDate, requestHeaders }?: WebhookPartnerValidator.FetchDeliveryTsParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.DeliveryTsResult>;
|
|
35
45
|
/**
|
|
36
46
|
* @param {WebhookPartnerValidator.FetchReportFiltersParam} arg - Arg object.
|
|
37
47
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
38
48
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
39
|
-
* @returns {Promise<WebhookPartnerModel.
|
|
49
|
+
* @returns {Promise<WebhookPartnerModel.FilterReportResult[]>} - Success response
|
|
40
50
|
* @name fetchReportFilters
|
|
41
51
|
* @summary: Fetch webhook report filters
|
|
42
|
-
* @description: Fetch webhook report filters - Check out [method documentation](https://
|
|
52
|
+
* @description: Fetch webhook report filters - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/fetchReportFilters/).
|
|
53
|
+
*/
|
|
54
|
+
fetchReportFilters({ extensionId, startDate, endDate, pageNo, pageSize, requestHeaders }?: WebhookPartnerValidator.FetchReportFiltersParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.FilterReportResult[]>;
|
|
55
|
+
/**
|
|
56
|
+
* @param {WebhookPartnerValidator.DownloadDeliveryReportParam} arg - Arg object.
|
|
57
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
58
|
+
* @param {import("../PartnerAPIClient").Options} - Options
|
|
59
|
+
* @returns {Promise<WebhookPartnerModel.DownloadReportResult>} - Success response
|
|
60
|
+
* @name downloadDeliveryReport
|
|
61
|
+
* @summary: Download webhook delivery report
|
|
62
|
+
* @description: Download webhook delivery report - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/downloadDeliveryReport/).
|
|
43
63
|
*/
|
|
44
|
-
|
|
64
|
+
downloadDeliveryReport({ extensionId, body, requestHeaders }?: WebhookPartnerValidator.DownloadDeliveryReportParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.DownloadReportResult>;
|
|
45
65
|
/**
|
|
46
66
|
* @param {WebhookPartnerValidator.CancelReportDownloadParam} arg - Arg object.
|
|
47
67
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
48
68
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
49
|
-
* @returns {Promise<WebhookPartnerModel.
|
|
69
|
+
* @returns {Promise<WebhookPartnerModel.CancelDownloadResult>} - Success response
|
|
50
70
|
* @name cancelReportDownload
|
|
51
71
|
* @summary: Cancel report download job
|
|
52
|
-
* @description: Cancel report download job - Check out [method documentation](https://
|
|
72
|
+
* @description: Cancel report download job - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/cancelReportDownload/).
|
|
53
73
|
*/
|
|
54
|
-
cancelReportDownload({ extensionId, filename, requestHeaders }?: WebhookPartnerValidator.CancelReportDownloadParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.
|
|
74
|
+
cancelReportDownload({ extensionId, filename, requestHeaders }?: WebhookPartnerValidator.CancelReportDownloadParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.CancelDownloadResult>;
|
|
55
75
|
/**
|
|
56
76
|
* @param {WebhookPartnerValidator.GetHistoricalReportsParam} arg - Arg object.
|
|
57
77
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
58
78
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
59
|
-
* @returns {Promise<WebhookPartnerModel.
|
|
79
|
+
* @returns {Promise<WebhookPartnerModel.HistoryResult>} - Success response
|
|
60
80
|
* @name getHistoricalReports
|
|
61
81
|
* @summary: Get report download history.
|
|
62
82
|
* @description: Retrieve history reports for a specific company based on the provided filters.
|
|
63
|
-
* - Check out [method documentation](https://
|
|
83
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/getHistoricalReports/).
|
|
64
84
|
*/
|
|
65
|
-
getHistoricalReports({ extensionId, body, requestHeaders }?: WebhookPartnerValidator.GetHistoricalReportsParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.
|
|
85
|
+
getHistoricalReports({ extensionId, body, requestHeaders }?: WebhookPartnerValidator.GetHistoricalReportsParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.HistoryResult>;
|
|
66
86
|
/**
|
|
67
87
|
* @param {WebhookPartnerValidator.GetInvalidEventListParam} arg - Arg object.
|
|
68
88
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
69
89
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
70
|
-
* @returns {Promise<WebhookPartnerModel.
|
|
90
|
+
* @returns {Promise<WebhookPartnerModel.InvalidEventsResult[]>} - Success response
|
|
71
91
|
* @name getInvalidEventList
|
|
72
92
|
* @summary: Get invalid event list
|
|
73
93
|
* @description: Get invalid event list.
|
|
74
|
-
* - Check out [method documentation](https://
|
|
94
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/getInvalidEventList/).
|
|
75
95
|
*/
|
|
76
|
-
getInvalidEventList({ extensionId, body, requestHeaders }?: WebhookPartnerValidator.GetInvalidEventListParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.
|
|
96
|
+
getInvalidEventList({ extensionId, body, requestHeaders }?: WebhookPartnerValidator.GetInvalidEventListParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.InvalidEventsResult[]>;
|
|
77
97
|
/**
|
|
78
98
|
* @param {WebhookPartnerValidator.FetchSubscribersParam} arg - Arg object.
|
|
79
99
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
80
100
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
81
|
-
* @returns {Promise<WebhookPartnerModel.
|
|
101
|
+
* @returns {Promise<WebhookPartnerModel.SubscriberConfigDetails>} - Success response
|
|
82
102
|
* @name fetchSubscribers
|
|
83
103
|
* @summary: Fetch subscriber by filters
|
|
84
|
-
* @description: Fetch subscriber by filters - Check out [method documentation](https://
|
|
104
|
+
* @description: Fetch subscriber by filters - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/fetchSubscribers/).
|
|
85
105
|
*/
|
|
86
|
-
fetchSubscribers({ extensionId, requestHeaders }?: WebhookPartnerValidator.FetchSubscribersParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.
|
|
106
|
+
fetchSubscribers({ extensionId, requestHeaders }?: WebhookPartnerValidator.FetchSubscribersParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.SubscriberConfigDetails>;
|
|
87
107
|
/**
|
|
88
108
|
* @param {WebhookPartnerValidator.UpdateSubscriberParam} arg - Arg object.
|
|
89
109
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
90
110
|
* @param {import("../PartnerAPIClient").Options} - Options
|
|
91
|
-
* @returns {Promise<WebhookPartnerModel.
|
|
111
|
+
* @returns {Promise<WebhookPartnerModel.SubscriberUpdateResult>} - Success response
|
|
92
112
|
* @name updateSubscriber
|
|
93
113
|
* @summary: Update subscriber status by id.
|
|
94
114
|
* @description: Update subscriber status by id.
|
|
95
|
-
* - Check out [method documentation](https://
|
|
115
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/updateSubscriber/).
|
|
116
|
+
*/
|
|
117
|
+
updateSubscriber({ extensionId, subscriberId, body, requestHeaders }?: WebhookPartnerValidator.UpdateSubscriberParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.SubscriberUpdateResult>;
|
|
118
|
+
/**
|
|
119
|
+
* @param {WebhookPartnerValidator.ValidateFilterConfigurationParam} arg - Arg object.
|
|
120
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
121
|
+
* @param {import("../PartnerAPIClient").Options} - Options
|
|
122
|
+
* @returns {Promise<WebhookPartnerModel.FilterValidationResult>} - Success response
|
|
123
|
+
* @name validateFilterConfiguration
|
|
124
|
+
* @summary: Validate filter configuration.
|
|
125
|
+
* @description: Validate a filter configuration against sample payload data.
|
|
126
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/validateFilterConfiguration/).
|
|
127
|
+
*/
|
|
128
|
+
validateFilterConfiguration({ extensionId, body, requestHeaders }?: WebhookPartnerValidator.ValidateFilterConfigurationParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.FilterValidationResult>;
|
|
129
|
+
/**
|
|
130
|
+
* @param {WebhookPartnerValidator.ValidateReducerConfigurationParam} arg -
|
|
131
|
+
* Arg object.
|
|
132
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
133
|
+
* @param {import("../PartnerAPIClient").Options} - Options
|
|
134
|
+
* @returns {Promise<WebhookPartnerModel.ReducerValidationResult>} - Success response
|
|
135
|
+
* @name validateReducerConfiguration
|
|
136
|
+
* @summary: Validate reducer configuration.
|
|
137
|
+
* @description: Validate a reducer configuration against sample payload data.
|
|
138
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/validateReducerConfiguration/).
|
|
139
|
+
*/
|
|
140
|
+
validateReducerConfiguration({ extensionId, body, requestHeaders }?: WebhookPartnerValidator.ValidateReducerConfigurationParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.ReducerValidationResult>;
|
|
141
|
+
/**
|
|
142
|
+
* @param {WebhookPartnerValidator.SaveFilterReducerConfigurationParam} arg
|
|
143
|
+
* - Arg object.
|
|
144
|
+
*
|
|
145
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
146
|
+
* @param {import("../PartnerAPIClient").Options} - Options
|
|
147
|
+
* @returns {Promise<WebhookPartnerModel.FilterReducerSaveResult>} - Success response
|
|
148
|
+
* @name saveFilterReducerConfiguration
|
|
149
|
+
* @summary: Save filter or reducer configuration.
|
|
150
|
+
* @description: Save filter and/or reducer configuration for a subscriber event mapping.
|
|
151
|
+
* - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/partner/webhook/saveFilterReducerConfiguration/).
|
|
96
152
|
*/
|
|
97
|
-
|
|
153
|
+
saveFilterReducerConfiguration({ extensionId, companyId, subscriberId, body, requestHeaders }?: WebhookPartnerValidator.SaveFilterReducerConfigurationParam, { responseHeaders }?: object): Promise<WebhookPartnerModel.FilterReducerSaveResult>;
|
|
98
154
|
}
|
|
99
155
|
import WebhookPartnerModel = require("./WebhookPartnerModel");
|