@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0
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 +2 -2
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +81 -101
- package/sdk/application/Cart/CartApplicationClient.js +173 -511
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +214 -447
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -19
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -43
- package/sdk/application/Communication/CommunicationApplicationClient.js +4 -214
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +41 -54
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +39 -192
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -61
- package/sdk/application/Content/ContentApplicationClient.js +183 -366
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +6 -6
- package/sdk/application/Lead/LeadApplicationClient.js +24 -55
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +28 -117
- package/sdk/application/Logistic/LogisticApplicationClient.js +99 -492
- package/sdk/application/Order/OrderApplicationClient.d.ts +31 -51
- package/sdk/application/Order/OrderApplicationClient.js +89 -293
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +108 -218
- package/sdk/application/Payment/PaymentApplicationClient.js +100 -1081
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationClient.js +13 -66
- package/sdk/application/Share/ShareApplicationClient.d.ts +11 -11
- package/sdk/application/Share/ShareApplicationClient.js +35 -89
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +5 -25
- package/sdk/application/Theme/ThemeApplicationClient.js +24 -150
- package/sdk/application/User/UserApplicationClient.d.ts +23 -13
- package/sdk/application/User/UserApplicationClient.js +49 -407
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -11
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +10 -54
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +32 -364
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +54 -1
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +43 -0
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -35
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +52 -98
- package/sdk/partner/Lead/LeadPartnerModel.js +76 -100
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +172 -41
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1222 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1921 -297
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +973 -258
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +148 -16
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +21 -63
- package/sdk/partner/Theme/ThemePartnerClient.js +67 -392
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +72 -104
- package/sdk/partner/Theme/ThemePartnerModel.js +75 -101
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -5
- package/sdk/partner/Theme/ThemePartnerValidator.js +12 -42
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +673 -189
- package/sdk/partner/Webhook/WebhookPartnerModel.js +270 -159
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- 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 +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- 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 +172 -251
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +577 -648
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +270 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +192 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4554 -3154
- package/sdk/platform/Cart/CartPlatformModel.js +1935 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +380 -976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6464
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +161 -1082
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +80 -884
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +568 -325
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1560 -1162
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9772 -7871
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6978 -9516
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +231 -240
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +180 -188
- package/sdk/platform/Common/CommonPlatformClient.d.ts +6 -5
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +19 -25
- package/sdk/platform/Common/CommonPlatformModel.js +11 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +240 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +589 -874
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +139 -170
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +126 -145
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -56
- package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -307
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +330 -502
- package/sdk/platform/Communication/CommunicationPlatformModel.js +376 -610
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +3 -62
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +2 -48
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +72 -100
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -146
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +270 -241
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +248 -226
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -31
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -25
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +117 -332
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +409 -1470
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +55 -158
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +41 -163
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +65 -142
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +103 -568
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +562 -1289
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +368 -1037
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +34 -80
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +24 -79
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +302 -248
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1292 -773
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +330 -218
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +325 -208
- package/sdk/platform/Content/ContentPlatformClient.d.ts +279 -118
- package/sdk/platform/Content/ContentPlatformClient.js +1617 -492
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2391 -924
- package/sdk/platform/Content/ContentPlatformModel.js +1314 -970
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +272 -134
- package/sdk/platform/Content/ContentPlatformValidator.js +295 -118
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +53 -43
- package/sdk/platform/Discount/DiscountPlatformClient.js +53 -43
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +383 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +117 -108
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -163
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1078
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -141
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -177
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +30 -1123
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +24 -1135
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- 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 +24 -4
- package/sdk/platform/Lead/LeadPlatformClient.js +160 -4
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +60 -140
- package/sdk/platform/Lead/LeadPlatformModel.js +81 -162
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +29 -3
- package/sdk/platform/Lead/LeadPlatformValidator.js +28 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +19 -98
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +27 -662
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +91 -118
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -127
- package/sdk/platform/Order/OrderPlatformClient.d.ts +406 -403
- package/sdk/platform/Order/OrderPlatformClient.js +1200 -1343
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8665 -4505
- package/sdk/platform/Order/OrderPlatformModel.js +4088 -3601
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +666 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +353 -312
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +67 -19
- package/sdk/platform/Partner/PartnerPlatformModel.js +26 -17
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +135 -382
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +937 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +100 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +74 -305
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +56 -66
- package/sdk/platform/Payment/PaymentPlatformClient.js +124 -269
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1307 -3536
- package/sdk/platform/Payment/PaymentPlatformModel.js +1389 -3692
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +35 -64
- package/sdk/platform/Payment/PaymentPlatformValidator.js +34 -60
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- 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 +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +64 -136
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +111 -521
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -117
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +160 -149
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +766 -545
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6196 -3978
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3181 -3895
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +294 -220
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -149
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.js +86 -8
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +23 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +16 -3
- package/sdk/platform/Share/SharePlatformModel.d.ts +53 -9
- package/sdk/platform/Share/SharePlatformModel.js +45 -5
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +17 -37
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +66 -204
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +25 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +20 -31
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -18
- package/sdk/platform/Theme/ThemePlatformClient.js +8 -85
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +17 -425
- package/sdk/platform/Theme/ThemePlatformModel.js +23 -329
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +3 -7
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -9
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +81 -18
- package/sdk/platform/User/UserPlatformApplicationClient.js +491 -27
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +126 -10
- package/sdk/platform/User/UserPlatformApplicationValidator.js +92 -7
- package/sdk/platform/User/UserPlatformModel.d.ts +317 -218
- package/sdk/platform/User/UserPlatformModel.js +253 -210
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +813 -426
- package/sdk/platform/Webhook/WebhookPlatformModel.js +446 -395
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- 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 +4 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -113
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +46 -114
- package/sdk/public/Configuration/ConfigurationPublicModel.js +32 -117
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -11
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +0 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -25
- package/sdk/public/Content/ContentPublicClient.js +254 -280
- package/sdk/public/Content/ContentPublicModel.d.ts +151 -38
- package/sdk/public/Content/ContentPublicModel.js +98 -44
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -17
- package/sdk/public/Content/ContentPublicValidator.js +26 -19
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- 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 +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +9 -48
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +215 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +66 -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/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +0 -66
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +0 -431
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +0 -231
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +0 -152
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +0 -8
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +0 -39
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +0 -26
- package/sdk/partner/Catalog/CatalogPartnerClient.js +0 -173
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +0 -238
- package/sdk/partner/Catalog/CatalogPartnerModel.js +0 -248
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +0 -5
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +0 -19
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +0 -116
- package/sdk/partner/Payment/PaymentPartnerClient.js +0 -857
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +0 -388
- package/sdk/partner/Payment/PaymentPartnerModel.js +0 -442
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +0 -14
- package/sdk/partner/Payment/PaymentPartnerValidator.js +0 -74
- 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 -2895
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2150
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -1,7 +1,31 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
|
+
/**
|
|
4
|
+
* @typedef CurrencyExchangeResponseV2
|
|
5
|
+
* @property {string} base - The 3-letter ISO 4217 code representing the base currency.
|
|
6
|
+
* @property {string} base_currency_name - The name of the base currency.
|
|
7
|
+
* @property {number} ttl_seconds - Time in seconds for which the exchange rates
|
|
8
|
+
* are valid.
|
|
9
|
+
* @property {CurrencyExchangeItem[]} items - List of exchange rates and currency details.
|
|
10
|
+
* @property {number} total - Total number of currency exchange items.
|
|
11
|
+
*/
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* @typedef CurrencyExchangeItem
|
|
15
|
+
* @property {string} currency_code - 3-letter ISO 4217 exchange currency code.
|
|
16
|
+
* @property {string} name - Name of the exchange currency
|
|
17
|
+
* @property {number} rate - Exchange rate of the currency with respect to the
|
|
18
|
+
* base currency.
|
|
19
|
+
* @property {string} country_code - ISO 3166 country code.
|
|
20
|
+
* @property {string} country_name - Name of the country using this currency.
|
|
21
|
+
* @property {string} subunit - The name of the subunit for the currency.
|
|
22
|
+
* @property {number} decimal_digits - Number of decimal digits the currency supports.
|
|
23
|
+
* @property {string} symbol - The symbol of the currency.
|
|
24
|
+
*/
|
|
25
|
+
|
|
3
26
|
/**
|
|
4
27
|
* @typedef ApplicationInventory
|
|
28
|
+
* @property {SearchConfig} [search]
|
|
5
29
|
* @property {AppInventoryConfig} [inventory]
|
|
6
30
|
* @property {AuthenticationConfig} [authentication]
|
|
7
31
|
* @property {ArticleAssignmentConfig} [article_assignment]
|
|
@@ -19,8 +43,7 @@ const Joi = require("joi");
|
|
|
19
43
|
* or not for sales channel inventory
|
|
20
44
|
* @property {CommunicationConfig} [communication]
|
|
21
45
|
* @property {string[]} [platforms]
|
|
22
|
-
* @property {string} [_id] - The unique identifier
|
|
23
|
-
* of the sales channel inventory
|
|
46
|
+
* @property {string} [_id] - The unique identifier of the sales channel inventory
|
|
24
47
|
* @property {LoyaltyPointsConfig} [loyalty_points]
|
|
25
48
|
* @property {string} [app] - Current sales channel ID
|
|
26
49
|
* @property {string} [created_at] - ISO 8601 timestamp of sales channel
|
|
@@ -37,32 +60,43 @@ const Joi = require("joi");
|
|
|
37
60
|
*/
|
|
38
61
|
|
|
39
62
|
/**
|
|
40
|
-
* @typedef
|
|
41
|
-
* @property {
|
|
63
|
+
* @typedef FstIdentification
|
|
64
|
+
* @property {boolean} [enabled] - Indicates whether search query interpretation
|
|
65
|
+
* is enabled for the application.
|
|
66
|
+
*/
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* @typedef QuerySuggestions
|
|
70
|
+
* @property {boolean} [enabled] - Indicates whether to enable or disable query
|
|
71
|
+
* suggestions powered by the GPT model using the current live catalog within
|
|
72
|
+
* the application.
|
|
73
|
+
* @property {number} [max_limit] - Specifies the maximum number of query
|
|
74
|
+
* suggestions that can be returned.
|
|
42
75
|
*/
|
|
43
76
|
|
|
44
77
|
/**
|
|
45
|
-
* @typedef
|
|
46
|
-
* @property {
|
|
78
|
+
* @typedef SearchConfig
|
|
79
|
+
* @property {FstIdentification} [fst_identification]
|
|
80
|
+
* @property {QuerySuggestions} [query_suggestions]
|
|
47
81
|
*/
|
|
48
82
|
|
|
49
83
|
/**
|
|
50
84
|
* @typedef AppInventoryConfig
|
|
85
|
+
* @property {DeliveryStrategy} [delivery_strategy]
|
|
51
86
|
* @property {InventoryBrand} [brand]
|
|
52
87
|
* @property {InventoryStore} [store]
|
|
53
88
|
* @property {InventoryCategory} [category]
|
|
54
89
|
* @property {InventoryPrice} [price]
|
|
55
90
|
* @property {InventoryDiscount} [discount]
|
|
56
|
-
* @property {PricingStrategy} [pricing_strategy]
|
|
57
91
|
* @property {boolean} [out_of_stock] - Indicates whether out of stock products
|
|
58
92
|
* are allowed to show up on the website
|
|
59
93
|
* @property {boolean} [only_verified_products] - Show only verified products
|
|
60
94
|
* (the ones whose data has been verified by the admin)
|
|
61
95
|
* @property {boolean} [franchise_enabled] - Allow other businesses (companies)
|
|
62
96
|
* to consume the current sales channel's inventory and sell products
|
|
63
|
-
* @property {
|
|
97
|
+
* @property {Object[]} [exclude_category] - List of excluded brands category
|
|
64
98
|
* @property {string[]} [image]
|
|
65
|
-
* @property {
|
|
99
|
+
* @property {Object[]} [company_store] - List of selling locations whose
|
|
66
100
|
* inventory is available to the sales channel for displaying on the website
|
|
67
101
|
* @property {number} [company_id]
|
|
68
102
|
*/
|
|
@@ -78,7 +112,7 @@ const Joi = require("joi");
|
|
|
78
112
|
* @typedef InventoryStore
|
|
79
113
|
* @property {string} [criteria] - All stores or specific (explicit) stores to
|
|
80
114
|
* be shown on the website
|
|
81
|
-
* @property {
|
|
115
|
+
* @property {Object[]} [stores] - List of stores
|
|
82
116
|
* @property {AppStoreRules[]} [rules] - Rules to show which brands or companies
|
|
83
117
|
* products should be listed on sales channel.
|
|
84
118
|
*/
|
|
@@ -94,7 +128,7 @@ const Joi = require("joi");
|
|
|
94
128
|
/**
|
|
95
129
|
* @typedef InventoryCategory
|
|
96
130
|
* @property {string} [criteria]
|
|
97
|
-
* @property {
|
|
131
|
+
* @property {Object[]} [categories] - List of categories whose products will be
|
|
98
132
|
* shown on the website
|
|
99
133
|
*/
|
|
100
134
|
|
|
@@ -133,7 +167,7 @@ const Joi = require("joi");
|
|
|
133
167
|
* @typedef StorePriority
|
|
134
168
|
* @property {boolean} [enabled] - Shows store priority is enabled or disabled
|
|
135
169
|
* for assignment of article
|
|
136
|
-
* @property {
|
|
170
|
+
* @property {Object[]} [storetype_order] - List of store types for article
|
|
137
171
|
* assignment e.g. warehouse, mall, highstreet
|
|
138
172
|
*/
|
|
139
173
|
|
|
@@ -256,6 +290,7 @@ const Joi = require("joi");
|
|
|
256
290
|
|
|
257
291
|
/**
|
|
258
292
|
* @typedef AppInventoryPartialUpdate
|
|
293
|
+
* @property {SearchConfig} [search]
|
|
259
294
|
* @property {RewardPointsConfig} [reward_points]
|
|
260
295
|
* @property {AppCartConfig} [cart]
|
|
261
296
|
* @property {AppPaymentConfig} [payment]
|
|
@@ -272,19 +307,19 @@ const Joi = require("joi");
|
|
|
272
307
|
*/
|
|
273
308
|
|
|
274
309
|
/**
|
|
275
|
-
* @typedef
|
|
310
|
+
* @typedef CompanyByBrandsRequestSchema
|
|
276
311
|
* @property {number} brands - Brand UID
|
|
277
312
|
* @property {string} [search_text] - A search field for finding a company by its name
|
|
278
313
|
*/
|
|
279
314
|
|
|
280
315
|
/**
|
|
281
|
-
* @typedef
|
|
316
|
+
* @typedef CompanyByBrandsResponseSchema
|
|
282
317
|
* @property {BrandCompanyInfo[]} [items]
|
|
283
318
|
* @property {Page} [page]
|
|
284
319
|
*/
|
|
285
320
|
|
|
286
321
|
/**
|
|
287
|
-
* @typedef
|
|
322
|
+
* @typedef StoreByBrandsRequestSchema
|
|
288
323
|
* @property {number} [company_id] - Current company ID for current company
|
|
289
324
|
* stores only. Don't send in case cross-selling (franchise) is enabled.
|
|
290
325
|
* @property {number} brands - Brand UID
|
|
@@ -292,7 +327,7 @@ const Joi = require("joi");
|
|
|
292
327
|
*/
|
|
293
328
|
|
|
294
329
|
/**
|
|
295
|
-
* @typedef
|
|
330
|
+
* @typedef StoreByBrandsResponseSchema
|
|
296
331
|
* @property {BrandStoreInfo[]} [items]
|
|
297
332
|
* @property {Page} [page]
|
|
298
333
|
*/
|
|
@@ -320,21 +355,18 @@ const Joi = require("joi");
|
|
|
320
355
|
*/
|
|
321
356
|
|
|
322
357
|
/**
|
|
323
|
-
* @typedef
|
|
358
|
+
* @typedef BrandsByCompanyResponseSchema
|
|
324
359
|
* @property {CompanyBrandInfo[]} [brands]
|
|
325
360
|
*/
|
|
326
361
|
|
|
327
362
|
/**
|
|
328
|
-
* @typedef
|
|
363
|
+
* @typedef ValidationFailedResponseSchema
|
|
329
364
|
* @property {string} [message] - Response message for failed validation
|
|
330
|
-
* @property {Object[]} [errors] - Response message for failed validation
|
|
331
365
|
*/
|
|
332
366
|
|
|
333
367
|
/**
|
|
334
368
|
* @typedef NotFound
|
|
335
369
|
* @property {string} [message] - Response message for not found
|
|
336
|
-
* @property {string} [error] - Error message for not found
|
|
337
|
-
* @property {string} [code] - Unique code for each error
|
|
338
370
|
* @property {boolean} [success] - Flag for required not successfull.
|
|
339
371
|
*/
|
|
340
372
|
|
|
@@ -360,20 +392,20 @@ const Joi = require("joi");
|
|
|
360
392
|
*/
|
|
361
393
|
|
|
362
394
|
/**
|
|
363
|
-
* @typedef
|
|
395
|
+
* @typedef CreateApplicationRequestSchema
|
|
364
396
|
* @property {App} [app]
|
|
365
397
|
* @property {ApplicationInventory} [configuration]
|
|
366
398
|
* @property {AppDomain} [domain]
|
|
367
399
|
*/
|
|
368
400
|
|
|
369
401
|
/**
|
|
370
|
-
* @typedef
|
|
402
|
+
* @typedef CreateAppResponseSchema
|
|
371
403
|
* @property {Application} [app]
|
|
372
404
|
* @property {ApplicationInventory} [configuration]
|
|
373
405
|
*/
|
|
374
406
|
|
|
375
407
|
/**
|
|
376
|
-
* @typedef
|
|
408
|
+
* @typedef ApplicationsResponseSchema
|
|
377
409
|
* @property {Application[]} [items]
|
|
378
410
|
* @property {Page} [page]
|
|
379
411
|
*/
|
|
@@ -381,8 +413,7 @@ const Joi = require("joi");
|
|
|
381
413
|
/**
|
|
382
414
|
* @typedef MobileAppConfiguration
|
|
383
415
|
* @property {boolean} [is_active] - Indicates the availability of the mobile build
|
|
384
|
-
* @property {string} [_id] - The unique identifier
|
|
385
|
-
* for mobile application configuration
|
|
416
|
+
* @property {string} [_id] - The unique identifier for mobile application configuration
|
|
386
417
|
* @property {string} [app_name] - Name of the mobile app
|
|
387
418
|
* @property {LandingImage} [landing_image]
|
|
388
419
|
* @property {SplashImage} [splash_image]
|
|
@@ -411,7 +442,7 @@ const Joi = require("joi");
|
|
|
411
442
|
*/
|
|
412
443
|
|
|
413
444
|
/**
|
|
414
|
-
* @typedef
|
|
445
|
+
* @typedef MobileAppConfigRequestSchema
|
|
415
446
|
* @property {string} [app_name] - Name of the mobile app
|
|
416
447
|
* @property {LandingImage} [landing_image]
|
|
417
448
|
* @property {SplashImage} [splash_image]
|
|
@@ -427,7 +458,7 @@ const Joi = require("joi");
|
|
|
427
458
|
|
|
428
459
|
/**
|
|
429
460
|
* @typedef BuildVersion
|
|
430
|
-
* @property {string} [_id] -
|
|
461
|
+
* @property {string} [_id] - Primary Identifier of the build version.
|
|
431
462
|
* @property {string} [application] - Application ID of the sales channel
|
|
432
463
|
* @property {string} [platform_type] - Device platform for which the mobile app
|
|
433
464
|
* was built, e.g. android, ios.
|
|
@@ -446,8 +477,8 @@ const Joi = require("joi");
|
|
|
446
477
|
|
|
447
478
|
/**
|
|
448
479
|
* @typedef AppSupportedCurrency
|
|
449
|
-
* @property {string} [_id] - The unique identifier
|
|
450
|
-
*
|
|
480
|
+
* @property {string} [_id] - The unique identifier of the currency
|
|
481
|
+
* configuration supported by the application
|
|
451
482
|
* @property {string[]} [supported_currency]
|
|
452
483
|
* @property {string} [application] - Alphanumeric ID allotted to an application
|
|
453
484
|
* (sales channel website) created within a business account.
|
|
@@ -460,8 +491,7 @@ const Joi = require("joi");
|
|
|
460
491
|
|
|
461
492
|
/**
|
|
462
493
|
* @typedef DefaultCurrency
|
|
463
|
-
* @property {string} [ref] - The unique identifier
|
|
464
|
-
* of the default currency
|
|
494
|
+
* @property {string} [ref] - The unique identifier of the default currency
|
|
465
495
|
* @property {string} [code] - 3-character code of the default currency, e.g.
|
|
466
496
|
* INR, EUR, USD
|
|
467
497
|
*/
|
|
@@ -469,8 +499,7 @@ const Joi = require("joi");
|
|
|
469
499
|
/**
|
|
470
500
|
* @typedef DomainAdd
|
|
471
501
|
* @property {string} [name] - Full domain name, e.g. uniket.hostx0.de
|
|
472
|
-
* @property {string} [_id] - The unique identifier
|
|
473
|
-
* of the domain
|
|
502
|
+
* @property {string} [_id] - The unique identifier of the domain
|
|
474
503
|
* @property {boolean} [verified] - Domain is verified or not (indicates if A
|
|
475
504
|
* records and TXT records are correct)
|
|
476
505
|
* @property {boolean} [is_primary] - Domain is primary or not (indicates if the
|
|
@@ -483,15 +512,14 @@ const Joi = require("joi");
|
|
|
483
512
|
*/
|
|
484
513
|
|
|
485
514
|
/**
|
|
486
|
-
* @typedef
|
|
515
|
+
* @typedef DomainAddRequestSchema
|
|
487
516
|
* @property {DomainAdd} [domain]
|
|
488
517
|
*/
|
|
489
518
|
|
|
490
519
|
/**
|
|
491
520
|
* @typedef Domain
|
|
492
521
|
* @property {string} [name] - Full domain name, e.g. newton.com
|
|
493
|
-
* @property {string} [_id] - The unique identifier
|
|
494
|
-
* of the sales channel domain
|
|
522
|
+
* @property {string} [_id] - The unique identifier of the sales channel domain
|
|
495
523
|
* @property {boolean} [verified] - Domain is verified or not. TXT and A records
|
|
496
524
|
* should propagate correctly.
|
|
497
525
|
* @property {boolean} [is_primary] - Domain is primary or not. Primary domain
|
|
@@ -502,15 +530,14 @@ const Joi = require("joi");
|
|
|
502
530
|
*/
|
|
503
531
|
|
|
504
532
|
/**
|
|
505
|
-
* @typedef
|
|
533
|
+
* @typedef DomainsResponseSchema
|
|
506
534
|
* @property {Domain[]} [domains]
|
|
507
535
|
*/
|
|
508
536
|
|
|
509
537
|
/**
|
|
510
538
|
* @typedef UpdateDomain
|
|
511
539
|
* @property {string} [name] - Full domain name, e.g. zenz.com
|
|
512
|
-
* @property {string} [_id] - The unique identifier
|
|
513
|
-
* of the domain
|
|
540
|
+
* @property {string} [_id] - The unique identifier of the domain
|
|
514
541
|
* @property {boolean} [verified] - Domain is verified or not (indicates if A
|
|
515
542
|
* records and TXT records are correct)
|
|
516
543
|
* @property {boolean} [is_primary] - Domain is primary or not (indicates if the
|
|
@@ -520,14 +547,14 @@ const Joi = require("joi");
|
|
|
520
547
|
*/
|
|
521
548
|
|
|
522
549
|
/**
|
|
523
|
-
* @typedef
|
|
550
|
+
* @typedef UpdateDomainTypeRequestSchema
|
|
524
551
|
* @property {UpdateDomain} [domain]
|
|
525
552
|
* @property {string} [action] - Shows domain is made primary domain for the
|
|
526
553
|
* sales channel or shorlink is created for the sales channel domain
|
|
527
554
|
*/
|
|
528
555
|
|
|
529
556
|
/**
|
|
530
|
-
* @typedef
|
|
557
|
+
* @typedef DomainStatusRequestSchema
|
|
531
558
|
* @property {string} [domain_url] - URL of the domain, e.g. uniket.hostx0.de
|
|
532
559
|
*/
|
|
533
560
|
|
|
@@ -539,15 +566,17 @@ const Joi = require("joi");
|
|
|
539
566
|
*/
|
|
540
567
|
|
|
541
568
|
/**
|
|
542
|
-
* @typedef
|
|
569
|
+
* @typedef DomainStatusResponseSchema
|
|
543
570
|
* @property {boolean} [connected] - Check if domain is live and mapped to
|
|
544
571
|
* appropriate IP of Fynd Servers
|
|
545
572
|
* @property {DomainStatus[]} [status]
|
|
546
573
|
*/
|
|
547
574
|
|
|
548
575
|
/**
|
|
549
|
-
* @typedef
|
|
576
|
+
* @typedef DomainSuggestionsRequestSchema
|
|
550
577
|
* @property {string} [domain_url] - Domain url
|
|
578
|
+
* @property {boolean} [custom_domain] - Get suggestions for custom domains or
|
|
579
|
+
* Fynd domains
|
|
551
580
|
*/
|
|
552
581
|
|
|
553
582
|
/**
|
|
@@ -562,205 +591,16 @@ const Joi = require("joi");
|
|
|
562
591
|
*/
|
|
563
592
|
|
|
564
593
|
/**
|
|
565
|
-
* @typedef
|
|
594
|
+
* @typedef DomainSuggestionsResponseSchema
|
|
566
595
|
* @property {DomainSuggestion[]} [domains] - Domain URL
|
|
567
596
|
*/
|
|
568
597
|
|
|
569
598
|
/**
|
|
570
|
-
* @typedef
|
|
599
|
+
* @typedef SuccessMessageResponseSchema
|
|
571
600
|
* @property {boolean} [success] - Shows whether domain was deleted successfully
|
|
572
601
|
* @property {string} [message] - Success message shown to the user (in a string format)
|
|
573
602
|
*/
|
|
574
603
|
|
|
575
|
-
/**
|
|
576
|
-
* @typedef GetIntegrationsOptInsResponse
|
|
577
|
-
* @property {IntegrationOptIn[]} [items]
|
|
578
|
-
* @property {Page} [page]
|
|
579
|
-
*/
|
|
580
|
-
|
|
581
|
-
/**
|
|
582
|
-
* @typedef IntegrationOptIn
|
|
583
|
-
* @property {Validators} [validators]
|
|
584
|
-
* @property {string} [description] - Basic description about the opted integration
|
|
585
|
-
* @property {string} [description_html] - Basic HTML description about the
|
|
586
|
-
* opted integration
|
|
587
|
-
* @property {string} [constants]
|
|
588
|
-
* @property {string[]} [companies]
|
|
589
|
-
* @property {string[]} [support]
|
|
590
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
591
|
-
* of the opted integration
|
|
592
|
-
* @property {string} [name] - Nmae of the opted integration, e.g. SAP RBL Integration
|
|
593
|
-
* @property {string} [slug] - Slug of the opted integration, e.g. ginesys
|
|
594
|
-
* @property {boolean} [hidden]
|
|
595
|
-
* @property {IntegrationMeta[]} [meta]
|
|
596
|
-
* @property {string} [icon] - Hosted URL of the icon image
|
|
597
|
-
* @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
|
|
598
|
-
* of the user who created the integration
|
|
599
|
-
* @property {string} [created_at] - ISO 8601 timestamp of integration creation
|
|
600
|
-
* @property {string} [modified_at] - ISO 8601 timestamp of integration updation
|
|
601
|
-
* @property {string} [token] - Randomly generated fixed-length string for opted
|
|
602
|
-
* integration. It is auto-generated. It would never change once it is generated.
|
|
603
|
-
* @property {string} [secret] - Randomly generated fixed-length string for
|
|
604
|
-
* opted integration. It is auto-generated. It would never change once it is generated.
|
|
605
|
-
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
606
|
-
*/
|
|
607
|
-
|
|
608
|
-
/**
|
|
609
|
-
* @typedef Validators
|
|
610
|
-
* @property {CompanyValidator} [company]
|
|
611
|
-
* @property {StoreValidator} [store]
|
|
612
|
-
* @property {InventoryValidator} [inventory]
|
|
613
|
-
* @property {OrderValidator} [order]
|
|
614
|
-
*/
|
|
615
|
-
|
|
616
|
-
/**
|
|
617
|
-
* @typedef CompanyValidator
|
|
618
|
-
* @property {JsonSchema[]} [json_schema]
|
|
619
|
-
* @property {string} [browser_script] - Browser script for the company validator
|
|
620
|
-
*/
|
|
621
|
-
|
|
622
|
-
/**
|
|
623
|
-
* @typedef JsonSchema
|
|
624
|
-
* @property {string} [display] - Display text of the validator JSON schema. It
|
|
625
|
-
* will show in the UI.
|
|
626
|
-
* @property {string} [key] - Key related to the display text of the validator JSON schema
|
|
627
|
-
* @property {string} [type] - Indicates the type of form field, e.g. Text, Dropdown.
|
|
628
|
-
* @property {string} [tooltip] - Tooltip text for the UI of the validator JSON
|
|
629
|
-
* schema. It will show in the UI.
|
|
630
|
-
*/
|
|
631
|
-
|
|
632
|
-
/**
|
|
633
|
-
* @typedef StoreValidator
|
|
634
|
-
* @property {JsonSchema[]} [json_schema]
|
|
635
|
-
* @property {string} [browser_script] - Browser script for the store validator
|
|
636
|
-
*/
|
|
637
|
-
|
|
638
|
-
/**
|
|
639
|
-
* @typedef InventoryValidator
|
|
640
|
-
* @property {JsonSchema[]} [json_schema]
|
|
641
|
-
* @property {string} [browser_script] - Browser script for the inventory validator
|
|
642
|
-
*/
|
|
643
|
-
|
|
644
|
-
/**
|
|
645
|
-
* @typedef OrderValidator
|
|
646
|
-
* @property {JsonSchema[]} [json_schema]
|
|
647
|
-
* @property {string} [browser_script] - Browser script for the order validator
|
|
648
|
-
*/
|
|
649
|
-
|
|
650
|
-
/**
|
|
651
|
-
* @typedef IntegrationMeta
|
|
652
|
-
* @property {boolean} [is_public]
|
|
653
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
654
|
-
* of the integration meta
|
|
655
|
-
* @property {string} [name] - Nmae of integration meta, e.g. price_level
|
|
656
|
-
* @property {string} [value] - Value related to integration meta name, e.g. store
|
|
657
|
-
*/
|
|
658
|
-
|
|
659
|
-
/**
|
|
660
|
-
* @typedef Integration
|
|
661
|
-
* @property {Validators} [validators]
|
|
662
|
-
* @property {string} [description] - Basic description about the integration
|
|
663
|
-
* @property {string} [description_html] - Basic HTML description about the integration
|
|
664
|
-
* @property {Object} [constants]
|
|
665
|
-
* @property {string[]} [companies]
|
|
666
|
-
* @property {string[]} [support]
|
|
667
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
668
|
-
* of the integration
|
|
669
|
-
* @property {string} [name] - Name of the integration, e.g. SAP RBL Integration
|
|
670
|
-
* @property {string} [slug] - Name of the integration, e.g. SAP RBL Integration
|
|
671
|
-
* @property {IntegrationMeta[]} [meta]
|
|
672
|
-
* @property {string} [icon] - Hosted URL of the icon image
|
|
673
|
-
* @property {boolean} [hidden]
|
|
674
|
-
* @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
|
|
675
|
-
* of the user who created the integration
|
|
676
|
-
* @property {string} [created_at] - ISO 8601 timestamp of integration creation
|
|
677
|
-
* @property {string} [modified_at] - ISO 8601 timestamp of integration updation
|
|
678
|
-
* @property {string} [token] - Randomly generated fixed-length string for opted
|
|
679
|
-
* integration. It is auto-generated. It would never change once it is generated.
|
|
680
|
-
* @property {string} [secret] - Randomly generated fixed-length string for
|
|
681
|
-
* opted integration. It is auto-generated. It would never change once it is generated.
|
|
682
|
-
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
683
|
-
*/
|
|
684
|
-
|
|
685
|
-
/**
|
|
686
|
-
* @typedef IntegrationConfigResponse
|
|
687
|
-
* @property {IntegrationLevel[]} [items]
|
|
688
|
-
*/
|
|
689
|
-
|
|
690
|
-
/**
|
|
691
|
-
* @typedef IntegrationLevel
|
|
692
|
-
* @property {boolean} [opted] - Shows this integration is opted or not opted
|
|
693
|
-
* for the current company
|
|
694
|
-
* @property {Object[]} [permissions]
|
|
695
|
-
* @property {LastPatch[]} [last_patch]
|
|
696
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
697
|
-
* of the integration config
|
|
698
|
-
* @property {string} [integration] - Integration id. Shows which integration
|
|
699
|
-
* you are enabling.
|
|
700
|
-
* @property {string} [level] - Shows for what level the integration is set up.
|
|
701
|
-
* It can be company level or store level.
|
|
702
|
-
* @property {number} [uid] - It can be store uid or company uid. Depends on the
|
|
703
|
-
* level of integration.
|
|
704
|
-
* @property {number} [company_id] - Unique id of company.
|
|
705
|
-
* @property {IntegrationMeta[]} [meta]
|
|
706
|
-
* @property {string} [token] - Randomly generated fixed-length string for opted
|
|
707
|
-
* integration. It is auto-generated. It would never change once it is generated.
|
|
708
|
-
* @property {string} [created_at] - ISO 8601 timestamp of integration config creation
|
|
709
|
-
* @property {string} [modified_at] - ISO 8601 timestamp of integration config updation
|
|
710
|
-
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
711
|
-
* @property {Object} [data] - Schema data of the integration stored in key-value pairs
|
|
712
|
-
* @property {boolean} [success]
|
|
713
|
-
* @property {string} [message]
|
|
714
|
-
*/
|
|
715
|
-
|
|
716
|
-
/**
|
|
717
|
-
* @typedef UpdateIntegrationLevelRequest
|
|
718
|
-
* @property {IntegrationLevel[]} [items]
|
|
719
|
-
*/
|
|
720
|
-
|
|
721
|
-
/**
|
|
722
|
-
* @typedef OptedStoreIntegration
|
|
723
|
-
* @property {boolean} [other_opted] - Allow user to opt same store in other integration
|
|
724
|
-
* @property {IntegrationOptIn} [other_integration]
|
|
725
|
-
* @property {OtherEntity} [other_entity]
|
|
726
|
-
*/
|
|
727
|
-
|
|
728
|
-
/**
|
|
729
|
-
* @typedef OtherEntity
|
|
730
|
-
* @property {boolean} [opted] - Allow other entity opted in integration
|
|
731
|
-
* @property {string[]} [permissions]
|
|
732
|
-
* @property {LastPatch[]} [last_patch]
|
|
733
|
-
* @property {string} [_id] - The unique identifier of the other entity for
|
|
734
|
-
* opted store integration
|
|
735
|
-
* @property {string} [integration] - Integration ID. Shows which integration
|
|
736
|
-
* you are enabling.
|
|
737
|
-
* @property {string} [level] - Indicates integration level. It can be company
|
|
738
|
-
* level or store level.
|
|
739
|
-
* @property {number} [uid] - It can be store uid or company uid. Depends on the
|
|
740
|
-
* level of integration.
|
|
741
|
-
* @property {OtherEntityData} [data]
|
|
742
|
-
* @property {Object[]} [meta]
|
|
743
|
-
* @property {string} [token] - Randomly generated fixed-length string for opted
|
|
744
|
-
* integration. It is auto-generated. It would never change once it is generated.
|
|
745
|
-
* @property {string} [created_at] - ISO 8601 timestamp of other entity creation
|
|
746
|
-
* for opted store integration
|
|
747
|
-
* @property {string} [modified_at] - ISO 8601 timestamp of other entity
|
|
748
|
-
* updation for opted store integration
|
|
749
|
-
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
750
|
-
*/
|
|
751
|
-
|
|
752
|
-
/**
|
|
753
|
-
* @typedef LastPatch
|
|
754
|
-
* @property {string} [op]
|
|
755
|
-
* @property {string} [path]
|
|
756
|
-
* @property {string} [value] - It can be inventory level or order level
|
|
757
|
-
*/
|
|
758
|
-
|
|
759
|
-
/**
|
|
760
|
-
* @typedef OtherEntityData
|
|
761
|
-
* @property {string} [article_identifier]
|
|
762
|
-
*/
|
|
763
|
-
|
|
764
604
|
/**
|
|
765
605
|
* @typedef App
|
|
766
606
|
* @property {string} [company_id] - Numeric ID allotted to a business account
|
|
@@ -772,34 +612,13 @@ const Joi = require("joi");
|
|
|
772
612
|
* @property {string} [desc] - Detailed description about the sales channel
|
|
773
613
|
*/
|
|
774
614
|
|
|
775
|
-
/**
|
|
776
|
-
* @typedef InventoryConfig
|
|
777
|
-
* @property {InventoryBrandRule} [brand]
|
|
778
|
-
* @property {InventoryStoreRule} [store]
|
|
779
|
-
* @property {string[]} [image]
|
|
780
|
-
* @property {boolean} [franchise_enabled] - Allow other businesses (companies)
|
|
781
|
-
* to consume the current sales channel's inventory and sell products
|
|
782
|
-
* @property {boolean} [out_of_stock] - Indicates whether out of stock products
|
|
783
|
-
* are allowed to show up on the website.
|
|
784
|
-
* @property {boolean} [only_verified_products] - Show only verified products
|
|
785
|
-
* (the ones whose data have been verified by the admin)
|
|
786
|
-
* @property {PricingStrategy} [pricing_strategy]
|
|
787
|
-
*/
|
|
788
|
-
|
|
789
|
-
/**
|
|
790
|
-
* @typedef AppInventory
|
|
791
|
-
* @property {InventoryConfig} [inventory]
|
|
792
|
-
* @property {InventoryPaymentConfig} [payment]
|
|
793
|
-
* @property {InventoryArticleAssignment} [article_assignment]
|
|
794
|
-
*/
|
|
795
|
-
|
|
796
615
|
/**
|
|
797
616
|
* @typedef AppDomain
|
|
798
617
|
* @property {string} [name] - Domain URL of current sales channel, e.g. zenz.com
|
|
799
618
|
*/
|
|
800
619
|
|
|
801
620
|
/**
|
|
802
|
-
* @typedef
|
|
621
|
+
* @typedef CompaniesResponseSchema
|
|
803
622
|
* @property {AppInventoryCompanies[]} [items]
|
|
804
623
|
* @property {Page} [page]
|
|
805
624
|
*/
|
|
@@ -813,25 +632,15 @@ const Joi = require("joi");
|
|
|
813
632
|
*/
|
|
814
633
|
|
|
815
634
|
/**
|
|
816
|
-
* @typedef
|
|
635
|
+
* @typedef StoresResponseSchema
|
|
817
636
|
* @property {AppInventoryStores[]} [items]
|
|
818
637
|
* @property {Page} [page]
|
|
819
638
|
*/
|
|
820
639
|
|
|
821
|
-
/**
|
|
822
|
-
* @typedef ListStoreResponse
|
|
823
|
-
* @property {AppInventoryStores[]} [stores]
|
|
824
|
-
*/
|
|
825
|
-
|
|
826
|
-
/**
|
|
827
|
-
* @typedef ArrayStoreResponse
|
|
828
|
-
* @property {AppInventoryStores[]} [data]
|
|
829
|
-
*/
|
|
830
|
-
|
|
831
640
|
/**
|
|
832
641
|
* @typedef AppInventoryStores
|
|
833
|
-
* @property {string} [_id] - The unique identifier of the store
|
|
834
|
-
*
|
|
642
|
+
* @property {string} [_id] - The unique identifier of the store in the sales
|
|
643
|
+
* channel inventory
|
|
835
644
|
* @property {string} [modified_on] - ISO 8601 timestamp of last known updation
|
|
836
645
|
* to the stores in sales channel inventory
|
|
837
646
|
* @property {number} [uid] - Sales channel inventory store UID
|
|
@@ -850,7 +659,7 @@ const Joi = require("joi");
|
|
|
850
659
|
*/
|
|
851
660
|
|
|
852
661
|
/**
|
|
853
|
-
* @typedef
|
|
662
|
+
* @typedef FilterOrderingStoreRequestSchema
|
|
854
663
|
* @property {boolean} [all_stores] - Allow all stores from the ordering stores
|
|
855
664
|
* @property {number[]} [deployed_stores]
|
|
856
665
|
* @property {string} [q] - Store code or name of the ordering store
|
|
@@ -864,8 +673,7 @@ const Joi = require("joi");
|
|
|
864
673
|
* @property {string} [type] - Permitted values are 'hard' and 'soft'. For hard
|
|
865
674
|
* type delivery, store selection is compulsory. For soft type, delivery store
|
|
866
675
|
* selection is optional.
|
|
867
|
-
* @property {string} [_id] - The unique identifier
|
|
868
|
-
* of the ordering stores
|
|
676
|
+
* @property {string} [_id] - The unique identifier of the ordering stores
|
|
869
677
|
* @property {string} [app] - Alphanumeric ID allotted to an application (sales
|
|
870
678
|
* channel website) created within a business account
|
|
871
679
|
* @property {number} [__v]
|
|
@@ -877,7 +685,7 @@ const Joi = require("joi");
|
|
|
877
685
|
*/
|
|
878
686
|
|
|
879
687
|
/**
|
|
880
|
-
* @typedef
|
|
688
|
+
* @typedef OrderingStoreSelectRequestSchema
|
|
881
689
|
* @property {OrderingStoreSelect} ordering_store
|
|
882
690
|
*/
|
|
883
691
|
|
|
@@ -896,8 +704,7 @@ const Joi = require("joi");
|
|
|
896
704
|
* @typedef OtherSellerApplication
|
|
897
705
|
* @property {string} [name] - Name of the other seller's sales channel
|
|
898
706
|
* @property {string} [description] - Basic details about the other seller's sales channel
|
|
899
|
-
* @property {string} [_id] - The unique identifier
|
|
900
|
-
* of the other seller's sales channel
|
|
707
|
+
* @property {string} [_id] - The unique identifier of the other seller's sales channel
|
|
901
708
|
* @property {string} [domain] - Domain URL of the other seller's sales channel
|
|
902
709
|
* @property {OtherSellerCompany} [company]
|
|
903
710
|
* @property {string} [opt_type] - Inventory opted by the other seller's sales
|
|
@@ -911,11 +718,10 @@ const Joi = require("joi");
|
|
|
911
718
|
*/
|
|
912
719
|
|
|
913
720
|
/**
|
|
914
|
-
* @typedef
|
|
721
|
+
* @typedef OptedApplicationResponseSchema
|
|
915
722
|
* @property {string} [name] - Name of the other seller's sales channel
|
|
916
723
|
* @property {string} [description] - Basic details about the other seller's sales channel
|
|
917
|
-
* @property {string} [_id] - The unique identifier
|
|
918
|
-
* of the other seller's sales channel
|
|
724
|
+
* @property {string} [_id] - The unique identifier of the other seller's sales channel
|
|
919
725
|
* @property {string} [domain] - Domain URL of the other seller's sales channel
|
|
920
726
|
* @property {OptedCompany} [company]
|
|
921
727
|
* @property {OptedInventory} [opted_inventory]
|
|
@@ -968,10 +774,9 @@ const Joi = require("joi");
|
|
|
968
774
|
*/
|
|
969
775
|
|
|
970
776
|
/**
|
|
971
|
-
* @typedef
|
|
777
|
+
* @typedef TokenResponseSchema
|
|
972
778
|
* @property {Tokens} [tokens]
|
|
973
|
-
* @property {string} [_id] - The unique identifier
|
|
974
|
-
* of the token
|
|
779
|
+
* @property {string} [_id] - The unique identifier of the token
|
|
975
780
|
* @property {string} [application] - Alphanumeric ID allotted to the current
|
|
976
781
|
* application created within the current business account
|
|
977
782
|
* @property {string} [created_at] - ISO 8601 timestamp of token creation
|
|
@@ -1180,6 +985,22 @@ const Joi = require("joi");
|
|
|
1180
985
|
* address of the store, should be displayed upon visiting the website
|
|
1181
986
|
*/
|
|
1182
987
|
|
|
988
|
+
/**
|
|
989
|
+
* @typedef BuyboxFeature
|
|
990
|
+
* @property {boolean} [show_name] - Allow users to see seller/stores name on
|
|
991
|
+
* PDP (product detail page).
|
|
992
|
+
* @property {boolean} [enable_selection] - Allow selection of sellers/stores on
|
|
993
|
+
* PDP (product detail page).
|
|
994
|
+
* @property {boolean} [is_seller_buybox_enabled] - Toggle buybox listing
|
|
995
|
+
* between sellers and stores. True indicates seller listing, while False
|
|
996
|
+
* indicates store listing.
|
|
997
|
+
*/
|
|
998
|
+
|
|
999
|
+
/**
|
|
1000
|
+
* @typedef DeliveryStrategy
|
|
1001
|
+
* @property {string} [value] - Indicates the delivery strategy value.
|
|
1002
|
+
*/
|
|
1003
|
+
|
|
1183
1004
|
/**
|
|
1184
1005
|
* @typedef AppFeature
|
|
1185
1006
|
* @property {ProductDetailFeature} [product_detail]
|
|
@@ -1192,15 +1013,14 @@ const Joi = require("joi");
|
|
|
1192
1013
|
* @property {PcrFeature} [pcr]
|
|
1193
1014
|
* @property {OrderFeature} [order]
|
|
1194
1015
|
* @property {BuyboxFeature} [buybox]
|
|
1195
|
-
* @property {
|
|
1196
|
-
*
|
|
1016
|
+
* @property {DeliveryStrategy} [delivery_strategy]
|
|
1017
|
+
* @property {string} [_id] - The unique identifier for the sales channel features
|
|
1197
1018
|
* @property {string} [app] - Application ID of the sales channel
|
|
1198
1019
|
* @property {string} [created_at] - ISO 8601 timestamp showing the date when
|
|
1199
1020
|
* the features were configured
|
|
1200
1021
|
* @property {string} [modified_at] - ISO 8601 timestamp of last known
|
|
1201
1022
|
* modifications to the sales channel feature configuration
|
|
1202
1023
|
* @property {number} [__v] - Version key for tracking revisions. Default value is zero
|
|
1203
|
-
* @property {PricingStrategy} [pricing_strategy]
|
|
1204
1024
|
*/
|
|
1205
1025
|
|
|
1206
1026
|
/**
|
|
@@ -1312,30 +1132,19 @@ const Joi = require("joi");
|
|
|
1312
1132
|
*/
|
|
1313
1133
|
|
|
1314
1134
|
/**
|
|
1315
|
-
* @typedef
|
|
1316
|
-
* @property {boolean} [show_name] - Allow users to see seller/stores name on
|
|
1317
|
-
* PDP (product detail page).
|
|
1318
|
-
* @property {boolean} [enable_selection] - Allow selection of sellers/stores on
|
|
1319
|
-
* PDP (product detail page).
|
|
1320
|
-
* @property {boolean} [is_seller_buybox_enabled] - Toggle buybox listing
|
|
1321
|
-
* between sellers and stores. True indicates seller listing, while False
|
|
1322
|
-
* indicates store listing.
|
|
1323
|
-
*/
|
|
1324
|
-
|
|
1325
|
-
/**
|
|
1326
|
-
* @typedef AppFeatureRequest
|
|
1135
|
+
* @typedef AppFeatureRequestSchema
|
|
1327
1136
|
* @property {AppFeature} [feature]
|
|
1328
1137
|
*/
|
|
1329
1138
|
|
|
1330
1139
|
/**
|
|
1331
|
-
* @typedef
|
|
1140
|
+
* @typedef AppFeatureResponseSchema
|
|
1332
1141
|
* @property {AppFeature} [feature]
|
|
1333
1142
|
*/
|
|
1334
1143
|
|
|
1335
1144
|
/**
|
|
1336
1145
|
* @typedef Currency
|
|
1337
|
-
* @property {string} [_id] - The unique identifier
|
|
1338
|
-
*
|
|
1146
|
+
* @property {string} [_id] - The unique identifier of the current sales channel
|
|
1147
|
+
* supported currency
|
|
1339
1148
|
* @property {boolean} [is_active] - Shows currency is enabled or not in current
|
|
1340
1149
|
* sales channel
|
|
1341
1150
|
* @property {string} [name] - Name of the currency, e.g Indian Rupee
|
|
@@ -1347,7 +1156,7 @@ const Joi = require("joi");
|
|
|
1347
1156
|
* @property {number} [decimal_digits] - Acceptable decimal limits for a given
|
|
1348
1157
|
* currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid
|
|
1349
1158
|
* value of a currency.
|
|
1350
|
-
* @property {string} [symbol] - Unique symbol for identifying the currency, e.g.
|
|
1159
|
+
* @property {string} [symbol] - Unique symbol for identifying the currency, e.g. ₹
|
|
1351
1160
|
* @property {string} [country_name]
|
|
1352
1161
|
* @property {string} [country_code]
|
|
1353
1162
|
*/
|
|
@@ -1404,11 +1213,9 @@ const Joi = require("joi");
|
|
|
1404
1213
|
* @property {boolean} [is_internal] - Indicates whether a sales channel is
|
|
1405
1214
|
* internal or not
|
|
1406
1215
|
* @property {boolean} [is_active] - Indicates sales channel is active or not active
|
|
1407
|
-
* @property {string} [_id] - The unique identifier
|
|
1408
|
-
* of the sales channel
|
|
1216
|
+
* @property {string} [_id] - The unique identifier of the sales channel
|
|
1409
1217
|
* @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
|
|
1410
|
-
* @property {string} [owner] - The unique identifier
|
|
1411
|
-
* of owner who owns the application
|
|
1218
|
+
* @property {string} [owner] - The unique identifier of owner who owns the application
|
|
1412
1219
|
* @property {number} [company_id] - Numeric ID allotted to a business account
|
|
1413
1220
|
* where the sales channel exists
|
|
1414
1221
|
* @property {string} [token] - Random generated fix length string for sales
|
|
@@ -1433,70 +1240,63 @@ const Joi = require("joi");
|
|
|
1433
1240
|
*/
|
|
1434
1241
|
|
|
1435
1242
|
/**
|
|
1436
|
-
* @typedef
|
|
1437
|
-
* @property {
|
|
1438
|
-
* @property {
|
|
1439
|
-
* @property {
|
|
1440
|
-
|
|
1441
|
-
|
|
1442
|
-
|
|
1443
|
-
*
|
|
1444
|
-
* @property {
|
|
1445
|
-
*
|
|
1446
|
-
* @property {
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
|
-
* @
|
|
1451
|
-
* @property {string} [
|
|
1452
|
-
*
|
|
1453
|
-
*
|
|
1454
|
-
|
|
1455
|
-
|
|
1456
|
-
|
|
1457
|
-
* @
|
|
1458
|
-
* @property {string} [
|
|
1459
|
-
|
|
1460
|
-
|
|
1461
|
-
|
|
1462
|
-
* @
|
|
1463
|
-
* @property {
|
|
1464
|
-
* @property {
|
|
1465
|
-
|
|
1466
|
-
|
|
1467
|
-
|
|
1468
|
-
* @
|
|
1469
|
-
* @property {string} [
|
|
1470
|
-
*
|
|
1471
|
-
* @property {
|
|
1472
|
-
*
|
|
1473
|
-
* @property {number[]} [stores] - List of store uids. Used when critera is `explicit`.
|
|
1474
|
-
*/
|
|
1475
|
-
|
|
1476
|
-
/**
|
|
1477
|
-
* @typedef InventoryPaymentConfig
|
|
1478
|
-
* @property {string} [mode_of_payment] - Mode of payment for the inventory of
|
|
1479
|
-
* sales channel. It is required and default value is null.
|
|
1480
|
-
* @property {string} [source] - Source of the payment mode for the inventory
|
|
1481
|
-
* payment of sales channel. Default value is FYND.
|
|
1243
|
+
* @typedef ApplicationById
|
|
1244
|
+
* @property {ApplicationWebsite} [website]
|
|
1245
|
+
* @property {ApplicationCors} [cors]
|
|
1246
|
+
* @property {ApplicationAuth} [auth]
|
|
1247
|
+
* @property {string} [description] - It contains detailed information about the
|
|
1248
|
+
* sales channel.
|
|
1249
|
+
* @property {string} [channel_type] - It indicates different types of channels,
|
|
1250
|
+
* such as store, website, and mobile apps, with 'store' being the default value.
|
|
1251
|
+
* @property {number} [cache_ttl] - An integer value that specifies the number
|
|
1252
|
+
* of seconds until the key expires
|
|
1253
|
+
* @property {boolean} [is_internal] - Indicates whether a sales channel is
|
|
1254
|
+
* internal or not
|
|
1255
|
+
* @property {boolean} [is_active] - Indicates sales channel is active or not active
|
|
1256
|
+
* @property {string} [_id] - The unique identifier of the sales channel
|
|
1257
|
+
* @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
|
|
1258
|
+
* @property {string} [owner] - The unique identifier of owner who owns the application
|
|
1259
|
+
* @property {number} [company_id] - Numeric ID allotted to a business account
|
|
1260
|
+
* where the sales channel exists
|
|
1261
|
+
* @property {string} [token] - Random generated fix length string for sales
|
|
1262
|
+
* channel. It is required and auto-generated.
|
|
1263
|
+
* @property {ApplicationRedirections[]} [redirections]
|
|
1264
|
+
* @property {ApplicationMeta[]} [meta]
|
|
1265
|
+
* @property {string} [created_at] - ISO 8601 timestamp of sales channel creation
|
|
1266
|
+
* @property {string} [modified_at] - ISO 8601 timestamp of sales channel updation
|
|
1267
|
+
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
1268
|
+
* @property {SecureUrl} [banner]
|
|
1269
|
+
* @property {SecureUrl} [logo]
|
|
1270
|
+
* @property {SecureUrl} [favicon]
|
|
1271
|
+
* @property {Domain[]} [domains]
|
|
1272
|
+
* @property {string} [app_type] - It shows application is live or in development mode.
|
|
1273
|
+
* @property {SecureUrl} [mobile_logo]
|
|
1274
|
+
* @property {Domain} [domain]
|
|
1275
|
+
* @property {string} [slug]
|
|
1276
|
+
* @property {string} [mode]
|
|
1277
|
+
* @property {string} [status]
|
|
1278
|
+
* @property {TokenSchemaID[]} [tokens]
|
|
1279
|
+
* @property {string} [secret]
|
|
1482
1280
|
*/
|
|
1483
1281
|
|
|
1484
1282
|
/**
|
|
1485
|
-
* @typedef
|
|
1486
|
-
* @property {
|
|
1487
|
-
*
|
|
1488
|
-
* @property {string
|
|
1283
|
+
* @typedef TokenSchemaID
|
|
1284
|
+
* @property {string} [token]
|
|
1285
|
+
* @property {string} [created_by]
|
|
1286
|
+
* @property {string} [created_at] - ISO 8601 timestamp of when token created
|
|
1489
1287
|
*/
|
|
1490
1288
|
|
|
1491
1289
|
/**
|
|
1492
|
-
* @typedef
|
|
1493
|
-
* @property {
|
|
1290
|
+
* @typedef TokenSchema
|
|
1291
|
+
* @property {string} [token]
|
|
1292
|
+
* @property {Object} [created_by]
|
|
1293
|
+
* @property {string} [created_at] - ISO 8601 timestamp of when token created
|
|
1494
1294
|
*/
|
|
1495
1295
|
|
|
1496
1296
|
/**
|
|
1497
|
-
* @typedef
|
|
1498
|
-
* @property {
|
|
1499
|
-
* @property {
|
|
1297
|
+
* @typedef InvalidPayloadRequestSchema
|
|
1298
|
+
* @property {string} [message] - Error message when request body payload is improper
|
|
1299
|
+
* @property {boolean} [success] - Flag for required not successfull.
|
|
1500
1300
|
*/
|
|
1501
1301
|
|
|
1502
1302
|
/**
|
|
@@ -1508,7 +1308,7 @@ const Joi = require("joi");
|
|
|
1508
1308
|
* @property {number} [current] - The current page number.
|
|
1509
1309
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
1510
1310
|
* @property {number} [size] - The number of items per page.
|
|
1511
|
-
* @property {number} [
|
|
1311
|
+
* @property {number} [page_size] - The number of items per page.
|
|
1512
1312
|
*/
|
|
1513
1313
|
|
|
1514
1314
|
/**
|
|
@@ -1519,8 +1319,7 @@ const Joi = require("joi");
|
|
|
1519
1319
|
* @property {Links[]} [links]
|
|
1520
1320
|
* @property {string} [copyright_text] - Copyright statement usually seen at the
|
|
1521
1321
|
* site's footer
|
|
1522
|
-
* @property {string} [_id] - Unique identifier
|
|
1523
|
-
* the application information
|
|
1322
|
+
* @property {string} [_id] - Unique identifier of the application information
|
|
1524
1323
|
* @property {BusinessHighlights[]} [business_highlights]
|
|
1525
1324
|
* @property {string} [application] - Alphanumeric ID allotted to a sales
|
|
1526
1325
|
* channel application created within a business account
|
|
@@ -1657,8 +1456,7 @@ const Joi = require("joi");
|
|
|
1657
1456
|
|
|
1658
1457
|
/**
|
|
1659
1458
|
* @typedef BusinessHighlights
|
|
1660
|
-
* @property {string} [_id] - Unique identifier
|
|
1661
|
-
* the related business
|
|
1459
|
+
* @property {string} [_id] - Unique identifier of the related business
|
|
1662
1460
|
* @property {string} [title] - Title of the business highlight, e.g. Superfast Delivery
|
|
1663
1461
|
* @property {string} [icon] - Hosted URL of icon image representing the
|
|
1664
1462
|
* business highlight
|
|
@@ -1676,21 +1474,20 @@ const Joi = require("joi");
|
|
|
1676
1474
|
* @property {SecureUrl} [banner]
|
|
1677
1475
|
* @property {Domain} [domain]
|
|
1678
1476
|
* @property {Domain[]} [domains]
|
|
1679
|
-
* @property {string} [_id] - The unique identifier
|
|
1680
|
-
* for the sales channel details
|
|
1477
|
+
* @property {string} [_id] - The unique identifier for the sales channel details
|
|
1681
1478
|
* @property {string} [slug]
|
|
1682
1479
|
* @property {number} [company_id]
|
|
1683
1480
|
*/
|
|
1684
1481
|
|
|
1685
1482
|
/**
|
|
1686
|
-
* @typedef
|
|
1483
|
+
* @typedef CurrenciesResponseSchema
|
|
1687
1484
|
* @property {Currency[]} [items]
|
|
1688
1485
|
*/
|
|
1689
1486
|
|
|
1690
1487
|
/**
|
|
1691
|
-
* @typedef
|
|
1692
|
-
* @property {string} [_id] - The unique identifier
|
|
1693
|
-
*
|
|
1488
|
+
* @typedef AppCurrencyResponseSchema
|
|
1489
|
+
* @property {string} [_id] - The unique identifier of the currency
|
|
1490
|
+
* configuration supported by the application
|
|
1694
1491
|
* @property {string} [application] - Alphanumeric ID allotted to an application
|
|
1695
1492
|
* (sales channel website) created within a business account
|
|
1696
1493
|
* @property {DefaultCurrency} [default_currency]
|
|
@@ -1719,14 +1516,12 @@ const Joi = require("joi");
|
|
|
1719
1516
|
* @property {string} [sector] - Sector for the opted store.
|
|
1720
1517
|
* @property {string} [country_code] - Country code of the selected country
|
|
1721
1518
|
* @property {string} [state_code] - Selected state code
|
|
1722
|
-
* @property {string} [landmark] - Landmark of the address
|
|
1723
1519
|
*/
|
|
1724
1520
|
|
|
1725
1521
|
/**
|
|
1726
1522
|
* @typedef OrderingStore
|
|
1727
1523
|
* @property {OptedStoreAddress} [address]
|
|
1728
|
-
* @property {string} [_id] - The unique identifier
|
|
1729
|
-
* of the ordering store
|
|
1524
|
+
* @property {string} [_id] - The unique identifier of the ordering store
|
|
1730
1525
|
* @property {number} [uid] - Ordering store UID
|
|
1731
1526
|
* @property {string} [name] - Store name of the ordering store
|
|
1732
1527
|
* @property {string} [display_name] - Display name of the ordering store
|
|
@@ -1746,8 +1541,7 @@ const Joi = require("joi");
|
|
|
1746
1541
|
* @property {boolean} [enabled] - Allow ordering stores for current sales channel
|
|
1747
1542
|
* @property {string} [type] - For hard type delivery, store selection is
|
|
1748
1543
|
* compulsory. For soft type, delivery store selection is optional.
|
|
1749
|
-
* @property {string} [_id] - The unique identifier
|
|
1750
|
-
* of the ordering store
|
|
1544
|
+
* @property {string} [_id] - The unique identifier of the ordering store
|
|
1751
1545
|
* @property {string} [app] - Alphanumeric ID allotted to an application (sales
|
|
1752
1546
|
* channel website) created within a business account
|
|
1753
1547
|
* @property {number} [__v] - Version key for tracking ordering stores. Default
|
|
@@ -1755,139 +1549,54 @@ const Joi = require("joi");
|
|
|
1755
1549
|
*/
|
|
1756
1550
|
|
|
1757
1551
|
/**
|
|
1758
|
-
* @typedef
|
|
1759
|
-
* @property {string} type
|
|
1760
|
-
* @property {number} [interval]
|
|
1761
|
-
*/
|
|
1762
|
-
|
|
1763
|
-
/**
|
|
1764
|
-
* @typedef PlatformVersionRequest
|
|
1765
|
-
* @property {string} app_code_name
|
|
1766
|
-
* @property {string} app_name
|
|
1767
|
-
* @property {string} force_version
|
|
1768
|
-
* @property {string} latest_version
|
|
1769
|
-
* @property {boolean} is_app_blocked
|
|
1770
|
-
* @property {UpdateDiealog} update_dialog
|
|
1771
|
-
*/
|
|
1772
|
-
|
|
1773
|
-
/**
|
|
1774
|
-
* @typedef PlatformVersion
|
|
1775
|
-
* @property {string} app_code_name
|
|
1776
|
-
* @property {string} app_name
|
|
1777
|
-
* @property {string} force_version
|
|
1778
|
-
* @property {string} latest_version
|
|
1779
|
-
* @property {boolean} is_app_blocked
|
|
1780
|
-
* @property {UpdateDiealog} update_dialog
|
|
1781
|
-
* @property {string} [_id]
|
|
1782
|
-
* @property {string} [modified_at] - ISO 8601 timestamp when currency was added
|
|
1783
|
-
* in the list of currencies supported by the sales channel
|
|
1784
|
-
* @property {string} [created_at] - ISO 8601 timestamp when currency was added
|
|
1785
|
-
* in the list of currencies supported by the sales channel
|
|
1786
|
-
* @property {number} [__v]
|
|
1787
|
-
*/
|
|
1788
|
-
|
|
1789
|
-
/**
|
|
1790
|
-
* @typedef OrderingStoresResponse
|
|
1552
|
+
* @typedef OrderingStoresResponseSchema
|
|
1791
1553
|
* @property {Page} [page]
|
|
1792
1554
|
* @property {OrderingStore[]} [items]
|
|
1793
1555
|
*/
|
|
1794
1556
|
|
|
1795
1557
|
/**
|
|
1796
|
-
* @typedef
|
|
1797
|
-
* @property {
|
|
1798
|
-
* @property {string} [code]
|
|
1799
|
-
*/
|
|
1800
|
-
|
|
1801
|
-
/**
|
|
1802
|
-
* @typedef LocationDefaultCurrency
|
|
1803
|
-
* @property {string} [name]
|
|
1804
|
-
* @property {string} [symbol]
|
|
1805
|
-
* @property {string} [code]
|
|
1806
|
-
*/
|
|
1807
|
-
|
|
1808
|
-
/**
|
|
1809
|
-
* @typedef LocationCountry
|
|
1810
|
-
* @property {string} [capital]
|
|
1811
|
-
* @property {string} [currency]
|
|
1812
|
-
* @property {string} [iso2]
|
|
1813
|
-
* @property {string} [iso3]
|
|
1814
|
-
* @property {string} [name]
|
|
1815
|
-
* @property {string} [parent]
|
|
1816
|
-
* @property {string} [phone_code]
|
|
1817
|
-
* @property {string} [type]
|
|
1818
|
-
* @property {number} [uid]
|
|
1819
|
-
* @property {number} [__v]
|
|
1820
|
-
* @property {string} [_id]
|
|
1821
|
-
* @property {LocationDefaultCurrency} [default_currency]
|
|
1822
|
-
* @property {LocationDefaultLanguage} [default_language]
|
|
1823
|
-
* @property {string} [state_code]
|
|
1824
|
-
* @property {string} [country_code]
|
|
1825
|
-
* @property {string} [latitude]
|
|
1826
|
-
* @property {string} [longitude]
|
|
1827
|
-
*/
|
|
1828
|
-
|
|
1829
|
-
/**
|
|
1830
|
-
* @typedef Locations
|
|
1831
|
-
* @property {LocationCountry[]} [items]
|
|
1832
|
-
*/
|
|
1833
|
-
|
|
1834
|
-
/**
|
|
1835
|
-
* @typedef UrlRedirectionResponse
|
|
1836
|
-
* @property {UrlRedirection[]} [redirections]
|
|
1837
|
-
*/
|
|
1838
|
-
|
|
1839
|
-
/**
|
|
1840
|
-
* @typedef UrlRedirectionRequest
|
|
1841
|
-
* @property {UrlRedirection} [redirection]
|
|
1842
|
-
*/
|
|
1843
|
-
|
|
1844
|
-
/**
|
|
1845
|
-
* @typedef UrlRedirection
|
|
1846
|
-
* @property {string} [redirect_from]
|
|
1847
|
-
* @property {string} [redirect_to]
|
|
1848
|
-
* @property {string} [type]
|
|
1849
|
-
* @property {string} [_id]
|
|
1850
|
-
*/
|
|
1851
|
-
|
|
1852
|
-
/**
|
|
1853
|
-
* @typedef StoreForConfigurationRequest
|
|
1854
|
-
* @property {AppStoreRules[]} [conf]
|
|
1558
|
+
* @typedef ValidationErrors
|
|
1559
|
+
* @property {ValidationError[]} errors - A list of validation errors in the request.
|
|
1855
1560
|
*/
|
|
1856
1561
|
|
|
1857
1562
|
/**
|
|
1858
|
-
* @typedef
|
|
1859
|
-
* @property {
|
|
1860
|
-
* @property {string
|
|
1861
|
-
* @property {string[]} [network_cnames]
|
|
1563
|
+
* @typedef ValidationError
|
|
1564
|
+
* @property {string} message - A brief description of the error encountered.
|
|
1565
|
+
* @property {string} field - The field in the request that caused the error.
|
|
1862
1566
|
*/
|
|
1863
1567
|
|
|
1864
|
-
|
|
1865
|
-
|
|
1866
|
-
|
|
1867
|
-
|
|
1868
|
-
|
|
1869
|
-
|
|
1870
|
-
|
|
1871
|
-
|
|
1872
|
-
|
|
1873
|
-
|
|
1874
|
-
|
|
1875
|
-
|
|
1876
|
-
|
|
1877
|
-
/**
|
|
1878
|
-
* @typedef StoreRequest
|
|
1879
|
-
* @property {number[]} [companies]
|
|
1880
|
-
*/
|
|
1568
|
+
class ConfigurationPlatformModel {
|
|
1569
|
+
/** @returns {CurrencyExchangeResponseV2} */
|
|
1570
|
+
static CurrencyExchangeResponseV2() {
|
|
1571
|
+
return Joi.object({
|
|
1572
|
+
base: Joi.string().allow("").required(),
|
|
1573
|
+
base_currency_name: Joi.string().allow("").required(),
|
|
1574
|
+
ttl_seconds: Joi.number().required(),
|
|
1575
|
+
items: Joi.array()
|
|
1576
|
+
.items(ConfigurationPlatformModel.CurrencyExchangeItem())
|
|
1577
|
+
.required(),
|
|
1578
|
+
total: Joi.number().required(),
|
|
1579
|
+
});
|
|
1580
|
+
}
|
|
1881
1581
|
|
|
1882
|
-
/**
|
|
1883
|
-
|
|
1884
|
-
|
|
1885
|
-
|
|
1582
|
+
/** @returns {CurrencyExchangeItem} */
|
|
1583
|
+
static CurrencyExchangeItem() {
|
|
1584
|
+
return Joi.object({
|
|
1585
|
+
currency_code: Joi.string().allow("").required(),
|
|
1586
|
+
name: Joi.string().allow("").required(),
|
|
1587
|
+
rate: Joi.number().required(),
|
|
1588
|
+
country_code: Joi.string().allow("").required(),
|
|
1589
|
+
country_name: Joi.string().allow("").required(),
|
|
1590
|
+
subunit: Joi.string().allow("").required(),
|
|
1591
|
+
decimal_digits: Joi.number().required(),
|
|
1592
|
+
symbol: Joi.string().allow("").required(),
|
|
1593
|
+
});
|
|
1594
|
+
}
|
|
1886
1595
|
|
|
1887
|
-
class ConfigurationPlatformModel {
|
|
1888
1596
|
/** @returns {ApplicationInventory} */
|
|
1889
1597
|
static ApplicationInventory() {
|
|
1890
1598
|
return Joi.object({
|
|
1599
|
+
search: ConfigurationPlatformModel.SearchConfig(),
|
|
1891
1600
|
inventory: ConfigurationPlatformModel.AppInventoryConfig(),
|
|
1892
1601
|
authentication: ConfigurationPlatformModel.AuthenticationConfig(),
|
|
1893
1602
|
article_assignment: ConfigurationPlatformModel.ArticleAssignmentConfig(),
|
|
@@ -1919,35 +1628,44 @@ class ConfigurationPlatformModel {
|
|
|
1919
1628
|
});
|
|
1920
1629
|
}
|
|
1921
1630
|
|
|
1922
|
-
/** @returns {
|
|
1923
|
-
static
|
|
1631
|
+
/** @returns {FstIdentification} */
|
|
1632
|
+
static FstIdentification() {
|
|
1633
|
+
return Joi.object({
|
|
1634
|
+
enabled: Joi.boolean(),
|
|
1635
|
+
});
|
|
1636
|
+
}
|
|
1637
|
+
|
|
1638
|
+
/** @returns {QuerySuggestions} */
|
|
1639
|
+
static QuerySuggestions() {
|
|
1924
1640
|
return Joi.object({
|
|
1925
|
-
|
|
1641
|
+
enabled: Joi.boolean(),
|
|
1642
|
+
max_limit: Joi.number(),
|
|
1926
1643
|
});
|
|
1927
1644
|
}
|
|
1928
1645
|
|
|
1929
|
-
/** @returns {
|
|
1930
|
-
static
|
|
1646
|
+
/** @returns {SearchConfig} */
|
|
1647
|
+
static SearchConfig() {
|
|
1931
1648
|
return Joi.object({
|
|
1932
|
-
|
|
1649
|
+
fst_identification: ConfigurationPlatformModel.FstIdentification(),
|
|
1650
|
+
query_suggestions: ConfigurationPlatformModel.QuerySuggestions(),
|
|
1933
1651
|
});
|
|
1934
1652
|
}
|
|
1935
1653
|
|
|
1936
1654
|
/** @returns {AppInventoryConfig} */
|
|
1937
1655
|
static AppInventoryConfig() {
|
|
1938
1656
|
return Joi.object({
|
|
1657
|
+
delivery_strategy: ConfigurationPlatformModel.DeliveryStrategy(),
|
|
1939
1658
|
brand: ConfigurationPlatformModel.InventoryBrand(),
|
|
1940
1659
|
store: ConfigurationPlatformModel.InventoryStore(),
|
|
1941
1660
|
category: ConfigurationPlatformModel.InventoryCategory(),
|
|
1942
1661
|
price: ConfigurationPlatformModel.InventoryPrice(),
|
|
1943
1662
|
discount: ConfigurationPlatformModel.InventoryDiscount(),
|
|
1944
|
-
pricing_strategy: ConfigurationPlatformModel.PricingStrategy(),
|
|
1945
1663
|
out_of_stock: Joi.boolean(),
|
|
1946
1664
|
only_verified_products: Joi.boolean(),
|
|
1947
1665
|
franchise_enabled: Joi.boolean(),
|
|
1948
|
-
exclude_category: Joi.array().items(Joi.
|
|
1666
|
+
exclude_category: Joi.array().items(Joi.any()),
|
|
1949
1667
|
image: Joi.array().items(Joi.string().allow("")),
|
|
1950
|
-
company_store: Joi.array().items(Joi.
|
|
1668
|
+
company_store: Joi.array().items(Joi.any()),
|
|
1951
1669
|
company_id: Joi.number(),
|
|
1952
1670
|
});
|
|
1953
1671
|
}
|
|
@@ -1964,7 +1682,7 @@ class ConfigurationPlatformModel {
|
|
|
1964
1682
|
static InventoryStore() {
|
|
1965
1683
|
return Joi.object({
|
|
1966
1684
|
criteria: Joi.string().allow(""),
|
|
1967
|
-
stores: Joi.array().items(Joi.
|
|
1685
|
+
stores: Joi.array().items(Joi.any()),
|
|
1968
1686
|
rules: Joi.array().items(ConfigurationPlatformModel.AppStoreRules()),
|
|
1969
1687
|
});
|
|
1970
1688
|
}
|
|
@@ -1981,7 +1699,7 @@ class ConfigurationPlatformModel {
|
|
|
1981
1699
|
static InventoryCategory() {
|
|
1982
1700
|
return Joi.object({
|
|
1983
1701
|
criteria: Joi.string().allow(""),
|
|
1984
|
-
categories: Joi.array().items(Joi.
|
|
1702
|
+
categories: Joi.array().items(Joi.any()),
|
|
1985
1703
|
});
|
|
1986
1704
|
}
|
|
1987
1705
|
|
|
@@ -2029,7 +1747,7 @@ class ConfigurationPlatformModel {
|
|
|
2029
1747
|
static StorePriority() {
|
|
2030
1748
|
return Joi.object({
|
|
2031
1749
|
enabled: Joi.boolean(),
|
|
2032
|
-
storetype_order: Joi.array().items(Joi.
|
|
1750
|
+
storetype_order: Joi.array().items(Joi.any()),
|
|
2033
1751
|
});
|
|
2034
1752
|
}
|
|
2035
1753
|
|
|
@@ -2166,6 +1884,7 @@ class ConfigurationPlatformModel {
|
|
|
2166
1884
|
/** @returns {AppInventoryPartialUpdate} */
|
|
2167
1885
|
static AppInventoryPartialUpdate() {
|
|
2168
1886
|
return Joi.object({
|
|
1887
|
+
search: ConfigurationPlatformModel.SearchConfig(),
|
|
2169
1888
|
reward_points: ConfigurationPlatformModel.RewardPointsConfig(),
|
|
2170
1889
|
cart: ConfigurationPlatformModel.AppCartConfig(),
|
|
2171
1890
|
payment: ConfigurationPlatformModel.AppPaymentConfig(),
|
|
@@ -2183,24 +1902,24 @@ class ConfigurationPlatformModel {
|
|
|
2183
1902
|
});
|
|
2184
1903
|
}
|
|
2185
1904
|
|
|
2186
|
-
/** @returns {
|
|
2187
|
-
static
|
|
1905
|
+
/** @returns {CompanyByBrandsRequestSchema} */
|
|
1906
|
+
static CompanyByBrandsRequestSchema() {
|
|
2188
1907
|
return Joi.object({
|
|
2189
1908
|
brands: Joi.number().required(),
|
|
2190
1909
|
search_text: Joi.string().allow(""),
|
|
2191
1910
|
});
|
|
2192
1911
|
}
|
|
2193
1912
|
|
|
2194
|
-
/** @returns {
|
|
2195
|
-
static
|
|
1913
|
+
/** @returns {CompanyByBrandsResponseSchema} */
|
|
1914
|
+
static CompanyByBrandsResponseSchema() {
|
|
2196
1915
|
return Joi.object({
|
|
2197
1916
|
items: Joi.array().items(ConfigurationPlatformModel.BrandCompanyInfo()),
|
|
2198
1917
|
page: ConfigurationPlatformModel.Page(),
|
|
2199
1918
|
});
|
|
2200
1919
|
}
|
|
2201
1920
|
|
|
2202
|
-
/** @returns {
|
|
2203
|
-
static
|
|
1921
|
+
/** @returns {StoreByBrandsRequestSchema} */
|
|
1922
|
+
static StoreByBrandsRequestSchema() {
|
|
2204
1923
|
return Joi.object({
|
|
2205
1924
|
company_id: Joi.number(),
|
|
2206
1925
|
brands: Joi.number().required(),
|
|
@@ -2208,8 +1927,8 @@ class ConfigurationPlatformModel {
|
|
|
2208
1927
|
});
|
|
2209
1928
|
}
|
|
2210
1929
|
|
|
2211
|
-
/** @returns {
|
|
2212
|
-
static
|
|
1930
|
+
/** @returns {StoreByBrandsResponseSchema} */
|
|
1931
|
+
static StoreByBrandsResponseSchema() {
|
|
2213
1932
|
return Joi.object({
|
|
2214
1933
|
items: Joi.array().items(ConfigurationPlatformModel.BrandStoreInfo()),
|
|
2215
1934
|
page: ConfigurationPlatformModel.Page(),
|
|
@@ -2239,18 +1958,17 @@ class ConfigurationPlatformModel {
|
|
|
2239
1958
|
});
|
|
2240
1959
|
}
|
|
2241
1960
|
|
|
2242
|
-
/** @returns {
|
|
2243
|
-
static
|
|
1961
|
+
/** @returns {BrandsByCompanyResponseSchema} */
|
|
1962
|
+
static BrandsByCompanyResponseSchema() {
|
|
2244
1963
|
return Joi.object({
|
|
2245
1964
|
brands: Joi.array().items(ConfigurationPlatformModel.CompanyBrandInfo()),
|
|
2246
1965
|
});
|
|
2247
1966
|
}
|
|
2248
1967
|
|
|
2249
|
-
/** @returns {
|
|
2250
|
-
static
|
|
1968
|
+
/** @returns {ValidationFailedResponseSchema} */
|
|
1969
|
+
static ValidationFailedResponseSchema() {
|
|
2251
1970
|
return Joi.object({
|
|
2252
1971
|
message: Joi.string().allow(""),
|
|
2253
|
-
errors: Joi.array().items(Joi.any()),
|
|
2254
1972
|
});
|
|
2255
1973
|
}
|
|
2256
1974
|
|
|
@@ -2258,8 +1976,6 @@ class ConfigurationPlatformModel {
|
|
|
2258
1976
|
static NotFound() {
|
|
2259
1977
|
return Joi.object({
|
|
2260
1978
|
message: Joi.string().allow(""),
|
|
2261
|
-
error: Joi.string().allow(""),
|
|
2262
|
-
code: Joi.string().allow(""),
|
|
2263
1979
|
success: Joi.boolean(),
|
|
2264
1980
|
});
|
|
2265
1981
|
}
|
|
@@ -2289,8 +2005,8 @@ class ConfigurationPlatformModel {
|
|
|
2289
2005
|
});
|
|
2290
2006
|
}
|
|
2291
2007
|
|
|
2292
|
-
/** @returns {
|
|
2293
|
-
static
|
|
2008
|
+
/** @returns {CreateApplicationRequestSchema} */
|
|
2009
|
+
static CreateApplicationRequestSchema() {
|
|
2294
2010
|
return Joi.object({
|
|
2295
2011
|
app: ConfigurationPlatformModel.App(),
|
|
2296
2012
|
configuration: ConfigurationPlatformModel.ApplicationInventory(),
|
|
@@ -2298,16 +2014,16 @@ class ConfigurationPlatformModel {
|
|
|
2298
2014
|
});
|
|
2299
2015
|
}
|
|
2300
2016
|
|
|
2301
|
-
/** @returns {
|
|
2302
|
-
static
|
|
2017
|
+
/** @returns {CreateAppResponseSchema} */
|
|
2018
|
+
static CreateAppResponseSchema() {
|
|
2303
2019
|
return Joi.object({
|
|
2304
2020
|
app: ConfigurationPlatformModel.Application(),
|
|
2305
2021
|
configuration: ConfigurationPlatformModel.ApplicationInventory(),
|
|
2306
2022
|
});
|
|
2307
2023
|
}
|
|
2308
2024
|
|
|
2309
|
-
/** @returns {
|
|
2310
|
-
static
|
|
2025
|
+
/** @returns {ApplicationsResponseSchema} */
|
|
2026
|
+
static ApplicationsResponseSchema() {
|
|
2311
2027
|
return Joi.object({
|
|
2312
2028
|
items: Joi.array().items(ConfigurationPlatformModel.Application()),
|
|
2313
2029
|
page: ConfigurationPlatformModel.Page(),
|
|
@@ -2347,8 +2063,8 @@ class ConfigurationPlatformModel {
|
|
|
2347
2063
|
});
|
|
2348
2064
|
}
|
|
2349
2065
|
|
|
2350
|
-
/** @returns {
|
|
2351
|
-
static
|
|
2066
|
+
/** @returns {MobileAppConfigRequestSchema} */
|
|
2067
|
+
static MobileAppConfigRequestSchema() {
|
|
2352
2068
|
return Joi.object({
|
|
2353
2069
|
app_name: Joi.string().allow(""),
|
|
2354
2070
|
landing_image: ConfigurationPlatformModel.LandingImage(),
|
|
@@ -2414,8 +2130,8 @@ class ConfigurationPlatformModel {
|
|
|
2414
2130
|
});
|
|
2415
2131
|
}
|
|
2416
2132
|
|
|
2417
|
-
/** @returns {
|
|
2418
|
-
static
|
|
2133
|
+
/** @returns {DomainAddRequestSchema} */
|
|
2134
|
+
static DomainAddRequestSchema() {
|
|
2419
2135
|
return Joi.object({
|
|
2420
2136
|
domain: ConfigurationPlatformModel.DomainAdd(),
|
|
2421
2137
|
});
|
|
@@ -2434,8 +2150,8 @@ class ConfigurationPlatformModel {
|
|
|
2434
2150
|
});
|
|
2435
2151
|
}
|
|
2436
2152
|
|
|
2437
|
-
/** @returns {
|
|
2438
|
-
static
|
|
2153
|
+
/** @returns {DomainsResponseSchema} */
|
|
2154
|
+
static DomainsResponseSchema() {
|
|
2439
2155
|
return Joi.object({
|
|
2440
2156
|
domains: Joi.array().items(ConfigurationPlatformModel.Domain()),
|
|
2441
2157
|
});
|
|
@@ -2452,16 +2168,16 @@ class ConfigurationPlatformModel {
|
|
|
2452
2168
|
});
|
|
2453
2169
|
}
|
|
2454
2170
|
|
|
2455
|
-
/** @returns {
|
|
2456
|
-
static
|
|
2171
|
+
/** @returns {UpdateDomainTypeRequestSchema} */
|
|
2172
|
+
static UpdateDomainTypeRequestSchema() {
|
|
2457
2173
|
return Joi.object({
|
|
2458
2174
|
domain: ConfigurationPlatformModel.UpdateDomain(),
|
|
2459
2175
|
action: Joi.string().allow(""),
|
|
2460
2176
|
});
|
|
2461
2177
|
}
|
|
2462
2178
|
|
|
2463
|
-
/** @returns {
|
|
2464
|
-
static
|
|
2179
|
+
/** @returns {DomainStatusRequestSchema} */
|
|
2180
|
+
static DomainStatusRequestSchema() {
|
|
2465
2181
|
return Joi.object({
|
|
2466
2182
|
domain_url: Joi.string().allow(""),
|
|
2467
2183
|
});
|
|
@@ -2475,18 +2191,19 @@ class ConfigurationPlatformModel {
|
|
|
2475
2191
|
});
|
|
2476
2192
|
}
|
|
2477
2193
|
|
|
2478
|
-
/** @returns {
|
|
2479
|
-
static
|
|
2194
|
+
/** @returns {DomainStatusResponseSchema} */
|
|
2195
|
+
static DomainStatusResponseSchema() {
|
|
2480
2196
|
return Joi.object({
|
|
2481
2197
|
connected: Joi.boolean(),
|
|
2482
2198
|
status: Joi.array().items(ConfigurationPlatformModel.DomainStatus()),
|
|
2483
2199
|
});
|
|
2484
2200
|
}
|
|
2485
2201
|
|
|
2486
|
-
/** @returns {
|
|
2487
|
-
static
|
|
2202
|
+
/** @returns {DomainSuggestionsRequestSchema} */
|
|
2203
|
+
static DomainSuggestionsRequestSchema() {
|
|
2488
2204
|
return Joi.object({
|
|
2489
2205
|
domain_url: Joi.string().allow(""),
|
|
2206
|
+
custom_domain: Joi.boolean(),
|
|
2490
2207
|
});
|
|
2491
2208
|
}
|
|
2492
2209
|
|
|
@@ -2501,261 +2218,41 @@ class ConfigurationPlatformModel {
|
|
|
2501
2218
|
});
|
|
2502
2219
|
}
|
|
2503
2220
|
|
|
2504
|
-
/** @returns {
|
|
2505
|
-
static
|
|
2221
|
+
/** @returns {DomainSuggestionsResponseSchema} */
|
|
2222
|
+
static DomainSuggestionsResponseSchema() {
|
|
2506
2223
|
return Joi.object({
|
|
2507
2224
|
domains: Joi.array().items(ConfigurationPlatformModel.DomainSuggestion()),
|
|
2508
2225
|
});
|
|
2509
2226
|
}
|
|
2510
2227
|
|
|
2511
|
-
/** @returns {
|
|
2512
|
-
static
|
|
2228
|
+
/** @returns {SuccessMessageResponseSchema} */
|
|
2229
|
+
static SuccessMessageResponseSchema() {
|
|
2513
2230
|
return Joi.object({
|
|
2514
2231
|
success: Joi.boolean(),
|
|
2515
2232
|
message: Joi.string().allow(""),
|
|
2516
2233
|
});
|
|
2517
2234
|
}
|
|
2518
2235
|
|
|
2519
|
-
/** @returns {
|
|
2520
|
-
static
|
|
2236
|
+
/** @returns {App} */
|
|
2237
|
+
static App() {
|
|
2521
2238
|
return Joi.object({
|
|
2522
|
-
|
|
2523
|
-
|
|
2239
|
+
company_id: Joi.string().allow(""),
|
|
2240
|
+
channel_type: Joi.string().allow(""),
|
|
2241
|
+
auth: ConfigurationPlatformModel.ApplicationAuth(),
|
|
2242
|
+
name: Joi.string().allow(""),
|
|
2243
|
+
desc: Joi.string().allow(""),
|
|
2524
2244
|
});
|
|
2525
2245
|
}
|
|
2526
2246
|
|
|
2527
|
-
/** @returns {
|
|
2528
|
-
static
|
|
2247
|
+
/** @returns {AppDomain} */
|
|
2248
|
+
static AppDomain() {
|
|
2529
2249
|
return Joi.object({
|
|
2530
|
-
validators: ConfigurationPlatformModel.Validators(),
|
|
2531
|
-
description: Joi.string().allow(""),
|
|
2532
|
-
description_html: Joi.string().allow(""),
|
|
2533
|
-
constants: Joi.string().allow(""),
|
|
2534
|
-
companies: Joi.array().items(Joi.string().allow("")),
|
|
2535
|
-
support: Joi.array().items(Joi.string().allow("")),
|
|
2536
|
-
_id: Joi.string().allow(""),
|
|
2537
2250
|
name: Joi.string().allow(""),
|
|
2538
|
-
slug: Joi.string().allow(""),
|
|
2539
|
-
hidden: Joi.boolean(),
|
|
2540
|
-
meta: Joi.array().items(ConfigurationPlatformModel.IntegrationMeta()),
|
|
2541
|
-
icon: Joi.string().allow(""),
|
|
2542
|
-
owner: Joi.string().allow(""),
|
|
2543
|
-
created_at: Joi.string().allow(""),
|
|
2544
|
-
modified_at: Joi.string().allow(""),
|
|
2545
|
-
token: Joi.string().allow(""),
|
|
2546
|
-
secret: Joi.string().allow(""),
|
|
2547
|
-
__v: Joi.number(),
|
|
2548
2251
|
});
|
|
2549
2252
|
}
|
|
2550
2253
|
|
|
2551
|
-
/** @returns {
|
|
2552
|
-
static
|
|
2553
|
-
return Joi.object({
|
|
2554
|
-
company: ConfigurationPlatformModel.CompanyValidator(),
|
|
2555
|
-
store: ConfigurationPlatformModel.StoreValidator(),
|
|
2556
|
-
inventory: ConfigurationPlatformModel.InventoryValidator(),
|
|
2557
|
-
order: ConfigurationPlatformModel.OrderValidator(),
|
|
2558
|
-
});
|
|
2559
|
-
}
|
|
2560
|
-
|
|
2561
|
-
/** @returns {CompanyValidator} */
|
|
2562
|
-
static CompanyValidator() {
|
|
2563
|
-
return Joi.object({
|
|
2564
|
-
json_schema: Joi.array().items(ConfigurationPlatformModel.JsonSchema()),
|
|
2565
|
-
browser_script: Joi.string().allow(""),
|
|
2566
|
-
});
|
|
2567
|
-
}
|
|
2568
|
-
|
|
2569
|
-
/** @returns {JsonSchema} */
|
|
2570
|
-
static JsonSchema() {
|
|
2571
|
-
return Joi.object({
|
|
2572
|
-
display: Joi.string().allow(""),
|
|
2573
|
-
key: Joi.string().allow(""),
|
|
2574
|
-
type: Joi.string().allow(""),
|
|
2575
|
-
tooltip: Joi.string().allow(""),
|
|
2576
|
-
});
|
|
2577
|
-
}
|
|
2578
|
-
|
|
2579
|
-
/** @returns {StoreValidator} */
|
|
2580
|
-
static StoreValidator() {
|
|
2581
|
-
return Joi.object({
|
|
2582
|
-
json_schema: Joi.array().items(ConfigurationPlatformModel.JsonSchema()),
|
|
2583
|
-
browser_script: Joi.string().allow(""),
|
|
2584
|
-
});
|
|
2585
|
-
}
|
|
2586
|
-
|
|
2587
|
-
/** @returns {InventoryValidator} */
|
|
2588
|
-
static InventoryValidator() {
|
|
2589
|
-
return Joi.object({
|
|
2590
|
-
json_schema: Joi.array().items(ConfigurationPlatformModel.JsonSchema()),
|
|
2591
|
-
browser_script: Joi.string().allow(""),
|
|
2592
|
-
});
|
|
2593
|
-
}
|
|
2594
|
-
|
|
2595
|
-
/** @returns {OrderValidator} */
|
|
2596
|
-
static OrderValidator() {
|
|
2597
|
-
return Joi.object({
|
|
2598
|
-
json_schema: Joi.array().items(ConfigurationPlatformModel.JsonSchema()),
|
|
2599
|
-
browser_script: Joi.string().allow(""),
|
|
2600
|
-
});
|
|
2601
|
-
}
|
|
2602
|
-
|
|
2603
|
-
/** @returns {IntegrationMeta} */
|
|
2604
|
-
static IntegrationMeta() {
|
|
2605
|
-
return Joi.object({
|
|
2606
|
-
is_public: Joi.boolean(),
|
|
2607
|
-
_id: Joi.string().allow(""),
|
|
2608
|
-
name: Joi.string().allow(""),
|
|
2609
|
-
value: Joi.string().allow(""),
|
|
2610
|
-
});
|
|
2611
|
-
}
|
|
2612
|
-
|
|
2613
|
-
/** @returns {Integration} */
|
|
2614
|
-
static Integration() {
|
|
2615
|
-
return Joi.object({
|
|
2616
|
-
validators: ConfigurationPlatformModel.Validators(),
|
|
2617
|
-
description: Joi.string().allow(""),
|
|
2618
|
-
description_html: Joi.string().allow(""),
|
|
2619
|
-
constants: Joi.any(),
|
|
2620
|
-
companies: Joi.array().items(Joi.string().allow("")),
|
|
2621
|
-
support: Joi.array().items(Joi.string().allow("")),
|
|
2622
|
-
_id: Joi.string().allow(""),
|
|
2623
|
-
name: Joi.string().allow(""),
|
|
2624
|
-
slug: Joi.string().allow(""),
|
|
2625
|
-
meta: Joi.array().items(ConfigurationPlatformModel.IntegrationMeta()),
|
|
2626
|
-
icon: Joi.string().allow(""),
|
|
2627
|
-
hidden: Joi.boolean(),
|
|
2628
|
-
owner: Joi.string().allow(""),
|
|
2629
|
-
created_at: Joi.string().allow(""),
|
|
2630
|
-
modified_at: Joi.string().allow(""),
|
|
2631
|
-
token: Joi.string().allow(""),
|
|
2632
|
-
secret: Joi.string().allow(""),
|
|
2633
|
-
__v: Joi.number(),
|
|
2634
|
-
});
|
|
2635
|
-
}
|
|
2636
|
-
|
|
2637
|
-
/** @returns {IntegrationConfigResponse} */
|
|
2638
|
-
static IntegrationConfigResponse() {
|
|
2639
|
-
return Joi.object({
|
|
2640
|
-
items: Joi.array().items(ConfigurationPlatformModel.IntegrationLevel()),
|
|
2641
|
-
});
|
|
2642
|
-
}
|
|
2643
|
-
|
|
2644
|
-
/** @returns {IntegrationLevel} */
|
|
2645
|
-
static IntegrationLevel() {
|
|
2646
|
-
return Joi.object({
|
|
2647
|
-
opted: Joi.boolean(),
|
|
2648
|
-
permissions: Joi.array().items(Joi.any()),
|
|
2649
|
-
last_patch: Joi.array().items(ConfigurationPlatformModel.LastPatch()),
|
|
2650
|
-
_id: Joi.string().allow(""),
|
|
2651
|
-
integration: Joi.string().allow(""),
|
|
2652
|
-
level: Joi.string().allow(""),
|
|
2653
|
-
uid: Joi.number(),
|
|
2654
|
-
company_id: Joi.number(),
|
|
2655
|
-
meta: Joi.array().items(ConfigurationPlatformModel.IntegrationMeta()),
|
|
2656
|
-
token: Joi.string().allow(""),
|
|
2657
|
-
created_at: Joi.string().allow(""),
|
|
2658
|
-
modified_at: Joi.string().allow(""),
|
|
2659
|
-
__v: Joi.number(),
|
|
2660
|
-
data: Joi.any(),
|
|
2661
|
-
success: Joi.boolean(),
|
|
2662
|
-
message: Joi.string().allow(""),
|
|
2663
|
-
});
|
|
2664
|
-
}
|
|
2665
|
-
|
|
2666
|
-
/** @returns {UpdateIntegrationLevelRequest} */
|
|
2667
|
-
static UpdateIntegrationLevelRequest() {
|
|
2668
|
-
return Joi.object({
|
|
2669
|
-
items: Joi.array().items(ConfigurationPlatformModel.IntegrationLevel()),
|
|
2670
|
-
});
|
|
2671
|
-
}
|
|
2672
|
-
|
|
2673
|
-
/** @returns {OptedStoreIntegration} */
|
|
2674
|
-
static OptedStoreIntegration() {
|
|
2675
|
-
return Joi.object({
|
|
2676
|
-
other_opted: Joi.boolean(),
|
|
2677
|
-
other_integration: ConfigurationPlatformModel.IntegrationOptIn(),
|
|
2678
|
-
other_entity: ConfigurationPlatformModel.OtherEntity(),
|
|
2679
|
-
});
|
|
2680
|
-
}
|
|
2681
|
-
|
|
2682
|
-
/** @returns {OtherEntity} */
|
|
2683
|
-
static OtherEntity() {
|
|
2684
|
-
return Joi.object({
|
|
2685
|
-
opted: Joi.boolean(),
|
|
2686
|
-
permissions: Joi.array().items(Joi.string().allow("")),
|
|
2687
|
-
last_patch: Joi.array().items(ConfigurationPlatformModel.LastPatch()),
|
|
2688
|
-
_id: Joi.string().allow(""),
|
|
2689
|
-
integration: Joi.string().allow(""),
|
|
2690
|
-
level: Joi.string().allow(""),
|
|
2691
|
-
uid: Joi.number(),
|
|
2692
|
-
data: ConfigurationPlatformModel.OtherEntityData(),
|
|
2693
|
-
meta: Joi.array().items(Joi.any()),
|
|
2694
|
-
token: Joi.string().allow(""),
|
|
2695
|
-
created_at: Joi.string().allow(""),
|
|
2696
|
-
modified_at: Joi.string().allow(""),
|
|
2697
|
-
__v: Joi.number(),
|
|
2698
|
-
});
|
|
2699
|
-
}
|
|
2700
|
-
|
|
2701
|
-
/** @returns {LastPatch} */
|
|
2702
|
-
static LastPatch() {
|
|
2703
|
-
return Joi.object({
|
|
2704
|
-
op: Joi.string().allow(""),
|
|
2705
|
-
path: Joi.string().allow(""),
|
|
2706
|
-
value: Joi.string().allow(""),
|
|
2707
|
-
});
|
|
2708
|
-
}
|
|
2709
|
-
|
|
2710
|
-
/** @returns {OtherEntityData} */
|
|
2711
|
-
static OtherEntityData() {
|
|
2712
|
-
return Joi.object({
|
|
2713
|
-
article_identifier: Joi.string().allow(""),
|
|
2714
|
-
});
|
|
2715
|
-
}
|
|
2716
|
-
|
|
2717
|
-
/** @returns {App} */
|
|
2718
|
-
static App() {
|
|
2719
|
-
return Joi.object({
|
|
2720
|
-
company_id: Joi.string().allow(""),
|
|
2721
|
-
channel_type: Joi.string().allow(""),
|
|
2722
|
-
auth: ConfigurationPlatformModel.ApplicationAuth(),
|
|
2723
|
-
name: Joi.string().allow(""),
|
|
2724
|
-
desc: Joi.string().allow(""),
|
|
2725
|
-
});
|
|
2726
|
-
}
|
|
2727
|
-
|
|
2728
|
-
/** @returns {InventoryConfig} */
|
|
2729
|
-
static InventoryConfig() {
|
|
2730
|
-
return Joi.object({
|
|
2731
|
-
brand: ConfigurationPlatformModel.InventoryBrandRule(),
|
|
2732
|
-
store: ConfigurationPlatformModel.InventoryStoreRule(),
|
|
2733
|
-
image: Joi.array().items(Joi.string().allow("")),
|
|
2734
|
-
franchise_enabled: Joi.boolean(),
|
|
2735
|
-
out_of_stock: Joi.boolean(),
|
|
2736
|
-
only_verified_products: Joi.boolean(),
|
|
2737
|
-
pricing_strategy: ConfigurationPlatformModel.PricingStrategy(),
|
|
2738
|
-
});
|
|
2739
|
-
}
|
|
2740
|
-
|
|
2741
|
-
/** @returns {AppInventory} */
|
|
2742
|
-
static AppInventory() {
|
|
2743
|
-
return Joi.object({
|
|
2744
|
-
inventory: ConfigurationPlatformModel.InventoryConfig(),
|
|
2745
|
-
payment: ConfigurationPlatformModel.InventoryPaymentConfig(),
|
|
2746
|
-
article_assignment: ConfigurationPlatformModel.InventoryArticleAssignment(),
|
|
2747
|
-
});
|
|
2748
|
-
}
|
|
2749
|
-
|
|
2750
|
-
/** @returns {AppDomain} */
|
|
2751
|
-
static AppDomain() {
|
|
2752
|
-
return Joi.object({
|
|
2753
|
-
name: Joi.string().allow(""),
|
|
2754
|
-
});
|
|
2755
|
-
}
|
|
2756
|
-
|
|
2757
|
-
/** @returns {CompaniesResponse} */
|
|
2758
|
-
static CompaniesResponse() {
|
|
2254
|
+
/** @returns {CompaniesResponseSchema} */
|
|
2255
|
+
static CompaniesResponseSchema() {
|
|
2759
2256
|
return Joi.object({
|
|
2760
2257
|
items: Joi.array().items(
|
|
2761
2258
|
ConfigurationPlatformModel.AppInventoryCompanies()
|
|
@@ -2773,30 +2270,14 @@ class ConfigurationPlatformModel {
|
|
|
2773
2270
|
});
|
|
2774
2271
|
}
|
|
2775
2272
|
|
|
2776
|
-
/** @returns {
|
|
2777
|
-
static
|
|
2273
|
+
/** @returns {StoresResponseSchema} */
|
|
2274
|
+
static StoresResponseSchema() {
|
|
2778
2275
|
return Joi.object({
|
|
2779
2276
|
items: Joi.array().items(ConfigurationPlatformModel.AppInventoryStores()),
|
|
2780
2277
|
page: ConfigurationPlatformModel.Page(),
|
|
2781
2278
|
});
|
|
2782
2279
|
}
|
|
2783
2280
|
|
|
2784
|
-
/** @returns {ListStoreResponse} */
|
|
2785
|
-
static ListStoreResponse() {
|
|
2786
|
-
return Joi.object({
|
|
2787
|
-
stores: Joi.array().items(
|
|
2788
|
-
ConfigurationPlatformModel.AppInventoryStores()
|
|
2789
|
-
),
|
|
2790
|
-
});
|
|
2791
|
-
}
|
|
2792
|
-
|
|
2793
|
-
/** @returns {ArrayStoreResponse} */
|
|
2794
|
-
static ArrayStoreResponse() {
|
|
2795
|
-
return Joi.object({
|
|
2796
|
-
data: Joi.array().items(ConfigurationPlatformModel.AppInventoryStores()),
|
|
2797
|
-
});
|
|
2798
|
-
}
|
|
2799
|
-
|
|
2800
2281
|
/** @returns {AppInventoryStores} */
|
|
2801
2282
|
static AppInventoryStores() {
|
|
2802
2283
|
return Joi.object({
|
|
@@ -2813,8 +2294,8 @@ class ConfigurationPlatformModel {
|
|
|
2813
2294
|
});
|
|
2814
2295
|
}
|
|
2815
2296
|
|
|
2816
|
-
/** @returns {
|
|
2817
|
-
static
|
|
2297
|
+
/** @returns {FilterOrderingStoreRequestSchema} */
|
|
2298
|
+
static FilterOrderingStoreRequestSchema() {
|
|
2818
2299
|
return Joi.object({
|
|
2819
2300
|
all_stores: Joi.boolean(),
|
|
2820
2301
|
deployed_stores: Joi.array().items(Joi.number()),
|
|
@@ -2842,8 +2323,8 @@ class ConfigurationPlatformModel {
|
|
|
2842
2323
|
});
|
|
2843
2324
|
}
|
|
2844
2325
|
|
|
2845
|
-
/** @returns {
|
|
2846
|
-
static
|
|
2326
|
+
/** @returns {OrderingStoreSelectRequestSchema} */
|
|
2327
|
+
static OrderingStoreSelectRequestSchema() {
|
|
2847
2328
|
return Joi.object({
|
|
2848
2329
|
ordering_store: ConfigurationPlatformModel.OrderingStoreSelect().required(),
|
|
2849
2330
|
});
|
|
@@ -2886,8 +2367,8 @@ class ConfigurationPlatformModel {
|
|
|
2886
2367
|
});
|
|
2887
2368
|
}
|
|
2888
2369
|
|
|
2889
|
-
/** @returns {
|
|
2890
|
-
static
|
|
2370
|
+
/** @returns {OptedApplicationResponseSchema} */
|
|
2371
|
+
static OptedApplicationResponseSchema() {
|
|
2891
2372
|
return Joi.object({
|
|
2892
2373
|
name: Joi.string().allow(""),
|
|
2893
2374
|
description: Joi.string().allow(""),
|
|
@@ -2947,8 +2428,8 @@ class ConfigurationPlatformModel {
|
|
|
2947
2428
|
});
|
|
2948
2429
|
}
|
|
2949
2430
|
|
|
2950
|
-
/** @returns {
|
|
2951
|
-
static
|
|
2431
|
+
/** @returns {TokenResponseSchema} */
|
|
2432
|
+
static TokenResponseSchema() {
|
|
2952
2433
|
return Joi.object({
|
|
2953
2434
|
tokens: ConfigurationPlatformModel.Tokens(),
|
|
2954
2435
|
_id: Joi.string().allow(""),
|
|
@@ -3154,8 +2635,8 @@ class ConfigurationPlatformModel {
|
|
|
3154
2635
|
static LaunchPage() {
|
|
3155
2636
|
return Joi.object({
|
|
3156
2637
|
page_type: Joi.string().allow(""),
|
|
3157
|
-
params: Joi.any(),
|
|
3158
|
-
query: Joi.any(),
|
|
2638
|
+
params: Joi.object().pattern(/\S/, Joi.any()),
|
|
2639
|
+
query: Joi.object().pattern(/\S/, Joi.any()),
|
|
3159
2640
|
});
|
|
3160
2641
|
}
|
|
3161
2642
|
|
|
@@ -3184,6 +2665,22 @@ class ConfigurationPlatformModel {
|
|
|
3184
2665
|
});
|
|
3185
2666
|
}
|
|
3186
2667
|
|
|
2668
|
+
/** @returns {BuyboxFeature} */
|
|
2669
|
+
static BuyboxFeature() {
|
|
2670
|
+
return Joi.object({
|
|
2671
|
+
show_name: Joi.boolean(),
|
|
2672
|
+
enable_selection: Joi.boolean(),
|
|
2673
|
+
is_seller_buybox_enabled: Joi.boolean(),
|
|
2674
|
+
});
|
|
2675
|
+
}
|
|
2676
|
+
|
|
2677
|
+
/** @returns {DeliveryStrategy} */
|
|
2678
|
+
static DeliveryStrategy() {
|
|
2679
|
+
return Joi.object({
|
|
2680
|
+
value: Joi.string().allow(""),
|
|
2681
|
+
});
|
|
2682
|
+
}
|
|
2683
|
+
|
|
3187
2684
|
/** @returns {AppFeature} */
|
|
3188
2685
|
static AppFeature() {
|
|
3189
2686
|
return Joi.object({
|
|
@@ -3197,12 +2694,12 @@ class ConfigurationPlatformModel {
|
|
|
3197
2694
|
pcr: ConfigurationPlatformModel.PcrFeature(),
|
|
3198
2695
|
order: ConfigurationPlatformModel.OrderFeature(),
|
|
3199
2696
|
buybox: ConfigurationPlatformModel.BuyboxFeature(),
|
|
2697
|
+
delivery_strategy: ConfigurationPlatformModel.DeliveryStrategy(),
|
|
3200
2698
|
_id: Joi.string().allow(""),
|
|
3201
2699
|
app: Joi.string().allow(""),
|
|
3202
2700
|
created_at: Joi.string().allow(""),
|
|
3203
2701
|
modified_at: Joi.string().allow(""),
|
|
3204
2702
|
__v: Joi.number(),
|
|
3205
|
-
pricing_strategy: ConfigurationPlatformModel.PricingStrategy(),
|
|
3206
2703
|
});
|
|
3207
2704
|
}
|
|
3208
2705
|
|
|
@@ -3323,24 +2820,15 @@ class ConfigurationPlatformModel {
|
|
|
3323
2820
|
});
|
|
3324
2821
|
}
|
|
3325
2822
|
|
|
3326
|
-
/** @returns {
|
|
3327
|
-
static
|
|
3328
|
-
return Joi.object({
|
|
3329
|
-
show_name: Joi.boolean(),
|
|
3330
|
-
enable_selection: Joi.boolean(),
|
|
3331
|
-
is_seller_buybox_enabled: Joi.boolean(),
|
|
3332
|
-
});
|
|
3333
|
-
}
|
|
3334
|
-
|
|
3335
|
-
/** @returns {AppFeatureRequest} */
|
|
3336
|
-
static AppFeatureRequest() {
|
|
2823
|
+
/** @returns {AppFeatureRequestSchema} */
|
|
2824
|
+
static AppFeatureRequestSchema() {
|
|
3337
2825
|
return Joi.object({
|
|
3338
2826
|
feature: ConfigurationPlatformModel.AppFeature(),
|
|
3339
2827
|
});
|
|
3340
2828
|
}
|
|
3341
2829
|
|
|
3342
|
-
/** @returns {
|
|
3343
|
-
static
|
|
2830
|
+
/** @returns {AppFeatureResponseSchema} */
|
|
2831
|
+
static AppFeatureResponseSchema() {
|
|
3344
2832
|
return Joi.object({
|
|
3345
2833
|
feature: ConfigurationPlatformModel.AppFeature(),
|
|
3346
2834
|
});
|
|
@@ -3446,84 +2934,67 @@ class ConfigurationPlatformModel {
|
|
|
3446
2934
|
});
|
|
3447
2935
|
}
|
|
3448
2936
|
|
|
3449
|
-
/** @returns {
|
|
3450
|
-
static
|
|
2937
|
+
/** @returns {ApplicationById} */
|
|
2938
|
+
static ApplicationById() {
|
|
3451
2939
|
return Joi.object({
|
|
2940
|
+
website: ConfigurationPlatformModel.ApplicationWebsite(),
|
|
2941
|
+
cors: ConfigurationPlatformModel.ApplicationCors(),
|
|
2942
|
+
auth: ConfigurationPlatformModel.ApplicationAuth(),
|
|
2943
|
+
description: Joi.string().allow(""),
|
|
2944
|
+
channel_type: Joi.string().allow(""),
|
|
2945
|
+
cache_ttl: Joi.number(),
|
|
2946
|
+
is_internal: Joi.boolean(),
|
|
2947
|
+
is_active: Joi.boolean(),
|
|
2948
|
+
_id: Joi.string().allow(""),
|
|
2949
|
+
name: Joi.string().allow(""),
|
|
2950
|
+
owner: Joi.string().allow(""),
|
|
2951
|
+
company_id: Joi.number(),
|
|
3452
2952
|
token: Joi.string().allow(""),
|
|
3453
|
-
|
|
2953
|
+
redirections: Joi.array().items(
|
|
2954
|
+
ConfigurationPlatformModel.ApplicationRedirections()
|
|
2955
|
+
),
|
|
2956
|
+
meta: Joi.array().items(ConfigurationPlatformModel.ApplicationMeta()),
|
|
3454
2957
|
created_at: Joi.string().allow(""),
|
|
2958
|
+
modified_at: Joi.string().allow(""),
|
|
2959
|
+
__v: Joi.number(),
|
|
2960
|
+
banner: ConfigurationPlatformModel.SecureUrl(),
|
|
2961
|
+
logo: ConfigurationPlatformModel.SecureUrl(),
|
|
2962
|
+
favicon: ConfigurationPlatformModel.SecureUrl(),
|
|
2963
|
+
domains: Joi.array().items(ConfigurationPlatformModel.Domain()),
|
|
2964
|
+
app_type: Joi.string().allow(""),
|
|
2965
|
+
mobile_logo: ConfigurationPlatformModel.SecureUrl(),
|
|
2966
|
+
domain: ConfigurationPlatformModel.Domain(),
|
|
2967
|
+
slug: Joi.string().allow(""),
|
|
2968
|
+
mode: Joi.string().allow(""),
|
|
2969
|
+
status: Joi.string().allow(""),
|
|
2970
|
+
tokens: Joi.array().items(ConfigurationPlatformModel.TokenSchemaID()),
|
|
2971
|
+
secret: Joi.string().allow(""),
|
|
3455
2972
|
});
|
|
3456
2973
|
}
|
|
3457
2974
|
|
|
3458
|
-
/** @returns {
|
|
3459
|
-
static
|
|
3460
|
-
return Joi.object({
|
|
3461
|
-
message: Joi.string().allow(""),
|
|
3462
|
-
success: Joi.boolean(),
|
|
3463
|
-
domain: Joi.any(),
|
|
3464
|
-
});
|
|
3465
|
-
}
|
|
3466
|
-
|
|
3467
|
-
/** @returns {InventoryBrandRule} */
|
|
3468
|
-
static InventoryBrandRule() {
|
|
3469
|
-
return Joi.object({
|
|
3470
|
-
criteria: Joi.string().allow(""),
|
|
3471
|
-
brands: Joi.array().items(Joi.number()),
|
|
3472
|
-
});
|
|
3473
|
-
}
|
|
3474
|
-
|
|
3475
|
-
/** @returns {PricingStrategy} */
|
|
3476
|
-
static PricingStrategy() {
|
|
3477
|
-
return Joi.object({
|
|
3478
|
-
value: Joi.string().allow(""),
|
|
3479
|
-
});
|
|
3480
|
-
}
|
|
3481
|
-
|
|
3482
|
-
/** @returns {StoreCriteriaRule} */
|
|
3483
|
-
static StoreCriteriaRule() {
|
|
3484
|
-
return Joi.object({
|
|
3485
|
-
companies: Joi.array().items(Joi.number()),
|
|
3486
|
-
brands: Joi.array().items(Joi.number()),
|
|
3487
|
-
});
|
|
3488
|
-
}
|
|
3489
|
-
|
|
3490
|
-
/** @returns {InventoryStoreRule} */
|
|
3491
|
-
static InventoryStoreRule() {
|
|
3492
|
-
return Joi.object({
|
|
3493
|
-
criteria: Joi.string().allow(""),
|
|
3494
|
-
rules: Joi.array().items(ConfigurationPlatformModel.StoreCriteriaRule()),
|
|
3495
|
-
stores: Joi.array().items(Joi.number()),
|
|
3496
|
-
});
|
|
3497
|
-
}
|
|
3498
|
-
|
|
3499
|
-
/** @returns {InventoryPaymentConfig} */
|
|
3500
|
-
static InventoryPaymentConfig() {
|
|
3501
|
-
return Joi.object({
|
|
3502
|
-
mode_of_payment: Joi.string().allow(""),
|
|
3503
|
-
source: Joi.string().allow(""),
|
|
3504
|
-
});
|
|
3505
|
-
}
|
|
3506
|
-
|
|
3507
|
-
/** @returns {StorePriorityRule} */
|
|
3508
|
-
static StorePriorityRule() {
|
|
2975
|
+
/** @returns {TokenSchemaID} */
|
|
2976
|
+
static TokenSchemaID() {
|
|
3509
2977
|
return Joi.object({
|
|
3510
|
-
|
|
3511
|
-
|
|
2978
|
+
token: Joi.string().allow(""),
|
|
2979
|
+
created_by: Joi.string().allow(""),
|
|
2980
|
+
created_at: Joi.string().allow(""),
|
|
3512
2981
|
});
|
|
3513
2982
|
}
|
|
3514
2983
|
|
|
3515
|
-
/** @returns {
|
|
3516
|
-
static
|
|
2984
|
+
/** @returns {TokenSchema} */
|
|
2985
|
+
static TokenSchema() {
|
|
3517
2986
|
return Joi.object({
|
|
3518
|
-
|
|
2987
|
+
token: Joi.string().allow(""),
|
|
2988
|
+
created_by: Joi.object().pattern(/\S/, Joi.any()),
|
|
2989
|
+
created_at: Joi.string().allow(""),
|
|
3519
2990
|
});
|
|
3520
2991
|
}
|
|
3521
2992
|
|
|
3522
|
-
/** @returns {
|
|
3523
|
-
static
|
|
2993
|
+
/** @returns {InvalidPayloadRequestSchema} */
|
|
2994
|
+
static InvalidPayloadRequestSchema() {
|
|
3524
2995
|
return Joi.object({
|
|
3525
|
-
|
|
3526
|
-
|
|
2996
|
+
message: Joi.string().allow(""),
|
|
2997
|
+
success: Joi.boolean(),
|
|
3527
2998
|
});
|
|
3528
2999
|
}
|
|
3529
3000
|
|
|
@@ -3537,7 +3008,7 @@ class ConfigurationPlatformModel {
|
|
|
3537
3008
|
current: Joi.number(),
|
|
3538
3009
|
type: Joi.string().allow("").required(),
|
|
3539
3010
|
size: Joi.number(),
|
|
3540
|
-
|
|
3011
|
+
page_size: Joi.number(),
|
|
3541
3012
|
});
|
|
3542
3013
|
}
|
|
3543
3014
|
|
|
@@ -3749,15 +3220,15 @@ class ConfigurationPlatformModel {
|
|
|
3749
3220
|
});
|
|
3750
3221
|
}
|
|
3751
3222
|
|
|
3752
|
-
/** @returns {
|
|
3753
|
-
static
|
|
3223
|
+
/** @returns {CurrenciesResponseSchema} */
|
|
3224
|
+
static CurrenciesResponseSchema() {
|
|
3754
3225
|
return Joi.object({
|
|
3755
3226
|
items: Joi.array().items(ConfigurationPlatformModel.Currency()),
|
|
3756
3227
|
});
|
|
3757
3228
|
}
|
|
3758
3229
|
|
|
3759
|
-
/** @returns {
|
|
3760
|
-
static
|
|
3230
|
+
/** @returns {AppCurrencyResponseSchema} */
|
|
3231
|
+
static AppCurrencyResponseSchema() {
|
|
3761
3232
|
return Joi.object({
|
|
3762
3233
|
_id: Joi.string().allow(""),
|
|
3763
3234
|
application: Joi.string().allow(""),
|
|
@@ -3791,7 +3262,6 @@ class ConfigurationPlatformModel {
|
|
|
3791
3262
|
sector: Joi.string().allow(""),
|
|
3792
3263
|
country_code: Joi.string().allow(""),
|
|
3793
3264
|
state_code: Joi.string().allow(""),
|
|
3794
|
-
landmark: Joi.string().allow(""),
|
|
3795
3265
|
});
|
|
3796
3266
|
}
|
|
3797
3267
|
|
|
@@ -3825,167 +3295,28 @@ class ConfigurationPlatformModel {
|
|
|
3825
3295
|
});
|
|
3826
3296
|
}
|
|
3827
3297
|
|
|
3828
|
-
/** @returns {
|
|
3829
|
-
static
|
|
3830
|
-
return Joi.object({
|
|
3831
|
-
type: Joi.string().allow("").required(),
|
|
3832
|
-
interval: Joi.number(),
|
|
3833
|
-
});
|
|
3834
|
-
}
|
|
3835
|
-
|
|
3836
|
-
/** @returns {PlatformVersionRequest} */
|
|
3837
|
-
static PlatformVersionRequest() {
|
|
3838
|
-
return Joi.object({
|
|
3839
|
-
app_code_name: Joi.string().allow("").required(),
|
|
3840
|
-
app_name: Joi.string().allow("").required(),
|
|
3841
|
-
force_version: Joi.string().allow("").required(),
|
|
3842
|
-
latest_version: Joi.string().allow("").required(),
|
|
3843
|
-
is_app_blocked: Joi.boolean().required(),
|
|
3844
|
-
update_dialog: ConfigurationPlatformModel.UpdateDiealog().required(),
|
|
3845
|
-
});
|
|
3846
|
-
}
|
|
3847
|
-
|
|
3848
|
-
/** @returns {PlatformVersion} */
|
|
3849
|
-
static PlatformVersion() {
|
|
3850
|
-
return Joi.object({
|
|
3851
|
-
app_code_name: Joi.string().allow("").required(),
|
|
3852
|
-
app_name: Joi.string().allow("").required(),
|
|
3853
|
-
force_version: Joi.string().allow("").required(),
|
|
3854
|
-
latest_version: Joi.string().allow("").required(),
|
|
3855
|
-
is_app_blocked: Joi.boolean().required(),
|
|
3856
|
-
update_dialog: ConfigurationPlatformModel.UpdateDiealog().required(),
|
|
3857
|
-
_id: Joi.string().allow(""),
|
|
3858
|
-
modified_at: Joi.string().allow(""),
|
|
3859
|
-
created_at: Joi.string().allow(""),
|
|
3860
|
-
__v: Joi.number(),
|
|
3861
|
-
});
|
|
3862
|
-
}
|
|
3863
|
-
|
|
3864
|
-
/** @returns {OrderingStoresResponse} */
|
|
3865
|
-
static OrderingStoresResponse() {
|
|
3298
|
+
/** @returns {OrderingStoresResponseSchema} */
|
|
3299
|
+
static OrderingStoresResponseSchema() {
|
|
3866
3300
|
return Joi.object({
|
|
3867
3301
|
page: ConfigurationPlatformModel.Page(),
|
|
3868
3302
|
items: Joi.array().items(ConfigurationPlatformModel.OrderingStore()),
|
|
3869
3303
|
});
|
|
3870
3304
|
}
|
|
3871
3305
|
|
|
3872
|
-
/** @returns {
|
|
3873
|
-
static
|
|
3874
|
-
return Joi.object({
|
|
3875
|
-
name: Joi.string().allow(""),
|
|
3876
|
-
code: Joi.string().allow(""),
|
|
3877
|
-
});
|
|
3878
|
-
}
|
|
3879
|
-
|
|
3880
|
-
/** @returns {LocationDefaultCurrency} */
|
|
3881
|
-
static LocationDefaultCurrency() {
|
|
3882
|
-
return Joi.object({
|
|
3883
|
-
name: Joi.string().allow(""),
|
|
3884
|
-
symbol: Joi.string().allow(""),
|
|
3885
|
-
code: Joi.string().allow(""),
|
|
3886
|
-
});
|
|
3887
|
-
}
|
|
3888
|
-
|
|
3889
|
-
/** @returns {LocationCountry} */
|
|
3890
|
-
static LocationCountry() {
|
|
3891
|
-
return Joi.object({
|
|
3892
|
-
capital: Joi.string().allow(""),
|
|
3893
|
-
currency: Joi.string().allow(""),
|
|
3894
|
-
iso2: Joi.string().allow(""),
|
|
3895
|
-
iso3: Joi.string().allow(""),
|
|
3896
|
-
name: Joi.string().allow(""),
|
|
3897
|
-
parent: Joi.string().allow(""),
|
|
3898
|
-
phone_code: Joi.string().allow(""),
|
|
3899
|
-
type: Joi.string().allow(""),
|
|
3900
|
-
uid: Joi.number(),
|
|
3901
|
-
__v: Joi.number(),
|
|
3902
|
-
_id: Joi.string().allow(""),
|
|
3903
|
-
default_currency: ConfigurationPlatformModel.LocationDefaultCurrency(),
|
|
3904
|
-
default_language: ConfigurationPlatformModel.LocationDefaultLanguage(),
|
|
3905
|
-
state_code: Joi.string().allow(""),
|
|
3906
|
-
country_code: Joi.string().allow(""),
|
|
3907
|
-
latitude: Joi.string().allow(""),
|
|
3908
|
-
longitude: Joi.string().allow(""),
|
|
3909
|
-
});
|
|
3910
|
-
}
|
|
3911
|
-
|
|
3912
|
-
/** @returns {Locations} */
|
|
3913
|
-
static Locations() {
|
|
3914
|
-
return Joi.object({
|
|
3915
|
-
items: Joi.array().items(ConfigurationPlatformModel.LocationCountry()),
|
|
3916
|
-
});
|
|
3917
|
-
}
|
|
3918
|
-
|
|
3919
|
-
/** @returns {UrlRedirectionResponse} */
|
|
3920
|
-
static UrlRedirectionResponse() {
|
|
3921
|
-
return Joi.object({
|
|
3922
|
-
redirections: Joi.array().items(
|
|
3923
|
-
ConfigurationPlatformModel.UrlRedirection()
|
|
3924
|
-
),
|
|
3925
|
-
});
|
|
3926
|
-
}
|
|
3927
|
-
|
|
3928
|
-
/** @returns {UrlRedirectionRequest} */
|
|
3929
|
-
static UrlRedirectionRequest() {
|
|
3930
|
-
return Joi.object({
|
|
3931
|
-
redirection: ConfigurationPlatformModel.UrlRedirection(),
|
|
3932
|
-
});
|
|
3933
|
-
}
|
|
3934
|
-
|
|
3935
|
-
/** @returns {UrlRedirection} */
|
|
3936
|
-
static UrlRedirection() {
|
|
3937
|
-
return Joi.object({
|
|
3938
|
-
redirect_from: Joi.string().allow(""),
|
|
3939
|
-
redirect_to: Joi.string().allow(""),
|
|
3940
|
-
type: Joi.string().allow(""),
|
|
3941
|
-
_id: Joi.string().allow(""),
|
|
3942
|
-
});
|
|
3943
|
-
}
|
|
3944
|
-
|
|
3945
|
-
/** @returns {StoreForConfigurationRequest} */
|
|
3946
|
-
static StoreForConfigurationRequest() {
|
|
3306
|
+
/** @returns {ValidationErrors} */
|
|
3307
|
+
static ValidationErrors() {
|
|
3947
3308
|
return Joi.object({
|
|
3948
|
-
|
|
3949
|
-
|
|
3950
|
-
|
|
3951
|
-
|
|
3952
|
-
/** @returns {DomainOptionsResponse} */
|
|
3953
|
-
static DomainOptionsResponse() {
|
|
3954
|
-
return Joi.object({
|
|
3955
|
-
domain_types: Joi.array().items(ConfigurationPlatformModel.DomainType()),
|
|
3956
|
-
network_ips: Joi.array().items(Joi.string().allow("")),
|
|
3957
|
-
network_cnames: Joi.array().items(Joi.string().allow("")),
|
|
3958
|
-
});
|
|
3959
|
-
}
|
|
3960
|
-
|
|
3961
|
-
/** @returns {DomainType} */
|
|
3962
|
-
static DomainType() {
|
|
3963
|
-
return Joi.object({
|
|
3964
|
-
key: Joi.string().allow(""),
|
|
3965
|
-
display: Joi.string().allow(""),
|
|
3966
|
-
values: Joi.array().items(ConfigurationPlatformModel.DomainValue()),
|
|
3967
|
-
});
|
|
3968
|
-
}
|
|
3969
|
-
|
|
3970
|
-
/** @returns {DomainValue} */
|
|
3971
|
-
static DomainValue() {
|
|
3972
|
-
return Joi.object({
|
|
3973
|
-
value: Joi.string().allow(""),
|
|
3974
|
-
text: Joi.string().allow(""),
|
|
3975
|
-
});
|
|
3976
|
-
}
|
|
3977
|
-
|
|
3978
|
-
/** @returns {StoreRequest} */
|
|
3979
|
-
static StoreRequest() {
|
|
3980
|
-
return Joi.object({
|
|
3981
|
-
companies: Joi.array().items(Joi.number()),
|
|
3309
|
+
errors: Joi.array()
|
|
3310
|
+
.items(ConfigurationPlatformModel.ValidationError())
|
|
3311
|
+
.required(),
|
|
3982
3312
|
});
|
|
3983
3313
|
}
|
|
3984
3314
|
|
|
3985
|
-
/** @returns {
|
|
3986
|
-
static
|
|
3315
|
+
/** @returns {ValidationError} */
|
|
3316
|
+
static ValidationError() {
|
|
3987
3317
|
return Joi.object({
|
|
3988
|
-
|
|
3318
|
+
message: Joi.string().allow("").required(),
|
|
3319
|
+
field: Joi.string().allow("").required(),
|
|
3989
3320
|
});
|
|
3990
3321
|
}
|
|
3991
3322
|
}
|