@gofynd/fdk-client-javascript 1.4.8-beta.3 → 1.4.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (189) hide show
  1. package/README.md +26 -1
  2. package/package.json +2 -2
  3. package/sdk/application/ApplicationClient.d.ts +8 -0
  4. package/sdk/application/ApplicationClient.js +14 -0
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +20 -20
  6. package/sdk/application/Cart/CartApplicationClient.js +20 -20
  7. package/sdk/application/Cart/CartApplicationModel.d.ts +2446 -664
  8. package/sdk/application/Cart/CartApplicationModel.js +783 -552
  9. package/sdk/application/Cart/CartApplicationValidator.d.ts +268 -194
  10. package/sdk/application/Cart/CartApplicationValidator.js +100 -114
  11. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +53 -53
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +53 -53
  13. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2012 -503
  14. package/sdk/application/Catalog/CatalogApplicationModel.js +603 -453
  15. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +64 -64
  16. package/sdk/application/Catalog/CatalogApplicationValidator.js +32 -32
  17. package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
  18. package/sdk/application/Common/CommonApplicationClient.js +2 -2
  19. package/sdk/application/Common/CommonApplicationModel.d.ts +170 -90
  20. package/sdk/application/Common/CommonApplicationModel.js +59 -58
  21. package/sdk/application/Common/CommonApplicationValidator.d.ts +8 -5
  22. package/sdk/application/Common/CommonApplicationValidator.js +3 -3
  23. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +2 -2
  24. package/sdk/application/Communication/CommunicationApplicationClient.js +2 -2
  25. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +170 -35
  26. package/sdk/application/Communication/CommunicationApplicationModel.js +54 -33
  27. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +15 -15
  28. package/sdk/application/Configuration/ConfigurationApplicationClient.js +15 -15
  29. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +624 -443
  30. package/sdk/application/Configuration/ConfigurationApplicationModel.js +259 -248
  31. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +32 -24
  32. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +14 -13
  33. package/sdk/application/Content/ContentApplicationClient.d.ts +16 -16
  34. package/sdk/application/Content/ContentApplicationClient.js +16 -16
  35. package/sdk/application/Content/ContentApplicationModel.d.ts +1205 -282
  36. package/sdk/application/Content/ContentApplicationModel.js +341 -277
  37. package/sdk/application/Content/ContentApplicationValidator.d.ts +28 -17
  38. package/sdk/application/Content/ContentApplicationValidator.js +11 -10
  39. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
  40. package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
  41. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +146 -37
  42. package/sdk/application/FileStorage/FileStorageApplicationModel.js +38 -36
  43. package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
  44. package/sdk/application/Lead/LeadApplicationClient.js +3 -3
  45. package/sdk/application/Lead/LeadApplicationModel.d.ts +195 -134
  46. package/sdk/application/Lead/LeadApplicationModel.js +110 -67
  47. package/sdk/application/Lead/LeadApplicationValidator.d.ts +8 -8
  48. package/sdk/application/Lead/LeadApplicationValidator.js +4 -4
  49. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -10
  50. package/sdk/application/Logistic/LogisticApplicationClient.js +10 -10
  51. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +1039 -221
  52. package/sdk/application/Logistic/LogisticApplicationModel.js +342 -199
  53. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +76 -82
  54. package/sdk/application/Logistic/LogisticApplicationValidator.js +38 -41
  55. package/sdk/application/Order/OrderApplicationClient.d.ts +10 -10
  56. package/sdk/application/Order/OrderApplicationClient.js +10 -10
  57. package/sdk/application/Order/OrderApplicationModel.d.ts +1400 -325
  58. package/sdk/application/Order/OrderApplicationModel.js +391 -317
  59. package/sdk/application/Order/OrderApplicationValidator.d.ts +32 -30
  60. package/sdk/application/Order/OrderApplicationValidator.js +15 -14
  61. package/sdk/application/Payment/PaymentApplicationClient.d.ts +43 -43
  62. package/sdk/application/Payment/PaymentApplicationClient.js +43 -43
  63. package/sdk/application/Payment/PaymentApplicationModel.d.ts +1111 -1022
  64. package/sdk/application/Payment/PaymentApplicationModel.js +537 -521
  65. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +82 -49
  66. package/sdk/application/Payment/PaymentApplicationValidator.js +30 -30
  67. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +28 -7
  68. package/sdk/application/Rewards/RewardsApplicationModel.js +7 -7
  69. package/sdk/application/Share/ShareApplicationModel.d.ts +178 -38
  70. package/sdk/application/Share/ShareApplicationModel.js +53 -37
  71. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -2
  72. package/sdk/application/Share/ShareApplicationValidator.js +2 -1
  73. package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
  74. package/sdk/application/Theme/ThemeApplicationClient.js +14 -8
  75. package/sdk/application/Theme/ThemeApplicationModel.d.ts +528 -287
  76. package/sdk/application/Theme/ThemeApplicationModel.js +208 -172
  77. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +17 -12
  78. package/sdk/application/Theme/ThemeApplicationValidator.js +8 -6
  79. package/sdk/application/User/UserApplicationClient.d.ts +36 -36
  80. package/sdk/application/User/UserApplicationClient.js +36 -36
  81. package/sdk/application/User/UserApplicationModel.d.ts +1062 -255
  82. package/sdk/application/User/UserApplicationModel.js +298 -244
  83. package/sdk/application/User/UserApplicationValidator.d.ts +80 -80
  84. package/sdk/application/User/UserApplicationValidator.js +40 -40
  85. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
  86. package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
  87. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +20 -5
  88. package/sdk/application/Webhook/WebhookApplicationModel.js +5 -5
  89. package/sdk/common/Clickstream.js +95 -15
  90. package/sdk/common/Constant.d.ts +9 -0
  91. package/sdk/common/Constant.js +11 -0
  92. package/sdk/common/Utility.js +19 -0
  93. package/sdk/common/utils.js +8 -1
  94. package/sdk/partner/Lead/LeadPartnerModel.d.ts +28 -7
  95. package/sdk/partner/Lead/LeadPartnerModel.js +7 -7
  96. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +28 -7
  97. package/sdk/partner/Logistics/LogisticsPartnerModel.js +7 -7
  98. package/sdk/partner/PartnerClient.d.ts +8 -0
  99. package/sdk/partner/PartnerClient.js +14 -0
  100. package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -0
  101. package/sdk/partner/Theme/ThemePartnerClient.js +158 -0
  102. package/sdk/partner/Theme/ThemePartnerModel.d.ts +45 -6
  103. package/sdk/partner/Theme/ThemePartnerModel.js +33 -4
  104. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
  105. package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
  106. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +28 -7
  107. package/sdk/partner/Webhook/WebhookPartnerModel.js +7 -7
  108. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +28 -7
  109. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +7 -7
  110. package/sdk/platform/Billing/BillingPlatformClient.d.ts +6 -397
  111. package/sdk/platform/Billing/BillingPlatformClient.js +77 -3215
  112. package/sdk/platform/Billing/BillingPlatformModel.d.ts +621 -2021
  113. package/sdk/platform/Billing/BillingPlatformModel.js +353 -2405
  114. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +12 -451
  115. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -483
  116. package/sdk/platform/Cart/CartPlatformModel.d.ts +28 -7
  117. package/sdk/platform/Cart/CartPlatformModel.js +8 -8
  118. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +12 -2
  119. package/sdk/platform/Catalog/CatalogPlatformClient.js +41 -1
  120. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +46 -12
  121. package/sdk/platform/Catalog/CatalogPlatformModel.js +14 -11
  122. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +40 -0
  123. package/sdk/platform/Catalog/CatalogPlatformValidator.js +17 -0
  124. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +28 -7
  125. package/sdk/platform/Communication/CommunicationPlatformModel.js +7 -7
  126. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -7
  127. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +7 -7
  128. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +0 -97
  129. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +77 -782
  130. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +24 -701
  131. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +7 -539
  132. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -183
  133. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +0 -134
  134. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -10
  135. package/sdk/platform/Content/ContentPlatformApplicationClient.js +0 -79
  136. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -15
  137. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -13
  138. package/sdk/platform/Content/ContentPlatformModel.d.ts +58 -17
  139. package/sdk/platform/Content/ContentPlatformModel.js +28 -15
  140. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +28 -7
  141. package/sdk/platform/Discount/DiscountPlatformModel.js +7 -7
  142. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +127 -25
  143. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +37 -25
  144. package/sdk/platform/Finance/FinancePlatformClient.d.ts +28 -28
  145. package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
  146. package/sdk/platform/Finance/FinancePlatformModel.d.ts +1583 -347
  147. package/sdk/platform/Finance/FinancePlatformModel.js +463 -351
  148. package/sdk/platform/Lead/LeadPlatformModel.d.ts +28 -7
  149. package/sdk/platform/Lead/LeadPlatformModel.js +7 -7
  150. package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -0
  151. package/sdk/platform/Order/OrderPlatformClient.js +165 -0
  152. package/sdk/platform/Order/OrderPlatformModel.d.ts +613 -39
  153. package/sdk/platform/Order/OrderPlatformModel.js +359 -41
  154. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -1
  155. package/sdk/platform/Order/OrderPlatformValidator.js +28 -0
  156. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +30 -9
  157. package/sdk/platform/Payment/PaymentPlatformModel.js +9 -9
  158. package/sdk/platform/PlatformClient.d.ts +8 -0
  159. package/sdk/platform/PlatformClient.js +14 -0
  160. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +28 -7
  161. package/sdk/platform/Rewards/RewardsPlatformModel.js +7 -7
  162. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +12 -9
  163. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +12 -9
  164. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +120 -22
  165. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +76 -21
  166. package/sdk/platform/Share/SharePlatformModel.d.ts +28 -7
  167. package/sdk/platform/Share/SharePlatformModel.js +7 -7
  168. package/sdk/platform/Theme/ThemePlatformModel.d.ts +18 -5
  169. package/sdk/platform/Theme/ThemePlatformModel.js +7 -4
  170. package/sdk/platform/User/UserPlatformModel.d.ts +18 -18
  171. package/sdk/platform/User/UserPlatformModel.js +9 -9
  172. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +28 -7
  173. package/sdk/platform/Webhook/WebhookPlatformModel.js +7 -7
  174. package/sdk/public/PublicClient.d.ts +0 -4
  175. package/sdk/public/PublicClient.js +0 -8
  176. package/sdk/public/index.d.ts +0 -2
  177. package/sdk/public/index.js +0 -4
  178. package/sdk/public/Billing/BillingPublicClient.d.ts +0 -45
  179. package/sdk/public/Billing/BillingPublicClient.js +0 -269
  180. package/sdk/public/Billing/BillingPublicModel.d.ts +0 -434
  181. package/sdk/public/Billing/BillingPublicModel.js +0 -395
  182. package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -34
  183. package/sdk/public/Billing/BillingPublicValidator.js +0 -38
  184. package/sdk/public/Inventory/InventoryPublicClient.d.ts +0 -87
  185. package/sdk/public/Inventory/InventoryPublicClient.js +0 -529
  186. package/sdk/public/Inventory/InventoryPublicModel.d.ts +0 -393
  187. package/sdk/public/Inventory/InventoryPublicModel.js +0 -448
  188. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +0 -91
  189. package/sdk/public/Inventory/InventoryPublicValidator.js +0 -85
