@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
@@ -2,31 +2,37 @@ const Joi = require("joi");
2
2
 
3
3
  /**
4
4
  * @typedef OrederFreezeResponse
5
- * @property {boolean} [success]
6
- * @property {boolean} [oms_freeze]
7
- * @property {string} [source]
5
+ * @property {boolean} [success] - Indicates whether the operation was successful or not.
6
+ * @property {boolean} [oms_freeze] - Flag indicating if the system is frozen
7
+ * for order management.
8
+ * @property {string} [source] - Optional field indicating the data source of
9
+ * the information.
8
10
  */
9
11
 
10
12
  /**
11
13
  * @typedef GenerateReportMeta
12
- * @property {string} [brand]
13
- * @property {string} [company]
14
- * @property {string} [channel]
14
+ * @property {string} [brand] - The brand name associated with the report meta
15
+ * information.
16
+ * @property {string} [company] - The company name associated with the report
17
+ * meta information.
18
+ * @property {string} [channel] - The sale channel name associated with seller.
15
19
  */
16
20
 
17
21
  /**
18
22
  * @typedef GenerateReportFilters
19
- * @property {string[]} [brand]
20
- * @property {string[]} [company]
21
- * @property {string[]} [channel]
23
+ * @property {string[]} [brand] - An array of brand names to filter the report data.
24
+ * @property {string[]} [company] - An array of company id to filter the report data.
25
+ * @property {string[]} [channel] - An array of sale channel names associated
26
+ * with seller to filter the report data.
22
27
  */
23
28
 
24
29
  /**
25
30
  * @typedef GenerateReportPlatform
26
- * @property {string} [start_date]
27
- * @property {string} [end_date]
31
+ * @property {string} [start_date] - The start date to generate report specific preiod.
32
+ * @property {string} [end_date] - The end date to generate report specific preiod.
28
33
  * @property {GenerateReportMeta} [meta]
29
- * @property {string} [report_id]
34
+ * @property {string} [report_id] - The unique identifier of the generate report
35
+ * where different report configure.
30
36
  * @property {GenerateReportFilters} [filters]
31
37
  */
32
38
 
@@ -37,31 +43,32 @@ const Joi = require("joi");
37
43
 
38
44
  /**
39
45
  * @typedef Page
40
- * @property {number} [item_total]
41
- * @property {string} [next_id]
42
- * @property {boolean} [has_previous]
43
- * @property {boolean} [has_next]
44
- * @property {number} [current]
45
- * @property {string} type
46
- * @property {number} [size]
46
+ * @property {number} [item_total] - The total number of items on the page.
47
+ * @property {string} [next_id] - The identifier for the next page.
48
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
49
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
50
+ * @property {number} [current] - The current page number.
51
+ * @property {string} type - The type of the page, such as 'PageType'.
52
+ * @property {number} [size] - The number of items per page.
47
53
  */
48
54
 
49
55
  /**
50
56
  * @typedef Currency
51
- * @property {string} [code]
52
- * @property {string} [symbol]
53
- * @property {string} [name]
57
+ * @property {string} [code] - The unique currency code.
58
+ * @property {string} [symbol] - The unique currency symbol.
59
+ * @property {string} [name] - The unique currency name.
54
60
  */
55
61
 
56
62
  /**
57
63
  * @typedef GenerateReportJson
58
64
  * @property {Object} [data]
59
- * @property {number} [item_count]
65
+ * @property {number} [item_count] - Total number of items in the report.
60
66
  * @property {Page} [page]
61
- * @property {string} [end_date]
62
- * @property {string} [start_date]
63
- * @property {string[][]} [items]
64
- * @property {string[]} [headers]
67
+ * @property {string} [end_date] - The end date to generate report specific preiod.
68
+ * @property {string} [start_date] - The start date to generate report specific preiod.
69
+ * @property {string[][]} [items] - Nested array structure representing report
70
+ * items or data.
71
+ * @property {string[]} [headers] - Headers describing each item in the report data.
65
72
  */
66
73
 
67
74
  /**
@@ -96,47 +103,50 @@ const Joi = require("joi");
96
103
 
97
104
  /**
98
105
  * @typedef DownloadReportData
99
- * @property {number} [page]
100
- * @property {number} [page_size]
101
- * @property {string} [start_date]
102
- * @property {string} [end_date]
106
+ * @property {number} [page] - The current page number of the report.
107
+ * @property {number} [page_size] - The number of items displayed per page.
108
+ * @property {string} [start_date] - The start date for fetching the report
109
+ * history for download.
110
+ * @property {string} [end_date] - The end date for fetching the report history
111
+ * for download.
103
112
  */
104
113
 
105
114
  /**
106
115
  * @typedef DownloadReportItems
107
- * @property {string} [start_date]
108
- * @property {string} [end_date]
116
+ * @property {string} [start_date] - The start date for the report item.
117
+ * @property {string} [end_date] - The end date for the report item.
109
118
  * @property {GenerateReportMeta} [meta]
110
- * @property {string} [report_id]
119
+ * @property {string} [report_id] - The unique identifier of the report item.
111
120
  * @property {GenerateReportFilters} [filters]
112
- * @property {string} [type_of_request]
113
121
  */
114
122
 
115
123
  /**
116
124
  * @typedef DownloadReportList
117
- * @property {DownloadReportItems[]} [items]
125
+ * @property {DownloadReportItems[]} [items] - A list of report items available
126
+ * for download.
118
127
  * @property {Page} [page]
119
- * @property {number} [item_count]
128
+ * @property {number} [item_count] - The total number of items in the report list.
120
129
  */
121
130
 
122
131
  /**
123
132
  * @typedef GetEngineFilters
124
- * @property {string} [config_field]
125
- * @property {string} [status]
126
- * @property {boolean} [is_active]
127
- * @property {string} [seller_id]
133
+ * @property {string} [config_field] - The configuration field used for filtering.
134
+ * @property {string} [status] - The status used for filtering.
135
+ * @property {boolean} [is_active] - Flag indicating if the filter is active.
136
+ * @property {string} [seller_id] - The seller ID used for filtering.
128
137
  */
129
138
 
130
139
  /**
131
140
  * @typedef GetEngineData
132
- * @property {string} [status]
141
+ * @property {string} [status] - Status of the request.
133
142
  * @property {GetEngineFilters} [filters]
134
- * @property {string[]} [project]
135
- * @property {string} [table_name]
136
- * @property {Object} [search]
137
- * @property {number} [page]
138
- * @property {number} [page_size]
139
- * @property {string} [order_by]
143
+ * @property {string[]} [project] - A list of fields to get data from tables.
144
+ * @property {string} [table_name] - The name of the table from which to retrieve data.
145
+ * @property {Object} [search] - Search criteria for querying on given table
146
+ * specific fields.
147
+ * @property {number} [page] - The current page number for pagination.
148
+ * @property {number} [page_size] - The number of items displayed per page.
149
+ * @property {string} [order_by] - The field by which to order the results.
140
150
  */
141
151
 
142
152
  /**
@@ -146,15 +156,15 @@ const Joi = require("joi");
146
156
 
147
157
  /**
148
158
  * @typedef GetEngineResponse
149
- * @property {boolean} [success]
150
- * @property {Object[]} [items]
159
+ * @property {boolean} [success] - Indicates whether the request was successful.
160
+ * @property {Object[]} [items] - A list of items returned by the request.
151
161
  * @property {Page} [page]
152
- * @property {number} [item_count]
162
+ * @property {number} [item_count] - The total number of items returned by the request.
153
163
  */
154
164
 
155
165
  /**
156
166
  * @typedef GetReason
157
- * @property {string} [reason_type]
167
+ * @property {string} [reason_type] - The type of reason associated with the request.
158
168
  */
