@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.6
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 +3 -2
- package/sdk/application/ApplicationClient.js +20 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
- package/sdk/application/Cart/CartApplicationClient.js +82 -71
- package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
- package/sdk/application/Cart/CartApplicationValidator.js +59 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
- package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
- package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
- package/sdk/application/Content/ContentApplicationClient.js +34 -115
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
- package/sdk/application/Lead/LeadApplicationClient.js +14 -14
- package/sdk/application/Lead/LeadApplicationModel.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
- package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
- package/sdk/application/Order/OrderApplicationClient.js +24 -24
- package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
- package/sdk/application/Order/OrderApplicationModel.js +28 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
- package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
- package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
- package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
- package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
- package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
- package/sdk/application/Share/ShareApplicationClient.js +14 -14
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -4
- package/sdk/application/Share/ShareApplicationModel.js +0 -4
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +64 -64
- package/sdk/application/User/UserApplicationClient.js +64 -64
- package/sdk/common/Clickstream.d.ts +1 -0
- package/sdk/common/Clickstream.js +246 -0
- package/sdk/common/Utility.js +1 -4
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
- package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
- package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
- package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
- package/sdk/platform/Cart/CartPlatformModel.js +12 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
- package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
- package/sdk/platform/Common/CommonPlatformClient.js +3 -3
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
- package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
- package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.js +7 -7
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
- package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
- package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -56
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +20 -59
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -2
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -14
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -16
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
- package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
- package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
- package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
- package/sdk/platform/Order/OrderPlatformClient.js +79 -294
- package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
- package/sdk/platform/Order/OrderPlatformModel.js +34 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +4 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
- package/sdk/platform/Share/SharePlatformModel.d.ts +0 -4
- package/sdk/platform/Share/SharePlatformModel.js +0 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
- package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
- package/sdk/platform/User/UserPlatformModel.d.ts +4 -4
- package/sdk/platform/User/UserPlatformModel.js +4 -4
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
- package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicClient.js +2 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
|
@@ -42,8 +42,8 @@ declare class Catalog {
|
|
|
42
42
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
43
43
|
* @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
|
|
44
44
|
* @name followById
|
|
45
|
-
* @summary:
|
|
46
|
-
* @description:
|
|
45
|
+
* @summary: Follows an item by ID.
|
|
46
|
+
* @description: Adds a product, brand, or item to the user's followed list by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/followById/).
|
|
47
47
|
*/
|
|
48
48
|
followById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.FollowByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowPostResponse>;
|
|
49
49
|
/**
|
|
@@ -52,8 +52,8 @@ declare class Catalog {
|
|
|
52
52
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
53
53
|
* @returns {Promise<CatalogApplicationModel.BrandDetailResponse>} - Success response
|
|
54
54
|
* @name getBrandDetailBySlug
|
|
55
|
-
* @summary:
|
|
56
|
-
* @description:
|
|
55
|
+
* @summary: Retrieves detailed brand info by slug.
|
|
56
|
+
* @description: Retrieve 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
57
|
*/
|
|
58
58
|
getBrandDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetBrandDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.BrandDetailResponse>;
|
|
59
59
|
/**
|
|
@@ -62,8 +62,8 @@ declare class Catalog {
|
|
|
62
62
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
63
63
|
* @returns {Promise<CatalogApplicationModel.BrandListingResponse>} - Success response
|
|
64
64
|
* @name getBrands
|
|
65
|
-
* @summary:
|
|
66
|
-
* @description:
|
|
65
|
+
* @summary: Fetches all available brands.
|
|
66
|
+
* @description: Retrieves a comprehensive list of all brands in the catalog under which a product is sold. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrands/).
|
|
67
67
|
*/
|
|
68
68
|
getBrands({ department, pageNo, pageSize, requestHeaders }?: CatalogApplicationValidator.GetBrandsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.BrandListingResponse>;
|
|
69
69
|
/**
|
|
@@ -74,8 +74,8 @@ declare class Catalog {
|
|
|
74
74
|
* from the endpoint /service/application/catalog/v1.0/departments/
|
|
75
75
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
76
76
|
* @returns {Paginator<CatalogApplicationModel.BrandListingResponse>}
|
|
77
|
-
* @summary:
|
|
78
|
-
* @description:
|
|
77
|
+
* @summary: Fetches all available brands.
|
|
78
|
+
* @description: Retrieves a comprehensive list of all brands in the catalog under which a product is sold.
|
|
79
79
|
*/
|
|
80
80
|
getBrandsPaginator({ department, pageSize }?: {
|
|
81
81
|
department?: string;
|
|
@@ -88,8 +88,8 @@ declare class Catalog {
|
|
|
88
88
|
* @returns {Promise<CatalogApplicationModel.CategoryListingResponse>} -
|
|
89
89
|
* Success response
|
|
90
90
|
* @name getCategories
|
|
91
|
-
* @summary:
|
|
92
|
-
* @description:
|
|
91
|
+
* @summary: Lists all product categories.
|
|
92
|
+
* @description: Retrieves a list of all available product categories. Also filter the categories by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategories/).
|
|
93
93
|
*/
|
|
94
94
|
getCategories({ department, requestHeaders }?: CatalogApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.CategoryListingResponse>;
|
|
95
95
|
/**
|
|
@@ -98,8 +98,8 @@ declare class Catalog {
|
|
|
98
98
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
99
99
|
* @returns {Promise<CatalogApplicationModel.CategoryMetaResponse>} - Success response
|
|
100
100
|
* @name getCategoryDetailBySlug
|
|
101
|
-
* @summary:
|
|
102
|
-
* @description:
|
|
101
|
+
* @summary: Retrieves category details by slug.
|
|
102
|
+
* @description: Retrieve detailed information about a specific product category using its slug and Retrieve 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
103
|
*/
|
|
104
104
|
getCategoryDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetCategoryDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.CategoryMetaResponse>;
|
|
105
105
|
/**
|
|
@@ -111,8 +111,8 @@ declare class Catalog {
|
|
|
111
111
|
* @returns {Promise<CatalogApplicationModel.CollectionDetailResponse>} -
|
|
112
112
|
* Success response
|
|
113
113
|
* @name getCollectionDetailBySlug
|
|
114
|
-
* @summary:
|
|
115
|
-
* @description:
|
|
114
|
+
* @summary: Retrieves collection details by slug.
|
|
115
|
+
* @description: Retrieve detailed information about a specific collection using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionDetailBySlug/).
|
|
116
116
|
*/
|
|
117
117
|
getCollectionDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetCollectionDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.CollectionDetailResponse>;
|
|
118
118
|
/**
|
|
@@ -123,8 +123,8 @@ declare class Catalog {
|
|
|
123
123
|
* @returns {Promise<CatalogApplicationModel.ProductListingResponse>} -
|
|
124
124
|
* Success response
|
|
125
125
|
* @name getCollectionItemsBySlug
|
|
126
|
-
* @summary:
|
|
127
|
-
* @description:
|
|
126
|
+
* @summary: Lists items in a collection by slug.
|
|
127
|
+
* @description: Retrieve items in a specific collection identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionItemsBySlug/).
|
|
128
128
|
*/
|
|
129
129
|
getCollectionItemsBySlug({ slug, f, q, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: CatalogApplicationValidator.GetCollectionItemsBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductListingResponse>;
|
|
130
130
|
/**
|
|
@@ -145,8 +145,8 @@ declare class Catalog {
|
|
|
145
145
|
* either ascending or descending order. See the supported values below.
|
|
146
146
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
147
147
|
* @returns {Paginator<CatalogApplicationModel.ProductListingResponse>}
|
|
148
|
-
* @summary:
|
|
149
|
-
* @description:
|
|
148
|
+
* @summary: Lists items in a collection by slug.
|
|
149
|
+
* @description: Retrieve items in a specific collection identified by its slug.
|
|
150
150
|
*/
|
|
151
151
|
getCollectionItemsBySlugPaginator({ slug, f, q, filters, sortOn, pageSize, }?: {
|
|
152
152
|
slug: string;
|
|
@@ -164,8 +164,8 @@ declare class Catalog {
|
|
|
164
164
|
* - Success response
|
|
165
165
|
*
|
|
166
166
|
* @name getCollections
|
|
167
|
-
* @summary:
|
|
168
|
-
* @description:
|
|
167
|
+
* @summary: Fetches all available collections.
|
|
168
|
+
* @description: Retrieves a list of curated product collections. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollections/).
|
|
169
169
|
*/
|
|
170
170
|
getCollections({ pageNo, pageSize, tag, q, requestHeaders }?: CatalogApplicationValidator.GetCollectionsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.GetCollectionListingResponse>;
|
|
171
171
|
/**
|
|
@@ -174,8 +174,8 @@ declare class Catalog {
|
|
|
174
174
|
* @param {string[]} [arg.tag] - List of tags to filter collections
|
|
175
175
|
* @param {string} [arg.q] - Name of the collection to filter collection
|
|
176
176
|
* @returns {Paginator<CatalogApplicationModel.GetCollectionListingResponse>}
|
|
177
|
-
* @summary:
|
|
178
|
-
* @description:
|
|
177
|
+
* @summary: Fetches all available collections.
|
|
178
|
+
* @description: Retrieves a list of curated product collections.
|
|
179
179
|
*/
|
|
180
180
|
getCollectionsPaginator({ pageSize, tag, q }?: {
|
|
181
181
|
pageSize?: number;
|
|
@@ -192,8 +192,8 @@ declare class Catalog {
|
|
|
192
192
|
* - Success response
|
|
193
193
|
*
|
|
194
194
|
* @name getComparedFrequentlyProductBySlug
|
|
195
|
-
* @summary:
|
|
196
|
-
* @description:
|
|
195
|
+
* @summary: Retrieves products frequently compared with a given product.
|
|
196
|
+
* @description: Retrieve 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
197
|
*/
|
|
198
198
|
getComparedFrequentlyProductBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetComparedFrequentlyProductBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductFrequentlyComparedSimilarResponse>;
|
|
199
199
|
/**
|
|
@@ -202,8 +202,8 @@ declare class Catalog {
|
|
|
202
202
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
203
203
|
* @returns {Promise<CatalogApplicationModel.DepartmentResponse>} - Success response
|
|
204
204
|
* @name getDepartments
|
|
205
|
-
* @summary:
|
|
206
|
-
* @description:
|
|
205
|
+
* @summary: Lists all departments.
|
|
206
|
+
* @description: Retrieves a list of all available product departments. Departments are a way to categorise similar products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
|
|
207
207
|
*/
|
|
208
208
|
getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogApplicationModel.DepartmentResponse>;
|
|
209
209
|
/**
|
|
@@ -212,8 +212,8 @@ declare class Catalog {
|
|
|
212
212
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
213
213
|
* @returns {Promise<CatalogApplicationModel.FollowIdsResponse>} - Success response
|
|
214
214
|
* @name getFollowIds
|
|
215
|
-
* @summary:
|
|
216
|
-
* @description:
|
|
215
|
+
* @summary: Fetches IDs of followed items.
|
|
216
|
+
* @description: Retrieves the IDs of all items the user is currently following like Products, Brands and Collections. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowIds/).
|
|
217
217
|
*/
|
|
218
218
|
getFollowIds({ collectionType, requestHeaders }?: CatalogApplicationValidator.GetFollowIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowIdsResponse>;
|
|
219
219
|
/**
|
|
@@ -223,8 +223,8 @@ declare class Catalog {
|
|
|
223
223
|
* @returns {Promise<CatalogApplicationModel.GetFollowListingResponse>} -
|
|
224
224
|
* Success response
|
|
225
225
|
* @name getFollowedListing
|
|
226
|
-
* @summary:
|
|
227
|
-
* @description:
|
|
226
|
+
* @summary: Retrieves user's followed listings.
|
|
227
|
+
* @description: Retrieve 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
228
|
*/
|
|
229
229
|
getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?: CatalogApplicationValidator.GetFollowedListingParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.GetFollowListingResponse>;
|
|
230
230
|
/**
|
|
@@ -233,8 +233,8 @@ declare class Catalog {
|
|
|
233
233
|
* products, brands, or collections.
|
|
234
234
|
* @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
|
|
235
235
|
* @returns {Paginator<CatalogApplicationModel.GetFollowListingResponse>}
|
|
236
|
-
* @summary:
|
|
237
|
-
* @description:
|
|
236
|
+
* @summary: Retrieves user's followed listings.
|
|
237
|
+
* @description: Retrieve a list of products or brands the user is following.
|
|
238
238
|
*/
|
|
239
239
|
getFollowedListingPaginator({ collectionType, pageSize }?: {
|
|
240
240
|
collectionType: string;
|
|
@@ -247,8 +247,8 @@ declare class Catalog {
|
|
|
247
247
|
* @returns {Promise<CatalogApplicationModel.FollowerCountResponse>} -
|
|
248
248
|
* Success response
|
|
249
249
|
* @name getFollowerCountById
|
|
250
|
-
* @summary:
|
|
251
|
-
* @description:
|
|
250
|
+
* @summary: Retrieves follower count for an item.
|
|
251
|
+
* @description: Retrieves 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
252
|
*/
|
|
253
253
|
getFollowerCountById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.GetFollowerCountByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowerCountResponse>;
|
|
254
254
|
/**
|
|
@@ -257,7 +257,7 @@ declare class Catalog {
|
|
|
257
257
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
258
258
|
* @returns {Promise<CatalogApplicationModel.HomeListingResponse>} - Success response
|
|
259
259
|
* @name getHomeProducts
|
|
260
|
-
* @summary:
|
|
260
|
+
* @summary: Fetches homepage-featured products.
|
|
261
261
|
* @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
262
|
*/
|
|
263
263
|
getHomeProducts({ sortOn, pageId, pageSize, requestHeaders }?: CatalogApplicationValidator.GetHomeProductsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.HomeListingResponse>;
|
|
@@ -268,7 +268,7 @@ declare class Catalog {
|
|
|
268
268
|
* either ascending or descending order.
|
|
269
269
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
270
270
|
* @returns {Paginator<CatalogApplicationModel.HomeListingResponse>}
|
|
271
|
-
* @summary:
|
|
271
|
+
* @summary: Fetches homepage-featured products.
|
|
272
272
|
* @description: List all the products associated with a brand, collection or category in a random order.
|
|
273
273
|
*/
|
|
274
274
|
getHomeProductsPaginator({ sortOn, pageSize }?: {
|
|
@@ -282,8 +282,8 @@ declare class Catalog {
|
|
|
282
282
|
* @returns {Promise<CatalogApplicationModel.ApplicationStoreListing>} -
|
|
283
283
|
* Success response
|
|
284
284
|
* @name getInStockLocations
|
|
285
|
-
* @summary:
|
|
286
|
-
* @description:
|
|
285
|
+
* @summary: Finds in-stock locations for products.
|
|
286
|
+
* @description: Lists locations where specified products are currently in stock. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getInStockLocations/).
|
|
287
287
|
*/
|
|
288
288
|
getInStockLocations({ pageNo, pageSize, q, city, range, latitude, longitude, requestHeaders, }?: CatalogApplicationValidator.GetInStockLocationsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ApplicationStoreListing>;
|
|
289
289
|
/**
|
|
@@ -298,8 +298,8 @@ declare class Catalog {
|
|
|
298
298
|
* @param {number} [arg.longitude] - Longitude of the location from where
|
|
299
299
|
* one wants to retreive the nearest stores, e.g. 19.1174114
|
|
300
300
|
* @returns {Paginator<CatalogApplicationModel.ApplicationStoreListing>}
|
|
301
|
-
* @summary:
|
|
302
|
-
* @description:
|
|
301
|
+
* @summary: Finds in-stock locations for products.
|
|
302
|
+
* @description: Lists locations where specified products are currently in stock.
|
|
303
303
|
*/
|
|
304
304
|
getInStockLocationsPaginator({ pageSize, q, city, range, latitude, longitude, }?: {
|
|
305
305
|
pageSize?: number;
|
|
@@ -315,8 +315,8 @@ declare class Catalog {
|
|
|
315
315
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
316
316
|
* @returns {Promise<CatalogApplicationModel.StoreDetails>} - Success response
|
|
317
317
|
* @name getLocationDetailsById
|
|
318
|
-
* @summary:
|
|
319
|
-
* @description:
|
|
318
|
+
* @summary: Retrieves location details by ID.
|
|
319
|
+
* @description: Retrieves detailed information about a specific location using its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getLocationDetailsById/).
|
|
320
320
|
*/
|
|
321
321
|
getLocationDetailsById({ locationId, requestHeaders }?: CatalogApplicationValidator.GetLocationDetailsByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.StoreDetails>;
|
|
322
322
|
/**
|
|
@@ -325,8 +325,8 @@ declare class Catalog {
|
|
|
325
325
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
326
326
|
* @returns {Promise<CatalogApplicationModel.ProductBundle>} - Success response
|
|
327
327
|
* @name getProductBundlesBySlug
|
|
328
|
-
* @summary:
|
|
329
|
-
* @description:
|
|
328
|
+
* @summary: Fetches product bundles by slug.
|
|
329
|
+
* @description: Retrieve products bundles to the one specified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductBundlesBySlug/).
|
|
330
330
|
*/
|
|
331
331
|
getProductBundlesBySlug({ slug, id, requestHeaders }?: CatalogApplicationValidator.GetProductBundlesBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductBundle>;
|
|
332
332
|
/**
|
|
@@ -338,8 +338,8 @@ declare class Catalog {
|
|
|
338
338
|
* @returns {Promise<CatalogApplicationModel.ProductsComparisonResponse>} -
|
|
339
339
|
* Success response
|
|
340
340
|
* @name getProductComparisonBySlugs
|
|
341
|
-
* @summary:
|
|
342
|
-
* @description:
|
|
341
|
+
* @summary: Compares multiple products by slugs.
|
|
342
|
+
* @description: Retrieves side-by-side comparisons of multiple products identified by their slugs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductComparisonBySlugs/).
|
|
343
343
|
*/
|
|
344
344
|
getProductComparisonBySlugs({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductComparisonBySlugsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductsComparisonResponse>;
|
|
345
345
|
/**
|
|
@@ -348,8 +348,8 @@ declare class Catalog {
|
|
|
348
348
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
349
349
|
* @returns {Promise<CatalogApplicationModel.ProductDetail>} - Success response
|
|
350
350
|
* @name getProductDetailBySlug
|
|
351
|
-
* @summary:
|
|
352
|
-
* @description:
|
|
351
|
+
* @summary: Fetches detailed product information by slug.
|
|
352
|
+
* @description: Retrieve a product by its slug value. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductDetailBySlug/).
|
|
353
353
|
*/
|
|
354
354
|
getProductDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductDetail>;
|
|
355
355
|
/**
|
|
@@ -359,8 +359,8 @@ declare class Catalog {
|
|
|
359
359
|
* @returns {Promise<CatalogApplicationModel.ProductSizePriceResponseV3>} -
|
|
360
360
|
* Success response
|
|
361
361
|
* @name getProductPriceBySlug
|
|
362
|
-
* @summary:
|
|
363
|
-
* @description:
|
|
362
|
+
* @summary: Retrieves product price by slug.
|
|
363
|
+
* @description: Retrieve 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
364
|
*/
|
|
365
365
|
getProductPriceBySlug({ slug, size, storeId, moq, requestHeaders }?: CatalogApplicationValidator.GetProductPriceBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductSizePriceResponseV3>;
|
|
366
366
|
/**
|
|
@@ -371,8 +371,8 @@ declare class Catalog {
|
|
|
371
371
|
* - Success response
|
|
372
372
|
*
|
|
373
373
|
* @name getProductSellersBySlug
|
|
374
|
-
* @summary:
|
|
375
|
-
* @description:
|
|
374
|
+
* @summary: Lists sellers for a product by slug.
|
|
375
|
+
* @description: Retrieve a list of all sellers offering a specific product identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSellersBySlug/).
|
|
376
376
|
*/
|
|
377
377
|
getProductSellersBySlug({ slug, size, strategy, pageNo, pageSize, requestHeaders }?: CatalogApplicationValidator.GetProductSellersBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductSizeSellersResponseV3>;
|
|
378
378
|
/**
|
|
@@ -387,8 +387,8 @@ declare class Catalog {
|
|
|
387
387
|
* eg, fast-delivery, low-price, optimal.
|
|
388
388
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
389
389
|
* @returns {Paginator<CatalogApplicationModel.ProductSizeSellersResponseV3>}
|
|
390
|
-
* @summary:
|
|
391
|
-
* @description:
|
|
390
|
+
* @summary: Lists sellers for a product by slug.
|
|
391
|
+
* @description: Retrieve a list of all sellers offering a specific product identified by its slug.
|
|
392
392
|
*/
|
|
393
393
|
getProductSellersBySlugPaginator({ slug, size, strategy, pageSize }?: {
|
|
394
394
|
slug: string;
|
|
@@ -402,8 +402,8 @@ declare class Catalog {
|
|
|
402
402
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
403
403
|
* @returns {Promise<CatalogApplicationModel.ProductSizes>} - Success response
|
|
404
404
|
* @name getProductSizesBySlug
|
|
405
|
-
* @summary:
|
|
406
|
-
* @description:
|
|
405
|
+
* @summary: Retrieves available sizes for a product by slug.
|
|
406
|
+
* @description: Retrieve the size options available for a specific product based on its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSizesBySlug/).
|
|
407
407
|
*/
|
|
408
408
|
getProductSizesBySlug({ slug, storeId, requestHeaders }?: CatalogApplicationValidator.GetProductSizesBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductSizes>;
|
|
409
409
|
/**
|
|
@@ -413,8 +413,8 @@ declare class Catalog {
|
|
|
413
413
|
* @returns {Promise<CatalogApplicationModel.ProductStockStatusResponse>} -
|
|
414
414
|
* Success response
|
|
415
415
|
* @name getProductStockByIds
|
|
416
|
-
* @summary:
|
|
417
|
-
* @description:
|
|
416
|
+
* @summary: Checks product stock by IDs.
|
|
417
|
+
* @description: Retrieves the current stock status for products identified by their IDs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockByIds/).
|
|
418
418
|
*/
|
|
419
419
|
getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?: CatalogApplicationValidator.GetProductStockByIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductStockStatusResponse>;
|
|
420
420
|
/**
|
|
@@ -425,8 +425,8 @@ declare class Catalog {
|
|
|
425
425
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
426
426
|
* @returns {Promise<CatalogApplicationModel.ProductStockPolling>} - Success response
|
|
427
427
|
* @name getProductStockForTimeByIds
|
|
428
|
-
* @summary:
|
|
429
|
-
* @description:
|
|
428
|
+
* @summary: Fetches future stock data for products.
|
|
429
|
+
* @description: Retrieves projected stock levels for specified products at a future time. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockForTimeByIds/).
|
|
430
430
|
*/
|
|
431
431
|
getProductStockForTimeByIds({ timestamp, pageSize, pageId, requestHeaders }?: CatalogApplicationValidator.GetProductStockForTimeByIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductStockPolling>;
|
|
432
432
|
/**
|
|
@@ -434,8 +434,8 @@ declare class Catalog {
|
|
|
434
434
|
* @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z)
|
|
435
435
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
436
436
|
* @returns {Paginator<CatalogApplicationModel.ProductStockPolling>}
|
|
437
|
-
* @summary:
|
|
438
|
-
* @description:
|
|
437
|
+
* @summary: Fetches future stock data for products.
|
|
438
|
+
* @description: Retrieves projected stock levels for specified products at a future time.
|
|
439
439
|
*/
|
|
440
440
|
getProductStockForTimeByIdsPaginator({ timestamp, pageSize }?: {
|
|
441
441
|
timestamp: string;
|
|
@@ -449,8 +449,8 @@ declare class Catalog {
|
|
|
449
449
|
* @returns {Promise<CatalogApplicationModel.ProductVariantsResponse>} -
|
|
450
450
|
* Success response
|
|
451
451
|
* @name getProductVariantsBySlug
|
|
452
|
-
* @summary:
|
|
453
|
-
* @description:
|
|
452
|
+
* @summary: Retrieves product variants by slug.
|
|
453
|
+
* @description: Retrieves 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
454
|
*/
|
|
455
455
|
getProductVariantsBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductVariantsBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductVariantsResponse>;
|
|
456
456
|
/**
|
|
@@ -460,8 +460,8 @@ declare class Catalog {
|
|
|
460
460
|
* @returns {Promise<CatalogApplicationModel.ProductListingResponse>} -
|
|
461
461
|
* Success response
|
|
462
462
|
* @name getProducts
|
|
463
|
-
* @summary:
|
|
464
|
-
* @description:
|
|
463
|
+
* @summary: Lists all products.
|
|
464
|
+
* @description: Retrieves a list of all products in the catalog. Choose a sort order or make arbitrary search queries by entering the product name, brand, category or collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProducts/).
|
|
465
465
|
*/
|
|
466
466
|
getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: CatalogApplicationValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductListingResponse>;
|
|
467
467
|
/**
|
|
@@ -479,8 +479,8 @@ declare class Catalog {
|
|
|
479
479
|
* either ascending or descending order. See the supported values below.
|
|
480
480
|
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
481
481
|
* @returns {Paginator<CatalogApplicationModel.ProductListingResponse>}
|
|
482
|
-
* @summary:
|
|
483
|
-
* @description:
|
|
482
|
+
* @summary: Lists all products.
|
|
483
|
+
* @description: Retrieves a list of all products in the catalog. Choose a sort order or make arbitrary search queries by entering the product name, brand, category or collection.
|
|
484
484
|
*/
|
|
485
485
|
getProductsPaginator({ q, f, filters, sortOn, pageSize }?: {
|
|
486
486
|
q?: string;
|
|
@@ -495,8 +495,8 @@ declare class Catalog {
|
|
|
495
495
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
496
496
|
* @returns {Promise<CatalogApplicationModel.AutoCompleteResponse>} - Success response
|
|
497
497
|
* @name getSearchResults
|
|
498
|
-
* @summary:
|
|
499
|
-
* @description: Retrieves
|
|
498
|
+
* @summary: Retrieves search result listings.
|
|
499
|
+
* @description: Retrieves products that match the user's search criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSearchResults/).
|
|
500
500
|
*/
|
|
501
501
|
getSearchResults({ q, requestHeaders }?: CatalogApplicationValidator.GetSearchResultsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.AutoCompleteResponse>;
|
|
502
502
|
/**
|
|
@@ -508,8 +508,8 @@ declare class Catalog {
|
|
|
508
508
|
* @returns {Promise<CatalogApplicationModel.ProductCompareResponse>} -
|
|
509
509
|
* Success response
|
|
510
510
|
* @name getSimilarComparisonProductBySlug
|
|
511
|
-
* @summary:
|
|
512
|
-
* @description:
|
|
511
|
+
* @summary: Fetches similar products for comparison.
|
|
512
|
+
* @description: Gets products similar to the one identified by the given slug for comparison. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSimilarComparisonProductBySlug/).
|
|
513
513
|
*/
|
|
514
514
|
getSimilarComparisonProductBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetSimilarComparisonProductBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductCompareResponse>;
|
|
515
515
|
/**
|
|
@@ -518,8 +518,8 @@ declare class Catalog {
|
|
|
518
518
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
519
519
|
* @returns {Promise<CatalogApplicationModel.StoreListingResponse>} - Success response
|
|
520
520
|
* @name getStores
|
|
521
|
-
* @summary:
|
|
522
|
-
* @description:
|
|
521
|
+
* @summary: Lists available stores.
|
|
522
|
+
* @description: Retrieves a list of all physical or online stores. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
|
|
523
523
|
*/
|
|
524
524
|
getStores({ pageNo, pageSize, q, city, range, latitude, longitude, tags, requestHeaders, }?: CatalogApplicationValidator.GetStoresParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.StoreListingResponse>;
|
|
525
525
|
/**
|
|
@@ -535,8 +535,8 @@ declare class Catalog {
|
|
|
535
535
|
* one wants to retreive the nearest stores, e.g. 19.1174114
|
|
536
536
|
* @param {string} [arg.tags] - Search stores based on tags.
|
|
537
537
|
* @returns {Paginator<CatalogApplicationModel.StoreListingResponse>}
|
|
538
|
-
* @summary:
|
|
539
|
-
* @description:
|
|
538
|
+
* @summary: Lists available stores.
|
|
539
|
+
* @description: Retrieves a list of all physical or online stores.
|
|
540
540
|
*/
|
|
541
541
|
getStoresPaginator({ pageSize, q, city, range, latitude, longitude, tags, }?: {
|
|
542
542
|
pageSize?: number;
|
|
@@ -553,8 +553,8 @@ declare class Catalog {
|
|
|
553
553
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
554
554
|
* @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
|
|
555
555
|
* @name unfollowById
|
|
556
|
-
* @summary:
|
|
557
|
-
* @description:
|
|
556
|
+
* @summary: Unfollows an item by ID.
|
|
557
|
+
* @description: Removes a followed item, brand, or product based on its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/unfollowById/).
|
|
558
558
|
*/
|
|
559
559
|
unfollowById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.UnfollowByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowPostResponse>;
|
|
560
560
|
}
|