@gofynd/fdk-client-javascript 1.4.3 → 1.4.4

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 (193) hide show
  1. package/README.md +1 -10
  2. package/application.d.ts +3 -3
  3. package/common.d.ts +3 -3
  4. package/index.d.ts +15 -15
  5. package/package.json +1 -1
  6. package/partner.d.ts +3 -3
  7. package/platform.d.ts +3 -3
  8. package/public.d.ts +2 -2
  9. package/sdk/application/ApplicationAPIClient.d.ts +1 -1
  10. package/sdk/application/ApplicationClient.d.ts +17 -17
  11. package/sdk/application/ApplicationConfig.d.ts +3 -3
  12. package/sdk/application/Cart/CartApplicationClient.d.ts +50 -50
  13. package/sdk/application/Cart/CartApplicationClient.js +48 -48
  14. package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -1
  15. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +72 -72
  16. package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
  17. package/sdk/application/Common/CommonApplicationClient.d.ts +6 -6
  18. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  19. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +8 -8
  20. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  21. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  22. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -34
  23. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
  24. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +1 -1
  25. package/sdk/application/Content/ContentApplicationClient.d.ts +48 -48
  26. package/sdk/application/Content/ContentApplicationClient.js +45 -45
  27. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +7 -7
  28. package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
  29. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  30. package/sdk/application/Lead/LeadApplicationClient.d.ts +11 -11
  31. package/sdk/application/Lead/LeadApplicationClient.js +9 -9
  32. package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -1
  33. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +24 -24
  34. package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
  35. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -1
  36. package/sdk/application/Order/OrderApplicationClient.d.ts +16 -27
  37. package/sdk/application/Order/OrderApplicationClient.js +14 -94
  38. package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -16
  39. package/sdk/application/Order/OrderApplicationValidator.js +0 -13
  40. package/sdk/application/Payment/PaymentApplicationClient.d.ts +73 -73
  41. package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
  42. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +1 -1
  43. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +2 -2
  44. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +1 -1
  45. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +3 -3
  46. package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
  47. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +1 -1
  48. package/sdk/application/Share/ShareApplicationClient.d.ts +3 -3
  49. package/sdk/application/Share/ShareApplicationClient.js +1 -1
  50. package/sdk/application/Share/ShareApplicationValidator.d.ts +1 -1
  51. package/sdk/application/Theme/ThemeApplicationClient.d.ts +10 -10
  52. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  53. package/sdk/application/User/UserApplicationClient.d.ts +76 -76
  54. package/sdk/application/User/UserApplicationClient.js +74 -74
  55. package/sdk/application/User/UserApplicationValidator.d.ts +1 -1
  56. package/sdk/application/index.d.ts +18 -18
  57. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +1 -1
  58. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  59. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +1 -1
  60. package/sdk/partner/OAuthClient.d.ts +4 -4
  61. package/sdk/partner/PartnerAPIClient.d.ts +1 -1
  62. package/sdk/partner/PartnerClient.d.ts +6 -6
  63. package/sdk/partner/PartnerConfig.d.ts +4 -4
  64. package/sdk/partner/Theme/ThemePartnerClient.d.ts +1 -1
  65. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +1 -1
  66. package/sdk/partner/index.d.ts +7 -7
  67. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +7 -7
  68. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
  69. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  70. package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
  71. package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
  72. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -1
  73. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +104 -104
  74. package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
  75. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -1
  76. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +135 -134
  77. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
  78. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1 -1
  79. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +133 -133
  80. package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
  81. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -1
  82. package/sdk/platform/Common/CommonPlatformClient.d.ts +4 -4
  83. package/sdk/platform/Common/CommonPlatformClient.js +2 -2
  84. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +120 -120
  85. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
  86. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +1 -1
  87. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -3
  88. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  89. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +25 -25
  90. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
  91. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +1 -1
  92. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +43 -43
  93. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
  94. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +1 -1
  95. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +28 -28
  96. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
  97. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -1
  98. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +96 -96
  99. package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
  100. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -1
  101. package/sdk/platform/Content/ContentPlatformClient.d.ts +31 -31
  102. package/sdk/platform/Content/ContentPlatformClient.js +29 -29
  103. package/sdk/platform/Content/ContentPlatformValidator.d.ts +1 -1
  104. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +20 -20
  105. package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
  106. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +1 -1
  107. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -19
  108. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
  109. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  110. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  111. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
  112. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
  113. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +1 -1
  114. package/sdk/platform/Finance/FinancePlatformClient.d.ts +6 -6
  115. package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
  116. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -1
  117. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +14 -14
  118. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  119. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -1
  120. package/sdk/platform/Lead/LeadPlatformClient.d.ts +17 -17
  121. package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
  122. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -1
  123. package/sdk/platform/OAuthClient.d.ts +3 -3
  124. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +12 -12
  125. package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
  126. package/sdk/platform/Order/OrderPlatformClient.d.ts +97 -108
  127. package/sdk/platform/Order/OrderPlatformClient.js +95 -190
  128. package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
  129. package/sdk/platform/Order/OrderPlatformModel.js +4 -0
  130. package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -34
  131. package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
  132. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -6
  133. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  134. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -1
  135. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +79 -79
  136. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
  137. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -1
  138. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +4 -4
  139. package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
  140. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
  141. package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
  142. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +1 -1
  143. package/sdk/platform/PlatformAPIClient.d.ts +1 -1
  144. package/sdk/platform/PlatformApplicationClient.d.ts +16 -16
  145. package/sdk/platform/PlatformClient.d.ts +19 -21
  146. package/sdk/platform/PlatformClient.js +0 -4
  147. package/sdk/platform/PlatformConfig.d.ts +4 -4
  148. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +9 -9
  149. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
  150. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
  151. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +42 -42
  152. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
  153. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -1
  154. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +53 -52
  155. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
  156. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -1
  157. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +3 -3
  158. package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
  159. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  160. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
  161. package/sdk/platform/Share/SharePlatformModel.js +2 -0
  162. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -106
  163. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
  164. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +2 -101
  165. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
  166. package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -8
  167. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  168. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +1 -1
  169. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +37 -37
  170. package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
  171. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +1 -1
  172. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -8
  173. package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
  174. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +1 -1
  175. package/sdk/platform/index.d.ts +24 -25
  176. package/sdk/platform/index.js +0 -2
  177. package/sdk/public/Billing/BillingPublicClient.d.ts +2 -2
  178. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
  179. package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
  180. package/sdk/public/Inventory/InventoryPublicClient.d.ts +2 -2
  181. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +1 -1
  182. package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
  183. package/sdk/public/PublicAPIClient.d.ts +1 -1
  184. package/sdk/public/PublicClient.d.ts +7 -7
  185. package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
  186. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -1
  187. package/sdk/public/index.d.ts +8 -8
  188. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
  189. package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
  190. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
  191. package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
  192. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
  193. package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