@@ -43,7 +43,7 @@ declare class Catalog {
43
43
  * @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
44
44
  * @name followById
45
45
  * @summary: Create item, brand, product
46
- * @description: Adds 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/).
46
+ * @description: Add a product, brand, or item to the user's followed list by collection Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/followById/).
47
47
  */
48
48
  followById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.FollowByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowPostResponse>;
49
49
  /**
@@ -53,7 +53,7 @@ declare class Catalog {
53
53
  * @returns {Promise<CatalogApplicationModel.BrandDetailResponse>} - Success response
54
54
  * @name getBrandDetailBySlug
55
55
  * @summary: Get a brand
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/).
56
+ * @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
57
  */
58
58
  getBrandDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetBrandDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.BrandDetailResponse>;
59
59
  /**
@@ -63,7 +63,7 @@ declare class Catalog {
63
63
  * @returns {Promise<CatalogApplicationModel.BrandListingResponse>} - Success response
64
64
  * @name getBrands
65
65
  * @summary: List brands
66
- * @description: Retrieves a list of all the availabe brands. Filtering can be applied on department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrands/).
66
+ * @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
67
  */
68
68
  getBrands({ department, pageNo, pageSize, requestHeaders }?: CatalogApplicationValidator.GetBrandsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.BrandListingResponse>;
69
69
  /**
@@ -71,11 +71,11 @@ declare class Catalog {
71
71
  * @param {string} [arg.department] - The name of the department. Use this
72
72
  * parameter to filter products by a particular department. See the list
73
73
  * of available departments below. Also, you can get available departments
74
- * from the endpoint /service/application/catalog/v1.0/departments/
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
77
  * @summary: List brands
78
- * @description: Retrieves a list of all the availabe brands. Filtering can be applied on department.
78
+ * @description: Get a list of all the available brands. Filtering can be applied to the department.
79
79
  */
80
80
  getBrandsPaginator({ department, pageSize }?: {
81
81
  department?: string;
@@ -89,7 +89,7 @@ declare class Catalog {
89
89
  * Success response
90
90
  * @name getCategories
91
91
  * @summary: List product categories
92
- * @description: Retrieves a list of all available product categories. Also user can filter the categories by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategories/).
92
+ * @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
93
  */
94
94
  getCategories({ department, requestHeaders }?: CatalogApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.CategoryListingResponse>;
95
95
  /**
@@ -99,7 +99,7 @@ declare class Catalog {
99
99
  * @returns {Promise<CatalogApplicationModel.CategoryMetaResponse>} - Success response
100
100
  * @name getCategoryDetailBySlug
101
101
  * @summary: Get category 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/).
102
+ * @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
103
  */
104
104
  getCategoryDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetCategoryDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.CategoryMetaResponse>;
105
105
  /**
@@ -112,7 +112,7 @@ declare class Catalog {
112
112
  * Success response
113
113
  * @name getCollectionDetailBySlug
114
114
  * @summary: Get a collection
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/).
115
+ * @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
116
  */
117
117
  getCollectionDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetCollectionDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.CollectionDetailResponse>;
118
118
  /**
@@ -135,11 +135,11 @@ declare class Catalog {
135
135
  * @param {string} [arg.f] - The search filter parameters. Filter parameters
136
136
  * will be passed in f parameter as shown in the example below. Double
137
137
  * Pipe (||) denotes the OR condition, whereas Triple-colon (:::)
138
- * indicates a new filter paramater applied as an AND condition.
138
+ * indicates a new filter parameter applied as an AND condition.
139
139
  * @param {string} [arg.q] - The search query for entering partial or full
140
140
  * name of product, brand, category, or collection.
141
- * @param {boolean} [arg.filters] - This is a boolean value, True for
142
- * fetching all filter parameters and False for disabling the filter parameters.
141
+ * @param {boolean} [arg.filters] - True for fetching all filter parameters
142
+ * and False for disabling the filter parameters.
143
143
  * @param {string} [arg.sortOn] - The order in which the list of products
144
144
  * should be sorted, e.g. popularity, price, latest and discount, in
145
145
  * either ascending or descending order. See the supported values below.
@@ -165,17 +165,17 @@ declare class Catalog {
165
165
  *
166
166
  * @name getCollections
167
167
  * @summary: List collections
168
- * @description: Retrieve a 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/).
168
+ * @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
169
  */
170
170
  getCollections({ pageNo, pageSize, tag, q, requestHeaders }?: CatalogApplicationValidator.GetCollectionsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.GetCollectionListingResponse>;
171
171
  /**
172
172
  * @param {Object} arg - Arg object.
173
173
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
174
- * @param {string[]} [arg.tag] - List of tags to filter collections
175
- * @param {string} [arg.q] - Name of the collection to filter collection
174
+ * @param {string[]} [arg.tag] - List of tags to filter collections.
175
+ * @param {string} [arg.q] - Name of the collection to filter collection.
176
176
  * @returns {Paginator<CatalogApplicationModel.GetCollectionListingResponse>}
177
177
  * @summary: List collections
178
- * @description: Retrieve a list of curated product collections with filtering options based on tags and collection names.
178
+ * @description: List of curated product collections with filtering options based on tags and collection names.
179
179
  */
180
180
  getCollectionsPaginator({ pageSize, tag, q }?: {
181
181
  pageSize?: number;
@@ -193,7 +193,7 @@ declare class Catalog {
193
193
  *
194
194
  * @name getComparedFrequentlyProductBySlug
195
195
  * @summary: List frequent products
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/).
196
+ * @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
197
  */
198
198
  getComparedFrequentlyProductBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetComparedFrequentlyProductBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductFrequentlyComparedSimilarResponse>;
199
199
  /**
@@ -203,7 +203,7 @@ declare class Catalog {
203
203
  * @returns {Promise<CatalogApplicationModel.DepartmentResponse>} - Success response
204
204
  * @name getDepartments
205
205
  * @summary: List departments
206
- * @description: Retrieve a list of all departments associated with available products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
206
+ * @description: List all departments associated with available 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
  /**
@@ -213,7 +213,7 @@ declare class Catalog {
213
213
  * @returns {Promise<CatalogApplicationModel.FollowIdsResponse>} - Success response
214
214
  * @name getFollowIds
215
215
  * @summary: List Ids of followed item, brand, product
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/).
216
+ * @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
217
  */
218
218
  getFollowIds({ collectionType, requestHeaders }?: CatalogApplicationValidator.GetFollowIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowIdsResponse>;
219
219
  /**
@@ -224,7 +224,7 @@ declare class Catalog {
224
224
  * Success response
225
225
  * @name getFollowedListing
226
226
  * @summary: List followed products, brands
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/).
227
+ * @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
228
  */
229
229
  getFollowedListing({ collectionType, pageId, pageSize, requestHeaders }?: CatalogApplicationValidator.GetFollowedListingParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.GetFollowListingResponse>;
230
230
  /**
@@ -234,7 +234,7 @@ declare class Catalog {
234
234
  * @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
235
235
  * @returns {Paginator<CatalogApplicationModel.GetFollowListingResponse>}
236
236
  * @summary: List followed products, brands
237
- * @description: Retrieve a list of products or brands the user is following.
237
+ * @description: Get a list of products or brands the user is following.
238
238
  */
239
239
  getFollowedListingPaginator({ collectionType, pageSize }?: {
240
240
  collectionType: string;
@@ -248,7 +248,7 @@ declare class Catalog {
248
248
  * Success response
249
249
  * @name getFollowerCountById
250
250
  * @summary: Get follower count
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/).
251
+ * @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
252
  */
253
253
  getFollowerCountById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.GetFollowerCountByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowerCountResponse>;
254
254
  /**
@@ -283,7 +283,7 @@ declare class Catalog {
283
283
  * Success response
284
284
  * @name getInStockLocations
285
285
  * @summary: List stores with inventory
286
- * @description: Lists stores where specified products are currently in stock. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getInStockLocations/).
286
+ * @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
287
  */
288
288
  getInStockLocations({ pageNo, pageSize, q, city, range, latitude, longitude, requestHeaders, }?: CatalogApplicationValidator.GetInStockLocationsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ApplicationStoreListing>;
289
289
  /**
@@ -292,14 +292,14 @@ declare class Catalog {
292
292
  * @param {string} [arg.q] - Search a store by its name or store_code.
293
293
  * @param {string} [arg.city] - Search stores by the city in which they are situated.
294
294
  * @param {number} [arg.range] - Use this to retrieve stores within a
295
- * particular range in meters, e.g. 10000, to indicate a 10km range
295
+ * particular range in meters, e.g. 10000, to indicate a 10km range.
296
296
  * @param {number} [arg.latitude] - Latitude of the location from where one
297
- * wants to retreive the nearest stores, e.g. 72.8691788
297
+ * wants to retrieve the nearest stores, e.g. 72.8691788.
298
298
  * @param {number} [arg.longitude] - Longitude of the location from where
299
- * one wants to retreive the nearest stores, e.g. 19.1174114
299
+ * one wants to retrieve the nearest stores, e.g. 19.1174114.
300
300
  * @returns {Paginator<CatalogApplicationModel.ApplicationStoreListing>}
301
301
  * @summary: List stores with inventory
302
- * @description: Lists stores where specified products are currently in stock.
302
+ * @description: List stores where specified products are currently in stock.
303
303
  */
304
304
  getInStockLocationsPaginator({ pageSize, q, city, range, latitude, longitude, }?: {
305
305
  pageSize?: number;
@@ -316,7 +316,7 @@ declare class Catalog {
316
316
  * @returns {Promise<CatalogApplicationModel.StoreDetails>} - Success response
317
317
  * @name getLocationDetailsById
318
318
  * @summary: Get selling location
319
- * @description: This API retrieves comprehensive details about a store based on its location Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getLocationDetailsById/).
319
+ * @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
320
  */
321
321
  getLocationDetailsById({ locationId, requestHeaders }?: CatalogApplicationValidator.GetLocationDetailsByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.StoreDetails>;
322
322
  /**
@@ -326,7 +326,7 @@ declare class Catalog {
326
326
  * @returns {Promise<CatalogApplicationModel.ProductBundle>} - Success response
327
327
  * @name getProductBundlesBySlug
328
328
  * @summary: List product bundles
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/).
329
+ * @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
330
  */
331
331
  getProductBundlesBySlug({ slug, id, requestHeaders }?: CatalogApplicationValidator.GetProductBundlesBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductBundle>;
332
332
  /**
@@ -339,7 +339,7 @@ declare class Catalog {
339
339
  * Success response
340
340
  * @name getProductComparisonBySlugs
341
341
  * @summary: List products for comparison
342
- * @description: Retrives all the products that have same category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductComparisonBySlugs/).
342
+ * @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
343
  */
344
344
  getProductComparisonBySlugs({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductComparisonBySlugsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductsComparisonResponse>;
345
345
  /**
@@ -349,7 +349,7 @@ declare class Catalog {
349
349
  * @returns {Promise<CatalogApplicationModel.ProductDetail>} - Success response
350
350
  * @name getProductDetailBySlug
351
351
  * @summary: Get a product
352
- * @description: Fetches properties related to Product such as price, attributes, HSN code, SKU code, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductDetailBySlug/).
352
+ * @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
353
  */
354
354
  getProductDetailBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductDetail>;
355
355
  /**
@@ -360,7 +360,7 @@ declare class Catalog {
360
360
  * Success response
361
361
  * @name getProductPriceBySlug
362
362
  * @summary: Get product price
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/).
363
+ * @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
364
  */
365
365
  getProductPriceBySlug({ slug, size, storeId, moq, requestHeaders }?: CatalogApplicationValidator.GetProductPriceBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductSizePriceResponseV3>;
366
366
  /**
@@ -372,23 +372,23 @@ declare class Catalog {
372
372
  *
373
373
  * @name getProductSellersBySlug
374
374
  * @summary: List sellers
375
- * @description: Retrieve a list of 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/).
375
+ * @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
376
  */
377
377
  getProductSellersBySlug({ slug, size, strategy, pageNo, pageSize, requestHeaders }?: CatalogApplicationValidator.GetProductSellersBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductSizeSellersResponseV3>;
378
378
  /**
379
379
  * @param {Object} arg - Arg object.
380
380
  * @param {string} arg.slug - A short, human-readable, URL-friendly
381
381
  * identifier of a product. You can get slug value from the endpoint
382
- * /service/application/catalog/v1.0/products/
382
+ * /service/application/catalog/v1.0/products/.
383
383
  * @param {string} arg.size - A string indicating the size of the product,
384
384
  * e.g. S, M, XL. You can get slug value from the endpoint
385
- * /service/application/catalog/v1.0/products/sizes
385
+ * /service/application/catalog/v1.0/products/sizes.
386
386
  * @param {string} [arg.strategy] - Sort stores on the basis of strategy.
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
390
  * @summary: List sellers
391
- * @description: Retrieve a list of all sellers offering a specific product identified by its slug and size
391
+ * @description: List all sellers offering a specific product identified by its slug and size.
392
392
  */
393
393
  getProductSellersBySlugPaginator({ slug, size, strategy, pageSize }?: {
394
394
  slug: string;
@@ -414,7 +414,7 @@ declare class Catalog {
414
414
  * Success response
415
415
  * @name getProductStockByIds
416
416
  * @summary: Get product stocks
417
- * @description: Retrieves 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/).
417
+ * @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
418
  */
419
419
  getProductStockByIds({ itemId, alu, skuCode, ean, upc, requestHeaders }?: CatalogApplicationValidator.GetProductStockByIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductStockStatusResponse>;
420
420
  /**
@@ -426,16 +426,16 @@ declare class Catalog {
426
426
  * @returns {Promise<CatalogApplicationModel.ProductStockPolling>} - Success response
427
427
  * @name getProductStockForTimeByIds
428
428
  * @summary: List future stock
429
- * @description: Retrives 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/).
429
+ * @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
430
  */
431
431
  getProductStockForTimeByIds({ timestamp, pageSize, pageId, requestHeaders }?: CatalogApplicationValidator.GetProductStockForTimeByIdsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductStockPolling>;
432
432
  /**
433
433
  * @param {Object} arg - Arg object.
434
- * @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z)
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
437
  * @summary: List future stock
438
- * @description: Retrives the available stock levels for all products associated with a particular sales channel at a specified future time.
438
+ * @description: Get the available stock levels for all products associated with a particular sales channel at a specified future time.
439
439
  */
440
440
  getProductStockForTimeByIdsPaginator({ timestamp, pageSize }?: {
441
441
  timestamp: string;
@@ -450,7 +450,7 @@ declare class Catalog {
450
450
  * Success response
451
451
  * @name getProductVariantsBySlug
452
452
  * @summary: List product variants
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/).
453
+ * @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
454
  */
455
455
  getProductVariantsBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetProductVariantsBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductVariantsResponse>;
456
456
  /**
@@ -461,7 +461,7 @@ declare class Catalog {
461
461
  * Success response
462
462
  * @name getProducts
463
463
  * @summary: List products
464
- * @description: Retrieves a list of 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/).
464
+ * @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
465
  */
466
466
  getProducts({ q, f, filters, sortOn, pageId, pageSize, pageNo, pageType, requestHeaders, }?: CatalogApplicationValidator.GetProductsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductListingResponse>;
467
467
  /**
@@ -471,16 +471,16 @@ declare class Catalog {
471
471
  * @param {string} [arg.f] - The search filter parameters. Filter parameters
472
472
  * will be passed in f parameter as shown in the example below. Double
473
473
  * Pipe (||) denotes the OR condition, whereas Triple-colon (:::)
474
- * indicates a new filter paramater applied as an AND condition.
475
- * @param {boolean} [arg.filters] - This is a boolean value, True for
476
- * fetching all filter parameters and False for disabling the filter parameters.
474
+ * indicates a new filter parameter applied as an AND condition.
475
+ * @param {boolean} [arg.filters] - True for fetching all filter parameters
476
+ * and False for disabling the filter parameters.
477
477
  * @param {string} [arg.sortOn] - The order in which the list of products
478
478
  * should be sorted, e.g. popularity, price, latest and discount, in
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
482
  * @summary: List products
483
- * @description: Retrieves a list of 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.
483
+ * @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
484
  */
485
485
  getProductsPaginator({ q, f, filters, sortOn, pageSize }?: {
486
486
  q?: string;
@@ -496,7 +496,7 @@ declare class Catalog {
496
496
  * @returns {Promise<CatalogApplicationModel.AutoCompleteResponse>} - Success response
497
497
  * @name getSearchResults
498
498
  * @summary: List product, brand, category
499
- * @description: Retrieve 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/).
499
+ * @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
500
  */
501
501
  getSearchResults({ q, requestHeaders }?: CatalogApplicationValidator.GetSearchResultsParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.AutoCompleteResponse>;
502
502
  /**
@@ -509,7 +509,7 @@ declare class Catalog {
509
509
  * Success response
510
510
  * @name getSimilarComparisonProductBySlug
511
511
  * @summary: List similar products
512
- * @description: Retrives 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/).
512
+ * @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
513
  */
514
514
  getSimilarComparisonProductBySlug({ slug, requestHeaders }?: CatalogApplicationValidator.GetSimilarComparisonProductBySlugParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.ProductCompareResponse>;
515
515
  /**
@@ -519,7 +519,7 @@ declare class Catalog {
519
519
  * @returns {Promise<CatalogApplicationModel.StoreListingResponse>} - Success response
520
520
  * @name getStores
521
521
  * @summary: List available stores
522
- * @description: Retrieves a list of all stores associated with sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
522
+ * @description: List all stores associated with the sales channel. - 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
  /**
@@ -528,15 +528,15 @@ declare class Catalog {
528
528
  * @param {string} [arg.q] - Search a store by its name or store_code.
529
529
  * @param {string} [arg.city] - Search stores by the city in which they are situated.
530
530
  * @param {number} [arg.range] - Use this to retrieve stores within a
531
- * particular range in meters, e.g. 10000, to indicate a 10km range
531
+ * particular range in meters, e.g. 10000, to indicate a 10km range.
532
532
  * @param {number} [arg.latitude] - Latitude of the location from where one
533
- * wants to retreive the nearest stores, e.g. 72.8691788
533
+ * wants to retrieve the nearest stores, e.g. 72.8691788.
534
534
  * @param {number} [arg.longitude] - Longitude of the location from where
535
- * one wants to retreive the nearest stores, e.g. 19.1174114
535
+ * one wants to retrieve 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
538
  * @summary: List available stores
539
- * @description: Retrieves a list of all stores associated with sales channel
539
+ * @description: List all stores associated with the sales channel.
540
540
  */
541
541
  getStoresPaginator({ pageSize, q, city, range, latitude, longitude, tags, }?: {
542
542
  pageSize?: number;
@@ -554,7 +554,7 @@ declare class Catalog {
554
554
  * @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
555
555
  * @name unfollowById
556
556
  * @summary: Delete item, brand, product
557
- * @description: Removes a followed item, brand, or product using its collection ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/unfollowById/).
557
+ * @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
558
  */
559
559
  unfollowById({ collectionType, collectionId, requestHeaders }?: CatalogApplicationValidator.UnfollowByIdParam, { responseHeaders }?: object): Promise<CatalogApplicationModel.FollowPostResponse>;
560
560
  }