@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.5

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 (140) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
  4. package/sdk/application/Cart/CartApplicationClient.js +82 -71
  5. package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
  6. package/sdk/application/Cart/CartApplicationValidator.js +59 -34
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
  16. package/sdk/application/Content/ContentApplicationClient.js +34 -115
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
  20. package/sdk/application/Lead/LeadApplicationClient.js +14 -14
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
  24. package/sdk/application/Order/OrderApplicationClient.js +24 -24
  25. package/sdk/application/Order/OrderApplicationModel.d.ts +23 -1
  26. package/sdk/application/Order/OrderApplicationModel.js +28 -0
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
  28. package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
  29. package/sdk/application/Payment/PaymentApplicationModel.d.ts +498 -3
  30. package/sdk/application/Payment/PaymentApplicationModel.js +316 -2
  31. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
  32. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  33. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
  34. package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
  35. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
  36. package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
  37. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
  38. package/sdk/application/Share/ShareApplicationClient.js +14 -14
  39. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  40. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  41. package/sdk/application/User/UserApplicationClient.d.ts +64 -64
  42. package/sdk/application/User/UserApplicationClient.js +64 -64
  43. package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
  44. package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
  45. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
  46. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
  47. package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
  48. package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
  49. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
  50. package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
  51. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
  52. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
  53. package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
  54. package/sdk/platform/Cart/CartPlatformModel.js +12 -0
  55. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +195 -108
  56. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +278 -113
  57. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +2 -2
  58. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -2
  59. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
  60. package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
  61. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +5 -5
  62. package/sdk/platform/Catalog/CatalogPlatformModel.js +3 -3
  63. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
  64. package/sdk/platform/Common/CommonPlatformClient.js +3 -3
  65. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
  66. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
  67. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
  68. package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
  69. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
  70. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
  71. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
  72. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
  73. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
  74. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
  75. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
  76. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
  77. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
  78. package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
  79. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
  80. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
  81. package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
  82. package/sdk/platform/Content/ContentPlatformClient.js +7 -7
  83. package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
  84. package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
  85. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
  86. package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
  87. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +19 -55
  88. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +19 -55
  89. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +14 -50
  90. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +16 -55
  91. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +13 -12
  92. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +12 -14
  93. package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
  94. package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
  95. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
  96. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  97. package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
  98. package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
  99. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
  100. package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
  101. package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
  102. package/sdk/platform/Order/OrderPlatformClient.js +79 -294
  103. package/sdk/platform/Order/OrderPlatformModel.d.ts +32 -3
  104. package/sdk/platform/Order/OrderPlatformModel.js +34 -2
  105. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
  106. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  107. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
  108. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
  109. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
  110. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
  111. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  112. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  113. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
  114. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
  115. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
  116. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
  117. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +5 -5
  118. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -8
  119. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
  120. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
  121. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -10
  122. package/sdk/platform/Share/SharePlatformApplicationClient.js +10 -10
  123. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
  124. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
  125. package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
  126. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  127. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
  128. package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
  129. package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
  130. package/sdk/platform/User/UserPlatformModel.js +2 -2
  131. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
  132. package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
  133. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
  134. package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
  135. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
  136. package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
  137. package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
  138. package/sdk/public/Partner/PartnerPublicClient.js +2 -2
  139. package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
  140. package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
@@ -87,8 +87,8 @@ class Catalog {
87
87
  * @param {import("../ApplicationAPIClient").Options} - Options
88
88
  * @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
89
89
  * @name followById
90
- * @summary: Follow an entity (product/brand/collection)
91
- * @description: Follow a particular entity such as product, brand, collection specified by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/followById/).
90
+ * @summary: Follows an item by ID.
91
+ * @description: Adds a product, brand, or item to the user's followed list by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/followById/).
92
92
  */
93
93
  async followById(
94
94
  { collectionType, collectionId, requestHeaders } = { requestHeaders: {} },
@@ -165,8 +165,8 @@ class Catalog {
165
165
  * @param {import("../ApplicationAPIClient").Options} - Options
166
166
  * @returns {Promise<CatalogApplicationModel.BrandDetailResponse>} - Success response
167
167
  * @name getBrandDetailBySlug
168
- * @summary: Get metadata of a brand
169
- * @description: Fetch 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/).
168
+ * @summary: Retrieves detailed brand info by slug.
169
+ * @description: Retrieve metadata of a brand such as name, information, logo, banner, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrandDetailBySlug/).
170
170
  */
