@gofynd/fdk-client-javascript 1.4.8-beta.3 → 1.4.9
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 +26 -1
- package/package.json +2 -2
- package/sdk/application/ApplicationClient.d.ts +8 -0
- package/sdk/application/ApplicationClient.js +14 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +20 -20
- package/sdk/application/Cart/CartApplicationClient.js +20 -20
- package/sdk/application/Cart/CartApplicationModel.d.ts +2446 -664
- package/sdk/application/Cart/CartApplicationModel.js +783 -552
- package/sdk/application/Cart/CartApplicationValidator.d.ts +268 -194
- package/sdk/application/Cart/CartApplicationValidator.js +100 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +53 -53
- package/sdk/application/Catalog/CatalogApplicationClient.js +53 -53
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2012 -503
- package/sdk/application/Catalog/CatalogApplicationModel.js +603 -453
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +64 -64
- package/sdk/application/Catalog/CatalogApplicationValidator.js +32 -32
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Common/CommonApplicationModel.d.ts +170 -90
- package/sdk/application/Common/CommonApplicationModel.js +59 -58
- package/sdk/application/Common/CommonApplicationValidator.d.ts +8 -5
- package/sdk/application/Common/CommonApplicationValidator.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +170 -35
- package/sdk/application/Communication/CommunicationApplicationModel.js +54 -33
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +15 -15
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +15 -15
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +624 -443
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +259 -248
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +32 -24
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +14 -13
- package/sdk/application/Content/ContentApplicationClient.d.ts +16 -16
- package/sdk/application/Content/ContentApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationModel.d.ts +1205 -282
- package/sdk/application/Content/ContentApplicationModel.js +341 -277
- package/sdk/application/Content/ContentApplicationValidator.d.ts +28 -17
- package/sdk/application/Content/ContentApplicationValidator.js +11 -10
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +146 -37
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +38 -36
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Lead/LeadApplicationModel.d.ts +195 -134
- package/sdk/application/Lead/LeadApplicationModel.js +110 -67
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +8 -8
- package/sdk/application/Lead/LeadApplicationValidator.js +4 -4
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -10
- package/sdk/application/Logistic/LogisticApplicationClient.js +10 -10
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +1039 -221
- package/sdk/application/Logistic/LogisticApplicationModel.js +342 -199
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +76 -82
- package/sdk/application/Logistic/LogisticApplicationValidator.js +38 -41
- package/sdk/application/Order/OrderApplicationClient.d.ts +10 -10
- package/sdk/application/Order/OrderApplicationClient.js +10 -10
- package/sdk/application/Order/OrderApplicationModel.d.ts +1400 -325
- package/sdk/application/Order/OrderApplicationModel.js +391 -317
- package/sdk/application/Order/OrderApplicationValidator.d.ts +32 -30
- package/sdk/application/Order/OrderApplicationValidator.js +15 -14
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +43 -43
- package/sdk/application/Payment/PaymentApplicationClient.js +43 -43
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +1111 -1022
- package/sdk/application/Payment/PaymentApplicationModel.js +537 -521
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +82 -49
- package/sdk/application/Payment/PaymentApplicationValidator.js +30 -30
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +28 -7
- package/sdk/application/Rewards/RewardsApplicationModel.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +178 -38
- package/sdk/application/Share/ShareApplicationModel.js +53 -37
- package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -2
- package/sdk/application/Share/ShareApplicationValidator.js +2 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +14 -8
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +528 -287
- package/sdk/application/Theme/ThemeApplicationModel.js +208 -172
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +17 -12
- package/sdk/application/Theme/ThemeApplicationValidator.js +8 -6
- package/sdk/application/User/UserApplicationClient.d.ts +36 -36
- package/sdk/application/User/UserApplicationClient.js +36 -36
- package/sdk/application/User/UserApplicationModel.d.ts +1062 -255
- package/sdk/application/User/UserApplicationModel.js +298 -244
- package/sdk/application/User/UserApplicationValidator.d.ts +80 -80
- package/sdk/application/User/UserApplicationValidator.js +40 -40
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +20 -5
- package/sdk/application/Webhook/WebhookApplicationModel.js +5 -5
- package/sdk/common/Clickstream.js +95 -15
- package/sdk/common/Constant.d.ts +9 -0
- package/sdk/common/Constant.js +11 -0
- package/sdk/common/Utility.js +19 -0
- package/sdk/common/utils.js +8 -1
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +28 -7
- package/sdk/partner/Lead/LeadPartnerModel.js +7 -7
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +28 -7
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +7 -7
- package/sdk/partner/PartnerClient.d.ts +8 -0
- package/sdk/partner/PartnerClient.js +14 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +158 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +45 -6
- package/sdk/partner/Theme/ThemePartnerModel.js +33 -4
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +28 -7
- package/sdk/partner/Webhook/WebhookPartnerModel.js +7 -7
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +28 -7
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +7 -7
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +6 -397
- package/sdk/platform/Billing/BillingPlatformClient.js +77 -3215
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +621 -2021
- package/sdk/platform/Billing/BillingPlatformModel.js +353 -2405
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +12 -451
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -483
- package/sdk/platform/Cart/CartPlatformModel.d.ts +28 -7
- package/sdk/platform/Cart/CartPlatformModel.js +8 -8
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +12 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +41 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +46 -12
- package/sdk/platform/Catalog/CatalogPlatformModel.js +14 -11
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +40 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +17 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +28 -7
- package/sdk/platform/Communication/CommunicationPlatformModel.js +7 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +7 -7
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +0 -97
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +77 -782
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +24 -701
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +7 -539
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -183
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +0 -134
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -10
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +0 -79
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -15
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -13
- package/sdk/platform/Content/ContentPlatformModel.d.ts +58 -17
- package/sdk/platform/Content/ContentPlatformModel.js +28 -15
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +28 -7
- package/sdk/platform/Discount/DiscountPlatformModel.js +7 -7
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +127 -25
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +37 -25
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +28 -28
- package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +1583 -347
- package/sdk/platform/Finance/FinancePlatformModel.js +463 -351
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +28 -7
- package/sdk/platform/Lead/LeadPlatformModel.js +7 -7
- package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -0
- package/sdk/platform/Order/OrderPlatformClient.js +165 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +613 -39
- package/sdk/platform/Order/OrderPlatformModel.js +359 -41
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -1
- package/sdk/platform/Order/OrderPlatformValidator.js +28 -0
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +30 -9
- package/sdk/platform/Payment/PaymentPlatformModel.js +9 -9
- package/sdk/platform/PlatformClient.d.ts +8 -0
- package/sdk/platform/PlatformClient.js +14 -0
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +28 -7
- package/sdk/platform/Rewards/RewardsPlatformModel.js +7 -7
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +12 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +12 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +120 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +76 -21
- package/sdk/platform/Share/SharePlatformModel.d.ts +28 -7
- package/sdk/platform/Share/SharePlatformModel.js +7 -7
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +18 -5
- package/sdk/platform/Theme/ThemePlatformModel.js +7 -4
- package/sdk/platform/User/UserPlatformModel.d.ts +18 -18
- package/sdk/platform/User/UserPlatformModel.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +28 -7
- package/sdk/platform/Webhook/WebhookPlatformModel.js +7 -7
- package/sdk/public/PublicClient.d.ts +0 -4
- package/sdk/public/PublicClient.js +0 -8
- package/sdk/public/index.d.ts +0 -2
- package/sdk/public/index.js +0 -4
- package/sdk/public/Billing/BillingPublicClient.d.ts +0 -45
- package/sdk/public/Billing/BillingPublicClient.js +0 -269
- package/sdk/public/Billing/BillingPublicModel.d.ts +0 -434
- package/sdk/public/Billing/BillingPublicModel.js +0 -395
- package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -34
- package/sdk/public/Billing/BillingPublicValidator.js +0 -38
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +0 -87
- package/sdk/public/Inventory/InventoryPublicClient.js +0 -529
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +0 -393
- package/sdk/public/Inventory/InventoryPublicModel.js +0 -448
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +0 -91
- package/sdk/public/Inventory/InventoryPublicValidator.js +0 -85
|
@@ -16,7 +16,7 @@ export = CatalogApplicationValidator;
|
|
|
16
16
|
* @property {string} [department] - The name of the department. Use this
|
|
17
17
|
* parameter to filter products by a particular department. See the list of
|
|
18
18
|
* available departments below. Also, you can get available departments from
|
|
19
|
-
* the endpoint /service/application/catalog/v1.0/departments
|
|
19
|
+
* the endpoint /service/application/catalog/v1.0/departments/.
|
|
20
20
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
21
21
|
* set of results.
|
|
22
22
|
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
@@ -26,7 +26,7 @@ export = CatalogApplicationValidator;
|
|
|
26
26
|
* @property {string} [department] - The name of the department. Use this
|
|
27
27
|
* parameter to filter products by a particular department. See the list of
|
|
28
28
|
* available departments below. Also, you can get available departments from
|
|
29
|
-
* the endpoint /service/application/catalog/v1.0/departments
|
|
29
|
+
* the endpoint /service/application/catalog/v1.0/departments/.
|
|
30
30
|
*/
|
|
31
31
|
/**
|
|
32
32
|
* @typedef GetCategoryDetailBySlugParam
|
|
@@ -48,11 +48,11 @@ export = CatalogApplicationValidator;
|
|
|
48
48
|
* @property {string} [f] - The search filter parameters. Filter parameters will
|
|
49
49
|
* be passed in f parameter as shown in the example below. Double Pipe (||)
|
|
50
50
|
* denotes the OR condition, whereas Triple-colon (:::) indicates a new filter
|
|
51
|
-
*
|
|
51
|
+
* parameter applied as an AND condition.
|
|
52
52
|
* @property {string} [q] - The search query for entering partial or full name
|
|
53
53
|
* of product, brand, category, or collection.
|
|
54
|
-
* @property {boolean} [filters] -
|
|
55
|
-
*
|
|
54
|
+
* @property {boolean} [filters] - True for fetching all filter parameters and
|
|
55
|
+
* False for disabling the filter parameters.
|
|
56
56
|
* @property {string} [sortOn] - The order in which the list of products should
|
|
57
57
|
* be sorted, e.g. popularity, price, latest and discount, in either ascending
|
|
58
58
|
* or descending order. See the supported values below.
|
|
@@ -67,14 +67,14 @@ export = CatalogApplicationValidator;
|
|
|
67
67
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
68
68
|
* set of results.
|
|
69
69
|
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
70
|
-
* @property {string[]} [tag] - List of tags to filter collections
|
|
71
|
-
* @property {string} [q] - Name of the collection to filter collection
|
|
70
|
+
* @property {string[]} [tag] - List of tags to filter collections.
|
|
71
|
+
* @property {string} [q] - Name of the collection to filter collection.
|
|
72
72
|
*/
|
|
73
73
|
/**
|
|
74
74
|
* @typedef GetComparedFrequentlyProductBySlugParam
|
|
75
75
|
* @property {string} slug - A short, human-readable, URL-friendly identifier of
|
|
76
76
|
* a product. You can get slug value from the endpoint
|
|
77
|
-
* /service/application/catalog/v1.0/products
|
|
77
|
+
* /service/application/catalog/v1.0/products/.
|
|
78
78
|
*/
|
|
79
79
|
/** @typedef GetDepartmentsParam */
|
|
80
80
|
/**
|
|
@@ -111,11 +111,11 @@ export = CatalogApplicationValidator;
|
|
|
111
111
|
* @property {string} [q] - Search a store by its name or store_code.
|
|
112
112
|
* @property {string} [city] - Search stores by the city in which they are situated.
|
|
113
113
|
* @property {number} [range] - Use this to retrieve stores within a particular
|
|
114
|
-
* range in meters, e.g. 10000, to indicate a 10km range
|
|
114
|
+
* range in meters, e.g. 10000, to indicate a 10km range.
|
|
115
115
|
* @property {number} [latitude] - Latitude of the location from where one wants
|
|
116
|
-
* to
|
|
116
|
+
* to retrieve the nearest stores, e.g. 72.8691788.
|
|
117
117
|
* @property {number} [longitude] - Longitude of the location from where one
|
|
118
|
-
* wants to
|
|
118
|
+
* wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
119
119
|
*/
|
|
120
120
|
/**
|
|
121
121
|
* @typedef GetLocationDetailsByIdParam
|
|
@@ -124,7 +124,7 @@ export = CatalogApplicationValidator;
|
|
|
124
124
|
/**
|
|
125
125
|
* @typedef GetProductBundlesBySlugParam
|
|
126
126
|
* @property {string} [slug] - Product slug for which bundles need to be fetched.
|
|
127
|
-
* @property {string} [id] - Product uid
|
|
127
|
+
* @property {string} [id] - Product uid.
|
|
128
128
|
*/
|
|
129
129
|
/**
|
|
130
130
|
* @typedef GetProductComparisonBySlugsParam
|
|
@@ -136,16 +136,16 @@ export = CatalogApplicationValidator;
|
|
|
136
136
|
* @typedef GetProductDetailBySlugParam
|
|
137
137
|
* @property {string} slug - A short, human-readable, URL-friendly identifier of
|
|
138
138
|
* a product. You can get slug value from the endpoint
|
|
139
|
-
* /service/application/catalog/v1.0/products
|
|
139
|
+
* /service/application/catalog/v1.0/products/.
|
|
140
140
|
*/
|
|
141
141
|
/**
|
|
142
142
|
* @typedef GetProductPriceBySlugParam
|
|
143
143
|
* @property {string} slug - A short, human-readable, URL-friendly identifier of
|
|
144
144
|
* a product. You can get slug value from the endpoint
|
|
145
|
-
* /service/application/catalog/v1.0/products
|
|
145
|
+
* /service/application/catalog/v1.0/products/.
|
|
146
146
|
* @property {string} size - A string indicating the size of the product, e.g.
|
|
147
147
|
* S, M, XL. You can get slug value from the endpoint
|
|
148
|
-
* /service/application/catalog/v1.0/products/sizes
|
|
148
|
+
* /service/application/catalog/v1.0/products/sizes.
|
|
149
149
|
* @property {number} [storeId] - The ID of the store that is selling the
|
|
150
150
|
* product, e.g. 1,2,3.
|
|
151
151
|
* @property {number} [moq] - An Integer indication the Minimum Order Quantity
|
|
@@ -155,10 +155,10 @@ export = CatalogApplicationValidator;
|
|
|
155
155
|
* @typedef GetProductSellersBySlugParam
|
|
156
156
|
* @property {string} slug - A short, human-readable, URL-friendly identifier of
|
|
157
157
|
* a product. You can get slug value from the endpoint
|
|
158
|
-
* /service/application/catalog/v1.0/products
|
|
158
|
+
* /service/application/catalog/v1.0/products/.
|
|
159
159
|
* @property {string} size - A string indicating the size of the product, e.g.
|
|
160
160
|
* S, M, XL. You can get slug value from the endpoint
|
|
161
|
-
* /service/application/catalog/v1.0/products/sizes
|
|
161
|
+
* /service/application/catalog/v1.0/products/sizes.
|
|
162
162
|
* @property {string} [strategy] - Sort stores on the basis of strategy. eg,
|
|
163
163
|
* fast-delivery, low-price, optimal.
|
|
164
164
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
@@ -169,25 +169,25 @@ export = CatalogApplicationValidator;
|
|
|
169
169
|
* @typedef GetProductSizesBySlugParam
|
|
170
170
|
* @property {string} slug - A short, human-readable, URL-friendly identifier of
|
|
171
171
|
* a product. You can get slug value from the endpoint
|
|
172
|
-
* /service/application/catalog/v1.0/products
|
|
172
|
+
* /service/application/catalog/v1.0/products/.
|
|
173
173
|
* @property {number} [storeId] - The ID of the store that is selling the
|
|
174
174
|
* product, e.g. 1,2,3.
|
|
175
175
|
*/
|
|
176
176
|
/**
|
|
177
177
|
* @typedef GetProductStockByIdsParam
|
|
178
|
-
* @property {string} [itemId] - The Item ID of the product (Max. 50 allowed)
|
|
178
|
+
* @property {string} [itemId] - The Item ID of the product (Max. 50 allowed).
|
|
179
179
|
* @property {string} [alu] - ALU of the product (limited upto 50 ALU identifier
|
|
180
|
-
* in a single request)
|
|
180
|
+
* in a single request).
|
|
181
181
|
* @property {string} [skuCode] - Stock-keeping Unit of the product (limited
|
|
182
|
-
* upto 50 SKU Code in a single request)
|
|
182
|
+
* upto 50 SKU Code in a single request).
|
|
183
183
|
* @property {string} [ean] - European Article Number of the product (limited
|
|
184
|
-
* upto 50 EAN identifier in a single request)
|
|
184
|
+
* upto 50 EAN identifier in a single request).
|
|
185
185
|
* @property {string} [upc] - Universal Product Code of the product (limited
|
|
186
|
-
* upto 50 UPC identifier in a single request)
|
|
186
|
+
* upto 50 UPC identifier in a single request).
|
|
187
187
|
*/
|
|
188
188
|
/**
|
|
189
189
|
* @typedef GetProductStockForTimeByIdsParam
|
|
190
|
-
* @property {string} timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z)
|
|
190
|
+
* @property {string} timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z).
|
|
191
191
|
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
192
192
|
* @property {string} [pageId] - Page ID to retrieve next set of results.
|
|
193
193
|
*/
|
|
@@ -195,7 +195,7 @@ export = CatalogApplicationValidator;
|
|
|
195
195
|
* @typedef GetProductVariantsBySlugParam
|
|
196
196
|
* @property {string} slug - A short, human-readable, URL-friendly identifier of
|
|
197
197
|
* a product. You can get slug value from the endpoint
|
|
198
|
-
* /service/application/catalog/v1.0/products
|
|
198
|
+
* /service/application/catalog/v1.0/products/.
|
|
199
199
|
*/
|
|
200
200
|
/**
|
|
201
201
|
* @typedef GetProductsParam
|
|
@@ -204,9 +204,9 @@ export = CatalogApplicationValidator;
|
|
|
204
204
|
* @property {string} [f] - The search filter parameters. Filter parameters will
|
|
205
205
|
* be passed in f parameter as shown in the example below. Double Pipe (||)
|
|
206
206
|
* denotes the OR condition, whereas Triple-colon (:::) indicates a new filter
|
|
207
|
-
*
|
|
208
|
-
* @property {boolean} [filters] -
|
|
209
|
-
*
|
|
207
|
+
* parameter applied as an AND condition.
|
|
208
|
+
* @property {boolean} [filters] - True for fetching all filter parameters and
|
|
209
|
+
* False for disabling the filter parameters.
|
|
210
210
|
* @property {string} [sortOn] - The order in which the list of products should
|
|
211
211
|
* be sorted, e.g. popularity, price, latest and discount, in either ascending
|
|
212
212
|
* or descending order. See the supported values below.
|
|
@@ -227,7 +227,7 @@ export = CatalogApplicationValidator;
|
|
|
227
227
|
* @typedef GetSimilarComparisonProductBySlugParam
|
|
228
228
|
* @property {string} slug - A short, human-readable, URL-friendly identifier of
|
|
229
229
|
* a product. You can get slug value from the endpoint
|
|
230
|
-
* /service/application/catalog/v1.0/products
|
|
230
|
+
* /service/application/catalog/v1.0/products/.
|
|
231
231
|
*/
|
|
232
232
|
/**
|
|
233
233
|
* @typedef GetStoresParam
|
|
@@ -237,11 +237,11 @@ export = CatalogApplicationValidator;
|
|
|
237
237
|
* @property {string} [q] - Search a store by its name or store_code.
|
|
238
238
|
* @property {string} [city] - Search stores by the city in which they are situated.
|
|
239
239
|
* @property {number} [range] - Use this to retrieve stores within a particular
|
|
240
|
-
* range in meters, e.g. 10000, to indicate a 10km range
|
|
240
|
+
* range in meters, e.g. 10000, to indicate a 10km range.
|
|
241
241
|
* @property {number} [latitude] - Latitude of the location from where one wants
|
|
242
|
-
* to
|
|
242
|
+
* to retrieve the nearest stores, e.g. 72.8691788.
|
|
243
243
|
* @property {number} [longitude] - Longitude of the location from where one
|
|
244
|
-
* wants to
|
|
244
|
+
* wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
245
245
|
* @property {string} [tags] - Search stores based on tags.
|
|
246
246
|
*/
|
|
247
247
|
/**
|
|
@@ -339,7 +339,7 @@ type GetBrandsParam = {
|
|
|
339
339
|
* - The name of the department. Use this
|
|
340
340
|
* parameter to filter products by a particular department. See the list of
|
|
341
341
|
* available departments below. Also, you can get available departments from
|
|
342
|
-
* the endpoint /service/application/catalog/v1.0/departments
|
|
342
|
+
* the endpoint /service/application/catalog/v1.0/departments/.
|
|
343
343
|
*/
|
|
344
344
|
department?: string;
|
|
345
345
|
/**
|
|
@@ -357,7 +357,7 @@ type GetCategoriesParam = {
|
|
|
357
357
|
* - The name of the department. Use this
|
|
358
358
|
* parameter to filter products by a particular department. See the list of
|
|
359
359
|
* available departments below. Also, you can get available departments from
|
|
360
|
-
* the endpoint /service/application/catalog/v1.0/departments
|
|
360
|
+
* the endpoint /service/application/catalog/v1.0/departments/.
|
|
361
361
|
*/
|
|
362
362
|
department?: string;
|
|
363
363
|
};
|
|
@@ -388,7 +388,7 @@ type GetCollectionItemsBySlugParam = {
|
|
|
388
388
|
* - The search filter parameters. Filter parameters will
|
|
389
389
|
* be passed in f parameter as shown in the example below. Double Pipe (||)
|
|
390
390
|
* denotes the OR condition, whereas Triple-colon (:::) indicates a new filter
|
|
391
|
-
*
|
|
391
|
+
* parameter applied as an AND condition.
|
|
392
392
|
*/
|
|
393
393
|
f?: string;
|
|
394
394
|
/**
|
|
@@ -397,8 +397,8 @@ type GetCollectionItemsBySlugParam = {
|
|
|
397
397
|
*/
|
|
398
398
|
q?: string;
|
|
399
399
|
/**
|
|
400
|
-
* -
|
|
401
|
-
*
|
|
400
|
+
* - True for fetching all filter parameters and
|
|
401
|
+
* False for disabling the filter parameters.
|
|
402
402
|
*/
|
|
403
403
|
filters?: boolean;
|
|
404
404
|
/**
|
|
@@ -436,11 +436,11 @@ type GetCollectionsParam = {
|
|
|
436
436
|
*/
|
|
437
437
|
pageSize?: number;
|
|
438
438
|
/**
|
|
439
|
-
* - List of tags to filter collections
|
|
439
|
+
* - List of tags to filter collections.
|
|
440
440
|
*/
|
|
441
441
|
tag?: string[];
|
|
442
442
|
/**
|
|
443
|
-
* - Name of the collection to filter collection
|
|
443
|
+
* - Name of the collection to filter collection.
|
|
444
444
|
*/
|
|
445
445
|
q?: string;
|
|
446
446
|
};
|
|
@@ -448,7 +448,7 @@ type GetComparedFrequentlyProductBySlugParam = {
|
|
|
448
448
|
/**
|
|
449
449
|
* - A short, human-readable, URL-friendly identifier of
|
|
450
450
|
* a product. You can get slug value from the endpoint
|
|
451
|
-
* /service/application/catalog/v1.0/products
|
|
451
|
+
* /service/application/catalog/v1.0/products/.
|
|
452
452
|
*/
|
|
453
453
|
slug: string;
|
|
454
454
|
};
|
|
@@ -521,17 +521,17 @@ type GetInStockLocationsParam = {
|
|
|
521
521
|
city?: string;
|
|
522
522
|
/**
|
|
523
523
|
* - Use this to retrieve stores within a particular
|
|
524
|
-
* range in meters, e.g. 10000, to indicate a 10km range
|
|
524
|
+
* range in meters, e.g. 10000, to indicate a 10km range.
|
|
525
525
|
*/
|
|
526
526
|
range?: number;
|
|
527
527
|
/**
|
|
528
528
|
* - Latitude of the location from where one wants
|
|
529
|
-
* to
|
|
529
|
+
* to retrieve the nearest stores, e.g. 72.8691788.
|
|
530
530
|
*/
|
|
531
531
|
latitude?: number;
|
|
532
532
|
/**
|
|
533
533
|
* - Longitude of the location from where one
|
|
534
|
-
* wants to
|
|
534
|
+
* wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
535
535
|
*/
|
|
536
536
|
longitude?: number;
|
|
537
537
|
};
|
|
@@ -547,7 +547,7 @@ type GetProductBundlesBySlugParam = {
|
|
|
547
547
|
*/
|
|
548
548
|
slug?: string;
|
|
549
549
|
/**
|
|
550
|
-
* - Product uid
|
|
550
|
+
* - Product uid.
|
|
551
551
|
*/
|
|
552
552
|
id?: string;
|
|
553
553
|
};
|
|
@@ -563,7 +563,7 @@ type GetProductDetailBySlugParam = {
|
|
|
563
563
|
/**
|
|
564
564
|
* - A short, human-readable, URL-friendly identifier of
|
|
565
565
|
* a product. You can get slug value from the endpoint
|
|
566
|
-
* /service/application/catalog/v1.0/products
|
|
566
|
+
* /service/application/catalog/v1.0/products/.
|
|
567
567
|
*/
|
|
568
568
|
slug: string;
|
|
569
569
|
};
|
|
@@ -571,13 +571,13 @@ type GetProductPriceBySlugParam = {
|
|
|
571
571
|
/**
|
|
572
572
|
* - A short, human-readable, URL-friendly identifier of
|
|
573
573
|
* a product. You can get slug value from the endpoint
|
|
574
|
-
* /service/application/catalog/v1.0/products
|
|
574
|
+
* /service/application/catalog/v1.0/products/.
|
|
575
575
|
*/
|
|
576
576
|
slug: string;
|
|
577
577
|
/**
|
|
578
578
|
* - A string indicating the size of the product, e.g.
|
|
579
579
|
* S, M, XL. You can get slug value from the endpoint
|
|
580
|
-
* /service/application/catalog/v1.0/products/sizes
|
|
580
|
+
* /service/application/catalog/v1.0/products/sizes.
|
|
581
581
|
*/
|
|
582
582
|
size: string;
|
|
583
583
|
/**
|
|
@@ -595,13 +595,13 @@ type GetProductSellersBySlugParam = {
|
|
|
595
595
|
/**
|
|
596
596
|
* - A short, human-readable, URL-friendly identifier of
|
|
597
597
|
* a product. You can get slug value from the endpoint
|
|
598
|
-
* /service/application/catalog/v1.0/products
|
|
598
|
+
* /service/application/catalog/v1.0/products/.
|
|
599
599
|
*/
|
|
600
600
|
slug: string;
|
|
601
601
|
/**
|
|
602
602
|
* - A string indicating the size of the product, e.g.
|
|
603
603
|
* S, M, XL. You can get slug value from the endpoint
|
|
604
|
-
* /service/application/catalog/v1.0/products/sizes
|
|
604
|
+
* /service/application/catalog/v1.0/products/sizes.
|
|
605
605
|
*/
|
|
606
606
|
size: string;
|
|
607
607
|
/**
|
|
@@ -623,7 +623,7 @@ type GetProductSizesBySlugParam = {
|
|
|
623
623
|
/**
|
|
624
624
|
* - A short, human-readable, URL-friendly identifier of
|
|
625
625
|
* a product. You can get slug value from the endpoint
|
|
626
|
-
* /service/application/catalog/v1.0/products
|
|
626
|
+
* /service/application/catalog/v1.0/products/.
|
|
627
627
|
*/
|
|
628
628
|
slug: string;
|
|
629
629
|
/**
|
|
@@ -634,33 +634,33 @@ type GetProductSizesBySlugParam = {
|
|
|
634
634
|
};
|
|
635
635
|
type GetProductStockByIdsParam = {
|
|
636
636
|
/**
|
|
637
|
-
* - The Item ID of the product (Max. 50 allowed)
|
|
637
|
+
* - The Item ID of the product (Max. 50 allowed).
|
|
638
638
|
*/
|
|
639
639
|
itemId?: string;
|
|
640
640
|
/**
|
|
641
641
|
* - ALU of the product (limited upto 50 ALU identifier
|
|
642
|
-
* in a single request)
|
|
642
|
+
* in a single request).
|
|
643
643
|
*/
|
|
644
644
|
alu?: string;
|
|
645
645
|
/**
|
|
646
646
|
* - Stock-keeping Unit of the product (limited
|
|
647
|
-
* upto 50 SKU Code in a single request)
|
|
647
|
+
* upto 50 SKU Code in a single request).
|
|
648
648
|
*/
|
|
649
649
|
skuCode?: string;
|
|
650
650
|
/**
|
|
651
651
|
* - European Article Number of the product (limited
|
|
652
|
-
* upto 50 EAN identifier in a single request)
|
|
652
|
+
* upto 50 EAN identifier in a single request).
|
|
653
653
|
*/
|
|
654
654
|
ean?: string;
|
|
655
655
|
/**
|
|
656
656
|
* - Universal Product Code of the product (limited
|
|
657
|
-
* upto 50 UPC identifier in a single request)
|
|
657
|
+
* upto 50 UPC identifier in a single request).
|
|
658
658
|
*/
|
|
659
659
|
upc?: string;
|
|
660
660
|
};
|
|
661
661
|
type GetProductStockForTimeByIdsParam = {
|
|
662
662
|
/**
|
|
663
|
-
* - Timestamp in UTC format (2020-07-23T10:27:50Z)
|
|
663
|
+
* - Timestamp in UTC format (2020-07-23T10:27:50Z).
|
|
664
664
|
*/
|
|
665
665
|
timestamp: string;
|
|
666
666
|
/**
|
|
@@ -676,7 +676,7 @@ type GetProductVariantsBySlugParam = {
|
|
|
676
676
|
/**
|
|
677
677
|
* - A short, human-readable, URL-friendly identifier of
|
|
678
678
|
* a product. You can get slug value from the endpoint
|
|
679
|
-
* /service/application/catalog/v1.0/products
|
|
679
|
+
* /service/application/catalog/v1.0/products/.
|
|
680
680
|
*/
|
|
681
681
|
slug: string;
|
|
682
682
|
};
|
|
@@ -690,12 +690,12 @@ type GetProductsParam = {
|
|
|
690
690
|
* - The search filter parameters. Filter parameters will
|
|
691
691
|
* be passed in f parameter as shown in the example below. Double Pipe (||)
|
|
692
692
|
* denotes the OR condition, whereas Triple-colon (:::) indicates a new filter
|
|
693
|
-
*
|
|
693
|
+
* parameter applied as an AND condition.
|
|
694
694
|
*/
|
|
695
695
|
f?: string;
|
|
696
696
|
/**
|
|
697
|
-
* -
|
|
698
|
-
*
|
|
697
|
+
* - True for fetching all filter parameters and
|
|
698
|
+
* False for disabling the filter parameters.
|
|
699
699
|
*/
|
|
700
700
|
filters?: boolean;
|
|
701
701
|
/**
|
|
@@ -735,7 +735,7 @@ type GetSimilarComparisonProductBySlugParam = {
|
|
|
735
735
|
/**
|
|
736
736
|
* - A short, human-readable, URL-friendly identifier of
|
|
737
737
|
* a product. You can get slug value from the endpoint
|
|
738
|
-
* /service/application/catalog/v1.0/products
|
|
738
|
+
* /service/application/catalog/v1.0/products/.
|
|
739
739
|
*/
|
|
740
740
|
slug: string;
|
|
741
741
|
};
|
|
@@ -759,17 +759,17 @@ type GetStoresParam = {
|
|
|
759
759
|
city?: string;
|
|
760
760
|
/**
|
|
761
761
|
* - Use this to retrieve stores within a particular
|
|
762
|
-
* range in meters, e.g. 10000, to indicate a 10km range
|
|
762
|
+
* range in meters, e.g. 10000, to indicate a 10km range.
|
|
763
763
|
*/
|
|
764
764
|
range?: number;
|
|
765
765
|
/**
|
|
766
766
|
* - Latitude of the location from where one wants
|
|
767
|
-
* to
|
|
767
|
+
* to retrieve the nearest stores, e.g. 72.8691788.
|
|
768
768
|
*/
|
|
769
769
|
latitude?: number;
|
|
770
770
|
/**
|
|
771
771
|
* - Longitude of the location from where one
|
|
772
|
-
* wants to
|
|
772
|
+
* wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
773
773
|
*/
|
|
774
774
|
longitude?: number;
|
|
775
775
|
/**
|
|
@@ -21,7 +21,7 @@ const CatalogApplicationModel = require("./CatalogApplicationModel");
|
|
|
21
21
|
* @property {string} [department] - The name of the department. Use this
|
|
22
22
|
* parameter to filter products by a particular department. See the list of
|
|
23
23
|
* available departments below. Also, you can get available departments from
|
|
24
|
-
* the endpoint /service/application/catalog/v1.0/departments
|
|
24
|
+
* the endpoint /service/application/catalog/v1.0/departments/.
|
|
25
25
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
26
26
|
* set of results.
|
|
27
27
|
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
@@ -32,7 +32,7 @@ const CatalogApplicationModel = require("./CatalogApplicationModel");
|
|
|
32
32
|
* @property {string} [department] - The name of the department. Use this
|
|
33
33
|
* parameter to filter products by a particular department. See the list of
|
|
34
34
|
* available departments below. Also, you can get available departments from
|
|
35
|
-
* the endpoint /service/application/catalog/v1.0/departments
|
|
35
|
+
* the endpoint /service/application/catalog/v1.0/departments/.
|
|
36
36
|
*/
|
|
37
37
|
|
|
38
38
|
/**
|
|
@@ -57,11 +57,11 @@ const CatalogApplicationModel = require("./CatalogApplicationModel");
|
|
|
57
57
|
* @property {string} [f] - The search filter parameters. Filter parameters will
|
|
58
58
|
* be passed in f parameter as shown in the example below. Double Pipe (||)
|
|
59
59
|
* denotes the OR condition, whereas Triple-colon (:::) indicates a new filter
|
|
60
|
-
*
|
|
60
|
+
* parameter applied as an AND condition.
|
|
61
61
|
* @property {string} [q] - The search query for entering partial or full name
|
|
62
62
|
* of product, brand, category, or collection.
|
|
63
|
-
* @property {boolean} [filters] -
|
|
64
|
-
*
|
|
63
|
+
* @property {boolean} [filters] - True for fetching all filter parameters and
|
|
64
|
+
* False for disabling the filter parameters.
|
|
65
65
|
* @property {string} [sortOn] - The order in which the list of products should
|
|
66
66
|
* be sorted, e.g. popularity, price, latest and discount, in either ascending
|
|
67
67
|
* or descending order. See the supported values below.
|
|
@@ -77,15 +77,15 @@ const CatalogApplicationModel = require("./CatalogApplicationModel");
|
|
|
77
77
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
78
78
|
* set of results.
|
|
79
79
|
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
80
|
-
* @property {string[]} [tag] - List of tags to filter collections
|
|
81
|
-
* @property {string} [q] - Name of the collection to filter collection
|
|
80
|
+
* @property {string[]} [tag] - List of tags to filter collections.
|
|
81
|
+
* @property {string} [q] - Name of the collection to filter collection.
|
|
82
82
|
*/
|
|
83
83
|
|
|
84
84
|
/**
|
|
85
85
|
* @typedef GetComparedFrequentlyProductBySlugParam
|
|
86
86
|
* @property {string} slug - A short, human-readable, URL-friendly identifier of
|
|
87
87
|
* a product. You can get slug value from the endpoint
|
|
88
|
-
* /service/application/catalog/v1.0/products
|
|
88
|
+
* /service/application/catalog/v1.0/products/.
|
|
89
89
|
*/
|
|
90
90
|
|
|
91
91
|
/** @typedef GetDepartmentsParam */
|
|
@@ -128,11 +128,11 @@ const CatalogApplicationModel = require("./CatalogApplicationModel");
|
|
|
128
128
|
* @property {string} [q] - Search a store by its name or store_code.
|
|
129
129
|
* @property {string} [city] - Search stores by the city in which they are situated.
|
|
130
130
|
* @property {number} [range] - Use this to retrieve stores within a particular
|
|
131
|
-
* range in meters, e.g. 10000, to indicate a 10km range
|
|
131
|
+
* range in meters, e.g. 10000, to indicate a 10km range.
|
|
132
132
|
* @property {number} [latitude] - Latitude of the location from where one wants
|
|
133
|
-
* to
|
|
133
|
+
* to retrieve the nearest stores, e.g. 72.8691788.
|
|
134
134
|
* @property {number} [longitude] - Longitude of the location from where one
|
|
135
|
-
* wants to
|
|
135
|
+
* wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
136
136
|
*/
|
|
137
137
|
|
|
138
138
|
/**
|
|
@@ -143,7 +143,7 @@ const CatalogApplicationModel = require("./CatalogApplicationModel");
|
|
|
143
143
|
/**
|
|
144
144
|
* @typedef GetProductBundlesBySlugParam
|
|
145
145
|
* @property {string} [slug] - Product slug for which bundles need to be fetched.
|
|
146
|
-
* @property {string} [id] - Product uid
|
|
146
|
+
* @property {string} [id] - Product uid.
|
|
147
147
|
*/
|
|
148
148
|
|
|
149
149
|
/**
|
|
@@ -157,17 +157,17 @@ const CatalogApplicationModel = require("./CatalogApplicationModel");
|
|
|
157
157
|
* @typedef GetProductDetailBySlugParam
|
|
158
158
|
* @property {string} slug - A short, human-readable, URL-friendly identifier of
|
|
159
159
|
* a product. You can get slug value from the endpoint
|
|
160
|
-
* /service/application/catalog/v1.0/products
|
|
160
|
+
* /service/application/catalog/v1.0/products/.
|
|
161
161
|
*/
|
|
162
162
|
|
|
163
163
|
/**
|
|
164
164
|
* @typedef GetProductPriceBySlugParam
|
|
165
165
|
* @property {string} slug - A short, human-readable, URL-friendly identifier of
|
|
166
166
|
* a product. You can get slug value from the endpoint
|
|
167
|
-
* /service/application/catalog/v1.0/products
|
|
167
|
+
* /service/application/catalog/v1.0/products/.
|
|
168
168
|
* @property {string} size - A string indicating the size of the product, e.g.
|
|
169
169
|
* S, M, XL. You can get slug value from the endpoint
|
|
170
|
-
* /service/application/catalog/v1.0/products/sizes
|
|
170
|
+
* /service/application/catalog/v1.0/products/sizes.
|
|
171
171
|
* @property {number} [storeId] - The ID of the store that is selling the
|
|
172
172
|
* product, e.g. 1,2,3.
|
|
173
173
|
* @property {number} [moq] - An Integer indication the Minimum Order Quantity
|
|
@@ -178,10 +178,10 @@ const CatalogApplicationModel = require("./CatalogApplicationModel");
|
|
|
178
178
|
* @typedef GetProductSellersBySlugParam
|
|
179
179
|
* @property {string} slug - A short, human-readable, URL-friendly identifier of
|
|
180
180
|
* a product. You can get slug value from the endpoint
|
|
181
|
-
* /service/application/catalog/v1.0/products
|
|
181
|
+
* /service/application/catalog/v1.0/products/.
|
|
182
182
|
* @property {string} size - A string indicating the size of the product, e.g.
|
|
183
183
|
* S, M, XL. You can get slug value from the endpoint
|
|
184
|
-
* /service/application/catalog/v1.0/products/sizes
|
|
184
|
+
* /service/application/catalog/v1.0/products/sizes.
|
|
185
185
|
* @property {string} [strategy] - Sort stores on the basis of strategy. eg,
|
|
186
186
|
* fast-delivery, low-price, optimal.
|
|
187
187
|
* @property {number} [pageNo] - The page number to navigate through the given
|
|
@@ -193,27 +193,27 @@ const CatalogApplicationModel = require("./CatalogApplicationModel");
|
|
|
193
193
|
* @typedef GetProductSizesBySlugParam
|
|
194
194
|
* @property {string} slug - A short, human-readable, URL-friendly identifier of
|
|
195
195
|
* a product. You can get slug value from the endpoint
|
|
196
|
-
* /service/application/catalog/v1.0/products
|
|
196
|
+
* /service/application/catalog/v1.0/products/.
|
|
197
197
|
* @property {number} [storeId] - The ID of the store that is selling the
|
|
198
198
|
* product, e.g. 1,2,3.
|
|
199
199
|
*/
|
|
200
200
|
|
|
201
201
|
/**
|
|
202
202
|
* @typedef GetProductStockByIdsParam
|
|
203
|
-
* @property {string} [itemId] - The Item ID of the product (Max. 50 allowed)
|
|
203
|
+
* @property {string} [itemId] - The Item ID of the product (Max. 50 allowed).
|
|
204
204
|
* @property {string} [alu] - ALU of the product (limited upto 50 ALU identifier
|
|
205
|
-
* in a single request)
|
|
205
|
+
* in a single request).
|
|
206
206
|
* @property {string} [skuCode] - Stock-keeping Unit of the product (limited
|
|
207
|
-
* upto 50 SKU Code in a single request)
|
|
207
|
+
* upto 50 SKU Code in a single request).
|
|
208
208
|
* @property {string} [ean] - European Article Number of the product (limited
|
|
209
|
-
* upto 50 EAN identifier in a single request)
|
|
209
|
+
* upto 50 EAN identifier in a single request).
|
|
210
210
|
* @property {string} [upc] - Universal Product Code of the product (limited
|
|
211
|
-
* upto 50 UPC identifier in a single request)
|
|
211
|
+
* upto 50 UPC identifier in a single request).
|
|
212
212
|
*/
|
|
213
213
|
|
|
214
214
|
/**
|
|
215
215
|
* @typedef GetProductStockForTimeByIdsParam
|
|
216
|
-
* @property {string} timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z)
|
|
216
|
+
* @property {string} timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z).
|
|
217
217
|
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
218
218
|
* @property {string} [pageId] - Page ID to retrieve next set of results.
|
|
219
219
|
*/
|
|
@@ -222,7 +222,7 @@ const CatalogApplicationModel = require("./CatalogApplicationModel");
|
|
|
222
222
|
* @typedef GetProductVariantsBySlugParam
|
|
223
223
|
* @property {string} slug - A short, human-readable, URL-friendly identifier of
|
|
224
224
|
* a product. You can get slug value from the endpoint
|
|
225
|
-
* /service/application/catalog/v1.0/products
|
|
225
|
+
* /service/application/catalog/v1.0/products/.
|
|
226
226
|
*/
|
|
227
227
|
|
|
228
228
|
/**
|
|
@@ -232,9 +232,9 @@ const CatalogApplicationModel = require("./CatalogApplicationModel");
|
|
|
232
232
|
* @property {string} [f] - The search filter parameters. Filter parameters will
|
|
233
233
|
* be passed in f parameter as shown in the example below. Double Pipe (||)
|
|
234
234
|
* denotes the OR condition, whereas Triple-colon (:::) indicates a new filter
|
|
235
|
-
*
|
|
236
|
-
* @property {boolean} [filters] -
|
|
237
|
-
*
|
|
235
|
+
* parameter applied as an AND condition.
|
|
236
|
+
* @property {boolean} [filters] - True for fetching all filter parameters and
|
|
237
|
+
* False for disabling the filter parameters.
|
|
238
238
|
* @property {string} [sortOn] - The order in which the list of products should
|
|
239
239
|
* be sorted, e.g. popularity, price, latest and discount, in either ascending
|
|
240
240
|
* or descending order. See the supported values below.
|
|
@@ -257,7 +257,7 @@ const CatalogApplicationModel = require("./CatalogApplicationModel");
|
|
|
257
257
|
* @typedef GetSimilarComparisonProductBySlugParam
|
|
258
258
|
* @property {string} slug - A short, human-readable, URL-friendly identifier of
|
|
259
259
|
* a product. You can get slug value from the endpoint
|
|
260
|
-
* /service/application/catalog/v1.0/products
|
|
260
|
+
* /service/application/catalog/v1.0/products/.
|
|
261
261
|
*/
|
|
262
262
|
|
|
263
263
|
/**
|
|
@@ -268,11 +268,11 @@ const CatalogApplicationModel = require("./CatalogApplicationModel");
|
|
|
268
268
|
* @property {string} [q] - Search a store by its name or store_code.
|
|
269
269
|
* @property {string} [city] - Search stores by the city in which they are situated.
|
|
270
270
|
* @property {number} [range] - Use this to retrieve stores within a particular
|
|
271
|
-
* range in meters, e.g. 10000, to indicate a 10km range
|
|
271
|
+
* range in meters, e.g. 10000, to indicate a 10km range.
|
|
272
272
|
* @property {number} [latitude] - Latitude of the location from where one wants
|
|
273
|
-
* to
|
|
273
|
+
* to retrieve the nearest stores, e.g. 72.8691788.
|
|
274
274
|
* @property {number} [longitude] - Longitude of the location from where one
|
|
275
|
-
* wants to
|
|
275
|
+
* wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
276
276
|
* @property {string} [tags] - Search stores based on tags.
|
|
277
277
|
*/
|
|
278
278
|
|
|
@@ -15,7 +15,7 @@ declare class Common {
|
|
|
15
15
|
* @returns {Promise<CommonApplicationModel.Locations>} - Success response
|
|
16
16
|
* @name getLocations
|
|
17
17
|
* @summary: Get a location
|
|
18
|
-
* @description:
|
|
18
|
+
* @description: Get countries , state , cities data associated with the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/getLocations/).
|
|
19
19
|
*/
|
|
20
20
|
getLocations({ locationType, id, requestHeaders }?: CommonApplicationValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CommonApplicationModel.Locations>;
|
|
21
21
|
/**
|
|
@@ -25,7 +25,7 @@ declare class Common {
|
|
|
25
25
|
* @returns {Promise<CommonApplicationModel.ApplicationResponse>} - Success response
|
|
26
26
|
* @name searchApplication
|
|
27
27
|
* @summary: Get sales channel
|
|
28
|
-
* @description:
|
|
28
|
+
* @description: Get an active sales channel based on a provided query. The query can be a valid sales channel ID or a verified domain name. If the sales channel is found, a success response is returned. If not, a 404 error response is returned. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/searchApplication/).
|
|
29
29
|
*/
|
|
30
30
|
searchApplication({ authorization, query, requestHeaders }?: CommonApplicationValidator.SearchApplicationParam, { responseHeaders }?: object): Promise<CommonApplicationModel.ApplicationResponse>;
|
|
31
31
|
}
|
|
@@ -41,7 +41,7 @@ class Common {
|
|
|
41
41
|
* @returns {Promise<CommonApplicationModel.Locations>} - Success response
|
|
42
42
|
* @name getLocations
|
|
43
43
|
* @summary: Get a location
|
|
44
|
-
* @description:
|
|
44
|
+
* @description: Get countries , state , cities data associated with the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/getLocations/).
|
|
45
45
|
*/
|
|
46
46
|
async getLocations(
|
|
47
47
|
{ locationType, id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -121,7 +121,7 @@ class Common {
|
|
|
121
121
|
* @returns {Promise<CommonApplicationModel.ApplicationResponse>} - Success response
|
|
122
122
|
* @name searchApplication
|
|
123
123
|
* @summary: Get sales channel
|
|
124
|
-
* @description:
|
|
124
|
+
* @description: Get an active sales channel based on a provided query. The query can be a valid sales channel ID or a verified domain name. If the sales channel is found, a success response is returned. If not, a 404 error response is returned. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/searchApplication/).
|
|
125
125
|
*/
|
|
126
126
|
async searchApplication(
|
|
127
127
|
{ authorization, query, requestHeaders } = { requestHeaders: {} },
|