159
169
 
160
170
  /**
@@ -164,23 +174,24 @@ const Joi = require("joi");
164
174
 
165
175
  /**
166
176
  * @typedef ReasonItem
167
- * @property {string} [id]
168
- * @property {string} [name]
169
- * @property {string} [display_name]
177
+ * @property {string} [id] - Id of the reason for reason_type.
178
+ * @property {string} [name] - Code of the reason for reason_type.
179
+ * @property {string} [display_name] - Display name of the reason for reason_type.
170
180
  */
171
181
 
172
182
  /**
173
183
  * @typedef GetReasonResponse
174
- * @property {boolean} [success]
175
- * @property {ReasonItem[]} [item_list]
176
- * @property {number} [item_count]
184
+ * @property {boolean} [success] - Indicates whether the request was successfull.
185
+ * @property {ReasonItem[]} [item_list] - The list of items returned in the response.
186
+ * @property {number} [item_count] - The number of items in the response.
177
187
  * @property {Page} [page]
178
188
  */
179
189
 
180
190
  /**
181
191
  * @typedef GetReportListData
182
- * @property {string} [role_name]
183
- * @property {boolean} [listing_enabled]
192
+ * @property {string} [role_name] - The name of the role requesting the report list.
193
+ * @property {boolean} [listing_enabled] - Indicates whether listing is enabled
194
+ * for the role.
184
195
  */
185
196
 
186
197
  /**
@@ -188,40 +199,43 @@ const Joi = require("joi");
188
199
  * @property {GetReportListData} [data]
189
200
  */
190
201
 
191
- /**
192
- * @typedef GetAffiliate
193
- * @property {number} [company_id]
194
- */
195
-
196
202
  /**
197
203
  * @typedef GetReportListResponse
198
- * @property {boolean} [success]
199
- * @property {ReportItem[]} [items]
204
+ * @property {boolean} [success] - Indicates whether the request was successful.
205
+ * @property {ReportItem[]} [items] - The list of report items.
200
206
  * @property {Page} [page]
201
- * @property {number} [total_count]
207
+ * @property {number} [total_count] - The total number of items in the report list.
202
208
  */
203
209
 
204
210
  /**
205
211
  * @typedef ReportItem
206
- * @property {string} [id]
207
- * @property {string} [name]
208
- * @property {string} [description]
209
- * @property {string[]} [allowed_filters]
210
- * @property {Object} [config_meta]
211
- * @property {string} [report_type]
212
- * @property {string} [display_date]
212
+ * @property {string} [id] - The unique identifier for the report item.
213
+ * @property {string} [name] - The name of the report item.
214
+ * @property {string} [description] - A brief description of the report item.
215
+ * @property {string[]} [allowed_filters] - The filters that can be applied to
216
+ * the report item.
217
+ * @property {Object} [config_meta] - Metadata related to the report item configuration.
218
+ * @property {string} [report_type] - The type of the report item.
219
+ * @property {string} [display_date] - The display date of the report item, if applicable.
220
+ */
221
+
222
+ /**
223
+ * @typedef GetAffiliate
224
+ * @property {number} [company_id] - The unique identifier of the company
225
+ * associated with the affiliate.
213
226
  */
214
227
 
215
228
  /**
216
229
  * @typedef GetAffiliateResponse
217
- * @property {string} [reason]
218
- * @property {boolean} [success]
219
- * @property {Object[]} [docs]
230
+ * @property {string} [reason] - The reason for the response, if applicable.
231
+ * @property {boolean} [success] - Indicates whether the request was successful.
232
+ * @property {Object[]} [docs] - List of items or data related to the affiliate.
220
233
  */
221
234
 
222
235
  /**
223
236
  * @typedef DownloadCreditDebitNote
224
- * @property {string[]} [note_id]
237
+ * @property {string[]} [note_id] - List of unique identifiers for the
238
+ * credit/debit notes to be download.
225
239
  */
226
240
 
227
241
  /**
@@ -231,28 +245,39 @@ const Joi = require("joi");
231
245
 
232
246
  /**
233
247
  * @typedef DownloadCreditDebitNoteResponseData
234
- * @property {string} [id]
235
- * @property {string} [pdf_s3_url]
248
+ * @property {string} [id] - The unique identifier of the download credit/debit note.
249
+ * @property {string} [pdf_s3_url] - The URL where the PDF of the credit/debit
250
+ * note is stored.
236
251
  */
237
252
 
238
253
  /**
239
254
  * @typedef DownloadCreditDebitNoteResponse
240
- * @property {boolean} [success]
241
- * @property {DownloadCreditDebitNoteResponseData[]} [data]
255
+ * @property {boolean} [success] - Indicates whether the request to download the
256
+ * credit/debit notes was successful.
257
+ * @property {DownloadCreditDebitNoteResponseData[]} [data] - List of
258
+ * credit/debit notes download data.
259
+ */
260
+
261
+ /**
262
+ * @typedef InvoiceBillingItem
263
+ * @property {string} [invoice_number] - The number of the invoice associated
264
+ * with the billing item.
265
+ * @property {number} [amount] - The amount of the billing item.
242
266
  */
243
267
 
244
268
  /**
245
269
  * @typedef PaymentProcessPayload
246
- * @property {string} [platform]
247
- * @property {number} [amount]
248
- * @property {string} [transaction_type]
249
- * @property {string} [source_reference]
250
- * @property {number} [total_amount]
251
- * @property {Object} [meta]
252
- * @property {string} [currency]
253
- * @property {string} [seller_id]
254
- * @property {string} [mode_of_payment]
255
- * @property {string} [invoice_number]
270
+ * @property {string} [platform] - The platform through which the payment is processed.
271
+ * @property {number} [amount] - The total amount to be processed in the payment.
272
+ * @property {string} [transaction_type] - The type of transaction (e.g., seller_online).
273
+ * @property {string} [source_reference] - The reference for the source of the payment.
274
+ * @property {number} [total_amount] - The total amount to be processed in the payment.
275
+ * @property {Object} [meta] - Additional metadata related to the payment.
276
+ * @property {string} [currency] - The currency in which the payment is made.
277
+ * @property {string} [seller_id] - The unique identifier for the seller
278
+ * receiving the payment.
279
+ * @property {string} [mode_of_payment] - The mode of payment (e.g., online).
280
+ * @property {InvoiceBillingItem[]} [invoice_billing_items]
256
281
  */
257
282
 
258
283
  /**
@@ -262,20 +287,24 @@ const Joi = require("joi");
262
287
 
263
288
  /**
264
289
  * @typedef PaymentProcessResponse
265
- * @property {number} [code]
266
- * @property {string} [message]
267
- * @property {Object} [meta]
268
- * @property {string} [transaction_id]
269
- * @property {string} [redirect_url]
290
+ * @property {number} [code] - Response code indicating the status of the payment process.
291
+ * @property {string} [message] - A message providing additional information
292
+ * about the payment process response.
293
+ * @property {Object} [meta] - Additional metadata related to the payment
294
+ * process response.
295
+ * @property {string} [transaction_id] - The unique identifier for the payment
296
+ * transaction.
297
+ * @property {string} [redirect_url] - URL to redirect the user to complete the
298
+ * payment process, if applicable.
270
299
  */
271
300
 
272
301
  /**
273
302
  * @typedef CreditlineDataPlatformPayload
274
- * @property {number} [page]
275
- * @property {string} [seller_id]
276
- * @property {string} [end_date]
277
- * @property {string} [start_date]
278
- * @property {number} [page_size]
303
+ * @property {number} [page] - The page number for pagination.
304
+ * @property {string} [seller_id] - The unique identifier for the seller.
305
+ * @property {string} [end_date] - The end date for the query.
306
+ * @property {string} [start_date] - The start date for the query.
307
+ * @property {number} [page_size] - The number of items per page.
279
308
  */
