@gofynd/fdk-client-javascript 1.4.8-beta.2 → 1.4.8

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 (198) hide show
  1. package/README.md +26 -1
  2. package/package.json +2 -2
  3. package/sdk/application/ApplicationClient.d.ts +8 -0
  4. package/sdk/application/ApplicationClient.js +14 -0
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +20 -20
  6. package/sdk/application/Cart/CartApplicationClient.js +20 -20
  7. package/sdk/application/Cart/CartApplicationModel.d.ts +2446 -664
  8. package/sdk/application/Cart/CartApplicationModel.js +783 -552
  9. package/sdk/application/Cart/CartApplicationValidator.d.ts +268 -194
  10. package/sdk/application/Cart/CartApplicationValidator.js +100 -114
  11. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +53 -53
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +53 -53
  13. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2012 -503
  14. package/sdk/application/Catalog/CatalogApplicationModel.js +603 -453
  15. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +64 -64
  16. package/sdk/application/Catalog/CatalogApplicationValidator.js +32 -32
  17. package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
  18. package/sdk/application/Common/CommonApplicationClient.js +2 -2
  19. package/sdk/application/Common/CommonApplicationModel.d.ts +170 -90
  20. package/sdk/application/Common/CommonApplicationModel.js +59 -58
  21. package/sdk/application/Common/CommonApplicationValidator.d.ts +8 -5
  22. package/sdk/application/Common/CommonApplicationValidator.js +3 -3
  23. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +2 -2
  24. package/sdk/application/Communication/CommunicationApplicationClient.js +2 -2
  25. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +170 -35
  26. package/sdk/application/Communication/CommunicationApplicationModel.js +54 -33
  27. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +15 -15
  28. package/sdk/application/Configuration/ConfigurationApplicationClient.js +15 -15
  29. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +624 -443
  30. package/sdk/application/Configuration/ConfigurationApplicationModel.js +259 -248
  31. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +32 -24
  32. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +14 -13
  33. package/sdk/application/Content/ContentApplicationClient.d.ts +16 -16
  34. package/sdk/application/Content/ContentApplicationClient.js +16 -16
  35. package/sdk/application/Content/ContentApplicationModel.d.ts +1206 -281
  36. package/sdk/application/Content/ContentApplicationModel.js +342 -276
  37. package/sdk/application/Content/ContentApplicationValidator.d.ts +28 -17
  38. package/sdk/application/Content/ContentApplicationValidator.js +11 -10
  39. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
  40. package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
  41. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +146 -37
  42. package/sdk/application/FileStorage/FileStorageApplicationModel.js +38 -36
  43. package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
  44. package/sdk/application/Lead/LeadApplicationClient.js +3 -3
  45. package/sdk/application/Lead/LeadApplicationModel.d.ts +195 -134
  46. package/sdk/application/Lead/LeadApplicationModel.js +110 -67
  47. package/sdk/application/Lead/LeadApplicationValidator.d.ts +8 -8
  48. package/sdk/application/Lead/LeadApplicationValidator.js +4 -4
  49. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -10
  50. package/sdk/application/Logistic/LogisticApplicationClient.js +10 -10
  51. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +1039 -221
  52. package/sdk/application/Logistic/LogisticApplicationModel.js +342 -199
  53. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +76 -82
  54. package/sdk/application/Logistic/LogisticApplicationValidator.js +38 -41
  55. package/sdk/application/Order/OrderApplicationClient.d.ts +10 -10
  56. package/sdk/application/Order/OrderApplicationClient.js +10 -10
  57. package/sdk/application/Order/OrderApplicationModel.d.ts +1401 -324
  58. package/sdk/application/Order/OrderApplicationModel.js +392 -316
  59. package/sdk/application/Order/OrderApplicationValidator.d.ts +32 -30
  60. package/sdk/application/Order/OrderApplicationValidator.js +15 -14
  61. package/sdk/application/Payment/PaymentApplicationClient.d.ts +43 -43
  62. package/sdk/application/Payment/PaymentApplicationClient.js +43 -43
  63. package/sdk/application/Payment/PaymentApplicationModel.d.ts +1111 -1022
  64. package/sdk/application/Payment/PaymentApplicationModel.js +537 -521
  65. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +82 -49
  66. package/sdk/application/Payment/PaymentApplicationValidator.js +30 -30
  67. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +28 -7
  68. package/sdk/application/Rewards/RewardsApplicationModel.js +7 -7
  69. package/sdk/application/Share/ShareApplicationModel.d.ts +178 -38
  70. package/sdk/application/Share/ShareApplicationModel.js +53 -37
  71. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -2
  72. package/sdk/application/Share/ShareApplicationValidator.js +2 -1
  73. package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
  74. package/sdk/application/Theme/ThemeApplicationClient.js +14 -8
  75. package/sdk/application/Theme/ThemeApplicationModel.d.ts +528 -287
  76. package/sdk/application/Theme/ThemeApplicationModel.js +208 -172
  77. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +17 -12
  78. package/sdk/application/Theme/ThemeApplicationValidator.js +8 -6
  79. package/sdk/application/User/UserApplicationClient.d.ts +36 -36
  80. package/sdk/application/User/UserApplicationClient.js +36 -36
  81. package/sdk/application/User/UserApplicationModel.d.ts +1062 -255
  82. package/sdk/application/User/UserApplicationModel.js +298 -244
  83. package/sdk/application/User/UserApplicationValidator.d.ts +80 -80
  84. package/sdk/application/User/UserApplicationValidator.js +40 -40
  85. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
  86. package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
  87. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +20 -5
  88. package/sdk/application/Webhook/WebhookApplicationModel.js +5 -5
  89. package/sdk/common/Clickstream.js +95 -15
  90. package/sdk/common/Constant.d.ts +9 -0
  91. package/sdk/common/Constant.js +11 -0
  92. package/sdk/common/Utility.js +19 -0
  93. package/sdk/common/utils.js +8 -1
  94. package/sdk/partner/Lead/LeadPartnerModel.d.ts +28 -7
  95. package/sdk/partner/Lead/LeadPartnerModel.js +7 -7
  96. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +75 -8
  97. package/sdk/partner/Logistics/LogisticsPartnerModel.js +59 -7
  98. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +2 -2
  99. package/sdk/partner/PartnerClient.d.ts +8 -0
  100. package/sdk/partner/PartnerClient.js +14 -0
  101. package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -0
  102. package/sdk/partner/Theme/ThemePartnerClient.js +158 -0
  103. package/sdk/partner/Theme/ThemePartnerModel.d.ts +45 -6
  104. package/sdk/partner/Theme/ThemePartnerModel.js +33 -4
  105. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
  106. package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
  107. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +28 -7
  108. package/sdk/partner/Webhook/WebhookPartnerModel.js +7 -7
  109. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +28 -7
  110. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +7 -7
  111. package/sdk/platform/Billing/BillingPlatformClient.d.ts +21 -10
  112. package/sdk/platform/Billing/BillingPlatformClient.js +167 -83
  113. package/sdk/platform/Billing/BillingPlatformModel.d.ts +2849 -565
  114. package/sdk/platform/Billing/BillingPlatformModel.js +935 -556
  115. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +30 -14
  116. package/sdk/platform/Billing/BillingPlatformValidator.js +31 -16
  117. package/sdk/platform/Cart/CartPlatformModel.d.ts +28 -7
  118. package/sdk/platform/Cart/CartPlatformModel.js +8 -8
  119. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
  120. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +20 -0
  121. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +37 -0
  122. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +16 -0
  123. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +12 -2
  124. package/sdk/platform/Catalog/CatalogPlatformClient.js +41 -1
  125. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +46 -12
  126. package/sdk/platform/Catalog/CatalogPlatformModel.js +14 -11
  127. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +40 -0
  128. package/sdk/platform/Catalog/CatalogPlatformValidator.js +17 -0
  129. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +28 -7
  130. package/sdk/platform/Communication/CommunicationPlatformModel.js +7 -7
  131. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -7
  132. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +7 -7
  133. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +0 -97
  134. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +77 -782
  135. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +24 -701
  136. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +7 -539
  137. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -183
  138. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +0 -134
  139. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -10
  140. package/sdk/platform/Content/ContentPlatformApplicationClient.js +0 -79
  141. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -15
  142. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -13
  143. package/sdk/platform/Content/ContentPlatformModel.d.ts +60 -17
  144. package/sdk/platform/Content/ContentPlatformModel.js +30 -15
  145. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +28 -7
  146. package/sdk/platform/Discount/DiscountPlatformModel.js +7 -7
  147. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +127 -25
  148. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +37 -25
  149. package/sdk/platform/Finance/FinancePlatformClient.d.ts +30 -30
  150. package/sdk/platform/Finance/FinancePlatformClient.js +30 -30
  151. package/sdk/platform/Finance/FinancePlatformModel.d.ts +1601 -348
  152. package/sdk/platform/Finance/FinancePlatformModel.js +488 -352
  153. package/sdk/platform/Lead/LeadPlatformModel.d.ts +28 -7
  154. package/sdk/platform/Lead/LeadPlatformModel.js +7 -7
  155. package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -0
  156. package/sdk/platform/Order/OrderPlatformClient.js +165 -0
  157. package/sdk/platform/Order/OrderPlatformModel.d.ts +631 -39
  158. package/sdk/platform/Order/OrderPlatformModel.js +367 -41
  159. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -1
  160. package/sdk/platform/Order/OrderPlatformValidator.js +28 -0
  161. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +30 -9
  162. package/sdk/platform/Payment/PaymentPlatformModel.js +9 -9
  163. package/sdk/platform/PlatformClient.d.ts +8 -0
  164. package/sdk/platform/PlatformClient.js +14 -0
  165. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +28 -7
  166. package/sdk/platform/Rewards/RewardsPlatformModel.js +7 -7
  167. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +12 -9
  168. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +12 -9
  169. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -1
  170. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +4 -4
  171. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +139 -22
  172. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +98 -21
  173. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
  174. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
  175. package/sdk/platform/Share/SharePlatformModel.d.ts +28 -7
  176. package/sdk/platform/Share/SharePlatformModel.js +7 -7
  177. package/sdk/platform/Theme/ThemePlatformModel.d.ts +18 -5
  178. package/sdk/platform/Theme/ThemePlatformModel.js +7 -4
  179. package/sdk/platform/User/UserPlatformModel.d.ts +18 -20
  180. package/sdk/platform/User/UserPlatformModel.js +9 -11
  181. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +54 -33
  182. package/sdk/platform/Webhook/WebhookPlatformModel.js +33 -33
  183. package/sdk/public/Billing/BillingPublicClient.d.ts +11 -0
  184. package/sdk/public/Billing/BillingPublicClient.js +80 -0
  185. package/sdk/public/Billing/BillingPublicModel.d.ts +584 -99
  186. package/sdk/public/Billing/BillingPublicModel.js +252 -87
  187. package/sdk/public/Billing/BillingPublicValidator.d.ts +10 -1
  188. package/sdk/public/Billing/BillingPublicValidator.js +12 -0
  189. package/sdk/public/PublicClient.d.ts +0 -2
  190. package/sdk/public/PublicClient.js +0 -4
  191. package/sdk/public/index.d.ts +0 -1
  192. package/sdk/public/index.js +0 -2
  193. package/sdk/public/Inventory/InventoryPublicClient.d.ts +0 -87
  194. package/sdk/public/Inventory/InventoryPublicClient.js +0 -529
  195. package/sdk/public/Inventory/InventoryPublicModel.d.ts +0 -393
  196. package/sdk/public/Inventory/InventoryPublicModel.js +0 -448
  197. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +0 -91
  198. package/sdk/public/Inventory/InventoryPublicValidator.js +0 -85
