@gofynd/fdk-client-javascript 1.4.15-beta.6 → 1.4.16-beta.1

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 (237) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +2 -0
  4. package/sdk/application/ApplicationClient.js +2 -0
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
  6. package/sdk/application/Cart/CartApplicationClient.js +130 -27
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
  10. package/sdk/application/Common/CommonApplicationClient.js +1 -1
  11. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
  12. package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
  13. package/sdk/application/Content/ContentApplicationClient.d.ts +19 -30
  14. package/sdk/application/Content/ContentApplicationClient.js +40 -60
  15. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -8
  16. package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -7
  17. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  18. package/sdk/application/Finance/FinanceApplicationClient.js +126 -0
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
  20. package/sdk/application/Lead/LeadApplicationClient.js +1 -1
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +118 -8
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
  24. package/sdk/application/Order/OrderApplicationClient.js +62 -8
  25. package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
  26. package/sdk/application/Payment/PaymentApplicationClient.js +65 -46
  27. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
  28. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  29. package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
  30. package/sdk/application/Theme/ThemeApplicationClient.js +4 -2
  31. package/sdk/application/User/UserApplicationClient.d.ts +10 -10
  32. package/sdk/application/User/UserApplicationClient.js +6 -6
  33. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  34. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
  35. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
  36. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
  37. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
  38. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
  39. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
  40. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
  41. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  42. package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
  43. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
  44. package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
  45. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
  46. package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
  47. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
  48. package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
  49. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
  50. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
  51. package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
  52. package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
  53. package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
  54. package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
  55. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  56. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
  57. package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
  58. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
  59. package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
  60. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
  61. package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
  62. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
  63. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
  64. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
  65. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
  66. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
  67. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
  68. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
  69. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
  70. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  71. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  72. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  73. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  74. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  75. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  76. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  77. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  78. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
  79. package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
  80. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
  81. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
  82. package/sdk/platform/Cart/CartPlatformModel.d.ts +5039 -1300
  83. package/sdk/platform/Cart/CartPlatformModel.js +1976 -1217
  84. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
  85. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
  86. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
  87. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
  88. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
  89. package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
  90. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6941 -2203
  91. package/sdk/platform/Catalog/CatalogPlatformModel.js +3224 -1687
  92. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
  93. package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
  94. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
  95. package/sdk/platform/Common/CommonPlatformClient.js +3 -2
  96. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  97. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  98. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
  99. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
  100. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
  101. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
  102. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
  103. package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
  104. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
  105. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
  106. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
  107. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
  108. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  109. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  110. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
  111. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
  112. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
  113. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
  114. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
  115. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
  116. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
  117. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
  118. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  119. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  120. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
  121. package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
  122. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
  123. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
  124. package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
  125. package/sdk/platform/Content/ContentPlatformClient.js +523 -336
  126. package/sdk/platform/Content/ContentPlatformModel.d.ts +1241 -395
  127. package/sdk/platform/Content/ContentPlatformModel.js +521 -390
  128. package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
  129. package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
  130. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
  131. package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
  132. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
  133. package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
  134. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  135. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  136. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
  137. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
  138. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
  139. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
  140. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
  141. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
  142. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
  143. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
  144. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  145. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  146. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
  147. package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
  148. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
  149. package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
  150. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
  151. package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
  152. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
  153. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
  154. package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
  155. package/sdk/platform/Order/OrderPlatformClient.js +416 -198
  156. package/sdk/platform/Order/OrderPlatformModel.d.ts +7602 -1269
  157. package/sdk/platform/Order/OrderPlatformModel.js +3926 -1269
  158. package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
  159. package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
  160. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
  161. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
  162. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  163. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  164. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
  165. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
  166. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
  167. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
  168. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  169. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  170. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
  171. package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
  172. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  173. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  174. package/sdk/platform/PlatformClient.d.ts +0 -2
  175. package/sdk/platform/PlatformClient.js +0 -4
  176. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  177. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  178. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  179. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  180. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
  181. package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
  182. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +48 -38
  183. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +134 -43
  184. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
  185. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
  186. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +38 -44
  187. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +56 -62
  188. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
  189. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
  190. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
  191. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
  192. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
  193. package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
  194. package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
  195. package/sdk/platform/Share/SharePlatformModel.js +27 -4
  196. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
  197. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
  198. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
  199. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
  200. package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
  201. package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
  202. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
  203. package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
  204. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
  205. package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
  206. package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
  207. package/sdk/platform/User/UserPlatformModel.js +23 -23
  208. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
  209. package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
  210. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
  211. package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
  212. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  213. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  214. package/sdk/platform/index.d.ts +0 -1
  215. package/sdk/platform/index.js +0 -2
  216. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
  217. package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
  218. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
  219. package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
  220. package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
  221. package/sdk/public/Content/ContentPublicClient.js +895 -8
  222. package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
  223. package/sdk/public/Content/ContentPublicModel.js +649 -3
  224. package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
  225. package/sdk/public/Content/ContentPublicValidator.js +88 -2
  226. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  227. package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
  228. package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
  229. package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
  230. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  231. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  232. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  233. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  234. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  235. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  236. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  237. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