280
309
 
281
310
  /**
@@ -285,18 +314,20 @@ const Joi = require("joi");
285
314
 
286
315
  /**
287
316
  * @typedef CreditlineDataPlatformResponse
288
- * @property {Object[]} [items]
289
- * @property {number} [code]
290
- * @property {boolean} [show_mr]
317
+ * @property {Object[]} [items] - The list of items in the response.
318
+ * @property {number} [code] - The response status code.
319
+ * @property {boolean} [show_mr] - A flag indicating whether to show MR (some
320
+ * specific field).
291
321
  * @property {Page} [page]
292
- * @property {string} [message]
293
- * @property {string[]} [headers]
294
- * @property {number} [item_count]
322
+ * @property {string} [message] - The response message.
323
+ * @property {string[]} [headers] - The list of response headers.
324
+ * @property {number} [item_count] - The total number of items.
295
325
  */
296
326
 
297
327
  /**
298
328
  * @typedef IsCreditlinePayload
299
- * @property {string} [seller_id]
329
+ * @property {string} [seller_id] - The unique identifier for the seller to
330
+ * check for credit line eligibility.
300
331
  */
301
332
 
302
333
  /**
@@ -306,13 +337,15 @@ const Joi = require("joi");
306
337
 
307
338
  /**
308
339
  * @typedef IsCreditlinePlatformResponse
309
- * @property {boolean} [is_creditline_opted]
310
- * @property {number} [code]
340
+ * @property {boolean} [is_creditline_opted] - Indicates whether the seller has
341
+ * opted for a credit line.
342
+ * @property {number} [code] - Response code indicating the status of the credit
343
+ * line check.
311
344
  */
312
345
 
313
346
  /**
314
347
  * @typedef InvoiceTypePayloadData
315
- * @property {boolean} [is_active]
348
+ * @property {boolean} [is_active] - Indicates if the invoice type is active.
316
349
  */
317
350
 
318
351
  /**
@@ -322,31 +355,33 @@ const Joi = require("joi");
322
355
 
323
356
  /**
324
357
  * @typedef InvoiceTypeResponseItems
325
- * @property {string} [text]
326
- * @property {string} [value]
358
+ * @property {string} [text] - The text description of the invoice type.
359
+ * @property {string} [value] - The value or code representing the invoice type.
327
360
  */
328
361
 
329
362
  /**
330
363
  * @typedef InvoiceTypeResponse
331
- * @property {boolean} [success]
332
- * @property {InvoiceTypeResponseItems[]} [invoice_type_list]
333
- * @property {InvoiceTypeResponseItems[]} [payment_status_list]
364
+ * @property {boolean} [success] - Indicates whether the request was successful.
365
+ * @property {InvoiceTypeResponseItems[]} [invoice_type_list] - List of invoice
366
+ * types available.
367
+ * @property {InvoiceTypeResponseItems[]} [payment_status_list] - List of
368
+ * payment statuses available.
334
369
  */
335
370
 
336
371
  /**
337
372
  * @typedef InoviceListingPayloadDataFilters
338
- * @property {string[]} [payment_status]
339
- * @property {string[]} [invoice_type]
340
- * @property {string[]} [company_id]
373
+ * @property {string[]} [payment_status] - List of payment statuses to filter by.
374
+ * @property {string[]} [invoice_type] - List of invoice types to filter by.
375
+ * @property {string[]} [company_id] - List of company IDs to filter by.
341
376
  */
342
377
 
343
378
  /**
344
379
  * @typedef InvoiceListingPayloadData
345
- * @property {number} [page_size]
346
- * @property {number} [page]
347
- * @property {string} [start_date]
348
- * @property {string} [end_date]
349
- * @property {string} [search]
380
+ * @property {number} [page_size] - The number of items per page for pagination.
381
+ * @property {number} [page] - The page number for pagination.
382
+ * @property {string} [start_date] - The start date for the invoice listing filter.
383
+ * @property {string} [end_date] - The end date for the invoice listing filter.
384
+ * @property {string} [search] - Search term for filtering invoices.
350
385
  * @property {InoviceListingPayloadDataFilters} [filters]
351
386
  */
352
387
 
@@ -357,39 +392,43 @@ const Joi = require("joi");
357
392
 
358
393
  /**
359
394
  * @typedef UnpaidInvoiceDataItems
360
- * @property {number} [total_unpaid_invoice_count]
361
- * @property {string} [currency]
362
- * @property {number} [total_unpaid_amount]
395
+ * @property {number} [total_unpaid_invoice_count] - The total count of unpaid invoices.
396
+ * @property {string} [currency] - The currency used for unpaid invoices.
397
+ * @property {number} [total_unpaid_amount] - The total amount of unpaid invoices.
363
398
  */
364
399
 
365
400
  /**
366
401
  * @typedef InvoiceListingResponseItems
367
- * @property {number} [amount]
368
- * @property {string} [company]
369
- * @property {string} [status]
370
- * @property {string} [due_date]
371
- * @property {string} [invoice_date]
372
- * @property {string} [invoice_type]
373
- * @property {string} [period]
374
- * @property {string} [invoice_number]
375
- * @property {boolean} [is_downloadable]
376
- * @property {string} [invoice_id]
402
+ * @property {number} [amount] - The amount of the invoice.
403
+ * @property {string} [company] - The name of the company associated with the invoice.
404
+ * @property {string} [status] - The current status of the invoice (e.g.,
405
+ * 'paid', 'unpaid').
406
+ * @property {string} [due_date] - The due date of the invoice.
407
+ * @property {string} [invoice_date] - The date when the invoice was issued.
408
+ * @property {string} [invoice_type] - The type of invoice.
409
+ * @property {string} [period] - The period covered by the invoice.
410
+ * @property {string} [invoice_number] - The invoice number.
411
+ * @property {boolean} [is_downloadable] - Indicates if the invoice is available
412
+ * for download.
413
+ * @property {string} [invoice_id] - The unique identifier of the invoice.
377
414
  * @property {Currency} [currency]
378
415
  */
379
416
 
380
417
  /**
381
418
  * @typedef InvoiceListingResponse
382
- * @property {boolean} [success]
383
- * @property {string[]} [headers]
419
+ * @property {boolean} [success] - Indicates whether the request was successful.
420
+ * @property {string[]} [headers] - Headers related to the invoice listing response.
384
421
  * @property {UnpaidInvoiceDataItems} [unpaid_invoice_data]
385
- * @property {InvoiceListingResponseItems[]} [items]
422
+ * @property {InvoiceListingResponseItems[]} [items] - List of invoice items in
423
+ * the response.
386
424
  * @property {Page} [page]
387
- * @property {number} [item_count]
425
+ * @property {number} [item_count] - The total number of invoice items in the response.
388
426
  */
389
427
 
390
428
  /**
391
429
  * @typedef InvoicePdfPayloadData
392
- * @property {string[]} [invoice_number]
430
+ * @property {string[]} [invoice_number] - List of invoice numbers for which
431
+ * PDFs are requested.
393
432
  */
394
433
 
395
434
  /**
@@ -399,16 +438,19 @@ const Joi = require("joi");
399
438
 
400
439
  /**
401
440
  * @typedef InvoicePdfResponse
402
- * @property {boolean} [success]
403
- * @property {string[]} [data]
404
- * @property {string[]} [error]
441
+ * @property {boolean} [success] - Indicates whether the PDF generation request
442
+ * was successful.
443
+ * @property {string[]} [data] - List of URLs or paths to the generated PDF files.
444
+ * @property {string[]} [error] - List of errors encountered while generating the PDFs.
405
445
  */