@@ -1,11 +1,11 @@
1
1
  export = OrderApplicationValidator;
2
2
  /**
3
3
  * @typedef GetCustomerDetailsByShipmentIdParam
4
- * @property {string} orderId - ID of the shipment. An order may contain
4
+ * @property {string} orderId - A unique number used for identifying and
5
+ * tracking your orders.
6
+ * @property {string} shipmentId - ID of the shipment. An order may contain
5
7
  * multiple items and may get divided into one or more shipment, each having
6
8
  * its own ID.
7
- * @property {string} shipmentId - A unique number used for identifying and
8
- * tracking your orders.
9
9
  */
10
10
  /**
11
11
  * @typedef GetInvoiceByShipmentIdParam
@@ -15,38 +15,39 @@ export = OrderApplicationValidator;
15
15
  * @typedef GetOrderByIdParam
16
16
  * @property {string} orderId - A unique number used for identifying and
17
17
  * tracking an order.
18
- * @property {boolean} [allowInactive] - Flag to allow inactive shipments
18
+ * @property {boolean} [allowInactive] - Flag to allow inactive shipments.
19
19
  */
20
20
  /**
21
21
  * @typedef GetOrdersParam
22
22
  * @property {number} [status] - A filter to retrieve orders by their current
23
- * status such as _placed_, _delivered_, etc.
23
+ * status such as 'placed', 'delivered' etc.
24
24
  * @property {number} [pageNo] - The page number to navigate through the given
25
25
  * set of results. Default value is 1.
26
26
  * @property {number} [pageSize] - The number of items to retrieve in each page.
27
27
  * Default value is 10.
28
28
  * @property {string} [fromDate] - The date from which the orders should be retrieved.
29
29
  * @property {string} [toDate] - The date till which the orders should be retrieved.
30
- * @property {string} [startDate] - UTC Start Date in ISO format
31
- * @property {string} [endDate] - UTC Start Date in ISO format
30
+ * @property {string} [startDate] - Start date in UTC (ISO-8601 format).
31
+ * @property {string} [endDate] - End date in UTC (ISO-8601 format).
32
32
  * @property {string} [customMeta] - A filter and retrieve data using special
33
- * fields included for special use-cases
33
+ * fields included for special use-cases.
34
34
  * @property {boolean} [allowInactive] - Flag indicating whether inactive
35
- * shipments are allowed
35
+ * shipments are allowed.
36
36
  */
