@gofynd/fdk-client-javascript 1.1.6 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +12 -0
- package/index.js +0 -3
- package/package.json +1 -1
- package/sdk/application/ApplicationAPIClient.d.ts +15 -1
- package/sdk/application/ApplicationAPIClient.js +8 -1
- package/sdk/application/ApplicationClient.d.ts +37 -6
- package/sdk/application/ApplicationClient.js +31 -0
- package/sdk/application/ApplicationConfig.d.ts +52 -12
- package/sdk/application/ApplicationConfig.js +37 -2
- package/sdk/application/ApplicationModels.d.ts +46 -1
- package/sdk/application/ApplicationModels.js +18 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +172 -357
- package/sdk/application/Cart/CartApplicationClient.js +620 -483
- package/sdk/application/Cart/CartApplicationModel.d.ts +2054 -96
- package/sdk/application/Cart/CartApplicationModel.js +1224 -93
- package/sdk/application/Cart/CartApplicationValidator.d.ts +508 -30
- package/sdk/application/Cart/CartApplicationValidator.js +270 -15
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +234 -413
- package/sdk/application/Catalog/CatalogApplicationClient.js +777 -630
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2218 -117
- package/sdk/application/Catalog/CatalogApplicationModel.js +1499 -170
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +798 -31
- package/sdk/application/Catalog/CatalogApplicationValidator.js +318 -3
- package/sdk/application/Common/CommonApplicationClient.d.ts +14 -21
- package/sdk/application/Common/CommonApplicationClient.js +50 -33
- package/sdk/application/Common/CommonApplicationModel.d.ts +448 -19
- package/sdk/application/Common/CommonApplicationModel.js +224 -16
- package/sdk/application/Common/CommonApplicationValidator.d.ts +42 -4
- package/sdk/application/Common/CommonApplicationValidator.js +21 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +25 -18
- package/sdk/application/Communication/CommunicationApplicationClient.js +74 -47
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +190 -14
- package/sdk/application/Communication/CommunicationApplicationModel.js +124 -7
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +27 -4
- package/sdk/application/Communication/CommunicationApplicationValidator.js +21 -5
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +113 -112
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +381 -260
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +2453 -110
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1254 -108
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +160 -8
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +88 -4
- package/sdk/application/Content/ContentApplicationClient.d.ts +120 -138
- package/sdk/application/Content/ContentApplicationClient.js +409 -277
- package/sdk/application/Content/ContentApplicationModel.d.ts +1627 -105
- package/sdk/application/Content/ContentApplicationModel.js +1202 -109
- package/sdk/application/Content/ContentApplicationValidator.d.ts +214 -12
- package/sdk/application/Content/ContentApplicationValidator.js +113 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +20 -29
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +68 -47
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +299 -20
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +209 -16
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +55 -5
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +33 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +50 -53
- package/sdk/application/Lead/LeadApplicationClient.js +169 -103
- package/sdk/application/Lead/LeadApplicationModel.d.ts +1405 -54
- package/sdk/application/Lead/LeadApplicationModel.js +619 -73
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +91 -9
- package/sdk/application/Lead/LeadApplicationValidator.js +51 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +34 -33
- package/sdk/application/Logistic/LogisticApplicationClient.js +110 -73
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +399 -28
- package/sdk/application/Logistic/LogisticApplicationModel.js +293 -24
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +48 -6
- package/sdk/application/Logistic/LogisticApplicationValidator.js +34 -6
- package/sdk/application/Order/OrderApplicationClient.d.ts +81 -133
- package/sdk/application/Order/OrderApplicationClient.js +297 -217
- package/sdk/application/Order/OrderApplicationModel.d.ts +1101 -66
- package/sdk/application/Order/OrderApplicationModel.js +776 -57
- package/sdk/application/Order/OrderApplicationValidator.d.ts +249 -14
- package/sdk/application/Order/OrderApplicationValidator.js +114 -5
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +341 -356
- package/sdk/application/Payment/PaymentApplicationClient.js +1077 -703
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +3125 -99
- package/sdk/application/Payment/PaymentApplicationModel.js +1158 -62
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +494 -41
- package/sdk/application/Payment/PaymentApplicationValidator.js +297 -25
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +178 -350
- package/sdk/application/PosCart/PosCartApplicationClient.js +636 -491
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1823 -89
- package/sdk/application/PosCart/PosCartApplicationModel.js +1117 -85
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +480 -29
- package/sdk/application/PosCart/PosCartApplicationValidator.js +262 -15
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +49 -47
- package/sdk/application/Rewards/RewardsApplicationClient.js +160 -102
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +343 -22
- package/sdk/application/Rewards/RewardsApplicationModel.js +230 -15
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +70 -7
- package/sdk/application/Rewards/RewardsApplicationValidator.js +45 -6
- package/sdk/application/Share/ShareApplicationClient.d.ts +44 -50
- package/sdk/application/Share/ShareApplicationClient.js +165 -97
- package/sdk/application/Share/ShareApplicationModel.d.ts +230 -15
- package/sdk/application/Share/ShareApplicationModel.js +154 -16
- package/sdk/application/Share/ShareApplicationValidator.d.ts +86 -8
- package/sdk/application/Share/ShareApplicationValidator.js +48 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +25 -27
- package/sdk/application/Theme/ThemeApplicationClient.js +83 -54
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +621 -48
- package/sdk/application/Theme/ThemeApplicationModel.js +464 -40
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +49 -5
- package/sdk/application/Theme/ThemeApplicationValidator.js +26 -3
- package/sdk/application/User/UserApplicationClient.d.ts +219 -303
- package/sdk/application/User/UserApplicationClient.js +819 -522
- package/sdk/application/User/UserApplicationModel.d.ts +1390 -101
- package/sdk/application/User/UserApplicationModel.js +983 -44
- package/sdk/application/User/UserApplicationValidator.d.ts +457 -33
- package/sdk/application/User/UserApplicationValidator.js +265 -31
- package/sdk/common/AxiosHelper.js +8 -2
- package/sdk/common/Paginator.d.ts +27 -12
- package/sdk/common/Paginator.js +15 -0
- package/sdk/common/RequestSigner.js +0 -1
- package/sdk/partner/PartnerAPIClient.d.ts +15 -1
- package/sdk/partner/PartnerAPIClient.js +8 -1
- package/sdk/partner/PartnerClient.d.ts +20 -3
- package/sdk/partner/PartnerClient.js +17 -0
- package/sdk/partner/PartnerConfig.d.ts +40 -14
- package/sdk/partner/PartnerConfig.js +31 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +26 -25
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +82 -53
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +202 -17
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +139 -10
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +42 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +26 -4
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +88 -97
- package/sdk/platform/Billing/BillingPlatformClient.js +310 -191
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +1211 -68
- package/sdk/platform/Billing/BillingPlatformModel.js +824 -59
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +153 -12
- package/sdk/platform/Billing/BillingPlatformValidator.js +87 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +392 -634
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1480 -957
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +827 -57
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +492 -34
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3639 -175
- package/sdk/platform/Cart/CartPlatformModel.js +2368 -212
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +438 -615
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1449 -984
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1081 -49
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +482 -23
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +573 -824
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1773 -1264
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6871 -326
- package/sdk/platform/Catalog/CatalogPlatformModel.js +4215 -349
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1331 -71
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +611 -30
- package/sdk/platform/Common/CommonPlatformClient.d.ts +14 -21
- package/sdk/platform/Common/CommonPlatformClient.js +48 -33
- package/sdk/platform/Common/CommonPlatformModel.d.ts +448 -19
- package/sdk/platform/Common/CommonPlatformModel.js +224 -16
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +42 -4
- package/sdk/platform/Common/CommonPlatformValidator.js +21 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +457 -279
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1423 -553
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +581 -42
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +294 -22
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +18 -5
- package/sdk/platform/Communication/CommunicationPlatformClient.js +58 -19
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1630 -102
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1150 -85
- package/sdk/platform/Communication/CommunicationPlatformValidator.d.ts +16 -3
- package/sdk/platform/Communication/CommunicationPlatformValidator.js +11 -3
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +102 -111
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +321 -225
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +830 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +612 -78
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +180 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +98 -10
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +232 -212
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +737 -438
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +293 -22
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +184 -17
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +166 -178
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +519 -310
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +4504 -188
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2242 -204
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +332 -19
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +153 -10
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +495 -560
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1777 -987
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +872 -62
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +487 -35
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1661 -108
- package/sdk/platform/Content/ContentPlatformModel.js +1217 -113
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +67 -101
- package/sdk/platform/Discount/DiscountPlatformClient.js +240 -176
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +242 -15
- package/sdk/platform/Discount/DiscountPlatformModel.js +162 -10
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +185 -13
- package/sdk/platform/Discount/DiscountPlatformValidator.js +88 -8
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +32 -41
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +106 -74
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +77 -6
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +41 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +39 -54
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +124 -99
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +299 -20
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +207 -16
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +98 -8
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +54 -7
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +85 -91
- package/sdk/platform/Finance/FinancePlatformClient.js +272 -180
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +619 -50
- package/sdk/platform/Finance/FinancePlatformModel.js +458 -30
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +123 -15
- package/sdk/platform/Finance/FinancePlatformValidator.js +95 -16
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +99 -97
- package/sdk/platform/Inventory/InventoryPlatformClient.js +288 -199
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +1354 -61
- package/sdk/platform/Inventory/InventoryPlatformModel.js +916 -83
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +168 -12
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +82 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +86 -106
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +326 -186
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +180 -14
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +94 -9
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +75 -101
- package/sdk/platform/Lead/LeadPlatformClient.js +240 -174
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +1403 -54
- package/sdk/platform/Lead/LeadPlatformModel.js +618 -73
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +173 -12
- package/sdk/platform/Lead/LeadPlatformValidator.js +85 -8
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +18 -14
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +56 -29
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +26 -4
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
- package/sdk/platform/Order/OrderPlatformClient.d.ts +343 -556
- package/sdk/platform/Order/OrderPlatformClient.js +969 -762
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4967 -247
- package/sdk/platform/Order/OrderPlatformModel.js +3249 -259
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +758 -37
- package/sdk/platform/Order/OrderPlatformValidator.js +351 -22
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +28 -36
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +103 -59
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +66 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +32 -4
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +68 -107
- package/sdk/platform/Partner/PartnerPlatformClient.js +253 -174
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +767 -45
- package/sdk/platform/Partner/PartnerPlatformModel.js +524 -41
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +207 -13
- package/sdk/platform/Partner/PartnerPlatformValidator.js +87 -5
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +255 -260
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +860 -504
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +348 -30
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +221 -19
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +73 -73
- package/sdk/platform/Payment/PaymentPlatformClient.js +238 -154
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2658 -93
- package/sdk/platform/Payment/PaymentPlatformModel.js +1035 -36
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +111 -11
- package/sdk/platform/Payment/PaymentPlatformValidator.js +68 -7
- package/sdk/platform/PlatformAPIClient.d.ts +16 -1
- package/sdk/platform/PlatformAPIClient.js +9 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +22 -1798
- package/sdk/platform/PlatformApplicationClient.js +17 -1899
- package/sdk/platform/PlatformClient.d.ts +29 -12579
- package/sdk/platform/PlatformClient.js +26 -15085
- package/sdk/platform/PlatformConfig.d.ts +37 -11
- package/sdk/platform/PlatformConfig.js +32 -6
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +80 -92
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +307 -177
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +149 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +82 -8
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +371 -23
- package/sdk/platform/Rewards/RewardsPlatformModel.js +246 -16
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +120 -89
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +349 -201
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +128 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +85 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +148 -178
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +454 -329
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1399 -96
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1022 -71
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +280 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -11
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +38 -47
- package/sdk/platform/Share/SharePlatformApplicationClient.js +137 -73
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +87 -7
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +42 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +250 -16
- package/sdk/platform/Share/SharePlatformModel.js +165 -17
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +149 -183
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +579 -330
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +308 -24
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +162 -10
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +621 -48
- package/sdk/platform/Theme/ThemePlatformModel.js +464 -40
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +119 -151
- package/sdk/platform/User/UserPlatformApplicationClient.js +411 -244
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +235 -18
- package/sdk/platform/User/UserPlatformApplicationValidator.js +126 -12
- package/sdk/platform/User/UserPlatformModel.d.ts +1390 -101
- package/sdk/platform/User/UserPlatformModel.js +983 -44
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +38 -47
- package/sdk/platform/Webhook/WebhookPlatformClient.js +137 -87
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +242 -16
- package/sdk/platform/Webhook/WebhookPlatformModel.js +167 -18
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +83 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +43 -5
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +14 -21
- package/sdk/public/Configuration/ConfigurationPublicClient.js +46 -33
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +473 -19
- package/sdk/public/Configuration/ConfigurationPublicModel.js +224 -16
- package/sdk/public/Configuration/ConfigurationPublicValidator.d.ts +42 -4
- package/sdk/public/Configuration/ConfigurationPublicValidator.js +21 -3
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +48 -48
- package/sdk/public/Inventory/InventoryPublicClient.js +146 -98
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +392 -21
- package/sdk/public/Inventory/InventoryPublicModel.js +267 -27
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +90 -8
- package/sdk/public/Inventory/InventoryPublicValidator.js +44 -4
- package/sdk/public/PublicClient.d.ts +19 -3
- package/sdk/public/PublicClient.js +16 -0
- package/sdk/public/PublicConfig.d.ts +27 -6
- package/sdk/public/PublicConfig.js +17 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -11
- package/sdk/public/Webhook/WebhookPublicClient.js +42 -27
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +242 -16
- package/sdk/public/Webhook/WebhookPublicModel.js +167 -18
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +18 -3
- package/sdk/public/Webhook/WebhookPublicValidator.js +14 -4
|
@@ -1,118 +1,2219 @@
|
|
|
1
|
-
export =
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
1
|
+
export = CatalogApplicationModel;
|
|
2
|
+
/**
|
|
3
|
+
* @typedef ApplicationItemMOQ
|
|
4
|
+
* @property {number} [increment_unit] - The minimum quantity increment in which
|
|
5
|
+
* the item can be purchased.
|
|
6
|
+
* @property {number} [maximum] - The maximum quantity allowed for purchase.
|
|
7
|
+
* @property {number} [minimum] - The minimum quantity required for purchase.
|
|
8
|
+
*/
|
|
9
|
+
/**
|
|
10
|
+
* @typedef ApplicationItemSEO
|
|
11
|
+
* @property {Object} [description] - The SEO description of the item
|
|
12
|
+
* @property {Object} [title] - The SEO title of the item
|
|
13
|
+
*/
|
|
14
|
+
/**
|
|
15
|
+
* @typedef ApplicationStoreListing
|
|
16
|
+
* @property {Object[]} [filters]
|
|
17
|
+
* @property {AppStore[]} [items]
|
|
18
|
+
* @property {Page} [page]
|
|
19
|
+
*/
|
|
20
|
+
/**
|
|
21
|
+
* @typedef AppStore
|
|
22
|
+
* @property {StoreAddressSerializer} [address]
|
|
23
|
+
* @property {CompanyStore} [company]
|
|
24
|
+
* @property {SellerPhoneNumber[]} [contact_numbers]
|
|
25
|
+
* @property {StoreDepartments[]} [departments]
|
|
26
|
+
* @property {StoreManagerSerializer} [manager]
|
|
27
|
+
* @property {string} [name]
|
|
28
|
+
* @property {string} [store_code]
|
|
29
|
+
* @property {number} [uid]
|
|
30
|
+
*/
|
|
31
|
+
/**
|
|
32
|
+
* @typedef ArticleAssignmentV3
|
|
33
|
+
* @property {string} [level]
|
|
34
|
+
* @property {string} [strategy]
|
|
35
|
+
*/
|
|
36
|
+
/**
|
|
37
|
+
* @typedef AttributeDetail
|
|
38
|
+
* @property {string} [description]
|
|
39
|
+
* @property {string} [display]
|
|
40
|
+
* @property {string} [key]
|
|
41
|
+
* @property {string} [logo]
|
|
42
|
+
*/
|
|
43
|
+
/**
|
|
44
|
+
* @typedef AttributeMetadata
|
|
45
|
+
* @property {AttributeDetail[]} [details]
|
|
46
|
+
* @property {string} [title]
|
|
47
|
+
*/
|
|
48
|
+
/**
|
|
49
|
+
* @typedef AutocompleteItem
|
|
50
|
+
* @property {Object} [_custom_json]
|
|
51
|
+
* @property {ProductListingAction} [action]
|
|
52
|
+
* @property {string} [display]
|
|
53
|
+
* @property {Media} [logo]
|
|
54
|
+
* @property {string} [type]
|
|
55
|
+
*/
|
|
56
|
+
/**
|
|
57
|
+
* @typedef AutoCompleteResponse
|
|
58
|
+
* @property {AutocompleteItem[]} [items]
|
|
59
|
+
*/
|
|
60
|
+
/**
|
|
61
|
+
* @typedef BrandDetailResponse
|
|
62
|
+
* @property {Object} [_custom_json]
|
|
63
|
+
* @property {ImageUrls} [banners]
|
|
64
|
+
* @property {string} [description]
|
|
65
|
+
* @property {Media} [logo]
|
|
66
|
+
* @property {string} [name]
|
|
67
|
+
* @property {number} [uid]
|
|
68
|
+
*/
|
|
69
|
+
/**
|
|
70
|
+
* @typedef BrandItem
|
|
71
|
+
* @property {ProductListingAction} [action]
|
|
72
|
+
* @property {ImageUrls} [banners]
|
|
73
|
+
* @property {string[]} [departments]
|
|
74
|
+
* @property {string} [description]
|
|
75
|
+
* @property {string} [discount]
|
|
76
|
+
* @property {Media} [logo]
|
|
77
|
+
* @property {string} [name]
|
|
78
|
+
* @property {string} [slug]
|
|
79
|
+
* @property {number} [uid]
|
|
80
|
+
*/
|
|
81
|
+
/**
|
|
82
|
+
* @typedef BrandListingResponse
|
|
83
|
+
* @property {BrandItem[]} [items]
|
|
84
|
+
* @property {Page} page
|
|
85
|
+
*/
|
|
86
|
+
/**
|
|
87
|
+
* @typedef CategoryBanner
|
|
88
|
+
* @property {Media} landscape
|
|
89
|
+
* @property {Media} portrait
|
|
90
|
+
*/
|
|
91
|
+
/**
|
|
92
|
+
* @typedef CategoryItems
|
|
93
|
+
* @property {ProductListingAction} action
|
|
94
|
+
* @property {CategoryBanner} banners
|
|
95
|
+
* @property {Child[]} [childs]
|
|
96
|
+
* @property {string} name
|
|
97
|
+
* @property {string} slug
|
|
98
|
+
* @property {number} uid
|
|
99
|
+
*/
|
|
100
|
+
/**
|
|
101
|
+
* @typedef CategoryListingResponse
|
|
102
|
+
* @property {DepartmentCategoryTree[]} [data]
|
|
103
|
+
* @property {DepartmentIdentifier[]} [departments]
|
|
104
|
+
*/
|
|
105
|
+
/**
|
|
106
|
+
* @typedef CategoryMetaResponse
|
|
107
|
+
* @property {Object} [_custom_json]
|
|
108
|
+
* @property {ImageUrls} [banners]
|
|
109
|
+
* @property {Media} [logo]
|
|
110
|
+
* @property {string} [name]
|
|
111
|
+
* @property {number} [uid]
|
|
112
|
+
*/
|
|
113
|
+
/**
|
|
114
|
+
* @typedef Child
|
|
115
|
+
* @property {Object} [_custom_json]
|
|
116
|
+
* @property {ProductListingAction} [action]
|
|
117
|
+
* @property {ImageUrls} [banners]
|
|
118
|
+
* @property {SecondLevelChild[]} [childs]
|
|
119
|
+
* @property {string} [name]
|
|
120
|
+
* @property {string} [slug]
|
|
121
|
+
* @property {number} [uid]
|
|
122
|
+
*/
|
|
123
|
+
/**
|
|
124
|
+
* @typedef CollectionDetailResponse
|
|
125
|
+
* @property {Object} [_custom_json]
|
|
126
|
+
* @property {Object} [_schedule]
|
|
127
|
+
* @property {boolean} [allow_facets]
|
|
128
|
+
* @property {boolean} [allow_sort]
|
|
129
|
+
* @property {string} [app_id]
|
|
130
|
+
* @property {Object} [badge]
|
|
131
|
+
* @property {ImageUrls} [banners]
|
|
132
|
+
* @property {Object} [cron]
|
|
133
|
+
* @property {string} [description]
|
|
134
|
+
* @property {boolean} [is_active]
|
|
135
|
+
* @property {Media} [logo]
|
|
136
|
+
* @property {Object} [meta]
|
|
137
|
+
* @property {string} [name]
|
|
138
|
+
* @property {number} [priority]
|
|
139
|
+
* @property {CollectionQuery[]} [query]
|
|
140
|
+
* @property {string} [slug]
|
|
141
|
+
* @property {string} [sort_on]
|
|
142
|
+
* @property {string[]} [tag]
|
|
143
|
+
* @property {string} [type]
|
|
144
|
+
* @property {string[]} [visible_facets_keys]
|
|
145
|
+
*/
|
|
146
|
+
/**
|
|
147
|
+
* @typedef CollectionListingFilter
|
|
148
|
+
* @property {CollectionListingFilterTag[]} [tags]
|
|
149
|
+
* @property {CollectionListingFilterType[]} [type]
|
|
150
|
+
*/
|
|
151
|
+
/**
|
|
152
|
+
* @typedef CollectionListingFilterTag
|
|
153
|
+
* @property {string} [display]
|
|
154
|
+
* @property {boolean} [is_selected]
|
|
155
|
+
* @property {string} [name]
|
|
156
|
+
*/
|
|
157
|
+
/**
|
|
158
|
+
* @typedef CollectionListingFilterType
|
|
159
|
+
* @property {string} [display]
|
|
160
|
+
* @property {boolean} [is_selected]
|
|
161
|
+
* @property {string} [name]
|
|
162
|
+
*/
|
|
163
|
+
/**
|
|
164
|
+
* @typedef CollectionQuery
|
|
165
|
+
* @property {string} attribute
|
|
166
|
+
* @property {string} op
|
|
167
|
+
* @property {Object[]} value
|
|
168
|
+
*/
|
|
169
|
+
/**
|
|
170
|
+
* @typedef ColumnHeader
|
|
171
|
+
* @property {boolean} [convertable]
|
|
172
|
+
* @property {string} [value]
|
|
173
|
+
*/
|
|
174
|
+
/**
|
|
175
|
+
* @typedef ColumnHeaders
|
|
176
|
+
* @property {ColumnHeader} [col_1]
|
|
177
|
+
* @property {ColumnHeader} [col_2]
|
|
178
|
+
* @property {ColumnHeader} [col_3]
|
|
179
|
+
* @property {ColumnHeader} [col_4]
|
|
180
|
+
* @property {ColumnHeader} [col_5]
|
|
181
|
+
* @property {ColumnHeader} [col_6]
|
|
182
|
+
*/
|
|
183
|
+
/**
|
|
184
|
+
* @typedef CompanyDetail
|
|
185
|
+
* @property {number} [id]
|
|
186
|
+
* @property {string} [name]
|
|
187
|
+
*/
|
|
188
|
+
/**
|
|
189
|
+
* @typedef CompanyStore
|
|
190
|
+
* @property {string} [business_type]
|
|
191
|
+
* @property {string} [company_type]
|
|
192
|
+
* @property {string} [name]
|
|
193
|
+
* @property {number} [uid]
|
|
194
|
+
*/
|
|
195
|
+
/**
|
|
196
|
+
* @typedef CustomMetaFields
|
|
197
|
+
* @property {string} key - A key to store a custom field.
|
|
198
|
+
* @property {string} value - A value to store in the custom field.
|
|
199
|
+
*/
|
|
200
|
+
/**
|
|
201
|
+
* @typedef Department
|
|
202
|
+
* @property {Media} [logo]
|
|
203
|
+
* @property {string} [name]
|
|
204
|
+
* @property {number} [priority_order]
|
|
205
|
+
* @property {string} [slug]
|
|
206
|
+
* @property {number} [uid]
|
|
207
|
+
*/
|
|
208
|
+
/**
|
|
209
|
+
* @typedef DepartmentCategoryTree
|
|
210
|
+
* @property {string} department
|
|
211
|
+
* @property {CategoryItems[]} [items]
|
|
212
|
+
*/
|
|
213
|
+
/**
|
|
214
|
+
* @typedef DepartmentIdentifier
|
|
215
|
+
* @property {string} [slug]
|
|
216
|
+
* @property {number} [uid]
|
|
217
|
+
*/
|
|
218
|
+
/**
|
|
219
|
+
* @typedef DepartmentResponse
|
|
220
|
+
* @property {Department[]} [items]
|
|
221
|
+
*/
|
|
222
|
+
/**
|
|
223
|
+
* @typedef DetailsSchemaV3
|
|
224
|
+
* @property {string} [key]
|
|
225
|
+
* @property {string} [type]
|
|
226
|
+
* @property {string} [value]
|
|
227
|
+
*/
|
|
228
|
+
/**
|
|
229
|
+
* @typedef Dimension
|
|
230
|
+
* @property {number} height - The height of the product
|
|
231
|
+
* @property {boolean} is_default - Whether the dimension is the default one or not
|
|
232
|
+
* @property {number} length - The length of the product
|
|
233
|
+
* @property {string} unit - The unit of dimension
|
|
234
|
+
* @property {number} width - The width of the product
|
|
235
|
+
*/
|
|
236
|
+
/**
|
|
237
|
+
* @typedef ErrorResponse
|
|
238
|
+
* @property {string} [error]
|
|
239
|
+
*/
|
|
240
|
+
/**
|
|
241
|
+
* @typedef FollowerCountResponse
|
|
242
|
+
* @property {number} [count]
|
|
243
|
+
*/
|
|
244
|
+
/**
|
|
245
|
+
* @typedef FollowIdsData
|
|
246
|
+
* @property {number[]} [brands]
|
|
247
|
+
* @property {number[]} [collections]
|
|
248
|
+
* @property {number[]} [products]
|
|
249
|
+
*/
|
|
250
|
+
/**
|
|
251
|
+
* @typedef FollowIdsResponse
|
|
252
|
+
* @property {FollowIdsData} [data]
|
|
253
|
+
*/
|
|
254
|
+
/**
|
|
255
|
+
* @typedef FollowPostResponse
|
|
256
|
+
* @property {string} id
|
|
257
|
+
* @property {string} message
|
|
258
|
+
*/
|
|
259
|
+
/**
|
|
260
|
+
* @typedef GetCollectionDetailNest
|
|
261
|
+
* @property {Object} [_custom_json]
|
|
262
|
+
* @property {Object} [_schedule]
|
|
263
|
+
* @property {ProductListingAction} [action]
|
|
264
|
+
* @property {boolean} [allow_facets]
|
|
265
|
+
* @property {boolean} [allow_sort]
|
|
266
|
+
* @property {string} [app_id]
|
|
267
|
+
* @property {Object} [badge]
|
|
268
|
+
* @property {ImageUrls} [banners]
|
|
269
|
+
* @property {Object} [cron]
|
|
270
|
+
* @property {string} [description]
|
|
271
|
+
* @property {boolean} [is_active]
|
|
272
|
+
* @property {Media} [logo]
|
|
273
|
+
* @property {Object} [meta]
|
|
274
|
+
* @property {string} [name]
|
|
275
|
+
* @property {number} [priority]
|
|
276
|
+
* @property {CollectionQuery[]} [query]
|
|
277
|
+
* @property {string} [slug]
|
|
278
|
+
* @property {string} [sort_on]
|
|
279
|
+
* @property {string[]} [tag]
|
|
280
|
+
* @property {string} [type]
|
|
281
|
+
* @property {string} [uid]
|
|
282
|
+
* @property {string[]} [visible_facets_keys]
|
|
283
|
+
*/
|
|
284
|
+
/**
|
|
285
|
+
* @typedef GetCollectionListingResponse
|
|
286
|
+
* @property {CollectionListingFilter} [filters]
|
|
287
|
+
* @property {GetCollectionDetailNest[]} [items]
|
|
288
|
+
* @property {Page} page
|
|
289
|
+
*/
|
|
290
|
+
/**
|
|
291
|
+
* @typedef GetFollowListingResponse
|
|
292
|
+
* @property {ProductListingDetail[]} items
|
|
293
|
+
* @property {Page} page
|
|
294
|
+
*/
|
|
295
|
+
/**
|
|
296
|
+
* @typedef HomeListingResponse
|
|
297
|
+
* @property {ProductListingDetail[]} [items]
|
|
298
|
+
* @property {string} [message]
|
|
299
|
+
* @property {Page} page
|
|
300
|
+
*/
|
|
301
|
+
/**
|
|
302
|
+
* @typedef ImageUrls
|
|
303
|
+
* @property {Media} [landscape]
|
|
304
|
+
* @property {Media} [portrait]
|
|
305
|
+
*/
|
|
306
|
+
/**
|
|
307
|
+
* @typedef LatLong
|
|
308
|
+
* @property {number[]} [coordinates]
|
|
309
|
+
* @property {string} [type]
|
|
310
|
+
*/
|
|
311
|
+
/**
|
|
312
|
+
* @typedef MarketPlaceSttributesSchemaV3
|
|
313
|
+
* @property {DetailsSchemaV3[]} [details]
|
|
314
|
+
* @property {string} [title]
|
|
315
|
+
*/
|
|
316
|
+
/**
|
|
317
|
+
* @typedef Media
|
|
318
|
+
* @property {string} [alt]
|
|
319
|
+
* @property {Meta} [meta]
|
|
320
|
+
* @property {string} [type]
|
|
321
|
+
* @property {string} [url]
|
|
322
|
+
*/
|
|
323
|
+
/**
|
|
324
|
+
* @typedef Meta
|
|
325
|
+
* @property {string} [source]
|
|
326
|
+
*/
|
|
327
|
+
/**
|
|
328
|
+
* @typedef NetQuantity
|
|
329
|
+
* @property {Object} [unit] - The unit of measurement used for the net quantity
|
|
330
|
+
* of the product.
|
|
331
|
+
* @property {number} [value] - The value of the net quantity of the product.
|
|
332
|
+
*/
|
|
333
|
+
/**
|
|
334
|
+
* @typedef Page
|
|
335
|
+
* @property {number} [current]
|
|
336
|
+
* @property {boolean} [has_next]
|
|
337
|
+
* @property {boolean} [has_previous]
|
|
338
|
+
* @property {number} [item_total]
|
|
339
|
+
* @property {string} [next_id]
|
|
340
|
+
* @property {number} [size]
|
|
341
|
+
* @property {string} type
|
|
342
|
+
*/
|
|
343
|
+
/**
|
|
344
|
+
* @typedef Price
|
|
345
|
+
* @property {string} [currency_code]
|
|
346
|
+
* @property {string} [currency_symbol]
|
|
347
|
+
* @property {number} [max]
|
|
348
|
+
* @property {number} [min]
|
|
349
|
+
*/
|
|
350
|
+
/**
|
|
351
|
+
* @typedef ProductBrand
|
|
352
|
+
* @property {ProductListingAction} [action]
|
|
353
|
+
* @property {string} [description]
|
|
354
|
+
* @property {Media} [logo]
|
|
355
|
+
* @property {string} [name]
|
|
356
|
+
* @property {number} [uid]
|
|
357
|
+
*/
|
|
358
|
+
/**
|
|
359
|
+
* @typedef ProductBundle
|
|
360
|
+
* @property {ProductGroupingModel[]} [items]
|
|
361
|
+
*/
|
|
362
|
+
/**
|
|
363
|
+
* @typedef ProductCategoryMap
|
|
364
|
+
* @property {ProductBrand} [l1]
|
|
365
|
+
* @property {ProductBrand} [l2]
|
|
366
|
+
* @property {ProductBrand} [l3]
|
|
367
|
+
*/
|
|
368
|
+
/**
|
|
369
|
+
* @typedef ProductCompareResponse
|
|
370
|
+
* @property {AttributeMetadata[]} [attributes_metadata]
|
|
371
|
+
* @property {ProductDetail[]} [items]
|
|
372
|
+
* @property {string} [subtitle]
|
|
373
|
+
* @property {string} [title]
|
|
374
|
+
*/
|
|
375
|
+
/**
|
|
376
|
+
* @typedef ProductDetail
|
|
377
|
+
* @property {Object} [_custom_json]
|
|
378
|
+
* @property {CustomMetaFields[]} [_custom_meta]
|
|
379
|
+
* @property {ProductListingAction} [action]
|
|
380
|
+
* @property {Object} [attributes]
|
|
381
|
+
* @property {ProductBrand} [brand]
|
|
382
|
+
* @property {ProductBrand[]} [categories]
|
|
383
|
+
* @property {ProductCategoryMap} [category_map]
|
|
384
|
+
* @property {string} [color]
|
|
385
|
+
* @property {ProductDetailCustomOrder} [custom_order]
|
|
386
|
+
* @property {string} [description]
|
|
387
|
+
* @property {string} [discount]
|
|
388
|
+
* @property {ProductDetailGroupedAttribute[]} [grouped_attributes]
|
|
389
|
+
* @property {boolean} [has_variant]
|
|
390
|
+
* @property {string[]} [highlights]
|
|
391
|
+
* @property {string} [image_nature]
|
|
392
|
+
* @property {boolean} [is_dependent]
|
|
393
|
+
* @property {string} [item_code]
|
|
394
|
+
* @property {string} [item_type]
|
|
395
|
+
* @property {Media[]} [medias]
|
|
396
|
+
* @property {ApplicationItemMOQ} [moq]
|
|
397
|
+
* @property {string} [name]
|
|
398
|
+
* @property {NetQuantity} [net_quantity]
|
|
399
|
+
* @property {ProductListingPrice} [price]
|
|
400
|
+
* @property {string[]} [product_group_tag]
|
|
401
|
+
* @property {string} [product_online_date]
|
|
402
|
+
* @property {number} [rating]
|
|
403
|
+
* @property {number} [rating_count]
|
|
404
|
+
* @property {ApplicationItemSEO} [seo]
|
|
405
|
+
* @property {string} [short_description]
|
|
406
|
+
* @property {string[]} [similars]
|
|
407
|
+
* @property {string} slug
|
|
408
|
+
* @property {string[]} [tags]
|
|
409
|
+
* @property {string} [teaser_tag]
|
|
410
|
+
* @property {string[]} [tryouts]
|
|
411
|
+
* @property {string} [type]
|
|
412
|
+
* @property {number} [uid]
|
|
413
|
+
*/
|
|
414
|
+
/**
|
|
415
|
+
* @typedef ProductDetailAttribute
|
|
416
|
+
* @property {string} [key]
|
|
417
|
+
* @property {string} [type]
|
|
418
|
+
* @property {string} [value]
|
|
419
|
+
*/
|
|
420
|
+
/**
|
|
421
|
+
* @typedef ProductDetailCustomOrder
|
|
422
|
+
* @property {boolean} [is_custom_order]
|
|
423
|
+
* @property {number} [manufacturing_time]
|
|
424
|
+
* @property {string} [manufacturing_time_unit]
|
|
425
|
+
*/
|
|
426
|
+
/**
|
|
427
|
+
* @typedef ProductDetailGroupedAttribute
|
|
428
|
+
* @property {ProductDetailAttribute[]} [details]
|
|
429
|
+
* @property {string} [title]
|
|
430
|
+
*/
|
|
431
|
+
/**
|
|
432
|
+
* @typedef ProductDetails
|
|
433
|
+
* @property {Object} [attributes] - A dictionary of product attributes
|
|
434
|
+
* @property {number} [brand_uid] - The unique ID of the product's brand
|
|
435
|
+
* @property {Object} [country_of_origin] - The country of origin for the product
|
|
436
|
+
* @property {Object} [description] - The long description of the product
|
|
437
|
+
* @property {Object} [grouped_attributes] - A dictionary of grouped product attributes
|
|
438
|
+
* @property {boolean} [has_variant] - Whether or not the product has a variant
|
|
439
|
+
* @property {Object[]} [highlights] - A list of highlights for the product
|
|
440
|
+
* @property {number} [hsn_code] - The HSN code of the product
|
|
441
|
+
* @property {Object} [identifier] - A dictionary of product identifiers
|
|
442
|
+
* @property {Object} [image_nature] - The nature of the product's images
|
|
443
|
+
* @property {Object[]} [images] - A list of image URLs for the product
|
|
444
|
+
* @property {boolean} [is_set] - Whether or not the product is a set of items
|
|
445
|
+
* @property {Object} [item_code] - The item code of the product
|
|
446
|
+
* @property {Object[]} [media] - A list of media objects for the product
|
|
447
|
+
* @property {Object} [name] - The name of the product
|
|
448
|
+
* @property {boolean} [out_of_stock] - Whether or not the product is out of stock
|
|
449
|
+
* @property {number} [rating] - The rating of the product
|
|
450
|
+
* @property {number} [rating_count] - The number of ratings the product has received
|
|
451
|
+
* @property {Object} [short_description] - The short description of the product
|
|
452
|
+
* @property {Object} [slug] - The slug of the product
|
|
453
|
+
* @property {Object} [template_tag] - The template tag of the product
|
|
454
|
+
*/
|
|
455
|
+
/**
|
|
456
|
+
* @typedef ProductFilters
|
|
457
|
+
* @property {ProductFiltersKey} key
|
|
458
|
+
* @property {ProductFiltersValue[]} values
|
|
459
|
+
*/
|
|
460
|
+
/**
|
|
461
|
+
* @typedef ProductFiltersKey
|
|
462
|
+
* @property {string} display
|
|
463
|
+
* @property {string} [kind]
|
|
464
|
+
* @property {string} [logo]
|
|
465
|
+
* @property {string} name
|
|
466
|
+
*/
|
|
467
|
+
/**
|
|
468
|
+
* @typedef ProductFiltersValue
|
|
469
|
+
* @property {number} [count]
|
|
470
|
+
* @property {string} [currency_code]
|
|
471
|
+
* @property {string} [currency_symbol]
|
|
472
|
+
* @property {string} display
|
|
473
|
+
* @property {string} [display_format]
|
|
474
|
+
* @property {boolean} is_selected
|
|
475
|
+
* @property {number} [max]
|
|
476
|
+
* @property {number} [min]
|
|
477
|
+
* @property {string} [query_format]
|
|
478
|
+
* @property {number} [selected_max]
|
|
479
|
+
* @property {number} [selected_min]
|
|
480
|
+
* @property {string} [value]
|
|
481
|
+
*/
|
|
482
|
+
/**
|
|
483
|
+
* @typedef ProductFrequentlyComparedSimilarResponse
|
|
484
|
+
* @property {ProductCompareResponse} [similars]
|
|
485
|
+
*/
|
|
486
|
+
/**
|
|
487
|
+
* @typedef ProductGroupingModel
|
|
488
|
+
* @property {Object} [_id]
|
|
489
|
+
* @property {Object} [choice] - The choice of the product grouping.
|
|
490
|
+
* @property {number} [company_id] - The ID of the company that owns the product grouping.
|
|
491
|
+
* @property {UserDetail} [created_by] - User details of the creator of the document
|
|
492
|
+
* @property {string} created_on - Timestamp of the creation of the document
|
|
493
|
+
* @property {boolean} [is_active] - Whether the product grouping is active.
|
|
494
|
+
* @property {Object} [logo] - The URL for the logo of the product grouping.
|
|
495
|
+
* @property {Object} [meta] - A dictionary containing metadata information.
|
|
496
|
+
* @property {UserDetail} [modified_by] - User details of the last modifier of
|
|
497
|
+
* the document
|
|
498
|
+
* @property {string} modified_on - Timestamp of the last modification of the document
|
|
499
|
+
* @property {Object} name - The name of the product grouping.
|
|
500
|
+
* @property {Object[]} [page_visibility] - A list of page visibilities of the
|
|
501
|
+
* product grouping.
|
|
502
|
+
* @property {ProductInGroup[]} products - A list of products in the grouping.
|
|
503
|
+
* @property {boolean} [same_store_assignment] - Whether the products are
|
|
504
|
+
* assigned to the same store.
|
|
505
|
+
* @property {Object} [slug] - The unique identifier for the product grouping.
|
|
506
|
+
* @property {UserDetail} [verified_by] - User details of the verifier of the
|
|
507
|
+
* document, if applicable
|
|
508
|
+
* @property {string} [verified_on] - Timestamp of when the document was
|
|
509
|
+
* verified, if applicable
|
|
510
|
+
*/
|
|
511
|
+
/**
|
|
512
|
+
* @typedef ProductGroupPrice
|
|
513
|
+
* @property {Object} [currency] - The currency code for the prices.
|
|
514
|
+
* @property {number} [max_effective] - The maximum effective price of the product group.
|
|
515
|
+
* @property {number} [max_marked] - The maximum marked price of the product group.
|
|
516
|
+
* @property {number} [min_effective] - The minimum effective price of the product group.
|
|
517
|
+
* @property {number} [min_marked] - The minimum marked price of the product group.
|
|
518
|
+
*/
|
|
519
|
+
/**
|
|
520
|
+
* @typedef ProductInGroup
|
|
521
|
+
* @property {boolean} [allow_remove] - A flag indicating whether the product
|
|
522
|
+
* can be removed from the cart.
|
|
523
|
+
* @property {boolean} [auto_add_to_cart] - A flag indicating whether the
|
|
524
|
+
* product should be automatically added to the cart.
|
|
525
|
+
* @property {boolean} [auto_select] - A flag indicating whether the product
|
|
526
|
+
* should be automatically selected.
|
|
527
|
+
* @property {number} max_quantity - The maximum quantity of the product that
|
|
528
|
+
* can be added to the cart.
|
|
529
|
+
* @property {number} [min_quantity] - The minimum quantity of the product that
|
|
530
|
+
* can be added to the cart.
|
|
531
|
+
* @property {ProductGroupPrice} [price] - The price details for the product group.
|
|
532
|
+
* @property {ProductDetails} [product_details] - The details of the product.
|
|
533
|
+
* @property {number} product_uid - The unique ID of the product in the group.
|
|
534
|
+
* @property {Size[]} [sizes] - The available sizes for the product.
|
|
535
|
+
*/
|
|
536
|
+
/**
|
|
537
|
+
* @typedef ProductListingAction
|
|
538
|
+
* @property {ProductListingActionPage} [page]
|
|
539
|
+
* @property {string} [type]
|
|
540
|
+
*/
|
|
541
|
+
/**
|
|
542
|
+
* @typedef ProductListingActionPage
|
|
543
|
+
* @property {Object} [params]
|
|
544
|
+
* @property {Object} [query]
|
|
545
|
+
* @property {string} [type]
|
|
546
|
+
*/
|
|
547
|
+
/**
|
|
548
|
+
* @typedef ProductListingDetail
|
|
549
|
+
* @property {Object} [_custom_json]
|
|
550
|
+
* @property {CustomMetaFields[]} [_custom_meta]
|
|
551
|
+
* @property {ProductListingAction} [action]
|
|
552
|
+
* @property {Object} [attributes]
|
|
553
|
+
* @property {ProductBrand} [brand]
|
|
554
|
+
* @property {ProductBrand[]} [categories]
|
|
555
|
+
* @property {ProductCategoryMap} [category_map]
|
|
556
|
+
* @property {string} [color]
|
|
557
|
+
* @property {ProductDetailCustomOrder} [custom_order]
|
|
558
|
+
* @property {string} [description]
|
|
559
|
+
* @property {string} [discount]
|
|
560
|
+
* @property {ProductDetailGroupedAttribute[]} [grouped_attributes]
|
|
561
|
+
* @property {boolean} [has_variant]
|
|
562
|
+
* @property {string[]} [highlights]
|
|
563
|
+
* @property {string[]} [identifiers]
|
|
564
|
+
* @property {string} [image_nature]
|
|
565
|
+
* @property {boolean} [is_dependent]
|
|
566
|
+
* @property {string} [item_code]
|
|
567
|
+
* @property {string} [item_type]
|
|
568
|
+
* @property {Media[]} [medias]
|
|
569
|
+
* @property {ApplicationItemMOQ} [moq]
|
|
570
|
+
* @property {string} [name]
|
|
571
|
+
* @property {NetQuantity} [net_quantity]
|
|
572
|
+
* @property {ProductListingPrice} [price]
|
|
573
|
+
* @property {string[]} [product_group_tag]
|
|
574
|
+
* @property {string} [product_online_date]
|
|
575
|
+
* @property {number} [rating]
|
|
576
|
+
* @property {number} [rating_count]
|
|
577
|
+
* @property {boolean} [sellable]
|
|
578
|
+
* @property {ApplicationItemSEO} [seo]
|
|
579
|
+
* @property {string} [short_description]
|
|
580
|
+
* @property {string[]} [similars]
|
|
581
|
+
* @property {string[]} [sizes]
|
|
582
|
+
* @property {string} slug
|
|
583
|
+
* @property {string[]} [tags]
|
|
584
|
+
* @property {string} [teaser_tag]
|
|
585
|
+
* @property {string[]} [tryouts]
|
|
586
|
+
* @property {string} [type]
|
|
587
|
+
* @property {number} [uid]
|
|
588
|
+
* @property {ProductVariantListingResponse[]} [variants]
|
|
589
|
+
*/
|
|
590
|
+
/**
|
|
591
|
+
* @typedef ProductListingPrice
|
|
592
|
+
* @property {Price} [effective]
|
|
593
|
+
* @property {Price} [marked]
|
|
594
|
+
*/
|
|
595
|
+
/**
|
|
596
|
+
* @typedef ProductListingResponse
|
|
597
|
+
* @property {ProductFilters[]} [filters]
|
|
598
|
+
* @property {ProductListingDetail[]} [items]
|
|
599
|
+
* @property {Page} page
|
|
600
|
+
* @property {ProductSortOn[]} [sort_on]
|
|
601
|
+
*/
|
|
602
|
+
/**
|
|
603
|
+
* @typedef ProductsComparisonResponse
|
|
604
|
+
* @property {AttributeMetadata[]} [attributes_metadata]
|
|
605
|
+
* @property {ProductDetail[]} [items]
|
|
606
|
+
*/
|
|
607
|
+
/**
|
|
608
|
+
* @typedef ProductSetDistributionSizeV3
|
|
609
|
+
* @property {number} [pieces]
|
|
610
|
+
* @property {string} [size]
|
|
611
|
+
*/
|
|
612
|
+
/**
|
|
613
|
+
* @typedef ProductSetDistributionV3
|
|
614
|
+
* @property {ProductSetDistributionSizeV3[]} [sizes]
|
|
615
|
+
*/
|
|
616
|
+
/**
|
|
617
|
+
* @typedef ProductSetV3
|
|
618
|
+
* @property {number} [quantity]
|
|
619
|
+
* @property {ProductSetDistributionV3} [size_distribution]
|
|
620
|
+
*/
|
|
621
|
+
/**
|
|
622
|
+
* @typedef ProductSize
|
|
623
|
+
* @property {Dimension} [dimension]
|
|
624
|
+
* @property {string} [display]
|
|
625
|
+
* @property {boolean} [is_available]
|
|
626
|
+
* @property {number} [quantity]
|
|
627
|
+
* @property {string[]} [seller_identifiers]
|
|
628
|
+
* @property {string} [value]
|
|
629
|
+
* @property {Weight} [weight]
|
|
630
|
+
*/
|
|
631
|
+
/**
|
|
632
|
+
* @typedef ProductSizePriceResponseV3
|
|
633
|
+
* @property {ArticleAssignmentV3} [article_assignment]
|
|
634
|
+
* @property {string} [article_id]
|
|
635
|
+
* @property {string} [discount]
|
|
636
|
+
* @property {SellerGroupAttributes[]} [grouped_attributes]
|
|
637
|
+
* @property {boolean} [is_cod]
|
|
638
|
+
* @property {boolean} [is_gift]
|
|
639
|
+
* @property {string} [item_type]
|
|
640
|
+
* @property {number[]} [long_lat]
|
|
641
|
+
* @property {MarketPlaceSttributesSchemaV3[]} [marketplace_attributes]
|
|
642
|
+
* @property {number} [pincode]
|
|
643
|
+
* @property {ProductStockPriceV3} [price]
|
|
644
|
+
* @property {ProductStockPriceV3} [price_per_piece]
|
|
645
|
+
* @property {ProductStockUnitPriceV3} [price_per_unit]
|
|
646
|
+
* @property {number} [quantity]
|
|
647
|
+
* @property {ReturnConfigSchemaV3} [return_config]
|
|
648
|
+
* @property {SellerV3} [seller]
|
|
649
|
+
* @property {number} [seller_count]
|
|
650
|
+
* @property {ProductSetV3} [set]
|
|
651
|
+
* @property {string} [special_badge]
|
|
652
|
+
* @property {StoreV3} [store]
|
|
653
|
+
* @property {StrategyWiseListingSchemaV3[]} [strategy_wise_listing]
|
|
654
|
+
*/
|
|
655
|
+
/**
|
|
656
|
+
* @typedef ProductSizes
|
|
657
|
+
* @property {string} [discount]
|
|
658
|
+
* @property {boolean} [multi_size]
|
|
659
|
+
* @property {ProductListingPrice} [price]
|
|
660
|
+
* @property {boolean} [sellable]
|
|
661
|
+
* @property {SizeChart} [size_chart]
|
|
662
|
+
* @property {ProductSize[]} [sizes]
|
|
663
|
+
* @property {ProductSizeStores} [stores]
|
|
664
|
+
*/
|
|
665
|
+
/**
|
|
666
|
+
* @typedef ProductSizeSellerFilterSchemaV3
|
|
667
|
+
* @property {boolean} [is_selected]
|
|
668
|
+
* @property {string} [name]
|
|
669
|
+
* @property {string} [value]
|
|
670
|
+
*/
|
|
671
|
+
/**
|
|
672
|
+
* @typedef ProductSizeSellersResponseV3
|
|
673
|
+
* @property {ProductSizePriceResponseV3[]} [items]
|
|
674
|
+
* @property {Page} page
|
|
675
|
+
* @property {ProductSizeSellerFilterSchemaV3[]} [sort_on]
|
|
676
|
+
*/
|
|
677
|
+
/**
|
|
678
|
+
* @typedef ProductSizeStores
|
|
679
|
+
* @property {number} [count]
|
|
680
|
+
*/
|
|
681
|
+
/**
|
|
682
|
+
* @typedef ProductSortOn
|
|
683
|
+
* @property {string} [display]
|
|
684
|
+
* @property {boolean} [is_selected]
|
|
685
|
+
* @property {string} [logo]
|
|
686
|
+
* @property {string} [name]
|
|
687
|
+
* @property {string} [value]
|
|
688
|
+
*/
|
|
689
|
+
/**
|
|
690
|
+
* @typedef ProductStockPolling
|
|
691
|
+
* @property {ProductStockStatusItem[]} [items]
|
|
692
|
+
* @property {Page} page
|
|
693
|
+
*/
|
|
694
|
+
/**
|
|
695
|
+
* @typedef ProductStockPrice
|
|
696
|
+
* @property {string} [currency]
|
|
697
|
+
* @property {number} [effective]
|
|
698
|
+
* @property {number} [marked]
|
|
699
|
+
*/
|
|
700
|
+
/**
|
|
701
|
+
* @typedef ProductStockPriceV3
|
|
702
|
+
* @property {string} [currency]
|
|
703
|
+
* @property {number} [effective]
|
|
704
|
+
* @property {number} [marked]
|
|
705
|
+
*/
|
|
706
|
+
/**
|
|
707
|
+
* @typedef ProductStockStatusItem
|
|
708
|
+
* @property {CompanyDetail} [company]
|
|
709
|
+
* @property {Object} [identifier]
|
|
710
|
+
* @property {number} [item_id]
|
|
711
|
+
* @property {ProductStockPrice} [price]
|
|
712
|
+
* @property {number} [quantity]
|
|
713
|
+
* @property {Seller} [seller]
|
|
714
|
+
* @property {string} [size]
|
|
715
|
+
* @property {StoreDetail} [store]
|
|
716
|
+
* @property {string} [uid]
|
|
717
|
+
*/
|
|
718
|
+
/**
|
|
719
|
+
* @typedef ProductStockStatusResponse
|
|
720
|
+
* @property {ProductStockStatusItem[]} [items]
|
|
721
|
+
*/
|
|
722
|
+
/**
|
|
723
|
+
* @typedef ProductStockUnitPriceV3
|
|
724
|
+
* @property {string} [currency_code]
|
|
725
|
+
* @property {string} [currency_symbol]
|
|
726
|
+
* @property {number} [price]
|
|
727
|
+
* @property {string} [unit]
|
|
728
|
+
*/
|
|
729
|
+
/**
|
|
730
|
+
* @typedef ProductVariantItemResponse
|
|
731
|
+
* @property {CustomMetaFields[]} [_custom_meta]
|
|
732
|
+
* @property {ProductListingAction} [action]
|
|
733
|
+
* @property {string} [color]
|
|
734
|
+
* @property {string} [color_name]
|
|
735
|
+
* @property {boolean} [is_available]
|
|
736
|
+
* @property {Media[]} [medias]
|
|
737
|
+
* @property {string} [name]
|
|
738
|
+
* @property {string} [slug]
|
|
739
|
+
* @property {number} [uid]
|
|
740
|
+
* @property {string} [value]
|
|
741
|
+
*/
|
|
742
|
+
/**
|
|
743
|
+
* @typedef ProductVariantListingResponse
|
|
744
|
+
* @property {string} [display_type]
|
|
745
|
+
* @property {string} [header]
|
|
746
|
+
* @property {ProductVariantItemResponse[]} [items]
|
|
747
|
+
* @property {string} [key]
|
|
748
|
+
* @property {number} [total]
|
|
749
|
+
*/
|
|
750
|
+
/**
|
|
751
|
+
* @typedef ProductVariantResponse
|
|
752
|
+
* @property {string} [display_type]
|
|
753
|
+
* @property {string} [header]
|
|
754
|
+
* @property {ProductVariantItemResponse[]} [items]
|
|
755
|
+
* @property {string} [key]
|
|
756
|
+
*/
|
|
757
|
+
/**
|
|
758
|
+
* @typedef ProductVariantsResponse
|
|
759
|
+
* @property {ProductVariantResponse[]} [variants]
|
|
760
|
+
*/
|
|
761
|
+
/**
|
|
762
|
+
* @typedef ReturnConfigSchemaV3
|
|
763
|
+
* @property {boolean} [returnable]
|
|
764
|
+
* @property {number} [time]
|
|
765
|
+
* @property {string} [unit]
|
|
766
|
+
*/
|
|
767
|
+
/**
|
|
768
|
+
* @typedef SecondLevelChild
|
|
769
|
+
* @property {Object} [_custom_json]
|
|
770
|
+
* @property {ProductListingAction} [action]
|
|
771
|
+
* @property {ImageUrls} [banners]
|
|
772
|
+
* @property {ThirdLevelChild[]} [childs]
|
|
773
|
+
* @property {string} [name]
|
|
774
|
+
* @property {string} [slug]
|
|
775
|
+
* @property {number} [uid]
|
|
776
|
+
*/
|
|
777
|
+
/**
|
|
778
|
+
* @typedef Seller
|
|
779
|
+
* @property {number} [count]
|
|
780
|
+
* @property {string} [name]
|
|
781
|
+
* @property {number} [uid]
|
|
782
|
+
*/
|
|
783
|
+
/**
|
|
784
|
+
* @typedef SellerGroupAttributes
|
|
785
|
+
* @property {DetailsSchemaV3[]} [details]
|
|
786
|
+
* @property {string} [title]
|
|
787
|
+
*/
|
|
788
|
+
/**
|
|
789
|
+
* @typedef SellerPhoneNumber
|
|
790
|
+
* @property {number} country_code
|
|
791
|
+
* @property {string} number
|
|
792
|
+
*/
|
|
793
|
+
/**
|
|
794
|
+
* @typedef SellerV3
|
|
795
|
+
* @property {number} [count]
|
|
796
|
+
* @property {string} [name]
|
|
797
|
+
* @property {number} [uid]
|
|
798
|
+
*/
|
|
799
|
+
/**
|
|
800
|
+
* @typedef Size
|
|
801
|
+
* @property {Object} [display] - The display string for the size
|
|
802
|
+
* @property {boolean} [is_available] - Whether or not this size is available
|
|
803
|
+
* @property {number} [quantity] - The quantity of this size available
|
|
804
|
+
* @property {Object} [value] - The value of the size
|
|
805
|
+
*/
|
|
806
|
+
/**
|
|
807
|
+
* @typedef SizeChart
|
|
808
|
+
* @property {string} [description]
|
|
809
|
+
* @property {ColumnHeaders} [headers]
|
|
810
|
+
* @property {string} [image]
|
|
811
|
+
* @property {string} [size_tip]
|
|
812
|
+
* @property {SizeChartValues[]} [sizes]
|
|
813
|
+
* @property {string} [title]
|
|
814
|
+
* @property {string} [unit]
|
|
815
|
+
*/
|
|
816
|
+
/**
|
|
817
|
+
* @typedef SizeChartValues
|
|
818
|
+
* @property {string} [col_1]
|
|
819
|
+
* @property {string} [col_2]
|
|
820
|
+
* @property {string} [col_3]
|
|
821
|
+
* @property {string} [col_4]
|
|
822
|
+
* @property {string} [col_5]
|
|
823
|
+
* @property {string} [col_6]
|
|
824
|
+
*/
|
|
825
|
+
/**
|
|
826
|
+
* @typedef Store
|
|
827
|
+
* @property {string} [address]
|
|
828
|
+
* @property {string} [city]
|
|
829
|
+
* @property {string} [country]
|
|
830
|
+
* @property {LatLong} [lat_long]
|
|
831
|
+
* @property {string} [name]
|
|
832
|
+
* @property {number} [pincode]
|
|
833
|
+
* @property {string} [state]
|
|
834
|
+
* @property {string} [store_code]
|
|
835
|
+
* @property {string} [store_email]
|
|
836
|
+
* @property {number} [uid]
|
|
837
|
+
*/
|
|
838
|
+
/**
|
|
839
|
+
* @typedef StoreAddressSerializer
|
|
840
|
+
* @property {string} [address1]
|
|
841
|
+
* @property {string} [address2]
|
|
842
|
+
* @property {string} [city]
|
|
843
|
+
* @property {string} [country]
|
|
844
|
+
* @property {string} [landmark]
|
|
845
|
+
* @property {number} [latitude]
|
|
846
|
+
* @property {number} [longitude]
|
|
847
|
+
* @property {number} [pincode]
|
|
848
|
+
* @property {string} [state]
|
|
849
|
+
*/
|
|
850
|
+
/**
|
|
851
|
+
* @typedef StoreDepartments
|
|
852
|
+
* @property {Object} [logo]
|
|
853
|
+
* @property {string} [name]
|
|
854
|
+
* @property {number} [priority_order]
|
|
855
|
+
* @property {string} [slug]
|
|
856
|
+
* @property {number} [uid]
|
|
857
|
+
*/
|
|
858
|
+
/**
|
|
859
|
+
* @typedef StoreDetail
|
|
860
|
+
* @property {string} [city]
|
|
861
|
+
* @property {string} [code]
|
|
862
|
+
* @property {number} [id]
|
|
863
|
+
* @property {string} [name]
|
|
864
|
+
*/
|
|
865
|
+
/**
|
|
866
|
+
* @typedef StoreDetails
|
|
867
|
+
* @property {Object} [_custom_json]
|
|
868
|
+
* @property {StoreAddressSerializer} [address]
|
|
869
|
+
* @property {CompanyStore} [company]
|
|
870
|
+
* @property {SellerPhoneNumber[]} [contact_numbers]
|
|
871
|
+
* @property {StoreDepartments[]} [departments]
|
|
872
|
+
* @property {StoreManagerSerializer} [manager]
|
|
873
|
+
* @property {string} [name]
|
|
874
|
+
* @property {string} [store_code]
|
|
875
|
+
* @property {StoreTiming[]} [timing]
|
|
876
|
+
* @property {number} [uid]
|
|
877
|
+
*/
|
|
878
|
+
/**
|
|
879
|
+
* @typedef StoreListingResponse
|
|
880
|
+
* @property {Store[]} items
|
|
881
|
+
* @property {Page} page
|
|
882
|
+
*/
|
|
883
|
+
/**
|
|
884
|
+
* @typedef StoreManagerSerializer
|
|
885
|
+
* @property {string} [email]
|
|
886
|
+
* @property {SellerPhoneNumber} [mobile_no]
|
|
887
|
+
* @property {string} [name]
|
|
888
|
+
*/
|
|
889
|
+
/**
|
|
890
|
+
* @typedef StoreTiming
|
|
891
|
+
* @property {Time} [closing]
|
|
892
|
+
* @property {boolean} [open]
|
|
893
|
+
* @property {Time} [opening]
|
|
894
|
+
* @property {string} [weekday]
|
|
895
|
+
*/
|
|
896
|
+
/**
|
|
897
|
+
* @typedef StoreV3
|
|
898
|
+
* @property {number} [count]
|
|
899
|
+
* @property {string} [name]
|
|
900
|
+
* @property {number} [uid]
|
|
901
|
+
*/
|
|
902
|
+
/**
|
|
903
|
+
* @typedef StrategyWiseListingSchemaV3
|
|
904
|
+
* @property {number} [distance]
|
|
905
|
+
* @property {number} [pincode]
|
|
906
|
+
* @property {number} [quantity]
|
|
907
|
+
* @property {number} [tat]
|
|
908
|
+
*/
|
|
909
|
+
/**
|
|
910
|
+
* @typedef ThirdLevelChild
|
|
911
|
+
* @property {Object} [_custom_json]
|
|
912
|
+
* @property {ProductListingAction} [action]
|
|
913
|
+
* @property {ImageUrls} [banners]
|
|
914
|
+
* @property {Object[]} [childs]
|
|
915
|
+
* @property {string} [name]
|
|
916
|
+
* @property {string} [slug]
|
|
917
|
+
* @property {number} [uid]
|
|
918
|
+
*/
|
|
919
|
+
/**
|
|
920
|
+
* @typedef Time
|
|
921
|
+
* @property {number} [hour]
|
|
922
|
+
* @property {number} [minute]
|
|
923
|
+
*/
|
|
924
|
+
/**
|
|
925
|
+
* @typedef UserDetail
|
|
926
|
+
* @property {string} [contact] - The contact details of the user.
|
|
927
|
+
* @property {boolean} [super_user] - A flag indicating whether the user is a super user.
|
|
928
|
+
* @property {string} user_id - The user ID of the user.
|
|
929
|
+
* @property {string} username - The username of the user.
|
|
930
|
+
*/
|
|
931
|
+
/**
|
|
932
|
+
* @typedef Weight
|
|
933
|
+
* @property {boolean} is_default - Whether the weight is the default one or not
|
|
934
|
+
* @property {number} shipping - The shipping weight of the product
|
|
935
|
+
* @property {string} unit - The unit of weight
|
|
936
|
+
*/
|
|
937
|
+
declare class CatalogApplicationModel {
|
|
118
938
|
}
|
|
939
|
+
declare namespace CatalogApplicationModel {
|
|
940
|
+
export { ApplicationItemMOQ, ApplicationItemSEO, ApplicationStoreListing, AppStore, ArticleAssignmentV3, AttributeDetail, AttributeMetadata, AutocompleteItem, AutoCompleteResponse, BrandDetailResponse, BrandItem, BrandListingResponse, CategoryBanner, CategoryItems, CategoryListingResponse, CategoryMetaResponse, Child, CollectionDetailResponse, CollectionListingFilter, CollectionListingFilterTag, CollectionListingFilterType, CollectionQuery, ColumnHeader, ColumnHeaders, CompanyDetail, CompanyStore, CustomMetaFields, Department, DepartmentCategoryTree, DepartmentIdentifier, DepartmentResponse, DetailsSchemaV3, Dimension, ErrorResponse, FollowerCountResponse, FollowIdsData, FollowIdsResponse, FollowPostResponse, GetCollectionDetailNest, GetCollectionListingResponse, GetFollowListingResponse, HomeListingResponse, ImageUrls, LatLong, MarketPlaceSttributesSchemaV3, Media, Meta, NetQuantity, Page, Price, ProductBrand, ProductBundle, ProductCategoryMap, ProductCompareResponse, ProductDetail, ProductDetailAttribute, ProductDetailCustomOrder, ProductDetailGroupedAttribute, ProductDetails, ProductFilters, ProductFiltersKey, ProductFiltersValue, ProductFrequentlyComparedSimilarResponse, ProductGroupingModel, ProductGroupPrice, ProductInGroup, ProductListingAction, ProductListingActionPage, ProductListingDetail, ProductListingPrice, ProductListingResponse, ProductsComparisonResponse, ProductSetDistributionSizeV3, ProductSetDistributionV3, ProductSetV3, ProductSize, ProductSizePriceResponseV3, ProductSizes, ProductSizeSellerFilterSchemaV3, ProductSizeSellersResponseV3, ProductSizeStores, ProductSortOn, ProductStockPolling, ProductStockPrice, ProductStockPriceV3, ProductStockStatusItem, ProductStockStatusResponse, ProductStockUnitPriceV3, ProductVariantItemResponse, ProductVariantListingResponse, ProductVariantResponse, ProductVariantsResponse, ReturnConfigSchemaV3, SecondLevelChild, Seller, SellerGroupAttributes, SellerPhoneNumber, SellerV3, Size, SizeChart, SizeChartValues, Store, StoreAddressSerializer, StoreDepartments, StoreDetail, StoreDetails, StoreListingResponse, StoreManagerSerializer, StoreTiming, StoreV3, StrategyWiseListingSchemaV3, ThirdLevelChild, Time, UserDetail, Weight };
|
|
941
|
+
}
|
|
942
|
+
/** @returns {ApplicationItemMOQ} */
|
|
943
|
+
declare function ApplicationItemMOQ(): ApplicationItemMOQ;
|
|
944
|
+
type ApplicationItemMOQ = {
|
|
945
|
+
/**
|
|
946
|
+
* - The minimum quantity increment in which
|
|
947
|
+
* the item can be purchased.
|
|
948
|
+
*/
|
|
949
|
+
increment_unit?: number;
|
|
950
|
+
/**
|
|
951
|
+
* - The maximum quantity allowed for purchase.
|
|
952
|
+
*/
|
|
953
|
+
maximum?: number;
|
|
954
|
+
/**
|
|
955
|
+
* - The minimum quantity required for purchase.
|
|
956
|
+
*/
|
|
957
|
+
minimum?: number;
|
|
958
|
+
};
|
|
959
|
+
/** @returns {ApplicationItemSEO} */
|
|
960
|
+
declare function ApplicationItemSEO(): ApplicationItemSEO;
|
|
961
|
+
type ApplicationItemSEO = {
|
|
962
|
+
/**
|
|
963
|
+
* - The SEO description of the item
|
|
964
|
+
*/
|
|
965
|
+
description?: any;
|
|
966
|
+
/**
|
|
967
|
+
* - The SEO title of the item
|
|
968
|
+
*/
|
|
969
|
+
title?: any;
|
|
970
|
+
};
|
|
971
|
+
/** @returns {ApplicationStoreListing} */
|
|
972
|
+
declare function ApplicationStoreListing(): ApplicationStoreListing;
|
|
973
|
+
type ApplicationStoreListing = {
|
|
974
|
+
filters?: any[];
|
|
975
|
+
items?: AppStore[];
|
|
976
|
+
page?: Page;
|
|
977
|
+
};
|
|
978
|
+
/** @returns {AppStore} */
|
|
979
|
+
declare function AppStore(): AppStore;
|
|
980
|
+
type AppStore = {
|
|
981
|
+
address?: StoreAddressSerializer;
|
|
982
|
+
company?: CompanyStore;
|
|
983
|
+
contact_numbers?: SellerPhoneNumber[];
|
|
984
|
+
departments?: StoreDepartments[];
|
|
985
|
+
manager?: StoreManagerSerializer;
|
|
986
|
+
name?: string;
|
|
987
|
+
store_code?: string;
|
|
988
|
+
uid?: number;
|
|
989
|
+
};
|
|
990
|
+
/** @returns {ArticleAssignmentV3} */
|
|
991
|
+
declare function ArticleAssignmentV3(): ArticleAssignmentV3;
|
|
992
|
+
type ArticleAssignmentV3 = {
|
|
993
|
+
level?: string;
|
|
994
|
+
strategy?: string;
|
|
995
|
+
};
|
|
996
|
+
/** @returns {AttributeDetail} */
|
|
997
|
+
declare function AttributeDetail(): AttributeDetail;
|
|
998
|
+
type AttributeDetail = {
|
|
999
|
+
description?: string;
|
|
1000
|
+
display?: string;
|
|
1001
|
+
key?: string;
|
|
1002
|
+
logo?: string;
|
|
1003
|
+
};
|
|
1004
|
+
/** @returns {AttributeMetadata} */
|
|
1005
|
+
declare function AttributeMetadata(): AttributeMetadata;
|
|
1006
|
+
type AttributeMetadata = {
|
|
1007
|
+
details?: AttributeDetail[];
|
|
1008
|
+
title?: string;
|
|
1009
|
+
};
|
|
1010
|
+
/** @returns {AutocompleteItem} */
|
|
1011
|
+
declare function AutocompleteItem(): AutocompleteItem;
|
|
1012
|
+
type AutocompleteItem = {
|
|
1013
|
+
_custom_json?: any;
|
|
1014
|
+
action?: ProductListingAction;
|
|
1015
|
+
display?: string;
|
|
1016
|
+
logo?: Media;
|
|
1017
|
+
type?: string;
|
|
1018
|
+
};
|
|
1019
|
+
/** @returns {AutoCompleteResponse} */
|
|
1020
|
+
declare function AutoCompleteResponse(): AutoCompleteResponse;
|
|
1021
|
+
type AutoCompleteResponse = {
|
|
1022
|
+
items?: AutocompleteItem[];
|
|
1023
|
+
};
|
|
1024
|
+
/** @returns {BrandDetailResponse} */
|
|
1025
|
+
declare function BrandDetailResponse(): BrandDetailResponse;
|
|
1026
|
+
type BrandDetailResponse = {
|
|
1027
|
+
_custom_json?: any;
|
|
1028
|
+
banners?: ImageUrls;
|
|
1029
|
+
description?: string;
|
|
1030
|
+
logo?: Media;
|
|
1031
|
+
name?: string;
|
|
1032
|
+
uid?: number;
|
|
1033
|
+
};
|
|
1034
|
+
/** @returns {BrandItem} */
|
|
1035
|
+
declare function BrandItem(): BrandItem;
|
|
1036
|
+
type BrandItem = {
|
|
1037
|
+
action?: ProductListingAction;
|
|
1038
|
+
banners?: ImageUrls;
|
|
1039
|
+
departments?: string[];
|
|
1040
|
+
description?: string;
|
|
1041
|
+
discount?: string;
|
|
1042
|
+
logo?: Media;
|
|
1043
|
+
name?: string;
|
|
1044
|
+
slug?: string;
|
|
1045
|
+
uid?: number;
|
|
1046
|
+
};
|
|
1047
|
+
/** @returns {BrandListingResponse} */
|
|
1048
|
+
declare function BrandListingResponse(): BrandListingResponse;
|
|
1049
|
+
type BrandListingResponse = {
|
|
1050
|
+
items?: BrandItem[];
|
|
1051
|
+
page: Page;
|
|
1052
|
+
};
|
|
1053
|
+
/** @returns {CategoryBanner} */
|
|
1054
|
+
declare function CategoryBanner(): CategoryBanner;
|
|
1055
|
+
type CategoryBanner = {
|
|
1056
|
+
landscape: Media;
|
|
1057
|
+
portrait: Media;
|
|
1058
|
+
};
|
|
1059
|
+
/** @returns {CategoryItems} */
|
|
1060
|
+
declare function CategoryItems(): CategoryItems;
|
|
1061
|
+
type CategoryItems = {
|
|
1062
|
+
action: ProductListingAction;
|
|
1063
|
+
banners: CategoryBanner;
|
|
1064
|
+
childs?: Child[];
|
|
1065
|
+
name: string;
|
|
1066
|
+
slug: string;
|
|
1067
|
+
uid: number;
|
|
1068
|
+
};
|
|
1069
|
+
/** @returns {CategoryListingResponse} */
|
|
1070
|
+
declare function CategoryListingResponse(): CategoryListingResponse;
|
|
1071
|
+
type CategoryListingResponse = {
|
|
1072
|
+
data?: DepartmentCategoryTree[];
|
|
1073
|
+
departments?: DepartmentIdentifier[];
|
|
1074
|
+
};
|
|
1075
|
+
/** @returns {CategoryMetaResponse} */
|
|
1076
|
+
declare function CategoryMetaResponse(): CategoryMetaResponse;
|
|
1077
|
+
type CategoryMetaResponse = {
|
|
1078
|
+
_custom_json?: any;
|
|
1079
|
+
banners?: ImageUrls;
|
|
1080
|
+
logo?: Media;
|
|
1081
|
+
name?: string;
|
|
1082
|
+
uid?: number;
|
|
1083
|
+
};
|
|
1084
|
+
/** @returns {Child} */
|
|
1085
|
+
declare function Child(): Child;
|
|
1086
|
+
type Child = {
|
|
1087
|
+
_custom_json?: any;
|
|
1088
|
+
action?: ProductListingAction;
|
|
1089
|
+
banners?: ImageUrls;
|
|
1090
|
+
childs?: SecondLevelChild[];
|
|
1091
|
+
name?: string;
|
|
1092
|
+
slug?: string;
|
|
1093
|
+
uid?: number;
|
|
1094
|
+
};
|
|
1095
|
+
/** @returns {CollectionDetailResponse} */
|
|
1096
|
+
declare function CollectionDetailResponse(): CollectionDetailResponse;
|
|
1097
|
+
type CollectionDetailResponse = {
|
|
1098
|
+
_custom_json?: any;
|
|
1099
|
+
_schedule?: any;
|
|
1100
|
+
allow_facets?: boolean;
|
|
1101
|
+
allow_sort?: boolean;
|
|
1102
|
+
app_id?: string;
|
|
1103
|
+
badge?: any;
|
|
1104
|
+
banners?: ImageUrls;
|
|
1105
|
+
cron?: any;
|
|
1106
|
+
description?: string;
|
|
1107
|
+
is_active?: boolean;
|
|
1108
|
+
logo?: Media;
|
|
1109
|
+
meta?: any;
|
|
1110
|
+
name?: string;
|
|
1111
|
+
priority?: number;
|
|
1112
|
+
query?: CollectionQuery[];
|
|
1113
|
+
slug?: string;
|
|
1114
|
+
sort_on?: string;
|
|
1115
|
+
tag?: string[];
|
|
1116
|
+
type?: string;
|
|
1117
|
+
visible_facets_keys?: string[];
|
|
1118
|
+
};
|
|
1119
|
+
/** @returns {CollectionListingFilter} */
|
|
1120
|
+
declare function CollectionListingFilter(): CollectionListingFilter;
|
|
1121
|
+
type CollectionListingFilter = {
|
|
1122
|
+
tags?: CollectionListingFilterTag[];
|
|
1123
|
+
type?: CollectionListingFilterType[];
|
|
1124
|
+
};
|
|
1125
|
+
/** @returns {CollectionListingFilterTag} */
|
|
1126
|
+
declare function CollectionListingFilterTag(): CollectionListingFilterTag;
|
|
1127
|
+
type CollectionListingFilterTag = {
|
|
1128
|
+
display?: string;
|
|
1129
|
+
is_selected?: boolean;
|
|
1130
|
+
name?: string;
|
|
1131
|
+
};
|
|
1132
|
+
/** @returns {CollectionListingFilterType} */
|
|
1133
|
+
declare function CollectionListingFilterType(): CollectionListingFilterType;
|
|
1134
|
+
type CollectionListingFilterType = {
|
|
1135
|
+
display?: string;
|
|
1136
|
+
is_selected?: boolean;
|
|
1137
|
+
name?: string;
|
|
1138
|
+
};
|
|
1139
|
+
/** @returns {CollectionQuery} */
|
|
1140
|
+
declare function CollectionQuery(): CollectionQuery;
|
|
1141
|
+
type CollectionQuery = {
|
|
1142
|
+
attribute: string;
|
|
1143
|
+
op: string;
|
|
1144
|
+
value: any[];
|
|
1145
|
+
};
|
|
1146
|
+
/** @returns {ColumnHeader} */
|
|
1147
|
+
declare function ColumnHeader(): ColumnHeader;
|
|
1148
|
+
type ColumnHeader = {
|
|
1149
|
+
convertable?: boolean;
|
|
1150
|
+
value?: string;
|
|
1151
|
+
};
|
|
1152
|
+
/** @returns {ColumnHeaders} */
|
|
1153
|
+
declare function ColumnHeaders(): ColumnHeaders;
|
|
1154
|
+
type ColumnHeaders = {
|
|
1155
|
+
col_1?: ColumnHeader;
|
|
1156
|
+
col_2?: ColumnHeader;
|
|
1157
|
+
col_3?: ColumnHeader;
|
|
1158
|
+
col_4?: ColumnHeader;
|
|
1159
|
+
col_5?: ColumnHeader;
|
|
1160
|
+
col_6?: ColumnHeader;
|
|
1161
|
+
};
|
|
1162
|
+
/** @returns {CompanyDetail} */
|
|
1163
|
+
declare function CompanyDetail(): CompanyDetail;
|
|
1164
|
+
type CompanyDetail = {
|
|
1165
|
+
id?: number;
|
|
1166
|
+
name?: string;
|
|
1167
|
+
};
|
|
1168
|
+
/** @returns {CompanyStore} */
|
|
1169
|
+
declare function CompanyStore(): CompanyStore;
|
|
1170
|
+
type CompanyStore = {
|
|
1171
|
+
business_type?: string;
|
|
1172
|
+
company_type?: string;
|
|
1173
|
+
name?: string;
|
|
1174
|
+
uid?: number;
|
|
1175
|
+
};
|
|
1176
|
+
/** @returns {CustomMetaFields} */
|
|
1177
|
+
declare function CustomMetaFields(): CustomMetaFields;
|
|
1178
|
+
type CustomMetaFields = {
|
|
1179
|
+
/**
|
|
1180
|
+
* - A key to store a custom field.
|
|
1181
|
+
*/
|
|
1182
|
+
key: string;
|
|
1183
|
+
/**
|
|
1184
|
+
* - A value to store in the custom field.
|
|
1185
|
+
*/
|
|
1186
|
+
value: string;
|
|
1187
|
+
};
|
|
1188
|
+
/** @returns {Department} */
|
|
1189
|
+
declare function Department(): Department;
|
|
1190
|
+
type Department = {
|
|
1191
|
+
logo?: Media;
|
|
1192
|
+
name?: string;
|
|
1193
|
+
priority_order?: number;
|
|
1194
|
+
slug?: string;
|
|
1195
|
+
uid?: number;
|
|
1196
|
+
};
|
|
1197
|
+
/** @returns {DepartmentCategoryTree} */
|
|
1198
|
+
declare function DepartmentCategoryTree(): DepartmentCategoryTree;
|
|
1199
|
+
type DepartmentCategoryTree = {
|
|
1200
|
+
department: string;
|
|
1201
|
+
items?: CategoryItems[];
|
|
1202
|
+
};
|
|
1203
|
+
/** @returns {DepartmentIdentifier} */
|
|
1204
|
+
declare function DepartmentIdentifier(): DepartmentIdentifier;
|
|
1205
|
+
type DepartmentIdentifier = {
|
|
1206
|
+
slug?: string;
|
|
1207
|
+
uid?: number;
|
|
1208
|
+
};
|
|
1209
|
+
/** @returns {DepartmentResponse} */
|
|
1210
|
+
declare function DepartmentResponse(): DepartmentResponse;
|
|
1211
|
+
type DepartmentResponse = {
|
|
1212
|
+
items?: Department[];
|
|
1213
|
+
};
|
|
1214
|
+
/** @returns {DetailsSchemaV3} */
|
|
1215
|
+
declare function DetailsSchemaV3(): DetailsSchemaV3;
|
|
1216
|
+
type DetailsSchemaV3 = {
|
|
1217
|
+
key?: string;
|
|
1218
|
+
type?: string;
|
|
1219
|
+
value?: string;
|
|
1220
|
+
};
|
|
1221
|
+
/** @returns {Dimension} */
|
|
1222
|
+
declare function Dimension(): Dimension;
|
|
1223
|
+
type Dimension = {
|
|
1224
|
+
/**
|
|
1225
|
+
* - The height of the product
|
|
1226
|
+
*/
|
|
1227
|
+
height: number;
|
|
1228
|
+
/**
|
|
1229
|
+
* - Whether the dimension is the default one or not
|
|
1230
|
+
*/
|
|
1231
|
+
is_default: boolean;
|
|
1232
|
+
/**
|
|
1233
|
+
* - The length of the product
|
|
1234
|
+
*/
|
|
1235
|
+
length: number;
|
|
1236
|
+
/**
|
|
1237
|
+
* - The unit of dimension
|
|
1238
|
+
*/
|
|
1239
|
+
unit: string;
|
|
1240
|
+
/**
|
|
1241
|
+
* - The width of the product
|
|
1242
|
+
*/
|
|
1243
|
+
width: number;
|
|
1244
|
+
};
|
|
1245
|
+
/** @returns {ErrorResponse} */
|
|
1246
|
+
declare function ErrorResponse(): ErrorResponse;
|
|
1247
|
+
type ErrorResponse = {
|
|
1248
|
+
error?: string;
|
|
1249
|
+
};
|
|
1250
|
+
/** @returns {FollowerCountResponse} */
|
|
1251
|
+
declare function FollowerCountResponse(): FollowerCountResponse;
|
|
1252
|
+
type FollowerCountResponse = {
|
|
1253
|
+
count?: number;
|
|
1254
|
+
};
|
|
1255
|
+
/** @returns {FollowIdsData} */
|
|
1256
|
+
declare function FollowIdsData(): FollowIdsData;
|
|
1257
|
+
type FollowIdsData = {
|
|
1258
|
+
brands?: number[];
|
|
1259
|
+
collections?: number[];
|
|
1260
|
+
products?: number[];
|
|
1261
|
+
};
|
|
1262
|
+
/** @returns {FollowIdsResponse} */
|
|
1263
|
+
declare function FollowIdsResponse(): FollowIdsResponse;
|
|
1264
|
+
type FollowIdsResponse = {
|
|
1265
|
+
data?: FollowIdsData;
|
|
1266
|
+
};
|
|
1267
|
+
/** @returns {FollowPostResponse} */
|
|
1268
|
+
declare function FollowPostResponse(): FollowPostResponse;
|
|
1269
|
+
type FollowPostResponse = {
|
|
1270
|
+
id: string;
|
|
1271
|
+
message: string;
|
|
1272
|
+
};
|
|
1273
|
+
/** @returns {GetCollectionDetailNest} */
|
|
1274
|
+
declare function GetCollectionDetailNest(): GetCollectionDetailNest;
|
|
1275
|
+
type GetCollectionDetailNest = {
|
|
1276
|
+
_custom_json?: any;
|
|
1277
|
+
_schedule?: any;
|
|
1278
|
+
action?: ProductListingAction;
|
|
1279
|
+
allow_facets?: boolean;
|
|
1280
|
+
allow_sort?: boolean;
|
|
1281
|
+
app_id?: string;
|
|
1282
|
+
badge?: any;
|
|
1283
|
+
banners?: ImageUrls;
|
|
1284
|
+
cron?: any;
|
|
1285
|
+
description?: string;
|
|
1286
|
+
is_active?: boolean;
|
|
1287
|
+
logo?: Media;
|
|
1288
|
+
meta?: any;
|
|
1289
|
+
name?: string;
|
|
1290
|
+
priority?: number;
|
|
1291
|
+
query?: CollectionQuery[];
|
|
1292
|
+
slug?: string;
|
|
1293
|
+
sort_on?: string;
|
|
1294
|
+
tag?: string[];
|
|
1295
|
+
type?: string;
|
|
1296
|
+
uid?: string;
|
|
1297
|
+
visible_facets_keys?: string[];
|
|
1298
|
+
};
|
|
1299
|
+
/** @returns {GetCollectionListingResponse} */
|
|
1300
|
+
declare function GetCollectionListingResponse(): GetCollectionListingResponse;
|
|
1301
|
+
type GetCollectionListingResponse = {
|
|
1302
|
+
filters?: CollectionListingFilter;
|
|
1303
|
+
items?: GetCollectionDetailNest[];
|
|
1304
|
+
page: Page;
|
|
1305
|
+
};
|
|
1306
|
+
/** @returns {GetFollowListingResponse} */
|
|
1307
|
+
declare function GetFollowListingResponse(): GetFollowListingResponse;
|
|
1308
|
+
type GetFollowListingResponse = {
|
|
1309
|
+
items: ProductListingDetail[];
|
|
1310
|
+
page: Page;
|
|
1311
|
+
};
|
|
1312
|
+
/** @returns {HomeListingResponse} */
|
|
1313
|
+
declare function HomeListingResponse(): HomeListingResponse;
|
|
1314
|
+
type HomeListingResponse = {
|
|
1315
|
+
items?: ProductListingDetail[];
|
|
1316
|
+
message?: string;
|
|
1317
|
+
page: Page;
|
|
1318
|
+
};
|
|
1319
|
+
/** @returns {ImageUrls} */
|
|
1320
|
+
declare function ImageUrls(): ImageUrls;
|
|
1321
|
+
type ImageUrls = {
|
|
1322
|
+
landscape?: Media;
|
|
1323
|
+
portrait?: Media;
|
|
1324
|
+
};
|
|
1325
|
+
/** @returns {LatLong} */
|
|
1326
|
+
declare function LatLong(): LatLong;
|
|
1327
|
+
type LatLong = {
|
|
1328
|
+
coordinates?: number[];
|
|
1329
|
+
type?: string;
|
|
1330
|
+
};
|
|
1331
|
+
/** @returns {MarketPlaceSttributesSchemaV3} */
|
|
1332
|
+
declare function MarketPlaceSttributesSchemaV3(): MarketPlaceSttributesSchemaV3;
|
|
1333
|
+
type MarketPlaceSttributesSchemaV3 = {
|
|
1334
|
+
details?: DetailsSchemaV3[];
|
|
1335
|
+
title?: string;
|
|
1336
|
+
};
|
|
1337
|
+
/** @returns {Media} */
|
|
1338
|
+
declare function Media(): Media;
|
|
1339
|
+
type Media = {
|
|
1340
|
+
alt?: string;
|
|
1341
|
+
meta?: Meta;
|
|
1342
|
+
type?: string;
|
|
1343
|
+
url?: string;
|
|
1344
|
+
};
|
|
1345
|
+
/** @returns {Meta} */
|
|
1346
|
+
declare function Meta(): Meta;
|
|
1347
|
+
type Meta = {
|
|
1348
|
+
source?: string;
|
|
1349
|
+
};
|
|
1350
|
+
/** @returns {NetQuantity} */
|
|
1351
|
+
declare function NetQuantity(): NetQuantity;
|
|
1352
|
+
type NetQuantity = {
|
|
1353
|
+
/**
|
|
1354
|
+
* - The unit of measurement used for the net quantity
|
|
1355
|
+
* of the product.
|
|
1356
|
+
*/
|
|
1357
|
+
unit?: any;
|
|
1358
|
+
/**
|
|
1359
|
+
* - The value of the net quantity of the product.
|
|
1360
|
+
*/
|
|
1361
|
+
value?: number;
|
|
1362
|
+
};
|
|
1363
|
+
/** @returns {Page} */
|
|
1364
|
+
declare function Page(): Page;
|
|
1365
|
+
type Page = {
|
|
1366
|
+
current?: number;
|
|
1367
|
+
has_next?: boolean;
|
|
1368
|
+
has_previous?: boolean;
|
|
1369
|
+
item_total?: number;
|
|
1370
|
+
next_id?: string;
|
|
1371
|
+
size?: number;
|
|
1372
|
+
type: string;
|
|
1373
|
+
};
|
|
1374
|
+
/** @returns {Price} */
|
|
1375
|
+
declare function Price(): Price;
|
|
1376
|
+
type Price = {
|
|
1377
|
+
currency_code?: string;
|
|
1378
|
+
currency_symbol?: string;
|
|
1379
|
+
max?: number;
|
|
1380
|
+
min?: number;
|
|
1381
|
+
};
|
|
1382
|
+
/** @returns {ProductBrand} */
|
|
1383
|
+
declare function ProductBrand(): ProductBrand;
|
|
1384
|
+
type ProductBrand = {
|
|
1385
|
+
action?: ProductListingAction;
|
|
1386
|
+
description?: string;
|
|
1387
|
+
logo?: Media;
|
|
1388
|
+
name?: string;
|
|
1389
|
+
uid?: number;
|
|
1390
|
+
};
|
|
1391
|
+
/** @returns {ProductBundle} */
|
|
1392
|
+
declare function ProductBundle(): ProductBundle;
|
|
1393
|
+
type ProductBundle = {
|
|
1394
|
+
items?: ProductGroupingModel[];
|
|
1395
|
+
};
|
|
1396
|
+
/** @returns {ProductCategoryMap} */
|
|
1397
|
+
declare function ProductCategoryMap(): ProductCategoryMap;
|
|
1398
|
+
type ProductCategoryMap = {
|
|
1399
|
+
l1?: ProductBrand;
|
|
1400
|
+
l2?: ProductBrand;
|
|
1401
|
+
l3?: ProductBrand;
|
|
1402
|
+
};
|
|
1403
|
+
/** @returns {ProductCompareResponse} */
|
|
1404
|
+
declare function ProductCompareResponse(): ProductCompareResponse;
|
|
1405
|
+
type ProductCompareResponse = {
|
|
1406
|
+
attributes_metadata?: AttributeMetadata[];
|
|
1407
|
+
items?: ProductDetail[];
|
|
1408
|
+
subtitle?: string;
|
|
1409
|
+
title?: string;
|
|
1410
|
+
};
|
|
1411
|
+
/** @returns {ProductDetail} */
|
|
1412
|
+
declare function ProductDetail(): ProductDetail;
|
|
1413
|
+
type ProductDetail = {
|
|
1414
|
+
_custom_json?: any;
|
|
1415
|
+
_custom_meta?: CustomMetaFields[];
|
|
1416
|
+
action?: ProductListingAction;
|
|
1417
|
+
attributes?: any;
|
|
1418
|
+
brand?: ProductBrand;
|
|
1419
|
+
categories?: ProductBrand[];
|
|
1420
|
+
category_map?: ProductCategoryMap;
|
|
1421
|
+
color?: string;
|
|
1422
|
+
custom_order?: ProductDetailCustomOrder;
|
|
1423
|
+
description?: string;
|
|
1424
|
+
discount?: string;
|
|
1425
|
+
grouped_attributes?: ProductDetailGroupedAttribute[];
|
|
1426
|
+
has_variant?: boolean;
|
|
1427
|
+
highlights?: string[];
|
|
1428
|
+
image_nature?: string;
|
|
1429
|
+
is_dependent?: boolean;
|
|
1430
|
+
item_code?: string;
|
|
1431
|
+
item_type?: string;
|
|
1432
|
+
medias?: Media[];
|
|
1433
|
+
moq?: ApplicationItemMOQ;
|
|
1434
|
+
name?: string;
|
|
1435
|
+
net_quantity?: NetQuantity;
|
|
1436
|
+
price?: ProductListingPrice;
|
|
1437
|
+
product_group_tag?: string[];
|
|
1438
|
+
product_online_date?: string;
|
|
1439
|
+
rating?: number;
|
|
1440
|
+
rating_count?: number;
|
|
1441
|
+
seo?: ApplicationItemSEO;
|
|
1442
|
+
short_description?: string;
|
|
1443
|
+
similars?: string[];
|
|
1444
|
+
slug: string;
|
|
1445
|
+
tags?: string[];
|
|
1446
|
+
teaser_tag?: string;
|
|
1447
|
+
tryouts?: string[];
|
|
1448
|
+
type?: string;
|
|
1449
|
+
uid?: number;
|
|
1450
|
+
};
|
|
1451
|
+
/** @returns {ProductDetailAttribute} */
|
|
1452
|
+
declare function ProductDetailAttribute(): ProductDetailAttribute;
|
|
1453
|
+
type ProductDetailAttribute = {
|
|
1454
|
+
key?: string;
|
|
1455
|
+
type?: string;
|
|
1456
|
+
value?: string;
|
|
1457
|
+
};
|
|
1458
|
+
/** @returns {ProductDetailCustomOrder} */
|
|
1459
|
+
declare function ProductDetailCustomOrder(): ProductDetailCustomOrder;
|
|
1460
|
+
type ProductDetailCustomOrder = {
|
|
1461
|
+
is_custom_order?: boolean;
|
|
1462
|
+
manufacturing_time?: number;
|
|
1463
|
+
manufacturing_time_unit?: string;
|
|
1464
|
+
};
|
|
1465
|
+
/** @returns {ProductDetailGroupedAttribute} */
|
|
1466
|
+
declare function ProductDetailGroupedAttribute(): ProductDetailGroupedAttribute;
|
|
1467
|
+
type ProductDetailGroupedAttribute = {
|
|
1468
|
+
details?: ProductDetailAttribute[];
|
|
1469
|
+
title?: string;
|
|
1470
|
+
};
|
|
1471
|
+
/** @returns {ProductDetails} */
|
|
1472
|
+
declare function ProductDetails(): ProductDetails;
|
|
1473
|
+
type ProductDetails = {
|
|
1474
|
+
/**
|
|
1475
|
+
* - A dictionary of product attributes
|
|
1476
|
+
*/
|
|
1477
|
+
attributes?: any;
|
|
1478
|
+
/**
|
|
1479
|
+
* - The unique ID of the product's brand
|
|
1480
|
+
*/
|
|
1481
|
+
brand_uid?: number;
|
|
1482
|
+
/**
|
|
1483
|
+
* - The country of origin for the product
|
|
1484
|
+
*/
|
|
1485
|
+
country_of_origin?: any;
|
|
1486
|
+
/**
|
|
1487
|
+
* - The long description of the product
|
|
1488
|
+
*/
|
|
1489
|
+
description?: any;
|
|
1490
|
+
/**
|
|
1491
|
+
* - A dictionary of grouped product attributes
|
|
1492
|
+
*/
|
|
1493
|
+
grouped_attributes?: any;
|
|
1494
|
+
/**
|
|
1495
|
+
* - Whether or not the product has a variant
|
|
1496
|
+
*/
|
|
1497
|
+
has_variant?: boolean;
|
|
1498
|
+
/**
|
|
1499
|
+
* - A list of highlights for the product
|
|
1500
|
+
*/
|
|
1501
|
+
highlights?: any[];
|
|
1502
|
+
/**
|
|
1503
|
+
* - The HSN code of the product
|
|
1504
|
+
*/
|
|
1505
|
+
hsn_code?: number;
|
|
1506
|
+
/**
|
|
1507
|
+
* - A dictionary of product identifiers
|
|
1508
|
+
*/
|
|
1509
|
+
identifier?: any;
|
|
1510
|
+
/**
|
|
1511
|
+
* - The nature of the product's images
|
|
1512
|
+
*/
|
|
1513
|
+
image_nature?: any;
|
|
1514
|
+
/**
|
|
1515
|
+
* - A list of image URLs for the product
|
|
1516
|
+
*/
|
|
1517
|
+
images?: any[];
|
|
1518
|
+
/**
|
|
1519
|
+
* - Whether or not the product is a set of items
|
|
1520
|
+
*/
|
|
1521
|
+
is_set?: boolean;
|
|
1522
|
+
/**
|
|
1523
|
+
* - The item code of the product
|
|
1524
|
+
*/
|
|
1525
|
+
item_code?: any;
|
|
1526
|
+
/**
|
|
1527
|
+
* - A list of media objects for the product
|
|
1528
|
+
*/
|
|
1529
|
+
media?: any[];
|
|
1530
|
+
/**
|
|
1531
|
+
* - The name of the product
|
|
1532
|
+
*/
|
|
1533
|
+
name?: any;
|
|
1534
|
+
/**
|
|
1535
|
+
* - Whether or not the product is out of stock
|
|
1536
|
+
*/
|
|
1537
|
+
out_of_stock?: boolean;
|
|
1538
|
+
/**
|
|
1539
|
+
* - The rating of the product
|
|
1540
|
+
*/
|
|
1541
|
+
rating?: number;
|
|
1542
|
+
/**
|
|
1543
|
+
* - The number of ratings the product has received
|
|
1544
|
+
*/
|
|
1545
|
+
rating_count?: number;
|
|
1546
|
+
/**
|
|
1547
|
+
* - The short description of the product
|
|
1548
|
+
*/
|
|
1549
|
+
short_description?: any;
|
|
1550
|
+
/**
|
|
1551
|
+
* - The slug of the product
|
|
1552
|
+
*/
|
|
1553
|
+
slug?: any;
|
|
1554
|
+
/**
|
|
1555
|
+
* - The template tag of the product
|
|
1556
|
+
*/
|
|
1557
|
+
template_tag?: any;
|
|
1558
|
+
};
|
|
1559
|
+
/** @returns {ProductFilters} */
|
|
1560
|
+
declare function ProductFilters(): ProductFilters;
|
|
1561
|
+
type ProductFilters = {
|
|
1562
|
+
key: ProductFiltersKey;
|
|
1563
|
+
values: ProductFiltersValue[];
|
|
1564
|
+
};
|
|
1565
|
+
/** @returns {ProductFiltersKey} */
|
|
1566
|
+
declare function ProductFiltersKey(): ProductFiltersKey;
|
|
1567
|
+
type ProductFiltersKey = {
|
|
1568
|
+
display: string;
|
|
1569
|
+
kind?: string;
|
|
1570
|
+
logo?: string;
|
|
1571
|
+
name: string;
|
|
1572
|
+
};
|
|
1573
|
+
/** @returns {ProductFiltersValue} */
|
|
1574
|
+
declare function ProductFiltersValue(): ProductFiltersValue;
|
|
1575
|
+
type ProductFiltersValue = {
|
|
1576
|
+
count?: number;
|
|
1577
|
+
currency_code?: string;
|
|
1578
|
+
currency_symbol?: string;
|
|
1579
|
+
display: string;
|
|
1580
|
+
display_format?: string;
|
|
1581
|
+
is_selected: boolean;
|
|
1582
|
+
max?: number;
|
|
1583
|
+
min?: number;
|
|
1584
|
+
query_format?: string;
|
|
1585
|
+
selected_max?: number;
|
|
1586
|
+
selected_min?: number;
|
|
1587
|
+
value?: string;
|
|
1588
|
+
};
|
|
1589
|
+
/** @returns {ProductFrequentlyComparedSimilarResponse} */
|
|
1590
|
+
declare function ProductFrequentlyComparedSimilarResponse(): ProductFrequentlyComparedSimilarResponse;
|
|
1591
|
+
type ProductFrequentlyComparedSimilarResponse = {
|
|
1592
|
+
similars?: ProductCompareResponse;
|
|
1593
|
+
};
|
|
1594
|
+
/** @returns {ProductGroupingModel} */
|
|
1595
|
+
declare function ProductGroupingModel(): ProductGroupingModel;
|
|
1596
|
+
type ProductGroupingModel = {
|
|
1597
|
+
_id?: any;
|
|
1598
|
+
/**
|
|
1599
|
+
* - The choice of the product grouping.
|
|
1600
|
+
*/
|
|
1601
|
+
choice?: any;
|
|
1602
|
+
/**
|
|
1603
|
+
* - The ID of the company that owns the product grouping.
|
|
1604
|
+
*/
|
|
1605
|
+
company_id?: number;
|
|
1606
|
+
/**
|
|
1607
|
+
* - User details of the creator of the document
|
|
1608
|
+
*/
|
|
1609
|
+
created_by?: UserDetail;
|
|
1610
|
+
/**
|
|
1611
|
+
* - Timestamp of the creation of the document
|
|
1612
|
+
*/
|
|
1613
|
+
created_on: string;
|
|
1614
|
+
/**
|
|
1615
|
+
* - Whether the product grouping is active.
|
|
1616
|
+
*/
|
|
1617
|
+
is_active?: boolean;
|
|
1618
|
+
/**
|
|
1619
|
+
* - The URL for the logo of the product grouping.
|
|
1620
|
+
*/
|
|
1621
|
+
logo?: any;
|
|
1622
|
+
/**
|
|
1623
|
+
* - A dictionary containing metadata information.
|
|
1624
|
+
*/
|
|
1625
|
+
meta?: any;
|
|
1626
|
+
/**
|
|
1627
|
+
* - User details of the last modifier of
|
|
1628
|
+
* the document
|
|
1629
|
+
*/
|
|
1630
|
+
modified_by?: UserDetail;
|
|
1631
|
+
/**
|
|
1632
|
+
* - Timestamp of the last modification of the document
|
|
1633
|
+
*/
|
|
1634
|
+
modified_on: string;
|
|
1635
|
+
/**
|
|
1636
|
+
* - The name of the product grouping.
|
|
1637
|
+
*/
|
|
1638
|
+
name: any;
|
|
1639
|
+
/**
|
|
1640
|
+
* - A list of page visibilities of the
|
|
1641
|
+
* product grouping.
|
|
1642
|
+
*/
|
|
1643
|
+
page_visibility?: any[];
|
|
1644
|
+
/**
|
|
1645
|
+
* - A list of products in the grouping.
|
|
1646
|
+
*/
|
|
1647
|
+
products: ProductInGroup[];
|
|
1648
|
+
/**
|
|
1649
|
+
* - Whether the products are
|
|
1650
|
+
* assigned to the same store.
|
|
1651
|
+
*/
|
|
1652
|
+
same_store_assignment?: boolean;
|
|
1653
|
+
/**
|
|
1654
|
+
* - The unique identifier for the product grouping.
|
|
1655
|
+
*/
|
|
1656
|
+
slug?: any;
|
|
1657
|
+
/**
|
|
1658
|
+
* - User details of the verifier of the
|
|
1659
|
+
* document, if applicable
|
|
1660
|
+
*/
|
|
1661
|
+
verified_by?: UserDetail;
|
|
1662
|
+
/**
|
|
1663
|
+
* - Timestamp of when the document was
|
|
1664
|
+
* verified, if applicable
|
|
1665
|
+
*/
|
|
1666
|
+
verified_on?: string;
|
|
1667
|
+
};
|
|
1668
|
+
/** @returns {ProductGroupPrice} */
|
|
1669
|
+
declare function ProductGroupPrice(): ProductGroupPrice;
|
|
1670
|
+
type ProductGroupPrice = {
|
|
1671
|
+
/**
|
|
1672
|
+
* - The currency code for the prices.
|
|
1673
|
+
*/
|
|
1674
|
+
currency?: any;
|
|
1675
|
+
/**
|
|
1676
|
+
* - The maximum effective price of the product group.
|
|
1677
|
+
*/
|
|
1678
|
+
max_effective?: number;
|
|
1679
|
+
/**
|
|
1680
|
+
* - The maximum marked price of the product group.
|
|
1681
|
+
*/
|
|
1682
|
+
max_marked?: number;
|
|
1683
|
+
/**
|
|
1684
|
+
* - The minimum effective price of the product group.
|
|
1685
|
+
*/
|
|
1686
|
+
min_effective?: number;
|
|
1687
|
+
/**
|
|
1688
|
+
* - The minimum marked price of the product group.
|
|
1689
|
+
*/
|
|
1690
|
+
min_marked?: number;
|
|
1691
|
+
};
|
|
1692
|
+
/** @returns {ProductInGroup} */
|
|
1693
|
+
declare function ProductInGroup(): ProductInGroup;
|
|
1694
|
+
type ProductInGroup = {
|
|
1695
|
+
/**
|
|
1696
|
+
* - A flag indicating whether the product
|
|
1697
|
+
* can be removed from the cart.
|
|
1698
|
+
*/
|
|
1699
|
+
allow_remove?: boolean;
|
|
1700
|
+
/**
|
|
1701
|
+
* - A flag indicating whether the
|
|
1702
|
+
* product should be automatically added to the cart.
|
|
1703
|
+
*/
|
|
1704
|
+
auto_add_to_cart?: boolean;
|
|
1705
|
+
/**
|
|
1706
|
+
* - A flag indicating whether the product
|
|
1707
|
+
* should be automatically selected.
|
|
1708
|
+
*/
|
|
1709
|
+
auto_select?: boolean;
|
|
1710
|
+
/**
|
|
1711
|
+
* - The maximum quantity of the product that
|
|
1712
|
+
* can be added to the cart.
|
|
1713
|
+
*/
|
|
1714
|
+
max_quantity: number;
|
|
1715
|
+
/**
|
|
1716
|
+
* - The minimum quantity of the product that
|
|
1717
|
+
* can be added to the cart.
|
|
1718
|
+
*/
|
|
1719
|
+
min_quantity?: number;
|
|
1720
|
+
/**
|
|
1721
|
+
* - The price details for the product group.
|
|
1722
|
+
*/
|
|
1723
|
+
price?: ProductGroupPrice;
|
|
1724
|
+
/**
|
|
1725
|
+
* - The details of the product.
|
|
1726
|
+
*/
|
|
1727
|
+
product_details?: ProductDetails;
|
|
1728
|
+
/**
|
|
1729
|
+
* - The unique ID of the product in the group.
|
|
1730
|
+
*/
|
|
1731
|
+
product_uid: number;
|
|
1732
|
+
/**
|
|
1733
|
+
* - The available sizes for the product.
|
|
1734
|
+
*/
|
|
1735
|
+
sizes?: Size[];
|
|
1736
|
+
};
|
|
1737
|
+
/** @returns {ProductListingAction} */
|
|
1738
|
+
declare function ProductListingAction(): ProductListingAction;
|
|
1739
|
+
type ProductListingAction = {
|
|
1740
|
+
page?: ProductListingActionPage;
|
|
1741
|
+
type?: string;
|
|
1742
|
+
};
|
|
1743
|
+
/** @returns {ProductListingActionPage} */
|
|
1744
|
+
declare function ProductListingActionPage(): ProductListingActionPage;
|
|
1745
|
+
type ProductListingActionPage = {
|
|
1746
|
+
params?: any;
|
|
1747
|
+
query?: any;
|
|
1748
|
+
type?: string;
|
|
1749
|
+
};
|
|
1750
|
+
/** @returns {ProductListingDetail} */
|
|
1751
|
+
declare function ProductListingDetail(): ProductListingDetail;
|
|
1752
|
+
type ProductListingDetail = {
|
|
1753
|
+
_custom_json?: any;
|
|
1754
|
+
_custom_meta?: CustomMetaFields[];
|
|
1755
|
+
action?: ProductListingAction;
|
|
1756
|
+
attributes?: any;
|
|
1757
|
+
brand?: ProductBrand;
|
|
1758
|
+
categories?: ProductBrand[];
|
|
1759
|
+
category_map?: ProductCategoryMap;
|
|
1760
|
+
color?: string;
|
|
1761
|
+
custom_order?: ProductDetailCustomOrder;
|
|
1762
|
+
description?: string;
|
|
1763
|
+
discount?: string;
|
|
1764
|
+
grouped_attributes?: ProductDetailGroupedAttribute[];
|
|
1765
|
+
has_variant?: boolean;
|
|
1766
|
+
highlights?: string[];
|
|
1767
|
+
identifiers?: string[];
|
|
1768
|
+
image_nature?: string;
|
|
1769
|
+
is_dependent?: boolean;
|
|
1770
|
+
item_code?: string;
|
|
1771
|
+
item_type?: string;
|
|
1772
|
+
medias?: Media[];
|
|
1773
|
+
moq?: ApplicationItemMOQ;
|
|
1774
|
+
name?: string;
|
|
1775
|
+
net_quantity?: NetQuantity;
|
|
1776
|
+
price?: ProductListingPrice;
|
|
1777
|
+
product_group_tag?: string[];
|
|
1778
|
+
product_online_date?: string;
|
|
1779
|
+
rating?: number;
|
|
1780
|
+
rating_count?: number;
|
|
1781
|
+
sellable?: boolean;
|
|
1782
|
+
seo?: ApplicationItemSEO;
|
|
1783
|
+
short_description?: string;
|
|
1784
|
+
similars?: string[];
|
|
1785
|
+
sizes?: string[];
|
|
1786
|
+
slug: string;
|
|
1787
|
+
tags?: string[];
|
|
1788
|
+
teaser_tag?: string;
|
|
1789
|
+
tryouts?: string[];
|
|
1790
|
+
type?: string;
|
|
1791
|
+
uid?: number;
|
|
1792
|
+
variants?: ProductVariantListingResponse[];
|
|
1793
|
+
};
|
|
1794
|
+
/** @returns {ProductListingPrice} */
|
|
1795
|
+
declare function ProductListingPrice(): ProductListingPrice;
|
|
1796
|
+
type ProductListingPrice = {
|
|
1797
|
+
effective?: Price;
|
|
1798
|
+
marked?: Price;
|
|
1799
|
+
};
|
|
1800
|
+
/** @returns {ProductListingResponse} */
|
|
1801
|
+
declare function ProductListingResponse(): ProductListingResponse;
|
|
1802
|
+
type ProductListingResponse = {
|
|
1803
|
+
filters?: ProductFilters[];
|
|
1804
|
+
items?: ProductListingDetail[];
|
|
1805
|
+
page: Page;
|
|
1806
|
+
sort_on?: ProductSortOn[];
|
|
1807
|
+
};
|
|
1808
|
+
/** @returns {ProductsComparisonResponse} */
|
|
1809
|
+
declare function ProductsComparisonResponse(): ProductsComparisonResponse;
|
|
1810
|
+
type ProductsComparisonResponse = {
|
|
1811
|
+
attributes_metadata?: AttributeMetadata[];
|
|
1812
|
+
items?: ProductDetail[];
|
|
1813
|
+
};
|
|
1814
|
+
/** @returns {ProductSetDistributionSizeV3} */
|
|
1815
|
+
declare function ProductSetDistributionSizeV3(): ProductSetDistributionSizeV3;
|
|
1816
|
+
type ProductSetDistributionSizeV3 = {
|
|
1817
|
+
pieces?: number;
|
|
1818
|
+
size?: string;
|
|
1819
|
+
};
|
|
1820
|
+
/** @returns {ProductSetDistributionV3} */
|
|
1821
|
+
declare function ProductSetDistributionV3(): ProductSetDistributionV3;
|
|
1822
|
+
type ProductSetDistributionV3 = {
|
|
1823
|
+
sizes?: ProductSetDistributionSizeV3[];
|
|
1824
|
+
};
|
|
1825
|
+
/** @returns {ProductSetV3} */
|
|
1826
|
+
declare function ProductSetV3(): ProductSetV3;
|
|
1827
|
+
type ProductSetV3 = {
|
|
1828
|
+
quantity?: number;
|
|
1829
|
+
size_distribution?: ProductSetDistributionV3;
|
|
1830
|
+
};
|
|
1831
|
+
/** @returns {ProductSize} */
|
|
1832
|
+
declare function ProductSize(): ProductSize;
|
|
1833
|
+
type ProductSize = {
|
|
1834
|
+
dimension?: Dimension;
|
|
1835
|
+
display?: string;
|
|
1836
|
+
is_available?: boolean;
|
|
1837
|
+
quantity?: number;
|
|
1838
|
+
seller_identifiers?: string[];
|
|
1839
|
+
value?: string;
|
|
1840
|
+
weight?: Weight;
|
|
1841
|
+
};
|
|
1842
|
+
/** @returns {ProductSizePriceResponseV3} */
|
|
1843
|
+
declare function ProductSizePriceResponseV3(): ProductSizePriceResponseV3;
|
|
1844
|
+
type ProductSizePriceResponseV3 = {
|
|
1845
|
+
article_assignment?: ArticleAssignmentV3;
|
|
1846
|
+
article_id?: string;
|
|
1847
|
+
discount?: string;
|
|
1848
|
+
grouped_attributes?: SellerGroupAttributes[];
|
|
1849
|
+
is_cod?: boolean;
|
|
1850
|
+
is_gift?: boolean;
|
|
1851
|
+
item_type?: string;
|
|
1852
|
+
long_lat?: number[];
|
|
1853
|
+
marketplace_attributes?: MarketPlaceSttributesSchemaV3[];
|
|
1854
|
+
pincode?: number;
|
|
1855
|
+
price?: ProductStockPriceV3;
|
|
1856
|
+
price_per_piece?: ProductStockPriceV3;
|
|
1857
|
+
price_per_unit?: ProductStockUnitPriceV3;
|
|
1858
|
+
quantity?: number;
|
|
1859
|
+
return_config?: ReturnConfigSchemaV3;
|
|
1860
|
+
seller?: SellerV3;
|
|
1861
|
+
seller_count?: number;
|
|
1862
|
+
set?: ProductSetV3;
|
|
1863
|
+
special_badge?: string;
|
|
1864
|
+
store?: StoreV3;
|
|
1865
|
+
strategy_wise_listing?: StrategyWiseListingSchemaV3[];
|
|
1866
|
+
};
|
|
1867
|
+
/** @returns {ProductSizes} */
|
|
1868
|
+
declare function ProductSizes(): ProductSizes;
|
|
1869
|
+
type ProductSizes = {
|
|
1870
|
+
discount?: string;
|
|
1871
|
+
multi_size?: boolean;
|
|
1872
|
+
price?: ProductListingPrice;
|
|
1873
|
+
sellable?: boolean;
|
|
1874
|
+
size_chart?: SizeChart;
|
|
1875
|
+
sizes?: ProductSize[];
|
|
1876
|
+
stores?: ProductSizeStores;
|
|
1877
|
+
};
|
|
1878
|
+
/** @returns {ProductSizeSellerFilterSchemaV3} */
|
|
1879
|
+
declare function ProductSizeSellerFilterSchemaV3(): ProductSizeSellerFilterSchemaV3;
|
|
1880
|
+
type ProductSizeSellerFilterSchemaV3 = {
|
|
1881
|
+
is_selected?: boolean;
|
|
1882
|
+
name?: string;
|
|
1883
|
+
value?: string;
|
|
1884
|
+
};
|
|
1885
|
+
/** @returns {ProductSizeSellersResponseV3} */
|
|
1886
|
+
declare function ProductSizeSellersResponseV3(): ProductSizeSellersResponseV3;
|
|
1887
|
+
type ProductSizeSellersResponseV3 = {
|
|
1888
|
+
items?: ProductSizePriceResponseV3[];
|
|
1889
|
+
page: Page;
|
|
1890
|
+
sort_on?: ProductSizeSellerFilterSchemaV3[];
|
|
1891
|
+
};
|
|
1892
|
+
/** @returns {ProductSizeStores} */
|
|
1893
|
+
declare function ProductSizeStores(): ProductSizeStores;
|
|
1894
|
+
type ProductSizeStores = {
|
|
1895
|
+
count?: number;
|
|
1896
|
+
};
|
|
1897
|
+
/** @returns {ProductSortOn} */
|
|
1898
|
+
declare function ProductSortOn(): ProductSortOn;
|
|
1899
|
+
type ProductSortOn = {
|
|
1900
|
+
display?: string;
|
|
1901
|
+
is_selected?: boolean;
|
|
1902
|
+
logo?: string;
|
|
1903
|
+
name?: string;
|
|
1904
|
+
value?: string;
|
|
1905
|
+
};
|
|
1906
|
+
/** @returns {ProductStockPolling} */
|
|
1907
|
+
declare function ProductStockPolling(): ProductStockPolling;
|
|
1908
|
+
type ProductStockPolling = {
|
|
1909
|
+
items?: ProductStockStatusItem[];
|
|
1910
|
+
page: Page;
|
|
1911
|
+
};
|
|
1912
|
+
/** @returns {ProductStockPrice} */
|
|
1913
|
+
declare function ProductStockPrice(): ProductStockPrice;
|
|
1914
|
+
type ProductStockPrice = {
|
|
1915
|
+
currency?: string;
|
|
1916
|
+
effective?: number;
|
|
1917
|
+
marked?: number;
|
|
1918
|
+
};
|
|
1919
|
+
/** @returns {ProductStockPriceV3} */
|
|
1920
|
+
declare function ProductStockPriceV3(): ProductStockPriceV3;
|
|
1921
|
+
type ProductStockPriceV3 = {
|
|
1922
|
+
currency?: string;
|
|
1923
|
+
effective?: number;
|
|
1924
|
+
marked?: number;
|
|
1925
|
+
};
|
|
1926
|
+
/** @returns {ProductStockStatusItem} */
|
|
1927
|
+
declare function ProductStockStatusItem(): ProductStockStatusItem;
|
|
1928
|
+
type ProductStockStatusItem = {
|
|
1929
|
+
company?: CompanyDetail;
|
|
1930
|
+
identifier?: any;
|
|
1931
|
+
item_id?: number;
|
|
1932
|
+
price?: ProductStockPrice;
|
|
1933
|
+
quantity?: number;
|
|
1934
|
+
seller?: Seller;
|
|
1935
|
+
size?: string;
|
|
1936
|
+
store?: StoreDetail;
|
|
1937
|
+
uid?: string;
|
|
1938
|
+
};
|
|
1939
|
+
/** @returns {ProductStockStatusResponse} */
|
|
1940
|
+
declare function ProductStockStatusResponse(): ProductStockStatusResponse;
|
|
1941
|
+
type ProductStockStatusResponse = {
|
|
1942
|
+
items?: ProductStockStatusItem[];
|
|
1943
|
+
};
|
|
1944
|
+
/** @returns {ProductStockUnitPriceV3} */
|
|
1945
|
+
declare function ProductStockUnitPriceV3(): ProductStockUnitPriceV3;
|
|
1946
|
+
type ProductStockUnitPriceV3 = {
|
|
1947
|
+
currency_code?: string;
|
|
1948
|
+
currency_symbol?: string;
|
|
1949
|
+
price?: number;
|
|
1950
|
+
unit?: string;
|
|
1951
|
+
};
|
|
1952
|
+
/** @returns {ProductVariantItemResponse} */
|
|
1953
|
+
declare function ProductVariantItemResponse(): ProductVariantItemResponse;
|
|
1954
|
+
type ProductVariantItemResponse = {
|
|
1955
|
+
_custom_meta?: CustomMetaFields[];
|
|
1956
|
+
action?: ProductListingAction;
|
|
1957
|
+
color?: string;
|
|
1958
|
+
color_name?: string;
|
|
1959
|
+
is_available?: boolean;
|
|
1960
|
+
medias?: Media[];
|
|
1961
|
+
name?: string;
|
|
1962
|
+
slug?: string;
|
|
1963
|
+
uid?: number;
|
|
1964
|
+
value?: string;
|
|
1965
|
+
};
|
|
1966
|
+
/** @returns {ProductVariantListingResponse} */
|
|
1967
|
+
declare function ProductVariantListingResponse(): ProductVariantListingResponse;
|
|
1968
|
+
type ProductVariantListingResponse = {
|
|
1969
|
+
display_type?: string;
|
|
1970
|
+
header?: string;
|
|
1971
|
+
items?: ProductVariantItemResponse[];
|
|
1972
|
+
key?: string;
|
|
1973
|
+
total?: number;
|
|
1974
|
+
};
|
|
1975
|
+
/** @returns {ProductVariantResponse} */
|
|
1976
|
+
declare function ProductVariantResponse(): ProductVariantResponse;
|
|
1977
|
+
type ProductVariantResponse = {
|
|
1978
|
+
display_type?: string;
|
|
1979
|
+
header?: string;
|
|
1980
|
+
items?: ProductVariantItemResponse[];
|
|
1981
|
+
key?: string;
|
|
1982
|
+
};
|
|
1983
|
+
/** @returns {ProductVariantsResponse} */
|
|
1984
|
+
declare function ProductVariantsResponse(): ProductVariantsResponse;
|
|
1985
|
+
type ProductVariantsResponse = {
|
|
1986
|
+
variants?: ProductVariantResponse[];
|
|
1987
|
+
};
|
|
1988
|
+
/** @returns {ReturnConfigSchemaV3} */
|
|
1989
|
+
declare function ReturnConfigSchemaV3(): ReturnConfigSchemaV3;
|
|
1990
|
+
type ReturnConfigSchemaV3 = {
|
|
1991
|
+
returnable?: boolean;
|
|
1992
|
+
time?: number;
|
|
1993
|
+
unit?: string;
|
|
1994
|
+
};
|
|
1995
|
+
/** @returns {SecondLevelChild} */
|
|
1996
|
+
declare function SecondLevelChild(): SecondLevelChild;
|
|
1997
|
+
type SecondLevelChild = {
|
|
1998
|
+
_custom_json?: any;
|
|
1999
|
+
action?: ProductListingAction;
|
|
2000
|
+
banners?: ImageUrls;
|
|
2001
|
+
childs?: ThirdLevelChild[];
|
|
2002
|
+
name?: string;
|
|
2003
|
+
slug?: string;
|
|
2004
|
+
uid?: number;
|
|
2005
|
+
};
|
|
2006
|
+
/** @returns {Seller} */
|
|
2007
|
+
declare function Seller(): Seller;
|
|
2008
|
+
type Seller = {
|
|
2009
|
+
count?: number;
|
|
2010
|
+
name?: string;
|
|
2011
|
+
uid?: number;
|
|
2012
|
+
};
|
|
2013
|
+
/** @returns {SellerGroupAttributes} */
|
|
2014
|
+
declare function SellerGroupAttributes(): SellerGroupAttributes;
|
|
2015
|
+
type SellerGroupAttributes = {
|
|
2016
|
+
details?: DetailsSchemaV3[];
|
|
2017
|
+
title?: string;
|
|
2018
|
+
};
|
|
2019
|
+
/** @returns {SellerPhoneNumber} */
|
|
2020
|
+
declare function SellerPhoneNumber(): SellerPhoneNumber;
|
|
2021
|
+
type SellerPhoneNumber = {
|
|
2022
|
+
country_code: number;
|
|
2023
|
+
number: string;
|
|
2024
|
+
};
|
|
2025
|
+
/** @returns {SellerV3} */
|
|
2026
|
+
declare function SellerV3(): SellerV3;
|
|
2027
|
+
type SellerV3 = {
|
|
2028
|
+
count?: number;
|
|
2029
|
+
name?: string;
|
|
2030
|
+
uid?: number;
|
|
2031
|
+
};
|
|
2032
|
+
/** @returns {Size} */
|
|
2033
|
+
declare function Size(): Size;
|
|
2034
|
+
type Size = {
|
|
2035
|
+
/**
|
|
2036
|
+
* - The display string for the size
|
|
2037
|
+
*/
|
|
2038
|
+
display?: any;
|
|
2039
|
+
/**
|
|
2040
|
+
* - Whether or not this size is available
|
|
2041
|
+
*/
|
|
2042
|
+
is_available?: boolean;
|
|
2043
|
+
/**
|
|
2044
|
+
* - The quantity of this size available
|
|
2045
|
+
*/
|
|
2046
|
+
quantity?: number;
|
|
2047
|
+
/**
|
|
2048
|
+
* - The value of the size
|
|
2049
|
+
*/
|
|
2050
|
+
value?: any;
|
|
2051
|
+
};
|
|
2052
|
+
/** @returns {SizeChart} */
|
|
2053
|
+
declare function SizeChart(): SizeChart;
|
|
2054
|
+
type SizeChart = {
|
|
2055
|
+
description?: string;
|
|
2056
|
+
headers?: ColumnHeaders;
|
|
2057
|
+
image?: string;
|
|
2058
|
+
size_tip?: string;
|
|
2059
|
+
sizes?: SizeChartValues[];
|
|
2060
|
+
title?: string;
|
|
2061
|
+
unit?: string;
|
|
2062
|
+
};
|
|
2063
|
+
/** @returns {SizeChartValues} */
|
|
2064
|
+
declare function SizeChartValues(): SizeChartValues;
|
|
2065
|
+
type SizeChartValues = {
|
|
2066
|
+
col_1?: string;
|
|
2067
|
+
col_2?: string;
|
|
2068
|
+
col_3?: string;
|
|
2069
|
+
col_4?: string;
|
|
2070
|
+
col_5?: string;
|
|
2071
|
+
col_6?: string;
|
|
2072
|
+
};
|
|
2073
|
+
/** @returns {Store} */
|
|
2074
|
+
declare function Store(): Store;
|
|
2075
|
+
type Store = {
|
|
2076
|
+
address?: string;
|
|
2077
|
+
city?: string;
|
|
2078
|
+
country?: string;
|
|
2079
|
+
lat_long?: LatLong;
|
|
2080
|
+
name?: string;
|
|
2081
|
+
pincode?: number;
|
|
2082
|
+
state?: string;
|
|
2083
|
+
store_code?: string;
|
|
2084
|
+
store_email?: string;
|
|
2085
|
+
uid?: number;
|
|
2086
|
+
};
|
|
2087
|
+
/** @returns {StoreAddressSerializer} */
|
|
2088
|
+
declare function StoreAddressSerializer(): StoreAddressSerializer;
|
|
2089
|
+
type StoreAddressSerializer = {
|
|
2090
|
+
address1?: string;
|
|
2091
|
+
address2?: string;
|
|
2092
|
+
city?: string;
|
|
2093
|
+
country?: string;
|
|
2094
|
+
landmark?: string;
|
|
2095
|
+
latitude?: number;
|
|
2096
|
+
longitude?: number;
|
|
2097
|
+
pincode?: number;
|
|
2098
|
+
state?: string;
|
|
2099
|
+
};
|
|
2100
|
+
/** @returns {StoreDepartments} */
|
|
2101
|
+
declare function StoreDepartments(): StoreDepartments;
|
|
2102
|
+
type StoreDepartments = {
|
|
2103
|
+
logo?: any;
|
|
2104
|
+
name?: string;
|
|
2105
|
+
priority_order?: number;
|
|
2106
|
+
slug?: string;
|
|
2107
|
+
uid?: number;
|
|
2108
|
+
};
|
|
2109
|
+
/** @returns {StoreDetail} */
|
|
2110
|
+
declare function StoreDetail(): StoreDetail;
|
|
2111
|
+
type StoreDetail = {
|
|
2112
|
+
city?: string;
|
|
2113
|
+
code?: string;
|
|
2114
|
+
id?: number;
|
|
2115
|
+
name?: string;
|
|
2116
|
+
};
|
|
2117
|
+
/** @returns {StoreDetails} */
|
|
2118
|
+
declare function StoreDetails(): StoreDetails;
|
|
2119
|
+
type StoreDetails = {
|
|
2120
|
+
_custom_json?: any;
|
|
2121
|
+
address?: StoreAddressSerializer;
|
|
2122
|
+
company?: CompanyStore;
|
|
2123
|
+
contact_numbers?: SellerPhoneNumber[];
|
|
2124
|
+
departments?: StoreDepartments[];
|
|
2125
|
+
manager?: StoreManagerSerializer;
|
|
2126
|
+
name?: string;
|
|
2127
|
+
store_code?: string;
|
|
2128
|
+
timing?: StoreTiming[];
|
|
2129
|
+
uid?: number;
|
|
2130
|
+
};
|
|
2131
|
+
/** @returns {StoreListingResponse} */
|
|
2132
|
+
declare function StoreListingResponse(): StoreListingResponse;
|
|
2133
|
+
type StoreListingResponse = {
|
|
2134
|
+
items: Store[];
|
|
2135
|
+
page: Page;
|
|
2136
|
+
};
|
|
2137
|
+
/** @returns {StoreManagerSerializer} */
|
|
2138
|
+
declare function StoreManagerSerializer(): StoreManagerSerializer;
|
|
2139
|
+
type StoreManagerSerializer = {
|
|
2140
|
+
email?: string;
|
|
2141
|
+
mobile_no?: SellerPhoneNumber;
|
|
2142
|
+
name?: string;
|
|
2143
|
+
};
|
|
2144
|
+
/** @returns {StoreTiming} */
|
|
2145
|
+
declare function StoreTiming(): StoreTiming;
|
|
2146
|
+
type StoreTiming = {
|
|
2147
|
+
closing?: Time;
|
|
2148
|
+
open?: boolean;
|
|
2149
|
+
opening?: Time;
|
|
2150
|
+
weekday?: string;
|
|
2151
|
+
};
|
|
2152
|
+
/** @returns {StoreV3} */
|
|
2153
|
+
declare function StoreV3(): StoreV3;
|
|
2154
|
+
type StoreV3 = {
|
|
2155
|
+
count?: number;
|
|
2156
|
+
name?: string;
|
|
2157
|
+
uid?: number;
|
|
2158
|
+
};
|
|
2159
|
+
/** @returns {StrategyWiseListingSchemaV3} */
|
|
2160
|
+
declare function StrategyWiseListingSchemaV3(): StrategyWiseListingSchemaV3;
|
|
2161
|
+
type StrategyWiseListingSchemaV3 = {
|
|
2162
|
+
distance?: number;
|
|
2163
|
+
pincode?: number;
|
|
2164
|
+
quantity?: number;
|
|
2165
|
+
tat?: number;
|
|
2166
|
+
};
|
|
2167
|
+
/** @returns {ThirdLevelChild} */
|
|
2168
|
+
declare function ThirdLevelChild(): ThirdLevelChild;
|
|
2169
|
+
type ThirdLevelChild = {
|
|
2170
|
+
_custom_json?: any;
|
|
2171
|
+
action?: ProductListingAction;
|
|
2172
|
+
banners?: ImageUrls;
|
|
2173
|
+
childs?: any[];
|
|
2174
|
+
name?: string;
|
|
2175
|
+
slug?: string;
|
|
2176
|
+
uid?: number;
|
|
2177
|
+
};
|
|
2178
|
+
/** @returns {Time} */
|
|
2179
|
+
declare function Time(): Time;
|
|
2180
|
+
type Time = {
|
|
2181
|
+
hour?: number;
|
|
2182
|
+
minute?: number;
|
|
2183
|
+
};
|
|
2184
|
+
/** @returns {UserDetail} */
|
|
2185
|
+
declare function UserDetail(): UserDetail;
|
|
2186
|
+
type UserDetail = {
|
|
2187
|
+
/**
|
|
2188
|
+
* - The contact details of the user.
|
|
2189
|
+
*/
|
|
2190
|
+
contact?: string;
|
|
2191
|
+
/**
|
|
2192
|
+
* - A flag indicating whether the user is a super user.
|
|
2193
|
+
*/
|
|
2194
|
+
super_user?: boolean;
|
|
2195
|
+
/**
|
|
2196
|
+
* - The user ID of the user.
|
|
2197
|
+
*/
|
|
2198
|
+
user_id: string;
|
|
2199
|
+
/**
|
|
2200
|
+
* - The username of the user.
|
|
2201
|
+
*/
|
|
2202
|
+
username: string;
|
|
2203
|
+
};
|
|
2204
|
+
/** @returns {Weight} */
|
|
2205
|
+
declare function Weight(): Weight;
|
|
2206
|
+
type Weight = {
|
|
2207
|
+
/**
|
|
2208
|
+
* - Whether the weight is the default one or not
|
|
2209
|
+
*/
|
|
2210
|
+
is_default: boolean;
|
|
2211
|
+
/**
|
|
2212
|
+
* - The shipping weight of the product
|
|
2213
|
+
*/
|
|
2214
|
+
shipping: number;
|
|
2215
|
+
/**
|
|
2216
|
+
* - The unit of weight
|
|
2217
|
+
*/
|
|
2218
|
+
unit: string;
|
|
2219
|
+
};
|