@gofynd/fdk-client-javascript 1.4.15-beta.1 → 1.4.15-beta.10
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 +2 -3
- 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 +80 -142
- package/sdk/application/Catalog/CatalogApplicationClient.js +148 -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 +9 -12
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +22 -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/FileStorage/FileStoragePartnerModel.d.ts +2 -0
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +2 -0
- 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/CartPlatformModel.d.ts +28 -0
- package/sdk/platform/Cart/CartPlatformModel.js +12 -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/FileStorage/FileStoragePlatformApplicationClient.d.ts +3 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +3 -0
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +3 -1
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +3 -0
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +16 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +20 -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
|
@@ -37,35 +37,32 @@ declare class Catalog {
|
|
|
37
37
|
_urls: {};
|
|
38
38
|
updateUrls(urls: any): void;
|
|
39
39
|
/**
|
|
40
|
-
* @param {CatalogApplicationValidator.FollowByIdParam} arg - Arg object.
|
|
41
40
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
42
41
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
43
|
-
* @returns {Promise<
|
|
42
|
+
* @returns {Promise<FollowPostResponse>} - Success response
|
|
44
43
|
* @name followById
|
|
45
44
|
* @summary: Create item, brand, product
|
|
46
45
|
* @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
46
|
*/
|
|
48
|
-
followById({ collectionType, collectionId, requestHeaders }?:
|
|
47
|
+
followById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FollowPostResponse>;
|
|
49
48
|
/**
|
|
50
|
-
* @param {CatalogApplicationValidator.GetBrandDetailBySlugParam} arg - Arg object.
|
|
51
49
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
52
50
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
53
|
-
* @returns {Promise<
|
|
51
|
+
* @returns {Promise<BrandDetailResponse>} - Success response
|
|
54
52
|
* @name getBrandDetailBySlug
|
|
55
53
|
* @summary: Get a brand
|
|
56
54
|
* @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
55
|
*/
|
|
58
|
-
getBrandDetailBySlug({ slug, requestHeaders }?:
|
|
56
|
+
getBrandDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<BrandDetailResponse>;
|
|
59
57
|
/**
|
|
60
|
-
* @param {CatalogApplicationValidator.GetBrandsParam} arg - Arg object.
|
|
61
58
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
62
59
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
63
|
-
* @returns {Promise<
|
|
60
|
+
* @returns {Promise<BrandListingResponse>} - Success response
|
|
64
61
|
* @name getBrands
|
|
65
62
|
* @summary: List brands
|
|
66
63
|
* @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
64
|
*/
|
|
68
|
-
getBrands({ department, pageNo, pageSize, requestHeaders }?:
|
|
65
|
+
getBrands({ department, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BrandListingResponse>;
|
|
69
66
|
/**
|
|
70
67
|
* @param {Object} arg - Arg object.
|
|
71
68
|
* @param {string} [arg.department] - The name of the department. Use this
|
|
@@ -73,60 +70,50 @@ declare class Catalog {
|
|
|
73
70
|
* of available departments below. Also, you can get available departments
|
|
74
71
|
* from the endpoint /service/application/catalog/v1.0/departments/.
|
|
75
72
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
76
|
-
* @returns {Paginator<
|
|
73
|
+
* @returns {Paginator<BrandListingResponse>}
|
|
77
74
|
* @summary: List brands
|
|
78
75
|
* @description: Get a list of all the available brands. Filtering can be applied to the department.
|
|
79
76
|
*/
|
|
80
77
|
getBrandsPaginator({ department, pageSize }?: {
|
|
81
78
|
department?: string;
|
|
82
79
|
pageSize?: number;
|
|
83
|
-
}): Paginator<
|
|
80
|
+
}): Paginator<BrandListingResponse>;
|
|
84
81
|
/**
|
|
85
|
-
* @param {CatalogApplicationValidator.GetCategoriesParam} arg - Arg object.
|
|
86
82
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
87
83
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
88
|
-
* @returns {Promise<
|
|
89
|
-
* Success response
|
|
84
|
+
* @returns {Promise<CategoryListingResponse>} - Success response
|
|
90
85
|
* @name getCategories
|
|
91
86
|
* @summary: List product categories
|
|
92
87
|
* @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
88
|
*/
|
|
94
|
-
getCategories({ department, requestHeaders }?:
|
|
89
|
+
getCategories({ department, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CategoryListingResponse>;
|
|
95
90
|
/**
|
|
96
|
-
* @param {CatalogApplicationValidator.GetCategoryDetailBySlugParam} arg - Arg object.
|
|
97
91
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
98
92
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
99
|
-
* @returns {Promise<
|
|
93
|
+
* @returns {Promise<CategoryMetaResponse>} - Success response
|
|
100
94
|
* @name getCategoryDetailBySlug
|
|
101
95
|
* @summary: Get category by slug
|
|
102
96
|
* @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
97
|
*/
|
|
104
|
-
getCategoryDetailBySlug({ slug, requestHeaders }?:
|
|
98
|
+
getCategoryDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CategoryMetaResponse>;
|
|
105
99
|
/**
|
|
106
|
-
* @param {CatalogApplicationValidator.GetCollectionDetailBySlugParam} arg
|
|
107
|
-
* - Arg object.
|
|
108
|
-
*
|
|
109
100
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
110
101
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
111
|
-
* @returns {Promise<
|
|
112
|
-
* Success response
|
|
102
|
+
* @returns {Promise<CollectionDetailResponse>} - Success response
|
|
113
103
|
* @name getCollectionDetailBySlug
|
|
114
104
|
* @summary: Get a collection
|
|
115
105
|
* @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
106
|
*/
|
|
117
|
-
getCollectionDetailBySlug({ slug, requestHeaders }?:
|
|
107
|
+
getCollectionDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CollectionDetailResponse>;
|
|
118
108
|
/**
|
|
119
|
-
* @param {CatalogApplicationValidator.GetCollectionItemsBySlugParam} arg -
|
|
120
|
-
* Arg object.
|
|
121
109
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
122
110
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
123
|
-
* @returns {Promise<
|
|
124
|
-
* Success response
|
|
111
|
+
* @returns {Promise<ProductListingResponse>} - Success response
|
|
125
112
|
* @name getCollectionItemsBySlug
|
|
126
113
|
* @summary: Lists items of collection
|
|
127
114
|
* @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
115
|
*/
|
|
129
|
-
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?:
|
|
116
|
+
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductListingResponse>;
|
|
130
117
|
/**
|
|
131
118
|
* @param {Object} arg - Arg object.
|
|
132
119
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -144,7 +131,7 @@ declare class Catalog {
|
|
|
144
131
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
145
132
|
* either ascending or descending order. See the supported values below.
|
|
146
133
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
147
|
-
* @returns {Paginator<
|
|
134
|
+
* @returns {Paginator<ProductListingResponse>}
|
|
148
135
|
* @summary: Lists items of collection
|
|
149
136
|
* @description: Fetch items within a particular collection identified by its slug.
|
|
150
137
|
*/
|
|
@@ -155,25 +142,22 @@ declare class Catalog {
|
|
|
155
142
|
filters?: boolean;
|
|
156
143
|
sortOn?: string;
|
|
157
144
|
pageSize?: number;
|
|
158
|
-
}): Paginator<
|
|
145
|
+
}): Paginator<ProductListingResponse>;
|
|
159
146
|
/**
|
|
160
|
-
* @param {CatalogApplicationValidator.GetCollectionsParam} arg - Arg object.
|
|
161
147
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
162
148
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
163
|
-
* @returns {Promise<
|
|
164
|
-
* - Success response
|
|
165
|
-
*
|
|
149
|
+
* @returns {Promise<GetCollectionListingResponse>} - Success response
|
|
166
150
|
* @name getCollections
|
|
167
151
|
* @summary: List collections
|
|
168
152
|
* @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
153
|
*/
|
|
170
|
-
getCollections({ pageNo, pageSize, tag, q, requestHeaders }?:
|
|
154
|
+
getCollections({ pageNo, pageSize, tag, q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCollectionListingResponse>;
|
|
171
155
|
/**
|
|
172
156
|
* @param {Object} arg - Arg object.
|
|
173
157
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
174
158
|
* @param {string[]} [arg.tag] - List of tags to filter collections.
|
|
175
159
|
* @param {string} [arg.q] - Name of the collection to filter collection.
|
|
176
|
-
* @returns {Paginator<
|
|
160
|
+
* @returns {Paginator<GetCollectionListingResponse>}
|
|
177
161
|
* @summary: List collections
|
|
178
162
|
* @description: List of curated product collections with filtering options based on tags and collection names.
|
|
179
163
|
*/
|
|
@@ -181,111 +165,97 @@ declare class Catalog {
|
|
|
181
165
|
pageSize?: number;
|
|
182
166
|
tag?: string[];
|
|
183
167
|
q?: string;
|
|
184
|
-
}): Paginator<
|
|
168
|
+
}): Paginator<GetCollectionListingResponse>;
|
|
185
169
|
/**
|
|
186
|
-
* @param {CatalogApplicationValidator.GetComparedFrequentlyProductBySlugParam} arg
|
|
187
|
-
* - Arg object.
|
|
188
|
-
*
|
|
189
170
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
190
171
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
191
|
-
* @returns {Promise<
|
|
192
|
-
* - Success response
|
|
193
|
-
*
|
|
172
|
+
* @returns {Promise<ProductFrequentlyComparedSimilarResponse>} - Success response
|
|
194
173
|
* @name getComparedFrequentlyProductBySlug
|
|
195
174
|
* @summary: List frequent products
|
|
196
175
|
* @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
176
|
*/
|
|
198
|
-
getComparedFrequentlyProductBySlug({ slug, requestHeaders }?:
|
|
177
|
+
getComparedFrequentlyProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductFrequentlyComparedSimilarResponse>;
|
|
199
178
|
/**
|
|
200
|
-
* @param {CatalogApplicationValidator.GetDepartmentsParam} arg - Arg object.
|
|
201
179
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
202
180
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
203
|
-
* @returns {Promise<
|
|
181
|
+
* @returns {Promise<DepartmentResponse>} - Success response
|
|
204
182
|
* @name getDepartments
|
|
205
183
|
* @summary: List departments
|
|
206
184
|
* @description: List all departments associated with available products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
|
|
207
185
|
*/
|
|
208
|
-
getDepartments({ requestHeaders }?:
|
|
186
|
+
getDepartments({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<DepartmentResponse>;
|
|
209
187
|
/**
|
|
210
|
-
* @param {CatalogApplicationValidator.GetFollowIdsParam} arg - Arg object.
|
|
211
188
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
212
189
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
213
|
-
* @returns {Promise<
|
|
190
|
+
* @returns {Promise<FollowIdsResponse>} - Success response
|
|
214
191
|
* @name getFollowIds
|
|
215
192
|
* @summary: List Ids of followed item, brand, product
|
|
216
193
|
* @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
194
|
*/
|
|
218
|
-
getFollowIds({ collectionType, requestHeaders }?:
|
|
195
|
+
getFollowIds({ collectionType, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<FollowIdsResponse>;
|
|
219
196
|
/**
|
|
220
|
-
* @param {CatalogApplicationValidator.GetFollowedListingParam} arg - Arg object.
|
|
221
197
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
222
198
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
223
|
-
* @returns {Promise<
|
|
224
|
-
* Success response
|
|
199
|
+
* @returns {Promise<GetFollowListingResponse>} - Success response
|
|
225
200
|
* @name getFollowedListing
|
|
226
201
|
* @summary: List followed products, brands
|
|
227
202
|
* @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
203
|
*/
|
|
229
|
-
getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?:
|
|
204
|
+
getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<GetFollowListingResponse>;
|
|
230
205
|
/**
|
|
231
206
|
* @param {Object} arg - Arg object.
|
|
232
207
|
* @param {string} arg.collectionType - Type of collection followed, i.e.
|
|
233
208
|
* products, brands, or collections.
|
|
234
209
|
* @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
|
|
235
|
-
* @returns {Paginator<
|
|
210
|
+
* @returns {Paginator<GetFollowListingResponse>}
|
|
236
211
|
* @summary: List followed products, brands
|
|
237
212
|
* @description: Get a list of products or brands the user is following.
|
|
238
213
|
*/
|
|
239
214
|
getFollowedListingPaginator({ collectionType, pageSize }?: {
|
|
240
215
|
collectionType: string;
|
|
241
216
|
pageSize?: number;
|
|
242
|
-
}): Paginator<
|
|
217
|
+
}): Paginator<GetFollowListingResponse>;
|
|
243
218
|
/**
|
|
244
|
-
* @param {CatalogApplicationValidator.GetFollowerCountByIdParam} arg - Arg object.
|
|
245
219
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
246
220
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
247
|
-
* @returns {Promise<
|
|
248
|
-
* Success response
|
|
221
|
+
* @returns {Promise<FollowerCountResponse>} - Success response
|
|
249
222
|
* @name getFollowerCountById
|
|
250
223
|
* @summary: Get follower count
|
|
251
224
|
* @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
225
|
*/
|
|
253
|
-
getFollowerCountById({ collectionType, collectionId, requestHeaders }?:
|
|
226
|
+
getFollowerCountById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FollowerCountResponse>;
|
|
254
227
|
/**
|
|
255
|
-
* @param {CatalogApplicationValidator.GetHomeProductsParam} arg - Arg object.
|
|
256
228
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
257
229
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
258
|
-
* @returns {Promise<
|
|
230
|
+
* @returns {Promise<HomeListingResponse>} - Success response
|
|
259
231
|
* @name getHomeProducts
|
|
260
232
|
* @summary: List homepage-featured products
|
|
261
233
|
* @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
234
|
*/
|
|
263
|
-
getHomeProducts({ sortOn, pageId, pageSize, requestHeaders }?:
|
|
235
|
+
getHomeProducts({ sortOn, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<HomeListingResponse>;
|
|
264
236
|
/**
|
|
265
237
|
* @param {Object} arg - Arg object.
|
|
266
238
|
* @param {string} [arg.sortOn] - The order in which the list of products
|
|
267
239
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
268
240
|
* either ascending or descending order.
|
|
269
241
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
270
|
-
* @returns {Paginator<
|
|
242
|
+
* @returns {Paginator<HomeListingResponse>}
|
|
271
243
|
* @summary: List homepage-featured products
|
|
272
244
|
* @description: List all the products associated with a brand, collection or category in a random order.
|
|
273
245
|
*/
|
|
274
246
|
getHomeProductsPaginator({ sortOn, pageSize }?: {
|
|
275
247
|
sortOn?: string;
|
|
276
248
|
pageSize?: number;
|
|
277
|
-
}): Paginator<
|
|
249
|
+
}): Paginator<HomeListingResponse>;
|
|
278
250
|
/**
|
|
279
|
-
* @param {CatalogApplicationValidator.GetInStockLocationsParam} arg - Arg object.
|
|
280
251
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
281
252
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
282
|
-
* @returns {Promise<
|
|
283
|
-
* Success response
|
|
253
|
+
* @returns {Promise<ApplicationStoreListing>} - Success response
|
|
284
254
|
* @name getInStockLocations
|
|
285
255
|
* @summary: List stores with inventory
|
|
286
256
|
* @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
257
|
*/
|
|
288
|
-
getInStockLocations({ pageNo, pageSize, q, city, range, latitude, longitude, requestHeaders, }?:
|
|
258
|
+
getInStockLocations({ pageNo, pageSize, q, city, range, latitude, longitude, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationStoreListing>;
|
|
289
259
|
/**
|
|
290
260
|
* @param {Object} arg - Arg object.
|
|
291
261
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each page.
|
|
@@ -297,7 +267,7 @@ declare class Catalog {
|
|
|
297
267
|
* wants to retrieve the nearest stores, e.g. 72.8691788.
|
|
298
268
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
299
269
|
* one wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
300
|
-
* @returns {Paginator<
|
|
270
|
+
* @returns {Paginator<ApplicationStoreListing>}
|
|
301
271
|
* @summary: List stores with inventory
|
|
302
272
|
* @description: List stores where specified products are currently in stock.
|
|
303
273
|
*/
|
|
@@ -308,73 +278,61 @@ declare class Catalog {
|
|
|
308
278
|
range?: number;
|
|
309
279
|
latitude?: number;
|
|
310
280
|
longitude?: number;
|
|
311
|
-
}): Paginator<
|
|
281
|
+
}): Paginator<ApplicationStoreListing>;
|
|
312
282
|
/**
|
|
313
|
-
* @param {CatalogApplicationValidator.GetLocationDetailsByIdParam} arg - Arg object.
|
|
314
283
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
315
284
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
316
|
-
* @returns {Promise<
|
|
285
|
+
* @returns {Promise<StoreDetails>} - Success response
|
|
317
286
|
* @name getLocationDetailsById
|
|
318
287
|
* @summary: Get selling location
|
|
319
288
|
* @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
289
|
*/
|
|
321
|
-
getLocationDetailsById({ locationId, requestHeaders }?:
|
|
290
|
+
getLocationDetailsById({ locationId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<StoreDetails>;
|
|
322
291
|
/**
|
|
323
|
-
* @param {CatalogApplicationValidator.GetProductBundlesBySlugParam} arg - Arg object.
|
|
324
292
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
325
293
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
326
|
-
* @returns {Promise<
|
|
294
|
+
* @returns {Promise<ProductBundle>} - Success response
|
|
327
295
|
* @name getProductBundlesBySlug
|
|
328
296
|
* @summary: List product bundles
|
|
329
297
|
* @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
298
|
*/
|
|
331
|
-
getProductBundlesBySlug({ slug, id, requestHeaders }?:
|
|
299
|
+
getProductBundlesBySlug({ slug, id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductBundle>;
|
|
332
300
|
/**
|
|
333
|
-
* @param {CatalogApplicationValidator.GetProductComparisonBySlugsParam} arg
|
|
334
|
-
* - Arg object.
|
|
335
|
-
*
|
|
336
301
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
337
302
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
338
|
-
* @returns {Promise<
|
|
339
|
-
* Success response
|
|
303
|
+
* @returns {Promise<ProductsComparisonResponse>} - Success response
|
|
340
304
|
* @name getProductComparisonBySlugs
|
|
341
305
|
* @summary: List products for comparison
|
|
342
306
|
* @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
307
|
*/
|
|
344
|
-
getProductComparisonBySlugs({ slug, requestHeaders }?:
|
|
308
|
+
getProductComparisonBySlugs({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductsComparisonResponse>;
|
|
345
309
|
/**
|
|
346
|
-
* @param {CatalogApplicationValidator.GetProductDetailBySlugParam} arg - Arg object.
|
|
347
310
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
348
311
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
349
|
-
* @returns {Promise<
|
|
312
|
+
* @returns {Promise<ProductDetail>} - Success response
|
|
350
313
|
* @name getProductDetailBySlug
|
|
351
314
|
* @summary: Get a product
|
|
352
315
|
* @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
316
|
*/
|
|
354
|
-
getProductDetailBySlug({ slug, requestHeaders }?:
|
|
317
|
+
getProductDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductDetail>;
|
|
355
318
|
/**
|
|
356
|
-
* @param {CatalogApplicationValidator.GetProductPriceBySlugParam} arg - Arg object.
|
|
357
319
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
358
320
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
359
|
-
* @returns {Promise<
|
|
360
|
-
* Success response
|
|
321
|
+
* @returns {Promise<ProductSizePriceResponseV3>} - Success response
|
|
361
322
|
* @name getProductPriceBySlug
|
|
362
323
|
* @summary: Get product price
|
|
363
324
|
* @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
325
|
*/
|
|
365
|
-
getProductPriceBySlug({ slug, size, storeId, moq, requestHeaders }?:
|
|
326
|
+
getProductPriceBySlug({ slug, size, storeId, moq, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizePriceResponseV3>;
|
|
366
327
|
/**
|
|
367
|
-
* @param {CatalogApplicationValidator.GetProductSellersBySlugParam} arg - Arg object.
|
|
368
328
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
369
329
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
370
|
-
* @returns {Promise<
|
|
371
|
-
* - Success response
|
|
372
|
-
*
|
|
330
|
+
* @returns {Promise<ProductSizeSellersResponseV3>} - Success response
|
|
373
331
|
* @name getProductSellersBySlug
|
|
374
332
|
* @summary: List sellers
|
|
375
333
|
* @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
334
|
*/
|
|
377
|
-
getProductSellersBySlug({ slug, size, strategy, pageNo, pageSize, requestHeaders }?:
|
|
335
|
+
getProductSellersBySlug({ slug, size, strategy, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizeSellersResponseV3>;
|
|
378
336
|
/**
|
|
379
337
|
* @param {Object} arg - Arg object.
|
|
380
338
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -386,7 +344,7 @@ declare class Catalog {
|
|
|
386
344
|
* @param {string} [arg.strategy] - Sort stores on the basis of strategy.
|
|
387
345
|
* eg, fast-delivery, low-price, optimal.
|
|
388
346
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
389
|
-
* @returns {Paginator<
|
|
347
|
+
* @returns {Paginator<ProductSizeSellersResponseV3>}
|
|
390
348
|
* @summary: List sellers
|
|
391
349
|
* @description: List all sellers offering a specific product identified by its slug and size.
|
|
392
350
|
*/
|
|
@@ -395,75 +353,64 @@ declare class Catalog {
|
|
|
395
353
|
size: string;
|
|
396
354
|
strategy?: string;
|
|
397
355
|
pageSize?: number;
|
|
398
|
-
}): Paginator<
|
|
356
|
+
}): Paginator<ProductSizeSellersResponseV3>;
|
|
399
357
|
/**
|
|
400
|
-
* @param {CatalogApplicationValidator.GetProductSizesBySlugParam} arg - Arg object.
|
|
401
358
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
402
359
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
403
|
-
* @returns {Promise<
|
|
360
|
+
* @returns {Promise<ProductSizes>} - Success response
|
|
404
361
|
* @name getProductSizesBySlug
|
|
405
362
|
* @summary: List sizes
|
|
406
363
|
* @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
364
|
*/
|
|
408
|
-
getProductSizesBySlug({ slug, storeId, requestHeaders }?:
|
|
365
|
+
getProductSizesBySlug({ slug, storeId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizes>;
|
|
409
366
|
/**
|
|
410
|
-
* @param {CatalogApplicationValidator.GetProductStockByIdsParam} arg - Arg object.
|
|
411
367
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
412
368
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
413
|
-
* @returns {Promise<
|
|
414
|
-
* Success response
|
|
369
|
+
* @returns {Promise<ProductStockStatusResponse>} - Success response
|
|
415
370
|
* @name getProductStockByIds
|
|
416
371
|
* @summary: Get product stocks
|
|
417
372
|
* @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
373
|
*/
|
|
419
|
-
getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?:
|
|
374
|
+
getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductStockStatusResponse>;
|
|
420
375
|
/**
|
|
421
|
-
* @param {CatalogApplicationValidator.GetProductStockForTimeByIdsParam} arg
|
|
422
|
-
* - Arg object.
|
|
423
|
-
*
|
|
424
376
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
425
377
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
426
|
-
* @returns {Promise<
|
|
378
|
+
* @returns {Promise<ProductStockPolling>} - Success response
|
|
427
379
|
* @name getProductStockForTimeByIds
|
|
428
380
|
* @summary: List future stock
|
|
429
381
|
* @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
382
|
*/
|
|
431
|
-
getProductStockForTimeByIds({ timestamp, pageSize, pageId, requestHeaders }?:
|
|
383
|
+
getProductStockForTimeByIds({ timestamp, pageSize, pageId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductStockPolling>;
|
|
432
384
|
/**
|
|
433
385
|
* @param {Object} arg - Arg object.
|
|
434
386
|
* @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z).
|
|
435
387
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
436
|
-
* @returns {Paginator<
|
|
388
|
+
* @returns {Paginator<ProductStockPolling>}
|
|
437
389
|
* @summary: List future stock
|
|
438
390
|
* @description: Get the available stock levels for all products associated with a particular sales channel at a specified future time.
|
|
439
391
|
*/
|
|
440
392
|
getProductStockForTimeByIdsPaginator({ timestamp, pageSize }?: {
|
|
441
393
|
timestamp: string;
|
|
442
394
|
pageSize?: number;
|
|
443
|
-
}): Paginator<
|
|
395
|
+
}): Paginator<ProductStockPolling>;
|
|
444
396
|
/**
|
|
445
|
-
* @param {CatalogApplicationValidator.GetProductVariantsBySlugParam} arg -
|
|
446
|
-
* Arg object.
|
|
447
397
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
448
398
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
449
|
-
* @returns {Promise<
|
|
450
|
-
* Success response
|
|
399
|
+
* @returns {Promise<ProductVariantsResponse>} - Success response
|
|
451
400
|
* @name getProductVariantsBySlug
|
|
452
401
|
* @summary: List product variants
|
|
453
402
|
* @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
403
|
*/
|
|
455
|
-
getProductVariantsBySlug({ slug, requestHeaders }?:
|
|
404
|
+
getProductVariantsBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductVariantsResponse>;
|
|
456
405
|
/**
|
|
457
|
-
* @param {CatalogApplicationValidator.GetProductsParam} arg - Arg object.
|
|
458
406
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
459
407
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
460
|
-
* @returns {Promise<
|
|
461
|
-
* Success response
|
|
408
|
+
* @returns {Promise<ProductListingResponse>} - Success response
|
|
462
409
|
* @name getProducts
|
|
463
410
|
* @summary: List products
|
|
464
411
|
* @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
412
|
*/
|
|
466
|
-
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?:
|
|
413
|
+
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductListingResponse>;
|
|
467
414
|
/**
|
|
468
415
|
* @param {Object} arg - Arg object.
|
|
469
416
|
* @param {string} [arg.q] - The search query for entering partial or full
|
|
@@ -478,7 +425,7 @@ declare class Catalog {
|
|
|
478
425
|
* should be sorted, e.g. popularity, price, latest and discount, in
|
|
479
426
|
* either ascending or descending order. See the supported values below.
|
|
480
427
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
481
|
-
* @returns {Paginator<
|
|
428
|
+
* @returns {Paginator<ProductListingResponse>}
|
|
482
429
|
* @summary: List products
|
|
483
430
|
* @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
431
|
*/
|
|
@@ -488,40 +435,34 @@ declare class Catalog {
|
|
|
488
435
|
filters?: boolean;
|
|
489
436
|
sortOn?: string;
|
|
490
437
|
pageSize?: number;
|
|
491
|
-
}): Paginator<
|
|
438
|
+
}): Paginator<ProductListingResponse>;
|
|
492
439
|
/**
|
|
493
|
-
* @param {CatalogApplicationValidator.GetSearchResultsParam} arg - Arg object.
|
|
494
440
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
495
441
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
496
|
-
* @returns {Promise<
|
|
442
|
+
* @returns {Promise<AutoCompleteResponse>} - Success response
|
|
497
443
|
* @name getSearchResults
|
|
498
444
|
* @summary: List product, brand, category
|
|
499
445
|
* @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
446
|
*/
|
|
501
|
-
getSearchResults({ q, requestHeaders }?:
|
|
447
|
+
getSearchResults({ q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AutoCompleteResponse>;
|
|
502
448
|
/**
|
|
503
|
-
* @param {CatalogApplicationValidator.GetSimilarComparisonProductBySlugParam} arg
|
|
504
|
-
* - Arg object.
|
|
505
|
-
*
|
|
506
449
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
507
450
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
508
|
-
* @returns {Promise<
|
|
509
|
-
* Success response
|
|
451
|
+
* @returns {Promise<ProductCompareResponse>} - Success response
|
|
510
452
|
* @name getSimilarComparisonProductBySlug
|
|
511
453
|
* @summary: List similar products
|
|
512
454
|
* @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
455
|
*/
|
|
514
|
-
getSimilarComparisonProductBySlug({ slug, requestHeaders }?:
|
|
456
|
+
getSimilarComparisonProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductCompareResponse>;
|
|
515
457
|
/**
|
|
516
|
-
* @param {CatalogApplicationValidator.GetStoresParam} arg - Arg object.
|
|
517
458
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
518
459
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
519
|
-
* @returns {Promise<
|
|
460
|
+
* @returns {Promise<StoreListingResponse>} - Success response
|
|
520
461
|
* @name getStores
|
|
521
462
|
* @summary: List available stores
|
|
522
463
|
* @description: List all stores associated with the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
|
|
523
464
|
*/
|
|
524
|
-
getStores({ pageNo, pageSize, q, city, range, latitude, longitude, tags, requestHeaders, }?:
|
|
465
|
+
getStores({ pageNo, pageSize, q, city, range, latitude, longitude, tags, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<StoreListingResponse>;
|
|
525
466
|
/**
|
|
526
467
|
* @param {Object} arg - Arg object.
|
|
527
468
|
* @param {number} [arg.pageSize] - Number of items to retrieve in each page.
|
|
@@ -534,7 +475,7 @@ declare class Catalog {
|
|
|
534
475
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
535
476
|
* one wants to retrieve the nearest stores, e.g. 19.1174114.
|
|
536
477
|
* @param {string} [arg.tags] - Search stores based on tags.
|
|
537
|
-
* @returns {Paginator<
|
|
478
|
+
* @returns {Paginator<StoreListingResponse>}
|
|
538
479
|
* @summary: List available stores
|
|
539
480
|
* @description: List all stores associated with the sales channel.
|
|
540
481
|
*/
|
|
@@ -546,18 +487,15 @@ declare class Catalog {
|
|
|
546
487
|
latitude?: number;
|
|
547
488
|
longitude?: number;
|
|
548
489
|
tags?: string;
|
|
549
|
-
}): Paginator<
|
|
490
|
+
}): Paginator<StoreListingResponse>;
|
|
550
491
|
/**
|
|
551
|
-
* @param {CatalogApplicationValidator.UnfollowByIdParam} arg - Arg object.
|
|
552
492
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
553
493
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
554
|
-
* @returns {Promise<
|
|
494
|
+
* @returns {Promise<FollowPostResponse>} - Success response
|
|
555
495
|
* @name unfollowById
|
|
556
496
|
* @summary: Delete item, brand, product
|
|
557
497
|
* @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
498
|
*/
|
|
559
|
-
unfollowById({ collectionType, collectionId, requestHeaders }?:
|
|
499
|
+
unfollowById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FollowPostResponse>;
|
|
560
500
|
}
|
|
561
|
-
import CatalogApplicationValidator = require("./CatalogApplicationValidator");
|
|
562
|
-
import CatalogApplicationModel = require("./CatalogApplicationModel");
|
|
563
501
|
import Paginator = require("../../common/Paginator");
|