37
37
  /**
38
38
  * @typedef GetShipmentBagReasonsParam
39
- * @property {string} shipmentId - ID of the bag. An order may contain multiple
40
- * items and may get divided into one or more shipment, each having its own ID.
41
- * @property {string} bagId - ID of the bag. An order may contain multiple items
42
- * and may get divided into one or more shipment, each having its own ID.
39
+ * @property {string} shipmentId - ID of the shipment. An order may contain
40
+ * multiple items and may get divided into one or more shipment, each having
41
+ * its own ID.
42
+ * @property {string} bagId - ID of the bag. An shipment may contain multiple
43
+ * items and may get divided into one or more bags, each having its own ID.
43
44
  */
44
45
  /**
45
46
  * @typedef GetShipmentByIdParam
46
47
  * @property {string} shipmentId - ID of the shipment. An order may contain
47
48
  * multiple items and may get divided into one or more shipment, each having
48
49
  * its own ID.
49
- * @property {boolean} [allowInactive] - Flag to allow inactive shipments
50
+ * @property {boolean} [allowInactive] - Flag to allow inactive shipments.
50
51
  */
51
52
  /**
52
53
  * @typedef GetShipmentReasonsParam
@@ -113,14 +114,14 @@ declare namespace OrderApplicationValidator {
113
114
  }
114
115
  type GetCustomerDetailsByShipmentIdParam = {
115
116
  /**
116
- * - ID of the shipment. An order may contain
117
- * multiple items and may get divided into one or more shipment, each having
118
- * its own ID.
117
+ * - A unique number used for identifying and
118
+ * tracking your orders.
119
119
  */
120
120
  orderId: string;
121
121
  /**
122
- * - A unique number used for identifying and
123
- * tracking your orders.
122
+ * - ID of the shipment. An order may contain
123
+ * multiple items and may get divided into one or more shipment, each having
124
+ * its own ID.
124
125
  */
125
126
  shipmentId: string;
126
127
  };
@@ -137,14 +138,14 @@ type GetOrderByIdParam = {
137
138
  */
138
139
  orderId: string;
139
140
  /**
140
- * - Flag to allow inactive shipments
141
+ * - Flag to allow inactive shipments.
141
142
  */
142
143
  allowInactive?: boolean;
143
144
  };
144
145
  type GetOrdersParam = {
145
146
  /**
146
147
  * - A filter to retrieve orders by their current
147
- * status such as _placed_, _delivered_, etc.
148
+ * status such as 'placed', 'delivered' etc.
148
149
  */
149
150
  status?: number;
150
151
  /**
@@ -166,33 +167,34 @@ type GetOrdersParam = {
166
167
  */
167
168
  toDate?: string;
168
169
  /**
169
- * - UTC Start Date in ISO format
170
+ * - Start date in UTC (ISO-8601 format).
170
171
  */
171
172
  startDate?: string;
172
173
  /**
173
- * - UTC Start Date in ISO format
174
+ * - End date in UTC (ISO-8601 format).
174
175
  */
175
176
  endDate?: string;
176
177
  /**
177
178
  * - A filter and retrieve data using special
178
- * fields included for special use-cases
179
+ * fields included for special use-cases.
179
180
  */
180
181
  customMeta?: string;
181
182
  /**
182
183
  * - Flag indicating whether inactive
183
- * shipments are allowed
184
+ * shipments are allowed.
184
185
  */
185
186
  allowInactive?: boolean;
186
187
  };
187
188
  type GetShipmentBagReasonsParam = {
188
189
  /**
189
- * - ID of the bag. An order may contain multiple
190
- * items and may get divided into one or more shipment, each having its own ID.
190
+ * - ID of the shipment. An order may contain
191
+ * multiple items and may get divided into one or more shipment, each having
192
+ * its own ID.
191
193
  */
192
194
  shipmentId: string;
193
195
  /**
194
- * - ID of the bag. An order may contain multiple items
195
- * and may get divided into one or more shipment, each having its own ID.
196
+ * - ID of the bag. An shipment may contain multiple
197
+ * items and may get divided into one or more bags, each having its own ID.
196
198
  */
197
199
  bagId: string;
198
200
  };
@@ -204,7 +206,7 @@ type GetShipmentByIdParam = {
204
206
  */
205
207
  shipmentId: string;
206
208
  /**
207
- * - Flag to allow inactive shipments
209
+ * - Flag to allow inactive shipments.
208
210
  */
209
211
  allowInactive?: boolean;
210
212
  };
@@ -4,11 +4,11 @@ const OrderApplicationModel = require("./OrderApplicationModel");
4
4
 
5
5
  /**
6
6
  * @typedef GetCustomerDetailsByShipmentIdParam
7
- * @property {string} orderId - ID of the shipment. An order may contain
7
+ * @property {string} orderId - A unique number used for identifying and
8
+ * tracking your orders.
9
+ * @property {string} shipmentId - ID of the shipment. An order may contain
8
10
  * multiple items and may get divided into one or more shipment, each having
9
11
  * its own ID.
10
- * @property {string} shipmentId - A unique number used for identifying and
11
- * tracking your orders.
12
12
  */
13
13
 
14
14
  /**
@@ -20,33 +20,34 @@ const OrderApplicationModel = require("./OrderApplicationModel");
20
20
  * @typedef GetOrderByIdParam
21
21
  * @property {string} orderId - A unique number used for identifying and
22
22
  * tracking an order.
23
- * @property {boolean} [allowInactive] - Flag to allow inactive shipments
23
+ * @property {boolean} [allowInactive] - Flag to allow inactive shipments.
24
24
  */
25
25
 
