@gofynd/fdk-client-javascript 3.0.0-beta.1 → 3.0.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 +1 -1
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +93 -113
- package/sdk/application/Cart/CartApplicationClient.js +157 -530
- 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 +65 -55
- package/sdk/application/Content/ContentApplicationClient.js +211 -341
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +14 -33
- 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 +32 -87
- package/sdk/application/Logistic/LogisticApplicationClient.js +126 -383
- 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 +18 -62
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +40 -372
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +99 -33
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +84 -25
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +7 -38
- 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 +15 -406
- package/sdk/platform/Billing/BillingPlatformClient.js +76 -3214
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +459 -3798
- package/sdk/platform/Billing/BillingPlatformModel.js +338 -2573
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +24 -465
- package/sdk/platform/Billing/BillingPlatformValidator.js +14 -490
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +205 -284
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +554 -672
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +165 -165
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +132 -108
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4865 -3148
- package/sdk/platform/Cart/CartPlatformModel.js +2071 -2854
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +419 -1015
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2004 -6444
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +226 -1117
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +127 -919
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +574 -372
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1315 -1238
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9334 -7634
- package/sdk/platform/Catalog/CatalogPlatformModel.js +6980 -9652
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +239 -294
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +186 -246
- 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 +236 -376
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +579 -868
- 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 +314 -422
- package/sdk/platform/Communication/CommunicationPlatformModel.js +382 -538
- 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 -68
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +88 -84
- 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 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +118 -333
- 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 +565 -1282
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +369 -1034
- 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 -246
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1297 -776
- 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 +2374 -877
- package/sdk/platform/Content/ContentPlatformModel.js +1304 -930
- 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 +421 -418
- package/sdk/platform/Order/OrderPlatformClient.js +1194 -1350
- package/sdk/platform/Order/OrderPlatformModel.d.ts +9145 -4107
- package/sdk/platform/Order/OrderPlatformModel.js +4257 -3197
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +641 -442
- package/sdk/platform/Order/OrderPlatformValidator.js +341 -311
- 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 +934 -2452
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +93 -306
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +70 -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 +1327 -3529
- package/sdk/platform/Payment/PaymentPlatformModel.js +1397 -3693
- 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 -513
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +75 -103
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +50 -99
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +162 -127
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +775 -435
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +6250 -3861
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3178 -3798
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +295 -199
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +205 -133
- 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 -4
- package/sdk/platform/Share/SharePlatformModel.js +45 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +4 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +10 -157
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +10 -21
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +6 -23
- 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 -2
- package/sdk/public/PublicClient.js +2 -2
- 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 -1
- package/sdk/public/index.js +1 -1
- 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
- package/sdk/public/Billing/BillingPublicClient.d.ts +0 -56
- package/sdk/public/Billing/BillingPublicClient.js +0 -397
- package/sdk/public/Billing/BillingPublicModel.d.ts +0 -919
- package/sdk/public/Billing/BillingPublicModel.js +0 -560
- package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -43
- package/sdk/public/Billing/BillingPublicValidator.js +0 -50
|
@@ -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
|
|
@@ -984,6 +807,7 @@ export = ConfigurationPlatformModel;
|
|
|
984
807
|
*/
|
|
985
808
|
/**
|
|
986
809
|
* @typedef GoogleMap
|
|
810
|
+
* @property {boolean} [enabled] - Shows whether Google map integration is enabled or not.
|
|
987
811
|
* @property {GoogleMapCredentials} [credentials]
|
|
988
812
|
*/
|
|
989
813
|
/**
|
|
@@ -1044,6 +868,20 @@ export = ConfigurationPlatformModel;
|
|
|
1044
868
|
* @property {boolean} [ask_store_address] - Shows whether a form to collect the
|
|
1045
869
|
* address of the store, should be displayed upon visiting the website
|
|
1046
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
|
+
*/
|
|
1047
885
|
/**
|
|
1048
886
|
* @typedef AppFeature
|
|
1049
887
|
* @property {ProductDetailFeature} [product_detail]
|
|
@@ -1056,15 +894,14 @@ export = ConfigurationPlatformModel;
|
|
|
1056
894
|
* @property {PcrFeature} [pcr]
|
|
1057
895
|
* @property {OrderFeature} [order]
|
|
1058
896
|
* @property {BuyboxFeature} [buybox]
|
|
1059
|
-
* @property {
|
|
1060
|
-
*
|
|
897
|
+
* @property {DeliveryStrategy} [delivery_strategy]
|
|
898
|
+
* @property {string} [_id] - The unique identifier for the sales channel features
|
|
1061
899
|
* @property {string} [app] - Application ID of the sales channel
|
|
1062
900
|
* @property {string} [created_at] - ISO 8601 timestamp showing the date when
|
|
1063
901
|
* the features were configured
|
|
1064
902
|
* @property {string} [modified_at] - ISO 8601 timestamp of last known
|
|
1065
903
|
* modifications to the sales channel feature configuration
|
|
1066
904
|
* @property {number} [__v] - Version key for tracking revisions. Default value is zero
|
|
1067
|
-
* @property {PricingStrategy} [pricing_strategy]
|
|
1068
905
|
*/
|
|
1069
906
|
/**
|
|
1070
907
|
* @typedef HomePageFeature
|
|
@@ -1161,27 +998,17 @@ export = ConfigurationPlatformModel;
|
|
|
1161
998
|
* value is false.
|
|
1162
999
|
*/
|
|
1163
1000
|
/**
|
|
1164
|
-
* @typedef
|
|
1165
|
-
* @property {boolean} [show_name] - Allow users to see seller/stores name on
|
|
1166
|
-
* PDP (product detail page).
|
|
1167
|
-
* @property {boolean} [enable_selection] - Allow selection of sellers/stores on
|
|
1168
|
-
* PDP (product detail page).
|
|
1169
|
-
* @property {boolean} [is_seller_buybox_enabled] - Toggle buybox listing
|
|
1170
|
-
* between sellers and stores. True indicates seller listing, while False
|
|
1171
|
-
* indicates store listing.
|
|
1172
|
-
*/
|
|
1173
|
-
/**
|
|
1174
|
-
* @typedef AppFeatureRequest
|
|
1001
|
+
* @typedef AppFeatureRequestSchema
|
|
1175
1002
|
* @property {AppFeature} [feature]
|
|
1176
1003
|
*/
|
|
1177
1004
|
/**
|
|
1178
|
-
* @typedef
|
|
1005
|
+
* @typedef AppFeatureResponseSchema
|
|
1179
1006
|
* @property {AppFeature} [feature]
|
|
1180
1007
|
*/
|
|
1181
1008
|
/**
|
|
1182
1009
|
* @typedef Currency
|
|
1183
|
-
* @property {string} [_id] - The unique identifier
|
|
1184
|
-
*
|
|
1010
|
+
* @property {string} [_id] - The unique identifier of the current sales channel
|
|
1011
|
+
* supported currency
|
|
1185
1012
|
* @property {boolean} [is_active] - Shows currency is enabled or not in current
|
|
1186
1013
|
* sales channel
|
|
1187
1014
|
* @property {string} [name] - Name of the currency, e.g Indian Rupee
|
|
@@ -1243,11 +1070,9 @@ export = ConfigurationPlatformModel;
|
|
|
1243
1070
|
* @property {boolean} [is_internal] - Indicates whether a sales channel is
|
|
1244
1071
|
* internal or not
|
|
1245
1072
|
* @property {boolean} [is_active] - Indicates sales channel is active or not active
|
|
1246
|
-
* @property {string} [_id] - The unique identifier
|
|
1247
|
-
* of the sales channel
|
|
1073
|
+
* @property {string} [_id] - The unique identifier of the sales channel
|
|
1248
1074
|
* @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
|
|
1249
|
-
* @property {string} [owner] - The unique identifier
|
|
1250
|
-
* of owner who owns the application
|
|
1075
|
+
* @property {string} [owner] - The unique identifier of owner who owns the application
|
|
1251
1076
|
* @property {number} [company_id] - Numeric ID allotted to a business account
|
|
1252
1077
|
* where the sales channel exists
|
|
1253
1078
|
* @property {string} [token] - Random generated fix length string for sales
|
|
@@ -1270,6 +1095,51 @@ export = ConfigurationPlatformModel;
|
|
|
1270
1095
|
* @property {TokenSchema[]} [tokens]
|
|
1271
1096
|
* @property {string} [secret]
|
|
1272
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
|
+
*/
|
|
1273
1143
|
/**
|
|
1274
1144
|
* @typedef TokenSchema
|
|
1275
1145
|
* @property {string} [token]
|
|
@@ -1277,55 +1147,9 @@ export = ConfigurationPlatformModel;
|
|
|
1277
1147
|
* @property {string} [created_at] - ISO 8601 timestamp of when token created
|
|
1278
1148
|
*/
|
|
1279
1149
|
/**
|
|
1280
|
-
* @typedef
|
|
1150
|
+
* @typedef InvalidPayloadRequestSchema
|
|
1281
1151
|
* @property {string} [message] - Error message when request body payload is improper
|
|
1282
1152
|
* @property {boolean} [success] - Flag for required not successfull.
|
|
1283
|
-
* @property {Object} [domain] - All errors related to domin
|
|
1284
|
-
*/
|
|
1285
|
-
/**
|
|
1286
|
-
* @typedef InventoryBrandRule
|
|
1287
|
-
* @property {string} [criteria] - Whether all brands are enabled, or explicitly
|
|
1288
|
-
* few brands in the inventory
|
|
1289
|
-
* @property {number[]} [brands]
|
|
1290
|
-
*/
|
|
1291
|
-
/**
|
|
1292
|
-
* @typedef PricingStrategy
|
|
1293
|
-
* @property {string} [value] - Indicates the pricing strategy value.
|
|
1294
|
-
*/
|
|
1295
|
-
/**
|
|
1296
|
-
* @typedef StoreCriteriaRule
|
|
1297
|
-
* @property {number[]} [companies] - List of company UID
|
|
1298
|
-
* @property {number[]} [brands] - List of brand UID
|
|
1299
|
-
*/
|
|
1300
|
-
/**
|
|
1301
|
-
* @typedef InventoryStoreRule
|
|
1302
|
-
* @property {string} [criteria] - Whether all stores are enabled, or explicitly
|
|
1303
|
-
* few stores in the inventory, or use brands and company filter.
|
|
1304
|
-
* @property {StoreCriteriaRule[]} [rules] - List of rules with company and
|
|
1305
|
-
* brands uids. Used when critera is `filter`.
|
|
1306
|
-
* @property {number[]} [stores] - List of store uids. Used when critera is `explicit`.
|
|
1307
|
-
*/
|
|
1308
|
-
/**
|
|
1309
|
-
* @typedef InventoryPaymentConfig
|
|
1310
|
-
* @property {string} [mode_of_payment] - Mode of payment for the inventory of
|
|
1311
|
-
* sales channel. It is required and default value is null.
|
|
1312
|
-
* @property {string} [source] - Source of the payment mode for the inventory
|
|
1313
|
-
* payment of sales channel. Default value is FYND.
|
|
1314
|
-
*/
|
|
1315
|
-
/**
|
|
1316
|
-
* @typedef StorePriorityRule
|
|
1317
|
-
* @property {boolean} [enabled] - Shows store priority is enabled or not
|
|
1318
|
-
* enabled for the article assignment.
|
|
1319
|
-
* @property {string[]} [storetype_order]
|
|
1320
|
-
*/
|
|
1321
|
-
/**
|
|
1322
|
-
* @typedef ArticleAssignmentRule
|
|
1323
|
-
* @property {StorePriorityRule} [store_priority]
|
|
1324
|
-
*/
|
|
1325
|
-
/**
|
|
1326
|
-
* @typedef InventoryArticleAssignment
|
|
1327
|
-
* @property {boolean} [post_order_reassignment] - Allow post order reassigment of article
|
|
1328
|
-
* @property {ArticleAssignmentRule} [rules]
|
|
1329
1153
|
*/
|
|
1330
1154
|
/**
|
|
1331
1155
|
* @typedef Page
|
|
@@ -1336,7 +1160,7 @@ export = ConfigurationPlatformModel;
|
|
|
1336
1160
|
* @property {number} [current] - The current page number.
|
|
1337
1161
|
* @property {string} type - The type of the page, such as 'PageType'.
|
|
1338
1162
|
* @property {number} [size] - The number of items per page.
|
|
1339
|
-
* @property {number} [
|
|
1163
|
+
* @property {number} [page_size] - The number of items per page.
|
|
1340
1164
|
*/
|
|
1341
1165
|
/**
|
|
1342
1166
|
* @typedef ApplicationInformation
|
|
@@ -1346,8 +1170,7 @@ export = ConfigurationPlatformModel;
|
|
|
1346
1170
|
* @property {Links[]} [links]
|
|
1347
1171
|
* @property {string} [copyright_text] - Copyright statement usually seen at the
|
|
1348
1172
|
* site's footer
|
|
1349
|
-
* @property {string} [_id] - Unique identifier
|
|
1350
|
-
* the application information
|
|
1173
|
+
* @property {string} [_id] - Unique identifier of the application information
|
|
1351
1174
|
* @property {BusinessHighlights[]} [business_highlights]
|
|
1352
1175
|
* @property {string} [application] - Alphanumeric ID allotted to a sales
|
|
1353
1176
|
* channel application created within a business account
|
|
@@ -1466,8 +1289,7 @@ export = ConfigurationPlatformModel;
|
|
|
1466
1289
|
*/
|
|
1467
1290
|
/**
|
|
1468
1291
|
* @typedef BusinessHighlights
|
|
1469
|
-
* @property {string} [_id] - Unique identifier
|
|
1470
|
-
* the related business
|
|
1292
|
+
* @property {string} [_id] - Unique identifier of the related business
|
|
1471
1293
|
* @property {string} [title] - Title of the business highlight, e.g. Superfast Delivery
|
|
1472
1294
|
* @property {string} [icon] - Hosted URL of icon image representing the
|
|
1473
1295
|
* business highlight
|
|
@@ -1484,19 +1306,18 @@ export = ConfigurationPlatformModel;
|
|
|
1484
1306
|
* @property {SecureUrl} [banner]
|
|
1485
1307
|
* @property {Domain} [domain]
|
|
1486
1308
|
* @property {Domain[]} [domains]
|
|
1487
|
-
* @property {string} [_id] - The unique identifier
|
|
1488
|
-
* for the sales channel details
|
|
1309
|
+
* @property {string} [_id] - The unique identifier for the sales channel details
|
|
1489
1310
|
* @property {string} [slug]
|
|
1490
1311
|
* @property {number} [company_id]
|
|
1491
1312
|
*/
|
|
1492
1313
|
/**
|
|
1493
|
-
* @typedef
|
|
1314
|
+
* @typedef CurrenciesResponseSchema
|
|
1494
1315
|
* @property {Currency[]} [items]
|
|
1495
1316
|
*/
|
|
1496
1317
|
/**
|
|
1497
|
-
* @typedef
|
|
1498
|
-
* @property {string} [_id] - The unique identifier
|
|
1499
|
-
*
|
|
1318
|
+
* @typedef AppCurrencyResponseSchema
|
|
1319
|
+
* @property {string} [_id] - The unique identifier of the currency
|
|
1320
|
+
* configuration supported by the application
|
|
1500
1321
|
* @property {string} [application] - Alphanumeric ID allotted to an application
|
|
1501
1322
|
* (sales channel website) created within a business account
|
|
1502
1323
|
* @property {DefaultCurrency} [default_currency]
|
|
@@ -1527,8 +1348,7 @@ export = ConfigurationPlatformModel;
|
|
|
1527
1348
|
/**
|
|
1528
1349
|
* @typedef OrderingStore
|
|
1529
1350
|
* @property {OptedStoreAddress} [address]
|
|
1530
|
-
* @property {string} [_id] - The unique identifier
|
|
1531
|
-
* of the ordering store
|
|
1351
|
+
* @property {string} [_id] - The unique identifier of the ordering store
|
|
1532
1352
|
* @property {number} [uid] - Ordering store UID
|
|
1533
1353
|
* @property {string} [name] - Store name of the ordering store
|
|
1534
1354
|
* @property {string} [display_name] - Display name of the ordering store
|
|
@@ -1547,134 +1367,97 @@ export = ConfigurationPlatformModel;
|
|
|
1547
1367
|
* @property {boolean} [enabled] - Allow ordering stores for current sales channel
|
|
1548
1368
|
* @property {string} [type] - For hard type delivery, store selection is
|
|
1549
1369
|
* compulsory. For soft type, delivery store selection is optional.
|
|
1550
|
-
* @property {string} [_id] - The unique identifier
|
|
1551
|
-
* of the ordering store
|
|
1370
|
+
* @property {string} [_id] - The unique identifier of the ordering store
|
|
1552
1371
|
* @property {string} [app] - Alphanumeric ID allotted to an application (sales
|
|
1553
1372
|
* channel website) created within a business account
|
|
1554
1373
|
* @property {number} [__v] - Version key for tracking ordering stores. Default
|
|
1555
1374
|
* value is zero.
|
|
1556
1375
|
*/
|
|
1557
1376
|
/**
|
|
1558
|
-
* @typedef
|
|
1559
|
-
* @property {string} type
|
|
1560
|
-
* @property {number} [interval]
|
|
1561
|
-
*/
|
|
1562
|
-
/**
|
|
1563
|
-
* @typedef PlatformVersionRequest
|
|
1564
|
-
* @property {string} app_code_name
|
|
1565
|
-
* @property {string} app_name
|
|
1566
|
-
* @property {string} force_version
|
|
1567
|
-
* @property {string} latest_version
|
|
1568
|
-
* @property {boolean} is_app_blocked
|
|
1569
|
-
* @property {UpdateDiealog} update_dialog
|
|
1570
|
-
*/
|
|
1571
|
-
/**
|
|
1572
|
-
* @typedef PlatformVersion
|
|
1573
|
-
* @property {string} app_code_name
|
|
1574
|
-
* @property {string} app_name
|
|
1575
|
-
* @property {string} force_version
|
|
1576
|
-
* @property {string} latest_version
|
|
1577
|
-
* @property {boolean} is_app_blocked
|
|
1578
|
-
* @property {UpdateDiealog} update_dialog
|
|
1579
|
-
* @property {string} [_id]
|
|
1580
|
-
* @property {string} [modified_at] - ISO 8601 timestamp when currency was added
|
|
1581
|
-
* in the list of currencies supported by the sales channel
|
|
1582
|
-
* @property {string} [created_at] - ISO 8601 timestamp when currency was added
|
|
1583
|
-
* in the list of currencies supported by the sales channel
|
|
1584
|
-
* @property {number} [__v]
|
|
1585
|
-
*/
|
|
1586
|
-
/**
|
|
1587
|
-
* @typedef OrderingStoresResponse
|
|
1377
|
+
* @typedef OrderingStoresResponseSchema
|
|
1588
1378
|
* @property {Page} [page]
|
|
1589
1379
|
* @property {OrderingStore[]} [items]
|
|
1590
1380
|
*/
|
|
1591
1381
|
/**
|
|
1592
|
-
* @typedef
|
|
1593
|
-
* @property {
|
|
1594
|
-
* @property {string} [code]
|
|
1595
|
-
*/
|
|
1596
|
-
/**
|
|
1597
|
-
* @typedef LocationDefaultCurrency
|
|
1598
|
-
* @property {string} [name]
|
|
1599
|
-
* @property {string} [symbol]
|
|
1600
|
-
* @property {string} [code]
|
|
1601
|
-
*/
|
|
1602
|
-
/**
|
|
1603
|
-
* @typedef LocationCountry
|
|
1604
|
-
* @property {string} [capital]
|
|
1605
|
-
* @property {string} [currency]
|
|
1606
|
-
* @property {string} [iso2]
|
|
1607
|
-
* @property {string} [iso3]
|
|
1608
|
-
* @property {string} [name]
|
|
1609
|
-
* @property {string} [parent]
|
|
1610
|
-
* @property {string} [phone_code]
|
|
1611
|
-
* @property {string} [type]
|
|
1612
|
-
* @property {number} [uid]
|
|
1613
|
-
* @property {number} [__v]
|
|
1614
|
-
* @property {string} [_id]
|
|
1615
|
-
* @property {LocationDefaultCurrency} [default_currency]
|
|
1616
|
-
* @property {LocationDefaultLanguage} [default_language]
|
|
1617
|
-
* @property {string} [state_code]
|
|
1618
|
-
* @property {string} [country_code]
|
|
1619
|
-
* @property {string} [latitude]
|
|
1620
|
-
* @property {string} [longitude]
|
|
1621
|
-
*/
|
|
1622
|
-
/**
|
|
1623
|
-
* @typedef Locations
|
|
1624
|
-
* @property {LocationCountry[]} [items]
|
|
1625
|
-
*/
|
|
1626
|
-
/**
|
|
1627
|
-
* @typedef UrlRedirectionResponse
|
|
1628
|
-
* @property {UrlRedirection[]} [redirections]
|
|
1629
|
-
*/
|
|
1630
|
-
/**
|
|
1631
|
-
* @typedef UrlRedirectionRequest
|
|
1632
|
-
* @property {UrlRedirection} [redirection]
|
|
1633
|
-
*/
|
|
1634
|
-
/**
|
|
1635
|
-
* @typedef UrlRedirection
|
|
1636
|
-
* @property {string} [redirect_from]
|
|
1637
|
-
* @property {string} [redirect_to]
|
|
1638
|
-
* @property {string} [type]
|
|
1639
|
-
* @property {string} [_id]
|
|
1640
|
-
*/
|
|
1641
|
-
/**
|
|
1642
|
-
* @typedef StoreForConfigurationRequest
|
|
1643
|
-
* @property {AppStoreRules[]} [conf]
|
|
1644
|
-
*/
|
|
1645
|
-
/**
|
|
1646
|
-
* @typedef DomainOptionsResponse
|
|
1647
|
-
* @property {DomainType[]} [domain_types]
|
|
1648
|
-
* @property {string[]} [network_ips]
|
|
1649
|
-
* @property {string[]} [network_cnames]
|
|
1650
|
-
*/
|
|
1651
|
-
/**
|
|
1652
|
-
* @typedef DomainType
|
|
1653
|
-
* @property {string} [key]
|
|
1654
|
-
* @property {string} [display]
|
|
1655
|
-
* @property {DomainValue[]} [values]
|
|
1656
|
-
*/
|
|
1657
|
-
/**
|
|
1658
|
-
* @typedef DomainValue
|
|
1659
|
-
* @property {string} [value]
|
|
1660
|
-
* @property {string} [text]
|
|
1661
|
-
*/
|
|
1662
|
-
/**
|
|
1663
|
-
* @typedef StoreRequest
|
|
1664
|
-
* @property {number[]} [companies]
|
|
1382
|
+
* @typedef ValidationErrors
|
|
1383
|
+
* @property {ValidationError[]} errors - A list of validation errors in the request.
|
|
1665
1384
|
*/
|
|
1666
1385
|
/**
|
|
1667
|
-
* @typedef
|
|
1668
|
-
* @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.
|
|
1669
1389
|
*/
|
|
1670
1390
|
declare class ConfigurationPlatformModel {
|
|
1671
1391
|
}
|
|
1672
1392
|
declare namespace ConfigurationPlatformModel {
|
|
1673
|
-
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 };
|
|
1674
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
|
+
};
|
|
1675
1457
|
/** @returns {ApplicationInventory} */
|
|
1676
1458
|
declare function ApplicationInventory(): ApplicationInventory;
|
|
1677
1459
|
type ApplicationInventory = {
|
|
1460
|
+
search?: SearchConfig;
|
|
1678
1461
|
inventory?: AppInventoryConfig;
|
|
1679
1462
|
authentication?: AuthenticationConfig;
|
|
1680
1463
|
article_assignment?: ArticleAssignmentConfig;
|
|
@@ -1699,8 +1482,7 @@ type ApplicationInventory = {
|
|
|
1699
1482
|
communication?: CommunicationConfig;
|
|
1700
1483
|
platforms?: string[];
|
|
1701
1484
|
/**
|
|
1702
|
-
* - The unique identifier
|
|
1703
|
-
* of the sales channel inventory
|
|
1485
|
+
* - The unique identifier of the sales channel inventory
|
|
1704
1486
|
*/
|
|
1705
1487
|
_id?: string;
|
|
1706
1488
|
loyalty_points?: LoyaltyPointsConfig;
|
|
@@ -1729,25 +1511,45 @@ declare function PiiMasking(): PiiMasking;
|
|
|
1729
1511
|
type PiiMasking = {
|
|
1730
1512
|
enabled?: boolean;
|
|
1731
1513
|
};
|
|
1732
|
-
/** @returns {
|
|
1733
|
-
declare function
|
|
1734
|
-
type
|
|
1735
|
-
|
|
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;
|
|
1736
1537
|
};
|
|
1737
|
-
/** @returns {
|
|
1738
|
-
declare function
|
|
1739
|
-
type
|
|
1740
|
-
|
|
1538
|
+
/** @returns {SearchConfig} */
|
|
1539
|
+
declare function SearchConfig(): SearchConfig;
|
|
1540
|
+
type SearchConfig = {
|
|
1541
|
+
fst_identification?: FstIdentification;
|
|
1542
|
+
query_suggestions?: QuerySuggestions;
|
|
1741
1543
|
};
|
|
1742
1544
|
/** @returns {AppInventoryConfig} */
|
|
1743
1545
|
declare function AppInventoryConfig(): AppInventoryConfig;
|
|
1744
1546
|
type AppInventoryConfig = {
|
|
1547
|
+
delivery_strategy?: DeliveryStrategy;
|
|
1745
1548
|
brand?: InventoryBrand;
|
|
1746
1549
|
store?: InventoryStore;
|
|
1747
1550
|
category?: InventoryCategory;
|
|
1748
1551
|
price?: InventoryPrice;
|
|
1749
1552
|
discount?: InventoryDiscount;
|
|
1750
|
-
pricing_strategy?: PricingStrategy;
|
|
1751
1553
|
/**
|
|
1752
1554
|
* - Indicates whether out of stock products
|
|
1753
1555
|
* are allowed to show up on the website
|
|
@@ -1766,13 +1568,13 @@ type AppInventoryConfig = {
|
|
|
1766
1568
|
/**
|
|
1767
1569
|
* - List of excluded brands category
|
|
1768
1570
|
*/
|
|
1769
|
-
exclude_category?:
|
|
1571
|
+
exclude_category?: any[];
|
|
1770
1572
|
image?: string[];
|
|
1771
1573
|
/**
|
|
1772
1574
|
* - List of selling locations whose
|
|
1773
1575
|
* inventory is available to the sales channel for displaying on the website
|
|
1774
1576
|
*/
|
|
1775
|
-
company_store?:
|
|
1577
|
+
company_store?: any[];
|
|
1776
1578
|
company_id?: number;
|
|
1777
1579
|
};
|
|
1778
1580
|
/** @returns {InventoryBrand} */
|
|
@@ -1799,7 +1601,7 @@ type InventoryStore = {
|
|
|
1799
1601
|
/**
|
|
1800
1602
|
* - List of stores
|
|
1801
1603
|
*/
|
|
1802
|
-
stores?:
|
|
1604
|
+
stores?: any[];
|
|
1803
1605
|
/**
|
|
1804
1606
|
* - Rules to show which brands or companies
|
|
1805
1607
|
* products should be listed on sales channel.
|
|
@@ -1828,7 +1630,7 @@ type InventoryCategory = {
|
|
|
1828
1630
|
* - List of categories whose products will be
|
|
1829
1631
|
* shown on the website
|
|
1830
1632
|
*/
|
|
1831
|
-
categories?:
|
|
1633
|
+
categories?: any[];
|
|
1832
1634
|
};
|
|
1833
1635
|
/** @returns {InventoryPrice} */
|
|
1834
1636
|
declare function InventoryPrice(): InventoryPrice;
|
|
@@ -1894,7 +1696,7 @@ type StorePriority = {
|
|
|
1894
1696
|
* - List of store types for article
|
|
1895
1697
|
* assignment e.g. warehouse, mall, highstreet
|
|
1896
1698
|
*/
|
|
1897
|
-
storetype_order?:
|
|
1699
|
+
storetype_order?: any[];
|
|
1898
1700
|
};
|
|
1899
1701
|
/** @returns {AppCartConfig} */
|
|
1900
1702
|
declare function AppCartConfig(): AppCartConfig;
|
|
@@ -2097,6 +1899,7 @@ type LoyaltyPointsConfig = {
|
|
|
2097
1899
|
/** @returns {AppInventoryPartialUpdate} */
|
|
2098
1900
|
declare function AppInventoryPartialUpdate(): AppInventoryPartialUpdate;
|
|
2099
1901
|
type AppInventoryPartialUpdate = {
|
|
1902
|
+
search?: SearchConfig;
|
|
2100
1903
|
reward_points?: RewardPointsConfig;
|
|
2101
1904
|
cart?: AppCartConfig;
|
|
2102
1905
|
payment?: AppPaymentConfig;
|
|
@@ -2120,9 +1923,9 @@ type BrandCompanyInfo = {
|
|
|
2120
1923
|
*/
|
|
2121
1924
|
company_id?: number;
|
|
2122
1925
|
};
|
|
2123
|
-
/** @returns {
|
|
2124
|
-
declare function
|
|
2125
|
-
type
|
|
1926
|
+
/** @returns {CompanyByBrandsRequestSchema} */
|
|
1927
|
+
declare function CompanyByBrandsRequestSchema(): CompanyByBrandsRequestSchema;
|
|
1928
|
+
type CompanyByBrandsRequestSchema = {
|
|
2126
1929
|
/**
|
|
2127
1930
|
* - Brand UID
|
|
2128
1931
|
*/
|
|
@@ -2132,15 +1935,15 @@ type CompanyByBrandsRequest = {
|
|
|
2132
1935
|
*/
|
|
2133
1936
|
search_text?: string;
|
|
2134
1937
|
};
|
|
2135
|
-
/** @returns {
|
|
2136
|
-
declare function
|
|
2137
|
-
type
|
|
1938
|
+
/** @returns {CompanyByBrandsResponseSchema} */
|
|
1939
|
+
declare function CompanyByBrandsResponseSchema(): CompanyByBrandsResponseSchema;
|
|
1940
|
+
type CompanyByBrandsResponseSchema = {
|
|
2138
1941
|
items?: BrandCompanyInfo[];
|
|
2139
1942
|
page?: Page;
|
|
2140
1943
|
};
|
|
2141
|
-
/** @returns {
|
|
2142
|
-
declare function
|
|
2143
|
-
type
|
|
1944
|
+
/** @returns {StoreByBrandsRequestSchema} */
|
|
1945
|
+
declare function StoreByBrandsRequestSchema(): StoreByBrandsRequestSchema;
|
|
1946
|
+
type StoreByBrandsRequestSchema = {
|
|
2144
1947
|
/**
|
|
2145
1948
|
* - Current company ID for current company
|
|
2146
1949
|
* stores only. Don't send in case cross-selling (franchise) is enabled.
|
|
@@ -2155,9 +1958,9 @@ type StoreByBrandsRequest = {
|
|
|
2155
1958
|
*/
|
|
2156
1959
|
search_text?: string;
|
|
2157
1960
|
};
|
|
2158
|
-
/** @returns {
|
|
2159
|
-
declare function
|
|
2160
|
-
type
|
|
1961
|
+
/** @returns {StoreByBrandsResponseSchema} */
|
|
1962
|
+
declare function StoreByBrandsResponseSchema(): StoreByBrandsResponseSchema;
|
|
1963
|
+
type StoreByBrandsResponseSchema = {
|
|
2161
1964
|
items?: BrandStoreInfo[];
|
|
2162
1965
|
page?: Page;
|
|
2163
1966
|
};
|
|
@@ -2210,22 +2013,18 @@ type CompanyBrandInfo = {
|
|
|
2210
2013
|
*/
|
|
2211
2014
|
brand_banner_portrait_url?: string;
|
|
2212
2015
|
};
|
|
2213
|
-
/** @returns {
|
|
2214
|
-
declare function
|
|
2215
|
-
type
|
|
2016
|
+
/** @returns {BrandsByCompanyResponseSchema} */
|
|
2017
|
+
declare function BrandsByCompanyResponseSchema(): BrandsByCompanyResponseSchema;
|
|
2018
|
+
type BrandsByCompanyResponseSchema = {
|
|
2216
2019
|
brands?: CompanyBrandInfo[];
|
|
2217
2020
|
};
|
|
2218
|
-
/** @returns {
|
|
2219
|
-
declare function
|
|
2220
|
-
type
|
|
2021
|
+
/** @returns {ValidationFailedResponseSchema} */
|
|
2022
|
+
declare function ValidationFailedResponseSchema(): ValidationFailedResponseSchema;
|
|
2023
|
+
type ValidationFailedResponseSchema = {
|
|
2221
2024
|
/**
|
|
2222
2025
|
* - Response message for failed validation
|
|
2223
2026
|
*/
|
|
2224
2027
|
message?: string;
|
|
2225
|
-
/**
|
|
2226
|
-
* - Response message for failed validation
|
|
2227
|
-
*/
|
|
2228
|
-
errors?: any[];
|
|
2229
2028
|
};
|
|
2230
2029
|
/** @returns {NotFound} */
|
|
2231
2030
|
declare function NotFound(): NotFound;
|
|
@@ -2234,14 +2033,6 @@ type NotFound = {
|
|
|
2234
2033
|
* - Response message for not found
|
|
2235
2034
|
*/
|
|
2236
2035
|
message?: string;
|
|
2237
|
-
/**
|
|
2238
|
-
* - Error message for not found
|
|
2239
|
-
*/
|
|
2240
|
-
error?: string;
|
|
2241
|
-
/**
|
|
2242
|
-
* - Unique code for each error
|
|
2243
|
-
*/
|
|
2244
|
-
code?: string;
|
|
2245
2036
|
/**
|
|
2246
2037
|
* - Flag for required not successfull.
|
|
2247
2038
|
*/
|
|
@@ -2280,22 +2071,22 @@ type PanCardConfig = {
|
|
|
2280
2071
|
*/
|
|
2281
2072
|
online_threshold_amount?: number;
|
|
2282
2073
|
};
|
|
2283
|
-
/** @returns {
|
|
2284
|
-
declare function
|
|
2285
|
-
type
|
|
2074
|
+
/** @returns {CreateApplicationRequestSchema} */
|
|
2075
|
+
declare function CreateApplicationRequestSchema(): CreateApplicationRequestSchema;
|
|
2076
|
+
type CreateApplicationRequestSchema = {
|
|
2286
2077
|
app?: App;
|
|
2287
2078
|
configuration?: ApplicationInventory;
|
|
2288
2079
|
domain?: AppDomain;
|
|
2289
2080
|
};
|
|
2290
|
-
/** @returns {
|
|
2291
|
-
declare function
|
|
2292
|
-
type
|
|
2081
|
+
/** @returns {CreateAppResponseSchema} */
|
|
2082
|
+
declare function CreateAppResponseSchema(): CreateAppResponseSchema;
|
|
2083
|
+
type CreateAppResponseSchema = {
|
|
2293
2084
|
app?: Application;
|
|
2294
2085
|
configuration?: ApplicationInventory;
|
|
2295
2086
|
};
|
|
2296
|
-
/** @returns {
|
|
2297
|
-
declare function
|
|
2298
|
-
type
|
|
2087
|
+
/** @returns {ApplicationsResponseSchema} */
|
|
2088
|
+
declare function ApplicationsResponseSchema(): ApplicationsResponseSchema;
|
|
2089
|
+
type ApplicationsResponseSchema = {
|
|
2299
2090
|
items?: Application[];
|
|
2300
2091
|
page?: Page;
|
|
2301
2092
|
};
|
|
@@ -2307,8 +2098,7 @@ type MobileAppConfiguration = {
|
|
|
2307
2098
|
*/
|
|
2308
2099
|
is_active?: boolean;
|
|
2309
2100
|
/**
|
|
2310
|
-
* - The unique identifier
|
|
2311
|
-
* for mobile application configuration
|
|
2101
|
+
* - The unique identifier for mobile application configuration
|
|
2312
2102
|
*/
|
|
2313
2103
|
_id?: string;
|
|
2314
2104
|
/**
|
|
@@ -2370,9 +2160,9 @@ type SplashImage = {
|
|
|
2370
2160
|
*/
|
|
2371
2161
|
secure_url?: string;
|
|
2372
2162
|
};
|
|
2373
|
-
/** @returns {
|
|
2374
|
-
declare function
|
|
2375
|
-
type
|
|
2163
|
+
/** @returns {MobileAppConfigRequestSchema} */
|
|
2164
|
+
declare function MobileAppConfigRequestSchema(): MobileAppConfigRequestSchema;
|
|
2165
|
+
type MobileAppConfigRequestSchema = {
|
|
2376
2166
|
/**
|
|
2377
2167
|
* - Name of the mobile app
|
|
2378
2168
|
*/
|
|
@@ -2398,7 +2188,7 @@ type BuildVersionHistory = {
|
|
|
2398
2188
|
declare function BuildVersion(): BuildVersion;
|
|
2399
2189
|
type BuildVersion = {
|
|
2400
2190
|
/**
|
|
2401
|
-
* -
|
|
2191
|
+
* - Primary Identifier of the build version.
|
|
2402
2192
|
*/
|
|
2403
2193
|
_id?: string;
|
|
2404
2194
|
/**
|
|
@@ -2444,8 +2234,8 @@ type BuildVersion = {
|
|
|
2444
2234
|
declare function AppSupportedCurrency(): AppSupportedCurrency;
|
|
2445
2235
|
type AppSupportedCurrency = {
|
|
2446
2236
|
/**
|
|
2447
|
-
* - The unique identifier
|
|
2448
|
-
*
|
|
2237
|
+
* - The unique identifier of the currency
|
|
2238
|
+
* configuration supported by the application
|
|
2449
2239
|
*/
|
|
2450
2240
|
_id?: string;
|
|
2451
2241
|
supported_currency?: string[];
|
|
@@ -2470,8 +2260,7 @@ type AppSupportedCurrency = {
|
|
|
2470
2260
|
declare function DefaultCurrency(): DefaultCurrency;
|
|
2471
2261
|
type DefaultCurrency = {
|
|
2472
2262
|
/**
|
|
2473
|
-
* - The unique identifier
|
|
2474
|
-
* of the default currency
|
|
2263
|
+
* - The unique identifier of the default currency
|
|
2475
2264
|
*/
|
|
2476
2265
|
ref?: string;
|
|
2477
2266
|
/**
|
|
@@ -2488,8 +2277,7 @@ type DomainAdd = {
|
|
|
2488
2277
|
*/
|
|
2489
2278
|
name?: string;
|
|
2490
2279
|
/**
|
|
2491
|
-
* - The unique identifier
|
|
2492
|
-
* of the domain
|
|
2280
|
+
* - The unique identifier of the domain
|
|
2493
2281
|
*/
|
|
2494
2282
|
_id?: string;
|
|
2495
2283
|
/**
|
|
@@ -2514,9 +2302,9 @@ type DomainAdd = {
|
|
|
2514
2302
|
message?: string;
|
|
2515
2303
|
txt_records?: string[];
|
|
2516
2304
|
};
|
|
2517
|
-
/** @returns {
|
|
2518
|
-
declare function
|
|
2519
|
-
type
|
|
2305
|
+
/** @returns {DomainAddRequestSchema} */
|
|
2306
|
+
declare function DomainAddRequestSchema(): DomainAddRequestSchema;
|
|
2307
|
+
type DomainAddRequestSchema = {
|
|
2520
2308
|
domain?: DomainAdd;
|
|
2521
2309
|
};
|
|
2522
2310
|
/** @returns {Domain} */
|
|
@@ -2527,8 +2315,7 @@ type Domain = {
|
|
|
2527
2315
|
*/
|
|
2528
2316
|
name?: string;
|
|
2529
2317
|
/**
|
|
2530
|
-
* - The unique identifier
|
|
2531
|
-
* of the sales channel domain
|
|
2318
|
+
* - The unique identifier of the sales channel domain
|
|
2532
2319
|
*/
|
|
2533
2320
|
_id?: string;
|
|
2534
2321
|
/**
|
|
@@ -2551,9 +2338,9 @@ type Domain = {
|
|
|
2551
2338
|
is_predefined?: boolean;
|
|
2552
2339
|
message?: string;
|
|
2553
2340
|
};
|
|
2554
|
-
/** @returns {
|
|
2555
|
-
declare function
|
|
2556
|
-
type
|
|
2341
|
+
/** @returns {DomainsResponseSchema} */
|
|
2342
|
+
declare function DomainsResponseSchema(): DomainsResponseSchema;
|
|
2343
|
+
type DomainsResponseSchema = {
|
|
2557
2344
|
domains?: Domain[];
|
|
2558
2345
|
};
|
|
2559
2346
|
/** @returns {UpdateDomain} */
|
|
@@ -2564,8 +2351,7 @@ type UpdateDomain = {
|
|
|
2564
2351
|
*/
|
|
2565
2352
|
name?: string;
|
|
2566
2353
|
/**
|
|
2567
|
-
* - The unique identifier
|
|
2568
|
-
* of the domain
|
|
2354
|
+
* - The unique identifier of the domain
|
|
2569
2355
|
*/
|
|
2570
2356
|
_id?: string;
|
|
2571
2357
|
/**
|
|
@@ -2584,9 +2370,9 @@ type UpdateDomain = {
|
|
|
2584
2370
|
*/
|
|
2585
2371
|
is_shortlink?: boolean;
|
|
2586
2372
|
};
|
|
2587
|
-
/** @returns {
|
|
2588
|
-
declare function
|
|
2589
|
-
type
|
|
2373
|
+
/** @returns {UpdateDomainTypeRequestSchema} */
|
|
2374
|
+
declare function UpdateDomainTypeRequestSchema(): UpdateDomainTypeRequestSchema;
|
|
2375
|
+
type UpdateDomainTypeRequestSchema = {
|
|
2590
2376
|
domain?: UpdateDomain;
|
|
2591
2377
|
/**
|
|
2592
2378
|
* - Shows domain is made primary domain for the
|
|
@@ -2594,9 +2380,9 @@ type UpdateDomainTypeRequest = {
|
|
|
2594
2380
|
*/
|
|
2595
2381
|
action?: string;
|
|
2596
2382
|
};
|
|
2597
|
-
/** @returns {
|
|
2598
|
-
declare function
|
|
2599
|
-
type
|
|
2383
|
+
/** @returns {DomainStatusRequestSchema} */
|
|
2384
|
+
declare function DomainStatusRequestSchema(): DomainStatusRequestSchema;
|
|
2385
|
+
type DomainStatusRequestSchema = {
|
|
2600
2386
|
/**
|
|
2601
2387
|
* - URL of the domain, e.g. uniket.hostx0.de
|
|
2602
2388
|
*/
|
|
@@ -2615,9 +2401,9 @@ type DomainStatus = {
|
|
|
2615
2401
|
*/
|
|
2616
2402
|
status?: boolean;
|
|
2617
2403
|
};
|
|
2618
|
-
/** @returns {
|
|
2619
|
-
declare function
|
|
2620
|
-
type
|
|
2404
|
+
/** @returns {DomainStatusResponseSchema} */
|
|
2405
|
+
declare function DomainStatusResponseSchema(): DomainStatusResponseSchema;
|
|
2406
|
+
type DomainStatusResponseSchema = {
|
|
2621
2407
|
/**
|
|
2622
2408
|
* - Check if domain is live and mapped to
|
|
2623
2409
|
* appropriate IP of Fynd Servers
|
|
@@ -2625,13 +2411,18 @@ type DomainStatusResponse = {
|
|
|
2625
2411
|
connected?: boolean;
|
|
2626
2412
|
status?: DomainStatus[];
|
|
2627
2413
|
};
|
|
2628
|
-
/** @returns {
|
|
2629
|
-
declare function
|
|
2630
|
-
type
|
|
2414
|
+
/** @returns {DomainSuggestionsRequestSchema} */
|
|
2415
|
+
declare function DomainSuggestionsRequestSchema(): DomainSuggestionsRequestSchema;
|
|
2416
|
+
type DomainSuggestionsRequestSchema = {
|
|
2631
2417
|
/**
|
|
2632
2418
|
* - Domain url
|
|
2633
2419
|
*/
|
|
2634
2420
|
domain_url?: string;
|
|
2421
|
+
/**
|
|
2422
|
+
* - Get suggestions for custom domains or
|
|
2423
|
+
* Fynd domains
|
|
2424
|
+
*/
|
|
2425
|
+
custom_domain?: boolean;
|
|
2635
2426
|
};
|
|
2636
2427
|
/** @returns {DomainSuggestion} */
|
|
2637
2428
|
declare function DomainSuggestion(): DomainSuggestion;
|
|
@@ -2659,17 +2450,17 @@ type DomainSuggestion = {
|
|
|
2659
2450
|
*/
|
|
2660
2451
|
currency?: string;
|
|
2661
2452
|
};
|
|
2662
|
-
/** @returns {
|
|
2663
|
-
declare function
|
|
2664
|
-
type
|
|
2453
|
+
/** @returns {DomainSuggestionsResponseSchema} */
|
|
2454
|
+
declare function DomainSuggestionsResponseSchema(): DomainSuggestionsResponseSchema;
|
|
2455
|
+
type DomainSuggestionsResponseSchema = {
|
|
2665
2456
|
/**
|
|
2666
2457
|
* - Domain URL
|
|
2667
2458
|
*/
|
|
2668
2459
|
domains?: DomainSuggestion[];
|
|
2669
2460
|
};
|
|
2670
|
-
/** @returns {
|
|
2671
|
-
declare function
|
|
2672
|
-
type
|
|
2461
|
+
/** @returns {SuccessMessageResponseSchema} */
|
|
2462
|
+
declare function SuccessMessageResponseSchema(): SuccessMessageResponseSchema;
|
|
2463
|
+
type SuccessMessageResponseSchema = {
|
|
2673
2464
|
/**
|
|
2674
2465
|
* - Shows whether domain was deleted successfully
|
|
2675
2466
|
*/
|
|
@@ -2679,481 +2470,81 @@ type SuccessMessageResponse = {
|
|
|
2679
2470
|
*/
|
|
2680
2471
|
message?: string;
|
|
2681
2472
|
};
|
|
2682
|
-
/** @returns {
|
|
2683
|
-
declare function
|
|
2684
|
-
type
|
|
2685
|
-
items?: IntegrationOptIn[];
|
|
2686
|
-
page?: Page;
|
|
2687
|
-
};
|
|
2688
|
-
/** @returns {IntegrationOptIn} */
|
|
2689
|
-
declare function IntegrationOptIn(): IntegrationOptIn;
|
|
2690
|
-
type IntegrationOptIn = {
|
|
2691
|
-
validators?: Validators;
|
|
2692
|
-
/**
|
|
2693
|
-
* - Basic description about the opted integration
|
|
2694
|
-
*/
|
|
2695
|
-
description?: string;
|
|
2473
|
+
/** @returns {App} */
|
|
2474
|
+
declare function App(): App;
|
|
2475
|
+
type App = {
|
|
2696
2476
|
/**
|
|
2697
|
-
* -
|
|
2698
|
-
*
|
|
2477
|
+
* - Numeric ID allotted to a business account
|
|
2478
|
+
* on Fynd Platform.
|
|
2699
2479
|
*/
|
|
2700
|
-
|
|
2701
|
-
constants?: string;
|
|
2702
|
-
companies?: string[];
|
|
2703
|
-
support?: string[];
|
|
2480
|
+
company_id?: string;
|
|
2704
2481
|
/**
|
|
2705
|
-
* -
|
|
2706
|
-
*
|
|
2482
|
+
* - It indicates different channel types like
|
|
2483
|
+
* store, website-and-mobile-apps. Default value is store
|
|
2707
2484
|
*/
|
|
2708
|
-
|
|
2485
|
+
channel_type?: string;
|
|
2486
|
+
auth?: ApplicationAuth;
|
|
2709
2487
|
/**
|
|
2710
|
-
* -
|
|
2488
|
+
* - User-friendly name for sales channel, e.g. Zenz Fashion
|
|
2711
2489
|
*/
|
|
2712
2490
|
name?: string;
|
|
2713
2491
|
/**
|
|
2714
|
-
* -
|
|
2492
|
+
* - Detailed description about the sales channel
|
|
2715
2493
|
*/
|
|
2716
|
-
|
|
2717
|
-
|
|
2718
|
-
|
|
2494
|
+
desc?: string;
|
|
2495
|
+
};
|
|
2496
|
+
/** @returns {AppDomain} */
|
|
2497
|
+
declare function AppDomain(): AppDomain;
|
|
2498
|
+
type AppDomain = {
|
|
2719
2499
|
/**
|
|
2720
|
-
* -
|
|
2500
|
+
* - Domain URL of current sales channel, e.g. zenz.com
|
|
2721
2501
|
*/
|
|
2722
|
-
|
|
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 = {
|
|
2723
2513
|
/**
|
|
2724
|
-
* -
|
|
2725
|
-
* of the user who created the integration
|
|
2514
|
+
* - UID of the company, e.g. 108
|
|
2726
2515
|
*/
|
|
2727
|
-
|
|
2516
|
+
uid?: number;
|
|
2728
2517
|
/**
|
|
2729
|
-
* -
|
|
2518
|
+
* - Name of the company, e.g. Newton Traders
|
|
2730
2519
|
*/
|
|
2731
|
-
|
|
2520
|
+
name?: string;
|
|
2732
2521
|
/**
|
|
2733
|
-
* -
|
|
2522
|
+
* - Indicates the type of the company, e.g.
|
|
2523
|
+
* franchisee, distributor, etc.
|
|
2734
2524
|
*/
|
|
2735
|
-
|
|
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 = {
|
|
2736
2536
|
/**
|
|
2737
|
-
* -
|
|
2738
|
-
*
|
|
2537
|
+
* - The unique identifier of the store in the sales
|
|
2538
|
+
* channel inventory
|
|
2739
2539
|
*/
|
|
2740
|
-
|
|
2540
|
+
_id?: string;
|
|
2741
2541
|
/**
|
|
2742
|
-
* -
|
|
2743
|
-
*
|
|
2542
|
+
* - ISO 8601 timestamp of last known updation
|
|
2543
|
+
* to the stores in sales channel inventory
|
|
2744
2544
|
*/
|
|
2745
|
-
|
|
2545
|
+
modified_on?: string;
|
|
2746
2546
|
/**
|
|
2747
|
-
* -
|
|
2748
|
-
*/
|
|
2749
|
-
__v?: number;
|
|
2750
|
-
};
|
|
2751
|
-
/** @returns {Validators} */
|
|
2752
|
-
declare function Validators(): Validators;
|
|
2753
|
-
type Validators = {
|
|
2754
|
-
company?: CompanyValidator;
|
|
2755
|
-
store?: StoreValidator;
|
|
2756
|
-
inventory?: InventoryValidator;
|
|
2757
|
-
order?: OrderValidator;
|
|
2758
|
-
};
|
|
2759
|
-
/** @returns {CompanyValidator} */
|
|
2760
|
-
declare function CompanyValidator(): CompanyValidator;
|
|
2761
|
-
type CompanyValidator = {
|
|
2762
|
-
json_schema?: JsonSchema[];
|
|
2763
|
-
/**
|
|
2764
|
-
* - Browser script for the company validator
|
|
2765
|
-
*/
|
|
2766
|
-
browser_script?: string;
|
|
2767
|
-
};
|
|
2768
|
-
/** @returns {JsonSchema} */
|
|
2769
|
-
declare function JsonSchema(): JsonSchema;
|
|
2770
|
-
type JsonSchema = {
|
|
2771
|
-
/**
|
|
2772
|
-
* - Display text of the validator JSON schema. It
|
|
2773
|
-
* will show in the UI.
|
|
2774
|
-
*/
|
|
2775
|
-
display?: string;
|
|
2776
|
-
/**
|
|
2777
|
-
* - Key related to the display text of the validator JSON schema
|
|
2778
|
-
*/
|
|
2779
|
-
key?: string;
|
|
2780
|
-
/**
|
|
2781
|
-
* - Indicates the type of form field, e.g. Text, Dropdown.
|
|
2782
|
-
*/
|
|
2783
|
-
type?: string;
|
|
2784
|
-
/**
|
|
2785
|
-
* - Tooltip text for the UI of the validator JSON
|
|
2786
|
-
* schema. It will show in the UI.
|
|
2787
|
-
*/
|
|
2788
|
-
tooltip?: string;
|
|
2789
|
-
};
|
|
2790
|
-
/** @returns {StoreValidator} */
|
|
2791
|
-
declare function StoreValidator(): StoreValidator;
|
|
2792
|
-
type StoreValidator = {
|
|
2793
|
-
json_schema?: JsonSchema[];
|
|
2794
|
-
/**
|
|
2795
|
-
* - Browser script for the store validator
|
|
2796
|
-
*/
|
|
2797
|
-
browser_script?: string;
|
|
2798
|
-
};
|
|
2799
|
-
/** @returns {InventoryValidator} */
|
|
2800
|
-
declare function InventoryValidator(): InventoryValidator;
|
|
2801
|
-
type InventoryValidator = {
|
|
2802
|
-
json_schema?: JsonSchema[];
|
|
2803
|
-
/**
|
|
2804
|
-
* - Browser script for the inventory validator
|
|
2805
|
-
*/
|
|
2806
|
-
browser_script?: string;
|
|
2807
|
-
};
|
|
2808
|
-
/** @returns {OrderValidator} */
|
|
2809
|
-
declare function OrderValidator(): OrderValidator;
|
|
2810
|
-
type OrderValidator = {
|
|
2811
|
-
json_schema?: JsonSchema[];
|
|
2812
|
-
/**
|
|
2813
|
-
* - Browser script for the order validator
|
|
2814
|
-
*/
|
|
2815
|
-
browser_script?: string;
|
|
2816
|
-
};
|
|
2817
|
-
/** @returns {IntegrationMeta} */
|
|
2818
|
-
declare function IntegrationMeta(): IntegrationMeta;
|
|
2819
|
-
type IntegrationMeta = {
|
|
2820
|
-
is_public?: boolean;
|
|
2821
|
-
/**
|
|
2822
|
-
* - The unique identifier (24-digit Mongo Object ID)
|
|
2823
|
-
* of the integration meta
|
|
2824
|
-
*/
|
|
2825
|
-
_id?: string;
|
|
2826
|
-
/**
|
|
2827
|
-
* - Nmae of integration meta, e.g. price_level
|
|
2828
|
-
*/
|
|
2829
|
-
name?: string;
|
|
2830
|
-
/**
|
|
2831
|
-
* - Value related to integration meta name, e.g. store
|
|
2832
|
-
*/
|
|
2833
|
-
value?: string;
|
|
2834
|
-
};
|
|
2835
|
-
/** @returns {Integration} */
|
|
2836
|
-
declare function Integration(): Integration;
|
|
2837
|
-
type Integration = {
|
|
2838
|
-
validators?: Validators;
|
|
2839
|
-
/**
|
|
2840
|
-
* - Basic description about the integration
|
|
2841
|
-
*/
|
|
2842
|
-
description?: string;
|
|
2843
|
-
/**
|
|
2844
|
-
* - Basic HTML description about the integration
|
|
2845
|
-
*/
|
|
2846
|
-
description_html?: string;
|
|
2847
|
-
constants?: any;
|
|
2848
|
-
companies?: string[];
|
|
2849
|
-
support?: string[];
|
|
2850
|
-
/**
|
|
2851
|
-
* - The unique identifier (24-digit Mongo Object ID)
|
|
2852
|
-
* of the integration
|
|
2853
|
-
*/
|
|
2854
|
-
_id?: string;
|
|
2855
|
-
/**
|
|
2856
|
-
* - Name of the integration, e.g. SAP RBL Integration
|
|
2857
|
-
*/
|
|
2858
|
-
name?: string;
|
|
2859
|
-
/**
|
|
2860
|
-
* - Name of the integration, e.g. SAP RBL Integration
|
|
2861
|
-
*/
|
|
2862
|
-
slug?: string;
|
|
2863
|
-
meta?: IntegrationMeta[];
|
|
2864
|
-
/**
|
|
2865
|
-
* - Hosted URL of the icon image
|
|
2866
|
-
*/
|
|
2867
|
-
icon?: string;
|
|
2868
|
-
hidden?: boolean;
|
|
2869
|
-
/**
|
|
2870
|
-
* - The unique identifier (24-digit Mongo Object ID)
|
|
2871
|
-
* of the user who created the integration
|
|
2872
|
-
*/
|
|
2873
|
-
owner?: string;
|
|
2874
|
-
/**
|
|
2875
|
-
* - ISO 8601 timestamp of integration creation
|
|
2876
|
-
*/
|
|
2877
|
-
created_at?: string;
|
|
2878
|
-
/**
|
|
2879
|
-
* - ISO 8601 timestamp of integration updation
|
|
2880
|
-
*/
|
|
2881
|
-
modified_at?: string;
|
|
2882
|
-
/**
|
|
2883
|
-
* - Randomly generated fixed-length string for opted
|
|
2884
|
-
* integration. It is auto-generated. It would never change once it is generated.
|
|
2885
|
-
*/
|
|
2886
|
-
token?: string;
|
|
2887
|
-
/**
|
|
2888
|
-
* - Randomly generated fixed-length string for
|
|
2889
|
-
* opted integration. It is auto-generated. It would never change once it is generated.
|
|
2890
|
-
*/
|
|
2891
|
-
secret?: string;
|
|
2892
|
-
/**
|
|
2893
|
-
* - Version key for tracking revisions. Default value is zero.
|
|
2894
|
-
*/
|
|
2895
|
-
__v?: number;
|
|
2896
|
-
};
|
|
2897
|
-
/** @returns {IntegrationConfigResponse} */
|
|
2898
|
-
declare function IntegrationConfigResponse(): IntegrationConfigResponse;
|
|
2899
|
-
type IntegrationConfigResponse = {
|
|
2900
|
-
items?: IntegrationLevel[];
|
|
2901
|
-
};
|
|
2902
|
-
/** @returns {IntegrationLevel} */
|
|
2903
|
-
declare function IntegrationLevel(): IntegrationLevel;
|
|
2904
|
-
type IntegrationLevel = {
|
|
2905
|
-
/**
|
|
2906
|
-
* - Shows this integration is opted or not opted
|
|
2907
|
-
* for the current company
|
|
2908
|
-
*/
|
|
2909
|
-
opted?: boolean;
|
|
2910
|
-
permissions?: any[];
|
|
2911
|
-
last_patch?: LastPatch[];
|
|
2912
|
-
/**
|
|
2913
|
-
* - The unique identifier (24-digit Mongo Object ID)
|
|
2914
|
-
* of the integration config
|
|
2915
|
-
*/
|
|
2916
|
-
_id?: string;
|
|
2917
|
-
/**
|
|
2918
|
-
* - Integration id. Shows which integration
|
|
2919
|
-
* you are enabling.
|
|
2920
|
-
*/
|
|
2921
|
-
integration?: string;
|
|
2922
|
-
/**
|
|
2923
|
-
* - Shows for what level the integration is set up.
|
|
2924
|
-
* It can be company level or store level.
|
|
2925
|
-
*/
|
|
2926
|
-
level?: string;
|
|
2927
|
-
/**
|
|
2928
|
-
* - It can be store uid or company uid. Depends on the
|
|
2929
|
-
* level of integration.
|
|
2930
|
-
*/
|
|
2931
|
-
uid?: number;
|
|
2932
|
-
/**
|
|
2933
|
-
* - Unique id of company.
|
|
2934
|
-
*/
|
|
2935
|
-
company_id?: number;
|
|
2936
|
-
meta?: IntegrationMeta[];
|
|
2937
|
-
/**
|
|
2938
|
-
* - Randomly generated fixed-length string for opted
|
|
2939
|
-
* integration. It is auto-generated. It would never change once it is generated.
|
|
2940
|
-
*/
|
|
2941
|
-
token?: string;
|
|
2942
|
-
/**
|
|
2943
|
-
* - ISO 8601 timestamp of integration config creation
|
|
2944
|
-
*/
|
|
2945
|
-
created_at?: string;
|
|
2946
|
-
/**
|
|
2947
|
-
* - ISO 8601 timestamp of integration config updation
|
|
2948
|
-
*/
|
|
2949
|
-
modified_at?: string;
|
|
2950
|
-
/**
|
|
2951
|
-
* - Version key for tracking revisions. Default value is zero.
|
|
2952
|
-
*/
|
|
2953
|
-
__v?: number;
|
|
2954
|
-
/**
|
|
2955
|
-
* - Schema data of the integration stored in key-value pairs
|
|
2956
|
-
*/
|
|
2957
|
-
data?: any;
|
|
2958
|
-
success?: boolean;
|
|
2959
|
-
message?: string;
|
|
2960
|
-
};
|
|
2961
|
-
/** @returns {UpdateIntegrationLevelRequest} */
|
|
2962
|
-
declare function UpdateIntegrationLevelRequest(): UpdateIntegrationLevelRequest;
|
|
2963
|
-
type UpdateIntegrationLevelRequest = {
|
|
2964
|
-
items?: IntegrationLevel[];
|
|
2965
|
-
};
|
|
2966
|
-
/** @returns {OptedStoreIntegration} */
|
|
2967
|
-
declare function OptedStoreIntegration(): OptedStoreIntegration;
|
|
2968
|
-
type OptedStoreIntegration = {
|
|
2969
|
-
/**
|
|
2970
|
-
* - Allow user to opt same store in other integration
|
|
2971
|
-
*/
|
|
2972
|
-
other_opted?: boolean;
|
|
2973
|
-
other_integration?: IntegrationOptIn;
|
|
2974
|
-
other_entity?: OtherEntity;
|
|
2975
|
-
};
|
|
2976
|
-
/** @returns {OtherEntity} */
|
|
2977
|
-
declare function OtherEntity(): OtherEntity;
|
|
2978
|
-
type OtherEntity = {
|
|
2979
|
-
/**
|
|
2980
|
-
* - Allow other entity opted in integration
|
|
2981
|
-
*/
|
|
2982
|
-
opted?: boolean;
|
|
2983
|
-
permissions?: string[];
|
|
2984
|
-
last_patch?: LastPatch[];
|
|
2985
|
-
/**
|
|
2986
|
-
* - The unique identifier of the other entity for
|
|
2987
|
-
* opted store integration
|
|
2988
|
-
*/
|
|
2989
|
-
_id?: string;
|
|
2990
|
-
/**
|
|
2991
|
-
* - Integration ID. Shows which integration
|
|
2992
|
-
* you are enabling.
|
|
2993
|
-
*/
|
|
2994
|
-
integration?: string;
|
|
2995
|
-
/**
|
|
2996
|
-
* - Indicates integration level. It can be company
|
|
2997
|
-
* level or store level.
|
|
2998
|
-
*/
|
|
2999
|
-
level?: string;
|
|
3000
|
-
/**
|
|
3001
|
-
* - It can be store uid or company uid. Depends on the
|
|
3002
|
-
* level of integration.
|
|
3003
|
-
*/
|
|
3004
|
-
uid?: number;
|
|
3005
|
-
data?: OtherEntityData;
|
|
3006
|
-
meta?: any[];
|
|
3007
|
-
/**
|
|
3008
|
-
* - Randomly generated fixed-length string for opted
|
|
3009
|
-
* integration. It is auto-generated. It would never change once it is generated.
|
|
3010
|
-
*/
|
|
3011
|
-
token?: string;
|
|
3012
|
-
/**
|
|
3013
|
-
* - ISO 8601 timestamp of other entity creation
|
|
3014
|
-
* for opted store integration
|
|
3015
|
-
*/
|
|
3016
|
-
created_at?: string;
|
|
3017
|
-
/**
|
|
3018
|
-
* - ISO 8601 timestamp of other entity
|
|
3019
|
-
* updation for opted store integration
|
|
3020
|
-
*/
|
|
3021
|
-
modified_at?: string;
|
|
3022
|
-
/**
|
|
3023
|
-
* - Version key for tracking revisions. Default value is zero.
|
|
3024
|
-
*/
|
|
3025
|
-
__v?: number;
|
|
3026
|
-
};
|
|
3027
|
-
/** @returns {LastPatch} */
|
|
3028
|
-
declare function LastPatch(): LastPatch;
|
|
3029
|
-
type LastPatch = {
|
|
3030
|
-
op?: string;
|
|
3031
|
-
path?: string;
|
|
3032
|
-
/**
|
|
3033
|
-
* - It can be inventory level or order level
|
|
3034
|
-
*/
|
|
3035
|
-
value?: string;
|
|
3036
|
-
};
|
|
3037
|
-
/** @returns {OtherEntityData} */
|
|
3038
|
-
declare function OtherEntityData(): OtherEntityData;
|
|
3039
|
-
type OtherEntityData = {
|
|
3040
|
-
article_identifier?: string;
|
|
3041
|
-
};
|
|
3042
|
-
/** @returns {App} */
|
|
3043
|
-
declare function App(): App;
|
|
3044
|
-
type App = {
|
|
3045
|
-
/**
|
|
3046
|
-
* - Numeric ID allotted to a business account
|
|
3047
|
-
* on Fynd Platform.
|
|
3048
|
-
*/
|
|
3049
|
-
company_id?: string;
|
|
3050
|
-
/**
|
|
3051
|
-
* - It indicates different channel types like
|
|
3052
|
-
* store, website-and-mobile-apps. Default value is store
|
|
3053
|
-
*/
|
|
3054
|
-
channel_type?: string;
|
|
3055
|
-
auth?: ApplicationAuth;
|
|
3056
|
-
/**
|
|
3057
|
-
* - User-friendly name for sales channel, e.g. Zenz Fashion
|
|
3058
|
-
*/
|
|
3059
|
-
name?: string;
|
|
3060
|
-
/**
|
|
3061
|
-
* - Detailed description about the sales channel
|
|
3062
|
-
*/
|
|
3063
|
-
desc?: string;
|
|
3064
|
-
};
|
|
3065
|
-
/** @returns {InventoryConfig} */
|
|
3066
|
-
declare function InventoryConfig(): InventoryConfig;
|
|
3067
|
-
type InventoryConfig = {
|
|
3068
|
-
brand?: InventoryBrandRule;
|
|
3069
|
-
store?: InventoryStoreRule;
|
|
3070
|
-
image?: string[];
|
|
3071
|
-
/**
|
|
3072
|
-
* - Allow other businesses (companies)
|
|
3073
|
-
* to consume the current sales channel's inventory and sell products
|
|
3074
|
-
*/
|
|
3075
|
-
franchise_enabled?: boolean;
|
|
3076
|
-
/**
|
|
3077
|
-
* - Indicates whether out of stock products
|
|
3078
|
-
* are allowed to show up on the website.
|
|
3079
|
-
*/
|
|
3080
|
-
out_of_stock?: boolean;
|
|
3081
|
-
/**
|
|
3082
|
-
* - Show only verified products
|
|
3083
|
-
* (the ones whose data have been verified by the admin)
|
|
3084
|
-
*/
|
|
3085
|
-
only_verified_products?: boolean;
|
|
3086
|
-
pricing_strategy?: PricingStrategy;
|
|
3087
|
-
};
|
|
3088
|
-
/** @returns {AppInventory} */
|
|
3089
|
-
declare function AppInventory(): AppInventory;
|
|
3090
|
-
type AppInventory = {
|
|
3091
|
-
inventory?: InventoryConfig;
|
|
3092
|
-
payment?: InventoryPaymentConfig;
|
|
3093
|
-
article_assignment?: InventoryArticleAssignment;
|
|
3094
|
-
};
|
|
3095
|
-
/** @returns {AppDomain} */
|
|
3096
|
-
declare function AppDomain(): AppDomain;
|
|
3097
|
-
type AppDomain = {
|
|
3098
|
-
/**
|
|
3099
|
-
* - Domain URL of current sales channel, e.g. zenz.com
|
|
3100
|
-
*/
|
|
3101
|
-
name?: string;
|
|
3102
|
-
};
|
|
3103
|
-
/** @returns {CompaniesResponse} */
|
|
3104
|
-
declare function CompaniesResponse(): CompaniesResponse;
|
|
3105
|
-
type CompaniesResponse = {
|
|
3106
|
-
items?: AppInventoryCompanies[];
|
|
3107
|
-
page?: Page;
|
|
3108
|
-
};
|
|
3109
|
-
/** @returns {AppInventoryCompanies} */
|
|
3110
|
-
declare function AppInventoryCompanies(): AppInventoryCompanies;
|
|
3111
|
-
type AppInventoryCompanies = {
|
|
3112
|
-
/**
|
|
3113
|
-
* - UID of the company, e.g. 108
|
|
3114
|
-
*/
|
|
3115
|
-
uid?: number;
|
|
3116
|
-
/**
|
|
3117
|
-
* - Name of the company, e.g. Newton Traders
|
|
3118
|
-
*/
|
|
3119
|
-
name?: string;
|
|
3120
|
-
/**
|
|
3121
|
-
* - Indicates the type of the company, e.g.
|
|
3122
|
-
* franchisee, distributor, etc.
|
|
3123
|
-
*/
|
|
3124
|
-
company_type?: string;
|
|
3125
|
-
};
|
|
3126
|
-
/** @returns {StoresResponse} */
|
|
3127
|
-
declare function StoresResponse(): StoresResponse;
|
|
3128
|
-
type StoresResponse = {
|
|
3129
|
-
items?: AppInventoryStores[];
|
|
3130
|
-
page?: Page;
|
|
3131
|
-
};
|
|
3132
|
-
/** @returns {ListStoreResponse} */
|
|
3133
|
-
declare function ListStoreResponse(): ListStoreResponse;
|
|
3134
|
-
type ListStoreResponse = {
|
|
3135
|
-
stores?: AppInventoryStores[];
|
|
3136
|
-
};
|
|
3137
|
-
/** @returns {ArrayStoreResponse} */
|
|
3138
|
-
declare function ArrayStoreResponse(): ArrayStoreResponse;
|
|
3139
|
-
type ArrayStoreResponse = {
|
|
3140
|
-
data?: AppInventoryStores[];
|
|
3141
|
-
};
|
|
3142
|
-
/** @returns {AppInventoryStores} */
|
|
3143
|
-
declare function AppInventoryStores(): AppInventoryStores;
|
|
3144
|
-
type AppInventoryStores = {
|
|
3145
|
-
/**
|
|
3146
|
-
* - The unique identifier of the store (24-digit Mongo
|
|
3147
|
-
* Object ID) in the sales channel inventory
|
|
3148
|
-
*/
|
|
3149
|
-
_id?: string;
|
|
3150
|
-
/**
|
|
3151
|
-
* - ISO 8601 timestamp of last known updation
|
|
3152
|
-
* to the stores in sales channel inventory
|
|
3153
|
-
*/
|
|
3154
|
-
modified_on?: string;
|
|
3155
|
-
/**
|
|
3156
|
-
* - Sales channel inventory store UID
|
|
2547
|
+
* - Sales channel inventory store UID
|
|
3157
2548
|
*/
|
|
3158
2549
|
uid?: number;
|
|
3159
2550
|
/**
|
|
@@ -3184,9 +2575,9 @@ type AppInventoryStores = {
|
|
|
3184
2575
|
address?: any;
|
|
3185
2576
|
integration_type?: any;
|
|
3186
2577
|
};
|
|
3187
|
-
/** @returns {
|
|
3188
|
-
declare function
|
|
3189
|
-
type
|
|
2578
|
+
/** @returns {FilterOrderingStoreRequestSchema} */
|
|
2579
|
+
declare function FilterOrderingStoreRequestSchema(): FilterOrderingStoreRequestSchema;
|
|
2580
|
+
type FilterOrderingStoreRequestSchema = {
|
|
3190
2581
|
/**
|
|
3191
2582
|
* - Allow all stores from the ordering stores
|
|
3192
2583
|
*/
|
|
@@ -3216,8 +2607,7 @@ type DeploymentMeta = {
|
|
|
3216
2607
|
*/
|
|
3217
2608
|
type?: string;
|
|
3218
2609
|
/**
|
|
3219
|
-
* - The unique identifier
|
|
3220
|
-
* of the ordering stores
|
|
2610
|
+
* - The unique identifier of the ordering stores
|
|
3221
2611
|
*/
|
|
3222
2612
|
_id?: string;
|
|
3223
2613
|
/**
|
|
@@ -3232,9 +2622,9 @@ declare function OrderingStoreConfig(): OrderingStoreConfig;
|
|
|
3232
2622
|
type OrderingStoreConfig = {
|
|
3233
2623
|
deployment_meta?: DeploymentMeta;
|
|
3234
2624
|
};
|
|
3235
|
-
/** @returns {
|
|
3236
|
-
declare function
|
|
3237
|
-
type
|
|
2625
|
+
/** @returns {OrderingStoreSelectRequestSchema} */
|
|
2626
|
+
declare function OrderingStoreSelectRequestSchema(): OrderingStoreSelectRequestSchema;
|
|
2627
|
+
type OrderingStoreSelectRequestSchema = {
|
|
3238
2628
|
ordering_store: OrderingStoreSelect;
|
|
3239
2629
|
};
|
|
3240
2630
|
/** @returns {OrderingStoreSelect} */
|
|
@@ -3269,8 +2659,7 @@ type OtherSellerApplication = {
|
|
|
3269
2659
|
*/
|
|
3270
2660
|
description?: string;
|
|
3271
2661
|
/**
|
|
3272
|
-
* - The unique identifier
|
|
3273
|
-
* of the other seller's sales channel
|
|
2662
|
+
* - The unique identifier of the other seller's sales channel
|
|
3274
2663
|
*/
|
|
3275
2664
|
_id?: string;
|
|
3276
2665
|
/**
|
|
@@ -3290,9 +2679,9 @@ type OtherSellerApplications = {
|
|
|
3290
2679
|
items?: OtherSellerApplication[];
|
|
3291
2680
|
page?: Page;
|
|
3292
2681
|
};
|
|
3293
|
-
/** @returns {
|
|
3294
|
-
declare function
|
|
3295
|
-
type
|
|
2682
|
+
/** @returns {OptedApplicationResponseSchema} */
|
|
2683
|
+
declare function OptedApplicationResponseSchema(): OptedApplicationResponseSchema;
|
|
2684
|
+
type OptedApplicationResponseSchema = {
|
|
3296
2685
|
/**
|
|
3297
2686
|
* - Name of the other seller's sales channel
|
|
3298
2687
|
*/
|
|
@@ -3302,8 +2691,7 @@ type OptedApplicationResponse = {
|
|
|
3302
2691
|
*/
|
|
3303
2692
|
description?: string;
|
|
3304
2693
|
/**
|
|
3305
|
-
* - The unique identifier
|
|
3306
|
-
* of the other seller's sales channel
|
|
2694
|
+
* - The unique identifier of the other seller's sales channel
|
|
3307
2695
|
*/
|
|
3308
2696
|
_id?: string;
|
|
3309
2697
|
/**
|
|
@@ -3404,13 +2792,12 @@ type OptOutInventory = {
|
|
|
3404
2792
|
*/
|
|
3405
2793
|
company: number[];
|
|
3406
2794
|
};
|
|
3407
|
-
/** @returns {
|
|
3408
|
-
declare function
|
|
3409
|
-
type
|
|
2795
|
+
/** @returns {TokenResponseSchema} */
|
|
2796
|
+
declare function TokenResponseSchema(): TokenResponseSchema;
|
|
2797
|
+
type TokenResponseSchema = {
|
|
3410
2798
|
tokens?: Tokens;
|
|
3411
2799
|
/**
|
|
3412
|
-
* - The unique identifier
|
|
3413
|
-
* of the token
|
|
2800
|
+
* - The unique identifier of the token
|
|
3414
2801
|
*/
|
|
3415
2802
|
_id?: string;
|
|
3416
2803
|
/**
|
|
@@ -3631,6 +3018,10 @@ type FyndRewardsCredentials = {
|
|
|
3631
3018
|
/** @returns {GoogleMap} */
|
|
3632
3019
|
declare function GoogleMap(): GoogleMap;
|
|
3633
3020
|
type GoogleMap = {
|
|
3021
|
+
/**
|
|
3022
|
+
* - Shows whether Google map integration is enabled or not.
|
|
3023
|
+
*/
|
|
3024
|
+
enabled?: boolean;
|
|
3634
3025
|
credentials?: GoogleMapCredentials;
|
|
3635
3026
|
};
|
|
3636
3027
|
/** @returns {GoogleMapCredentials} */
|
|
@@ -3751,6 +3142,34 @@ type RegistrationPageFeature = {
|
|
|
3751
3142
|
*/
|
|
3752
3143
|
ask_store_address?: boolean;
|
|
3753
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
|
+
};
|
|
3754
3173
|
/** @returns {AppFeature} */
|
|
3755
3174
|
declare function AppFeature(): AppFeature;
|
|
3756
3175
|
type AppFeature = {
|
|
@@ -3764,9 +3183,9 @@ type AppFeature = {
|
|
|
3764
3183
|
pcr?: PcrFeature;
|
|
3765
3184
|
order?: OrderFeature;
|
|
3766
3185
|
buybox?: BuyboxFeature;
|
|
3186
|
+
delivery_strategy?: DeliveryStrategy;
|
|
3767
3187
|
/**
|
|
3768
|
-
* - The unique identifier
|
|
3769
|
-
* for the sales channel features
|
|
3188
|
+
* - The unique identifier for the sales channel features
|
|
3770
3189
|
*/
|
|
3771
3190
|
_id?: string;
|
|
3772
3191
|
/**
|
|
@@ -3787,7 +3206,6 @@ type AppFeature = {
|
|
|
3787
3206
|
* - Version key for tracking revisions. Default value is zero
|
|
3788
3207
|
*/
|
|
3789
3208
|
__v?: number;
|
|
3790
|
-
pricing_strategy?: PricingStrategy;
|
|
3791
3209
|
};
|
|
3792
3210
|
/** @returns {HomePageFeature} */
|
|
3793
3211
|
declare function HomePageFeature(): HomePageFeature;
|
|
@@ -3966,42 +3384,22 @@ type OrderFeature = {
|
|
|
3966
3384
|
*/
|
|
3967
3385
|
buy_again?: boolean;
|
|
3968
3386
|
};
|
|
3969
|
-
/** @returns {
|
|
3970
|
-
declare function
|
|
3971
|
-
type
|
|
3972
|
-
/**
|
|
3973
|
-
* - Allow users to see seller/stores name on
|
|
3974
|
-
* PDP (product detail page).
|
|
3975
|
-
*/
|
|
3976
|
-
show_name?: boolean;
|
|
3977
|
-
/**
|
|
3978
|
-
* - Allow selection of sellers/stores on
|
|
3979
|
-
* PDP (product detail page).
|
|
3980
|
-
*/
|
|
3981
|
-
enable_selection?: boolean;
|
|
3982
|
-
/**
|
|
3983
|
-
* - Toggle buybox listing
|
|
3984
|
-
* between sellers and stores. True indicates seller listing, while False
|
|
3985
|
-
* indicates store listing.
|
|
3986
|
-
*/
|
|
3987
|
-
is_seller_buybox_enabled?: boolean;
|
|
3988
|
-
};
|
|
3989
|
-
/** @returns {AppFeatureRequest} */
|
|
3990
|
-
declare function AppFeatureRequest(): AppFeatureRequest;
|
|
3991
|
-
type AppFeatureRequest = {
|
|
3387
|
+
/** @returns {AppFeatureRequestSchema} */
|
|
3388
|
+
declare function AppFeatureRequestSchema(): AppFeatureRequestSchema;
|
|
3389
|
+
type AppFeatureRequestSchema = {
|
|
3992
3390
|
feature?: AppFeature;
|
|
3993
3391
|
};
|
|
3994
|
-
/** @returns {
|
|
3995
|
-
declare function
|
|
3996
|
-
type
|
|
3392
|
+
/** @returns {AppFeatureResponseSchema} */
|
|
3393
|
+
declare function AppFeatureResponseSchema(): AppFeatureResponseSchema;
|
|
3394
|
+
type AppFeatureResponseSchema = {
|
|
3997
3395
|
feature?: AppFeature;
|
|
3998
3396
|
};
|
|
3999
3397
|
/** @returns {Currency} */
|
|
4000
3398
|
declare function Currency(): Currency;
|
|
4001
3399
|
type Currency = {
|
|
4002
3400
|
/**
|
|
4003
|
-
* - The unique identifier
|
|
4004
|
-
*
|
|
3401
|
+
* - The unique identifier of the current sales channel
|
|
3402
|
+
* supported currency
|
|
4005
3403
|
*/
|
|
4006
3404
|
_id?: string;
|
|
4007
3405
|
/**
|
|
@@ -4136,8 +3534,7 @@ type Application = {
|
|
|
4136
3534
|
*/
|
|
4137
3535
|
is_active?: boolean;
|
|
4138
3536
|
/**
|
|
4139
|
-
* - The unique identifier
|
|
4140
|
-
* of the sales channel
|
|
3537
|
+
* - The unique identifier of the sales channel
|
|
4141
3538
|
*/
|
|
4142
3539
|
_id?: string;
|
|
4143
3540
|
/**
|
|
@@ -4145,8 +3542,7 @@ type Application = {
|
|
|
4145
3542
|
*/
|
|
4146
3543
|
name?: string;
|
|
4147
3544
|
/**
|
|
4148
|
-
* - The unique identifier
|
|
4149
|
-
* of owner who owns the application
|
|
3545
|
+
* - The unique identifier of owner who owns the application
|
|
4150
3546
|
*/
|
|
4151
3547
|
owner?: string;
|
|
4152
3548
|
/**
|
|
@@ -4189,117 +3585,119 @@ type Application = {
|
|
|
4189
3585
|
tokens?: TokenSchema[];
|
|
4190
3586
|
secret?: string;
|
|
4191
3587
|
};
|
|
4192
|
-
/** @returns {
|
|
4193
|
-
declare function
|
|
4194
|
-
type
|
|
4195
|
-
|
|
4196
|
-
|
|
3588
|
+
/** @returns {ApplicationById} */
|
|
3589
|
+
declare function ApplicationById(): ApplicationById;
|
|
3590
|
+
type ApplicationById = {
|
|
3591
|
+
website?: ApplicationWebsite;
|
|
3592
|
+
cors?: ApplicationCors;
|
|
3593
|
+
auth?: ApplicationAuth;
|
|
4197
3594
|
/**
|
|
4198
|
-
* -
|
|
3595
|
+
* - It contains detailed information about the
|
|
3596
|
+
* sales channel.
|
|
4199
3597
|
*/
|
|
4200
|
-
|
|
4201
|
-
};
|
|
4202
|
-
/** @returns {InvalidPayloadRequest} */
|
|
4203
|
-
declare function InvalidPayloadRequest(): InvalidPayloadRequest;
|
|
4204
|
-
type InvalidPayloadRequest = {
|
|
3598
|
+
description?: string;
|
|
4205
3599
|
/**
|
|
4206
|
-
* -
|
|
3600
|
+
* - It indicates different types of channels,
|
|
3601
|
+
* such as store, website, and mobile apps, with 'store' being the default value.
|
|
4207
3602
|
*/
|
|
4208
|
-
|
|
3603
|
+
channel_type?: string;
|
|
4209
3604
|
/**
|
|
4210
|
-
* -
|
|
3605
|
+
* - An integer value that specifies the number
|
|
3606
|
+
* of seconds until the key expires
|
|
4211
3607
|
*/
|
|
4212
|
-
|
|
3608
|
+
cache_ttl?: number;
|
|
4213
3609
|
/**
|
|
4214
|
-
* -
|
|
3610
|
+
* - Indicates whether a sales channel is
|
|
3611
|
+
* internal or not
|
|
4215
3612
|
*/
|
|
4216
|
-
|
|
4217
|
-
};
|
|
4218
|
-
/** @returns {InventoryBrandRule} */
|
|
4219
|
-
declare function InventoryBrandRule(): InventoryBrandRule;
|
|
4220
|
-
type InventoryBrandRule = {
|
|
3613
|
+
is_internal?: boolean;
|
|
4221
3614
|
/**
|
|
4222
|
-
* -
|
|
4223
|
-
* few brands in the inventory
|
|
3615
|
+
* - Indicates sales channel is active or not active
|
|
4224
3616
|
*/
|
|
4225
|
-
|
|
4226
|
-
brands?: number[];
|
|
4227
|
-
};
|
|
4228
|
-
/** @returns {PricingStrategy} */
|
|
4229
|
-
declare function PricingStrategy(): PricingStrategy;
|
|
4230
|
-
type PricingStrategy = {
|
|
3617
|
+
is_active?: boolean;
|
|
4231
3618
|
/**
|
|
4232
|
-
* -
|
|
3619
|
+
* - The unique identifier of the sales channel
|
|
4233
3620
|
*/
|
|
4234
|
-
|
|
4235
|
-
};
|
|
4236
|
-
/** @returns {StoreCriteriaRule} */
|
|
4237
|
-
declare function StoreCriteriaRule(): StoreCriteriaRule;
|
|
4238
|
-
type StoreCriteriaRule = {
|
|
3621
|
+
_id?: string;
|
|
4239
3622
|
/**
|
|
4240
|
-
* -
|
|
3623
|
+
* - Name of the sales channel, e.g. Zenz Fashion
|
|
4241
3624
|
*/
|
|
4242
|
-
|
|
3625
|
+
name?: string;
|
|
4243
3626
|
/**
|
|
4244
|
-
* -
|
|
3627
|
+
* - The unique identifier of owner who owns the application
|
|
4245
3628
|
*/
|
|
4246
|
-
|
|
4247
|
-
};
|
|
4248
|
-
/** @returns {InventoryStoreRule} */
|
|
4249
|
-
declare function InventoryStoreRule(): InventoryStoreRule;
|
|
4250
|
-
type InventoryStoreRule = {
|
|
3629
|
+
owner?: string;
|
|
4251
3630
|
/**
|
|
4252
|
-
* -
|
|
4253
|
-
*
|
|
3631
|
+
* - Numeric ID allotted to a business account
|
|
3632
|
+
* where the sales channel exists
|
|
4254
3633
|
*/
|
|
4255
|
-
|
|
3634
|
+
company_id?: number;
|
|
4256
3635
|
/**
|
|
4257
|
-
* -
|
|
4258
|
-
*
|
|
3636
|
+
* - Random generated fix length string for sales
|
|
3637
|
+
* channel. It is required and auto-generated.
|
|
4259
3638
|
*/
|
|
4260
|
-
|
|
3639
|
+
token?: string;
|
|
3640
|
+
redirections?: ApplicationRedirections[];
|
|
3641
|
+
meta?: ApplicationMeta[];
|
|
4261
3642
|
/**
|
|
4262
|
-
* -
|
|
3643
|
+
* - ISO 8601 timestamp of sales channel creation
|
|
4263
3644
|
*/
|
|
4264
|
-
|
|
4265
|
-
};
|
|
4266
|
-
/** @returns {InventoryPaymentConfig} */
|
|
4267
|
-
declare function InventoryPaymentConfig(): InventoryPaymentConfig;
|
|
4268
|
-
type InventoryPaymentConfig = {
|
|
3645
|
+
created_at?: string;
|
|
4269
3646
|
/**
|
|
4270
|
-
* -
|
|
4271
|
-
* sales channel. It is required and default value is null.
|
|
3647
|
+
* - ISO 8601 timestamp of sales channel updation
|
|
4272
3648
|
*/
|
|
4273
|
-
|
|
3649
|
+
modified_at?: string;
|
|
4274
3650
|
/**
|
|
4275
|
-
* -
|
|
4276
|
-
* payment of sales channel. Default value is FYND.
|
|
3651
|
+
* - Version key for tracking revisions. Default value is zero.
|
|
4277
3652
|
*/
|
|
4278
|
-
|
|
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;
|
|
4279
3669
|
};
|
|
4280
|
-
/** @returns {
|
|
4281
|
-
declare function
|
|
4282
|
-
type
|
|
3670
|
+
/** @returns {TokenSchemaID} */
|
|
3671
|
+
declare function TokenSchemaID(): TokenSchemaID;
|
|
3672
|
+
type TokenSchemaID = {
|
|
3673
|
+
token?: string;
|
|
3674
|
+
created_by?: string;
|
|
4283
3675
|
/**
|
|
4284
|
-
* -
|
|
4285
|
-
* enabled for the article assignment.
|
|
3676
|
+
* - ISO 8601 timestamp of when token created
|
|
4286
3677
|
*/
|
|
4287
|
-
|
|
4288
|
-
storetype_order?: string[];
|
|
3678
|
+
created_at?: string;
|
|
4289
3679
|
};
|
|
4290
|
-
/** @returns {
|
|
4291
|
-
declare function
|
|
4292
|
-
type
|
|
4293
|
-
|
|
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;
|
|
4294
3689
|
};
|
|
4295
|
-
/** @returns {
|
|
4296
|
-
declare function
|
|
4297
|
-
type
|
|
3690
|
+
/** @returns {InvalidPayloadRequestSchema} */
|
|
3691
|
+
declare function InvalidPayloadRequestSchema(): InvalidPayloadRequestSchema;
|
|
3692
|
+
type InvalidPayloadRequestSchema = {
|
|
4298
3693
|
/**
|
|
4299
|
-
* -
|
|
3694
|
+
* - Error message when request body payload is improper
|
|
4300
3695
|
*/
|
|
4301
|
-
|
|
4302
|
-
|
|
3696
|
+
message?: string;
|
|
3697
|
+
/**
|
|
3698
|
+
* - Flag for required not successfull.
|
|
3699
|
+
*/
|
|
3700
|
+
success?: boolean;
|
|
4303
3701
|
};
|
|
4304
3702
|
/** @returns {Page} */
|
|
4305
3703
|
declare function Page(): Page;
|
|
@@ -4333,9 +3731,9 @@ type Page = {
|
|
|
4333
3731
|
*/
|
|
4334
3732
|
size?: number;
|
|
4335
3733
|
/**
|
|
4336
|
-
* -
|
|
3734
|
+
* - The number of items per page.
|
|
4337
3735
|
*/
|
|
4338
|
-
|
|
3736
|
+
page_size?: number;
|
|
4339
3737
|
};
|
|
4340
3738
|
/** @returns {ApplicationInformation} */
|
|
4341
3739
|
declare function ApplicationInformation(): ApplicationInformation;
|
|
@@ -4350,8 +3748,7 @@ type ApplicationInformation = {
|
|
|
4350
3748
|
*/
|
|
4351
3749
|
copyright_text?: string;
|
|
4352
3750
|
/**
|
|
4353
|
-
* - Unique identifier
|
|
4354
|
-
* the application information
|
|
3751
|
+
* - Unique identifier of the application information
|
|
4355
3752
|
*/
|
|
4356
3753
|
_id?: string;
|
|
4357
3754
|
business_highlights?: BusinessHighlights[];
|
|
@@ -4626,8 +4023,7 @@ type Links = {
|
|
|
4626
4023
|
declare function BusinessHighlights(): BusinessHighlights;
|
|
4627
4024
|
type BusinessHighlights = {
|
|
4628
4025
|
/**
|
|
4629
|
-
* - Unique identifier
|
|
4630
|
-
* the related business
|
|
4026
|
+
* - Unique identifier of the related business
|
|
4631
4027
|
*/
|
|
4632
4028
|
_id?: string;
|
|
4633
4029
|
/**
|
|
@@ -4663,24 +4059,23 @@ type ApplicationDetail = {
|
|
|
4663
4059
|
domain?: Domain;
|
|
4664
4060
|
domains?: Domain[];
|
|
4665
4061
|
/**
|
|
4666
|
-
* - The unique identifier
|
|
4667
|
-
* for the sales channel details
|
|
4062
|
+
* - The unique identifier for the sales channel details
|
|
4668
4063
|
*/
|
|
4669
4064
|
_id?: string;
|
|
4670
4065
|
slug?: string;
|
|
4671
4066
|
company_id?: number;
|
|
4672
4067
|
};
|
|
4673
|
-
/** @returns {
|
|
4674
|
-
declare function
|
|
4675
|
-
type
|
|
4068
|
+
/** @returns {CurrenciesResponseSchema} */
|
|
4069
|
+
declare function CurrenciesResponseSchema(): CurrenciesResponseSchema;
|
|
4070
|
+
type CurrenciesResponseSchema = {
|
|
4676
4071
|
items?: Currency[];
|
|
4677
4072
|
};
|
|
4678
|
-
/** @returns {
|
|
4679
|
-
declare function
|
|
4680
|
-
type
|
|
4073
|
+
/** @returns {AppCurrencyResponseSchema} */
|
|
4074
|
+
declare function AppCurrencyResponseSchema(): AppCurrencyResponseSchema;
|
|
4075
|
+
type AppCurrencyResponseSchema = {
|
|
4681
4076
|
/**
|
|
4682
|
-
* - The unique identifier
|
|
4683
|
-
*
|
|
4077
|
+
* - The unique identifier of the currency
|
|
4078
|
+
* configuration supported by the application
|
|
4684
4079
|
*/
|
|
4685
4080
|
_id?: string;
|
|
4686
4081
|
/**
|
|
@@ -4756,8 +4151,7 @@ declare function OrderingStore(): OrderingStore;
|
|
|
4756
4151
|
type OrderingStore = {
|
|
4757
4152
|
address?: OptedStoreAddress;
|
|
4758
4153
|
/**
|
|
4759
|
-
* - The unique identifier
|
|
4760
|
-
* of the ordering store
|
|
4154
|
+
* - The unique identifier of the ordering store
|
|
4761
4155
|
*/
|
|
4762
4156
|
_id?: string;
|
|
4763
4157
|
/**
|
|
@@ -4810,8 +4204,7 @@ type OrderingStores = {
|
|
|
4810
4204
|
*/
|
|
4811
4205
|
type?: string;
|
|
4812
4206
|
/**
|
|
4813
|
-
* - The unique identifier
|
|
4814
|
-
* of the ordering store
|
|
4207
|
+
* - The unique identifier of the ordering store
|
|
4815
4208
|
*/
|
|
4816
4209
|
_id?: string;
|
|
4817
4210
|
/**
|
|
@@ -4825,139 +4218,29 @@ type OrderingStores = {
|
|
|
4825
4218
|
*/
|
|
4826
4219
|
__v?: number;
|
|
4827
4220
|
};
|
|
4828
|
-
/** @returns {
|
|
4829
|
-
declare function
|
|
4830
|
-
type
|
|
4831
|
-
type: string;
|
|
4832
|
-
interval?: number;
|
|
4833
|
-
};
|
|
4834
|
-
/** @returns {PlatformVersionRequest} */
|
|
4835
|
-
declare function PlatformVersionRequest(): PlatformVersionRequest;
|
|
4836
|
-
type PlatformVersionRequest = {
|
|
4837
|
-
app_code_name: string;
|
|
4838
|
-
app_name: string;
|
|
4839
|
-
force_version: string;
|
|
4840
|
-
latest_version: string;
|
|
4841
|
-
is_app_blocked: boolean;
|
|
4842
|
-
update_dialog: UpdateDiealog;
|
|
4843
|
-
};
|
|
4844
|
-
/** @returns {PlatformVersion} */
|
|
4845
|
-
declare function PlatformVersion(): PlatformVersion;
|
|
4846
|
-
type PlatformVersion = {
|
|
4847
|
-
app_code_name: string;
|
|
4848
|
-
app_name: string;
|
|
4849
|
-
force_version: string;
|
|
4850
|
-
latest_version: string;
|
|
4851
|
-
is_app_blocked: boolean;
|
|
4852
|
-
update_dialog: UpdateDiealog;
|
|
4853
|
-
_id?: string;
|
|
4854
|
-
/**
|
|
4855
|
-
* - ISO 8601 timestamp when currency was added
|
|
4856
|
-
* in the list of currencies supported by the sales channel
|
|
4857
|
-
*/
|
|
4858
|
-
modified_at?: string;
|
|
4859
|
-
/**
|
|
4860
|
-
* - ISO 8601 timestamp when currency was added
|
|
4861
|
-
* in the list of currencies supported by the sales channel
|
|
4862
|
-
*/
|
|
4863
|
-
created_at?: string;
|
|
4864
|
-
__v?: number;
|
|
4865
|
-
};
|
|
4866
|
-
/** @returns {OrderingStoresResponse} */
|
|
4867
|
-
declare function OrderingStoresResponse(): OrderingStoresResponse;
|
|
4868
|
-
type OrderingStoresResponse = {
|
|
4221
|
+
/** @returns {OrderingStoresResponseSchema} */
|
|
4222
|
+
declare function OrderingStoresResponseSchema(): OrderingStoresResponseSchema;
|
|
4223
|
+
type OrderingStoresResponseSchema = {
|
|
4869
4224
|
page?: Page;
|
|
4870
4225
|
items?: OrderingStore[];
|
|
4871
4226
|
};
|
|
4872
|
-
/** @returns {
|
|
4873
|
-
declare function
|
|
4874
|
-
type
|
|
4875
|
-
|
|
4876
|
-
|
|
4877
|
-
|
|
4878
|
-
|
|
4879
|
-
declare function LocationDefaultCurrency(): LocationDefaultCurrency;
|
|
4880
|
-
type LocationDefaultCurrency = {
|
|
4881
|
-
name?: string;
|
|
4882
|
-
symbol?: string;
|
|
4883
|
-
code?: string;
|
|
4884
|
-
};
|
|
4885
|
-
/** @returns {LocationCountry} */
|
|
4886
|
-
declare function LocationCountry(): LocationCountry;
|
|
4887
|
-
type LocationCountry = {
|
|
4888
|
-
capital?: string;
|
|
4889
|
-
currency?: string;
|
|
4890
|
-
iso2?: string;
|
|
4891
|
-
iso3?: string;
|
|
4892
|
-
name?: string;
|
|
4893
|
-
parent?: string;
|
|
4894
|
-
phone_code?: string;
|
|
4895
|
-
type?: string;
|
|
4896
|
-
uid?: number;
|
|
4897
|
-
__v?: number;
|
|
4898
|
-
_id?: string;
|
|
4899
|
-
default_currency?: LocationDefaultCurrency;
|
|
4900
|
-
default_language?: LocationDefaultLanguage;
|
|
4901
|
-
state_code?: string;
|
|
4902
|
-
country_code?: string;
|
|
4903
|
-
latitude?: string;
|
|
4904
|
-
longitude?: string;
|
|
4905
|
-
};
|
|
4906
|
-
/** @returns {Locations} */
|
|
4907
|
-
declare function Locations(): Locations;
|
|
4908
|
-
type Locations = {
|
|
4909
|
-
items?: LocationCountry[];
|
|
4910
|
-
};
|
|
4911
|
-
/** @returns {UrlRedirectionResponse} */
|
|
4912
|
-
declare function UrlRedirectionResponse(): UrlRedirectionResponse;
|
|
4913
|
-
type UrlRedirectionResponse = {
|
|
4914
|
-
redirections?: UrlRedirection[];
|
|
4915
|
-
};
|
|
4916
|
-
/** @returns {UrlRedirectionRequest} */
|
|
4917
|
-
declare function UrlRedirectionRequest(): UrlRedirectionRequest;
|
|
4918
|
-
type UrlRedirectionRequest = {
|
|
4919
|
-
redirection?: UrlRedirection;
|
|
4920
|
-
};
|
|
4921
|
-
/** @returns {UrlRedirection} */
|
|
4922
|
-
declare function UrlRedirection(): UrlRedirection;
|
|
4923
|
-
type UrlRedirection = {
|
|
4924
|
-
redirect_from?: string;
|
|
4925
|
-
redirect_to?: string;
|
|
4926
|
-
type?: string;
|
|
4927
|
-
_id?: string;
|
|
4928
|
-
};
|
|
4929
|
-
/** @returns {StoreForConfigurationRequest} */
|
|
4930
|
-
declare function StoreForConfigurationRequest(): StoreForConfigurationRequest;
|
|
4931
|
-
type StoreForConfigurationRequest = {
|
|
4932
|
-
conf?: AppStoreRules[];
|
|
4933
|
-
};
|
|
4934
|
-
/** @returns {DomainOptionsResponse} */
|
|
4935
|
-
declare function DomainOptionsResponse(): DomainOptionsResponse;
|
|
4936
|
-
type DomainOptionsResponse = {
|
|
4937
|
-
domain_types?: DomainType[];
|
|
4938
|
-
network_ips?: string[];
|
|
4939
|
-
network_cnames?: string[];
|
|
4940
|
-
};
|
|
4941
|
-
/** @returns {DomainType} */
|
|
4942
|
-
declare function DomainType(): DomainType;
|
|
4943
|
-
type DomainType = {
|
|
4944
|
-
key?: string;
|
|
4945
|
-
display?: string;
|
|
4946
|
-
values?: DomainValue[];
|
|
4947
|
-
};
|
|
4948
|
-
/** @returns {DomainValue} */
|
|
4949
|
-
declare function DomainValue(): DomainValue;
|
|
4950
|
-
type DomainValue = {
|
|
4951
|
-
value?: string;
|
|
4952
|
-
text?: string;
|
|
4953
|
-
};
|
|
4954
|
-
/** @returns {StoreRequest} */
|
|
4955
|
-
declare function StoreRequest(): StoreRequest;
|
|
4956
|
-
type StoreRequest = {
|
|
4957
|
-
companies?: number[];
|
|
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[];
|
|
4958
4234
|
};
|
|
4959
|
-
/** @returns {
|
|
4960
|
-
declare function
|
|
4961
|
-
type
|
|
4962
|
-
|
|
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;
|
|
4963
4246
|
};
|