@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +2 -2
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +81 -101
- package/sdk/application/Cart/CartApplicationClient.js +173 -511
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +110 -110
- package/sdk/application/Catalog/CatalogApplicationClient.js +214 -447
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -19
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -43
- package/sdk/application/Communication/CommunicationApplicationClient.js +4 -214
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +41 -54
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +39 -192
- package/sdk/application/Content/ContentApplicationClient.d.ts +61 -61
- package/sdk/application/Content/ContentApplicationClient.js +183 -366
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +6 -6
- package/sdk/application/Lead/LeadApplicationClient.js +24 -55
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +28 -117
- package/sdk/application/Logistic/LogisticApplicationClient.js +99 -492
- package/sdk/application/Order/OrderApplicationClient.d.ts +31 -51
- package/sdk/application/Order/OrderApplicationClient.js +89 -293
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +108 -218
- package/sdk/application/Payment/PaymentApplicationClient.js +100 -1081
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -14
- package/sdk/application/Rewards/RewardsApplicationClient.js +13 -66
- package/sdk/application/Share/ShareApplicationClient.d.ts +11 -11
- package/sdk/application/Share/ShareApplicationClient.js +35 -89
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +5 -25
- package/sdk/application/Theme/ThemeApplicationClient.js +24 -150
- package/sdk/application/User/UserApplicationClient.d.ts +23 -13
- package/sdk/application/User/UserApplicationClient.js +49 -407
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -11
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +10 -54
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +32 -364
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +54 -1
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +43 -0
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -35
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerClient.js +4 -4
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +52 -98
- package/sdk/partner/Lead/LeadPartnerModel.js +76 -100
- package/sdk/partner/Lead/LeadPartnerValidator.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +172 -41
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1222 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1921 -297
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +973 -258
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +148 -16
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +21 -63
- package/sdk/partner/Theme/ThemePartnerClient.js +67 -392
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +72 -104
- package/sdk/partner/Theme/ThemePartnerModel.js +75 -101
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +1 -5
- package/sdk/partner/Theme/ThemePartnerValidator.js +12 -42
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +673 -189
- package/sdk/partner/Webhook/WebhookPartnerModel.js +270 -159
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -3
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +3 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +172 -251
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +577 -648
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +270 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +192 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4554 -3154
- package/sdk/platform/Cart/CartPlatformModel.js +1935 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +380 -976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6464
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +161 -1082
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +80 -884
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +568 -325
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1560 -1162
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9772 -7871
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6978 -9516
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +231 -240
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +180 -188
- package/sdk/platform/Common/CommonPlatformClient.d.ts +6 -5
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +19 -25
- package/sdk/platform/Common/CommonPlatformModel.js +11 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +240 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +589 -874
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +139 -170
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +126 -145
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -56
- package/sdk/platform/Communication/CommunicationPlatformClient.js +4 -307
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +330 -502
- package/sdk/platform/Communication/CommunicationPlatformModel.js +376 -610
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +3 -62
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +2 -48
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +72 -100
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -146
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +270 -241
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +248 -226
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +20 -31
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -25
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +117 -332
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +409 -1470
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +55 -158
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +41 -163
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +65 -142
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +103 -568
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +562 -1289
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +368 -1037
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +34 -80
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +24 -79
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +302 -248
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1292 -773
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +330 -218
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +325 -208
- package/sdk/platform/Content/ContentPlatformClient.d.ts +279 -118
- package/sdk/platform/Content/ContentPlatformClient.js +1617 -492
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2391 -924
- package/sdk/platform/Content/ContentPlatformModel.js +1314 -970
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +272 -134
- package/sdk/platform/Content/ContentPlatformValidator.js +295 -118
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +53 -43
- package/sdk/platform/Discount/DiscountPlatformClient.js +53 -43
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +383 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +117 -108
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -163
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1078
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -141
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -177
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +30 -1123
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +24 -1135
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +33 -33
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +19 -19
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +14 -14
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +24 -4
- package/sdk/platform/Lead/LeadPlatformClient.js +160 -4
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +60 -140
- package/sdk/platform/Lead/LeadPlatformModel.js +81 -162
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +29 -3
- package/sdk/platform/Lead/LeadPlatformValidator.js +28 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +19 -98
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +27 -662
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +91 -118
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +32 -127
- package/sdk/platform/Order/OrderPlatformClient.d.ts +406 -403
- package/sdk/platform/Order/OrderPlatformClient.js +1200 -1343
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8665 -4505
- package/sdk/platform/Order/OrderPlatformModel.js +4088 -3601
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +666 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +353 -312
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +67 -19
- package/sdk/platform/Partner/PartnerPlatformModel.js +26 -17
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +135 -382
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +937 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +100 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +74 -305
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +56 -66
- package/sdk/platform/Payment/PaymentPlatformClient.js +124 -269
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1307 -3536
- package/sdk/platform/Payment/PaymentPlatformModel.js +1389 -3692
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +35 -64
- package/sdk/platform/Payment/PaymentPlatformValidator.js +34 -60
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +10 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +64 -136
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +111 -521
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -117
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -105
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +160 -149
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +766 -545
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6196 -3978
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3181 -3895
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +294 -220
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -149
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +16 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.js +86 -8
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +23 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +16 -3
- package/sdk/platform/Share/SharePlatformModel.d.ts +53 -9
- package/sdk/platform/Share/SharePlatformModel.js +45 -5
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +17 -37
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +66 -204
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +25 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +20 -31
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -18
- package/sdk/platform/Theme/ThemePlatformClient.js +8 -85
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +17 -425
- package/sdk/platform/Theme/ThemePlatformModel.js +23 -329
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +3 -7
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -9
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +81 -18
- package/sdk/platform/User/UserPlatformApplicationClient.js +491 -27
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +126 -10
- package/sdk/platform/User/UserPlatformApplicationValidator.js +92 -7
- package/sdk/platform/User/UserPlatformModel.d.ts +317 -218
- package/sdk/platform/User/UserPlatformModel.js +253 -210
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +813 -426
- package/sdk/platform/Webhook/WebhookPlatformModel.js +446 -395
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +4 -14
- package/sdk/public/Configuration/ConfigurationPublicClient.js +10 -113
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +46 -114
- package/sdk/public/Configuration/ConfigurationPublicModel.js +32 -117
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +1 -11
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +0 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -25
- package/sdk/public/Content/ContentPublicClient.js +254 -280
- package/sdk/public/Content/ContentPublicModel.d.ts +151 -38
- package/sdk/public/Content/ContentPublicModel.js +98 -44
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -17
- package/sdk/public/Content/ContentPublicValidator.js +26 -19
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +9 -48
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +215 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +66 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/partner/Authorization/AuthorizationPartnerClient.d.ts +0 -66
- package/sdk/partner/Authorization/AuthorizationPartnerClient.js +0 -431
- package/sdk/partner/Authorization/AuthorizationPartnerModel.d.ts +0 -231
- package/sdk/partner/Authorization/AuthorizationPartnerModel.js +0 -152
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.d.ts +0 -8
- package/sdk/partner/Authorization/AuthorizationPartnerValidator.js +0 -39
- package/sdk/partner/Catalog/CatalogPartnerClient.d.ts +0 -26
- package/sdk/partner/Catalog/CatalogPartnerClient.js +0 -173
- package/sdk/partner/Catalog/CatalogPartnerModel.d.ts +0 -238
- package/sdk/partner/Catalog/CatalogPartnerModel.js +0 -248
- package/sdk/partner/Catalog/CatalogPartnerValidator.d.ts +0 -5
- package/sdk/partner/Catalog/CatalogPartnerValidator.js +0 -19
- package/sdk/partner/Payment/PaymentPartnerClient.d.ts +0 -116
- package/sdk/partner/Payment/PaymentPartnerClient.js +0 -857
- package/sdk/partner/Payment/PaymentPartnerModel.d.ts +0 -388
- package/sdk/partner/Payment/PaymentPartnerModel.js +0 -442
- package/sdk/partner/Payment/PaymentPartnerValidator.d.ts +0 -14
- package/sdk/partner/Payment/PaymentPartnerValidator.js +0 -74
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2895
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2150
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -1,6 +1,28 @@
|
|
|
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
|
+
*/
|
|
2
23
|
/**
|
|
3
24
|
* @typedef ApplicationInventory
|
|
25
|
+
* @property {SearchConfig} [search]
|
|
4
26
|
* @property {AppInventoryConfig} [inventory]
|
|
5
27
|
* @property {AuthenticationConfig} [authentication]
|
|
6
28
|
* @property {ArticleAssignmentConfig} [article_assignment]
|
|
@@ -18,8 +40,7 @@ export = ConfigurationPlatformModel;
|
|
|
18
40
|
* or not for sales channel inventory
|
|
19
41
|
* @property {CommunicationConfig} [communication]
|
|
20
42
|
* @property {string[]} [platforms]
|
|
21
|
-
* @property {string} [_id] - The unique identifier
|
|
22
|
-
* of the sales channel inventory
|
|
43
|
+
* @property {string} [_id] - The unique identifier of the sales channel inventory
|
|
23
44
|
* @property {LoyaltyPointsConfig} [loyalty_points]
|
|
24
45
|
* @property {string} [app] - Current sales channel ID
|
|
25
46
|
* @property {string} [created_at] - ISO 8601 timestamp of sales channel
|
|
@@ -34,30 +55,40 @@ export = ConfigurationPlatformModel;
|
|
|
34
55
|
* @property {boolean} [enabled]
|
|
35
56
|
*/
|
|
36
57
|
/**
|
|
37
|
-
* @typedef
|
|
38
|
-
* @property {
|
|
58
|
+
* @typedef FstIdentification
|
|
59
|
+
* @property {boolean} [enabled] - Indicates whether search query interpretation
|
|
60
|
+
* is enabled for the application.
|
|
61
|
+
*/
|
|
62
|
+
/**
|
|
63
|
+
* @typedef QuerySuggestions
|
|
64
|
+
* @property {boolean} [enabled] - Indicates whether to enable or disable query
|
|
65
|
+
* suggestions powered by the GPT model using the current live catalog within
|
|
66
|
+
* the application.
|
|
67
|
+
* @property {number} [max_limit] - Specifies the maximum number of query
|
|
68
|
+
* suggestions that can be returned.
|
|
39
69
|
*/
|
|
40
70
|
/**
|
|
41
|
-
* @typedef
|
|
42
|
-
* @property {
|
|
71
|
+
* @typedef SearchConfig
|
|
72
|
+
* @property {FstIdentification} [fst_identification]
|
|
73
|
+
* @property {QuerySuggestions} [query_suggestions]
|
|
43
74
|
*/
|
|
44
75
|
/**
|
|
45
76
|
* @typedef AppInventoryConfig
|
|
77
|
+
* @property {DeliveryStrategy} [delivery_strategy]
|
|
46
78
|
* @property {InventoryBrand} [brand]
|
|
47
79
|
* @property {InventoryStore} [store]
|
|
48
80
|
* @property {InventoryCategory} [category]
|
|
49
81
|
* @property {InventoryPrice} [price]
|
|
50
82
|
* @property {InventoryDiscount} [discount]
|
|
51
|
-
* @property {PricingStrategy} [pricing_strategy]
|
|
52
83
|
* @property {boolean} [out_of_stock] - Indicates whether out of stock products
|
|
53
84
|
* are allowed to show up on the website
|
|
54
85
|
* @property {boolean} [only_verified_products] - Show only verified products
|
|
55
86
|
* (the ones whose data has been verified by the admin)
|
|
56
87
|
* @property {boolean} [franchise_enabled] - Allow other businesses (companies)
|
|
57
88
|
* to consume the current sales channel's inventory and sell products
|
|
58
|
-
* @property {
|
|
89
|
+
* @property {Object[]} [exclude_category] - List of excluded brands category
|
|
59
90
|
* @property {string[]} [image]
|
|
60
|
-
* @property {
|
|
91
|
+
* @property {Object[]} [company_store] - List of selling locations whose
|
|
61
92
|
* inventory is available to the sales channel for displaying on the website
|
|
62
93
|
* @property {number} [company_id]
|
|
63
94
|
*/
|
|
@@ -71,7 +102,7 @@ export = ConfigurationPlatformModel;
|
|
|
71
102
|
* @typedef InventoryStore
|
|
72
103
|
* @property {string} [criteria] - All stores or specific (explicit) stores to
|
|
73
104
|
* be shown on the website
|
|
74
|
-
* @property {
|
|
105
|
+
* @property {Object[]} [stores] - List of stores
|
|
75
106
|
* @property {AppStoreRules[]} [rules] - Rules to show which brands or companies
|
|
76
107
|
* products should be listed on sales channel.
|
|
77
108
|
*/
|
|
@@ -85,7 +116,7 @@ export = ConfigurationPlatformModel;
|
|
|
85
116
|
/**
|
|
86
117
|
* @typedef InventoryCategory
|
|
87
118
|
* @property {string} [criteria]
|
|
88
|
-
* @property {
|
|
119
|
+
* @property {Object[]} [categories] - List of categories whose products will be
|
|
89
120
|
* shown on the website
|
|
90
121
|
*/
|
|
91
122
|
/**
|
|
@@ -118,7 +149,7 @@ export = ConfigurationPlatformModel;
|
|
|
118
149
|
* @typedef StorePriority
|
|
119
150
|
* @property {boolean} [enabled] - Shows store priority is enabled or disabled
|
|
120
151
|
* for assignment of article
|
|
121
|
-
* @property {
|
|
152
|
+
* @property {Object[]} [storetype_order] - List of store types for article
|
|
122
153
|
* assignment e.g. warehouse, mall, highstreet
|
|
123
154
|
*/
|
|
124
155
|
/**
|
|
@@ -228,6 +259,7 @@ export = ConfigurationPlatformModel;
|
|
|
228
259
|
*/
|
|
229
260
|
/**
|
|
230
261
|
* @typedef AppInventoryPartialUpdate
|
|
262
|
+
* @property {SearchConfig} [search]
|
|
231
263
|
* @property {RewardPointsConfig} [reward_points]
|
|
232
264
|
* @property {AppCartConfig} [cart]
|
|
233
265
|
* @property {AppPaymentConfig} [payment]
|
|
@@ -242,24 +274,24 @@ export = ConfigurationPlatformModel;
|
|
|
242
274
|
* @property {number} [company_id] - Numeric ID allotted to a business account
|
|
243
275
|
*/
|
|
244
276
|
/**
|
|
245
|
-
* @typedef
|
|
277
|
+
* @typedef CompanyByBrandsRequestSchema
|
|
246
278
|
* @property {number} brands - Brand UID
|
|
247
279
|
* @property {string} [search_text] - A search field for finding a company by its name
|
|
248
280
|
*/
|
|
249
281
|
/**
|
|
250
|
-
* @typedef
|
|
282
|
+
* @typedef CompanyByBrandsResponseSchema
|
|
251
283
|
* @property {BrandCompanyInfo[]} [items]
|
|
252
284
|
* @property {Page} [page]
|
|
253
285
|
*/
|
|
254
286
|
/**
|
|
255
|
-
* @typedef
|
|
287
|
+
* @typedef StoreByBrandsRequestSchema
|
|
256
288
|
* @property {number} [company_id] - Current company ID for current company
|
|
257
289
|
* stores only. Don't send in case cross-selling (franchise) is enabled.
|
|
258
290
|
* @property {number} brands - Brand UID
|
|
259
291
|
* @property {string} [search_text] - Search store by its name or store code
|
|
260
292
|
*/
|
|
261
293
|
/**
|
|
262
|
-
* @typedef
|
|
294
|
+
* @typedef StoreByBrandsResponseSchema
|
|
263
295
|
* @property {BrandStoreInfo[]} [items]
|
|
264
296
|
* @property {Page} [page]
|
|
265
297
|
*/
|
|
@@ -284,19 +316,16 @@ export = ConfigurationPlatformModel;
|
|
|
284
316
|
* portrait banner
|
|
285
317
|
*/
|
|
286
318
|
/**
|
|
287
|
-
* @typedef
|
|
319
|
+
* @typedef BrandsByCompanyResponseSchema
|
|
288
320
|
* @property {CompanyBrandInfo[]} [brands]
|
|
289
321
|
*/
|
|
290
322
|
/**
|
|
291
|
-
* @typedef
|
|
323
|
+
* @typedef ValidationFailedResponseSchema
|
|
292
324
|
* @property {string} [message] - Response message for failed validation
|
|
293
|
-
* @property {Object[]} [errors] - Response message for failed validation
|
|
294
325
|
*/
|
|
295
326
|
/**
|
|
296
327
|
* @typedef NotFound
|
|
297
328
|
* @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
|
|
300
329
|
* @property {boolean} [success] - Flag for required not successfull.
|
|
301
330
|
*/
|
|
302
331
|
/**
|
|
@@ -318,26 +347,25 @@ export = ConfigurationPlatformModel;
|
|
|
318
347
|
* amount pan card number is expected from customer for order
|
|
319
348
|
*/
|
|
320
349
|
/**
|
|
321
|
-
* @typedef
|
|
350
|
+
* @typedef CreateApplicationRequestSchema
|
|
322
351
|
* @property {App} [app]
|
|
323
352
|
* @property {ApplicationInventory} [configuration]
|
|
324
353
|
* @property {AppDomain} [domain]
|
|
325
354
|
*/
|
|
326
355
|
/**
|
|
327
|
-
* @typedef
|
|
356
|
+
* @typedef CreateAppResponseSchema
|
|
328
357
|
* @property {Application} [app]
|
|
329
358
|
* @property {ApplicationInventory} [configuration]
|
|
330
359
|
*/
|
|
331
360
|
/**
|
|
332
|
-
* @typedef
|
|
361
|
+
* @typedef ApplicationsResponseSchema
|
|
333
362
|
* @property {Application[]} [items]
|
|
334
363
|
* @property {Page} [page]
|
|
335
364
|
*/
|
|
336
365
|
/**
|
|
337
366
|
* @typedef MobileAppConfiguration
|
|
338
367
|
* @property {boolean} [is_active] - Indicates the availability of the mobile build
|
|
339
|
-
* @property {string} [_id] - The unique identifier
|
|
340
|
-
* for mobile application configuration
|
|
368
|
+
* @property {string} [_id] - The unique identifier for mobile application configuration
|
|
341
369
|
* @property {string} [app_name] - Name of the mobile app
|
|
342
370
|
* @property {LandingImage} [landing_image]
|
|
343
371
|
* @property {SplashImage} [splash_image]
|
|
@@ -363,7 +391,7 @@ export = ConfigurationPlatformModel;
|
|
|
363
391
|
* @property {string} [secure_url] - URL where the splash image is hosted
|
|
364
392
|
*/
|
|
365
393
|
/**
|
|
366
|
-
* @typedef
|
|
394
|
+
* @typedef MobileAppConfigRequestSchema
|
|
367
395
|
* @property {string} [app_name] - Name of the mobile app
|
|
368
396
|
* @property {LandingImage} [landing_image]
|
|
369
397
|
* @property {SplashImage} [splash_image]
|
|
@@ -377,7 +405,7 @@ export = ConfigurationPlatformModel;
|
|
|
377
405
|
*/
|
|
378
406
|
/**
|
|
379
407
|
* @typedef BuildVersion
|
|
380
|
-
* @property {string} [_id] -
|
|
408
|
+
* @property {string} [_id] - Primary Identifier of the build version.
|
|
381
409
|
* @property {string} [application] - Application ID of the sales channel
|
|
382
410
|
* @property {string} [platform_type] - Device platform for which the mobile app
|
|
383
411
|
* was built, e.g. android, ios.
|
|
@@ -395,8 +423,8 @@ export = ConfigurationPlatformModel;
|
|
|
395
423
|
*/
|
|
396
424
|
/**
|
|
397
425
|
* @typedef AppSupportedCurrency
|
|
398
|
-
* @property {string} [_id] - The unique identifier
|
|
399
|
-
*
|
|
426
|
+
* @property {string} [_id] - The unique identifier of the currency
|
|
427
|
+
* configuration supported by the application
|
|
400
428
|
* @property {string[]} [supported_currency]
|
|
401
429
|
* @property {string} [application] - Alphanumeric ID allotted to an application
|
|
402
430
|
* (sales channel website) created within a business account.
|
|
@@ -408,16 +436,14 @@ export = ConfigurationPlatformModel;
|
|
|
408
436
|
*/
|
|
409
437
|
/**
|
|
410
438
|
* @typedef DefaultCurrency
|
|
411
|
-
* @property {string} [ref] - The unique identifier
|
|
412
|
-
* of the default currency
|
|
439
|
+
* @property {string} [ref] - The unique identifier of the default currency
|
|
413
440
|
* @property {string} [code] - 3-character code of the default currency, e.g.
|
|
414
441
|
* INR, EUR, USD
|
|
415
442
|
*/
|
|
416
443
|
/**
|
|
417
444
|
* @typedef DomainAdd
|
|
418
445
|
* @property {string} [name] - Full domain name, e.g. uniket.hostx0.de
|
|
419
|
-
* @property {string} [_id] - The unique identifier
|
|
420
|
-
* of the domain
|
|
446
|
+
* @property {string} [_id] - The unique identifier of the domain
|
|
421
447
|
* @property {boolean} [verified] - Domain is verified or not (indicates if A
|
|
422
448
|
* records and TXT records are correct)
|
|
423
449
|
* @property {boolean} [is_primary] - Domain is primary or not (indicates if the
|
|
@@ -429,14 +455,13 @@ export = ConfigurationPlatformModel;
|
|
|
429
455
|
* @property {string[]} [txt_records]
|
|
430
456
|
*/
|
|
431
457
|
/**
|
|
432
|
-
* @typedef
|
|
458
|
+
* @typedef DomainAddRequestSchema
|
|
433
459
|
* @property {DomainAdd} [domain]
|
|
434
460
|
*/
|
|
435
461
|
/**
|
|
436
462
|
* @typedef Domain
|
|
437
463
|
* @property {string} [name] - Full domain name, e.g. newton.com
|
|
438
|
-
* @property {string} [_id] - The unique identifier
|
|
439
|
-
* of the sales channel domain
|
|
464
|
+
* @property {string} [_id] - The unique identifier of the sales channel domain
|
|
440
465
|
* @property {boolean} [verified] - Domain is verified or not. TXT and A records
|
|
441
466
|
* should propagate correctly.
|
|
442
467
|
* @property {boolean} [is_primary] - Domain is primary or not. Primary domain
|
|
@@ -446,14 +471,13 @@ export = ConfigurationPlatformModel;
|
|
|
446
471
|
* @property {string} [message]
|
|
447
472
|
*/
|
|
448
473
|
/**
|
|
449
|
-
* @typedef
|
|
474
|
+
* @typedef DomainsResponseSchema
|
|
450
475
|
* @property {Domain[]} [domains]
|
|
451
476
|
*/
|
|
452
477
|
/**
|
|
453
478
|
* @typedef UpdateDomain
|
|
454
479
|
* @property {string} [name] - Full domain name, e.g. zenz.com
|
|
455
|
-
* @property {string} [_id] - The unique identifier
|
|
456
|
-
* of the domain
|
|
480
|
+
* @property {string} [_id] - The unique identifier of the domain
|
|
457
481
|
* @property {boolean} [verified] - Domain is verified or not (indicates if A
|
|
458
482
|
* records and TXT records are correct)
|
|
459
483
|
* @property {boolean} [is_primary] - Domain is primary or not (indicates if the
|
|
@@ -462,13 +486,13 @@ export = ConfigurationPlatformModel;
|
|
|
462
486
|
* domain (short URL e.g. bit.ly)
|
|
463
487
|
*/
|
|
464
488
|
/**
|
|
465
|
-
* @typedef
|
|
489
|
+
* @typedef UpdateDomainTypeRequestSchema
|
|
466
490
|
* @property {UpdateDomain} [domain]
|
|
467
491
|
* @property {string} [action] - Shows domain is made primary domain for the
|
|
468
492
|
* sales channel or shorlink is created for the sales channel domain
|
|
469
493
|
*/
|
|
470
494
|
/**
|
|
471
|
-
* @typedef
|
|
495
|
+
* @typedef DomainStatusRequestSchema
|
|
472
496
|
* @property {string} [domain_url] - URL of the domain, e.g. uniket.hostx0.de
|
|
473
497
|
*/
|
|
474
498
|
/**
|
|
@@ -478,14 +502,16 @@ export = ConfigurationPlatformModel;
|
|
|
478
502
|
* domain are correctly propagating via DNS servers
|
|
479
503
|
*/
|
|
480
504
|
/**
|
|
481
|
-
* @typedef
|
|
505
|
+
* @typedef DomainStatusResponseSchema
|
|
482
506
|
* @property {boolean} [connected] - Check if domain is live and mapped to
|
|
483
507
|
* appropriate IP of Fynd Servers
|
|
484
508
|
* @property {DomainStatus[]} [status]
|
|
485
509
|
*/
|
|
486
510
|
/**
|
|
487
|
-
* @typedef
|
|
511
|
+
* @typedef DomainSuggestionsRequestSchema
|
|
488
512
|
* @property {string} [domain_url] - Domain url
|
|
513
|
+
* @property {boolean} [custom_domain] - Get suggestions for custom domains or
|
|
514
|
+
* Fynd domains
|
|
489
515
|
*/
|
|
490
516
|
/**
|
|
491
517
|
* @typedef DomainSuggestion
|
|
@@ -498,186 +524,14 @@ export = ConfigurationPlatformModel;
|
|
|
498
524
|
* @property {string} [currency] - Custom domain currency. Not present for Fynd domains.
|
|
499
525
|
*/
|
|
500
526
|
/**
|
|
501
|
-
* @typedef
|
|
527
|
+
* @typedef DomainSuggestionsResponseSchema
|
|
502
528
|
* @property {DomainSuggestion[]} [domains] - Domain URL
|
|
503
529
|
*/
|
|
504
530
|
/**
|
|
505
|
-
* @typedef
|
|
531
|
+
* @typedef SuccessMessageResponseSchema
|
|
506
532
|
* @property {boolean} [success] - Shows whether domain was deleted successfully
|
|
507
533
|
* @property {string} [message] - Success message shown to the user (in a string format)
|
|
508
534
|
*/
|
|
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
|
-
*/
|
|
681
535
|
/**
|
|
682
536
|
* @typedef App
|
|
683
537
|
* @property {string} [company_id] - Numeric ID allotted to a business account
|
|
@@ -688,31 +542,12 @@ export = ConfigurationPlatformModel;
|
|
|
688
542
|
* @property {string} [name] - User-friendly name for sales channel, e.g. Zenz Fashion
|
|
689
543
|
* @property {string} [desc] - Detailed description about the sales channel
|
|
690
544
|
*/
|
|
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
|
-
*/
|
|
710
545
|
/**
|
|
711
546
|
* @typedef AppDomain
|
|
712
547
|
* @property {string} [name] - Domain URL of current sales channel, e.g. zenz.com
|
|
713
548
|
*/
|
|
714
549
|
/**
|
|
715
|
-
* @typedef
|
|
550
|
+
* @typedef CompaniesResponseSchema
|
|
716
551
|
* @property {AppInventoryCompanies[]} [items]
|
|
717
552
|
* @property {Page} [page]
|
|
718
553
|
*/
|
|
@@ -724,22 +559,14 @@ export = ConfigurationPlatformModel;
|
|
|
724
559
|
* franchisee, distributor, etc.
|
|
725
560
|
*/
|
|
726
561
|
/**
|
|
727
|
-
* @typedef
|
|
562
|
+
* @typedef StoresResponseSchema
|
|
728
563
|
* @property {AppInventoryStores[]} [items]
|
|
729
564
|
* @property {Page} [page]
|
|
730
565
|
*/
|
|
731
|
-
/**
|
|
732
|
-
* @typedef ListStoreResponse
|
|
733
|
-
* @property {AppInventoryStores[]} [stores]
|
|
734
|
-
*/
|
|
735
|
-
/**
|
|
736
|
-
* @typedef ArrayStoreResponse
|
|
737
|
-
* @property {AppInventoryStores[]} [data]
|
|
738
|
-
*/
|
|
739
566
|
/**
|
|
740
567
|
* @typedef AppInventoryStores
|
|
741
|
-
* @property {string} [_id] - The unique identifier of the store
|
|
742
|
-
*
|
|
568
|
+
* @property {string} [_id] - The unique identifier of the store in the sales
|
|
569
|
+
* channel inventory
|
|
743
570
|
* @property {string} [modified_on] - ISO 8601 timestamp of last known updation
|
|
744
571
|
* to the stores in sales channel inventory
|
|
745
572
|
* @property {number} [uid] - Sales channel inventory store UID
|
|
@@ -757,7 +584,7 @@ export = ConfigurationPlatformModel;
|
|
|
757
584
|
* @property {Object} [integration_type]
|
|
758
585
|
*/
|
|
759
586
|
/**
|
|
760
|
-
* @typedef
|
|
587
|
+
* @typedef FilterOrderingStoreRequestSchema
|
|
761
588
|
* @property {boolean} [all_stores] - Allow all stores from the ordering stores
|
|
762
589
|
* @property {number[]} [deployed_stores]
|
|
763
590
|
* @property {string} [q] - Store code or name of the ordering store
|
|
@@ -770,8 +597,7 @@ export = ConfigurationPlatformModel;
|
|
|
770
597
|
* @property {string} [type] - Permitted values are 'hard' and 'soft'. For hard
|
|
771
598
|
* type delivery, store selection is compulsory. For soft type, delivery store
|
|
772
599
|
* selection is optional.
|
|
773
|
-
* @property {string} [_id] - The unique identifier
|
|
774
|
-
* of the ordering stores
|
|
600
|
+
* @property {string} [_id] - The unique identifier of the ordering stores
|
|
775
601
|
* @property {string} [app] - Alphanumeric ID allotted to an application (sales
|
|
776
602
|
* channel website) created within a business account
|
|
777
603
|
* @property {number} [__v]
|
|
@@ -781,7 +607,7 @@ export = ConfigurationPlatformModel;
|
|
|
781
607
|
* @property {DeploymentMeta} [deployment_meta]
|
|
782
608
|
*/
|
|
783
609
|
/**
|
|
784
|
-
* @typedef
|
|
610
|
+
* @typedef OrderingStoreSelectRequestSchema
|
|
785
611
|
* @property {OrderingStoreSelect} ordering_store
|
|
786
612
|
*/
|
|
787
613
|
/**
|
|
@@ -797,8 +623,7 @@ export = ConfigurationPlatformModel;
|
|
|
797
623
|
* @typedef OtherSellerApplication
|
|
798
624
|
* @property {string} [name] - Name of the other seller's sales channel
|
|
799
625
|
* @property {string} [description] - Basic details about the other seller's sales channel
|
|
800
|
-
* @property {string} [_id] - The unique identifier
|
|
801
|
-
* of the other seller's sales channel
|
|
626
|
+
* @property {string} [_id] - The unique identifier of the other seller's sales channel
|
|
802
627
|
* @property {string} [domain] - Domain URL of the other seller's sales channel
|
|
803
628
|
* @property {OtherSellerCompany} [company]
|
|
804
629
|
* @property {string} [opt_type] - Inventory opted by the other seller's sales
|
|
@@ -810,11 +635,10 @@ export = ConfigurationPlatformModel;
|
|
|
810
635
|
* @property {Page} [page]
|
|
811
636
|
*/
|
|
812
637
|
/**
|
|
813
|
-
* @typedef
|
|
638
|
+
* @typedef OptedApplicationResponseSchema
|
|
814
639
|
* @property {string} [name] - Name of the other seller's sales channel
|
|
815
640
|
* @property {string} [description] - Basic details about the other seller's sales channel
|
|
816
|
-
* @property {string} [_id] - The unique identifier
|
|
817
|
-
* of the other seller's sales channel
|
|
641
|
+
* @property {string} [_id] - The unique identifier of the other seller's sales channel
|
|
818
642
|
* @property {string} [domain] - Domain URL of the other seller's sales channel
|
|
819
643
|
* @property {OptedCompany} [company]
|
|
820
644
|
* @property {OptedInventory} [opted_inventory]
|
|
@@ -861,10 +685,9 @@ export = ConfigurationPlatformModel;
|
|
|
861
685
|
* of other seller's application
|
|
862
686
|
*/
|
|
863
687
|
/**
|
|
864
|
-
* @typedef
|
|
688
|
+
* @typedef TokenResponseSchema
|
|
865
689
|
* @property {Tokens} [tokens]
|
|
866
|
-
* @property {string} [_id] - The unique identifier
|
|
867
|
-
* of the token
|
|
690
|
+
* @property {string} [_id] - The unique identifier of the token
|
|
868
691
|
* @property {string} [application] - Alphanumeric ID allotted to the current
|
|
869
692
|
* application created within the current business account
|
|
870
693
|
* @property {string} [created_at] - ISO 8601 timestamp of token creation
|
|
@@ -1045,6 +868,20 @@ export = ConfigurationPlatformModel;
|
|
|
1045
868
|
* @property {boolean} [ask_store_address] - Shows whether a form to collect the
|
|
1046
869
|
* address of the store, should be displayed upon visiting the website
|
|
1047
870
|
*/
|
|
871
|
+
/**
|
|
872
|
+
* @typedef BuyboxFeature
|
|
873
|
+
* @property {boolean} [show_name] - Allow users to see seller/stores name on
|
|
874
|
+
* PDP (product detail page).
|
|
875
|
+
* @property {boolean} [enable_selection] - Allow selection of sellers/stores on
|
|
876
|
+
* PDP (product detail page).
|
|
877
|
+
* @property {boolean} [is_seller_buybox_enabled] - Toggle buybox listing
|
|
878
|
+
* between sellers and stores. True indicates seller listing, while False
|
|
879
|
+
* indicates store listing.
|
|
880
|
+
*/
|
|
881
|
+
/**
|
|
882
|
+
* @typedef DeliveryStrategy
|
|
883
|
+
* @property {string} [value] - Indicates the delivery strategy value.
|
|
884
|
+
*/
|
|
1048
885
|
/**
|
|
1049
886
|
* @typedef AppFeature
|
|
1050
887
|
* @property {ProductDetailFeature} [product_detail]
|
|
@@ -1057,15 +894,14 @@ export = ConfigurationPlatformModel;
|
|
|
1057
894
|
* @property {PcrFeature} [pcr]
|
|
1058
895
|
* @property {OrderFeature} [order]
|
|
1059
896
|
* @property {BuyboxFeature} [buybox]
|
|
1060
|
-
* @property {
|
|
1061
|
-
*
|
|
897
|
+
* @property {DeliveryStrategy} [delivery_strategy]
|
|
898
|
+
* @property {string} [_id] - The unique identifier for the sales channel features
|
|
1062
899
|
* @property {string} [app] - Application ID of the sales channel
|
|
1063
900
|
* @property {string} [created_at] - ISO 8601 timestamp showing the date when
|
|
1064
901
|
* the features were configured
|
|
1065
902
|
* @property {string} [modified_at] - ISO 8601 timestamp of last known
|
|
1066
903
|
* modifications to the sales channel feature configuration
|
|
1067
904
|
* @property {number} [__v] - Version key for tracking revisions. Default value is zero
|
|
1068
|
-
* @property {PricingStrategy} [pricing_strategy]
|
|
1069
905
|
*/
|
|
1070
906
|
/**
|
|
1071
907
|
* @typedef HomePageFeature
|
|
@@ -1162,27 +998,17 @@ export = ConfigurationPlatformModel;
|
|
|
1162
998
|
* value is false.
|
|
1163
999
|
*/
|
|
1164
1000
|
/**
|
|
1165
|
-
* @typedef
|
|
1166
|
-
* @property {boolean} [show_name] - Allow users to see seller/stores name on
|
|
1167
|
-
* PDP (product detail page).
|
|
1168
|
-
* @property {boolean} [enable_selection] - Allow selection of sellers/stores on
|
|
1169
|
-
* PDP (product detail page).
|
|
1170
|
-
* @property {boolean} [is_seller_buybox_enabled] - Toggle buybox listing
|
|
1171
|
-
* between sellers and stores. True indicates seller listing, while False
|
|
1172
|
-
* indicates store listing.
|
|
1173
|
-
*/
|
|
1174
|
-
/**
|
|
1175
|
-
* @typedef AppFeatureRequest
|
|
1001
|
+
* @typedef AppFeatureRequestSchema
|
|
1176
1002
|
* @property {AppFeature} [feature]
|
|
1177
1003
|
*/
|
|
1178
1004
|
/**
|
|
1179
|
-
* @typedef
|
|
1005
|
+
* @typedef AppFeatureResponseSchema
|
|
1180
1006
|
* @property {AppFeature} [feature]
|
|
1181
1007
|
*/
|
|
1182
1008
|
/**
|
|
1183
1009
|
* @typedef Currency
|
|
1184
|
-
* @property {string} [_id] - The unique identifier
|
|
1185
|
-
*
|
|
1010
|
+
* @property {string} [_id] - The unique identifier of the current sales channel
|
|
1011
|
+
* supported currency
|
|
1186
1012
|
* @property {boolean} [is_active] - Shows currency is enabled or not in current
|
|
1187
1013
|
* sales channel
|
|
1188
1014
|
* @property {string} [name] - Name of the currency, e.g Indian Rupee
|
|
@@ -1194,7 +1020,7 @@ export = ConfigurationPlatformModel;
|
|
|
1194
1020
|
* @property {number} [decimal_digits] - Acceptable decimal limits for a given
|
|
1195
1021
|
* currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid
|
|
1196
1022
|
* value of a currency.
|
|
1197
|
-
* @property {string} [symbol] - Unique symbol for identifying the currency, e.g.
|
|
1023
|
+
* @property {string} [symbol] - Unique symbol for identifying the currency, e.g. ₹
|
|
1198
1024
|
* @property {string} [country_name]
|
|
1199
1025
|
* @property {string} [country_code]
|
|
1200
1026
|
*/
|
|
@@ -1244,11 +1070,9 @@ export = ConfigurationPlatformModel;
|
|
|
1244
1070
|
* @property {boolean} [is_internal] - Indicates whether a sales channel is
|
|
1245
1071
|
* internal or not
|
|
1246
1072
|
* @property {boolean} [is_active] - Indicates sales channel is active or not active
|
|
1247
|
-
* @property {string} [_id] - The unique identifier
|
|
1248
|
-
* of the sales channel
|
|
1073
|
+
* @property {string} [_id] - The unique identifier of the sales channel
|
|
1249
1074
|
* @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
|
|
1250
|
-
* @property {string} [owner] - The unique identifier
|
|
1251
|
-
* of owner who owns the application
|
|
1075
|
+
* @property {string} [owner] - The unique identifier of owner who owns the application
|
|
1252
1076
|
* @property {number} [company_id] - Numeric ID allotted to a business account
|
|
1253
1077
|
* where the sales channel exists
|
|
1254
1078
|
* @property {string} [token] - Random generated fix length string for sales
|
|
@@ -1271,6 +1095,51 @@ export = ConfigurationPlatformModel;
|
|
|
1271
1095
|
* @property {TokenSchema[]} [tokens]
|
|
1272
1096
|
* @property {string} [secret]
|
|
1273
1097
|
*/
|
|
1098
|
+
/**
|
|
1099
|
+
* @typedef ApplicationById
|
|
1100
|
+
* @property {ApplicationWebsite} [website]
|
|
1101
|
+
* @property {ApplicationCors} [cors]
|
|
1102
|
+
* @property {ApplicationAuth} [auth]
|
|
1103
|
+
* @property {string} [description] - It contains detailed information about the
|
|
1104
|
+
* sales channel.
|
|
1105
|
+
* @property {string} [channel_type] - It indicates different types of channels,
|
|
1106
|
+
* such as store, website, and mobile apps, with 'store' being the default value.
|
|
1107
|
+
* @property {number} [cache_ttl] - An integer value that specifies the number
|
|
1108
|
+
* of seconds until the key expires
|
|
1109
|
+
* @property {boolean} [is_internal] - Indicates whether a sales channel is
|
|
1110
|
+
* internal or not
|
|
1111
|
+
* @property {boolean} [is_active] - Indicates sales channel is active or not active
|
|
1112
|
+
* @property {string} [_id] - The unique identifier of the sales channel
|
|
1113
|
+
* @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
|
|
1114
|
+
* @property {string} [owner] - The unique identifier of owner who owns the application
|
|
1115
|
+
* @property {number} [company_id] - Numeric ID allotted to a business account
|
|
1116
|
+
* where the sales channel exists
|
|
1117
|
+
* @property {string} [token] - Random generated fix length string for sales
|
|
1118
|
+
* channel. It is required and auto-generated.
|
|
1119
|
+
* @property {ApplicationRedirections[]} [redirections]
|
|
1120
|
+
* @property {ApplicationMeta[]} [meta]
|
|
1121
|
+
* @property {string} [created_at] - ISO 8601 timestamp of sales channel creation
|
|
1122
|
+
* @property {string} [modified_at] - ISO 8601 timestamp of sales channel updation
|
|
1123
|
+
* @property {number} [__v] - Version key for tracking revisions. Default value is zero.
|
|
1124
|
+
* @property {SecureUrl} [banner]
|
|
1125
|
+
* @property {SecureUrl} [logo]
|
|
1126
|
+
* @property {SecureUrl} [favicon]
|
|
1127
|
+
* @property {Domain[]} [domains]
|
|
1128
|
+
* @property {string} [app_type] - It shows application is live or in development mode.
|
|
1129
|
+
* @property {SecureUrl} [mobile_logo]
|
|
1130
|
+
* @property {Domain} [domain]
|
|
1131
|
+
* @property {string} [slug]
|
|
1132
|
+
* @property {string} [mode]
|
|
1133
|
+
* @property {string} [status]
|
|
1134
|
+
* @property {TokenSchemaID[]} [tokens]
|
|
1135
|
+
* @property {string} [secret]
|
|
1136
|
+
*/
|
|
1137
|
+
/**
|
|
1138
|
+
* @typedef TokenSchemaID
|
|
1139
|
+
* @property {string} [token]
|
|
1140
|
+
* @property {string} [created_by]
|
|
1141
|
+
* @property {string} [created_at] - ISO 8601 timestamp of when token created
|
|
1142
|
+
*/
|
|
1274
1143
|
/**
|
|
1275
1144
|
* @typedef TokenSchema
|
|
1276
1145
|
* @property {string} [token]
|
|
@@ -1278,55 +1147,9 @@ export = ConfigurationPlatformModel;
|
|
|
1278
1147
|
* @property {string} [created_at] - ISO 8601 timestamp of when token created
|
|
1279
1148
|
*/
|
|
1280
1149
|
/**
|
|
1281
|
-
* @typedef
|
|
1150
|
+
* @typedef InvalidPayloadRequestSchema
|
|
1282
1151
|
* @property {string} [message] - Error message when request body payload is improper
|
|
1283
1152
|
* @property {boolean} [success] - Flag for required not successfull.
|
|
1284
|
-
* @property {Object} [domain] - All errors related to domin
|
|
1285
|
-
*/
|
|
1286
|
-
/**
|
|
1287
|
-
* @typedef InventoryBrandRule
|
|
1288
|
-
* @property {string} [criteria] - Whether all brands are enabled, or explicitly
|
|
1289
|
-
* few brands in the inventory
|
|
1290
|
-
* @property {number[]} [brands]
|
|
1291
|
-
*/
|
|
1292
|
-
/**
|
|
1293
|
-
* @typedef PricingStrategy
|
|
1294
|
-
* @property {string} [value] - Indicates the pricing strategy value.
|
|
1295
|
-
*/
|
|
1296
|
-
/**
|
|
1297
|
-
* @typedef StoreCriteriaRule
|
|
1298
|
-
* @property {number[]} [companies] - List of company UID
|
|
1299
|
-
* @property {number[]} [brands] - List of brand UID
|
|
1300
|
-
*/
|
|
1301
|
-
/**
|
|
1302
|
-
* @typedef InventoryStoreRule
|
|
1303
|
-
* @property {string} [criteria] - Whether all stores are enabled, or explicitly
|
|
1304
|
-
* few stores in the inventory, or use brands and company filter.
|
|
1305
|
-
* @property {StoreCriteriaRule[]} [rules] - List of rules with company and
|
|
1306
|
-
* brands uids. Used when critera is `filter`.
|
|
1307
|
-
* @property {number[]} [stores] - List of store uids. Used when critera is `explicit`.
|
|
1308
|
-
*/
|
|
1309
|
-
/**
|
|
1310
|
-
* @typedef InventoryPaymentConfig
|
|
1311
|
-
* @property {string} [mode_of_payment] - Mode of payment for the inventory of
|
|
1312
|
-
* sales channel. It is required and default value is null.
|
|
1313
|
-
* @property {string} [source] - Source of the payment mode for the inventory
|
|
1314
|
-
* payment of sales channel. Default value is FYND.
|
|
1315
|
-
*/
|
|
1316
|
-
/**
|
|
1317
|
-
* @typedef StorePriorityRule
|
|
1318
|
-
* @property {boolean} [enabled] - Shows store priority is enabled or not
|
|
1319
|
-
* enabled for the article assignment.
|
|
1320
|
-
* @property {string[]} [storetype_order]
|
|
1321
|
-
*/
|
|
1322
|
-
/**
|
|
1323
|
-
* @typedef ArticleAssignmentRule
|
|
1324
|
-
* @property {StorePriorityRule} [store_priority]
|
|
1325
|
-
*/
|
|
1326
|
-
/**
|
|
1327
|
-
* @typedef InventoryArticleAssignment
|
|
1328
|
-
* @property {boolean} [post_order_reassignment] - Allow post order reassigment of article
|
|
1329
|
-
* @property {ArticleAssignmentRule} [rules]
|
|
1330
1153
|
*/
|
|
1331
1154
|
/**
|
|
1332
1155
|
* @typedef Page
|
|
@@ -1337,7 +1160,7 @@ export = ConfigurationPlatformModel;
|
|
|
1337
1160
|
* @property {number} [current] - The current page number.
|
|
1338
1161
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
1339
1162
|
* @property {number} [size] - The number of items per page.
|
|
1340
|
-
* @property {number} [
|
|
1163
|
+
* @property {number} [page_size] - The number of items per page.
|
|
1341
1164
|
*/
|
|
1342
1165
|
/**
|
|
1343
1166
|
* @typedef ApplicationInformation
|
|
@@ -1347,8 +1170,7 @@ export = ConfigurationPlatformModel;
|
|
|
1347
1170
|
* @property {Links[]} [links]
|
|
1348
1171
|
* @property {string} [copyright_text] - Copyright statement usually seen at the
|
|
1349
1172
|
* site's footer
|
|
1350
|
-
* @property {string} [_id] - Unique identifier
|
|
1351
|
-
* the application information
|
|
1173
|
+
* @property {string} [_id] - Unique identifier of the application information
|
|
1352
1174
|
* @property {BusinessHighlights[]} [business_highlights]
|
|
1353
1175
|
* @property {string} [application] - Alphanumeric ID allotted to a sales
|
|
1354
1176
|
* channel application created within a business account
|
|
@@ -1467,8 +1289,7 @@ export = ConfigurationPlatformModel;
|
|
|
1467
1289
|
*/
|
|
1468
1290
|
/**
|
|
1469
1291
|
* @typedef BusinessHighlights
|
|
1470
|
-
* @property {string} [_id] - Unique identifier
|
|
1471
|
-
* the related business
|
|
1292
|
+
* @property {string} [_id] - Unique identifier of the related business
|
|
1472
1293
|
* @property {string} [title] - Title of the business highlight, e.g. Superfast Delivery
|
|
1473
1294
|
* @property {string} [icon] - Hosted URL of icon image representing the
|
|
1474
1295
|
* business highlight
|
|
@@ -1485,19 +1306,18 @@ export = ConfigurationPlatformModel;
|
|
|
1485
1306
|
* @property {SecureUrl} [banner]
|
|
1486
1307
|
* @property {Domain} [domain]
|
|
1487
1308
|
* @property {Domain[]} [domains]
|
|
1488
|
-
* @property {string} [_id] - The unique identifier
|
|
1489
|
-
* for the sales channel details
|
|
1309
|
+
* @property {string} [_id] - The unique identifier for the sales channel details
|
|
1490
1310
|
* @property {string} [slug]
|
|
1491
1311
|
* @property {number} [company_id]
|
|
1492
1312
|
*/
|
|
1493
1313
|
/**
|
|
1494
|
-
* @typedef
|
|
1314
|
+
* @typedef CurrenciesResponseSchema
|
|
1495
1315
|
* @property {Currency[]} [items]
|
|
1496
1316
|
*/
|
|
1497
1317
|
/**
|
|
1498
|
-
* @typedef
|
|
1499
|
-
* @property {string} [_id] - The unique identifier
|
|
1500
|
-
*
|
|
1318
|
+
* @typedef AppCurrencyResponseSchema
|
|
1319
|
+
* @property {string} [_id] - The unique identifier of the currency
|
|
1320
|
+
* configuration supported by the application
|
|
1501
1321
|
* @property {string} [application] - Alphanumeric ID allotted to an application
|
|
1502
1322
|
* (sales channel website) created within a business account
|
|
1503
1323
|
* @property {DefaultCurrency} [default_currency]
|
|
@@ -1524,13 +1344,11 @@ export = ConfigurationPlatformModel;
|
|
|
1524
1344
|
* @property {string} [sector] - Sector for the opted store.
|
|
1525
1345
|
* @property {string} [country_code] - Country code of the selected country
|
|
1526
1346
|
* @property {string} [state_code] - Selected state code
|
|
1527
|
-
* @property {string} [landmark] - Landmark of the address
|
|
1528
1347
|
*/
|
|
1529
1348
|
/**
|
|
1530
1349
|
* @typedef OrderingStore
|
|
1531
1350
|
* @property {OptedStoreAddress} [address]
|
|
1532
|
-
* @property {string} [_id] - The unique identifier
|
|
1533
|
-
* of the ordering store
|
|
1351
|
+
* @property {string} [_id] - The unique identifier of the ordering store
|
|
1534
1352
|
* @property {number} [uid] - Ordering store UID
|
|
1535
1353
|
* @property {string} [name] - Store name of the ordering store
|
|
1536
1354
|
* @property {string} [display_name] - Display name of the ordering store
|
|
@@ -1549,134 +1367,97 @@ export = ConfigurationPlatformModel;
|
|
|
1549
1367
|
* @property {boolean} [enabled] - Allow ordering stores for current sales channel
|
|
1550
1368
|
* @property {string} [type] - For hard type delivery, store selection is
|
|
1551
1369
|
* compulsory. For soft type, delivery store selection is optional.
|
|
1552
|
-
* @property {string} [_id] - The unique identifier
|
|
1553
|
-
* of the ordering store
|
|
1370
|
+
* @property {string} [_id] - The unique identifier of the ordering store
|
|
1554
1371
|
* @property {string} [app] - Alphanumeric ID allotted to an application (sales
|
|
1555
1372
|
* channel website) created within a business account
|
|
1556
1373
|
* @property {number} [__v] - Version key for tracking ordering stores. Default
|
|
1557
1374
|
* value is zero.
|
|
1558
1375
|
*/
|
|
1559
1376
|
/**
|
|
1560
|
-
* @typedef
|
|
1561
|
-
* @property {string} type
|
|
1562
|
-
* @property {number} [interval]
|
|
1563
|
-
*/
|
|
1564
|
-
/**
|
|
1565
|
-
* @typedef PlatformVersionRequest
|
|
1566
|
-
* @property {string} app_code_name
|
|
1567
|
-
* @property {string} app_name
|
|
1568
|
-
* @property {string} force_version
|
|
1569
|
-
* @property {string} latest_version
|
|
1570
|
-
* @property {boolean} is_app_blocked
|
|
1571
|
-
* @property {UpdateDiealog} update_dialog
|
|
1572
|
-
*/
|
|
1573
|
-
/**
|
|
1574
|
-
* @typedef PlatformVersion
|
|
1575
|
-
* @property {string} app_code_name
|
|
1576
|
-
* @property {string} app_name
|
|
1577
|
-
* @property {string} force_version
|
|
1578
|
-
* @property {string} latest_version
|
|
1579
|
-
* @property {boolean} is_app_blocked
|
|
1580
|
-
* @property {UpdateDiealog} update_dialog
|
|
1581
|
-
* @property {string} [_id]
|
|
1582
|
-
* @property {string} [modified_at] - ISO 8601 timestamp when currency was added
|
|
1583
|
-
* in the list of currencies supported by the sales channel
|
|
1584
|
-
* @property {string} [created_at] - ISO 8601 timestamp when currency was added
|
|
1585
|
-
* in the list of currencies supported by the sales channel
|
|
1586
|
-
* @property {number} [__v]
|
|
1587
|
-
*/
|
|
1588
|
-
/**
|
|
1589
|
-
* @typedef OrderingStoresResponse
|
|
1377
|
+
* @typedef OrderingStoresResponseSchema
|
|
1590
1378
|
* @property {Page} [page]
|
|
1591
1379
|
* @property {OrderingStore[]} [items]
|
|
1592
1380
|
*/
|
|
1593
1381
|
/**
|
|
1594
|
-
* @typedef
|
|
1595
|
-
* @property {
|
|
1596
|
-
* @property {string} [code]
|
|
1597
|
-
*/
|
|
1598
|
-
/**
|
|
1599
|
-
* @typedef LocationDefaultCurrency
|
|
1600
|
-
* @property {string} [name]
|
|
1601
|
-
* @property {string} [symbol]
|
|
1602
|
-
* @property {string} [code]
|
|
1603
|
-
*/
|
|
1604
|
-
/**
|
|
1605
|
-
* @typedef LocationCountry
|
|
1606
|
-
* @property {string} [capital]
|
|
1607
|
-
* @property {string} [currency]
|
|
1608
|
-
* @property {string} [iso2]
|
|
1609
|
-
* @property {string} [iso3]
|
|
1610
|
-
* @property {string} [name]
|
|
1611
|
-
* @property {string} [parent]
|
|
1612
|
-
* @property {string} [phone_code]
|
|
1613
|
-
* @property {string} [type]
|
|
1614
|
-
* @property {number} [uid]
|
|
1615
|
-
* @property {number} [__v]
|
|
1616
|
-
* @property {string} [_id]
|
|
1617
|
-
* @property {LocationDefaultCurrency} [default_currency]
|
|
1618
|
-
* @property {LocationDefaultLanguage} [default_language]
|
|
1619
|
-
* @property {string} [state_code]
|
|
1620
|
-
* @property {string} [country_code]
|
|
1621
|
-
* @property {string} [latitude]
|
|
1622
|
-
* @property {string} [longitude]
|
|
1623
|
-
*/
|
|
1624
|
-
/**
|
|
1625
|
-
* @typedef Locations
|
|
1626
|
-
* @property {LocationCountry[]} [items]
|
|
1627
|
-
*/
|
|
1628
|
-
/**
|
|
1629
|
-
* @typedef UrlRedirectionResponse
|
|
1630
|
-
* @property {UrlRedirection[]} [redirections]
|
|
1631
|
-
*/
|
|
1632
|
-
/**
|
|
1633
|
-
* @typedef UrlRedirectionRequest
|
|
1634
|
-
* @property {UrlRedirection} [redirection]
|
|
1635
|
-
*/
|
|
1636
|
-
/**
|
|
1637
|
-
* @typedef UrlRedirection
|
|
1638
|
-
* @property {string} [redirect_from]
|
|
1639
|
-
* @property {string} [redirect_to]
|
|
1640
|
-
* @property {string} [type]
|
|
1641
|
-
* @property {string} [_id]
|
|
1642
|
-
*/
|
|
1643
|
-
/**
|
|
1644
|
-
* @typedef StoreForConfigurationRequest
|
|
1645
|
-
* @property {AppStoreRules[]} [conf]
|
|
1646
|
-
*/
|
|
1647
|
-
/**
|
|
1648
|
-
* @typedef DomainOptionsResponse
|
|
1649
|
-
* @property {DomainType[]} [domain_types]
|
|
1650
|
-
* @property {string[]} [network_ips]
|
|
1651
|
-
* @property {string[]} [network_cnames]
|
|
1652
|
-
*/
|
|
1653
|
-
/**
|
|
1654
|
-
* @typedef DomainType
|
|
1655
|
-
* @property {string} [key]
|
|
1656
|
-
* @property {string} [display]
|
|
1657
|
-
* @property {DomainValue[]} [values]
|
|
1658
|
-
*/
|
|
1659
|
-
/**
|
|
1660
|
-
* @typedef DomainValue
|
|
1661
|
-
* @property {string} [value]
|
|
1662
|
-
* @property {string} [text]
|
|
1663
|
-
*/
|
|
1664
|
-
/**
|
|
1665
|
-
* @typedef StoreRequest
|
|
1666
|
-
* @property {number[]} [companies]
|
|
1382
|
+
* @typedef ValidationErrors
|
|
1383
|
+
* @property {ValidationError[]} errors - A list of validation errors in the request.
|
|
1667
1384
|
*/
|
|
1668
1385
|
/**
|
|
1669
|
-
* @typedef
|
|
1670
|
-
* @property {
|
|
1386
|
+
* @typedef ValidationError
|
|
1387
|
+
* @property {string} message - A brief description of the error encountered.
|
|
1388
|
+
* @property {string} field - The field in the request that caused the error.
|
|
1671
1389
|
*/
|
|
1672
1390
|
declare class ConfigurationPlatformModel {
|
|
1673
1391
|
}
|
|
1674
1392
|
declare namespace ConfigurationPlatformModel {
|
|
1675
|
-
export { ApplicationInventory, PiiMasking,
|
|
1393
|
+
export { CurrencyExchangeResponseV2, CurrencyExchangeItem, ApplicationInventory, PiiMasking, FstIdentification, QuerySuggestions, SearchConfig, 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, CompanyByBrandsRequestSchema, CompanyByBrandsResponseSchema, StoreByBrandsRequestSchema, StoreByBrandsResponseSchema, BrandStoreInfo, CompanyBrandInfo, BrandsByCompanyResponseSchema, ValidationFailedResponseSchema, NotFound, CommunicationConfig, CommsConfig, PanCardConfig, CreateApplicationRequestSchema, CreateAppResponseSchema, ApplicationsResponseSchema, MobileAppConfiguration, LandingImage, SplashImage, MobileAppConfigRequestSchema, BuildVersionHistory, BuildVersion, AppSupportedCurrency, DefaultCurrency, DomainAdd, DomainAddRequestSchema, Domain, DomainsResponseSchema, UpdateDomain, UpdateDomainTypeRequestSchema, DomainStatusRequestSchema, DomainStatus, DomainStatusResponseSchema, DomainSuggestionsRequestSchema, DomainSuggestion, DomainSuggestionsResponseSchema, SuccessMessageResponseSchema, App, AppDomain, CompaniesResponseSchema, AppInventoryCompanies, StoresResponseSchema, AppInventoryStores, FilterOrderingStoreRequestSchema, DeploymentMeta, OrderingStoreConfig, OrderingStoreSelectRequestSchema, OrderingStoreSelect, OtherSellerCompany, OtherSellerApplication, OtherSellerApplications, OptedApplicationResponseSchema, OptedCompany, OptedInventory, OptType, OptedStore, OptOutInventory, TokenResponseSchema, 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, BuyboxFeature, DeliveryStrategy, AppFeature, HomePageFeature, CommonFeature, InternationalShipping, CommunicationOptinDialogFeature, DeploymentStoreSelectionFeature, ListingPriceFeature, CurrencyFeature, RevenueEngineFeature, FeedbackFeature, CompareProductsFeature, CartFeature, QrFeature, PcrFeature, OrderFeature, AppFeatureRequestSchema, AppFeatureResponseSchema, Currency, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, ApplicationById, TokenSchemaID, TokenSchema, InvalidPayloadRequestSchema, Page, ApplicationInformation, InformationAddress, InformationPhone, InformationLoc, InformationSupport, InformationSupportPhone, InformationSupportEmail, SocialLinks, FacebookLink, InstagramLink, TwitterLink, PinterestLink, GooglePlusLink, YoutubeLink, LinkedInLink, VimeoLink, BlogLink, Links, BusinessHighlights, ApplicationDetail, CurrenciesResponseSchema, AppCurrencyResponseSchema, StoreLatLong, OptedStoreAddress, OrderingStore, OrderingStores, OrderingStoresResponseSchema, ValidationErrors, ValidationError };
|
|
1676
1394
|
}
|
|
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
|
+
};
|
|
1677
1457
|
/** @returns {ApplicationInventory} */
|
|
1678
1458
|
declare function ApplicationInventory(): ApplicationInventory;
|
|
1679
1459
|
type ApplicationInventory = {
|
|
1460
|
+
search?: SearchConfig;
|
|
1680
1461
|
inventory?: AppInventoryConfig;
|
|
1681
1462
|
authentication?: AuthenticationConfig;
|
|
1682
1463
|
article_assignment?: ArticleAssignmentConfig;
|
|
@@ -1701,8 +1482,7 @@ type ApplicationInventory = {
|
|
|
1701
1482
|
communication?: CommunicationConfig;
|
|
1702
1483
|
platforms?: string[];
|
|
1703
1484
|
/**
|
|
1704
|
-
* - The unique identifier
|
|
1705
|
-
* of the sales channel inventory
|
|
1485
|
+
* - The unique identifier of the sales channel inventory
|
|
1706
1486
|
*/
|
|
1707
1487
|
_id?: string;
|
|
1708
1488
|
loyalty_points?: LoyaltyPointsConfig;
|
|
@@ -1731,25 +1511,45 @@ declare function PiiMasking(): PiiMasking;
|
|
|
1731
1511
|
type PiiMasking = {
|
|
1732
1512
|
enabled?: boolean;
|
|
1733
1513
|
};
|
|
1734
|
-
/** @returns {
|
|
1735
|
-
declare function
|
|
1736
|
-
type
|
|
1737
|
-
|
|
1514
|
+
/** @returns {FstIdentification} */
|
|
1515
|
+
declare function FstIdentification(): FstIdentification;
|
|
1516
|
+
type FstIdentification = {
|
|
1517
|
+
/**
|
|
1518
|
+
* - Indicates whether search query interpretation
|
|
1519
|
+
* is enabled for the application.
|
|
1520
|
+
*/
|
|
1521
|
+
enabled?: boolean;
|
|
1522
|
+
};
|
|
1523
|
+
/** @returns {QuerySuggestions} */
|
|
1524
|
+
declare function QuerySuggestions(): QuerySuggestions;
|
|
1525
|
+
type QuerySuggestions = {
|
|
1526
|
+
/**
|
|
1527
|
+
* - Indicates whether to enable or disable query
|
|
1528
|
+
* suggestions powered by the GPT model using the current live catalog within
|
|
1529
|
+
* the application.
|
|
1530
|
+
*/
|
|
1531
|
+
enabled?: boolean;
|
|
1532
|
+
/**
|
|
1533
|
+
* - Specifies the maximum number of query
|
|
1534
|
+
* suggestions that can be returned.
|
|
1535
|
+
*/
|
|
1536
|
+
max_limit?: number;
|
|
1738
1537
|
};
|
|
1739
|
-
/** @returns {
|
|
1740
|
-
declare function
|
|
1741
|
-
type
|
|
1742
|
-
|
|
1538
|
+
/** @returns {SearchConfig} */
|
|
1539
|
+
declare function SearchConfig(): SearchConfig;
|
|
1540
|
+
type SearchConfig = {
|
|
1541
|
+
fst_identification?: FstIdentification;
|
|
1542
|
+
query_suggestions?: QuerySuggestions;
|
|
1743
1543
|
};
|
|
1744
1544
|
/** @returns {AppInventoryConfig} */
|
|
1745
1545
|
declare function AppInventoryConfig(): AppInventoryConfig;
|
|
1746
1546
|
type AppInventoryConfig = {
|
|
1547
|
+
delivery_strategy?: DeliveryStrategy;
|
|
1747
1548
|
brand?: InventoryBrand;
|
|
1748
1549
|
store?: InventoryStore;
|
|
1749
1550
|
category?: InventoryCategory;
|
|
1750
1551
|
price?: InventoryPrice;
|
|
1751
1552
|
discount?: InventoryDiscount;
|
|
1752
|
-
pricing_strategy?: PricingStrategy;
|
|
1753
1553
|
/**
|
|
1754
1554
|
* - Indicates whether out of stock products
|
|
1755
1555
|
* are allowed to show up on the website
|
|
@@ -1768,13 +1568,13 @@ type AppInventoryConfig = {
|
|
|
1768
1568
|
/**
|
|
1769
1569
|
* - List of excluded brands category
|
|
1770
1570
|
*/
|
|
1771
|
-
exclude_category?:
|
|
1571
|
+
exclude_category?: any[];
|
|
1772
1572
|
image?: string[];
|
|
1773
1573
|
/**
|
|
1774
1574
|
* - List of selling locations whose
|
|
1775
1575
|
* inventory is available to the sales channel for displaying on the website
|
|
1776
1576
|
*/
|
|
1777
|
-
company_store?:
|
|
1577
|
+
company_store?: any[];
|
|
1778
1578
|
company_id?: number;
|
|
1779
1579
|
};
|
|
1780
1580
|
/** @returns {InventoryBrand} */
|
|
@@ -1801,7 +1601,7 @@ type InventoryStore = {
|
|
|
1801
1601
|
/**
|
|
1802
1602
|
* - List of stores
|
|
1803
1603
|
*/
|
|
1804
|
-
stores?:
|
|
1604
|
+
stores?: any[];
|
|
1805
1605
|
/**
|
|
1806
1606
|
* - Rules to show which brands or companies
|
|
1807
1607
|
* products should be listed on sales channel.
|
|
@@ -1830,7 +1630,7 @@ type InventoryCategory = {
|
|
|
1830
1630
|
* - List of categories whose products will be
|
|
1831
1631
|
* shown on the website
|
|
1832
1632
|
*/
|
|
1833
|
-
categories?:
|
|
1633
|
+
categories?: any[];
|
|
1834
1634
|
};
|
|
1835
1635
|
/** @returns {InventoryPrice} */
|
|
1836
1636
|
declare function InventoryPrice(): InventoryPrice;
|
|
@@ -1896,7 +1696,7 @@ type StorePriority = {
|
|
|
1896
1696
|
* - List of store types for article
|
|
1897
1697
|
* assignment e.g. warehouse, mall, highstreet
|
|
1898
1698
|
*/
|
|
1899
|
-
storetype_order?:
|
|
1699
|
+
storetype_order?: any[];
|
|
1900
1700
|
};
|
|
1901
1701
|
/** @returns {AppCartConfig} */
|
|
1902
1702
|
declare function AppCartConfig(): AppCartConfig;
|
|
@@ -2099,6 +1899,7 @@ type LoyaltyPointsConfig = {
|
|
|
2099
1899
|
/** @returns {AppInventoryPartialUpdate} */
|
|
2100
1900
|
declare function AppInventoryPartialUpdate(): AppInventoryPartialUpdate;
|
|
2101
1901
|
type AppInventoryPartialUpdate = {
|
|
1902
|
+
search?: SearchConfig;
|
|
2102
1903
|
reward_points?: RewardPointsConfig;
|
|
2103
1904
|
cart?: AppCartConfig;
|
|
2104
1905
|
payment?: AppPaymentConfig;
|
|
@@ -2122,9 +1923,9 @@ type BrandCompanyInfo = {
|
|
|
2122
1923
|
*/
|
|
2123
1924
|
company_id?: number;
|
|
2124
1925
|
};
|
|
2125
|
-
/** @returns {
|
|
2126
|
-
declare function
|
|
2127
|
-
type
|
|
1926
|
+
/** @returns {CompanyByBrandsRequestSchema} */
|
|
1927
|
+
declare function CompanyByBrandsRequestSchema(): CompanyByBrandsRequestSchema;
|
|
1928
|
+
type CompanyByBrandsRequestSchema = {
|
|
2128
1929
|
/**
|
|
2129
1930
|
* - Brand UID
|
|
2130
1931
|
*/
|
|
@@ -2134,15 +1935,15 @@ type CompanyByBrandsRequest = {
|
|
|
2134
1935
|
*/
|
|
2135
1936
|
search_text?: string;
|
|
2136
1937
|
};
|
|
2137
|
-
/** @returns {
|
|
2138
|
-
declare function
|
|
2139
|
-
type
|
|
1938
|
+
/** @returns {CompanyByBrandsResponseSchema} */
|
|
1939
|
+
declare function CompanyByBrandsResponseSchema(): CompanyByBrandsResponseSchema;
|
|
1940
|
+
type CompanyByBrandsResponseSchema = {
|
|
2140
1941
|
items?: BrandCompanyInfo[];
|
|
2141
1942
|
page?: Page;
|
|
2142
1943
|
};
|
|
2143
|
-
/** @returns {
|
|
2144
|
-
declare function
|
|
2145
|
-
type
|
|
1944
|
+
/** @returns {StoreByBrandsRequestSchema} */
|
|
1945
|
+
declare function StoreByBrandsRequestSchema(): StoreByBrandsRequestSchema;
|
|
1946
|
+
type StoreByBrandsRequestSchema = {
|
|
2146
1947
|
/**
|
|
2147
1948
|
* - Current company ID for current company
|
|
2148
1949
|
* stores only. Don't send in case cross-selling (franchise) is enabled.
|
|
@@ -2157,9 +1958,9 @@ type StoreByBrandsRequest = {
|
|
|
2157
1958
|
*/
|
|
2158
1959
|
search_text?: string;
|
|
2159
1960
|
};
|
|
2160
|
-
/** @returns {
|
|
2161
|
-
declare function
|
|
2162
|
-
type
|
|
1961
|
+
/** @returns {StoreByBrandsResponseSchema} */
|
|
1962
|
+
declare function StoreByBrandsResponseSchema(): StoreByBrandsResponseSchema;
|
|
1963
|
+
type StoreByBrandsResponseSchema = {
|
|
2163
1964
|
items?: BrandStoreInfo[];
|
|
2164
1965
|
page?: Page;
|
|
2165
1966
|
};
|
|
@@ -2212,22 +2013,18 @@ type CompanyBrandInfo = {
|
|
|
2212
2013
|
*/
|
|
2213
2014
|
brand_banner_portrait_url?: string;
|
|
2214
2015
|
};
|
|
2215
|
-
/** @returns {
|
|
2216
|
-
declare function
|
|
2217
|
-
type
|
|
2016
|
+
/** @returns {BrandsByCompanyResponseSchema} */
|
|
2017
|
+
declare function BrandsByCompanyResponseSchema(): BrandsByCompanyResponseSchema;
|
|
2018
|
+
type BrandsByCompanyResponseSchema = {
|
|
2218
2019
|
brands?: CompanyBrandInfo[];
|
|
2219
2020
|
};
|
|
2220
|
-
/** @returns {
|
|
2221
|
-
declare function
|
|
2222
|
-
type
|
|
2021
|
+
/** @returns {ValidationFailedResponseSchema} */
|
|
2022
|
+
declare function ValidationFailedResponseSchema(): ValidationFailedResponseSchema;
|
|
2023
|
+
type ValidationFailedResponseSchema = {
|
|
2223
2024
|
/**
|
|
2224
2025
|
* - Response message for failed validation
|
|
2225
2026
|
*/
|
|
2226
2027
|
message?: string;
|
|
2227
|
-
/**
|
|
2228
|
-
* - Response message for failed validation
|
|
2229
|
-
*/
|
|
2230
|
-
errors?: any[];
|
|
2231
2028
|
};
|
|
2232
2029
|
/** @returns {NotFound} */
|
|
2233
2030
|
declare function NotFound(): NotFound;
|
|
@@ -2236,14 +2033,6 @@ type NotFound = {
|
|
|
2236
2033
|
* - Response message for not found
|
|
2237
2034
|
*/
|
|
2238
2035
|
message?: string;
|
|
2239
|
-
/**
|
|
2240
|
-
* - Error message for not found
|
|
2241
|
-
*/
|
|
2242
|
-
error?: string;
|
|
2243
|
-
/**
|
|
2244
|
-
* - Unique code for each error
|
|
2245
|
-
*/
|
|
2246
|
-
code?: string;
|
|
2247
2036
|
/**
|
|
2248
2037
|
* - Flag for required not successfull.
|
|
2249
2038
|
*/
|
|
@@ -2282,22 +2071,22 @@ type PanCardConfig = {
|
|
|
2282
2071
|
*/
|
|
2283
2072
|
online_threshold_amount?: number;
|
|
2284
2073
|
};
|
|
2285
|
-
/** @returns {
|
|
2286
|
-
declare function
|
|
2287
|
-
type
|
|
2074
|
+
/** @returns {CreateApplicationRequestSchema} */
|
|
2075
|
+
declare function CreateApplicationRequestSchema(): CreateApplicationRequestSchema;
|
|
2076
|
+
type CreateApplicationRequestSchema = {
|
|
2288
2077
|
app?: App;
|
|
2289
2078
|
configuration?: ApplicationInventory;
|
|
2290
2079
|
domain?: AppDomain;
|
|
2291
2080
|
};
|
|
2292
|
-
/** @returns {
|
|
2293
|
-
declare function
|
|
2294
|
-
type
|
|
2081
|
+
/** @returns {CreateAppResponseSchema} */
|
|
2082
|
+
declare function CreateAppResponseSchema(): CreateAppResponseSchema;
|
|
2083
|
+
type CreateAppResponseSchema = {
|
|
2295
2084
|
app?: Application;
|
|
2296
2085
|
configuration?: ApplicationInventory;
|
|
2297
2086
|
};
|
|
2298
|
-
/** @returns {
|
|
2299
|
-
declare function
|
|
2300
|
-
type
|
|
2087
|
+
/** @returns {ApplicationsResponseSchema} */
|
|
2088
|
+
declare function ApplicationsResponseSchema(): ApplicationsResponseSchema;
|
|
2089
|
+
type ApplicationsResponseSchema = {
|
|
2301
2090
|
items?: Application[];
|
|
2302
2091
|
page?: Page;
|
|
2303
2092
|
};
|
|
@@ -2309,8 +2098,7 @@ type MobileAppConfiguration = {
|
|
|
2309
2098
|
*/
|
|
2310
2099
|
is_active?: boolean;
|
|
2311
2100
|
/**
|
|
2312
|
-
* - The unique identifier
|
|
2313
|
-
* for mobile application configuration
|
|
2101
|
+
* - The unique identifier for mobile application configuration
|
|
2314
2102
|
*/
|
|
2315
2103
|
_id?: string;
|
|
2316
2104
|
/**
|
|
@@ -2372,9 +2160,9 @@ type SplashImage = {
|
|
|
2372
2160
|
*/
|
|
2373
2161
|
secure_url?: string;
|
|
2374
2162
|
};
|
|
2375
|
-
/** @returns {
|
|
2376
|
-
declare function
|
|
2377
|
-
type
|
|
2163
|
+
/** @returns {MobileAppConfigRequestSchema} */
|
|
2164
|
+
declare function MobileAppConfigRequestSchema(): MobileAppConfigRequestSchema;
|
|
2165
|
+
type MobileAppConfigRequestSchema = {
|
|
2378
2166
|
/**
|
|
2379
2167
|
* - Name of the mobile app
|
|
2380
2168
|
*/
|
|
@@ -2400,7 +2188,7 @@ type BuildVersionHistory = {
|
|
|
2400
2188
|
declare function BuildVersion(): BuildVersion;
|
|
2401
2189
|
type BuildVersion = {
|
|
2402
2190
|
/**
|
|
2403
|
-
* -
|
|
2191
|
+
* - Primary Identifier of the build version.
|
|
2404
2192
|
*/
|
|
2405
2193
|
_id?: string;
|
|
2406
2194
|
/**
|
|
@@ -2446,8 +2234,8 @@ type BuildVersion = {
|
|
|
2446
2234
|
declare function AppSupportedCurrency(): AppSupportedCurrency;
|
|
2447
2235
|
type AppSupportedCurrency = {
|
|
2448
2236
|
/**
|
|
2449
|
-
* - The unique identifier
|
|
2450
|
-
*
|
|
2237
|
+
* - The unique identifier of the currency
|
|
2238
|
+
* configuration supported by the application
|
|
2451
2239
|
*/
|
|
2452
2240
|
_id?: string;
|
|
2453
2241
|
supported_currency?: string[];
|
|
@@ -2472,8 +2260,7 @@ type AppSupportedCurrency = {
|
|
|
2472
2260
|
declare function DefaultCurrency(): DefaultCurrency;
|
|
2473
2261
|
type DefaultCurrency = {
|
|
2474
2262
|
/**
|
|
2475
|
-
* - The unique identifier
|
|
2476
|
-
* of the default currency
|
|
2263
|
+
* - The unique identifier of the default currency
|
|
2477
2264
|
*/
|
|
2478
2265
|
ref?: string;
|
|
2479
2266
|
/**
|
|
@@ -2490,8 +2277,7 @@ type DomainAdd = {
|
|
|
2490
2277
|
*/
|
|
2491
2278
|
name?: string;
|
|
2492
2279
|
/**
|
|
2493
|
-
* - The unique identifier
|
|
2494
|
-
* of the domain
|
|
2280
|
+
* - The unique identifier of the domain
|
|
2495
2281
|
*/
|
|
2496
2282
|
_id?: string;
|
|
2497
2283
|
/**
|
|
@@ -2516,9 +2302,9 @@ type DomainAdd = {
|
|
|
2516
2302
|
message?: string;
|
|
2517
2303
|
txt_records?: string[];
|
|
2518
2304
|
};
|
|
2519
|
-
/** @returns {
|
|
2520
|
-
declare function
|
|
2521
|
-
type
|
|
2305
|
+
/** @returns {DomainAddRequestSchema} */
|
|
2306
|
+
declare function DomainAddRequestSchema(): DomainAddRequestSchema;
|
|
2307
|
+
type DomainAddRequestSchema = {
|
|
2522
2308
|
domain?: DomainAdd;
|
|
2523
2309
|
};
|
|
2524
2310
|
/** @returns {Domain} */
|
|
@@ -2529,8 +2315,7 @@ type Domain = {
|
|
|
2529
2315
|
*/
|
|
2530
2316
|
name?: string;
|
|
2531
2317
|
/**
|
|
2532
|
-
* - The unique identifier
|
|
2533
|
-
* of the sales channel domain
|
|
2318
|
+
* - The unique identifier of the sales channel domain
|
|
2534
2319
|
*/
|
|
2535
2320
|
_id?: string;
|
|
2536
2321
|
/**
|
|
@@ -2553,9 +2338,9 @@ type Domain = {
|
|
|
2553
2338
|
is_predefined?: boolean;
|
|
2554
2339
|
message?: string;
|
|
2555
2340
|
};
|
|
2556
|
-
/** @returns {
|
|
2557
|
-
declare function
|
|
2558
|
-
type
|
|
2341
|
+
/** @returns {DomainsResponseSchema} */
|
|
2342
|
+
declare function DomainsResponseSchema(): DomainsResponseSchema;
|
|
2343
|
+
type DomainsResponseSchema = {
|
|
2559
2344
|
domains?: Domain[];
|
|
2560
2345
|
};
|
|
2561
2346
|
/** @returns {UpdateDomain} */
|
|
@@ -2566,8 +2351,7 @@ type UpdateDomain = {
|
|
|
2566
2351
|
*/
|
|
2567
2352
|
name?: string;
|
|
2568
2353
|
/**
|
|
2569
|
-
* - The unique identifier
|
|
2570
|
-
* of the domain
|
|
2354
|
+
* - The unique identifier of the domain
|
|
2571
2355
|
*/
|
|
2572
2356
|
_id?: string;
|
|
2573
2357
|
/**
|
|
@@ -2586,9 +2370,9 @@ type UpdateDomain = {
|
|
|
2586
2370
|
*/
|
|
2587
2371
|
is_shortlink?: boolean;
|
|
2588
2372
|
};
|
|
2589
|
-
/** @returns {
|
|
2590
|
-
declare function
|
|
2591
|
-
type
|
|
2373
|
+
/** @returns {UpdateDomainTypeRequestSchema} */
|
|
2374
|
+
declare function UpdateDomainTypeRequestSchema(): UpdateDomainTypeRequestSchema;
|
|
2375
|
+
type UpdateDomainTypeRequestSchema = {
|
|
2592
2376
|
domain?: UpdateDomain;
|
|
2593
2377
|
/**
|
|
2594
2378
|
* - Shows domain is made primary domain for the
|
|
@@ -2596,9 +2380,9 @@ type UpdateDomainTypeRequest = {
|
|
|
2596
2380
|
*/
|
|
2597
2381
|
action?: string;
|
|
2598
2382
|
};
|
|
2599
|
-
/** @returns {
|
|
2600
|
-
declare function
|
|
2601
|
-
type
|
|
2383
|
+
/** @returns {DomainStatusRequestSchema} */
|
|
2384
|
+
declare function DomainStatusRequestSchema(): DomainStatusRequestSchema;
|
|
2385
|
+
type DomainStatusRequestSchema = {
|
|
2602
2386
|
/**
|
|
2603
2387
|
* - URL of the domain, e.g. uniket.hostx0.de
|
|
2604
2388
|
*/
|
|
@@ -2617,9 +2401,9 @@ type DomainStatus = {
|
|
|
2617
2401
|
*/
|
|
2618
2402
|
status?: boolean;
|
|
2619
2403
|
};
|
|
2620
|
-
/** @returns {
|
|
2621
|
-
declare function
|
|
2622
|
-
type
|
|
2404
|
+
/** @returns {DomainStatusResponseSchema} */
|
|
2405
|
+
declare function DomainStatusResponseSchema(): DomainStatusResponseSchema;
|
|
2406
|
+
type DomainStatusResponseSchema = {
|
|
2623
2407
|
/**
|
|
2624
2408
|
* - Check if domain is live and mapped to
|
|
2625
2409
|
* appropriate IP of Fynd Servers
|
|
@@ -2627,13 +2411,18 @@ type DomainStatusResponse = {
|
|
|
2627
2411
|
connected?: boolean;
|
|
2628
2412
|
status?: DomainStatus[];
|
|
2629
2413
|
};
|
|
2630
|
-
/** @returns {
|
|
2631
|
-
declare function
|
|
2632
|
-
type
|
|
2414
|
+
/** @returns {DomainSuggestionsRequestSchema} */
|
|
2415
|
+
declare function DomainSuggestionsRequestSchema(): DomainSuggestionsRequestSchema;
|
|
2416
|
+
type DomainSuggestionsRequestSchema = {
|
|
2633
2417
|
/**
|
|
2634
2418
|
* - Domain url
|
|
2635
2419
|
*/
|
|
2636
2420
|
domain_url?: string;
|
|
2421
|
+
/**
|
|
2422
|
+
* - Get suggestions for custom domains or
|
|
2423
|
+
* Fynd domains
|
|
2424
|
+
*/
|
|
2425
|
+
custom_domain?: boolean;
|
|
2637
2426
|
};
|
|
2638
2427
|
/** @returns {DomainSuggestion} */
|
|
2639
2428
|
declare function DomainSuggestion(): DomainSuggestion;
|
|
@@ -2661,17 +2450,17 @@ type DomainSuggestion = {
|
|
|
2661
2450
|
*/
|
|
2662
2451
|
currency?: string;
|
|
2663
2452
|
};
|
|
2664
|
-
/** @returns {
|
|
2665
|
-
declare function
|
|
2666
|
-
type
|
|
2453
|
+
/** @returns {DomainSuggestionsResponseSchema} */
|
|
2454
|
+
declare function DomainSuggestionsResponseSchema(): DomainSuggestionsResponseSchema;
|
|
2455
|
+
type DomainSuggestionsResponseSchema = {
|
|
2667
2456
|
/**
|
|
2668
2457
|
* - Domain URL
|
|
2669
2458
|
*/
|
|
2670
2459
|
domains?: DomainSuggestion[];
|
|
2671
2460
|
};
|
|
2672
|
-
/** @returns {
|
|
2673
|
-
declare function
|
|
2674
|
-
type
|
|
2461
|
+
/** @returns {SuccessMessageResponseSchema} */
|
|
2462
|
+
declare function SuccessMessageResponseSchema(): SuccessMessageResponseSchema;
|
|
2463
|
+
type SuccessMessageResponseSchema = {
|
|
2675
2464
|
/**
|
|
2676
2465
|
* - Shows whether domain was deleted successfully
|
|
2677
2466
|
*/
|
|
@@ -2681,481 +2470,81 @@ type SuccessMessageResponse = {
|
|
|
2681
2470
|
*/
|
|
2682
2471
|
message?: string;
|
|
2683
2472
|
};
|
|
2684
|
-
/** @returns {
|
|
2685
|
-
declare function
|
|
2686
|
-
type
|
|
2687
|
-
items?: IntegrationOptIn[];
|
|
2688
|
-
page?: Page;
|
|
2689
|
-
};
|
|
2690
|
-
/** @returns {IntegrationOptIn} */
|
|
2691
|
-
declare function IntegrationOptIn(): IntegrationOptIn;
|
|
2692
|
-
type IntegrationOptIn = {
|
|
2693
|
-
validators?: Validators;
|
|
2694
|
-
/**
|
|
2695
|
-
* - Basic description about the opted integration
|
|
2696
|
-
*/
|
|
2697
|
-
description?: string;
|
|
2473
|
+
/** @returns {App} */
|
|
2474
|
+
declare function App(): App;
|
|
2475
|
+
type App = {
|
|
2698
2476
|
/**
|
|
2699
|
-
* -
|
|
2700
|
-
*
|
|
2477
|
+
* - Numeric ID allotted to a business account
|
|
2478
|
+
* on Fynd Platform.
|
|
2701
2479
|
*/
|
|
2702
|
-
|
|
2703
|
-
constants?: string;
|
|
2704
|
-
companies?: string[];
|
|
2705
|
-
support?: string[];
|
|
2480
|
+
company_id?: string;
|
|
2706
2481
|
/**
|
|
2707
|
-
* -
|
|
2708
|
-
*
|
|
2482
|
+
* - It indicates different channel types like
|
|
2483
|
+
* store, website-and-mobile-apps. Default value is store
|
|
2709
2484
|
*/
|
|
2710
|
-
|
|
2485
|
+
channel_type?: string;
|
|
2486
|
+
auth?: ApplicationAuth;
|
|
2711
2487
|
/**
|
|
2712
|
-
* -
|
|
2488
|
+
* - User-friendly name for sales channel, e.g. Zenz Fashion
|
|
2713
2489
|
*/
|
|
2714
2490
|
name?: string;
|
|
2715
2491
|
/**
|
|
2716
|
-
* -
|
|
2492
|
+
* - Detailed description about the sales channel
|
|
2717
2493
|
*/
|
|
2718
|
-
|
|
2719
|
-
|
|
2720
|
-
|
|
2494
|
+
desc?: string;
|
|
2495
|
+
};
|
|
2496
|
+
/** @returns {AppDomain} */
|
|
2497
|
+
declare function AppDomain(): AppDomain;
|
|
2498
|
+
type AppDomain = {
|
|
2721
2499
|
/**
|
|
2722
|
-
* -
|
|
2500
|
+
* - Domain URL of current sales channel, e.g. zenz.com
|
|
2723
2501
|
*/
|
|
2724
|
-
|
|
2502
|
+
name?: string;
|
|
2503
|
+
};
|
|
2504
|
+
/** @returns {CompaniesResponseSchema} */
|
|
2505
|
+
declare function CompaniesResponseSchema(): CompaniesResponseSchema;
|
|
2506
|
+
type CompaniesResponseSchema = {
|
|
2507
|
+
items?: AppInventoryCompanies[];
|
|
2508
|
+
page?: Page;
|
|
2509
|
+
};
|
|
2510
|
+
/** @returns {AppInventoryCompanies} */
|
|
2511
|
+
declare function AppInventoryCompanies(): AppInventoryCompanies;
|
|
2512
|
+
type AppInventoryCompanies = {
|
|
2725
2513
|
/**
|
|
2726
|
-
* -
|
|
2727
|
-
* of the user who created the integration
|
|
2514
|
+
* - UID of the company, e.g. 108
|
|
2728
2515
|
*/
|
|
2729
|
-
|
|
2516
|
+
uid?: number;
|
|
2730
2517
|
/**
|
|
2731
|
-
* -
|
|
2518
|
+
* - Name of the company, e.g. Newton Traders
|
|
2732
2519
|
*/
|
|
2733
|
-
|
|
2520
|
+
name?: string;
|
|
2734
2521
|
/**
|
|
2735
|
-
* -
|
|
2522
|
+
* - Indicates the type of the company, e.g.
|
|
2523
|
+
* franchisee, distributor, etc.
|
|
2736
2524
|
*/
|
|
2737
|
-
|
|
2525
|
+
company_type?: string;
|
|
2526
|
+
};
|
|
2527
|
+
/** @returns {StoresResponseSchema} */
|
|
2528
|
+
declare function StoresResponseSchema(): StoresResponseSchema;
|
|
2529
|
+
type StoresResponseSchema = {
|
|
2530
|
+
items?: AppInventoryStores[];
|
|
2531
|
+
page?: Page;
|
|
2532
|
+
};
|
|
2533
|
+
/** @returns {AppInventoryStores} */
|
|
2534
|
+
declare function AppInventoryStores(): AppInventoryStores;
|
|
2535
|
+
type AppInventoryStores = {
|
|
2738
2536
|
/**
|
|
2739
|
-
* -
|
|
2740
|
-
*
|
|
2537
|
+
* - The unique identifier of the store in the sales
|
|
2538
|
+
* channel inventory
|
|
2741
2539
|
*/
|
|
2742
|
-
|
|
2540
|
+
_id?: string;
|
|
2743
2541
|
/**
|
|
2744
|
-
* -
|
|
2745
|
-
*
|
|
2542
|
+
* - ISO 8601 timestamp of last known updation
|
|
2543
|
+
* to the stores in sales channel inventory
|
|
2746
2544
|
*/
|
|
2747
|
-
|
|
2545
|
+
modified_on?: string;
|
|
2748
2546
|
/**
|
|
2749
|
-
* -
|
|
2750
|
-
*/
|
|
2751
|
-
__v?: number;
|
|
2752
|
-
};
|
|
2753
|
-
/** @returns {Validators} */
|
|
2754
|
-
declare function Validators(): Validators;
|
|
2755
|
-
type Validators = {
|
|
2756
|
-
company?: CompanyValidator;
|
|
2757
|
-
store?: StoreValidator;
|
|
2758
|
-
inventory?: InventoryValidator;
|
|
2759
|
-
order?: OrderValidator;
|
|
2760
|
-
};
|
|
2761
|
-
/** @returns {CompanyValidator} */
|
|
2762
|
-
declare function CompanyValidator(): CompanyValidator;
|
|
2763
|
-
type CompanyValidator = {
|
|
2764
|
-
json_schema?: JsonSchema[];
|
|
2765
|
-
/**
|
|
2766
|
-
* - Browser script for the company validator
|
|
2767
|
-
*/
|
|
2768
|
-
browser_script?: string;
|
|
2769
|
-
};
|
|
2770
|
-
/** @returns {JsonSchema} */
|
|
2771
|
-
declare function JsonSchema(): JsonSchema;
|
|
2772
|
-
type JsonSchema = {
|
|
2773
|
-
/**
|
|
2774
|
-
* - Display text of the validator JSON schema. It
|
|
2775
|
-
* will show in the UI.
|
|
2776
|
-
*/
|
|
2777
|
-
display?: string;
|
|
2778
|
-
/**
|
|
2779
|
-
* - Key related to the display text of the validator JSON schema
|
|
2780
|
-
*/
|
|
2781
|
-
key?: string;
|
|
2782
|
-
/**
|
|
2783
|
-
* - Indicates the type of form field, e.g. Text, Dropdown.
|
|
2784
|
-
*/
|
|
2785
|
-
type?: string;
|
|
2786
|
-
/**
|
|
2787
|
-
* - Tooltip text for the UI of the validator JSON
|
|
2788
|
-
* schema. It will show in the UI.
|
|
2789
|
-
*/
|
|
2790
|
-
tooltip?: string;
|
|
2791
|
-
};
|
|
2792
|
-
/** @returns {StoreValidator} */
|
|
2793
|
-
declare function StoreValidator(): StoreValidator;
|
|
2794
|
-
type StoreValidator = {
|
|
2795
|
-
json_schema?: JsonSchema[];
|
|
2796
|
-
/**
|
|
2797
|
-
* - Browser script for the store validator
|
|
2798
|
-
*/
|
|
2799
|
-
browser_script?: string;
|
|
2800
|
-
};
|
|
2801
|
-
/** @returns {InventoryValidator} */
|
|
2802
|
-
declare function InventoryValidator(): InventoryValidator;
|
|
2803
|
-
type InventoryValidator = {
|
|
2804
|
-
json_schema?: JsonSchema[];
|
|
2805
|
-
/**
|
|
2806
|
-
* - Browser script for the inventory validator
|
|
2807
|
-
*/
|
|
2808
|
-
browser_script?: string;
|
|
2809
|
-
};
|
|
2810
|
-
/** @returns {OrderValidator} */
|
|
2811
|
-
declare function OrderValidator(): OrderValidator;
|
|
2812
|
-
type OrderValidator = {
|
|
2813
|
-
json_schema?: JsonSchema[];
|
|
2814
|
-
/**
|
|
2815
|
-
* - Browser script for the order validator
|
|
2816
|
-
*/
|
|
2817
|
-
browser_script?: string;
|
|
2818
|
-
};
|
|
2819
|
-
/** @returns {IntegrationMeta} */
|
|
2820
|
-
declare function IntegrationMeta(): IntegrationMeta;
|
|
2821
|
-
type IntegrationMeta = {
|
|
2822
|
-
is_public?: boolean;
|
|
2823
|
-
/**
|
|
2824
|
-
* - The unique identifier (24-digit Mongo Object ID)
|
|
2825
|
-
* of the integration meta
|
|
2826
|
-
*/
|
|
2827
|
-
_id?: string;
|
|
2828
|
-
/**
|
|
2829
|
-
* - Nmae of integration meta, e.g. price_level
|
|
2830
|
-
*/
|
|
2831
|
-
name?: string;
|
|
2832
|
-
/**
|
|
2833
|
-
* - Value related to integration meta name, e.g. store
|
|
2834
|
-
*/
|
|
2835
|
-
value?: string;
|
|
2836
|
-
};
|
|
2837
|
-
/** @returns {Integration} */
|
|
2838
|
-
declare function Integration(): Integration;
|
|
2839
|
-
type Integration = {
|
|
2840
|
-
validators?: Validators;
|
|
2841
|
-
/**
|
|
2842
|
-
* - Basic description about the integration
|
|
2843
|
-
*/
|
|
2844
|
-
description?: string;
|
|
2845
|
-
/**
|
|
2846
|
-
* - Basic HTML description about the integration
|
|
2847
|
-
*/
|
|
2848
|
-
description_html?: string;
|
|
2849
|
-
constants?: any;
|
|
2850
|
-
companies?: string[];
|
|
2851
|
-
support?: string[];
|
|
2852
|
-
/**
|
|
2853
|
-
* - The unique identifier (24-digit Mongo Object ID)
|
|
2854
|
-
* of the integration
|
|
2855
|
-
*/
|
|
2856
|
-
_id?: string;
|
|
2857
|
-
/**
|
|
2858
|
-
* - Name of the integration, e.g. SAP RBL Integration
|
|
2859
|
-
*/
|
|
2860
|
-
name?: string;
|
|
2861
|
-
/**
|
|
2862
|
-
* - Name of the integration, e.g. SAP RBL Integration
|
|
2863
|
-
*/
|
|
2864
|
-
slug?: string;
|
|
2865
|
-
meta?: IntegrationMeta[];
|
|
2866
|
-
/**
|
|
2867
|
-
* - Hosted URL of the icon image
|
|
2868
|
-
*/
|
|
2869
|
-
icon?: string;
|
|
2870
|
-
hidden?: boolean;
|
|
2871
|
-
/**
|
|
2872
|
-
* - The unique identifier (24-digit Mongo Object ID)
|
|
2873
|
-
* of the user who created the integration
|
|
2874
|
-
*/
|
|
2875
|
-
owner?: string;
|
|
2876
|
-
/**
|
|
2877
|
-
* - ISO 8601 timestamp of integration creation
|
|
2878
|
-
*/
|
|
2879
|
-
created_at?: string;
|
|
2880
|
-
/**
|
|
2881
|
-
* - ISO 8601 timestamp of integration updation
|
|
2882
|
-
*/
|
|
2883
|
-
modified_at?: string;
|
|
2884
|
-
/**
|
|
2885
|
-
* - Randomly generated fixed-length string for opted
|
|
2886
|
-
* integration. It is auto-generated. It would never change once it is generated.
|
|
2887
|
-
*/
|
|
2888
|
-
token?: string;
|
|
2889
|
-
/**
|
|
2890
|
-
* - Randomly generated fixed-length string for
|
|
2891
|
-
* opted integration. It is auto-generated. It would never change once it is generated.
|
|
2892
|
-
*/
|
|
2893
|
-
secret?: string;
|
|
2894
|
-
/**
|
|
2895
|
-
* - Version key for tracking revisions. Default value is zero.
|
|
2896
|
-
*/
|
|
2897
|
-
__v?: number;
|
|
2898
|
-
};
|
|
2899
|
-
/** @returns {IntegrationConfigResponse} */
|
|
2900
|
-
declare function IntegrationConfigResponse(): IntegrationConfigResponse;
|
|
2901
|
-
type IntegrationConfigResponse = {
|
|
2902
|
-
items?: IntegrationLevel[];
|
|
2903
|
-
};
|
|
2904
|
-
/** @returns {IntegrationLevel} */
|
|
2905
|
-
declare function IntegrationLevel(): IntegrationLevel;
|
|
2906
|
-
type IntegrationLevel = {
|
|
2907
|
-
/**
|
|
2908
|
-
* - Shows this integration is opted or not opted
|
|
2909
|
-
* for the current company
|
|
2910
|
-
*/
|
|
2911
|
-
opted?: boolean;
|
|
2912
|
-
permissions?: any[];
|
|
2913
|
-
last_patch?: LastPatch[];
|
|
2914
|
-
/**
|
|
2915
|
-
* - The unique identifier (24-digit Mongo Object ID)
|
|
2916
|
-
* of the integration config
|
|
2917
|
-
*/
|
|
2918
|
-
_id?: string;
|
|
2919
|
-
/**
|
|
2920
|
-
* - Integration id. Shows which integration
|
|
2921
|
-
* you are enabling.
|
|
2922
|
-
*/
|
|
2923
|
-
integration?: string;
|
|
2924
|
-
/**
|
|
2925
|
-
* - Shows for what level the integration is set up.
|
|
2926
|
-
* It can be company level or store level.
|
|
2927
|
-
*/
|
|
2928
|
-
level?: string;
|
|
2929
|
-
/**
|
|
2930
|
-
* - It can be store uid or company uid. Depends on the
|
|
2931
|
-
* level of integration.
|
|
2932
|
-
*/
|
|
2933
|
-
uid?: number;
|
|
2934
|
-
/**
|
|
2935
|
-
* - Unique id of company.
|
|
2936
|
-
*/
|
|
2937
|
-
company_id?: number;
|
|
2938
|
-
meta?: IntegrationMeta[];
|
|
2939
|
-
/**
|
|
2940
|
-
* - Randomly generated fixed-length string for opted
|
|
2941
|
-
* integration. It is auto-generated. It would never change once it is generated.
|
|
2942
|
-
*/
|
|
2943
|
-
token?: string;
|
|
2944
|
-
/**
|
|
2945
|
-
* - ISO 8601 timestamp of integration config creation
|
|
2946
|
-
*/
|
|
2947
|
-
created_at?: string;
|
|
2948
|
-
/**
|
|
2949
|
-
* - ISO 8601 timestamp of integration config updation
|
|
2950
|
-
*/
|
|
2951
|
-
modified_at?: string;
|
|
2952
|
-
/**
|
|
2953
|
-
* - Version key for tracking revisions. Default value is zero.
|
|
2954
|
-
*/
|
|
2955
|
-
__v?: number;
|
|
2956
|
-
/**
|
|
2957
|
-
* - Schema data of the integration stored in key-value pairs
|
|
2958
|
-
*/
|
|
2959
|
-
data?: any;
|
|
2960
|
-
success?: boolean;
|
|
2961
|
-
message?: string;
|
|
2962
|
-
};
|
|
2963
|
-
/** @returns {UpdateIntegrationLevelRequest} */
|
|
2964
|
-
declare function UpdateIntegrationLevelRequest(): UpdateIntegrationLevelRequest;
|
|
2965
|
-
type UpdateIntegrationLevelRequest = {
|
|
2966
|
-
items?: IntegrationLevel[];
|
|
2967
|
-
};
|
|
2968
|
-
/** @returns {OptedStoreIntegration} */
|
|
2969
|
-
declare function OptedStoreIntegration(): OptedStoreIntegration;
|
|
2970
|
-
type OptedStoreIntegration = {
|
|
2971
|
-
/**
|
|
2972
|
-
* - Allow user to opt same store in other integration
|
|
2973
|
-
*/
|
|
2974
|
-
other_opted?: boolean;
|
|
2975
|
-
other_integration?: IntegrationOptIn;
|
|
2976
|
-
other_entity?: OtherEntity;
|
|
2977
|
-
};
|
|
2978
|
-
/** @returns {OtherEntity} */
|
|
2979
|
-
declare function OtherEntity(): OtherEntity;
|
|
2980
|
-
type OtherEntity = {
|
|
2981
|
-
/**
|
|
2982
|
-
* - Allow other entity opted in integration
|
|
2983
|
-
*/
|
|
2984
|
-
opted?: boolean;
|
|
2985
|
-
permissions?: string[];
|
|
2986
|
-
last_patch?: LastPatch[];
|
|
2987
|
-
/**
|
|
2988
|
-
* - The unique identifier of the other entity for
|
|
2989
|
-
* opted store integration
|
|
2990
|
-
*/
|
|
2991
|
-
_id?: string;
|
|
2992
|
-
/**
|
|
2993
|
-
* - Integration ID. Shows which integration
|
|
2994
|
-
* you are enabling.
|
|
2995
|
-
*/
|
|
2996
|
-
integration?: string;
|
|
2997
|
-
/**
|
|
2998
|
-
* - Indicates integration level. It can be company
|
|
2999
|
-
* level or store level.
|
|
3000
|
-
*/
|
|
3001
|
-
level?: string;
|
|
3002
|
-
/**
|
|
3003
|
-
* - It can be store uid or company uid. Depends on the
|
|
3004
|
-
* level of integration.
|
|
3005
|
-
*/
|
|
3006
|
-
uid?: number;
|
|
3007
|
-
data?: OtherEntityData;
|
|
3008
|
-
meta?: any[];
|
|
3009
|
-
/**
|
|
3010
|
-
* - Randomly generated fixed-length string for opted
|
|
3011
|
-
* integration. It is auto-generated. It would never change once it is generated.
|
|
3012
|
-
*/
|
|
3013
|
-
token?: string;
|
|
3014
|
-
/**
|
|
3015
|
-
* - ISO 8601 timestamp of other entity creation
|
|
3016
|
-
* for opted store integration
|
|
3017
|
-
*/
|
|
3018
|
-
created_at?: string;
|
|
3019
|
-
/**
|
|
3020
|
-
* - ISO 8601 timestamp of other entity
|
|
3021
|
-
* updation for opted store integration
|
|
3022
|
-
*/
|
|
3023
|
-
modified_at?: string;
|
|
3024
|
-
/**
|
|
3025
|
-
* - Version key for tracking revisions. Default value is zero.
|
|
3026
|
-
*/
|
|
3027
|
-
__v?: number;
|
|
3028
|
-
};
|
|
3029
|
-
/** @returns {LastPatch} */
|
|
3030
|
-
declare function LastPatch(): LastPatch;
|
|
3031
|
-
type LastPatch = {
|
|
3032
|
-
op?: string;
|
|
3033
|
-
path?: string;
|
|
3034
|
-
/**
|
|
3035
|
-
* - It can be inventory level or order level
|
|
3036
|
-
*/
|
|
3037
|
-
value?: string;
|
|
3038
|
-
};
|
|
3039
|
-
/** @returns {OtherEntityData} */
|
|
3040
|
-
declare function OtherEntityData(): OtherEntityData;
|
|
3041
|
-
type OtherEntityData = {
|
|
3042
|
-
article_identifier?: string;
|
|
3043
|
-
};
|
|
3044
|
-
/** @returns {App} */
|
|
3045
|
-
declare function App(): App;
|
|
3046
|
-
type App = {
|
|
3047
|
-
/**
|
|
3048
|
-
* - Numeric ID allotted to a business account
|
|
3049
|
-
* on Fynd Platform.
|
|
3050
|
-
*/
|
|
3051
|
-
company_id?: string;
|
|
3052
|
-
/**
|
|
3053
|
-
* - It indicates different channel types like
|
|
3054
|
-
* store, website-and-mobile-apps. Default value is store
|
|
3055
|
-
*/
|
|
3056
|
-
channel_type?: string;
|
|
3057
|
-
auth?: ApplicationAuth;
|
|
3058
|
-
/**
|
|
3059
|
-
* - User-friendly name for sales channel, e.g. Zenz Fashion
|
|
3060
|
-
*/
|
|
3061
|
-
name?: string;
|
|
3062
|
-
/**
|
|
3063
|
-
* - Detailed description about the sales channel
|
|
3064
|
-
*/
|
|
3065
|
-
desc?: string;
|
|
3066
|
-
};
|
|
3067
|
-
/** @returns {InventoryConfig} */
|
|
3068
|
-
declare function InventoryConfig(): InventoryConfig;
|
|
3069
|
-
type InventoryConfig = {
|
|
3070
|
-
brand?: InventoryBrandRule;
|
|
3071
|
-
store?: InventoryStoreRule;
|
|
3072
|
-
image?: string[];
|
|
3073
|
-
/**
|
|
3074
|
-
* - Allow other businesses (companies)
|
|
3075
|
-
* to consume the current sales channel's inventory and sell products
|
|
3076
|
-
*/
|
|
3077
|
-
franchise_enabled?: boolean;
|
|
3078
|
-
/**
|
|
3079
|
-
* - Indicates whether out of stock products
|
|
3080
|
-
* are allowed to show up on the website.
|
|
3081
|
-
*/
|
|
3082
|
-
out_of_stock?: boolean;
|
|
3083
|
-
/**
|
|
3084
|
-
* - Show only verified products
|
|
3085
|
-
* (the ones whose data have been verified by the admin)
|
|
3086
|
-
*/
|
|
3087
|
-
only_verified_products?: boolean;
|
|
3088
|
-
pricing_strategy?: PricingStrategy;
|
|
3089
|
-
};
|
|
3090
|
-
/** @returns {AppInventory} */
|
|
3091
|
-
declare function AppInventory(): AppInventory;
|
|
3092
|
-
type AppInventory = {
|
|
3093
|
-
inventory?: InventoryConfig;
|
|
3094
|
-
payment?: InventoryPaymentConfig;
|
|
3095
|
-
article_assignment?: InventoryArticleAssignment;
|
|
3096
|
-
};
|
|
3097
|
-
/** @returns {AppDomain} */
|
|
3098
|
-
declare function AppDomain(): AppDomain;
|
|
3099
|
-
type AppDomain = {
|
|
3100
|
-
/**
|
|
3101
|
-
* - Domain URL of current sales channel, e.g. zenz.com
|
|
3102
|
-
*/
|
|
3103
|
-
name?: string;
|
|
3104
|
-
};
|
|
3105
|
-
/** @returns {CompaniesResponse} */
|
|
3106
|
-
declare function CompaniesResponse(): CompaniesResponse;
|
|
3107
|
-
type CompaniesResponse = {
|
|
3108
|
-
items?: AppInventoryCompanies[];
|
|
3109
|
-
page?: Page;
|
|
3110
|
-
};
|
|
3111
|
-
/** @returns {AppInventoryCompanies} */
|
|
3112
|
-
declare function AppInventoryCompanies(): AppInventoryCompanies;
|
|
3113
|
-
type AppInventoryCompanies = {
|
|
3114
|
-
/**
|
|
3115
|
-
* - UID of the company, e.g. 108
|
|
3116
|
-
*/
|
|
3117
|
-
uid?: number;
|
|
3118
|
-
/**
|
|
3119
|
-
* - Name of the company, e.g. Newton Traders
|
|
3120
|
-
*/
|
|
3121
|
-
name?: string;
|
|
3122
|
-
/**
|
|
3123
|
-
* - Indicates the type of the company, e.g.
|
|
3124
|
-
* franchisee, distributor, etc.
|
|
3125
|
-
*/
|
|
3126
|
-
company_type?: string;
|
|
3127
|
-
};
|
|
3128
|
-
/** @returns {StoresResponse} */
|
|
3129
|
-
declare function StoresResponse(): StoresResponse;
|
|
3130
|
-
type StoresResponse = {
|
|
3131
|
-
items?: AppInventoryStores[];
|
|
3132
|
-
page?: Page;
|
|
3133
|
-
};
|
|
3134
|
-
/** @returns {ListStoreResponse} */
|
|
3135
|
-
declare function ListStoreResponse(): ListStoreResponse;
|
|
3136
|
-
type ListStoreResponse = {
|
|
3137
|
-
stores?: AppInventoryStores[];
|
|
3138
|
-
};
|
|
3139
|
-
/** @returns {ArrayStoreResponse} */
|
|
3140
|
-
declare function ArrayStoreResponse(): ArrayStoreResponse;
|
|
3141
|
-
type ArrayStoreResponse = {
|
|
3142
|
-
data?: AppInventoryStores[];
|
|
3143
|
-
};
|
|
3144
|
-
/** @returns {AppInventoryStores} */
|
|
3145
|
-
declare function AppInventoryStores(): AppInventoryStores;
|
|
3146
|
-
type AppInventoryStores = {
|
|
3147
|
-
/**
|
|
3148
|
-
* - The unique identifier of the store (24-digit Mongo
|
|
3149
|
-
* Object ID) in the sales channel inventory
|
|
3150
|
-
*/
|
|
3151
|
-
_id?: string;
|
|
3152
|
-
/**
|
|
3153
|
-
* - ISO 8601 timestamp of last known updation
|
|
3154
|
-
* to the stores in sales channel inventory
|
|
3155
|
-
*/
|
|
3156
|
-
modified_on?: string;
|
|
3157
|
-
/**
|
|
3158
|
-
* - Sales channel inventory store UID
|
|
2547
|
+
* - Sales channel inventory store UID
|
|
3159
2548
|
*/
|
|
3160
2549
|
uid?: number;
|
|
3161
2550
|
/**
|
|
@@ -3186,9 +2575,9 @@ type AppInventoryStores = {
|
|
|
3186
2575
|
address?: any;
|
|
3187
2576
|
integration_type?: any;
|
|
3188
2577
|
};
|
|
3189
|
-
/** @returns {
|
|
3190
|
-
declare function
|
|
3191
|
-
type
|
|
2578
|
+
/** @returns {FilterOrderingStoreRequestSchema} */
|
|
2579
|
+
declare function FilterOrderingStoreRequestSchema(): FilterOrderingStoreRequestSchema;
|
|
2580
|
+
type FilterOrderingStoreRequestSchema = {
|
|
3192
2581
|
/**
|
|
3193
2582
|
* - Allow all stores from the ordering stores
|
|
3194
2583
|
*/
|
|
@@ -3218,8 +2607,7 @@ type DeploymentMeta = {
|
|
|
3218
2607
|
*/
|
|
3219
2608
|
type?: string;
|
|
3220
2609
|
/**
|
|
3221
|
-
* - The unique identifier
|
|
3222
|
-
* of the ordering stores
|
|
2610
|
+
* - The unique identifier of the ordering stores
|
|
3223
2611
|
*/
|
|
3224
2612
|
_id?: string;
|
|
3225
2613
|
/**
|
|
@@ -3234,9 +2622,9 @@ declare function OrderingStoreConfig(): OrderingStoreConfig;
|
|
|
3234
2622
|
type OrderingStoreConfig = {
|
|
3235
2623
|
deployment_meta?: DeploymentMeta;
|
|
3236
2624
|
};
|
|
3237
|
-
/** @returns {
|
|
3238
|
-
declare function
|
|
3239
|
-
type
|
|
2625
|
+
/** @returns {OrderingStoreSelectRequestSchema} */
|
|
2626
|
+
declare function OrderingStoreSelectRequestSchema(): OrderingStoreSelectRequestSchema;
|
|
2627
|
+
type OrderingStoreSelectRequestSchema = {
|
|
3240
2628
|
ordering_store: OrderingStoreSelect;
|
|
3241
2629
|
};
|
|
3242
2630
|
/** @returns {OrderingStoreSelect} */
|
|
@@ -3271,8 +2659,7 @@ type OtherSellerApplication = {
|
|
|
3271
2659
|
*/
|
|
3272
2660
|
description?: string;
|
|
3273
2661
|
/**
|
|
3274
|
-
* - The unique identifier
|
|
3275
|
-
* of the other seller's sales channel
|
|
2662
|
+
* - The unique identifier of the other seller's sales channel
|
|
3276
2663
|
*/
|
|
3277
2664
|
_id?: string;
|
|
3278
2665
|
/**
|
|
@@ -3292,9 +2679,9 @@ type OtherSellerApplications = {
|
|
|
3292
2679
|
items?: OtherSellerApplication[];
|
|
3293
2680
|
page?: Page;
|
|
3294
2681
|
};
|
|
3295
|
-
/** @returns {
|
|
3296
|
-
declare function
|
|
3297
|
-
type
|
|
2682
|
+
/** @returns {OptedApplicationResponseSchema} */
|
|
2683
|
+
declare function OptedApplicationResponseSchema(): OptedApplicationResponseSchema;
|
|
2684
|
+
type OptedApplicationResponseSchema = {
|
|
3298
2685
|
/**
|
|
3299
2686
|
* - Name of the other seller's sales channel
|
|
3300
2687
|
*/
|
|
@@ -3304,8 +2691,7 @@ type OptedApplicationResponse = {
|
|
|
3304
2691
|
*/
|
|
3305
2692
|
description?: string;
|
|
3306
2693
|
/**
|
|
3307
|
-
* - The unique identifier
|
|
3308
|
-
* of the other seller's sales channel
|
|
2694
|
+
* - The unique identifier of the other seller's sales channel
|
|
3309
2695
|
*/
|
|
3310
2696
|
_id?: string;
|
|
3311
2697
|
/**
|
|
@@ -3406,13 +2792,12 @@ type OptOutInventory = {
|
|
|
3406
2792
|
*/
|
|
3407
2793
|
company: number[];
|
|
3408
2794
|
};
|
|
3409
|
-
/** @returns {
|
|
3410
|
-
declare function
|
|
3411
|
-
type
|
|
2795
|
+
/** @returns {TokenResponseSchema} */
|
|
2796
|
+
declare function TokenResponseSchema(): TokenResponseSchema;
|
|
2797
|
+
type TokenResponseSchema = {
|
|
3412
2798
|
tokens?: Tokens;
|
|
3413
2799
|
/**
|
|
3414
|
-
* - The unique identifier
|
|
3415
|
-
* of the token
|
|
2800
|
+
* - The unique identifier of the token
|
|
3416
2801
|
*/
|
|
3417
2802
|
_id?: string;
|
|
3418
2803
|
/**
|
|
@@ -3757,6 +3142,34 @@ type RegistrationPageFeature = {
|
|
|
3757
3142
|
*/
|
|
3758
3143
|
ask_store_address?: boolean;
|
|
3759
3144
|
};
|
|
3145
|
+
/** @returns {BuyboxFeature} */
|
|
3146
|
+
declare function BuyboxFeature(): BuyboxFeature;
|
|
3147
|
+
type BuyboxFeature = {
|
|
3148
|
+
/**
|
|
3149
|
+
* - Allow users to see seller/stores name on
|
|
3150
|
+
* PDP (product detail page).
|
|
3151
|
+
*/
|
|
3152
|
+
show_name?: boolean;
|
|
3153
|
+
/**
|
|
3154
|
+
* - Allow selection of sellers/stores on
|
|
3155
|
+
* PDP (product detail page).
|
|
3156
|
+
*/
|
|
3157
|
+
enable_selection?: boolean;
|
|
3158
|
+
/**
|
|
3159
|
+
* - Toggle buybox listing
|
|
3160
|
+
* between sellers and stores. True indicates seller listing, while False
|
|
3161
|
+
* indicates store listing.
|
|
3162
|
+
*/
|
|
3163
|
+
is_seller_buybox_enabled?: boolean;
|
|
3164
|
+
};
|
|
3165
|
+
/** @returns {DeliveryStrategy} */
|
|
3166
|
+
declare function DeliveryStrategy(): DeliveryStrategy;
|
|
3167
|
+
type DeliveryStrategy = {
|
|
3168
|
+
/**
|
|
3169
|
+
* - Indicates the delivery strategy value.
|
|
3170
|
+
*/
|
|
3171
|
+
value?: string;
|
|
3172
|
+
};
|
|
3760
3173
|
/** @returns {AppFeature} */
|
|
3761
3174
|
declare function AppFeature(): AppFeature;
|
|
3762
3175
|
type AppFeature = {
|
|
@@ -3770,9 +3183,9 @@ type AppFeature = {
|
|
|
3770
3183
|
pcr?: PcrFeature;
|
|
3771
3184
|
order?: OrderFeature;
|
|
3772
3185
|
buybox?: BuyboxFeature;
|
|
3186
|
+
delivery_strategy?: DeliveryStrategy;
|
|
3773
3187
|
/**
|
|
3774
|
-
* - The unique identifier
|
|
3775
|
-
* for the sales channel features
|
|
3188
|
+
* - The unique identifier for the sales channel features
|
|
3776
3189
|
*/
|
|
3777
3190
|
_id?: string;
|
|
3778
3191
|
/**
|
|
@@ -3793,7 +3206,6 @@ type AppFeature = {
|
|
|
3793
3206
|
* - Version key for tracking revisions. Default value is zero
|
|
3794
3207
|
*/
|
|
3795
3208
|
__v?: number;
|
|
3796
|
-
pricing_strategy?: PricingStrategy;
|
|
3797
3209
|
};
|
|
3798
3210
|
/** @returns {HomePageFeature} */
|
|
3799
3211
|
declare function HomePageFeature(): HomePageFeature;
|
|
@@ -3972,42 +3384,22 @@ type OrderFeature = {
|
|
|
3972
3384
|
*/
|
|
3973
3385
|
buy_again?: boolean;
|
|
3974
3386
|
};
|
|
3975
|
-
/** @returns {
|
|
3976
|
-
declare function
|
|
3977
|
-
type
|
|
3978
|
-
/**
|
|
3979
|
-
* - Allow users to see seller/stores name on
|
|
3980
|
-
* PDP (product detail page).
|
|
3981
|
-
*/
|
|
3982
|
-
show_name?: boolean;
|
|
3983
|
-
/**
|
|
3984
|
-
* - Allow selection of sellers/stores on
|
|
3985
|
-
* PDP (product detail page).
|
|
3986
|
-
*/
|
|
3987
|
-
enable_selection?: boolean;
|
|
3988
|
-
/**
|
|
3989
|
-
* - Toggle buybox listing
|
|
3990
|
-
* between sellers and stores. True indicates seller listing, while False
|
|
3991
|
-
* indicates store listing.
|
|
3992
|
-
*/
|
|
3993
|
-
is_seller_buybox_enabled?: boolean;
|
|
3994
|
-
};
|
|
3995
|
-
/** @returns {AppFeatureRequest} */
|
|
3996
|
-
declare function AppFeatureRequest(): AppFeatureRequest;
|
|
3997
|
-
type AppFeatureRequest = {
|
|
3387
|
+
/** @returns {AppFeatureRequestSchema} */
|
|
3388
|
+
declare function AppFeatureRequestSchema(): AppFeatureRequestSchema;
|
|
3389
|
+
type AppFeatureRequestSchema = {
|
|
3998
3390
|
feature?: AppFeature;
|
|
3999
3391
|
};
|
|
4000
|
-
/** @returns {
|
|
4001
|
-
declare function
|
|
4002
|
-
type
|
|
3392
|
+
/** @returns {AppFeatureResponseSchema} */
|
|
3393
|
+
declare function AppFeatureResponseSchema(): AppFeatureResponseSchema;
|
|
3394
|
+
type AppFeatureResponseSchema = {
|
|
4003
3395
|
feature?: AppFeature;
|
|
4004
3396
|
};
|
|
4005
3397
|
/** @returns {Currency} */
|
|
4006
3398
|
declare function Currency(): Currency;
|
|
4007
3399
|
type Currency = {
|
|
4008
3400
|
/**
|
|
4009
|
-
* - The unique identifier
|
|
4010
|
-
*
|
|
3401
|
+
* - The unique identifier of the current sales channel
|
|
3402
|
+
* supported currency
|
|
4011
3403
|
*/
|
|
4012
3404
|
_id?: string;
|
|
4013
3405
|
/**
|
|
@@ -4040,7 +3432,7 @@ type Currency = {
|
|
|
4040
3432
|
*/
|
|
4041
3433
|
decimal_digits?: number;
|
|
4042
3434
|
/**
|
|
4043
|
-
* - Unique symbol for identifying the currency, e.g.
|
|
3435
|
+
* - Unique symbol for identifying the currency, e.g. ₹
|
|
4044
3436
|
*/
|
|
4045
3437
|
symbol?: string;
|
|
4046
3438
|
country_name?: string;
|
|
@@ -4142,8 +3534,7 @@ type Application = {
|
|
|
4142
3534
|
*/
|
|
4143
3535
|
is_active?: boolean;
|
|
4144
3536
|
/**
|
|
4145
|
-
* - The unique identifier
|
|
4146
|
-
* of the sales channel
|
|
3537
|
+
* - The unique identifier of the sales channel
|
|
4147
3538
|
*/
|
|
4148
3539
|
_id?: string;
|
|
4149
3540
|
/**
|
|
@@ -4151,8 +3542,7 @@ type Application = {
|
|
|
4151
3542
|
*/
|
|
4152
3543
|
name?: string;
|
|
4153
3544
|
/**
|
|
4154
|
-
* - The unique identifier
|
|
4155
|
-
* of owner who owns the application
|
|
3545
|
+
* - The unique identifier of owner who owns the application
|
|
4156
3546
|
*/
|
|
4157
3547
|
owner?: string;
|
|
4158
3548
|
/**
|
|
@@ -4195,117 +3585,119 @@ type Application = {
|
|
|
4195
3585
|
tokens?: TokenSchema[];
|
|
4196
3586
|
secret?: string;
|
|
4197
3587
|
};
|
|
4198
|
-
/** @returns {
|
|
4199
|
-
declare function
|
|
4200
|
-
type
|
|
4201
|
-
|
|
4202
|
-
|
|
3588
|
+
/** @returns {ApplicationById} */
|
|
3589
|
+
declare function ApplicationById(): ApplicationById;
|
|
3590
|
+
type ApplicationById = {
|
|
3591
|
+
website?: ApplicationWebsite;
|
|
3592
|
+
cors?: ApplicationCors;
|
|
3593
|
+
auth?: ApplicationAuth;
|
|
4203
3594
|
/**
|
|
4204
|
-
* -
|
|
3595
|
+
* - It contains detailed information about the
|
|
3596
|
+
* sales channel.
|
|
4205
3597
|
*/
|
|
4206
|
-
|
|
4207
|
-
};
|
|
4208
|
-
/** @returns {InvalidPayloadRequest} */
|
|
4209
|
-
declare function InvalidPayloadRequest(): InvalidPayloadRequest;
|
|
4210
|
-
type InvalidPayloadRequest = {
|
|
3598
|
+
description?: string;
|
|
4211
3599
|
/**
|
|
4212
|
-
* -
|
|
3600
|
+
* - It indicates different types of channels,
|
|
3601
|
+
* such as store, website, and mobile apps, with 'store' being the default value.
|
|
4213
3602
|
*/
|
|
4214
|
-
|
|
3603
|
+
channel_type?: string;
|
|
4215
3604
|
/**
|
|
4216
|
-
* -
|
|
3605
|
+
* - An integer value that specifies the number
|
|
3606
|
+
* of seconds until the key expires
|
|
4217
3607
|
*/
|
|
4218
|
-
|
|
3608
|
+
cache_ttl?: number;
|
|
4219
3609
|
/**
|
|
4220
|
-
* -
|
|
3610
|
+
* - Indicates whether a sales channel is
|
|
3611
|
+
* internal or not
|
|
4221
3612
|
*/
|
|
4222
|
-
|
|
4223
|
-
};
|
|
4224
|
-
/** @returns {InventoryBrandRule} */
|
|
4225
|
-
declare function InventoryBrandRule(): InventoryBrandRule;
|
|
4226
|
-
type InventoryBrandRule = {
|
|
3613
|
+
is_internal?: boolean;
|
|
4227
3614
|
/**
|
|
4228
|
-
* -
|
|
4229
|
-
* few brands in the inventory
|
|
3615
|
+
* - Indicates sales channel is active or not active
|
|
4230
3616
|
*/
|
|
4231
|
-
|
|
4232
|
-
brands?: number[];
|
|
4233
|
-
};
|
|
4234
|
-
/** @returns {PricingStrategy} */
|
|
4235
|
-
declare function PricingStrategy(): PricingStrategy;
|
|
4236
|
-
type PricingStrategy = {
|
|
3617
|
+
is_active?: boolean;
|
|
4237
3618
|
/**
|
|
4238
|
-
* -
|
|
3619
|
+
* - The unique identifier of the sales channel
|
|
4239
3620
|
*/
|
|
4240
|
-
|
|
4241
|
-
};
|
|
4242
|
-
/** @returns {StoreCriteriaRule} */
|
|
4243
|
-
declare function StoreCriteriaRule(): StoreCriteriaRule;
|
|
4244
|
-
type StoreCriteriaRule = {
|
|
3621
|
+
_id?: string;
|
|
4245
3622
|
/**
|
|
4246
|
-
* -
|
|
3623
|
+
* - Name of the sales channel, e.g. Zenz Fashion
|
|
4247
3624
|
*/
|
|
4248
|
-
|
|
3625
|
+
name?: string;
|
|
4249
3626
|
/**
|
|
4250
|
-
* -
|
|
3627
|
+
* - The unique identifier of owner who owns the application
|
|
4251
3628
|
*/
|
|
4252
|
-
|
|
4253
|
-
};
|
|
4254
|
-
/** @returns {InventoryStoreRule} */
|
|
4255
|
-
declare function InventoryStoreRule(): InventoryStoreRule;
|
|
4256
|
-
type InventoryStoreRule = {
|
|
3629
|
+
owner?: string;
|
|
4257
3630
|
/**
|
|
4258
|
-
* -
|
|
4259
|
-
*
|
|
3631
|
+
* - Numeric ID allotted to a business account
|
|
3632
|
+
* where the sales channel exists
|
|
4260
3633
|
*/
|
|
4261
|
-
|
|
3634
|
+
company_id?: number;
|
|
4262
3635
|
/**
|
|
4263
|
-
* -
|
|
4264
|
-
*
|
|
3636
|
+
* - Random generated fix length string for sales
|
|
3637
|
+
* channel. It is required and auto-generated.
|
|
4265
3638
|
*/
|
|
4266
|
-
|
|
3639
|
+
token?: string;
|
|
3640
|
+
redirections?: ApplicationRedirections[];
|
|
3641
|
+
meta?: ApplicationMeta[];
|
|
4267
3642
|
/**
|
|
4268
|
-
* -
|
|
3643
|
+
* - ISO 8601 timestamp of sales channel creation
|
|
4269
3644
|
*/
|
|
4270
|
-
|
|
4271
|
-
};
|
|
4272
|
-
/** @returns {InventoryPaymentConfig} */
|
|
4273
|
-
declare function InventoryPaymentConfig(): InventoryPaymentConfig;
|
|
4274
|
-
type InventoryPaymentConfig = {
|
|
3645
|
+
created_at?: string;
|
|
4275
3646
|
/**
|
|
4276
|
-
* -
|
|
4277
|
-
* sales channel. It is required and default value is null.
|
|
3647
|
+
* - ISO 8601 timestamp of sales channel updation
|
|
4278
3648
|
*/
|
|
4279
|
-
|
|
3649
|
+
modified_at?: string;
|
|
4280
3650
|
/**
|
|
4281
|
-
* -
|
|
4282
|
-
* payment of sales channel. Default value is FYND.
|
|
3651
|
+
* - Version key for tracking revisions. Default value is zero.
|
|
4283
3652
|
*/
|
|
4284
|
-
|
|
3653
|
+
__v?: number;
|
|
3654
|
+
banner?: SecureUrl;
|
|
3655
|
+
logo?: SecureUrl;
|
|
3656
|
+
favicon?: SecureUrl;
|
|
3657
|
+
domains?: Domain[];
|
|
3658
|
+
/**
|
|
3659
|
+
* - It shows application is live or in development mode.
|
|
3660
|
+
*/
|
|
3661
|
+
app_type?: string;
|
|
3662
|
+
mobile_logo?: SecureUrl;
|
|
3663
|
+
domain?: Domain;
|
|
3664
|
+
slug?: string;
|
|
3665
|
+
mode?: string;
|
|
3666
|
+
status?: string;
|
|
3667
|
+
tokens?: TokenSchemaID[];
|
|
3668
|
+
secret?: string;
|
|
4285
3669
|
};
|
|
4286
|
-
/** @returns {
|
|
4287
|
-
declare function
|
|
4288
|
-
type
|
|
3670
|
+
/** @returns {TokenSchemaID} */
|
|
3671
|
+
declare function TokenSchemaID(): TokenSchemaID;
|
|
3672
|
+
type TokenSchemaID = {
|
|
3673
|
+
token?: string;
|
|
3674
|
+
created_by?: string;
|
|
4289
3675
|
/**
|
|
4290
|
-
* -
|
|
4291
|
-
* enabled for the article assignment.
|
|
3676
|
+
* - ISO 8601 timestamp of when token created
|
|
4292
3677
|
*/
|
|
4293
|
-
|
|
4294
|
-
storetype_order?: string[];
|
|
3678
|
+
created_at?: string;
|
|
4295
3679
|
};
|
|
4296
|
-
/** @returns {
|
|
4297
|
-
declare function
|
|
4298
|
-
type
|
|
4299
|
-
|
|
3680
|
+
/** @returns {TokenSchema} */
|
|
3681
|
+
declare function TokenSchema(): TokenSchema;
|
|
3682
|
+
type TokenSchema = {
|
|
3683
|
+
token?: string;
|
|
3684
|
+
created_by?: any;
|
|
3685
|
+
/**
|
|
3686
|
+
* - ISO 8601 timestamp of when token created
|
|
3687
|
+
*/
|
|
3688
|
+
created_at?: string;
|
|
4300
3689
|
};
|
|
4301
|
-
/** @returns {
|
|
4302
|
-
declare function
|
|
4303
|
-
type
|
|
3690
|
+
/** @returns {InvalidPayloadRequestSchema} */
|
|
3691
|
+
declare function InvalidPayloadRequestSchema(): InvalidPayloadRequestSchema;
|
|
3692
|
+
type InvalidPayloadRequestSchema = {
|
|
4304
3693
|
/**
|
|
4305
|
-
* -
|
|
3694
|
+
* - Error message when request body payload is improper
|
|
4306
3695
|
*/
|
|
4307
|
-
|
|
4308
|
-
|
|
3696
|
+
message?: string;
|
|
3697
|
+
/**
|
|
3698
|
+
* - Flag for required not successfull.
|
|
3699
|
+
*/
|
|
3700
|
+
success?: boolean;
|
|
4309
3701
|
};
|
|
4310
3702
|
/** @returns {Page} */
|
|
4311
3703
|
declare function Page(): Page;
|
|
@@ -4339,9 +3731,9 @@ type Page = {
|
|
|
4339
3731
|
*/
|
|
4340
3732
|
size?: number;
|
|
4341
3733
|
/**
|
|
4342
|
-
* -
|
|
3734
|
+
* - The number of items per page.
|
|
4343
3735
|
*/
|
|
4344
|
-
|
|
3736
|
+
page_size?: number;
|
|
4345
3737
|
};
|
|
4346
3738
|
/** @returns {ApplicationInformation} */
|
|
4347
3739
|
declare function ApplicationInformation(): ApplicationInformation;
|
|
@@ -4356,8 +3748,7 @@ type ApplicationInformation = {
|
|
|
4356
3748
|
*/
|
|
4357
3749
|
copyright_text?: string;
|
|
4358
3750
|
/**
|
|
4359
|
-
* - Unique identifier
|
|
4360
|
-
* the application information
|
|
3751
|
+
* - Unique identifier of the application information
|
|
4361
3752
|
*/
|
|
4362
3753
|
_id?: string;
|
|
4363
3754
|
business_highlights?: BusinessHighlights[];
|
|
@@ -4632,8 +4023,7 @@ type Links = {
|
|
|
4632
4023
|
declare function BusinessHighlights(): BusinessHighlights;
|
|
4633
4024
|
type BusinessHighlights = {
|
|
4634
4025
|
/**
|
|
4635
|
-
* - Unique identifier
|
|
4636
|
-
* the related business
|
|
4026
|
+
* - Unique identifier of the related business
|
|
4637
4027
|
*/
|
|
4638
4028
|
_id?: string;
|
|
4639
4029
|
/**
|
|
@@ -4669,24 +4059,23 @@ type ApplicationDetail = {
|
|
|
4669
4059
|
domain?: Domain;
|
|
4670
4060
|
domains?: Domain[];
|
|
4671
4061
|
/**
|
|
4672
|
-
* - The unique identifier
|
|
4673
|
-
* for the sales channel details
|
|
4062
|
+
* - The unique identifier for the sales channel details
|
|
4674
4063
|
*/
|
|
4675
4064
|
_id?: string;
|
|
4676
4065
|
slug?: string;
|
|
4677
4066
|
company_id?: number;
|
|
4678
4067
|
};
|
|
4679
|
-
/** @returns {
|
|
4680
|
-
declare function
|
|
4681
|
-
type
|
|
4068
|
+
/** @returns {CurrenciesResponseSchema} */
|
|
4069
|
+
declare function CurrenciesResponseSchema(): CurrenciesResponseSchema;
|
|
4070
|
+
type CurrenciesResponseSchema = {
|
|
4682
4071
|
items?: Currency[];
|
|
4683
4072
|
};
|
|
4684
|
-
/** @returns {
|
|
4685
|
-
declare function
|
|
4686
|
-
type
|
|
4073
|
+
/** @returns {AppCurrencyResponseSchema} */
|
|
4074
|
+
declare function AppCurrencyResponseSchema(): AppCurrencyResponseSchema;
|
|
4075
|
+
type AppCurrencyResponseSchema = {
|
|
4687
4076
|
/**
|
|
4688
|
-
* - The unique identifier
|
|
4689
|
-
*
|
|
4077
|
+
* - The unique identifier of the currency
|
|
4078
|
+
* configuration supported by the application
|
|
4690
4079
|
*/
|
|
4691
4080
|
_id?: string;
|
|
4692
4081
|
/**
|
|
@@ -4756,18 +4145,13 @@ type OptedStoreAddress = {
|
|
|
4756
4145
|
* - Selected state code
|
|
4757
4146
|
*/
|
|
4758
4147
|
state_code?: string;
|
|
4759
|
-
/**
|
|
4760
|
-
* - Landmark of the address
|
|
4761
|
-
*/
|
|
4762
|
-
landmark?: string;
|
|
4763
4148
|
};
|
|
4764
4149
|
/** @returns {OrderingStore} */
|
|
4765
4150
|
declare function OrderingStore(): OrderingStore;
|
|
4766
4151
|
type OrderingStore = {
|
|
4767
4152
|
address?: OptedStoreAddress;
|
|
4768
4153
|
/**
|
|
4769
|
-
* - The unique identifier
|
|
4770
|
-
* of the ordering store
|
|
4154
|
+
* - The unique identifier of the ordering store
|
|
4771
4155
|
*/
|
|
4772
4156
|
_id?: string;
|
|
4773
4157
|
/**
|
|
@@ -4820,8 +4204,7 @@ type OrderingStores = {
|
|
|
4820
4204
|
*/
|
|
4821
4205
|
type?: string;
|
|
4822
4206
|
/**
|
|
4823
|
-
* - The unique identifier
|
|
4824
|
-
* of the ordering store
|
|
4207
|
+
* - The unique identifier of the ordering store
|
|
4825
4208
|
*/
|
|
4826
4209
|
_id?: string;
|
|
4827
4210
|
/**
|
|
@@ -4835,139 +4218,29 @@ type OrderingStores = {
|
|
|
4835
4218
|
*/
|
|
4836
4219
|
__v?: number;
|
|
4837
4220
|
};
|
|
4838
|
-
/** @returns {
|
|
4839
|
-
declare function
|
|
4840
|
-
type
|
|
4841
|
-
type: string;
|
|
4842
|
-
interval?: number;
|
|
4843
|
-
};
|
|
4844
|
-
/** @returns {PlatformVersionRequest} */
|
|
4845
|
-
declare function PlatformVersionRequest(): PlatformVersionRequest;
|
|
4846
|
-
type PlatformVersionRequest = {
|
|
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
|
-
};
|
|
4854
|
-
/** @returns {PlatformVersion} */
|
|
4855
|
-
declare function PlatformVersion(): PlatformVersion;
|
|
4856
|
-
type PlatformVersion = {
|
|
4857
|
-
app_code_name: string;
|
|
4858
|
-
app_name: string;
|
|
4859
|
-
force_version: string;
|
|
4860
|
-
latest_version: string;
|
|
4861
|
-
is_app_blocked: boolean;
|
|
4862
|
-
update_dialog: UpdateDiealog;
|
|
4863
|
-
_id?: string;
|
|
4864
|
-
/**
|
|
4865
|
-
* - ISO 8601 timestamp when currency was added
|
|
4866
|
-
* in the list of currencies supported by the sales channel
|
|
4867
|
-
*/
|
|
4868
|
-
modified_at?: string;
|
|
4869
|
-
/**
|
|
4870
|
-
* - ISO 8601 timestamp when currency was added
|
|
4871
|
-
* in the list of currencies supported by the sales channel
|
|
4872
|
-
*/
|
|
4873
|
-
created_at?: string;
|
|
4874
|
-
__v?: number;
|
|
4875
|
-
};
|
|
4876
|
-
/** @returns {OrderingStoresResponse} */
|
|
4877
|
-
declare function OrderingStoresResponse(): OrderingStoresResponse;
|
|
4878
|
-
type OrderingStoresResponse = {
|
|
4221
|
+
/** @returns {OrderingStoresResponseSchema} */
|
|
4222
|
+
declare function OrderingStoresResponseSchema(): OrderingStoresResponseSchema;
|
|
4223
|
+
type OrderingStoresResponseSchema = {
|
|
4879
4224
|
page?: Page;
|
|
4880
4225
|
items?: OrderingStore[];
|
|
4881
4226
|
};
|
|
4882
|
-
/** @returns {
|
|
4883
|
-
declare function
|
|
4884
|
-
type
|
|
4885
|
-
|
|
4886
|
-
|
|
4887
|
-
|
|
4888
|
-
|
|
4889
|
-
declare function LocationDefaultCurrency(): LocationDefaultCurrency;
|
|
4890
|
-
type LocationDefaultCurrency = {
|
|
4891
|
-
name?: string;
|
|
4892
|
-
symbol?: string;
|
|
4893
|
-
code?: string;
|
|
4894
|
-
};
|
|
4895
|
-
/** @returns {LocationCountry} */
|
|
4896
|
-
declare function LocationCountry(): LocationCountry;
|
|
4897
|
-
type LocationCountry = {
|
|
4898
|
-
capital?: string;
|
|
4899
|
-
currency?: string;
|
|
4900
|
-
iso2?: string;
|
|
4901
|
-
iso3?: string;
|
|
4902
|
-
name?: string;
|
|
4903
|
-
parent?: string;
|
|
4904
|
-
phone_code?: string;
|
|
4905
|
-
type?: string;
|
|
4906
|
-
uid?: number;
|
|
4907
|
-
__v?: number;
|
|
4908
|
-
_id?: string;
|
|
4909
|
-
default_currency?: LocationDefaultCurrency;
|
|
4910
|
-
default_language?: LocationDefaultLanguage;
|
|
4911
|
-
state_code?: string;
|
|
4912
|
-
country_code?: string;
|
|
4913
|
-
latitude?: string;
|
|
4914
|
-
longitude?: string;
|
|
4915
|
-
};
|
|
4916
|
-
/** @returns {Locations} */
|
|
4917
|
-
declare function Locations(): Locations;
|
|
4918
|
-
type Locations = {
|
|
4919
|
-
items?: LocationCountry[];
|
|
4920
|
-
};
|
|
4921
|
-
/** @returns {UrlRedirectionResponse} */
|
|
4922
|
-
declare function UrlRedirectionResponse(): UrlRedirectionResponse;
|
|
4923
|
-
type UrlRedirectionResponse = {
|
|
4924
|
-
redirections?: UrlRedirection[];
|
|
4925
|
-
};
|
|
4926
|
-
/** @returns {UrlRedirectionRequest} */
|
|
4927
|
-
declare function UrlRedirectionRequest(): UrlRedirectionRequest;
|
|
4928
|
-
type UrlRedirectionRequest = {
|
|
4929
|
-
redirection?: UrlRedirection;
|
|
4930
|
-
};
|
|
4931
|
-
/** @returns {UrlRedirection} */
|
|
4932
|
-
declare function UrlRedirection(): UrlRedirection;
|
|
4933
|
-
type UrlRedirection = {
|
|
4934
|
-
redirect_from?: string;
|
|
4935
|
-
redirect_to?: string;
|
|
4936
|
-
type?: string;
|
|
4937
|
-
_id?: string;
|
|
4938
|
-
};
|
|
4939
|
-
/** @returns {StoreForConfigurationRequest} */
|
|
4940
|
-
declare function StoreForConfigurationRequest(): StoreForConfigurationRequest;
|
|
4941
|
-
type StoreForConfigurationRequest = {
|
|
4942
|
-
conf?: AppStoreRules[];
|
|
4943
|
-
};
|
|
4944
|
-
/** @returns {DomainOptionsResponse} */
|
|
4945
|
-
declare function DomainOptionsResponse(): DomainOptionsResponse;
|
|
4946
|
-
type DomainOptionsResponse = {
|
|
4947
|
-
domain_types?: DomainType[];
|
|
4948
|
-
network_ips?: string[];
|
|
4949
|
-
network_cnames?: string[];
|
|
4950
|
-
};
|
|
4951
|
-
/** @returns {DomainType} */
|
|
4952
|
-
declare function DomainType(): DomainType;
|
|
4953
|
-
type DomainType = {
|
|
4954
|
-
key?: string;
|
|
4955
|
-
display?: string;
|
|
4956
|
-
values?: DomainValue[];
|
|
4957
|
-
};
|
|
4958
|
-
/** @returns {DomainValue} */
|
|
4959
|
-
declare function DomainValue(): DomainValue;
|
|
4960
|
-
type DomainValue = {
|
|
4961
|
-
value?: string;
|
|
4962
|
-
text?: string;
|
|
4963
|
-
};
|
|
4964
|
-
/** @returns {StoreRequest} */
|
|
4965
|
-
declare function StoreRequest(): StoreRequest;
|
|
4966
|
-
type StoreRequest = {
|
|
4967
|
-
companies?: number[];
|
|
4227
|
+
/** @returns {ValidationErrors} */
|
|
4228
|
+
declare function ValidationErrors(): ValidationErrors;
|
|
4229
|
+
type ValidationErrors = {
|
|
4230
|
+
/**
|
|
4231
|
+
* - A list of validation errors in the request.
|
|
4232
|
+
*/
|
|
4233
|
+
errors: ValidationError[];
|
|
4968
4234
|
};
|
|
4969
|
-
/** @returns {
|
|
4970
|
-
declare function
|
|
4971
|
-
type
|
|
4972
|
-
|
|
4235
|
+
/** @returns {ValidationError} */
|
|
4236
|
+
declare function ValidationError(): ValidationError;
|
|
4237
|
+
type ValidationError = {
|
|
4238
|
+
/**
|
|
4239
|
+
* - A brief description of the error encountered.
|
|
4240
|
+
*/
|
|
4241
|
+
message: string;
|
|
4242
|
+
/**
|
|
4243
|
+
* - The field in the request that caused the error.
|
|
4244
|
+
*/
|
|
4245
|
+
field: string;
|
|
4973
4246
|
};
|