@gofynd/fdk-client-javascript 3.3.5 → 3.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +36 -33
- package/sdk/application/Catalog/CatalogApplicationClient.js +54 -35
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +19 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +53 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +6 -6
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +3 -3
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +7 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +3 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +233 -3
- package/sdk/platform/Cart/CartPlatformModel.js +147 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +81 -79
- package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -80
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +89 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +57 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +7 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -2
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +19 -3
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +16 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +29 -10
- package/sdk/platform/Order/OrderPlatformModel.js +28 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.js +1 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +162 -39
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +840 -73
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +30 -30
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +36 -30
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +936 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +591 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +70 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +285 -34
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
- package/sdk/platform/User/UserPlatformModel.js +276 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +12 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +5 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
|
@@ -42,7 +42,7 @@ declare class Catalog {
|
|
|
42
42
|
* @returns {Promise<FollowPostResponseSchema>} - Success response
|
|
43
43
|
* @name followById
|
|
44
44
|
* @summary: Create item, brand, product
|
|
45
|
-
* @description: Add a product, brand, or item to the user's followed list by collection Id. - Check out [method documentation](https://
|
|
45
|
+
* @description: Add a product, brand, or item to the user's followed list by collection Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/followById/).
|
|
46
46
|
*/
|
|
47
47
|
followById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FollowPostResponseSchema>;
|
|
48
48
|
/**
|
|
@@ -51,7 +51,7 @@ declare class Catalog {
|
|
|
51
51
|
* @returns {Promise<BrandDetailResponseSchema>} - Success response
|
|
52
52
|
* @name getBrandDetailBySlug
|
|
53
53
|
* @summary: Get a brand
|
|
54
|
-
* @description: Get metadata of a brand such as name, information, logo, banner, etc. - Check out [method documentation](https://
|
|
54
|
+
* @description: Get metadata of a brand such as name, information, logo, banner, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getBrandDetailBySlug/).
|
|
55
55
|
*/
|
|
56
56
|
getBrandDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<BrandDetailResponseSchema>;
|
|
57
57
|
/**
|
|
@@ -60,7 +60,7 @@ declare class Catalog {
|
|
|
60
60
|
* @returns {Promise<BrandListingResponseSchema>} - Success response
|
|
61
61
|
* @name getBrands
|
|
62
62
|
* @summary: List brands
|
|
63
|
-
* @description: Get a list of all the available brands. Filtering can be applied to the department. - Check out [method documentation](https://
|
|
63
|
+
* @description: Get a list of all the available brands. Filtering can be applied to the department. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getBrands/).
|
|
64
64
|
*/
|
|
65
65
|
getBrands({ department, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BrandListingResponseSchema>;
|
|
66
66
|
/**
|
|
@@ -84,7 +84,7 @@ declare class Catalog {
|
|
|
84
84
|
* @returns {Promise<CategoryListingResponseSchema>} - Success response
|
|
85
85
|
* @name getCategories
|
|
86
86
|
* @summary: List product categories
|
|
87
|
-
* @description: List all available product categories. Also, users can filter the categories by department. - Check out [method documentation](https://
|
|
87
|
+
* @description: List all available product categories. Also, users can filter the categories by department. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCategories/).
|
|
88
88
|
*/
|
|
89
89
|
getCategories({ department, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CategoryListingResponseSchema>;
|
|
90
90
|
/**
|
|
@@ -93,7 +93,7 @@ declare class Catalog {
|
|
|
93
93
|
* @returns {Promise<CategoryMetaResponseSchema>} - Success response
|
|
94
94
|
* @name getCategoryDetailBySlug
|
|
95
95
|
* @summary: Get category by slug
|
|
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://
|
|
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://docs.fynd.com/partners/commerce/sdk/application/catalog/getCategoryDetailBySlug/).
|
|
97
97
|
*/
|
|
98
98
|
getCategoryDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CategoryMetaResponseSchema>;
|
|
99
99
|
/**
|
|
@@ -102,7 +102,7 @@ declare class Catalog {
|
|
|
102
102
|
* @returns {Promise<CollectionDetailResponseSchema>} - Success response
|
|
103
103
|
* @name getCollectionDetailBySlug
|
|
104
104
|
* @summary: Get a collection
|
|
105
|
-
* @description: Get detailed information about a specific collection using its slug. - Check out [method documentation](https://
|
|
105
|
+
* @description: Get detailed information about a specific collection using its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCollectionDetailBySlug/).
|
|
106
106
|
*/
|
|
107
107
|
getCollectionDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CollectionDetailResponseSchema>;
|
|
108
108
|
/**
|
|
@@ -111,7 +111,7 @@ declare class Catalog {
|
|
|
111
111
|
* @returns {Promise<ProductListingResponseSchema>} - Success response
|
|
112
112
|
* @name getCollectionItemsBySlug
|
|
113
113
|
* @summary: Lists items of collection
|
|
114
|
-
* @description: Fetch items within a particular collection identified by its slug. - Check out [method documentation](https://
|
|
114
|
+
* @description: Fetch items within a particular collection identified by its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCollectionItemsBySlug/).
|
|
115
115
|
*/
|
|
116
116
|
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductListingResponseSchema>;
|
|
117
117
|
/**
|
|
@@ -149,7 +149,7 @@ declare class Catalog {
|
|
|
149
149
|
* @returns {Promise<GetCollectionListingResponseSchema>} - Success response
|
|
150
150
|
* @name getCollections
|
|
151
151
|
* @summary: List collections
|
|
152
|
-
* @description: List of curated product collections with filtering options based on tags and collection names. - Check out [method documentation](https://
|
|
152
|
+
* @description: List of curated product collections with filtering options based on tags and collection names. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getCollections/).
|
|
153
153
|
*/
|
|
154
154
|
getCollections({ pageNo, pageSize, tag, q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCollectionListingResponseSchema>;
|
|
155
155
|
/**
|
|
@@ -173,7 +173,7 @@ declare class Catalog {
|
|
|
173
173
|
* Success response
|
|
174
174
|
* @name getComparedFrequentlyProductBySlug
|
|
175
175
|
* @summary: List frequent products
|
|
176
|
-
* @description: Get products that are often compared to the product specified by its slug. - Check out [method documentation](https://
|
|
176
|
+
* @description: Get products that are often compared to the product specified by its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getComparedFrequentlyProductBySlug/).
|
|
177
177
|
*/
|
|
178
178
|
getComparedFrequentlyProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductFrequentlyComparedSimilarResponseSchema>;
|
|
179
179
|
/**
|
|
@@ -182,7 +182,7 @@ declare class Catalog {
|
|
|
182
182
|
* @returns {Promise<DepartmentResponseSchema>} - Success response
|
|
183
183
|
* @name getDepartments
|
|
184
184
|
* @summary: List departments
|
|
185
|
-
* @description: List all departments associated with available products. - Check out [method documentation](https://
|
|
185
|
+
* @description: List all departments associated with available products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getDepartments/).
|
|
186
186
|
*/
|
|
187
187
|
getDepartments({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<DepartmentResponseSchema>;
|
|
188
188
|
/**
|
|
@@ -191,7 +191,7 @@ declare class Catalog {
|
|
|
191
191
|
* @returns {Promise<FollowIdsResponseSchema>} - Success response
|
|
192
192
|
* @name getFollowIds
|
|
193
193
|
* @summary: List Ids of followed item, brand, product
|
|
194
|
-
* @description: Get the IDs of all items the user is currently following, such as Products, Brands, and Collections. - Check out [method documentation](https://
|
|
194
|
+
* @description: Get the IDs of all items the user is currently following, such as Products, Brands, and Collections. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getFollowIds/).
|
|
195
195
|
*/
|
|
196
196
|
getFollowIds({ collectionType, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<FollowIdsResponseSchema>;
|
|
197
197
|
/**
|
|
@@ -200,7 +200,7 @@ declare class Catalog {
|
|
|
200
200
|
* @returns {Promise<GetFollowListingResponseSchema>} - Success response
|
|
201
201
|
* @name getFollowedListing
|
|
202
202
|
* @summary: List followed products, brands
|
|
203
|
-
* @description: Get a list of products or brands the user is following. - Check out [method documentation](https://
|
|
203
|
+
* @description: Get a list of products or brands the user is following. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getFollowedListing/).
|
|
204
204
|
*/
|
|
205
205
|
getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<GetFollowListingResponseSchema>;
|
|
206
206
|
/**
|
|
@@ -222,7 +222,7 @@ declare class Catalog {
|
|
|
222
222
|
* @returns {Promise<FollowerCountResponseSchema>} - Success response
|
|
223
223
|
* @name getFollowerCountById
|
|
224
224
|
* @summary: Get follower count
|
|
225
|
-
* @description: Get the total number of followers for a specific item by its ID. - Check out [method documentation](https://
|
|
225
|
+
* @description: Get the total number of followers for a specific item by its ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getFollowerCountById/).
|
|
226
226
|
*/
|
|
227
227
|
getFollowerCountById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FollowerCountResponseSchema>;
|
|
228
228
|
/**
|
|
@@ -231,7 +231,7 @@ declare class Catalog {
|
|
|
231
231
|
* @returns {Promise<HomeListingResponseSchema>} - Success response
|
|
232
232
|
* @name getHomeProducts
|
|
233
233
|
* @summary: List homepage-featured products
|
|
234
|
-
* @description: List all the products associated with a brand, collection or category in a random order. - Check out [method documentation](https://
|
|
234
|
+
* @description: List all the products associated with a brand, collection or category in a random order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getHomeProducts/).
|
|
235
235
|
*/
|
|
236
236
|
getHomeProducts({ sortOn, pageId, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<HomeListingResponseSchema>;
|
|
237
237
|
/**
|
|
@@ -254,7 +254,7 @@ declare class Catalog {
|
|
|
254
254
|
* @returns {Promise<ApplicationStoreListing>} - Success response
|
|
255
255
|
* @name getInStockLocations
|
|
256
256
|
* @summary: List stores with inventory
|
|
257
|
-
* @description: List stores where specified products are currently in stock. - Check out [method documentation](https://
|
|
257
|
+
* @description: List stores where specified products are currently in stock. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getInStockLocations/).
|
|
258
258
|
*/
|
|
259
259
|
getInStockLocations({ pageNo, pageSize, q, city, range, latitude, longitude, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationStoreListing>;
|
|
260
260
|
/**
|
|
@@ -286,7 +286,7 @@ declare class Catalog {
|
|
|
286
286
|
* @returns {Promise<StoreDetails>} - Success response
|
|
287
287
|
* @name getLocationDetailsById
|
|
288
288
|
* @summary: Get selling location
|
|
289
|
-
* @description: Get details about a store based on its location Id. - Check out [method documentation](https://
|
|
289
|
+
* @description: Get details about a store based on its location Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getLocationDetailsById/).
|
|
290
290
|
*/
|
|
291
291
|
getLocationDetailsById({ locationId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<StoreDetails>;
|
|
292
292
|
/**
|
|
@@ -295,7 +295,7 @@ declare class Catalog {
|
|
|
295
295
|
* @returns {Promise<ProductBundle>} - Success response
|
|
296
296
|
* @name getProductBundlesBySlug
|
|
297
297
|
* @summary: List product bundles
|
|
298
|
-
* @description: Get products bundles to the one specified by its slug. - Check out [method documentation](https://
|
|
298
|
+
* @description: Get products bundles to the one specified by its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductBundlesBySlug/).
|
|
299
299
|
*/
|
|
300
300
|
getProductBundlesBySlug({ slug, id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductBundle>;
|
|
301
301
|
/**
|
|
@@ -304,7 +304,7 @@ declare class Catalog {
|
|
|
304
304
|
* @returns {Promise<ProductsComparisonResponseSchema>} - Success response
|
|
305
305
|
* @name getProductComparisonBySlugs
|
|
306
306
|
* @summary: List products for comparison
|
|
307
|
-
* @description: Get all the products that have the same category. - Check out [method documentation](https://
|
|
307
|
+
* @description: Get all the products that have the same category. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductComparisonBySlugs/).
|
|
308
308
|
*/
|
|
309
309
|
getProductComparisonBySlugs({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductsComparisonResponseSchema>;
|
|
310
310
|
/**
|
|
@@ -313,7 +313,7 @@ declare class Catalog {
|
|
|
313
313
|
* @returns {Promise<ProductDetail>} - Success response
|
|
314
314
|
* @name getProductDetailBySlug
|
|
315
315
|
* @summary: Get a product
|
|
316
|
-
* @description: Get product details such as price, attributes, HSN code, SKU code, etc. - Check out [method documentation](https://
|
|
316
|
+
* @description: Get product details such as price, attributes, HSN code, SKU code, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductDetailBySlug/).
|
|
317
317
|
*/
|
|
318
318
|
getProductDetailBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductDetail>;
|
|
319
319
|
/**
|
|
@@ -322,18 +322,18 @@ declare class Catalog {
|
|
|
322
322
|
* @returns {Promise<ProductSizePriceResponseV4>} - Success response
|
|
323
323
|
* @name getProductPriceBySlug
|
|
324
324
|
* @summary: Get product price
|
|
325
|
-
* @description: Get the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://
|
|
325
|
+
* @description: Get the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductPriceBySlug/).
|
|
326
326
|
*/
|
|
327
|
-
getProductPriceBySlug({ slug, size, storeId, moq, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizePriceResponseV4>;
|
|
327
|
+
getProductPriceBySlug({ slug, size, storeId, moq, fulfillmentOptionSlug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizePriceResponseV4>;
|
|
328
328
|
/**
|
|
329
329
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
330
330
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
331
331
|
* @returns {Promise<ProductSizeSellersResponseV4>} - Success response
|
|
332
332
|
* @name getProductSellersBySlug
|
|
333
333
|
* @summary: List sellers
|
|
334
|
-
* @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://
|
|
334
|
+
* @description: List all sellers offering a specific product identified by its slug and size. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSellersBySlug/).
|
|
335
335
|
*/
|
|
336
|
-
getProductSellersBySlug({ slug, size, strategy, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizeSellersResponseV4>;
|
|
336
|
+
getProductSellersBySlug({ slug, size, strategy, fulfillmentOptionSlug, pageNo, pageSize, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizeSellersResponseV4>;
|
|
337
337
|
/**
|
|
338
338
|
* @param {Object} arg - Arg object.
|
|
339
339
|
* @param {string} arg.slug - A short, human-readable, URL-friendly
|
|
@@ -344,15 +344,18 @@ declare class Catalog {
|
|
|
344
344
|
* /service/application/catalog/v1.0/products/sizes.
|
|
345
345
|
* @param {string} [arg.strategy] - Sort stores on the basis of strategy.
|
|
346
346
|
* eg, fast-delivery, low-price, optimal.
|
|
347
|
+
* @param {string} [arg.fulfillmentOptionSlug] - Specifies the fulfillment
|
|
348
|
+
* method, indicating whether an order is for home delivery or store pickup
|
|
347
349
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
348
350
|
* @returns {Paginator<ProductSizeSellersResponseV4>}
|
|
349
351
|
* @summary: List sellers
|
|
350
352
|
* @description: List all sellers offering a specific product identified by its slug and size.
|
|
351
353
|
*/
|
|
352
|
-
getProductSellersBySlugPaginator({ slug, size, strategy, pageSize }?: {
|
|
354
|
+
getProductSellersBySlugPaginator({ slug, size, strategy, fulfillmentOptionSlug, pageSize, }?: {
|
|
353
355
|
slug: string;
|
|
354
356
|
size: string;
|
|
355
357
|
strategy?: string;
|
|
358
|
+
fulfillmentOptionSlug?: string;
|
|
356
359
|
pageSize?: number;
|
|
357
360
|
}): Paginator<ProductSizeSellersResponseV4>;
|
|
358
361
|
/**
|
|
@@ -361,7 +364,7 @@ declare class Catalog {
|
|
|
361
364
|
* @returns {Promise<ProductSizes>} - Success response
|
|
362
365
|
* @name getProductSizesBySlug
|
|
363
366
|
* @summary: List sizes
|
|
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://
|
|
367
|
+
* @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://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductSizesBySlug/).
|
|
365
368
|
*/
|
|
366
369
|
getProductSizesBySlug({ slug, storeId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductSizes>;
|
|
367
370
|
/**
|
|
@@ -370,7 +373,7 @@ declare class Catalog {
|
|
|
370
373
|
* @returns {Promise<ProductStockStatusResponseSchema>} - Success response
|
|
371
374
|
* @name getProductStockByIds
|
|
372
375
|
* @summary: Get product stocks
|
|
373
|
-
* @description: Get the current stock status for products identified by their IDs, such as SKU, ALU, EAN, etc. - Check out [method documentation](https://
|
|
376
|
+
* @description: Get the current stock status for products identified by their IDs, such as SKU, ALU, EAN, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductStockByIds/).
|
|
374
377
|
*/
|
|
375
378
|
getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductStockStatusResponseSchema>;
|
|
376
379
|
/**
|
|
@@ -379,7 +382,7 @@ declare class Catalog {
|
|
|
379
382
|
* @returns {Promise<ProductStockPolling>} - Success response
|
|
380
383
|
* @name getProductStockForTimeByIds
|
|
381
384
|
* @summary: List future stock
|
|
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://
|
|
385
|
+
* @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://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductStockForTimeByIds/).
|
|
383
386
|
*/
|
|
384
387
|
getProductStockForTimeByIds({ timestamp, pageSize, pageId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductStockPolling>;
|
|
385
388
|
/**
|
|
@@ -400,7 +403,7 @@ declare class Catalog {
|
|
|
400
403
|
* @returns {Promise<ProductVariantsResponseSchema>} - Success response
|
|
401
404
|
* @name getProductVariantsBySlug
|
|
402
405
|
* @summary: List product variants
|
|
403
|
-
* @description: Get all available variants of a specific product identified by its slug. - Check out [method documentation](https://
|
|
406
|
+
* @description: Get all available variants of a specific product identified by its slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getProductVariantsBySlug/).
|
|
404
407
|
*/
|
|
405
408
|
getProductVariantsBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductVariantsResponseSchema>;
|
|
406
409
|
/**
|
|
@@ -409,7 +412,7 @@ declare class Catalog {
|
|
|
409
412
|
* @returns {Promise<ProductListingResponseSchema>} - Success response
|
|
410
413
|
* @name getProducts
|
|
411
414
|
* @summary: List products
|
|
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://
|
|
415
|
+
* @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://docs.fynd.com/partners/commerce/sdk/application/catalog/getProducts/).
|
|
413
416
|
*/
|
|
414
417
|
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ProductListingResponseSchema>;
|
|
415
418
|
/**
|
|
@@ -443,7 +446,7 @@ declare class Catalog {
|
|
|
443
446
|
* @returns {Promise<AutoCompleteResponseSchema>} - Success response
|
|
444
447
|
* @name getSearchResults
|
|
445
448
|
* @summary: List product, brand, category
|
|
446
|
-
* @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://
|
|
449
|
+
* @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://docs.fynd.com/partners/commerce/sdk/application/catalog/getSearchResults/).
|
|
447
450
|
*/
|
|
448
451
|
getSearchResults({ q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AutoCompleteResponseSchema>;
|
|
449
452
|
/**
|
|
@@ -452,7 +455,7 @@ declare class Catalog {
|
|
|
452
455
|
* @returns {Promise<ProductCompareResponseSchema>} - Success response
|
|
453
456
|
* @name getSimilarComparisonProductBySlug
|
|
454
457
|
* @summary: List similar products
|
|
455
|
-
* @description: Get all products within the same category as the one specified by the provided slug. - Check out [method documentation](https://
|
|
458
|
+
* @description: Get all products within the same category as the one specified by the provided slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getSimilarComparisonProductBySlug/).
|
|
456
459
|
*/
|
|
457
460
|
getSimilarComparisonProductBySlug({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ProductCompareResponseSchema>;
|
|
458
461
|
/**
|
|
@@ -461,7 +464,7 @@ declare class Catalog {
|
|
|
461
464
|
* @returns {Promise<StoreListingResponseSchema>} - Success response
|
|
462
465
|
* @name getStores
|
|
463
466
|
* @summary: List available stores
|
|
464
|
-
* @description: List all stores associated with the sales channel. - Check out [method documentation](https://
|
|
467
|
+
* @description: List all stores associated with the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/getStores/).
|
|
465
468
|
*/
|
|
466
469
|
getStores({ pageNo, pageSize, q, city, range, latitude, longitude, tags, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<StoreListingResponseSchema>;
|
|
467
470
|
/**
|
|
@@ -495,7 +498,7 @@ declare class Catalog {
|
|
|
495
498
|
* @returns {Promise<FollowPostResponseSchema>} - Success response
|
|
496
499
|
* @name unfollowById
|
|
497
500
|
* @summary: Delete item, brand, product
|
|
498
|
-
* @description: Remove a followed item, brand, or product using its collection ID. - Check out [method documentation](https://
|
|
501
|
+
* @description: Remove a followed item, brand, or product using its collection ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/catalog/unfollowById/).
|
|
499
502
|
*/
|
|
500
503
|
unfollowById({ collectionType, collectionId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<FollowPostResponseSchema>;
|
|
501
504
|
}
|