@@ -13,8 +13,8 @@ declare class Catalog {
13
13
  * - Success response
14
14
  *
15
15
  * @name addCollectionItems
16
- * @summary: Add items to a collection
17
- * @description: Adds items to a collection specified by its `id`. See `CollectionItemRequest` for the list of attributes needed to add items to an collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addCollectionItems/).
16
+ * @summary: Create items in a collection
17
+ * @description: Adds items to a collection specified by its id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/addCollectionItems/).
18
18
  */
19
19
  addCollectionItems({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.AddCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CommonResponseSchemaCollection>;
20
20
  /**
@@ -25,8 +25,8 @@ declare class Catalog {
25
25
  * @param {import("../PlatformAPIClient").Options} - Options
26
26
  * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
27
27
  * @name createAppCategoryReturnConfiguration
28
- * @summary: Create Category level Application Return Configuration setttings
29
- * @description: Create Category level Application Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppCategoryReturnConfiguration/).
28
+ * @summary: Create return configuration
29
+ * @description: Create Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppCategoryReturnConfiguration/).
30
30
  */
31
31
  createAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
32
32
  /**
@@ -37,8 +37,8 @@ declare class Catalog {
37
37
  * @param {import("../PlatformAPIClient").Options} - Options
38
38
  * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
39
39
  * @name createAppReturnConfiguration
40
- * @summary: Create Return configuration level set for an application
41
- * @description: Create Return configuration level set for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppReturnConfiguration/).
40
+ * @summary: Create product return configuration
41
+ * @description: This allows you to configure all return-related settings, such as is_returnable and return window etc. for sales channel level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createAppReturnConfiguration/).
42
42
  */
43
43
  createAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
44
44
  /**
@@ -48,8 +48,8 @@ declare class Catalog {
48
48
  * @returns {Promise<CatalogPlatformModel.CollectionCreateResponse>} -
49
49
  * Success response
50
50
  * @name createCollection
51
- * @summary: Add a Collection
52
- * @description: Create a collection to the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCollection/).
51
+ * @summary: Create a collection
52
+ * @description: Create a collection for a sales channel linked to a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCollection/).
53
53
  */
54
54
  createCollection({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CollectionCreateResponse>;
55
55
  /**
@@ -61,8 +61,8 @@ declare class Catalog {
61
61
  * @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
62
62
  * Success response
63
63
  * @name createConfigurationByType
64
- * @summary: Create configuration by type
65
- * @description: Add configuration for categories & brands. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationByType/).
64
+ * @summary: Create configuration
65
+ * @description: Add configuration details based on a specific type in the catalog for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationByType/).
66
66
  */
67
67
  createConfigurationByType({ type, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
68
68
  /**
@@ -74,8 +74,8 @@ declare class Catalog {
74
74
  * @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
75
75
  * Success response
76
76
  * @name createConfigurationProductListing
77
- * @summary: Create configuration for product listing
78
- * @description: Add configuration for products & listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationProductListing/).
77
+ * @summary: Create product listing configuration
78
+ * @description: Add configuration for products & listing specific to a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createConfigurationProductListing/).
79
79
  */
80
80
  createConfigurationProductListing({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateConfigurationProductListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
81
81
  /**
@@ -88,8 +88,8 @@ declare class Catalog {
88
88
  * - Success response
89
89
  *
90
90
  * @name createCustomAutocompleteRule
91
- * @summary: Create custom autocomplete rules
92
- * @description: Generate and add custom autocomplete rules to the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomAutocompleteRule/).
91
+ * @summary: Create autocomplete configurations
92
+ * @description: Create custom autocomplete keyword configurations for a specific sales channel to map any endpoint with these keywords. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomAutocompleteRule/).
93
93
  */
94
94
  createCustomAutocompleteRule({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomAutocompleteRuleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateAutocompleteWordsResponse>;
95
95
  /**
@@ -100,8 +100,8 @@ declare class Catalog {
100
100
  * @param {import("../PlatformAPIClient").Options} - Options
101
101
  * @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
102
102
  * @name createCustomKeyword
103
- * @summary: Create custom search keywords
104
- * @description: Create a Custom Search Keywords. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomKeyword/).
103
+ * @summary: Create search keywords
104
+ * @description: Create a Custom Search Keywords for a specific company and sales channel allows you to map certail conditions with the keywords to give you ultimate results. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createCustomKeyword/).
105
105
  */
106
106
  createCustomKeyword({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateCustomKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsData>;
107
107
  /**
@@ -113,7 +113,7 @@ declare class Catalog {
113
113
  * @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
114
114
  * @name createGroupConfiguration
115
115
  * @summary: Create group configuration
116
- * @description: Create configuration for group configuration types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createGroupConfiguration/).
116
+ * @description: Create group configuration for a specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createGroupConfiguration/).
117
117
  */
118
118
  createGroupConfiguration({ configType, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationDetail>;
119
119
  /**
@@ -125,7 +125,7 @@ declare class Catalog {
125
125
  * @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
126
126
  * @name createListingConfiguration
127
127
  * @summary: Create listing configuration
128
- * @description: Add configuration for catalog listing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createListingConfiguration/).
128
+ * @description: Add configuration for product catalog listing specific to a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createListingConfiguration/).
129
129
  */
130
130
  createListingConfiguration({ configType, body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationsSort>;
131
131
  /**
@@ -139,7 +139,7 @@ declare class Catalog {
139
139
  *
140
140
  * @name createSearchConfiguration
141
141
  * @summary: Create search configuration
142
- * @description: Create search configuration for the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSearchConfiguration/).
142
+ * @description: Create search configuration for the catalog for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createSearchConfiguration/).
143
143
  */
144
144
  createSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.CreateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CreateSearchConfigurationResponse>;
145
145
  /**
@@ -150,8 +150,8 @@ declare class Catalog {
150
150
  * @param {import("../PlatformAPIClient").Options} - Options
151
151
  * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
152
152
  * @name deleteAppCategoryReturnConfiguration
153
- * @summary: Delete Category level Application Return Configuration setttings
154
- * @description: Delete Category level Application Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAppCategoryReturnConfiguration/).
153
+ * @summary: Delete product return configuration
154
+ * @description: Delete Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAppCategoryReturnConfiguration/).
155
155
  */
156
156
  deleteAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
157
157
  /**
@@ -162,8 +162,8 @@ declare class Catalog {
162
162
  * @param {import("../PlatformAPIClient").Options} - Options
163
163
  * @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
164
164
  * @name deleteAutocompleteKeyword
165
- * @summary: Delete autocomplete keywords
166
- * @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAutocompleteKeyword/).
165
+ * @summary: Delete autocomplete keyword
166
+ * @description: Delete custom autocomplete keyword configurations for a specific sales channel by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteAutocompleteKeyword/).
167
167
  */
168
168
  deleteAutocompleteKeyword({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponse>;
169
169
  /**
@@ -187,7 +187,7 @@ declare class Catalog {
187
187
  * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
188
188
  * @name deleteGroupConfiguration
189
189
  * @summary: Delete group configuration
190
- * @description: Delete configuration of the product config type of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteGroupConfiguration/).
190
+ * @description: Delete group configurations by its slug for a specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteGroupConfiguration/).
191
191
  */
192
192
  deleteGroupConfiguration({ configType, groupSlug, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
193
193
  /**
@@ -199,7 +199,7 @@ declare class Catalog {
199
199
  * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
200
200
  * @name deleteListingConfiguration
201
201
  * @summary: Delete listing configuration
202
- * @description: Remove a specific listing configuration from the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteListingConfiguration/).
202
+ * @description: Remove a specific product listing configuration by its config_id for a specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteListingConfiguration/).
203
203
  */
204
204
  deleteListingConfiguration({ configType, configId, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
205
205
  /**
@@ -212,8 +212,8 @@ declare class Catalog {
212
212
  * - Success response
213
213
  *
214
214
  * @name deleteSearchConfiguration
215
- * @summary: Delete Search Configuration
216
- * @description: Delete search configuration in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchConfiguration/).
215
+ * @summary: Delete search configuration
216
+ * @description: Delete Search Configuration for a specific sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchConfiguration/).
217
217
  */
218
218
  deleteSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteSearchConfigurationResponse>;
219
219
  /**
@@ -225,7 +225,7 @@ declare class Catalog {
225
225
  * @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
226
226
  * @name deleteSearchKeywords
227
227
  * @summary: Delete search keywords
228
- * @description: Delete a keywords by it's id. Returns an object that tells whether the keywords was deleted successfully - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchKeywords/).
228
+ * @description: Delete a search keywords by its id for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteSearchKeywords/).
229
229
  */
230
230
  deleteSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponse>;
231
231
  /**
@@ -237,8 +237,8 @@ declare class Catalog {
237
237
  * @returns {Promise<CatalogPlatformModel.GetCollectionListingResponse>} -
238
238
  * Success response
239
239
  * @name getAllCollections
240
- * @summary: Retrieve all collections
241
- * @description: A Collection allows you to organize your products into hierarchical groups. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllCollections/).
240
+ * @summary: List collections
241
+ * @description: Retrieve all collections based on criteria such as collection name, schedule status, and active status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllCollections/).
242
242
  */
243
243
  getAllCollections({ q, scheduleStatus, type, tags, isActive, pageNo, pageSize, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAllCollectionsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionListingResponse>;
244
244
  /**
@@ -257,8 +257,8 @@ declare class Catalog {
257
257
  * @param {number} [arg.pageSize] - Number of items to retrieve in each
258
258
  * page. Default is 12.
259
259
  * @returns {Paginator<CatalogPlatformModel.GetCollectionListingResponse>}
260
- * @summary: Retrieve all collections
261
- * @description: A Collection allows you to organize your products into hierarchical groups.
260
+ * @summary: List collections
261
+ * @description: Retrieve all collections based on criteria such as collection name, schedule status, and active status.
262
262
  */
263
263
  getAllCollectionsPaginator({ companyId, applicationId, q, scheduleStatus, type, tags, isActive, pageSize, }?: {
264
264
  companyId: string;
@@ -278,8 +278,8 @@ declare class Catalog {
278
278
  * @param {import("../PlatformAPIClient").Options} - Options
279
279
  * @returns {Promise<CatalogPlatformModel.GetSearchWordsResponse>} - Success response
280
280
  * @name getAllSearchKeyword
281
- * @summary: Get all search keywords
282
- * @description: Custom Search Keyword allows you to map conditions with keywords to give you the ultimate results - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllSearchKeyword/).
281
+ * @summary: List search keywords
282
+ * @description: Get all custom search keywords for a specific company and sales channel allows you to map certain conditions with the keywords to give you ultimate results. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAllSearchKeyword/).
283
283
  */
284
284
  getAllSearchKeyword({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsResponse>;
285
285
  /**
@@ -292,8 +292,8 @@ declare class Catalog {
292
292
  * - Success response
293
293
  *
294
294
  * @name getAppCategoryReturnConfig
295
- * @summary: Get all category level configuration level set for an application
296
- * @description: Get all category level configuration level set for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppCategoryReturnConfig/).
295
+ * @summary: Get category return configuration
296
+ * @description: Get all category level configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppCategoryReturnConfig/).
297
297
  */
298
298
  getAppCategoryReturnConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.BaseAppCategoryReturnConfigResponse>;
299
299
  /**
@@ -302,8 +302,8 @@ declare class Catalog {
302
302
  * @param {import("../PlatformAPIClient").Options} - Options
303
303
  * @returns {Promise<CatalogPlatformModel.InventoryStockResponse>} - Success response
304
304
  * @name getAppInventory
305
- * @summary: Get application inventory
306
- * @description: Retrieve inventory data related to the application. Retrieve the available Inventory of the products. Use this API to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id, Items, Pagination - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppInventory/).
305
+ * @summary: List sales channel inventory
306
+ * @description: Retrieve inventory data related to the sales channel. this can be used to get the Inventory status of products with the filters of timestamp, store_ids, brand_ids, item_id, Items, Pagination. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppInventory/).
307
307
  */
308
308
  getAppInventory({ itemIds, storeIds, brandIds, sellerIdentifiers, timestamp, pageSize, pageId, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppInventoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryStockResponse>;
309
309
  /**
@@ -312,8 +312,8 @@ declare class Catalog {
312
312
  * @param {import("../PlatformAPIClient").Options} - Options
313
313
  * @returns {Promise<CatalogPlatformModel.LocationListSerializer>} - Success response
314
314
  * @name getAppLocations
315
- * @summary: Get application locations
316
- * @description: Retrieve locations specific to the application. View all the locations asscoiated to a application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppLocations/).
315
+ * @summary: List sales channels
316
+ * @description: Retrieve all stores associated with an sales channel, with support for searching by store name and filtering by store type and status (verified/unverified) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppLocations/).
317
317
  */
318
318
  getAppLocations({ storeType, uid, q, stage, pageNo, pageSize, tags, storeTypes, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationListSerializer>;
319
319
  /**
@@ -333,8 +333,8 @@ declare class Catalog {
333
333
  * @param {string[]} [arg.tags] - Get locations filtered by tags.
334
334
  * @param {string[]} [arg.storeTypes] - Get locations filtered by store types.
335
335
  * @returns {Paginator<CatalogPlatformModel.LocationListSerializer>}
336
- * @summary: Get application locations
337
- * @description: Retrieve locations specific to the application. View all the locations asscoiated to a application.
336
+ * @summary: List sales channels
337
+ * @description: Retrieve all stores associated with an sales channel, with support for searching by store name and filtering by store type and status (verified/unverified)
338
338
  */
339
339
  getAppLocationsPaginator({ companyId, applicationId, storeType, uid, q, stage, pageSize, tags, storeTypes, }?: {
340
340
  companyId: string;
@@ -353,8 +353,8 @@ declare class Catalog {
353
353
  * @param {import("../PlatformAPIClient").Options} - Options
354
354
  * @returns {Promise<CatalogPlatformModel.OwnerAppItemResponse>} - Success response
355
355
  * @name getAppProduct
356
- * @summary: Retrieve application product data
357
- * @description: Products are the core resource of an application. If successful, returns a Company Application Product resource in the response body depending upon filter sent. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProduct/).
356
+ * @summary: Get sales channel product
357
+ * @description: Retrieve sales channel product details by its item_id and depending upon filters sent in request. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProduct/).
358
358
  */
359
359
  getAppProduct({ itemId, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.OwnerAppItemResponse>;
360
360
  /**
@@ -364,8 +364,8 @@ declare class Catalog {
364
364
  * @returns {Promise<CatalogPlatformModel.RawProductListingResponse>} -
365
365
  * Success response
366
366
  * @name getAppProducts
367
- * @summary: Get application products
368
- * @description: Retrieve products specific to the application. Products are the core resource of an application. Products can be associated by categories, collections, brands and more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProducts/).
367
+ * @summary: List sales channel products
368
+ * @description: Retrieve products specific to the sales channel, with filtering options available for brand, category, department, tags, item IDs, product name, and pagination support - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppProducts/).
369
369
  */
370
370
  getAppProducts({ brandIds, categoryIds, departmentIds, tags, itemIds, pageNo, pageSize, q, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.RawProductListingResponse>;
371
371
  /**
@@ -385,8 +385,8 @@ declare class Catalog {
385
385
  * page. Default is 10.
386
386
  * @param {string} [arg.q] - Search with Item Code, Name, Slug or Identifier.
387
387
  * @returns {Paginator<CatalogPlatformModel.RawProductListingResponse>}
388
- * @summary: Get application products
389
- * @description: Retrieve products specific to the application. Products are the core resource of an application. Products can be associated by categories, collections, brands and more.
388
+ * @summary: List sales channel products
389
+ * @description: Retrieve products specific to the sales channel, with filtering options available for brand, category, department, tags, item IDs, product name, and pagination support
390
390
  */
391
391
  getAppProductsPaginator({ companyId, applicationId, brandIds, categoryIds, departmentIds, tags, itemIds, pageSize, q, }?: {
392
392
  companyId: string;
@@ -407,8 +407,8 @@ declare class Catalog {
407
407
  * @param {import("../PlatformAPIClient").Options} - Options
408
408
  * @returns {Promise<CatalogPlatformModel.AppReturnConfigResponse>} - Success response
409
409
  * @name getAppReturnConfiguration
410
- * @summary: Get Return configuration level set for an application
411
- * @description: Get Product Return configuration set at an application level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppReturnConfiguration/).
410
+ * @summary: get product-return configuration
411
+ * @description: Get Product Return configuration set at an sales channel level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppReturnConfiguration/).
412
412
  */
413
413
  getAppReturnConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppReturnConfigResponse>;
414
414
  /**
@@ -421,8 +421,8 @@ declare class Catalog {
421
421
  * - Success response
422
422
  *
423
423
  * @name getAppicationProducts
424
- * @summary: Get application products
425
- * @description: Retrieve products associated with the application. List all the products associated with a brand, collection or category in a requested sort order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppicationProducts/).
424
+ * @summary: List sales channel products
425
+ * @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppicationProducts/).
426
426
  */
427
427
  getAppicationProducts({ q, f, c, filters, isDependent, sortOn, pageId, pageSize, pageNo, pageType, itemIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppicationProductsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationProductListingResponse>;
428
428
  /**
@@ -452,8 +452,8 @@ declare class Catalog {
452
452
  * page. Default is 12.
453
453
  * @param {number[]} [arg.itemIds] - Item Ids of product
454
454
  * @returns {Paginator<CatalogPlatformModel.ApplicationProductListingResponse>}
455
- * @summary: Get application products
456
- * @description: Retrieve products associated with the application. List all the products associated with a brand, collection or category in a requested sort order.
455
+ * @summary: List sales channel products
456
+ * @description: Retrieve products associated with the sales channel. List all the products associated with a brand, collection or category in a requested sort order.
457
457
  */
458
458
  getAppicationProductsPaginator({ companyId, applicationId, q, f, c, filters, isDependent, sortOn, pageSize, itemIds, }?: {
459
459
  companyId: string;
@@ -475,8 +475,8 @@ declare class Catalog {
475
475
  * @param {import("../PlatformAPIClient").Options} - Options
476
476
  * @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
477
477
  * @name getApplicationBrandListing
478
- * @summary: Get application brand listing
479
- * @description: Retrieve brand listings related to the application. A brand is the name under which a product is being sold - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrandListing/).
478
+ * @summary: List sales channel brands
479
+ * @description: Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrandListing/).
480
480
  */
481
481
  getApplicationBrandListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponse>;
482
482
  /**
@@ -490,8 +490,8 @@ declare class Catalog {
490
490
  * @param {string} [arg.q] - Search query with brand name.Use this parameter
491
491
  * to search brands by brand name.
492
492
  * @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
493
- * @summary: Get application brand listing
494
- * @description: Retrieve brand listings related to the application. A brand is the name under which a product is being sold
493
+ * @summary: List sales channel brands
494
+ * @description: Retrieve brand listings related to the sales channel. A brand is the name under which a product is being sold
495
495
  */
496
496
  getApplicationBrandListingPaginator({ companyId, applicationId, pageSize, q, }?: {
497
497
  companyId: string;
@@ -507,8 +507,8 @@ declare class Catalog {
507
507
  * @param {import("../PlatformAPIClient").Options} - Options
508
508
  * @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
509
509
  * @name getApplicationBrands
510
- * @summary: Get application brands
511
- * @description: List all the brands. A brand is the name under which a product is being sold. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
510
+ * @summary: List brands
511
+ * @description: List all the brands, and have search capabilities on brand uid, name etc - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationBrands/).
512
512
  */
513
513
  getApplicationBrands({ department, pageNo, pageSize, q, brandId, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationBrandsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponse>;
514
514
  /**
@@ -528,8 +528,8 @@ declare class Catalog {
528
528
  * @param {number[]} [arg.brandId] - Helps to sort the brands list on the
529
529
  * basis of uid list.
530
530
  * @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
531
- * @summary: Get application brands
532
- * @description: List all the brands. A brand is the name under which a product is being sold.
531
+ * @summary: List brands
532
+ * @description: List all the brands, and have search capabilities on brand uid, name etc
533
533
  */
534
534
  getApplicationBrandsPaginator({ companyId, applicationId, department, pageSize, q, brandId, }?: {
535
535
  companyId: string;
@@ -547,8 +547,8 @@ declare class Catalog {
547
547
  * @param {import("../PlatformAPIClient").Options} - Options
548
548
  * @returns {Promise<CatalogPlatformModel.BrandListingResponse>} - Success response
549
549
  * @name getApplicationCategoryListing
550
- * @summary: Get application category listing
551
- * @description: Retrieve category listings related to the application. A brand is the name under which a product is being sold. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationCategoryListing/).
550
+ * @summary: List sales channel categories
551
+ * @description: Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationCategoryListing/).
552
552
  */
553
553
  getApplicationCategoryListing({ departmentId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationCategoryListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.BrandListingResponse>;
554
554
  /**
@@ -564,8 +564,8 @@ declare class Catalog {
564
564
  * @param {string} [arg.q] - Search query with brand name.Use this parameter
565
565
  * to search brands by brand name.
566
566
  * @returns {Paginator<CatalogPlatformModel.BrandListingResponse>}
567
- * @summary: Get application category listing
568
- * @description: Retrieve category listings related to the application. A brand is the name under which a product is being sold.
567
+ * @summary: List sales channel categories
568
+ * @description: Retrieve category listings related to the sales channel , with the ability to filter results based on department ,category names etc.
569
569
  */
570
570
  getApplicationCategoryListingPaginator({ companyId, applicationId, departmentId, pageSize, q, }?: {
571
571
  companyId: string;
@@ -584,8 +584,8 @@ declare class Catalog {
584
584
  * - Success response
585
585
  *
586
586
  * @name getApplicationDepartmentListing
587
- * @summary: Get application department listing
588
- * @description: Retrieve department listings related to the application. Departments are a way to categorise similar products. A product can lie in multiple departments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationDepartmentListing/).
587
+ * @summary: List sales channel departments
588
+ * @description: Retrieve department listings related to the sales channel. Departments are used to categorize similar products, and you can filter the results based on department names - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationDepartmentListing/).
589
589
  */
590
590
  getApplicationDepartmentListing({ pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationDepartmentListingParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ApplicationDepartmentListingResponse>;
591
591
  /**
@@ -599,8 +599,8 @@ declare class Catalog {
599
599
  * @param {string} [arg.q] - Search query with brand name.Use this parameter
600
600
  * to search department by name.
601
601
  * @returns {Paginator<CatalogPlatformModel.ApplicationDepartmentListingResponse>}
602
- * @summary: Get application department listing
603
- * @description: Retrieve department listings related to the application. Departments are a way to categorise similar products. A product can lie in multiple departments.
602
+ * @summary: List sales channel departments
603
+ * @description: Retrieve department listings related to the sales channel. Departments are used to categorize similar products, and you can filter the results based on department names
604
604
  */
605
605
  getApplicationDepartmentListingPaginator({ companyId, applicationId, pageSize, q, }?: {
606
606
  companyId: string;
@@ -617,8 +617,8 @@ declare class Catalog {
617
617
  * @returns {Promise<CatalogPlatformModel.GetQueryFiltersKeysResponse>} -
618
618
  * Success response
619
619
  * @name getApplicationFilterKeys
620
- * @summary: Get filters keys of the filter options
621
- * @description: Get query filters keys to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationFilterKeys/).
620
+ * @summary: List filter keys
621
+ * @description: Retrieve the details of all applicable product filters, such as Color, Brand, and Category, indicating the criteria keys where filters can be applied. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationFilterKeys/).
622
622
  */
623
623
  getApplicationFilterKeys({ c, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterKeysParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersKeysResponse>;
624
624
  /**
@@ -630,8 +630,9 @@ declare class Catalog {
630
630
  * @returns {Promise<CatalogPlatformModel.GetQueryFiltersValuesResponse>} -
631
631
  * Success response
632
632
  * @name getApplicationFilterValues
633
- * @summary: Get values of the selected value for the filter options
634
- * @description: Get query filters keys to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationFilterValues/).
633
+ * @summary: List product filters
634
+ * @description: This API is designed to retrieve the filter values for all available options within the selected filter, such as "red" for color.
635
+ * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getApplicationFilterValues/).
635
636
  */
636
637
  getApplicationFilterValues({ filterKey, c, collectionId, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetApplicationFilterValuesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersValuesResponse>;
637
638
  /**
@@ -644,7 +645,7 @@ declare class Catalog {
644
645
  * Success response
645
646
  * @name getAutocompleteConfig
646
647
  * @summary: Get autocomplete configuration
647
- * @description: Custom Autocomplete Keyword allows you to map conditions with keywords to give you the ultimate results - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteConfig/).
648
+ * @description: Get custom autocomplete keyword configuration for a specific sales channel which allows you to map any endpoint with these keywords to give you the ultimate suggestion results. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteConfig/).
648
649
  */
649
650
  getAutocompleteConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
650
651
  /**
@@ -656,8 +657,8 @@ declare class Catalog {
656
657
  * @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
657
658
  * Success response
658
659
  * @name getAutocompleteKeywordDetail
659
- * @summary: Get autocomplete keyword details
660
- * @description: Retrieve detailed information about a specific autocomplete keyword. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteKeywordDetail/).
660
+ * @summary: Get autocomplete keyword
661
+ * @description: Retrieve detailed information about a specific autocomplete keyword for a specific sales channel by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAutocompleteKeywordDetail/).
661
662
  */
662
663
  getAutocompleteKeywordDetail({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetAutocompleteKeywordDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
663
664
  /**
@@ -670,8 +671,8 @@ declare class Catalog {
670
671
  * - Success response
671
672
  *
672
673
  * @name getCatalogConfiguration
673
- * @summary: Retrieve catalog configuration
674
- * @description: Retrieve configuration meta details for the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogConfiguration/).
674
+ * @summary: Get catalog configuration meta data
675
+ * @description: Retrieve configuration meta data for the catalog specific to a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogConfiguration/).
675
676
  */
676
677
  getCatalogConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCatalogConfigurationMetaData>;
677
678
  /**
@@ -682,8 +683,8 @@ declare class Catalog {
682
683
  * @param {import("../PlatformAPIClient").Options} - Options
683
684
  * @returns {Promise<CatalogPlatformModel.CatalogInsightResponse>} - Success response
684
685
  * @name getCatalogInsights
685
- * @summary: Get catalog insights
686
- * @description: Retrieve the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogInsights/).
686
+ * @summary: Get catalog counts
687
+ * @description: Retrieve the count of catalog related data like products, brands, departments and categories that have been made live as per configuration of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCatalogInsights/).
687
688
  */
688
689
  getCatalogInsights({ brand, requestHeaders }?: CatalogPlatformApplicationValidator.GetCatalogInsightsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CatalogInsightResponse>;
689
690
  /**
@@ -692,8 +693,8 @@ declare class Catalog {
692
693
  * @param {import("../PlatformAPIClient").Options} - Options
693
694
  * @returns {Promise<CatalogPlatformModel.CategoryListingResponse>} - Success response
694
695
  * @name getCategories
695
- * @summary: Get categories
696
- * @description: Retrieve a list of categories. Optionally pass filter the brands by the department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategories/).
696
+ * @summary: List categories
697
+ * @description: Retrieve a list of categories associated to company and sales channel. user can filter on departments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCategories/).
697
698
  */
698
699
  getCategories({ department, requestHeaders }?: CatalogPlatformApplicationValidator.GetCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryListingResponse>;
699
700
  /**
@@ -705,7 +706,7 @@ declare class Catalog {
705
706
  * @returns {Promise<CatalogPlatformModel.GetCollectionDetailResponse>} -
706
707
  * Success response
707
708
  * @name getCollectionDetail
708
- * @summary: Get collection details
709
+ * @summary: Get a collection
709
710
  * @description: Get the details of a collection by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionDetail/).
710
711
  */
711
712
  getCollectionDetail({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionDetailResponse>;
@@ -718,8 +719,8 @@ declare class Catalog {
718
719
  * @returns {Promise<CatalogPlatformModel.GetCollectionItemsResponse>} -
719
720
  * Success response
720
721
  * @name getCollectionItems
721
- * @summary: Get the items for a collection
722
- * @description: Get items from a collection specified by its `id`. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionItems/).
722
+ * @summary: List items of collection
723
+ * @description: Get items from a collection specified by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionItems/).
723
724
  */
724
725
  getCollectionItems({ id, sortOn, pageId, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionItemsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionItemsResponse>;
725
726
  /**
@@ -732,8 +733,8 @@ declare class Catalog {
732
733
  * - Success response
733
734
  *
734
735
  * @name getConfigurationByType
735
- * @summary: Retrieve configuration by type
736
- * @description: Retrieve configuration details based on a specific type in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationByType/).
736
+ * @summary: Get configuration
737
+ * @description: Retrieve configuration details based on a specific type in the catalog for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationByType/).
737
738
  */
738
739
  getConfigurationByType({ type, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationByTypeParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogEntityConfiguration>;
739
740
  /**
@@ -745,8 +746,8 @@ declare class Catalog {
745
746
  * @returns {Promise<CatalogPlatformModel.GetConfigMetadataResponse>} -
746
747
  * Success response
747
748
  * @name getConfigurationMetadata
748
- * @summary: Retrieve configuration metadata
749
- * @description: Retrieve the configuraion metadata details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationMetadata/).
749
+ * @summary: Get configuration metadata
750
+ * @description: Retrieve the configuraion metadata details for specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationMetadata/).
750
751
  */
751
752
  getConfigurationMetadata({ configType, templateSlug, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationMetadataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigMetadataResponse>;
752
753
  /**
@@ -758,8 +759,8 @@ declare class Catalog {
758
759
  * @returns {Promise<CatalogPlatformModel.GetAppCatalogConfiguration>} -
759
760
  * Success response
760
761
  * @name getConfigurations
761
- * @summary: Retrieve configurations
762
- * @description: Retrieve a configured details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurations/).
762
+ * @summary: Get product configurations
763
+ * @description: Retrieve a detailed configurations for product catalog specific to a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurations/).
763
764
  */
764
765
  getConfigurations({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAppCatalogConfiguration>;
765
766
  /**
@@ -768,8 +769,8 @@ declare class Catalog {
768
769
  * @param {import("../PlatformAPIClient").Options} - Options
769
770
  * @returns {Promise<CatalogPlatformModel.DepartmentResponse>} - Success response
770
771
  * @name getDepartments
771
- * @summary: Get departments
772
- * @description: Retrieve a list of departments. Departments are a way to categorise similar products. A product can lie in multiple departments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartments/).
772
+ * @summary: List departments
773
+ * @description: Retrieve a list of departments associated with a comapny and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDepartments/).
773
774
  */
774
775
  getDepartments({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.DepartmentResponse>;
775
776
  /**
@@ -782,7 +783,7 @@ declare class Catalog {
782
783
  * - Success response
783
784
  *
784
785
  * @name getDiscountedInventoryBySizeIdentifier
785
- * @summary: Get discounted inventory by size identifier
786
+ * @summary: Get discounted inventory
786
787
  * @description: Allows to retrieve Inventory data for particular company grouped by size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getDiscountedInventoryBySizeIdentifier/).
787
788
  */
788
789
  getDiscountedInventoryBySizeIdentifier({ itemId, sizeIdentifier, pageNo, pageSize, q, locationIds, requestHeaders, }?: CatalogPlatformApplicationValidator.GetDiscountedInventoryBySizeIdentifierParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>;
@@ -799,7 +800,7 @@ declare class Catalog {
799
800
  * @param {string} [arg.q] - Search with help of store code.
800
801
  * @param {number[]} [arg.locationIds] - Search by store ids.
801
802
  * @returns {Paginator<CatalogPlatformModel.InventorySellerIdentifierResponsePaginated>}
802
- * @summary: Get discounted inventory by size identifier
803
+ * @summary: Get discounted inventory
803
804
  * @description: Allows to retrieve Inventory data for particular company grouped by size and store.
804
805
  */
805
806
  getDiscountedInventoryBySizeIdentifierPaginator({ companyId, applicationId, itemId, sizeIdentifier, pageSize, q, locationIds, }?: {
@@ -819,8 +820,8 @@ declare class Catalog {
819
820
  * @param {import("../PlatformAPIClient").Options} - Options
820
821
  * @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
821
822
  * @name getGroupConfigurations
822
- * @summary: Retrieve group configurations
823
- * @description: Retrieve the details of the application configured configurations of group config types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGroupConfigurations/).
823
+ * @summary: Get group configurations
824
+ * @description: Retrieve the details of product group configurations based on config types for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getGroupConfigurations/).
824
825
  */
825
826
  getGroupConfigurations({ configType, pageNo, pageSize, search, templateSlug, requestHeaders }?: CatalogPlatformApplicationValidator.GetGroupConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponse>;
826
827
  /**
@@ -831,8 +832,8 @@ declare class Catalog {
831
832
  * @param {import("../PlatformAPIClient").Options} - Options
832
833
  * @returns {Promise<CatalogPlatformModel.GetConfigResponse>} - Success response
833
834
  * @name getListingConfigurations
834
- * @summary: Retrieve listing configurations
835
- * @description: Retrieve the details of the application configured configurations of listing config types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getListingConfigurations/).
835
+ * @summary: Get listing configurations
836
+ * @description: Retrieve product listing configurations based on specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getListingConfigurations/).
836
837
  */
837
838
  getListingConfigurations({ configType, pageNo, pageSize, search, requestHeaders }?: CatalogPlatformApplicationValidator.GetListingConfigurationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigResponse>;
838
839
  /**
@@ -843,8 +844,8 @@ declare class Catalog {
843
844
  * @param {import("../PlatformAPIClient").Options} - Options
844
845
  * @returns {Promise<CatalogPlatformModel.ProductDetail>} - Success response
845
846
  * @name getProductDetailBySlug
846
- * @summary: Get product details by slug
847
- * @description: Retrieve detailed product information using a product slug. Products are the core resource of an application. Products can be associated by categories, collections, brands and more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductDetailBySlug/).
847
+ * @summary: Get product details
848
+ * @description: Retrieve detailed product information using a product slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getProductDetailBySlug/).
848
849
  */
849
850
  getProductDetailBySlug({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetProductDetailBySlugParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ProductDetail>;
850
851
  /**
@@ -853,8 +854,8 @@ declare class Catalog {
853
854
  * @param {import("../PlatformAPIClient").Options} - Options
854
855
  * @returns {Promise<CatalogPlatformModel.GetQueryFiltersResponse>} - Success response
855
856
  * @name getQueryFilters
856
- * @summary: Retrieve query filters
857
- * @description: Retrieve query filters to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getQueryFilters/).
857
+ * @summary: Get collection query filters
858
+ * @description: Retrieve query filters to configure a collection for a company and a sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getQueryFilters/).
858
859
  */
859
860
  getQueryFilters({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersResponse>;
860
861
  /**
@@ -867,8 +868,8 @@ declare class Catalog {
867
868
  * - Success response
868
869
  *
869
870
  * @name getSearchConfiguration
870
- * @summary: Get Search Configuration
871
- * @description: Get search configuration in the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchConfiguration/).
871
+ * @summary: Get Search configuration
872
+ * @description: Get search configuration for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchConfiguration/).
872
873
  */
873
874
  getSearchConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchConfigurationResponse>;
874
875
  /**
@@ -880,8 +881,8 @@ declare class Catalog {
880
881
  * @returns {Promise<CatalogPlatformModel.GetSearchWordsDetailResponse>} -
881
882
  * Success response
882
883
  * @name getSearchKeywords
883
- * @summary: Retrieve search keywords
884
- * @description: Retrieve a list of search keywords from the catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchKeywords/).
884
+ * @summary: Get search keywords
885
+ * @description: Retrieve a list of a specific list of keywords by its id for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSearchKeywords/).
885
886
  */
886
887
  getSearchKeywords({ id, requestHeaders }?: CatalogPlatformApplicationValidator.GetSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsDetailResponse>;
887
888
  /**
@@ -893,7 +894,7 @@ declare class Catalog {
893
894
  * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
894
895
  * @name updateAllowSingle
895
896
  * @summary: Update 'Allow Single' setting
896
- * @description: Modify allow single flag for filters of the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAllowSingle/).
897
+ * @description: Modify allow single flag for filters of the sales channel for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAllowSingle/).
897
898
  */
898
899
  updateAllowSingle({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAllowSingleParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
899
900
  /**
@@ -902,8 +903,8 @@ declare class Catalog {
902
903
  * @param {import("../PlatformAPIClient").Options} - Options
903
904
  * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
904
905
  * @name updateAppBrand
905
- * @summary: Update application brand
906
- * @description: Modify data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppBrand/).
906
+ * @summary: Update sales channel brand
907
+ * @description: Modify data associated to the brand for that particular sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppBrand/).
907
908
  */
908
909
  updateAppBrand({ brandUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppBrandParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
909
910
  /**
@@ -914,8 +915,8 @@ declare class Catalog {
914
915
  * @param {import("../PlatformAPIClient").Options} - Options
915
916
  * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
916
917
  * @name updateAppCategory
917
- * @summary: Update application category
918
- * @description: Modify category data related to the application. Helps to update data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategory/).
918
+ * @summary: Update sales channel category
919
+ * @description: Modify category data related to the sales channel . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategory/).
919
920
  */
920
921
  updateAppCategory({ categoryUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
921
922
  /**
@@ -926,8 +927,8 @@ declare class Catalog {
926
927
  * @param {import("../PlatformAPIClient").Options} - Options
927
928
  * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
928
929
  * @name updateAppCategoryReturnConfiguration
929
- * @summary: Update Category level Application Return Configuration setttings
930
- * @description: Update Category level Application Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategoryReturnConfiguration/).
930
+ * @summary: Update return Configuration
931
+ * @description: Update Category level sales channel Return Configuration setttings - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppCategoryReturnConfiguration/).
931
932
  */
932
933
  updateAppCategoryReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppCategoryReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
933
934
  /**
@@ -938,8 +939,8 @@ declare class Catalog {
938
939
  * @param {import("../PlatformAPIClient").Options} - Options
939
940
  * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
940
941
  * @name updateAppDepartment
941
- * @summary: Update application department
942
- * @description: Modify department data related to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppDepartment/).
942
+ * @summary: Update sales channel department
943
+ * @description: Modify department data associated to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppDepartment/).
943
944
  */
944
945
  updateAppDepartment({ departmentUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppDepartmentParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
945
946
  /**
@@ -950,8 +951,8 @@ declare class Catalog {
950
951
  * @param {import("../PlatformAPIClient").Options} - Options
951
952
  * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
952
953
  * @name updateAppLocation
953
- * @summary: Update application location
954
- * @description: Modify location data related to the application. Helps to update data associated to a item custom meta - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppLocation/).
954
+ * @summary: Update sales channel location
955
+ * @description: Modify location data related to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppLocation/).
955
956
  */
956
957
  updateAppLocation({ storeUid, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppLocationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
957
958
  /**
@@ -960,8 +961,8 @@ declare class Catalog {
960
961
  * @param {import("../PlatformAPIClient").Options} - Options
961
962
  * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
962
963
  * @name updateAppProduct
963
- * @summary: Update application product data
964
- * @description: Allows to update data associated to a item custom meta. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppProduct/).
964
+ * @summary: Update sales channel product
965
+ * @description: Allows to update data associated to a item by its item_id for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppProduct/).
965
966
  */
966
967
  updateAppProduct({ itemId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
967
968
  /**
@@ -972,8 +973,8 @@ declare class Catalog {
972
973
  * @param {import("../PlatformAPIClient").Options} - Options
973
974
  * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
974
975
  * @name updateAppReturnConfiguration
975
- * @summary: Update Return configuration level set for an application
976
- * @description: Update Return configuration level set for an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppReturnConfiguration/).
976
+ * @summary: Update product return configuration
977
+ * @description: Update Return configuration level set for an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAppReturnConfiguration/).
977
978
  */
978
979
  updateAppReturnConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAppReturnConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
979
980
  /**
@@ -985,8 +986,8 @@ declare class Catalog {
985
986
  * @returns {Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>} -
986
987
  * Success response
987
988
  * @name updateAutocompleteKeyword
988
- * @summary: Update autocomplete keywords
989
- * @description: Update a mapping by it's id. On successful request, returns the updated Keyword mapping - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAutocompleteKeyword/).
989
+ * @summary: Update autocomplete keyword
990
+ * @description: Update a specific autocomplete keyword configuration by its id for a specific sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateAutocompleteKeyword/).
990
991
  */
991
992
  updateAutocompleteKeyword({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateAutocompleteKeywordParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAutocompleteWordsResponse>;
992
993
  /**
@@ -1008,7 +1009,7 @@ declare class Catalog {
1008
1009
  * @returns {Promise<CatalogPlatformModel.ConfigSuccessResponse>} - Success response
1009
1010
  * @name updateDefaultSort
1010
1011
  * @summary: Update default sorting
1011
- * @description: Modify the default sort key configuration for the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDefaultSort/).
1012
+ * @description: Modify the default sort key configuration for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateDefaultSort/).
1012
1013
  */
1013
1014
  updateDefaultSort({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateDefaultSortParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ConfigSuccessResponse>;
1014
1015
  /**
@@ -1020,7 +1021,7 @@ declare class Catalog {
1020
1021
  * @returns {Promise<CatalogPlatformModel.AppConfigurationDetail>} - Success response
1021
1022
  * @name updateGroupConfiguration
1022
1023
  * @summary: Update group configuration
1023
- * @description: Modify the group configurations for the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateGroupConfiguration/).
1024
+ * @description: Modify group configurations by its slug for specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateGroupConfiguration/).
1024
1025
  */
1025
1026
  updateGroupConfiguration({ configType, groupSlug, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateGroupConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationDetail>;
1026
1027
  /**
@@ -1032,7 +1033,7 @@ declare class Catalog {
1032
1033
  * @returns {Promise<CatalogPlatformModel.AppConfigurationsSort>} - Success response
1033
1034
  * @name updateListingConfiguration
1034
1035
  * @summary: Update listing configuration
1035
- * @description: Modify the details and settings of an existing listing configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateListingConfiguration/).
1036
+ * @description: Modify a specific product listing configuration by its config_id for a specific config_type for a company and an sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateListingConfiguration/).
1036
1037
  */
1037
1038
  updateListingConfiguration({ configType, configId, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateListingConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.AppConfigurationsSort>;
1038
1039
  /**
@@ -1045,8 +1046,8 @@ declare class Catalog {
1045
1046
  * - Success response
1046
1047
  *
1047
1048
  * @name updateSearchConfiguration
1048
- * @summary: Update search configuration for an application
1049
- * @description: This view allows you to modify searchable attributes for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSearchConfiguration/).
1049
+ * @summary: Update search configuration
1050
+ * @description: Allows you to modify searchable attributes for an sales channel. searchable attributes are the fields on which the products are searched. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSearchConfiguration/).
1050
1051
  */
1051
1052
  updateSearchConfiguration({ body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSearchConfigurationParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateSearchConfigurationResponse>;
1052
1053
  /**
@@ -1058,10 +1059,10 @@ declare class Catalog {
1058
1059
  * @returns {Promise<CatalogPlatformModel.GetSearchWordsData>} - Success response
1059
1060
  * @name updateSearchKeywords
1060
1061
  * @summary: Update search keywords
1061
- * @description: Update Search Keyword by its id. On successful request, returns the updated collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSearchKeywords/).
1062
+ * @description: Update a specific search keyword by its id for a specific company and sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateSearchKeywords/).
1062
1063
  */
1063
1064
  updateSearchKeywords({ id, body, requestHeaders }?: CatalogPlatformApplicationValidator.UpdateSearchKeywordsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetSearchWordsData>;
1064
1065
  }
1065
- import CatalogPlatformApplicationValidator = require("./CatalogPlatformApplicationValidator");
1066
- import CatalogPlatformModel = require("./CatalogPlatformModel");
1067
- import Paginator = require("../../common/Paginator");
1066
+ import CatalogPlatformApplicationValidator = require("sdk/output/javascript/code/sdk/platform/Catalog/CatalogPlatformApplicationValidator");
1067
+ import CatalogPlatformModel = require("sdk/output/javascript/code/sdk/platform/Catalog/CatalogPlatformModel");
1068
+ import Paginator = require("sdk/output/javascript/code/sdk/common/Paginator");