26
26
  /**
27
27
  * @typedef GetOrdersParam
28
28
  * @property {number} [status] - A filter to retrieve orders by their current
29
- * status such as _placed_, _delivered_, etc.
29
+ * status such as 'placed', 'delivered' etc.
30
30
  * @property {number} [pageNo] - The page number to navigate through the given
31
31
  * set of results. Default value is 1.
32
32
  * @property {number} [pageSize] - The number of items to retrieve in each page.
33
33
  * Default value is 10.
34
34
  * @property {string} [fromDate] - The date from which the orders should be retrieved.
35
35
  * @property {string} [toDate] - The date till which the orders should be retrieved.
36
- * @property {string} [startDate] - UTC Start Date in ISO format
37
- * @property {string} [endDate] - UTC Start Date in ISO format
36
+ * @property {string} [startDate] - Start date in UTC (ISO-8601 format).
37
+ * @property {string} [endDate] - End date in UTC (ISO-8601 format).
38
38
  * @property {string} [customMeta] - A filter and retrieve data using special
39
- * fields included for special use-cases
39
+ * fields included for special use-cases.
40
40
  * @property {boolean} [allowInactive] - Flag indicating whether inactive
41
- * shipments are allowed
41
+ * shipments are allowed.
42
42
  */
43
43
 
44
44
  /**
45
45
  * @typedef GetShipmentBagReasonsParam
46
- * @property {string} shipmentId - ID of the bag. An order may contain multiple
47
- * items and may get divided into one or more shipment, each having its own ID.
48
- * @property {string} bagId - ID of the bag. An order may contain multiple items
49
- * and may get divided into one or more shipment, each having its own ID.
46
+ * @property {string} shipmentId - ID of the shipment. An order may contain
47
+ * multiple items and may get divided into one or more shipment, each having
48
+ * its own ID.
49
+ * @property {string} bagId - ID of the bag. An shipment may contain multiple
50
+ * items and may get divided into one or more bags, each having its own ID.
50
51
  */
51
52
 
52
53
  /**
@@ -54,7 +55,7 @@ const OrderApplicationModel = require("./OrderApplicationModel");
54
55
  * @property {string} shipmentId - ID of the shipment. An order may contain
55
56
  * multiple items and may get divided into one or more shipment, each having
56
57
  * its own ID.
57
- * @property {boolean} [allowInactive] - Flag to allow inactive shipments
58
+ * @property {boolean} [allowInactive] - Flag to allow inactive shipments.
58
59
  */
59
60
 
60
61
  /**
@@ -60,7 +60,7 @@ declare class Payment {
60
60
  * Success response
61
61
  * @name addBeneficiaryDetails
62
62
  * @summary: Add beneficiary for refund
63
- * @description: Adds beneficiary details specifically for refund transactions, including account holder name, account number and bank details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/addBeneficiaryDetails/).
63
+ * @description: Add beneficiary details specifically for refund transactions, including account holder name, account number and bank details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/addBeneficiaryDetails/).
64
64
  */