171
171
  async getBrandDetailBySlug(
172
172
  { slug, requestHeaders } = { requestHeaders: {} },
@@ -245,8 +245,8 @@ class Catalog {
245
245
  * @param {import("../ApplicationAPIClient").Options} - Options
246
246
  * @returns {Promise<CatalogApplicationModel.BrandListingResponse>} - Success response
247
247
  * @name getBrands
248
- * @summary: Get all the brands
249
- * @description: A brand is the name under which a product is sold. Use this API to list all the brands. You can also filter the brands by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrands/).
248
+ * @summary: Fetches all available brands.
249
+ * @description: Retrieves a comprehensive list of all brands in the catalog under which a product is sold. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getBrands/).
250
250
  */
251
251
  async getBrands(
252
252
  { department, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -328,8 +328,8 @@ class Catalog {
328
328
  * from the endpoint /service/application/catalog/v1.0/departments/
329
329
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
330
330
  * @returns {Paginator<CatalogApplicationModel.BrandListingResponse>}
331
- * @summary: Get all the brands
332
- * @description: A brand is the name under which a product is sold. Use this API to list all the brands. You can also filter the brands by department.
331
+ * @summary: Fetches all available brands.
332
+ * @description: Retrieves a comprehensive list of all brands in the catalog under which a product is sold.
333
333
  */
334
334
  getBrandsPaginator({ department, pageSize } = {}) {
335
335
  const paginator = new Paginator();
@@ -359,8 +359,8 @@ class Catalog {
359
359
  * @returns {Promise<CatalogApplicationModel.CategoryListingResponse>} -
360
360
  * Success response
361
361
  * @name getCategories
362
- * @summary: List all the categories
363
- * @description: Use this API to list all the categories. You can also filter the categories by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategories/).
362
+ * @summary: Lists all product categories.
363
+ * @description: Retrieves a list of all available product categories. Also filter the categories by department. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategories/).
364
364
  */
365
365
  async getCategories(
366
366
  { department, requestHeaders } = { requestHeaders: {} },
@@ -438,8 +438,8 @@ class Catalog {
438
438
  * @param {import("../ApplicationAPIClient").Options} - Options
439
439
  * @returns {Promise<CatalogApplicationModel.CategoryMetaResponse>} - Success response
440
440
  * @name getCategoryDetailBySlug
441
- * @summary: Get metadata of a category
442
- * @description: Fetch 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/).
441
+ * @summary: Retrieves category details by slug.
442
+ * @description: Retrieve detailed information about a specific product category using its slug and Retrieve metadata of a category such as name, information, logo, banner, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCategoryDetailBySlug/).
443
443
  */
444
444
  async getCategoryDetailBySlug(
445
445
  { slug, requestHeaders } = { requestHeaders: {} },
@@ -521,8 +521,8 @@ class Catalog {
521
521
  * @returns {Promise<CatalogApplicationModel.CollectionDetailResponse>} -
522
522
  * Success response
523
523
  * @name getCollectionDetailBySlug
524
- * @summary: Get a particular collection
525
- * @description: Get the details of a collection by its `slug`. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionDetailBySlug/).
524
+ * @summary: Retrieves collection details by slug.
525
+ * @description: Retrieve detailed information about a specific collection using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionDetailBySlug/).
526
526
  */
527
527
  async getCollectionDetailBySlug(
528
528
  { slug, requestHeaders } = { requestHeaders: {} },
@@ -603,8 +603,8 @@ class Catalog {
603
603
  * @returns {Promise<CatalogApplicationModel.ProductListingResponse>} -
604
604
  * Success response
605
605
  * @name getCollectionItemsBySlug
606
- * @summary: Get the items in a collection
607
- * @description: Get items in a collection specified by its `slug`. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionItemsBySlug/).
606
+ * @summary: Lists items in a collection by slug.
607
+ * @description: Retrieve items in a specific collection identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollectionItemsBySlug/).
608
608
  */
609
609
  async getCollectionItemsBySlug(
610
610
  {
@@ -714,8 +714,8 @@ class Catalog {
714
714
  * either ascending or descending order. See the supported values below.
715
715
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
716
716
  * @returns {Paginator<CatalogApplicationModel.ProductListingResponse>}
717
- * @summary: Get the items in a collection
718
- * @description: Get items in a collection specified by its `slug`.
717
+ * @summary: Lists items in a collection by slug.
718
+ * @description: Retrieve items in a specific collection identified by its slug.
719
719
  */
720
720
  getCollectionItemsBySlugPaginator({
721
721
  slug,
@@ -759,8 +759,8 @@ class Catalog {
759
759
  * - Success response
760
760
  *
761
761
  * @name getCollections
762
- * @summary: List all the collections
763
- * @description: Collections are a great way to organize your products and can improve the ability for customers to find items quickly and efficiently. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollections/).
762
+ * @summary: Fetches all available collections.
763
+ * @description: Retrieves a list of curated product collections. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getCollections/).
764
764
  */
765
765
  async getCollections(
766
766
  { pageNo, pageSize, tag, q, requestHeaders } = { requestHeaders: {} },
@@ -841,8 +841,8 @@ class Catalog {
841
841
  * @param {string[]} [arg.tag] - List of tags to filter collections
842
842
  * @param {string} [arg.q] - Name of the collection to filter collection
843
843
  * @returns {Paginator<CatalogApplicationModel.GetCollectionListingResponse>}
844
- * @summary: List all the collections
845
- * @description: Collections are a great way to organize your products and can improve the ability for customers to find items quickly and efficiently.
844
+ * @summary: Fetches all available collections.
845
+ * @description: Retrieves a list of curated product collections.
846
846
  */
847
847
  getCollectionsPaginator({ pageSize, tag, q } = {}) {
848
848
  const paginator = new Paginator();
@@ -876,8 +876,8 @@ class Catalog {
876
876
  * - Success response
877
877
  *
878
878
  * @name getComparedFrequentlyProductBySlug
879
- * @summary: Get comparison between frequently compared products with the given product
880
- * @description: Use this API to compare a given product automatically with products that are frequently compared with it. Only one slug is needed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getComparedFrequentlyProductBySlug/).
879
+ * @summary: Retrieves products frequently compared with a given product.
880
+ * @description: Retrieve products that are often compared to the product specified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getComparedFrequentlyProductBySlug/).
881
881
  */
882
882
  async getComparedFrequentlyProductBySlug(
883
883
  { slug, requestHeaders } = { requestHeaders: {} },
@@ -956,8 +956,8 @@ class Catalog {
956
956
  * @param {import("../ApplicationAPIClient").Options} - Options
957
957
  * @returns {Promise<CatalogApplicationModel.DepartmentResponse>} - Success response
958
958
  * @name getDepartments
959
- * @summary: List all the departments
960
- * @description: Departments are a way to categorise similar products. A product can lie in multiple departments. For example, a skirt can below to the 'Women's Fashion' Department while a handbag can lie in 'Women's Accessories' Department. Use this API to list all the departments. If successful, returns the list of departments specified in `DepartmentResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
959
+ * @summary: Lists all departments.
960
+ * @description: Retrieves a list of all available product departments. Departments are a way to categorise similar products. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getDepartments/).
961
961
  */
962
962
  async getDepartments(
963
963
  { requestHeaders } = { requestHeaders: {} },
@@ -1034,8 +1034,8 @@ class Catalog {
1034
1034
  * @param {import("../ApplicationAPIClient").Options} - Options
1035
1035
  * @returns {Promise<CatalogApplicationModel.FollowIdsResponse>} - Success response
1036
1036
  * @name getFollowIds
1037
- * @summary: Get the IDs of followed products, brands and collections.
1038
- * @description: You can get the IDs of all the followed Products, Brands and Collections. Pass collection_type as query parameter to fetch specific Ids - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowIds/).
1037
+ * @summary: Fetches IDs of followed items.
1038
+ * @description: Retrieves the IDs of all items the user is currently following like Products, Brands and Collections. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowIds/).
1039
1039
  */
1040
1040
  async getFollowIds(
1041
1041
  { collectionType, requestHeaders } = { requestHeaders: {} },
@@ -1114,8 +1114,8 @@ class Catalog {
1114
1114
  * @returns {Promise<CatalogApplicationModel.GetFollowListingResponse>} -
1115
1115
  * Success response
1116
1116
  * @name getFollowedListing
1117
- * @summary: Get a list of followed Products, Brands, Collections
1118
- * @description: Users can follow a product they like. This API retrieves the products the user have followed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowedListing/).
1117
+ * @summary: Retrieves user's followed listings.
1118
+ * @description: Retrieve a list of products or brands the user is following. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowedListing/).
1119
1119
  */
1120
1120
  async getFollowedListing(
1121
1121
  { collectionType, pageId, pageSize, requestHeaders } = {
@@ -1196,8 +1196,8 @@ class Catalog {
1196
1196
  * products, brands, or collections.
1197
1197
  * @param {number} [arg.pageSize] - Page ID to retrieve next set of results.
1198
1198
  * @returns {Paginator<CatalogApplicationModel.GetFollowListingResponse>}
1199
- * @summary: Get a list of followed Products, Brands, Collections
1200
- * @description: Users can follow a product they like. This API retrieves the products the user have followed.
1199
+ * @summary: Retrieves user's followed listings.
1200
+ * @description: Retrieve a list of products or brands the user is following.
1201
1201
  */
1202
1202
  getFollowedListingPaginator({ collectionType, pageSize } = {}) {
1203
1203
  const paginator = new Paginator();
@@ -1227,8 +1227,8 @@ class Catalog {
1227
1227
  * @returns {Promise<CatalogApplicationModel.FollowerCountResponse>} -
1228
1228
  * Success response
1229
1229
  * @name getFollowerCountById
1230
- * @summary: Get Follow Count
1231
- * @description: Get the total count of followers for a given collection type and collection ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowerCountById/).
1230
+ * @summary: Retrieves follower count for an item.
1231
+ * @description: Retrieves the total number of followers for a specific item by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getFollowerCountById/).
1232
1232
  */
1233
1233
  async getFollowerCountById(
1234
1234
  { collectionType, collectionId, requestHeaders } = { requestHeaders: {} },
@@ -1307,7 +1307,7 @@ class Catalog {
1307
1307
  * @param {import("../ApplicationAPIClient").Options} - Options
1308
1308
  * @returns {Promise<CatalogApplicationModel.HomeListingResponse>} - Success response
1309
1309
  * @name getHomeProducts
1310
- * @summary: List the products
1310
+ * @summary: Fetches homepage-featured products.
1311
1311
  * @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/).
1312
1312
  */
1313
1313
  async getHomeProducts(
@@ -1389,7 +1389,7 @@ class Catalog {
1389
1389
  * either ascending or descending order.
1390
1390
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
1391
1391
  * @returns {Paginator<CatalogApplicationModel.HomeListingResponse>}
1392
- * @summary: List the products
1392
+ * @summary: Fetches homepage-featured products.
1393
1393
  * @description: List all the products associated with a brand, collection or category in a random order.
1394
1394
  */
1395
1395
  getHomeProductsPaginator({ sortOn, pageSize } = {}) {
@@ -1420,8 +1420,8 @@ class Catalog {
1420
1420
  * @returns {Promise<CatalogApplicationModel.ApplicationStoreListing>} -
1421
1421
  * Success response
1422
1422
  * @name getInStockLocations
1423
- * @summary: Get store meta information.
1424
- * @description: Use this API to get a list of stores in a specific application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getInStockLocations/).
1423
+ * @summary: Finds in-stock locations for products.
1424
+ * @description: Lists locations where specified products are currently in stock. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getInStockLocations/).
1425
1425
  */
1426
1426
  async getInStockLocations(
1427
1427
  {
@@ -1522,8 +1522,8 @@ class Catalog {
1522
1522
  * @param {number} [arg.longitude] - Longitude of the location from where
1523
1523
  * one wants to retreive the nearest stores, e.g. 19.1174114
1524
1524
  * @returns {Paginator<CatalogApplicationModel.ApplicationStoreListing>}
1525
- * @summary: Get store meta information.
1526
- * @description: Use this API to get a list of stores in a specific application.
1525
+ * @summary: Finds in-stock locations for products.
1526
+ * @description: Lists locations where specified products are currently in stock.
1527
1527
  */
1528
1528
  getInStockLocationsPaginator({
1529
1529
  pageSize,
@@ -1563,8 +1563,8 @@ class Catalog {
1563
1563
  * @param {import("../ApplicationAPIClient").Options} - Options
1564
1564
  * @returns {Promise<CatalogApplicationModel.StoreDetails>} - Success response
1565
1565
  * @name getLocationDetailsById
1566
- * @summary: Get store meta information.
1567
- * @description: Use this API to get meta details for a store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getLocationDetailsById/).
1566
+ * @summary: Retrieves location details by ID.
1567
+ * @description: Retrieves detailed information about a specific location using its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getLocationDetailsById/).
1568
1568
  */
1569
1569
  async getLocationDetailsById(
1570
1570
  { locationId, requestHeaders } = { requestHeaders: {} },
@@ -1643,8 +1643,8 @@ class Catalog {
1643
1643
  * @param {import("../ApplicationAPIClient").Options} - Options
1644
1644
  * @returns {Promise<CatalogApplicationModel.ProductBundle>} - Success response
1645
1645
  * @name getProductBundlesBySlug
1646
- * @summary: Get product bundles
1647
- * @description: Use this API to retrieve products bundles to the one specified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductBundlesBySlug/).
1646
+ * @summary: Fetches product bundles by slug.
1647
+ * @description: Retrieve products bundles to the one specified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductBundlesBySlug/).
1648
1648
  */
1649
1649
  async getProductBundlesBySlug(
1650
1650
  { slug, id, requestHeaders } = { requestHeaders: {} },
@@ -1728,8 +1728,8 @@ class Catalog {
1728
1728
  * @returns {Promise<CatalogApplicationModel.ProductsComparisonResponse>} -
1729
1729
  * Success response
1730
1730
  * @name getProductComparisonBySlugs
1731
- * @summary: Compare products
1732
- * @description: Use this API to compare the features of products belonging to the same category. Note that at least one slug is mandatory in the request query. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductComparisonBySlugs/).
1731
+ * @summary: Compares multiple products by slugs.
1732
+ * @description: Retrieves side-by-side comparisons of multiple products identified by their slugs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductComparisonBySlugs/).
1733
1733
  */
1734
1734
  async getProductComparisonBySlugs(
1735
1735
  { slug, requestHeaders } = { requestHeaders: {} },
@@ -1809,8 +1809,8 @@ class Catalog {
1809
1809
  * @param {import("../ApplicationAPIClient").Options} - Options
1810
1810
  * @returns {Promise<CatalogApplicationModel.ProductDetail>} - Success response
1811
1811
  * @name getProductDetailBySlug
1812
- * @summary: Get a product
1813
- * @description: Use this API to retrieve a product by its slug value. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductDetailBySlug/).
1812
+ * @summary: Fetches detailed product information by slug.
1813
+ * @description: Retrieve a product by its slug value. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductDetailBySlug/).
1814
1814
  */
1815
1815
  async getProductDetailBySlug(
1816
1816
  { slug, requestHeaders } = { requestHeaders: {} },
@@ -1890,8 +1890,8 @@ class Catalog {
1890
1890
  * @returns {Promise<CatalogApplicationModel.ProductSizePriceResponseV3>} -
1891
1891
  * Success response
1892
1892
  * @name getProductPriceBySlug
1893
- * @summary: Get the price of a product size at a PIN Code
1894
- * @description: Prices may vary for different sizes of a product. Use this API to retrieve the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductPriceBySlug/).
1893
+ * @summary: Retrieves product price by slug.
1894
+ * @description: Retrieve the price of a product size at all the selling locations near to a PIN Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductPriceBySlug/).
1895
1895
  */
1896
1896
  async getProductPriceBySlug(
1897
1897
  { slug, size, storeId, moq, requestHeaders } = { requestHeaders: {} },
@@ -1974,8 +1974,8 @@ class Catalog {
1974
1974
  * - Success response
1975
1975
  *
1976
1976
  * @name getProductSellersBySlug
1977
- * @summary: Get the sellers of a product size at a PIN Code
1978
- * @description: A product of a particular size may be sold by multiple sellers. Use this API to fetch the sellers having the stock of a particular size at a given PIN Code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSellersBySlug/).
1977
+ * @summary: Lists sellers for a product by slug.
1978
+ * @description: Retrieve a list of all sellers offering a specific product identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSellersBySlug/).
1979
1979
  */
1980
1980
  async getProductSellersBySlug(
1981
1981
  { slug, size, strategy, pageNo, pageSize, requestHeaders } = {
@@ -2065,8 +2065,8 @@ class Catalog {
2065
2065
  * eg, fast-delivery, low-price, optimal.
2066
2066
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
2067
2067
  * @returns {Paginator<CatalogApplicationModel.ProductSizeSellersResponseV3>}
2068
- * @summary: Get the sellers of a product size at a PIN Code
2069
- * @description: A product of a particular size may be sold by multiple sellers. Use this API to fetch the sellers having the stock of a particular size at a given PIN Code.
2068
+ * @summary: Lists sellers for a product by slug.
2069
+ * @description: Retrieve a list of all sellers offering a specific product identified by its slug.
2070
2070
  */
2071
2071
  getProductSellersBySlugPaginator({ slug, size, strategy, pageSize } = {}) {
2072
2072
  const paginator = new Paginator();
@@ -2097,8 +2097,8 @@ class Catalog {
2097
2097
  * @param {import("../ApplicationAPIClient").Options} - Options
2098
2098
  * @returns {Promise<CatalogApplicationModel.ProductSizes>} - Success response
2099
2099
  * @name getProductSizesBySlug
2100
- * @summary: Get the sizes of a product
2101
- * @description: A product can have multiple sizes. Use this API to fetch all the available sizes of a product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSizesBySlug/).
2100
+ * @summary: Retrieves available sizes for a product by slug.
2101
+ * @description: Retrieve the size options available for a specific product based on its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductSizesBySlug/).
2102
2102
  */
2103
2103
  async getProductSizesBySlug(
2104
2104
  { slug, storeId, requestHeaders } = { requestHeaders: {} },
@@ -2179,8 +2179,8 @@ class Catalog {
2179
2179
  * @returns {Promise<CatalogApplicationModel.ProductStockStatusResponse>} -
2180
2180
  * Success response
2181
2181
  * @name getProductStockByIds
2182
- * @summary: Get the stock of a product
2183
- * @description: Retrieve the available stock of the products. Use this API to retrieve stock of multiple products (up to 50) at a time. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockByIds/).
2182
+ * @summary: Checks product stock by IDs.
2183
+ * @description: Retrieves the current stock status for products identified by their IDs. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockByIds/).
2184
2184
  */
2185
2185
  async getProductStockByIds(
2186
2186
  { itemId, alu, skuCode, ean, upc, requestHeaders } = { requestHeaders: {} },
@@ -2266,8 +2266,8 @@ class Catalog {
2266
2266
  * @param {import("../ApplicationAPIClient").Options} - Options
2267
2267
  * @returns {Promise<CatalogApplicationModel.ProductStockPolling>} - Success response
2268
2268
  * @name getProductStockForTimeByIds
2269
- * @summary: Get the stock of a product
2270
- * @description: Retrieve the available stock of the products. Use this API to get the stock status of products whose inventory is updated at the specified time - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockForTimeByIds/).
2269
+ * @summary: Fetches future stock data for products.
2270
+ * @description: Retrieves projected stock levels for specified products at a future time. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductStockForTimeByIds/).
2271
2271
  */
2272
2272
  async getProductStockForTimeByIds(
2273
2273
  { timestamp, pageSize, pageId, requestHeaders } = { requestHeaders: {} },
@@ -2348,8 +2348,8 @@ class Catalog {
2348
2348
  * @param {string} arg.timestamp - Timestamp in UTC format (2020-07-23T10:27:50Z)
2349
2349
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
2350
2350
  * @returns {Paginator<CatalogApplicationModel.ProductStockPolling>}
2351
- * @summary: Get the stock of a product
2352
- * @description: Retrieve the available stock of the products. Use this API to get the stock status of products whose inventory is updated at the specified time
2351
+ * @summary: Fetches future stock data for products.
2352
+ * @description: Retrieves projected stock levels for specified products at a future time.
2353
2353
  */
2354
2354
  getProductStockForTimeByIdsPaginator({ timestamp, pageSize } = {}) {
2355
2355
  const paginator = new Paginator();
@@ -2380,8 +2380,8 @@ class Catalog {
2380
2380
  * @returns {Promise<CatalogApplicationModel.ProductVariantsResponse>} -
2381
2381
  * Success response
2382
2382
  * @name getProductVariantsBySlug
2383
- * @summary: Get variant of a particular product
2384
- * @description: A product can have a different type of variants such as colour, shade, memory. Use this API to fetch all the available variants of a product using its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductVariantsBySlug/).
2383
+ * @summary: Retrieves product variants by slug.
2384
+ * @description: Retrieves all available variants of a specific product identified by its slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProductVariantsBySlug/).
2385
2385
  */
2386
2386
  async getProductVariantsBySlug(
2387
2387
  { slug, requestHeaders } = { requestHeaders: {} },
@@ -2461,8 +2461,8 @@ class Catalog {
2461
2461
  * @returns {Promise<CatalogApplicationModel.ProductListingResponse>} -
2462
2462
  * Success response
2463
2463
  * @name getProducts
2464
- * @summary: Get all the products
2465
- * @description: Use this API to list all the products. You may choose a sort order or make arbitrary search queries by entering the product name, brand, category or collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProducts/).
2464
+ * @summary: Lists all products.
2465
+ * @description: Retrieves a list of all products in the catalog. Choose a sort order or make arbitrary search queries by entering the product name, brand, category or collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getProducts/).
2466
2466
  */
2467
2467
  async getProducts(
2468
2468
  {
@@ -2566,8 +2566,8 @@ class Catalog {
2566
2566
  * either ascending or descending order. See the supported values below.
2567
2567
  * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
2568
2568
  * @returns {Paginator<CatalogApplicationModel.ProductListingResponse>}
2569
- * @summary: Get all the products
2570
- * @description: Use this API to list all the products. You may choose a sort order or make arbitrary search queries by entering the product name, brand, category or collection.
2569
+ * @summary: Lists all products.
2570
+ * @description: Retrieves a list of all products in the catalog. Choose a sort order or make arbitrary search queries by entering the product name, brand, category or collection.
2571
2571
  */
2572
2572
  getProductsPaginator({ q, f, filters, sortOn, pageSize } = {}) {
2573
2573
  const paginator = new Paginator();
@@ -2601,8 +2601,8 @@ class Catalog {
2601
2601
  * @param {import("../ApplicationAPIClient").Options} - Options
2602
2602
  * @returns {Promise<CatalogApplicationModel.AutoCompleteResponse>} - Success response
2603
2603
  * @name getSearchResults
2604
- * @summary: Get relevant suggestions for a search query
2605
- * @description: Retrieves a list of suggestions for a given search query. Each suggestion is a valid search term that's generated on the basis of query. This is particularly useful to enhance the user experience while using the search tool. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSearchResults/).
2604
+ * @summary: Retrieves search result listings.
2605
+ * @description: Retrieves products that match the user's search criteria. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSearchResults/).
2606
2606
  */
2607
2607
  async getSearchResults(
2608
2608
  { q, requestHeaders } = { requestHeaders: {} },
@@ -2683,8 +2683,8 @@ class Catalog {
2683
2683
  * @returns {Promise<CatalogApplicationModel.ProductCompareResponse>} -
2684
2684
  * Success response
2685
2685
  * @name getSimilarComparisonProductBySlug
2686
- * @summary: Get comparison between similar products
2687
- * @description: Use this API to compare a given product automatically with similar products. Only one slug is needed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSimilarComparisonProductBySlug/).
2686
+ * @summary: Fetches similar products for comparison.
2687
+ * @description: Gets products similar to the one identified by the given slug for comparison. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getSimilarComparisonProductBySlug/).
2688
2688
  */
2689
2689
  async getSimilarComparisonProductBySlug(
2690
2690
  { slug, requestHeaders } = { requestHeaders: {} },
@@ -2763,8 +2763,8 @@ class Catalog {
2763
2763
  * @param {import("../ApplicationAPIClient").Options} - Options
2764
2764
  * @returns {Promise<CatalogApplicationModel.StoreListingResponse>} - Success response
2765
2765
  * @name getStores
2766
- * @summary: Get store meta information.
2767
- * @description: Use this API to get a list of stores in a specific application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
2766
+ * @summary: Lists available stores.
2767
+ * @description: Retrieves a list of all physical or online stores. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/getStores/).
2768
2768
  */
2769
2769
  async getStores(
2770
2770
  {
@@ -2866,8 +2866,8 @@ class Catalog {
2866
2866
  * one wants to retreive the nearest stores, e.g. 19.1174114
2867
2867
  * @param {string} [arg.tags] - Search stores based on tags.
2868
2868
  * @returns {Paginator<CatalogApplicationModel.StoreListingResponse>}
2869
- * @summary: Get store meta information.
2870
- * @description: Use this API to get a list of stores in a specific application.
2869
+ * @summary: Lists available stores.
2870
+ * @description: Retrieves a list of all physical or online stores.
2871
2871
  */
2872
2872
  getStoresPaginator({
2873
2873
  pageSize,
@@ -2909,8 +2909,8 @@ class Catalog {
2909
2909
  * @param {import("../ApplicationAPIClient").Options} - Options
2910
2910
  * @returns {Promise<CatalogApplicationModel.FollowPostResponse>} - Success response
2911
2911
  * @name unfollowById
2912
- * @summary: Unfollow an entity (product/brand/collection)
2913
- * @description: You can undo a followed product, brand or collection by its ID. This action is referred as _unfollow_. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/unfollowById/).
2912
+ * @summary: Unfollows an item by ID.
2913
+ * @description: Removes a followed item, brand, or product based on its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/catalog/unfollowById/).
2914
2914
  */
2915
2915
  async unfollowById(
2916
2916
  { collectionType, collectionId, requestHeaders } = { requestHeaders: {} },
@@ -14,8 +14,8 @@ declare class Common {
14
14
  * @param {import("../ApplicationAPIClient").Options} - Options
15
15
  * @returns {Promise<CommonApplicationModel.Locations>} - Success response
16
16
  * @name getLocations
17
- * @summary: Get countries, states, cities
18
- * @description: Get countries, states, cities - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/getLocations/).
17
+ * @summary: Fetches available locations.
18
+ * @description: Retrieves a list of all locations of countries, states, cities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/getLocations/).
19
19
  */
20
20
  getLocations({ locationType, id, requestHeaders }?: CommonApplicationValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CommonApplicationModel.Locations>;
21
21
  /**
@@ -24,8 +24,8 @@ declare class Common {
24
24
  * @param {import("../ApplicationAPIClient").Options} - Options
25
25
  * @returns {Promise<CommonApplicationModel.ApplicationResponse>} - Success response
26
26
  * @name searchApplication
27
- * @summary: Search Application
28
- * @description: Provide application name or domain url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/searchApplication/).
27
+ * @summary: Searches through applications.
28
+ * @description: Provide application name or domain url. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/searchApplication/).
29
29
  */
30
30
  searchApplication({ authorization, query, requestHeaders }?: CommonApplicationValidator.SearchApplicationParam, { responseHeaders }?: object): Promise<CommonApplicationModel.ApplicationResponse>;
31
31
  }
@@ -40,8 +40,8 @@ class Common {
40
40
  * @param {import("../ApplicationAPIClient").Options} - Options
41
41
  * @returns {Promise<CommonApplicationModel.Locations>} - Success response
42
42
  * @name getLocations
43
- * @summary: Get countries, states, cities
44
- * @description: Get countries, states, cities - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/getLocations/).
43
+ * @summary: Fetches available locations.
44
+ * @description: Retrieves a list of all locations of countries, states, cities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/getLocations/).
45
45
  */
46
46
  async getLocations(
47
47
  { locationType, id, requestHeaders } = { requestHeaders: {} },
@@ -120,8 +120,8 @@ class Common {
120
120
  * @param {import("../ApplicationAPIClient").Options} - Options
121
121
  * @returns {Promise<CommonApplicationModel.ApplicationResponse>} - Success response
122
122
  * @name searchApplication
123
- * @summary: Search Application
124
- * @description: Provide application name or domain url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/searchApplication/).
123
+ * @summary: Searches through applications.
124
+ * @description: Provide application name or domain url. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/searchApplication/).
125
125
  */
126
126
  async searchApplication(
127
127
  { authorization, query, requestHeaders } = { requestHeaders: {} },
@@ -18,8 +18,8 @@ declare class Communication {
18
18
  * @returns {Promise<CommunicationApplicationModel.CommunicationConsent>} -
19
19
  * Success response
20
20
  * @name getCommunicationConsent
21
- * @summary: Get communication consent
22
- * @description: Use this API to retrieve the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/getCommunicationConsent/).
21
+ * @summary: Retrieves communication consent status.
22
+ * @description: Retrieve the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/getCommunicationConsent/).
23
23
  */
24
24
  getCommunicationConsent({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationApplicationModel.CommunicationConsent>;
25
25
  /**
@@ -29,8 +29,8 @@ declare class Communication {
29
29
  * @param {import("../ApplicationAPIClient").Options} - Options
30
30
  * @returns {Promise<CommunicationApplicationModel.PushtokenRes>} - Success response
31
31
  * @name upsertAppPushtoken
32
- * @summary: Upsert push token of a user
33
- * @description: Use this API to update and insert the push token of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertAppPushtoken/).
32
+ * @summary: Updates or adds app push token.
33
+ * @description: Update the push token of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertAppPushtoken/).
34
34
  */
35
35
  upsertAppPushtoken({ body, requestHeaders }?: CommunicationApplicationValidator.UpsertAppPushtokenParam, { responseHeaders }?: object): Promise<CommunicationApplicationModel.PushtokenRes>;
36
36
  /**
@@ -43,8 +43,8 @@ declare class Communication {
43
43
  * - Success response
44
44
  *
45
45
  * @name upsertCommunicationConsent
46
- * @summary: Upsert communication consent
47
- * @description: Use this API to update and insert the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertCommunicationConsent/).
46
+ * @summary: Updates or inserts consent settings.
47
+ * @description: Update and insert the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertCommunicationConsent/).
48
48
  */
49
49
  upsertCommunicationConsent({ body, requestHeaders }?: CommunicationApplicationValidator.UpsertCommunicationConsentParam, { responseHeaders }?: object): Promise<CommunicationApplicationModel.CommunicationConsentRes>;
50
50
  }
@@ -45,8 +45,8 @@ class Communication {
45
45
  * @returns {Promise<CommunicationApplicationModel.CommunicationConsent>} -
46
46
  * Success response
47
47
  * @name getCommunicationConsent
48
- * @summary: Get communication consent
49
- * @description: Use this API to retrieve the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/getCommunicationConsent/).
48
+ * @summary: Retrieves communication consent status.
49
+ * @description: Retrieve the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/getCommunicationConsent/).
50
50
  */
51
51
  async getCommunicationConsent(
52
52
  { requestHeaders } = { requestHeaders: {} },
@@ -126,8 +126,8 @@ class Communication {
126
126
  * @param {import("../ApplicationAPIClient").Options} - Options
127
127
  * @returns {Promise<CommunicationApplicationModel.PushtokenRes>} - Success response
128
128
  * @name upsertAppPushtoken
129
- * @summary: Upsert push token of a user
130
- * @description: Use this API to update and insert the push token of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertAppPushtoken/).
129
+ * @summary: Updates or adds app push token.
130
+ * @description: Update the push token of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertAppPushtoken/).
131
131
  */
132
132
  async upsertAppPushtoken(
133
133
  { body, requestHeaders } = { requestHeaders: {} },
@@ -210,8 +210,8 @@ class Communication {
210
210
  * - Success response
211
211
  *
212
212
  * @name upsertCommunicationConsent
213
- * @summary: Upsert communication consent
214
- * @description: Use this API to update and insert the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertCommunicationConsent/).
213
+ * @summary: Updates or inserts consent settings.
214
+ * @description: Update and insert the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertCommunicationConsent/).
215
215
  */
216
216
  async upsertCommunicationConsent(
217
217
  { body, requestHeaders } = { requestHeaders: {} },