@gofynd/fdk-client-javascript 1.3.4-beta.1 → 1.3.4
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/Catalog/CatalogApplicationModel.d.ts +18 -1
- package/sdk/application/Catalog/CatalogApplicationModel.js +20 -0
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +23 -9
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +21 -7
- package/sdk/application/User/UserApplicationClient.d.ts +56 -0
- package/sdk/application/User/UserApplicationClient.js +385 -0
- package/sdk/application/User/UserApplicationModel.d.ts +93 -1
- package/sdk/application/User/UserApplicationModel.js +110 -0
- package/sdk/application/User/UserApplicationValidator.d.ts +66 -1
- package/sdk/application/User/UserApplicationValidator.js +68 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +96 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +177 -0
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +139 -0
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -0
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +6 -0
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +33 -0
- package/sdk/partner/PartnerClient.d.ts +2 -0
- package/sdk/partner/PartnerClient.js +3 -0
- package/sdk/partner/index.d.ts +1 -0
- package/sdk/partner/index.js +2 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +4 -16
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +11 -79
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +12 -8
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +7 -9
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +37 -27
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +145 -56
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +22 -11
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +24 -10
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +4 -8
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +832 -150
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +940 -138
- package/sdk/platform/Order/OrderPlatformClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformClient.js +1 -1
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -2
- package/sdk/platform/Order/OrderPlatformModel.js +10 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +4 -4
- package/sdk/platform/Order/OrderPlatformValidator.js +4 -4
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +42 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +241 -0
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +41 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +40 -0
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +72 -1
- package/sdk/platform/Payment/PaymentPlatformModel.js +54 -0
|
@@ -1,17 +1,13 @@
|
|
|
1
1
|
export = FileStoragePlatformModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
4
|
-
* @property {
|
|
5
|
-
* @property {
|
|
6
|
-
*/
|
|
7
|
-
/**
|
|
8
|
-
* @typedef BulkUploadFailResponse
|
|
9
|
-
* @property {Status} status
|
|
3
|
+
* @typedef AwbNumberLabelBarcodeGenerator
|
|
4
|
+
* @property {KwargsAwbNumber} [kwargs]
|
|
5
|
+
* @property {string} [method]
|
|
10
6
|
*/
|
|
11
7
|
/**
|
|
12
|
-
* @typedef
|
|
13
|
-
* @property {
|
|
14
|
-
* @property {
|
|
8
|
+
* @typedef Brand
|
|
9
|
+
* @property {string} [logo]
|
|
10
|
+
* @property {string} [name]
|
|
15
11
|
*/
|
|
16
12
|
/**
|
|
17
13
|
* @typedef CDN
|
|
@@ -19,11 +15,35 @@ export = FileStoragePlatformModel;
|
|
|
19
15
|
* @property {string} relative_url
|
|
20
16
|
* @property {string} url
|
|
21
17
|
*/
|
|
18
|
+
/**
|
|
19
|
+
* @typedef Cgst
|
|
20
|
+
* @property {number} [percent]
|
|
21
|
+
* @property {number} [value]
|
|
22
|
+
*/
|
|
23
|
+
/**
|
|
24
|
+
* @typedef CompanyDetail
|
|
25
|
+
* @property {string} [address]
|
|
26
|
+
* @property {string} [cin]
|
|
27
|
+
* @property {string} [city]
|
|
28
|
+
* @property {string} [country]
|
|
29
|
+
* @property {string} [country_code]
|
|
30
|
+
* @property {string} [email]
|
|
31
|
+
* @property {string} [gstin]
|
|
32
|
+
* @property {string} [name]
|
|
33
|
+
* @property {string} [pan]
|
|
34
|
+
* @property {string} [phone_no]
|
|
35
|
+
* @property {string} [state]
|
|
36
|
+
* @property {string} [state_code]
|
|
37
|
+
* @property {string} [website_url]
|
|
38
|
+
* @property {number} [zip_code]
|
|
39
|
+
*/
|
|
22
40
|
/**
|
|
23
41
|
* @typedef CompleteResponse
|
|
24
42
|
* @property {string} _id
|
|
25
43
|
* @property {CDN} cdn
|
|
44
|
+
* @property {number} company_id
|
|
26
45
|
* @property {string} content_type
|
|
46
|
+
* @property {CreatedBy} [created_by]
|
|
27
47
|
* @property {string} created_on
|
|
28
48
|
* @property {string} file_name
|
|
29
49
|
* @property {string} file_path
|
|
@@ -35,84 +55,298 @@ export = FileStoragePlatformModel;
|
|
|
35
55
|
* @property {string[]} [tags]
|
|
36
56
|
* @property {Upload} upload
|
|
37
57
|
*/
|
|
58
|
+
/**
|
|
59
|
+
* @typedef ConversionRate
|
|
60
|
+
* @property {string} [base]
|
|
61
|
+
* @property {Rates} [rates]
|
|
62
|
+
* @property {number} [timestamp]
|
|
63
|
+
*/
|
|
38
64
|
/**
|
|
39
65
|
* @typedef CopyFiles
|
|
40
66
|
* @property {DestinationNamespace} destination
|
|
41
|
-
* @property {string[]} urls
|
|
67
|
+
* @property {string[]} [urls]
|
|
42
68
|
*/
|
|
43
69
|
/**
|
|
44
|
-
* @typedef
|
|
45
|
-
* @property {string}
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
* @
|
|
49
|
-
* @property {string}
|
|
50
|
-
* @property {string}
|
|
51
|
-
* @property {string}
|
|
52
|
-
* @property {string}
|
|
53
|
-
* @property {string} [
|
|
54
|
-
* @property {
|
|
55
|
-
* @property {string[]
|
|
56
|
-
* @property {
|
|
70
|
+
* @typedef CreatedBy
|
|
71
|
+
* @property {string} [username]
|
|
72
|
+
*/
|
|
73
|
+
/**
|
|
74
|
+
* @typedef CustomerBillingDetail
|
|
75
|
+
* @property {string} [address]
|
|
76
|
+
* @property {string} [city]
|
|
77
|
+
* @property {string} [country]
|
|
78
|
+
* @property {string} [country_code]
|
|
79
|
+
* @property {string} [gstin]
|
|
80
|
+
* @property {string} [name]
|
|
81
|
+
* @property {string} [phone_no]
|
|
82
|
+
* @property {string} [state]
|
|
83
|
+
* @property {string} [state_code]
|
|
84
|
+
* @property {string} [zip_code]
|
|
85
|
+
*/
|
|
86
|
+
/**
|
|
87
|
+
* @typedef CustomerShippingDetail
|
|
88
|
+
* @property {string} [address]
|
|
89
|
+
* @property {string} [city]
|
|
90
|
+
* @property {string} [country]
|
|
91
|
+
* @property {string} [country_code]
|
|
92
|
+
* @property {string} [gstin]
|
|
93
|
+
* @property {string} [name]
|
|
94
|
+
* @property {string} [phone_no]
|
|
95
|
+
* @property {string} [state]
|
|
96
|
+
* @property {string} [state_code]
|
|
97
|
+
* @property {string} [zip_code]
|
|
98
|
+
*/
|
|
99
|
+
/**
|
|
100
|
+
* @typedef DeliveryPartnerDetail
|
|
101
|
+
* @property {string} [awb_number]
|
|
102
|
+
* @property {string} [awb_number_barcode]
|
|
103
|
+
* @property {string} [eway_bill_number]
|
|
104
|
+
* @property {string} [name]
|
|
57
105
|
*/
|
|
58
106
|
/**
|
|
59
107
|
* @typedef DestinationNamespace
|
|
60
108
|
* @property {string} [namespace]
|
|
61
109
|
*/
|
|
62
110
|
/**
|
|
63
|
-
* @typedef
|
|
111
|
+
* @typedef DigitalsignatureGenerator
|
|
112
|
+
* @property {Kwargs} [kwargs]
|
|
113
|
+
* @property {string} [method]
|
|
114
|
+
*/
|
|
115
|
+
/**
|
|
116
|
+
* @typedef Document
|
|
117
|
+
* @property {number} [__v]
|
|
118
|
+
* @property {string} [_id]
|
|
119
|
+
* @property {string} [country_code]
|
|
120
|
+
* @property {string} [format]
|
|
121
|
+
* @property {number} [pdf_type_id]
|
|
122
|
+
* @property {string} [template]
|
|
123
|
+
*/
|
|
124
|
+
/**
|
|
125
|
+
* @typedef DummyTemplateData
|
|
64
126
|
* @property {number} [__v]
|
|
65
127
|
* @property {string} [_id]
|
|
66
|
-
* @property {
|
|
128
|
+
* @property {DummyTemplateDataPayload} payload
|
|
67
129
|
* @property {number} [pdf_type_id]
|
|
68
130
|
*/
|
|
131
|
+
/**
|
|
132
|
+
* @typedef DummyTemplateDataItems
|
|
133
|
+
* @property {DummyTemplateData[]} data
|
|
134
|
+
* @property {boolean} success
|
|
135
|
+
*/
|
|
136
|
+
/**
|
|
137
|
+
* @typedef DummyTemplateDataPayload
|
|
138
|
+
* @property {number} [amount_paid]
|
|
139
|
+
* @property {number} [amount_to_be_collected]
|
|
140
|
+
* @property {string} [app_domain_name]
|
|
141
|
+
* @property {string} [awb_number_barcode]
|
|
142
|
+
* @property {string} [brand_logo]
|
|
143
|
+
* @property {CompanyDetail} [company_detail]
|
|
144
|
+
* @property {ConversionRate} [conversion_rate]
|
|
145
|
+
* @property {string} [currency_code]
|
|
146
|
+
* @property {CustomerBillingDetail} [customer_billing_detail]
|
|
147
|
+
* @property {CustomerShippingDetail} [customer_shipping_detail]
|
|
148
|
+
* @property {string[]} [declaration_texts]
|
|
149
|
+
* @property {DeliveryPartnerDetail} [delivery_partner_detail]
|
|
150
|
+
* @property {string} [digitalsignature]
|
|
151
|
+
* @property {string} [disclaimer]
|
|
152
|
+
* @property {Image} [image]
|
|
153
|
+
* @property {InvoiceDetail} [invoice_detail]
|
|
154
|
+
* @property {boolean} [is_international]
|
|
155
|
+
* @property {boolean} [is_self_pickup]
|
|
156
|
+
* @property {boolean} [is_self_ship]
|
|
157
|
+
* @property {Meta} [meta]
|
|
158
|
+
* @property {string} [mode]
|
|
159
|
+
* @property {PaymentData[]} [payments]
|
|
160
|
+
* @property {string} [platform_name]
|
|
161
|
+
* @property {ProductTable} [product_table]
|
|
162
|
+
* @property {RegisteredCompanyDetail} [registered_company_detail]
|
|
163
|
+
* @property {ReturnDetail} [return_detail]
|
|
164
|
+
* @property {string} [shipment_id]
|
|
165
|
+
* @property {string} [shipment_id_barcode]
|
|
166
|
+
* @property {string} [signed_qrcode]
|
|
167
|
+
* @property {StoreDetail} [store_detail]
|
|
168
|
+
* @property {TaxTable} [tax_table]
|
|
169
|
+
* @property {number} [total_items]
|
|
170
|
+
* @property {string} [uid]
|
|
171
|
+
* @property {string} [upi_qrcode]
|
|
172
|
+
* @property {Object[]} [waybills]
|
|
173
|
+
*/
|
|
69
174
|
/**
|
|
70
175
|
* @typedef FailedResponse
|
|
71
176
|
* @property {string} message
|
|
72
177
|
*/
|
|
73
178
|
/**
|
|
74
|
-
* @typedef
|
|
75
|
-
* @property {
|
|
179
|
+
* @typedef Igst
|
|
180
|
+
* @property {number} [percent]
|
|
181
|
+
* @property {number} [value]
|
|
76
182
|
*/
|
|
77
183
|
/**
|
|
78
|
-
* @typedef
|
|
79
|
-
* @property {string} [
|
|
80
|
-
* @property {string} [namespace]
|
|
81
|
-
* @property {string} url
|
|
184
|
+
* @typedef Image
|
|
185
|
+
* @property {string} [sales_channel_logo]
|
|
82
186
|
*/
|
|
83
187
|
/**
|
|
84
|
-
* @typedef
|
|
85
|
-
* @property {
|
|
86
|
-
* @property {
|
|
188
|
+
* @typedef Inr
|
|
189
|
+
* @property {string} [name]
|
|
190
|
+
* @property {string} [sub_unit]
|
|
191
|
+
* @property {string} [symbol]
|
|
192
|
+
* @property {number} [value]
|
|
87
193
|
*/
|
|
88
194
|
/**
|
|
89
|
-
* @typedef
|
|
195
|
+
* @typedef InvoiceDetail
|
|
196
|
+
* @property {string} [external_order_id]
|
|
197
|
+
* @property {string} [invoice_date]
|
|
198
|
+
* @property {string} [invoice_id]
|
|
199
|
+
* @property {string} [irn]
|
|
200
|
+
* @property {string} [shipment_id]
|
|
201
|
+
* @property {string} [signed_qrcode]
|
|
202
|
+
* @property {string} [upi_qrcode]
|
|
203
|
+
*/
|
|
204
|
+
/**
|
|
205
|
+
* @typedef InvoiceTypesDataResponse
|
|
90
206
|
* @property {number} __v
|
|
91
207
|
* @property {string} _id
|
|
208
|
+
* @property {string} [country_code]
|
|
92
209
|
* @property {string[]} format
|
|
93
210
|
* @property {string} name
|
|
94
211
|
* @property {number} pdf_type_id
|
|
95
|
-
* @property {
|
|
212
|
+
* @property {boolean} [status]
|
|
96
213
|
* @property {boolean} visibility
|
|
97
214
|
*/
|
|
98
215
|
/**
|
|
99
|
-
* @typedef
|
|
100
|
-
* @property {
|
|
101
|
-
* @property {boolean}
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
* @
|
|
105
|
-
* @property {
|
|
106
|
-
* @property {
|
|
216
|
+
* @typedef InvoiceTypesResponse
|
|
217
|
+
* @property {InvoiceTypesDataResponse[]} data
|
|
218
|
+
* @property {boolean} success
|
|
219
|
+
*/
|
|
220
|
+
/**
|
|
221
|
+
* @typedef ItemsProductTable
|
|
222
|
+
* @property {Brand} [brand]
|
|
223
|
+
* @property {number} [discount]
|
|
224
|
+
* @property {string} [hsn_code]
|
|
225
|
+
* @property {string} [item_code]
|
|
226
|
+
* @property {number} [mrp]
|
|
227
|
+
* @property {string} [name]
|
|
228
|
+
* @property {string} [seller_identifier]
|
|
229
|
+
* @property {string} [size]
|
|
230
|
+
* @property {Tax} [tax]
|
|
231
|
+
* @property {number} [taxable_amount]
|
|
232
|
+
* @property {number} [total]
|
|
233
|
+
* @property {number} [total_taxable_amount]
|
|
234
|
+
* @property {number} [total_units]
|
|
107
235
|
*/
|
|
108
236
|
/**
|
|
109
|
-
* @typedef
|
|
237
|
+
* @typedef Kwargs
|
|
238
|
+
* @property {string} [value]
|
|
239
|
+
*/
|
|
240
|
+
/**
|
|
241
|
+
* @typedef KwargsAwbNumber
|
|
242
|
+
* @property {Object[]} [value]
|
|
243
|
+
*/
|
|
244
|
+
/**
|
|
245
|
+
* @typedef KwargsUpiQrcode
|
|
246
|
+
* @property {string} [qr_data]
|
|
247
|
+
* @property {string} [qr_url]
|
|
248
|
+
*/
|
|
249
|
+
/**
|
|
250
|
+
* @typedef Meta
|
|
251
|
+
* @property {MetaProperty} [generator]
|
|
252
|
+
*/
|
|
253
|
+
/**
|
|
254
|
+
* @typedef MetaProperty
|
|
255
|
+
* @property {AwbNumberLabelBarcodeGenerator} [awb_number_label_barcode_generator]
|
|
256
|
+
* @property {DigitalsignatureGenerator} [digitalsignature_generator]
|
|
257
|
+
* @property {ShipmentIdBarcodeGenerator} [shipment_id_barcode_generator]
|
|
258
|
+
* @property {SignedQrcodeGenerator} [signed_qrcode_generator]
|
|
259
|
+
* @property {UpiQrcodeGenerator} [upi_qrcode_generator]
|
|
260
|
+
*/
|
|
261
|
+
/**
|
|
262
|
+
* @typedef Params
|
|
263
|
+
* @property {string} [subpath] - The subpath for the file.
|
|
264
|
+
*/
|
|
265
|
+
/**
|
|
266
|
+
* @typedef PaymentData
|
|
267
|
+
* @property {number} [amount]
|
|
268
|
+
* @property {string} [date]
|
|
269
|
+
* @property {string} [payment_type]
|
|
270
|
+
* @property {string} [transaction_id]
|
|
271
|
+
*/
|
|
272
|
+
/**
|
|
273
|
+
* @typedef PaymentReceiptCustomerDetails
|
|
274
|
+
* @property {string} [email_id]
|
|
275
|
+
* @property {string} [first_name]
|
|
276
|
+
* @property {string} [id]
|
|
277
|
+
* @property {string} [last_name]
|
|
278
|
+
* @property {string} [mobile_number]
|
|
279
|
+
*/
|
|
280
|
+
/**
|
|
281
|
+
* @typedef PaymentReceiptFormat
|
|
282
|
+
* @property {string[]} [payment_receipt]
|
|
283
|
+
*/
|
|
284
|
+
/**
|
|
285
|
+
* @typedef PaymentReceiptMeta
|
|
286
|
+
* @property {string} [action]
|
|
287
|
+
* @property {string[]} [application_id]
|
|
288
|
+
* @property {number} [company_id]
|
|
289
|
+
* @property {number} [created_timestamp]
|
|
290
|
+
* @property {Object} [event]
|
|
291
|
+
* @property {Object} [event_trace_info]
|
|
292
|
+
* @property {PaymentReceiptFormat} [format]
|
|
293
|
+
* @property {string} [job_type]
|
|
294
|
+
* @property {string} [organizaton_id]
|
|
295
|
+
* @property {PaymentReceiptService} [service]
|
|
296
|
+
* @property {string} [trace]
|
|
297
|
+
* @property {string[]} [trace_id]
|
|
298
|
+
*/
|
|
299
|
+
/**
|
|
300
|
+
* @typedef PaymentReceiptOrderDetails
|
|
301
|
+
* @property {number} [final_amount]
|
|
302
|
+
* @property {string} [final_amount_in_words]
|
|
303
|
+
* @property {string} [jiomart_order_id]
|
|
304
|
+
* @property {string} [order_created_date]
|
|
305
|
+
* @property {string} [order_created_time]
|
|
306
|
+
* @property {string} [prm_id]
|
|
307
|
+
* @property {string} [receipt_no]
|
|
308
|
+
* @property {PaymentReceiptTaxes} [taxes]
|
|
309
|
+
* @property {number} [total_items]
|
|
310
|
+
*/
|
|
311
|
+
/**
|
|
312
|
+
* @typedef PaymentReceiptPayload
|
|
313
|
+
* @property {PaymentReceiptCustomerDetails} [customer_detail]
|
|
314
|
+
* @property {PaymentReceiptOrderDetails} [order_detail]
|
|
315
|
+
* @property {PaymentReceiptPayments[]} [payments]
|
|
316
|
+
* @property {string} [uid]
|
|
317
|
+
*/
|
|
318
|
+
/**
|
|
319
|
+
* @typedef PaymentReceiptPayments
|
|
320
|
+
* @property {string} [payment_desc]
|
|
321
|
+
* @property {string} [txn_date]
|
|
322
|
+
*/
|
|
323
|
+
/**
|
|
324
|
+
* @typedef PaymentReceiptRequestBody
|
|
325
|
+
* @property {PaymentReceiptMeta} [meta]
|
|
326
|
+
* @property {PaymentReceiptPayload} [payload]
|
|
327
|
+
*/
|
|
328
|
+
/**
|
|
329
|
+
* @typedef PaymentReceiptService
|
|
330
|
+
* @property {string} [name]
|
|
331
|
+
*/
|
|
332
|
+
/**
|
|
333
|
+
* @typedef PaymentReceiptTaxes
|
|
334
|
+
* @property {string} [gstin]
|
|
335
|
+
* @property {string} [pancard]
|
|
336
|
+
*/
|
|
337
|
+
/**
|
|
338
|
+
* @typedef PdfConfig
|
|
110
339
|
* @property {string} [format] - This is invoice document format such as A4, A6, POS
|
|
111
340
|
* @property {number} [pdf_type_id]
|
|
112
341
|
* @property {string} [template] - This is html template string
|
|
113
342
|
*/
|
|
114
343
|
/**
|
|
115
344
|
* @typedef PdfConfigSaveSuccess
|
|
345
|
+
* @property {PdfConfigSaveSuccessData} [data]
|
|
346
|
+
* @property {boolean} [success]
|
|
347
|
+
*/
|
|
348
|
+
/**
|
|
349
|
+
* @typedef PdfConfigSaveSuccessData
|
|
116
350
|
* @property {number} [__v]
|
|
117
351
|
* @property {string} [_id]
|
|
118
352
|
* @property {string} [application_id]
|
|
@@ -123,27 +357,76 @@ export = FileStoragePlatformModel;
|
|
|
123
357
|
*/
|
|
124
358
|
/**
|
|
125
359
|
* @typedef PdfConfigSuccess
|
|
360
|
+
* @property {PdfConfigSuccessData[]} [data]
|
|
361
|
+
* @property {boolean} [success]
|
|
362
|
+
*/
|
|
363
|
+
/**
|
|
364
|
+
* @typedef PdfConfigSuccessData
|
|
126
365
|
* @property {number} [__v]
|
|
127
366
|
* @property {string} [_id]
|
|
128
367
|
* @property {string} [application_id]
|
|
129
368
|
* @property {number} [company_id]
|
|
369
|
+
* @property {string} [country_code]
|
|
130
370
|
* @property {string} [format]
|
|
131
371
|
* @property {number} [pdf_type_id]
|
|
132
372
|
* @property {string} [template]
|
|
133
373
|
*/
|
|
134
374
|
/**
|
|
135
375
|
* @typedef PdfDefaultTemplateSuccess
|
|
136
|
-
* @property {
|
|
137
|
-
* @property {
|
|
138
|
-
* @property {string} [format]
|
|
139
|
-
* @property {number} [pdf_type_id]
|
|
140
|
-
* @property {string} [template]
|
|
376
|
+
* @property {Document[]} [data]
|
|
377
|
+
* @property {boolean} [success] - Indicates if the request was successful.
|
|
141
378
|
*/
|
|
142
379
|
/**
|
|
143
|
-
* @typedef
|
|
144
|
-
* @property {
|
|
145
|
-
* @property {
|
|
146
|
-
* @property {
|
|
380
|
+
* @typedef ProductTable
|
|
381
|
+
* @property {number} [cod_charges]
|
|
382
|
+
* @property {string} [delivery_charge_text]
|
|
383
|
+
* @property {number} [delivery_charges]
|
|
384
|
+
* @property {number} [fynd_discounts]
|
|
385
|
+
* @property {number} [grand_total]
|
|
386
|
+
* @property {ItemsProductTable[]} [products]
|
|
387
|
+
* @property {string} [total_in_words]
|
|
388
|
+
* @property {number} [total_items]
|
|
389
|
+
*/
|
|
390
|
+
/**
|
|
391
|
+
* @typedef Rates
|
|
392
|
+
* @property {Inr} [inr]
|
|
393
|
+
* @property {Usd} [usd]
|
|
394
|
+
*/
|
|
395
|
+
/**
|
|
396
|
+
* @typedef RegisteredCompanyDetail
|
|
397
|
+
* @property {string} [address]
|
|
398
|
+
* @property {string} [city]
|
|
399
|
+
* @property {string} [country]
|
|
400
|
+
* @property {string} [country_code]
|
|
401
|
+
* @property {string} [state]
|
|
402
|
+
* @property {string} [state_code]
|
|
403
|
+
* @property {number} [zip_code]
|
|
404
|
+
*/
|
|
405
|
+
/**
|
|
406
|
+
* @typedef ReturnDetail
|
|
407
|
+
* @property {string} [address]
|
|
408
|
+
* @property {string} [city]
|
|
409
|
+
* @property {string} [country]
|
|
410
|
+
* @property {string} [country_code]
|
|
411
|
+
* @property {string} [gstin]
|
|
412
|
+
* @property {string} [state]
|
|
413
|
+
* @property {string} [state_code]
|
|
414
|
+
* @property {string} [zip_code]
|
|
415
|
+
*/
|
|
416
|
+
/**
|
|
417
|
+
* @typedef Sgst
|
|
418
|
+
* @property {number} [percent]
|
|
419
|
+
* @property {number} [value]
|
|
420
|
+
*/
|
|
421
|
+
/**
|
|
422
|
+
* @typedef ShipmentIdBarcodeGenerator
|
|
423
|
+
* @property {Kwargs} [kwargs]
|
|
424
|
+
* @property {string} [method]
|
|
425
|
+
*/
|
|
426
|
+
/**
|
|
427
|
+
* @typedef SignedQrcodeGenerator
|
|
428
|
+
* @property {Kwargs} [kwargs]
|
|
429
|
+
* @property {string} [method]
|
|
147
430
|
*/
|
|
148
431
|
/**
|
|
149
432
|
* @typedef SignUrlRequest
|
|
@@ -158,7 +441,7 @@ export = FileStoragePlatformModel;
|
|
|
158
441
|
* @typedef StartRequest
|
|
159
442
|
* @property {string} content_type
|
|
160
443
|
* @property {string} file_name
|
|
161
|
-
* @property {
|
|
444
|
+
* @property {Params} [params]
|
|
162
445
|
* @property {number} size
|
|
163
446
|
* @property {string[]} [tags]
|
|
164
447
|
*/
|
|
@@ -176,11 +459,39 @@ export = FileStoragePlatformModel;
|
|
|
176
459
|
* @property {Upload} upload
|
|
177
460
|
*/
|
|
178
461
|
/**
|
|
179
|
-
* @typedef
|
|
180
|
-
* @property {
|
|
181
|
-
* @property {string} [
|
|
182
|
-
* @property {
|
|
183
|
-
* @property {
|
|
462
|
+
* @typedef StoreDetail
|
|
463
|
+
* @property {string} [address]
|
|
464
|
+
* @property {string} [city]
|
|
465
|
+
* @property {string} [country]
|
|
466
|
+
* @property {string} [country_code]
|
|
467
|
+
* @property {string} [gstin]
|
|
468
|
+
* @property {string} [state]
|
|
469
|
+
* @property {string} [state_code]
|
|
470
|
+
* @property {string} [store_name]
|
|
471
|
+
* @property {string} [zip_code]
|
|
472
|
+
*/
|
|
473
|
+
/**
|
|
474
|
+
* @typedef Tax
|
|
475
|
+
* @property {Cgst} [cgst]
|
|
476
|
+
* @property {Igst} [igst]
|
|
477
|
+
* @property {Sgst} [sgst]
|
|
478
|
+
*/
|
|
479
|
+
/**
|
|
480
|
+
* @typedef Taxes
|
|
481
|
+
* @property {string} [hsn_code]
|
|
482
|
+
* @property {Tax} [tax]
|
|
483
|
+
* @property {number} [total_tax_value]
|
|
484
|
+
*/
|
|
485
|
+
/**
|
|
486
|
+
* @typedef TaxTable
|
|
487
|
+
* @property {string} [tax_in_words]
|
|
488
|
+
* @property {Taxes[]} [taxes]
|
|
489
|
+
* @property {number} [total_tax]
|
|
490
|
+
*/
|
|
491
|
+
/**
|
|
492
|
+
* @typedef UpiQrcodeGenerator
|
|
493
|
+
* @property {KwargsUpiQrcode} [kwargs]
|
|
494
|
+
* @property {string} [method]
|
|
184
495
|
*/
|
|
185
496
|
/**
|
|
186
497
|
* @typedef Upload
|
|
@@ -193,27 +504,29 @@ export = FileStoragePlatformModel;
|
|
|
193
504
|
* @property {string} signed_url
|
|
194
505
|
* @property {string} url
|
|
195
506
|
*/
|
|
507
|
+
/**
|
|
508
|
+
* @typedef Usd
|
|
509
|
+
* @property {string} [name]
|
|
510
|
+
* @property {string} [sub_unit]
|
|
511
|
+
* @property {string} [symbol]
|
|
512
|
+
* @property {number} [value]
|
|
513
|
+
*/
|
|
196
514
|
declare class FileStoragePlatformModel {
|
|
197
515
|
}
|
|
198
516
|
declare namespace FileStoragePlatformModel {
|
|
199
|
-
export {
|
|
517
|
+
export { AwbNumberLabelBarcodeGenerator, Brand, CDN, Cgst, CompanyDetail, CompleteResponse, ConversionRate, CopyFiles, CreatedBy, CustomerBillingDetail, CustomerShippingDetail, DeliveryPartnerDetail, DestinationNamespace, DigitalsignatureGenerator, Document, DummyTemplateData, DummyTemplateDataItems, DummyTemplateDataPayload, FailedResponse, Igst, Image, Inr, InvoiceDetail, InvoiceTypesDataResponse, InvoiceTypesResponse, ItemsProductTable, Kwargs, KwargsAwbNumber, KwargsUpiQrcode, Meta, MetaProperty, Params, PaymentData, PaymentReceiptCustomerDetails, PaymentReceiptFormat, PaymentReceiptMeta, PaymentReceiptOrderDetails, PaymentReceiptPayload, PaymentReceiptPayments, PaymentReceiptRequestBody, PaymentReceiptService, PaymentReceiptTaxes, PdfConfig, PdfConfigSaveSuccess, PdfConfigSaveSuccessData, PdfConfigSuccess, PdfConfigSuccessData, PdfDefaultTemplateSuccess, ProductTable, Rates, RegisteredCompanyDetail, ReturnDetail, Sgst, ShipmentIdBarcodeGenerator, SignedQrcodeGenerator, SignUrlRequest, SignUrlResponse, StartRequest, StartResponse, StoreDetail, Tax, Taxes, TaxTable, UpiQrcodeGenerator, Upload, Urls, Usd };
|
|
200
518
|
}
|
|
201
|
-
/** @returns {
|
|
202
|
-
declare function
|
|
203
|
-
type
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
};
|
|
207
|
-
/** @returns {
|
|
208
|
-
declare function
|
|
209
|
-
type
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
/** @returns {BulkUploadSyncMode} */
|
|
213
|
-
declare function BulkUploadSyncMode(): BulkUploadSyncMode;
|
|
214
|
-
type BulkUploadSyncMode = {
|
|
215
|
-
files?: FilesSuccess[];
|
|
216
|
-
status: Status;
|
|
519
|
+
/** @returns {AwbNumberLabelBarcodeGenerator} */
|
|
520
|
+
declare function AwbNumberLabelBarcodeGenerator(): AwbNumberLabelBarcodeGenerator;
|
|
521
|
+
type AwbNumberLabelBarcodeGenerator = {
|
|
522
|
+
kwargs?: KwargsAwbNumber;
|
|
523
|
+
method?: string;
|
|
524
|
+
};
|
|
525
|
+
/** @returns {Brand} */
|
|
526
|
+
declare function Brand(): Brand;
|
|
527
|
+
type Brand = {
|
|
528
|
+
logo?: string;
|
|
529
|
+
name?: string;
|
|
217
530
|
};
|
|
218
531
|
/** @returns {CDN} */
|
|
219
532
|
declare function CDN(): CDN;
|
|
@@ -222,12 +535,38 @@ type CDN = {
|
|
|
222
535
|
relative_url: string;
|
|
223
536
|
url: string;
|
|
224
537
|
};
|
|
538
|
+
/** @returns {Cgst} */
|
|
539
|
+
declare function Cgst(): Cgst;
|
|
540
|
+
type Cgst = {
|
|
541
|
+
percent?: number;
|
|
542
|
+
value?: number;
|
|
543
|
+
};
|
|
544
|
+
/** @returns {CompanyDetail} */
|
|
545
|
+
declare function CompanyDetail(): CompanyDetail;
|
|
546
|
+
type CompanyDetail = {
|
|
547
|
+
address?: string;
|
|
548
|
+
cin?: string;
|
|
549
|
+
city?: string;
|
|
550
|
+
country?: string;
|
|
551
|
+
country_code?: string;
|
|
552
|
+
email?: string;
|
|
553
|
+
gstin?: string;
|
|
554
|
+
name?: string;
|
|
555
|
+
pan?: string;
|
|
556
|
+
phone_no?: string;
|
|
557
|
+
state?: string;
|
|
558
|
+
state_code?: string;
|
|
559
|
+
website_url?: string;
|
|
560
|
+
zip_code?: number;
|
|
561
|
+
};
|
|
225
562
|
/** @returns {CompleteResponse} */
|
|
226
563
|
declare function CompleteResponse(): CompleteResponse;
|
|
227
564
|
type CompleteResponse = {
|
|
228
565
|
_id: string;
|
|
229
566
|
cdn: CDN;
|
|
567
|
+
company_id: number;
|
|
230
568
|
content_type: string;
|
|
569
|
+
created_by?: CreatedBy;
|
|
231
570
|
created_on: string;
|
|
232
571
|
file_name: string;
|
|
233
572
|
file_path: string;
|
|
@@ -239,89 +578,327 @@ type CompleteResponse = {
|
|
|
239
578
|
tags?: string[];
|
|
240
579
|
upload: Upload;
|
|
241
580
|
};
|
|
581
|
+
/** @returns {ConversionRate} */
|
|
582
|
+
declare function ConversionRate(): ConversionRate;
|
|
583
|
+
type ConversionRate = {
|
|
584
|
+
base?: string;
|
|
585
|
+
rates?: Rates;
|
|
586
|
+
timestamp?: number;
|
|
587
|
+
};
|
|
242
588
|
/** @returns {CopyFiles} */
|
|
243
589
|
declare function CopyFiles(): CopyFiles;
|
|
244
590
|
type CopyFiles = {
|
|
245
591
|
destination: DestinationNamespace;
|
|
246
|
-
urls
|
|
592
|
+
urls?: string[];
|
|
247
593
|
};
|
|
248
|
-
/** @returns {
|
|
249
|
-
declare function
|
|
250
|
-
type
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
594
|
+
/** @returns {CreatedBy} */
|
|
595
|
+
declare function CreatedBy(): CreatedBy;
|
|
596
|
+
type CreatedBy = {
|
|
597
|
+
username?: string;
|
|
598
|
+
};
|
|
599
|
+
/** @returns {CustomerBillingDetail} */
|
|
600
|
+
declare function CustomerBillingDetail(): CustomerBillingDetail;
|
|
601
|
+
type CustomerBillingDetail = {
|
|
602
|
+
address?: string;
|
|
603
|
+
city?: string;
|
|
604
|
+
country?: string;
|
|
605
|
+
country_code?: string;
|
|
606
|
+
gstin?: string;
|
|
607
|
+
name?: string;
|
|
608
|
+
phone_no?: string;
|
|
609
|
+
state?: string;
|
|
610
|
+
state_code?: string;
|
|
611
|
+
zip_code?: string;
|
|
612
|
+
};
|
|
613
|
+
/** @returns {CustomerShippingDetail} */
|
|
614
|
+
declare function CustomerShippingDetail(): CustomerShippingDetail;
|
|
615
|
+
type CustomerShippingDetail = {
|
|
616
|
+
address?: string;
|
|
617
|
+
city?: string;
|
|
618
|
+
country?: string;
|
|
619
|
+
country_code?: string;
|
|
620
|
+
gstin?: string;
|
|
621
|
+
name?: string;
|
|
622
|
+
phone_no?: string;
|
|
623
|
+
state?: string;
|
|
624
|
+
state_code?: string;
|
|
625
|
+
zip_code?: string;
|
|
626
|
+
};
|
|
627
|
+
/** @returns {DeliveryPartnerDetail} */
|
|
628
|
+
declare function DeliveryPartnerDetail(): DeliveryPartnerDetail;
|
|
629
|
+
type DeliveryPartnerDetail = {
|
|
630
|
+
awb_number?: string;
|
|
631
|
+
awb_number_barcode?: string;
|
|
632
|
+
eway_bill_number?: string;
|
|
633
|
+
name?: string;
|
|
263
634
|
};
|
|
264
635
|
/** @returns {DestinationNamespace} */
|
|
265
636
|
declare function DestinationNamespace(): DestinationNamespace;
|
|
266
637
|
type DestinationNamespace = {
|
|
267
638
|
namespace?: string;
|
|
268
639
|
};
|
|
269
|
-
/** @returns {
|
|
270
|
-
declare function
|
|
271
|
-
type
|
|
640
|
+
/** @returns {DigitalsignatureGenerator} */
|
|
641
|
+
declare function DigitalsignatureGenerator(): DigitalsignatureGenerator;
|
|
642
|
+
type DigitalsignatureGenerator = {
|
|
643
|
+
kwargs?: Kwargs;
|
|
644
|
+
method?: string;
|
|
645
|
+
};
|
|
646
|
+
/** @returns {Document} */
|
|
647
|
+
declare function Document(): Document;
|
|
648
|
+
type Document = {
|
|
272
649
|
__v?: number;
|
|
273
650
|
_id?: string;
|
|
274
|
-
|
|
651
|
+
country_code?: string;
|
|
652
|
+
format?: string;
|
|
275
653
|
pdf_type_id?: number;
|
|
654
|
+
template?: string;
|
|
655
|
+
};
|
|
656
|
+
/** @returns {DummyTemplateData} */
|
|
657
|
+
declare function DummyTemplateData(): DummyTemplateData;
|
|
658
|
+
type DummyTemplateData = {
|
|
659
|
+
__v?: number;
|
|
660
|
+
_id?: string;
|
|
661
|
+
payload: DummyTemplateDataPayload;
|
|
662
|
+
pdf_type_id?: number;
|
|
663
|
+
};
|
|
664
|
+
/** @returns {DummyTemplateDataItems} */
|
|
665
|
+
declare function DummyTemplateDataItems(): DummyTemplateDataItems;
|
|
666
|
+
type DummyTemplateDataItems = {
|
|
667
|
+
data: DummyTemplateData[];
|
|
668
|
+
success: boolean;
|
|
669
|
+
};
|
|
670
|
+
/** @returns {DummyTemplateDataPayload} */
|
|
671
|
+
declare function DummyTemplateDataPayload(): DummyTemplateDataPayload;
|
|
672
|
+
type DummyTemplateDataPayload = {
|
|
673
|
+
amount_paid?: number;
|
|
674
|
+
amount_to_be_collected?: number;
|
|
675
|
+
app_domain_name?: string;
|
|
676
|
+
awb_number_barcode?: string;
|
|
677
|
+
brand_logo?: string;
|
|
678
|
+
company_detail?: CompanyDetail;
|
|
679
|
+
conversion_rate?: ConversionRate;
|
|
680
|
+
currency_code?: string;
|
|
681
|
+
customer_billing_detail?: CustomerBillingDetail;
|
|
682
|
+
customer_shipping_detail?: CustomerShippingDetail;
|
|
683
|
+
declaration_texts?: string[];
|
|
684
|
+
delivery_partner_detail?: DeliveryPartnerDetail;
|
|
685
|
+
digitalsignature?: string;
|
|
686
|
+
disclaimer?: string;
|
|
687
|
+
image?: Image;
|
|
688
|
+
invoice_detail?: InvoiceDetail;
|
|
689
|
+
is_international?: boolean;
|
|
690
|
+
is_self_pickup?: boolean;
|
|
691
|
+
is_self_ship?: boolean;
|
|
692
|
+
meta?: Meta;
|
|
693
|
+
mode?: string;
|
|
694
|
+
payments?: PaymentData[];
|
|
695
|
+
platform_name?: string;
|
|
696
|
+
product_table?: ProductTable;
|
|
697
|
+
registered_company_detail?: RegisteredCompanyDetail;
|
|
698
|
+
return_detail?: ReturnDetail;
|
|
699
|
+
shipment_id?: string;
|
|
700
|
+
shipment_id_barcode?: string;
|
|
701
|
+
signed_qrcode?: string;
|
|
702
|
+
store_detail?: StoreDetail;
|
|
703
|
+
tax_table?: TaxTable;
|
|
704
|
+
total_items?: number;
|
|
705
|
+
uid?: string;
|
|
706
|
+
upi_qrcode?: string;
|
|
707
|
+
waybills?: any[];
|
|
276
708
|
};
|
|
277
709
|
/** @returns {FailedResponse} */
|
|
278
710
|
declare function FailedResponse(): FailedResponse;
|
|
279
711
|
type FailedResponse = {
|
|
280
712
|
message: string;
|
|
281
713
|
};
|
|
282
|
-
/** @returns {
|
|
283
|
-
declare function
|
|
284
|
-
type
|
|
285
|
-
|
|
714
|
+
/** @returns {Igst} */
|
|
715
|
+
declare function Igst(): Igst;
|
|
716
|
+
type Igst = {
|
|
717
|
+
percent?: number;
|
|
718
|
+
value?: number;
|
|
286
719
|
};
|
|
287
|
-
/** @returns {
|
|
288
|
-
declare function
|
|
289
|
-
type
|
|
290
|
-
|
|
291
|
-
namespace?: string;
|
|
292
|
-
url: string;
|
|
720
|
+
/** @returns {Image} */
|
|
721
|
+
declare function Image(): Image;
|
|
722
|
+
type Image = {
|
|
723
|
+
sales_channel_logo?: string;
|
|
293
724
|
};
|
|
294
|
-
/** @returns {
|
|
295
|
-
declare function
|
|
296
|
-
type
|
|
297
|
-
|
|
298
|
-
|
|
725
|
+
/** @returns {Inr} */
|
|
726
|
+
declare function Inr(): Inr;
|
|
727
|
+
type Inr = {
|
|
728
|
+
name?: string;
|
|
729
|
+
sub_unit?: string;
|
|
730
|
+
symbol?: string;
|
|
731
|
+
value?: number;
|
|
299
732
|
};
|
|
300
|
-
/** @returns {
|
|
301
|
-
declare function
|
|
302
|
-
type
|
|
733
|
+
/** @returns {InvoiceDetail} */
|
|
734
|
+
declare function InvoiceDetail(): InvoiceDetail;
|
|
735
|
+
type InvoiceDetail = {
|
|
736
|
+
external_order_id?: string;
|
|
737
|
+
invoice_date?: string;
|
|
738
|
+
invoice_id?: string;
|
|
739
|
+
irn?: string;
|
|
740
|
+
shipment_id?: string;
|
|
741
|
+
signed_qrcode?: string;
|
|
742
|
+
upi_qrcode?: string;
|
|
743
|
+
};
|
|
744
|
+
/** @returns {InvoiceTypesDataResponse} */
|
|
745
|
+
declare function InvoiceTypesDataResponse(): InvoiceTypesDataResponse;
|
|
746
|
+
type InvoiceTypesDataResponse = {
|
|
303
747
|
__v: number;
|
|
304
748
|
_id: string;
|
|
749
|
+
country_code?: string;
|
|
305
750
|
format: string[];
|
|
306
751
|
name: string;
|
|
307
752
|
pdf_type_id: number;
|
|
308
|
-
|
|
753
|
+
status?: boolean;
|
|
309
754
|
visibility: boolean;
|
|
310
755
|
};
|
|
311
|
-
/** @returns {
|
|
312
|
-
declare function
|
|
313
|
-
type
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
756
|
+
/** @returns {InvoiceTypesResponse} */
|
|
757
|
+
declare function InvoiceTypesResponse(): InvoiceTypesResponse;
|
|
758
|
+
type InvoiceTypesResponse = {
|
|
759
|
+
data: InvoiceTypesDataResponse[];
|
|
760
|
+
success: boolean;
|
|
761
|
+
};
|
|
762
|
+
/** @returns {ItemsProductTable} */
|
|
763
|
+
declare function ItemsProductTable(): ItemsProductTable;
|
|
764
|
+
type ItemsProductTable = {
|
|
765
|
+
brand?: Brand;
|
|
766
|
+
discount?: number;
|
|
767
|
+
hsn_code?: string;
|
|
768
|
+
item_code?: string;
|
|
769
|
+
mrp?: number;
|
|
770
|
+
name?: string;
|
|
771
|
+
seller_identifier?: string;
|
|
772
|
+
size?: string;
|
|
773
|
+
tax?: Tax;
|
|
774
|
+
taxable_amount?: number;
|
|
775
|
+
total?: number;
|
|
776
|
+
total_taxable_amount?: number;
|
|
777
|
+
total_units?: number;
|
|
778
|
+
};
|
|
779
|
+
/** @returns {Kwargs} */
|
|
780
|
+
declare function Kwargs(): Kwargs;
|
|
781
|
+
type Kwargs = {
|
|
782
|
+
value?: string;
|
|
783
|
+
};
|
|
784
|
+
/** @returns {KwargsAwbNumber} */
|
|
785
|
+
declare function KwargsAwbNumber(): KwargsAwbNumber;
|
|
786
|
+
type KwargsAwbNumber = {
|
|
787
|
+
value?: any[];
|
|
788
|
+
};
|
|
789
|
+
/** @returns {KwargsUpiQrcode} */
|
|
790
|
+
declare function KwargsUpiQrcode(): KwargsUpiQrcode;
|
|
791
|
+
type KwargsUpiQrcode = {
|
|
792
|
+
qr_data?: string;
|
|
793
|
+
qr_url?: string;
|
|
794
|
+
};
|
|
795
|
+
/** @returns {Meta} */
|
|
796
|
+
declare function Meta(): Meta;
|
|
797
|
+
type Meta = {
|
|
798
|
+
generator?: MetaProperty;
|
|
799
|
+
};
|
|
800
|
+
/** @returns {MetaProperty} */
|
|
801
|
+
declare function MetaProperty(): MetaProperty;
|
|
802
|
+
type MetaProperty = {
|
|
803
|
+
awb_number_label_barcode_generator?: AwbNumberLabelBarcodeGenerator;
|
|
804
|
+
digitalsignature_generator?: DigitalsignatureGenerator;
|
|
805
|
+
shipment_id_barcode_generator?: ShipmentIdBarcodeGenerator;
|
|
806
|
+
signed_qrcode_generator?: SignedQrcodeGenerator;
|
|
807
|
+
upi_qrcode_generator?: UpiQrcodeGenerator;
|
|
808
|
+
};
|
|
809
|
+
/** @returns {Params} */
|
|
810
|
+
declare function Params(): Params;
|
|
811
|
+
type Params = {
|
|
812
|
+
/**
|
|
813
|
+
* - The subpath for the file.
|
|
814
|
+
*/
|
|
815
|
+
subpath?: string;
|
|
816
|
+
};
|
|
817
|
+
/** @returns {PaymentData} */
|
|
818
|
+
declare function PaymentData(): PaymentData;
|
|
819
|
+
type PaymentData = {
|
|
820
|
+
amount?: number;
|
|
821
|
+
date?: string;
|
|
822
|
+
payment_type?: string;
|
|
823
|
+
transaction_id?: string;
|
|
824
|
+
};
|
|
825
|
+
/** @returns {PaymentReceiptCustomerDetails} */
|
|
826
|
+
declare function PaymentReceiptCustomerDetails(): PaymentReceiptCustomerDetails;
|
|
827
|
+
type PaymentReceiptCustomerDetails = {
|
|
828
|
+
email_id?: string;
|
|
829
|
+
first_name?: string;
|
|
830
|
+
id?: string;
|
|
831
|
+
last_name?: string;
|
|
832
|
+
mobile_number?: string;
|
|
833
|
+
};
|
|
834
|
+
/** @returns {PaymentReceiptFormat} */
|
|
835
|
+
declare function PaymentReceiptFormat(): PaymentReceiptFormat;
|
|
836
|
+
type PaymentReceiptFormat = {
|
|
837
|
+
payment_receipt?: string[];
|
|
838
|
+
};
|
|
839
|
+
/** @returns {PaymentReceiptMeta} */
|
|
840
|
+
declare function PaymentReceiptMeta(): PaymentReceiptMeta;
|
|
841
|
+
type PaymentReceiptMeta = {
|
|
842
|
+
action?: string;
|
|
843
|
+
application_id?: string[];
|
|
844
|
+
company_id?: number;
|
|
845
|
+
created_timestamp?: number;
|
|
846
|
+
event?: any;
|
|
847
|
+
event_trace_info?: any;
|
|
848
|
+
format?: PaymentReceiptFormat;
|
|
849
|
+
job_type?: string;
|
|
850
|
+
organizaton_id?: string;
|
|
851
|
+
service?: PaymentReceiptService;
|
|
852
|
+
trace?: string;
|
|
853
|
+
trace_id?: string[];
|
|
854
|
+
};
|
|
855
|
+
/** @returns {PaymentReceiptOrderDetails} */
|
|
856
|
+
declare function PaymentReceiptOrderDetails(): PaymentReceiptOrderDetails;
|
|
857
|
+
type PaymentReceiptOrderDetails = {
|
|
858
|
+
final_amount?: number;
|
|
859
|
+
final_amount_in_words?: string;
|
|
860
|
+
jiomart_order_id?: string;
|
|
861
|
+
order_created_date?: string;
|
|
862
|
+
order_created_time?: string;
|
|
863
|
+
prm_id?: string;
|
|
864
|
+
receipt_no?: string;
|
|
865
|
+
taxes?: PaymentReceiptTaxes;
|
|
866
|
+
total_items?: number;
|
|
867
|
+
};
|
|
868
|
+
/** @returns {PaymentReceiptPayload} */
|
|
869
|
+
declare function PaymentReceiptPayload(): PaymentReceiptPayload;
|
|
870
|
+
type PaymentReceiptPayload = {
|
|
871
|
+
customer_detail?: PaymentReceiptCustomerDetails;
|
|
872
|
+
order_detail?: PaymentReceiptOrderDetails;
|
|
873
|
+
payments?: PaymentReceiptPayments[];
|
|
874
|
+
uid?: string;
|
|
875
|
+
};
|
|
876
|
+
/** @returns {PaymentReceiptPayments} */
|
|
877
|
+
declare function PaymentReceiptPayments(): PaymentReceiptPayments;
|
|
878
|
+
type PaymentReceiptPayments = {
|
|
879
|
+
payment_desc?: string;
|
|
880
|
+
txn_date?: string;
|
|
881
|
+
};
|
|
882
|
+
/** @returns {PaymentReceiptRequestBody} */
|
|
883
|
+
declare function PaymentReceiptRequestBody(): PaymentReceiptRequestBody;
|
|
884
|
+
type PaymentReceiptRequestBody = {
|
|
885
|
+
meta?: PaymentReceiptMeta;
|
|
886
|
+
payload?: PaymentReceiptPayload;
|
|
887
|
+
};
|
|
888
|
+
/** @returns {PaymentReceiptService} */
|
|
889
|
+
declare function PaymentReceiptService(): PaymentReceiptService;
|
|
890
|
+
type PaymentReceiptService = {
|
|
891
|
+
name?: string;
|
|
892
|
+
};
|
|
893
|
+
/** @returns {PaymentReceiptTaxes} */
|
|
894
|
+
declare function PaymentReceiptTaxes(): PaymentReceiptTaxes;
|
|
895
|
+
type PaymentReceiptTaxes = {
|
|
896
|
+
gstin?: string;
|
|
897
|
+
pancard?: string;
|
|
898
|
+
};
|
|
899
|
+
/** @returns {PdfConfig} */
|
|
900
|
+
declare function PdfConfig(): PdfConfig;
|
|
901
|
+
type PdfConfig = {
|
|
325
902
|
/**
|
|
326
903
|
* - This is invoice document format such as A4, A6, POS
|
|
327
904
|
*/
|
|
@@ -335,6 +912,12 @@ type pdfConfig = {
|
|
|
335
912
|
/** @returns {PdfConfigSaveSuccess} */
|
|
336
913
|
declare function PdfConfigSaveSuccess(): PdfConfigSaveSuccess;
|
|
337
914
|
type PdfConfigSaveSuccess = {
|
|
915
|
+
data?: PdfConfigSaveSuccessData;
|
|
916
|
+
success?: boolean;
|
|
917
|
+
};
|
|
918
|
+
/** @returns {PdfConfigSaveSuccessData} */
|
|
919
|
+
declare function PdfConfigSaveSuccessData(): PdfConfigSaveSuccessData;
|
|
920
|
+
type PdfConfigSaveSuccessData = {
|
|
338
921
|
__v?: number;
|
|
339
922
|
_id?: string;
|
|
340
923
|
application_id?: string;
|
|
@@ -346,10 +929,17 @@ type PdfConfigSaveSuccess = {
|
|
|
346
929
|
/** @returns {PdfConfigSuccess} */
|
|
347
930
|
declare function PdfConfigSuccess(): PdfConfigSuccess;
|
|
348
931
|
type PdfConfigSuccess = {
|
|
932
|
+
data?: PdfConfigSuccessData[];
|
|
933
|
+
success?: boolean;
|
|
934
|
+
};
|
|
935
|
+
/** @returns {PdfConfigSuccessData} */
|
|
936
|
+
declare function PdfConfigSuccessData(): PdfConfigSuccessData;
|
|
937
|
+
type PdfConfigSuccessData = {
|
|
349
938
|
__v?: number;
|
|
350
939
|
_id?: string;
|
|
351
940
|
application_id?: string;
|
|
352
941
|
company_id?: number;
|
|
942
|
+
country_code?: string;
|
|
353
943
|
format?: string;
|
|
354
944
|
pdf_type_id?: number;
|
|
355
945
|
template?: string;
|
|
@@ -357,18 +947,70 @@ type PdfConfigSuccess = {
|
|
|
357
947
|
/** @returns {PdfDefaultTemplateSuccess} */
|
|
358
948
|
declare function PdfDefaultTemplateSuccess(): PdfDefaultTemplateSuccess;
|
|
359
949
|
type PdfDefaultTemplateSuccess = {
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
950
|
+
data?: Document[];
|
|
951
|
+
/**
|
|
952
|
+
* - Indicates if the request was successful.
|
|
953
|
+
*/
|
|
954
|
+
success?: boolean;
|
|
365
955
|
};
|
|
366
|
-
/** @returns {
|
|
367
|
-
declare function
|
|
368
|
-
type
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
956
|
+
/** @returns {ProductTable} */
|
|
957
|
+
declare function ProductTable(): ProductTable;
|
|
958
|
+
type ProductTable = {
|
|
959
|
+
cod_charges?: number;
|
|
960
|
+
delivery_charge_text?: string;
|
|
961
|
+
delivery_charges?: number;
|
|
962
|
+
fynd_discounts?: number;
|
|
963
|
+
grand_total?: number;
|
|
964
|
+
products?: ItemsProductTable[];
|
|
965
|
+
total_in_words?: string;
|
|
966
|
+
total_items?: number;
|
|
967
|
+
};
|
|
968
|
+
/** @returns {Rates} */
|
|
969
|
+
declare function Rates(): Rates;
|
|
970
|
+
type Rates = {
|
|
971
|
+
inr?: Inr;
|
|
972
|
+
usd?: Usd;
|
|
973
|
+
};
|
|
974
|
+
/** @returns {RegisteredCompanyDetail} */
|
|
975
|
+
declare function RegisteredCompanyDetail(): RegisteredCompanyDetail;
|
|
976
|
+
type RegisteredCompanyDetail = {
|
|
977
|
+
address?: string;
|
|
978
|
+
city?: string;
|
|
979
|
+
country?: string;
|
|
980
|
+
country_code?: string;
|
|
981
|
+
state?: string;
|
|
982
|
+
state_code?: string;
|
|
983
|
+
zip_code?: number;
|
|
984
|
+
};
|
|
985
|
+
/** @returns {ReturnDetail} */
|
|
986
|
+
declare function ReturnDetail(): ReturnDetail;
|
|
987
|
+
type ReturnDetail = {
|
|
988
|
+
address?: string;
|
|
989
|
+
city?: string;
|
|
990
|
+
country?: string;
|
|
991
|
+
country_code?: string;
|
|
992
|
+
gstin?: string;
|
|
993
|
+
state?: string;
|
|
994
|
+
state_code?: string;
|
|
995
|
+
zip_code?: string;
|
|
996
|
+
};
|
|
997
|
+
/** @returns {Sgst} */
|
|
998
|
+
declare function Sgst(): Sgst;
|
|
999
|
+
type Sgst = {
|
|
1000
|
+
percent?: number;
|
|
1001
|
+
value?: number;
|
|
1002
|
+
};
|
|
1003
|
+
/** @returns {ShipmentIdBarcodeGenerator} */
|
|
1004
|
+
declare function ShipmentIdBarcodeGenerator(): ShipmentIdBarcodeGenerator;
|
|
1005
|
+
type ShipmentIdBarcodeGenerator = {
|
|
1006
|
+
kwargs?: Kwargs;
|
|
1007
|
+
method?: string;
|
|
1008
|
+
};
|
|
1009
|
+
/** @returns {SignedQrcodeGenerator} */
|
|
1010
|
+
declare function SignedQrcodeGenerator(): SignedQrcodeGenerator;
|
|
1011
|
+
type SignedQrcodeGenerator = {
|
|
1012
|
+
kwargs?: Kwargs;
|
|
1013
|
+
method?: string;
|
|
372
1014
|
};
|
|
373
1015
|
/** @returns {SignUrlRequest} */
|
|
374
1016
|
declare function SignUrlRequest(): SignUrlRequest;
|
|
@@ -386,7 +1028,7 @@ declare function StartRequest(): StartRequest;
|
|
|
386
1028
|
type StartRequest = {
|
|
387
1029
|
content_type: string;
|
|
388
1030
|
file_name: string;
|
|
389
|
-
params?:
|
|
1031
|
+
params?: Params;
|
|
390
1032
|
size: number;
|
|
391
1033
|
tags?: string[];
|
|
392
1034
|
};
|
|
@@ -404,13 +1046,45 @@ type StartResponse = {
|
|
|
404
1046
|
tags?: string[];
|
|
405
1047
|
upload: Upload;
|
|
406
1048
|
};
|
|
407
|
-
/** @returns {
|
|
408
|
-
declare function
|
|
409
|
-
type
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
1049
|
+
/** @returns {StoreDetail} */
|
|
1050
|
+
declare function StoreDetail(): StoreDetail;
|
|
1051
|
+
type StoreDetail = {
|
|
1052
|
+
address?: string;
|
|
1053
|
+
city?: string;
|
|
1054
|
+
country?: string;
|
|
1055
|
+
country_code?: string;
|
|
1056
|
+
gstin?: string;
|
|
1057
|
+
state?: string;
|
|
1058
|
+
state_code?: string;
|
|
1059
|
+
store_name?: string;
|
|
1060
|
+
zip_code?: string;
|
|
1061
|
+
};
|
|
1062
|
+
/** @returns {Tax} */
|
|
1063
|
+
declare function Tax(): Tax;
|
|
1064
|
+
type Tax = {
|
|
1065
|
+
cgst?: Cgst;
|
|
1066
|
+
igst?: Igst;
|
|
1067
|
+
sgst?: Sgst;
|
|
1068
|
+
};
|
|
1069
|
+
/** @returns {Taxes} */
|
|
1070
|
+
declare function Taxes(): Taxes;
|
|
1071
|
+
type Taxes = {
|
|
1072
|
+
hsn_code?: string;
|
|
1073
|
+
tax?: Tax;
|
|
1074
|
+
total_tax_value?: number;
|
|
1075
|
+
};
|
|
1076
|
+
/** @returns {TaxTable} */
|
|
1077
|
+
declare function TaxTable(): TaxTable;
|
|
1078
|
+
type TaxTable = {
|
|
1079
|
+
tax_in_words?: string;
|
|
1080
|
+
taxes?: Taxes[];
|
|
1081
|
+
total_tax?: number;
|
|
1082
|
+
};
|
|
1083
|
+
/** @returns {UpiQrcodeGenerator} */
|
|
1084
|
+
declare function UpiQrcodeGenerator(): UpiQrcodeGenerator;
|
|
1085
|
+
type UpiQrcodeGenerator = {
|
|
1086
|
+
kwargs?: KwargsUpiQrcode;
|
|
1087
|
+
method?: string;
|
|
414
1088
|
};
|
|
415
1089
|
/** @returns {Upload} */
|
|
416
1090
|
declare function Upload(): Upload;
|
|
@@ -425,3 +1099,11 @@ type Urls = {
|
|
|
425
1099
|
signed_url: string;
|
|
426
1100
|
url: string;
|
|
427
1101
|
};
|
|
1102
|
+
/** @returns {Usd} */
|
|
1103
|
+
declare function Usd(): Usd;
|
|
1104
|
+
type Usd = {
|
|
1105
|
+
name?: string;
|
|
1106
|
+
sub_unit?: string;
|
|
1107
|
+
symbol?: string;
|
|
1108
|
+
value?: number;
|
|
1109
|
+
};
|