406
446
 
407
447
  /**
408
448
  * @typedef IsCnRefundMethodData
409
- * @property {string} [affiliate_id]
410
- * @property {boolean} [toggle_edit_required]
411
- * @property {number} [seller_id]
449
+ * @property {string} [affiliate_id] - The unique identifier of sale channels or
450
+ * application as affiliate_id associated with the seller.
451
+ * @property {boolean} [toggle_edit_required] - Indicates whether editing the
452
+ * refund method is required.
453
+ * @property {number} [seller_id] - Unique identifier for the seller.
412
454
  */
413
455
 
414
456
  /**
@@ -418,32 +460,40 @@ const Joi = require("joi");
418
460
 
419
461
  /**
420
462
  * @typedef IsCnRefundMethodResponseData
421
- * @property {boolean} [is_first_time_user]
463
+ * @property {boolean} [is_first_time_user] - Indicates whether the seller for
464
+ * specific sale channel is using the refund method for the first time.
422
465
  */
423
466
 
424
467
  /**
425
468
  * @typedef IsCnRefundMethodResponse
426
- * @property {boolean} [success]
469
+ * @property {boolean} [success] - Indicates whether the request to determine
470
+ * the refund method was successful.
427
471
  * @property {IsCnRefundMethodResponseData} [data]
428
472
  */
429
473
 
430
474
  /**
431
475
  * @typedef CreditNoteConfigNotificationEvents
432
- * @property {number} [expiration_reminder_to_customer]
476
+ * @property {number} [expiration_reminder_to_customer] - Number of days before
477
+ * the expiration date to send a reminder notification to the customer.
433
478
  */
434
479
 
435
480
  /**
436
481
  * @typedef CreateSellerCreditNoteConfig
437
- * @property {boolean} [is_cn_as_refund_method]
438
- * @property {string} [affiliate_id]
439
- * @property {string[]} [source_channel]
440
- * @property {number} [seller_id]
482
+ * @property {boolean} [is_cn_as_refund_method] - Indicates if the credit note
483
+ * is used as a refund method.
484
+ * @property {string} [affiliate_id] - The unique identifier of sale channels or
485
+ * application as affiliate_id associated with the seller.
486
+ * @property {string[]} [source_channel] - List of source channels associated
487
+ * with the credit note configuration.
488
+ * @property {number} [seller_id] - Unique identifier for the seller.
441
489
  * @property {CreditNoteConfigNotificationEvents} [notification_events]
442
- * @property {string} [sales_channel_name]
443
- * @property {string[]} [ordering_channel]
444
- * @property {number} [validity]
445
- * @property {string} [currency_type]
446
- * @property {string[]} [slug_values]
490
+ * @property {string} [sales_channel_name] - Name of the sales channel.
491
+ * @property {string[]} [ordering_channel] - List of ordering channels
492
+ * associated with the credit note configuration.
493
+ * @property {number} [validity] - Validity period of the credit note in days.
494
+ * @property {string} [currency_type] - Type of currency used for the credit note.
495
+ * @property {string[]} [slug_values] - List of slug values associated with the
496
+ * credit note configuration.
447
497
  */
448
498
 
449
499
  /**
@@ -453,15 +503,19 @@ const Joi = require("joi");
453
503
 
454
504
  /**
455
505
  * @typedef CreateSellerCreditNoteConfigResponse
456
- * @property {boolean} [success]
457
- * @property {string} [message]
506
+ * @property {boolean} [success] - Indicates if the credit note configuration
507
+ * creation was successful.
508
+ * @property {string} [message] - Additional information or message about the
509
+ * credit note configuration creation process.
458
510
  */
459
511
 
460
512
  /**
461
513
  * @typedef DeleteConfig
462
- * @property {string} [affiliate_id]
463
- * @property {string[]} [slug_values]
464
- * @property {number} [seller_id]
514
+ * @property {string} [affiliate_id] - The unique identifier of sale channels or
515
+ * application as affiliate_id associated with the seller.
516
+ * @property {string[]} [slug_values] - List of slug values associated with the
517
+ * credit note configuration.
518
+ * @property {number} [seller_id] - Unique identifier for the seller.
465
519
  */
466
520
 
467
521
  /**
@@ -471,25 +525,29 @@ const Joi = require("joi");
471
525
 
472
526
  /**
473
527
  * @typedef DeleteConfigResponse
474
- * @property {boolean} [success]
475
- * @property {string} [message]
528
+ * @property {boolean} [success] - Indicates if the configuration deletion was successful.
529
+ * @property {string} [message] - Additional information or message about the
530
+ * configuration deletion process.
476
531
  */
477
532
 
478
533
  /**
479
534
  * @typedef ChannelDisplayNameItems
480
- * @property {string} [key]
481
- * @property {string} [value]
535
+ * @property {string} [key] - The unique key identifying the channel.
536
+ * @property {string} [value] - The display name of the channel associated with the key.
482
537
  */
483
538
 
484
539
  /**
485
540
  * @typedef ChannelDisplayNameResponse
486
- * @property {boolean} [success]
487
- * @property {ChannelDisplayNameItems[]} [items]
541
+ * @property {boolean} [success] - Indicates if the retrieval of channel display
542
+ * names was successful.
543
+ * @property {ChannelDisplayNameItems[]} [items] - List of items containing
544
+ * key-value pairs for channel display names.
488
545
  */
489
546
 
490
547
  /**
491
548
  * @typedef CnReferenceNumber
492
- * @property {string} [cn_reference_number]
549
+ * @property {string} [cn_reference_number] - The unique reference number of the
550
+ * credit note.
493
551
  */
494
552
 
495
553
  /**
@@ -499,13 +557,16 @@ const Joi = require("joi");
499
557
 
500
558
  /**
501
559
  * @typedef GetPdfUrlViewResponseData
502
- * @property {string} [s3_pdf_link]
503
- * @property {string} [cn_reference_number]
560
+ * @property {string} [s3_pdf_link] - The URL link where credit nore pdf stored
561
+ * to view and download.
562
+ * @property {string} [cn_reference_number] - The unique reference number of the
563
+ * credit note.
504
564
  */
505
565
 
506
566
  /**
507
567
  * @typedef GetPdfUrlViewResponse
508
- * @property {boolean} [success]
568
+ * @property {boolean} [success] - Indicates if the retrieval of the pdf URL was
569
+ * successful.
509
570
  * @property {GetPdfUrlViewResponseData} [data]
510
571
  */
511
572
 
@@ -516,55 +577,65 @@ const Joi = require("joi");
516
577
 
517
578
  /**
518
579
  * @typedef CnDetails
519
- * @property {string} [staff_id]
520
- * @property {string} [expiry_date]
521
- * @property {string} [channel_of_issuance]
522
- * @property {string} [order_id]
523
- * @property {string} [date_issued]
524
- * @property {string} [ordering_channel]
525
- * @property {string} [shipment_id]
526
- * @property {string} [store_id]
527
- * @property {string} [invoice_number]
580
+ * @property {string} [staff_id] - ID of the staff member associated with the credit note.
581
+ * @property {string} [expiry_date] - Expiry date of the credit note.
582
+ * @property {string} [channel_of_issuance] - Channel through which the credit
583
+ * note was issued.
584
+ * @property {string} [order_id] - Order ID of order for which credit note created.
585
+ * @property {string} [date_issued] - Date when the credit note was issued.
586
+ * @property {string} [ordering_channel] - Ordering channel associated with the
587
+ * credit note.
588
+ * @property {string} [shipment_id] - Shipment Id associated with the credit note.
589
+ * @property {string} [store_id] - Store Id associated with the credit note.
590
+ * @property {string} [invoice_number] - Invoice number associated with the credit note.
528
591
  */
