@gofynd/fdk-client-javascript 1.4.16-beta.4 → 1.4.16-beta.5
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 +118 -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 +51 -30
- package/sdk/application/Content/ContentApplicationClient.js +161 -56
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -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 +101 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
- package/sdk/application/Order/OrderApplicationClient.js +56 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -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 -21
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -16
- 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 +5070 -1296
- package/sdk/platform/Cart/CartPlatformModel.js +1992 -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 +6512 -1770
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3228 -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 +204 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1076 -478
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +253 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +256 -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 +1372 -400
- package/sdk/platform/Content/ContentPlatformModel.js +631 -394
- 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 +95 -39
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -63
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -22
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -24
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -116
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -104
- 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 +7607 -1267
- package/sdk/platform/Order/OrderPlatformModel.js +3929 -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 +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- 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 +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +9 -9
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +3 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +46 -7
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- 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 +810 -6
- 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]
|
|
@@ -223,6 +261,7 @@ export = ConfigurationPlatformModel;
|
|
|
223
261
|
*/
|
|
224
262
|
/**
|
|
225
263
|
* @typedef AppInventoryPartialUpdate
|
|
264
|
+
* @property {SearchConfig} [search]
|
|
226
265
|
* @property {RewardPointsConfig} [reward_points]
|
|
227
266
|
* @property {AppCartConfig} [cart]
|
|
228
267
|
* @property {AppPaymentConfig} [payment]
|
|
@@ -237,24 +276,24 @@ export = ConfigurationPlatformModel;
|
|
|
237
276
|
* @property {number} [company_id] - Numeric ID allotted to a business account
|
|
238
277
|
*/
|
|
239
278
|
/**
|
|
240
|
-
* @typedef
|
|
279
|
+
* @typedef CompanyByBrandsRequestSchema
|
|
241
280
|
* @property {number} brands - Brand UID
|
|
242
281
|
* @property {string} [search_text] - A search field for finding a company by its name
|
|
243
282
|
*/
|
|
244
283
|
/**
|
|
245
|
-
* @typedef
|
|
284
|
+
* @typedef CompanyByBrandsResponseSchema
|
|
246
285
|
* @property {BrandCompanyInfo[]} [items]
|
|
247
286
|
* @property {Page} [page]
|
|
248
287
|
*/
|
|
249
288
|
/**
|
|
250
|
-
* @typedef
|
|
289
|
+
* @typedef StoreByBrandsRequestSchema
|
|
251
290
|
* @property {number} [company_id] - Current company ID for current company
|
|
252
291
|
* stores only. Don't send in case cross-selling (franchise) is enabled.
|
|
253
292
|
* @property {number} brands - Brand UID
|
|
254
293
|
* @property {string} [search_text] - Search store by its name or store code
|
|
255
294
|
*/
|
|
256
295
|
/**
|
|
257
|
-
* @typedef
|
|
296
|
+
* @typedef StoreByBrandsResponseSchema
|
|
258
297
|
* @property {BrandStoreInfo[]} [items]
|
|
259
298
|
* @property {Page} [page]
|
|
260
299
|
*/
|
|
@@ -279,11 +318,11 @@ export = ConfigurationPlatformModel;
|
|
|
279
318
|
* portrait banner
|
|
280
319
|
*/
|
|
281
320
|
/**
|
|
282
|
-
* @typedef
|
|
321
|
+
* @typedef BrandsByCompanyResponseSchema
|
|
283
322
|
* @property {CompanyBrandInfo[]} [brands]
|
|
284
323
|
*/
|
|
285
324
|
/**
|
|
286
|
-
* @typedef
|
|
325
|
+
* @typedef ValidationFailedResponseSchema
|
|
287
326
|
* @property {string} [message] - Response message for failed validation
|
|
288
327
|
*/
|
|
289
328
|
/**
|
|
@@ -310,18 +349,18 @@ export = ConfigurationPlatformModel;
|
|
|
310
349
|
* amount pan card number is expected from customer for order
|
|
311
350
|
*/
|
|
312
351
|
/**
|
|
313
|
-
* @typedef
|
|
352
|
+
* @typedef CreateApplicationRequestSchema
|
|
314
353
|
* @property {App} [app]
|
|
315
354
|
* @property {ApplicationInventory} [configuration]
|
|
316
355
|
* @property {AppDomain} [domain]
|
|
317
356
|
*/
|
|
318
357
|
/**
|
|
319
|
-
* @typedef
|
|
358
|
+
* @typedef CreateAppResponseSchema
|
|
320
359
|
* @property {Application} [app]
|
|
321
360
|
* @property {ApplicationInventory} [configuration]
|
|
322
361
|
*/
|
|
323
362
|
/**
|
|
324
|
-
* @typedef
|
|
363
|
+
* @typedef ApplicationsResponseSchema
|
|
325
364
|
* @property {Application[]} [items]
|
|
326
365
|
* @property {Page} [page]
|
|
327
366
|
*/
|
|
@@ -355,7 +394,7 @@ export = ConfigurationPlatformModel;
|
|
|
355
394
|
* @property {string} [secure_url] - URL where the splash image is hosted
|
|
356
395
|
*/
|
|
357
396
|
/**
|
|
358
|
-
* @typedef
|
|
397
|
+
* @typedef MobileAppConfigRequestSchema
|
|
359
398
|
* @property {string} [app_name] - Name of the mobile app
|
|
360
399
|
* @property {LandingImage} [landing_image]
|
|
361
400
|
* @property {SplashImage} [splash_image]
|
|
@@ -421,7 +460,7 @@ export = ConfigurationPlatformModel;
|
|
|
421
460
|
* @property {string[]} [txt_records]
|
|
422
461
|
*/
|
|
423
462
|
/**
|
|
424
|
-
* @typedef
|
|
463
|
+
* @typedef DomainAddRequestSchema
|
|
425
464
|
* @property {DomainAdd} [domain]
|
|
426
465
|
*/
|
|
427
466
|
/**
|
|
@@ -438,7 +477,7 @@ export = ConfigurationPlatformModel;
|
|
|
438
477
|
* @property {string} [message]
|
|
439
478
|
*/
|
|
440
479
|
/**
|
|
441
|
-
* @typedef
|
|
480
|
+
* @typedef DomainsResponseSchema
|
|
442
481
|
* @property {Domain[]} [domains]
|
|
443
482
|
*/
|
|
444
483
|
/**
|
|
@@ -454,13 +493,13 @@ export = ConfigurationPlatformModel;
|
|
|
454
493
|
* domain (short URL e.g. bit.ly)
|
|
455
494
|
*/
|
|
456
495
|
/**
|
|
457
|
-
* @typedef
|
|
496
|
+
* @typedef UpdateDomainTypeRequestSchema
|
|
458
497
|
* @property {UpdateDomain} [domain]
|
|
459
498
|
* @property {string} [action] - Shows domain is made primary domain for the
|
|
460
499
|
* sales channel or shorlink is created for the sales channel domain
|
|
461
500
|
*/
|
|
462
501
|
/**
|
|
463
|
-
* @typedef
|
|
502
|
+
* @typedef DomainStatusRequestSchema
|
|
464
503
|
* @property {string} [domain_url] - URL of the domain, e.g. uniket.hostx0.de
|
|
465
504
|
*/
|
|
466
505
|
/**
|
|
@@ -470,15 +509,16 @@ export = ConfigurationPlatformModel;
|
|
|
470
509
|
* domain are correctly propagating via DNS servers
|
|
471
510
|
*/
|
|
472
511
|
/**
|
|
473
|
-
* @typedef
|
|
512
|
+
* @typedef DomainStatusResponseSchema
|
|
474
513
|
* @property {boolean} [connected] - Check if domain is live and mapped to
|
|
475
514
|
* appropriate IP of Fynd Servers
|
|
476
515
|
* @property {DomainStatus[]} [status]
|
|
477
516
|
*/
|
|
478
517
|
/**
|
|
479
|
-
* @typedef
|
|
518
|
+
* @typedef DomainSuggestionsRequestSchema
|
|
480
519
|
* @property {string} [domain_url] - Domain url
|
|
481
|
-
* @property {boolean} [
|
|
520
|
+
* @property {boolean} [custom_domain] - Get suggestions for custom domains or
|
|
521
|
+
* Fynd domains
|
|
482
522
|
*/
|
|
483
523
|
/**
|
|
484
524
|
* @typedef DomainSuggestion
|
|
@@ -491,11 +531,11 @@ export = ConfigurationPlatformModel;
|
|
|
491
531
|
* @property {string} [currency] - Custom domain currency. Not present for Fynd domains.
|
|
492
532
|
*/
|
|
493
533
|
/**
|
|
494
|
-
* @typedef
|
|
534
|
+
* @typedef DomainSuggestionsResponseSchema
|
|
495
535
|
* @property {DomainSuggestion[]} [domains] - Domain URL
|
|
496
536
|
*/
|
|
497
537
|
/**
|
|
498
|
-
* @typedef
|
|
538
|
+
* @typedef SuccessMessageResponseSchema
|
|
499
539
|
* @property {boolean} [success] - Shows whether domain was deleted successfully
|
|
500
540
|
* @property {string} [message] - Success message shown to the user (in a string format)
|
|
501
541
|
*/
|
|
@@ -514,7 +554,7 @@ export = ConfigurationPlatformModel;
|
|
|
514
554
|
* @property {string} [name] - Domain URL of current sales channel, e.g. zenz.com
|
|
515
555
|
*/
|
|
516
556
|
/**
|
|
517
|
-
* @typedef
|
|
557
|
+
* @typedef CompaniesResponseSchema
|
|
518
558
|
* @property {AppInventoryCompanies[]} [items]
|
|
519
559
|
* @property {Page} [page]
|
|
520
560
|
*/
|
|
@@ -526,7 +566,7 @@ export = ConfigurationPlatformModel;
|
|
|
526
566
|
* franchisee, distributor, etc.
|
|
527
567
|
*/
|
|
528
568
|
/**
|
|
529
|
-
* @typedef
|
|
569
|
+
* @typedef StoresResponseSchema
|
|
530
570
|
* @property {AppInventoryStores[]} [items]
|
|
531
571
|
* @property {Page} [page]
|
|
532
572
|
*/
|
|
@@ -551,7 +591,7 @@ export = ConfigurationPlatformModel;
|
|
|
551
591
|
* @property {Object} [integration_type]
|
|
552
592
|
*/
|
|
553
593
|
/**
|
|
554
|
-
* @typedef
|
|
594
|
+
* @typedef FilterOrderingStoreRequestSchema
|
|
555
595
|
* @property {boolean} [all_stores] - Allow all stores from the ordering stores
|
|
556
596
|
* @property {number[]} [deployed_stores]
|
|
557
597
|
* @property {string} [q] - Store code or name of the ordering store
|
|
@@ -575,7 +615,7 @@ export = ConfigurationPlatformModel;
|
|
|
575
615
|
* @property {DeploymentMeta} [deployment_meta]
|
|
576
616
|
*/
|
|
577
617
|
/**
|
|
578
|
-
* @typedef
|
|
618
|
+
* @typedef OrderingStoreSelectRequestSchema
|
|
579
619
|
* @property {OrderingStoreSelect} ordering_store
|
|
580
620
|
*/
|
|
581
621
|
/**
|
|
@@ -604,7 +644,7 @@ export = ConfigurationPlatformModel;
|
|
|
604
644
|
* @property {Page} [page]
|
|
605
645
|
*/
|
|
606
646
|
/**
|
|
607
|
-
* @typedef
|
|
647
|
+
* @typedef OptedApplicationResponseSchema
|
|
608
648
|
* @property {string} [name] - Name of the other seller's sales channel
|
|
609
649
|
* @property {string} [description] - Basic details about the other seller's sales channel
|
|
610
650
|
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
@@ -655,7 +695,7 @@ export = ConfigurationPlatformModel;
|
|
|
655
695
|
* of other seller's application
|
|
656
696
|
*/
|
|
657
697
|
/**
|
|
658
|
-
* @typedef
|
|
698
|
+
* @typedef TokenResponseSchema
|
|
659
699
|
* @property {Tokens} [tokens]
|
|
660
700
|
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
661
701
|
* of the token
|
|
@@ -954,11 +994,11 @@ export = ConfigurationPlatformModel;
|
|
|
954
994
|
* value is false.
|
|
955
995
|
*/
|
|
956
996
|
/**
|
|
957
|
-
* @typedef
|
|
997
|
+
* @typedef AppFeatureRequestSchema
|
|
958
998
|
* @property {AppFeature} [feature]
|
|
959
999
|
*/
|
|
960
1000
|
/**
|
|
961
|
-
* @typedef
|
|
1001
|
+
* @typedef AppFeatureResponseSchema
|
|
962
1002
|
* @property {AppFeature} [feature]
|
|
963
1003
|
*/
|
|
964
1004
|
/**
|
|
@@ -1107,7 +1147,7 @@ export = ConfigurationPlatformModel;
|
|
|
1107
1147
|
* @property {string} [created_at] - ISO 8601 timestamp of when token created
|
|
1108
1148
|
*/
|
|
1109
1149
|
/**
|
|
1110
|
-
* @typedef
|
|
1150
|
+
* @typedef InvalidPayloadRequestSchema
|
|
1111
1151
|
* @property {string} [message] - Error message when request body payload is improper
|
|
1112
1152
|
* @property {boolean} [success] - Flag for required not successfull.
|
|
1113
1153
|
*/
|
|
@@ -1273,11 +1313,11 @@ export = ConfigurationPlatformModel;
|
|
|
1273
1313
|
* @property {number} [company_id]
|
|
1274
1314
|
*/
|
|
1275
1315
|
/**
|
|
1276
|
-
* @typedef
|
|
1316
|
+
* @typedef CurrenciesResponseSchema
|
|
1277
1317
|
* @property {Currency[]} [items]
|
|
1278
1318
|
*/
|
|
1279
1319
|
/**
|
|
1280
|
-
* @typedef
|
|
1320
|
+
* @typedef AppCurrencyResponseSchema
|
|
1281
1321
|
* @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
|
|
1282
1322
|
* of the currency configuration supported by the application
|
|
1283
1323
|
* @property {string} [application] - Alphanumeric ID allotted to an application
|
|
@@ -1338,18 +1378,90 @@ export = ConfigurationPlatformModel;
|
|
|
1338
1378
|
* value is zero.
|
|
1339
1379
|
*/
|
|
1340
1380
|
/**
|
|
1341
|
-
* @typedef
|
|
1381
|
+
* @typedef OrderingStoresResponseSchema
|
|
1342
1382
|
* @property {Page} [page]
|
|
1343
1383
|
* @property {OrderingStore[]} [items]
|
|
1344
1384
|
*/
|
|
1385
|
+
/**
|
|
1386
|
+
* @typedef ValidationErrors
|
|
1387
|
+
* @property {ValidationError[]} errors
|
|
1388
|
+
*/
|
|
1389
|
+
/**
|
|
1390
|
+
* @typedef ValidationError
|
|
1391
|
+
* @property {string} message - A brief description of the error encountered.
|
|
1392
|
+
* @property {string} field - The field in the request that caused the error.
|
|
1393
|
+
*/
|
|
1345
1394
|
declare class ConfigurationPlatformModel {
|
|
1346
1395
|
}
|
|
1347
1396
|
declare namespace ConfigurationPlatformModel {
|
|
1348
|
-
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,
|
|
1397
|
+
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 };
|
|
1349
1398
|
}
|
|
1399
|
+
/** @returns {CurrencyExchangeResponseV2} */
|
|
1400
|
+
declare function CurrencyExchangeResponseV2(): CurrencyExchangeResponseV2;
|
|
1401
|
+
type CurrencyExchangeResponseV2 = {
|
|
1402
|
+
/**
|
|
1403
|
+
* - The 3-letter ISO 4217 code representing the base currency.
|
|
1404
|
+
*/
|
|
1405
|
+
base: string;
|
|
1406
|
+
/**
|
|
1407
|
+
* - The name of the base currency.
|
|
1408
|
+
*/
|
|
1409
|
+
base_currency_name: string;
|
|
1410
|
+
/**
|
|
1411
|
+
* - Time in seconds for which the exchange rates
|
|
1412
|
+
* are valid.
|
|
1413
|
+
*/
|
|
1414
|
+
ttl_seconds: number;
|
|
1415
|
+
/**
|
|
1416
|
+
* - List of exchange rates and currency details.
|
|
1417
|
+
*/
|
|
1418
|
+
items: CurrencyExchangeItem[];
|
|
1419
|
+
/**
|
|
1420
|
+
* - Total number of currency exchange items.
|
|
1421
|
+
*/
|
|
1422
|
+
total: number;
|
|
1423
|
+
};
|
|
1424
|
+
/** @returns {CurrencyExchangeItem} */
|
|
1425
|
+
declare function CurrencyExchangeItem(): CurrencyExchangeItem;
|
|
1426
|
+
type CurrencyExchangeItem = {
|
|
1427
|
+
/**
|
|
1428
|
+
* - 3-letter ISO 4217 exchange currency code.
|
|
1429
|
+
*/
|
|
1430
|
+
currency_code: string;
|
|
1431
|
+
/**
|
|
1432
|
+
* - Name of the exchange currency
|
|
1433
|
+
*/
|
|
1434
|
+
name: string;
|
|
1435
|
+
/**
|
|
1436
|
+
* - Exchange rate of the currency with respect to the
|
|
1437
|
+
* base currency.
|
|
1438
|
+
*/
|
|
1439
|
+
rate: number;
|
|
1440
|
+
/**
|
|
1441
|
+
* - ISO 3166 country code.
|
|
1442
|
+
*/
|
|
1443
|
+
country_code: string;
|
|
1444
|
+
/**
|
|
1445
|
+
* - Name of the country using this currency.
|
|
1446
|
+
*/
|
|
1447
|
+
country_name: string;
|
|
1448
|
+
/**
|
|
1449
|
+
* - The name of the subunit for the currency.
|
|
1450
|
+
*/
|
|
1451
|
+
subunit: string;
|
|
1452
|
+
/**
|
|
1453
|
+
* - Number of decimal digits the currency supports.
|
|
1454
|
+
*/
|
|
1455
|
+
decimal_digits: number;
|
|
1456
|
+
/**
|
|
1457
|
+
* - The symbol of the currency.
|
|
1458
|
+
*/
|
|
1459
|
+
symbol: string;
|
|
1460
|
+
};
|
|
1350
1461
|
/** @returns {ApplicationInventory} */
|
|
1351
1462
|
declare function ApplicationInventory(): ApplicationInventory;
|
|
1352
1463
|
type ApplicationInventory = {
|
|
1464
|
+
search?: SearchConfig;
|
|
1353
1465
|
inventory?: AppInventoryConfig;
|
|
1354
1466
|
authentication?: AuthenticationConfig;
|
|
1355
1467
|
article_assignment?: ArticleAssignmentConfig;
|
|
@@ -1404,6 +1516,34 @@ declare function PiiMasking(): PiiMasking;
|
|
|
1404
1516
|
type PiiMasking = {
|
|
1405
1517
|
enabled?: boolean;
|
|
1406
1518
|
};
|
|
1519
|
+
/** @returns {FstIdentification} */
|
|
1520
|
+
declare function FstIdentification(): FstIdentification;
|
|
1521
|
+
type FstIdentification = {
|
|
1522
|
+
/**
|
|
1523
|
+
* - Indicates whether FST identification is
|
|
1524
|
+
* enabled for the application.
|
|
1525
|
+
*/
|
|
1526
|
+
enabled?: boolean;
|
|
1527
|
+
};
|
|
1528
|
+
/** @returns {QuerySuggestions} */
|
|
1529
|
+
declare function QuerySuggestions(): QuerySuggestions;
|
|
1530
|
+
type QuerySuggestions = {
|
|
1531
|
+
/**
|
|
1532
|
+
* - Indicates whether query suggestions are enabled.
|
|
1533
|
+
*/
|
|
1534
|
+
enabled?: boolean;
|
|
1535
|
+
/**
|
|
1536
|
+
* - Specifies the maximum number of query
|
|
1537
|
+
* suggestions that can be returned.
|
|
1538
|
+
*/
|
|
1539
|
+
max_limit?: number;
|
|
1540
|
+
};
|
|
1541
|
+
/** @returns {SearchConfig} */
|
|
1542
|
+
declare function SearchConfig(): SearchConfig;
|
|
1543
|
+
type SearchConfig = {
|
|
1544
|
+
fst_identification?: FstIdentification;
|
|
1545
|
+
query_suggestions?: QuerySuggestions;
|
|
1546
|
+
};
|
|
1407
1547
|
/** @returns {AppInventoryConfig} */
|
|
1408
1548
|
declare function AppInventoryConfig(): AppInventoryConfig;
|
|
1409
1549
|
type AppInventoryConfig = {
|
|
@@ -1771,6 +1911,7 @@ type LoyaltyPointsConfig = {
|
|
|
1771
1911
|
/** @returns {AppInventoryPartialUpdate} */
|
|
1772
1912
|
declare function AppInventoryPartialUpdate(): AppInventoryPartialUpdate;
|
|
1773
1913
|
type AppInventoryPartialUpdate = {
|
|
1914
|
+
search?: SearchConfig;
|
|
1774
1915
|
reward_points?: RewardPointsConfig;
|
|
1775
1916
|
cart?: AppCartConfig;
|
|
1776
1917
|
payment?: AppPaymentConfig;
|
|
@@ -1794,9 +1935,9 @@ type BrandCompanyInfo = {
|
|
|
1794
1935
|
*/
|
|
1795
1936
|
company_id?: number;
|
|
1796
1937
|
};
|
|
1797
|
-
/** @returns {
|
|
1798
|
-
declare function
|
|
1799
|
-
type
|
|
1938
|
+
/** @returns {CompanyByBrandsRequestSchema} */
|
|
1939
|
+
declare function CompanyByBrandsRequestSchema(): CompanyByBrandsRequestSchema;
|
|
1940
|
+
type CompanyByBrandsRequestSchema = {
|
|
1800
1941
|
/**
|
|
1801
1942
|
* - Brand UID
|
|
1802
1943
|
*/
|
|
@@ -1806,15 +1947,15 @@ type CompanyByBrandsRequest = {
|
|
|
1806
1947
|
*/
|
|
1807
1948
|
search_text?: string;
|
|
1808
1949
|
};
|
|
1809
|
-
/** @returns {
|
|
1810
|
-
declare function
|
|
1811
|
-
type
|
|
1950
|
+
/** @returns {CompanyByBrandsResponseSchema} */
|
|
1951
|
+
declare function CompanyByBrandsResponseSchema(): CompanyByBrandsResponseSchema;
|
|
1952
|
+
type CompanyByBrandsResponseSchema = {
|
|
1812
1953
|
items?: BrandCompanyInfo[];
|
|
1813
1954
|
page?: Page;
|
|
1814
1955
|
};
|
|
1815
|
-
/** @returns {
|
|
1816
|
-
declare function
|
|
1817
|
-
type
|
|
1956
|
+
/** @returns {StoreByBrandsRequestSchema} */
|
|
1957
|
+
declare function StoreByBrandsRequestSchema(): StoreByBrandsRequestSchema;
|
|
1958
|
+
type StoreByBrandsRequestSchema = {
|
|
1818
1959
|
/**
|
|
1819
1960
|
* - Current company ID for current company
|
|
1820
1961
|
* stores only. Don't send in case cross-selling (franchise) is enabled.
|
|
@@ -1829,9 +1970,9 @@ type StoreByBrandsRequest = {
|
|
|
1829
1970
|
*/
|
|
1830
1971
|
search_text?: string;
|
|
1831
1972
|
};
|
|
1832
|
-
/** @returns {
|
|
1833
|
-
declare function
|
|
1834
|
-
type
|
|
1973
|
+
/** @returns {StoreByBrandsResponseSchema} */
|
|
1974
|
+
declare function StoreByBrandsResponseSchema(): StoreByBrandsResponseSchema;
|
|
1975
|
+
type StoreByBrandsResponseSchema = {
|
|
1835
1976
|
items?: BrandStoreInfo[];
|
|
1836
1977
|
page?: Page;
|
|
1837
1978
|
};
|
|
@@ -1884,14 +2025,14 @@ type CompanyBrandInfo = {
|
|
|
1884
2025
|
*/
|
|
1885
2026
|
brand_banner_portrait_url?: string;
|
|
1886
2027
|
};
|
|
1887
|
-
/** @returns {
|
|
1888
|
-
declare function
|
|
1889
|
-
type
|
|
2028
|
+
/** @returns {BrandsByCompanyResponseSchema} */
|
|
2029
|
+
declare function BrandsByCompanyResponseSchema(): BrandsByCompanyResponseSchema;
|
|
2030
|
+
type BrandsByCompanyResponseSchema = {
|
|
1890
2031
|
brands?: CompanyBrandInfo[];
|
|
1891
2032
|
};
|
|
1892
|
-
/** @returns {
|
|
1893
|
-
declare function
|
|
1894
|
-
type
|
|
2033
|
+
/** @returns {ValidationFailedResponseSchema} */
|
|
2034
|
+
declare function ValidationFailedResponseSchema(): ValidationFailedResponseSchema;
|
|
2035
|
+
type ValidationFailedResponseSchema = {
|
|
1895
2036
|
/**
|
|
1896
2037
|
* - Response message for failed validation
|
|
1897
2038
|
*/
|
|
@@ -1942,22 +2083,22 @@ type PanCardConfig = {
|
|
|
1942
2083
|
*/
|
|
1943
2084
|
online_threshold_amount?: number;
|
|
1944
2085
|
};
|
|
1945
|
-
/** @returns {
|
|
1946
|
-
declare function
|
|
1947
|
-
type
|
|
2086
|
+
/** @returns {CreateApplicationRequestSchema} */
|
|
2087
|
+
declare function CreateApplicationRequestSchema(): CreateApplicationRequestSchema;
|
|
2088
|
+
type CreateApplicationRequestSchema = {
|
|
1948
2089
|
app?: App;
|
|
1949
2090
|
configuration?: ApplicationInventory;
|
|
1950
2091
|
domain?: AppDomain;
|
|
1951
2092
|
};
|
|
1952
|
-
/** @returns {
|
|
1953
|
-
declare function
|
|
1954
|
-
type
|
|
2093
|
+
/** @returns {CreateAppResponseSchema} */
|
|
2094
|
+
declare function CreateAppResponseSchema(): CreateAppResponseSchema;
|
|
2095
|
+
type CreateAppResponseSchema = {
|
|
1955
2096
|
app?: Application;
|
|
1956
2097
|
configuration?: ApplicationInventory;
|
|
1957
2098
|
};
|
|
1958
|
-
/** @returns {
|
|
1959
|
-
declare function
|
|
1960
|
-
type
|
|
2099
|
+
/** @returns {ApplicationsResponseSchema} */
|
|
2100
|
+
declare function ApplicationsResponseSchema(): ApplicationsResponseSchema;
|
|
2101
|
+
type ApplicationsResponseSchema = {
|
|
1961
2102
|
items?: Application[];
|
|
1962
2103
|
page?: Page;
|
|
1963
2104
|
};
|
|
@@ -2032,9 +2173,9 @@ type SplashImage = {
|
|
|
2032
2173
|
*/
|
|
2033
2174
|
secure_url?: string;
|
|
2034
2175
|
};
|
|
2035
|
-
/** @returns {
|
|
2036
|
-
declare function
|
|
2037
|
-
type
|
|
2176
|
+
/** @returns {MobileAppConfigRequestSchema} */
|
|
2177
|
+
declare function MobileAppConfigRequestSchema(): MobileAppConfigRequestSchema;
|
|
2178
|
+
type MobileAppConfigRequestSchema = {
|
|
2038
2179
|
/**
|
|
2039
2180
|
* - Name of the mobile app
|
|
2040
2181
|
*/
|
|
@@ -2176,9 +2317,9 @@ type DomainAdd = {
|
|
|
2176
2317
|
message?: string;
|
|
2177
2318
|
txt_records?: string[];
|
|
2178
2319
|
};
|
|
2179
|
-
/** @returns {
|
|
2180
|
-
declare function
|
|
2181
|
-
type
|
|
2320
|
+
/** @returns {DomainAddRequestSchema} */
|
|
2321
|
+
declare function DomainAddRequestSchema(): DomainAddRequestSchema;
|
|
2322
|
+
type DomainAddRequestSchema = {
|
|
2182
2323
|
domain?: DomainAdd;
|
|
2183
2324
|
};
|
|
2184
2325
|
/** @returns {Domain} */
|
|
@@ -2213,9 +2354,9 @@ type Domain = {
|
|
|
2213
2354
|
is_predefined?: boolean;
|
|
2214
2355
|
message?: string;
|
|
2215
2356
|
};
|
|
2216
|
-
/** @returns {
|
|
2217
|
-
declare function
|
|
2218
|
-
type
|
|
2357
|
+
/** @returns {DomainsResponseSchema} */
|
|
2358
|
+
declare function DomainsResponseSchema(): DomainsResponseSchema;
|
|
2359
|
+
type DomainsResponseSchema = {
|
|
2219
2360
|
domains?: Domain[];
|
|
2220
2361
|
};
|
|
2221
2362
|
/** @returns {UpdateDomain} */
|
|
@@ -2246,9 +2387,9 @@ type UpdateDomain = {
|
|
|
2246
2387
|
*/
|
|
2247
2388
|
is_shortlink?: boolean;
|
|
2248
2389
|
};
|
|
2249
|
-
/** @returns {
|
|
2250
|
-
declare function
|
|
2251
|
-
type
|
|
2390
|
+
/** @returns {UpdateDomainTypeRequestSchema} */
|
|
2391
|
+
declare function UpdateDomainTypeRequestSchema(): UpdateDomainTypeRequestSchema;
|
|
2392
|
+
type UpdateDomainTypeRequestSchema = {
|
|
2252
2393
|
domain?: UpdateDomain;
|
|
2253
2394
|
/**
|
|
2254
2395
|
* - Shows domain is made primary domain for the
|
|
@@ -2256,9 +2397,9 @@ type UpdateDomainTypeRequest = {
|
|
|
2256
2397
|
*/
|
|
2257
2398
|
action?: string;
|
|
2258
2399
|
};
|
|
2259
|
-
/** @returns {
|
|
2260
|
-
declare function
|
|
2261
|
-
type
|
|
2400
|
+
/** @returns {DomainStatusRequestSchema} */
|
|
2401
|
+
declare function DomainStatusRequestSchema(): DomainStatusRequestSchema;
|
|
2402
|
+
type DomainStatusRequestSchema = {
|
|
2262
2403
|
/**
|
|
2263
2404
|
* - URL of the domain, e.g. uniket.hostx0.de
|
|
2264
2405
|
*/
|
|
@@ -2277,9 +2418,9 @@ type DomainStatus = {
|
|
|
2277
2418
|
*/
|
|
2278
2419
|
status?: boolean;
|
|
2279
2420
|
};
|
|
2280
|
-
/** @returns {
|
|
2281
|
-
declare function
|
|
2282
|
-
type
|
|
2421
|
+
/** @returns {DomainStatusResponseSchema} */
|
|
2422
|
+
declare function DomainStatusResponseSchema(): DomainStatusResponseSchema;
|
|
2423
|
+
type DomainStatusResponseSchema = {
|
|
2283
2424
|
/**
|
|
2284
2425
|
* - Check if domain is live and mapped to
|
|
2285
2426
|
* appropriate IP of Fynd Servers
|
|
@@ -2287,17 +2428,18 @@ type DomainStatusResponse = {
|
|
|
2287
2428
|
connected?: boolean;
|
|
2288
2429
|
status?: DomainStatus[];
|
|
2289
2430
|
};
|
|
2290
|
-
/** @returns {
|
|
2291
|
-
declare function
|
|
2292
|
-
type
|
|
2431
|
+
/** @returns {DomainSuggestionsRequestSchema} */
|
|
2432
|
+
declare function DomainSuggestionsRequestSchema(): DomainSuggestionsRequestSchema;
|
|
2433
|
+
type DomainSuggestionsRequestSchema = {
|
|
2293
2434
|
/**
|
|
2294
2435
|
* - Domain url
|
|
2295
2436
|
*/
|
|
2296
2437
|
domain_url?: string;
|
|
2297
2438
|
/**
|
|
2298
|
-
* - Get suggestions for custom domains or
|
|
2439
|
+
* - Get suggestions for custom domains or
|
|
2440
|
+
* Fynd domains
|
|
2299
2441
|
*/
|
|
2300
|
-
|
|
2442
|
+
custom_domain?: boolean;
|
|
2301
2443
|
};
|
|
2302
2444
|
/** @returns {DomainSuggestion} */
|
|
2303
2445
|
declare function DomainSuggestion(): DomainSuggestion;
|
|
@@ -2325,17 +2467,17 @@ type DomainSuggestion = {
|
|
|
2325
2467
|
*/
|
|
2326
2468
|
currency?: string;
|
|
2327
2469
|
};
|
|
2328
|
-
/** @returns {
|
|
2329
|
-
declare function
|
|
2330
|
-
type
|
|
2470
|
+
/** @returns {DomainSuggestionsResponseSchema} */
|
|
2471
|
+
declare function DomainSuggestionsResponseSchema(): DomainSuggestionsResponseSchema;
|
|
2472
|
+
type DomainSuggestionsResponseSchema = {
|
|
2331
2473
|
/**
|
|
2332
2474
|
* - Domain URL
|
|
2333
2475
|
*/
|
|
2334
2476
|
domains?: DomainSuggestion[];
|
|
2335
2477
|
};
|
|
2336
|
-
/** @returns {
|
|
2337
|
-
declare function
|
|
2338
|
-
type
|
|
2478
|
+
/** @returns {SuccessMessageResponseSchema} */
|
|
2479
|
+
declare function SuccessMessageResponseSchema(): SuccessMessageResponseSchema;
|
|
2480
|
+
type SuccessMessageResponseSchema = {
|
|
2339
2481
|
/**
|
|
2340
2482
|
* - Shows whether domain was deleted successfully
|
|
2341
2483
|
*/
|
|
@@ -2376,9 +2518,9 @@ type AppDomain = {
|
|
|
2376
2518
|
*/
|
|
2377
2519
|
name?: string;
|
|
2378
2520
|
};
|
|
2379
|
-
/** @returns {
|
|
2380
|
-
declare function
|
|
2381
|
-
type
|
|
2521
|
+
/** @returns {CompaniesResponseSchema} */
|
|
2522
|
+
declare function CompaniesResponseSchema(): CompaniesResponseSchema;
|
|
2523
|
+
type CompaniesResponseSchema = {
|
|
2382
2524
|
items?: AppInventoryCompanies[];
|
|
2383
2525
|
page?: Page;
|
|
2384
2526
|
};
|
|
@@ -2399,9 +2541,9 @@ type AppInventoryCompanies = {
|
|
|
2399
2541
|
*/
|
|
2400
2542
|
company_type?: string;
|
|
2401
2543
|
};
|
|
2402
|
-
/** @returns {
|
|
2403
|
-
declare function
|
|
2404
|
-
type
|
|
2544
|
+
/** @returns {StoresResponseSchema} */
|
|
2545
|
+
declare function StoresResponseSchema(): StoresResponseSchema;
|
|
2546
|
+
type StoresResponseSchema = {
|
|
2405
2547
|
items?: AppInventoryStores[];
|
|
2406
2548
|
page?: Page;
|
|
2407
2549
|
};
|
|
@@ -2450,9 +2592,9 @@ type AppInventoryStores = {
|
|
|
2450
2592
|
address?: any;
|
|
2451
2593
|
integration_type?: any;
|
|
2452
2594
|
};
|
|
2453
|
-
/** @returns {
|
|
2454
|
-
declare function
|
|
2455
|
-
type
|
|
2595
|
+
/** @returns {FilterOrderingStoreRequestSchema} */
|
|
2596
|
+
declare function FilterOrderingStoreRequestSchema(): FilterOrderingStoreRequestSchema;
|
|
2597
|
+
type FilterOrderingStoreRequestSchema = {
|
|
2456
2598
|
/**
|
|
2457
2599
|
* - Allow all stores from the ordering stores
|
|
2458
2600
|
*/
|
|
@@ -2498,9 +2640,9 @@ declare function OrderingStoreConfig(): OrderingStoreConfig;
|
|
|
2498
2640
|
type OrderingStoreConfig = {
|
|
2499
2641
|
deployment_meta?: DeploymentMeta;
|
|
2500
2642
|
};
|
|
2501
|
-
/** @returns {
|
|
2502
|
-
declare function
|
|
2503
|
-
type
|
|
2643
|
+
/** @returns {OrderingStoreSelectRequestSchema} */
|
|
2644
|
+
declare function OrderingStoreSelectRequestSchema(): OrderingStoreSelectRequestSchema;
|
|
2645
|
+
type OrderingStoreSelectRequestSchema = {
|
|
2504
2646
|
ordering_store: OrderingStoreSelect;
|
|
2505
2647
|
};
|
|
2506
2648
|
/** @returns {OrderingStoreSelect} */
|
|
@@ -2556,9 +2698,9 @@ type OtherSellerApplications = {
|
|
|
2556
2698
|
items?: OtherSellerApplication[];
|
|
2557
2699
|
page?: Page;
|
|
2558
2700
|
};
|
|
2559
|
-
/** @returns {
|
|
2560
|
-
declare function
|
|
2561
|
-
type
|
|
2701
|
+
/** @returns {OptedApplicationResponseSchema} */
|
|
2702
|
+
declare function OptedApplicationResponseSchema(): OptedApplicationResponseSchema;
|
|
2703
|
+
type OptedApplicationResponseSchema = {
|
|
2562
2704
|
/**
|
|
2563
2705
|
* - Name of the other seller's sales channel
|
|
2564
2706
|
*/
|
|
@@ -2670,9 +2812,9 @@ type OptOutInventory = {
|
|
|
2670
2812
|
*/
|
|
2671
2813
|
company: number[];
|
|
2672
2814
|
};
|
|
2673
|
-
/** @returns {
|
|
2674
|
-
declare function
|
|
2675
|
-
type
|
|
2815
|
+
/** @returns {TokenResponseSchema} */
|
|
2816
|
+
declare function TokenResponseSchema(): TokenResponseSchema;
|
|
2817
|
+
type TokenResponseSchema = {
|
|
2676
2818
|
tokens?: Tokens;
|
|
2677
2819
|
/**
|
|
2678
2820
|
* - The unique identifier (24-digit Mongo Object ID)
|
|
@@ -3234,14 +3376,14 @@ type OrderFeature = {
|
|
|
3234
3376
|
*/
|
|
3235
3377
|
buy_again?: boolean;
|
|
3236
3378
|
};
|
|
3237
|
-
/** @returns {
|
|
3238
|
-
declare function
|
|
3239
|
-
type
|
|
3379
|
+
/** @returns {AppFeatureRequestSchema} */
|
|
3380
|
+
declare function AppFeatureRequestSchema(): AppFeatureRequestSchema;
|
|
3381
|
+
type AppFeatureRequestSchema = {
|
|
3240
3382
|
feature?: AppFeature;
|
|
3241
3383
|
};
|
|
3242
|
-
/** @returns {
|
|
3243
|
-
declare function
|
|
3244
|
-
type
|
|
3384
|
+
/** @returns {AppFeatureResponseSchema} */
|
|
3385
|
+
declare function AppFeatureResponseSchema(): AppFeatureResponseSchema;
|
|
3386
|
+
type AppFeatureResponseSchema = {
|
|
3245
3387
|
feature?: AppFeature;
|
|
3246
3388
|
};
|
|
3247
3389
|
/** @returns {Currency} */
|
|
@@ -3541,9 +3683,9 @@ type TokenSchema = {
|
|
|
3541
3683
|
*/
|
|
3542
3684
|
created_at?: string;
|
|
3543
3685
|
};
|
|
3544
|
-
/** @returns {
|
|
3545
|
-
declare function
|
|
3546
|
-
type
|
|
3686
|
+
/** @returns {InvalidPayloadRequestSchema} */
|
|
3687
|
+
declare function InvalidPayloadRequestSchema(): InvalidPayloadRequestSchema;
|
|
3688
|
+
type InvalidPayloadRequestSchema = {
|
|
3547
3689
|
/**
|
|
3548
3690
|
* - Error message when request body payload is improper
|
|
3549
3691
|
*/
|
|
@@ -3918,14 +4060,14 @@ type ApplicationDetail = {
|
|
|
3918
4060
|
slug?: string;
|
|
3919
4061
|
company_id?: number;
|
|
3920
4062
|
};
|
|
3921
|
-
/** @returns {
|
|
3922
|
-
declare function
|
|
3923
|
-
type
|
|
4063
|
+
/** @returns {CurrenciesResponseSchema} */
|
|
4064
|
+
declare function CurrenciesResponseSchema(): CurrenciesResponseSchema;
|
|
4065
|
+
type CurrenciesResponseSchema = {
|
|
3924
4066
|
items?: Currency[];
|
|
3925
4067
|
};
|
|
3926
|
-
/** @returns {
|
|
3927
|
-
declare function
|
|
3928
|
-
type
|
|
4068
|
+
/** @returns {AppCurrencyResponseSchema} */
|
|
4069
|
+
declare function AppCurrencyResponseSchema(): AppCurrencyResponseSchema;
|
|
4070
|
+
type AppCurrencyResponseSchema = {
|
|
3929
4071
|
/**
|
|
3930
4072
|
* - The unique identifier (24-digit Mongo Object ID)
|
|
3931
4073
|
* of the currency configuration supported by the application
|
|
@@ -4073,9 +4215,26 @@ type OrderingStores = {
|
|
|
4073
4215
|
*/
|
|
4074
4216
|
__v?: number;
|
|
4075
4217
|
};
|
|
4076
|
-
/** @returns {
|
|
4077
|
-
declare function
|
|
4078
|
-
type
|
|
4218
|
+
/** @returns {OrderingStoresResponseSchema} */
|
|
4219
|
+
declare function OrderingStoresResponseSchema(): OrderingStoresResponseSchema;
|
|
4220
|
+
type OrderingStoresResponseSchema = {
|
|
4079
4221
|
page?: Page;
|
|
4080
4222
|
items?: OrderingStore[];
|
|
4081
4223
|
};
|
|
4224
|
+
/** @returns {ValidationErrors} */
|
|
4225
|
+
declare function ValidationErrors(): ValidationErrors;
|
|
4226
|
+
type ValidationErrors = {
|
|
4227
|
+
errors: ValidationError[];
|
|
4228
|
+
};
|
|
4229
|
+
/** @returns {ValidationError} */
|
|
4230
|
+
declare function ValidationError(): ValidationError;
|
|
4231
|
+
type ValidationError = {
|
|
4232
|
+
/**
|
|
4233
|
+
* - A brief description of the error encountered.
|
|
4234
|
+
*/
|
|
4235
|
+
message: string;
|
|
4236
|
+
/**
|
|
4237
|
+
* - The field in the request that caused the error.
|
|
4238
|
+
*/
|
|
4239
|
+
field: string;
|
|
4240
|
+
};
|