@gofynd/fdk-client-javascript 1.4.2-beta.2 → 1.4.2-beta.3

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 (106) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationModel.d.ts +1742 -1726
  4. package/sdk/application/Cart/CartApplicationModel.js +1497 -1481
  5. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
  6. package/sdk/application/Catalog/CatalogApplicationModel.js +1611 -1611
  7. package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
  8. package/sdk/application/Common/CommonApplicationModel.js +172 -172
  9. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
  10. package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
  11. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1614 -1614
  12. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1151 -1151
  13. package/sdk/application/Content/ContentApplicationModel.d.ts +797 -797
  14. package/sdk/application/Content/ContentApplicationModel.js +757 -757
  15. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
  16. package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
  17. package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
  18. package/sdk/application/Lead/LeadApplicationModel.js +301 -301
  19. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +666 -666
  20. package/sdk/application/Logistic/LogisticApplicationModel.js +601 -601
  21. package/sdk/application/Order/OrderApplicationModel.d.ts +846 -846
  22. package/sdk/application/Order/OrderApplicationModel.js +822 -822
  23. package/sdk/application/Payment/PaymentApplicationClient.d.ts +5 -5
  24. package/sdk/application/Payment/PaymentApplicationClient.js +10 -10
  25. package/sdk/application/Payment/PaymentApplicationModel.d.ts +2155 -2150
  26. package/sdk/application/Payment/PaymentApplicationModel.js +1460 -1458
  27. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
  28. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  29. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1462 -1462
  30. package/sdk/application/PosCart/PosCartApplicationModel.js +1260 -1260
  31. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
  32. package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
  33. package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
  34. package/sdk/application/Share/ShareApplicationModel.js +121 -121
  35. package/sdk/application/Theme/ThemeApplicationModel.d.ts +895 -895
  36. package/sdk/application/Theme/ThemeApplicationModel.js +684 -684
  37. package/sdk/application/User/UserApplicationModel.d.ts +762 -762
  38. package/sdk/application/User/UserApplicationModel.js +738 -738
  39. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +63 -63
  40. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +65 -65
  41. package/sdk/partner/Lead/LeadPartnerModel.d.ts +661 -661
  42. package/sdk/partner/Lead/LeadPartnerModel.js +491 -491
  43. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +223 -223
  44. package/sdk/partner/Logistics/LogisticsPartnerModel.js +235 -235
  45. package/sdk/partner/Theme/ThemePartnerModel.d.ts +1087 -1087
  46. package/sdk/partner/Theme/ThemePartnerModel.js +819 -819
  47. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +386 -386
  48. package/sdk/partner/Webhook/WebhookPartnerModel.js +342 -342
  49. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
  50. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
  51. package/sdk/platform/Billing/BillingPlatformModel.d.ts +801 -801
  52. package/sdk/platform/Billing/BillingPlatformModel.js +783 -783
  53. package/sdk/platform/Cart/CartPlatformModel.d.ts +3333 -3317
  54. package/sdk/platform/Cart/CartPlatformModel.js +2936 -2920
  55. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1013 -1013
  56. package/sdk/platform/Catalog/CatalogPlatformModel.js +923 -923
  57. package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
  58. package/sdk/platform/Common/CommonPlatformModel.js +187 -187
  59. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1238 -1238
  60. package/sdk/platform/Communication/CommunicationPlatformModel.js +1273 -1273
  61. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +661 -661
  62. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +692 -692
  63. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +3198 -3198
  64. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2247 -2247
  65. package/sdk/platform/Content/ContentPlatformModel.d.ts +1833 -1833
  66. package/sdk/platform/Content/ContentPlatformModel.js +1837 -1837
  67. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +245 -245
  68. package/sdk/platform/Discount/DiscountPlatformModel.js +248 -248
  69. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +865 -865
  70. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +877 -877
  71. package/sdk/platform/Finance/FinancePlatformModel.d.ts +1044 -1044
  72. package/sdk/platform/Finance/FinancePlatformModel.js +974 -974
  73. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
  74. package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
  75. package/sdk/platform/Lead/LeadPlatformModel.d.ts +608 -608
  76. package/sdk/platform/Lead/LeadPlatformModel.js +465 -465
  77. package/sdk/platform/Order/OrderPlatformModel.d.ts +5180 -5176
  78. package/sdk/platform/Order/OrderPlatformModel.js +4740 -4736
  79. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
  80. package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
  81. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2670 -2660
  82. package/sdk/platform/Payment/PaymentPlatformModel.js +1831 -1827
  83. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
  84. package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
  85. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1505 -1507
  86. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1532 -1536
  87. package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
  88. package/sdk/platform/Share/SharePlatformModel.js +139 -139
  89. package/sdk/platform/Theme/ThemePlatformModel.d.ts +1046 -1046
  90. package/sdk/platform/Theme/ThemePlatformModel.js +789 -789
  91. package/sdk/platform/User/UserPlatformModel.d.ts +758 -758
  92. package/sdk/platform/User/UserPlatformModel.js +643 -643
  93. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +439 -439
  94. package/sdk/platform/Webhook/WebhookPlatformModel.js +364 -364
  95. package/sdk/public/Billing/BillingPublicModel.d.ts +55 -55
  96. package/sdk/public/Billing/BillingPublicModel.js +51 -51
  97. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
  98. package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
  99. package/sdk/public/Content/ContentPublicModel.d.ts +26 -26
  100. package/sdk/public/Content/ContentPublicModel.js +28 -28
  101. package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
  102. package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
  103. package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
  104. package/sdk/public/Partner/PartnerPublicModel.js +113 -113
  105. package/sdk/public/Webhook/WebhookPublicModel.d.ts +87 -87
  106. package/sdk/public/Webhook/WebhookPublicModel.js +93 -93
@@ -1,161 +1,152 @@
1
1
  export = FinancePlatformModel;
2
2
  /**
3
- * @typedef ChannelDisplayName
4
- * @property {string} [platform_pos]
3
+ * @typedef GenerateReportMeta
4
+ * @property {string} [brand]
5
+ * @property {string} [company]
6
+ * @property {string} [channel]
5
7
  */
6
8
  /**
7
- * @typedef ChannelDisplayNameResponse
8
- * @property {ChannelDisplayName} [data]
9
- * @property {boolean} [success]
9
+ * @typedef GenerateReportFilters
10
+ * @property {string[]} [brand]
11
+ * @property {string[]} [company]
12
+ * @property {string[]} [channel]
10
13
  */
11
14
  /**
12
- * @typedef CnDetails
13
- * @property {string} [channel_of_issuance]
14
- * @property {string} [date_issued]
15
- * @property {string} [expiry_date]
16
- * @property {string} [invoice_number]
17
- * @property {string} [order_id]
18
- * @property {string} [ordering_channel]
19
- * @property {string} [shipment_id]
20
- * @property {string} [staff_id]
21
- * @property {string} [store_id]
15
+ * @typedef GenerateReportPlatform
16
+ * @property {string} [start_date]
17
+ * @property {string} [end_date]
18
+ * @property {GenerateReportMeta} [meta]
19
+ * @property {string} [report_id]
20
+ * @property {GenerateReportFilters} [filters]
22
21
  */
23
22
  /**
24
- * @typedef CnDownloadReport
25
- * @property {string} [affiliate_id]
23
+ * @typedef GenerateReportRequest
24
+ * @property {GenerateReportPlatform} [data]
25
+ */
26
+ /**
27
+ * @typedef Page
28
+ * @property {number} [item_total]
29
+ * @property {string} [next_id]
30
+ * @property {boolean} [has_previous]
31
+ * @property {boolean} [has_next]
32
+ * @property {number} [current]
33
+ * @property {string} type
34
+ * @property {number} [size]
35
+ */
36
+ /**
37
+ * @typedef Currency
38
+ * @property {string} [code]
39
+ * @property {string} [symbol]
40
+ * @property {string} [name]
41
+ */
42
+ /**
43
+ * @typedef GenerateReportJson
44
+ * @property {string[][]} [items]
45
+ * @property {Page} [page]
26
46
  * @property {string} [end_date]
27
- * @property {number} [page]
28
- * @property {number} [pagesize]
29
- * @property {string} [search]
30
- * @property {string} [search_type]
47
+ * @property {string[]} [headers]
31
48
  * @property {string} [start_date]
32
- * @property {string[]} [status]
49
+ * @property {number} [item_count]
33
50
  */
34
51
  /**
35
- * @typedef CnGenerateReport
36
- * @property {string} [affiliate_id]
37
- * @property {string} [end_date]
38
- * @property {CnGenerateReportFilters} [filters]
39
- * @property {GenerateReportFilters} [meta]
52
+ * @typedef Error
53
+ * @property {string} [reason]
54
+ * @property {boolean} [success]
55
+ */
56
+ /**
57
+ * @typedef DownloadReport
40
58
  * @property {number} [page]
41
59
  * @property {number} [pagesize]
42
- * @property {string} [report_id]
43
- * @property {string} [search]
44
- * @property {string} [search_type]
45
60
  * @property {string} [start_date]
61
+ * @property {string} [end_date]
46
62
  */
47
63
  /**
48
- * @typedef CnGenerateReportFilters
49
- * @property {string[]} [channel_of_issuance]
50
- * @property {string[]} [ordering_channel]
51
- * @property {string[]} [staff_id]
52
- * @property {number[]} [store_id]
53
- * @property {string[]} [types_of_transaction]
54
- * @property {string[]} [utilisation]
64
+ * @typedef DownloadReportItems
65
+ * @property {string} [start_date]
66
+ * @property {string} [end_date]
67
+ * @property {GenerateReportMeta} [meta]
68
+ * @property {string} [report_id]
69
+ * @property {GenerateReportFilters} [filters]
70
+ * @property {string} [type_of_request]
55
71
  */
56
72
  /**
57
- * @typedef CnGenerateReportItems
58
- * @property {string} [credit_note_number]
59
- * @property {string} [date_issued]
60
- * @property {string} [expiry_date]
61
- * @property {string} [invoice_number]
62
- * @property {string} [order_id]
63
- * @property {string} [shipment_id]
64
- * @property {string} [status]
65
- * @property {number} [total_amount]
73
+ * @typedef DownloadReportList
74
+ * @property {DownloadReportItems[]} [items]
75
+ * @property {Page} [page]
76
+ * @property {number} [item_count]
66
77
  */
67
78
  /**
68
- * @typedef CnReferenceNumber
69
- * @property {string} [cn_reference_number]
79
+ * @typedef GetEngineData
80
+ * @property {string} [table_name]
81
+ * @property {string[]} [project]
82
+ * @property {Object} [filters]
70
83
  */
71
84
  /**
72
- * @typedef CreateSellerCreditNoteConfig
73
- * @property {string} [affiliate_id]
74
- * @property {string} [currency_type]
75
- * @property {boolean} [is_cn_as_refund_method]
76
- * @property {CreditNoteConfigNotificationEvents} [notification_events]
77
- * @property {string[]} [ordering_channel]
78
- * @property {string} [sales_channel_name]
79
- * @property {number} [seller_id]
80
- * @property {string[]} [slug_values]
81
- * @property {string[]} [source_channel]
82
- * @property {number} [validity]
85
+ * @typedef GetEngineRequest
86
+ * @property {GetEngineData} [data]
83
87
  */
84
88
  /**
85
- * @typedef CreateSellerCreditNoteConfigRequest
86
- * @property {CreateSellerCreditNoteConfig} [data]
89
+ * @typedef GetEngineResponse
90
+ * @property {boolean} [success]
91
+ * @property {Object[]} [items]
92
+ * @property {Page} [page]
93
+ * @property {number} [item_count]
87
94
  */
88
95
  /**
89
- * @typedef CreateSellerCreditNoteConfigResponse
90
- * @property {string} [message]
91
- * @property {boolean} [success]
96
+ * @typedef GetReason
97
+ * @property {string} [reason_type]
92
98
  */
93
99
  /**
94
- * @typedef CreditlineDataPlatformPayload
95
- * @property {string} [end_end]
96
- * @property {number} [page]
97
- * @property {number} [pagesize]
98
- * @property {string} [seller_id]
99
- * @property {string} [start_end]
100
+ * @typedef GetReasonRequest
101
+ * @property {GetReason} [data]
100
102
  */
101
103
  /**
102
- * @typedef CreditlineDataPlatformRequest
103
- * @property {CreditlineDataPlatformPayload} [data]
104
+ * @typedef ReasonItem
105
+ * @property {string} [id]
106
+ * @property {string} [name]
107
+ * @property {string} [display_name]
104
108
  */
105
109
  /**
106
- * @typedef CreditlineDataPlatformResponse
107
- * @property {number} [code]
108
- * @property {string[]} [headers]
110
+ * @typedef GetReasonResponse
111
+ * @property {boolean} [success]
112
+ * @property {ReasonItem[]} [item_list]
109
113
  * @property {number} [item_count]
110
- * @property {Object[]} [items]
111
- * @property {string} [message]
112
114
  * @property {Page} [page]
113
- * @property {boolean} [show_mr]
114
115
  */
115
116
  /**
116
- * @typedef CreditNoteConfigNotificationEvents
117
- * @property {number} [expiration_reminder_to_customer]
117
+ * @typedef GetReportListData
118
+ * @property {string} [role_name]
119
+ * @property {boolean} [listing_enabled]
118
120
  */
119
121
  /**
120
- * @typedef CreditNoteDetails
121
- * @property {number} [available_cn_balance]
122
- * @property {number} [cn_amount]
123
- * @property {CnDetails} [cn_details]
124
- * @property {string} [cn_reference_number]
125
- * @property {string} [cn_status]
126
- * @property {string} [customer_mobile_number]
127
- * @property {RedemptionDetails[]} [redemption_details]
128
- * @property {number} [remaining_cn_amount]
122
+ * @typedef GetReportListRequest
123
+ * @property {GetReportListData} [data]
129
124
  */
130
125
  /**
131
- * @typedef CreditNoteDetailsRequest
132
- * @property {CnReferenceNumber} [data]
126
+ * @typedef GetAffiliate
127
+ * @property {number} [company_id]
133
128
  */
134
129
  /**
135
- * @typedef CreditNoteDetailsResponse
136
- * @property {CreditNoteDetails} [data]
130
+ * @typedef GetReportListResponse
137
131
  * @property {boolean} [success]
132
+ * @property {ReportItem[]} [items]
133
+ * @property {Page} [page]
134
+ * @property {number} [total_count]
138
135
  */