529
592
 
530
593
  /**
531
594
  * @typedef RedemptionDetails
532
- * @property {Object} [meta]
533
- * @property {string} [staff_id]
534
- * @property {string} [created_at]
535
- * @property {string} [order_id]
536
- * @property {string} [store_id]
537
- * @property {string} [shipment_id]
538
- * @property {string} [ordering_channel]
539
- * @property {number} [amount_debited]
540
- * @property {string} [invoice_number]
595
+ * @property {Object} [meta] - Additional metadata related to the redemption details.
596
+ * @property {string} [staff_id] - ID of the staff member who processed the redemption.
597
+ * @property {string} [created_at] - Date and time when the redemption was processed.
598
+ * @property {string} [order_id] - Order Id of the order associated with the redemption.
599
+ * @property {string} [store_id] - Store Id of the order associated with the redemption.
600
+ * @property {string} [shipment_id] - Shipment Id of the order associated with
601
+ * the redemption.
602
+ * @property {string} [ordering_channel] - Ordering channel associated with the
603
+ * redemption.
604
+ * @property {number} [amount_debited] - Amount debited from the credit note
605
+ * during redemption.
606
+ * @property {string} [invoice_number] - Invoice number associated with the redemption.
541
607
  */
542
608
 
543
609
  /**
544
610
  * @typedef CreditNoteDetails
545
- * @property {string} [currency]
546
- * @property {number} [current_amount_used]
547
- * @property {string} [cn_status]
548
- * @property {string} [customer_mobile_number]
549
- * @property {string} [cn_reference_number]
611
+ * @property {string} [currency] - Currency in which the credit note is issued.
612
+ * @property {number} [current_amount_used] - Current amount used from the credit note.
613
+ * @property {string} [cn_status] - Status of the credit note.
614
+ * @property {string} [customer_mobile_number] - Mobile number of the customer
615
+ * associated with the credit note.
616
+ * @property {string} [cn_reference_number] - Unique Credit number of the credit note.
550
617
  * @property {CnDetails} [cn_details]
551
- * @property {RedemptionDetails[]} [redemption_details]
552
- * @property {number} [remaining_cn_amount]
553
- * @property {number} [available_cn_balance]
554
- * @property {number} [cn_amount]
618
+ * @property {RedemptionDetails[]} [redemption_details] - List of redemption
619
+ * details associated with the credit note.
620
+ * @property {number} [remaining_cn_amount] - Remaining amount left in the credit note.
621
+ * @property {number} [available_cn_balance] - Available balance in the credit note.
622
+ * @property {number} [cn_amount] - Total amount of the credit note.
555
623
  */
556
624
 
557
625
  /**
558
626
  * @typedef CreditNoteDetailsResponse
559
- * @property {boolean} [success]
627
+ * @property {boolean} [success] - Indicates if the retrieval of credit note
628
+ * details was successful.
560
629
  * @property {CreditNoteDetails} [data]
561
630
  */
562
631
 
563
632
  /**
564
633
  * @typedef GetCustomerCreditBalance
565
- * @property {string} [affiliate_id]
566
- * @property {number} [seller_id]
567
- * @property {string} [customer_mobile_number]
634
+ * @property {string} [affiliate_id] - The unique identifier of sale channels or
635
+ * application as affiliate_id associated with the seller.
636
+ * @property {number} [seller_id] - Unique identifier for the seller.
637
+ * @property {string} [customer_mobile_number] - Mobile number of the customer
638
+ * for whom the credit balance is requested.
568
639
  */
569
640
 
570
641
  /**
@@ -574,13 +645,15 @@ const Joi = require("joi");
574
645
 
575
646
  /**
576
647
  * @typedef GetCustomerCreditBalanceResponseData
577
- * @property {string} [customer_mobile_number]
578
- * @property {number} [total_credited_balance]
648
+ * @property {string} [customer_mobile_number] - Mobile number of the customer.
649
+ * @property {number} [total_credited_balance] - Total credited balance
650
+ * available for the customer.
579
651
  */
580
652
 
581
653
  /**
582
654
  * @typedef GetCustomerCreditBalanceResponse
583
- * @property {boolean} [success]
655
+ * @property {boolean} [success] - Indicates if the retrieval of customer credit
656
+ * balance was successful.
584
657
  * @property {GetCustomerCreditBalanceResponseData} [data]
585
658
  */
586
659
 
@@ -591,51 +664,64 @@ const Joi = require("joi");
591
664
 
592
665
  /**
593
666
  * @typedef GetCnConfigResponseMeta
594
- * @property {string} [reason]
595
- * @property {string[]} [source_channel]
667
+ * @property {string} [reason] - Reason associated with the configuration response.
668
+ * @property {string[]} [source_channel] - List of source channels associated
669
+ * with the credit note configuration.
596
670
  */
597
671
 
598
672
  /**
599
673
  * @typedef GetCnConfigResponseData
600
- * @property {boolean} [is_cn_as_refund_method]
601
- * @property {string} [affiliate_id]
674
+ * @property {boolean} [is_cn_as_refund_method] - Indicates if the credit note
675
+ * is configured as a refund method.
676
+ * @property {string} [affiliate_id] - The unique identifier of sale channels or
677
+ * application as affiliate_id associated with the seller.
602
678
  * @property {Object} [meta]
603
- * @property {number} [seller_id]
679
+ * @property {number} [seller_id] - Unique identifier for the seller.
604
680
  * @property {CreditNoteConfigNotificationEvents} [notification_events]
605
- * @property {number} [validity]
606
- * @property {string[]} [redemption_ordering_channel]
607
- * @property {string} [currency_type]
681
+ * @property {number} [validity] - Validity period of the credit note
682
+ * configuration in days.
683
+ * @property {string[]} [redemption_ordering_channel] - List of ordering
684
+ * channels associated with credit note redemption.
685
+ * @property {string} [currency_type] - Type of currency used for the credit note.
608
686
  */
609
687
 
610
688
  /**
611
689
  * @typedef GetCnConfigResponse
612
- * @property {boolean} [success]
690
+ * @property {boolean} [success] - Indicates if the retrieval of credit note
691
+ * configuration was successful.
613
692
  * @property {GetCnConfigResponseData} [data]
614
693
  */
615
694
 
616
695
  /**
617
696
  * @typedef CnGenerateReportFilters
618
- * @property {string[]} [staff_id]
619
- * @property {string[]} [channel_of_issuance]
620
- * @property {string[]} [utilisation]
621
- * @property {string[]} [ordering_channel]
622
- * @property {number[]} [store_id]
623
- * @property {string[]} [type_of_transaction]
624
- * @property {string[]} [issuance_channel]
697
+ * @property {string[]} [staff_id] - Array of staff IDs for filtering credit note reports.
698
+ * @property {string[]} [channel_of_issuance] - Array of channels through which
699
+ * credit notes were issued.
700
+ * @property {string[]} [utilisation] - Array of utilisation types for filtering
701
+ * credit note reports.
702
+ * @property {string[]} [ordering_channel] - Array of ordering channels
703
+ * associated with credit note reports.
704
+ * @property {number[]} [store_id] - Array of store IDs for filtering credit note reports.
705
+ * @property {string[]} [type_of_transaction] - Array of transaction types for
706
+ * filtering credit note reports.
707
+ * @property {string[]} [issuance_channel] - Array of issuance channels for
708
+ * filtering credit note reports.
625
709
  */
626
710
 
