@gofynd/fdk-client-javascript 1.6.4 → 3.0.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +113 -93
- package/sdk/application/Cart/CartApplicationClient.js +270 -139
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +122 -138
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +43 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +190 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +71 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +103 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +51 -21
- package/sdk/application/Content/ContentApplicationClient.js +197 -36
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +79 -64
- package/sdk/application/Logistic/LogisticApplicationClient.js +246 -264
- package/sdk/application/Order/OrderApplicationClient.d.ts +44 -24
- package/sdk/application/Order/OrderApplicationClient.js +140 -21
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +211 -111
- package/sdk/application/Payment/PaymentApplicationClient.js +610 -109
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +23 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +103 -5
- package/sdk/application/User/UserApplicationClient.d.ts +13 -23
- package/sdk/application/User/UserApplicationClient.js +9 -57
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +66 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +431 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +231 -0
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +152 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +8 -0
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +39 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +26 -0
- package/sdk/partner/Catalog/CatalogPartnerClient.js +173 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +238 -0
- package/sdk/partner/Catalog/CatalogPartnerModel.js +248 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +5 -0
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +19 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -22
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +12 -87
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +33 -99
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +25 -84
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -10
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +100 -49
- package/sdk/partner/Lead/LeadPartnerModel.js +100 -74
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +33 -160
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +66 -1180
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +288 -1685
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +226 -824
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -13
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +14 -141
- package/sdk/partner/PartnerClient.d.ts +6 -0
- package/sdk/partner/PartnerClient.js +9 -0
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +116 -0
- package/sdk/partner/Payment/PaymentPartnerClient.js +857 -0
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +388 -0
- package/sdk/partner/Payment/PaymentPartnerModel.js +442 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +14 -0
- package/sdk/partner/Payment/PaymentPartnerValidator.js +74 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +63 -21
- package/sdk/partner/Theme/ThemePartnerClient.js +396 -71
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +104 -72
- package/sdk/partner/Theme/ThemePartnerModel.js +101 -75
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +5 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +42 -12
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +191 -670
- package/sdk/partner/Webhook/WebhookPartnerModel.js +159 -268
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +3 -0
- package/sdk/partner/index.js +6 -0
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +1 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +145 -49
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +171 -20
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +406 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +3214 -76
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +3798 -459
- package/sdk/platform/Billing/BillingPlatformModel.js +2577 -342
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +465 -24
- package/sdk/platform/Billing/BillingPlatformValidator.js +490 -14
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +284 -205
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +671 -553
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +108 -132
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3136 -4788
- package/sdk/platform/Cart/CartPlatformModel.js +2850 -2031
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1015 -419
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +6450 -2010
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1121 -230
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +919 -127
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +372 -574
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1238 -1317
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +8351 -9825
- package/sdk/platform/Catalog/CatalogPlatformModel.js +9662 -6881
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +288 -235
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +241 -183
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -6
- package/sdk/platform/Common/CommonPlatformClient.js +5 -6
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +374 -234
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +875 -583
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +170 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +145 -126
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +56 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +307 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +424 -252
- package/sdk/platform/Communication/CommunicationPlatformModel.js +540 -320
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +62 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +48 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +68 -99
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +84 -140
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +238 -256
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +222 -244
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +333 -118
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1470 -409
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +158 -55
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +163 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +151 -61
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +595 -101
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +1199 -462
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1008 -321
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +80 -34
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +79 -24
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +253 -140
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1087 -458
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +221 -178
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +220 -157
- package/sdk/platform/Content/ContentPlatformClient.d.ts +124 -123
- package/sdk/platform/Content/ContentPlatformClient.js +459 -379
- package/sdk/platform/Content/ContentPlatformModel.d.ts +833 -1307
- package/sdk/platform/Content/ContentPlatformModel.js +893 -582
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +140 -150
- package/sdk/platform/Content/ContentPlatformValidator.js +131 -135
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +60 -36
- package/sdk/platform/Discount/DiscountPlatformClient.js +85 -36
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +46 -47
- package/sdk/platform/Discount/DiscountPlatformModel.js +42 -46
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +24 -22
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +75 -86
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +60 -74
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2895 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2150 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +4 -24
- package/sdk/platform/Lead/LeadPlatformClient.js +4 -160
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +142 -57
- package/sdk/platform/Lead/LeadPlatformModel.js +162 -79
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +3 -29
- package/sdk/platform/Lead/LeadPlatformValidator.js +2 -28
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +94 -25
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +600 -57
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +115 -115
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +120 -43
- package/sdk/platform/Order/OrderPlatformClient.d.ts +502 -293
- package/sdk/platform/Order/OrderPlatformClient.js +1466 -913
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4103 -9109
- package/sdk/platform/Order/OrderPlatformModel.js +3198 -4245
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +445 -612
- package/sdk/platform/Order/OrderPlatformValidator.js +316 -326
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +7 -7
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +382 -135
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +2453 -935
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +306 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +305 -70
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +66 -56
- package/sdk/platform/Payment/PaymentPlatformClient.js +269 -124
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +3525 -1313
- package/sdk/platform/Payment/PaymentPlatformModel.js +3813 -1511
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +64 -35
- package/sdk/platform/Payment/PaymentPlatformValidator.js +60 -34
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +14 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +344 -56
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +2180 -302
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +380 -54
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +336 -37
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +127 -213
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +538 -1306
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +3429 -2979
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3642 -1785
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +218 -392
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +151 -290
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Share/SharePlatformApplicationClient.js +8 -86
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +6 -23
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +3 -16
- package/sdk/platform/Share/SharePlatformModel.d.ts +6 -50
- package/sdk/platform/Share/SharePlatformModel.js +3 -43
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +157 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +21 -10
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +23 -6
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +18 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +85 -8
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +425 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +329 -23
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +7 -3
- package/sdk/platform/Theme/ThemePlatformValidator.js +9 -2
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +18 -71
- package/sdk/platform/User/UserPlatformApplicationClient.js +27 -412
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +10 -114
- package/sdk/platform/User/UserPlatformApplicationValidator.js +7 -80
- package/sdk/platform/User/UserPlatformModel.d.ts +216 -264
- package/sdk/platform/User/UserPlatformModel.js +209 -216
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +428 -810
- package/sdk/platform/Webhook/WebhookPlatformModel.js +395 -444
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Billing/BillingPublicClient.d.ts +56 -0
- package/sdk/public/Billing/BillingPublicClient.js +397 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +919 -0
- package/sdk/public/Billing/BillingPublicModel.js +560 -0
- package/sdk/public/Billing/BillingPublicValidator.d.ts +43 -0
- package/sdk/public/Billing/BillingPublicValidator.js +50 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +97 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +102 -40
- package/sdk/public/Configuration/ConfigurationPublicModel.js +111 -29
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +11 -1
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +12 -0
- package/sdk/public/Content/ContentPublicClient.d.ts +22 -0
- package/sdk/public/Content/ContentPublicClient.js +183 -0
- package/sdk/public/Content/ContentPublicModel.d.ts +38 -1
- package/sdk/public/Content/ContentPublicModel.js +47 -1
- package/sdk/public/Content/ContentPublicValidator.d.ts +17 -1
- package/sdk/public/Content/ContentPublicValidator.js +19 -0
- package/sdk/public/PublicClient.d.ts +2 -2
- package/sdk/public/PublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +67 -215
- package/sdk/public/Webhook/WebhookPublicModel.js +61 -66
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -1
- package/sdk/public/index.js +1 -1
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -126
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +0 -22
- package/sdk/public/Catalog/CatalogPublicClient.js +0 -138
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +0 -155
- package/sdk/public/Catalog/CatalogPublicModel.js +0 -116
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +0 -55
- package/sdk/public/Catalog/CatalogPublicValidator.js +0 -35
|
@@ -1,28 +1,6 @@
|
|
|
1
1
|
export = ConfigurationPlatformModel;
|
|
2
|
-
/**
|
|
3
|
-
* @typedef CurrencyExchangeResponseV2
|
|
4
|
-
* @property {string} base - The 3-letter ISO 4217 code representing the base currency.
|
|
5
|
-
* @property {string} base_currency_name - The name of the base currency.
|
|
6
|
-
* @property {number} ttl_seconds - Time in seconds for which the exchange rates
|
|
7
|
-
* are valid.
|
|
8
|
-
* @property {CurrencyExchangeItem[]} items - List of exchange rates and currency details.
|
|
9
|
-
* @property {number} total - Total number of currency exchange items.
|
|
10
|
-
*/
|
|
11
|
-
/**
|
|
12
|
-
* @typedef CurrencyExchangeItem
|
|
13
|
-
* @property {string} currency_code - 3-letter ISO 4217 exchange currency code.
|
|
14
|
-
* @property {string} name - Name of the exchange currency
|
|
15
|
-
* @property {number} rate - Exchange rate of the currency with respect to the
|
|
16
|
-
* base currency.
|
|
17
|
-
* @property {string} country_code - ISO 3166 country code.
|
|
18
|
-
* @property {string} country_name - Name of the country using this currency.
|
|
19
|
-
* @property {string} subunit - The name of the subunit for the currency.
|
|
20
|
-
* @property {number} decimal_digits - Number of decimal digits the currency supports.
|
|
21
|
-
* @property {string} symbol - The symbol of the currency.
|
|
22
|
-
*/
|
|
23
2
|
/**
|
|
24
3
|
* @typedef ApplicationInventory
|
|
25
|
-
* @property {SearchConfig} [search]
|
|
26
4
|
* @property {AppInventoryConfig} [inventory]
|
|
27
5
|
* @property {AuthenticationConfig} [authentication]
|
|
28
6
|
* @property {ArticleAssignmentConfig} [article_assignment]
|
|
@@ -56,20 +34,12 @@ export = ConfigurationPlatformModel;
|
|
|
56
34
|
* @property {boolean} [enabled]
|
|
57
35
|
*/
|
|
58
36
|
/**
|
|
59
|
-
* @typedef
|
|
60
|
-
* @property {
|
|
61
|
-
* enabled for the application.
|
|
62
|
-
*/
|
|
63
|
-
/**
|
|
64
|
-
* @typedef QuerySuggestions
|
|
65
|
-
* @property {boolean} [enabled] - Indicates whether query suggestions are enabled.
|
|
66
|
-
* @property {number} [max_limit] - Specifies the maximum number of query
|
|
67
|
-
* suggestions that can be returned.
|
|
37
|
+
* @typedef OwnerAppInventoryConfig
|
|
38
|
+
* @property {PricingStrategy} [pricing_strategy]
|
|
68
39
|
*/
|
|
69
40
|
/**
|
|
70
|
-
* @typedef
|
|
71
|
-
* @property {
|
|
72
|
-
* @property {QuerySuggestions} [query_suggestions]
|
|
41
|
+
* @typedef OwnerAppConfig
|
|
42
|
+
* @property {OwnerAppInventoryConfig} [inventory]
|
|
73
43
|
*/
|
|
74
44
|
/**
|
|
75
45
|
* @typedef AppInventoryConfig
|
|
@@ -78,15 +48,16 @@ export = ConfigurationPlatformModel;
|
|
|
78
48
|
* @property {InventoryCategory} [category]
|
|
79
49
|
* @property {InventoryPrice} [price]
|
|
80
50
|
* @property {InventoryDiscount} [discount]
|
|
51
|
+
* @property {PricingStrategy} [pricing_strategy]
|
|
81
52
|
* @property {boolean} [out_of_stock] - Indicates whether out of stock products
|
|
82
53
|
* are allowed to show up on the website
|
|
83
54
|
* @property {boolean} [only_verified_products] - Show only verified products
|
|
84
55
|
* (the ones whose data has been verified by the admin)
|
|
85
56
|
* @property {boolean} [franchise_enabled] - Allow other businesses (companies)
|
|
86
57
|
* to consume the current sales channel's inventory and sell products
|
|
87
|
-
* @property {
|
|
58
|
+
* @property {number[]} [exclude_category] - List of excluded brands category
|
|
88
59
|
* @property {string[]} [image]
|
|
89
|
-
* @property {
|
|
60
|
+
* @property {number[]} [company_store] - List of selling locations whose
|
|
90
61
|
* inventory is available to the sales channel for displaying on the website
|
|
91
62
|
* @property {number} [company_id]
|
|
92
63
|
*/
|
|
@@ -100,7 +71,7 @@ export = ConfigurationPlatformModel;
|
|
|
100
71
|
* @typedef InventoryStore
|
|
101
72
|
* @property {string} [criteria] - All stores or specific (explicit) stores to
|
|
102
73
|
* be shown on the website
|
|
103
|
-
* @property {
|
|
74
|
+
* @property {number[]} [stores] - List of stores
|
|
104
75
|
* @property {AppStoreRules[]} [rules] - Rules to show which brands or companies
|
|
105
76
|
* products should be listed on sales channel.
|
|
106
77
|
*/
|
|
@@ -114,7 +85,7 @@ export = ConfigurationPlatformModel;
|
|
|
114
85
|
/**
|
|
115
86
|
* @typedef InventoryCategory
|
|
116
87
|
* @property {string} [criteria]
|
|
117
|
-
* @property {
|
|
88
|
+
* @property {number[]} [categories] - List of categories whose products will be
|
|
118
89
|
* shown on the website
|
|
119
90
|
*/
|
|
120
91
|
/**
|
|
@@ -147,7 +118,7 @@ export = ConfigurationPlatformModel;
|
|
|
147
118
|
* @typedef StorePriority
|
|
148
119
|
* @property {boolean} [enabled] - Shows store priority is enabled or disabled
|
|
149
120
|
* for assignment of article
|
|
150
|
-
* @property {
|
|
121
|
+
* @property {number[]} [storetype_order] - List of store types for article
|
|
151
122
|
* assignment e.g. warehouse, mall, highstreet
|
|
152
123
|
*/
|
|
153
124
|
/**
|
|
@@ -257,7 +228,6 @@ export = ConfigurationPlatformModel;
|
|
|
257
228
|
*/
|
|
258
229
|
/**
|
|
259
230
|
* @typedef AppInventoryPartialUpdate
|
|
260
|
-
* @property {SearchConfig} [search]
|
|
261
231
|
* @property {RewardPointsConfig} [reward_points]
|
|
262
232
|
* @property {AppCartConfig} [cart]
|
|
263
233
|
* @property {AppPaymentConfig} [payment]
|
|
@@ -272,24 +242,24 @@ export = ConfigurationPlatformModel;
|
|
|
272
242
|
* @property {number} [company_id] - Numeric ID allotted to a business account
|
|
273
243
|
*/
|
|
274
244
|
/**
|
|
275
|
-
* @typedef
|
|
245
|
+
* @typedef CompanyByBrandsRequest
|
|
276
246
|
* @property {number} brands - Brand UID
|
|
277
247
|
* @property {string} [search_text] - A search field for finding a company by its name
|
|
278
248
|
*/
|
|
279
249
|
/**
|
|
280
|
-
* @typedef
|
|
250
|
+
* @typedef CompanyByBrandsResponse
|
|
281
251
|
* @property {BrandCompanyInfo[]} [items]
|
|
282
252
|
* @property {Page} [page]
|
|
283
253
|
*/
|
|
284
254
|
/**
|
|
285
|
-
* @typedef
|
|
255
|
+
* @typedef StoreByBrandsRequest
|
|
286
256
|
* @property {number} [company_id] - Current company ID for current company
|
|
287
257
|
* stores only. Don't send in case cross-selling (franchise) is enabled.
|
|
288
258
|
* @property {number} brands - Brand UID
|
|
289
259
|
* @property {string} [search_text] - Search store by its name or store code
|
|
290
260
|
*/
|
|
291
261
|
/**
|
|
292
|
-
* @typedef
|
|
262
|
+
* @typedef StoreByBrandsResponse
|
|
293
263
|
* @property {BrandStoreInfo[]} [items]
|
|
294
264
|
* @property {Page} [page]
|
|
295
265
|
*/
|
|
@@ -314,16 +284,19 @@ export = ConfigurationPlatformModel;
|
|
|
314
284
|
* portrait banner
|
|
315
285
|
*/
|
|
316
286
|
/**
|
|
317
|
-
* @typedef
|
|
287
|
+
* @typedef BrandsByCompanyResponse
|
|
318
288
|
* @property {CompanyBrandInfo[]} [brands]
|
|
319
289
|
*/
|
|
320
290
|
/**
|
|
321
|
-
* @typedef
|
|
291
|
+
* @typedef ValidationFailedResponse
|
|
322
292
|
* @property {string} [message] - Response message for failed validation
|
|
293
|
+
* @property {Object[]} [errors] - Response message for failed validation
|
|
323
294
|
*/
|
|
324
295
|
/**
|
|
325
296
|
* @typedef NotFound
|
|
326
297
|
* @property {string} [message] - Response message for not found
|
|
298
|
+
* @property {string} [error] - Error message for not found
|
|
299
|
+
* @property {string} [code] - Unique code for each error
|
|
327
300
|
* @property {boolean} [success] - Flag for required not successfull.
|
|
328
301
|
*/
|
|
329
302
|
/**
|
|
@@ -345,18 +318,18 @@ export = ConfigurationPlatformModel;
|
|
|
345
318
|
* amount pan card number is expected from customer for order
|
|
346
319
|
*/
|
|
347
320
|
/**
|
|
348
|
-
* @typedef
|
|
321
|
+
* @typedef CreateApplicationRequest
|
|
349
322
|
* @property {App} [app]
|
|
350
323
|
* @property {ApplicationInventory} [configuration]
|
|
351
324
|
* @property {AppDomain} [domain]
|
|
352
325
|
*/
|
|
353
326
|
/**
|
|
354
|
-
* @typedef
|
|
327
|
+
* @typedef CreateAppResponse
|
|
355
328
|
* @property {Application} [app]
|
|
356
329
|
* @property {ApplicationInventory} [configuration]
|
|
357
330
|
*/
|
|
358
331
|
/**
|
|
359
|
-
* @typedef
|
|
332
|
+
* @typedef ApplicationsResponse
|
|
360
333
|
* @property {Application[]} [items]
|
|
361
334
|
* @property {Page} [page]
|
|
362
335
|
*/
|
|
@@ -390,7 +363,7 @@ export = ConfigurationPlatformModel;
|
|
|
390
363
|
* @property {string} [secure_url] - URL where the splash image is hosted
|
|
391
364
|
*/
|
|
392
365
|
/**
|
|
393
|
-
* @typedef
|
|
366
|
+
* @typedef MobileAppConfigRequest
|
|
394
367
|
* @property {string} [app_name] - Name of the mobile app
|
|
395
368
|
* @property {LandingImage} [landing_image]
|
|
396
369
|
* @property {SplashImage} [splash_image]
|
|
@@ -456,7 +429,7 @@ export = ConfigurationPlatformModel;
|
|
|
456
429
|
* @property {string[]} [txt_records]
|
|
457
430
|
*/
|
|
458
431
|
/**
|
|
459
|
-
* @typedef
|
|
432
|
+
* @typedef DomainAddRequest
|
|
460
433
|
* @property {DomainAdd} [domain]
|
|
461
434
|
*/
|
|
462
435
|
/**
|
|
@@ -473,7 +446,7 @@ export = ConfigurationPlatformModel;
|
|
|
473
446
|
* @property {string} [message]
|
|
474
447
|
*/
|
|
475
448
|
/**
|
|
476
|
-
* @typedef
|
|
449
|
+
* @typedef DomainsResponse
|
|
477
450
|
* @property {Domain[]} [domains]
|
|
478
451
|
*/
|
|
479
452
|
/**
|
|
@@ -489,13 +462,13 @@ export = ConfigurationPlatformModel;
|
|
|
489
462
|
* domain (short URL e.g. bit.ly)
|
|
490
463
|
*/
|
|
491
464
|
/**
|
|
492
|
-
* @typedef
|
|
465
|
+
* @typedef UpdateDomainTypeRequest
|
|
493
466
|
* @property {UpdateDomain} [domain]
|
|
494
467
|
* @property {string} [action] - Shows domain is made primary domain for the
|
|
495
468
|
* sales channel or shorlink is created for the sales channel domain
|
|
496
469
|
*/
|
|
497
470
|
/**
|
|
498
|
-
* @typedef
|
|
471
|
+
* @typedef DomainStatusRequest
|
|
499
472
|
* @property {string} [domain_url] - URL of the domain, e.g. uniket.hostx0.de
|
|
500
473
|
*/
|
|
501
474
|
/**
|
|
@@ -505,16 +478,14 @@ export = ConfigurationPlatformModel;
|
|
|
505
478
|
* domain are correctly propagating via DNS servers
|
|
506
479
|
*/
|
|
507
480
|
/**
|
|
508
|
-
* @typedef
|
|
481
|
+
* @typedef DomainStatusResponse
|
|
509
482
|
* @property {boolean} [connected] - Check if domain is live and mapped to
|
|
510
483
|
* appropriate IP of Fynd Servers
|
|
511
484
|
* @property {DomainStatus[]} [status]
|
|
512
485
|
*/
|
|
513
486
|
/**
|
|
514
|
-
* @typedef
|
|
487
|
+
* @typedef DomainSuggestionsRequest
|
|
515
488
|
* @property {string} [domain_url] - Domain url
|
|
516
|
-
* @property {boolean} [custom_domain] - Get suggestions for custom domains or
|
|
517
|
-
* Fynd domains
|
|
518
489
|
*/
|
|
519
490
|
/**
|
|
520
491
|
* @typedef DomainSuggestion
|
|
@@ -527,14 +498,186 @@ export = ConfigurationPlatformModel;
|
|
|
527
498
|
* @property {string} [currency] - Custom domain currency. Not present for Fynd domains.
|
|
528
499
|
*/
|
|
529
500
|
/**
|
|
530
|
-
* @typedef
|
|
501
|
+
* @typedef DomainSuggestionsResponse
|
|
531
502
|
* @property {DomainSuggestion[]} [domains] - Domain URL
|
|
532
503
|
*/
|
|
533
504
|
/**
|
|
534
|
-
* @typedef
|
|
505
|
+
* @typedef SuccessMessageResponse
|
|
535
506
|
* @property {boolean} [success] - Shows whether domain was deleted successfully
|
|
536
507
|
* @property {string} [message] - Success message shown to the user (in a string format)
|
|
537
508
|
*/
|
|
509
|
+
/**
|
|
510
|
+
* @typedef GetIntegrationsOptInsResponse
|
|
511
|
+
* @property {IntegrationOptIn[]} [items]
|
|
512
|
+
* @property {Page} [page]
|
|
513
|
+
*/
|
|
514
|
+
/**
|
|
515
|
+
* @typedef IntegrationOptIn
|
|
516
|
+
* @property {Validators} [validators]
|
|
517
|
+
* @property {string} [description] - Basic description about the opted integration
|
|
518
|
+
* @property {string} [description_html] - Basic HTML description about the
|
|
519
|
+
* opted integration
|
|
520
|
+
* @property {string} [constants]
|
|
521
|
+
* @property {string[]} [companies]
|
|
522
|
+
* @property {string[]} [support]
|
|
523
|
+
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
524
|
+
* of the opted integration
|
|
525
|
+
* @property {string} [name] - Nmae of the opted integration, e.g. SAP RBL Integration
|
|
526
|
+
* @property {string} [slug] - Slug of the opted integration, e.g. ginesys
|
|
527
|
+
* @property {boolean} [hidden]
|
|
528
|
+
* @property {IntegrationMeta[]} [meta]
|
|
529
|
+
* @property {string} [icon] - Hosted URL of the icon image
|
|
530
|
+
* @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
|
|
531
|
+
* of the user who created the integration
|
|
532
|
+
* @property {string} [created_at] - ISO 8601 timestamp of integration creation
|
|
533
|
+
* @property {string} [modified_at] - ISO 8601 timestamp of integration updation
|
|
534
|
+
* @property {string} [token] - Randomly generated fixed-length string for opted
|
|
535
|
+
* integration. It is auto-generated. It would never change once it is generated.
|
|
536
|
+
* @property {string} [secret] - Randomly generated fixed-length string for
|
|
537
|
+
* opted integration. It is auto-generated. It would never change once it is generated.
|
|
538
|
+
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
539
|
+
*/
|
|
540
|
+
/**
|
|
541
|
+
* @typedef Validators
|
|
542
|
+
* @property {CompanyValidator} [company]
|
|
543
|
+
* @property {StoreValidator} [store]
|
|
544
|
+
* @property {InventoryValidator} [inventory]
|
|
545
|
+
* @property {OrderValidator} [order]
|
|
546
|
+
*/
|
|
547
|
+
/**
|
|
548
|
+
* @typedef CompanyValidator
|
|
549
|
+
* @property {JsonSchema[]} [json_schema]
|
|
550
|
+
* @property {string} [browser_script] - Browser script for the company validator
|
|
551
|
+
*/
|
|
552
|
+
/**
|
|
553
|
+
* @typedef JsonSchema
|
|
554
|
+
* @property {string} [display] - Display text of the validator JSON schema. It
|
|
555
|
+
* will show in the UI.
|
|
556
|
+
* @property {string} [key] - Key related to the display text of the validator JSON schema
|
|
557
|
+
* @property {string} [type] - Indicates the type of form field, e.g. Text, Dropdown.
|
|
558
|
+
* @property {string} [tooltip] - Tooltip text for the UI of the validator JSON
|
|
559
|
+
* schema. It will show in the UI.
|
|
560
|
+
*/
|
|
561
|
+
/**
|
|
562
|
+
* @typedef StoreValidator
|
|
563
|
+
* @property {JsonSchema[]} [json_schema]
|
|
564
|
+
* @property {string} [browser_script] - Browser script for the store validator
|
|
565
|
+
*/
|
|
566
|
+
/**
|
|
567
|
+
* @typedef InventoryValidator
|
|
568
|
+
* @property {JsonSchema[]} [json_schema]
|
|
569
|
+
* @property {string} [browser_script] - Browser script for the inventory validator
|
|
570
|
+
*/
|
|
571
|
+
/**
|
|
572
|
+
* @typedef OrderValidator
|
|
573
|
+
* @property {JsonSchema[]} [json_schema]
|
|
574
|
+
* @property {string} [browser_script] - Browser script for the order validator
|
|
575
|
+
*/
|
|
576
|
+
/**
|
|
577
|
+
* @typedef IntegrationMeta
|
|
578
|
+
* @property {boolean} [is_public]
|
|
579
|
+
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
580
|
+
* of the integration meta
|
|
581
|
+
* @property {string} [name] - Nmae of integration meta, e.g. price_level
|
|
582
|
+
* @property {string} [value] - Value related to integration meta name, e.g. store
|
|
583
|
+
*/
|
|
584
|
+
/**
|
|
585
|
+
* @typedef Integration
|
|
586
|
+
* @property {Validators} [validators]
|
|
587
|
+
* @property {string} [description] - Basic description about the integration
|
|
588
|
+
* @property {string} [description_html] - Basic HTML description about the integration
|
|
589
|
+
* @property {Object} [constants]
|
|
590
|
+
* @property {string[]} [companies]
|
|
591
|
+
* @property {string[]} [support]
|
|
592
|
+
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
593
|
+
* of the integration
|
|
594
|
+
* @property {string} [name] - Name of the integration, e.g. SAP RBL Integration
|
|
595
|
+
* @property {string} [slug] - Name of the integration, e.g. SAP RBL Integration
|
|
596
|
+
* @property {IntegrationMeta[]} [meta]
|
|
597
|
+
* @property {string} [icon] - Hosted URL of the icon image
|
|
598
|
+
* @property {boolean} [hidden]
|
|
599
|
+
* @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
|
|
600
|
+
* of the user who created the integration
|
|
601
|
+
* @property {string} [created_at] - ISO 8601 timestamp of integration creation
|
|
602
|
+
* @property {string} [modified_at] - ISO 8601 timestamp of integration updation
|
|
603
|
+
* @property {string} [token] - Randomly generated fixed-length string for opted
|
|
604
|
+
* integration. It is auto-generated. It would never change once it is generated.
|
|
605
|
+
* @property {string} [secret] - Randomly generated fixed-length string for
|
|
606
|
+
* opted integration. It is auto-generated. It would never change once it is generated.
|
|
607
|
+
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
608
|
+
*/
|
|
609
|
+
/**
|
|
610
|
+
* @typedef IntegrationConfigResponse
|
|
611
|
+
* @property {IntegrationLevel[]} [items]
|
|
612
|
+
*/
|
|
613
|
+
/**
|
|
614
|
+
* @typedef IntegrationLevel
|
|
615
|
+
* @property {boolean} [opted] - Shows this integration is opted or not opted
|
|
616
|
+
* for the current company
|
|
617
|
+
* @property {Object[]} [permissions]
|
|
618
|
+
* @property {LastPatch[]} [last_patch]
|
|
619
|
+
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
620
|
+
* of the integration config
|
|
621
|
+
* @property {string} [integration] - Integration id. Shows which integration
|
|
622
|
+
* you are enabling.
|
|
623
|
+
* @property {string} [level] - Shows for what level the integration is set up.
|
|
624
|
+
* It can be company level or store level.
|
|
625
|
+
* @property {number} [uid] - It can be store uid or company uid. Depends on the
|
|
626
|
+
* level of integration.
|
|
627
|
+
* @property {number} [company_id] - Unique id of company.
|
|
628
|
+
* @property {IntegrationMeta[]} [meta]
|
|
629
|
+
* @property {string} [token] - Randomly generated fixed-length string for opted
|
|
630
|
+
* integration. It is auto-generated. It would never change once it is generated.
|
|
631
|
+
* @property {string} [created_at] - ISO 8601 timestamp of integration config creation
|
|
632
|
+
* @property {string} [modified_at] - ISO 8601 timestamp of integration config updation
|
|
633
|
+
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
634
|
+
* @property {Object} [data] - Schema data of the integration stored in key-value pairs
|
|
635
|
+
* @property {boolean} [success]
|
|
636
|
+
* @property {string} [message]
|
|
637
|
+
*/
|
|
638
|
+
/**
|
|
639
|
+
* @typedef UpdateIntegrationLevelRequest
|
|
640
|
+
* @property {IntegrationLevel[]} [items]
|
|
641
|
+
*/
|
|
642
|
+
/**
|
|
643
|
+
* @typedef OptedStoreIntegration
|
|
644
|
+
* @property {boolean} [other_opted] - Allow user to opt same store in other integration
|
|
645
|
+
* @property {IntegrationOptIn} [other_integration]
|
|
646
|
+
* @property {OtherEntity} [other_entity]
|
|
647
|
+
*/
|
|
648
|
+
/**
|
|
649
|
+
* @typedef OtherEntity
|
|
650
|
+
* @property {boolean} [opted] - Allow other entity opted in integration
|
|
651
|
+
* @property {string[]} [permissions]
|
|
652
|
+
* @property {LastPatch[]} [last_patch]
|
|
653
|
+
* @property {string} [_id] - The unique identifier of the other entity for
|
|
654
|
+
* opted store integration
|
|
655
|
+
* @property {string} [integration] - Integration ID. Shows which integration
|
|
656
|
+
* you are enabling.
|
|
657
|
+
* @property {string} [level] - Indicates integration level. It can be company
|
|
658
|
+
* level or store level.
|
|
659
|
+
* @property {number} [uid] - It can be store uid or company uid. Depends on the
|
|
660
|
+
* level of integration.
|
|
661
|
+
* @property {OtherEntityData} [data]
|
|
662
|
+
* @property {Object[]} [meta]
|
|
663
|
+
* @property {string} [token] - Randomly generated fixed-length string for opted
|
|
664
|
+
* integration. It is auto-generated. It would never change once it is generated.
|
|
665
|
+
* @property {string} [created_at] - ISO 8601 timestamp of other entity creation
|
|
666
|
+
* for opted store integration
|
|
667
|
+
* @property {string} [modified_at] - ISO 8601 timestamp of other entity
|
|
668
|
+
* updation for opted store integration
|
|
669
|
+
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
670
|
+
*/
|
|
671
|
+
/**
|
|
672
|
+
* @typedef LastPatch
|
|
673
|
+
* @property {string} [op]
|
|
674
|
+
* @property {string} [path]
|
|
675
|
+
* @property {string} [value] - It can be inventory level or order level
|
|
676
|
+
*/
|
|
677
|
+
/**
|
|
678
|
+
* @typedef OtherEntityData
|
|
679
|
+
* @property {string} [article_identifier]
|
|
680
|
+
*/
|
|
538
681
|
/**
|
|
539
682
|
* @typedef App
|
|
540
683
|
* @property {string} [company_id] - Numeric ID allotted to a business account
|
|
@@ -545,12 +688,31 @@ export = ConfigurationPlatformModel;
|
|
|
545
688
|
* @property {string} [name] - User-friendly name for sales channel, e.g. Zenz Fashion
|
|
546
689
|
* @property {string} [desc] - Detailed description about the sales channel
|
|
547
690
|
*/
|
|
691
|
+
/**
|
|
692
|
+
* @typedef InventoryConfig
|
|
693
|
+
* @property {InventoryBrandRule} [brand]
|
|
694
|
+
* @property {InventoryStoreRule} [store]
|
|
695
|
+
* @property {string[]} [image]
|
|
696
|
+
* @property {boolean} [franchise_enabled] - Allow other businesses (companies)
|
|
697
|
+
* to consume the current sales channel's inventory and sell products
|
|
698
|
+
* @property {boolean} [out_of_stock] - Indicates whether out of stock products
|
|
699
|
+
* are allowed to show up on the website.
|
|
700
|
+
* @property {boolean} [only_verified_products] - Show only verified products
|
|
701
|
+
* (the ones whose data have been verified by the admin)
|
|
702
|
+
* @property {PricingStrategy} [pricing_strategy]
|
|
703
|
+
*/
|
|
704
|
+
/**
|
|
705
|
+
* @typedef AppInventory
|
|
706
|
+
* @property {InventoryConfig} [inventory]
|
|
707
|
+
* @property {InventoryPaymentConfig} [payment]
|
|
708
|
+
* @property {InventoryArticleAssignment} [article_assignment]
|
|
709
|
+
*/
|
|
548
710
|
/**
|
|
549
711
|
* @typedef AppDomain
|
|
550
712
|
* @property {string} [name] - Domain URL of current sales channel, e.g. zenz.com
|
|
551
713
|
*/
|
|
552
714
|
/**
|
|
553
|
-
* @typedef
|
|
715
|
+
* @typedef CompaniesResponse
|
|
554
716
|
* @property {AppInventoryCompanies[]} [items]
|
|
555
717
|
* @property {Page} [page]
|
|
556
718
|
*/
|
|
@@ -562,10 +724,18 @@ export = ConfigurationPlatformModel;
|
|
|
562
724
|
* franchisee, distributor, etc.
|
|
563
725
|
*/
|
|
564
726
|
/**
|
|
565
|
-
* @typedef
|
|
727
|
+
* @typedef StoresResponse
|
|
566
728
|
* @property {AppInventoryStores[]} [items]
|
|
567
729
|
* @property {Page} [page]
|
|
568
730
|
*/
|
|
731
|
+
/**
|
|
732
|
+
* @typedef ListStoreResponse
|
|
733
|
+
* @property {AppInventoryStores[]} [stores]
|
|
734
|
+
*/
|
|
735
|
+
/**
|
|
736
|
+
* @typedef ArrayStoreResponse
|
|
737
|
+
* @property {AppInventoryStores[]} [data]
|
|
738
|
+
*/
|
|
569
739
|
/**
|
|
570
740
|
* @typedef AppInventoryStores
|
|
571
741
|
* @property {string} [_id] - The unique identifier of the store (24-digit Mongo
|
|
@@ -587,7 +757,7 @@ export = ConfigurationPlatformModel;
|
|
|
587
757
|
* @property {Object} [integration_type]
|
|
588
758
|
*/
|
|
589
759
|
/**
|
|
590
|
-
* @typedef
|
|
760
|
+
* @typedef FilterOrderingStoreRequest
|
|
591
761
|
* @property {boolean} [all_stores] - Allow all stores from the ordering stores
|
|
592
762
|
* @property {number[]} [deployed_stores]
|
|
593
763
|
* @property {string} [q] - Store code or name of the ordering store
|
|
@@ -611,7 +781,7 @@ export = ConfigurationPlatformModel;
|
|
|
611
781
|
* @property {DeploymentMeta} [deployment_meta]
|
|
612
782
|
*/
|
|
613
783
|
/**
|
|
614
|
-
* @typedef
|
|
784
|
+
* @typedef OrderingStoreSelectRequest
|
|
615
785
|
* @property {OrderingStoreSelect} ordering_store
|
|
616
786
|
*/
|
|
617
787
|
/**
|
|
@@ -640,7 +810,7 @@ export = ConfigurationPlatformModel;
|
|
|
640
810
|
* @property {Page} [page]
|
|
641
811
|
*/
|
|
642
812
|
/**
|
|
643
|
-
* @typedef
|
|
813
|
+
* @typedef OptedApplicationResponse
|
|
644
814
|
* @property {string} [name] - Name of the other seller's sales channel
|
|
645
815
|
* @property {string} [description] - Basic details about the other seller's sales channel
|
|
646
816
|
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
@@ -691,7 +861,7 @@ export = ConfigurationPlatformModel;
|
|
|
691
861
|
* of other seller's application
|
|
692
862
|
*/
|
|
693
863
|
/**
|
|
694
|
-
* @typedef
|
|
864
|
+
* @typedef TokenResponse
|
|
695
865
|
* @property {Tokens} [tokens]
|
|
696
866
|
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
697
867
|
* of the token
|
|
@@ -814,7 +984,6 @@ export = ConfigurationPlatformModel;
|
|
|
814
984
|
*/
|
|
815
985
|
/**
|
|
816
986
|
* @typedef GoogleMap
|
|
817
|
-
* @property {boolean} [enabled] - Shows whether Google map integration is enabled or not.
|
|
818
987
|
* @property {GoogleMapCredentials} [credentials]
|
|
819
988
|
*/
|
|
820
989
|
/**
|
|
@@ -886,6 +1055,7 @@ export = ConfigurationPlatformModel;
|
|
|
886
1055
|
* @property {QrFeature} [qr]
|
|
887
1056
|
* @property {PcrFeature} [pcr]
|
|
888
1057
|
* @property {OrderFeature} [order]
|
|
1058
|
+
* @property {BuyboxFeature} [buybox]
|
|
889
1059
|
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
890
1060
|
* for the sales channel features
|
|
891
1061
|
* @property {string} [app] - Application ID of the sales channel
|
|
@@ -894,6 +1064,7 @@ export = ConfigurationPlatformModel;
|
|
|
894
1064
|
* @property {string} [modified_at] - ISO 8601 timestamp of last known
|
|
895
1065
|
* modifications to the sales channel feature configuration
|
|
896
1066
|
* @property {number} [__v] - Version key for tracking revisions. Default value is zero
|
|
1067
|
+
* @property {PricingStrategy} [pricing_strategy]
|
|
897
1068
|
*/
|
|
898
1069
|
/**
|
|
899
1070
|
* @typedef HomePageFeature
|
|
@@ -990,11 +1161,21 @@ export = ConfigurationPlatformModel;
|
|
|
990
1161
|
* value is false.
|
|
991
1162
|
*/
|
|
992
1163
|
/**
|
|
993
|
-
* @typedef
|
|
1164
|
+
* @typedef BuyboxFeature
|
|
1165
|
+
* @property {boolean} [show_name] - Allow users to see seller/stores name on
|
|
1166
|
+
* PDP (product detail page).
|
|
1167
|
+
* @property {boolean} [enable_selection] - Allow selection of sellers/stores on
|
|
1168
|
+
* PDP (product detail page).
|
|
1169
|
+
* @property {boolean} [is_seller_buybox_enabled] - Toggle buybox listing
|
|
1170
|
+
* between sellers and stores. True indicates seller listing, while False
|
|
1171
|
+
* indicates store listing.
|
|
1172
|
+
*/
|
|
1173
|
+
/**
|
|
1174
|
+
* @typedef AppFeatureRequest
|
|
994
1175
|
* @property {AppFeature} [feature]
|
|
995
1176
|
*/
|
|
996
1177
|
/**
|
|
997
|
-
* @typedef
|
|
1178
|
+
* @typedef AppFeatureResponse
|
|
998
1179
|
* @property {AppFeature} [feature]
|
|
999
1180
|
*/
|
|
1000
1181
|
/**
|
|
@@ -1089,53 +1270,6 @@ export = ConfigurationPlatformModel;
|
|
|
1089
1270
|
* @property {TokenSchema[]} [tokens]
|
|
1090
1271
|
* @property {string} [secret]
|
|
1091
1272
|
*/
|
|
1092
|
-
/**
|
|
1093
|
-
* @typedef ApplicationById
|
|
1094
|
-
* @property {ApplicationWebsite} [website]
|
|
1095
|
-
* @property {ApplicationCors} [cors]
|
|
1096
|
-
* @property {ApplicationAuth} [auth]
|
|
1097
|
-
* @property {string} [description] - It contains detailed information about the
|
|
1098
|
-
* sales channel.
|
|
1099
|
-
* @property {string} [channel_type] - It indicates different types of channels,
|
|
1100
|
-
* such as store, website, and mobile apps, with 'store' being the default value.
|
|
1101
|
-
* @property {number} [cache_ttl] - An integer value that specifies the number
|
|
1102
|
-
* of seconds until the key expires
|
|
1103
|
-
* @property {boolean} [is_internal] - Indicates whether a sales channel is
|
|
1104
|
-
* internal or not
|
|
1105
|
-
* @property {boolean} [is_active] - Indicates sales channel is active or not active
|
|
1106
|
-
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
1107
|
-
* of the sales channel
|
|
1108
|
-
* @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
|
|
1109
|
-
* @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
|
|
1110
|
-
* of owner who owns the application
|
|
1111
|
-
* @property {number} [company_id] - Numeric ID allotted to a business account
|
|
1112
|
-
* where the sales channel exists
|
|
1113
|
-
* @property {string} [token] - Random generated fix length string for sales
|
|
1114
|
-
* channel. It is required and auto-generated.
|
|
1115
|
-
* @property {ApplicationRedirections[]} [redirections]
|
|
1116
|
-
* @property {ApplicationMeta[]} [meta]
|
|
1117
|
-
* @property {string} [created_at] - ISO 8601 timestamp of sales channel creation
|
|
1118
|
-
* @property {string} [modified_at] - ISO 8601 timestamp of sales channel updation
|
|
1119
|
-
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
1120
|
-
* @property {SecureUrl} [banner]
|
|
1121
|
-
* @property {SecureUrl} [logo]
|
|
1122
|
-
* @property {SecureUrl} [favicon]
|
|
1123
|
-
* @property {Domain[]} [domains]
|
|
1124
|
-
* @property {string} [app_type] - It shows application is live or in development mode.
|
|
1125
|
-
* @property {SecureUrl} [mobile_logo]
|
|
1126
|
-
* @property {Domain} [domain]
|
|
1127
|
-
* @property {string} [slug]
|
|
1128
|
-
* @property {string} [mode]
|
|
1129
|
-
* @property {string} [status]
|
|
1130
|
-
* @property {TokenSchemaID[]} [tokens]
|
|
1131
|
-
* @property {string} [secret]
|
|
1132
|
-
*/
|
|
1133
|
-
/**
|
|
1134
|
-
* @typedef TokenSchemaID
|
|
1135
|
-
* @property {string} [token]
|
|
1136
|
-
* @property {string} [created_by]
|
|
1137
|
-
* @property {string} [created_at] - ISO 8601 timestamp of when token created
|
|
1138
|
-
*/
|
|
1139
1273
|
/**
|
|
1140
1274
|
* @typedef TokenSchema
|
|
1141
1275
|
* @property {string} [token]
|
|
@@ -1143,9 +1277,55 @@ export = ConfigurationPlatformModel;
|
|
|
1143
1277
|
* @property {string} [created_at] - ISO 8601 timestamp of when token created
|
|
1144
1278
|
*/
|
|
1145
1279
|
/**
|
|
1146
|
-
* @typedef
|
|
1280
|
+
* @typedef InvalidPayloadRequest
|
|
1147
1281
|
* @property {string} [message] - Error message when request body payload is improper
|
|
1148
1282
|
* @property {boolean} [success] - Flag for required not successfull.
|
|
1283
|
+
* @property {Object} [domain] - All errors related to domin
|
|
1284
|
+
*/
|
|
1285
|
+
/**
|
|
1286
|
+
* @typedef InventoryBrandRule
|
|
1287
|
+
* @property {string} [criteria] - Whether all brands are enabled, or explicitly
|
|
1288
|
+
* few brands in the inventory
|
|
1289
|
+
* @property {number[]} [brands]
|
|
1290
|
+
*/
|
|
1291
|
+
/**
|
|
1292
|
+
* @typedef PricingStrategy
|
|
1293
|
+
* @property {string} [value] - Indicates the pricing strategy value.
|
|
1294
|
+
*/
|
|
1295
|
+
/**
|
|
1296
|
+
* @typedef StoreCriteriaRule
|
|
1297
|
+
* @property {number[]} [companies] - List of company UID
|
|
1298
|
+
* @property {number[]} [brands] - List of brand UID
|
|
1299
|
+
*/
|
|
1300
|
+
/**
|
|
1301
|
+
* @typedef InventoryStoreRule
|
|
1302
|
+
* @property {string} [criteria] - Whether all stores are enabled, or explicitly
|
|
1303
|
+
* few stores in the inventory, or use brands and company filter.
|
|
1304
|
+
* @property {StoreCriteriaRule[]} [rules] - List of rules with company and
|
|
1305
|
+
* brands uids. Used when critera is `filter`.
|
|
1306
|
+
* @property {number[]} [stores] - List of store uids. Used when critera is `explicit`.
|
|
1307
|
+
*/
|
|
1308
|
+
/**
|
|
1309
|
+
* @typedef InventoryPaymentConfig
|
|
1310
|
+
* @property {string} [mode_of_payment] - Mode of payment for the inventory of
|
|
1311
|
+
* sales channel. It is required and default value is null.
|
|
1312
|
+
* @property {string} [source] - Source of the payment mode for the inventory
|
|
1313
|
+
* payment of sales channel. Default value is FYND.
|
|
1314
|
+
*/
|
|
1315
|
+
/**
|
|
1316
|
+
* @typedef StorePriorityRule
|
|
1317
|
+
* @property {boolean} [enabled] - Shows store priority is enabled or not
|
|
1318
|
+
* enabled for the article assignment.
|
|
1319
|
+
* @property {string[]} [storetype_order]
|
|
1320
|
+
*/
|
|
1321
|
+
/**
|
|
1322
|
+
* @typedef ArticleAssignmentRule
|
|
1323
|
+
* @property {StorePriorityRule} [store_priority]
|
|
1324
|
+
*/
|
|
1325
|
+
/**
|
|
1326
|
+
* @typedef InventoryArticleAssignment
|
|
1327
|
+
* @property {boolean} [post_order_reassignment] - Allow post order reassigment of article
|
|
1328
|
+
* @property {ArticleAssignmentRule} [rules]
|
|
1149
1329
|
*/
|
|
1150
1330
|
/**
|
|
1151
1331
|
* @typedef Page
|
|
@@ -1156,6 +1336,7 @@ export = ConfigurationPlatformModel;
|
|
|
1156
1336
|
* @property {number} [current] - The current page number.
|
|
1157
1337
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
1158
1338
|
* @property {number} [size] - The number of items per page.
|
|
1339
|
+
* @property {number} [total] - Total number of items.
|
|
1159
1340
|
*/
|
|
1160
1341
|
/**
|
|
1161
1342
|
* @typedef ApplicationInformation
|
|
@@ -1309,11 +1490,11 @@ export = ConfigurationPlatformModel;
|
|
|
1309
1490
|
* @property {number} [company_id]
|
|
1310
1491
|
*/
|
|
1311
1492
|
/**
|
|
1312
|
-
* @typedef
|
|
1493
|
+
* @typedef CurrenciesResponse
|
|
1313
1494
|
* @property {Currency[]} [items]
|
|
1314
1495
|
*/
|
|
1315
1496
|
/**
|
|
1316
|
-
* @typedef
|
|
1497
|
+
* @typedef AppCurrencyResponse
|
|
1317
1498
|
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
1318
1499
|
* of the currency configuration supported by the application
|
|
1319
1500
|
* @property {string} [application] - Alphanumeric ID allotted to an application
|
|
@@ -1336,7 +1517,7 @@ export = ConfigurationPlatformModel;
|
|
|
1336
1517
|
* @property {string} [address1] - Address of the opted store
|
|
1337
1518
|
* @property {StoreLatLong} [lat_long]
|
|
1338
1519
|
* @property {string} [address2] - Address of the opted store
|
|
1339
|
-
* @property {
|
|
1520
|
+
* @property {string} [pincode] - 6-digit PIN code of the opted store location
|
|
1340
1521
|
* @property {string} [country] - Country of the opted store, e.g. India
|
|
1341
1522
|
* @property {string} [city] - City of the opted store, e.g. Mumbai
|
|
1342
1523
|
* @property {string} [sector] - Sector for the opted store.
|
|
@@ -1354,7 +1535,7 @@ export = ConfigurationPlatformModel;
|
|
|
1354
1535
|
* @property {string} [store_type] - Store type of the ordering store, e.g.
|
|
1355
1536
|
* high_street, mall, warehouse
|
|
1356
1537
|
* @property {string} [store_code] - Store code of the ordering store, e.g. MUM-102
|
|
1357
|
-
* @property {
|
|
1538
|
+
* @property {string} [pincode] - 6-digit PIN Code of the ordering store, e.g. 400001
|
|
1358
1539
|
* @property {string} [code] - Code of the ordering store (usually same as Store Code)
|
|
1359
1540
|
*/
|
|
1360
1541
|
/**
|
|
@@ -1374,90 +1555,126 @@ export = ConfigurationPlatformModel;
|
|
|
1374
1555
|
* value is zero.
|
|
1375
1556
|
*/
|
|
1376
1557
|
/**
|
|
1377
|
-
* @typedef
|
|
1558
|
+
* @typedef UpdateDiealog
|
|
1559
|
+
* @property {string} type
|
|
1560
|
+
* @property {number} [interval]
|
|
1561
|
+
*/
|
|
1562
|
+
/**
|
|
1563
|
+
* @typedef PlatformVersionRequest
|
|
1564
|
+
* @property {string} app_code_name
|
|
1565
|
+
* @property {string} app_name
|
|
1566
|
+
* @property {string} force_version
|
|
1567
|
+
* @property {string} latest_version
|
|
1568
|
+
* @property {boolean} is_app_blocked
|
|
1569
|
+
* @property {UpdateDiealog} update_dialog
|
|
1570
|
+
*/
|
|
1571
|
+
/**
|
|
1572
|
+
* @typedef PlatformVersion
|
|
1573
|
+
* @property {string} app_code_name
|
|
1574
|
+
* @property {string} app_name
|
|
1575
|
+
* @property {string} force_version
|
|
1576
|
+
* @property {string} latest_version
|
|
1577
|
+
* @property {boolean} is_app_blocked
|
|
1578
|
+
* @property {UpdateDiealog} update_dialog
|
|
1579
|
+
* @property {string} [_id]
|
|
1580
|
+
* @property {string} [modified_at] - ISO 8601 timestamp when currency was added
|
|
1581
|
+
* in the list of currencies supported by the sales channel
|
|
1582
|
+
* @property {string} [created_at] - ISO 8601 timestamp when currency was added
|
|
1583
|
+
* in the list of currencies supported by the sales channel
|
|
1584
|
+
* @property {number} [__v]
|
|
1585
|
+
*/
|
|
1586
|
+
/**
|
|
1587
|
+
* @typedef OrderingStoresResponse
|
|
1378
1588
|
* @property {Page} [page]
|
|
1379
1589
|
* @property {OrderingStore[]} [items]
|
|
1380
1590
|
*/
|
|
1381
1591
|
/**
|
|
1382
|
-
* @typedef
|
|
1383
|
-
* @property {
|
|
1592
|
+
* @typedef LocationDefaultLanguage
|
|
1593
|
+
* @property {string} [name]
|
|
1594
|
+
* @property {string} [code]
|
|
1595
|
+
*/
|
|
1596
|
+
/**
|
|
1597
|
+
* @typedef LocationDefaultCurrency
|
|
1598
|
+
* @property {string} [name]
|
|
1599
|
+
* @property {string} [symbol]
|
|
1600
|
+
* @property {string} [code]
|
|
1601
|
+
*/
|
|
1602
|
+
/**
|
|
1603
|
+
* @typedef LocationCountry
|
|
1604
|
+
* @property {string} [capital]
|
|
1605
|
+
* @property {string} [currency]
|
|
1606
|
+
* @property {string} [iso2]
|
|
1607
|
+
* @property {string} [iso3]
|
|
1608
|
+
* @property {string} [name]
|
|
1609
|
+
* @property {string} [parent]
|
|
1610
|
+
* @property {string} [phone_code]
|
|
1611
|
+
* @property {string} [type]
|
|
1612
|
+
* @property {number} [uid]
|
|
1613
|
+
* @property {number} [__v]
|
|
1614
|
+
* @property {string} [_id]
|
|
1615
|
+
* @property {LocationDefaultCurrency} [default_currency]
|
|
1616
|
+
* @property {LocationDefaultLanguage} [default_language]
|
|
1617
|
+
* @property {string} [state_code]
|
|
1618
|
+
* @property {string} [country_code]
|
|
1619
|
+
* @property {string} [latitude]
|
|
1620
|
+
* @property {string} [longitude]
|
|
1621
|
+
*/
|
|
1622
|
+
/**
|
|
1623
|
+
* @typedef Locations
|
|
1624
|
+
* @property {LocationCountry[]} [items]
|
|
1625
|
+
*/
|
|
1626
|
+
/**
|
|
1627
|
+
* @typedef UrlRedirectionResponse
|
|
1628
|
+
* @property {UrlRedirection[]} [redirections]
|
|
1629
|
+
*/
|
|
1630
|
+
/**
|
|
1631
|
+
* @typedef UrlRedirectionRequest
|
|
1632
|
+
* @property {UrlRedirection} [redirection]
|
|
1633
|
+
*/
|
|
1634
|
+
/**
|
|
1635
|
+
* @typedef UrlRedirection
|
|
1636
|
+
* @property {string} [redirect_from]
|
|
1637
|
+
* @property {string} [redirect_to]
|
|
1638
|
+
* @property {string} [type]
|
|
1639
|
+
* @property {string} [_id]
|
|
1640
|
+
*/
|
|
1641
|
+
/**
|
|
1642
|
+
* @typedef StoreForConfigurationRequest
|
|
1643
|
+
* @property {AppStoreRules[]} [conf]
|
|
1644
|
+
*/
|
|
1645
|
+
/**
|
|
1646
|
+
* @typedef DomainOptionsResponse
|
|
1647
|
+
* @property {DomainType[]} [domain_types]
|
|
1648
|
+
* @property {string[]} [network_ips]
|
|
1649
|
+
* @property {string[]} [network_cnames]
|
|
1650
|
+
*/
|
|
1651
|
+
/**
|
|
1652
|
+
* @typedef DomainType
|
|
1653
|
+
* @property {string} [key]
|
|
1654
|
+
* @property {string} [display]
|
|
1655
|
+
* @property {DomainValue[]} [values]
|
|
1656
|
+
*/
|
|
1657
|
+
/**
|
|
1658
|
+
* @typedef DomainValue
|
|
1659
|
+
* @property {string} [value]
|
|
1660
|
+
* @property {string} [text]
|
|
1661
|
+
*/
|
|
1662
|
+
/**
|
|
1663
|
+
* @typedef StoreRequest
|
|
1664
|
+
* @property {number[]} [companies]
|
|
1384
1665
|
*/
|
|
1385
1666
|
/**
|
|
1386
|
-
* @typedef
|
|
1387
|
-
* @property {
|
|
1388
|
-
* @property {string} field - The field in the request that caused the error.
|
|
1667
|
+
* @typedef StoreResponse
|
|
1668
|
+
* @property {number[]} [data]
|
|
1389
1669
|
*/
|
|
1390
1670
|
declare class ConfigurationPlatformModel {
|
|
1391
1671
|
}
|
|
1392
1672
|
declare namespace ConfigurationPlatformModel {
|
|
1393
|
-
export {
|
|
1673
|
+
export { ApplicationInventory, PiiMasking, OwnerAppInventoryConfig, OwnerAppConfig, AppInventoryConfig, InventoryBrand, InventoryStore, AppStoreRules, InventoryCategory, InventoryPrice, InventoryDiscount, AuthenticationConfig, ArticleAssignmentConfig, ArticleAssignmentRules, StorePriority, AppCartConfig, InternationalDeliveryCharges, DeliveryCharges, Charges, AppPaymentConfig, CallbackUrl, Methods, PaymentModeConfig, PaymentSelectionLock, AppOrderConfig, AppLogisticsConfig, LoyaltyPointsConfig, AppInventoryPartialUpdate, BrandCompanyInfo, CompanyByBrandsRequest, CompanyByBrandsResponse, StoreByBrandsRequest, StoreByBrandsResponse, BrandStoreInfo, CompanyBrandInfo, BrandsByCompanyResponse, ValidationFailedResponse, NotFound, CommunicationConfig, CommsConfig, PanCardConfig, CreateApplicationRequest, CreateAppResponse, ApplicationsResponse, MobileAppConfiguration, LandingImage, SplashImage, MobileAppConfigRequest, BuildVersionHistory, BuildVersion, AppSupportedCurrency, DefaultCurrency, DomainAdd, DomainAddRequest, Domain, DomainsResponse, UpdateDomain, UpdateDomainTypeRequest, DomainStatusRequest, DomainStatus, DomainStatusResponse, DomainSuggestionsRequest, DomainSuggestion, DomainSuggestionsResponse, SuccessMessageResponse, GetIntegrationsOptInsResponse, IntegrationOptIn, Validators, CompanyValidator, JsonSchema, StoreValidator, InventoryValidator, OrderValidator, IntegrationMeta, Integration, IntegrationConfigResponse, IntegrationLevel, UpdateIntegrationLevelRequest, OptedStoreIntegration, OtherEntity, LastPatch, OtherEntityData, App, InventoryConfig, AppInventory, AppDomain, CompaniesResponse, AppInventoryCompanies, StoresResponse, ListStoreResponse, ArrayStoreResponse, AppInventoryStores, FilterOrderingStoreRequest, DeploymentMeta, OrderingStoreConfig, OrderingStoreSelectRequest, OrderingStoreSelect, OtherSellerCompany, OtherSellerApplication, OtherSellerApplications, OptedApplicationResponse, OptedCompany, OptedInventory, OptType, OptedStore, OptOutInventory, TokenResponse, Tokens, Firebase, Credentials, Ios, Android, Moengage, MoengageCredentials, Segment, SegmentCredentials, Gtm, GtmCredentials, Freshchat, FreshchatCredentials, Safetynet, SafetynetCredentials, FyndRewards, FyndRewardsCredentials, GoogleMap, GoogleMapCredentials, RewardPointsConfig, Credit, Debit, ProductDetailFeature, LaunchPage, LandingPageFeature, ListingPageFeature, RegistrationPageFeature, AppFeature, HomePageFeature, CommonFeature, InternationalShipping, CommunicationOptinDialogFeature, DeploymentStoreSelectionFeature, ListingPriceFeature, CurrencyFeature, RevenueEngineFeature, FeedbackFeature, CompareProductsFeature, CartFeature, QrFeature, PcrFeature, OrderFeature, BuyboxFeature, AppFeatureRequest, AppFeatureResponse, Currency, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, TokenSchema, InvalidPayloadRequest, InventoryBrandRule, PricingStrategy, StoreCriteriaRule, InventoryStoreRule, InventoryPaymentConfig, StorePriorityRule, ArticleAssignmentRule, InventoryArticleAssignment, Page, ApplicationInformation, InformationAddress, InformationPhone, InformationLoc, InformationSupport, InformationSupportPhone, InformationSupportEmail, SocialLinks, FacebookLink, InstagramLink, TwitterLink, PinterestLink, GooglePlusLink, YoutubeLink, LinkedInLink, VimeoLink, BlogLink, Links, BusinessHighlights, ApplicationDetail, CurrenciesResponse, AppCurrencyResponse, StoreLatLong, OptedStoreAddress, OrderingStore, OrderingStores, UpdateDiealog, PlatformVersionRequest, PlatformVersion, OrderingStoresResponse, LocationDefaultLanguage, LocationDefaultCurrency, LocationCountry, Locations, UrlRedirectionResponse, UrlRedirectionRequest, UrlRedirection, StoreForConfigurationRequest, DomainOptionsResponse, DomainType, DomainValue, StoreRequest, StoreResponse };
|
|
1394
1674
|
}
|
|
1395
|
-
/** @returns {CurrencyExchangeResponseV2} */
|
|
1396
|
-
declare function CurrencyExchangeResponseV2(): CurrencyExchangeResponseV2;
|
|
1397
|
-
type CurrencyExchangeResponseV2 = {
|
|
1398
|
-
/**
|
|
1399
|
-
* - The 3-letter ISO 4217 code representing the base currency.
|
|
1400
|
-
*/
|
|
1401
|
-
base: string;
|
|
1402
|
-
/**
|
|
1403
|
-
* - The name of the base currency.
|
|
1404
|
-
*/
|
|
1405
|
-
base_currency_name: string;
|
|
1406
|
-
/**
|
|
1407
|
-
* - Time in seconds for which the exchange rates
|
|
1408
|
-
* are valid.
|
|
1409
|
-
*/
|
|
1410
|
-
ttl_seconds: number;
|
|
1411
|
-
/**
|
|
1412
|
-
* - List of exchange rates and currency details.
|
|
1413
|
-
*/
|
|
1414
|
-
items: CurrencyExchangeItem[];
|
|
1415
|
-
/**
|
|
1416
|
-
* - Total number of currency exchange items.
|
|
1417
|
-
*/
|
|
1418
|
-
total: number;
|
|
1419
|
-
};
|
|
1420
|
-
/** @returns {CurrencyExchangeItem} */
|
|
1421
|
-
declare function CurrencyExchangeItem(): CurrencyExchangeItem;
|
|
1422
|
-
type CurrencyExchangeItem = {
|
|
1423
|
-
/**
|
|
1424
|
-
* - 3-letter ISO 4217 exchange currency code.
|
|
1425
|
-
*/
|
|
1426
|
-
currency_code: string;
|
|
1427
|
-
/**
|
|
1428
|
-
* - Name of the exchange currency
|
|
1429
|
-
*/
|
|
1430
|
-
name: string;
|
|
1431
|
-
/**
|
|
1432
|
-
* - Exchange rate of the currency with respect to the
|
|
1433
|
-
* base currency.
|
|
1434
|
-
*/
|
|
1435
|
-
rate: number;
|
|
1436
|
-
/**
|
|
1437
|
-
* - ISO 3166 country code.
|
|
1438
|
-
*/
|
|
1439
|
-
country_code: string;
|
|
1440
|
-
/**
|
|
1441
|
-
* - Name of the country using this currency.
|
|
1442
|
-
*/
|
|
1443
|
-
country_name: string;
|
|
1444
|
-
/**
|
|
1445
|
-
* - The name of the subunit for the currency.
|
|
1446
|
-
*/
|
|
1447
|
-
subunit: string;
|
|
1448
|
-
/**
|
|
1449
|
-
* - Number of decimal digits the currency supports.
|
|
1450
|
-
*/
|
|
1451
|
-
decimal_digits: number;
|
|
1452
|
-
/**
|
|
1453
|
-
* - The symbol of the currency.
|
|
1454
|
-
*/
|
|
1455
|
-
symbol: string;
|
|
1456
|
-
};
|
|
1457
1675
|
/** @returns {ApplicationInventory} */
|
|
1458
1676
|
declare function ApplicationInventory(): ApplicationInventory;
|
|
1459
1677
|
type ApplicationInventory = {
|
|
1460
|
-
search?: SearchConfig;
|
|
1461
1678
|
inventory?: AppInventoryConfig;
|
|
1462
1679
|
authentication?: AuthenticationConfig;
|
|
1463
1680
|
article_assignment?: ArticleAssignmentConfig;
|
|
@@ -1512,33 +1729,15 @@ declare function PiiMasking(): PiiMasking;
|
|
|
1512
1729
|
type PiiMasking = {
|
|
1513
1730
|
enabled?: boolean;
|
|
1514
1731
|
};
|
|
1515
|
-
/** @returns {
|
|
1516
|
-
declare function
|
|
1517
|
-
type
|
|
1518
|
-
|
|
1519
|
-
* - Indicates whether FST identification is
|
|
1520
|
-
* enabled for the application.
|
|
1521
|
-
*/
|
|
1522
|
-
enabled?: boolean;
|
|
1523
|
-
};
|
|
1524
|
-
/** @returns {QuerySuggestions} */
|
|
1525
|
-
declare function QuerySuggestions(): QuerySuggestions;
|
|
1526
|
-
type QuerySuggestions = {
|
|
1527
|
-
/**
|
|
1528
|
-
* - Indicates whether query suggestions are enabled.
|
|
1529
|
-
*/
|
|
1530
|
-
enabled?: boolean;
|
|
1531
|
-
/**
|
|
1532
|
-
* - Specifies the maximum number of query
|
|
1533
|
-
* suggestions that can be returned.
|
|
1534
|
-
*/
|
|
1535
|
-
max_limit?: number;
|
|
1732
|
+
/** @returns {OwnerAppInventoryConfig} */
|
|
1733
|
+
declare function OwnerAppInventoryConfig(): OwnerAppInventoryConfig;
|
|
1734
|
+
type OwnerAppInventoryConfig = {
|
|
1735
|
+
pricing_strategy?: PricingStrategy;
|
|
1536
1736
|
};
|
|
1537
|
-
/** @returns {
|
|
1538
|
-
declare function
|
|
1539
|
-
type
|
|
1540
|
-
|
|
1541
|
-
query_suggestions?: QuerySuggestions;
|
|
1737
|
+
/** @returns {OwnerAppConfig} */
|
|
1738
|
+
declare function OwnerAppConfig(): OwnerAppConfig;
|
|
1739
|
+
type OwnerAppConfig = {
|
|
1740
|
+
inventory?: OwnerAppInventoryConfig;
|
|
1542
1741
|
};
|
|
1543
1742
|
/** @returns {AppInventoryConfig} */
|
|
1544
1743
|
declare function AppInventoryConfig(): AppInventoryConfig;
|
|
@@ -1548,6 +1747,7 @@ type AppInventoryConfig = {
|
|
|
1548
1747
|
category?: InventoryCategory;
|
|
1549
1748
|
price?: InventoryPrice;
|
|
1550
1749
|
discount?: InventoryDiscount;
|
|
1750
|
+
pricing_strategy?: PricingStrategy;
|
|
1551
1751
|
/**
|
|
1552
1752
|
* - Indicates whether out of stock products
|
|
1553
1753
|
* are allowed to show up on the website
|
|
@@ -1566,13 +1766,13 @@ type AppInventoryConfig = {
|
|
|
1566
1766
|
/**
|
|
1567
1767
|
* - List of excluded brands category
|
|
1568
1768
|
*/
|
|
1569
|
-
exclude_category?:
|
|
1769
|
+
exclude_category?: number[];
|
|
1570
1770
|
image?: string[];
|
|
1571
1771
|
/**
|
|
1572
1772
|
* - List of selling locations whose
|
|
1573
1773
|
* inventory is available to the sales channel for displaying on the website
|
|
1574
1774
|
*/
|
|
1575
|
-
company_store?:
|
|
1775
|
+
company_store?: number[];
|
|
1576
1776
|
company_id?: number;
|
|
1577
1777
|
};
|
|
1578
1778
|
/** @returns {InventoryBrand} */
|
|
@@ -1599,7 +1799,7 @@ type InventoryStore = {
|
|
|
1599
1799
|
/**
|
|
1600
1800
|
* - List of stores
|
|
1601
1801
|
*/
|
|
1602
|
-
stores?:
|
|
1802
|
+
stores?: number[];
|
|
1603
1803
|
/**
|
|
1604
1804
|
* - Rules to show which brands or companies
|
|
1605
1805
|
* products should be listed on sales channel.
|
|
@@ -1628,7 +1828,7 @@ type InventoryCategory = {
|
|
|
1628
1828
|
* - List of categories whose products will be
|
|
1629
1829
|
* shown on the website
|
|
1630
1830
|
*/
|
|
1631
|
-
categories?:
|
|
1831
|
+
categories?: number[];
|
|
1632
1832
|
};
|
|
1633
1833
|
/** @returns {InventoryPrice} */
|
|
1634
1834
|
declare function InventoryPrice(): InventoryPrice;
|
|
@@ -1694,7 +1894,7 @@ type StorePriority = {
|
|
|
1694
1894
|
* - List of store types for article
|
|
1695
1895
|
* assignment e.g. warehouse, mall, highstreet
|
|
1696
1896
|
*/
|
|
1697
|
-
storetype_order?:
|
|
1897
|
+
storetype_order?: number[];
|
|
1698
1898
|
};
|
|
1699
1899
|
/** @returns {AppCartConfig} */
|
|
1700
1900
|
declare function AppCartConfig(): AppCartConfig;
|
|
@@ -1897,7 +2097,6 @@ type LoyaltyPointsConfig = {
|
|
|
1897
2097
|
/** @returns {AppInventoryPartialUpdate} */
|
|
1898
2098
|
declare function AppInventoryPartialUpdate(): AppInventoryPartialUpdate;
|
|
1899
2099
|
type AppInventoryPartialUpdate = {
|
|
1900
|
-
search?: SearchConfig;
|
|
1901
2100
|
reward_points?: RewardPointsConfig;
|
|
1902
2101
|
cart?: AppCartConfig;
|
|
1903
2102
|
payment?: AppPaymentConfig;
|
|
@@ -1921,9 +2120,9 @@ type BrandCompanyInfo = {
|
|
|
1921
2120
|
*/
|
|
1922
2121
|
company_id?: number;
|
|
1923
2122
|
};
|
|
1924
|
-
/** @returns {
|
|
1925
|
-
declare function
|
|
1926
|
-
type
|
|
2123
|
+
/** @returns {CompanyByBrandsRequest} */
|
|
2124
|
+
declare function CompanyByBrandsRequest(): CompanyByBrandsRequest;
|
|
2125
|
+
type CompanyByBrandsRequest = {
|
|
1927
2126
|
/**
|
|
1928
2127
|
* - Brand UID
|
|
1929
2128
|
*/
|
|
@@ -1933,15 +2132,15 @@ type CompanyByBrandsRequestSchema = {
|
|
|
1933
2132
|
*/
|
|
1934
2133
|
search_text?: string;
|
|
1935
2134
|
};
|
|
1936
|
-
/** @returns {
|
|
1937
|
-
declare function
|
|
1938
|
-
type
|
|
2135
|
+
/** @returns {CompanyByBrandsResponse} */
|
|
2136
|
+
declare function CompanyByBrandsResponse(): CompanyByBrandsResponse;
|
|
2137
|
+
type CompanyByBrandsResponse = {
|
|
1939
2138
|
items?: BrandCompanyInfo[];
|
|
1940
2139
|
page?: Page;
|
|
1941
2140
|
};
|
|
1942
|
-
/** @returns {
|
|
1943
|
-
declare function
|
|
1944
|
-
type
|
|
2141
|
+
/** @returns {StoreByBrandsRequest} */
|
|
2142
|
+
declare function StoreByBrandsRequest(): StoreByBrandsRequest;
|
|
2143
|
+
type StoreByBrandsRequest = {
|
|
1945
2144
|
/**
|
|
1946
2145
|
* - Current company ID for current company
|
|
1947
2146
|
* stores only. Don't send in case cross-selling (franchise) is enabled.
|
|
@@ -1956,9 +2155,9 @@ type StoreByBrandsRequestSchema = {
|
|
|
1956
2155
|
*/
|
|
1957
2156
|
search_text?: string;
|
|
1958
2157
|
};
|
|
1959
|
-
/** @returns {
|
|
1960
|
-
declare function
|
|
1961
|
-
type
|
|
2158
|
+
/** @returns {StoreByBrandsResponse} */
|
|
2159
|
+
declare function StoreByBrandsResponse(): StoreByBrandsResponse;
|
|
2160
|
+
type StoreByBrandsResponse = {
|
|
1962
2161
|
items?: BrandStoreInfo[];
|
|
1963
2162
|
page?: Page;
|
|
1964
2163
|
};
|
|
@@ -2011,18 +2210,22 @@ type CompanyBrandInfo = {
|
|
|
2011
2210
|
*/
|
|
2012
2211
|
brand_banner_portrait_url?: string;
|
|
2013
2212
|
};
|
|
2014
|
-
/** @returns {
|
|
2015
|
-
declare function
|
|
2016
|
-
type
|
|
2213
|
+
/** @returns {BrandsByCompanyResponse} */
|
|
2214
|
+
declare function BrandsByCompanyResponse(): BrandsByCompanyResponse;
|
|
2215
|
+
type BrandsByCompanyResponse = {
|
|
2017
2216
|
brands?: CompanyBrandInfo[];
|
|
2018
2217
|
};
|
|
2019
|
-
/** @returns {
|
|
2020
|
-
declare function
|
|
2021
|
-
type
|
|
2218
|
+
/** @returns {ValidationFailedResponse} */
|
|
2219
|
+
declare function ValidationFailedResponse(): ValidationFailedResponse;
|
|
2220
|
+
type ValidationFailedResponse = {
|
|
2022
2221
|
/**
|
|
2023
2222
|
* - Response message for failed validation
|
|
2024
2223
|
*/
|
|
2025
2224
|
message?: string;
|
|
2225
|
+
/**
|
|
2226
|
+
* - Response message for failed validation
|
|
2227
|
+
*/
|
|
2228
|
+
errors?: any[];
|
|
2026
2229
|
};
|
|
2027
2230
|
/** @returns {NotFound} */
|
|
2028
2231
|
declare function NotFound(): NotFound;
|
|
@@ -2031,6 +2234,14 @@ type NotFound = {
|
|
|
2031
2234
|
* - Response message for not found
|
|
2032
2235
|
*/
|
|
2033
2236
|
message?: string;
|
|
2237
|
+
/**
|
|
2238
|
+
* - Error message for not found
|
|
2239
|
+
*/
|
|
2240
|
+
error?: string;
|
|
2241
|
+
/**
|
|
2242
|
+
* - Unique code for each error
|
|
2243
|
+
*/
|
|
2244
|
+
code?: string;
|
|
2034
2245
|
/**
|
|
2035
2246
|
* - Flag for required not successfull.
|
|
2036
2247
|
*/
|
|
@@ -2069,22 +2280,22 @@ type PanCardConfig = {
|
|
|
2069
2280
|
*/
|
|
2070
2281
|
online_threshold_amount?: number;
|
|
2071
2282
|
};
|
|
2072
|
-
/** @returns {
|
|
2073
|
-
declare function
|
|
2074
|
-
type
|
|
2283
|
+
/** @returns {CreateApplicationRequest} */
|
|
2284
|
+
declare function CreateApplicationRequest(): CreateApplicationRequest;
|
|
2285
|
+
type CreateApplicationRequest = {
|
|
2075
2286
|
app?: App;
|
|
2076
2287
|
configuration?: ApplicationInventory;
|
|
2077
2288
|
domain?: AppDomain;
|
|
2078
2289
|
};
|
|
2079
|
-
/** @returns {
|
|
2080
|
-
declare function
|
|
2081
|
-
type
|
|
2290
|
+
/** @returns {CreateAppResponse} */
|
|
2291
|
+
declare function CreateAppResponse(): CreateAppResponse;
|
|
2292
|
+
type CreateAppResponse = {
|
|
2082
2293
|
app?: Application;
|
|
2083
2294
|
configuration?: ApplicationInventory;
|
|
2084
2295
|
};
|
|
2085
|
-
/** @returns {
|
|
2086
|
-
declare function
|
|
2087
|
-
type
|
|
2296
|
+
/** @returns {ApplicationsResponse} */
|
|
2297
|
+
declare function ApplicationsResponse(): ApplicationsResponse;
|
|
2298
|
+
type ApplicationsResponse = {
|
|
2088
2299
|
items?: Application[];
|
|
2089
2300
|
page?: Page;
|
|
2090
2301
|
};
|
|
@@ -2159,9 +2370,9 @@ type SplashImage = {
|
|
|
2159
2370
|
*/
|
|
2160
2371
|
secure_url?: string;
|
|
2161
2372
|
};
|
|
2162
|
-
/** @returns {
|
|
2163
|
-
declare function
|
|
2164
|
-
type
|
|
2373
|
+
/** @returns {MobileAppConfigRequest} */
|
|
2374
|
+
declare function MobileAppConfigRequest(): MobileAppConfigRequest;
|
|
2375
|
+
type MobileAppConfigRequest = {
|
|
2165
2376
|
/**
|
|
2166
2377
|
* - Name of the mobile app
|
|
2167
2378
|
*/
|
|
@@ -2303,9 +2514,9 @@ type DomainAdd = {
|
|
|
2303
2514
|
message?: string;
|
|
2304
2515
|
txt_records?: string[];
|
|
2305
2516
|
};
|
|
2306
|
-
/** @returns {
|
|
2307
|
-
declare function
|
|
2308
|
-
type
|
|
2517
|
+
/** @returns {DomainAddRequest} */
|
|
2518
|
+
declare function DomainAddRequest(): DomainAddRequest;
|
|
2519
|
+
type DomainAddRequest = {
|
|
2309
2520
|
domain?: DomainAdd;
|
|
2310
2521
|
};
|
|
2311
2522
|
/** @returns {Domain} */
|
|
@@ -2340,9 +2551,9 @@ type Domain = {
|
|
|
2340
2551
|
is_predefined?: boolean;
|
|
2341
2552
|
message?: string;
|
|
2342
2553
|
};
|
|
2343
|
-
/** @returns {
|
|
2344
|
-
declare function
|
|
2345
|
-
type
|
|
2554
|
+
/** @returns {DomainsResponse} */
|
|
2555
|
+
declare function DomainsResponse(): DomainsResponse;
|
|
2556
|
+
type DomainsResponse = {
|
|
2346
2557
|
domains?: Domain[];
|
|
2347
2558
|
};
|
|
2348
2559
|
/** @returns {UpdateDomain} */
|
|
@@ -2373,9 +2584,9 @@ type UpdateDomain = {
|
|
|
2373
2584
|
*/
|
|
2374
2585
|
is_shortlink?: boolean;
|
|
2375
2586
|
};
|
|
2376
|
-
/** @returns {
|
|
2377
|
-
declare function
|
|
2378
|
-
type
|
|
2587
|
+
/** @returns {UpdateDomainTypeRequest} */
|
|
2588
|
+
declare function UpdateDomainTypeRequest(): UpdateDomainTypeRequest;
|
|
2589
|
+
type UpdateDomainTypeRequest = {
|
|
2379
2590
|
domain?: UpdateDomain;
|
|
2380
2591
|
/**
|
|
2381
2592
|
* - Shows domain is made primary domain for the
|
|
@@ -2383,9 +2594,9 @@ type UpdateDomainTypeRequestSchema = {
|
|
|
2383
2594
|
*/
|
|
2384
2595
|
action?: string;
|
|
2385
2596
|
};
|
|
2386
|
-
/** @returns {
|
|
2387
|
-
declare function
|
|
2388
|
-
type
|
|
2597
|
+
/** @returns {DomainStatusRequest} */
|
|
2598
|
+
declare function DomainStatusRequest(): DomainStatusRequest;
|
|
2599
|
+
type DomainStatusRequest = {
|
|
2389
2600
|
/**
|
|
2390
2601
|
* - URL of the domain, e.g. uniket.hostx0.de
|
|
2391
2602
|
*/
|
|
@@ -2404,9 +2615,9 @@ type DomainStatus = {
|
|
|
2404
2615
|
*/
|
|
2405
2616
|
status?: boolean;
|
|
2406
2617
|
};
|
|
2407
|
-
/** @returns {
|
|
2408
|
-
declare function
|
|
2409
|
-
type
|
|
2618
|
+
/** @returns {DomainStatusResponse} */
|
|
2619
|
+
declare function DomainStatusResponse(): DomainStatusResponse;
|
|
2620
|
+
type DomainStatusResponse = {
|
|
2410
2621
|
/**
|
|
2411
2622
|
* - Check if domain is live and mapped to
|
|
2412
2623
|
* appropriate IP of Fynd Servers
|
|
@@ -2414,18 +2625,13 @@ type DomainStatusResponseSchema = {
|
|
|
2414
2625
|
connected?: boolean;
|
|
2415
2626
|
status?: DomainStatus[];
|
|
2416
2627
|
};
|
|
2417
|
-
/** @returns {
|
|
2418
|
-
declare function
|
|
2419
|
-
type
|
|
2628
|
+
/** @returns {DomainSuggestionsRequest} */
|
|
2629
|
+
declare function DomainSuggestionsRequest(): DomainSuggestionsRequest;
|
|
2630
|
+
type DomainSuggestionsRequest = {
|
|
2420
2631
|
/**
|
|
2421
2632
|
* - Domain url
|
|
2422
2633
|
*/
|
|
2423
2634
|
domain_url?: string;
|
|
2424
|
-
/**
|
|
2425
|
-
* - Get suggestions for custom domains or
|
|
2426
|
-
* Fynd domains
|
|
2427
|
-
*/
|
|
2428
|
-
custom_domain?: boolean;
|
|
2429
2635
|
};
|
|
2430
2636
|
/** @returns {DomainSuggestion} */
|
|
2431
2637
|
declare function DomainSuggestion(): DomainSuggestion;
|
|
@@ -2453,17 +2659,17 @@ type DomainSuggestion = {
|
|
|
2453
2659
|
*/
|
|
2454
2660
|
currency?: string;
|
|
2455
2661
|
};
|
|
2456
|
-
/** @returns {
|
|
2457
|
-
declare function
|
|
2458
|
-
type
|
|
2662
|
+
/** @returns {DomainSuggestionsResponse} */
|
|
2663
|
+
declare function DomainSuggestionsResponse(): DomainSuggestionsResponse;
|
|
2664
|
+
type DomainSuggestionsResponse = {
|
|
2459
2665
|
/**
|
|
2460
2666
|
* - Domain URL
|
|
2461
2667
|
*/
|
|
2462
2668
|
domains?: DomainSuggestion[];
|
|
2463
2669
|
};
|
|
2464
|
-
/** @returns {
|
|
2465
|
-
declare function
|
|
2466
|
-
type
|
|
2670
|
+
/** @returns {SuccessMessageResponse} */
|
|
2671
|
+
declare function SuccessMessageResponse(): SuccessMessageResponse;
|
|
2672
|
+
type SuccessMessageResponse = {
|
|
2467
2673
|
/**
|
|
2468
2674
|
* - Shows whether domain was deleted successfully
|
|
2469
2675
|
*/
|
|
@@ -2473,74 +2679,474 @@ type SuccessMessageResponseSchema = {
|
|
|
2473
2679
|
*/
|
|
2474
2680
|
message?: string;
|
|
2475
2681
|
};
|
|
2476
|
-
/** @returns {
|
|
2477
|
-
declare function
|
|
2478
|
-
type
|
|
2682
|
+
/** @returns {GetIntegrationsOptInsResponse} */
|
|
2683
|
+
declare function GetIntegrationsOptInsResponse(): GetIntegrationsOptInsResponse;
|
|
2684
|
+
type GetIntegrationsOptInsResponse = {
|
|
2685
|
+
items?: IntegrationOptIn[];
|
|
2686
|
+
page?: Page;
|
|
2687
|
+
};
|
|
2688
|
+
/** @returns {IntegrationOptIn} */
|
|
2689
|
+
declare function IntegrationOptIn(): IntegrationOptIn;
|
|
2690
|
+
type IntegrationOptIn = {
|
|
2691
|
+
validators?: Validators;
|
|
2479
2692
|
/**
|
|
2480
|
-
* -
|
|
2481
|
-
* on Fynd Platform.
|
|
2693
|
+
* - Basic description about the opted integration
|
|
2482
2694
|
*/
|
|
2483
|
-
|
|
2695
|
+
description?: string;
|
|
2484
2696
|
/**
|
|
2485
|
-
* -
|
|
2486
|
-
*
|
|
2697
|
+
* - Basic HTML description about the
|
|
2698
|
+
* opted integration
|
|
2487
2699
|
*/
|
|
2488
|
-
|
|
2489
|
-
|
|
2700
|
+
description_html?: string;
|
|
2701
|
+
constants?: string;
|
|
2702
|
+
companies?: string[];
|
|
2703
|
+
support?: string[];
|
|
2490
2704
|
/**
|
|
2491
|
-
* -
|
|
2705
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
2706
|
+
* of the opted integration
|
|
2492
2707
|
*/
|
|
2493
|
-
|
|
2708
|
+
_id?: string;
|
|
2494
2709
|
/**
|
|
2495
|
-
* -
|
|
2710
|
+
* - Nmae of the opted integration, e.g. SAP RBL Integration
|
|
2496
2711
|
*/
|
|
2497
|
-
|
|
2498
|
-
};
|
|
2499
|
-
/** @returns {AppDomain} */
|
|
2500
|
-
declare function AppDomain(): AppDomain;
|
|
2501
|
-
type AppDomain = {
|
|
2712
|
+
name?: string;
|
|
2502
2713
|
/**
|
|
2503
|
-
* -
|
|
2714
|
+
* - Slug of the opted integration, e.g. ginesys
|
|
2504
2715
|
*/
|
|
2505
|
-
|
|
2506
|
-
|
|
2507
|
-
|
|
2508
|
-
declare function CompaniesResponseSchema(): CompaniesResponseSchema;
|
|
2509
|
-
type CompaniesResponseSchema = {
|
|
2510
|
-
items?: AppInventoryCompanies[];
|
|
2511
|
-
page?: Page;
|
|
2512
|
-
};
|
|
2513
|
-
/** @returns {AppInventoryCompanies} */
|
|
2514
|
-
declare function AppInventoryCompanies(): AppInventoryCompanies;
|
|
2515
|
-
type AppInventoryCompanies = {
|
|
2716
|
+
slug?: string;
|
|
2717
|
+
hidden?: boolean;
|
|
2718
|
+
meta?: IntegrationMeta[];
|
|
2516
2719
|
/**
|
|
2517
|
-
* -
|
|
2720
|
+
* - Hosted URL of the icon image
|
|
2518
2721
|
*/
|
|
2519
|
-
|
|
2722
|
+
icon?: string;
|
|
2520
2723
|
/**
|
|
2521
|
-
* -
|
|
2724
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
2725
|
+
* of the user who created the integration
|
|
2522
2726
|
*/
|
|
2523
|
-
|
|
2727
|
+
owner?: string;
|
|
2524
2728
|
/**
|
|
2525
|
-
* -
|
|
2526
|
-
* franchisee, distributor, etc.
|
|
2729
|
+
* - ISO 8601 timestamp of integration creation
|
|
2527
2730
|
*/
|
|
2528
|
-
|
|
2529
|
-
};
|
|
2530
|
-
/** @returns {StoresResponseSchema} */
|
|
2531
|
-
declare function StoresResponseSchema(): StoresResponseSchema;
|
|
2532
|
-
type StoresResponseSchema = {
|
|
2533
|
-
items?: AppInventoryStores[];
|
|
2534
|
-
page?: Page;
|
|
2535
|
-
};
|
|
2536
|
-
/** @returns {AppInventoryStores} */
|
|
2537
|
-
declare function AppInventoryStores(): AppInventoryStores;
|
|
2538
|
-
type AppInventoryStores = {
|
|
2731
|
+
created_at?: string;
|
|
2539
2732
|
/**
|
|
2540
|
-
* -
|
|
2541
|
-
* Object ID) in the sales channel inventory
|
|
2733
|
+
* - ISO 8601 timestamp of integration updation
|
|
2542
2734
|
*/
|
|
2543
|
-
|
|
2735
|
+
modified_at?: string;
|
|
2736
|
+
/**
|
|
2737
|
+
* - Randomly generated fixed-length string for opted
|
|
2738
|
+
* integration. It is auto-generated. It would never change once it is generated.
|
|
2739
|
+
*/
|
|
2740
|
+
token?: string;
|
|
2741
|
+
/**
|
|
2742
|
+
* - Randomly generated fixed-length string for
|
|
2743
|
+
* opted integration. It is auto-generated. It would never change once it is generated.
|
|
2744
|
+
*/
|
|
2745
|
+
secret?: string;
|
|
2746
|
+
/**
|
|
2747
|
+
* - Version key for tracking revisions. Default value is zero.
|
|
2748
|
+
*/
|
|
2749
|
+
__v?: number;
|
|
2750
|
+
};
|
|
2751
|
+
/** @returns {Validators} */
|
|
2752
|
+
declare function Validators(): Validators;
|
|
2753
|
+
type Validators = {
|
|
2754
|
+
company?: CompanyValidator;
|
|
2755
|
+
store?: StoreValidator;
|
|
2756
|
+
inventory?: InventoryValidator;
|
|
2757
|
+
order?: OrderValidator;
|
|
2758
|
+
};
|
|
2759
|
+
/** @returns {CompanyValidator} */
|
|
2760
|
+
declare function CompanyValidator(): CompanyValidator;
|
|
2761
|
+
type CompanyValidator = {
|
|
2762
|
+
json_schema?: JsonSchema[];
|
|
2763
|
+
/**
|
|
2764
|
+
* - Browser script for the company validator
|
|
2765
|
+
*/
|
|
2766
|
+
browser_script?: string;
|
|
2767
|
+
};
|
|
2768
|
+
/** @returns {JsonSchema} */
|
|
2769
|
+
declare function JsonSchema(): JsonSchema;
|
|
2770
|
+
type JsonSchema = {
|
|
2771
|
+
/**
|
|
2772
|
+
* - Display text of the validator JSON schema. It
|
|
2773
|
+
* will show in the UI.
|
|
2774
|
+
*/
|
|
2775
|
+
display?: string;
|
|
2776
|
+
/**
|
|
2777
|
+
* - Key related to the display text of the validator JSON schema
|
|
2778
|
+
*/
|
|
2779
|
+
key?: string;
|
|
2780
|
+
/**
|
|
2781
|
+
* - Indicates the type of form field, e.g. Text, Dropdown.
|
|
2782
|
+
*/
|
|
2783
|
+
type?: string;
|
|
2784
|
+
/**
|
|
2785
|
+
* - Tooltip text for the UI of the validator JSON
|
|
2786
|
+
* schema. It will show in the UI.
|
|
2787
|
+
*/
|
|
2788
|
+
tooltip?: string;
|
|
2789
|
+
};
|
|
2790
|
+
/** @returns {StoreValidator} */
|
|
2791
|
+
declare function StoreValidator(): StoreValidator;
|
|
2792
|
+
type StoreValidator = {
|
|
2793
|
+
json_schema?: JsonSchema[];
|
|
2794
|
+
/**
|
|
2795
|
+
* - Browser script for the store validator
|
|
2796
|
+
*/
|
|
2797
|
+
browser_script?: string;
|
|
2798
|
+
};
|
|
2799
|
+
/** @returns {InventoryValidator} */
|
|
2800
|
+
declare function InventoryValidator(): InventoryValidator;
|
|
2801
|
+
type InventoryValidator = {
|
|
2802
|
+
json_schema?: JsonSchema[];
|
|
2803
|
+
/**
|
|
2804
|
+
* - Browser script for the inventory validator
|
|
2805
|
+
*/
|
|
2806
|
+
browser_script?: string;
|
|
2807
|
+
};
|
|
2808
|
+
/** @returns {OrderValidator} */
|
|
2809
|
+
declare function OrderValidator(): OrderValidator;
|
|
2810
|
+
type OrderValidator = {
|
|
2811
|
+
json_schema?: JsonSchema[];
|
|
2812
|
+
/**
|
|
2813
|
+
* - Browser script for the order validator
|
|
2814
|
+
*/
|
|
2815
|
+
browser_script?: string;
|
|
2816
|
+
};
|
|
2817
|
+
/** @returns {IntegrationMeta} */
|
|
2818
|
+
declare function IntegrationMeta(): IntegrationMeta;
|
|
2819
|
+
type IntegrationMeta = {
|
|
2820
|
+
is_public?: boolean;
|
|
2821
|
+
/**
|
|
2822
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
2823
|
+
* of the integration meta
|
|
2824
|
+
*/
|
|
2825
|
+
_id?: string;
|
|
2826
|
+
/**
|
|
2827
|
+
* - Nmae of integration meta, e.g. price_level
|
|
2828
|
+
*/
|
|
2829
|
+
name?: string;
|
|
2830
|
+
/**
|
|
2831
|
+
* - Value related to integration meta name, e.g. store
|
|
2832
|
+
*/
|
|
2833
|
+
value?: string;
|
|
2834
|
+
};
|
|
2835
|
+
/** @returns {Integration} */
|
|
2836
|
+
declare function Integration(): Integration;
|
|
2837
|
+
type Integration = {
|
|
2838
|
+
validators?: Validators;
|
|
2839
|
+
/**
|
|
2840
|
+
* - Basic description about the integration
|
|
2841
|
+
*/
|
|
2842
|
+
description?: string;
|
|
2843
|
+
/**
|
|
2844
|
+
* - Basic HTML description about the integration
|
|
2845
|
+
*/
|
|
2846
|
+
description_html?: string;
|
|
2847
|
+
constants?: any;
|
|
2848
|
+
companies?: string[];
|
|
2849
|
+
support?: string[];
|
|
2850
|
+
/**
|
|
2851
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
2852
|
+
* of the integration
|
|
2853
|
+
*/
|
|
2854
|
+
_id?: string;
|
|
2855
|
+
/**
|
|
2856
|
+
* - Name of the integration, e.g. SAP RBL Integration
|
|
2857
|
+
*/
|
|
2858
|
+
name?: string;
|
|
2859
|
+
/**
|
|
2860
|
+
* - Name of the integration, e.g. SAP RBL Integration
|
|
2861
|
+
*/
|
|
2862
|
+
slug?: string;
|
|
2863
|
+
meta?: IntegrationMeta[];
|
|
2864
|
+
/**
|
|
2865
|
+
* - Hosted URL of the icon image
|
|
2866
|
+
*/
|
|
2867
|
+
icon?: string;
|
|
2868
|
+
hidden?: boolean;
|
|
2869
|
+
/**
|
|
2870
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
2871
|
+
* of the user who created the integration
|
|
2872
|
+
*/
|
|
2873
|
+
owner?: string;
|
|
2874
|
+
/**
|
|
2875
|
+
* - ISO 8601 timestamp of integration creation
|
|
2876
|
+
*/
|
|
2877
|
+
created_at?: string;
|
|
2878
|
+
/**
|
|
2879
|
+
* - ISO 8601 timestamp of integration updation
|
|
2880
|
+
*/
|
|
2881
|
+
modified_at?: string;
|
|
2882
|
+
/**
|
|
2883
|
+
* - Randomly generated fixed-length string for opted
|
|
2884
|
+
* integration. It is auto-generated. It would never change once it is generated.
|
|
2885
|
+
*/
|
|
2886
|
+
token?: string;
|
|
2887
|
+
/**
|
|
2888
|
+
* - Randomly generated fixed-length string for
|
|
2889
|
+
* opted integration. It is auto-generated. It would never change once it is generated.
|
|
2890
|
+
*/
|
|
2891
|
+
secret?: string;
|
|
2892
|
+
/**
|
|
2893
|
+
* - Version key for tracking revisions. Default value is zero.
|
|
2894
|
+
*/
|
|
2895
|
+
__v?: number;
|
|
2896
|
+
};
|
|
2897
|
+
/** @returns {IntegrationConfigResponse} */
|
|
2898
|
+
declare function IntegrationConfigResponse(): IntegrationConfigResponse;
|
|
2899
|
+
type IntegrationConfigResponse = {
|
|
2900
|
+
items?: IntegrationLevel[];
|
|
2901
|
+
};
|
|
2902
|
+
/** @returns {IntegrationLevel} */
|
|
2903
|
+
declare function IntegrationLevel(): IntegrationLevel;
|
|
2904
|
+
type IntegrationLevel = {
|
|
2905
|
+
/**
|
|
2906
|
+
* - Shows this integration is opted or not opted
|
|
2907
|
+
* for the current company
|
|
2908
|
+
*/
|
|
2909
|
+
opted?: boolean;
|
|
2910
|
+
permissions?: any[];
|
|
2911
|
+
last_patch?: LastPatch[];
|
|
2912
|
+
/**
|
|
2913
|
+
* - The unique identifier (24-digit Mongo Object ID)
|
|
2914
|
+
* of the integration config
|
|
2915
|
+
*/
|
|
2916
|
+
_id?: string;
|
|
2917
|
+
/**
|
|
2918
|
+
* - Integration id. Shows which integration
|
|
2919
|
+
* you are enabling.
|
|
2920
|
+
*/
|
|
2921
|
+
integration?: string;
|
|
2922
|
+
/**
|
|
2923
|
+
* - Shows for what level the integration is set up.
|
|
2924
|
+
* It can be company level or store level.
|
|
2925
|
+
*/
|
|
2926
|
+
level?: string;
|
|
2927
|
+
/**
|
|
2928
|
+
* - It can be store uid or company uid. Depends on the
|
|
2929
|
+
* level of integration.
|
|
2930
|
+
*/
|
|
2931
|
+
uid?: number;
|
|
2932
|
+
/**
|
|
2933
|
+
* - Unique id of company.
|
|
2934
|
+
*/
|
|
2935
|
+
company_id?: number;
|
|
2936
|
+
meta?: IntegrationMeta[];
|
|
2937
|
+
/**
|
|
2938
|
+
* - Randomly generated fixed-length string for opted
|
|
2939
|
+
* integration. It is auto-generated. It would never change once it is generated.
|
|
2940
|
+
*/
|
|
2941
|
+
token?: string;
|
|
2942
|
+
/**
|
|
2943
|
+
* - ISO 8601 timestamp of integration config creation
|
|
2944
|
+
*/
|
|
2945
|
+
created_at?: string;
|
|
2946
|
+
/**
|
|
2947
|
+
* - ISO 8601 timestamp of integration config updation
|
|
2948
|
+
*/
|
|
2949
|
+
modified_at?: string;
|
|
2950
|
+
/**
|
|
2951
|
+
* - Version key for tracking revisions. Default value is zero.
|
|
2952
|
+
*/
|
|
2953
|
+
__v?: number;
|
|
2954
|
+
/**
|
|
2955
|
+
* - Schema data of the integration stored in key-value pairs
|
|
2956
|
+
*/
|
|
2957
|
+
data?: any;
|
|
2958
|
+
success?: boolean;
|
|
2959
|
+
message?: string;
|
|
2960
|
+
};
|
|
2961
|
+
/** @returns {UpdateIntegrationLevelRequest} */
|
|
2962
|
+
declare function UpdateIntegrationLevelRequest(): UpdateIntegrationLevelRequest;
|
|
2963
|
+
type UpdateIntegrationLevelRequest = {
|
|
2964
|
+
items?: IntegrationLevel[];
|
|
2965
|
+
};
|
|
2966
|
+
/** @returns {OptedStoreIntegration} */
|
|
2967
|
+
declare function OptedStoreIntegration(): OptedStoreIntegration;
|
|
2968
|
+
type OptedStoreIntegration = {
|
|
2969
|
+
/**
|
|
2970
|
+
* - Allow user to opt same store in other integration
|
|
2971
|
+
*/
|
|
2972
|
+
other_opted?: boolean;
|
|
2973
|
+
other_integration?: IntegrationOptIn;
|
|
2974
|
+
other_entity?: OtherEntity;
|
|
2975
|
+
};
|
|
2976
|
+
/** @returns {OtherEntity} */
|
|
2977
|
+
declare function OtherEntity(): OtherEntity;
|
|
2978
|
+
type OtherEntity = {
|
|
2979
|
+
/**
|
|
2980
|
+
* - Allow other entity opted in integration
|
|
2981
|
+
*/
|
|
2982
|
+
opted?: boolean;
|
|
2983
|
+
permissions?: string[];
|
|
2984
|
+
last_patch?: LastPatch[];
|
|
2985
|
+
/**
|
|
2986
|
+
* - The unique identifier of the other entity for
|
|
2987
|
+
* opted store integration
|
|
2988
|
+
*/
|
|
2989
|
+
_id?: string;
|
|
2990
|
+
/**
|
|
2991
|
+
* - Integration ID. Shows which integration
|
|
2992
|
+
* you are enabling.
|
|
2993
|
+
*/
|
|
2994
|
+
integration?: string;
|
|
2995
|
+
/**
|
|
2996
|
+
* - Indicates integration level. It can be company
|
|
2997
|
+
* level or store level.
|
|
2998
|
+
*/
|
|
2999
|
+
level?: string;
|
|
3000
|
+
/**
|
|
3001
|
+
* - It can be store uid or company uid. Depends on the
|
|
3002
|
+
* level of integration.
|
|
3003
|
+
*/
|
|
3004
|
+
uid?: number;
|
|
3005
|
+
data?: OtherEntityData;
|
|
3006
|
+
meta?: any[];
|
|
3007
|
+
/**
|
|
3008
|
+
* - Randomly generated fixed-length string for opted
|
|
3009
|
+
* integration. It is auto-generated. It would never change once it is generated.
|
|
3010
|
+
*/
|
|
3011
|
+
token?: string;
|
|
3012
|
+
/**
|
|
3013
|
+
* - ISO 8601 timestamp of other entity creation
|
|
3014
|
+
* for opted store integration
|
|
3015
|
+
*/
|
|
3016
|
+
created_at?: string;
|
|
3017
|
+
/**
|
|
3018
|
+
* - ISO 8601 timestamp of other entity
|
|
3019
|
+
* updation for opted store integration
|
|
3020
|
+
*/
|
|
3021
|
+
modified_at?: string;
|
|
3022
|
+
/**
|
|
3023
|
+
* - Version key for tracking revisions. Default value is zero.
|
|
3024
|
+
*/
|
|
3025
|
+
__v?: number;
|
|
3026
|
+
};
|
|
3027
|
+
/** @returns {LastPatch} */
|
|
3028
|
+
declare function LastPatch(): LastPatch;
|
|
3029
|
+
type LastPatch = {
|
|
3030
|
+
op?: string;
|
|
3031
|
+
path?: string;
|
|
3032
|
+
/**
|
|
3033
|
+
* - It can be inventory level or order level
|
|
3034
|
+
*/
|
|
3035
|
+
value?: string;
|
|
3036
|
+
};
|
|
3037
|
+
/** @returns {OtherEntityData} */
|
|
3038
|
+
declare function OtherEntityData(): OtherEntityData;
|
|
3039
|
+
type OtherEntityData = {
|
|
3040
|
+
article_identifier?: string;
|
|
3041
|
+
};
|
|
3042
|
+
/** @returns {App} */
|
|
3043
|
+
declare function App(): App;
|
|
3044
|
+
type App = {
|
|
3045
|
+
/**
|
|
3046
|
+
* - Numeric ID allotted to a business account
|
|
3047
|
+
* on Fynd Platform.
|
|
3048
|
+
*/
|
|
3049
|
+
company_id?: string;
|
|
3050
|
+
/**
|
|
3051
|
+
* - It indicates different channel types like
|
|
3052
|
+
* store, website-and-mobile-apps. Default value is store
|
|
3053
|
+
*/
|
|
3054
|
+
channel_type?: string;
|
|
3055
|
+
auth?: ApplicationAuth;
|
|
3056
|
+
/**
|
|
3057
|
+
* - User-friendly name for sales channel, e.g. Zenz Fashion
|
|
3058
|
+
*/
|
|
3059
|
+
name?: string;
|
|
3060
|
+
/**
|
|
3061
|
+
* - Detailed description about the sales channel
|
|
3062
|
+
*/
|
|
3063
|
+
desc?: string;
|
|
3064
|
+
};
|
|
3065
|
+
/** @returns {InventoryConfig} */
|
|
3066
|
+
declare function InventoryConfig(): InventoryConfig;
|
|
3067
|
+
type InventoryConfig = {
|
|
3068
|
+
brand?: InventoryBrandRule;
|
|
3069
|
+
store?: InventoryStoreRule;
|
|
3070
|
+
image?: string[];
|
|
3071
|
+
/**
|
|
3072
|
+
* - Allow other businesses (companies)
|
|
3073
|
+
* to consume the current sales channel's inventory and sell products
|
|
3074
|
+
*/
|
|
3075
|
+
franchise_enabled?: boolean;
|
|
3076
|
+
/**
|
|
3077
|
+
* - Indicates whether out of stock products
|
|
3078
|
+
* are allowed to show up on the website.
|
|
3079
|
+
*/
|
|
3080
|
+
out_of_stock?: boolean;
|
|
3081
|
+
/**
|
|
3082
|
+
* - Show only verified products
|
|
3083
|
+
* (the ones whose data have been verified by the admin)
|
|
3084
|
+
*/
|
|
3085
|
+
only_verified_products?: boolean;
|
|
3086
|
+
pricing_strategy?: PricingStrategy;
|
|
3087
|
+
};
|
|
3088
|
+
/** @returns {AppInventory} */
|
|
3089
|
+
declare function AppInventory(): AppInventory;
|
|
3090
|
+
type AppInventory = {
|
|
3091
|
+
inventory?: InventoryConfig;
|
|
3092
|
+
payment?: InventoryPaymentConfig;
|
|
3093
|
+
article_assignment?: InventoryArticleAssignment;
|
|
3094
|
+
};
|
|
3095
|
+
/** @returns {AppDomain} */
|
|
3096
|
+
declare function AppDomain(): AppDomain;
|
|
3097
|
+
type AppDomain = {
|
|
3098
|
+
/**
|
|
3099
|
+
* - Domain URL of current sales channel, e.g. zenz.com
|
|
3100
|
+
*/
|
|
3101
|
+
name?: string;
|
|
3102
|
+
};
|
|
3103
|
+
/** @returns {CompaniesResponse} */
|
|
3104
|
+
declare function CompaniesResponse(): CompaniesResponse;
|
|
3105
|
+
type CompaniesResponse = {
|
|
3106
|
+
items?: AppInventoryCompanies[];
|
|
3107
|
+
page?: Page;
|
|
3108
|
+
};
|
|
3109
|
+
/** @returns {AppInventoryCompanies} */
|
|
3110
|
+
declare function AppInventoryCompanies(): AppInventoryCompanies;
|
|
3111
|
+
type AppInventoryCompanies = {
|
|
3112
|
+
/**
|
|
3113
|
+
* - UID of the company, e.g. 108
|
|
3114
|
+
*/
|
|
3115
|
+
uid?: number;
|
|
3116
|
+
/**
|
|
3117
|
+
* - Name of the company, e.g. Newton Traders
|
|
3118
|
+
*/
|
|
3119
|
+
name?: string;
|
|
3120
|
+
/**
|
|
3121
|
+
* - Indicates the type of the company, e.g.
|
|
3122
|
+
* franchisee, distributor, etc.
|
|
3123
|
+
*/
|
|
3124
|
+
company_type?: string;
|
|
3125
|
+
};
|
|
3126
|
+
/** @returns {StoresResponse} */
|
|
3127
|
+
declare function StoresResponse(): StoresResponse;
|
|
3128
|
+
type StoresResponse = {
|
|
3129
|
+
items?: AppInventoryStores[];
|
|
3130
|
+
page?: Page;
|
|
3131
|
+
};
|
|
3132
|
+
/** @returns {ListStoreResponse} */
|
|
3133
|
+
declare function ListStoreResponse(): ListStoreResponse;
|
|
3134
|
+
type ListStoreResponse = {
|
|
3135
|
+
stores?: AppInventoryStores[];
|
|
3136
|
+
};
|
|
3137
|
+
/** @returns {ArrayStoreResponse} */
|
|
3138
|
+
declare function ArrayStoreResponse(): ArrayStoreResponse;
|
|
3139
|
+
type ArrayStoreResponse = {
|
|
3140
|
+
data?: AppInventoryStores[];
|
|
3141
|
+
};
|
|
3142
|
+
/** @returns {AppInventoryStores} */
|
|
3143
|
+
declare function AppInventoryStores(): AppInventoryStores;
|
|
3144
|
+
type AppInventoryStores = {
|
|
3145
|
+
/**
|
|
3146
|
+
* - The unique identifier of the store (24-digit Mongo
|
|
3147
|
+
* Object ID) in the sales channel inventory
|
|
3148
|
+
*/
|
|
3149
|
+
_id?: string;
|
|
2544
3150
|
/**
|
|
2545
3151
|
* - ISO 8601 timestamp of last known updation
|
|
2546
3152
|
* to the stores in sales channel inventory
|
|
@@ -2578,9 +3184,9 @@ type AppInventoryStores = {
|
|
|
2578
3184
|
address?: any;
|
|
2579
3185
|
integration_type?: any;
|
|
2580
3186
|
};
|
|
2581
|
-
/** @returns {
|
|
2582
|
-
declare function
|
|
2583
|
-
type
|
|
3187
|
+
/** @returns {FilterOrderingStoreRequest} */
|
|
3188
|
+
declare function FilterOrderingStoreRequest(): FilterOrderingStoreRequest;
|
|
3189
|
+
type FilterOrderingStoreRequest = {
|
|
2584
3190
|
/**
|
|
2585
3191
|
* - Allow all stores from the ordering stores
|
|
2586
3192
|
*/
|
|
@@ -2626,9 +3232,9 @@ declare function OrderingStoreConfig(): OrderingStoreConfig;
|
|
|
2626
3232
|
type OrderingStoreConfig = {
|
|
2627
3233
|
deployment_meta?: DeploymentMeta;
|
|
2628
3234
|
};
|
|
2629
|
-
/** @returns {
|
|
2630
|
-
declare function
|
|
2631
|
-
type
|
|
3235
|
+
/** @returns {OrderingStoreSelectRequest} */
|
|
3236
|
+
declare function OrderingStoreSelectRequest(): OrderingStoreSelectRequest;
|
|
3237
|
+
type OrderingStoreSelectRequest = {
|
|
2632
3238
|
ordering_store: OrderingStoreSelect;
|
|
2633
3239
|
};
|
|
2634
3240
|
/** @returns {OrderingStoreSelect} */
|
|
@@ -2684,9 +3290,9 @@ type OtherSellerApplications = {
|
|
|
2684
3290
|
items?: OtherSellerApplication[];
|
|
2685
3291
|
page?: Page;
|
|
2686
3292
|
};
|
|
2687
|
-
/** @returns {
|
|
2688
|
-
declare function
|
|
2689
|
-
type
|
|
3293
|
+
/** @returns {OptedApplicationResponse} */
|
|
3294
|
+
declare function OptedApplicationResponse(): OptedApplicationResponse;
|
|
3295
|
+
type OptedApplicationResponse = {
|
|
2690
3296
|
/**
|
|
2691
3297
|
* - Name of the other seller's sales channel
|
|
2692
3298
|
*/
|
|
@@ -2798,9 +3404,9 @@ type OptOutInventory = {
|
|
|
2798
3404
|
*/
|
|
2799
3405
|
company: number[];
|
|
2800
3406
|
};
|
|
2801
|
-
/** @returns {
|
|
2802
|
-
declare function
|
|
2803
|
-
type
|
|
3407
|
+
/** @returns {TokenResponse} */
|
|
3408
|
+
declare function TokenResponse(): TokenResponse;
|
|
3409
|
+
type TokenResponse = {
|
|
2804
3410
|
tokens?: Tokens;
|
|
2805
3411
|
/**
|
|
2806
3412
|
* - The unique identifier (24-digit Mongo Object ID)
|
|
@@ -3025,10 +3631,6 @@ type FyndRewardsCredentials = {
|
|
|
3025
3631
|
/** @returns {GoogleMap} */
|
|
3026
3632
|
declare function GoogleMap(): GoogleMap;
|
|
3027
3633
|
type GoogleMap = {
|
|
3028
|
-
/**
|
|
3029
|
-
* - Shows whether Google map integration is enabled or not.
|
|
3030
|
-
*/
|
|
3031
|
-
enabled?: boolean;
|
|
3032
3634
|
credentials?: GoogleMapCredentials;
|
|
3033
3635
|
};
|
|
3034
3636
|
/** @returns {GoogleMapCredentials} */
|
|
@@ -3161,6 +3763,7 @@ type AppFeature = {
|
|
|
3161
3763
|
qr?: QrFeature;
|
|
3162
3764
|
pcr?: PcrFeature;
|
|
3163
3765
|
order?: OrderFeature;
|
|
3766
|
+
buybox?: BuyboxFeature;
|
|
3164
3767
|
/**
|
|
3165
3768
|
* - The unique identifier (24-digit Mongo Object ID)
|
|
3166
3769
|
* for the sales channel features
|
|
@@ -3184,6 +3787,7 @@ type AppFeature = {
|
|
|
3184
3787
|
* - Version key for tracking revisions. Default value is zero
|
|
3185
3788
|
*/
|
|
3186
3789
|
__v?: number;
|
|
3790
|
+
pricing_strategy?: PricingStrategy;
|
|
3187
3791
|
};
|
|
3188
3792
|
/** @returns {HomePageFeature} */
|
|
3189
3793
|
declare function HomePageFeature(): HomePageFeature;
|
|
@@ -3362,14 +3966,34 @@ type OrderFeature = {
|
|
|
3362
3966
|
*/
|
|
3363
3967
|
buy_again?: boolean;
|
|
3364
3968
|
};
|
|
3365
|
-
/** @returns {
|
|
3366
|
-
declare function
|
|
3367
|
-
type
|
|
3969
|
+
/** @returns {BuyboxFeature} */
|
|
3970
|
+
declare function BuyboxFeature(): BuyboxFeature;
|
|
3971
|
+
type BuyboxFeature = {
|
|
3972
|
+
/**
|
|
3973
|
+
* - Allow users to see seller/stores name on
|
|
3974
|
+
* PDP (product detail page).
|
|
3975
|
+
*/
|
|
3976
|
+
show_name?: boolean;
|
|
3977
|
+
/**
|
|
3978
|
+
* - Allow selection of sellers/stores on
|
|
3979
|
+
* PDP (product detail page).
|
|
3980
|
+
*/
|
|
3981
|
+
enable_selection?: boolean;
|
|
3982
|
+
/**
|
|
3983
|
+
* - Toggle buybox listing
|
|
3984
|
+
* between sellers and stores. True indicates seller listing, while False
|
|
3985
|
+
* indicates store listing.
|
|
3986
|
+
*/
|
|
3987
|
+
is_seller_buybox_enabled?: boolean;
|
|
3988
|
+
};
|
|
3989
|
+
/** @returns {AppFeatureRequest} */
|
|
3990
|
+
declare function AppFeatureRequest(): AppFeatureRequest;
|
|
3991
|
+
type AppFeatureRequest = {
|
|
3368
3992
|
feature?: AppFeature;
|
|
3369
3993
|
};
|
|
3370
|
-
/** @returns {
|
|
3371
|
-
declare function
|
|
3372
|
-
type
|
|
3994
|
+
/** @returns {AppFeatureResponse} */
|
|
3995
|
+
declare function AppFeatureResponse(): AppFeatureResponse;
|
|
3996
|
+
type AppFeatureResponse = {
|
|
3373
3997
|
feature?: AppFeature;
|
|
3374
3998
|
};
|
|
3375
3999
|
/** @returns {Currency} */
|
|
@@ -3565,121 +4189,117 @@ type Application = {
|
|
|
3565
4189
|
tokens?: TokenSchema[];
|
|
3566
4190
|
secret?: string;
|
|
3567
4191
|
};
|
|
3568
|
-
/** @returns {
|
|
3569
|
-
declare function
|
|
3570
|
-
type
|
|
3571
|
-
|
|
3572
|
-
|
|
3573
|
-
auth?: ApplicationAuth;
|
|
3574
|
-
/**
|
|
3575
|
-
* - It contains detailed information about the
|
|
3576
|
-
* sales channel.
|
|
3577
|
-
*/
|
|
3578
|
-
description?: string;
|
|
4192
|
+
/** @returns {TokenSchema} */
|
|
4193
|
+
declare function TokenSchema(): TokenSchema;
|
|
4194
|
+
type TokenSchema = {
|
|
4195
|
+
token?: string;
|
|
4196
|
+
created_by?: any;
|
|
3579
4197
|
/**
|
|
3580
|
-
* -
|
|
3581
|
-
* such as store, website, and mobile apps, with 'store' being the default value.
|
|
4198
|
+
* - ISO 8601 timestamp of when token created
|
|
3582
4199
|
*/
|
|
3583
|
-
|
|
4200
|
+
created_at?: string;
|
|
4201
|
+
};
|
|
4202
|
+
/** @returns {InvalidPayloadRequest} */
|
|
4203
|
+
declare function InvalidPayloadRequest(): InvalidPayloadRequest;
|
|
4204
|
+
type InvalidPayloadRequest = {
|
|
3584
4205
|
/**
|
|
3585
|
-
* -
|
|
3586
|
-
* of seconds until the key expires
|
|
4206
|
+
* - Error message when request body payload is improper
|
|
3587
4207
|
*/
|
|
3588
|
-
|
|
4208
|
+
message?: string;
|
|
3589
4209
|
/**
|
|
3590
|
-
* -
|
|
3591
|
-
* internal or not
|
|
4210
|
+
* - Flag for required not successfull.
|
|
3592
4211
|
*/
|
|
3593
|
-
|
|
4212
|
+
success?: boolean;
|
|
3594
4213
|
/**
|
|
3595
|
-
* -
|
|
4214
|
+
* - All errors related to domin
|
|
3596
4215
|
*/
|
|
3597
|
-
|
|
4216
|
+
domain?: any;
|
|
4217
|
+
};
|
|
4218
|
+
/** @returns {InventoryBrandRule} */
|
|
4219
|
+
declare function InventoryBrandRule(): InventoryBrandRule;
|
|
4220
|
+
type InventoryBrandRule = {
|
|
3598
4221
|
/**
|
|
3599
|
-
* -
|
|
3600
|
-
*
|
|
4222
|
+
* - Whether all brands are enabled, or explicitly
|
|
4223
|
+
* few brands in the inventory
|
|
3601
4224
|
*/
|
|
3602
|
-
|
|
4225
|
+
criteria?: string;
|
|
4226
|
+
brands?: number[];
|
|
4227
|
+
};
|
|
4228
|
+
/** @returns {PricingStrategy} */
|
|
4229
|
+
declare function PricingStrategy(): PricingStrategy;
|
|
4230
|
+
type PricingStrategy = {
|
|
3603
4231
|
/**
|
|
3604
|
-
* -
|
|
4232
|
+
* - Indicates the pricing strategy value.
|
|
3605
4233
|
*/
|
|
3606
|
-
|
|
4234
|
+
value?: string;
|
|
4235
|
+
};
|
|
4236
|
+
/** @returns {StoreCriteriaRule} */
|
|
4237
|
+
declare function StoreCriteriaRule(): StoreCriteriaRule;
|
|
4238
|
+
type StoreCriteriaRule = {
|
|
3607
4239
|
/**
|
|
3608
|
-
* -
|
|
3609
|
-
* of owner who owns the application
|
|
4240
|
+
* - List of company UID
|
|
3610
4241
|
*/
|
|
3611
|
-
|
|
4242
|
+
companies?: number[];
|
|
3612
4243
|
/**
|
|
3613
|
-
* -
|
|
3614
|
-
* where the sales channel exists
|
|
4244
|
+
* - List of brand UID
|
|
3615
4245
|
*/
|
|
3616
|
-
|
|
4246
|
+
brands?: number[];
|
|
4247
|
+
};
|
|
4248
|
+
/** @returns {InventoryStoreRule} */
|
|
4249
|
+
declare function InventoryStoreRule(): InventoryStoreRule;
|
|
4250
|
+
type InventoryStoreRule = {
|
|
3617
4251
|
/**
|
|
3618
|
-
* -
|
|
3619
|
-
*
|
|
4252
|
+
* - Whether all stores are enabled, or explicitly
|
|
4253
|
+
* few stores in the inventory, or use brands and company filter.
|
|
3620
4254
|
*/
|
|
3621
|
-
|
|
3622
|
-
redirections?: ApplicationRedirections[];
|
|
3623
|
-
meta?: ApplicationMeta[];
|
|
4255
|
+
criteria?: string;
|
|
3624
4256
|
/**
|
|
3625
|
-
* -
|
|
4257
|
+
* - List of rules with company and
|
|
4258
|
+
* brands uids. Used when critera is `filter`.
|
|
3626
4259
|
*/
|
|
3627
|
-
|
|
4260
|
+
rules?: StoreCriteriaRule[];
|
|
3628
4261
|
/**
|
|
3629
|
-
* -
|
|
4262
|
+
* - List of store uids. Used when critera is `explicit`.
|
|
3630
4263
|
*/
|
|
3631
|
-
|
|
4264
|
+
stores?: number[];
|
|
4265
|
+
};
|
|
4266
|
+
/** @returns {InventoryPaymentConfig} */
|
|
4267
|
+
declare function InventoryPaymentConfig(): InventoryPaymentConfig;
|
|
4268
|
+
type InventoryPaymentConfig = {
|
|
3632
4269
|
/**
|
|
3633
|
-
* -
|
|
4270
|
+
* - Mode of payment for the inventory of
|
|
4271
|
+
* sales channel. It is required and default value is null.
|
|
3634
4272
|
*/
|
|
3635
|
-
|
|
3636
|
-
banner?: SecureUrl;
|
|
3637
|
-
logo?: SecureUrl;
|
|
3638
|
-
favicon?: SecureUrl;
|
|
3639
|
-
domains?: Domain[];
|
|
4273
|
+
mode_of_payment?: string;
|
|
3640
4274
|
/**
|
|
3641
|
-
* -
|
|
4275
|
+
* - Source of the payment mode for the inventory
|
|
4276
|
+
* payment of sales channel. Default value is FYND.
|
|
3642
4277
|
*/
|
|
3643
|
-
|
|
3644
|
-
mobile_logo?: SecureUrl;
|
|
3645
|
-
domain?: Domain;
|
|
3646
|
-
slug?: string;
|
|
3647
|
-
mode?: string;
|
|
3648
|
-
status?: string;
|
|
3649
|
-
tokens?: TokenSchemaID[];
|
|
3650
|
-
secret?: string;
|
|
4278
|
+
source?: string;
|
|
3651
4279
|
};
|
|
3652
|
-
/** @returns {
|
|
3653
|
-
declare function
|
|
3654
|
-
type
|
|
3655
|
-
token?: string;
|
|
3656
|
-
created_by?: string;
|
|
4280
|
+
/** @returns {StorePriorityRule} */
|
|
4281
|
+
declare function StorePriorityRule(): StorePriorityRule;
|
|
4282
|
+
type StorePriorityRule = {
|
|
3657
4283
|
/**
|
|
3658
|
-
* -
|
|
4284
|
+
* - Shows store priority is enabled or not
|
|
4285
|
+
* enabled for the article assignment.
|
|
3659
4286
|
*/
|
|
3660
|
-
|
|
4287
|
+
enabled?: boolean;
|
|
4288
|
+
storetype_order?: string[];
|
|
3661
4289
|
};
|
|
3662
|
-
/** @returns {
|
|
3663
|
-
declare function
|
|
3664
|
-
type
|
|
3665
|
-
|
|
3666
|
-
created_by?: any;
|
|
3667
|
-
/**
|
|
3668
|
-
* - ISO 8601 timestamp of when token created
|
|
3669
|
-
*/
|
|
3670
|
-
created_at?: string;
|
|
4290
|
+
/** @returns {ArticleAssignmentRule} */
|
|
4291
|
+
declare function ArticleAssignmentRule(): ArticleAssignmentRule;
|
|
4292
|
+
type ArticleAssignmentRule = {
|
|
4293
|
+
store_priority?: StorePriorityRule;
|
|
3671
4294
|
};
|
|
3672
|
-
/** @returns {
|
|
3673
|
-
declare function
|
|
3674
|
-
type
|
|
3675
|
-
/**
|
|
3676
|
-
* - Error message when request body payload is improper
|
|
3677
|
-
*/
|
|
3678
|
-
message?: string;
|
|
4295
|
+
/** @returns {InventoryArticleAssignment} */
|
|
4296
|
+
declare function InventoryArticleAssignment(): InventoryArticleAssignment;
|
|
4297
|
+
type InventoryArticleAssignment = {
|
|
3679
4298
|
/**
|
|
3680
|
-
* -
|
|
4299
|
+
* - Allow post order reassigment of article
|
|
3681
4300
|
*/
|
|
3682
|
-
|
|
4301
|
+
post_order_reassignment?: boolean;
|
|
4302
|
+
rules?: ArticleAssignmentRule;
|
|
3683
4303
|
};
|
|
3684
4304
|
/** @returns {Page} */
|
|
3685
4305
|
declare function Page(): Page;
|
|
@@ -3712,6 +4332,10 @@ type Page = {
|
|
|
3712
4332
|
* - The number of items per page.
|
|
3713
4333
|
*/
|
|
3714
4334
|
size?: number;
|
|
4335
|
+
/**
|
|
4336
|
+
* - Total number of items.
|
|
4337
|
+
*/
|
|
4338
|
+
total?: number;
|
|
3715
4339
|
};
|
|
3716
4340
|
/** @returns {ApplicationInformation} */
|
|
3717
4341
|
declare function ApplicationInformation(): ApplicationInformation;
|
|
@@ -4046,14 +4670,14 @@ type ApplicationDetail = {
|
|
|
4046
4670
|
slug?: string;
|
|
4047
4671
|
company_id?: number;
|
|
4048
4672
|
};
|
|
4049
|
-
/** @returns {
|
|
4050
|
-
declare function
|
|
4051
|
-
type
|
|
4673
|
+
/** @returns {CurrenciesResponse} */
|
|
4674
|
+
declare function CurrenciesResponse(): CurrenciesResponse;
|
|
4675
|
+
type CurrenciesResponse = {
|
|
4052
4676
|
items?: Currency[];
|
|
4053
4677
|
};
|
|
4054
|
-
/** @returns {
|
|
4055
|
-
declare function
|
|
4056
|
-
type
|
|
4678
|
+
/** @returns {AppCurrencyResponse} */
|
|
4679
|
+
declare function AppCurrencyResponse(): AppCurrencyResponse;
|
|
4680
|
+
type AppCurrencyResponse = {
|
|
4057
4681
|
/**
|
|
4058
4682
|
* - The unique identifier (24-digit Mongo Object ID)
|
|
4059
4683
|
* of the currency configuration supported by the application
|
|
@@ -4105,7 +4729,7 @@ type OptedStoreAddress = {
|
|
|
4105
4729
|
/**
|
|
4106
4730
|
* - 6-digit PIN code of the opted store location
|
|
4107
4731
|
*/
|
|
4108
|
-
pincode?:
|
|
4732
|
+
pincode?: string;
|
|
4109
4733
|
/**
|
|
4110
4734
|
* - Country of the opted store, e.g. India
|
|
4111
4735
|
*/
|
|
@@ -4160,7 +4784,7 @@ type OrderingStore = {
|
|
|
4160
4784
|
/**
|
|
4161
4785
|
* - 6-digit PIN Code of the ordering store, e.g. 400001
|
|
4162
4786
|
*/
|
|
4163
|
-
pincode?:
|
|
4787
|
+
pincode?: string;
|
|
4164
4788
|
/**
|
|
4165
4789
|
* - Code of the ordering store (usually same as Store Code)
|
|
4166
4790
|
*/
|
|
@@ -4201,26 +4825,139 @@ type OrderingStores = {
|
|
|
4201
4825
|
*/
|
|
4202
4826
|
__v?: number;
|
|
4203
4827
|
};
|
|
4204
|
-
/** @returns {
|
|
4205
|
-
declare function
|
|
4206
|
-
type
|
|
4207
|
-
|
|
4208
|
-
|
|
4209
|
-
};
|
|
4210
|
-
/** @returns {
|
|
4211
|
-
declare function
|
|
4212
|
-
type
|
|
4213
|
-
|
|
4214
|
-
|
|
4215
|
-
|
|
4216
|
-
|
|
4217
|
-
|
|
4828
|
+
/** @returns {UpdateDiealog} */
|
|
4829
|
+
declare function UpdateDiealog(): UpdateDiealog;
|
|
4830
|
+
type UpdateDiealog = {
|
|
4831
|
+
type: string;
|
|
4832
|
+
interval?: number;
|
|
4833
|
+
};
|
|
4834
|
+
/** @returns {PlatformVersionRequest} */
|
|
4835
|
+
declare function PlatformVersionRequest(): PlatformVersionRequest;
|
|
4836
|
+
type PlatformVersionRequest = {
|
|
4837
|
+
app_code_name: string;
|
|
4838
|
+
app_name: string;
|
|
4839
|
+
force_version: string;
|
|
4840
|
+
latest_version: string;
|
|
4841
|
+
is_app_blocked: boolean;
|
|
4842
|
+
update_dialog: UpdateDiealog;
|
|
4843
|
+
};
|
|
4844
|
+
/** @returns {PlatformVersion} */
|
|
4845
|
+
declare function PlatformVersion(): PlatformVersion;
|
|
4846
|
+
type PlatformVersion = {
|
|
4847
|
+
app_code_name: string;
|
|
4848
|
+
app_name: string;
|
|
4849
|
+
force_version: string;
|
|
4850
|
+
latest_version: string;
|
|
4851
|
+
is_app_blocked: boolean;
|
|
4852
|
+
update_dialog: UpdateDiealog;
|
|
4853
|
+
_id?: string;
|
|
4218
4854
|
/**
|
|
4219
|
-
* -
|
|
4855
|
+
* - ISO 8601 timestamp when currency was added
|
|
4856
|
+
* in the list of currencies supported by the sales channel
|
|
4220
4857
|
*/
|
|
4221
|
-
|
|
4858
|
+
modified_at?: string;
|
|
4222
4859
|
/**
|
|
4223
|
-
* -
|
|
4860
|
+
* - ISO 8601 timestamp when currency was added
|
|
4861
|
+
* in the list of currencies supported by the sales channel
|
|
4224
4862
|
*/
|
|
4225
|
-
|
|
4863
|
+
created_at?: string;
|
|
4864
|
+
__v?: number;
|
|
4865
|
+
};
|
|
4866
|
+
/** @returns {OrderingStoresResponse} */
|
|
4867
|
+
declare function OrderingStoresResponse(): OrderingStoresResponse;
|
|
4868
|
+
type OrderingStoresResponse = {
|
|
4869
|
+
page?: Page;
|
|
4870
|
+
items?: OrderingStore[];
|
|
4871
|
+
};
|
|
4872
|
+
/** @returns {LocationDefaultLanguage} */
|
|
4873
|
+
declare function LocationDefaultLanguage(): LocationDefaultLanguage;
|
|
4874
|
+
type LocationDefaultLanguage = {
|
|
4875
|
+
name?: string;
|
|
4876
|
+
code?: string;
|
|
4877
|
+
};
|
|
4878
|
+
/** @returns {LocationDefaultCurrency} */
|
|
4879
|
+
declare function LocationDefaultCurrency(): LocationDefaultCurrency;
|
|
4880
|
+
type LocationDefaultCurrency = {
|
|
4881
|
+
name?: string;
|
|
4882
|
+
symbol?: string;
|
|
4883
|
+
code?: string;
|
|
4884
|
+
};
|
|
4885
|
+
/** @returns {LocationCountry} */
|
|
4886
|
+
declare function LocationCountry(): LocationCountry;
|
|
4887
|
+
type LocationCountry = {
|
|
4888
|
+
capital?: string;
|
|
4889
|
+
currency?: string;
|
|
4890
|
+
iso2?: string;
|
|
4891
|
+
iso3?: string;
|
|
4892
|
+
name?: string;
|
|
4893
|
+
parent?: string;
|
|
4894
|
+
phone_code?: string;
|
|
4895
|
+
type?: string;
|
|
4896
|
+
uid?: number;
|
|
4897
|
+
__v?: number;
|
|
4898
|
+
_id?: string;
|
|
4899
|
+
default_currency?: LocationDefaultCurrency;
|
|
4900
|
+
default_language?: LocationDefaultLanguage;
|
|
4901
|
+
state_code?: string;
|
|
4902
|
+
country_code?: string;
|
|
4903
|
+
latitude?: string;
|
|
4904
|
+
longitude?: string;
|
|
4905
|
+
};
|
|
4906
|
+
/** @returns {Locations} */
|
|
4907
|
+
declare function Locations(): Locations;
|
|
4908
|
+
type Locations = {
|
|
4909
|
+
items?: LocationCountry[];
|
|
4910
|
+
};
|
|
4911
|
+
/** @returns {UrlRedirectionResponse} */
|
|
4912
|
+
declare function UrlRedirectionResponse(): UrlRedirectionResponse;
|
|
4913
|
+
type UrlRedirectionResponse = {
|
|
4914
|
+
redirections?: UrlRedirection[];
|
|
4915
|
+
};
|
|
4916
|
+
/** @returns {UrlRedirectionRequest} */
|
|
4917
|
+
declare function UrlRedirectionRequest(): UrlRedirectionRequest;
|
|
4918
|
+
type UrlRedirectionRequest = {
|
|
4919
|
+
redirection?: UrlRedirection;
|
|
4920
|
+
};
|
|
4921
|
+
/** @returns {UrlRedirection} */
|
|
4922
|
+
declare function UrlRedirection(): UrlRedirection;
|
|
4923
|
+
type UrlRedirection = {
|
|
4924
|
+
redirect_from?: string;
|
|
4925
|
+
redirect_to?: string;
|
|
4926
|
+
type?: string;
|
|
4927
|
+
_id?: string;
|
|
4928
|
+
};
|
|
4929
|
+
/** @returns {StoreForConfigurationRequest} */
|
|
4930
|
+
declare function StoreForConfigurationRequest(): StoreForConfigurationRequest;
|
|
4931
|
+
type StoreForConfigurationRequest = {
|
|
4932
|
+
conf?: AppStoreRules[];
|
|
4933
|
+
};
|
|
4934
|
+
/** @returns {DomainOptionsResponse} */
|
|
4935
|
+
declare function DomainOptionsResponse(): DomainOptionsResponse;
|
|
4936
|
+
type DomainOptionsResponse = {
|
|
4937
|
+
domain_types?: DomainType[];
|
|
4938
|
+
network_ips?: string[];
|
|
4939
|
+
network_cnames?: string[];
|
|
4940
|
+
};
|
|
4941
|
+
/** @returns {DomainType} */
|
|
4942
|
+
declare function DomainType(): DomainType;
|
|
4943
|
+
type DomainType = {
|
|
4944
|
+
key?: string;
|
|
4945
|
+
display?: string;
|
|
4946
|
+
values?: DomainValue[];
|
|
4947
|
+
};
|
|
4948
|
+
/** @returns {DomainValue} */
|
|
4949
|
+
declare function DomainValue(): DomainValue;
|
|
4950
|
+
type DomainValue = {
|
|
4951
|
+
value?: string;
|
|
4952
|
+
text?: string;
|
|
4953
|
+
};
|
|
4954
|
+
/** @returns {StoreRequest} */
|
|
4955
|
+
declare function StoreRequest(): StoreRequest;
|
|
4956
|
+
type StoreRequest = {
|
|
4957
|
+
companies?: number[];
|
|
4958
|
+
};
|
|
4959
|
+
/** @returns {StoreResponse} */
|
|
4960
|
+
declare function StoreResponse(): StoreResponse;
|
|
4961
|
+
type StoreResponse = {
|
|
4962
|
+
data?: number[];
|
|
4226
4963
|
};
|