@gofynd/fdk-client-javascript 1.4.2-beta.6 → 1.4.3

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 (187) hide show
  1. package/README.md +1 -1
  2. package/package.json +5 -3
  3. package/sdk/application/ApplicationAPIClient.d.ts +1 -1
  4. package/sdk/application/ApplicationAPIClient.js +0 -1
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +25 -25
  6. package/sdk/application/Cart/CartApplicationClient.js +25 -25
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +40 -40
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +40 -40
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
  10. package/sdk/application/Common/CommonApplicationClient.js +2 -2
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +10 -10
  16. package/sdk/application/Content/ContentApplicationClient.js +10 -10
  17. package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
  18. package/sdk/application/Content/ContentApplicationModel.js +26 -26
  19. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
  20. package/sdk/application/FileStorage/FileStorageApplicationClient.js +12 -6
  21. package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
  22. package/sdk/application/Lead/LeadApplicationClient.js +7 -7
  23. package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
  24. package/sdk/application/Lead/LeadApplicationModel.js +42 -52
  25. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +9 -9
  26. package/sdk/application/Logistic/LogisticApplicationClient.js +9 -9
  27. package/sdk/application/Order/OrderApplicationClient.d.ts +13 -13
  28. package/sdk/application/Order/OrderApplicationClient.js +16 -12
  29. package/sdk/application/Order/OrderApplicationValidator.d.ts +7 -0
  30. package/sdk/application/Order/OrderApplicationValidator.js +3 -0
  31. package/sdk/application/Payment/PaymentApplicationClient.d.ts +47 -47
  32. package/sdk/application/Payment/PaymentApplicationClient.js +52 -52
  33. package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
  34. package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
  35. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
  36. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  37. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +27 -27
  38. package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
  39. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +6 -6
  40. package/sdk/application/Rewards/RewardsApplicationClient.js +6 -6
  41. package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
  42. package/sdk/application/Share/ShareApplicationClient.js +7 -7
  43. package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
  44. package/sdk/application/Share/ShareApplicationModel.js +2 -0
  45. package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
  46. package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
  47. package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
  48. package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
  49. package/sdk/application/User/UserApplicationClient.d.ts +28 -28
  50. package/sdk/application/User/UserApplicationClient.js +28 -28
  51. package/sdk/application/User/UserApplicationModel.d.ts +44 -13
  52. package/sdk/application/User/UserApplicationModel.js +17 -13
  53. package/sdk/common/AxiosHelper.d.ts +1 -1
  54. package/sdk/common/AxiosHelper.js +38 -17
  55. package/sdk/common/Clickstream.js +33 -19
  56. package/sdk/common/curlHelper.js +1 -3
  57. package/sdk/common/utils.d.ts +15 -0
  58. package/sdk/common/utils.js +30 -0
  59. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +2 -2
  60. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
  61. package/sdk/partner/Lead/LeadPartnerClient.d.ts +1 -1
  62. package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
  63. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +4 -4
  64. package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
  65. package/sdk/partner/OAuthClient.d.ts +3 -3
  66. package/sdk/partner/PartnerAPIClient.d.ts +1 -1
  67. package/sdk/partner/PartnerAPIClient.js +0 -1
  68. package/sdk/partner/Theme/ThemePartnerClient.d.ts +19 -19
  69. package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
  70. package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
  71. package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
  72. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
  73. package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
  74. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
  75. package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -2
  76. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +4 -4
  77. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -4
  78. package/sdk/platform/Billing/BillingPlatformClient.d.ts +17 -17
  79. package/sdk/platform/Billing/BillingPlatformClient.js +17 -17
  80. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +49 -49
  81. package/sdk/platform/Cart/CartPlatformApplicationClient.js +49 -49
  82. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +60 -60
  83. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +62 -62
  84. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +87 -87
  85. package/sdk/platform/Catalog/CatalogPlatformClient.js +87 -87
  86. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
  87. package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
  88. package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
  89. package/sdk/platform/Common/CommonPlatformClient.js +2 -2
  90. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +58 -58
  91. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +58 -58
  92. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  93. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  94. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
  95. package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
  96. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +16 -16
  97. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +16 -16
  98. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
  99. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
  100. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
  101. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
  102. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +18 -18
  103. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +18 -18
  104. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +57 -57
  105. package/sdk/platform/Content/ContentPlatformApplicationClient.js +63 -63
  106. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
  107. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
  108. package/sdk/platform/Content/ContentPlatformClient.d.ts +3 -3
  109. package/sdk/platform/Content/ContentPlatformClient.js +9 -9
  110. package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
  111. package/sdk/platform/Content/ContentPlatformModel.js +26 -26
  112. package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
  113. package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
  114. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
  115. package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
  116. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +9 -9
  117. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -13
  118. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  119. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +23 -14
  120. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
  121. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
  122. package/sdk/platform/Finance/FinancePlatformClient.d.ts +27 -27
  123. package/sdk/platform/Finance/FinancePlatformClient.js +27 -27
  124. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +6 -6
  125. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +6 -6
  126. package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
  127. package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
  128. package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
  129. package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
  130. package/sdk/platform/OAuthClient.d.ts +3 -3
  131. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +2 -2
  132. package/sdk/platform/Order/OrderPlatformApplicationClient.js +2 -2
  133. package/sdk/platform/Order/OrderPlatformClient.d.ts +43 -43
  134. package/sdk/platform/Order/OrderPlatformClient.js +55 -44
  135. package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -2
  136. package/sdk/platform/Order/OrderPlatformModel.js +8 -2
  137. package/sdk/platform/Order/OrderPlatformValidator.d.ts +14 -0
  138. package/sdk/platform/Order/OrderPlatformValidator.js +6 -0
  139. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
  140. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
  141. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +38 -38
  142. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +38 -38
  143. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
  144. package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
  145. package/sdk/platform/PlatformAPIClient.d.ts +1 -1
  146. package/sdk/platform/PlatformAPIClient.js +0 -1
  147. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
  148. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
  149. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +9 -9
  150. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +9 -9
  151. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +15 -15
  152. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +15 -15
  153. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
  154. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
  155. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
  156. package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
  157. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
  158. package/sdk/platform/Share/SharePlatformModel.js +2 -0
  159. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +28 -28
  160. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +28 -28
  161. package/sdk/platform/Theme/ThemePlatformClient.d.ts +3 -3
  162. package/sdk/platform/Theme/ThemePlatformClient.js +3 -3
  163. package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
  164. package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
  165. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +16 -16
  166. package/sdk/platform/User/UserPlatformApplicationClient.js +16 -16
  167. package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
  168. package/sdk/platform/User/UserPlatformModel.js +21 -13
  169. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +16 -16
  170. package/sdk/platform/Webhook/WebhookPlatformClient.js +16 -16
  171. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +5 -45
  172. package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -50
  173. package/sdk/public/Billing/BillingPublicClient.d.ts +1 -1
  174. package/sdk/public/Billing/BillingPublicClient.js +4 -4
  175. package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
  176. package/sdk/public/Billing/BillingPublicValidator.js +2 -2
  177. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +1 -1
  178. package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
  179. package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
  180. package/sdk/public/Content/ContentPublicValidator.js +3 -3
  181. package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
  182. package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
  183. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  184. package/sdk/public/Partner/PartnerPublicClient.js +1 -1
  185. package/sdk/public/PublicAPIClient.d.ts +1 -1
  186. package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
  187. package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