627
711
  /**
628
712
  * @typedef CnGenerateReport
629
- * @property {number} [page]
630
- * @property {string} [end_date]
631
- * @property {number} [page_size]
713
+ * @property {number} [page] - Page number of the credit note report.
714
+ * @property {string} [end_date] - End date for filtering credit note data.
715
+ * @property {number} [page_size] - Number of items per page in the credit note report.
632
716
  * @property {CnGenerateReportFilters} [filters]
633
- * @property {string} [affiliate_id]
717
+ * @property {string} [affiliate_id] - The unique identifier of sale channels or
718
+ * application as affiliate_id associated with the seller.
634
719
  * @property {GenerateReportFilters} [meta]
635
- * @property {string} [search]
636
- * @property {string} [report_id]
637
- * @property {string} [search_type]
638
- * @property {string} [start_date]
720
+ * @property {string} [search] - Search query to filter credit note data by keyword.
721
+ * @property {string} [report_id] - Unique identifier for the credit note report.
722
+ * @property {string} [search_type] - Type of search criteria used for filtering
723
+ * credit note data.
724
+ * @property {string} [start_date] - Start date for filtering credit note data.
639
725
  */
640
726
 
641
727
  /**
@@ -645,29 +731,36 @@ const Joi = require("joi");
645
731
 
646
732
  /**
647
733
  * @typedef CnGenerateReportItems
648
- * @property {string} [expiry_date]
649
- * @property {string} [status]
650
- * @property {number} [total_amount]
651
- * @property {string} [order_id]
652
- * @property {string} [date_issued]
653
- * @property {string} [shipment_id]
654
- * @property {string} [invoice_number]
655
- * @property {string} [credit_note_number]
734
+ * @property {string} [expiry_date] - Expiry date of the credit note item.
735
+ * @property {string} [status] - Status of the credit note item.
736
+ * @property {number} [total_amount] - Total amount of the credit note item.
737
+ * @property {string} [order_id] - Order ID of the order associated with the
738
+ * credit note item.
739
+ * @property {string} [date_issued] - Date when the credit note item was issued.
740
+ * @property {string} [shipment_id] - Shipment ID of the order associated with
741
+ * the credit note item.
742
+ * @property {string} [invoice_number] - Invoice number associated with the
743
+ * credit note item.
744
+ * @property {string} [credit_note_number] - Unique number of the credit note item.
656
745
  */
657
746
 
658
747
  /**
659
748
  * @typedef GenerateReportCustomerCnResponseData
660
- * @property {boolean} [success]
661
- * @property {string} [message]
662
- * @property {CnGenerateReportItems[]} [items]
663
- * @property {Object} [row_header_display_order]
664
- * @property {string} [end_date]
749
+ * @property {boolean} [success] - Indicates if the credit note report
750
+ * generation was successful.
751
+ * @property {string} [message] - Additional message or information related to
752
+ * the credit note report.
753
+ * @property {CnGenerateReportItems[]} [items] - List of credit note items in the report.
754
+ * @property {Object} [row_header_display_order] - Display order for row headers
755
+ * in the report.
756
+ * @property {string} [end_date] - End date used in the credit note report.
665
757
  * @property {Page} [page]
666
- * @property {string[]} [headers]
667
- * @property {string[]} [primary_headers]
668
- * @property {string[]} [allowed_filters]
669
- * @property {string} [start_date]
670
- * @property {number} [item_count]
758
+ * @property {string[]} [headers] - Headers included in the credit note report.
759
+ * @property {string[]} [primary_headers] - Primary headers used in the credit
760
+ * note report.
761
+ * @property {string[]} [allowed_filters] - Allowed filters for the credit note report.
762
+ * @property {string} [start_date] - Start date used in the credit note report.
763
+ * @property {number} [item_count] - Total count of credit note items in the report.
671
764
  */
672
765
 
673
766
  /**
@@ -677,14 +770,17 @@ const Joi = require("joi");
677
770
 
678
771
  /**
679
772
  * @typedef CnDownloadReport
680
- * @property {number} [page]
681
- * @property {string} [start_date]
682
- * @property {string} [end_date]
683
- * @property {string} [affiliate_id]
684
- * @property {string} [search]
685
- * @property {string} [status]
686
- * @property {string} [search_type]
687
- * @property {number} [page_size]
773
+ * @property {number} [page] - Page number of the download report.
774
+ * @property {string} [start_date] - Start date for filtering credit note data
775
+ * in the report.
776
+ * @property {string} [end_date] - End date for filtering credit note data in the report.
777
+ * @property {string} [affiliate_id] - The unique identifier of sale channels or
778
+ * application as affiliate_id associated with the seller.
779
+ * @property {string} [search] - Search query to filter credit note data by keyword.
780
+ * @property {string} [status] - Status of the credit note data in the report.
781
+ * @property {string} [search_type] - Type of search criteria used for filtering
782
+ * credit note data.
783
+ * @property {number} [page_size] - Number of items per page in the download report.
688
784
  */
689
785
 
690
786
  /**
@@ -694,74 +790,77 @@ const Joi = require("joi");
694
790
 
695
791
  /**
696
792
  * @typedef DownloadReportResponseData
697
- * @property {string} [report_config_id]
698
- * @property {string} [full_name]
699
- * @property {string} [requested_by]
700
- * @property {string} [start_date]
701
- * @property {string} [end_date]
702
- * @property {Object} [request_dict]
703
- * @property {string} [download_link]
704
- * @property {string} [created_at]
705
- * @property {Object} [meta]
706
- * @property {string} [msg]
707
- * @property {string} [report_name]
708
- * @property {string} [status]
709
- * @property {string} [display_name]
710
- * @property {Object} [filters]
793
+ * @property {string} [report_config_id] - Unique identifier for the report configuration.
794
+ * @property {string} [full_name] - Full name associated with the report request.
795
+ * @property {string} [requested_by] - User who requested the report.
796
+ * @property {string} [start_date] - Start date used in the report.
797
+ * @property {string} [end_date] - End date used in the report.
798
+ * @property {Object} [request_dict] - Dictionary containing request parameters
799
+ * for the report.
800
+ * @property {string} [download_link] - Download link for accessing the generated report.
801
+ * @property {string} [created_at] - Date and time when the report was created.
802
+ * @property {Object} [meta] - Additional metadata associated with the report.
803
+ * @property {string} [msg] - Message related to the report status or generation.
804
+ * @property {string} [report_name] - Name of the generated report.
805
+ * @property {string} [status] - Status of the report.
806
+ * @property {string} [display_name] - Display name of the report.
807
+ * @property {Object} [filters] - Filters applied to generate the report.
711
808
  */
712
809
 
713
810
  /**
714
811
  * @typedef DownloadReportCustomerCnResponse
715
- * @property {DownloadReportResponseData[]} [items]
716
- * @property {DownloadReportResponseData[]} [data]
717
- * @property {number} [item_count]
812
+ * @property {DownloadReportResponseData[]} [items] - List of download report data items.
813
+ * @property {number} [item_count] - Total count of items in the download report.
718
814
  * @property {Page} [page]
719
815
  */
720
816
 
721
817
  /**
722
818
  * @typedef GetReportingFilters
723
- * @property {string} [text]
724
- * @property {string} [type]
725
- * @property {Object[]} [options]
726
- * @property {string} [value]
819
+ * @property {string} [text] - Display text for the filter.
820
+ * @property {string} [type] - Type of the fields like seach, filter(e.g.,
821
+ * single, multi select).
822
+ * @property {Object[]} [options] - Options available for the filter.
823
+ * @property {string} [value] - Value to be pass in response select from options.
727
824
  */
728
825
 
