@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
@@ -20,8 +20,8 @@ class Payment {
20
20
  * @param {import("../PlatformAPIClient").Options} - Options
21
21
  * @returns {Promise<PaymentPlatformModel.UpdatePayoutResponse>} - Success response
22
22
  * @name activateAndDectivatePayout
23
- * @summary: Partial Update Payout
24
- * @description: Partial Update Payout - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/activateAndDectivatePayout/).
23
+ * @summary: Activate/Deactivate payout.
24
+ * @description: Enable or disable payout functionality. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/activateAndDectivatePayout/).
25
25
  */
26
26
  async activateAndDectivatePayout(
27
27
  { uniqueTransferNo, body, requestHeaders } = { requestHeaders: {} },
@@ -103,8 +103,8 @@ class Payment {
103
103
  * @param {import("../PlatformAPIClient").Options} - Options
104
104
  * @returns {Promise<PaymentPlatformModel.DeletePayoutResponse>} - Success response
105
105
  * @name deletePayout
106
- * @summary: Delete Payout
107
- * @description: Delete Payout - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deletePayout/).
106
+ * @summary: Delete payout.
107
+ * @description: Remove a payout transaction from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deletePayout/).
108
108
  */
109
109
  async deletePayout(
110
110
  { uniqueTransferNo, requestHeaders } = { requestHeaders: {} },
@@ -186,8 +186,8 @@ class Payment {
186
186
  * - Success response
187
187
  *
188
188
  * @name deleteSubscriptionPaymentMethod
189
- * @summary: Delete Subscription Payment Method
190
- * @description: Uses this api to Delete Subscription Payment Method - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deleteSubscriptionPaymentMethod/).
189
+ * @summary: Delete subscription payment method.
190
+ * @description: Remove a payment method from subscription options. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deleteSubscriptionPaymentMethod/).
191
191
  */