@@ -42,7 +42,7 @@ declare class Catalog {
42
42
  * @param {import("../ApplicationAPIClient").Options} - Options
43
43
  * @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
44
44
  * @name followById
45
- * @summary: Follows an item by ID.
45
+ * @summary: Follows an item by ID
46
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>;
@@ -52,7 +52,7 @@ declare class Catalog {
52
52
  * @param {import("../ApplicationAPIClient").Options} - Options
53
53
  * @returns {Promise<CatalogApplicationModel.BrandDetailResponse>} - Success response
54
54
  * @name getBrandDetailBySlug
55
- * @summary: Retrieves detailed brand info by slug.
55
+ * @summary: Retrieves detailed brand info by slug
56
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>;
@@ -62,7 +62,7 @@ declare class Catalog {
62
62
  * @param {import("../ApplicationAPIClient").Options} - Options
63
63
  * @returns {Promise<CatalogApplicationModel.BrandListingResponse>} - Success response
64
64
  * @name getBrands
65
- * @summary: Fetches all available brands.
65
+ * @summary: Fetches all available brands
66
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>;
@@ -74,7 +74,7 @@ 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: Fetches all available brands.
77
+ * @summary: Fetches all available brands
78
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 }?: {
@@ -88,7 +88,7 @@ declare class Catalog {
88
88
  * @returns {Promise<CatalogApplicationModel.CategoryListingResponse>} -
89
89
  * Success response
90
90
  * @name getCategories
91
- * @summary: Lists all product categories.
91
+ * @summary: Lists all product categories
92
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>;
@@ -98,7 +98,7 @@ declare class Catalog {
98
98
  * @param {import("../ApplicationAPIClient").Options} - Options
99
99
  * @returns {Promise<CatalogApplicationModel.CategoryMetaResponse>} - Success response
100
100
  * @name getCategoryDetailBySlug
101
- * @summary: Retrieves category details by slug.
101
+ * @summary: Retrieves category details by slug
102
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>;
@@ -111,7 +111,7 @@ declare class Catalog {
111
111
  * @returns {Promise<CatalogApplicationModel.CollectionDetailResponse>} -
112
112
  * Success response
113
113
  * @name getCollectionDetailBySlug
114
- * @summary: Retrieves collection details by slug.
114
+ * @summary: Retrieves collection details by slug
115
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>;
@@ -123,7 +123,7 @@ declare class Catalog {
123
123
  * @returns {Promise<CatalogApplicationModel.ProductListingResponse>} -
124
124
  * Success response
125
125
  * @name getCollectionItemsBySlug
126
- * @summary: Lists items in a collection by slug.
126
+ * @summary: Lists items in a collection by slug
127
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>;
@@ -145,7 +145,7 @@ 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: Lists items in a collection by slug.
148
+ * @summary: Lists items in a collection by slug
149
149
  * @description: Retrieve items in a specific collection identified by its slug.
150
150
  */
151
151
  getCollectionItemsBySlugPaginator({ slug, f, q, filters, sortOn, pageSize, }?: {
@@ -164,7 +164,7 @@ declare class Catalog {
164
164
  * - Success response
165
165
  *
166
166
  * @name getCollections
167
- * @summary: Fetches all available collections.
167
+ * @summary: Fetches all available collections
168
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>;
@@ -174,7 +174,7 @@ 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: Fetches all available collections.
177
+ * @summary: Fetches all available collections
178
178
  * @description: Retrieves a list of curated product collections.
179
179
  */
180
180
  getCollectionsPaginator({ pageSize, tag, q }?: {
@@ -192,7 +192,7 @@ declare class Catalog {
192
192
  * - Success response
193
193
  *
194
194
  * @name getComparedFrequentlyProductBySlug
195
- * @summary: Retrieves products frequently compared with a given product.
195
+ * @summary: Retrieves products frequently compared with a given product
196
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>;
@@ -202,7 +202,7 @@ declare class Catalog {
202
202
  * @param {import("../ApplicationAPIClient").Options} - Options
203
203
  * @returns {Promise<CatalogApplicationModel.DepartmentResponse>} - Success response
204
204
  * @name getDepartments
205
- * @summary: Lists all departments.
205
+ * @summary: Lists all departments
206
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>;
@@ -212,7 +212,7 @@ declare class Catalog {
212
212
  * @param {import("../ApplicationAPIClient").Options} - Options
213
213
  * @returns {Promise<CatalogApplicationModel.FollowIdsResponse>} - Success response
214
214
  * @name getFollowIds
215
- * @summary: Fetches IDs of followed items.
215
+ * @summary: Fetches IDs of followed items
216
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>;
@@ -223,7 +223,7 @@ declare class Catalog {
223
223
  * @returns {Promise<CatalogApplicationModel.GetFollowListingResponse>} -
224
224
  * Success response
225
225
  * @name getFollowedListing
226
- * @summary: Retrieves user's followed listings.
226
+ * @summary: Retrieves user's followed listings
227
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>;
@@ -233,7 +233,7 @@ 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: Retrieves user's followed listings.
236
+ * @summary: Retrieves user's followed listings
237
237
  * @description: Retrieve a list of products or brands the user is following.
238
238
  */
239
239
  getFollowedListingPaginator({ collectionType, pageSize }?: {
@@ -247,7 +247,7 @@ declare class Catalog {
247
247
  * @returns {Promise<CatalogApplicationModel.FollowerCountResponse>} -
248
248
  * Success response
249
249
  * @name getFollowerCountById
250
- * @summary: Retrieves follower count for an item.
250
+ * @summary: Retrieves follower count for an item
251
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>;
@@ -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: Fetches homepage-featured products.
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: Fetches homepage-featured products.
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,7 +282,7 @@ declare class Catalog {
282
282
  * @returns {Promise<CatalogApplicationModel.ApplicationStoreListing>} -
283
283
  * Success response
284
284
  * @name getInStockLocations
285
- * @summary: Finds in-stock locations for products.
285
+ * @summary: Finds in-stock locations for products
286
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>;
@@ -298,7 +298,7 @@ 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: Finds in-stock locations for products.
301
+ * @summary: Finds in-stock locations for products
302
302
  * @description: Lists locations where specified products are currently in stock.
303
303
  */
304
304
  getInStockLocationsPaginator({ pageSize, q, city, range, latitude, longitude, }?: {
@@ -315,7 +315,7 @@ declare class Catalog {
315
315
  * @param {import("../ApplicationAPIClient").Options} - Options
316
316
  * @returns {Promise<CatalogApplicationModel.StoreDetails>} - Success response
317
317
  * @name getLocationDetailsById
318
- * @summary: Retrieves location details by ID.
318
+ * @summary: Retrieves location details by ID
319
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>;
@@ -325,7 +325,7 @@ declare class Catalog {
325
325
  * @param {import("../ApplicationAPIClient").Options} - Options
326
326
  * @returns {Promise<CatalogApplicationModel.ProductBundle>} - Success response
327
327
  * @name getProductBundlesBySlug
328
- * @summary: Fetches product bundles by slug.
328
+ * @summary: Fetches product bundles by slug
329
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>;
@@ -338,7 +338,7 @@ declare class Catalog {
338
338
  * @returns {Promise<CatalogApplicationModel.ProductsComparisonResponse>} -
339
339
  * Success response
340
340
  * @name getProductComparisonBySlugs
341
- * @summary: Compares multiple products by slugs.
341
+ * @summary: Compares multiple products by slugs
342
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>;
@@ -348,7 +348,7 @@ declare class Catalog {
348
348
  * @param {import("../ApplicationAPIClient").Options} - Options
349
349
  * @returns {Promise<CatalogApplicationModel.ProductDetail>} - Success response
350
350
  * @name getProductDetailBySlug
351
- * @summary: Fetches detailed product information by slug.
351
+ * @summary: Fetches detailed product information by slug
352
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>;
@@ -359,7 +359,7 @@ declare class Catalog {
359
359
  * @returns {Promise<CatalogApplicationModel.ProductSizePriceResponseV3>} -
360
360
  * Success response
361
361
  * @name getProductPriceBySlug
362
- * @summary: Retrieves product price by slug.
362
+ * @summary: Retrieves product price by slug
363
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>;
@@ -371,7 +371,7 @@ declare class Catalog {
371
371
  * - Success response
372
372
  *
373
373
  * @name getProductSellersBySlug
374
- * @summary: Lists sellers for a product by slug.
374
+ * @summary: Lists sellers for a product by slug
375
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>;
@@ -387,7 +387,7 @@ 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: Lists sellers for a product by slug.
390
+ * @summary: Lists sellers for a product by slug
391
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 }?: {
@@ -402,7 +402,7 @@ declare class Catalog {
402
402
  * @param {import("../ApplicationAPIClient").Options} - Options
403
403
  * @returns {Promise<CatalogApplicationModel.ProductSizes>} - Success response
404
404
  * @name getProductSizesBySlug
405
- * @summary: Retrieves available sizes for a product by slug.
405
+ * @summary: Retrieves available sizes for a product by slug
406
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>;
@@ -413,7 +413,7 @@ declare class Catalog {
413
413
  * @returns {Promise<CatalogApplicationModel.ProductStockStatusResponse>} -
414
414
  * Success response
415
415
  * @name getProductStockByIds
416
- * @summary: Checks product stock by IDs.
416
+ * @summary: Checks product stock by IDs
417
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>;
@@ -425,7 +425,7 @@ declare class Catalog {
425
425
  * @param {import("../ApplicationAPIClient").Options} - Options
426
426
  * @returns {Promise<CatalogApplicationModel.ProductStockPolling>} - Success response
427
427
  * @name getProductStockForTimeByIds
428
- * @summary: Fetches future stock data for products.
428
+ * @summary: Fetches future stock data for products
429
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>;
@@ -434,7 +434,7 @@ 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: Fetches future stock data for products.
437
+ * @summary: Fetches future stock data for products
438
438
  * @description: Retrieves projected stock levels for specified products at a future time.
439
439
  */
440
440
  getProductStockForTimeByIdsPaginator({ timestamp, pageSize }?: {
@@ -449,7 +449,7 @@ declare class Catalog {
449
449
  * @returns {Promise<CatalogApplicationModel.ProductVariantsResponse>} -
450
450
  * Success response
451
451
  * @name getProductVariantsBySlug
452
- * @summary: Retrieves product variants by slug.
452
+ * @summary: Retrieves product variants by slug
453
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>;
@@ -460,7 +460,7 @@ declare class Catalog {
460
460
  * @returns {Promise<CatalogApplicationModel.ProductListingResponse>} -
461
461
  * Success response
462
462
  * @name getProducts
463
- * @summary: Lists all products.
463
+ * @summary: Lists all products
464
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>;
@@ -479,7 +479,7 @@ 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: Lists all products.
482
+ * @summary: Lists all products
483
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 }?: {
@@ -495,7 +495,7 @@ declare class Catalog {
495
495
  * @param {import("../ApplicationAPIClient").Options} - Options
496
496
  * @returns {Promise<CatalogApplicationModel.AutoCompleteResponse>} - Success response
497
497
  * @name getSearchResults
498
- * @summary: Retrieves search result listings.
498
+ * @summary: Retrieves search result listings
499
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>;
@@ -508,7 +508,7 @@ declare class Catalog {
508
508
  * @returns {Promise<CatalogApplicationModel.ProductCompareResponse>} -
509
509
  * Success response
510
510
  * @name getSimilarComparisonProductBySlug
511
- * @summary: Fetches similar products for comparison.
511
+ * @summary: Fetches similar products for comparison
512
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>;
@@ -518,7 +518,7 @@ declare class Catalog {
518
518
  * @param {import("../ApplicationAPIClient").Options} - Options
519
519
  * @returns {Promise<CatalogApplicationModel.StoreListingResponse>} - Success response
520
520
  * @name getStores
521
- * @summary: Lists available stores.
521
+ * @summary: Lists available stores
522
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>;
@@ -535,7 +535,7 @@ 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: Lists available stores.
538
+ * @summary: Lists available stores
539
539
  * @description: Retrieves a list of all physical or online stores.
540
540
  */
541
541
  getStoresPaginator({ pageSize, q, city, range, latitude, longitude, tags, }?: {
@@ -553,7 +553,7 @@ declare class Catalog {
553
553
  * @param {import("../ApplicationAPIClient").Options} - Options
554
554
  * @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
555
555
  * @name unfollowById
556
- * @summary: Unfollows an item by ID.
556
+ * @summary: Unfollows an item by ID
557
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>;