729
826
  /**
730
827
  * @typedef GetReportingNestedFilters
731
- * @property {string} [text]
732
- * @property {Object[]} [options]
733
- * @property {boolean} [required]
734
- * @property {string} [placeholder_text]
735
- * @property {string} [type]
736
- * @property {string} [value]
828
+ * @property {string} [text] - Display text for the nested filter.
829
+ * @property {Object[]} [options] - Options available for the nested filter.
830
+ * @property {boolean} [required] - Indicates if the nested filter is required.
831
+ * @property {string} [placeholder_text] - Placeholder text for the nested filter.
832
+ * @property {string} [type] - Type of the nested filter (e.g., single, multi select).
833
+ * @property {string} [value] - Value to be pass in response select from options.
737
834
  */
738
835
 
739
836
  /**
740
837
  * @typedef GetReportingFiltersReasonOptions
741
- * @property {string} [text]
742
- * @property {string} [value]
743
- * @property {string} [placeholder_text]
838
+ * @property {string} [text] - Display text for the reason option.
839
+ * @property {string} [value] - Value of the reason option.
840
+ * @property {string} [placeholder_text] - Placeholder text for the reason option.
744
841
  */
745
842
 
746
843
  /**
747
844
  * @typedef GetReportingFiltersReason
748
- * @property {string} [text]
749
- * @property {string} [type]
750
- * @property {string} [value]
751
- * @property {GetReportingFiltersReasonOptions[]} [options]
845
+ * @property {string} [text] - Display text for the reason.
846
+ * @property {string} [type] - Type of the reason.
847
+ * @property {string} [value] - Value to be pass in response.
848
+ * @property {GetReportingFiltersReasonOptions[]} [options] - Options available
849
+ * for the reasons select from options.
752
850
  */
753
851
 
754
852
  /**
755
853
  * @typedef GetReportingFiltersResponse
756
854
  * @property {GetReportingFiltersReason} [reason]
757
855
  * @property {GetReportingFilters} [search]
758
- * @property {GetReportingNestedFilters[]} [filters]
856
+ * @property {GetReportingNestedFilters[]} [filters] - Array of nested filter objects.
759
857
  * @property {GetReportingFilters} [status]
760
858
  */
761
859
 
762
860
  /**
763
861
  * @typedef InvoicePaymentOptionsPayloadData
764
- * @property {string} [invoice_number]
862
+ * @property {string[]} [invoice_numbers] - List of invoice numbers for which
863
+ * payment options are being requested.
765
864
  */
766
865
 
767
866
  /**
@@ -771,90 +870,115 @@ const Joi = require("joi");
771
870
 
772
871
  /**
773
872
  * @typedef InvoicePaymentOptionsResponsePayableAmounts
774
- * @property {number} [amount]
775
- * @property {string} [amount_key]
776
- * @property {string} [header]
873
+ * @property {number} [amount] - Amount that is payable for the invoice.
874
+ * @property {string} [amount_key] - Key associated with the payable amount for
875
+ * identification.
876
+ * @property {string} [header] - Header describing the payable amount.
777
877
  */
778
878
 
779
879
  /**
780
880
  * @typedef InvoicePaymentOptionsResponseDeductedAmounts
781
- * @property {number} [amount]
782
- * @property {string} [header]
783
- * @property {string} [amount_key]
784
- * @property {boolean} [is_payable]
785
- * @property {string} [symbol]
881
+ * @property {number} [amount] - Amount deducted from the invoice.
882
+ * @property {string} [header] - Header describing the deducted amount.
883
+ * @property {string} [amount_key] - Key associated with the deducted amount for
884
+ * identification.
885
+ * @property {boolean} [is_payable] - Indicates whether the deducted amount is payable.
886
+ * @property {string} [symbol] - Currency symbol associated with the deducted amount.
786
887
  */
787
888
 
788
889
  /**
789
890
  * @typedef InvoicePaymentOptionsResponseData
790
- * @property {Currency} [currency]
791
- * @property {string} [invoice_type]
891
+ * @property {string} [invoice_number] - Invoice number for which payment
892
+ * options are provided.
893
+ * @property {string} [invoice_type] - Type of the invoice (e.g., 'Seller Fynd',
894
+ * 'Platform Subscription').
792
895
  * @property {InvoicePaymentOptionsResponsePayableAmounts[]} [display_amounts]
793
- * @property {Object} [total_amount]
794
- * @property {Object} [deducted_amounts]
896
+ * - List of amounts that are payable for the invoice.
897
+ *
898
+ * @property {Object} [total_amount] - Total amount for the invoice.
899
+ * @property {Object} [deducted_amounts] - Amounts deducted from the total,
900
+ * including any associated details.
795
901
  * @property {InvoicePaymentOptionsResponsePayableAmounts[]} [payable_amounts]
902
+ * - Amounts that are payable for the invoice.
903
+ *
904
+ * @property {Currency} [currency]
796
905
  */
797
906
 
798
907
  /**
799
908
  * @typedef InvoicePaymentOptionsResponse
800
- * @property {string} [reason]
801
- * @property {InvoicePaymentOptionsResponseData} [data]
802
- * @property {boolean} [success]
909
+ * @property {string} [reason] - Reason for the response or any errors encountered.
910
+ * @property {InvoicePaymentOptionsResponseData[]} [data] - List of data objects
911
+ * containing details about invoice payment options.
912
+ * @property {number} [total_payable_amount] - Total amount payable for the invoices.
913
+ * @property {number} [invoice_count] - Number of invoices included in the response.
914
+ * @property {boolean} [success] - Indicates whether the request to retrieve
915
+ * invoice payment options was successful.
803
916
  */
804
917
 
805
918
  /**
806
919
  * @typedef PaymentDetail
807
- * @property {string} [display_name]
808
- * @property {string} [value]
920
+ * @property {string} [display_name] - Name or label displayed for the payment detail.
921
+ * @property {string} [value] - Value associated with the payment detail (e.g.,
922
+ * amount, transaction ID).
809
923
  */
810
924
 
811
925
  /**
812
926
  * @typedef PaidInvoicePaymentDetail
813
- * @property {PaymentDetail[]} [payment_details]
814
- * @property {string} [date_of_payment]
815
- * @property {number} [amount]
927
+ * @property {PaymentDetail[]} [payment_details] - List of payment details for
928
+ * the invoice.
929
+ * @property {string} [date_of_payment] - Date when the payment was made.
930
+ * @property {number} [amount] - Amount paid towards the invoice.
816
931
  */
817
932
 
818
933
  /**
819
934
  * @typedef InvoicePaymentDetailsResponseData
820
- * @property {PaidInvoicePaymentDetail[]} [paid_invoice_payment_details]
821
- * @property {Object[]} [failed_attempts_details]
935
+ * @property {PaidInvoicePaymentDetail[]} [paid_invoice_payment_details] - List
936
+ * of details for paid invoices.
937
+ * @property {Object[]} [failed_attempts_details] - Details of any failed
938
+ * payment attempts for the invoices.
822
939
  */
823
940
 
824
941
  /**
825
942
  * @typedef InvoicePaymentDetailsResponse
826
- * @property {string} [reason]
943
+ * @property {string} [reason] - Reason for the response or any errors encountered.
827
944
  * @property {InvoicePaymentDetailsResponseData} [data]
828
- * @property {boolean} [success]
829
- * @property {boolean} [payment_details_visible]
945
+ * @property {boolean} [success] - Indicates whether the request to retrieve
946
+ * invoice payment details was successful.
947
+ * @property {boolean} [payment_details_visible] - Indicates whether payment
948
+ * details are visible or hidden in the response.
830
949
  */
831
950
 