139
136
  /**
140
- * @typedef Currency
141
- * @property {string} [code]
137
+ * @typedef ReportItem
138
+ * @property {string} [id]
142
139
  * @property {string} [name]
143
- * @property {string} [symbol]
144
- */
145
- /**
146
- * @typedef DeleteConfig
147
- * @property {string} [affiliate_id]
148
- * @property {number} [seller_id]
149
- * @property {string[]} [slug_values]
150
- */
151
- /**
152
- * @typedef DeleteConfigRequest
153
- * @property {DeleteConfig} [data]
140
+ * @property {string} [description]
141
+ * @property {string[]} [allowed_filters]
142
+ * @property {Object} [config_meta]
143
+ * @property {string} [report_type]
144
+ * @property {string} [display_date]
154
145
  */
155
146
  /**
156
- * @typedef DeleteConfigResponse
157
- * @property {string} [message]
147
+ * @typedef GetAffiliateResponse
158
148
  * @property {boolean} [success]
149
+ * @property {Object[]} [docs]
159
150
  */
160
151
  /**
161
152
  * @typedef DownloadCreditDebitNote
@@ -165,480 +156,490 @@ export = FinancePlatformModel;
165
156
  * @typedef DownloadCreditDebitNoteRequest
166
157
  * @property {DownloadCreditDebitNote} [data]
167
158
  */
168
- /**
169
- * @typedef DownloadCreditDebitNoteResponse
170
- * @property {DownloadCreditDebitNoteResponseData[]} [data]
171
- * @property {boolean} [success]
172
- */
173
159
  /**
174
160
  * @typedef DownloadCreditDebitNoteResponseData
175
161
  * @property {string} [id]
176
162
  * @property {string} [pdf_s3_url]
177
163
  */
178
164
  /**
179
- * @typedef DownloadReport
180
- * @property {string} [end_date]
181
- * @property {number} [page]
182
- * @property {number} [pagesize]
183
- * @property {string} [start_date]
184
- */
185
- /**
186
- * @typedef DownloadReportCustomerCnRequest
187
- * @property {CnDownloadReport} [data]
165
+ * @typedef DownloadCreditDebitNoteResponse
166
+ * @property {boolean} [success]
167
+ * @property {DownloadCreditDebitNoteResponseData[]} [data]
188
168
  */
189
169
  /**
190
- * @typedef DownloadReportCustomerCnResponse
191
- * @property {DownloadReportResponseData[]} [data]
170
+ * @typedef PaymentProcessPayload
171
+ * @property {string} [platform]
172
+ * @property {string} [amount]
173
+ * @property {string} [transaction_type]
174
+ * @property {string} [source_reference]
175
+ * @property {string} [total_amount]
176
+ * @property {Object} [meta]
177
+ * @property {string} [currency]
178
+ * @property {string} [seller_id]
179
+ * @property {string} [mode_of_payment]
180
+ * @property {string} [invoice_number]
192
181
  */
193
182
  /**
194
- * @typedef DownloadReportItems
195
- * @property {string} [end_date]
196
- * @property {GenerateReportFilters} [filters]
197
- * @property {GenerateReportMeta} [meta]
198
- * @property {string} [report_id]
199
- * @property {string} [start_date]
200
- * @property {string} [type_of_request]
183
+ * @typedef PaymentProcessRequest
184
+ * @property {PaymentProcessPayload} [data]
201
185
  */
202
186
  /**
203
- * @typedef DownloadReportList
204
- * @property {number} [item_count]
205
- * @property {DownloadReportItems[]} [items]
206
- * @property {Page} [page]
187
+ * @typedef PaymentProcessResponse
188
+ * @property {number} [code]
189
+ * @property {string} [message]
190
+ * @property {Object} [meta]
191
+ * @property {string} [transaction_id]
192
+ * @property {string} [redirect_url]
207
193
  */
208
194
  /**
209
- * @typedef DownloadReportResponseData
210
- * @property {string} [created_at]
211
- * @property {string} [display_name]
212
- * @property {string} [download_link]
213
- * @property {string} [end_date]
214
- * @property {Object} [filters]
215
- * @property {string} [full_name]
216
- * @property {Object} [meta]
217
- * @property {string} [msg]
218
- * @property {string} [report_config_id]
219
- * @property {string} [report_name]
220
- * @property {Object} [request_dict]
221
- * @property {string} [requested_by]
222
- * @property {string} [start_date]
223
- * @property {string} [status]
224
- */
225
- /**
226
- * @typedef Error
227
- * @property {string} [reason]
228
- * @property {boolean} [success]
229
- */
230
- /**
231
- * @typedef GenerateReportCustomerCnRequest
232
- * @property {CnGenerateReport} [data]
195
+ * @typedef CreditlineDataPlatformPayload
196
+ * @property {number} [page]
197
+ * @property {string} [seller_id]
198
+ * @property {string} [end_end]
199
+ * @property {string} [start_end]
200
+ * @property {number} [pagesize]
233
201
  */
234
202
  /**
235
- * @typedef GenerateReportCustomerCnResponse
236
- * @property {GenerateReportCustomerCnResponseData} [data]
203
+ * @typedef CreditlineDataPlatformRequest
204
+ * @property {CreditlineDataPlatformPayload} [data]
237
205
  */
238
206
  /**
239
- * @typedef GenerateReportCustomerCnResponseData
240
- * @property {string[]} [allowed_filters]
241
- * @property {string} [end_date]
207
+ * @typedef CreditlineDataPlatformResponse
208
+ * @property {Object[]} [items]
209
+ * @property {number} [code]
210
+ * @property {boolean} [show_mr]
211
+ * @property {Page} [page]
212
+ * @property {string} [message]
242
213
  * @property {string[]} [headers]
243
214
  * @property {number} [item_count]
244
- * @property {CnGenerateReportItems[]} [items]
245
- * @property {Page} [page]
246
- * @property {string[]} [primary_headers]
247
- * @property {Object} [row_header_display_order]
248
- * @property {string} [start_date]
249
215
  */
250
216
  /**
251
- * @typedef GenerateReportFilters
252
- * @property {string[]} [brand]
253
- * @property {string[]} [channel]
254
- * @property {string[]} [company]
217
+ * @typedef IsCreditlinePayload
218
+ * @property {string} [seller_id]
255
219
  */
256
220
  /**
257
- * @typedef GenerateReportJson
258
- * @property {string} [end_date]
259
- * @property {string[]} [headers]
260
- * @property {number} [item_count]
261
- * @property {string[][]} [items]
262
- * @property {Page} [page]
263
- * @property {string} [start_date]
221
+ * @typedef IsCreditlinePlatformRequest
222
+ * @property {IsCreditlinePayload} [data]
264
223
  */
265
224
  /**
266
- * @typedef GenerateReportMeta
267
- * @property {string} [brand]
268
- * @property {string} [channel]
269
- * @property {string} [company]
225
+ * @typedef IsCreditlinePlatformResponse
226
+ * @property {boolean} [is_creditline_opted]
227
+ * @property {number} [code]
270
228
  */
271
229
  /**
272
- * @typedef GenerateReportPlatform
273
- * @property {string} [end_date]
274
- * @property {GenerateReportFilters} [filters]
275
- * @property {GenerateReportMeta} [meta]
276
- * @property {string} [report_id]
277
- * @property {string} [start_date]
230
+ * @typedef InvoiceTypePayloadData
231
+ * @property {boolean} [is_active]
278
232
  */
279
233
  /**
280
- * @typedef GenerateReportRequest
281
- * @property {GenerateReportPlatform} [data]
234
+ * @typedef InvoiceTypeRequest
235
+ * @property {InvoiceTypePayloadData} [data]
282
236
  */
283
237
  /**
284
- * @typedef GetAffiliate
285
- * @property {number} [company_id]
238
+ * @typedef InvoiceTypeResponseItems
239
+ * @property {string} [text]
240
+ * @property {string} [value]
286
241
  */
287
242
  /**
288
- * @typedef GetAffiliateResponse
289
- * @property {Object[]} [docs]
243
+ * @typedef InvoiceTypeResponse
290
244
  * @property {boolean} [success]
245
+ * @property {InvoiceTypeResponseItems[]} [invoice_type_list]
246
+ * @property {InvoiceTypeResponseItems[]} [payment_status_list]
291
247
  */
292
248
  /**
293
- * @typedef GetCnConfigRequest
294
- * @property {DeleteConfig} [data]
249
+ * @typedef InoviceListingPayloadDataFilters
250
+ * @property {string[]} [payment_status]
251
+ * @property {string[]} [invoice_type]
252
+ * @property {string[]} [company_id]
295
253
  */
296
254
  /**
297
- * @typedef GetCnConfigResponse
298
- * @property {GetCnConfigResponseData} [data]
299
- * @property {boolean} [success]
255
+ * @typedef InvoiceListingPayloadData
256
+ * @property {number} [page_size]
257
+ * @property {number} [page]
258
+ * @property {string} [start_date]
259
+ * @property {string} [end_date]
260
+ * @property {string} [search]
261
+ * @property {InoviceListingPayloadDataFilters} [filters]
300
262
  */
301
263
  /**
302
- * @typedef GetCnConfigResponseData
303
- * @property {string} [affiliate_id]
304
- * @property {string} [currency_type]
305
- * @property {boolean} [is_cn_as_refund_method]
306
- * @property {GetCnConfigResponseMeta} [meta]
307
- * @property {CreditNoteConfigNotificationEvents} [notification_events]
308
- * @property {string[]} [redemption_ordering_channel]
309
- * @property {number} [seller_id]
310
- * @property {number} [validity]
264
+ * @typedef InvoiceListingRequest
265
+ * @property {InvoiceListingPayloadData} [data]
311
266
  */
312
267
  /**
313
- * @typedef GetCnConfigResponseMeta
314
- * @property {string} [reason]
315
- * @property {string[]} [source_channel]
268
+ * @typedef UnpaidInvoiceDataItems
269
+ * @property {number} [total_unpaid_invoice_count]
270
+ * @property {string} [currency]
271
+ * @property {number} [total_unpaid_amount]
316
272
  */
317
273
  /**
318
- * @typedef GetCustomerCreditBalance
319
- * @property {string} [affiliate_id]
320
- * @property {string} [customer_mobile_number]
321
- * @property {number} [seller_id]
274
+ * @typedef InvoiceListingResponseItems
275
+ * @property {string} [amount]
276
+ * @property {string} [company]
277
+ * @property {string} [status]
278
+ * @property {string} [due_date]
279
+ * @property {string} [invoice_date]
280
+ * @property {string} [invoice_type]
281
+ * @property {string} [period]
282
+ * @property {string} [invoice_number]
283
+ * @property {boolean} [is_downloadable]
284
+ * @property {string} [invoice_id]
285
+ * @property {Currency} [currency]
322
286
  */
323
287
  /**
324
- * @typedef GetCustomerCreditBalanceRequest
325
- * @property {GetCustomerCreditBalance} [data]
288
+ * @typedef InvoiceListingResponse
289
+ * @property {UnpaidInvoiceDataItems} [unpaid_invoice_data]
290
+ * @property {InvoiceListingResponseItems[]} [items]
291
+ * @property {Page} [page]
292
+ * @property {number} [item_count]
326
293
  */
327
294
  /**
328
- * @typedef GetCustomerCreditBalanceResponse
329
- * @property {GetCustomerCreditBalanceResponseData} [data]
330
- * @property {boolean} [success]
295
+ * @typedef InvoicePdfPayloadData
296
+ * @property {string[]} [invoice_number]
331
297
  */
332
298
  /**
333
- * @typedef GetCustomerCreditBalanceResponseData
334
- * @property {string} [customer_mobile_number]
335
- * @property {number} [total_credited_balance]
299
+ * @typedef InvoicePdfRequest
300
+ * @property {InvoicePdfPayloadData} [data]
336
301
  */
337
302
  /**
338
- * @typedef GetEngineData
339
- * @property {Object} [filters]
340
- * @property {string[]} [project]
341
- * @property {string} [table_name]
303
+ * @typedef InvoicePdfResponse
304
+ * @property {boolean} [success]
305
+ * @property {string[]} [data]
306
+ * @property {string[]} [error]
342
307
  */
343
308
  /**
344
- * @typedef GetEngineRequest
345
- * @property {GetEngineData} [data]
309
+ * @typedef IsCnRefundMethodData
310
+ * @property {string} [affiliate_id]
311
+ * @property {boolean} [toggle_edit_required]
312
+ * @property {number} [seller_id]
346
313
  */
347
314
  /**
348
- * @typedef GetEngineResponse
349
- * @property {number} [item_count]
350
- * @property {Object[]} [items]
351
- * @property {Page} [page]
352
- * @property {boolean} [success]
315
+ * @typedef IsCnRefundMethodRequest
316
+ * @property {IsCnRefundMethodData} [data]
353
317
  */
354
318
  /**
355
- * @typedef GetPdfUrlViewRequest
356
- * @property {CnReferenceNumber} [data]
319
+ * @typedef IsCnRefundMethodResponseData
320
+ * @property {boolean} [is_first_time_user]
357
321
  */
358
322
  /**
359
- * @typedef GetPdfUrlViewResponse
360
- * @property {GetPdfUrlViewResponseData} [data]
323
+ * @typedef IsCnRefundMethodResponse
361
324
  * @property {boolean} [success]
325
+ * @property {IsCnRefundMethodResponseData} [data]
362
326
  */
363
327
  /**
364
- * @typedef GetPdfUrlViewResponseData
365
- * @property {string} [cn_reference_number]
366
- * @property {string} [s3_pdf_link]
328
+ * @typedef CreditNoteConfigNotificationEvents
329
+ * @property {number} [expiration_reminder_to_customer]
367
330
  */
368
331
  /**
369
- * @typedef GetReason
370
- * @property {string} [reason_type]
332
+ * @typedef CreateSellerCreditNoteConfig
333
+ * @property {boolean} [is_cn_as_refund_method]
334
+ * @property {string} [affiliate_id]
335
+ * @property {string[]} [source_channel]
336
+ * @property {number} [seller_id]
337
+ * @property {CreditNoteConfigNotificationEvents} [notification_events]
338
+ * @property {string} [sales_channel_name]
339
+ * @property {string[]} [ordering_channel]
340
+ * @property {number} [validity]
341
+ * @property {string} [currency_type]
342
+ * @property {string[]} [slug_values]
371
343
  */
372
344
  /**
373
- * @typedef GetReasonRequest
374
- * @property {GetReason} [data]
345
+ * @typedef CreateSellerCreditNoteConfigRequest
346
+ * @property {CreateSellerCreditNoteConfig} [data]
375
347
  */
376
348
  /**
377
- * @typedef GetReasonResponse
378
- * @property {number} [item_count]
379
- * @property {ReasonItem[]} [item_list]
380
- * @property {Page} [page]
349
+ * @typedef CreateSellerCreditNoteConfigResponse
381
350
  * @property {boolean} [success]
351
+ * @property {string} [message]
382
352
  */