65
65
  addBeneficiaryDetails({ body, requestHeaders }?: PaymentApplicationValidator.AddBeneficiaryDetailsParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.RefundAccountResponse>;
66
66
  /**
@@ -73,7 +73,7 @@ declare class Payment {
73
73
  * Success response
74
74
  * @name addRefundBankAccountUsingOTP
75
75
  * @summary: Add refund account using OTP verification
76
- * @description: The addition of a bank account specifically for refunds, employing OTP verification for security - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/addRefundBankAccountUsingOTP/).
76
+ * @description: Add bank account specifically for refunds, employing OTP verification for security. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/addRefundBankAccountUsingOTP/).
77
77
  */
78
78
  addRefundBankAccountUsingOTP({ body, requestHeaders }?: PaymentApplicationValidator.AddRefundBankAccountUsingOTPParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.RefundAccountResponse>;
79
79
  /**
@@ -83,7 +83,7 @@ declare class Payment {
83
83
  * @returns {Promise<PaymentApplicationModel.AttachCardsResponse>} - Success response
84
84
  * @name attachCardToCustomer
85
85
  * @summary: Link payment card to customer
86
- * @description: Linking of a payment card to a user's account for seamless transactions. Upon successful linking, the card becomes associated with the user's profile, enabling secure and convenient payments - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/attachCardToCustomer/).
86
+ * @description: Link payment card to a user account for seamless transactions. Upon successful linking, the card becomes associated with the user's profile, enabling secure and convenient payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/attachCardToCustomer/).
87
87
  */
88
88
  attachCardToCustomer({ body, requestHeaders }?: PaymentApplicationValidator.AttachCardToCustomerParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.AttachCardsResponse>;
89
89
  /**
@@ -94,7 +94,7 @@ declare class Payment {
94
94
  * Success response
95
95
  * @name cancelPaymentLink
96
96
  * @summary: Cancel payment link
97
- * @description: Cancels a previously generated payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/cancelPaymentLink/).
97
+ * @description: Cancel previously generated payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/cancelPaymentLink/).
98
98
  */
99
99
  cancelPaymentLink({ body, requestHeaders }?: PaymentApplicationValidator.CancelPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.CancelPaymentLinkResponse>;
100
100
  /**
@@ -104,7 +104,7 @@ declare class Payment {
104
104
  * @returns {Promise<PaymentApplicationModel.CardDetailsResponse>} - Success response
105
105
  * @name cardDetails
106
106
  * @summary: Get card details
107
- * @description: Fetches the details of a specified payment card, including information such as the card type, brand, country, and expiration date. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/cardDetails/).
107
+ * @description: Get details of a specified payment card, including information such as the card type, brand, country, and expiration date. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/cardDetails/).
108
108
  */
109
109
  cardDetails({ cardInfo, aggregator, requestHeaders }?: PaymentApplicationValidator.CardDetailsParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.CardDetailsResponse>;
110
110
  /**
@@ -132,7 +132,7 @@ declare class Payment {
132
132
  *
133
133
  * @name checkAndUpdatePaymentStatusPaymentLink
134
134
  * @summary: Update payment link status
135
- * @description: Verifies and updates the status of a payment made through a link.Upon successful verification and update, the response includes details about the aggregator name, payment status, and whether retrying the process is required. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/checkAndUpdatePaymentStatusPaymentLink/).
135
+ * @description: Verify and update status of a payment made through a link.Upon successful verification and update, the response includes details about the aggregator name, payment status, and whether retrying the process is required. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/checkAndUpdatePaymentStatusPaymentLink/).
136
136
  */
137
137
  checkAndUpdatePaymentStatusPaymentLink({ body, requestHeaders }?: PaymentApplicationValidator.CheckAndUpdatePaymentStatusPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PaymentStatusUpdateResponse>;
138
138
  /**
@@ -142,7 +142,7 @@ declare class Payment {
142
142
  * @returns {Promise<PaymentApplicationModel.CheckCreditResponse>} - Success response
143
143
  * @name checkCredit
144
144
  * @summary: Verify credit availability and status
145
- * @description: Checks the availability and status of customer credit, providing the status of payment along with registration information and signup URL if the customer is not registered. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/checkCredit/).
145
+ * @description: Check the availability and status of customer credit, providing the status of payment along with registration information and signup URL if the customer is not registered. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/checkCredit/).
146
146
  */
147
147
  checkCredit({ aggregator, requestHeaders }?: PaymentApplicationValidator.CheckCreditParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.CheckCreditResponse>;
148
148
  /**
@@ -155,7 +155,7 @@ declare class Payment {
155
155
  * Success response
156
156
  * @name createOrderHandlerPaymentLink
157
157
  * @summary: Create order for payment via link
158
- * @description: Initiates the creation of an order handler for processing payments through a link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/createOrderHandlerPaymentLink/).
158
+ * @description: Initiate the creation of an order handler for processing payments through a link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/createOrderHandlerPaymentLink/).
159
159
  */
160
160
  createOrderHandlerPaymentLink({ body, requestHeaders }?: PaymentApplicationValidator.CreateOrderHandlerPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.CreateOrderUserResponse>;
161
161
  /**
@@ -166,7 +166,7 @@ declare class Payment {
166
166
  * Success response
167
167
  * @name createPaymentLink
168
168
  * @summary: Create payment link
169
- * @description: Generates a new payment link for transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/createPaymentLink/).
169
+ * @description: Create new payment link for transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/createPaymentLink/).
170
170
  */
171
171
  createPaymentLink({ body, requestHeaders }?: PaymentApplicationValidator.CreatePaymentLinkParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.CreatePaymentLinkResponse>;
172
172
  /**
@@ -176,7 +176,7 @@ declare class Payment {
176
176
  * @returns {Promise<PaymentApplicationModel.PaymentOrderResponse>} - Success response
177
177
  * @name createPaymentOrder
178
178
  * @summary: Create Order
179
- * @description: Create an order and payment on the aggregator side - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/createPaymentOrder/).
179
+ * @description: Create an order and payment on the aggregator side. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/createPaymentOrder/).
180
180
  */
181
181
  createPaymentOrder({ body, requestHeaders }?: PaymentApplicationValidator.CreatePaymentOrderParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PaymentOrderResponse>;
182
182
  /**
@@ -188,7 +188,7 @@ declare class Payment {
188
188
  *
189
189
  * @name customerCreditSummary
190
190
  * @summary: Credit summary
191
- * @description: Fetches a summary of the customer's credit information, including details such as merchant customer reference ID, status, balance, limit, due amount, used amount, due date, days overdue, total due amount, and a repayment URL. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/customerCreditSummary/).
191
+ * @description: Get summary of the customer's credit information, including details such as merchant customer reference ID, status, balance, limit, due amount, used amount, due date, days overdue, total due amount, and a repayment URL. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/customerCreditSummary/).
192
192
  */
193
193
  customerCreditSummary({ aggregator, requestHeaders }?: PaymentApplicationValidator.CustomerCreditSummaryParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.CustomerCreditSummaryResponse>;
194
194
  /**
@@ -199,7 +199,7 @@ declare class Payment {
199
199
  * Success response
200
200
  * @name customerOnboard
201
201
  * @summary: Onboard customer for payment
202
- * @description: Initiates the onboarding process for payment services, providing personal, business, and device information, along with marketplace details, to enable customer registration and credit availability. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/customerOnboard/).
202
+ * @description: Initiate the onboarding process for payment services, providing personal, business, and device information, along with marketplace details, to enable customer registration and credit availability. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/customerOnboard/).
203
203
  */
204
204
  customerOnboard({ body, requestHeaders }?: PaymentApplicationValidator.CustomerOnboardParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.CustomerOnboardingResponse>;
205
205
  /**
@@ -209,7 +209,7 @@ declare class Payment {
209
209
  * @returns {Promise<PaymentApplicationModel.DeleteCardsResponse>} - Success response
210
210
  * @name deleteUserCard
211
211
  * @summary: Delete customer card
212
- * @description: Deletion of a payment card from the user's account - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/deleteUserCard/).
212
+ * @description: Delete payment card from the user's account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/deleteUserCard/).
213
213
  */
214
214
  deleteUserCard({ body, requestHeaders }?: PaymentApplicationValidator.DeleteUserCardParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.DeleteCardsResponse>;
215
215
  /**
@@ -219,7 +219,7 @@ declare class Payment {
219
219
  * @returns {Promise<PaymentApplicationModel.WalletResponseSchema>} - Success response
220
220
  * @name delinkWallet
221
221
  * @summary: Delink the wallet
222
- * @description: User removes already linked wallet. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/delinkWallet/).
222
+ * @description: Delink the wallet. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/delinkWallet/).
223
223
  */
224
224
  delinkWallet({ body, requestHeaders }?: PaymentApplicationValidator.DelinkWalletParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.WalletResponseSchema>;
225
225
  /**
@@ -233,7 +233,7 @@ declare class Payment {
233
233
  *
234
234
  * @name enableOrDisableRefundTransferMode
235
235
  * @summary: Toggle refund mode
236
- * @description: Enables or disables a particular refund transfer mode based on the request body parameters, indicating whether the mode should be enabled or disabled - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/enableOrDisableRefundTransferMode/).
236
+ * @description: Enable/Disable a particular refund transfer mode based on the request body parameters, indicating whether the mode should be enabled or disabled. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/enableOrDisableRefundTransferMode/).
237
237
  */
238
238
  enableOrDisableRefundTransferMode({ body, requestHeaders }?: PaymentApplicationValidator.EnableOrDisableRefundTransferModeParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.UpdateRefundTransferModeResponse>;
239
239
  /**
@@ -245,7 +245,7 @@ declare class Payment {
245
245
  *
246
246
  * @name getActiveCardAggregator
247
247
  * @summary: Retrieve active card aggregator
248
- * @description: Fetches details about the active card aggregator used by the user, including the aggregator's name.You can refresh the data by setting the "refresh" parameter to true if needed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getActiveCardAggregator/).
248
+ * @description: Get details about the active card aggregator used by the user, including the aggregator name.You can refresh the data by setting the 'refresh' parameter to true if needed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getActiveCardAggregator/).
249
249
  */
250
250
  getActiveCardAggregator({ refresh, requestHeaders }?: PaymentApplicationValidator.GetActiveCardAggregatorParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.ActiveCardPaymentGatewayResponse>;
251
251
  /**
@@ -257,7 +257,7 @@ declare class Payment {
257
257
  * @returns {Promise<PaymentApplicationModel.TransferModeResponse>} - Success response
258
258
  * @name getActiveRefundTransferModes
259
259
  * @summary: Get refund transfer modes
260
- * @description: Lists the available refund modes, such as UPI, providing details like display name, logo, and ID for each mode - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getActiveRefundTransferModes/).
260
+ * @description: Lists available refund modes, such as UPI, providing details like display name, logo, and ID for each mode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getActiveRefundTransferModes/).
261
261
  */
262
262
  getActiveRefundTransferModes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentApplicationModel.TransferModeResponse>;
263
263
  /**
@@ -267,7 +267,7 @@ declare class Payment {
267
267
  * @returns {Promise<PaymentApplicationModel.ListCardsResponse>} - Success response
268
268
  * @name getActiveUserCards
269
269
  * @summary: Get customer cards
270
- * @description: Retrieves a list of all active cards saved by the user.Includes details such as the card's aggregator name, card ID, token, reference, number, expiration date, type, issuer, brand, nickname, and whether it has expired. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getActiveUserCards/).
270
+ * @description: List all active cards saved by the user.Includes details such as the card's aggregator name, card ID, token, reference, number, expiration date, type, issuer, brand, nickname, and whether it has expired. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getActiveUserCards/).
271
271
  */
272
272
  getActiveUserCards({ forceRefresh, requestHeaders }?: PaymentApplicationValidator.GetActiveUserCardsParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.ListCardsResponse>;
273
273
  /**
@@ -279,7 +279,7 @@ declare class Payment {
279
279
  *
280
280
  * @name getAggregatorsConfig
281
281
  * @summary: Get payment aggregators
282
- * @description: Retrieve the aggregator secret key of all payment gateways utilized for payments when using the SDK for the payment gateway - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getAggregatorsConfig/).
282
+ * @description: Get aggregator secret key of all payment gateways utilized for payments when using the SDK for the payment gateway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getAggregatorsConfig/).
283
283
  */
284
284
  getAggregatorsConfig({ xApiToken, refresh, requestHeaders }?: PaymentApplicationValidator.GetAggregatorsConfigParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.AggregatorsConfigDetailResponse>;
285
285
  /**
@@ -292,7 +292,7 @@ declare class Payment {
292
292
  * Success response
293
293
  * @name getEpaylaterBannerDetails
294
294
  * @summary: Epaylater banner info
295
- * @description: Retrieves details required to display the Epaylater payment banner. It provides information about the banner's display status, along with relevant messages and the user's registration status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getEpaylaterBannerDetails/).
295
+ * @description: Get Epaylater payment banner details. It provides information about the banner's display status, along with relevant messages and the user's registration status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getEpaylaterBannerDetails/).
296
296
  */
297
297
  getEpaylaterBannerDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentApplicationModel.EpaylaterBannerResponse>;
298
298
  /**
@@ -305,7 +305,7 @@ declare class Payment {
305
305
  * Success response
306
306
  * @name getOrderBeneficiariesDetail
307
307
  * @summary: Retrieve beneficiary details
308
- * @description: Retrieve beneficiary details like bank name , ifsc code , branch name associated with a specific order for refund processing - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getOrderBeneficiariesDetail/).
308
+ * @description: Get beneficiary details like bank name , ifsc code , branch name associated with a specific order for refund processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getOrderBeneficiariesDetail/).
309
309
  */
310
310
  getOrderBeneficiariesDetail({ orderId, requestHeaders }?: PaymentApplicationValidator.GetOrderBeneficiariesDetailParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.OrderBeneficiaryResponse>;
311
311
  /**
@@ -316,7 +316,7 @@ declare class Payment {
316
316
  * Success response
317
317
  * @name getPaymentLink
318
318
  * @summary: Get payment link
319
- * @description: Retrieves a generated payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPaymentLink/).
319
+ * @description: Get a generated payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPaymentLink/).
320
320
  */
321
321
  getPaymentLink({ paymentLinkId, requestHeaders }?: PaymentApplicationValidator.GetPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.GetPaymentLinkResponse>;
322
322
  /**
@@ -327,7 +327,7 @@ declare class Payment {
327
327
  * Success response
328
328
  * @name getPaymentModeRoutes
329
329
  * @summary: Get payment modes
330
- * @description: Available payment methods on the payment page, specifying the aggregator for each option, such as 'Netbanking powered by Juspay' and 'Card powered by Razorpay'. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPaymentModeRoutes/).
330
+ * @description: Get available payment methods on the payment page, specifying the aggregator for each option, such as 'Netbanking powered by Juspay' and 'Card powered by Razorpay'. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPaymentModeRoutes/).
331
331
  */
332
332
  getPaymentModeRoutes({ amount, cartId, checkoutMode, refresh, orderId, cardReference, userDetails, displaySplit, advancePayment, shipmentId, requestHeaders, }?: PaymentApplicationValidator.GetPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PaymentModeRouteResponse>;
333
333
  /**
@@ -340,7 +340,7 @@ declare class Payment {
340
340
  * Success response
341
341
  * @name getPaymentModeRoutesPaymentLink
342
342
  * @summary: Payment modes for payment link
343
- * @description: Lists payment modes available for a given payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPaymentModeRoutesPaymentLink/).
343
+ * @description: List payment modes available for a given payment link. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPaymentModeRoutesPaymentLink/).
344
344
  */
345
345
  getPaymentModeRoutesPaymentLink({ paymentLinkId, requestHeaders }?: PaymentApplicationValidator.GetPaymentModeRoutesPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PaymentModeRouteResponse>;
346
346
  /**
@@ -351,7 +351,7 @@ declare class Payment {
351
351
  * Success response
352
352
  * @name getPosPaymentModeRoutes
353
353
  * @summary: POS payment modes
354
- * @description: Available payment methods on the payment page for POS, specifying the aggregator for each option, such as 'CARD powered by Juspay' and 'QR powered by Razorpay'. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPosPaymentModeRoutes/).
354
+ * @description: Get available payment methods on the payment page for POS, specifying the aggregator for each option, such as 'CARD powered by Juspay' and 'QR powered by Razorpay'. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getPosPaymentModeRoutes/).
355
355
  */
356
356
  getPosPaymentModeRoutes({ amount, pincode, orderType, cartId, checkoutMode, refresh, cardReference, userDetails, requestHeaders, }?: PaymentApplicationValidator.GetPosPaymentModeRoutesParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PaymentModeRouteResponse>;
357
357
  /**
@@ -361,7 +361,7 @@ declare class Payment {
361
361
  * @returns {Promise<PaymentApplicationModel.RupifiBannerResponse>} - Success response
362
362
  * @name getRupifiBannerDetails
363
363
  * @summary: Rupifi banner info
364
- * @description: Retrieves details necessary for displaying the Rupifi payment banner. It provides information such as the KYC URL and the current status of the Rupifi payment banner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getRupifiBannerDetails/).
364
+ * @description: Get Rupifi payment banner details. It provides information such as the KYC URL and the current status of the Rupifi payment banner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getRupifiBannerDetails/).
365
365
  */
366
366
  getRupifiBannerDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentApplicationModel.RupifiBannerResponse>;
367
367
  /**
@@ -374,7 +374,7 @@ declare class Payment {
374
374
  * Success response
375
375
  * @name getUserBeneficiariesDetail
376
376
  * @summary: Retrieve beneficiary details
377
- * @description: Retrieves information about beneficiaries associated with the user for processing refunds, based on the provided order ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getUserBeneficiariesDetail/).
377
+ * @description: Get beneficiaries associated with the user for processing refunds, based on the provided order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/getUserBeneficiariesDetail/).
378
378
  */
379
379
  getUserBeneficiariesDetail({ orderId, requestHeaders }?: PaymentApplicationValidator.GetUserBeneficiariesDetailParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.OrderBeneficiaryResponse>;
380
380
  /**
@@ -386,7 +386,7 @@ declare class Payment {
386
386
  *
387
387
  * @name initialisePayment
388
388
  * @summary: Start payment process
389
- * @description: Initiates the payment procedure for an order.Upon successful initiation, it returns a details including the success status, aggregator information, payment method, status, merchant order ID aggregator order , polling URL, timeout, virtual ID, Razorpay payment ID, customer ID, and device ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/initialisePayment/).
389
+ * @description: Initiate the payment procedure for an order. Upon successful initiation, it returns a details including the success status, aggregator information, payment method, status, merchant order ID aggregator order , polling URL, timeout, virtual ID, Razorpay payment ID, customer ID, and device ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/initialisePayment/).
390
390
  */
391
391
  initialisePayment({ body, requestHeaders }?: PaymentApplicationValidator.InitialisePaymentParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PaymentInitializationResponse>;
392
392
  /**
@@ -400,7 +400,7 @@ declare class Payment {
400
400
  *
401
401
  * @name initialisePaymentPaymentLink
402
402
  * @summary: Initialize payment link
403
- * @description: Begins the payment process for an order by initializing it through a payment link.Upon successful initialization, the response includes details about the payment status, aggregator details, order IDs, polling URL for status updates, and other relevant information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/initialisePaymentPaymentLink/).
403
+ * @description: Begin payment process for an order by initializing it through a payment link.Upon successful initialization, the response includes details about the payment status, aggregator details, order IDs, polling URL for status updates, and other relevant information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/initialisePaymentPaymentLink/).
404
404
  */
405
405
  initialisePaymentPaymentLink({ body, requestHeaders }?: PaymentApplicationValidator.InitialisePaymentPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PaymentInitializationResponse>;
406
406
  /**
@@ -410,7 +410,7 @@ declare class Payment {
410
410
  * @returns {Promise<PaymentApplicationModel.WalletResponseSchema>} - Success response
411
411
  * @name linkWallet
412
412
  * @summary: OTP verification
413
- * @description: Verifies the linking of wallet using OTP for further processing of payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/linkWallet/).
413
+ * @description: Verify the linking of wallet using OTP for further processing of payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/linkWallet/).
414
414
  */
415
415
  linkWallet({ body, requestHeaders }?: PaymentApplicationValidator.LinkWalletParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.WalletResponseSchema>;
416
416
  /**
@@ -422,7 +422,7 @@ declare class Payment {
422
422
  *
423
423
  * @name outstandingOrderDetails
424
424
  * @summary: Outstanding orders
425
- * @description: Retrieve details of orders with outstanding payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/outstandingOrderDetails/).
425
+ * @description: Get details of orders with outstanding payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/outstandingOrderDetails/).
426
426
  */
427
427
  outstandingOrderDetails({ aggregator, requestHeaders }?: PaymentApplicationValidator.OutstandingOrderDetailsParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.OutstandingOrderDetailsResponse>;
428
428
  /**
@@ -433,7 +433,7 @@ declare class Payment {
433
433
  * Success response
434
434
  * @name paidOrderDetails
435
435
  * @summary: Retrieve details of paid orders
436
- * @description: Retrieves details of orders that have been paid for, including shipment ID, order ID, due date, payment date, amount, and transaction ID, based on the aggregator's merchant user ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/paidOrderDetails/).
436
+ * @description: Get details of orders that have been paid for, including shipment ID, order ID, due date, payment date, amount, and transaction ID, based on the aggregator merchant user ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/paidOrderDetails/).
437
437
  */
438
438
  paidOrderDetails({ aggregator, requestHeaders }?: PaymentApplicationValidator.PaidOrderDetailsParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PaidOrderDetailsResponse>;
439
439
  /**
@@ -444,7 +444,7 @@ declare class Payment {
444
444
  * Success response
445
445
  * @name pollingPaymentLink
446
446
  * @summary: Poll status of payment link
447
- * @description: Periodically checks the status of a payment link to monitor for any updates or changes.retrieve real-time information about the payment link's current status, such as whether it has been processed, cancelled, or expired. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/pollingPaymentLink/).
447
+ * @description: Get real-time information about the payment link's current status, such as whether it has been processed, cancelled, or expired. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/pollingPaymentLink/).
448
448
  */
449
449
  pollingPaymentLink({ paymentLinkId, requestHeaders }?: PaymentApplicationValidator.PollingPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.PollingPaymentLinkResponse>;
450
450
  /**
@@ -456,7 +456,7 @@ declare class Payment {
456
456
  *
457
457
  * @name redirectToAggregator
458
458
  * @summary: Redirects users to the payment aggregator's interface
459
- * @description: Redirects users to the payment aggregator's interface and provides necessary parameters such as the callback URL and aggregator name. Returns the status of the payment along with the redirect URL and signup URL. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/redirectToAggregator/).
459
+ * @description: Get details about the active card aggregator used by the user, including the aggregator's name. You can refresh the data by setting the 'refresh' parameter to true if needed. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/redirectToAggregator/).
460
460
  */
461
461
  redirectToAggregator({ source, aggregator, requestHeaders }?: PaymentApplicationValidator.RedirectToAggregatorParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.RedirectToAggregatorResponse>;
462
462
  /**
@@ -466,7 +466,7 @@ declare class Payment {
466
466
  * @returns {Promise<PaymentApplicationModel.renderHTMLResponse>} - Success response
467
467
  * @name renderHTML
468
468
  * @summary: Render HTML
469
- * @description: Render HTML for a payment aggregator page - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/renderHTML/).
469
+ * @description: Render HTML for a payment aggregator page. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/renderHTML/).
470
470
  */
471
471
  renderHTML({ body, requestHeaders }?: PaymentApplicationValidator.RenderHTMLParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.renderHTMLResponse>;
472
472
  /**
@@ -478,7 +478,7 @@ declare class Payment {
478
478
  *
479
479
  * @name resendOrCancelPayment
480
480
  * @summary: Resend or cancel a pending payment transaction
481
- * @description: Enable you to perform actions related to the resending and cancellation of payment links through SMS or E-mail. Resend or cancel payment link that have been initiated but may require modification or cancellation for various reasons, ensuring flexibility and control in payment processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/resendOrCancelPayment/).
481
+ * @description: Resend or cancel payment link that have been initiated but may require modification or cancellation for various reasons, ensuring flexibility and control in payment processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/resendOrCancelPayment/).
482
482
  */
483
483
  resendOrCancelPayment({ body, requestHeaders }?: PaymentApplicationValidator.ResendOrCancelPaymentParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.ResendOrCancelPaymentResponse>;
484
484
  /**
@@ -489,7 +489,7 @@ declare class Payment {
489
489
  * Success response
490
490
  * @name resendPaymentLink
491
491
  * @summary: Resend payment link
492
- * @description: Resends an existing payment link to the user to complete the payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/resendPaymentLink/).
492
+ * @description: Resend an existing payment link to the user to complete the payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/resendPaymentLink/).
493
493
  */
494
494
  resendPaymentLink({ body, requestHeaders }?: PaymentApplicationValidator.ResendPaymentLinkParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.ResendPaymentLinkResponse>;
495
495
  /**
@@ -502,7 +502,7 @@ declare class Payment {
502
502
  *
503
503
  * @name updateDefaultBeneficiary
504
504
  * @summary: Set default beneficiary for refund
505
- * @description: Updates the default beneficiary for the order refund of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/updateDefaultBeneficiary/).
505
+ * @description: Update default beneficiary for the order refund of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/updateDefaultBeneficiary/).
506
506
  */
507
507
  updateDefaultBeneficiary({ body, requestHeaders }?: PaymentApplicationValidator.UpdateDefaultBeneficiaryParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.SetDefaultBeneficiaryResponse>;
508
508
  /**
@@ -512,7 +512,7 @@ declare class Payment {
512
512
  * @returns {Promise<PaymentApplicationModel.ValidateVPAResponse>} - Success response
513
513
  * @name validateVPA
514
514
  * @summary: Validate VPA
515
- * @description: Checks whether a Virtual Payment Address (VPA) is valid for processing payments and returns the validation result.is_valid boolean value indicating whether the VPA is valid for payments - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/validateVPA/).
515
+ * @description: Validate if a Virtual Payment Address (VPA) is valid for processing payments and returns the validation result.is_valid boolean value indicating whether the VPA is valid for payments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/validateVPA/).
516
516
  */
517
517
  validateVPA({ body, requestHeaders }?: PaymentApplicationValidator.ValidateVPAParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.ValidateVPAResponse>;
518
518
  /**
@@ -535,7 +535,7 @@ declare class Payment {
535
535
  * Success response
536
536
  * @name verifyCustomerForPayment
537
537
  * @summary: Verify payment customer
538
- * @description: Verify whether the user is eligible for pay-later payment from the payment aggregator's side using the customer's phone number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyCustomerForPayment/).
538
+ * @description: Verify if the user is eligible for pay-later payment from the payment aggregator side using the customer's phone number. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyCustomerForPayment/).
539
539
  */
540
540
  verifyCustomerForPayment({ body, requestHeaders }?: PaymentApplicationValidator.VerifyCustomerForPaymentParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.ValidateCustomerResponse>;
541
541
  /**
@@ -545,7 +545,7 @@ declare class Payment {
545
545
  * @returns {Promise<PaymentApplicationModel.IfscCodeResponse>} - Success response
546
546
  * @name verifyIfscCode
547
547
  * @summary: Verify IFSC
548
- * @description: Checks the validity of the provided IFSC code and returns bank details if valid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyIfscCode/).
548
+ * @description: Validate IFSC code and returns bank details if valid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyIfscCode/).
549
549
  */
550
550
  verifyIfscCode({ ifscCode, requestHeaders }?: PaymentApplicationValidator.VerifyIfscCodeParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.IfscCodeResponse>;
551
551
  /**
@@ -559,7 +559,7 @@ declare class Payment {
559
559
  *
560
560
  * @name verifyOtpAndAddBeneficiaryForBank
561
561
  * @summary: Verify OTP for bank and add beneficiary
562
- * @description: This endpoint confirms the OTP provided by the user and adds a bank beneficiary for refund processing - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyOtpAndAddBeneficiaryForBank/).
562
+ * @description: Verify the OTP provided by the user and adds a bank beneficiary for refund processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyOtpAndAddBeneficiaryForBank/).
563
563
  */
564
564
  verifyOtpAndAddBeneficiaryForBank({ body, requestHeaders }?: PaymentApplicationValidator.VerifyOtpAndAddBeneficiaryForBankParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.AddBeneficiaryViaOtpVerificationResponse>;
565
565
  /**
@@ -571,7 +571,7 @@ declare class Payment {
571
571
  * @returns {Promise<PaymentApplicationModel.WalletOtpResponse>} - Success response
572
572
  * @name verifyOtpAndAddBeneficiaryForWallet
573
573
  * @summary: Verify OTP for wallet
574
- * @description: Confirm OTP provided by the user and adds a wallet beneficiary - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyOtpAndAddBeneficiaryForWallet/).
574
+ * @description: Verify OTP provided by the user and adds a wallet beneficiary. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/payment/verifyOtpAndAddBeneficiaryForWallet/).
575
575
  */
576
576
  verifyOtpAndAddBeneficiaryForWallet({ body, requestHeaders }?: PaymentApplicationValidator.VerifyOtpAndAddBeneficiaryForWalletParam, { responseHeaders }?: object): Promise<PaymentApplicationModel.WalletOtpResponse>;
577
577
  /**