832
951
  /**
833
952
  * @typedef InvoiceActivityLogsResponseData
834
- * @property {string} [performed_by]
835
- * @property {string} [status]
836
- * @property {string} [reason]
837
- * @property {boolean} [is_resolved]
838
- * @property {number} [retry_attempts]
839
- * @property {number} [max_retry_attempts]
953
+ * @property {string} [performed_by] - Identifier of the user or system that
954
+ * performed the activity.
955
+ * @property {string} [status] - Status of the activity (e.g., 'Completed', 'Pending').
956
+ * @property {string} [reason] - Reason for the activity status or any related notes.
957
+ * @property {boolean} [is_resolved] - Indicates whether the activity issue is resolved.
958
+ * @property {number} [retry_attempts] - Number of retry attempts made for the activity.
959
+ * @property {number} [max_retry_attempts] - Maximum number of retry attempts
960
+ * allowed for the activity.
840
961
  */
841
962
 
842
963
  /**
843
964
  * @typedef InvoiceActivityLogsResponse
844
- * @property {InvoiceActivityLogsResponseData[]} [data]
965
+ * @property {InvoiceActivityLogsResponseData[]} [data] - List of activity logs
966
+ * related to invoices.
845
967
  */
846
968
 
847
969
  /**
848
970
  * @typedef InvoiceActivityLogError
849
- * @property {string} [reason]
971
+ * @property {string} [reason] - Reason for the error or issue encountered with
972
+ * the invoice activity logs.
850
973
  */
851
974
 
852
975
  /**
853
976
  * @typedef UnlockCreditNoteRequestData
854
- * @property {string} [seller_id]
855
- * @property {string[]} [locked_credit_notes]
856
- * @property {string} [unlock_reason]
857
- * @property {string} [description]
977
+ * @property {string} [seller_id] - The unique identifier for the seller.
978
+ * @property {string[]} [locked_credit_notes] - A list of credit notes that are locked.
979
+ * @property {string} [unlock_reason] - The reason for unlocking the credit notes.
980
+ * @property {string} [description] - Additional details or comments about the
981
+ * unlock request.
858
982
  */
859
983
 
860
984
  /**
@@ -864,13 +988,14 @@ const Joi = require("joi");
864
988
 
865
989
  /**
866
990
  * @typedef UnlockCreditNoteResponseData
867
- * @property {boolean} [is_cn_unlocked]
868
- * @property {string} [status]
991
+ * @property {boolean} [is_cn_unlocked] - Indicates whether the credit note is unlocked.
992
+ * @property {string} [status] - The current status of the each credit notes.
869
993
  */
870
994
 
871
995
  /**
872
996
  * @typedef UnlockCreditNoteResponse
873
- * @property {boolean} [success]
997
+ * @property {boolean} [success] - Indicates whether the credit note unlock
998
+ * request was successful.
874
999
  * @property {UnlockCreditNoteResponseData} [data]
875
1000
  */
876
1001
 
@@ -1011,7 +1136,6 @@ class FinancePlatformModel {
1011
1136
  meta: FinancePlatformModel.GenerateReportMeta(),
1012
1137
  report_id: Joi.string().allow(""),
1013
1138
  filters: FinancePlatformModel.GenerateReportFilters(),
1014
- type_of_request: Joi.string().allow(""),
1015
1139
  });
1016
1140
  }
1017
1141
 
@@ -1113,13 +1237,6 @@ class FinancePlatformModel {
1113
1237
  });
1114
1238
  }
1115
1239
 
1116
- /** @returns {GetAffiliate} */
1117
- static GetAffiliate() {
1118
- return Joi.object({
1119
- company_id: Joi.number(),
1120
- });
1121
- }
1122
-
1123
1240
  /** @returns {GetReportListResponse} */
1124
1241
  static GetReportListResponse() {
1125
1242
  return Joi.object({
@@ -1143,6 +1260,13 @@ class FinancePlatformModel {
1143
1260
  });
1144
1261
  }
1145
1262
 
1263
+ /** @returns {GetAffiliate} */
1264
+ static GetAffiliate() {
1265
+ return Joi.object({
1266
+ company_id: Joi.number(),
1267
+ });
1268
+ }
1269
+
1146
1270
  /** @returns {GetAffiliateResponse} */
1147
1271
  static GetAffiliateResponse() {
1148
1272
  return Joi.object({
@@ -1184,6 +1308,14 @@ class FinancePlatformModel {
1184
1308
  });
1185
1309
  }
1186
1310
 
1311
+ /** @returns {InvoiceBillingItem} */
1312
+ static InvoiceBillingItem() {
1313
+ return Joi.object({
1314
+ invoice_number: Joi.string().allow(""),
1315
+ amount: Joi.number(),
1316
+ });
1317
+ }
1318
+
1187
1319
  /** @returns {PaymentProcessPayload} */
1188
1320
  static PaymentProcessPayload() {
1189
1321
  return Joi.object({
@@ -1196,7 +1328,9 @@ class FinancePlatformModel {
1196
1328
  currency: Joi.string().allow(""),
1197
1329
  seller_id: Joi.string().allow(""),
1198
1330
  mode_of_payment: Joi.string().allow(""),
1199
- invoice_number: Joi.string().allow(""),
1331
+ invoice_billing_items: Joi.array().items(
1332
+ FinancePlatformModel.InvoiceBillingItem()
1333
+ ),
1200
1334
  });
1201
1335
  }
1202
1336
 
@@ -1789,9 +1923,6 @@ class FinancePlatformModel {
1789
1923
  items: Joi.array().items(
1790
1924
  FinancePlatformModel.DownloadReportResponseData()
1791
1925
  ),
1792
- data: Joi.array().items(
1793
- FinancePlatformModel.DownloadReportResponseData()
1794
- ),
1795
1926
  item_count: Joi.number(),
1796
1927
  page: FinancePlatformModel.Page(),
1797
1928
  });
@@ -1855,7 +1986,7 @@ class FinancePlatformModel {
1855
1986
  /** @returns {InvoicePaymentOptionsPayloadData} */
1856
1987
  static InvoicePaymentOptionsPayloadData() {
1857
1988
  return Joi.object({
1858
- invoice_number: Joi.string().allow(""),
1989
+ invoice_numbers: Joi.array().items(Joi.string().allow("")),
1859
1990
  });
1860
1991
  }
1861
1992
 
@@ -1889,7 +2020,7 @@ class FinancePlatformModel {
1889
2020
  /** @returns {InvoicePaymentOptionsResponseData} */
1890
2021
  static InvoicePaymentOptionsResponseData() {
1891
2022
  return Joi.object({
1892
- currency: FinancePlatformModel.Currency(),
2023
+ invoice_number: Joi.string().allow(""),
1893
2024
  invoice_type: Joi.string().allow(""),
1894
2025
  display_amounts: Joi.array().items(
1895
2026
  FinancePlatformModel.InvoicePaymentOptionsResponsePayableAmounts()
@@ -1899,6 +2030,7 @@ class FinancePlatformModel {
1899
2030
  payable_amounts: Joi.array().items(
1900
2031
  FinancePlatformModel.InvoicePaymentOptionsResponsePayableAmounts()
1901
2032
  ),
2033
+ currency: FinancePlatformModel.Currency(),
1902
2034
  });
1903
2035
  }
1904
2036
 
@@ -1906,7 +2038,11 @@ class FinancePlatformModel {
1906
2038
  static InvoicePaymentOptionsResponse() {
1907
2039
  return Joi.object({
1908
2040
  reason: Joi.string().allow(""),
1909
- data: FinancePlatformModel.InvoicePaymentOptionsResponseData(),
2041
+ data: Joi.array().items(
2042
+ FinancePlatformModel.InvoicePaymentOptionsResponseData()
2043
+ ),
2044
+ total_payable_amount: Joi.number(),
2045
+ invoice_count: Joi.number(),
1910
2046
  success: Joi.boolean(),
1911
2047
  });
1912
2048
  }