383
353
  /**
384
- * @typedef GetReportingFilters
385
- * @property {Object[]} [options]
386
- * @property {string} [text]
387
- * @property {string} [type]
388
- * @property {string} [value]
389
- */
390
- /**
391
- * @typedef GetReportingFiltersResponse
392
- * @property {GetReportingNestedFilters[]} [filters]
393
- * @property {GetReportingFilters} [search]
394
- * @property {GetReportingFilters} [status]
354
+ * @typedef DeleteConfig
355
+ * @property {string} [affiliate_id]
356
+ * @property {string[]} [slug_values]
357
+ * @property {number} [seller_id]
395
358
  */
396
359
  /**
397
- * @typedef GetReportingNestedFilters
398
- * @property {Object[]} [options]
399
- * @property {string} [placeholder_text]
400
- * @property {boolean} [required]
401
- * @property {string} [text]
402
- * @property {string} [type]
403
- * @property {string} [value]
360
+ * @typedef DeleteConfigRequest
361
+ * @property {DeleteConfig} [data]
404
362
  */
405
363
  /**
406
- * @typedef GetReportListData
407
- * @property {boolean} [listing_enabled]
408
- * @property {string} [role_name]
364
+ * @typedef DeleteConfigResponse
365
+ * @property {boolean} [success]
366
+ * @property {string} [message]
409
367
  */
410
368
  /**
411
- * @typedef GetReportListRequest
412
- * @property {GetReportListData} [data]
369
+ * @typedef ChannelDisplayName
370
+ * @property {string} [platform_pos]
413
371
  */
414
372
  /**
415
- * @typedef GetReportListResponse
416
- * @property {ReportItem[]} [items]
417
- * @property {Page} [page]
373
+ * @typedef ChannelDisplayNameResponse
418
374
  * @property {boolean} [success]
419
- * @property {number} [total_count]
375
+ * @property {ChannelDisplayName} [data]
420
376
  */
421
377
  /**
422
- * @typedef InoviceListingPayloadDataFilters
423
- * @property {string[]} [company_id]
424
- * @property {string[]} [invoice_type]
425
- * @property {string[]} [payment_status]
378
+ * @typedef CnReferenceNumber
379
+ * @property {string} [cn_reference_number]
426
380
  */
427
381
  /**
428
- * @typedef InvoiceActivityLogError
429
- * @property {string} [reason]
382
+ * @typedef GetPdfUrlViewRequest
383
+ * @property {CnReferenceNumber} [data]
430
384
  */
431
385
  /**
432
- * @typedef InvoiceActivityLogsResponse
433
- * @property {InvoiceActivityLogsResponseData[]} [data]
386
+ * @typedef GetPdfUrlViewResponseData
387
+ * @property {string} [s3_pdf_link]
388
+ * @property {string} [cn_reference_number]
434
389
  */
435
390
  /**
436
- * @typedef InvoiceActivityLogsResponseData
437
- * @property {boolean} [is_resolved]
438
- * @property {number} [max_retry_attempts]
439
- * @property {string} [performed_by]
440
- * @property {string} [reason]
441
- * @property {number} [retry_attempts]
442
- * @property {string} [status]
391
+ * @typedef GetPdfUrlViewResponse
392
+ * @property {boolean} [success]
393
+ * @property {GetPdfUrlViewResponseData} [data]
443
394
  */
444
395
  /**
445
- * @typedef InvoiceListingPayloadData
446
- * @property {string} [end_date]
447
- * @property {InoviceListingPayloadDataFilters} [filters]
448
- * @property {number} [page]
449
- * @property {number} [page_size]
450
- * @property {string} [search]
451
- * @property {string} [start_date]
396
+ * @typedef CreditNoteDetailsRequest
397
+ * @property {CnReferenceNumber} [data]
452
398
  */
453
399
  /**
454
- * @typedef InvoiceListingRequest
455
- * @property {InvoiceListingPayloadData} [data]
400
+ * @typedef CnDetails
401
+ * @property {string} [staff_id]
402
+ * @property {string} [expiry_date]
403
+ * @property {string} [channel_of_issuance]
404
+ * @property {string} [order_id]
405
+ * @property {string} [date_issued]
406
+ * @property {string} [ordering_channel]
407
+ * @property {string} [shipment_id]
408
+ * @property {string} [store_id]
409
+ * @property {string} [invoice_number]
456
410
  */
457
411
  /**
458
- * @typedef InvoiceListingResponse
459
- * @property {number} [item_count]
460
- * @property {InvoiceListingResponseItems[]} [items]
461
- * @property {Page} [page]
462
- * @property {UnpaidInvoiceDataItems} [unpaid_invoice_data]
412
+ * @typedef RedemptionDetails
413
+ * @property {string} [staff_id]
414
+ * @property {string} [created_at]
415
+ * @property {string} [order_id]
416
+ * @property {string} [store_id]
417
+ * @property {string} [shipment_id]
418
+ * @property {string} [ordering_channel]
419
+ * @property {number} [amount_debited]
420
+ * @property {string} [invoice_number]
463
421
  */
464
422
  /**
465
- * @typedef InvoiceListingResponseItems
466
- * @property {string} [amount]
467
- * @property {string} [company]
468
- * @property {Currency} [currency]
469
- * @property {string} [due_date]
470
- * @property {string} [invoice_date]
471
- * @property {string} [invoice_id]
472
- * @property {string} [invoice_number]
473
- * @property {string} [invoice_type]
474
- * @property {boolean} [is_downloadable]
475
- * @property {string} [period]
476
- * @property {string} [status]
423
+ * @typedef CreditNoteDetails
424
+ * @property {string} [cn_status]
425
+ * @property {string} [customer_mobile_number]
426
+ * @property {string} [cn_reference_number]
427
+ * @property {CnDetails} [cn_details]
428
+ * @property {RedemptionDetails[]} [redemption_details]
429
+ * @property {number} [remaining_cn_amount]
430
+ * @property {number} [available_cn_balance]
431
+ * @property {number} [cn_amount]
477
432
  */
478
433
  /**
479
- * @typedef InvoicePaymentDetailsResponse
480
- * @property {InvoicePaymentDetailsResponseData} [data]
481
- * @property {boolean} [payment_details_visible]
434
+ * @typedef CreditNoteDetailsResponse
482
435
  * @property {boolean} [success]
436
+ * @property {CreditNoteDetails} [data]
483
437
  */
484
438
  /**
485
- * @typedef InvoicePaymentDetailsResponseData
486
- * @property {Object[]} [failed_attempts_details]
487
- * @property {PaidInvoicePaymentDetail[]} [paid_invoice_payment_details]
439
+ * @typedef GetCustomerCreditBalance
440
+ * @property {string} [affiliate_id]
441
+ * @property {number} [seller_id]
442
+ * @property {string} [customer_mobile_number]
488
443
  */
489
444
  /**
490
- * @typedef InvoicePdfPayloadData
491
- * @property {string[]} [invoice_number]
445
+ * @typedef GetCustomerCreditBalanceRequest
446
+ * @property {GetCustomerCreditBalance} [data]
492
447
  */
493
448
  /**
494
- * @typedef InvoicePdfRequest
495
- * @property {InvoicePdfPayloadData} [data]
449
+ * @typedef GetCustomerCreditBalanceResponseData
450
+ * @property {string} [customer_mobile_number]
451
+ * @property {number} [total_credited_balance]
496
452
  */
497
453
  /**
498
- * @typedef InvoicePdfResponse
499
- * @property {string[]} [data]
500
- * @property {string[]} [error]
454
+ * @typedef GetCustomerCreditBalanceResponse
501
455
  * @property {boolean} [success]
456
+ * @property {GetCustomerCreditBalanceResponseData} [data]
502
457
  */
503
458
  /**
504
- * @typedef InvoiceTypePayloadData
505
- * @property {boolean} [is_active]
459
+ * @typedef GetCnConfigRequest
460
+ * @property {DeleteConfig} [data]
506
461
  */
507
462
  /**
508
- * @typedef InvoiceTypeRequest
509
- * @property {InvoiceTypePayloadData} [data]
463
+ * @typedef GetCnConfigResponseMeta
464
+ * @property {string} [reason]
465
+ * @property {string[]} [source_channel]
510
466
  */
511
467
  /**
512
- * @typedef InvoiceTypeResponse
513
- * @property {InvoiceTypeResponseItems[]} [invoice_type_list]
514
- * @property {InvoiceTypeResponseItems[]} [payment_status_list]
468
+ * @typedef GetCnConfigResponseData
469
+ * @property {boolean} [is_cn_as_refund_method]
470
+ * @property {string} [affiliate_id]
471
+ * @property {GetCnConfigResponseMeta} [meta]
472
+ * @property {number} [seller_id]
473
+ * @property {CreditNoteConfigNotificationEvents} [notification_events]
474
+ * @property {number} [validity]
475
+ * @property {string[]} [redemption_ordering_channel]
476
+ * @property {string} [currency_type]
477
+ */
478
+ /**
479
+ * @typedef GetCnConfigResponse
515
480
  * @property {boolean} [success]
481
+ * @property {GetCnConfigResponseData} [data]
516
482
  */
517
483
  /**
518
- * @typedef InvoiceTypeResponseItems
519
- * @property {string} [text]
520
- * @property {string} [value]
484
+ * @typedef CnGenerateReportFilters
485
+ * @property {string[]} [staff_id]
486
+ * @property {string[]} [channel_of_issuance]
487
+ * @property {string[]} [utilisation]
488
+ * @property {string[]} [ordering_channel]
489
+ * @property {number[]} [store_id]
490
+ * @property {string[]} [types_of_transaction]
521
491
  */
522
492
  /**
523
- * @typedef IsCnRefundMethodData
493
+ * @typedef CnGenerateReport
494
+ * @property {number} [page]
495
+ * @property {string} [end_date]
496
+ * @property {number} [pagesize]
497
+ * @property {CnGenerateReportFilters} [filters]
524
498
  * @property {string} [affiliate_id]
525
- * @property {number} [seller_id]
526
- * @property {boolean} [toggle_edit_required]
499
+ * @property {GenerateReportFilters} [meta]
500
+ * @property {string} [search]
501
+ * @property {string} [report_id]
502
+ * @property {string} [search_type]
503
+ * @property {string} [start_date]
527
504
  */
528
505
  /**
529
- * @typedef IsCnRefundMethodRequest
530
- * @property {IsCnRefundMethodData} [data]
506
+ * @typedef GenerateReportCustomerCnRequest
507
+ * @property {CnGenerateReport} [data]
531
508
  */
532
509
  /**
533
- * @typedef IsCnRefundMethodResponse
534
- * @property {IsCnRefundMethodResponseData} [data]
535
- * @property {boolean} [success]
510
+ * @typedef CnGenerateReportItems
511
+ * @property {string} [expiry_date]
512
+ * @property {string} [status]
513
+ * @property {number} [total_amount]
514
+ * @property {string} [order_id]
515
+ * @property {string} [date_issued]
516
+ * @property {string} [shipment_id]
517
+ * @property {string} [invoice_number]
518
+ * @property {string} [credit_note_number]
536
519
  */
537
520
  /**
538
- * @typedef IsCnRefundMethodResponseData
539
- * @property {boolean} [is_first_time_user]
521
+ * @typedef GenerateReportCustomerCnResponseData
522
+ * @property {CnGenerateReportItems[]} [items]
523
+ * @property {Object} [row_header_display_order]
524
+ * @property {string} [end_date]
525
+ * @property {Page} [page]
526
+ * @property {string[]} [headers]
527
+ * @property {string[]} [primary_headers]
528
+ * @property {string[]} [allowed_filters]
529
+ * @property {string} [start_date]
530
+ * @property {number} [item_count]
540
531
  */
541
532
  /**
542
- * @typedef IsCreditlinePayload
543
- * @property {string} [seller_id]
533
+ * @typedef GenerateReportCustomerCnResponse
534
+ * @property {GenerateReportCustomerCnResponseData} [data]
544
535
  */
545
536
  /**
546
- * @typedef IsCreditlinePlatformRequest
547
- * @property {IsCreditlinePayload} [data]
537
+ * @typedef CnDownloadReport
538
+ * @property {number} [page]
539
+ * @property {string} [start_date]
540
+ * @property {string} [end_date]
541
+ * @property {string} [affiliate_id]
542
+ * @property {string} [search]
543
+ * @property {string[]} [status]
544
+ * @property {string} [search_type]
545
+ * @property {number} [pagesize]
548
546
  */
549
547
  /**
550
- * @typedef IsCreditlinePlatformResponse
551
- * @property {number} [code]
552
- * @property {boolean} [is_creditline_opted]
548
+ * @typedef DownloadReportCustomerCnRequest
549
+ * @property {CnDownloadReport} [data]
553
550
  */
554
551
  /**
555
- * @typedef Page
556
- * @property {number} [current]
557
- * @property {boolean} [has_next]
558
- * @property {boolean} [has_previous]
559
- * @property {number} [item_total]
560
- * @property {string} [next_id]
561
- * @property {number} [size]
562
- * @property {string} type
552
+ * @typedef DownloadReportResponseData
553
+ * @property {string} [report_config_id]
554
+ * @property {string} [full_name]
555
+ * @property {string} [requested_by]
556
+ * @property {string} [start_date]
557
+ * @property {string} [end_date]
558
+ * @property {Object} [request_dict]
559
+ * @property {string} [download_link]
560
+ * @property {string} [created_at]
561
+ * @property {Object} [meta]
562
+ * @property {string} [msg]
563
+ * @property {string} [report_name]
564
+ * @property {string} [status]
565
+ * @property {string} [display_name]
566
+ * @property {Object} [filters]
563
567
  */
564
568
  /**
565
- * @typedef PaidInvoicePaymentDetail
566
- * @property {number} [amount]
567
- * @property {string} [date_of_payment]
568
- * @property {PaymentDetail[]} [payment_details]
569
+ * @typedef DownloadReportCustomerCnResponse
570
+ * @property {DownloadReportResponseData[]} [data]
569
571
  */
570
572
  /**
571
- * @typedef PaymentDetail
572
- * @property {string} [display_name]
573
+ * @typedef GetReportingFilters
574
+ * @property {string} [text]
575
+ * @property {string} [type]
576
+ * @property {Object[]} [options]
573
577
  * @property {string} [value]
574
578
  */
