@gofynd/fdk-client-javascript 1.4.15-beta.6 → 1.4.16-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
- package/sdk/application/Cart/CartApplicationClient.js +130 -27
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +19 -30
- package/sdk/application/Content/ContentApplicationClient.js +40 -60
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -8
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -7
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +126 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
- package/sdk/application/Logistic/LogisticApplicationClient.js +118 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
- package/sdk/application/Order/OrderApplicationClient.js +62 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +65 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -2
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5039 -1300
- package/sdk/platform/Cart/CartPlatformModel.js +1976 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6941 -2203
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3224 -1687
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1241 -395
- package/sdk/platform/Content/ContentPlatformModel.js +521 -390
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7602 -1269
- package/sdk/platform/Order/OrderPlatformModel.js +3926 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- 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 +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +48 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +134 -43
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +38 -44
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +56 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
- package/sdk/platform/Share/SharePlatformModel.js +27 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- 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/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +895 -8
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- 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 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -1,6 +1,28 @@
|
|
|
1
1
|
export = ConfigurationPlatformModel;
|
|
2
|
+
/**
|
|
3
|
+
* @typedef CurrencyExchangeResponseV2
|
|
4
|
+
* @property {string} base - The 3-letter ISO 4217 code representing the base currency.
|
|
5
|
+
* @property {string} base_currency_name - The name of the base currency.
|
|
6
|
+
* @property {number} ttl_seconds - Time in seconds for which the exchange rates
|
|
7
|
+
* are valid.
|
|
8
|
+
* @property {CurrencyExchangeItem[]} items - List of exchange rates and currency details.
|
|
9
|
+
* @property {number} total - Total number of currency exchange items.
|
|
10
|
+
*/
|
|
11
|
+
/**
|
|
12
|
+
* @typedef CurrencyExchangeItem
|
|
13
|
+
* @property {string} currency_code - 3-letter ISO 4217 exchange currency code.
|
|
14
|
+
* @property {string} name - Name of the exchange currency
|
|
15
|
+
* @property {number} rate - Exchange rate of the currency with respect to the
|
|
16
|
+
* base currency.
|
|
17
|
+
* @property {string} country_code - ISO 3166 country code.
|
|
18
|
+
* @property {string} country_name - Name of the country using this currency.
|
|
19
|
+
* @property {string} subunit - The name of the subunit for the currency.
|
|
20
|
+
* @property {number} decimal_digits - Number of decimal digits the currency supports.
|
|
21
|
+
* @property {string} symbol - The symbol of the currency.
|
|
22
|
+
*/
|
|
2
23
|
/**
|
|
3
24
|
* @typedef ApplicationInventory
|
|
25
|
+
* @property {SearchConfig} [search]
|
|
4
26
|
* @property {AppInventoryConfig} [inventory]
|
|
5
27
|
* @property {AuthenticationConfig} [authentication]
|
|
6
28
|
* @property {ArticleAssignmentConfig} [article_assignment]
|
|
@@ -33,6 +55,22 @@ export = ConfigurationPlatformModel;
|
|
|
33
55
|
* @typedef PiiMasking
|
|
34
56
|
* @property {boolean} [enabled]
|
|
35
57
|
*/
|
|
58
|
+
/**
|
|
59
|
+
* @typedef FstIdentification
|
|
60
|
+
* @property {boolean} [enabled] - Indicates whether FST identification is
|
|
61
|
+
* enabled for the application.
|
|
62
|
+
*/
|
|
63
|
+
/**
|
|
64
|
+
* @typedef QuerySuggestions
|
|
65
|
+
* @property {boolean} [enabled] - Indicates whether query suggestions are enabled.
|
|
66
|
+
* @property {number} [max_limit] - Specifies the maximum number of query
|
|
67
|
+
* suggestions that can be returned.
|
|
68
|
+
*/
|
|
69
|
+
/**
|
|
70
|
+
* @typedef SearchConfig
|
|
71
|
+
* @property {FstIdentification} [fst_identification]
|
|
72
|
+
* @property {QuerySuggestions} [query_suggestions]
|
|
73
|
+
*/
|
|
36
74
|
/**
|
|
37
75
|
* @typedef AppInventoryConfig
|
|
38
76
|
* @property {InventoryBrand} [brand]
|
|
@@ -221,6 +259,7 @@ export = ConfigurationPlatformModel;
|
|
|
221
259
|
*/
|
|
222
260
|
/**
|
|
223
261
|
* @typedef AppInventoryPartialUpdate
|
|
262
|
+
* @property {SearchConfig} [search]
|
|
224
263
|
* @property {RewardPointsConfig} [reward_points]
|
|
225
264
|
* @property {AppCartConfig} [cart]
|
|
226
265
|
* @property {AppPaymentConfig} [payment]
|
|
@@ -235,24 +274,24 @@ export = ConfigurationPlatformModel;
|
|
|
235
274
|
* @property {number} [company_id] - Numeric ID allotted to a business account
|
|
236
275
|
*/
|
|
237
276
|
/**
|
|
238
|
-
* @typedef
|
|
277
|
+
* @typedef CompanyByBrandsRequestSchema
|
|
239
278
|
* @property {number} brands - Brand UID
|
|
240
279
|
* @property {string} [search_text] - A search field for finding a company by its name
|
|
241
280
|
*/
|
|
242
281
|
/**
|
|
243
|
-
* @typedef
|
|
282
|
+
* @typedef CompanyByBrandsResponseSchema
|
|
244
283
|
* @property {BrandCompanyInfo[]} [items]
|
|
245
284
|
* @property {Page} [page]
|
|
246
285
|
*/
|
|
247
286
|
/**
|
|
248
|
-
* @typedef
|
|
287
|
+
* @typedef StoreByBrandsRequestSchema
|
|
249
288
|
* @property {number} [company_id] - Current company ID for current company
|
|
250
289
|
* stores only. Don't send in case cross-selling (franchise) is enabled.
|
|
251
290
|
* @property {number} brands - Brand UID
|
|
252
291
|
* @property {string} [search_text] - Search store by its name or store code
|
|
253
292
|
*/
|
|
254
293
|
/**
|
|
255
|
-
* @typedef
|
|
294
|
+
* @typedef StoreByBrandsResponseSchema
|
|
256
295
|
* @property {BrandStoreInfo[]} [items]
|
|
257
296
|
* @property {Page} [page]
|
|
258
297
|
*/
|
|
@@ -277,11 +316,11 @@ export = ConfigurationPlatformModel;
|
|
|
277
316
|
* portrait banner
|
|
278
317
|
*/
|
|
279
318
|
/**
|
|
280
|
-
* @typedef
|
|
319
|
+
* @typedef BrandsByCompanyResponseSchema
|
|
281
320
|
* @property {CompanyBrandInfo[]} [brands]
|
|
282
321
|
*/
|
|
283
322
|
/**
|
|
284
|
-
* @typedef
|
|
323
|
+
* @typedef ValidationFailedResponseSchema
|
|
285
324
|
* @property {string} [message] - Response message for failed validation
|
|
286
325
|
*/
|
|
287
326
|
/**
|
|
@@ -308,18 +347,18 @@ export = ConfigurationPlatformModel;
|
|
|
308
347
|
* amount pan card number is expected from customer for order
|
|
309
348
|
*/
|
|
310
349
|
/**
|
|
311
|
-
* @typedef
|
|
350
|
+
* @typedef CreateApplicationRequestSchema
|
|
312
351
|
* @property {App} [app]
|
|
313
352
|
* @property {ApplicationInventory} [configuration]
|
|
314
353
|
* @property {AppDomain} [domain]
|
|
315
354
|
*/
|
|
316
355
|
/**
|
|
317
|
-
* @typedef
|
|
356
|
+
* @typedef CreateAppResponseSchema
|
|
318
357
|
* @property {Application} [app]
|
|
319
358
|
* @property {ApplicationInventory} [configuration]
|
|
320
359
|
*/
|
|
321
360
|
/**
|
|
322
|
-
* @typedef
|
|
361
|
+
* @typedef ApplicationsResponseSchema
|
|
323
362
|
* @property {Application[]} [items]
|
|
324
363
|
* @property {Page} [page]
|
|
325
364
|
*/
|
|
@@ -353,7 +392,7 @@ export = ConfigurationPlatformModel;
|
|
|
353
392
|
* @property {string} [secure_url] - URL where the splash image is hosted
|
|
354
393
|
*/
|
|
355
394
|
/**
|
|
356
|
-
* @typedef
|
|
395
|
+
* @typedef MobileAppConfigRequestSchema
|
|
357
396
|
* @property {string} [app_name] - Name of the mobile app
|
|
358
397
|
* @property {LandingImage} [landing_image]
|
|
359
398
|
* @property {SplashImage} [splash_image]
|
|
@@ -419,7 +458,7 @@ export = ConfigurationPlatformModel;
|
|
|
419
458
|
* @property {string[]} [txt_records]
|
|
420
459
|
*/
|
|
421
460
|
/**
|
|
422
|
-
* @typedef
|
|
461
|
+
* @typedef DomainAddRequestSchema
|
|
423
462
|
* @property {DomainAdd} [domain]
|
|
424
463
|
*/
|
|
425
464
|
/**
|
|
@@ -436,7 +475,7 @@ export = ConfigurationPlatformModel;
|
|
|
436
475
|
* @property {string} [message]
|
|
437
476
|
*/
|
|
438
477
|
/**
|
|
439
|
-
* @typedef
|
|
478
|
+
* @typedef DomainsResponseSchema
|
|
440
479
|
* @property {Domain[]} [domains]
|
|
441
480
|
*/
|
|
442
481
|
/**
|
|
@@ -452,13 +491,13 @@ export = ConfigurationPlatformModel;
|
|
|
452
491
|
* domain (short URL e.g. bit.ly)
|
|
453
492
|
*/
|
|
454
493
|
/**
|
|
455
|
-
* @typedef
|
|
494
|
+
* @typedef UpdateDomainTypeRequestSchema
|
|
456
495
|
* @property {UpdateDomain} [domain]
|
|
457
496
|
* @property {string} [action] - Shows domain is made primary domain for the
|
|
458
497
|
* sales channel or shorlink is created for the sales channel domain
|
|
459
498
|
*/
|
|
460
499
|
/**
|
|
461
|
-
* @typedef
|
|
500
|
+
* @typedef DomainStatusRequestSchema
|
|
462
501
|
* @property {string} [domain_url] - URL of the domain, e.g. uniket.hostx0.de
|
|
463
502
|
*/
|
|
464
503
|
/**
|
|
@@ -468,15 +507,16 @@ export = ConfigurationPlatformModel;
|
|
|
468
507
|
* domain are correctly propagating via DNS servers
|
|
469
508
|
*/
|
|
470
509
|
/**
|
|
471
|
-
* @typedef
|
|
510
|
+
* @typedef DomainStatusResponseSchema
|
|
472
511
|
* @property {boolean} [connected] - Check if domain is live and mapped to
|
|
473
512
|
* appropriate IP of Fynd Servers
|
|
474
513
|
* @property {DomainStatus[]} [status]
|
|
475
514
|
*/
|
|
476
515
|
/**
|
|
477
|
-
* @typedef
|
|
516
|
+
* @typedef DomainSuggestionsRequestSchema
|
|
478
517
|
* @property {string} [domain_url] - Domain url
|
|
479
|
-
* @property {boolean} [
|
|
518
|
+
* @property {boolean} [custom_domain] - Get suggestions for custom domains or
|
|
519
|
+
* Fynd domains
|
|
480
520
|
*/
|
|
481
521
|
/**
|
|
482
522
|
* @typedef DomainSuggestion
|
|
@@ -489,11 +529,11 @@ export = ConfigurationPlatformModel;
|
|
|
489
529
|
* @property {string} [currency] - Custom domain currency. Not present for Fynd domains.
|
|
490
530
|
*/
|
|
491
531
|
/**
|
|
492
|
-
* @typedef
|
|
532
|
+
* @typedef DomainSuggestionsResponseSchema
|
|
493
533
|
* @property {DomainSuggestion[]} [domains] - Domain URL
|
|
494
534
|
*/
|
|
495
535
|
/**
|
|
496
|
-
* @typedef
|
|
536
|
+
* @typedef SuccessMessageResponseSchema
|
|
497
537
|
* @property {boolean} [success] - Shows whether domain was deleted successfully
|
|
498
538
|
* @property {string} [message] - Success message shown to the user (in a string format)
|
|
499
539
|
*/
|
|
@@ -512,7 +552,7 @@ export = ConfigurationPlatformModel;
|
|
|
512
552
|
* @property {string} [name] - Domain URL of current sales channel, e.g. zenz.com
|
|
513
553
|
*/
|
|
514
554
|
/**
|
|
515
|
-
* @typedef
|
|
555
|
+
* @typedef CompaniesResponseSchema
|
|
516
556
|
* @property {AppInventoryCompanies[]} [items]
|
|
517
557
|
* @property {Page} [page]
|
|
518
558
|
*/
|
|
@@ -524,7 +564,7 @@ export = ConfigurationPlatformModel;
|
|
|
524
564
|
* franchisee, distributor, etc.
|
|
525
565
|
*/
|
|
526
566
|
/**
|
|
527
|
-
* @typedef
|
|
567
|
+
* @typedef StoresResponseSchema
|
|
528
568
|
* @property {AppInventoryStores[]} [items]
|
|
529
569
|
* @property {Page} [page]
|
|
530
570
|
*/
|
|
@@ -549,7 +589,7 @@ export = ConfigurationPlatformModel;
|
|
|
549
589
|
* @property {Object} [integration_type]
|
|
550
590
|
*/
|
|
551
591
|
/**
|
|
552
|
-
* @typedef
|
|
592
|
+
* @typedef FilterOrderingStoreRequestSchema
|
|
553
593
|
* @property {boolean} [all_stores] - Allow all stores from the ordering stores
|
|
554
594
|
* @property {number[]} [deployed_stores]
|
|
555
595
|
* @property {string} [q] - Store code or name of the ordering store
|
|
@@ -573,7 +613,7 @@ export = ConfigurationPlatformModel;
|
|
|
573
613
|
* @property {DeploymentMeta} [deployment_meta]
|
|
574
614
|
*/
|
|
575
615
|
/**
|
|
576
|
-
* @typedef
|
|
616
|
+
* @typedef OrderingStoreSelectRequestSchema
|
|
577
617
|
* @property {OrderingStoreSelect} ordering_store
|
|
578
618
|
*/
|
|
579
619
|
/**
|
|
@@ -602,7 +642,7 @@ export = ConfigurationPlatformModel;
|
|
|
602
642
|
* @property {Page} [page]
|
|
603
643
|
*/
|
|
604
644
|
/**
|
|
605
|
-
* @typedef
|
|
645
|
+
* @typedef OptedApplicationResponseSchema
|
|
606
646
|
* @property {string} [name] - Name of the other seller's sales channel
|
|
607
647
|
* @property {string} [description] - Basic details about the other seller's sales channel
|
|
608
648
|
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
@@ -653,7 +693,7 @@ export = ConfigurationPlatformModel;
|
|
|
653
693
|
* of other seller's application
|
|
654
694
|
*/
|
|
655
695
|
/**
|
|
656
|
-
* @typedef
|
|
696
|
+
* @typedef TokenResponseSchema
|
|
657
697
|
* @property {Tokens} [tokens]
|
|
658
698
|
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
659
699
|
* of the token
|
|
@@ -952,11 +992,11 @@ export = ConfigurationPlatformModel;
|
|
|
952
992
|
* value is false.
|
|
953
993
|
*/
|
|
954
994
|
/**
|
|
955
|
-
* @typedef
|
|
995
|
+
* @typedef AppFeatureRequestSchema
|
|
956
996
|
* @property {AppFeature} [feature]
|
|
957
997
|
*/
|
|
958
998
|
/**
|
|
959
|
-
* @typedef
|
|
999
|
+
* @typedef AppFeatureResponseSchema
|
|
960
1000
|
* @property {AppFeature} [feature]
|
|
961
1001
|
*/
|
|
962
1002
|
/**
|
|
@@ -1105,7 +1145,7 @@ export = ConfigurationPlatformModel;
|
|
|
1105
1145
|
* @property {string} [created_at] - ISO 8601 timestamp of when token created
|
|
1106
1146
|
*/
|
|
1107
1147
|
/**
|
|
1108
|
-
* @typedef
|
|
1148
|
+
* @typedef InvalidPayloadRequestSchema
|
|
1109
1149
|
* @property {string} [message] - Error message when request body payload is improper
|
|
1110
1150
|
* @property {boolean} [success] - Flag for required not successfull.
|
|
1111
1151
|
*/
|
|
@@ -1271,11 +1311,11 @@ export = ConfigurationPlatformModel;
|
|
|
1271
1311
|
* @property {number} [company_id]
|
|
1272
1312
|
*/
|
|
1273
1313
|
/**
|
|
1274
|
-
* @typedef
|
|
1314
|
+
* @typedef CurrenciesResponseSchema
|
|
1275
1315
|
* @property {Currency[]} [items]
|
|
1276
1316
|
*/
|
|
1277
1317
|
/**
|
|
1278
|
-
* @typedef
|
|
1318
|
+
* @typedef AppCurrencyResponseSchema
|
|
1279
1319
|
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
1280
1320
|
* of the currency configuration supported by the application
|
|
1281
1321
|
* @property {string} [application] - Alphanumeric ID allotted to an application
|
|
@@ -1336,18 +1376,90 @@ export = ConfigurationPlatformModel;
|
|
|
1336
1376
|
* value is zero.
|
|
1337
1377
|
*/
|
|
1338
1378
|
/**
|
|
1339
|
-
* @typedef
|
|
1379
|
+
* @typedef OrderingStoresResponseSchema
|
|
1340
1380
|
* @property {Page} [page]
|
|
1341
1381
|
* @property {OrderingStore[]} [items]
|
|
1342
1382
|
*/
|
|
1383
|
+
/**
|
|
1384
|
+
* @typedef ValidationErrors
|
|
1385
|
+
* @property {ValidationError[]} errors
|
|
1386
|
+
*/
|
|
1387
|
+
/**
|
|
1388
|
+
* @typedef ValidationError
|
|
1389
|
+
* @property {string} message - A brief description of the error encountered.
|
|
1390
|
+
* @property {string} field - The field in the request that caused the error.
|
|
1391
|
+
*/
|
|
1343
1392
|
declare class ConfigurationPlatformModel {
|
|
1344
1393
|
}
|
|
1345
1394
|
declare namespace ConfigurationPlatformModel {
|
|
1346
|
-
export { ApplicationInventory, PiiMasking, 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,
|
|
1395
|
+
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, 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 };
|
|
1347
1396
|
}
|
|
1397
|
+
/** @returns {CurrencyExchangeResponseV2} */
|
|
1398
|
+
declare function CurrencyExchangeResponseV2(): CurrencyExchangeResponseV2;
|
|
1399
|
+
type CurrencyExchangeResponseV2 = {
|
|
1400
|
+
/**
|
|
1401
|
+
* - The 3-letter ISO 4217 code representing the base currency.
|
|
1402
|
+
*/
|
|
1403
|
+
base: string;
|
|
1404
|
+
/**
|
|
1405
|
+
* - The name of the base currency.
|
|
1406
|
+
*/
|
|
1407
|
+
base_currency_name: string;
|
|
1408
|
+
/**
|
|
1409
|
+
* - Time in seconds for which the exchange rates
|
|
1410
|
+
* are valid.
|
|
1411
|
+
*/
|
|
1412
|
+
ttl_seconds: number;
|
|
1413
|
+
/**
|
|
1414
|
+
* - List of exchange rates and currency details.
|
|
1415
|
+
*/
|
|
1416
|
+
items: CurrencyExchangeItem[];
|
|
1417
|
+
/**
|
|
1418
|
+
* - Total number of currency exchange items.
|
|
1419
|
+
*/
|
|
1420
|
+
total: number;
|
|
1421
|
+
};
|
|
1422
|
+
/** @returns {CurrencyExchangeItem} */
|
|
1423
|
+
declare function CurrencyExchangeItem(): CurrencyExchangeItem;
|
|
1424
|
+
type CurrencyExchangeItem = {
|
|
1425
|
+
/**
|
|
1426
|
+
* - 3-letter ISO 4217 exchange currency code.
|
|
1427
|
+
*/
|
|
1428
|
+
currency_code: string;
|
|
1429
|
+
/**
|
|
1430
|
+
* - Name of the exchange currency
|
|
1431
|
+
*/
|
|
1432
|
+
name: string;
|
|
1433
|
+
/**
|
|
1434
|
+
* - Exchange rate of the currency with respect to the
|
|
1435
|
+
* base currency.
|
|
1436
|
+
*/
|
|
1437
|
+
rate: number;
|
|
1438
|
+
/**
|
|
1439
|
+
* - ISO 3166 country code.
|
|
1440
|
+
*/
|
|
1441
|
+
country_code: string;
|
|
1442
|
+
/**
|
|
1443
|
+
* - Name of the country using this currency.
|
|
1444
|
+
*/
|
|
1445
|
+
country_name: string;
|
|
1446
|
+
/**
|
|
1447
|
+
* - The name of the subunit for the currency.
|
|
1448
|
+
*/
|
|
1449
|
+
subunit: string;
|
|
1450
|
+
/**
|
|
1451
|
+
* - Number of decimal digits the currency supports.
|
|
1452
|
+
*/
|
|
1453
|
+
decimal_digits: number;
|
|
1454
|
+
/**
|
|
1455
|
+
* - The symbol of the currency.
|
|
1456
|
+
*/
|
|
1457
|
+
symbol: string;
|
|
1458
|
+
};
|
|
1348
1459
|
/** @returns {ApplicationInventory} */
|
|
1349
1460
|
declare function ApplicationInventory(): ApplicationInventory;
|
|
1350
1461
|
type ApplicationInventory = {
|
|
1462
|
+
search?: SearchConfig;
|
|
1351
1463
|
inventory?: AppInventoryConfig;
|
|
1352
1464
|
authentication?: AuthenticationConfig;
|
|
1353
1465
|
article_assignment?: ArticleAssignmentConfig;
|
|
@@ -1402,6 +1514,34 @@ declare function PiiMasking(): PiiMasking;
|
|
|
1402
1514
|
type PiiMasking = {
|
|
1403
1515
|
enabled?: boolean;
|
|
1404
1516
|
};
|
|
1517
|
+
/** @returns {FstIdentification} */
|
|
1518
|
+
declare function FstIdentification(): FstIdentification;
|
|
1519
|
+
type FstIdentification = {
|
|
1520
|
+
/**
|
|
1521
|
+
* - Indicates whether FST identification is
|
|
1522
|
+
* enabled for the application.
|
|
1523
|
+
*/
|
|
1524
|
+
enabled?: boolean;
|
|
1525
|
+
};
|
|
1526
|
+
/** @returns {QuerySuggestions} */
|
|
1527
|
+
declare function QuerySuggestions(): QuerySuggestions;
|
|
1528
|
+
type QuerySuggestions = {
|
|
1529
|
+
/**
|
|
1530
|
+
* - Indicates whether query suggestions are enabled.
|
|
1531
|
+
*/
|
|
1532
|
+
enabled?: boolean;
|
|
1533
|
+
/**
|
|
1534
|
+
* - Specifies the maximum number of query
|
|
1535
|
+
* suggestions that can be returned.
|
|
1536
|
+
*/
|
|
1537
|
+
max_limit?: number;
|
|
1538
|
+
};
|
|
1539
|
+
/** @returns {SearchConfig} */
|
|
1540
|
+
declare function SearchConfig(): SearchConfig;
|
|
1541
|
+
type SearchConfig = {
|
|
1542
|
+
fst_identification?: FstIdentification;
|
|
1543
|
+
query_suggestions?: QuerySuggestions;
|
|
1544
|
+
};
|
|
1405
1545
|
/** @returns {AppInventoryConfig} */
|
|
1406
1546
|
declare function AppInventoryConfig(): AppInventoryConfig;
|
|
1407
1547
|
type AppInventoryConfig = {
|
|
@@ -1764,6 +1904,7 @@ type LoyaltyPointsConfig = {
|
|
|
1764
1904
|
/** @returns {AppInventoryPartialUpdate} */
|
|
1765
1905
|
declare function AppInventoryPartialUpdate(): AppInventoryPartialUpdate;
|
|
1766
1906
|
type AppInventoryPartialUpdate = {
|
|
1907
|
+
search?: SearchConfig;
|
|
1767
1908
|
reward_points?: RewardPointsConfig;
|
|
1768
1909
|
cart?: AppCartConfig;
|
|
1769
1910
|
payment?: AppPaymentConfig;
|
|
@@ -1787,9 +1928,9 @@ type BrandCompanyInfo = {
|
|
|
1787
1928
|
*/
|
|
1788
1929
|
company_id?: number;
|
|
1789
1930
|
};
|
|
1790
|
-
/** @returns {
|
|
1791
|
-
declare function
|
|
1792
|
-
type
|
|
1931
|
+
/** @returns {CompanyByBrandsRequestSchema} */
|
|
1932
|
+
declare function CompanyByBrandsRequestSchema(): CompanyByBrandsRequestSchema;
|
|
1933
|
+
type CompanyByBrandsRequestSchema = {
|
|
1793
1934
|
/**
|
|
1794
1935
|
* - Brand UID
|
|
1795
1936
|
*/
|
|
@@ -1799,15 +1940,15 @@ type CompanyByBrandsRequest = {
|
|
|
1799
1940
|
*/
|
|
1800
1941
|
search_text?: string;
|
|
1801
1942
|
};
|
|
1802
|
-
/** @returns {
|
|
1803
|
-
declare function
|
|
1804
|
-
type
|
|
1943
|
+
/** @returns {CompanyByBrandsResponseSchema} */
|
|
1944
|
+
declare function CompanyByBrandsResponseSchema(): CompanyByBrandsResponseSchema;
|
|
1945
|
+
type CompanyByBrandsResponseSchema = {
|
|
1805
1946
|
items?: BrandCompanyInfo[];
|
|
1806
1947
|
page?: Page;
|
|
1807
1948
|
};
|
|
1808
|
-
/** @returns {
|
|
1809
|
-
declare function
|
|
1810
|
-
type
|
|
1949
|
+
/** @returns {StoreByBrandsRequestSchema} */
|
|
1950
|
+
declare function StoreByBrandsRequestSchema(): StoreByBrandsRequestSchema;
|
|
1951
|
+
type StoreByBrandsRequestSchema = {
|
|
1811
1952
|
/**
|
|
1812
1953
|
* - Current company ID for current company
|
|
1813
1954
|
* stores only. Don't send in case cross-selling (franchise) is enabled.
|
|
@@ -1822,9 +1963,9 @@ type StoreByBrandsRequest = {
|
|
|
1822
1963
|
*/
|
|
1823
1964
|
search_text?: string;
|
|
1824
1965
|
};
|
|
1825
|
-
/** @returns {
|
|
1826
|
-
declare function
|
|
1827
|
-
type
|
|
1966
|
+
/** @returns {StoreByBrandsResponseSchema} */
|
|
1967
|
+
declare function StoreByBrandsResponseSchema(): StoreByBrandsResponseSchema;
|
|
1968
|
+
type StoreByBrandsResponseSchema = {
|
|
1828
1969
|
items?: BrandStoreInfo[];
|
|
1829
1970
|
page?: Page;
|
|
1830
1971
|
};
|
|
@@ -1877,14 +2018,14 @@ type CompanyBrandInfo = {
|
|
|
1877
2018
|
*/
|
|
1878
2019
|
brand_banner_portrait_url?: string;
|
|
1879
2020
|
};
|
|
1880
|
-
/** @returns {
|
|
1881
|
-
declare function
|
|
1882
|
-
type
|
|
2021
|
+
/** @returns {BrandsByCompanyResponseSchema} */
|
|
2022
|
+
declare function BrandsByCompanyResponseSchema(): BrandsByCompanyResponseSchema;
|
|
2023
|
+
type BrandsByCompanyResponseSchema = {
|
|
1883
2024
|
brands?: CompanyBrandInfo[];
|
|
1884
2025
|
};
|
|
1885
|
-
/** @returns {
|
|
1886
|
-
declare function
|
|
1887
|
-
type
|
|
2026
|
+
/** @returns {ValidationFailedResponseSchema} */
|
|
2027
|
+
declare function ValidationFailedResponseSchema(): ValidationFailedResponseSchema;
|
|
2028
|
+
type ValidationFailedResponseSchema = {
|
|
1888
2029
|
/**
|
|
1889
2030
|
* - Response message for failed validation
|
|
1890
2031
|
*/
|
|
@@ -1935,22 +2076,22 @@ type PanCardConfig = {
|
|
|
1935
2076
|
*/
|
|
1936
2077
|
online_threshold_amount?: number;
|
|
1937
2078
|
};
|
|
1938
|
-
/** @returns {
|
|
1939
|
-
declare function
|
|
1940
|
-
type
|
|
2079
|
+
/** @returns {CreateApplicationRequestSchema} */
|
|
2080
|
+
declare function CreateApplicationRequestSchema(): CreateApplicationRequestSchema;
|
|
2081
|
+
type CreateApplicationRequestSchema = {
|
|
1941
2082
|
app?: App;
|
|
1942
2083
|
configuration?: ApplicationInventory;
|
|
1943
2084
|
domain?: AppDomain;
|
|
1944
2085
|
};
|
|
1945
|
-
/** @returns {
|
|
1946
|
-
declare function
|
|
1947
|
-
type
|
|
2086
|
+
/** @returns {CreateAppResponseSchema} */
|
|
2087
|
+
declare function CreateAppResponseSchema(): CreateAppResponseSchema;
|
|
2088
|
+
type CreateAppResponseSchema = {
|
|
1948
2089
|
app?: Application;
|
|
1949
2090
|
configuration?: ApplicationInventory;
|
|
1950
2091
|
};
|
|
1951
|
-
/** @returns {
|
|
1952
|
-
declare function
|
|
1953
|
-
type
|
|
2092
|
+
/** @returns {ApplicationsResponseSchema} */
|
|
2093
|
+
declare function ApplicationsResponseSchema(): ApplicationsResponseSchema;
|
|
2094
|
+
type ApplicationsResponseSchema = {
|
|
1954
2095
|
items?: Application[];
|
|
1955
2096
|
page?: Page;
|
|
1956
2097
|
};
|
|
@@ -2025,9 +2166,9 @@ type SplashImage = {
|
|
|
2025
2166
|
*/
|
|
2026
2167
|
secure_url?: string;
|
|
2027
2168
|
};
|
|
2028
|
-
/** @returns {
|
|
2029
|
-
declare function
|
|
2030
|
-
type
|
|
2169
|
+
/** @returns {MobileAppConfigRequestSchema} */
|
|
2170
|
+
declare function MobileAppConfigRequestSchema(): MobileAppConfigRequestSchema;
|
|
2171
|
+
type MobileAppConfigRequestSchema = {
|
|
2031
2172
|
/**
|
|
2032
2173
|
* - Name of the mobile app
|
|
2033
2174
|
*/
|
|
@@ -2169,9 +2310,9 @@ type DomainAdd = {
|
|
|
2169
2310
|
message?: string;
|
|
2170
2311
|
txt_records?: string[];
|
|
2171
2312
|
};
|
|
2172
|
-
/** @returns {
|
|
2173
|
-
declare function
|
|
2174
|
-
type
|
|
2313
|
+
/** @returns {DomainAddRequestSchema} */
|
|
2314
|
+
declare function DomainAddRequestSchema(): DomainAddRequestSchema;
|
|
2315
|
+
type DomainAddRequestSchema = {
|
|
2175
2316
|
domain?: DomainAdd;
|
|
2176
2317
|
};
|
|
2177
2318
|
/** @returns {Domain} */
|
|
@@ -2206,9 +2347,9 @@ type Domain = {
|
|
|
2206
2347
|
is_predefined?: boolean;
|
|
2207
2348
|
message?: string;
|
|
2208
2349
|
};
|
|
2209
|
-
/** @returns {
|
|
2210
|
-
declare function
|
|
2211
|
-
type
|
|
2350
|
+
/** @returns {DomainsResponseSchema} */
|
|
2351
|
+
declare function DomainsResponseSchema(): DomainsResponseSchema;
|
|
2352
|
+
type DomainsResponseSchema = {
|
|
2212
2353
|
domains?: Domain[];
|
|
2213
2354
|
};
|
|
2214
2355
|
/** @returns {UpdateDomain} */
|
|
@@ -2239,9 +2380,9 @@ type UpdateDomain = {
|
|
|
2239
2380
|
*/
|
|
2240
2381
|
is_shortlink?: boolean;
|
|
2241
2382
|
};
|
|
2242
|
-
/** @returns {
|
|
2243
|
-
declare function
|
|
2244
|
-
type
|
|
2383
|
+
/** @returns {UpdateDomainTypeRequestSchema} */
|
|
2384
|
+
declare function UpdateDomainTypeRequestSchema(): UpdateDomainTypeRequestSchema;
|
|
2385
|
+
type UpdateDomainTypeRequestSchema = {
|
|
2245
2386
|
domain?: UpdateDomain;
|
|
2246
2387
|
/**
|
|
2247
2388
|
* - Shows domain is made primary domain for the
|
|
@@ -2249,9 +2390,9 @@ type UpdateDomainTypeRequest = {
|
|
|
2249
2390
|
*/
|
|
2250
2391
|
action?: string;
|
|
2251
2392
|
};
|
|
2252
|
-
/** @returns {
|
|
2253
|
-
declare function
|
|
2254
|
-
type
|
|
2393
|
+
/** @returns {DomainStatusRequestSchema} */
|
|
2394
|
+
declare function DomainStatusRequestSchema(): DomainStatusRequestSchema;
|
|
2395
|
+
type DomainStatusRequestSchema = {
|
|
2255
2396
|
/**
|
|
2256
2397
|
* - URL of the domain, e.g. uniket.hostx0.de
|
|
2257
2398
|
*/
|
|
@@ -2270,9 +2411,9 @@ type DomainStatus = {
|
|
|
2270
2411
|
*/
|
|
2271
2412
|
status?: boolean;
|
|
2272
2413
|
};
|
|
2273
|
-
/** @returns {
|
|
2274
|
-
declare function
|
|
2275
|
-
type
|
|
2414
|
+
/** @returns {DomainStatusResponseSchema} */
|
|
2415
|
+
declare function DomainStatusResponseSchema(): DomainStatusResponseSchema;
|
|
2416
|
+
type DomainStatusResponseSchema = {
|
|
2276
2417
|
/**
|
|
2277
2418
|
* - Check if domain is live and mapped to
|
|
2278
2419
|
* appropriate IP of Fynd Servers
|
|
@@ -2280,17 +2421,18 @@ type DomainStatusResponse = {
|
|
|
2280
2421
|
connected?: boolean;
|
|
2281
2422
|
status?: DomainStatus[];
|
|
2282
2423
|
};
|
|
2283
|
-
/** @returns {
|
|
2284
|
-
declare function
|
|
2285
|
-
type
|
|
2424
|
+
/** @returns {DomainSuggestionsRequestSchema} */
|
|
2425
|
+
declare function DomainSuggestionsRequestSchema(): DomainSuggestionsRequestSchema;
|
|
2426
|
+
type DomainSuggestionsRequestSchema = {
|
|
2286
2427
|
/**
|
|
2287
2428
|
* - Domain url
|
|
2288
2429
|
*/
|
|
2289
2430
|
domain_url?: string;
|
|
2290
2431
|
/**
|
|
2291
|
-
* - Get suggestions for custom domains or
|
|
2432
|
+
* - Get suggestions for custom domains or
|
|
2433
|
+
* Fynd domains
|
|
2292
2434
|
*/
|
|
2293
|
-
|
|
2435
|
+
custom_domain?: boolean;
|
|
2294
2436
|
};
|
|
2295
2437
|
/** @returns {DomainSuggestion} */
|
|
2296
2438
|
declare function DomainSuggestion(): DomainSuggestion;
|
|
@@ -2318,17 +2460,17 @@ type DomainSuggestion = {
|
|
|
2318
2460
|
*/
|
|
2319
2461
|
currency?: string;
|
|
2320
2462
|
};
|
|
2321
|
-
/** @returns {
|
|
2322
|
-
declare function
|
|
2323
|
-
type
|
|
2463
|
+
/** @returns {DomainSuggestionsResponseSchema} */
|
|
2464
|
+
declare function DomainSuggestionsResponseSchema(): DomainSuggestionsResponseSchema;
|
|
2465
|
+
type DomainSuggestionsResponseSchema = {
|
|
2324
2466
|
/**
|
|
2325
2467
|
* - Domain URL
|
|
2326
2468
|
*/
|
|
2327
2469
|
domains?: DomainSuggestion[];
|
|
2328
2470
|
};
|
|
2329
|
-
/** @returns {
|
|
2330
|
-
declare function
|
|
2331
|
-
type
|
|
2471
|
+
/** @returns {SuccessMessageResponseSchema} */
|
|
2472
|
+
declare function SuccessMessageResponseSchema(): SuccessMessageResponseSchema;
|
|
2473
|
+
type SuccessMessageResponseSchema = {
|
|
2332
2474
|
/**
|
|
2333
2475
|
* - Shows whether domain was deleted successfully
|
|
2334
2476
|
*/
|
|
@@ -2369,9 +2511,9 @@ type AppDomain = {
|
|
|
2369
2511
|
*/
|
|
2370
2512
|
name?: string;
|
|
2371
2513
|
};
|
|
2372
|
-
/** @returns {
|
|
2373
|
-
declare function
|
|
2374
|
-
type
|
|
2514
|
+
/** @returns {CompaniesResponseSchema} */
|
|
2515
|
+
declare function CompaniesResponseSchema(): CompaniesResponseSchema;
|
|
2516
|
+
type CompaniesResponseSchema = {
|
|
2375
2517
|
items?: AppInventoryCompanies[];
|
|
2376
2518
|
page?: Page;
|
|
2377
2519
|
};
|
|
@@ -2392,9 +2534,9 @@ type AppInventoryCompanies = {
|
|
|
2392
2534
|
*/
|
|
2393
2535
|
company_type?: string;
|
|
2394
2536
|
};
|
|
2395
|
-
/** @returns {
|
|
2396
|
-
declare function
|
|
2397
|
-
type
|
|
2537
|
+
/** @returns {StoresResponseSchema} */
|
|
2538
|
+
declare function StoresResponseSchema(): StoresResponseSchema;
|
|
2539
|
+
type StoresResponseSchema = {
|
|
2398
2540
|
items?: AppInventoryStores[];
|
|
2399
2541
|
page?: Page;
|
|
2400
2542
|
};
|
|
@@ -2443,9 +2585,9 @@ type AppInventoryStores = {
|
|
|
2443
2585
|
address?: any;
|
|
2444
2586
|
integration_type?: any;
|
|
2445
2587
|
};
|
|
2446
|
-
/** @returns {
|
|
2447
|
-
declare function
|
|
2448
|
-
type
|
|
2588
|
+
/** @returns {FilterOrderingStoreRequestSchema} */
|
|
2589
|
+
declare function FilterOrderingStoreRequestSchema(): FilterOrderingStoreRequestSchema;
|
|
2590
|
+
type FilterOrderingStoreRequestSchema = {
|
|
2449
2591
|
/**
|
|
2450
2592
|
* - Allow all stores from the ordering stores
|
|
2451
2593
|
*/
|
|
@@ -2491,9 +2633,9 @@ declare function OrderingStoreConfig(): OrderingStoreConfig;
|
|
|
2491
2633
|
type OrderingStoreConfig = {
|
|
2492
2634
|
deployment_meta?: DeploymentMeta;
|
|
2493
2635
|
};
|
|
2494
|
-
/** @returns {
|
|
2495
|
-
declare function
|
|
2496
|
-
type
|
|
2636
|
+
/** @returns {OrderingStoreSelectRequestSchema} */
|
|
2637
|
+
declare function OrderingStoreSelectRequestSchema(): OrderingStoreSelectRequestSchema;
|
|
2638
|
+
type OrderingStoreSelectRequestSchema = {
|
|
2497
2639
|
ordering_store: OrderingStoreSelect;
|
|
2498
2640
|
};
|
|
2499
2641
|
/** @returns {OrderingStoreSelect} */
|
|
@@ -2549,9 +2691,9 @@ type OtherSellerApplications = {
|
|
|
2549
2691
|
items?: OtherSellerApplication[];
|
|
2550
2692
|
page?: Page;
|
|
2551
2693
|
};
|
|
2552
|
-
/** @returns {
|
|
2553
|
-
declare function
|
|
2554
|
-
type
|
|
2694
|
+
/** @returns {OptedApplicationResponseSchema} */
|
|
2695
|
+
declare function OptedApplicationResponseSchema(): OptedApplicationResponseSchema;
|
|
2696
|
+
type OptedApplicationResponseSchema = {
|
|
2555
2697
|
/**
|
|
2556
2698
|
* - Name of the other seller's sales channel
|
|
2557
2699
|
*/
|
|
@@ -2663,9 +2805,9 @@ type OptOutInventory = {
|
|
|
2663
2805
|
*/
|
|
2664
2806
|
company: number[];
|
|
2665
2807
|
};
|
|
2666
|
-
/** @returns {
|
|
2667
|
-
declare function
|
|
2668
|
-
type
|
|
2808
|
+
/** @returns {TokenResponseSchema} */
|
|
2809
|
+
declare function TokenResponseSchema(): TokenResponseSchema;
|
|
2810
|
+
type TokenResponseSchema = {
|
|
2669
2811
|
tokens?: Tokens;
|
|
2670
2812
|
/**
|
|
2671
2813
|
* - The unique identifier (24-digit Mongo Object ID)
|
|
@@ -3227,14 +3369,14 @@ type OrderFeature = {
|
|
|
3227
3369
|
*/
|
|
3228
3370
|
buy_again?: boolean;
|
|
3229
3371
|
};
|
|
3230
|
-
/** @returns {
|
|
3231
|
-
declare function
|
|
3232
|
-
type
|
|
3372
|
+
/** @returns {AppFeatureRequestSchema} */
|
|
3373
|
+
declare function AppFeatureRequestSchema(): AppFeatureRequestSchema;
|
|
3374
|
+
type AppFeatureRequestSchema = {
|
|
3233
3375
|
feature?: AppFeature;
|
|
3234
3376
|
};
|
|
3235
|
-
/** @returns {
|
|
3236
|
-
declare function
|
|
3237
|
-
type
|
|
3377
|
+
/** @returns {AppFeatureResponseSchema} */
|
|
3378
|
+
declare function AppFeatureResponseSchema(): AppFeatureResponseSchema;
|
|
3379
|
+
type AppFeatureResponseSchema = {
|
|
3238
3380
|
feature?: AppFeature;
|
|
3239
3381
|
};
|
|
3240
3382
|
/** @returns {Currency} */
|
|
@@ -3534,9 +3676,9 @@ type TokenSchema = {
|
|
|
3534
3676
|
*/
|
|
3535
3677
|
created_at?: string;
|
|
3536
3678
|
};
|
|
3537
|
-
/** @returns {
|
|
3538
|
-
declare function
|
|
3539
|
-
type
|
|
3679
|
+
/** @returns {InvalidPayloadRequestSchema} */
|
|
3680
|
+
declare function InvalidPayloadRequestSchema(): InvalidPayloadRequestSchema;
|
|
3681
|
+
type InvalidPayloadRequestSchema = {
|
|
3540
3682
|
/**
|
|
3541
3683
|
* - Error message when request body payload is improper
|
|
3542
3684
|
*/
|
|
@@ -3911,14 +4053,14 @@ type ApplicationDetail = {
|
|
|
3911
4053
|
slug?: string;
|
|
3912
4054
|
company_id?: number;
|
|
3913
4055
|
};
|
|
3914
|
-
/** @returns {
|
|
3915
|
-
declare function
|
|
3916
|
-
type
|
|
4056
|
+
/** @returns {CurrenciesResponseSchema} */
|
|
4057
|
+
declare function CurrenciesResponseSchema(): CurrenciesResponseSchema;
|
|
4058
|
+
type CurrenciesResponseSchema = {
|
|
3917
4059
|
items?: Currency[];
|
|
3918
4060
|
};
|
|
3919
|
-
/** @returns {
|
|
3920
|
-
declare function
|
|
3921
|
-
type
|
|
4061
|
+
/** @returns {AppCurrencyResponseSchema} */
|
|
4062
|
+
declare function AppCurrencyResponseSchema(): AppCurrencyResponseSchema;
|
|
4063
|
+
type AppCurrencyResponseSchema = {
|
|
3922
4064
|
/**
|
|
3923
4065
|
* - The unique identifier (24-digit Mongo Object ID)
|
|
3924
4066
|
* of the currency configuration supported by the application
|
|
@@ -4066,9 +4208,26 @@ type OrderingStores = {
|
|
|
4066
4208
|
*/
|
|
4067
4209
|
__v?: number;
|
|
4068
4210
|
};
|
|
4069
|
-
/** @returns {
|
|
4070
|
-
declare function
|
|
4071
|
-
type
|
|
4211
|
+
/** @returns {OrderingStoresResponseSchema} */
|
|
4212
|
+
declare function OrderingStoresResponseSchema(): OrderingStoresResponseSchema;
|
|
4213
|
+
type OrderingStoresResponseSchema = {
|
|
4072
4214
|
page?: Page;
|
|
4073
4215
|
items?: OrderingStore[];
|
|
4074
4216
|
};
|
|
4217
|
+
/** @returns {ValidationErrors} */
|
|
4218
|
+
declare function ValidationErrors(): ValidationErrors;
|
|
4219
|
+
type ValidationErrors = {
|
|
4220
|
+
errors: ValidationError[];
|
|
4221
|
+
};
|
|
4222
|
+
/** @returns {ValidationError} */
|
|
4223
|
+
declare function ValidationError(): ValidationError;
|
|
4224
|
+
type ValidationError = {
|
|
4225
|
+
/**
|
|
4226
|
+
* - A brief description of the error encountered.
|
|
4227
|
+
*/
|
|
4228
|
+
message: string;
|
|
4229
|
+
/**
|
|
4230
|
+
* - The field in the request that caused the error.
|
|
4231
|
+
*/
|
|
4232
|
+
field: string;
|
|
4233
|
+
};
|