192
192
  async deleteSubscriptionPaymentMethod(
193
193
  { uniqueExternalId, paymentMethodId, requestHeaders } = {
@@ -273,8 +273,8 @@ class Payment {
273
273
  * @param {import("../PlatformAPIClient").Options} - Options
274
274
  * @returns {Promise<PaymentPlatformModel.PayoutsResponse>} - Success response
275
275
  * @name getAllPayouts
276
- * @summary: Get All Payouts
277
- * @description: Get All Payouts - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getAllPayouts/).
276
+ * @summary: Get all payouts.
277
+ * @description: Retrieve a list of all payout transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getAllPayouts/).
278
278
  */
279
279
  async getAllPayouts(
280
280
  { uniqueExternalId, requestHeaders } = { requestHeaders: {} },
@@ -354,8 +354,8 @@ class Payment {
354
354
  * @returns {Promise<PaymentPlatformModel.SubscriptionConfigResponse>} -
355
355
  * Success response
356
356
  * @name getSubscriptionConfig
357
- * @summary: List Subscription Config
358
- * @description: Get all Subscription Config details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSubscriptionConfig/).
357
+ * @summary: Get subscription config.
358
+ * @description: Retrieve configuration settings for subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSubscriptionConfig/).
359
359
  */
360
360
  async getSubscriptionConfig(
361
361
  { requestHeaders } = { requestHeaders: {} },
@@ -433,8 +433,8 @@ class Payment {
433
433
  * - Success response
434
434
  *
435
435
  * @name getSubscriptionPaymentMethod
436
- * @summary: List Subscription Payment Method
437
- * @description: Get all Subscription Payment Method - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSubscriptionPaymentMethod/).
436
+ * @summary: Get subscription payment method.
437
+ * @description: Retrieve payment methods for subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSubscriptionPaymentMethod/).
438
438
  */
439
439
  async getSubscriptionPaymentMethod(
440
440
  { uniqueExternalId, requestHeaders } = { requestHeaders: {} },
@@ -515,8 +515,8 @@ class Payment {
515
515
  * @param {import("../PlatformAPIClient").Options} - Options
516
516
  * @returns {Promise<PaymentPlatformModel.PayoutResponse>} - Success response
517
517
  * @name savePayout
518
- * @summary: Save Payout
519
- * @description: Save Payout - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/savePayout/).
518
+ * @summary: Save payout.
519
+ * @description: Store and process a payout transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/savePayout/).
520
520
  */
521
521
  async savePayout(
522
522
  { body, requestHeaders } = { requestHeaders: {} },
@@ -594,8 +594,8 @@ class Payment {
594
594
  * - Success response
595
595
  *
596
596
  * @name saveSubscriptionSetupIntent
597
- * @summary: Save Subscription Setup Intent
598
- * @description: Uses this api to Save Subscription Setup Intent - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/saveSubscriptionSetupIntent/).
597
+ * @summary: Save subscription setup intent.
598
+ * @description: Store and process setup intent for subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/saveSubscriptionSetupIntent/).
599
599
  */
600
600
  async saveSubscriptionSetupIntent(
601
601
  { body, requestHeaders } = { requestHeaders: {} },
@@ -675,8 +675,8 @@ class Payment {
675
675
  * @param {import("../PlatformAPIClient").Options} - Options
676
676
  * @returns {Promise<PaymentPlatformModel.UpdatePayoutResponse>} - Success response
677
677
  * @name updatePayout
678
- * @summary: Update Payout
679
- * @description: Update Payout - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updatePayout/).
678
+ * @summary: Update payout.
679
+ * @description: Modify the details of a payout transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updatePayout/).
680
680
  */
681
681
  async updatePayout(
682
682
  { uniqueTransferNo, body, requestHeaders } = { requestHeaders: {} },
@@ -756,8 +756,8 @@ class Payment {
756
756
  * @param {import("../PlatformAPIClient").Options} - Options
757
757
  * @returns {Promise<PaymentPlatformModel.IfscCodeResponse>} - Success response
758
758
  * @name verifyIfscCode
759
- * @summary: Ifsc Code Verification
760
- * @description: Get True or False for correct IFSC Code for adding bank details for refund - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/verifyIfscCode/).
759
+ * @summary: Verify IFSC code.
760
+ * @description: Check the authenticity of an IFSC code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/verifyIfscCode/).
761
761
  */
762
762
  async verifyIfscCode(
763
763
  { ifscCode, requestHeaders } = { requestHeaders: {} },
@@ -10,7 +10,7 @@ declare class Rewards {
10
10
  * @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
11
11
  * @name getGiveawayById
12
12
  * @summary: Get giveaway by ID.
13
- * @description: Retrieve the specific giveaway by giveaway ID. It will show all the details of the requested giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getGiveawayById/).
13
+ * @description: Retrieve specific giveaway details by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getGiveawayById/).
14
14
  */
15
15
  getGiveawayById({ id, requestHeaders }?: RewardsPlatformApplicationValidator.GetGiveawayByIdParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Giveaway>;
16
16
  /**
@@ -19,8 +19,8 @@ declare class Rewards {
19
19
  * @param {import("../PlatformAPIClient").Options} - Options
20
20
  * @returns {Promise<RewardsPlatformModel.Offer>} - Success response
21
21
  * @name getOfferByName
22
- * @summary: Fetch a offer by its name
23
- * @description: Fetch the specific offer details and configuration by the name of the offer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getOfferByName/).
22
+ * @summary: Get offer by name.
23
+ * @description: Retrieve an offer by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getOfferByName/).
24
24
  */
25
25
  getOfferByName({ name, requestHeaders }?: RewardsPlatformApplicationValidator.GetOfferByNameParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Offer>;
26
26
  /**
@@ -31,8 +31,8 @@ declare class Rewards {
31
31
  * @param {import("../PlatformAPIClient").Options} - Options
32
32
  * @returns {Promise<RewardsPlatformModel.ConfigurationRes>} - Success response
33
33
  * @name getRewardsConfiguration
34
- * @summary: Get all valid android paths
35
- * @description: Use this API to get a list of valid android paths required by the Rewards INIT API to validate a fraudulent device. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getRewardsConfiguration/).
34
+ * @summary: Get rewards configuration.
35
+ * @description: Retrieve the configuration settings for the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getRewardsConfiguration/).
36
36
  */
37
37
  getRewardsConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<RewardsPlatformModel.ConfigurationRes>;
38
38
  /**
@@ -41,8 +41,8 @@ declare class Rewards {
41
41
  * @param {import("../PlatformAPIClient").Options} - Options
42
42
  * @returns {Promise<RewardsPlatformModel.UserRes>} - Success response
43
43
  * @name getUserDetails
44
- * @summary: Get user reward details
45
- * @description: Fetches the user details and the user reward details with their current reward points for the specific user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserDetails/).
44
+ * @summary: Get user details.
45
+ * @description: Retrieve comprehensive details about a user in the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserDetails/).
46
46
  */
47
47
  getUserDetails({ userId, requestHeaders }?: RewardsPlatformApplicationValidator.GetUserDetailsParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.UserRes>;
48
48
  /**
@@ -53,34 +53,18 @@ declare class Rewards {
53
53
  * @param {import("../PlatformAPIClient").Options} - Options
54
54
  * @returns {Promise<RewardsPlatformModel.HistoryRes>} - Success response
55
55
  * @name getUserPointsHistory
56
- * @summary: Get all transactions of reward points
57
- * @description: Fetches a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserPointsHistory/).
56
+ * @summary: Get user points history.
57
+ * @description: Retrieve the history of points earned and redeemed by a user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserPointsHistory/).
58
58
  */
59
59
  getUserPointsHistory({ userId, pageId, pageSize, requestHeaders }?: RewardsPlatformApplicationValidator.GetUserPointsHistoryParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.HistoryRes>;
60
- /**
61
- * @param {Object} arg - Arg object.
62
- * @param {string} arg.userId - User id
63
- * @param {string} arg.companyId - Company id
64
- * @param {string} arg.applicationId - Application id
65
- * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
66
- * @returns {Paginator<RewardsPlatformModel.HistoryRes>}
67
- * @summary: Get all transactions of reward points
68
- * @description: Fetches a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points.
69
- */
70
- getUserPointsHistoryPaginator({ userId, companyId, applicationId, pageSize, }?: {
71
- userId: string;
72
- companyId: string;
73
- applicationId: string;
74
- pageSize?: number;
75
- }): Paginator<RewardsPlatformModel.HistoryRes>;
76
60
  /**
77
61
  * @param {RewardsPlatformApplicationValidator.SaveGiveAwayParam} arg - Arg object
78
62
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
79
63
  * @param {import("../PlatformAPIClient").Options} - Options
80
64
  * @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
81
65
  * @name saveGiveAway
82
- * @summary: List of giveaways of the current application.
83
- * @description: Creates a new giveaway in the current application, specifying the target audience, points allocation, as well as the name and display name of the giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/saveGiveAway/).
66
+ * @summary: Save giveaway.
67
+ * @description: Store and manage details of a giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/saveGiveAway/).
84
68
  */
85
69
  saveGiveAway({ body, requestHeaders }?: RewardsPlatformApplicationValidator.SaveGiveAwayParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Giveaway>;
86
70
  /**
@@ -91,8 +75,8 @@ declare class Rewards {
91
75
  * @param {import("../PlatformAPIClient").Options} - Options
92
76
  * @returns {Promise<RewardsPlatformModel.SetConfigurationRes>} - Success response
93
77
  * @name setRewardsConfiguration
94
- * @summary: Updates the collection with given android paths.
95
- * @description: Updates the configuration or inserts new records with the given android paths. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/setRewardsConfiguration/).
78
+ * @summary: Set rewards configuration.
79
+ * @description: Configure and modify the settings for the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/setRewardsConfiguration/).
96
80
  */
97
81
  setRewardsConfiguration({ body, requestHeaders }?: RewardsPlatformApplicationValidator.SetRewardsConfigurationParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.SetConfigurationRes>;
98
82
  /**
@@ -101,8 +85,8 @@ declare class Rewards {
101
85
  * @param {import("../PlatformAPIClient").Options} - Options
102
86
  * @returns {Promise<RewardsPlatformModel.GiveawayResponse>} - Success response
103
87
  * @name showGiveaways
104
- * @summary: List of giveaways of the current application.
105
- * @description: Fetch the detailed compilation of live, completed, and scheduled point-based giveaways created. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showGiveaways/).
88
+ * @summary: Display giveaways.
89
+ * @description: Retrieve and display available giveaways. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showGiveaways/).
106
90
  */
107
91
  showGiveaways({ pageId, pageSize, requestHeaders }?: RewardsPlatformApplicationValidator.ShowGiveawaysParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.GiveawayResponse>;
108
92
  /**
@@ -111,8 +95,8 @@ declare class Rewards {
111
95
  * @param {import("../PlatformAPIClient").Options} - Options
112
96
  * @returns {Promise<RewardsPlatformModel.Offer[]>} - Success response
113
97
  * @name showOffers
114
- * @summary: List of offers of the current application.
115
- * @description: Retrieve the list of offers within the current application, including order_discount, order, sign_up, and referral, along with their respective details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showOffers/).
98
+ * @summary: Show offers.
99
+ * @description: Display available offers for users. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showOffers/).
116
100
  */
117
101
  showOffers({ requestHeaders }?: any, { responseHeaders }?: object): Promise<RewardsPlatformModel.Offer[]>;
118
102
  /**
@@ -121,8 +105,8 @@ declare class Rewards {
121
105
  * @param {import("../PlatformAPIClient").Options} - Options
122
106
  * @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
123
107
  * @name updateGiveAway
124
- * @summary: Updates the giveaway by it's ID.
125
- * @description: Make the necessary updates to the giveaway based on its giveaway ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateGiveAway/).
108
+ * @summary: Update giveaway.
109
+ * @description: Modify and update information about a giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateGiveAway/).
126
110
  */
127
111
  updateGiveAway({ id, body, requestHeaders }?: RewardsPlatformApplicationValidator.UpdateGiveAwayParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Giveaway>;
128
112
  /**
@@ -133,8 +117,8 @@ declare class Rewards {
133
117
  * @param {import("../PlatformAPIClient").Options} - Options
134
118
  * @returns {Promise<RewardsPlatformModel.Offer>} - Success response
135
119
  * @name updateOfferByName
136
- * @summary: Update offer by name
137
- * @description: Update the specific offer details and its configuration by offer name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateOfferByName/).
120
+ * @summary: Update offer by name.
121
+ * @description: Modify and manage an offer using its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateOfferByName/).
138
122
  */
139
123
  updateOfferByName({ name, body, requestHeaders }?: RewardsPlatformApplicationValidator.UpdateOfferByNameParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Offer>;
140
124
  /**
@@ -143,11 +127,10 @@ declare class Rewards {
143
127
  * @param {import("../PlatformAPIClient").Options} - Options
144
128
  * @returns {Promise<RewardsPlatformModel.AppUser>} - Success response
145
129
  * @name updateUserStatus
146
- * @summary: Update user status
147
- * @description: Update the user status by marking them as a block or unblock. It can be done by changing the active flag in request body. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateUserStatus/).
130
+ * @summary: Update user status.
131
+ * @description: Change and update the status of a user in the rewards system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateUserStatus/).
148
132
  */
149
133
  updateUserStatus({ userId, body, requestHeaders }?: RewardsPlatformApplicationValidator.UpdateUserStatusParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.AppUser>;
150
134
  }
151
135
  import RewardsPlatformApplicationValidator = require("./RewardsPlatformApplicationValidator");
152
136
  import RewardsPlatformModel = require("./RewardsPlatformModel");
153
- import Paginator = require("../../common/Paginator");
@@ -22,7 +22,7 @@ class Rewards {
22
22
  * @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
23
23
  * @name getGiveawayById
24
24
  * @summary: Get giveaway by ID.
25
- * @description: Retrieve the specific giveaway by giveaway ID. It will show all the details of the requested giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getGiveawayById/).
25
+ * @description: Retrieve specific giveaway details by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getGiveawayById/).
26
26
  */
27
27
  async getGiveawayById(
28
28
  { id, requestHeaders } = { requestHeaders: {} },
@@ -100,8 +100,8 @@ class Rewards {
100
100
  * @param {import("../PlatformAPIClient").Options} - Options
101
101
  * @returns {Promise<RewardsPlatformModel.Offer>} - Success response
102
102
  * @name getOfferByName
103
- * @summary: Fetch a offer by its name
104
- * @description: Fetch the specific offer details and configuration by the name of the offer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getOfferByName/).
103
+ * @summary: Get offer by name.
104
+ * @description: Retrieve an offer by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getOfferByName/).
105
105
  */
106
106
  async getOfferByName(
107
107
  { name, requestHeaders } = { requestHeaders: {} },
@@ -177,8 +177,8 @@ class Rewards {
177
177
  * @param {import("../PlatformAPIClient").Options} - Options
178
178
  * @returns {Promise<RewardsPlatformModel.ConfigurationRes>} - Success response
179
179
  * @name getRewardsConfiguration
180
- * @summary: Get all valid android paths
181
- * @description: Use this API to get a list of valid android paths required by the Rewards INIT API to validate a fraudulent device. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getRewardsConfiguration/).
180
+ * @summary: Get rewards configuration.
181
+ * @description: Retrieve the configuration settings for the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getRewardsConfiguration/).
182
182
  */
183
183
  async getRewardsConfiguration(
184
184
  { requestHeaders } = { requestHeaders: {} },
@@ -252,8 +252,8 @@ class Rewards {
252
252
  * @param {import("../PlatformAPIClient").Options} - Options
253
253
  * @returns {Promise<RewardsPlatformModel.UserRes>} - Success response
254
254
  * @name getUserDetails
255
- * @summary: Get user reward details
256
- * @description: Fetches the user details and the user reward details with their current reward points for the specific user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserDetails/).
255
+ * @summary: Get user details.
256
+ * @description: Retrieve comprehensive details about a user in the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserDetails/).
257
257
  */
258
258
  async getUserDetails(
259
259
  { userId, requestHeaders } = { requestHeaders: {} },
@@ -329,8 +329,8 @@ class Rewards {
329
329
  * @param {import("../PlatformAPIClient").Options} - Options
330
330
  * @returns {Promise<RewardsPlatformModel.HistoryRes>} - Success response
331
331
  * @name getUserPointsHistory
332
- * @summary: Get all transactions of reward points
333
- * @description: Fetches a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserPointsHistory/).
332
+ * @summary: Get user points history.
333
+ * @description: Retrieve the history of points earned and redeemed by a user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserPointsHistory/).
334
334
  */
335
335
  async getUserPointsHistory(
336
336
  { userId, pageId, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -410,52 +410,14 @@ class Rewards {
410
410
  return response;
411
411
  }
412
412
 
413
- /**
414
- * @param {Object} arg - Arg object.
415
- * @param {string} arg.userId - User id
416
- * @param {string} arg.companyId - Company id
417
- * @param {string} arg.applicationId - Application id
418
- * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
419
- * @returns {Paginator<RewardsPlatformModel.HistoryRes>}
420
- * @summary: Get all transactions of reward points
421
- * @description: Fetches a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points.
422
- */
423
- getUserPointsHistoryPaginator({
424
- userId,
425
- companyId,
426
- applicationId,
427
- pageSize,
428
- } = {}) {
429
- const paginator = new Paginator();
430
- const callback = async () => {
431
- const pageId = paginator.nextId;
432
- const pageNo = paginator.pageNo;
433
- const pageType = "cursor";
434
- const data = await this.getUserPointsHistory({
435
- userId: userId,
436
- companyId: companyId,
437
- applicationId: applicationId,
438
- pageId: pageId,
439
- pageSize: pageSize,
440
- });
441
- paginator.setPaginator({
442
- hasNext: data.page.has_next ? true : false,
443
- nextId: data.page.next_id,
444
- });
445
- return data;
446
- };
447
- paginator.setCallback(callback.bind(this));
448
- return paginator;
449
- }
450
-
451
413
  /**
452
414
  * @param {RewardsPlatformApplicationValidator.SaveGiveAwayParam} arg - Arg object
453
415
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
454
416
  * @param {import("../PlatformAPIClient").Options} - Options
455
417
  * @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
456
418
  * @name saveGiveAway
457
- * @summary: List of giveaways of the current application.
458
- * @description: Creates a new giveaway in the current application, specifying the target audience, points allocation, as well as the name and display name of the giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/saveGiveAway/).
419
+ * @summary: Save giveaway.
420
+ * @description: Store and manage details of a giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/saveGiveAway/).
459
421
  */
460
422
  async saveGiveAway(
461
423
  { body, requestHeaders } = { requestHeaders: {} },
@@ -535,8 +497,8 @@ class Rewards {
535
497
  * @param {import("../PlatformAPIClient").Options} - Options
536
498
  * @returns {Promise<RewardsPlatformModel.SetConfigurationRes>} - Success response
537
499
  * @name setRewardsConfiguration
538
- * @summary: Updates the collection with given android paths.
539
- * @description: Updates the configuration or inserts new records with the given android paths. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/setRewardsConfiguration/).
500
+ * @summary: Set rewards configuration.
501
+ * @description: Configure and modify the settings for the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/setRewardsConfiguration/).
540
502
  */
541
503
  async setRewardsConfiguration(
542
504
  { body, requestHeaders } = { requestHeaders: {} },
@@ -614,8 +576,8 @@ class Rewards {
614
576
  * @param {import("../PlatformAPIClient").Options} - Options
615
577
  * @returns {Promise<RewardsPlatformModel.GiveawayResponse>} - Success response
616
578
  * @name showGiveaways
617
- * @summary: List of giveaways of the current application.
618
- * @description: Fetch the detailed compilation of live, completed, and scheduled point-based giveaways created. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showGiveaways/).
579
+ * @summary: Display giveaways.
580
+ * @description: Retrieve and display available giveaways. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showGiveaways/).
619
581
  */
620
582
  async showGiveaways(
621
583
  { pageId, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -697,8 +659,8 @@ class Rewards {
697
659
  * @param {import("../PlatformAPIClient").Options} - Options
698
660
  * @returns {Promise<RewardsPlatformModel.Offer[]>} - Success response
699
661
  * @name showOffers
700
- * @summary: List of offers of the current application.
701
- * @description: Retrieve the list of offers within the current application, including order_discount, order, sign_up, and referral, along with their respective details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showOffers/).
662
+ * @summary: Show offers.
663
+ * @description: Display available offers for users. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showOffers/).
702
664
  */
703
665
  async showOffers(
704
666
  { requestHeaders } = { requestHeaders: {} },
@@ -767,8 +729,8 @@ class Rewards {
767
729
  * @param {import("../PlatformAPIClient").Options} - Options
768
730
  * @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
769
731
  * @name updateGiveAway
770
- * @summary: Updates the giveaway by it's ID.
771
- * @description: Make the necessary updates to the giveaway based on its giveaway ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateGiveAway/).
732
+ * @summary: Update giveaway.
733
+ * @description: Modify and update information about a giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateGiveAway/).
772
734
  */
773
735
  async updateGiveAway(
774
736
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -850,8 +812,8 @@ class Rewards {
850
812
  * @param {import("../PlatformAPIClient").Options} - Options
851
813
  * @returns {Promise<RewardsPlatformModel.Offer>} - Success response
852
814
  * @name updateOfferByName
853
- * @summary: Update offer by name
854
- * @description: Update the specific offer details and its configuration by offer name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateOfferByName/).
815
+ * @summary: Update offer by name.
816
+ * @description: Modify and manage an offer using its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateOfferByName/).
855
817
  */
856
818
  async updateOfferByName(
857
819
  { name, body, requestHeaders } = { requestHeaders: {} },
@@ -933,8 +895,8 @@ class Rewards {
933
895
  * @param {import("../PlatformAPIClient").Options} - Options
934
896
  * @returns {Promise<RewardsPlatformModel.AppUser>} - Success response
935
897
  * @name updateUserStatus
936
- * @summary: Update user status
937
- * @description: Update the user status by marking them as a block or unblock. It can be done by changing the active flag in request body. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateUserStatus/).
898
+ * @summary: Update user status.
899
+ * @description: Change and update the status of a user in the rewards system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateUserStatus/).
938
900
  */
939
901
  async updateUserStatus(
940
902
  { userId, body, requestHeaders } = { requestHeaders: {} },
@@ -200,8 +200,8 @@ declare class Serviceability {
200
200
  * - Success response
201
201
  *
202
202
  * @name updatePincodeAuditHistory
203
- * @summary: Auditlog configuration of application.
204
- * @description: This API returns Audit logs of Pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeAuditHistory/).
203
+ * @summary: Update pincode audit history.
204
+ * @description: Modify and update audit history records for pincode-related activities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeAuditHistory/).
205
205
  */
206
206
  updatePincodeAuditHistory({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeAuditHistoryParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryResponseData>;
207
207
  /**
@@ -214,8 +214,8 @@ declare class Serviceability {
214
214
  * - Success response
215
215
  *
216
216
  * @name updatePincodeBulkView
217
- * @summary: Bulk Update of pincode in the application.
218
- * @description: This API constructs bulk write operations to update the MOP data for each pincode in the payload. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeBulkView/).
217
+ * @summary: Update pincode bulk view.
218
+ * @description: Modify and update views related to bulk operations on pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeBulkView/).
219
219
  */
220
220
  updatePincodeBulkView({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeBulkViewParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeBulkViewResponse>;
221
221
  /**
@@ -228,8 +228,8 @@ declare class Serviceability {
228
228
  * - Success response
229
229
  *
230
230
  * @name updatePincodeCoDListing
231
- * @summary: Pincode count view of application.
232
- * @description: This API returns count of active pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeCoDListing/).
231
+ * @summary: Update pincode CoD (Cash on Delivery) listing.
232
+ * @description: Modify and update listings for CoD based on pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeCoDListing/).
233
233
  */
234
234
  updatePincodeCoDListing({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeCoDListingParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeCodStatusListingResponse>;
235
235
  /**
@@ -241,8 +241,8 @@ declare class Serviceability {
241
241
  * @returns {Promise<ServiceabilityPlatformModel.PincodeMOPresponse>} -
242
242
  * Success response
243
243
  * @name updatePincodeMopView
244
- * @summary: PincodeView update of MOP.
245
- * @description: This API updates Pincode method of payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeMopView/).
244
+ * @summary: Update pincode MOP (Mode of Payment) view.
245
+ * @description: Modify and update views related to pincode MOP. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeMopView/).
246
246
  */
247
247
  updatePincodeMopView({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeMopViewParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeMOPresponse>;
248
248
  /**
@@ -1182,8 +1182,8 @@ class Serviceability {
1182
1182
  * - Success response
1183
1183
  *
1184
1184
  * @name updatePincodeAuditHistory
1185
- * @summary: Auditlog configuration of application.
1186
- * @description: This API returns Audit logs of Pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeAuditHistory/).
1185
+ * @summary: Update pincode audit history.
1186
+ * @description: Modify and update audit history records for pincode-related activities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeAuditHistory/).
1187
1187
  */
1188
1188
  async updatePincodeAuditHistory(
1189
1189
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1265,8 +1265,8 @@ class Serviceability {
1265
1265
  * - Success response
1266
1266
  *
1267
1267
  * @name updatePincodeBulkView
1268
- * @summary: Bulk Update of pincode in the application.
1269
- * @description: This API constructs bulk write operations to update the MOP data for each pincode in the payload. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeBulkView/).
1268
+ * @summary: Update pincode bulk view.
1269
+ * @description: Modify and update views related to bulk operations on pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeBulkView/).
1270
1270
  */
1271
1271
  async updatePincodeBulkView(
1272
1272
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1348,8 +1348,8 @@ class Serviceability {
1348
1348
  * - Success response
1349
1349
  *
1350
1350
  * @name updatePincodeCoDListing
1351
- * @summary: Pincode count view of application.
1352
- * @description: This API returns count of active pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeCoDListing/).
1351
+ * @summary: Update pincode CoD (Cash on Delivery) listing.
1352
+ * @description: Modify and update listings for CoD based on pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeCoDListing/).
1353
1353
  */
1354
1354
  async updatePincodeCoDListing(
1355
1355
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1430,8 +1430,8 @@ class Serviceability {
1430
1430
  * @returns {Promise<ServiceabilityPlatformModel.PincodeMOPresponse>} -
1431
1431
  * Success response
1432
1432
  * @name updatePincodeMopView
1433
- * @summary: PincodeView update of MOP.
1434
- * @description: This API updates Pincode method of payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeMopView/).
1433
+ * @summary: Update pincode MOP (Mode of Payment) view.
1434
+ * @description: Modify and update views related to pincode MOP. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeMopView/).
1435
1435
  */
1436
1436
  async updatePincodeMopView(
1437
1437
  { body, requestHeaders } = { requestHeaders: {} },
@@ -71,8 +71,8 @@ declare class Serviceability {
71
71
  * @param {import("../PlatformAPIClient").Options} - Options
72
72
  * @returns {Promise<ServiceabilityPlatformModel.ZoneResponse>} - Success response
73
73
  * @name createZone
74
- * @summary: Creates a new Zone
75
- * @description: Creates a new zone with the specified mapping. A zone enables serviceability based on given regions. By creating a zone and including specific regions, you can ensure that the stores associated with the zone are serviceable for those added regions. This functionality is particularly useful when you need to ensure serviceability for multiple regions by grouping them into a single zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createZone/).
74
+ * @summary: Create zone.
75
+ * @description: Generate and add a new zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createZone/).
76
76
  */
77
77
  createZone({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneResponse>;
78
78
  /**
@@ -82,8 +82,8 @@ declare class Serviceability {
82
82
  * @returns {Promise<ServiceabilityPlatformModel.GetStoresViewResponse>} -
83
83
  * Success response
84
84
  * @name getAllStores
85
- * @summary: GET stores data
86
- * @description: This API returns stores data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getAllStores/).
85
+ * @summary: Get all stores.
86
+ * @description: Retrieve a list of all available stores data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getAllStores/).
87
87
  */
88
88
  getAllStores({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetStoresViewResponse>;
89
89
  /**
@@ -244,7 +244,7 @@ declare class Serviceability {
244
244
  * @summary: Shows zones defined at the company level
245
245
  * @description: Return the list of zones that are defined at the company level. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
246
246
  */
247
- getZones({ pageNo, pageSize, isActive, channelId, q, countryIsoCode, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResponse>;
247
+ getZones({ pageNo, pageSize, isActive, channelId, q, country, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResponse>;
248
248
  /**
249
249
  * @param {ServiceabilityPlatformValidator.UpdateCompanyConfigurationParam} arg
250
250
  * - Arg object
@@ -444,8 +444,8 @@ class Serviceability {
444
444
  * @param {import("../PlatformAPIClient").Options} - Options
445
445
  * @returns {Promise<ServiceabilityPlatformModel.ZoneResponse>} - Success response
446
446
  * @name createZone
447
- * @summary: Creates a new Zone
448
- * @description: Creates a new zone with the specified mapping. A zone enables serviceability based on given regions. By creating a zone and including specific regions, you can ensure that the stores associated with the zone are serviceable for those added regions. This functionality is particularly useful when you need to ensure serviceability for multiple regions by grouping them into a single zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createZone/).
447
+ * @summary: Create zone.
448
+ * @description: Generate and add a new zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createZone/).
449
449
  */
450
450
  async createZone(
451
451
  { body, requestHeaders } = { requestHeaders: {} },
@@ -524,8 +524,8 @@ class Serviceability {
524
524
  * @returns {Promise<ServiceabilityPlatformModel.GetStoresViewResponse>} -
525
525
  * Success response
526
526
  * @name getAllStores
527
- * @summary: GET stores data
528
- * @description: This API returns stores data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getAllStores/).
527
+ * @summary: Get all stores.
528
+ * @description: Retrieve a list of all available stores data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getAllStores/).
529
529
  */
530
530
  async getAllStores(
531
531
  { requestHeaders } = { requestHeaders: {} },
@@ -1729,7 +1729,7 @@ class Serviceability {
1729
1729
  isActive,
1730
1730
  channelId,
1731
1731
  q,
1732
- countryIsoCode,
1732
+ country,
1733
1733
  state,
1734
1734
  city,
1735
1735
  pincode,
@@ -1745,7 +1745,7 @@ class Serviceability {
1745
1745
  isActive,
1746
1746
  channelId,
1747
1747
  q,
1748
- countryIsoCode,
1748
+ country,
1749
1749
  state,
1750
1750
  city,
1751
1751
  pincode,
@@ -1767,7 +1767,7 @@ class Serviceability {
1767
1767
  isActive,
1768
1768
  channelId,
1769
1769
  q,
1770
- countryIsoCode,
1770
+ country,
1771
1771
  state,
1772
1772
  city,
1773
1773
  pincode,
@@ -1788,7 +1788,7 @@ class Serviceability {
1788
1788
  query_params["is_active"] = isActive;
1789
1789
  query_params["channel_id"] = channelId;
1790
1790
  query_params["q"] = q;
1791
- query_params["country_iso_code"] = countryIsoCode;
1791
+ query_params["country"] = country;
1792
1792
  query_params["state"] = state;
1793
1793
  query_params["city"] = city;
1794
1794
  query_params["pincode"] = pincode;