575
579
  /**
576
- * @typedef PaymentProcessPayload
577
- * @property {string} [amount]
578
- * @property {string} [currency]
579
- * @property {string} [invoice_number]
580
- * @property {Object} [meta]
581
- * @property {string} [mode_of_payment]
582
- * @property {string} [platform]
583
- * @property {string} [seller_id]
584
- * @property {string} [source_reference]
585
- * @property {string} [total_amount]
586
- * @property {string} [transaction_type]
580
+ * @typedef GetReportingNestedFilters
581
+ * @property {string} [text]
582
+ * @property {Object[]} [options]
583
+ * @property {boolean} [required]
584
+ * @property {string} [placeholder_text]
585
+ * @property {string} [type]
586
+ * @property {string} [value]
587
587
  */
588
588
  /**
589
- * @typedef PaymentProcessRequest
590
- * @property {PaymentProcessPayload} [data]
589
+ * @typedef GetReportingFiltersResponse
590
+ * @property {GetReportingFilters} [search]
591
+ * @property {GetReportingNestedFilters[]} [filters]
592
+ * @property {GetReportingFilters} [status]
591
593
  */
592
594
  /**
593
- * @typedef PaymentProcessResponse
594
- * @property {number} [code]
595
- * @property {string} [message]
596
- * @property {Object} [meta]
597
- * @property {string} [redirect_url]
598
- * @property {string} [transaction_id]
595
+ * @typedef PaymentDetail
596
+ * @property {string} [display_name]
597
+ * @property {string} [value]
599
598
  */
600
599
  /**
601
- * @typedef ReasonItem
602
- * @property {string} [display_name]
603
- * @property {string} [id]
604
- * @property {string} [name]
600
+ * @typedef PaidInvoicePaymentDetail
601
+ * @property {PaymentDetail[]} [payment_details]
602
+ * @property {string} [date_of_payment]
603
+ * @property {number} [amount]
605
604
  */
606
605
  /**
607
- * @typedef RedemptionDetails
608
- * @property {number} [amount_debited]
609
- * @property {string} [created_at]
610
- * @property {string} [invoice_number]
611
- * @property {string} [order_id]
612
- * @property {string} [ordering_channel]
613
- * @property {string} [shipment_id]
614
- * @property {string} [staff_id]
615
- * @property {string} [store_id]
606
+ * @typedef InvoicePaymentDetailsResponseData
607
+ * @property {PaidInvoicePaymentDetail[]} [paid_invoice_payment_details]
608
+ * @property {Object[]} [failed_attempts_details]
616
609
  */
617
610
  /**
618
- * @typedef ReportItem
619
- * @property {string[]} [allowed_filters]
620
- * @property {Object} [config_meta]
621
- * @property {string} [description]
622
- * @property {string} [display_date]
623
- * @property {string} [id]
624
- * @property {string} [name]
625
- * @property {string} [report_type]
611
+ * @typedef InvoicePaymentDetailsResponse
612
+ * @property {InvoicePaymentDetailsResponseData} [data]
613
+ * @property {boolean} [success]
614
+ * @property {boolean} [payment_details_visible]
626
615
  */
627
616
  /**
628
- * @typedef UnlockCreditNoteRequest
629
- * @property {UnlockCreditNoteRequestData} [data]
617
+ * @typedef InvoiceActivityLogsResponseData
618
+ * @property {string} [performed_by]
619
+ * @property {string} [status]
620
+ * @property {string} [reason]
621
+ * @property {boolean} [is_resolved]
622
+ * @property {number} [retry_attempts]
623
+ * @property {number} [max_retry_attempts]
624
+ */
625
+ /**
626
+ * @typedef InvoiceActivityLogsResponse
627
+ * @property {InvoiceActivityLogsResponseData[]} [data]
628
+ */
629
+ /**
630
+ * @typedef InvoiceActivityLogError
631
+ * @property {string} [reason]
630
632
  */
631
633
  /**
632
634
  * @typedef UnlockCreditNoteRequestData
633
- * @property {string} [description]
634
- * @property {string[]} [locked_credit_notes]
635
635
  * @property {string} [seller_id]
636
+ * @property {string[]} [locked_credit_notes]
636
637
  * @property {string} [unlock_reason]
638
+ * @property {string} [description]
637
639
  */
638
640
  /**
639
- * @typedef UnlockCreditNoteResponse
640
- * @property {UnlockCreditNoteResponseData} [data]
641
- * @property {boolean} [success]
641
+ * @typedef UnlockCreditNoteRequest
642
+ * @property {UnlockCreditNoteRequestData} [data]
642
643
  */
643
644
  /**
644
645
  * @typedef UnlockCreditNoteResponseData
@@ -646,195 +647,187 @@ export = FinancePlatformModel;
646
647
  * @property {string} [status]
647
648
  */
648
649
  /**
649
- * @typedef UnpaidInvoiceDataItems
650
- * @property {string} [currency]
651
- * @property {number} [total_unpaid_amount]
652
- * @property {number} [total_unpaid_invoice_count]
650
+ * @typedef UnlockCreditNoteResponse
651
+ * @property {boolean} [success]
652
+ * @property {UnlockCreditNoteResponseData} [data]
653
653
  */
654
654
  declare class FinancePlatformModel {
655
655
  }
656
656
  declare namespace FinancePlatformModel {
657
- export { ChannelDisplayName, ChannelDisplayNameResponse, CnDetails, CnDownloadReport, CnGenerateReport, CnGenerateReportFilters, CnGenerateReportItems, CnReferenceNumber, CreateSellerCreditNoteConfig, CreateSellerCreditNoteConfigRequest, CreateSellerCreditNoteConfigResponse, CreditlineDataPlatformPayload, CreditlineDataPlatformRequest, CreditlineDataPlatformResponse, CreditNoteConfigNotificationEvents, CreditNoteDetails, CreditNoteDetailsRequest, CreditNoteDetailsResponse, Currency, DeleteConfig, DeleteConfigRequest, DeleteConfigResponse, DownloadCreditDebitNote, DownloadCreditDebitNoteRequest, DownloadCreditDebitNoteResponse, DownloadCreditDebitNoteResponseData, DownloadReport, DownloadReportCustomerCnRequest, DownloadReportCustomerCnResponse, DownloadReportItems, DownloadReportList, DownloadReportResponseData, Error, GenerateReportCustomerCnRequest, GenerateReportCustomerCnResponse, GenerateReportCustomerCnResponseData, GenerateReportFilters, GenerateReportJson, GenerateReportMeta, GenerateReportPlatform, GenerateReportRequest, GetAffiliate, GetAffiliateResponse, GetCnConfigRequest, GetCnConfigResponse, GetCnConfigResponseData, GetCnConfigResponseMeta, GetCustomerCreditBalance, GetCustomerCreditBalanceRequest, GetCustomerCreditBalanceResponse, GetCustomerCreditBalanceResponseData, GetEngineData, GetEngineRequest, GetEngineResponse, GetPdfUrlViewRequest, GetPdfUrlViewResponse, GetPdfUrlViewResponseData, GetReason, GetReasonRequest, GetReasonResponse, GetReportingFilters, GetReportingFiltersResponse, GetReportingNestedFilters, GetReportListData, GetReportListRequest, GetReportListResponse, InoviceListingPayloadDataFilters, InvoiceActivityLogError, InvoiceActivityLogsResponse, InvoiceActivityLogsResponseData, InvoiceListingPayloadData, InvoiceListingRequest, InvoiceListingResponse, InvoiceListingResponseItems, InvoicePaymentDetailsResponse, InvoicePaymentDetailsResponseData, InvoicePdfPayloadData, InvoicePdfRequest, InvoicePdfResponse, InvoiceTypePayloadData, InvoiceTypeRequest, InvoiceTypeResponse, InvoiceTypeResponseItems, IsCnRefundMethodData, IsCnRefundMethodRequest, IsCnRefundMethodResponse, IsCnRefundMethodResponseData, IsCreditlinePayload, IsCreditlinePlatformRequest, IsCreditlinePlatformResponse, Page, PaidInvoicePaymentDetail, PaymentDetail, PaymentProcessPayload, PaymentProcessRequest, PaymentProcessResponse, ReasonItem, RedemptionDetails, ReportItem, UnlockCreditNoteRequest, UnlockCreditNoteRequestData, UnlockCreditNoteResponse, UnlockCreditNoteResponseData, UnpaidInvoiceDataItems };
657
+ export { GenerateReportMeta, GenerateReportFilters, GenerateReportPlatform, GenerateReportRequest, Page, Currency, GenerateReportJson, Error, DownloadReport, DownloadReportItems, DownloadReportList, GetEngineData, GetEngineRequest, GetEngineResponse, GetReason, GetReasonRequest, ReasonItem, GetReasonResponse, GetReportListData, GetReportListRequest, GetAffiliate, GetReportListResponse, ReportItem, GetAffiliateResponse, DownloadCreditDebitNote, DownloadCreditDebitNoteRequest, DownloadCreditDebitNoteResponseData, DownloadCreditDebitNoteResponse, PaymentProcessPayload, PaymentProcessRequest, PaymentProcessResponse, CreditlineDataPlatformPayload, CreditlineDataPlatformRequest, CreditlineDataPlatformResponse, IsCreditlinePayload, IsCreditlinePlatformRequest, IsCreditlinePlatformResponse, InvoiceTypePayloadData, InvoiceTypeRequest, InvoiceTypeResponseItems, InvoiceTypeResponse, InoviceListingPayloadDataFilters, InvoiceListingPayloadData, InvoiceListingRequest, UnpaidInvoiceDataItems, InvoiceListingResponseItems, InvoiceListingResponse, InvoicePdfPayloadData, InvoicePdfRequest, InvoicePdfResponse, IsCnRefundMethodData, IsCnRefundMethodRequest, IsCnRefundMethodResponseData, IsCnRefundMethodResponse, CreditNoteConfigNotificationEvents, CreateSellerCreditNoteConfig, CreateSellerCreditNoteConfigRequest, CreateSellerCreditNoteConfigResponse, DeleteConfig, DeleteConfigRequest, DeleteConfigResponse, ChannelDisplayName, ChannelDisplayNameResponse, CnReferenceNumber, GetPdfUrlViewRequest, GetPdfUrlViewResponseData, GetPdfUrlViewResponse, CreditNoteDetailsRequest, CnDetails, RedemptionDetails, CreditNoteDetails, CreditNoteDetailsResponse, GetCustomerCreditBalance, GetCustomerCreditBalanceRequest, GetCustomerCreditBalanceResponseData, GetCustomerCreditBalanceResponse, GetCnConfigRequest, GetCnConfigResponseMeta, GetCnConfigResponseData, GetCnConfigResponse, CnGenerateReportFilters, CnGenerateReport, GenerateReportCustomerCnRequest, CnGenerateReportItems, GenerateReportCustomerCnResponseData, GenerateReportCustomerCnResponse, CnDownloadReport, DownloadReportCustomerCnRequest, DownloadReportResponseData, DownloadReportCustomerCnResponse, GetReportingFilters, GetReportingNestedFilters, GetReportingFiltersResponse, PaymentDetail, PaidInvoicePaymentDetail, InvoicePaymentDetailsResponseData, InvoicePaymentDetailsResponse, InvoiceActivityLogsResponseData, InvoiceActivityLogsResponse, InvoiceActivityLogError, UnlockCreditNoteRequestData, UnlockCreditNoteRequest, UnlockCreditNoteResponseData, UnlockCreditNoteResponse };
658
658
  }
