@gofynd/fdk-client-javascript 1.6.4 → 3.1.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +100 -80
- package/sdk/application/Cart/CartApplicationClient.js +257 -126
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -21
- package/sdk/application/Content/ContentApplicationClient.js +250 -36
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +106 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +326 -208
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +0 -10
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +0 -75
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +1 -54
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +0 -43
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +251 -172
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +639 -521
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3150 -4468
- package/sdk/platform/Cart/CartPlatformModel.js +2858 -1867
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +976 -380
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6475 -2015
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1083 -162
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +884 -80
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +325 -568
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1162 -1562
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6008 -7688
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9522 -6892
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +234 -227
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +183 -177
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -238
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +876 -588
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +506 -270
- package/sdk/platform/Communication/CommunicationPlatformModel.js +611 -313
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +78 -77
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +97 -91
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +31 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +25 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1206 -459
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1011 -320
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +255 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1095 -464
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +871 -1315
- package/sdk/platform/Content/ContentPlatformModel.js +940 -599
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +486 -277
- package/sdk/platform/Order/OrderPlatformClient.js +1491 -938
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4560 -8636
- package/sdk/platform/Order/OrderPlatformModel.js +3604 -4056
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3531 -1292
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1504
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2188 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +394 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +342 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +150 -212
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +589 -1238
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3581 -2960
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3730 -1779
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +230 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +164 -287
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +11 -50
- package/sdk/platform/Share/SharePlatformModel.js +5 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -16
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +201 -58
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +28 -17
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +33 -16
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
- package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
- package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
- package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
- package/sdk/platform/User/UserPlatformModel.js +209 -216
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -1,5 +1,25 @@
|
|
|
1
1
|
export = WebhookPlatformValidator;
|
|
2
|
+
/**
|
|
3
|
+
* @typedef CancelJobByNameParam
|
|
4
|
+
* @property {string} filename
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* @typedef DownloadDeliveryReportParam
|
|
8
|
+
* @property {WebhookPlatformModel.EventProcessRequest} body
|
|
9
|
+
*/
|
|
2
10
|
/** @typedef FetchAllEventConfigurationsParam */
|
|
11
|
+
/**
|
|
12
|
+
* @typedef GetDeliveryReportsParam
|
|
13
|
+
* @property {WebhookPlatformModel.EventProcessRequest} body
|
|
14
|
+
*/
|
|
15
|
+
/**
|
|
16
|
+
* @typedef GetHistoricalReportsParam
|
|
17
|
+
* @property {WebhookPlatformModel.HistoryPayload} body
|
|
18
|
+
*/
|
|
19
|
+
/**
|
|
20
|
+
* @typedef GetReportFiltersParam
|
|
21
|
+
* @property {WebhookPlatformModel.ReportFiltersPayload} body
|
|
22
|
+
*/
|
|
3
23
|
/**
|
|
4
24
|
* @typedef GetSubscriberByIdParam
|
|
5
25
|
* @property {number} subscriberId - Subscriber id
|
|
@@ -16,6 +36,10 @@ export = WebhookPlatformValidator;
|
|
|
16
36
|
* @property {number} [pageSize] - Page Size
|
|
17
37
|
* @property {string} extensionId - Extension_id
|
|
18
38
|
*/
|
|
39
|
+
/**
|
|
40
|
+
* @typedef PingWebhookParam
|
|
41
|
+
* @property {WebhookPlatformModel.PingWebhook} body
|
|
42
|
+
*/
|
|
19
43
|
/**
|
|
20
44
|
* @typedef RegisterSubscriberToEventParam
|
|
21
45
|
* @property {WebhookPlatformModel.SubscriberConfigPost} body
|
|
@@ -32,19 +56,27 @@ export = WebhookPlatformValidator;
|
|
|
32
56
|
* @typedef UpdateSubscriberV2Param
|
|
33
57
|
* @property {WebhookPlatformModel.SubscriberConfigUpdateRequestV2} body
|
|
34
58
|
*/
|
|
35
|
-
/**
|
|
36
|
-
* @typedef UpsertSubscriberEventParam
|
|
37
|
-
* @property {WebhookPlatformModel.UpsertSubscriberConfig} body
|
|
38
|
-
*/
|
|
39
59
|
declare class WebhookPlatformValidator {
|
|
60
|
+
/** @returns {CancelJobByNameParam} */
|
|
61
|
+
static cancelJobByName(): CancelJobByNameParam;
|
|
62
|
+
/** @returns {DownloadDeliveryReportParam} */
|
|
63
|
+
static downloadDeliveryReport(): DownloadDeliveryReportParam;
|
|
40
64
|
/** @returns {FetchAllEventConfigurationsParam} */
|
|
41
65
|
static fetchAllEventConfigurations(): any;
|
|
66
|
+
/** @returns {GetDeliveryReportsParam} */
|
|
67
|
+
static getDeliveryReports(): GetDeliveryReportsParam;
|
|
68
|
+
/** @returns {GetHistoricalReportsParam} */
|
|
69
|
+
static getHistoricalReports(): GetHistoricalReportsParam;
|
|
70
|
+
/** @returns {GetReportFiltersParam} */
|
|
71
|
+
static getReportFilters(): GetReportFiltersParam;
|
|
42
72
|
/** @returns {GetSubscriberByIdParam} */
|
|
43
73
|
static getSubscriberById(): GetSubscriberByIdParam;
|
|
44
74
|
/** @returns {GetSubscribersByCompanyParam} */
|
|
45
75
|
static getSubscribersByCompany(): GetSubscribersByCompanyParam;
|
|
46
76
|
/** @returns {GetSubscribersByExtensionIdParam} */
|
|
47
77
|
static getSubscribersByExtensionId(): GetSubscribersByExtensionIdParam;
|
|
78
|
+
/** @returns {PingWebhookParam} */
|
|
79
|
+
static pingWebhook(): PingWebhookParam;
|
|
48
80
|
/** @returns {RegisterSubscriberToEventParam} */
|
|
49
81
|
static registerSubscriberToEvent(): RegisterSubscriberToEventParam;
|
|
50
82
|
/** @returns {RegisterSubscriberToEventV2Param} */
|
|
@@ -53,12 +85,25 @@ declare class WebhookPlatformValidator {
|
|
|
53
85
|
static updateSubscriberConfig(): UpdateSubscriberConfigParam;
|
|
54
86
|
/** @returns {UpdateSubscriberV2Param} */
|
|
55
87
|
static updateSubscriberV2(): UpdateSubscriberV2Param;
|
|
56
|
-
/** @returns {UpsertSubscriberEventParam} */
|
|
57
|
-
static upsertSubscriberEvent(): UpsertSubscriberEventParam;
|
|
58
88
|
}
|
|
59
89
|
declare namespace WebhookPlatformValidator {
|
|
60
|
-
export { FetchAllEventConfigurationsParam, GetSubscriberByIdParam, GetSubscribersByCompanyParam, GetSubscribersByExtensionIdParam, RegisterSubscriberToEventParam, RegisterSubscriberToEventV2Param, UpdateSubscriberConfigParam, UpdateSubscriberV2Param
|
|
90
|
+
export { CancelJobByNameParam, DownloadDeliveryReportParam, FetchAllEventConfigurationsParam, GetDeliveryReportsParam, GetHistoricalReportsParam, GetReportFiltersParam, GetSubscriberByIdParam, GetSubscribersByCompanyParam, GetSubscribersByExtensionIdParam, PingWebhookParam, RegisterSubscriberToEventParam, RegisterSubscriberToEventV2Param, UpdateSubscriberConfigParam, UpdateSubscriberV2Param };
|
|
61
91
|
}
|
|
92
|
+
type CancelJobByNameParam = {
|
|
93
|
+
filename: string;
|
|
94
|
+
};
|
|
95
|
+
type DownloadDeliveryReportParam = {
|
|
96
|
+
body: WebhookPlatformModel.EventProcessRequest;
|
|
97
|
+
};
|
|
98
|
+
type GetDeliveryReportsParam = {
|
|
99
|
+
body: WebhookPlatformModel.EventProcessRequest;
|
|
100
|
+
};
|
|
101
|
+
type GetHistoricalReportsParam = {
|
|
102
|
+
body: WebhookPlatformModel.HistoryPayload;
|
|
103
|
+
};
|
|
104
|
+
type GetReportFiltersParam = {
|
|
105
|
+
body: WebhookPlatformModel.ReportFiltersPayload;
|
|
106
|
+
};
|
|
62
107
|
type GetSubscriberByIdParam = {
|
|
63
108
|
/**
|
|
64
109
|
* - Subscriber id
|
|
@@ -93,6 +138,9 @@ type GetSubscribersByExtensionIdParam = {
|
|
|
93
138
|
*/
|
|
94
139
|
extensionId: string;
|
|
95
140
|
};
|
|
141
|
+
type PingWebhookParam = {
|
|
142
|
+
body: WebhookPlatformModel.PingWebhook;
|
|
143
|
+
};
|
|
96
144
|
type RegisterSubscriberToEventParam = {
|
|
97
145
|
body: WebhookPlatformModel.SubscriberConfigPost;
|
|
98
146
|
};
|
|
@@ -105,8 +153,5 @@ type UpdateSubscriberConfigParam = {
|
|
|
105
153
|
type UpdateSubscriberV2Param = {
|
|
106
154
|
body: WebhookPlatformModel.SubscriberConfigUpdateRequestV2;
|
|
107
155
|
};
|
|
108
|
-
type UpsertSubscriberEventParam = {
|
|
109
|
-
body: WebhookPlatformModel.UpsertSubscriberConfig;
|
|
110
|
-
};
|
|
111
156
|
type FetchAllEventConfigurationsParam = any;
|
|
112
157
|
import WebhookPlatformModel = require("./WebhookPlatformModel");
|
|
@@ -2,8 +2,33 @@ const Joi = require("joi");
|
|
|
2
2
|
|
|
3
3
|
const WebhookPlatformModel = require("./WebhookPlatformModel");
|
|
4
4
|
|
|
5
|
+
/**
|
|
6
|
+
* @typedef CancelJobByNameParam
|
|
7
|
+
* @property {string} filename
|
|
8
|
+
*/
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* @typedef DownloadDeliveryReportParam
|
|
12
|
+
* @property {WebhookPlatformModel.EventProcessRequest} body
|
|
13
|
+
*/
|
|
14
|
+
|
|
5
15
|
/** @typedef FetchAllEventConfigurationsParam */
|
|
6
16
|
|
|
17
|
+
/**
|
|
18
|
+
* @typedef GetDeliveryReportsParam
|
|
19
|
+
* @property {WebhookPlatformModel.EventProcessRequest} body
|
|
20
|
+
*/
|
|
21
|
+
|
|
22
|
+
/**
|
|
23
|
+
* @typedef GetHistoricalReportsParam
|
|
24
|
+
* @property {WebhookPlatformModel.HistoryPayload} body
|
|
25
|
+
*/
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* @typedef GetReportFiltersParam
|
|
29
|
+
* @property {WebhookPlatformModel.ReportFiltersPayload} body
|
|
30
|
+
*/
|
|
31
|
+
|
|
7
32
|
/**
|
|
8
33
|
* @typedef GetSubscriberByIdParam
|
|
9
34
|
* @property {number} subscriberId - Subscriber id
|
|
@@ -23,6 +48,11 @@ const WebhookPlatformModel = require("./WebhookPlatformModel");
|
|
|
23
48
|
* @property {string} extensionId - Extension_id
|
|
24
49
|
*/
|
|
25
50
|
|
|
51
|
+
/**
|
|
52
|
+
* @typedef PingWebhookParam
|
|
53
|
+
* @property {WebhookPlatformModel.PingWebhook} body
|
|
54
|
+
*/
|
|
55
|
+
|
|
26
56
|
/**
|
|
27
57
|
* @typedef RegisterSubscriberToEventParam
|
|
28
58
|
* @property {WebhookPlatformModel.SubscriberConfigPost} body
|
|
@@ -43,17 +73,47 @@ const WebhookPlatformModel = require("./WebhookPlatformModel");
|
|
|
43
73
|
* @property {WebhookPlatformModel.SubscriberConfigUpdateRequestV2} body
|
|
44
74
|
*/
|
|
45
75
|
|
|
46
|
-
/**
|
|
47
|
-
* @typedef UpsertSubscriberEventParam
|
|
48
|
-
* @property {WebhookPlatformModel.UpsertSubscriberConfig} body
|
|
49
|
-
*/
|
|
50
|
-
|
|
51
76
|
class WebhookPlatformValidator {
|
|
77
|
+
/** @returns {CancelJobByNameParam} */
|
|
78
|
+
static cancelJobByName() {
|
|
79
|
+
return Joi.object({
|
|
80
|
+
filename: Joi.string().allow("").required(),
|
|
81
|
+
}).required();
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
/** @returns {DownloadDeliveryReportParam} */
|
|
85
|
+
static downloadDeliveryReport() {
|
|
86
|
+
return Joi.object({
|
|
87
|
+
body: WebhookPlatformModel.EventProcessRequest().required(),
|
|
88
|
+
}).required();
|
|
89
|
+
}
|
|
90
|
+
|
|
52
91
|
/** @returns {FetchAllEventConfigurationsParam} */
|
|
53
92
|
static fetchAllEventConfigurations() {
|
|
54
93
|
return Joi.object({}).required();
|
|
55
94
|
}
|
|
56
95
|
|
|
96
|
+
/** @returns {GetDeliveryReportsParam} */
|
|
97
|
+
static getDeliveryReports() {
|
|
98
|
+
return Joi.object({
|
|
99
|
+
body: WebhookPlatformModel.EventProcessRequest().required(),
|
|
100
|
+
}).required();
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
/** @returns {GetHistoricalReportsParam} */
|
|
104
|
+
static getHistoricalReports() {
|
|
105
|
+
return Joi.object({
|
|
106
|
+
body: WebhookPlatformModel.HistoryPayload().required(),
|
|
107
|
+
}).required();
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
/** @returns {GetReportFiltersParam} */
|
|
111
|
+
static getReportFilters() {
|
|
112
|
+
return Joi.object({
|
|
113
|
+
body: WebhookPlatformModel.ReportFiltersPayload().required(),
|
|
114
|
+
}).required();
|
|
115
|
+
}
|
|
116
|
+
|
|
57
117
|
/** @returns {GetSubscriberByIdParam} */
|
|
58
118
|
static getSubscriberById() {
|
|
59
119
|
return Joi.object({
|
|
@@ -79,6 +139,13 @@ class WebhookPlatformValidator {
|
|
|
79
139
|
}).required();
|
|
80
140
|
}
|
|
81
141
|
|
|
142
|
+
/** @returns {PingWebhookParam} */
|
|
143
|
+
static pingWebhook() {
|
|
144
|
+
return Joi.object({
|
|
145
|
+
body: WebhookPlatformModel.PingWebhook().required(),
|
|
146
|
+
}).required();
|
|
147
|
+
}
|
|
148
|
+
|
|
82
149
|
/** @returns {RegisterSubscriberToEventParam} */
|
|
83
150
|
static registerSubscriberToEvent() {
|
|
84
151
|
return Joi.object({
|
|
@@ -106,13 +173,6 @@ class WebhookPlatformValidator {
|
|
|
106
173
|
body: WebhookPlatformModel.SubscriberConfigUpdateRequestV2().required(),
|
|
107
174
|
}).required();
|
|
108
175
|
}
|
|
109
|
-
|
|
110
|
-
/** @returns {UpsertSubscriberEventParam} */
|
|
111
|
-
static upsertSubscriberEvent() {
|
|
112
|
-
return Joi.object({
|
|
113
|
-
body: WebhookPlatformModel.UpsertSubscriberConfig().required(),
|
|
114
|
-
}).required();
|
|
115
|
-
}
|
|
116
176
|
}
|
|
117
177
|
|
|
118
178
|
module.exports = WebhookPlatformValidator;
|
package/sdk/platform/index.d.ts
CHANGED
|
@@ -13,6 +13,7 @@ export namespace PlatformModel {
|
|
|
13
13
|
const ContentPlatformModel: typeof import("./Content/ContentPlatformModel");
|
|
14
14
|
const DiscountPlatformModel: typeof import("./Discount/DiscountPlatformModel");
|
|
15
15
|
const FileStoragePlatformModel: typeof import("./FileStorage/FileStoragePlatformModel");
|
|
16
|
+
const FinancePlatformModel: typeof import("./Finance/FinancePlatformModel");
|
|
16
17
|
const LeadPlatformModel: typeof import("./Lead/LeadPlatformModel");
|
|
17
18
|
const ServiceabilityPlatformModel: typeof import("./Serviceability/ServiceabilityPlatformModel");
|
|
18
19
|
const OrderPlatformModel: typeof import("./Order/OrderPlatformModel");
|
package/sdk/platform/index.js
CHANGED
|
@@ -26,6 +26,8 @@ module.exports = {
|
|
|
26
26
|
|
|
27
27
|
FileStoragePlatformModel: require("./FileStorage/FileStoragePlatformModel"),
|
|
28
28
|
|
|
29
|
+
FinancePlatformModel: require("./Finance/FinancePlatformModel"),
|
|
30
|
+
|
|
29
31
|
LeadPlatformModel: require("./Lead/LeadPlatformModel"),
|
|
30
32
|
|
|
31
33
|
ServiceabilityPlatformModel: require("./Serviceability/ServiceabilityPlatformModel"),
|
|
@@ -3,11 +3,22 @@ declare class Configuration {
|
|
|
3
3
|
constructor(_conf: any);
|
|
4
4
|
_conf: any;
|
|
5
5
|
_relativeUrls: {
|
|
6
|
+
checkVersionIsUpToDate: string;
|
|
6
7
|
getLocations: string;
|
|
7
8
|
searchApplication: string;
|
|
8
9
|
};
|
|
9
10
|
_urls: {};
|
|
10
11
|
updateUrls(urls: any): void;
|
|
12
|
+
/**
|
|
13
|
+
* @param {ConfigurationPublicValidator.CheckVersionIsUpToDateParam} arg - Arg object.
|
|
14
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
15
|
+
* @param {import("../PublicAPIClient").Options} - Options
|
|
16
|
+
* @returns {Promise<ConfigurationPublicModel.VersionResponse>} - Success response
|
|
17
|
+
* @name checkVersionIsUpToDate
|
|
18
|
+
* @summary: Check application version
|
|
19
|
+
* @description: Check if the application version is up to date. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/checkVersionIsUpToDate/).
|
|
20
|
+
*/
|
|
21
|
+
checkVersionIsUpToDate({ body, requestHeaders }?: ConfigurationPublicValidator.CheckVersionIsUpToDateParam, { responseHeaders }?: object): Promise<ConfigurationPublicModel.VersionResponse>;
|
|
11
22
|
/**
|
|
12
23
|
* @param {ConfigurationPublicValidator.GetLocationsParam} arg - Arg object.
|
|
13
24
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -22,13 +33,12 @@ declare class Configuration {
|
|
|
22
33
|
* @param {ConfigurationPublicValidator.SearchApplicationParam} arg - Arg object.
|
|
23
34
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
24
35
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
25
|
-
* @returns {Promise<ConfigurationPublicModel.
|
|
26
|
-
* Success response
|
|
36
|
+
* @returns {Promise<ConfigurationPublicModel.ApplicationResponse>} - Success response
|
|
27
37
|
* @name searchApplication
|
|
28
|
-
* @summary: Search application
|
|
38
|
+
* @summary: Search application.
|
|
29
39
|
* @description: Provide application name or domain url. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/searchApplication/).
|
|
30
40
|
*/
|
|
31
|
-
searchApplication({ authorization, query, requestHeaders }?: ConfigurationPublicValidator.SearchApplicationParam, { responseHeaders }?: object): Promise<ConfigurationPublicModel.
|
|
41
|
+
searchApplication({ authorization, query, requestHeaders }?: ConfigurationPublicValidator.SearchApplicationParam, { responseHeaders }?: object): Promise<ConfigurationPublicModel.ApplicationResponse>;
|
|
32
42
|
}
|
|
33
43
|
import ConfigurationPublicValidator = require("./ConfigurationPublicValidator");
|
|
34
44
|
import ConfigurationPublicModel = require("./ConfigurationPublicModel");
|
|
@@ -16,9 +16,10 @@ class Configuration {
|
|
|
16
16
|
constructor(_conf) {
|
|
17
17
|
this._conf = _conf;
|
|
18
18
|
this._relativeUrls = {
|
|
19
|
-
|
|
19
|
+
checkVersionIsUpToDate: "/service/public/configuration/v1.0/version",
|
|
20
|
+
getLocations: "/service/public/configuration/v1.0/location",
|
|
20
21
|
searchApplication:
|
|
21
|
-
"/service/
|
|
22
|
+
"/service/public/configuration/v1.0/application/search-application",
|
|
22
23
|
};
|
|
23
24
|
this._urls = Object.entries(this._relativeUrls).reduce(
|
|
24
25
|
(urls, [method, relativeUrl]) => {
|
|
@@ -36,6 +37,94 @@ class Configuration {
|
|
|
36
37
|
};
|
|
37
38
|
}
|
|
38
39
|
|
|
40
|
+
/**
|
|
41
|
+
* @param {ConfigurationPublicValidator.CheckVersionIsUpToDateParam} arg - Arg object.
|
|
42
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
43
|
+
* @param {import("../PublicAPIClient").Options} - Options
|
|
44
|
+
* @returns {Promise<ConfigurationPublicModel.VersionResponse>} - Success response
|
|
45
|
+
* @name checkVersionIsUpToDate
|
|
46
|
+
* @summary: Check application version
|
|
47
|
+
* @description: Check if the application version is up to date. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/checkVersionIsUpToDate/).
|
|
48
|
+
*/
|
|
49
|
+
async checkVersionIsUpToDate(
|
|
50
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
51
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
52
|
+
) {
|
|
53
|
+
let invalidInput = [];
|
|
54
|
+
if (invalidInput.length) {
|
|
55
|
+
const error = new Error();
|
|
56
|
+
error.message = "Missing required field";
|
|
57
|
+
error.details = invalidInput;
|
|
58
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
const {
|
|
62
|
+
error,
|
|
63
|
+
} = ConfigurationPublicValidator.checkVersionIsUpToDate().validate(
|
|
64
|
+
{ body },
|
|
65
|
+
{ abortEarly: false, allowUnknown: true }
|
|
66
|
+
);
|
|
67
|
+
if (error) {
|
|
68
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
// Showing warrnings if extra unknown parameters are found
|
|
72
|
+
const {
|
|
73
|
+
error: warrning,
|
|
74
|
+
} = ConfigurationPublicValidator.checkVersionIsUpToDate().validate(
|
|
75
|
+
{ body },
|
|
76
|
+
{ abortEarly: false, allowUnknown: false }
|
|
77
|
+
);
|
|
78
|
+
if (warrning) {
|
|
79
|
+
Logger({
|
|
80
|
+
level: "WARN",
|
|
81
|
+
message: `Parameter Validation warrnings for public > Configuration > checkVersionIsUpToDate \n ${warrning}`,
|
|
82
|
+
});
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
const query_params = {};
|
|
86
|
+
|
|
87
|
+
const xHeaders = {};
|
|
88
|
+
|
|
89
|
+
const response = await PublicAPIClient.execute(
|
|
90
|
+
this._conf,
|
|
91
|
+
"post",
|
|
92
|
+
constructUrl({
|
|
93
|
+
url: this._urls["checkVersionIsUpToDate"],
|
|
94
|
+
params: {},
|
|
95
|
+
}),
|
|
96
|
+
query_params,
|
|
97
|
+
body,
|
|
98
|
+
{ ...xHeaders, ...requestHeaders },
|
|
99
|
+
{ responseHeaders }
|
|
100
|
+
);
|
|
101
|
+
|
|
102
|
+
let responseData = response;
|
|
103
|
+
if (responseHeaders) {
|
|
104
|
+
responseData = response[0];
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
const {
|
|
108
|
+
error: res_error,
|
|
109
|
+
} = ConfigurationPublicModel.VersionResponse().validate(responseData, {
|
|
110
|
+
abortEarly: false,
|
|
111
|
+
allowUnknown: true,
|
|
112
|
+
});
|
|
113
|
+
|
|
114
|
+
if (res_error) {
|
|
115
|
+
if (this._conf.options.strictResponseCheck === true) {
|
|
116
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
117
|
+
} else {
|
|
118
|
+
Logger({
|
|
119
|
+
level: "WARN",
|
|
120
|
+
message: `Response Validation Warnings for public > Configuration > checkVersionIsUpToDate \n ${res_error}`,
|
|
121
|
+
});
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
return response;
|
|
126
|
+
}
|
|
127
|
+
|
|
39
128
|
/**
|
|
40
129
|
* @param {ConfigurationPublicValidator.GetLocationsParam} arg - Arg object.
|
|
41
130
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -128,10 +217,9 @@ class Configuration {
|
|
|
128
217
|
* @param {ConfigurationPublicValidator.SearchApplicationParam} arg - Arg object.
|
|
129
218
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
130
219
|
* @param {import("../PublicAPIClient").Options} - Options
|
|
131
|
-
* @returns {Promise<ConfigurationPublicModel.
|
|
132
|
-
* Success response
|
|
220
|
+
* @returns {Promise<ConfigurationPublicModel.ApplicationResponse>} - Success response
|
|
133
221
|
* @name searchApplication
|
|
134
|
-
* @summary: Search application
|
|
222
|
+
* @summary: Search application.
|
|
135
223
|
* @description: Provide application name or domain url. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/searchApplication/).
|
|
136
224
|
*/
|
|
137
225
|
async searchApplication(
|
|
@@ -194,10 +282,10 @@ class Configuration {
|
|
|
194
282
|
|
|
195
283
|
const {
|
|
196
284
|
error: res_error,
|
|
197
|
-
} = ConfigurationPublicModel.
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
);
|
|
285
|
+
} = ConfigurationPublicModel.ApplicationResponse().validate(responseData, {
|
|
286
|
+
abortEarly: false,
|
|
287
|
+
allowUnknown: true,
|
|
288
|
+
});
|
|
201
289
|
|
|
202
290
|
if (res_error) {
|
|
203
291
|
if (this._conf.options.strictResponseCheck === true) {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export = ConfigurationPublicModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
3
|
+
* @typedef ApplicationResponse
|
|
4
4
|
* @property {Application} [application]
|
|
5
5
|
*/
|
|
6
6
|
/**
|
|
@@ -53,15 +53,14 @@ export = ConfigurationPublicModel;
|
|
|
53
53
|
* @property {ApplicationCors} [cors]
|
|
54
54
|
* @property {ApplicationAuth} [auth]
|
|
55
55
|
* @property {string} [description] - It contains detailed information about the
|
|
56
|
-
* sales channel
|
|
56
|
+
* sales channel.
|
|
57
57
|
* @property {string} [channel_type] - It indicates different channel types like
|
|
58
|
-
* store, website-and-mobile-apps. Default value is store
|
|
58
|
+
* store, website-and-mobile-apps. Default value is store
|
|
59
59
|
* @property {number} [cache_ttl] - An integer value that specifies the number
|
|
60
60
|
* of seconds until the key expires
|
|
61
61
|
* @property {boolean} [is_internal] - Indicates whether a sales channel is
|
|
62
62
|
* internal or not
|
|
63
|
-
* @property {boolean} [is_active] - Indicates
|
|
64
|
-
* or not active
|
|
63
|
+
* @property {boolean} [is_active] - Indicates sales channel is active or not active
|
|
65
64
|
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
66
65
|
* of the sales channel
|
|
67
66
|
* @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
|
|
@@ -69,30 +68,30 @@ export = ConfigurationPublicModel;
|
|
|
69
68
|
* of owner who owns the application
|
|
70
69
|
* @property {number} [company_id] - Numeric ID allotted to a business account
|
|
71
70
|
* where the sales channel exists
|
|
72
|
-
* @property {string} [token] -
|
|
71
|
+
* @property {string} [token] - Random generated fix length string for sales
|
|
73
72
|
* channel. It is required and auto-generated.
|
|
74
73
|
* @property {ApplicationRedirections[]} [redirections]
|
|
75
74
|
* @property {ApplicationMeta[]} [meta]
|
|
76
75
|
* @property {string} [created_at] - ISO 8601 timestamp of sales channel creation
|
|
77
|
-
* @property {string} [
|
|
76
|
+
* @property {string} [modified_at] - ISO 8601 timestamp of sales channel updation
|
|
78
77
|
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
79
78
|
* @property {SecureUrl} [banner]
|
|
80
79
|
* @property {SecureUrl} [logo]
|
|
81
80
|
* @property {SecureUrl} [favicon]
|
|
82
81
|
* @property {Domain[]} [domains]
|
|
83
|
-
* @property {string} [app_type] - It shows
|
|
84
|
-
* development mode
|
|
82
|
+
* @property {string} [app_type] - It shows application is live or in development mode.
|
|
85
83
|
* @property {SecureUrl} [mobile_logo]
|
|
86
84
|
* @property {Domain} [domain]
|
|
87
85
|
* @property {string} [slug]
|
|
86
|
+
* @property {string} [mode]
|
|
87
|
+
* @property {string} [status]
|
|
88
|
+
* @property {TokenSchema[]} [tokens]
|
|
88
89
|
*/
|
|
89
90
|
/**
|
|
90
|
-
* @typedef
|
|
91
|
-
* @property {string} [
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
* @typedef BadRequestSchema
|
|
95
|
-
* @property {string} [message] - Failure message (in a string format)
|
|
91
|
+
* @typedef TokenSchema
|
|
92
|
+
* @property {string} [token]
|
|
93
|
+
* @property {Object} [created_by]
|
|
94
|
+
* @property {string} [created_at] - ISO 8601 timestamp of when token created
|
|
96
95
|
*/
|
|
97
96
|
/**
|
|
98
97
|
* @typedef LocationDefaultLanguage
|
|
@@ -129,14 +128,45 @@ export = ConfigurationPublicModel;
|
|
|
129
128
|
* @typedef Locations
|
|
130
129
|
* @property {LocationCountry[]} [items]
|
|
131
130
|
*/
|
|
131
|
+
/**
|
|
132
|
+
* @typedef VersionApplication
|
|
133
|
+
* @property {string} [name]
|
|
134
|
+
* @property {string} [version]
|
|
135
|
+
*/
|
|
136
|
+
/**
|
|
137
|
+
* @typedef VersionDeviceOS
|
|
138
|
+
* @property {string} [name]
|
|
139
|
+
*/
|
|
140
|
+
/**
|
|
141
|
+
* @typedef VersionDevice
|
|
142
|
+
* @property {VersionDeviceOS} [os]
|
|
143
|
+
*/
|
|
144
|
+
/**
|
|
145
|
+
* @typedef VersionRequest
|
|
146
|
+
* @property {VersionApplication} application
|
|
147
|
+
* @property {VersionDevice} device
|
|
148
|
+
*/
|
|
149
|
+
/**
|
|
150
|
+
* @typedef VersionUpdateDialogue
|
|
151
|
+
* @property {string} [type]
|
|
152
|
+
* @property {number} [interval]
|
|
153
|
+
*/
|
|
154
|
+
/**
|
|
155
|
+
* @typedef VersionResponse
|
|
156
|
+
* @property {string} type
|
|
157
|
+
* @property {string} title
|
|
158
|
+
* @property {string} description
|
|
159
|
+
* @property {VersionUpdateDialogue} update_dialog
|
|
160
|
+
* @property {boolean} is_app_blocked
|
|
161
|
+
*/
|
|
132
162
|
declare class ConfigurationPublicModel {
|
|
133
163
|
}
|
|
134
164
|
declare namespace ConfigurationPublicModel {
|
|
135
|
-
export {
|
|
165
|
+
export { ApplicationResponse, Domain, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, TokenSchema, LocationDefaultLanguage, LocationDefaultCurrency, LocationCountry, Locations, VersionApplication, VersionDeviceOS, VersionDevice, VersionRequest, VersionUpdateDialogue, VersionResponse };
|
|
136
166
|
}
|
|
137
|
-
/** @returns {
|
|
138
|
-
declare function
|
|
139
|
-
type
|
|
167
|
+
/** @returns {ApplicationResponse} */
|
|
168
|
+
declare function ApplicationResponse(): ApplicationResponse;
|
|
169
|
+
type ApplicationResponse = {
|
|
140
170
|
application?: Application;
|
|
141
171
|
};
|
|
142
172
|
/** @returns {Domain} */
|
|
@@ -240,12 +270,12 @@ type Application = {
|
|
|
240
270
|
auth?: ApplicationAuth;
|
|
241
271
|
/**
|
|
242
272
|
* - It contains detailed information about the
|
|
243
|
-
* sales channel
|
|
273
|
+
* sales channel.
|
|
244
274
|
*/
|
|
245
275
|
description?: string;
|
|
246
276
|
/**
|
|
247
277
|
* - It indicates different channel types like
|
|
248
|
-
* store, website-and-mobile-apps. Default value is store
|
|
278
|
+
* store, website-and-mobile-apps. Default value is store
|
|
249
279
|
*/
|
|
250
280
|
channel_type?: string;
|
|
251
281
|
/**
|
|
@@ -259,8 +289,7 @@ type Application = {
|
|
|
259
289
|
*/
|
|
260
290
|
is_internal?: boolean;
|
|
261
291
|
/**
|
|
262
|
-
* - Indicates
|
|
263
|
-
* or not active
|
|
292
|
+
* - Indicates sales channel is active or not active
|
|
264
293
|
*/
|
|
265
294
|
is_active?: boolean;
|
|
266
295
|
/**
|
|
@@ -283,7 +312,7 @@ type Application = {
|
|
|
283
312
|
*/
|
|
284
313
|
company_id?: number;
|
|
285
314
|
/**
|
|
286
|
-
* -
|
|
315
|
+
* - Random generated fix length string for sales
|
|
287
316
|
* channel. It is required and auto-generated.
|
|
288
317
|
*/
|
|
289
318
|
token?: string;
|
|
@@ -296,7 +325,7 @@ type Application = {
|
|
|
296
325
|
/**
|
|
297
326
|
* - ISO 8601 timestamp of sales channel updation
|
|
298
327
|
*/
|
|
299
|
-
|
|
328
|
+
modified_at?: string;
|
|
300
329
|
/**
|
|
301
330
|
* - Version key for tracking revisions. Default value is zero.
|
|
302
331
|
*/
|
|
@@ -306,29 +335,25 @@ type Application = {
|
|
|
306
335
|
favicon?: SecureUrl;
|
|
307
336
|
domains?: Domain[];
|
|
308
337
|
/**
|
|
309
|
-
* - It shows
|
|
310
|
-
* development mode
|
|
338
|
+
* - It shows application is live or in development mode.
|
|
311
339
|
*/
|
|
312
340
|
app_type?: string;
|
|
313
341
|
mobile_logo?: SecureUrl;
|
|
314
342
|
domain?: Domain;
|
|
315
343
|
slug?: string;
|
|
344
|
+
mode?: string;
|
|
345
|
+
status?: string;
|
|
346
|
+
tokens?: TokenSchema[];
|
|
316
347
|
};
|
|
317
|
-
/** @returns {
|
|
318
|
-
declare function
|
|
319
|
-
type
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
*/
|
|
323
|
-
message?: string;
|
|
324
|
-
};
|
|
325
|
-
/** @returns {BadRequestSchema} */
|
|
326
|
-
declare function BadRequestSchema(): BadRequestSchema;
|
|
327
|
-
type BadRequestSchema = {
|
|
348
|
+
/** @returns {TokenSchema} */
|
|
349
|
+
declare function TokenSchema(): TokenSchema;
|
|
350
|
+
type TokenSchema = {
|
|
351
|
+
token?: string;
|
|
352
|
+
created_by?: any;
|
|
328
353
|
/**
|
|
329
|
-
* -
|
|
354
|
+
* - ISO 8601 timestamp of when token created
|
|
330
355
|
*/
|
|
331
|
-
|
|
356
|
+
created_at?: string;
|
|
332
357
|
};
|
|
333
358
|
/** @returns {LocationDefaultLanguage} */
|
|
334
359
|
declare function LocationDefaultLanguage(): LocationDefaultLanguage;
|
|
@@ -369,3 +394,40 @@ declare function Locations(): Locations;
|
|
|
369
394
|
type Locations = {
|
|
370
395
|
items?: LocationCountry[];
|
|
371
396
|
};
|
|
397
|
+
/** @returns {VersionApplication} */
|
|
398
|
+
declare function VersionApplication(): VersionApplication;
|
|
399
|
+
type VersionApplication = {
|
|
400
|
+
name?: string;
|
|
401
|
+
version?: string;
|
|
402
|
+
};
|
|
403
|
+
/** @returns {VersionDeviceOS} */
|
|
404
|
+
declare function VersionDeviceOS(): VersionDeviceOS;
|
|
405
|
+
type VersionDeviceOS = {
|
|
406
|
+
name?: string;
|
|
407
|
+
};
|
|
408
|
+
/** @returns {VersionDevice} */
|
|
409
|
+
declare function VersionDevice(): VersionDevice;
|
|
410
|
+
type VersionDevice = {
|
|
411
|
+
os?: VersionDeviceOS;
|
|
412
|
+
};
|
|
413
|
+
/** @returns {VersionRequest} */
|
|
414
|
+
declare function VersionRequest(): VersionRequest;
|
|
415
|
+
type VersionRequest = {
|
|
416
|
+
application: VersionApplication;
|
|
417
|
+
device: VersionDevice;
|
|
418
|
+
};
|
|
419
|
+
/** @returns {VersionUpdateDialogue} */
|
|
420
|
+
declare function VersionUpdateDialogue(): VersionUpdateDialogue;
|
|
421
|
+
type VersionUpdateDialogue = {
|
|
422
|
+
type?: string;
|
|
423
|
+
interval?: number;
|
|
424
|
+
};
|
|
425
|
+
/** @returns {VersionResponse} */
|
|
426
|
+
declare function VersionResponse(): VersionResponse;
|
|
427
|
+
type VersionResponse = {
|
|
428
|
+
type: string;
|
|
429
|
+
title: string;
|
|
430
|
+
description: string;
|
|
431
|
+
update_dialog: VersionUpdateDialogue;
|
|
432
|
+
is_app_blocked: boolean;
|
|
433
|
+
};
|