@@ -81,7 +81,7 @@ class Catalog {
81
81
  /**
82
82
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
83
83
  * @param {import("../ApplicationAPIClient").Options} - Options
84
- * @returns {Promise<FollowPostResponse>} - Success response
84
+ * @returns {Promise<FollowPostResponseSchema>} - Success response
85
85
  * @name followById
86
86
  * @summary: Create item, brand, product
87
87
  * @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/).
@@ -139,7 +139,7 @@ class Catalog {
139
139
  /**
140
140
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
141
141
  * @param {import("../ApplicationAPIClient").Options} - Options
142
- * @returns {Promise<BrandDetailResponse>} - Success response
142
+ * @returns {Promise<BrandDetailResponseSchema>} - Success response
143
143
  * @name getBrandDetailBySlug
144
144
  * @summary: Get a brand
145
145
  * @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/).
@@ -191,7 +191,7 @@ class Catalog {
191
191
  /**
192
192
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
193
193
  * @param {import("../ApplicationAPIClient").Options} - Options
194
- * @returns {Promise<BrandListingResponse>} - Success response
194
+ * @returns {Promise<BrandListingResponseSchema>} - Success response
195
195
  * @name getBrands
196
196
  * @summary: List brands
197
197
  * @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/).
@@ -243,7 +243,7 @@ class Catalog {
243
243
  * of available departments below. Also, you can get available departments
244
244
  * from the endpoint /service/application/catalog/v1.0/departments/.
245
245
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
246
- * @returns {Paginator<BrandListingResponse>}
246
+ * @returns {Paginator<BrandListingResponseSchema>}
247
247
  * @summary: List brands
248
248
  * @description: Get a list of all the available brands. Filtering can be applied to the department.
249
249
  */
@@ -271,7 +271,7 @@ class Catalog {
271
271
  /**
272
272
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
273
273
  * @param {import("../ApplicationAPIClient").Options} - Options
274
- * @returns {Promise<CategoryListingResponse>} - Success response
274
+ * @returns {Promise<CategoryListingResponseSchema>} - Success response
275
275
  * @name getCategories
276
276
  * @summary: List product categories
277
277
  * @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/).
@@ -317,7 +317,7 @@ class Catalog {
317
317
  /**
318
318
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
319
319
  * @param {import("../ApplicationAPIClient").Options} - Options
320
- * @returns {Promise<CategoryMetaResponse>} - Success response
320
+ * @returns {Promise<CategoryMetaResponseSchema>} - Success response
321
321
  * @name getCategoryDetailBySlug
322
322
  * @summary: Get category by slug
323
323
  * @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/).
@@ -369,7 +369,7 @@ class Catalog {
369
369
  /**
370
370
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
371
371
  * @param {import("../ApplicationAPIClient").Options} - Options
372
- * @returns {Promise<CollectionDetailResponse>} - Success response
372
+ * @returns {Promise<CollectionDetailResponseSchema>} - Success response
373
373
  * @name getCollectionDetailBySlug
374
374
  * @summary: Get a collection
375
375
  * @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/).
@@ -421,7 +421,7 @@ class Catalog {
421
421
  /**
422
422
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
423
423
  * @param {import("../ApplicationAPIClient").Options} - Options
424
- * @returns {Promise<ProductListingResponse>} - Success response
424
+ * @returns {Promise<ProductListingResponseSchema>} - Success response
425
425
  * @name getCollectionItemsBySlug
426
426
  * @summary: Lists items of collection
427
427
  * @description: Fetch items within a particular collection identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionItemsBySlug/).
@@ -506,7 +506,7 @@ class Catalog {
506
506
  * should be sorted, e.g. popularity, price, latest and discount, in
507
507
  * either ascending or descending order. See the supported values below.
508
508
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
509
- * @returns {Paginator<ProductListingResponse>}
509
+ * @returns {Paginator<ProductListingResponseSchema>}
510
510
  * @summary: Lists items of collection
511
511
  * @description: Fetch items within a particular collection identified by its slug.
512
512
  */
@@ -547,7 +547,7 @@ class Catalog {
547
547
  /**
548
548
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
549
549
  * @param {import("../ApplicationAPIClient").Options} - Options
550
- * @returns {Promise<GetCollectionListingResponse>} - Success response
550
+ * @returns {Promise<GetCollectionListingResponseSchema>} - Success response
551
551
  * @name getCollections
552
552
  * @summary: List collections
553
553
  * @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/).
@@ -598,7 +598,7 @@ class Catalog {
598
598
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
599
599
  * @param {string[]} [arg.tag] - List of tags to filter collections.
600
600
  * @param {string} [arg.q] - Name of the collection to filter collection.
601
- * @returns {Paginator<GetCollectionListingResponse>}
601
+ * @returns {Paginator<GetCollectionListingResponseSchema>}
602
602
  * @summary: List collections
603
603
  * @description: List of curated product collections with filtering options based on tags and collection names.
604
604
  */
@@ -627,7 +627,8 @@ class Catalog {
627
627
  /**
628
628
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
629
629
  * @param {import("../ApplicationAPIClient").Options} - Options
630
- * @returns {Promise<ProductFrequentlyComparedSimilarResponse>} - Success response
630
+ * @returns {Promise<ProductFrequentlyComparedSimilarResponseSchema>} -
631
+ * Success response
631
632
  * @name getComparedFrequentlyProductBySlug
632
633
  * @summary: List frequent products
633
634
  * @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/).
@@ -679,7 +680,7 @@ class Catalog {
679
680
  /**
680
681
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
681
682
  * @param {import("../ApplicationAPIClient").Options} - Options
682
- * @returns {Promise<DepartmentResponse>} - Success response
683
+ * @returns {Promise<DepartmentResponseSchema>} - Success response
683
684
  * @name getDepartments
684
685
  * @summary: List departments
685
686
  * @description: List all departments associated with available products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
@@ -724,7 +725,7 @@ class Catalog {
724
725
  /**
725
726
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
726
727
  * @param {import("../ApplicationAPIClient").Options} - Options
727
- * @returns {Promise<FollowIdsResponse>} - Success response
728
+ * @returns {Promise<FollowIdsResponseSchema>} - Success response
728
729
  * @name getFollowIds
729
730
  * @summary: List Ids of followed item, brand, product
730
731
  * @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/).
@@ -770,7 +771,7 @@ class Catalog {
770
771
  /**
771
772
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
772
773
  * @param {import("../ApplicationAPIClient").Options} - Options
773
- * @returns {Promise<GetFollowListingResponse>} - Success response
774
+ * @returns {Promise<GetFollowListingResponseSchema>} - Success response
774
775
  * @name getFollowedListing
775
776
  * @summary: List followed products, brands
776
777
  * @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/).
@@ -828,7 +829,7 @@ class Catalog {
828
829
  * @param {string} arg.collectionType - Type of collection followed, i.e.
829
830
  * products, brands, or collections.
830
831
  * @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
831
- * @returns {Paginator<GetFollowListingResponse>}
832
+ * @returns {Paginator<GetFollowListingResponseSchema>}
832
833
  * @summary: List followed products, brands
833
834
  * @description: Get a list of products or brands the user is following.
834
835
  */
@@ -856,7 +857,7 @@ class Catalog {
856
857
  /**
857
858
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
858
859
  * @param {import("../ApplicationAPIClient").Options} - Options
859
- * @returns {Promise<FollowerCountResponse>} - Success response
860
+ * @returns {Promise<FollowerCountResponseSchema>} - Success response
860
861
  * @name getFollowerCountById
861
862
  * @summary: Get follower count
862
863
  * @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/).
@@ -914,7 +915,7 @@ class Catalog {
914
915
  /**
915
916
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
916
917
  * @param {import("../ApplicationAPIClient").Options} - Options
917
- * @returns {Promise<HomeListingResponse>} - Success response
918
+ * @returns {Promise<HomeListingResponseSchema>} - Success response
918
919
  * @name getHomeProducts
919
920
  * @summary: List homepage-featured products
920
921
  * @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/).
@@ -965,7 +966,7 @@ class Catalog {
965
966
  * should be sorted, e.g. popularity, price, latest and discount, in
966
967
  * either ascending or descending order.
967
968
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
968
- * @returns {Paginator<HomeListingResponse>}
969
+ * @returns {Paginator<HomeListingResponseSchema>}
969
970
  * @summary: List homepage-featured products
970
971
  * @description: List all the products associated with a brand, collection or category in a random order.
971
972
  */
@@ -1200,7 +1201,7 @@ class Catalog {
1200
1201
  /**
1201
1202
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1202
1203
  * @param {import("../ApplicationAPIClient").Options} - Options
1203
- * @returns {Promise<ProductsComparisonResponse>} - Success response
1204
+ * @returns {Promise<ProductsComparisonResponseSchema>} - Success response
1204
1205
  * @name getProductComparisonBySlugs
1205
1206
  * @summary: List products for comparison
1206
1207
  * @description: Get all the products that have the same category. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductComparisonBySlugs/).
@@ -1519,7 +1520,7 @@ class Catalog {
1519
1520
  /**
1520
1521
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1521
1522
  * @param {import("../ApplicationAPIClient").Options} - Options
1522
- * @returns {Promise<ProductStockStatusResponse>} - Success response
1523
+ * @returns {Promise<ProductStockStatusResponseSchema>} - Success response
1523
1524
  * @name getProductStockByIds
1524
1525
  * @summary: Get product stocks
1525
1526
  * @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/).
@@ -1653,7 +1654,7 @@ class Catalog {
1653
1654
  /**
1654
1655
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1655
1656
  * @param {import("../ApplicationAPIClient").Options} - Options
1656
- * @returns {Promise<ProductVariantsResponse>} - Success response
1657
+ * @returns {Promise<ProductVariantsResponseSchema>} - Success response
1657
1658
  * @name getProductVariantsBySlug
1658
1659
  * @summary: List product variants
1659
1660
  * @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/).
@@ -1705,7 +1706,7 @@ class Catalog {
1705
1706
  /**
1706
1707
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1707
1708
  * @param {import("../ApplicationAPIClient").Options} - Options
1708
- * @returns {Promise<ProductListingResponse>} - Success response
1709
+ * @returns {Promise<ProductListingResponseSchema>} - Success response
1709
1710
  * @name getProducts
1710
1711
  * @summary: List products
1711
1712
  * @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/).
@@ -1779,7 +1780,7 @@ class Catalog {
1779
1780
  * should be sorted, e.g. popularity, price, latest and discount, in
1780
1781
  * either ascending or descending order. See the supported values below.
1781
1782
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
1782
- * @returns {Paginator<ProductListingResponse>}
1783
+ * @returns {Paginator<ProductListingResponseSchema>}
1783
1784
  * @summary: List products
1784
1785
  * @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.
1785
1786
  */
@@ -1812,7 +1813,7 @@ class Catalog {
1812
1813
  /**
1813
1814
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1814
1815
  * @param {import("../ApplicationAPIClient").Options} - Options
1815
- * @returns {Promise<AutoCompleteResponse>} - Success response
1816
+ * @returns {Promise<AutoCompleteResponseSchema>} - Success response
1816
1817
  * @name getSearchResults
1817
1818
  * @summary: List product, brand, category
1818
1819
  * @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/).
@@ -1865,7 +1866,7 @@ class Catalog {
1865
1866
  /**
1866
1867
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1867
1868
  * @param {import("../ApplicationAPIClient").Options} - Options
1868
- * @returns {Promise<ProductCompareResponse>} - Success response
1869
+ * @returns {Promise<ProductCompareResponseSchema>} - Success response
1869
1870
  * @name getSimilarComparisonProductBySlug
1870
1871
  * @summary: List similar products
1871
1872
  * @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/).
@@ -1917,7 +1918,7 @@ class Catalog {
1917
1918
  /**
1918
1919
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1919
1920
  * @param {import("../ApplicationAPIClient").Options} - Options
1920
- * @returns {Promise<StoreListingResponse>} - Success response
1921
+ * @returns {Promise<StoreListingResponseSchema>} - Success response
1921
1922
  * @name getStores
1922
1923
  * @summary: List available stores
1923
1924
  * @description: List all stores associated with the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
@@ -1989,7 +1990,7 @@ class Catalog {
1989
1990
  * @param {number} [arg.longitude] - Longitude of the location from where
1990
1991
  * one wants to retrieve the nearest stores, e.g. 19.1174114.
1991
1992
  * @param {string} [arg.tags] - Search stores based on tags.
1992
- * @returns {Paginator<StoreListingResponse>}
1993
+ * @returns {Paginator<StoreListingResponseSchema>}
1993
1994
  * @summary: List available stores
1994
1995
  * @description: List all stores associated with the sales channel.
1995
1996
  */
@@ -2030,7 +2031,7 @@ class Catalog {
2030
2031
  /**
2031
2032
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
2032
2033
  * @param {import("../ApplicationAPIClient").Options} - Options
2033
- * @returns {Promise<FollowPostResponse>} - Success response
2034
+ * @returns {Promise<FollowPostResponseSchema>} - Success response
2034
2035
  * @name unfollowById
2035
2036
  * @summary: Delete item, brand, product
2036
2037
  * @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/).
@@ -20,10 +20,10 @@ declare class Common {
20
20
  /**
21
21
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
22
22
  * @param {import("../ApplicationAPIClient").Options} - Options
23
- * @returns {Promise<ApplicationResponse>} - Success response
23
+ * @returns {Promise<ApplicationResponseSchema>} - Success response
24
24
  * @name searchApplication
25
25
  * @summary: Get sales channel
26
26
  * @description: Get an active sales channel based on a provided query. The query can be a valid sales channel ID or a verified domain name. If the sales channel is found, a success response is returned. If not, a 404 error response is returned. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/searchApplication/).
27
27
  */
28
- searchApplication({ authorization, query, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationResponse>;
28
+ searchApplication({ authorization, query, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationResponseSchema>;
29
29
  }
@@ -81,7 +81,7 @@ class Common {
81
81
  /**
82
82
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
83
83
  * @param {import("../ApplicationAPIClient").Options} - Options
84
- * @returns {Promise<ApplicationResponse>} - Success response
84
+ * @returns {Promise<ApplicationResponseSchema>} - Success response
85
85
  * @name searchApplication
86
86
  * @summary: Get sales channel
87
87
  * @description: Get an active sales channel based on a provided query. The query can be a valid sales channel ID or a verified domain name. If the sales channel is found, a success response is returned. If not, a 404 error response is returned. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/searchApplication/).
@@ -25,30 +25,30 @@ declare class Configuration {
25
25
  /**
26
26
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
27
27
  * @param {import("../ApplicationAPIClient").Options} - Options
28
- * @returns {Promise<AppCurrencyResponse>} - Success response
28
+ * @returns {Promise<AppCurrencyResponseSchema>} - Success response
29
29
  * @name getAppCurrencies
30
30
  * @summary: Get currency configuration
31
31
  * @description: Get currency configuration of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppCurrencies/).
32
32
  */
33
- getAppCurrencies({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppCurrencyResponse>;
33
+ getAppCurrencies({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppCurrencyResponseSchema>;
34
34
  /**
35
35
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
36
36
  * @param {import("../ApplicationAPIClient").Options} - Options
37
- * @returns {Promise<AppStaffListResponse>} - Success response
37
+ * @returns {Promise<AppStaffListResponseSchema>} - Success response
38
38
  * @name getAppStaffList
39
39
  * @summary: List staff members
40
40
  * @description: List all staff members of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffList/).
41
41
  */
42
- getAppStaffList({ pageNo, pageSize, orderIncent, orderingStore, user, userName, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppStaffListResponse>;
42
+ getAppStaffList({ pageNo, pageSize, orderIncent, orderingStore, user, userName, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppStaffListResponseSchema>;
43
43
  /**
44
44
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
45
45
  * @param {import("../ApplicationAPIClient").Options} - Options
46
- * @returns {Promise<AppStaffResponse>} - Success response
46
+ * @returns {Promise<AppStaffResponseSchema>} - Success response
47
47
  * @name getAppStaffs
48
48
  * @summary: Get staff member
49
49
  * @description: Get a staff user including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffs/).
50
50
  */
51
- getAppStaffs({ orderIncent, orderingStore, user, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppStaffResponse>;
51
+ getAppStaffs({ orderIncent, orderingStore, user, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppStaffResponseSchema>;
52
52
  /**
53
53
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
54
54
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -79,12 +79,12 @@ declare class Configuration {
79
79
  /**
80
80
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
81
81
  * @param {import("../ApplicationAPIClient").Options} - Options
82
- * @returns {Promise<CurrenciesResponse>} - Success response
82
+ * @returns {Promise<CurrenciesResponseSchema>} - Success response
83
83
  * @name getCurrencies
84
84
  * @summary: List currencies
85
85
  * @description: List available currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencies/).
86
86
  */
87
- getCurrencies({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CurrenciesResponse>;
87
+ getCurrencies({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CurrenciesResponseSchema>;
88
88
  /**
89
89
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
90
90
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -97,39 +97,39 @@ declare class Configuration {
97
97
  /**
98
98
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
99
99
  * @param {import("../ApplicationAPIClient").Options} - Options
100
- * @returns {Promise<AppFeatureResponse>} - Success response
100
+ * @returns {Promise<AppFeatureResponseSchema>} - Success response
101
101
  * @name getFeatures
102
102
  * @summary: Get sales channel features
103
103
  * @description: Get configuration of the features of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getFeatures/).
104
104
  */
105
- getFeatures({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppFeatureResponse>;
105
+ getFeatures({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppFeatureResponseSchema>;
106
106
  /**
107
107
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
108
108
  * @param {import("../ApplicationAPIClient").Options} - Options
109
- * @returns {Promise<AppTokenResponse>} - Success response
109
+ * @returns {Promise<AppTokenResponseSchema>} - Success response
110
110
  * @name getIntegrationTokens
111
111
  * @summary: Get API tokens
112
112
  * @description: Get tools integration token of the sales channel. For example, Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, and Facebook. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getIntegrationTokens/).
113
113
  */
114
- getIntegrationTokens({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppTokenResponse>;
114
+ getIntegrationTokens({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppTokenResponseSchema>;
115
115
  /**
116
116
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
117
117
  * @param {import("../ApplicationAPIClient").Options} - Options
118
- * @returns {Promise<LanguageResponse>} - Success response
118
+ * @returns {Promise<LanguageResponseSchema>} - Success response
119
119
  * @name getLanguages
120
120
  * @summary: List languages
121
121
  * @description: List available languages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getLanguages/).
122
122
  */
123
- getLanguages({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LanguageResponse>;
123
+ getLanguages({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LanguageResponseSchema>;
124
124
  /**
125
125
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
126
126
  * @param {import("../ApplicationAPIClient").Options} - Options
127
- * @returns {Promise<SuccessMessageResponse>} - Success response
127
+ * @returns {Promise<SuccessMessageResponseSchema>} - Success response
128
128
  * @name getOrderingStoreCookie
129
129
  * @summary: Create cookies
130
130
  * @description: Reset cookie of ordering store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStoreCookie/).
131
131
  */
132
- getOrderingStoreCookie({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SuccessMessageResponse>;
132
+ getOrderingStoreCookie({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SuccessMessageResponseSchema>;
133
133
  /**
134
134
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
135
135
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -142,12 +142,12 @@ declare class Configuration {
142
142
  /**
143
143
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
144
144
  * @param {import("../ApplicationAPIClient").Options} - Options
145
- * @returns {Promise<ApplicationAboutResponse>} - Success response
145
+ * @returns {Promise<ApplicationAboutResponseSchema>} - Success response
146
146
  * @name getOwnerInfo
147
147
  * @summary: Get sales channel owner
148
148
  * @description: Get details of the sales channel owner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOwnerInfo/).
149
149
  */
150
- getOwnerInfo({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationAboutResponse>;
150
+ getOwnerInfo({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationAboutResponseSchema>;
151
151
  /**
152
152
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
153
153
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -160,10 +160,10 @@ declare class Configuration {
160
160
  /**
161
161
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
162
162
  * @param {import("../ApplicationAPIClient").Options} - Options
163
- * @returns {Promise<SuccessMessageResponse>} - Success response
163
+ * @returns {Promise<SuccessMessageResponseSchema>} - Success response
164
164
  * @name removeOrderingStoreCookie
165
165
  * @summary: Delete store cookie
166
166
  * @description: Delete store cookie. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/removeOrderingStoreCookie/).
167
167
  */
168
- removeOrderingStoreCookie({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SuccessMessageResponse>;
168
+ removeOrderingStoreCookie({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SuccessMessageResponseSchema>;
169
169
  }
@@ -51,7 +51,7 @@ class Configuration {
51
51
  /**
52
52
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
53
53
  * @param {import("../ApplicationAPIClient").Options} - Options
54
- * @returns {Promise<AppCurrencyResponse>} - Success response
54
+ * @returns {Promise<AppCurrencyResponseSchema>} - Success response
55
55
  * @name getAppCurrencies
56
56
  * @summary: Get currency configuration
57
57
  * @description: Get currency configuration of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppCurrencies/).
@@ -96,7 +96,7 @@ class Configuration {
96
96
  /**
97
97
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
98
98
  * @param {import("../ApplicationAPIClient").Options} - Options
99
- * @returns {Promise<AppStaffListResponse>} - Success response
99
+ * @returns {Promise<AppStaffListResponseSchema>} - Success response
100
100
  * @name getAppStaffList
101
101
  * @summary: List staff members
102
102
  * @description: List all staff members of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffList/).
@@ -155,7 +155,7 @@ class Configuration {
155
155
  /**
156
156
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
157
157
  * @param {import("../ApplicationAPIClient").Options} - Options
158
- * @returns {Promise<AppStaffResponse>} - Success response
158
+ * @returns {Promise<AppStaffResponseSchema>} - Success response
159
159
  * @name getAppStaffs
160
160
  * @summary: Get staff member
161
161
  * @description: Get a staff user including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffs/).
@@ -340,7 +340,7 @@ class Configuration {
340
340
  /**
341
341
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
342
342
  * @param {import("../ApplicationAPIClient").Options} - Options
343
- * @returns {Promise<CurrenciesResponse>} - Success response
343
+ * @returns {Promise<CurrenciesResponseSchema>} - Success response
344
344
  * @name getCurrencies
345
345
  * @summary: List currencies
346
346
  * @description: List available currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencies/).
@@ -437,7 +437,7 @@ class Configuration {
437
437
  /**
438
438
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
439
439
  * @param {import("../ApplicationAPIClient").Options} - Options
440
- * @returns {Promise<AppFeatureResponse>} - Success response
440
+ * @returns {Promise<AppFeatureResponseSchema>} - Success response
441
441
  * @name getFeatures
442
442
  * @summary: Get sales channel features
443
443
  * @description: Get configuration of the features of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getFeatures/).
@@ -482,7 +482,7 @@ class Configuration {
482
482
  /**
483
483
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
484
484
  * @param {import("../ApplicationAPIClient").Options} - Options
485
- * @returns {Promise<AppTokenResponse>} - Success response
485
+ * @returns {Promise<AppTokenResponseSchema>} - Success response
486
486
  * @name getIntegrationTokens
487
487
  * @summary: Get API tokens
488
488
  * @description: Get tools integration token of the sales channel. For example, Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, and Facebook. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getIntegrationTokens/).
@@ -527,7 +527,7 @@ class Configuration {
527
527
  /**
528
528
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
529
529
  * @param {import("../ApplicationAPIClient").Options} - Options
530
- * @returns {Promise<LanguageResponse>} - Success response
530
+ * @returns {Promise<LanguageResponseSchema>} - Success response
531
531
  * @name getLanguages
532
532
  * @summary: List languages
533
533
  * @description: List available languages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getLanguages/).
@@ -572,7 +572,7 @@ class Configuration {
572
572
  /**
573
573
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
574
574
  * @param {import("../ApplicationAPIClient").Options} - Options
575
- * @returns {Promise<SuccessMessageResponse>} - Success response
575
+ * @returns {Promise<SuccessMessageResponseSchema>} - Success response
576
576
  * @name getOrderingStoreCookie
577
577
  * @summary: Create cookies
578
578
  * @description: Reset cookie of ordering store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStoreCookie/).
@@ -665,7 +665,7 @@ class Configuration {
665
665
  /**
666
666
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
667
667
  * @param {import("../ApplicationAPIClient").Options} - Options
668
- * @returns {Promise<ApplicationAboutResponse>} - Success response
668
+ * @returns {Promise<ApplicationAboutResponseSchema>} - Success response
669
669
  * @name getOwnerInfo
670
670
  * @summary: Get sales channel owner
671
671
  * @description: Get details of the sales channel owner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOwnerInfo/).
@@ -762,7 +762,7 @@ class Configuration {
762
762
  /**
763
763
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
764
764
  * @param {import("../ApplicationAPIClient").Options} - Options
765
- * @returns {Promise<SuccessMessageResponse>} - Success response
765
+ * @returns {Promise<SuccessMessageResponseSchema>} - Success response
766
766
  * @name removeOrderingStoreCookie
767
767
  * @summary: Delete store cookie
768
768
  * @description: Delete store cookie. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/removeOrderingStoreCookie/).
@@ -6,8 +6,8 @@ declare class Content {
6
6
  getAnnouncements: string;
7
7
  getBlog: string;
8
8
  getBlogs: string;
9
- getCustomFields: string;
10
- getCustomObject: string;
9
+ getCustomFieldsByResourceId: string;
10
+ getCustomObjectBySlug: string;
11
11
  getDataLoaders: string;
12
12
  getFaqBySlug: string;
13
13
  getFaqCategories: string;
@@ -45,34 +45,34 @@ declare class Content {
45
45
  * @summary: Get a blog
46
46
  * @description: Get information related to a specific blog such as it's contents, author, publish date, SEO related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlog/).
47
47
  */
48
- getBlog({ slug, rootId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BlogSchema>;
48
+ getBlog({ slug, rootId, preview, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BlogSchema>;
49
49
  /**
50
50
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
51
51
  * @param {import("../ApplicationAPIClient").Options} - Options
52
- * @returns {Promise<BlogGetResponse>} - Success response
52
+ * @returns {Promise<BlogGetDetails>} - Success response
53
53
  * @name getBlogs
54
54
  * @summary: List blogs
55
55
  * @description: List all the blogs against an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlogs/).
56
56
  */
57
- getBlogs({ pageNo, pageSize, tags, search, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BlogGetResponse>;
57
+ getBlogs({ pageNo, pageSize, tags, search, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<BlogGetDetails>;
58
58
  /**
59
59
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
60
60
  * @param {import("../ApplicationAPIClient").Options} - Options
61
61
  * @returns {Promise<CustomFieldsResponseByResourceIdSchema>} - Success response
62
- * @name getCustomFields
63
- * @summary: Get list of custom fields
64
- * @description: List custom fields attached to a particular resource by using the resource. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFields/).
62
+ * @name getCustomFieldsByResourceId
63
+ * @summary: Get list of custom fields of given resource and resource slug
64
+ * @description: Retrieves a list of custom fields attached to a particular resource by using the resource and resource slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFieldsByResourceId/).
65
65
  */
66
- getCustomFields({ resource, resourceId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomFieldsResponseByResourceIdSchema>;
66
+ getCustomFieldsByResourceId({ resource, resourceSlug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomFieldsResponseByResourceIdSchema>;
67
67
  /**
68
68
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
69
69
  * @param {import("../ApplicationAPIClient").Options} - Options
70
70
  * @returns {Promise<CustomObjectByIdSchema>} - Success response
71
- * @name getCustomObject
72
- * @summary: Get custom object
73
- * @description: Get details of custom objects, their field details, definitions, and references can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomObject/).
71
+ * @name getCustomObjectBySlug
72
+ * @summary: Get custom object details
73
+ * @description: Details of a custom object entry can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomObjectBySlug/).
74
74
  */
75
- getCustomObject({ metaobjectId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomObjectByIdSchema>;
75
+ getCustomObjectBySlug({ definitionSlug, slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomObjectByIdSchema>;
76
76
  /**
77
77
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
78
78
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -148,12 +148,12 @@ declare class Content {
148
148
  /**
149
149
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
150
150
  * @param {import("../ApplicationAPIClient").Options} - Options
151
- * @returns {Promise<NavigationGetResponse>} - Success response
151
+ * @returns {Promise<NavigationGetDetails>} - Success response
152
152
  * @name getNavigations
153
153
  * @summary: List navigation items
154
154
  * @description: Get the navigation link items which can be powered to generate menus on application's website or equivalent mobile apps. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getNavigations/).
155
155
  */
156
- getNavigations({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<NavigationGetResponse>;
156
+ getNavigations({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<NavigationGetDetails>;
157
157
  /**
158
158
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
159
159
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -166,12 +166,12 @@ declare class Content {
166
166
  /**
167
167
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
168
168
  * @param {import("../ApplicationAPIClient").Options} - Options
169
- * @returns {Promise<PageGetResponse>} - Success response
169
+ * @returns {Promise<PageGetDetails>} - Success response
170
170
  * @name getPages
171
171
  * @summary: Lists pages
172
172
  * @description: Lists all Custom Pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPages/).
173
173
  */
174
- getPages({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PageGetResponse>;
174
+ getPages({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PageGetDetails>;
175
175
  /**
176
176
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
177
177
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -202,22 +202,12 @@ declare class Content {
202
202
  /**
203
203
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
204
204
  * @param {import("../ApplicationAPIClient").Options} - Options
205
- * @returns {Promise<SlideshowGetResponse>} - Success response
205
+ * @returns {Promise<SlideshowGetDetails>} - Success response
206
206
  * @name getSlideshows
207
207
  * @summary: List Slideshows
208
208
  * @description: List slideshows along with their details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSlideshows/).
209
209
  */
210
- getSlideshows({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SlideshowGetResponse>;
211
- /**
212
- * @param {Object} arg - Arg object.
213
- * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
214
- * @returns {Paginator<SlideshowGetResponse>}
215
- * @summary: List Slideshows
216
- * @description: List slideshows along with their details.
217
- */
218
- getSlideshowsPaginator({ pageSize }?: {
219
- pageSize?: number;
220
- }): Paginator<SlideshowGetResponse>;
210
+ getSlideshows({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SlideshowGetDetails>;
221
211
  /**
222
212
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
223
213
  * @param {import("../ApplicationAPIClient").Options} - Options
@@ -237,4 +227,3 @@ declare class Content {
237
227
  */
238
228
  getTags({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<TagsSchema>;
239
229
  }
240
- import Paginator = require("../../common/Paginator");