659
- /** @returns {ChannelDisplayName} */
660
- declare function ChannelDisplayName(): ChannelDisplayName;
661
- type ChannelDisplayName = {
662
- platform_pos?: string;
663
- };
664
- /** @returns {ChannelDisplayNameResponse} */
665
- declare function ChannelDisplayNameResponse(): ChannelDisplayNameResponse;
666
- type ChannelDisplayNameResponse = {
667
- data?: ChannelDisplayName;
668
- success?: boolean;
659
+ /** @returns {GenerateReportMeta} */
660
+ declare function GenerateReportMeta(): GenerateReportMeta;
661
+ type GenerateReportMeta = {
662
+ brand?: string;
663
+ company?: string;
664
+ channel?: string;
669
665
  };
670
- /** @returns {CnDetails} */
671
- declare function CnDetails(): CnDetails;
672
- type CnDetails = {
673
- channel_of_issuance?: string;
674
- date_issued?: string;
675
- expiry_date?: string;
676
- invoice_number?: string;
677
- order_id?: string;
678
- ordering_channel?: string;
679
- shipment_id?: string;
680
- staff_id?: string;
681
- store_id?: string;
666
+ /** @returns {GenerateReportFilters} */
667
+ declare function GenerateReportFilters(): GenerateReportFilters;
668
+ type GenerateReportFilters = {
669
+ brand?: string[];
670
+ company?: string[];
671
+ channel?: string[];
682
672
  };
683
- /** @returns {CnDownloadReport} */
684
- declare function CnDownloadReport(): CnDownloadReport;
685
- type CnDownloadReport = {
686
- affiliate_id?: string;
687
- end_date?: string;
688
- page?: number;
689
- pagesize?: number;
690
- search?: string;
691
- search_type?: string;
673
+ /** @returns {GenerateReportPlatform} */
674
+ declare function GenerateReportPlatform(): GenerateReportPlatform;
675
+ type GenerateReportPlatform = {
692
676
  start_date?: string;
693
- status?: string[];
694
- };
695
- /** @returns {CnGenerateReport} */
696
- declare function CnGenerateReport(): CnGenerateReport;
697
- type CnGenerateReport = {
698
- affiliate_id?: string;
699
677
  end_date?: string;
700
- filters?: CnGenerateReportFilters;
701
- meta?: GenerateReportFilters;
702
- page?: number;
703
- pagesize?: number;
678
+ meta?: GenerateReportMeta;
704
679
  report_id?: string;
705
- search?: string;
706
- search_type?: string;
707
- start_date?: string;
708
- };
709
- /** @returns {CnGenerateReportFilters} */
710
- declare function CnGenerateReportFilters(): CnGenerateReportFilters;
711
- type CnGenerateReportFilters = {
712
- channel_of_issuance?: string[];
713
- ordering_channel?: string[];
714
- staff_id?: string[];
715
- store_id?: number[];
716
- types_of_transaction?: string[];
717
- utilisation?: string[];
680
+ filters?: GenerateReportFilters;
718
681
  };
719
- /** @returns {CnGenerateReportItems} */
720
- declare function CnGenerateReportItems(): CnGenerateReportItems;
721
- type CnGenerateReportItems = {
722
- credit_note_number?: string;
723
- date_issued?: string;
724
- expiry_date?: string;
725
- invoice_number?: string;
726
- order_id?: string;
727
- shipment_id?: string;
728
- status?: string;
729
- total_amount?: number;
682
+ /** @returns {GenerateReportRequest} */
683
+ declare function GenerateReportRequest(): GenerateReportRequest;
684
+ type GenerateReportRequest = {
685
+ data?: GenerateReportPlatform;
730
686
  };
731
- /** @returns {CnReferenceNumber} */
732
- declare function CnReferenceNumber(): CnReferenceNumber;
733
- type CnReferenceNumber = {
734
- cn_reference_number?: string;
687
+ /** @returns {Page} */
688
+ declare function Page(): Page;
689
+ type Page = {
690
+ item_total?: number;
691
+ next_id?: string;
692
+ has_previous?: boolean;
693
+ has_next?: boolean;
694
+ current?: number;
695
+ type: string;
696
+ size?: number;
735
697
  };
736
- /** @returns {CreateSellerCreditNoteConfig} */
737
- declare function CreateSellerCreditNoteConfig(): CreateSellerCreditNoteConfig;
738
- type CreateSellerCreditNoteConfig = {
739
- affiliate_id?: string;
740
- currency_type?: string;
741
- is_cn_as_refund_method?: boolean;
742
- notification_events?: CreditNoteConfigNotificationEvents;
743
- ordering_channel?: string[];
744
- sales_channel_name?: string;
745
- seller_id?: number;
746
- slug_values?: string[];
747
- source_channel?: string[];
748
- validity?: number;
698
+ /** @returns {Currency} */
699
+ declare function Currency(): Currency;
700
+ type Currency = {
701
+ code?: string;
702
+ symbol?: string;
703
+ name?: string;
749
704
  };
750
- /** @returns {CreateSellerCreditNoteConfigRequest} */
751
- declare function CreateSellerCreditNoteConfigRequest(): CreateSellerCreditNoteConfigRequest;
752
- type CreateSellerCreditNoteConfigRequest = {
753
- data?: CreateSellerCreditNoteConfig;
705
+ /** @returns {GenerateReportJson} */
706
+ declare function GenerateReportJson(): GenerateReportJson;
707
+ type GenerateReportJson = {
708
+ items?: string[][];
709
+ page?: Page;
710
+ end_date?: string;
711
+ headers?: string[];
712
+ start_date?: string;
713
+ item_count?: number;
754
714
  };
755
- /** @returns {CreateSellerCreditNoteConfigResponse} */
756
- declare function CreateSellerCreditNoteConfigResponse(): CreateSellerCreditNoteConfigResponse;
757
- type CreateSellerCreditNoteConfigResponse = {
758
- message?: string;
715
+ /** @returns {Error} */
716
+ declare function Error(): Error;
717
+ type Error = {
718
+ reason?: string;
759
719
  success?: boolean;
760
720
  };
761
- /** @returns {CreditlineDataPlatformPayload} */
762
- declare function CreditlineDataPlatformPayload(): CreditlineDataPlatformPayload;
763
- type CreditlineDataPlatformPayload = {
764
- end_end?: string;
721
+ /** @returns {DownloadReport} */
722
+ declare function DownloadReport(): DownloadReport;
723
+ type DownloadReport = {
765
724
  page?: number;
766
725
  pagesize?: number;
767
- seller_id?: string;
768
- start_end?: string;
726
+ start_date?: string;
727
+ end_date?: string;
769
728
  };
770
- /** @returns {CreditlineDataPlatformRequest} */
771
- declare function CreditlineDataPlatformRequest(): CreditlineDataPlatformRequest;
772
- type CreditlineDataPlatformRequest = {
773
- data?: CreditlineDataPlatformPayload;
729
+ /** @returns {DownloadReportItems} */
730
+ declare function DownloadReportItems(): DownloadReportItems;
731
+ type DownloadReportItems = {
732
+ start_date?: string;
733
+ end_date?: string;
734
+ meta?: GenerateReportMeta;
735
+ report_id?: string;
736
+ filters?: GenerateReportFilters;
737
+ type_of_request?: string;
774
738
  };
775
- /** @returns {CreditlineDataPlatformResponse} */
776
- declare function CreditlineDataPlatformResponse(): CreditlineDataPlatformResponse;
777
- type CreditlineDataPlatformResponse = {
778
- code?: number;
779
- headers?: string[];
780
- item_count?: number;
781
- items?: any[];
782
- message?: string;
739
+ /** @returns {DownloadReportList} */
740
+ declare function DownloadReportList(): DownloadReportList;
741
+ type DownloadReportList = {
742
+ items?: DownloadReportItems[];
783
743
  page?: Page;
784
- show_mr?: boolean;
785
- };
786
- /** @returns {CreditNoteConfigNotificationEvents} */
787
- declare function CreditNoteConfigNotificationEvents(): CreditNoteConfigNotificationEvents;
788
- type CreditNoteConfigNotificationEvents = {
789
- expiration_reminder_to_customer?: number;
744
+ item_count?: number;
790
745
  };
791
- /** @returns {CreditNoteDetails} */
792
- declare function CreditNoteDetails(): CreditNoteDetails;
793
- type CreditNoteDetails = {
794
- available_cn_balance?: number;
795
- cn_amount?: number;
796
- cn_details?: CnDetails;
797
- cn_reference_number?: string;
798
- cn_status?: string;
799
- customer_mobile_number?: string;
800
- redemption_details?: RedemptionDetails[];
801
- remaining_cn_amount?: number;
746
+ /** @returns {GetEngineData} */
747
+ declare function GetEngineData(): GetEngineData;
748
+ type GetEngineData = {
749
+ table_name?: string;
750
+ project?: string[];
751
+ filters?: any;
802
752
  };
803
- /** @returns {CreditNoteDetailsRequest} */
804
- declare function CreditNoteDetailsRequest(): CreditNoteDetailsRequest;
805
- type CreditNoteDetailsRequest = {
806
- data?: CnReferenceNumber;
753
+ /** @returns {GetEngineRequest} */
754
+ declare function GetEngineRequest(): GetEngineRequest;
755
+ type GetEngineRequest = {
756
+ data?: GetEngineData;
807
757
  };
808
- /** @returns {CreditNoteDetailsResponse} */
809
- declare function CreditNoteDetailsResponse(): CreditNoteDetailsResponse;
810
- type CreditNoteDetailsResponse = {
811
- data?: CreditNoteDetails;
758
+ /** @returns {GetEngineResponse} */
759
+ declare function GetEngineResponse(): GetEngineResponse;
760
+ type GetEngineResponse = {
812
761
  success?: boolean;
762
+ items?: any[];
763
+ page?: Page;
764
+ item_count?: number;
813
765
  };
814
- /** @returns {Currency} */
815
- declare function Currency(): Currency;
816
- type Currency = {
817
- code?: string;
766
+ /** @returns {GetReason} */
767
+ declare function GetReason(): GetReason;
768
+ type GetReason = {
769
+ reason_type?: string;
770
+ };
771
+ /** @returns {GetReasonRequest} */
772
+ declare function GetReasonRequest(): GetReasonRequest;
773
+ type GetReasonRequest = {
774
+ data?: GetReason;
775
+ };
776
+ /** @returns {ReasonItem} */
777
+ declare function ReasonItem(): ReasonItem;
778
+ type ReasonItem = {
779
+ id?: string;
818
780
  name?: string;
819
- symbol?: string;
781
+ display_name?: string;
820
782
  };
821
- /** @returns {DeleteConfig} */
822
- declare function DeleteConfig(): DeleteConfig;
823
- type DeleteConfig = {
824
- affiliate_id?: string;
825
- seller_id?: number;
826
- slug_values?: string[];
783
+ /** @returns {GetReasonResponse} */
784
+ declare function GetReasonResponse(): GetReasonResponse;
785
+ type GetReasonResponse = {
786
+ success?: boolean;
787
+ item_list?: ReasonItem[];
788
+ item_count?: number;
789
+ page?: Page;
827
790
  };
828
- /** @returns {DeleteConfigRequest} */
829
- declare function DeleteConfigRequest(): DeleteConfigRequest;
830
- type DeleteConfigRequest = {
831
- data?: DeleteConfig;
791
+ /** @returns {GetReportListData} */
792
+ declare function GetReportListData(): GetReportListData;
793
+ type GetReportListData = {
794
+ role_name?: string;
795
+ listing_enabled?: boolean;
832
796
  };
833
- /** @returns {DeleteConfigResponse} */
834
- declare function DeleteConfigResponse(): DeleteConfigResponse;
835
- type DeleteConfigResponse = {
836
- message?: string;
797
+ /** @returns {GetReportListRequest} */
798
+ declare function GetReportListRequest(): GetReportListRequest;
799
+ type GetReportListRequest = {
800
+ data?: GetReportListData;
801
+ };
802
+ /** @returns {GetAffiliate} */
803
+ declare function GetAffiliate(): GetAffiliate;
804
+ type GetAffiliate = {
805
+ company_id?: number;
806
+ };
807
+ /** @returns {GetReportListResponse} */
808
+ declare function GetReportListResponse(): GetReportListResponse;
809
+ type GetReportListResponse = {
810
+ success?: boolean;
811
+ items?: ReportItem[];
812
+ page?: Page;
813
+ total_count?: number;
814
+ };
815
+ /** @returns {ReportItem} */
816
+ declare function ReportItem(): ReportItem;
817
+ type ReportItem = {
818
+ id?: string;
819
+ name?: string;
820
+ description?: string;
821
+ allowed_filters?: string[];
822
+ config_meta?: any;
823
+ report_type?: string;
824
+ display_date?: string;
825
+ };
826
+ /** @returns {GetAffiliateResponse} */
827
+ declare function GetAffiliateResponse(): GetAffiliateResponse;
828
+ type GetAffiliateResponse = {
837
829
  success?: boolean;
830
+ docs?: any[];
838
831
  };
839
832
  /** @returns {DownloadCreditDebitNote} */
840
833
  declare function DownloadCreditDebitNote(): DownloadCreditDebitNote;
@@ -846,475 +839,507 @@ declare function DownloadCreditDebitNoteRequest(): DownloadCreditDebitNoteReques
846
839
  type DownloadCreditDebitNoteRequest = {
847
840
  data?: DownloadCreditDebitNote;
848
841
  };
849
- /** @returns {DownloadCreditDebitNoteResponse} */
850
- declare function DownloadCreditDebitNoteResponse(): DownloadCreditDebitNoteResponse;
851
- type DownloadCreditDebitNoteResponse = {
852
- data?: DownloadCreditDebitNoteResponseData[];
853
- success?: boolean;
854
- };
855
842
  /** @returns {DownloadCreditDebitNoteResponseData} */
856
843
  declare function DownloadCreditDebitNoteResponseData(): DownloadCreditDebitNoteResponseData;
857
844
  type DownloadCreditDebitNoteResponseData = {
858
845
  id?: string;
859
846
  pdf_s3_url?: string;
860
847
  };
861
- /** @returns {DownloadReport} */
862
- declare function DownloadReport(): DownloadReport;
863
- type DownloadReport = {
864
- end_date?: string;
865
- page?: number;
866
- pagesize?: number;
867
- start_date?: string;
868
- };
869
- /** @returns {DownloadReportCustomerCnRequest} */
870
- declare function DownloadReportCustomerCnRequest(): DownloadReportCustomerCnRequest;
871
- type DownloadReportCustomerCnRequest = {
872
- data?: CnDownloadReport;
873
- };
874
- /** @returns {DownloadReportCustomerCnResponse} */
875
- declare function DownloadReportCustomerCnResponse(): DownloadReportCustomerCnResponse;
876
- type DownloadReportCustomerCnResponse = {
877
- data?: DownloadReportResponseData[];
848
+ /** @returns {DownloadCreditDebitNoteResponse} */
849
+ declare function DownloadCreditDebitNoteResponse(): DownloadCreditDebitNoteResponse;
850
+ type DownloadCreditDebitNoteResponse = {
851
+ success?: boolean;
852
+ data?: DownloadCreditDebitNoteResponseData[];
878
853
  };
879
- /** @returns {DownloadReportItems} */
880
- declare function DownloadReportItems(): DownloadReportItems;
881
- type DownloadReportItems = {
882
- end_date?: string;
883
- filters?: GenerateReportFilters;
884
- meta?: GenerateReportMeta;
885
- report_id?: string;
886
- start_date?: string;
887
- type_of_request?: string;
854
+ /** @returns {PaymentProcessPayload} */
855
+ declare function PaymentProcessPayload(): PaymentProcessPayload;
856
+ type PaymentProcessPayload = {
857
+ platform?: string;
858
+ amount?: string;
859
+ transaction_type?: string;
860
+ source_reference?: string;
861
+ total_amount?: string;
862
+ meta?: any;
863
+ currency?: string;
864
+ seller_id?: string;
865
+ mode_of_payment?: string;
866
+ invoice_number?: string;
888
867
  };
889
- /** @returns {DownloadReportList} */
890
- declare function DownloadReportList(): DownloadReportList;
891
- type DownloadReportList = {
892
- item_count?: number;
893
- items?: DownloadReportItems[];
894
- page?: Page;
868
+ /** @returns {PaymentProcessRequest} */
869
+ declare function PaymentProcessRequest(): PaymentProcessRequest;
870
+ type PaymentProcessRequest = {
871
+ data?: PaymentProcessPayload;
895
872
  };
896
- /** @returns {DownloadReportResponseData} */
897
- declare function DownloadReportResponseData(): DownloadReportResponseData;
898
- type DownloadReportResponseData = {
899
- created_at?: string;
900
- display_name?: string;
901
- download_link?: string;
902
- end_date?: string;
903
- filters?: any;
904
- full_name?: string;
873
+ /** @returns {PaymentProcessResponse} */
874
+ declare function PaymentProcessResponse(): PaymentProcessResponse;
875
+ type PaymentProcessResponse = {
876
+ code?: number;
877
+ message?: string;
905
878
  meta?: any;
906
- msg?: string;
907
- report_config_id?: string;
908
- report_name?: string;
909
- request_dict?: any;
910
- requested_by?: string;
911
- start_date?: string;
912
- status?: string;
913
- };
914
- /** @returns {Error} */
915
- declare function Error(): Error;
916
- type Error = {
917
- reason?: string;
918
- success?: boolean;
879
+ transaction_id?: string;
880
+ redirect_url?: string;
919
881
  };
920
- /** @returns {GenerateReportCustomerCnRequest} */
921
- declare function GenerateReportCustomerCnRequest(): GenerateReportCustomerCnRequest;
922
- type GenerateReportCustomerCnRequest = {
923
- data?: CnGenerateReport;
882
+ /** @returns {CreditlineDataPlatformPayload} */
883
+ declare function CreditlineDataPlatformPayload(): CreditlineDataPlatformPayload;
884
+ type CreditlineDataPlatformPayload = {
885
+ page?: number;
886
+ seller_id?: string;
887
+ end_end?: string;
888
+ start_end?: string;
889
+ pagesize?: number;
924
890
  };
925
- /** @returns {GenerateReportCustomerCnResponse} */
926
- declare function GenerateReportCustomerCnResponse(): GenerateReportCustomerCnResponse;
927
- type GenerateReportCustomerCnResponse = {
928
- data?: GenerateReportCustomerCnResponseData;
891
+ /** @returns {CreditlineDataPlatformRequest} */
892
+ declare function CreditlineDataPlatformRequest(): CreditlineDataPlatformRequest;
893
+ type CreditlineDataPlatformRequest = {
894
+ data?: CreditlineDataPlatformPayload;
929
895
  };
930
- /** @returns {GenerateReportCustomerCnResponseData} */
931
- declare function GenerateReportCustomerCnResponseData(): GenerateReportCustomerCnResponseData;
932
- type GenerateReportCustomerCnResponseData = {
933
- allowed_filters?: string[];
934
- end_date?: string;
896
+ /** @returns {CreditlineDataPlatformResponse} */
897
+ declare function CreditlineDataPlatformResponse(): CreditlineDataPlatformResponse;
898
+ type CreditlineDataPlatformResponse = {
899
+ items?: any[];
900
+ code?: number;
901
+ show_mr?: boolean;
902
+ page?: Page;
903
+ message?: string;
935
904
  headers?: string[];
936
905
  item_count?: number;
937
- items?: CnGenerateReportItems[];
938
- page?: Page;
939
- primary_headers?: string[];
940
- row_header_display_order?: any;
941
- start_date?: string;
942
906
  };
943
- /** @returns {GenerateReportFilters} */
944
- declare function GenerateReportFilters(): GenerateReportFilters;
945
- type GenerateReportFilters = {
946
- brand?: string[];
947
- channel?: string[];
948
- company?: string[];
949
- };
950
- /** @returns {GenerateReportJson} */
951
- declare function GenerateReportJson(): GenerateReportJson;
952
- type GenerateReportJson = {
953
- end_date?: string;
954
- headers?: string[];
955
- item_count?: number;
956
- items?: string[][];
957
- page?: Page;
907
+ /** @returns {IsCreditlinePayload} */
908
+ declare function IsCreditlinePayload(): IsCreditlinePayload;
909
+ type IsCreditlinePayload = {
910
+ seller_id?: string;
911
+ };
912
+ /** @returns {IsCreditlinePlatformRequest} */
913
+ declare function IsCreditlinePlatformRequest(): IsCreditlinePlatformRequest;
914
+ type IsCreditlinePlatformRequest = {
915
+ data?: IsCreditlinePayload;
916
+ };
917
+ /** @returns {IsCreditlinePlatformResponse} */
918
+ declare function IsCreditlinePlatformResponse(): IsCreditlinePlatformResponse;
919
+ type IsCreditlinePlatformResponse = {
920
+ is_creditline_opted?: boolean;
921
+ code?: number;
922
+ };
923
+ /** @returns {InvoiceTypePayloadData} */
924
+ declare function InvoiceTypePayloadData(): InvoiceTypePayloadData;
925
+ type InvoiceTypePayloadData = {
926
+ is_active?: boolean;
927
+ };
928
+ /** @returns {InvoiceTypeRequest} */
929
+ declare function InvoiceTypeRequest(): InvoiceTypeRequest;
930
+ type InvoiceTypeRequest = {
931
+ data?: InvoiceTypePayloadData;
932
+ };
933
+ /** @returns {InvoiceTypeResponseItems} */
934
+ declare function InvoiceTypeResponseItems(): InvoiceTypeResponseItems;
935
+ type InvoiceTypeResponseItems = {
936
+ text?: string;
937
+ value?: string;
938
+ };
939
+ /** @returns {InvoiceTypeResponse} */
940
+ declare function InvoiceTypeResponse(): InvoiceTypeResponse;
941
+ type InvoiceTypeResponse = {
942
+ success?: boolean;
943
+ invoice_type_list?: InvoiceTypeResponseItems[];
944
+ payment_status_list?: InvoiceTypeResponseItems[];
945
+ };
946
+ /** @returns {InoviceListingPayloadDataFilters} */
947
+ declare function InoviceListingPayloadDataFilters(): InoviceListingPayloadDataFilters;
948
+ type InoviceListingPayloadDataFilters = {
949
+ payment_status?: string[];
950
+ invoice_type?: string[];
951
+ company_id?: string[];
952
+ };
953
+ /** @returns {InvoiceListingPayloadData} */
954
+ declare function InvoiceListingPayloadData(): InvoiceListingPayloadData;
955
+ type InvoiceListingPayloadData = {
956
+ page_size?: number;
957
+ page?: number;
958
958
  start_date?: string;
959
+ end_date?: string;
960
+ search?: string;
961
+ filters?: InoviceListingPayloadDataFilters;
959
962
  };
960
- /** @returns {GenerateReportMeta} */
961
- declare function GenerateReportMeta(): GenerateReportMeta;
962
- type GenerateReportMeta = {
963
- brand?: string;
964
- channel?: string;
963
+ /** @returns {InvoiceListingRequest} */
964
+ declare function InvoiceListingRequest(): InvoiceListingRequest;
965
+ type InvoiceListingRequest = {
966
+ data?: InvoiceListingPayloadData;
967
+ };
968
+ /** @returns {UnpaidInvoiceDataItems} */
969
+ declare function UnpaidInvoiceDataItems(): UnpaidInvoiceDataItems;
970
+ type UnpaidInvoiceDataItems = {
971
+ total_unpaid_invoice_count?: number;
972
+ currency?: string;
973
+ total_unpaid_amount?: number;
974
+ };
975
+ /** @returns {InvoiceListingResponseItems} */
976
+ declare function InvoiceListingResponseItems(): InvoiceListingResponseItems;
977
+ type InvoiceListingResponseItems = {
978
+ amount?: string;
965
979
  company?: string;
980
+ status?: string;
981
+ due_date?: string;
982
+ invoice_date?: string;
983
+ invoice_type?: string;
984
+ period?: string;
985
+ invoice_number?: string;
986
+ is_downloadable?: boolean;
987
+ invoice_id?: string;
988
+ currency?: Currency;
966
989
  };
967
- /** @returns {GenerateReportPlatform} */
968
- declare function GenerateReportPlatform(): GenerateReportPlatform;
969
- type GenerateReportPlatform = {
970
- end_date?: string;
971
- filters?: GenerateReportFilters;
972
- meta?: GenerateReportMeta;
973
- report_id?: string;
974
- start_date?: string;
990
+ /** @returns {InvoiceListingResponse} */
991
+ declare function InvoiceListingResponse(): InvoiceListingResponse;
992
+ type InvoiceListingResponse = {
993
+ unpaid_invoice_data?: UnpaidInvoiceDataItems;
994
+ items?: InvoiceListingResponseItems[];
995
+ page?: Page;
996
+ item_count?: number;
975
997
  };
976
- /** @returns {GenerateReportRequest} */
977
- declare function GenerateReportRequest(): GenerateReportRequest;
978
- type GenerateReportRequest = {
979
- data?: GenerateReportPlatform;
998
+ /** @returns {InvoicePdfPayloadData} */
999
+ declare function InvoicePdfPayloadData(): InvoicePdfPayloadData;
1000
+ type InvoicePdfPayloadData = {
1001
+ invoice_number?: string[];
980
1002
  };
981
- /** @returns {GetAffiliate} */
982
- declare function GetAffiliate(): GetAffiliate;
983
- type GetAffiliate = {
984
- company_id?: number;
1003
+ /** @returns {InvoicePdfRequest} */
1004
+ declare function InvoicePdfRequest(): InvoicePdfRequest;
1005
+ type InvoicePdfRequest = {
1006
+ data?: InvoicePdfPayloadData;
985
1007
  };
986
- /** @returns {GetAffiliateResponse} */
987
- declare function GetAffiliateResponse(): GetAffiliateResponse;
988
- type GetAffiliateResponse = {
989
- docs?: any[];
1008
+ /** @returns {InvoicePdfResponse} */
1009
+ declare function InvoicePdfResponse(): InvoicePdfResponse;
1010
+ type InvoicePdfResponse = {
990
1011
  success?: boolean;
1012
+ data?: string[];
1013
+ error?: string[];
991
1014
  };
992
- /** @returns {GetCnConfigRequest} */
993
- declare function GetCnConfigRequest(): GetCnConfigRequest;
994
- type GetCnConfigRequest = {
995
- data?: DeleteConfig;
1015
+ /** @returns {IsCnRefundMethodData} */
1016
+ declare function IsCnRefundMethodData(): IsCnRefundMethodData;
1017
+ type IsCnRefundMethodData = {
1018
+ affiliate_id?: string;
1019
+ toggle_edit_required?: boolean;
1020
+ seller_id?: number;
996
1021
  };
997
- /** @returns {GetCnConfigResponse} */
998
- declare function GetCnConfigResponse(): GetCnConfigResponse;
999
- type GetCnConfigResponse = {
1000
- data?: GetCnConfigResponseData;
1022
+ /** @returns {IsCnRefundMethodRequest} */
1023
+ declare function IsCnRefundMethodRequest(): IsCnRefundMethodRequest;
1024
+ type IsCnRefundMethodRequest = {
1025
+ data?: IsCnRefundMethodData;
1026
+ };
1027
+ /** @returns {IsCnRefundMethodResponseData} */
1028
+ declare function IsCnRefundMethodResponseData(): IsCnRefundMethodResponseData;
1029
+ type IsCnRefundMethodResponseData = {
1030
+ is_first_time_user?: boolean;
1031
+ };
1032
+ /** @returns {IsCnRefundMethodResponse} */
1033
+ declare function IsCnRefundMethodResponse(): IsCnRefundMethodResponse;
1034
+ type IsCnRefundMethodResponse = {
1001
1035
  success?: boolean;
1036
+ data?: IsCnRefundMethodResponseData;
1002
1037
  };
1003
- /** @returns {GetCnConfigResponseData} */
1004
- declare function GetCnConfigResponseData(): GetCnConfigResponseData;
1005
- type GetCnConfigResponseData = {
1006
- affiliate_id?: string;
1007
- currency_type?: string;
1038
+ /** @returns {CreditNoteConfigNotificationEvents} */
1039
+ declare function CreditNoteConfigNotificationEvents(): CreditNoteConfigNotificationEvents;
1040
+ type CreditNoteConfigNotificationEvents = {
1041
+ expiration_reminder_to_customer?: number;
1042
+ };
1043
+ /** @returns {CreateSellerCreditNoteConfig} */
1044
+ declare function CreateSellerCreditNoteConfig(): CreateSellerCreditNoteConfig;
1045
+ type CreateSellerCreditNoteConfig = {
1008
1046
  is_cn_as_refund_method?: boolean;
1009
- meta?: GetCnConfigResponseMeta;
1010
- notification_events?: CreditNoteConfigNotificationEvents;
1011
- redemption_ordering_channel?: string[];
1047
+ affiliate_id?: string;
1048
+ source_channel?: string[];
1012
1049
  seller_id?: number;
1050
+ notification_events?: CreditNoteConfigNotificationEvents;
1051
+ sales_channel_name?: string;
1052
+ ordering_channel?: string[];
1013
1053
  validity?: number;
1054
+ currency_type?: string;
1055
+ slug_values?: string[];
1014
1056
  };
1015
- /** @returns {GetCnConfigResponseMeta} */
1016
- declare function GetCnConfigResponseMeta(): GetCnConfigResponseMeta;
1017
- type GetCnConfigResponseMeta = {
1018
- reason?: string;
1019
- source_channel?: string[];
1057
+ /** @returns {CreateSellerCreditNoteConfigRequest} */
1058
+ declare function CreateSellerCreditNoteConfigRequest(): CreateSellerCreditNoteConfigRequest;
1059
+ type CreateSellerCreditNoteConfigRequest = {
1060
+ data?: CreateSellerCreditNoteConfig;
1061
+ };
1062
+ /** @returns {CreateSellerCreditNoteConfigResponse} */
1063
+ declare function CreateSellerCreditNoteConfigResponse(): CreateSellerCreditNoteConfigResponse;
1064
+ type CreateSellerCreditNoteConfigResponse = {
1065
+ success?: boolean;
1066
+ message?: string;
1067
+ };
1068
+ /** @returns {DeleteConfig} */
1069
+ declare function DeleteConfig(): DeleteConfig;
1070
+ type DeleteConfig = {
1071
+ affiliate_id?: string;
1072
+ slug_values?: string[];
1073
+ seller_id?: number;
1074
+ };
1075
+ /** @returns {DeleteConfigRequest} */
1076
+ declare function DeleteConfigRequest(): DeleteConfigRequest;
1077
+ type DeleteConfigRequest = {
1078
+ data?: DeleteConfig;
1079
+ };
1080
+ /** @returns {DeleteConfigResponse} */
1081
+ declare function DeleteConfigResponse(): DeleteConfigResponse;
1082
+ type DeleteConfigResponse = {
1083
+ success?: boolean;
1084
+ message?: string;
1085
+ };
1086
+ /** @returns {ChannelDisplayName} */
1087
+ declare function ChannelDisplayName(): ChannelDisplayName;
1088
+ type ChannelDisplayName = {
1089
+ platform_pos?: string;
1090
+ };
1091
+ /** @returns {ChannelDisplayNameResponse} */
1092
+ declare function ChannelDisplayNameResponse(): ChannelDisplayNameResponse;
1093
+ type ChannelDisplayNameResponse = {
1094
+ success?: boolean;
1095
+ data?: ChannelDisplayName;
1096
+ };
1097
+ /** @returns {CnReferenceNumber} */
1098
+ declare function CnReferenceNumber(): CnReferenceNumber;
1099
+ type CnReferenceNumber = {
1100
+ cn_reference_number?: string;
1101
+ };
1102
+ /** @returns {GetPdfUrlViewRequest} */
1103
+ declare function GetPdfUrlViewRequest(): GetPdfUrlViewRequest;
1104
+ type GetPdfUrlViewRequest = {
1105
+ data?: CnReferenceNumber;
1106
+ };
1107
+ /** @returns {GetPdfUrlViewResponseData} */
1108
+ declare function GetPdfUrlViewResponseData(): GetPdfUrlViewResponseData;
1109
+ type GetPdfUrlViewResponseData = {
1110
+ s3_pdf_link?: string;
1111
+ cn_reference_number?: string;
1112
+ };
1113
+ /** @returns {GetPdfUrlViewResponse} */
1114
+ declare function GetPdfUrlViewResponse(): GetPdfUrlViewResponse;
1115
+ type GetPdfUrlViewResponse = {
1116
+ success?: boolean;
1117
+ data?: GetPdfUrlViewResponseData;
1118
+ };
1119
+ /** @returns {CreditNoteDetailsRequest} */
1120
+ declare function CreditNoteDetailsRequest(): CreditNoteDetailsRequest;
1121
+ type CreditNoteDetailsRequest = {
1122
+ data?: CnReferenceNumber;
1123
+ };
1124
+ /** @returns {CnDetails} */
1125
+ declare function CnDetails(): CnDetails;
1126
+ type CnDetails = {
1127
+ staff_id?: string;
1128
+ expiry_date?: string;
1129
+ channel_of_issuance?: string;
1130
+ order_id?: string;
1131
+ date_issued?: string;
1132
+ ordering_channel?: string;
1133
+ shipment_id?: string;
1134
+ store_id?: string;
1135
+ invoice_number?: string;
1136
+ };
1137
+ /** @returns {RedemptionDetails} */
1138
+ declare function RedemptionDetails(): RedemptionDetails;
1139
+ type RedemptionDetails = {
1140
+ staff_id?: string;
1141
+ created_at?: string;
1142
+ order_id?: string;
1143
+ store_id?: string;
1144
+ shipment_id?: string;
1145
+ ordering_channel?: string;
1146
+ amount_debited?: number;
1147
+ invoice_number?: string;
1148
+ };
1149
+ /** @returns {CreditNoteDetails} */
1150
+ declare function CreditNoteDetails(): CreditNoteDetails;
1151
+ type CreditNoteDetails = {
1152
+ cn_status?: string;
1153
+ customer_mobile_number?: string;
1154
+ cn_reference_number?: string;
1155
+ cn_details?: CnDetails;
1156
+ redemption_details?: RedemptionDetails[];
1157
+ remaining_cn_amount?: number;
1158
+ available_cn_balance?: number;
1159
+ cn_amount?: number;
1160
+ };
1161
+ /** @returns {CreditNoteDetailsResponse} */
1162
+ declare function CreditNoteDetailsResponse(): CreditNoteDetailsResponse;
1163
+ type CreditNoteDetailsResponse = {
1164
+ success?: boolean;
1165
+ data?: CreditNoteDetails;
1020
1166
  };
1021
1167
  /** @returns {GetCustomerCreditBalance} */
1022
1168
  declare function GetCustomerCreditBalance(): GetCustomerCreditBalance;
1023
1169
  type GetCustomerCreditBalance = {
1024
1170
  affiliate_id?: string;
1025
- customer_mobile_number?: string;
1026
1171
  seller_id?: number;
1172
+ customer_mobile_number?: string;
1027
1173
  };
1028
1174
  /** @returns {GetCustomerCreditBalanceRequest} */
1029
1175
  declare function GetCustomerCreditBalanceRequest(): GetCustomerCreditBalanceRequest;
1030
1176
  type GetCustomerCreditBalanceRequest = {
1031
1177
  data?: GetCustomerCreditBalance;
1032
1178
  };
1033
- /** @returns {GetCustomerCreditBalanceResponse} */
1034
- declare function GetCustomerCreditBalanceResponse(): GetCustomerCreditBalanceResponse;
1035
- type GetCustomerCreditBalanceResponse = {
1036
- data?: GetCustomerCreditBalanceResponseData;
1037
- success?: boolean;
1038
- };
1039
1179
  /** @returns {GetCustomerCreditBalanceResponseData} */
1040
1180
  declare function GetCustomerCreditBalanceResponseData(): GetCustomerCreditBalanceResponseData;
1041
1181
  type GetCustomerCreditBalanceResponseData = {
1042
1182
  customer_mobile_number?: string;
1043
1183
  total_credited_balance?: number;
1044
1184
  };
1045
- /** @returns {GetEngineData} */
1046
- declare function GetEngineData(): GetEngineData;
1047
- type GetEngineData = {
1048
- filters?: any;
1049
- project?: string[];
1050
- table_name?: string;
1051
- };
1052
- /** @returns {GetEngineRequest} */
1053
- declare function GetEngineRequest(): GetEngineRequest;
1054
- type GetEngineRequest = {
1055
- data?: GetEngineData;
1056
- };
1057
- /** @returns {GetEngineResponse} */
1058
- declare function GetEngineResponse(): GetEngineResponse;
1059
- type GetEngineResponse = {
1060
- item_count?: number;
1061
- items?: any[];
1062
- page?: Page;
1063
- success?: boolean;
1064
- };
1065
- /** @returns {GetPdfUrlViewRequest} */
1066
- declare function GetPdfUrlViewRequest(): GetPdfUrlViewRequest;
1067
- type GetPdfUrlViewRequest = {
1068
- data?: CnReferenceNumber;
1069
- };
1070
- /** @returns {GetPdfUrlViewResponse} */
1071
- declare function GetPdfUrlViewResponse(): GetPdfUrlViewResponse;
1072
- type GetPdfUrlViewResponse = {
1073
- data?: GetPdfUrlViewResponseData;
1074
- success?: boolean;
1075
- };
1076
- /** @returns {GetPdfUrlViewResponseData} */
1077
- declare function GetPdfUrlViewResponseData(): GetPdfUrlViewResponseData;
1078
- type GetPdfUrlViewResponseData = {
1079
- cn_reference_number?: string;
1080
- s3_pdf_link?: string;
1081
- };
1082
- /** @returns {GetReason} */
1083
- declare function GetReason(): GetReason;
1084
- type GetReason = {
1085
- reason_type?: string;
1086
- };
1087
- /** @returns {GetReasonRequest} */
1088
- declare function GetReasonRequest(): GetReasonRequest;
1089
- type GetReasonRequest = {
1090
- data?: GetReason;
1091
- };
1092
- /** @returns {GetReasonResponse} */
1093
- declare function GetReasonResponse(): GetReasonResponse;
1094
- type GetReasonResponse = {
1095
- item_count?: number;
1096
- item_list?: ReasonItem[];
1097
- page?: Page;
1185
+ /** @returns {GetCustomerCreditBalanceResponse} */
1186
+ declare function GetCustomerCreditBalanceResponse(): GetCustomerCreditBalanceResponse;
1187
+ type GetCustomerCreditBalanceResponse = {
1098
1188
  success?: boolean;
1189
+ data?: GetCustomerCreditBalanceResponseData;
1099
1190
  };
1100
- /** @returns {GetReportingFilters} */
1101
- declare function GetReportingFilters(): GetReportingFilters;
1102
- type GetReportingFilters = {
1103
- options?: any[];
1104
- text?: string;
1105
- type?: string;
1106
- value?: string;
1107
- };
1108
- /** @returns {GetReportingFiltersResponse} */
1109
- declare function GetReportingFiltersResponse(): GetReportingFiltersResponse;
1110
- type GetReportingFiltersResponse = {
1111
- filters?: GetReportingNestedFilters[];
1112
- search?: GetReportingFilters;
1113
- status?: GetReportingFilters;
1114
- };
1115
- /** @returns {GetReportingNestedFilters} */
1116
- declare function GetReportingNestedFilters(): GetReportingNestedFilters;
1117
- type GetReportingNestedFilters = {
1118
- options?: any[];
1119
- placeholder_text?: string;
1120
- required?: boolean;
1121
- text?: string;
1122
- type?: string;
1123
- value?: string;
1191
+ /** @returns {GetCnConfigRequest} */
1192
+ declare function GetCnConfigRequest(): GetCnConfigRequest;
1193
+ type GetCnConfigRequest = {
1194
+ data?: DeleteConfig;
1124
1195
  };
1125
- /** @returns {GetReportListData} */
1126
- declare function GetReportListData(): GetReportListData;
1127
- type GetReportListData = {
1128
- listing_enabled?: boolean;
1129
- role_name?: string;
1196
+ /** @returns {GetCnConfigResponseMeta} */
1197
+ declare function GetCnConfigResponseMeta(): GetCnConfigResponseMeta;
1198
+ type GetCnConfigResponseMeta = {
1199
+ reason?: string;
1200
+ source_channel?: string[];
1130
1201
  };
1131
- /** @returns {GetReportListRequest} */
1132
- declare function GetReportListRequest(): GetReportListRequest;
1133
- type GetReportListRequest = {
1134
- data?: GetReportListData;
1202
+ /** @returns {GetCnConfigResponseData} */
1203
+ declare function GetCnConfigResponseData(): GetCnConfigResponseData;
1204
+ type GetCnConfigResponseData = {
1205
+ is_cn_as_refund_method?: boolean;
1206
+ affiliate_id?: string;
1207
+ meta?: GetCnConfigResponseMeta;
1208
+ seller_id?: number;
1209
+ notification_events?: CreditNoteConfigNotificationEvents;
1210
+ validity?: number;
1211
+ redemption_ordering_channel?: string[];
1212
+ currency_type?: string;
1135
1213
  };
1136
- /** @returns {GetReportListResponse} */
1137
- declare function GetReportListResponse(): GetReportListResponse;
1138
- type GetReportListResponse = {
1139
- items?: ReportItem[];
1140
- page?: Page;
1214
+ /** @returns {GetCnConfigResponse} */
1215
+ declare function GetCnConfigResponse(): GetCnConfigResponse;
1216
+ type GetCnConfigResponse = {
1141
1217
  success?: boolean;
1142
- total_count?: number;
1143
- };
1144
- /** @returns {InoviceListingPayloadDataFilters} */
1145
- declare function InoviceListingPayloadDataFilters(): InoviceListingPayloadDataFilters;
1146
- type InoviceListingPayloadDataFilters = {
1147
- company_id?: string[];
1148
- invoice_type?: string[];
1149
- payment_status?: string[];
1150
- };
1151
- /** @returns {InvoiceActivityLogError} */
1152
- declare function InvoiceActivityLogError(): InvoiceActivityLogError;
1153
- type InvoiceActivityLogError = {
1154
- reason?: string;
1155
- };
1156
- /** @returns {InvoiceActivityLogsResponse} */
1157
- declare function InvoiceActivityLogsResponse(): InvoiceActivityLogsResponse;
1158
- type InvoiceActivityLogsResponse = {
1159
- data?: InvoiceActivityLogsResponseData[];
1218
+ data?: GetCnConfigResponseData;
1160
1219
  };
1161
- /** @returns {InvoiceActivityLogsResponseData} */
1162
- declare function InvoiceActivityLogsResponseData(): InvoiceActivityLogsResponseData;
1163
- type InvoiceActivityLogsResponseData = {
1164
- is_resolved?: boolean;
1165
- max_retry_attempts?: number;
1166
- performed_by?: string;
1167
- reason?: string;
1168
- retry_attempts?: number;
1169
- status?: string;
1220
+ /** @returns {CnGenerateReportFilters} */
1221
+ declare function CnGenerateReportFilters(): CnGenerateReportFilters;
1222
+ type CnGenerateReportFilters = {
1223
+ staff_id?: string[];
1224
+ channel_of_issuance?: string[];
1225
+ utilisation?: string[];
1226
+ ordering_channel?: string[];
1227
+ store_id?: number[];
1228
+ types_of_transaction?: string[];
1170
1229
  };
1171
- /** @returns {InvoiceListingPayloadData} */
1172
- declare function InvoiceListingPayloadData(): InvoiceListingPayloadData;
1173
- type InvoiceListingPayloadData = {
1174
- end_date?: string;
1175
- filters?: InoviceListingPayloadDataFilters;
1230
+ /** @returns {CnGenerateReport} */
1231
+ declare function CnGenerateReport(): CnGenerateReport;
1232
+ type CnGenerateReport = {
1176
1233
  page?: number;
1177
- page_size?: number;
1234
+ end_date?: string;
1235
+ pagesize?: number;
1236
+ filters?: CnGenerateReportFilters;
1237
+ affiliate_id?: string;
1238
+ meta?: GenerateReportFilters;
1178
1239
  search?: string;
1240
+ report_id?: string;
1241
+ search_type?: string;
1179
1242
  start_date?: string;
1180
1243
  };
1181
- /** @returns {InvoiceListingRequest} */
1182
- declare function InvoiceListingRequest(): InvoiceListingRequest;
1183
- type InvoiceListingRequest = {
1184
- data?: InvoiceListingPayloadData;
1185
- };
1186
- /** @returns {InvoiceListingResponse} */
1187
- declare function InvoiceListingResponse(): InvoiceListingResponse;
1188
- type InvoiceListingResponse = {
1189
- item_count?: number;
1190
- items?: InvoiceListingResponseItems[];
1191
- page?: Page;
1192
- unpaid_invoice_data?: UnpaidInvoiceDataItems;
1193
- };
1194
- /** @returns {InvoiceListingResponseItems} */
1195
- declare function InvoiceListingResponseItems(): InvoiceListingResponseItems;
1196
- type InvoiceListingResponseItems = {
1197
- amount?: string;
1198
- company?: string;
1199
- currency?: Currency;
1200
- due_date?: string;
1201
- invoice_date?: string;
1202
- invoice_id?: string;
1203
- invoice_number?: string;
1204
- invoice_type?: string;
1205
- is_downloadable?: boolean;
1206
- period?: string;
1207
- status?: string;
1208
- };
1209
- /** @returns {InvoicePaymentDetailsResponse} */
1210
- declare function InvoicePaymentDetailsResponse(): InvoicePaymentDetailsResponse;
1211
- type InvoicePaymentDetailsResponse = {
1212
- data?: InvoicePaymentDetailsResponseData;
1213
- payment_details_visible?: boolean;
1214
- success?: boolean;
1215
- };
1216
- /** @returns {InvoicePaymentDetailsResponseData} */
1217
- declare function InvoicePaymentDetailsResponseData(): InvoicePaymentDetailsResponseData;
1218
- type InvoicePaymentDetailsResponseData = {
1219
- failed_attempts_details?: any[];
1220
- paid_invoice_payment_details?: PaidInvoicePaymentDetail[];
1221
- };
1222
- /** @returns {InvoicePdfPayloadData} */
1223
- declare function InvoicePdfPayloadData(): InvoicePdfPayloadData;
1224
- type InvoicePdfPayloadData = {
1225
- invoice_number?: string[];
1226
- };
1227
- /** @returns {InvoicePdfRequest} */
1228
- declare function InvoicePdfRequest(): InvoicePdfRequest;
1229
- type InvoicePdfRequest = {
1230
- data?: InvoicePdfPayloadData;
1231
- };
1232
- /** @returns {InvoicePdfResponse} */
1233
- declare function InvoicePdfResponse(): InvoicePdfResponse;
1234
- type InvoicePdfResponse = {
1235
- data?: string[];
1236
- error?: string[];
1237
- success?: boolean;
1238
- };
1239
- /** @returns {InvoiceTypePayloadData} */
1240
- declare function InvoiceTypePayloadData(): InvoiceTypePayloadData;
1241
- type InvoiceTypePayloadData = {
1242
- is_active?: boolean;
1243
- };
1244
- /** @returns {InvoiceTypeRequest} */
1245
- declare function InvoiceTypeRequest(): InvoiceTypeRequest;
1246
- type InvoiceTypeRequest = {
1247
- data?: InvoiceTypePayloadData;
1248
- };
1249
- /** @returns {InvoiceTypeResponse} */
1250
- declare function InvoiceTypeResponse(): InvoiceTypeResponse;
1251
- type InvoiceTypeResponse = {
1252
- invoice_type_list?: InvoiceTypeResponseItems[];
1253
- payment_status_list?: InvoiceTypeResponseItems[];
1254
- success?: boolean;
1244
+ /** @returns {GenerateReportCustomerCnRequest} */
1245
+ declare function GenerateReportCustomerCnRequest(): GenerateReportCustomerCnRequest;
1246
+ type GenerateReportCustomerCnRequest = {
1247
+ data?: CnGenerateReport;
1255
1248
  };
1256
- /** @returns {InvoiceTypeResponseItems} */
1257
- declare function InvoiceTypeResponseItems(): InvoiceTypeResponseItems;
1258
- type InvoiceTypeResponseItems = {
1259
- text?: string;
1260
- value?: string;
1249
+ /** @returns {CnGenerateReportItems} */
1250
+ declare function CnGenerateReportItems(): CnGenerateReportItems;
1251
+ type CnGenerateReportItems = {
1252
+ expiry_date?: string;
1253
+ status?: string;
1254
+ total_amount?: number;
1255
+ order_id?: string;
1256
+ date_issued?: string;
1257
+ shipment_id?: string;
1258
+ invoice_number?: string;
1259
+ credit_note_number?: string;
1261
1260
  };
1262
- /** @returns {IsCnRefundMethodData} */
1263
- declare function IsCnRefundMethodData(): IsCnRefundMethodData;
1264
- type IsCnRefundMethodData = {
1265
- affiliate_id?: string;
1266
- seller_id?: number;
1267
- toggle_edit_required?: boolean;
1261
+ /** @returns {GenerateReportCustomerCnResponseData} */
1262
+ declare function GenerateReportCustomerCnResponseData(): GenerateReportCustomerCnResponseData;
1263
+ type GenerateReportCustomerCnResponseData = {
1264
+ items?: CnGenerateReportItems[];
1265
+ row_header_display_order?: any;
1266
+ end_date?: string;
1267
+ page?: Page;
1268
+ headers?: string[];
1269
+ primary_headers?: string[];
1270
+ allowed_filters?: string[];
1271
+ start_date?: string;
1272
+ item_count?: number;
1268
1273
  };
1269
- /** @returns {IsCnRefundMethodRequest} */
1270
- declare function IsCnRefundMethodRequest(): IsCnRefundMethodRequest;
1271
- type IsCnRefundMethodRequest = {
1272
- data?: IsCnRefundMethodData;
1274
+ /** @returns {GenerateReportCustomerCnResponse} */
1275
+ declare function GenerateReportCustomerCnResponse(): GenerateReportCustomerCnResponse;
1276
+ type GenerateReportCustomerCnResponse = {
1277
+ data?: GenerateReportCustomerCnResponseData;
1273
1278
  };
1274
- /** @returns {IsCnRefundMethodResponse} */
1275
- declare function IsCnRefundMethodResponse(): IsCnRefundMethodResponse;
1276
- type IsCnRefundMethodResponse = {
1277
- data?: IsCnRefundMethodResponseData;
1278
- success?: boolean;
1279
+ /** @returns {CnDownloadReport} */
1280
+ declare function CnDownloadReport(): CnDownloadReport;
1281
+ type CnDownloadReport = {
1282
+ page?: number;
1283
+ start_date?: string;
1284
+ end_date?: string;
1285
+ affiliate_id?: string;
1286
+ search?: string;
1287
+ status?: string[];
1288
+ search_type?: string;
1289
+ pagesize?: number;
1279
1290
  };
1280
- /** @returns {IsCnRefundMethodResponseData} */
1281
- declare function IsCnRefundMethodResponseData(): IsCnRefundMethodResponseData;
1282
- type IsCnRefundMethodResponseData = {
1283
- is_first_time_user?: boolean;
1291
+ /** @returns {DownloadReportCustomerCnRequest} */
1292
+ declare function DownloadReportCustomerCnRequest(): DownloadReportCustomerCnRequest;
1293
+ type DownloadReportCustomerCnRequest = {
1294
+ data?: CnDownloadReport;
1284
1295
  };
1285
- /** @returns {IsCreditlinePayload} */
1286
- declare function IsCreditlinePayload(): IsCreditlinePayload;
1287
- type IsCreditlinePayload = {
1288
- seller_id?: string;
1296
+ /** @returns {DownloadReportResponseData} */
1297
+ declare function DownloadReportResponseData(): DownloadReportResponseData;
1298
+ type DownloadReportResponseData = {
1299
+ report_config_id?: string;
1300
+ full_name?: string;
1301
+ requested_by?: string;
1302
+ start_date?: string;
1303
+ end_date?: string;
1304
+ request_dict?: any;
1305
+ download_link?: string;
1306
+ created_at?: string;
1307
+ meta?: any;
1308
+ msg?: string;
1309
+ report_name?: string;
1310
+ status?: string;
1311
+ display_name?: string;
1312
+ filters?: any;
1289
1313
  };
1290
- /** @returns {IsCreditlinePlatformRequest} */
1291
- declare function IsCreditlinePlatformRequest(): IsCreditlinePlatformRequest;
1292
- type IsCreditlinePlatformRequest = {
1293
- data?: IsCreditlinePayload;
1314
+ /** @returns {DownloadReportCustomerCnResponse} */
1315
+ declare function DownloadReportCustomerCnResponse(): DownloadReportCustomerCnResponse;
1316
+ type DownloadReportCustomerCnResponse = {
1317
+ data?: DownloadReportResponseData[];
1294
1318
  };
1295
- /** @returns {IsCreditlinePlatformResponse} */
1296
- declare function IsCreditlinePlatformResponse(): IsCreditlinePlatformResponse;
1297
- type IsCreditlinePlatformResponse = {
1298
- code?: number;
1299
- is_creditline_opted?: boolean;
1319
+ /** @returns {GetReportingFilters} */
1320
+ declare function GetReportingFilters(): GetReportingFilters;
1321
+ type GetReportingFilters = {
1322
+ text?: string;
1323
+ type?: string;
1324
+ options?: any[];
1325
+ value?: string;
1300
1326
  };
1301
- /** @returns {Page} */
1302
- declare function Page(): Page;
1303
- type Page = {
1304
- current?: number;
1305
- has_next?: boolean;
1306
- has_previous?: boolean;
1307
- item_total?: number;
1308
- next_id?: string;
1309
- size?: number;
1310
- type: string;
1327
+ /** @returns {GetReportingNestedFilters} */
1328
+ declare function GetReportingNestedFilters(): GetReportingNestedFilters;
1329
+ type GetReportingNestedFilters = {
1330
+ text?: string;
1331
+ options?: any[];
1332
+ required?: boolean;
1333
+ placeholder_text?: string;
1334
+ type?: string;
1335
+ value?: string;
1311
1336
  };
1312
- /** @returns {PaidInvoicePaymentDetail} */
1313
- declare function PaidInvoicePaymentDetail(): PaidInvoicePaymentDetail;
1314
- type PaidInvoicePaymentDetail = {
1315
- amount?: number;
1316
- date_of_payment?: string;
1317
- payment_details?: PaymentDetail[];
1337
+ /** @returns {GetReportingFiltersResponse} */
1338
+ declare function GetReportingFiltersResponse(): GetReportingFiltersResponse;
1339
+ type GetReportingFiltersResponse = {
1340
+ search?: GetReportingFilters;
1341
+ filters?: GetReportingNestedFilters[];
1342
+ status?: GetReportingFilters;
1318
1343
  };
1319
1344
  /** @returns {PaymentDetail} */
1320
1345
  declare function PaymentDetail(): PaymentDetail;
@@ -1322,82 +1347,58 @@ type PaymentDetail = {
1322
1347
  display_name?: string;
1323
1348
  value?: string;
1324
1349
  };
1325
- /** @returns {PaymentProcessPayload} */
1326
- declare function PaymentProcessPayload(): PaymentProcessPayload;
1327
- type PaymentProcessPayload = {
1328
- amount?: string;
1329
- currency?: string;
1330
- invoice_number?: string;
1331
- meta?: any;
1332
- mode_of_payment?: string;
1333
- platform?: string;
1334
- seller_id?: string;
1335
- source_reference?: string;
1336
- total_amount?: string;
1337
- transaction_type?: string;
1338
- };
1339
- /** @returns {PaymentProcessRequest} */
1340
- declare function PaymentProcessRequest(): PaymentProcessRequest;
1341
- type PaymentProcessRequest = {
1342
- data?: PaymentProcessPayload;
1350
+ /** @returns {PaidInvoicePaymentDetail} */
1351
+ declare function PaidInvoicePaymentDetail(): PaidInvoicePaymentDetail;
1352
+ type PaidInvoicePaymentDetail = {
1353
+ payment_details?: PaymentDetail[];
1354
+ date_of_payment?: string;
1355
+ amount?: number;
1343
1356
  };
1344
- /** @returns {PaymentProcessResponse} */
1345
- declare function PaymentProcessResponse(): PaymentProcessResponse;
1346
- type PaymentProcessResponse = {
1347
- code?: number;
1348
- message?: string;
1349
- meta?: any;
1350
- redirect_url?: string;
1351
- transaction_id?: string;
1357
+ /** @returns {InvoicePaymentDetailsResponseData} */
1358
+ declare function InvoicePaymentDetailsResponseData(): InvoicePaymentDetailsResponseData;
1359
+ type InvoicePaymentDetailsResponseData = {
1360
+ paid_invoice_payment_details?: PaidInvoicePaymentDetail[];
1361
+ failed_attempts_details?: any[];
1352
1362
  };
1353
- /** @returns {ReasonItem} */
1354
- declare function ReasonItem(): ReasonItem;
1355
- type ReasonItem = {
1356
- display_name?: string;
1357
- id?: string;
1358
- name?: string;
1363
+ /** @returns {InvoicePaymentDetailsResponse} */
1364
+ declare function InvoicePaymentDetailsResponse(): InvoicePaymentDetailsResponse;
1365
+ type InvoicePaymentDetailsResponse = {
1366
+ data?: InvoicePaymentDetailsResponseData;
1367
+ success?: boolean;
1368
+ payment_details_visible?: boolean;
1359
1369
  };
1360
- /** @returns {RedemptionDetails} */
1361
- declare function RedemptionDetails(): RedemptionDetails;
1362
- type RedemptionDetails = {
1363
- amount_debited?: number;
1364
- created_at?: string;
1365
- invoice_number?: string;
1366
- order_id?: string;
1367
- ordering_channel?: string;
1368
- shipment_id?: string;
1369
- staff_id?: string;
1370
- store_id?: string;
1370
+ /** @returns {InvoiceActivityLogsResponseData} */
1371
+ declare function InvoiceActivityLogsResponseData(): InvoiceActivityLogsResponseData;
1372
+ type InvoiceActivityLogsResponseData = {
1373
+ performed_by?: string;
1374
+ status?: string;
1375
+ reason?: string;
1376
+ is_resolved?: boolean;
1377
+ retry_attempts?: number;
1378
+ max_retry_attempts?: number;
1371
1379
  };
1372
- /** @returns {ReportItem} */
1373
- declare function ReportItem(): ReportItem;
1374
- type ReportItem = {
1375
- allowed_filters?: string[];
1376
- config_meta?: any;
1377
- description?: string;
1378
- display_date?: string;
1379
- id?: string;
1380
- name?: string;
1381
- report_type?: string;
1380
+ /** @returns {InvoiceActivityLogsResponse} */
1381
+ declare function InvoiceActivityLogsResponse(): InvoiceActivityLogsResponse;
1382
+ type InvoiceActivityLogsResponse = {
1383
+ data?: InvoiceActivityLogsResponseData[];
1382
1384
  };
1383
- /** @returns {UnlockCreditNoteRequest} */
1384
- declare function UnlockCreditNoteRequest(): UnlockCreditNoteRequest;
1385
- type UnlockCreditNoteRequest = {
1386
- data?: UnlockCreditNoteRequestData;
1385
+ /** @returns {InvoiceActivityLogError} */
1386
+ declare function InvoiceActivityLogError(): InvoiceActivityLogError;
1387
+ type InvoiceActivityLogError = {
1388
+ reason?: string;
1387
1389
  };
1388
1390
  /** @returns {UnlockCreditNoteRequestData} */
1389
1391
  declare function UnlockCreditNoteRequestData(): UnlockCreditNoteRequestData;
1390
1392
  type UnlockCreditNoteRequestData = {
1391
- description?: string;
1392
- locked_credit_notes?: string[];
1393
1393
  seller_id?: string;
1394
+ locked_credit_notes?: string[];
1394
1395
  unlock_reason?: string;
1396
+ description?: string;
1395
1397
  };
1396
- /** @returns {UnlockCreditNoteResponse} */
1397
- declare function UnlockCreditNoteResponse(): UnlockCreditNoteResponse;
1398
- type UnlockCreditNoteResponse = {
1399
- data?: UnlockCreditNoteResponseData;
1400
- success?: boolean;
1398
+ /** @returns {UnlockCreditNoteRequest} */
1399
+ declare function UnlockCreditNoteRequest(): UnlockCreditNoteRequest;
1400
+ type UnlockCreditNoteRequest = {
1401
+ data?: UnlockCreditNoteRequestData;
1401
1402
  };
1402
1403
  /** @returns {UnlockCreditNoteResponseData} */
1403
1404
  declare function UnlockCreditNoteResponseData(): UnlockCreditNoteResponseData;
@@ -1405,10 +1406,9 @@ type UnlockCreditNoteResponseData = {
1405
1406
  is_cn_unlocked?: boolean;
1406
1407
  status?: string;
1407
1408
  };
1408
- /** @returns {UnpaidInvoiceDataItems} */
1409
- declare function UnpaidInvoiceDataItems(): UnpaidInvoiceDataItems;
1410
- type UnpaidInvoiceDataItems = {
1411
- currency?: string;
1412
- total_unpaid_amount?: number;
1413
- total_unpaid_invoice_count?: number;
1409
+ /** @returns {UnlockCreditNoteResponse} */
1410
+ declare function UnlockCreditNoteResponse(): UnlockCreditNoteResponse;
1411
+ type UnlockCreditNoteResponse = {
1412
+ success?: boolean;
1413
+ data?: UnlockCreditNoteResponseData;
1414
1414
  };