@gofynd/fdk-client-javascript 1.4.15-beta.1 → 1.4.15-beta.11
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 +2 -2
- package/application.d.ts +1 -2
- package/application.js +2 -3
- package/index.d.ts +1 -2
- package/index.js +7 -1
- package/package.json +3 -4
- package/sdk/application/ApplicationClient.js +0 -18
- package/sdk/application/Cart/CartApplicationClient.d.ts +55 -90
- package/sdk/application/Cart/CartApplicationClient.js +60 -1185
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +90 -142
- package/sdk/application/Catalog/CatalogApplicationClient.js +187 -1293
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
- package/sdk/application/Common/CommonApplicationClient.js +5 -89
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -145
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +31 -718
- package/sdk/application/Content/ContentApplicationClient.d.ts +46 -78
- package/sdk/application/Content/ContentApplicationClient.js +77 -914
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +19 -125
- package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
- package/sdk/application/Lead/LeadApplicationClient.js +32 -202
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +50 -478
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -42
- package/sdk/application/Order/OrderApplicationClient.js +86 -472
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +92 -212
- package/sdk/application/Payment/PaymentApplicationClient.js +57 -2102
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -28
- package/sdk/application/Rewards/RewardsApplicationClient.js +16 -305
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
- package/sdk/application/Share/ShareApplicationClient.js +34 -294
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
- package/sdk/application/Theme/ThemeApplicationClient.js +28 -162
- package/sdk/application/User/UserApplicationClient.d.ts +85 -136
- package/sdk/application/User/UserApplicationClient.js +45 -1815
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +2 -5
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -47
- package/sdk/application/index.d.ts +0 -18
- package/sdk/application/index.js +0 -33
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/OAuthClient.js +1 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -40
- package/sdk/partner/Theme/ThemePartnerModel.js +2 -24
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +39 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +247 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +33 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +37 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +193 -1
- package/sdk/platform/Cart/CartPlatformModel.js +132 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +0 -7
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +14 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +6 -0
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -92
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
- package/sdk/platform/Order/OrderPlatformClient.d.ts +10 -0
- package/sdk/platform/Order/OrderPlatformClient.js +99 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7 -0
- package/sdk/platform/Order/OrderPlatformModel.js +3 -0
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -1
- package/sdk/platform/Order/OrderPlatformValidator.js +20 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +56 -19
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +42 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +3 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -40
- package/sdk/platform/Theme/ThemePlatformModel.js +2 -24
- package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +1 -1
- package/sdk/public/Content/ContentPublicClient.js +14 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +14 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -2
- package/sdk/application/Cart/CartApplicationModel.d.ts +0 -3994
- package/sdk/application/Cart/CartApplicationModel.js +0 -2497
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
- package/sdk/application/Cart/CartApplicationValidator.js +0 -530
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
- package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
- package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
- package/sdk/application/Common/CommonApplicationModel.js +0 -308
- package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
- package/sdk/application/Common/CommonApplicationValidator.js +0 -38
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
- package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
- package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
- package/sdk/application/Content/ContentApplicationModel.js +0 -1589
- package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
- package/sdk/application/Content/ContentApplicationValidator.js +0 -264
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
- package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
- package/sdk/application/Lead/LeadApplicationModel.js +0 -480
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
- package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
- package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
- package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
- package/sdk/application/Order/OrderApplicationModel.js +0 -1471
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
- package/sdk/application/Order/OrderApplicationValidator.js +0 -197
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
- package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
- package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
- package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
- package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
- package/sdk/application/Share/ShareApplicationModel.js +0 -234
- package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
- package/sdk/application/Share/ShareApplicationValidator.js +0 -91
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
- package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
- package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
- package/sdk/application/User/UserApplicationModel.js +0 -1382
- package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
- package/sdk/application/User/UserApplicationValidator.js +0 -573
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
- package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
- package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
- package/sdk/common/Clickstream.d.ts +0 -1
- package/sdk/common/Clickstream.js +0 -464
|
@@ -29,6 +29,7 @@ declare class Catalog {
|
|
|
29
29
|
getProductStockForTimeByIds: string;
|
|
30
30
|
getProductVariantsBySlug: string;
|
|
31
31
|
getProducts: string;
|
|
32
|
+
getProductsServiceability: string;
|
|
32
33
|
getSearchResults: string;
|
|
33
34
|
getSimilarComparisonProductBySlug: string;
|
|
34
35
|
getStores: string;
|
|
@@ -37,35 +38,32 @@ declare class Catalog {
|
|
|
37
38
|
_urls: {};
|
|
38
39
|
updateUrls(urls: any): void;
|
|
39
40
|
/**
|
|
40
|
-
* @param {CatalogApplicationValidator.FollowByIdParam} arg - Arg object.
|
|
41
41
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
42
42
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
43
|
-
* @returns {Promise<
|
|
43
|
+
* @returns {Promise<FollowPostResponse>} - Success response
|
|
44
44
|
* @name followById
|
|
45
45
|
* @summary: Create item, brand, product
|
|
46
46
|
* @description: Add a product, brand, or item to the user's followed list by collection Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/followById/).
|
|
47
47
|
*/
|
|
48
|
-
followById({ collectionType, collectionId, requestHeaders }?:
|
|
48
|
+
followById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FollowPostResponse>;
|
|
49
49
|
/**
|
|
50
|
-
* @param {CatalogApplicationValidator.GetBrandDetailBySlugParam} arg - Arg object.
|
|
51
50
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
52
51
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
53
|
-
* @returns {Promise<
|
|
52
|
+
* @returns {Promise<BrandDetailResponse>} - Success response
|
|
54
53
|
* @name getBrandDetailBySlug
|
|
55
54
|
* @summary: Get a brand
|
|
56
55
|
* @description: Get metadata of a brand such as name, information, logo, banner, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrandDetailBySlug/).
|
|
57
56
|
*/
|
|
58
|
-
getBrandDetailBySlug({ slug, requestHeaders }?:
|
|
57
|
+
getBrandDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<BrandDetailResponse>;
|
|
59
58
|
/**
|
|
60
|
-
* @param {CatalogApplicationValidator.GetBrandsParam} arg - Arg object.
|
|
61
59
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
62
60
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
63
|
-
* @returns {Promise<
|
|
61
|
+
* @returns {Promise<BrandListingResponse>} - Success response
|
|
64
62
|
* @name getBrands
|
|
65
63
|
* @summary: List brands
|
|
66
64
|
* @description: Get a list of all the available brands. Filtering can be applied to the department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrands/).
|
|
67
65
|
*/
|
|
68
|
-
getBrands({ department, pageNo, pageSize, requestHeaders }?:
|
|
66
|
+
getBrands({ department, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BrandListingResponse>;
|
|
69
67
|
/**
|
|
70
68
|
* @param {Object} arg - Arg object.
|
|
71
69
|
* @param {string} [arg.department] - The name of the department. Use this
|
|
@@ -73,60 +71,50 @@ declare class Catalog {
|
|
|
73
71
|
* of available departments below. Also, you can get available departments
|
|
74
72
|
* from the endpoint /service/application/catalog/v1.0/departments/.
|
|
75
73
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
76
|
-
* @returns {Paginator<
|
|
74
|
+
* @returns {Paginator<BrandListingResponse>}
|
|
77
75
|
* @summary: List brands
|
|
78
76
|
* @description: Get a list of all the available brands. Filtering can be applied to the department.
|
|
79
77
|
*/
|
|
80
78
|
getBrandsPaginator({ department, pageSize }?: {
|
|
81
79
|
department?: string;
|
|
82
80
|
pageSize?: number;
|
|
83
|
-
}): Paginator<
|
|
81
|
+
}): Paginator<BrandListingResponse>;
|
|
84
82
|
/**
|
|
85
|
-
* @param {CatalogApplicationValidator.GetCategoriesParam} arg - Arg object.
|
|
86
83
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
87
84
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
88
|
-
* @returns {Promise<
|
|
89
|
-
* Success response
|
|
85
|
+
* @returns {Promise<CategoryListingResponse>} - Success response
|
|
90
86
|
* @name getCategories
|
|
91
87
|
* @summary: List product categories
|
|
92
88
|
* @description: List all available product categories. Also, users can filter the categories by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategories/).
|
|
93
89
|
*/
|
|
94
|
-
getCategories({ department, requestHeaders }?:
|
|
90
|
+
getCategories({ department, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CategoryListingResponse>;
|
|
95
91
|
/**
|
|
96
|
-
* @param {CatalogApplicationValidator.GetCategoryDetailBySlugParam} arg - Arg object.
|
|
97
92
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
98
93
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
99
|
-
* @returns {Promise<
|
|
94
|
+
* @returns {Promise<CategoryMetaResponse>} - Success response
|
|
100
95
|
* @name getCategoryDetailBySlug
|
|
101
96
|
* @summary: Get category by slug
|
|
102
97
|
* @description: Get detailed information about a specific product category using its slug and get metadata of a category such as name, information, logo, banner, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategoryDetailBySlug/).
|
|
103
98
|
*/
|
|
104
|
-
getCategoryDetailBySlug({ slug, requestHeaders }?:
|
|
99
|
+
getCategoryDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CategoryMetaResponse>;
|
|
105
100
|
/**
|
|
106
|
-
* @param {CatalogApplicationValidator.GetCollectionDetailBySlugParam} arg
|
|
107
|
-
* - Arg object.
|
|
108
|
-
*
|
|
109
101
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
110
102
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
111
|
-
* @returns {Promise<
|
|
112
|
-
* Success response
|
|
103
|
+
* @returns {Promise<CollectionDetailResponse>} - Success response
|
|
113
104
|
* @name getCollectionDetailBySlug
|
|
114
105
|
* @summary: Get a collection
|
|
115
106
|
* @description: Get detailed information about a specific collection using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionDetailBySlug/).
|
|
116
107
|
*/
|
|
117
|
-
getCollectionDetailBySlug({ slug, requestHeaders }?:
|
|
108
|
+
getCollectionDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CollectionDetailResponse>;
|
|
118
109
|
/**
|
|
119
|
-
* @param {CatalogApplicationValidator.GetCollectionItemsBySlugParam} arg -
|
|
120
|
-
* Arg object.
|
|
121
110
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
122
111
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
123
|
-
* @returns {Promise<
|
|
124
|
-
* Success response
|
|
112
|
+
* @returns {Promise<ProductListingResponse>} - Success response
|
|
125
113
|
* @name getCollectionItemsBySlug
|
|
126
114
|
* @summary: Lists items of collection
|
|
127
115
|
* @description: Fetch items within a particular collection identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionItemsBySlug/).
|
|
128
116
|
*/
|
|
129
|
-
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?:
|
|
117
|
+
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductListingResponse>;
|
|
130
118
|
/**
|
|
131
119
|
* @param {Object} arg - Arg object.
|
|
132
120
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -144,7 +132,7 @@ declare class Catalog {
|
|
|
144
132
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
145
133
|
* either ascending or descending order. See the supported values below.
|
|
146
134
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
147
|
-
* @returns {Paginator<
|
|
135
|
+
* @returns {Paginator<ProductListingResponse>}
|
|
148
136
|
* @summary: Lists items of collection
|
|
149
137
|
* @description: Fetch items within a particular collection identified by its slug.
|
|
150
138
|
*/
|
|
@@ -155,25 +143,22 @@ declare class Catalog {
|
|
|
155
143
|
filters?: boolean;
|
|
156
144
|
sortOn?: string;
|
|
157
145
|
pageSize?: number;
|
|
158
|
-
}): Paginator<
|
|
146
|
+
}): Paginator<ProductListingResponse>;
|
|
159
147
|
/**
|
|
160
|
-
* @param {CatalogApplicationValidator.GetCollectionsParam} arg - Arg object.
|
|
161
148
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
162
149
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
163
|
-
* @returns {Promise<
|
|
164
|
-
* - Success response
|
|
165
|
-
*
|
|
150
|
+
* @returns {Promise<GetCollectionListingResponse>} - Success response
|
|
166
151
|
* @name getCollections
|
|
167
152
|
* @summary: List collections
|
|
168
153
|
* @description: List of curated product collections with filtering options based on tags and collection names. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollections/).
|
|
169
154
|
*/
|
|
170
|
-
getCollections({ pageNo, pageSize, tag, q, requestHeaders }?:
|
|
155
|
+
getCollections({ pageNo, pageSize, tag, q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCollectionListingResponse>;
|
|
171
156
|
/**
|
|
172
157
|
* @param {Object} arg - Arg object.
|
|
173
158
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
174
159
|
* @param {string[]} [arg.tag] - List of tags to filter collections.
|
|
175
160
|
* @param {string} [arg.q] - Name of the collection to filter collection.
|
|
176
|
-
* @returns {Paginator<
|
|
161
|
+
* @returns {Paginator<GetCollectionListingResponse>}
|
|
177
162
|
* @summary: List collections
|
|
178
163
|
* @description: List of curated product collections with filtering options based on tags and collection names.
|
|
179
164
|
*/
|
|
@@ -181,111 +166,97 @@ declare class Catalog {
|
|
|
181
166
|
pageSize?: number;
|
|
182
167
|
tag?: string[];
|
|
183
168
|
q?: string;
|
|
184
|
-
}): Paginator<
|
|
169
|
+
}): Paginator<GetCollectionListingResponse>;
|
|
185
170
|
/**
|
|
186
|
-
* @param {CatalogApplicationValidator.GetComparedFrequentlyProductBySlugParam} arg
|
|
187
|
-
* - Arg object.
|
|
188
|
-
*
|
|
189
171
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
190
172
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
191
|
-
* @returns {Promise<
|
|
192
|
-
* - Success response
|
|
193
|
-
*
|
|
173
|
+
* @returns {Promise<ProductFrequentlyComparedSimilarResponse>} - Success response
|
|
194
174
|
* @name getComparedFrequentlyProductBySlug
|
|
195
175
|
* @summary: List frequent products
|
|
196
176
|
* @description: Get products that are often compared to the product specified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getComparedFrequentlyProductBySlug/).
|
|
197
177
|
*/
|
|
198
|
-
getComparedFrequentlyProductBySlug({ slug, requestHeaders }?:
|
|
178
|
+
getComparedFrequentlyProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductFrequentlyComparedSimilarResponse>;
|
|
199
179
|
/**
|
|
200
|
-
* @param {CatalogApplicationValidator.GetDepartmentsParam} arg - Arg object.
|
|
201
180
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
202
181
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
203
|
-
* @returns {Promise<
|
|
182
|
+
* @returns {Promise<DepartmentResponse>} - Success response
|
|
204
183
|
* @name getDepartments
|
|
205
184
|
* @summary: List departments
|
|
206
185
|
* @description: List all departments associated with available products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
|
|
207
186
|
*/
|
|
208
|
-
getDepartments({ requestHeaders }?:
|
|
187
|
+
getDepartments({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<DepartmentResponse>;
|
|
209
188
|
/**
|
|
210
|
-
* @param {CatalogApplicationValidator.GetFollowIdsParam} arg - Arg object.
|
|
211
189
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
212
190
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
213
|
-
* @returns {Promise<
|
|
191
|
+
* @returns {Promise<FollowIdsResponse>} - Success response
|
|
214
192
|
* @name getFollowIds
|
|
215
193
|
* @summary: List Ids of followed item, brand, product
|
|
216
194
|
* @description: Get the IDs of all items the user is currently following, such as Products, Brands, and Collections. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowIds/).
|
|
217
195
|
*/
|
|
218
|
-
getFollowIds({ collectionType, requestHeaders }?:
|
|
196
|
+
getFollowIds({ collectionType, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<FollowIdsResponse>;
|
|
219
197
|
/**
|
|
220
|
-
* @param {CatalogApplicationValidator.GetFollowedListingParam} arg - Arg object.
|
|
221
198
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
222
199
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
223
|
-
* @returns {Promise<
|
|
224
|
-
* Success response
|
|
200
|
+
* @returns {Promise<GetFollowListingResponse>} - Success response
|
|
225
201
|
* @name getFollowedListing
|
|
226
202
|
* @summary: List followed products, brands
|
|
227
203
|
* @description: Get a list of products or brands the user is following. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowedListing/).
|
|
228
204
|
*/
|
|
229
|
-
getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?:
|
|
205
|
+
getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<GetFollowListingResponse>;
|
|
230
206
|
/**
|
|
231
207
|
* @param {Object} arg - Arg object.
|
|
232
208
|
* @param {string} arg.collectionType - Type of collection followed, i.e.
|
|
233
209
|
* products, brands, or collections.
|
|
234
210
|
* @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
|
|
235
|
-
* @returns {Paginator<
|
|
211
|
+
* @returns {Paginator<GetFollowListingResponse>}
|
|
236
212
|
* @summary: List followed products, brands
|
|
237
213
|
* @description: Get a list of products or brands the user is following.
|
|
238
214
|
*/
|
|
239
215
|
getFollowedListingPaginator({ collectionType, pageSize }?: {
|
|
240
216
|
collectionType: string;
|
|
241
217
|
pageSize?: number;
|
|
242
|
-
}): Paginator<
|
|
218
|
+
}): Paginator<GetFollowListingResponse>;
|
|
243
219
|
/**
|
|
244
|
-
* @param {CatalogApplicationValidator.GetFollowerCountByIdParam} arg - Arg object.
|
|
245
220
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
246
221
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
247
|
-
* @returns {Promise<
|
|
248
|
-
* Success response
|
|
222
|
+
* @returns {Promise<FollowerCountResponse>} - Success response
|
|
249
223
|
* @name getFollowerCountById
|
|
250
224
|
* @summary: Get follower count
|
|
251
225
|
* @description: Get the total number of followers for a specific item by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowerCountById/).
|
|
252
226
|
*/
|
|
253
|
-
getFollowerCountById({ collectionType, collectionId, requestHeaders }?:
|
|
227
|
+
getFollowerCountById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FollowerCountResponse>;
|
|
254
228
|
/**
|
|
255
|
-
* @param {CatalogApplicationValidator.GetHomeProductsParam} arg - Arg object.
|
|
256
229
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
257
230
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
258
|
-
* @returns {Promise<
|
|
231
|
+
* @returns {Promise<HomeListingResponse>} - Success response
|
|
259
232
|
* @name getHomeProducts
|
|
260
233
|
* @summary: List homepage-featured products
|
|
261
234
|
* @description: List all the products associated with a brand, collection or category in a random order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getHomeProducts/).
|
|
262
235
|
*/
|
|
263
|
-
getHomeProducts({ sortOn, pageId, pageSize, requestHeaders }?:
|
|
236
|
+
getHomeProducts({ sortOn, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<HomeListingResponse>;
|
|
264
237
|
/**
|
|
265
238
|
* @param {Object} arg - Arg object.
|
|
266
239
|
* @param {string} [arg.sortOn] - The order in which the list of products
|
|
267
240
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
268
241
|
* either ascending or descending order.
|
|
269
242
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
270
|
-
* @returns {Paginator<
|
|
243
|
+
* @returns {Paginator<HomeListingResponse>}
|
|
271
244
|
* @summary: List homepage-featured products
|
|
272
245
|
* @description: List all the products associated with a brand, collection or category in a random order.
|
|
273
246
|
*/
|
|
274
247
|
getHomeProductsPaginator({ sortOn, pageSize }?: {
|
|
275
248
|
sortOn?: string;
|
|
276
249
|
pageSize?: number;
|
|
277
|
-
}): Paginator<
|
|
250
|
+
}): Paginator<HomeListingResponse>;
|
|
278
251
|
/**
|
|
279
|
-
* @param {CatalogApplicationValidator.GetInStockLocationsParam} arg - Arg object.
|
|
280
252
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
281
253
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
282
|
-
* @returns {Promise<
|
|
283
|
-
* Success response
|
|
254
|
+
* @returns {Promise<ApplicationStoreListing>} - Success response
|
|
284
255
|
* @name getInStockLocations
|
|
285
256
|
* @summary: List stores with inventory
|
|
286
257
|
* @description: List stores where specified products are currently in stock. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getInStockLocations/).
|
|
287
258
|
*/
|
|
288
|
-
getInStockLocations({ pageNo, pageSize, q, city, range, latitude, longitude, requestHeaders, }?:
|
|
259
|
+
getInStockLocations({ pageNo, pageSize, q, city, range, latitude, longitude, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationStoreListing>;
|
|
289
260
|
/**
|
|
290
261
|
* @param {Object} arg - Arg object.
|
|
291
262
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each page.
|
|
@@ -297,7 +268,7 @@ declare class Catalog {
|
|
|
297
268
|
* wants to retrieve the nearest stores, e.g. 72.8691788.
|
|
298
269
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
299
270
|
* one wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
300
|
-
* @returns {Paginator<
|
|
271
|
+
* @returns {Paginator<ApplicationStoreListing>}
|
|
301
272
|
* @summary: List stores with inventory
|
|
302
273
|
* @description: List stores where specified products are currently in stock.
|
|
303
274
|
*/
|
|
@@ -308,73 +279,61 @@ declare class Catalog {
|
|
|
308
279
|
range?: number;
|
|
309
280
|
latitude?: number;
|
|
310
281
|
longitude?: number;
|
|
311
|
-
}): Paginator<
|
|
282
|
+
}): Paginator<ApplicationStoreListing>;
|
|
312
283
|
/**
|
|
313
|
-
* @param {CatalogApplicationValidator.GetLocationDetailsByIdParam} arg - Arg object.
|
|
314
284
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
315
285
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
316
|
-
* @returns {Promise<
|
|
286
|
+
* @returns {Promise<StoreDetails>} - Success response
|
|
317
287
|
* @name getLocationDetailsById
|
|
318
288
|
* @summary: Get selling location
|
|
319
289
|
* @description: Get details about a store based on its location Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getLocationDetailsById/).
|
|
320
290
|
*/
|
|
321
|
-
getLocationDetailsById({ locationId, requestHeaders }?:
|
|
291
|
+
getLocationDetailsById({ locationId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<StoreDetails>;
|
|
322
292
|
/**
|
|
323
|
-
* @param {CatalogApplicationValidator.GetProductBundlesBySlugParam} arg - Arg object.
|
|
324
293
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
325
294
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
326
|
-
* @returns {Promise<
|
|
295
|
+
* @returns {Promise<ProductBundle>} - Success response
|
|
327
296
|
* @name getProductBundlesBySlug
|
|
328
297
|
* @summary: List product bundles
|
|
329
298
|
* @description: Get products bundles to the one specified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductBundlesBySlug/).
|
|
330
299
|
*/
|
|
331
|
-
getProductBundlesBySlug({ slug, id, requestHeaders }?:
|
|
300
|
+
getProductBundlesBySlug({ slug, id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductBundle>;
|
|
332
301
|
/**
|
|
333
|
-
* @param {CatalogApplicationValidator.GetProductComparisonBySlugsParam} arg
|
|
334
|
-
* - Arg object.
|
|
335
|
-
*
|
|
336
302
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
337
303
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
338
|
-
* @returns {Promise<
|
|
339
|
-
* Success response
|
|
304
|
+
* @returns {Promise<ProductsComparisonResponse>} - Success response
|
|
340
305
|
* @name getProductComparisonBySlugs
|
|
341
306
|
* @summary: List products for comparison
|
|
342
307
|
* @description: Get all the products that have the same category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductComparisonBySlugs/).
|
|
343
308
|
*/
|
|
344
|
-
getProductComparisonBySlugs({ slug, requestHeaders }?:
|
|
309
|
+
getProductComparisonBySlugs({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductsComparisonResponse>;
|
|
345
310
|
/**
|
|
346
|
-
* @param {CatalogApplicationValidator.GetProductDetailBySlugParam} arg - Arg object.
|
|
347
311
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
348
312
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
349
|
-
* @returns {Promise<
|
|
313
|
+
* @returns {Promise<ProductDetail>} - Success response
|
|
350
314
|
* @name getProductDetailBySlug
|
|
351
315
|
* @summary: Get a product
|
|
352
316
|
* @description: Get product details such as price, attributes, HSN code, SKU code, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductDetailBySlug/).
|
|
353
317
|
*/
|
|
354
|
-
getProductDetailBySlug({ slug, requestHeaders }?:
|
|
318
|
+
getProductDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductDetail>;
|
|
355
319
|
/**
|
|
356
|
-
* @param {CatalogApplicationValidator.GetProductPriceBySlugParam} arg - Arg object.
|
|
357
320
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
358
321
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
359
|
-
* @returns {Promise<
|
|
360
|
-
* Success response
|
|
322
|
+
* @returns {Promise<ProductSizePriceResponseV3>} - Success response
|
|
361
323
|
* @name getProductPriceBySlug
|
|
362
324
|
* @summary: Get product price
|
|
363
325
|
* @description: Get the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductPriceBySlug/).
|
|
364
326
|
*/
|
|
365
|
-
getProductPriceBySlug({ slug, size, storeId, moq, requestHeaders }?:
|
|
327
|
+
getProductPriceBySlug({ slug, size, storeId, moq, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizePriceResponseV3>;
|
|
366
328
|
/**
|
|
367
|
-
* @param {CatalogApplicationValidator.GetProductSellersBySlugParam} arg - Arg object.
|
|
368
329
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
369
330
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
370
|
-
* @returns {Promise<
|
|
371
|
-
* - Success response
|
|
372
|
-
*
|
|
331
|
+
* @returns {Promise<ProductSizeSellersResponseV3>} - Success response
|
|
373
332
|
* @name getProductSellersBySlug
|
|
374
333
|
* @summary: List sellers
|
|
375
334
|
* @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSellersBySlug/).
|
|
376
335
|
*/
|
|
377
|
-
getProductSellersBySlug({ slug, size, strategy, pageNo, pageSize, requestHeaders }?:
|
|
336
|
+
getProductSellersBySlug({ slug, size, strategy, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizeSellersResponseV3>;
|
|
378
337
|
/**
|
|
379
338
|
* @param {Object} arg - Arg object.
|
|
380
339
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -386,7 +345,7 @@ declare class Catalog {
|
|
|
386
345
|
* @param {string} [arg.strategy] - Sort stores on the basis of strategy.
|
|
387
346
|
* eg, fast-delivery, low-price, optimal.
|
|
388
347
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
389
|
-
* @returns {Paginator<
|
|
348
|
+
* @returns {Paginator<ProductSizeSellersResponseV3>}
|
|
390
349
|
* @summary: List sellers
|
|
391
350
|
* @description: List all sellers offering a specific product identified by its slug and size.
|
|
392
351
|
*/
|
|
@@ -395,75 +354,64 @@ declare class Catalog {
|
|
|
395
354
|
size: string;
|
|
396
355
|
strategy?: string;
|
|
397
356
|
pageSize?: number;
|
|
398
|
-
}): Paginator<
|
|
357
|
+
}): Paginator<ProductSizeSellersResponseV3>;
|
|
399
358
|
/**
|
|
400
|
-
* @param {CatalogApplicationValidator.GetProductSizesBySlugParam} arg - Arg object.
|
|
401
359
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
402
360
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
403
|
-
* @returns {Promise<
|
|
361
|
+
* @returns {Promise<ProductSizes>} - Success response
|
|
404
362
|
* @name getProductSizesBySlug
|
|
405
363
|
* @summary: List sizes
|
|
406
364
|
* @description: Provides detailed information about a product, including its availability (sellable), available sizes with quantities, dimensions, weight, availability status, price details (marked, effective, selling), minimum order quantity (MOQ). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSizesBySlug/).
|
|
407
365
|
*/
|
|
408
|
-
getProductSizesBySlug({ slug, storeId, requestHeaders }?:
|
|
366
|
+
getProductSizesBySlug({ slug, storeId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizes>;
|
|
409
367
|
/**
|
|
410
|
-
* @param {CatalogApplicationValidator.GetProductStockByIdsParam} arg - Arg object.
|
|
411
368
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
412
369
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
413
|
-
* @returns {Promise<
|
|
414
|
-
* Success response
|
|
370
|
+
* @returns {Promise<ProductStockStatusResponse>} - Success response
|
|
415
371
|
* @name getProductStockByIds
|
|
416
372
|
* @summary: Get product stocks
|
|
417
373
|
* @description: Get the current stock status for products identified by their IDs, such as SKU, ALU, EAN, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockByIds/).
|
|
418
374
|
*/
|
|
419
|
-
getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?:
|
|
375
|
+
getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductStockStatusResponse>;
|
|
420
376
|
/**
|
|
421
|
-
* @param {CatalogApplicationValidator.GetProductStockForTimeByIdsParam} arg
|
|
422
|
-
* - Arg object.
|
|
423
|
-
*
|
|
424
377
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
425
378
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
426
|
-
* @returns {Promise<
|
|
379
|
+
* @returns {Promise<ProductStockPolling>} - Success response
|
|
427
380
|
* @name getProductStockForTimeByIds
|
|
428
381
|
* @summary: List future stock
|
|
429
382
|
* @description: Get the available stock levels for all products associated with a particular sales channel at a specified future time. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockForTimeByIds/).
|
|
430
383
|
*/
|
|
431
|
-
getProductStockForTimeByIds({ timestamp, pageSize, pageId, requestHeaders }?:
|
|
384
|
+
getProductStockForTimeByIds({ timestamp, pageSize, pageId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductStockPolling>;
|
|
432
385
|
/**
|
|
433
386
|
* @param {Object} arg - Arg object.
|
|
434
387
|
* @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z).
|
|
435
388
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
436
|
-
* @returns {Paginator<
|
|
389
|
+
* @returns {Paginator<ProductStockPolling>}
|
|
437
390
|
* @summary: List future stock
|
|
438
391
|
* @description: Get the available stock levels for all products associated with a particular sales channel at a specified future time.
|
|
439
392
|
*/
|
|
440
393
|
getProductStockForTimeByIdsPaginator({ timestamp, pageSize }?: {
|
|
441
394
|
timestamp: string;
|
|
442
395
|
pageSize?: number;
|
|
443
|
-
}): Paginator<
|
|
396
|
+
}): Paginator<ProductStockPolling>;
|
|
444
397
|
/**
|
|
445
|
-
* @param {CatalogApplicationValidator.GetProductVariantsBySlugParam} arg -
|
|
446
|
-
* Arg object.
|
|
447
398
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
448
399
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
449
|
-
* @returns {Promise<
|
|
450
|
-
* Success response
|
|
400
|
+
* @returns {Promise<ProductVariantsResponse>} - Success response
|
|
451
401
|
* @name getProductVariantsBySlug
|
|
452
402
|
* @summary: List product variants
|
|
453
403
|
* @description: Get all available variants of a specific product identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductVariantsBySlug/).
|
|
454
404
|
*/
|
|
455
|
-
getProductVariantsBySlug({ slug, requestHeaders }?:
|
|
405
|
+
getProductVariantsBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductVariantsResponse>;
|
|
456
406
|
/**
|
|
457
|
-
* @param {CatalogApplicationValidator.GetProductsParam} arg - Arg object.
|
|
458
407
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
459
408
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
460
|
-
* @returns {Promise<
|
|
461
|
-
* Success response
|
|
409
|
+
* @returns {Promise<ProductListingResponse>} - Success response
|
|
462
410
|
* @name getProducts
|
|
463
411
|
* @summary: List products
|
|
464
412
|
* @description: List all products available in the catalog. It supports filtering based on product name, brand, department, category, collection, and more, while also offering sorting options based on factors like price, ratings, discounts, and other relevant criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProducts/).
|
|
465
413
|
*/
|
|
466
|
-
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?:
|
|
414
|
+
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductListingResponse>;
|
|
467
415
|
/**
|
|
468
416
|
* @param {Object} arg - Arg object.
|
|
469
417
|
* @param {string} [arg.q] - The search query for entering partial or full
|
|
@@ -478,7 +426,7 @@ declare class Catalog {
|
|
|
478
426
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
479
427
|
* either ascending or descending order. See the supported values below.
|
|
480
428
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
481
|
-
* @returns {Paginator<
|
|
429
|
+
* @returns {Paginator<ProductListingResponse>}
|
|
482
430
|
* @summary: List products
|
|
483
431
|
* @description: List all products available in the catalog. It supports filtering based on product name, brand, department, category, collection, and more, while also offering sorting options based on factors like price, ratings, discounts, and other relevant criteria.
|
|
484
432
|
*/
|
|
@@ -488,40 +436,43 @@ declare class Catalog {
|
|
|
488
436
|
filters?: boolean;
|
|
489
437
|
sortOn?: string;
|
|
490
438
|
pageSize?: number;
|
|
491
|
-
}): Paginator<
|
|
439
|
+
}): Paginator<ProductListingResponse>;
|
|
492
440
|
/**
|
|
493
|
-
* @param {CatalogApplicationValidator.GetSearchResultsParam} arg - Arg object.
|
|
494
441
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
495
442
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
496
|
-
* @returns {Promise<
|
|
443
|
+
* @returns {Promise<ProductSizePriceServiceabilityResponse>} - Success response
|
|
444
|
+
* @name getProductsServiceability
|
|
445
|
+
* @summary: get size price for multiple products,For serviceability
|
|
446
|
+
* @description: Get size price for multiple products, For serviceability, with reduced size of response - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductsServiceability/).
|
|
447
|
+
*/
|
|
448
|
+
getProductsServiceability({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductSizePriceServiceabilityResponse>;
|
|
449
|
+
/**
|
|
450
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
451
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
452
|
+
* @returns {Promise<AutoCompleteResponse>} - Success response
|
|
497
453
|
* @name getSearchResults
|
|
498
454
|
* @summary: List product, brand, category
|
|
499
455
|
* @description: Get products, brands, or categories based on a search query, which can be a partial or full name match. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSearchResults/).
|
|
500
456
|
*/
|
|
501
|
-
getSearchResults({ q, requestHeaders }?:
|
|
457
|
+
getSearchResults({ q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AutoCompleteResponse>;
|
|
502
458
|
/**
|
|
503
|
-
* @param {CatalogApplicationValidator.GetSimilarComparisonProductBySlugParam} arg
|
|
504
|
-
* - Arg object.
|
|
505
|
-
*
|
|
506
459
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
507
460
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
508
|
-
* @returns {Promise<
|
|
509
|
-
* Success response
|
|
461
|
+
* @returns {Promise<ProductCompareResponse>} - Success response
|
|
510
462
|
* @name getSimilarComparisonProductBySlug
|
|
511
463
|
* @summary: List similar products
|
|
512
464
|
* @description: Get all products within the same category as the one specified by the provided slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSimilarComparisonProductBySlug/).
|
|
513
465
|
*/
|
|
514
|
-
getSimilarComparisonProductBySlug({ slug, requestHeaders }?:
|
|
466
|
+
getSimilarComparisonProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductCompareResponse>;
|
|
515
467
|
/**
|
|
516
|
-
* @param {CatalogApplicationValidator.GetStoresParam} arg - Arg object.
|
|
517
468
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
518
469
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
519
|
-
* @returns {Promise<
|
|
470
|
+
* @returns {Promise<StoreListingResponse>} - Success response
|
|
520
471
|
* @name getStores
|
|
521
472
|
* @summary: List available stores
|
|
522
473
|
* @description: List all stores associated with the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
|
|
523
474
|
*/
|
|
524
|
-
getStores({ pageNo, pageSize, q, city, range, latitude, longitude, tags, requestHeaders, }?:
|
|
475
|
+
getStores({ pageNo, pageSize, q, city, range, latitude, longitude, tags, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<StoreListingResponse>;
|
|
525
476
|
/**
|
|
526
477
|
* @param {Object} arg - Arg object.
|
|
527
478
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each page.
|
|
@@ -534,7 +485,7 @@ declare class Catalog {
|
|
|
534
485
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
535
486
|
* one wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
536
487
|
* @param {string} [arg.tags] - Search stores based on tags.
|
|
537
|
-
* @returns {Paginator<
|
|
488
|
+
* @returns {Paginator<StoreListingResponse>}
|
|
538
489
|
* @summary: List available stores
|
|
539
490
|
* @description: List all stores associated with the sales channel.
|
|
540
491
|
*/
|
|
@@ -546,18 +497,15 @@ declare class Catalog {
|
|
|
546
497
|
latitude?: number;
|
|
547
498
|
longitude?: number;
|
|
548
499
|
tags?: string;
|
|
549
|
-
}): Paginator<
|
|
500
|
+
}): Paginator<StoreListingResponse>;
|
|
550
501
|
/**
|
|
551
|
-
* @param {CatalogApplicationValidator.UnfollowByIdParam} arg - Arg object.
|
|
552
502
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
553
503
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
554
|
-
* @returns {Promise<
|
|
504
|
+
* @returns {Promise<FollowPostResponse>} - Success response
|
|
555
505
|
* @name unfollowById
|
|
556
506
|
* @summary: Delete item, brand, product
|
|
557
507
|
* @description: Remove a followed item, brand, or product using its collection ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/unfollowById/).
|
|
558
508
|
*/
|
|
559
|
-
unfollowById({ collectionType, collectionId, requestHeaders }?:
|
|
509
|
+
unfollowById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FollowPostResponse>;
|
|
560
510
|
}
|
|
561
|
-
import CatalogApplicationValidator = require("./CatalogApplicationValidator");
|
|
562
|
-
import CatalogApplicationModel = require("./CatalogApplicationModel");
|
|
563
511
|
import Paginator = require("../../common/Paginator");
|