@gofynd/fdk-client-javascript 1.4.7 → 1.4.8-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.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +16 -3
- package/sdk/application/Cart/CartApplicationClient.js +118 -13
- package/sdk/application/Cart/CartApplicationModel.d.ts +121 -45
- package/sdk/application/Cart/CartApplicationModel.js +98 -26
- package/sdk/application/Cart/CartApplicationValidator.d.ts +45 -1
- package/sdk/application/Cart/CartApplicationValidator.js +26 -0
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +4 -2
- package/sdk/application/Catalog/CatalogApplicationModel.js +4 -2
- package/sdk/application/Content/ContentApplicationClient.d.ts +1 -1
- package/sdk/application/Content/ContentApplicationClient.js +5 -3
- package/sdk/application/Content/ContentApplicationModel.d.ts +7 -18
- package/sdk/application/Content/ContentApplicationModel.js +6 -20
- package/sdk/application/Content/ContentApplicationValidator.d.ts +10 -0
- package/sdk/application/Content/ContentApplicationValidator.js +4 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +0 -27
- package/sdk/application/Lead/LeadApplicationClient.js +0 -167
- package/sdk/application/Lead/LeadApplicationModel.d.ts +1 -146
- package/sdk/application/Lead/LeadApplicationModel.js +0 -126
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -25
- package/sdk/application/Lead/LeadApplicationValidator.js +0 -24
- package/sdk/application/Logistic/LogisticApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +2 -0
- package/sdk/application/Logistic/LogisticApplicationModel.js +2 -0
- package/sdk/application/Order/OrderApplicationModel.d.ts +4 -0
- package/sdk/application/Order/OrderApplicationModel.js +4 -0
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +9 -2
- package/sdk/application/Payment/PaymentApplicationModel.js +5 -2
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +2 -0
- package/sdk/application/Theme/ThemeApplicationModel.js +2 -0
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +0 -23
- package/sdk/partner/Lead/LeadPartnerClient.js +0 -157
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +12 -581
- package/sdk/partner/Lead/LeadPartnerModel.js +14 -403
- package/sdk/partner/Lead/LeadPartnerValidator.d.ts +0 -2
- package/sdk/partner/Lead/LeadPartnerValidator.js +0 -12
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +47 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +56 -4
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +2 -2
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +22 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +162 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +119 -1
- package/sdk/partner/Theme/ThemePartnerModel.js +142 -0
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +304 -43
- package/sdk/platform/Billing/BillingPlatformClient.js +2218 -118
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +1330 -282
- package/sdk/platform/Billing/BillingPlatformModel.js +1808 -590
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +324 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +340 -12
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +28 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +198 -5
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +81 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +48 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +214 -40
- package/sdk/platform/Cart/CartPlatformModel.js +164 -24
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +20 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +37 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +16 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +18 -2
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +4 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.js +4 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +28 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +12 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +18 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +25 -0
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +10 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +8 -4
- package/sdk/platform/Content/ContentPlatformModel.js +8 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +49 -28
- package/sdk/platform/Finance/FinancePlatformClient.js +181 -28
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +369 -129
- package/sdk/platform/Finance/FinancePlatformModel.js +404 -110
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +56 -43
- package/sdk/platform/Finance/FinancePlatformValidator.js +61 -42
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +0 -47
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +0 -321
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -46
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +0 -48
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -25
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -167
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +82 -204
- package/sdk/platform/Lead/LeadPlatformModel.js +98 -178
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -25
- package/sdk/platform/Lead/LeadPlatformValidator.js +0 -24
- package/sdk/platform/Order/OrderPlatformModel.d.ts +126 -15
- package/sdk/platform/Order/OrderPlatformModel.js +55 -14
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +12 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +5 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +20 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +26 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +12 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +82 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -1
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +14 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +67 -1
- package/sdk/platform/Theme/ThemePlatformModel.js +78 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +0 -2
- package/sdk/platform/User/UserPlatformModel.js +0 -2
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +0 -40
- package/sdk/platform/Webhook/WebhookPlatformClient.js +0 -307
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +94 -146
- package/sdk/platform/Webhook/WebhookPlatformModel.js +100 -151
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +9 -35
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +8 -46
- package/sdk/public/Billing/BillingPublicClient.d.ts +24 -2
- package/sdk/public/Billing/BillingPublicClient.js +156 -3
- package/sdk/public/Billing/BillingPublicModel.d.ts +368 -26
- package/sdk/public/Billing/BillingPublicModel.js +317 -18
- package/sdk/public/Billing/BillingPublicValidator.d.ts +19 -3
- package/sdk/public/Billing/BillingPublicValidator.js +22 -3
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +22 -22
- package/sdk/public/Webhook/WebhookPublicModel.js +22 -22
|
@@ -1,4 +1,10 @@
|
|
|
1
1
|
export = FinancePlatformModel;
|
|
2
|
+
/**
|
|
3
|
+
* @typedef OrederFreezeResponse
|
|
4
|
+
* @property {boolean} [success]
|
|
5
|
+
* @property {boolean} [oms_freeze]
|
|
6
|
+
* @property {string} [source]
|
|
7
|
+
*/
|
|
2
8
|
/**
|
|
3
9
|
* @typedef GenerateReportMeta
|
|
4
10
|
* @property {string} [brand]
|
|
@@ -20,7 +26,7 @@ export = FinancePlatformModel;
|
|
|
20
26
|
* @property {GenerateReportFilters} [filters]
|
|
21
27
|
*/
|
|
22
28
|
/**
|
|
23
|
-
* @typedef
|
|
29
|
+
* @typedef GenerateReportReq
|
|
24
30
|
* @property {GenerateReportPlatform} [data]
|
|
25
31
|
*/
|
|
26
32
|
/**
|
|
@@ -41,22 +47,44 @@ export = FinancePlatformModel;
|
|
|
41
47
|
*/
|
|
42
48
|
/**
|
|
43
49
|
* @typedef GenerateReportJson
|
|
44
|
-
* @property {
|
|
50
|
+
* @property {Object} [data]
|
|
51
|
+
* @property {number} [item_count]
|
|
45
52
|
* @property {Page} [page]
|
|
46
53
|
* @property {string} [end_date]
|
|
47
|
-
* @property {string[]} [headers]
|
|
48
54
|
* @property {string} [start_date]
|
|
49
|
-
* @property {
|
|
55
|
+
* @property {string[][]} [items]
|
|
56
|
+
* @property {string[]} [headers]
|
|
50
57
|
*/
|
|
51
58
|
/**
|
|
52
59
|
* @typedef Error
|
|
60
|
+
* @property {number} [status]
|
|
53
61
|
* @property {string} [reason]
|
|
54
62
|
* @property {boolean} [success]
|
|
63
|
+
* @property {string} [message]
|
|
64
|
+
* @property {string} [code]
|
|
65
|
+
* @property {string} [exception]
|
|
66
|
+
* @property {string} [info]
|
|
67
|
+
* @property {string} [request_id]
|
|
68
|
+
* @property {string} [stack_trace]
|
|
69
|
+
* @property {ErrorMeta} [meta]
|
|
70
|
+
*/
|
|
71
|
+
/**
|
|
72
|
+
* @typedef ErrorMeta
|
|
73
|
+
* @property {ErrorMetaItems[]} [columns_errors]
|
|
74
|
+
*/
|
|
75
|
+
/**
|
|
76
|
+
* @typedef ErrorMetaItems
|
|
77
|
+
* @property {number} [code]
|
|
78
|
+
* @property {string} [message]
|
|
55
79
|
*/
|
|
56
80
|
/**
|
|
57
81
|
* @typedef DownloadReport
|
|
82
|
+
* @property {DownloadReportData} [data]
|
|
83
|
+
*/
|
|
84
|
+
/**
|
|
85
|
+
* @typedef DownloadReportData
|
|
58
86
|
* @property {number} [page]
|
|
59
|
-
* @property {number} [
|
|
87
|
+
* @property {number} [page_size]
|
|
60
88
|
* @property {string} [start_date]
|
|
61
89
|
* @property {string} [end_date]
|
|
62
90
|
*/
|
|
@@ -75,14 +103,26 @@ export = FinancePlatformModel;
|
|
|
75
103
|
* @property {Page} [page]
|
|
76
104
|
* @property {number} [item_count]
|
|
77
105
|
*/
|
|
106
|
+
/**
|
|
107
|
+
* @typedef GetEngineFilters
|
|
108
|
+
* @property {string} [config_field]
|
|
109
|
+
* @property {string} [status]
|
|
110
|
+
* @property {boolean} [is_active]
|
|
111
|
+
* @property {string} [seller_id]
|
|
112
|
+
*/
|
|
78
113
|
/**
|
|
79
114
|
* @typedef GetEngineData
|
|
80
|
-
* @property {string} [
|
|
115
|
+
* @property {string} [status]
|
|
116
|
+
* @property {GetEngineFilters} [filters]
|
|
81
117
|
* @property {string[]} [project]
|
|
82
|
-
* @property {
|
|
118
|
+
* @property {string} [table_name]
|
|
119
|
+
* @property {Object} [search]
|
|
120
|
+
* @property {number} [page]
|
|
121
|
+
* @property {number} [page_size]
|
|
122
|
+
* @property {string} [order_by]
|
|
83
123
|
*/
|
|
84
124
|
/**
|
|
85
|
-
* @typedef
|
|
125
|
+
* @typedef GetEngineReq
|
|
86
126
|
* @property {GetEngineData} [data]
|
|
87
127
|
*/
|
|
88
128
|
/**
|
|
@@ -97,7 +137,7 @@ export = FinancePlatformModel;
|
|
|
97
137
|
* @property {string} [reason_type]
|
|
98
138
|
*/
|
|
99
139
|
/**
|
|
100
|
-
* @typedef
|
|
140
|
+
* @typedef GetReasonReq
|
|
101
141
|
* @property {GetReason} [data]
|
|
102
142
|
*/
|
|
103
143
|
/**
|
|
@@ -119,7 +159,7 @@ export = FinancePlatformModel;
|
|
|
119
159
|
* @property {boolean} [listing_enabled]
|
|
120
160
|
*/
|
|
121
161
|
/**
|
|
122
|
-
* @typedef
|
|
162
|
+
* @typedef GetReportListReq
|
|
123
163
|
* @property {GetReportListData} [data]
|
|
124
164
|
*/
|
|
125
165
|
/**
|
|
@@ -145,6 +185,7 @@ export = FinancePlatformModel;
|
|
|
145
185
|
*/
|
|
146
186
|
/**
|
|
147
187
|
* @typedef GetAffiliateResponse
|
|
188
|
+
* @property {string} [reason]
|
|
148
189
|
* @property {boolean} [success]
|
|
149
190
|
* @property {Object[]} [docs]
|
|
150
191
|
*/
|
|
@@ -153,7 +194,7 @@ export = FinancePlatformModel;
|
|
|
153
194
|
* @property {string[]} [note_id]
|
|
154
195
|
*/
|
|
155
196
|
/**
|
|
156
|
-
* @typedef
|
|
197
|
+
* @typedef DownloadCreditDebitNoteReq
|
|
157
198
|
* @property {DownloadCreditDebitNote} [data]
|
|
158
199
|
*/
|
|
159
200
|
/**
|
|
@@ -166,21 +207,26 @@ export = FinancePlatformModel;
|
|
|
166
207
|
* @property {boolean} [success]
|
|
167
208
|
* @property {DownloadCreditDebitNoteResponseData[]} [data]
|
|
168
209
|
*/
|
|
210
|
+
/**
|
|
211
|
+
* @typedef InvoiceBillingItem
|
|
212
|
+
* @property {string} [invoice_number]
|
|
213
|
+
* @property {number} [amount]
|
|
214
|
+
*/
|
|
169
215
|
/**
|
|
170
216
|
* @typedef PaymentProcessPayload
|
|
171
217
|
* @property {string} [platform]
|
|
172
|
-
* @property {
|
|
218
|
+
* @property {number} [amount]
|
|
173
219
|
* @property {string} [transaction_type]
|
|
174
220
|
* @property {string} [source_reference]
|
|
175
|
-
* @property {
|
|
221
|
+
* @property {number} [total_amount]
|
|
176
222
|
* @property {Object} [meta]
|
|
177
223
|
* @property {string} [currency]
|
|
178
224
|
* @property {string} [seller_id]
|
|
179
225
|
* @property {string} [mode_of_payment]
|
|
180
|
-
* @property {
|
|
226
|
+
* @property {InvoiceBillingItem[]} [invoice_billing_items]
|
|
181
227
|
*/
|
|
182
228
|
/**
|
|
183
|
-
* @typedef
|
|
229
|
+
* @typedef PaymentProcessReq
|
|
184
230
|
* @property {PaymentProcessPayload} [data]
|
|
185
231
|
*/
|
|
186
232
|
/**
|
|
@@ -195,12 +241,12 @@ export = FinancePlatformModel;
|
|
|
195
241
|
* @typedef CreditlineDataPlatformPayload
|
|
196
242
|
* @property {number} [page]
|
|
197
243
|
* @property {string} [seller_id]
|
|
198
|
-
* @property {string} [
|
|
199
|
-
* @property {string} [
|
|
200
|
-
* @property {number} [
|
|
244
|
+
* @property {string} [end_date]
|
|
245
|
+
* @property {string} [start_date]
|
|
246
|
+
* @property {number} [page_size]
|
|
201
247
|
*/
|
|
202
248
|
/**
|
|
203
|
-
* @typedef
|
|
249
|
+
* @typedef CreditlineDataPlatformReq
|
|
204
250
|
* @property {CreditlineDataPlatformPayload} [data]
|
|
205
251
|
*/
|
|
206
252
|
/**
|
|
@@ -218,7 +264,7 @@ export = FinancePlatformModel;
|
|
|
218
264
|
* @property {string} [seller_id]
|
|
219
265
|
*/
|
|
220
266
|
/**
|
|
221
|
-
* @typedef
|
|
267
|
+
* @typedef IsCreditlinePlatformReq
|
|
222
268
|
* @property {IsCreditlinePayload} [data]
|
|
223
269
|
*/
|
|
224
270
|
/**
|
|
@@ -231,7 +277,7 @@ export = FinancePlatformModel;
|
|
|
231
277
|
* @property {boolean} [is_active]
|
|
232
278
|
*/
|
|
233
279
|
/**
|
|
234
|
-
* @typedef
|
|
280
|
+
* @typedef InvoiceTypeReq
|
|
235
281
|
* @property {InvoiceTypePayloadData} [data]
|
|
236
282
|
*/
|
|
237
283
|
/**
|
|
@@ -261,7 +307,7 @@ export = FinancePlatformModel;
|
|
|
261
307
|
* @property {InoviceListingPayloadDataFilters} [filters]
|
|
262
308
|
*/
|
|
263
309
|
/**
|
|
264
|
-
* @typedef
|
|
310
|
+
* @typedef InvoiceListingReq
|
|
265
311
|
* @property {InvoiceListingPayloadData} [data]
|
|
266
312
|
*/
|
|
267
313
|
/**
|
|
@@ -272,7 +318,7 @@ export = FinancePlatformModel;
|
|
|
272
318
|
*/
|
|
273
319
|
/**
|
|
274
320
|
* @typedef InvoiceListingResponseItems
|
|
275
|
-
* @property {
|
|
321
|
+
* @property {number} [amount]
|
|
276
322
|
* @property {string} [company]
|
|
277
323
|
* @property {string} [status]
|
|
278
324
|
* @property {string} [due_date]
|
|
@@ -286,6 +332,8 @@ export = FinancePlatformModel;
|
|
|
286
332
|
*/
|
|
287
333
|
/**
|
|
288
334
|
* @typedef InvoiceListingResponse
|
|
335
|
+
* @property {boolean} [success]
|
|
336
|
+
* @property {string[]} [headers]
|
|
289
337
|
* @property {UnpaidInvoiceDataItems} [unpaid_invoice_data]
|
|
290
338
|
* @property {InvoiceListingResponseItems[]} [items]
|
|
291
339
|
* @property {Page} [page]
|
|
@@ -296,7 +344,7 @@ export = FinancePlatformModel;
|
|
|
296
344
|
* @property {string[]} [invoice_number]
|
|
297
345
|
*/
|
|
298
346
|
/**
|
|
299
|
-
* @typedef
|
|
347
|
+
* @typedef InvoicePdfReq
|
|
300
348
|
* @property {InvoicePdfPayloadData} [data]
|
|
301
349
|
*/
|
|
302
350
|
/**
|
|
@@ -312,7 +360,7 @@ export = FinancePlatformModel;
|
|
|
312
360
|
* @property {number} [seller_id]
|
|
313
361
|
*/
|
|
314
362
|
/**
|
|
315
|
-
* @typedef
|
|
363
|
+
* @typedef IsCnRefundMethodReq
|
|
316
364
|
* @property {IsCnRefundMethodData} [data]
|
|
317
365
|
*/
|
|
318
366
|
/**
|
|
@@ -342,7 +390,7 @@ export = FinancePlatformModel;
|
|
|
342
390
|
* @property {string[]} [slug_values]
|
|
343
391
|
*/
|
|
344
392
|
/**
|
|
345
|
-
* @typedef
|
|
393
|
+
* @typedef CreateSellerCreditNoteConfigReq
|
|
346
394
|
* @property {CreateSellerCreditNoteConfig} [data]
|
|
347
395
|
*/
|
|
348
396
|
/**
|
|
@@ -357,7 +405,7 @@ export = FinancePlatformModel;
|
|
|
357
405
|
* @property {number} [seller_id]
|
|
358
406
|
*/
|
|
359
407
|
/**
|
|
360
|
-
* @typedef
|
|
408
|
+
* @typedef DeleteConfigReq
|
|
361
409
|
* @property {DeleteConfig} [data]
|
|
362
410
|
*/
|
|
363
411
|
/**
|
|
@@ -366,20 +414,21 @@ export = FinancePlatformModel;
|
|
|
366
414
|
* @property {string} [message]
|
|
367
415
|
*/
|
|
368
416
|
/**
|
|
369
|
-
* @typedef
|
|
370
|
-
* @property {string} [
|
|
417
|
+
* @typedef ChannelDisplayNameItems
|
|
418
|
+
* @property {string} [key]
|
|
419
|
+
* @property {string} [value]
|
|
371
420
|
*/
|
|
372
421
|
/**
|
|
373
422
|
* @typedef ChannelDisplayNameResponse
|
|
374
423
|
* @property {boolean} [success]
|
|
375
|
-
* @property {
|
|
424
|
+
* @property {ChannelDisplayNameItems[]} [items]
|
|
376
425
|
*/
|
|
377
426
|
/**
|
|
378
427
|
* @typedef CnReferenceNumber
|
|
379
428
|
* @property {string} [cn_reference_number]
|
|
380
429
|
*/
|
|
381
430
|
/**
|
|
382
|
-
* @typedef
|
|
431
|
+
* @typedef GetPdfUrlViewReq
|
|
383
432
|
* @property {CnReferenceNumber} [data]
|
|
384
433
|
*/
|
|
385
434
|
/**
|
|
@@ -393,7 +442,7 @@ export = FinancePlatformModel;
|
|
|
393
442
|
* @property {GetPdfUrlViewResponseData} [data]
|
|
394
443
|
*/
|
|
395
444
|
/**
|
|
396
|
-
* @typedef
|
|
445
|
+
* @typedef CreditNoteDetailsReq
|
|
397
446
|
* @property {CnReferenceNumber} [data]
|
|
398
447
|
*/
|
|
399
448
|
/**
|
|
@@ -410,6 +459,7 @@ export = FinancePlatformModel;
|
|
|
410
459
|
*/
|
|
411
460
|
/**
|
|
412
461
|
* @typedef RedemptionDetails
|
|
462
|
+
* @property {Object} [meta]
|
|
413
463
|
* @property {string} [staff_id]
|
|
414
464
|
* @property {string} [created_at]
|
|
415
465
|
* @property {string} [order_id]
|
|
@@ -421,6 +471,8 @@ export = FinancePlatformModel;
|
|
|
421
471
|
*/
|
|
422
472
|
/**
|
|
423
473
|
* @typedef CreditNoteDetails
|
|
474
|
+
* @property {string} [currency]
|
|
475
|
+
* @property {number} [current_amount_used]
|
|
424
476
|
* @property {string} [cn_status]
|
|
425
477
|
* @property {string} [customer_mobile_number]
|
|
426
478
|
* @property {string} [cn_reference_number]
|
|
@@ -442,7 +494,7 @@ export = FinancePlatformModel;
|
|
|
442
494
|
* @property {string} [customer_mobile_number]
|
|
443
495
|
*/
|
|
444
496
|
/**
|
|
445
|
-
* @typedef
|
|
497
|
+
* @typedef GetCustomerCreditBalanceReq
|
|
446
498
|
* @property {GetCustomerCreditBalance} [data]
|
|
447
499
|
*/
|
|
448
500
|
/**
|
|
@@ -456,7 +508,7 @@ export = FinancePlatformModel;
|
|
|
456
508
|
* @property {GetCustomerCreditBalanceResponseData} [data]
|
|
457
509
|
*/
|
|
458
510
|
/**
|
|
459
|
-
* @typedef
|
|
511
|
+
* @typedef GetCnConfigReq
|
|
460
512
|
* @property {DeleteConfig} [data]
|
|
461
513
|
*/
|
|
462
514
|
/**
|
|
@@ -468,7 +520,7 @@ export = FinancePlatformModel;
|
|
|
468
520
|
* @typedef GetCnConfigResponseData
|
|
469
521
|
* @property {boolean} [is_cn_as_refund_method]
|
|
470
522
|
* @property {string} [affiliate_id]
|
|
471
|
-
* @property {
|
|
523
|
+
* @property {Object} [meta]
|
|
472
524
|
* @property {number} [seller_id]
|
|
473
525
|
* @property {CreditNoteConfigNotificationEvents} [notification_events]
|
|
474
526
|
* @property {number} [validity]
|
|
@@ -487,13 +539,14 @@ export = FinancePlatformModel;
|
|
|
487
539
|
* @property {string[]} [utilisation]
|
|
488
540
|
* @property {string[]} [ordering_channel]
|
|
489
541
|
* @property {number[]} [store_id]
|
|
490
|
-
* @property {string[]} [
|
|
542
|
+
* @property {string[]} [type_of_transaction]
|
|
543
|
+
* @property {string[]} [issuance_channel]
|
|
491
544
|
*/
|
|
492
545
|
/**
|
|
493
546
|
* @typedef CnGenerateReport
|
|
494
547
|
* @property {number} [page]
|
|
495
548
|
* @property {string} [end_date]
|
|
496
|
-
* @property {number} [
|
|
549
|
+
* @property {number} [page_size]
|
|
497
550
|
* @property {CnGenerateReportFilters} [filters]
|
|
498
551
|
* @property {string} [affiliate_id]
|
|
499
552
|
* @property {GenerateReportFilters} [meta]
|
|
@@ -503,7 +556,7 @@ export = FinancePlatformModel;
|
|
|
503
556
|
* @property {string} [start_date]
|
|
504
557
|
*/
|
|
505
558
|
/**
|
|
506
|
-
* @typedef
|
|
559
|
+
* @typedef GenerateReportCustomerCnReq
|
|
507
560
|
* @property {CnGenerateReport} [data]
|
|
508
561
|
*/
|
|
509
562
|
/**
|
|
@@ -519,6 +572,8 @@ export = FinancePlatformModel;
|
|
|
519
572
|
*/
|
|
520
573
|
/**
|
|
521
574
|
* @typedef GenerateReportCustomerCnResponseData
|
|
575
|
+
* @property {boolean} [success]
|
|
576
|
+
* @property {string} [message]
|
|
522
577
|
* @property {CnGenerateReportItems[]} [items]
|
|
523
578
|
* @property {Object} [row_header_display_order]
|
|
524
579
|
* @property {string} [end_date]
|
|
@@ -540,12 +595,12 @@ export = FinancePlatformModel;
|
|
|
540
595
|
* @property {string} [end_date]
|
|
541
596
|
* @property {string} [affiliate_id]
|
|
542
597
|
* @property {string} [search]
|
|
543
|
-
* @property {string
|
|
598
|
+
* @property {string} [status]
|
|
544
599
|
* @property {string} [search_type]
|
|
545
|
-
* @property {number} [
|
|
600
|
+
* @property {number} [page_size]
|
|
546
601
|
*/
|
|
547
602
|
/**
|
|
548
|
-
* @typedef
|
|
603
|
+
* @typedef DownloadReportCustomerCnReq
|
|
549
604
|
* @property {CnDownloadReport} [data]
|
|
550
605
|
*/
|
|
551
606
|
/**
|
|
@@ -567,7 +622,10 @@ export = FinancePlatformModel;
|
|
|
567
622
|
*/
|
|
568
623
|
/**
|
|
569
624
|
* @typedef DownloadReportCustomerCnResponse
|
|
625
|
+
* @property {DownloadReportResponseData[]} [items]
|
|
570
626
|
* @property {DownloadReportResponseData[]} [data]
|
|
627
|
+
* @property {number} [item_count]
|
|
628
|
+
* @property {Page} [page]
|
|
571
629
|
*/
|
|
572
630
|
/**
|
|
573
631
|
* @typedef GetReportingFilters
|
|
@@ -585,12 +643,66 @@ export = FinancePlatformModel;
|
|
|
585
643
|
* @property {string} [type]
|
|
586
644
|
* @property {string} [value]
|
|
587
645
|
*/
|
|
646
|
+
/**
|
|
647
|
+
* @typedef GetReportingFiltersReasonOptions
|
|
648
|
+
* @property {string} [text]
|
|
649
|
+
* @property {string} [value]
|
|
650
|
+
* @property {string} [placeholder_text]
|
|
651
|
+
*/
|
|
652
|
+
/**
|
|
653
|
+
* @typedef GetReportingFiltersReason
|
|
654
|
+
* @property {string} [text]
|
|
655
|
+
* @property {string} [type]
|
|
656
|
+
* @property {string} [value]
|
|
657
|
+
* @property {GetReportingFiltersReasonOptions[]} [options]
|
|
658
|
+
*/
|
|
588
659
|
/**
|
|
589
660
|
* @typedef GetReportingFiltersResponse
|
|
661
|
+
* @property {GetReportingFiltersReason} [reason]
|
|
590
662
|
* @property {GetReportingFilters} [search]
|
|
591
663
|
* @property {GetReportingNestedFilters[]} [filters]
|
|
592
664
|
* @property {GetReportingFilters} [status]
|
|
593
665
|
*/
|
|
666
|
+
/**
|
|
667
|
+
* @typedef InvoicePaymentOptionsPayloadData
|
|
668
|
+
* @property {string[]} [invoice_numbers]
|
|
669
|
+
*/
|
|
670
|
+
/**
|
|
671
|
+
* @typedef InvoicePaymentOptionsReq
|
|
672
|
+
* @property {InvoicePaymentOptionsPayloadData} [data]
|
|
673
|
+
*/
|
|
674
|
+
/**
|
|
675
|
+
* @typedef InvoicePaymentOptionsResponsePayableAmounts
|
|
676
|
+
* @property {number} [amount]
|
|
677
|
+
* @property {string} [amount_key]
|
|
678
|
+
* @property {string} [header]
|
|
679
|
+
*/
|
|
680
|
+
/**
|
|
681
|
+
* @typedef InvoicePaymentOptionsResponseDeductedAmounts
|
|
682
|
+
* @property {number} [amount]
|
|
683
|
+
* @property {string} [header]
|
|
684
|
+
* @property {string} [amount_key]
|
|
685
|
+
* @property {boolean} [is_payable]
|
|
686
|
+
* @property {string} [symbol]
|
|
687
|
+
*/
|
|
688
|
+
/**
|
|
689
|
+
* @typedef InvoicePaymentOptionsResponseData
|
|
690
|
+
* @property {string} [invoice_number]
|
|
691
|
+
* @property {string} [invoice_type]
|
|
692
|
+
* @property {InvoicePaymentOptionsResponsePayableAmounts[]} [display_amounts]
|
|
693
|
+
* @property {Object} [total_amount]
|
|
694
|
+
* @property {Object} [deducted_amounts]
|
|
695
|
+
* @property {InvoicePaymentOptionsResponsePayableAmounts[]} [payable_amounts]
|
|
696
|
+
* @property {Currency} [currency]
|
|
697
|
+
*/
|
|
698
|
+
/**
|
|
699
|
+
* @typedef InvoicePaymentOptionsResponse
|
|
700
|
+
* @property {string} [reason]
|
|
701
|
+
* @property {InvoicePaymentOptionsResponseData[]} [data]
|
|
702
|
+
* @property {number} [total_payable_amount]
|
|
703
|
+
* @property {number} [invoice_count]
|
|
704
|
+
* @property {boolean} [success]
|
|
705
|
+
*/
|
|
594
706
|
/**
|
|
595
707
|
* @typedef PaymentDetail
|
|
596
708
|
* @property {string} [display_name]
|
|
@@ -609,6 +721,7 @@ export = FinancePlatformModel;
|
|
|
609
721
|
*/
|
|
610
722
|
/**
|
|
611
723
|
* @typedef InvoicePaymentDetailsResponse
|
|
724
|
+
* @property {string} [reason]
|
|
612
725
|
* @property {InvoicePaymentDetailsResponseData} [data]
|
|
613
726
|
* @property {boolean} [success]
|
|
614
727
|
* @property {boolean} [payment_details_visible]
|
|
@@ -638,7 +751,7 @@ export = FinancePlatformModel;
|
|
|
638
751
|
* @property {string} [description]
|
|
639
752
|
*/
|
|
640
753
|
/**
|
|
641
|
-
* @typedef
|
|
754
|
+
* @typedef UnlockCreditNoteReq
|
|
642
755
|
* @property {UnlockCreditNoteRequestData} [data]
|
|
643
756
|
*/
|
|
644
757
|
/**
|
|
@@ -654,8 +767,15 @@ export = FinancePlatformModel;
|
|
|
654
767
|
declare class FinancePlatformModel {
|
|
655
768
|
}
|
|
656
769
|
declare namespace FinancePlatformModel {
|
|
657
|
-
export { GenerateReportMeta, GenerateReportFilters, GenerateReportPlatform,
|
|
770
|
+
export { OrederFreezeResponse, GenerateReportMeta, GenerateReportFilters, GenerateReportPlatform, GenerateReportReq, Page, Currency, GenerateReportJson, Error, ErrorMeta, ErrorMetaItems, DownloadReport, DownloadReportData, DownloadReportItems, DownloadReportList, GetEngineFilters, GetEngineData, GetEngineReq, GetEngineResponse, GetReason, GetReasonReq, ReasonItem, GetReasonResponse, GetReportListData, GetReportListReq, GetAffiliate, GetReportListResponse, ReportItem, GetAffiliateResponse, DownloadCreditDebitNote, DownloadCreditDebitNoteReq, DownloadCreditDebitNoteResponseData, DownloadCreditDebitNoteResponse, InvoiceBillingItem, PaymentProcessPayload, PaymentProcessReq, PaymentProcessResponse, CreditlineDataPlatformPayload, CreditlineDataPlatformReq, CreditlineDataPlatformResponse, IsCreditlinePayload, IsCreditlinePlatformReq, IsCreditlinePlatformResponse, InvoiceTypePayloadData, InvoiceTypeReq, InvoiceTypeResponseItems, InvoiceTypeResponse, InoviceListingPayloadDataFilters, InvoiceListingPayloadData, InvoiceListingReq, UnpaidInvoiceDataItems, InvoiceListingResponseItems, InvoiceListingResponse, InvoicePdfPayloadData, InvoicePdfReq, InvoicePdfResponse, IsCnRefundMethodData, IsCnRefundMethodReq, IsCnRefundMethodResponseData, IsCnRefundMethodResponse, CreditNoteConfigNotificationEvents, CreateSellerCreditNoteConfig, CreateSellerCreditNoteConfigReq, CreateSellerCreditNoteConfigResponse, DeleteConfig, DeleteConfigReq, DeleteConfigResponse, ChannelDisplayNameItems, ChannelDisplayNameResponse, CnReferenceNumber, GetPdfUrlViewReq, GetPdfUrlViewResponseData, GetPdfUrlViewResponse, CreditNoteDetailsReq, CnDetails, RedemptionDetails, CreditNoteDetails, CreditNoteDetailsResponse, GetCustomerCreditBalance, GetCustomerCreditBalanceReq, GetCustomerCreditBalanceResponseData, GetCustomerCreditBalanceResponse, GetCnConfigReq, GetCnConfigResponseMeta, GetCnConfigResponseData, GetCnConfigResponse, CnGenerateReportFilters, CnGenerateReport, GenerateReportCustomerCnReq, CnGenerateReportItems, GenerateReportCustomerCnResponseData, GenerateReportCustomerCnResponse, CnDownloadReport, DownloadReportCustomerCnReq, DownloadReportResponseData, DownloadReportCustomerCnResponse, GetReportingFilters, GetReportingNestedFilters, GetReportingFiltersReasonOptions, GetReportingFiltersReason, GetReportingFiltersResponse, InvoicePaymentOptionsPayloadData, InvoicePaymentOptionsReq, InvoicePaymentOptionsResponsePayableAmounts, InvoicePaymentOptionsResponseDeductedAmounts, InvoicePaymentOptionsResponseData, InvoicePaymentOptionsResponse, PaymentDetail, PaidInvoicePaymentDetail, InvoicePaymentDetailsResponseData, InvoicePaymentDetailsResponse, InvoiceActivityLogsResponseData, InvoiceActivityLogsResponse, InvoiceActivityLogError, UnlockCreditNoteRequestData, UnlockCreditNoteReq, UnlockCreditNoteResponseData, UnlockCreditNoteResponse };
|
|
658
771
|
}
|
|
772
|
+
/** @returns {OrederFreezeResponse} */
|
|
773
|
+
declare function OrederFreezeResponse(): OrederFreezeResponse;
|
|
774
|
+
type OrederFreezeResponse = {
|
|
775
|
+
success?: boolean;
|
|
776
|
+
oms_freeze?: boolean;
|
|
777
|
+
source?: string;
|
|
778
|
+
};
|
|
659
779
|
/** @returns {GenerateReportMeta} */
|
|
660
780
|
declare function GenerateReportMeta(): GenerateReportMeta;
|
|
661
781
|
type GenerateReportMeta = {
|
|
@@ -679,9 +799,9 @@ type GenerateReportPlatform = {
|
|
|
679
799
|
report_id?: string;
|
|
680
800
|
filters?: GenerateReportFilters;
|
|
681
801
|
};
|
|
682
|
-
/** @returns {
|
|
683
|
-
declare function
|
|
684
|
-
type
|
|
802
|
+
/** @returns {GenerateReportReq} */
|
|
803
|
+
declare function GenerateReportReq(): GenerateReportReq;
|
|
804
|
+
type GenerateReportReq = {
|
|
685
805
|
data?: GenerateReportPlatform;
|
|
686
806
|
};
|
|
687
807
|
/** @returns {Page} */
|
|
@@ -705,24 +825,49 @@ type Currency = {
|
|
|
705
825
|
/** @returns {GenerateReportJson} */
|
|
706
826
|
declare function GenerateReportJson(): GenerateReportJson;
|
|
707
827
|
type GenerateReportJson = {
|
|
708
|
-
|
|
828
|
+
data?: any;
|
|
829
|
+
item_count?: number;
|
|
709
830
|
page?: Page;
|
|
710
831
|
end_date?: string;
|
|
711
|
-
headers?: string[];
|
|
712
832
|
start_date?: string;
|
|
713
|
-
|
|
833
|
+
items?: string[][];
|
|
834
|
+
headers?: string[];
|
|
714
835
|
};
|
|
715
836
|
/** @returns {Error} */
|
|
716
837
|
declare function Error(): Error;
|
|
717
838
|
type Error = {
|
|
839
|
+
status?: number;
|
|
718
840
|
reason?: string;
|
|
719
841
|
success?: boolean;
|
|
842
|
+
message?: string;
|
|
843
|
+
code?: string;
|
|
844
|
+
exception?: string;
|
|
845
|
+
info?: string;
|
|
846
|
+
request_id?: string;
|
|
847
|
+
stack_trace?: string;
|
|
848
|
+
meta?: ErrorMeta;
|
|
849
|
+
};
|
|
850
|
+
/** @returns {ErrorMeta} */
|
|
851
|
+
declare function ErrorMeta(): ErrorMeta;
|
|
852
|
+
type ErrorMeta = {
|
|
853
|
+
columns_errors?: ErrorMetaItems[];
|
|
854
|
+
};
|
|
855
|
+
/** @returns {ErrorMetaItems} */
|
|
856
|
+
declare function ErrorMetaItems(): ErrorMetaItems;
|
|
857
|
+
type ErrorMetaItems = {
|
|
858
|
+
code?: number;
|
|
859
|
+
message?: string;
|
|
720
860
|
};
|
|
721
861
|
/** @returns {DownloadReport} */
|
|
722
862
|
declare function DownloadReport(): DownloadReport;
|
|
723
863
|
type DownloadReport = {
|
|
864
|
+
data?: DownloadReportData;
|
|
865
|
+
};
|
|
866
|
+
/** @returns {DownloadReportData} */
|
|
867
|
+
declare function DownloadReportData(): DownloadReportData;
|
|
868
|
+
type DownloadReportData = {
|
|
724
869
|
page?: number;
|
|
725
|
-
|
|
870
|
+
page_size?: number;
|
|
726
871
|
start_date?: string;
|
|
727
872
|
end_date?: string;
|
|
728
873
|
};
|
|
@@ -743,16 +888,29 @@ type DownloadReportList = {
|
|
|
743
888
|
page?: Page;
|
|
744
889
|
item_count?: number;
|
|
745
890
|
};
|
|
891
|
+
/** @returns {GetEngineFilters} */
|
|
892
|
+
declare function GetEngineFilters(): GetEngineFilters;
|
|
893
|
+
type GetEngineFilters = {
|
|
894
|
+
config_field?: string;
|
|
895
|
+
status?: string;
|
|
896
|
+
is_active?: boolean;
|
|
897
|
+
seller_id?: string;
|
|
898
|
+
};
|
|
746
899
|
/** @returns {GetEngineData} */
|
|
747
900
|
declare function GetEngineData(): GetEngineData;
|
|
748
901
|
type GetEngineData = {
|
|
749
|
-
|
|
902
|
+
status?: string;
|
|
903
|
+
filters?: GetEngineFilters;
|
|
750
904
|
project?: string[];
|
|
751
|
-
|
|
905
|
+
table_name?: string;
|
|
906
|
+
search?: any;
|
|
907
|
+
page?: number;
|
|
908
|
+
page_size?: number;
|
|
909
|
+
order_by?: string;
|
|
752
910
|
};
|
|
753
|
-
/** @returns {
|
|
754
|
-
declare function
|
|
755
|
-
type
|
|
911
|
+
/** @returns {GetEngineReq} */
|
|
912
|
+
declare function GetEngineReq(): GetEngineReq;
|
|
913
|
+
type GetEngineReq = {
|
|
756
914
|
data?: GetEngineData;
|
|
757
915
|
};
|
|
758
916
|
/** @returns {GetEngineResponse} */
|
|
@@ -768,9 +926,9 @@ declare function GetReason(): GetReason;
|
|
|
768
926
|
type GetReason = {
|
|
769
927
|
reason_type?: string;
|
|
770
928
|
};
|
|
771
|
-
/** @returns {
|
|
772
|
-
declare function
|
|
773
|
-
type
|
|
929
|
+
/** @returns {GetReasonReq} */
|
|
930
|
+
declare function GetReasonReq(): GetReasonReq;
|
|
931
|
+
type GetReasonReq = {
|
|
774
932
|
data?: GetReason;
|
|
775
933
|
};
|
|
776
934
|
/** @returns {ReasonItem} */
|
|
@@ -794,9 +952,9 @@ type GetReportListData = {
|
|
|
794
952
|
role_name?: string;
|
|
795
953
|
listing_enabled?: boolean;
|
|
796
954
|
};
|
|
797
|
-
/** @returns {
|
|
798
|
-
declare function
|
|
799
|
-
type
|
|
955
|
+
/** @returns {GetReportListReq} */
|
|
956
|
+
declare function GetReportListReq(): GetReportListReq;
|
|
957
|
+
type GetReportListReq = {
|
|
800
958
|
data?: GetReportListData;
|
|
801
959
|
};
|
|
802
960
|
/** @returns {GetAffiliate} */
|
|
@@ -826,6 +984,7 @@ type ReportItem = {
|
|
|
826
984
|
/** @returns {GetAffiliateResponse} */
|
|
827
985
|
declare function GetAffiliateResponse(): GetAffiliateResponse;
|
|
828
986
|
type GetAffiliateResponse = {
|
|
987
|
+
reason?: string;
|
|
829
988
|
success?: boolean;
|
|
830
989
|
docs?: any[];
|
|
831
990
|
};
|
|
@@ -834,9 +993,9 @@ declare function DownloadCreditDebitNote(): DownloadCreditDebitNote;
|
|
|
834
993
|
type DownloadCreditDebitNote = {
|
|
835
994
|
note_id?: string[];
|
|
836
995
|
};
|
|
837
|
-
/** @returns {
|
|
838
|
-
declare function
|
|
839
|
-
type
|
|
996
|
+
/** @returns {DownloadCreditDebitNoteReq} */
|
|
997
|
+
declare function DownloadCreditDebitNoteReq(): DownloadCreditDebitNoteReq;
|
|
998
|
+
type DownloadCreditDebitNoteReq = {
|
|
840
999
|
data?: DownloadCreditDebitNote;
|
|
841
1000
|
};
|
|
842
1001
|
/** @returns {DownloadCreditDebitNoteResponseData} */
|
|
@@ -851,23 +1010,29 @@ type DownloadCreditDebitNoteResponse = {
|
|
|
851
1010
|
success?: boolean;
|
|
852
1011
|
data?: DownloadCreditDebitNoteResponseData[];
|
|
853
1012
|
};
|
|
1013
|
+
/** @returns {InvoiceBillingItem} */
|
|
1014
|
+
declare function InvoiceBillingItem(): InvoiceBillingItem;
|
|
1015
|
+
type InvoiceBillingItem = {
|
|
1016
|
+
invoice_number?: string;
|
|
1017
|
+
amount?: number;
|
|
1018
|
+
};
|
|
854
1019
|
/** @returns {PaymentProcessPayload} */
|
|
855
1020
|
declare function PaymentProcessPayload(): PaymentProcessPayload;
|
|
856
1021
|
type PaymentProcessPayload = {
|
|
857
1022
|
platform?: string;
|
|
858
|
-
amount?:
|
|
1023
|
+
amount?: number;
|
|
859
1024
|
transaction_type?: string;
|
|
860
1025
|
source_reference?: string;
|
|
861
|
-
total_amount?:
|
|
1026
|
+
total_amount?: number;
|
|
862
1027
|
meta?: any;
|
|
863
1028
|
currency?: string;
|
|
864
1029
|
seller_id?: string;
|
|
865
1030
|
mode_of_payment?: string;
|
|
866
|
-
|
|
1031
|
+
invoice_billing_items?: InvoiceBillingItem[];
|
|
867
1032
|
};
|
|
868
|
-
/** @returns {
|
|
869
|
-
declare function
|
|
870
|
-
type
|
|
1033
|
+
/** @returns {PaymentProcessReq} */
|
|
1034
|
+
declare function PaymentProcessReq(): PaymentProcessReq;
|
|
1035
|
+
type PaymentProcessReq = {
|
|
871
1036
|
data?: PaymentProcessPayload;
|
|
872
1037
|
};
|
|
873
1038
|
/** @returns {PaymentProcessResponse} */
|
|
@@ -884,13 +1049,13 @@ declare function CreditlineDataPlatformPayload(): CreditlineDataPlatformPayload;
|
|
|
884
1049
|
type CreditlineDataPlatformPayload = {
|
|
885
1050
|
page?: number;
|
|
886
1051
|
seller_id?: string;
|
|
887
|
-
|
|
888
|
-
|
|
889
|
-
|
|
1052
|
+
end_date?: string;
|
|
1053
|
+
start_date?: string;
|
|
1054
|
+
page_size?: number;
|
|
890
1055
|
};
|
|
891
|
-
/** @returns {
|
|
892
|
-
declare function
|
|
893
|
-
type
|
|
1056
|
+
/** @returns {CreditlineDataPlatformReq} */
|
|
1057
|
+
declare function CreditlineDataPlatformReq(): CreditlineDataPlatformReq;
|
|
1058
|
+
type CreditlineDataPlatformReq = {
|
|
894
1059
|
data?: CreditlineDataPlatformPayload;
|
|
895
1060
|
};
|
|
896
1061
|
/** @returns {CreditlineDataPlatformResponse} */
|
|
@@ -909,9 +1074,9 @@ declare function IsCreditlinePayload(): IsCreditlinePayload;
|
|
|
909
1074
|
type IsCreditlinePayload = {
|
|
910
1075
|
seller_id?: string;
|
|
911
1076
|
};
|
|
912
|
-
/** @returns {
|
|
913
|
-
declare function
|
|
914
|
-
type
|
|
1077
|
+
/** @returns {IsCreditlinePlatformReq} */
|
|
1078
|
+
declare function IsCreditlinePlatformReq(): IsCreditlinePlatformReq;
|
|
1079
|
+
type IsCreditlinePlatformReq = {
|
|
915
1080
|
data?: IsCreditlinePayload;
|
|
916
1081
|
};
|
|
917
1082
|
/** @returns {IsCreditlinePlatformResponse} */
|
|
@@ -925,9 +1090,9 @@ declare function InvoiceTypePayloadData(): InvoiceTypePayloadData;
|
|
|
925
1090
|
type InvoiceTypePayloadData = {
|
|
926
1091
|
is_active?: boolean;
|
|
927
1092
|
};
|
|
928
|
-
/** @returns {
|
|
929
|
-
declare function
|
|
930
|
-
type
|
|
1093
|
+
/** @returns {InvoiceTypeReq} */
|
|
1094
|
+
declare function InvoiceTypeReq(): InvoiceTypeReq;
|
|
1095
|
+
type InvoiceTypeReq = {
|
|
931
1096
|
data?: InvoiceTypePayloadData;
|
|
932
1097
|
};
|
|
933
1098
|
/** @returns {InvoiceTypeResponseItems} */
|
|
@@ -960,9 +1125,9 @@ type InvoiceListingPayloadData = {
|
|
|
960
1125
|
search?: string;
|
|
961
1126
|
filters?: InoviceListingPayloadDataFilters;
|
|
962
1127
|
};
|
|
963
|
-
/** @returns {
|
|
964
|
-
declare function
|
|
965
|
-
type
|
|
1128
|
+
/** @returns {InvoiceListingReq} */
|
|
1129
|
+
declare function InvoiceListingReq(): InvoiceListingReq;
|
|
1130
|
+
type InvoiceListingReq = {
|
|
966
1131
|
data?: InvoiceListingPayloadData;
|
|
967
1132
|
};
|
|
968
1133
|
/** @returns {UnpaidInvoiceDataItems} */
|
|
@@ -975,7 +1140,7 @@ type UnpaidInvoiceDataItems = {
|
|
|
975
1140
|
/** @returns {InvoiceListingResponseItems} */
|
|
976
1141
|
declare function InvoiceListingResponseItems(): InvoiceListingResponseItems;
|
|
977
1142
|
type InvoiceListingResponseItems = {
|
|
978
|
-
amount?:
|
|
1143
|
+
amount?: number;
|
|
979
1144
|
company?: string;
|
|
980
1145
|
status?: string;
|
|
981
1146
|
due_date?: string;
|
|
@@ -990,6 +1155,8 @@ type InvoiceListingResponseItems = {
|
|
|
990
1155
|
/** @returns {InvoiceListingResponse} */
|
|
991
1156
|
declare function InvoiceListingResponse(): InvoiceListingResponse;
|
|
992
1157
|
type InvoiceListingResponse = {
|
|
1158
|
+
success?: boolean;
|
|
1159
|
+
headers?: string[];
|
|
993
1160
|
unpaid_invoice_data?: UnpaidInvoiceDataItems;
|
|
994
1161
|
items?: InvoiceListingResponseItems[];
|
|
995
1162
|
page?: Page;
|
|
@@ -1000,9 +1167,9 @@ declare function InvoicePdfPayloadData(): InvoicePdfPayloadData;
|
|
|
1000
1167
|
type InvoicePdfPayloadData = {
|
|
1001
1168
|
invoice_number?: string[];
|
|
1002
1169
|
};
|
|
1003
|
-
/** @returns {
|
|
1004
|
-
declare function
|
|
1005
|
-
type
|
|
1170
|
+
/** @returns {InvoicePdfReq} */
|
|
1171
|
+
declare function InvoicePdfReq(): InvoicePdfReq;
|
|
1172
|
+
type InvoicePdfReq = {
|
|
1006
1173
|
data?: InvoicePdfPayloadData;
|
|
1007
1174
|
};
|
|
1008
1175
|
/** @returns {InvoicePdfResponse} */
|
|
@@ -1019,9 +1186,9 @@ type IsCnRefundMethodData = {
|
|
|
1019
1186
|
toggle_edit_required?: boolean;
|
|
1020
1187
|
seller_id?: number;
|
|
1021
1188
|
};
|
|
1022
|
-
/** @returns {
|
|
1023
|
-
declare function
|
|
1024
|
-
type
|
|
1189
|
+
/** @returns {IsCnRefundMethodReq} */
|
|
1190
|
+
declare function IsCnRefundMethodReq(): IsCnRefundMethodReq;
|
|
1191
|
+
type IsCnRefundMethodReq = {
|
|
1025
1192
|
data?: IsCnRefundMethodData;
|
|
1026
1193
|
};
|
|
1027
1194
|
/** @returns {IsCnRefundMethodResponseData} */
|
|
@@ -1054,9 +1221,9 @@ type CreateSellerCreditNoteConfig = {
|
|
|
1054
1221
|
currency_type?: string;
|
|
1055
1222
|
slug_values?: string[];
|
|
1056
1223
|
};
|
|
1057
|
-
/** @returns {
|
|
1058
|
-
declare function
|
|
1059
|
-
type
|
|
1224
|
+
/** @returns {CreateSellerCreditNoteConfigReq} */
|
|
1225
|
+
declare function CreateSellerCreditNoteConfigReq(): CreateSellerCreditNoteConfigReq;
|
|
1226
|
+
type CreateSellerCreditNoteConfigReq = {
|
|
1060
1227
|
data?: CreateSellerCreditNoteConfig;
|
|
1061
1228
|
};
|
|
1062
1229
|
/** @returns {CreateSellerCreditNoteConfigResponse} */
|
|
@@ -1072,9 +1239,9 @@ type DeleteConfig = {
|
|
|
1072
1239
|
slug_values?: string[];
|
|
1073
1240
|
seller_id?: number;
|
|
1074
1241
|
};
|
|
1075
|
-
/** @returns {
|
|
1076
|
-
declare function
|
|
1077
|
-
type
|
|
1242
|
+
/** @returns {DeleteConfigReq} */
|
|
1243
|
+
declare function DeleteConfigReq(): DeleteConfigReq;
|
|
1244
|
+
type DeleteConfigReq = {
|
|
1078
1245
|
data?: DeleteConfig;
|
|
1079
1246
|
};
|
|
1080
1247
|
/** @returns {DeleteConfigResponse} */
|
|
@@ -1083,25 +1250,26 @@ type DeleteConfigResponse = {
|
|
|
1083
1250
|
success?: boolean;
|
|
1084
1251
|
message?: string;
|
|
1085
1252
|
};
|
|
1086
|
-
/** @returns {
|
|
1087
|
-
declare function
|
|
1088
|
-
type
|
|
1089
|
-
|
|
1253
|
+
/** @returns {ChannelDisplayNameItems} */
|
|
1254
|
+
declare function ChannelDisplayNameItems(): ChannelDisplayNameItems;
|
|
1255
|
+
type ChannelDisplayNameItems = {
|
|
1256
|
+
key?: string;
|
|
1257
|
+
value?: string;
|
|
1090
1258
|
};
|
|
1091
1259
|
/** @returns {ChannelDisplayNameResponse} */
|
|
1092
1260
|
declare function ChannelDisplayNameResponse(): ChannelDisplayNameResponse;
|
|
1093
1261
|
type ChannelDisplayNameResponse = {
|
|
1094
1262
|
success?: boolean;
|
|
1095
|
-
|
|
1263
|
+
items?: ChannelDisplayNameItems[];
|
|
1096
1264
|
};
|
|
1097
1265
|
/** @returns {CnReferenceNumber} */
|
|
1098
1266
|
declare function CnReferenceNumber(): CnReferenceNumber;
|
|
1099
1267
|
type CnReferenceNumber = {
|
|
1100
1268
|
cn_reference_number?: string;
|
|
1101
1269
|
};
|
|
1102
|
-
/** @returns {
|
|
1103
|
-
declare function
|
|
1104
|
-
type
|
|
1270
|
+
/** @returns {GetPdfUrlViewReq} */
|
|
1271
|
+
declare function GetPdfUrlViewReq(): GetPdfUrlViewReq;
|
|
1272
|
+
type GetPdfUrlViewReq = {
|
|
1105
1273
|
data?: CnReferenceNumber;
|
|
1106
1274
|
};
|
|
1107
1275
|
/** @returns {GetPdfUrlViewResponseData} */
|
|
@@ -1116,9 +1284,9 @@ type GetPdfUrlViewResponse = {
|
|
|
1116
1284
|
success?: boolean;
|
|
1117
1285
|
data?: GetPdfUrlViewResponseData;
|
|
1118
1286
|
};
|
|
1119
|
-
/** @returns {
|
|
1120
|
-
declare function
|
|
1121
|
-
type
|
|
1287
|
+
/** @returns {CreditNoteDetailsReq} */
|
|
1288
|
+
declare function CreditNoteDetailsReq(): CreditNoteDetailsReq;
|
|
1289
|
+
type CreditNoteDetailsReq = {
|
|
1122
1290
|
data?: CnReferenceNumber;
|
|
1123
1291
|
};
|
|
1124
1292
|
/** @returns {CnDetails} */
|
|
@@ -1137,6 +1305,7 @@ type CnDetails = {
|
|
|
1137
1305
|
/** @returns {RedemptionDetails} */
|
|
1138
1306
|
declare function RedemptionDetails(): RedemptionDetails;
|
|
1139
1307
|
type RedemptionDetails = {
|
|
1308
|
+
meta?: any;
|
|
1140
1309
|
staff_id?: string;
|
|
1141
1310
|
created_at?: string;
|
|
1142
1311
|
order_id?: string;
|
|
@@ -1149,6 +1318,8 @@ type RedemptionDetails = {
|
|
|
1149
1318
|
/** @returns {CreditNoteDetails} */
|
|
1150
1319
|
declare function CreditNoteDetails(): CreditNoteDetails;
|
|
1151
1320
|
type CreditNoteDetails = {
|
|
1321
|
+
currency?: string;
|
|
1322
|
+
current_amount_used?: number;
|
|
1152
1323
|
cn_status?: string;
|
|
1153
1324
|
customer_mobile_number?: string;
|
|
1154
1325
|
cn_reference_number?: string;
|
|
@@ -1171,9 +1342,9 @@ type GetCustomerCreditBalance = {
|
|
|
1171
1342
|
seller_id?: number;
|
|
1172
1343
|
customer_mobile_number?: string;
|
|
1173
1344
|
};
|
|
1174
|
-
/** @returns {
|
|
1175
|
-
declare function
|
|
1176
|
-
type
|
|
1345
|
+
/** @returns {GetCustomerCreditBalanceReq} */
|
|
1346
|
+
declare function GetCustomerCreditBalanceReq(): GetCustomerCreditBalanceReq;
|
|
1347
|
+
type GetCustomerCreditBalanceReq = {
|
|
1177
1348
|
data?: GetCustomerCreditBalance;
|
|
1178
1349
|
};
|
|
1179
1350
|
/** @returns {GetCustomerCreditBalanceResponseData} */
|
|
@@ -1188,9 +1359,9 @@ type GetCustomerCreditBalanceResponse = {
|
|
|
1188
1359
|
success?: boolean;
|
|
1189
1360
|
data?: GetCustomerCreditBalanceResponseData;
|
|
1190
1361
|
};
|
|
1191
|
-
/** @returns {
|
|
1192
|
-
declare function
|
|
1193
|
-
type
|
|
1362
|
+
/** @returns {GetCnConfigReq} */
|
|
1363
|
+
declare function GetCnConfigReq(): GetCnConfigReq;
|
|
1364
|
+
type GetCnConfigReq = {
|
|
1194
1365
|
data?: DeleteConfig;
|
|
1195
1366
|
};
|
|
1196
1367
|
/** @returns {GetCnConfigResponseMeta} */
|
|
@@ -1204,7 +1375,7 @@ declare function GetCnConfigResponseData(): GetCnConfigResponseData;
|
|
|
1204
1375
|
type GetCnConfigResponseData = {
|
|
1205
1376
|
is_cn_as_refund_method?: boolean;
|
|
1206
1377
|
affiliate_id?: string;
|
|
1207
|
-
meta?:
|
|
1378
|
+
meta?: any;
|
|
1208
1379
|
seller_id?: number;
|
|
1209
1380
|
notification_events?: CreditNoteConfigNotificationEvents;
|
|
1210
1381
|
validity?: number;
|
|
@@ -1225,14 +1396,15 @@ type CnGenerateReportFilters = {
|
|
|
1225
1396
|
utilisation?: string[];
|
|
1226
1397
|
ordering_channel?: string[];
|
|
1227
1398
|
store_id?: number[];
|
|
1228
|
-
|
|
1399
|
+
type_of_transaction?: string[];
|
|
1400
|
+
issuance_channel?: string[];
|
|
1229
1401
|
};
|
|
1230
1402
|
/** @returns {CnGenerateReport} */
|
|
1231
1403
|
declare function CnGenerateReport(): CnGenerateReport;
|
|
1232
1404
|
type CnGenerateReport = {
|
|
1233
1405
|
page?: number;
|
|
1234
1406
|
end_date?: string;
|
|
1235
|
-
|
|
1407
|
+
page_size?: number;
|
|
1236
1408
|
filters?: CnGenerateReportFilters;
|
|
1237
1409
|
affiliate_id?: string;
|
|
1238
1410
|
meta?: GenerateReportFilters;
|
|
@@ -1241,9 +1413,9 @@ type CnGenerateReport = {
|
|
|
1241
1413
|
search_type?: string;
|
|
1242
1414
|
start_date?: string;
|
|
1243
1415
|
};
|
|
1244
|
-
/** @returns {
|
|
1245
|
-
declare function
|
|
1246
|
-
type
|
|
1416
|
+
/** @returns {GenerateReportCustomerCnReq} */
|
|
1417
|
+
declare function GenerateReportCustomerCnReq(): GenerateReportCustomerCnReq;
|
|
1418
|
+
type GenerateReportCustomerCnReq = {
|
|
1247
1419
|
data?: CnGenerateReport;
|
|
1248
1420
|
};
|
|
1249
1421
|
/** @returns {CnGenerateReportItems} */
|
|
@@ -1261,6 +1433,8 @@ type CnGenerateReportItems = {
|
|
|
1261
1433
|
/** @returns {GenerateReportCustomerCnResponseData} */
|
|
1262
1434
|
declare function GenerateReportCustomerCnResponseData(): GenerateReportCustomerCnResponseData;
|
|
1263
1435
|
type GenerateReportCustomerCnResponseData = {
|
|
1436
|
+
success?: boolean;
|
|
1437
|
+
message?: string;
|
|
1264
1438
|
items?: CnGenerateReportItems[];
|
|
1265
1439
|
row_header_display_order?: any;
|
|
1266
1440
|
end_date?: string;
|
|
@@ -1284,13 +1458,13 @@ type CnDownloadReport = {
|
|
|
1284
1458
|
end_date?: string;
|
|
1285
1459
|
affiliate_id?: string;
|
|
1286
1460
|
search?: string;
|
|
1287
|
-
status?: string
|
|
1461
|
+
status?: string;
|
|
1288
1462
|
search_type?: string;
|
|
1289
|
-
|
|
1463
|
+
page_size?: number;
|
|
1290
1464
|
};
|
|
1291
|
-
/** @returns {
|
|
1292
|
-
declare function
|
|
1293
|
-
type
|
|
1465
|
+
/** @returns {DownloadReportCustomerCnReq} */
|
|
1466
|
+
declare function DownloadReportCustomerCnReq(): DownloadReportCustomerCnReq;
|
|
1467
|
+
type DownloadReportCustomerCnReq = {
|
|
1294
1468
|
data?: CnDownloadReport;
|
|
1295
1469
|
};
|
|
1296
1470
|
/** @returns {DownloadReportResponseData} */
|
|
@@ -1314,7 +1488,10 @@ type DownloadReportResponseData = {
|
|
|
1314
1488
|
/** @returns {DownloadReportCustomerCnResponse} */
|
|
1315
1489
|
declare function DownloadReportCustomerCnResponse(): DownloadReportCustomerCnResponse;
|
|
1316
1490
|
type DownloadReportCustomerCnResponse = {
|
|
1491
|
+
items?: DownloadReportResponseData[];
|
|
1317
1492
|
data?: DownloadReportResponseData[];
|
|
1493
|
+
item_count?: number;
|
|
1494
|
+
page?: Page;
|
|
1318
1495
|
};
|
|
1319
1496
|
/** @returns {GetReportingFilters} */
|
|
1320
1497
|
declare function GetReportingFilters(): GetReportingFilters;
|
|
@@ -1334,13 +1511,75 @@ type GetReportingNestedFilters = {
|
|
|
1334
1511
|
type?: string;
|
|
1335
1512
|
value?: string;
|
|
1336
1513
|
};
|
|
1514
|
+
/** @returns {GetReportingFiltersReasonOptions} */
|
|
1515
|
+
declare function GetReportingFiltersReasonOptions(): GetReportingFiltersReasonOptions;
|
|
1516
|
+
type GetReportingFiltersReasonOptions = {
|
|
1517
|
+
text?: string;
|
|
1518
|
+
value?: string;
|
|
1519
|
+
placeholder_text?: string;
|
|
1520
|
+
};
|
|
1521
|
+
/** @returns {GetReportingFiltersReason} */
|
|
1522
|
+
declare function GetReportingFiltersReason(): GetReportingFiltersReason;
|
|
1523
|
+
type GetReportingFiltersReason = {
|
|
1524
|
+
text?: string;
|
|
1525
|
+
type?: string;
|
|
1526
|
+
value?: string;
|
|
1527
|
+
options?: GetReportingFiltersReasonOptions[];
|
|
1528
|
+
};
|
|
1337
1529
|
/** @returns {GetReportingFiltersResponse} */
|
|
1338
1530
|
declare function GetReportingFiltersResponse(): GetReportingFiltersResponse;
|
|
1339
1531
|
type GetReportingFiltersResponse = {
|
|
1532
|
+
reason?: GetReportingFiltersReason;
|
|
1340
1533
|
search?: GetReportingFilters;
|
|
1341
1534
|
filters?: GetReportingNestedFilters[];
|
|
1342
1535
|
status?: GetReportingFilters;
|
|
1343
1536
|
};
|
|
1537
|
+
/** @returns {InvoicePaymentOptionsPayloadData} */
|
|
1538
|
+
declare function InvoicePaymentOptionsPayloadData(): InvoicePaymentOptionsPayloadData;
|
|
1539
|
+
type InvoicePaymentOptionsPayloadData = {
|
|
1540
|
+
invoice_numbers?: string[];
|
|
1541
|
+
};
|
|
1542
|
+
/** @returns {InvoicePaymentOptionsReq} */
|
|
1543
|
+
declare function InvoicePaymentOptionsReq(): InvoicePaymentOptionsReq;
|
|
1544
|
+
type InvoicePaymentOptionsReq = {
|
|
1545
|
+
data?: InvoicePaymentOptionsPayloadData;
|
|
1546
|
+
};
|
|
1547
|
+
/** @returns {InvoicePaymentOptionsResponsePayableAmounts} */
|
|
1548
|
+
declare function InvoicePaymentOptionsResponsePayableAmounts(): InvoicePaymentOptionsResponsePayableAmounts;
|
|
1549
|
+
type InvoicePaymentOptionsResponsePayableAmounts = {
|
|
1550
|
+
amount?: number;
|
|
1551
|
+
amount_key?: string;
|
|
1552
|
+
header?: string;
|
|
1553
|
+
};
|
|
1554
|
+
/** @returns {InvoicePaymentOptionsResponseDeductedAmounts} */
|
|
1555
|
+
declare function InvoicePaymentOptionsResponseDeductedAmounts(): InvoicePaymentOptionsResponseDeductedAmounts;
|
|
1556
|
+
type InvoicePaymentOptionsResponseDeductedAmounts = {
|
|
1557
|
+
amount?: number;
|
|
1558
|
+
header?: string;
|
|
1559
|
+
amount_key?: string;
|
|
1560
|
+
is_payable?: boolean;
|
|
1561
|
+
symbol?: string;
|
|
1562
|
+
};
|
|
1563
|
+
/** @returns {InvoicePaymentOptionsResponseData} */
|
|
1564
|
+
declare function InvoicePaymentOptionsResponseData(): InvoicePaymentOptionsResponseData;
|
|
1565
|
+
type InvoicePaymentOptionsResponseData = {
|
|
1566
|
+
invoice_number?: string;
|
|
1567
|
+
invoice_type?: string;
|
|
1568
|
+
display_amounts?: InvoicePaymentOptionsResponsePayableAmounts[];
|
|
1569
|
+
total_amount?: any;
|
|
1570
|
+
deducted_amounts?: any;
|
|
1571
|
+
payable_amounts?: InvoicePaymentOptionsResponsePayableAmounts[];
|
|
1572
|
+
currency?: Currency;
|
|
1573
|
+
};
|
|
1574
|
+
/** @returns {InvoicePaymentOptionsResponse} */
|
|
1575
|
+
declare function InvoicePaymentOptionsResponse(): InvoicePaymentOptionsResponse;
|
|
1576
|
+
type InvoicePaymentOptionsResponse = {
|
|
1577
|
+
reason?: string;
|
|
1578
|
+
data?: InvoicePaymentOptionsResponseData[];
|
|
1579
|
+
total_payable_amount?: number;
|
|
1580
|
+
invoice_count?: number;
|
|
1581
|
+
success?: boolean;
|
|
1582
|
+
};
|
|
1344
1583
|
/** @returns {PaymentDetail} */
|
|
1345
1584
|
declare function PaymentDetail(): PaymentDetail;
|
|
1346
1585
|
type PaymentDetail = {
|
|
@@ -1363,6 +1602,7 @@ type InvoicePaymentDetailsResponseData = {
|
|
|
1363
1602
|
/** @returns {InvoicePaymentDetailsResponse} */
|
|
1364
1603
|
declare function InvoicePaymentDetailsResponse(): InvoicePaymentDetailsResponse;
|
|
1365
1604
|
type InvoicePaymentDetailsResponse = {
|
|
1605
|
+
reason?: string;
|
|
1366
1606
|
data?: InvoicePaymentDetailsResponseData;
|
|
1367
1607
|
success?: boolean;
|
|
1368
1608
|
payment_details_visible?: boolean;
|
|
@@ -1395,9 +1635,9 @@ type UnlockCreditNoteRequestData = {
|
|
|
1395
1635
|
unlock_reason?: string;
|
|
1396
1636
|
description?: string;
|
|
1397
1637
|
};
|
|
1398
|
-
/** @returns {
|
|
1399
|
-
declare function
|
|
1400
|
-
type
|
|
1638
|
+
/** @returns {UnlockCreditNoteReq} */
|
|
1639
|
+
declare function UnlockCreditNoteReq(): UnlockCreditNoteReq;
|
|
1640
|
+
type UnlockCreditNoteReq = {
|
|
1401
1641
|
data?: UnlockCreditNoteRequestData;
|
|
1402
1642
|
};
|
|
1403
1643
|
/** @returns {UnlockCreditNoteResponseData} */
|