@gofynd/fdk-client-javascript 1.6.4 → 2.0.1
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 +5 -5
- package/sdk/application/Cart/CartApplicationClient.js +26 -268
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +20 -20
- package/sdk/application/Catalog/CatalogApplicationClient.js +98 -347
- package/sdk/application/Common/CommonApplicationClient.js +1 -16
- package/sdk/application/Communication/CommunicationApplicationClient.js +1 -24
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +24 -2
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +58 -137
- package/sdk/application/Content/ContentApplicationClient.d.ts +47 -7
- package/sdk/application/Content/ContentApplicationClient.js +222 -191
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
- package/sdk/application/Finance/FinanceApplicationClient.js +1 -16
- package/sdk/application/Lead/LeadApplicationClient.d.ts +4 -4
- package/sdk/application/Lead/LeadApplicationClient.js +21 -52
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +16 -56
- package/sdk/application/Logistic/LogisticApplicationClient.js +57 -332
- package/sdk/application/Order/OrderApplicationClient.d.ts +11 -11
- package/sdk/application/Order/OrderApplicationClient.js +68 -153
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +2 -12
- package/sdk/application/Payment/PaymentApplicationClient.js +7 -487
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.js +6 -59
- package/sdk/application/Share/ShareApplicationClient.d.ts +4 -4
- package/sdk/application/Share/ShareApplicationClient.js +21 -75
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +3 -3
- package/sdk/application/Theme/ThemeApplicationClient.js +19 -47
- package/sdk/application/User/UserApplicationClient.js +1 -407
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -8
- package/sdk/common/Utility.d.ts +1 -1
- package/sdk/common/Utility.js +10 -7
- package/sdk/common/Validator.d.ts +1 -0
- package/sdk/common/Validator.js +20 -0
- package/sdk/common/utils.d.ts +0 -1
- package/sdk/common/utils.js +0 -14
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +1 -55
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +1 -408
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -5
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -37
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -0
- package/sdk/partner/Lead/LeadPartnerModel.js +2 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +29 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +65 -42
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1008 -794
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +573 -460
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +10 -5
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +2 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +67 -9
- package/sdk/platform/Cart/CartPlatformModel.js +38 -5
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.js +4 -4
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +47 -13
- package/sdk/platform/Catalog/CatalogPlatformModel.js +29 -7
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +7 -4
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +71 -7
- package/sdk/platform/Communication/CommunicationPlatformModel.js +70 -6
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +0 -27
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +8 -60
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +31 -20
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +3 -3
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +13 -0
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +68 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +49 -7
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +169 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1279 -132
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +156 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +180 -0
- package/sdk/platform/Content/ContentPlatformClient.d.ts +162 -0
- package/sdk/platform/Content/ContentPlatformClient.js +1697 -497
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1053 -35
- package/sdk/platform/Content/ContentPlatformModel.js +717 -34
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +127 -1
- package/sdk/platform/Content/ContentPlatformValidator.js +171 -0
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +34 -0
- package/sdk/platform/Discount/DiscountPlatformClient.js +59 -0
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +365 -93
- package/sdk/platform/Discount/DiscountPlatformModel.js +98 -93
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +54 -34
- package/sdk/platform/Discount/DiscountPlatformValidator.js +27 -17
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +0 -156
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +0 -1072
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -137
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -173
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +1 -1105
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +0 -1125
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -0
- package/sdk/platform/Lead/LeadPlatformModel.js +2 -0
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -92
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
- package/sdk/platform/Order/OrderPlatformClient.d.ts +212 -0
- package/sdk/platform/Order/OrderPlatformClient.js +397 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +41 -9
- package/sdk/platform/Order/OrderPlatformModel.js +20 -7
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -1
- package/sdk/platform/Order/OrderPlatformValidator.js +20 -0
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +58 -10
- package/sdk/platform/Partner/PartnerPlatformModel.js +19 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +12 -2
- package/sdk/platform/Payment/PaymentPlatformModel.js +8 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +5 -0
- package/sdk/platform/Rewards/RewardsPlatformModel.js +2 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +240 -24
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +1753 -277
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +320 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +269 -19
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +53 -104
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +201 -629
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +5720 -2891
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3414 -2181
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +138 -216
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +81 -148
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +10 -0
- package/sdk/platform/User/UserPlatformApplicationClient.js +79 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +13 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +12 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +52 -1
- package/sdk/platform/User/UserPlatformModel.js +36 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +5 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.js +2 -0
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +6 -11
- package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -16
- package/sdk/public/Content/ContentPublicClient.d.ts +36 -3
- package/sdk/public/Content/ContentPublicClient.js +261 -104
- package/sdk/public/Content/ContentPublicModel.d.ts +155 -1
- package/sdk/public/Content/ContentPublicModel.js +102 -0
- package/sdk/public/Content/ContentPublicValidator.d.ts +18 -1
- package/sdk/public/Content/ContentPublicValidator.js +26 -0
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +6 -11
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.js +1 -40
|
@@ -1,83 +1,4 @@
|
|
|
1
1
|
export = FileStoragePlatformModel;
|
|
2
|
-
/**
|
|
3
|
-
* @typedef UpdatePdfType
|
|
4
|
-
* @property {number} [pdf_type_id]
|
|
5
|
-
* @property {string} [name]
|
|
6
|
-
* @property {string[]} [format]
|
|
7
|
-
* @property {boolean} [visibility]
|
|
8
|
-
* @property {Object} [schema]
|
|
9
|
-
* @property {boolean} [store_os]
|
|
10
|
-
* @property {string} [country_code]
|
|
11
|
-
*/
|
|
12
|
-
/**
|
|
13
|
-
* @typedef PdfTypeByIdDetails
|
|
14
|
-
* @property {boolean} [store_os]
|
|
15
|
-
* @property {string} [country_code]
|
|
16
|
-
* @property {number} [pdf_type_id]
|
|
17
|
-
* @property {number} [__v]
|
|
18
|
-
* @property {string} [_id]
|
|
19
|
-
* @property {string[]} [format]
|
|
20
|
-
* @property {string} [name]
|
|
21
|
-
* @property {boolean} [visibility]
|
|
22
|
-
*/
|
|
23
|
-
/**
|
|
24
|
-
* @typedef PdfConfigurationData
|
|
25
|
-
* @property {string} [_id]
|
|
26
|
-
* @property {number} [pdf_type_id]
|
|
27
|
-
* @property {string} [format]
|
|
28
|
-
* @property {string} [template]
|
|
29
|
-
* @property {string} [country_code]
|
|
30
|
-
* @property {number} [__v]
|
|
31
|
-
*/
|
|
32
|
-
/**
|
|
33
|
-
* @typedef UpdatedDefaultTemplateById
|
|
34
|
-
* @property {PdfConfigurationData} [data]
|
|
35
|
-
* @property {boolean} [success]
|
|
36
|
-
*/
|
|
37
|
-
/**
|
|
38
|
-
* @typedef UpdateTemplate
|
|
39
|
-
* @property {number} [pdf_type_id]
|
|
40
|
-
* @property {string} [format] - This is invoice document format such as A4, A6, POS, A5
|
|
41
|
-
* @property {string} [country_code] - This is iso code of a country
|
|
42
|
-
* @property {string} [template] - This is html template string
|
|
43
|
-
* @property {boolean} [store_os] - This flag is to identify store-os
|
|
44
|
-
*/
|
|
45
|
-
/**
|
|
46
|
-
* @typedef PdfDefaultTemplateById
|
|
47
|
-
* @property {string} [_id] - The ID of the PDF default template
|
|
48
|
-
* @property {string} [country_code] - The country code associated with the template
|
|
49
|
-
* @property {string} [format] - The format of the template (e.g., "A4")
|
|
50
|
-
* @property {number} [pdf_type_id] - The ID of the PDF type
|
|
51
|
-
* @property {number} [__v] - Version number
|
|
52
|
-
* @property {string} [template] - The HTML template content
|
|
53
|
-
*/
|
|
54
|
-
/**
|
|
55
|
-
* @typedef PdfTemplateCreateSuccess
|
|
56
|
-
* @property {number} [code]
|
|
57
|
-
* @property {boolean} [success]
|
|
58
|
-
* @property {PdfTemplateCreateSuccessData} [data]
|
|
59
|
-
*/
|
|
60
|
-
/**
|
|
61
|
-
* @typedef PdfTemplateCreateSuccessData
|
|
62
|
-
* @property {string} [_id]
|
|
63
|
-
* @property {number} [pdf_type_id]
|
|
64
|
-
* @property {string} [format]
|
|
65
|
-
* @property {string} [template]
|
|
66
|
-
* @property {string} [country_code]
|
|
67
|
-
* @property {number} [__v]
|
|
68
|
-
*/
|
|
69
|
-
/**
|
|
70
|
-
* @typedef CreateTemplate
|
|
71
|
-
* @property {number} pdf_type_id
|
|
72
|
-
* @property {string} format - This is invoice document format such as A4, A6, POS, A5
|
|
73
|
-
* @property {string} country_code - This is iso code of a country
|
|
74
|
-
* @property {string} [template] - This is html template string
|
|
75
|
-
*/
|
|
76
|
-
/**
|
|
77
|
-
* @typedef PdfDefaultTemplateSuccess
|
|
78
|
-
* @property {Document[]} [data]
|
|
79
|
-
* @property {boolean} [success] - Indicates if the request was successful.
|
|
80
|
-
*/
|
|
81
2
|
/**
|
|
82
3
|
* @typedef FailedBrowseFilesResult
|
|
83
4
|
* @property {string} message
|
|
@@ -164,376 +85,6 @@ export = FileStoragePlatformModel;
|
|
|
164
85
|
* @property {number} expiry
|
|
165
86
|
* @property {string[]} urls
|
|
166
87
|
*/
|
|
167
|
-
/**
|
|
168
|
-
* @typedef InvoiceTypesData
|
|
169
|
-
* @property {boolean} [status]
|
|
170
|
-
* @property {string} _id
|
|
171
|
-
* @property {number} pdf_type_id
|
|
172
|
-
* @property {string} name
|
|
173
|
-
* @property {string[]} format
|
|
174
|
-
* @property {number} __v
|
|
175
|
-
* @property {boolean} visibility
|
|
176
|
-
* @property {boolean} store_os
|
|
177
|
-
* @property {string} country_code
|
|
178
|
-
*/
|
|
179
|
-
/**
|
|
180
|
-
* @typedef InvoiceTypes
|
|
181
|
-
* @property {InvoiceTypesData[]} data
|
|
182
|
-
* @property {boolean} success
|
|
183
|
-
*/
|
|
184
|
-
/**
|
|
185
|
-
* @typedef ConversionRate
|
|
186
|
-
* @property {string} [base]
|
|
187
|
-
* @property {Object} [rates]
|
|
188
|
-
* @property {number} [timestamp]
|
|
189
|
-
*/
|
|
190
|
-
/**
|
|
191
|
-
* @typedef DeliveryPartnerDetail
|
|
192
|
-
* @property {string} [name]
|
|
193
|
-
* @property {string} [awb_number_barcode]
|
|
194
|
-
* @property {string} [awb_number]
|
|
195
|
-
* @property {string} [origin]
|
|
196
|
-
* @property {string} [destination]
|
|
197
|
-
* @property {string} [eway_bill_number]
|
|
198
|
-
*/
|
|
199
|
-
/**
|
|
200
|
-
* @typedef Image
|
|
201
|
-
* @property {string} [sales_channel_logo]
|
|
202
|
-
*/
|
|
203
|
-
/**
|
|
204
|
-
* @typedef PaymentData
|
|
205
|
-
* @property {string} [payment_type]
|
|
206
|
-
* @property {number} [amount]
|
|
207
|
-
* @property {string} [date]
|
|
208
|
-
* @property {string} [transaction_id]
|
|
209
|
-
* @property {string} [time]
|
|
210
|
-
* @property {string} [mode]
|
|
211
|
-
* @property {string} [name]
|
|
212
|
-
* @property {Object} [meta]
|
|
213
|
-
*/
|
|
214
|
-
/**
|
|
215
|
-
* @typedef InvoiceDetail
|
|
216
|
-
* @property {string} [invoice_id]
|
|
217
|
-
* @property {string} [invoice_date]
|
|
218
|
-
* @property {string} [irn]
|
|
219
|
-
* @property {string} [external_order_id]
|
|
220
|
-
* @property {string} [shipment_id]
|
|
221
|
-
* @property {string} [signed_qrcode]
|
|
222
|
-
* @property {string} [upi_qrcode]
|
|
223
|
-
* @property {string} [device_id]
|
|
224
|
-
* @property {string} [marketplace_invoice_id]
|
|
225
|
-
* @property {string} [marketplace_shipment_id]
|
|
226
|
-
* @property {string} [channel_order_id]
|
|
227
|
-
*/
|
|
228
|
-
/**
|
|
229
|
-
* @typedef CompanyDetail
|
|
230
|
-
* @property {string} [name] - The official name of the company.
|
|
231
|
-
* @property {string} [address] - The physical street address of the company.
|
|
232
|
-
* @property {string} [city] - The city where the company is located.
|
|
233
|
-
* @property {string} [state] - The state or province where the company is located.
|
|
234
|
-
* @property {string} [country] - The country where the company is based.
|
|
235
|
-
* @property {number} [zip_code] - The postal code for the company's location.
|
|
236
|
-
* @property {string} [state_code] - A code representing the state, often used
|
|
237
|
-
* in official documents and forms.
|
|
238
|
-
* @property {string} [country_code] - The code of the country.
|
|
239
|
-
* @property {string} [gstin] - The Goods and Services Tax Identification
|
|
240
|
-
* Number, unique to each business in India.
|
|
241
|
-
* @property {string} [pan] - The Permanent Account Number, unique to each
|
|
242
|
-
* taxpayer in India.
|
|
243
|
-
* @property {string} [phone_no] - The primary contact phone number for the company.
|
|
244
|
-
* @property {string} [cin] - The Corporate Identification Number, unique to
|
|
245
|
-
* each company registered in India.
|
|
246
|
-
* @property {string} [website_url] - The URL to the company's official website.
|
|
247
|
-
* @property {string} [email] - The company's official email address.
|
|
248
|
-
* @property {string} [display_address] - The display address of the company.
|
|
249
|
-
* @property {string} [sector] - The sector in which company is located.
|
|
250
|
-
* @property {Object} [phone] - The provided phone no of country.
|
|
251
|
-
* @property {string} [trn] - The trn no of the company.
|
|
252
|
-
* @property {string} [vat] - The vat no of the company.
|
|
253
|
-
* @property {string} [business_country_timezone] - The bussiness country timezone.
|
|
254
|
-
* @property {Object} [business_country_currency] - This object represents the
|
|
255
|
-
* bussiness country currency.
|
|
256
|
-
* @property {Object} [meta] - This object represents the meta fields for company.
|
|
257
|
-
*/
|
|
258
|
-
/**
|
|
259
|
-
* @typedef StoreDetail
|
|
260
|
-
* @property {string} [store_name]
|
|
261
|
-
* @property {string} [address]
|
|
262
|
-
* @property {string} [city]
|
|
263
|
-
* @property {string} [state]
|
|
264
|
-
* @property {string} [country]
|
|
265
|
-
* @property {string} [country_code]
|
|
266
|
-
* @property {string} [zip_code]
|
|
267
|
-
* @property {string} [state_code]
|
|
268
|
-
* @property {string} [gstin]
|
|
269
|
-
* @property {string} [display_address]
|
|
270
|
-
* @property {string} [sector]
|
|
271
|
-
* @property {string} [store_id]
|
|
272
|
-
*/
|
|
273
|
-
/**
|
|
274
|
-
* @typedef CustomerBillingDetail
|
|
275
|
-
* @property {string} [name]
|
|
276
|
-
* @property {string} [phone_no]
|
|
277
|
-
* @property {string} [address]
|
|
278
|
-
* @property {string} [city]
|
|
279
|
-
* @property {string} [state]
|
|
280
|
-
* @property {string} [country]
|
|
281
|
-
* @property {string} [country_code]
|
|
282
|
-
* @property {string} [zip_code]
|
|
283
|
-
* @property {string} [state_code]
|
|
284
|
-
* @property {string} [gstin]
|
|
285
|
-
* @property {string} [display_address]
|
|
286
|
-
* @property {string} [sector]
|
|
287
|
-
* @property {string} [email]
|
|
288
|
-
*/
|
|
289
|
-
/**
|
|
290
|
-
* @typedef CustomerShippingDetail
|
|
291
|
-
* @property {string} [name]
|
|
292
|
-
* @property {string} [phone_no]
|
|
293
|
-
* @property {string} [address]
|
|
294
|
-
* @property {string} [city]
|
|
295
|
-
* @property {string} [state]
|
|
296
|
-
* @property {string} [country]
|
|
297
|
-
* @property {string} [country_code]
|
|
298
|
-
* @property {string} [zip_code]
|
|
299
|
-
* @property {string} [state_code]
|
|
300
|
-
* @property {string} [gstin]
|
|
301
|
-
* @property {string} [display_address]
|
|
302
|
-
* @property {string} [sector]
|
|
303
|
-
*/
|
|
304
|
-
/**
|
|
305
|
-
* @typedef ReturnDetail
|
|
306
|
-
* @property {string} [address]
|
|
307
|
-
* @property {string} [city]
|
|
308
|
-
* @property {string} [state]
|
|
309
|
-
* @property {string} [country]
|
|
310
|
-
* @property {string} [country_code]
|
|
311
|
-
* @property {string} [zip_code]
|
|
312
|
-
* @property {string} [state_code]
|
|
313
|
-
* @property {string} [gstin]
|
|
314
|
-
* @property {string} [display_address]
|
|
315
|
-
* @property {string} [sector]
|
|
316
|
-
*/
|
|
317
|
-
/**
|
|
318
|
-
* @typedef Brand
|
|
319
|
-
* @property {string} [logo]
|
|
320
|
-
* @property {string} [name]
|
|
321
|
-
*/
|
|
322
|
-
/**
|
|
323
|
-
* @typedef Cgst
|
|
324
|
-
* @property {number} [value]
|
|
325
|
-
* @property {number} [percent]
|
|
326
|
-
*/
|
|
327
|
-
/**
|
|
328
|
-
* @typedef Sgst
|
|
329
|
-
* @property {number} [value]
|
|
330
|
-
* @property {number} [percent]
|
|
331
|
-
*/
|
|
332
|
-
/**
|
|
333
|
-
* @typedef Igst
|
|
334
|
-
* @property {number} [value]
|
|
335
|
-
* @property {number} [percent]
|
|
336
|
-
*/
|
|
337
|
-
/**
|
|
338
|
-
* @typedef Tax
|
|
339
|
-
* @property {Cgst} [cgst]
|
|
340
|
-
* @property {Sgst} [sgst]
|
|
341
|
-
* @property {Igst} [igst]
|
|
342
|
-
*/
|
|
343
|
-
/**
|
|
344
|
-
* @typedef ItemsProductTable
|
|
345
|
-
* @property {string} [name]
|
|
346
|
-
* @property {string} [seller_identifier]
|
|
347
|
-
* @property {number} [total]
|
|
348
|
-
* @property {Brand} [brand]
|
|
349
|
-
* @property {string} [hsn_code]
|
|
350
|
-
* @property {string} [item_code]
|
|
351
|
-
* @property {number} [total_units]
|
|
352
|
-
* @property {string} [size]
|
|
353
|
-
* @property {number} [mrp]
|
|
354
|
-
* @property {number} [discount]
|
|
355
|
-
* @property {number} [taxable_amount]
|
|
356
|
-
* @property {number} [total_taxable_amount]
|
|
357
|
-
* @property {Tax} [tax]
|
|
358
|
-
* @property {Object} [meta]
|
|
359
|
-
* @property {string} [country_of_origin]
|
|
360
|
-
*/
|
|
361
|
-
/**
|
|
362
|
-
* @typedef ProductTable
|
|
363
|
-
* @property {number} [total_items]
|
|
364
|
-
* @property {ItemsProductTable[]} [products]
|
|
365
|
-
* @property {number} [grand_total]
|
|
366
|
-
* @property {number} [delivery_charges]
|
|
367
|
-
* @property {string} [delivery_charge_text]
|
|
368
|
-
* @property {number} [cod_charges]
|
|
369
|
-
* @property {number} [fynd_discounts]
|
|
370
|
-
* @property {string} [total_in_words]
|
|
371
|
-
* @property {number} [gift_price]
|
|
372
|
-
* @property {number} [total_quantity]
|
|
373
|
-
* @property {number} [sub_total]
|
|
374
|
-
* @property {number} [discount]
|
|
375
|
-
* @property {number} [promotion]
|
|
376
|
-
* @property {number} [coupon]
|
|
377
|
-
* @property {number} [reward]
|
|
378
|
-
* @property {number} [round_off]
|
|
379
|
-
* @property {number} [total_value_of_goods]
|
|
380
|
-
*/
|
|
381
|
-
/**
|
|
382
|
-
* @typedef Taxes
|
|
383
|
-
* @property {string} [hsn_code]
|
|
384
|
-
* @property {Tax} [tax]
|
|
385
|
-
* @property {number} [total_tax_value]
|
|
386
|
-
*/
|
|
387
|
-
/**
|
|
388
|
-
* @typedef TaxTable
|
|
389
|
-
* @property {Taxes[]} [taxes]
|
|
390
|
-
* @property {number} [total_tax]
|
|
391
|
-
* @property {string} [tax_in_words]
|
|
392
|
-
*/
|
|
393
|
-
/**
|
|
394
|
-
* @typedef RegisteredCompanyDetail
|
|
395
|
-
* @property {string} [address]
|
|
396
|
-
* @property {string} [city]
|
|
397
|
-
* @property {string} [state]
|
|
398
|
-
* @property {string} [country]
|
|
399
|
-
* @property {string} [country_code]
|
|
400
|
-
* @property {number} [zip_code]
|
|
401
|
-
* @property {string} [state_code]
|
|
402
|
-
* @property {string} [display_address]
|
|
403
|
-
* @property {string} [sector]
|
|
404
|
-
*/
|
|
405
|
-
/**
|
|
406
|
-
* @typedef Kwargs
|
|
407
|
-
* @property {string} [value]
|
|
408
|
-
*/
|
|
409
|
-
/**
|
|
410
|
-
* @typedef ShipmentIdBarcodeGenerator
|
|
411
|
-
* @property {string} [method]
|
|
412
|
-
* @property {Kwargs} [kwargs]
|
|
413
|
-
*/
|
|
414
|
-
/**
|
|
415
|
-
* @typedef SignedQrcodeGenerator
|
|
416
|
-
* @property {string} [method]
|
|
417
|
-
* @property {Kwargs} [kwargs]
|
|
418
|
-
*/
|
|
419
|
-
/**
|
|
420
|
-
* @typedef KwargsUpiQrcode
|
|
421
|
-
* @property {string} [qr_data]
|
|
422
|
-
* @property {string} [qr_url]
|
|
423
|
-
*/
|
|
424
|
-
/**
|
|
425
|
-
* @typedef UpiQrcodeGenerator
|
|
426
|
-
* @property {string} [method]
|
|
427
|
-
* @property {KwargsUpiQrcode} [kwargs]
|
|
428
|
-
*/
|
|
429
|
-
/**
|
|
430
|
-
* @typedef DigitalsignatureGenerator
|
|
431
|
-
* @property {string} [method]
|
|
432
|
-
* @property {Kwargs} [kwargs]
|
|
433
|
-
*/
|
|
434
|
-
/**
|
|
435
|
-
* @typedef KwargsAwbNumber
|
|
436
|
-
* @property {Object[]} [value]
|
|
437
|
-
*/
|
|
438
|
-
/**
|
|
439
|
-
* @typedef AwbNumberLabelBarcodeGenerator
|
|
440
|
-
* @property {string} [method]
|
|
441
|
-
* @property {KwargsAwbNumber} [kwargs]
|
|
442
|
-
*/
|
|
443
|
-
/**
|
|
444
|
-
* @typedef AwbNumberBarcodeGenerator
|
|
445
|
-
* @property {string} [method]
|
|
446
|
-
* @property {Kwargs} [kwargs]
|
|
447
|
-
*/
|
|
448
|
-
/**
|
|
449
|
-
* @typedef MetaProperty
|
|
450
|
-
* @property {ShipmentIdBarcodeGenerator} [shipment_id_barcode_generator]
|
|
451
|
-
* @property {SignedQrcodeGenerator} [signed_qrcode_generator]
|
|
452
|
-
* @property {UpiQrcodeGenerator} [upi_qrcode_generator]
|
|
453
|
-
* @property {DigitalsignatureGenerator} [digitalsignature_generator]
|
|
454
|
-
* @property {AwbNumberLabelBarcodeGenerator} [awb_number_label_barcode_generator]
|
|
455
|
-
* @property {AwbNumberBarcodeGenerator} [awb_number_barcode_generator]
|
|
456
|
-
*/
|
|
457
|
-
/**
|
|
458
|
-
* @typedef Meta
|
|
459
|
-
* @property {MetaProperty} [generator]
|
|
460
|
-
*/
|
|
461
|
-
/**
|
|
462
|
-
* @typedef PdfPayloadDetails
|
|
463
|
-
* @property {boolean} [is_export]
|
|
464
|
-
* @property {boolean} [is_export_shipment]
|
|
465
|
-
* @property {string} [app_domain_name]
|
|
466
|
-
* @property {string} [txn_id]
|
|
467
|
-
* @property {string} [utr]
|
|
468
|
-
* @property {string} [po_number]
|
|
469
|
-
* @property {string} [credit_note_id]
|
|
470
|
-
* @property {string} [current_date]
|
|
471
|
-
* @property {number} [total_value_of_goods]
|
|
472
|
-
* @property {Object} [b2b_buyer_details]
|
|
473
|
-
* @property {Object} [is_qwik]
|
|
474
|
-
* @property {string} [order_type]
|
|
475
|
-
* @property {ConversionRate} [conversion_rate]
|
|
476
|
-
* @property {string} [currency_code]
|
|
477
|
-
* @property {string} [shipment_id]
|
|
478
|
-
* @property {DeliveryPartnerDetail} [delivery_partner_detail]
|
|
479
|
-
* @property {Image} [image]
|
|
480
|
-
* @property {PaymentData[]} [payments]
|
|
481
|
-
* @property {InvoiceDetail} [invoice_detail]
|
|
482
|
-
* @property {CompanyDetail} [company_detail]
|
|
483
|
-
* @property {StoreDetail} [store_detail]
|
|
484
|
-
* @property {CustomerBillingDetail} [customer_billing_detail]
|
|
485
|
-
* @property {CustomerShippingDetail} [customer_shipping_detail]
|
|
486
|
-
* @property {ReturnDetail} [return_detail]
|
|
487
|
-
* @property {ProductTable} [product_table]
|
|
488
|
-
* @property {TaxTable} [tax_table]
|
|
489
|
-
* @property {string[]} [declaration_texts]
|
|
490
|
-
* @property {RegisteredCompanyDetail} [registered_company_detail]
|
|
491
|
-
* @property {string} [disclaimer]
|
|
492
|
-
* @property {Meta} [meta]
|
|
493
|
-
* @property {boolean} [is_self_ship]
|
|
494
|
-
* @property {string} [mode]
|
|
495
|
-
* @property {boolean} [is_self_pickup]
|
|
496
|
-
* @property {string} [platform_name]
|
|
497
|
-
* @property {number} [amount_to_be_collected]
|
|
498
|
-
* @property {number} [amount_paid]
|
|
499
|
-
* @property {Object[]} [waybills]
|
|
500
|
-
* @property {number} [total_items]
|
|
501
|
-
* @property {string} [brand_logo]
|
|
502
|
-
* @property {string} [shipment_id_barcode]
|
|
503
|
-
* @property {string} [signed_qrcode]
|
|
504
|
-
* @property {string} [upi_qrcode]
|
|
505
|
-
* @property {string} [digitalsignature]
|
|
506
|
-
* @property {string} [awb_number_barcode]
|
|
507
|
-
* @property {string} [uid]
|
|
508
|
-
*/
|
|
509
|
-
/**
|
|
510
|
-
* @typedef DummyTemplateData
|
|
511
|
-
* @property {string} [_id] - This field contains the unique identifier for the
|
|
512
|
-
* PDF payload.
|
|
513
|
-
* @property {number} [pdf_type_id] - This is invoice unique id
|
|
514
|
-
* @property {PdfPayloadDetails} payload
|
|
515
|
-
* @property {string} [country_code] - This field represents the country code.
|
|
516
|
-
* @property {number} [__v]
|
|
517
|
-
*/
|
|
518
|
-
/**
|
|
519
|
-
* @typedef savePdfPayload
|
|
520
|
-
* @property {number} [pdf_type_id]
|
|
521
|
-
* @property {PdfPayloadDetails} [payload]
|
|
522
|
-
* @property {string} [country_code]
|
|
523
|
-
*/
|
|
524
|
-
/**
|
|
525
|
-
* @typedef MapperDetails
|
|
526
|
-
* @property {string} [_id]
|
|
527
|
-
* @property {number} [pdf_type_id]
|
|
528
|
-
* @property {PdfPayloadDetails} [payload]
|
|
529
|
-
* @property {string} [country_code]
|
|
530
|
-
* @property {number} [__v] - This field holds the version number.
|
|
531
|
-
*/
|
|
532
|
-
/**
|
|
533
|
-
* @typedef PdfDataItemsDetails
|
|
534
|
-
* @property {DummyTemplateData[]} data
|
|
535
|
-
* @property {boolean} success
|
|
536
|
-
*/
|
|
537
88
|
/**
|
|
538
89
|
* @typedef PdfConfig
|
|
539
90
|
* @property {string} [format] - This is invoice document format such as A4, A6, POS
|
|
@@ -559,12 +110,6 @@ export = FileStoragePlatformModel;
|
|
|
559
110
|
* configuration document.
|
|
560
111
|
* @property {string} [country_code]
|
|
561
112
|
*/
|
|
562
|
-
/**
|
|
563
|
-
* @typedef DeleteMapperById
|
|
564
|
-
* @property {string} [message] - This field represents the country code.
|
|
565
|
-
* @property {boolean} [default_template] - This field indicates whether the
|
|
566
|
-
* HTML template is the default template.
|
|
567
|
-
*/
|
|
568
113
|
/**
|
|
569
114
|
* @typedef PdfConfigSuccess
|
|
570
115
|
* @property {PdfConfigSuccessData[]} [data]
|
|
@@ -585,15 +130,6 @@ export = FileStoragePlatformModel;
|
|
|
585
130
|
* @property {PdfConfigSaveSuccessData} [data]
|
|
586
131
|
* @property {boolean} [success]
|
|
587
132
|
*/
|
|
588
|
-
/**
|
|
589
|
-
* @typedef Document
|
|
590
|
-
* @property {string} [_id]
|
|
591
|
-
* @property {number} [pdf_type_id]
|
|
592
|
-
* @property {string} [format]
|
|
593
|
-
* @property {string} [template]
|
|
594
|
-
* @property {string} [country_code]
|
|
595
|
-
* @property {number} [__v]
|
|
596
|
-
*/
|
|
597
133
|
/**
|
|
598
134
|
* @typedef PaymentReceiptRequestBody
|
|
599
135
|
* @property {PaymentReceiptPayload} [payload]
|
|
@@ -666,139 +202,8 @@ export = FileStoragePlatformModel;
|
|
|
666
202
|
declare class FileStoragePlatformModel {
|
|
667
203
|
}
|
|
668
204
|
declare namespace FileStoragePlatformModel {
|
|
669
|
-
export {
|
|
205
|
+
export { FailedBrowseFilesResult, CDN, Upload, FileUpload, FileUploadStart, CreatedBy, FileUploadComplete, ProxyFileAccess, DestinationNamespace, CopyFiles, Urls, SignUrlResult, SignUrl, PdfConfig, PdfConfigSuccessData, PdfConfigSuccess, PdfConfigSaveSuccessData, PdfConfigSaveSuccess, PaymentReceiptRequestBody, PaymentReceiptOrderDetails, PaymentReceiptCustomerDetails, PaymentReceiptPayments, PaymentReceiptFormat, PaymentReceiptService, PaymentReceiptTaxes, PaymentReceiptPayload, PaymentReceiptMeta, ExtensionSlug };
|
|
670
206
|
}
|
|
671
|
-
/** @returns {UpdatePdfType} */
|
|
672
|
-
declare function UpdatePdfType(): UpdatePdfType;
|
|
673
|
-
type UpdatePdfType = {
|
|
674
|
-
pdf_type_id?: number;
|
|
675
|
-
name?: string;
|
|
676
|
-
format?: string[];
|
|
677
|
-
visibility?: boolean;
|
|
678
|
-
schema?: any;
|
|
679
|
-
store_os?: boolean;
|
|
680
|
-
country_code?: string;
|
|
681
|
-
};
|
|
682
|
-
/** @returns {PdfTypeByIdDetails} */
|
|
683
|
-
declare function PdfTypeByIdDetails(): PdfTypeByIdDetails;
|
|
684
|
-
type PdfTypeByIdDetails = {
|
|
685
|
-
store_os?: boolean;
|
|
686
|
-
country_code?: string;
|
|
687
|
-
pdf_type_id?: number;
|
|
688
|
-
__v?: number;
|
|
689
|
-
_id?: string;
|
|
690
|
-
format?: string[];
|
|
691
|
-
name?: string;
|
|
692
|
-
visibility?: boolean;
|
|
693
|
-
};
|
|
694
|
-
/** @returns {PdfConfigurationData} */
|
|
695
|
-
declare function PdfConfigurationData(): PdfConfigurationData;
|
|
696
|
-
type PdfConfigurationData = {
|
|
697
|
-
_id?: string;
|
|
698
|
-
pdf_type_id?: number;
|
|
699
|
-
format?: string;
|
|
700
|
-
template?: string;
|
|
701
|
-
country_code?: string;
|
|
702
|
-
__v?: number;
|
|
703
|
-
};
|
|
704
|
-
/** @returns {UpdatedDefaultTemplateById} */
|
|
705
|
-
declare function UpdatedDefaultTemplateById(): UpdatedDefaultTemplateById;
|
|
706
|
-
type UpdatedDefaultTemplateById = {
|
|
707
|
-
data?: PdfConfigurationData;
|
|
708
|
-
success?: boolean;
|
|
709
|
-
};
|
|
710
|
-
/** @returns {UpdateTemplate} */
|
|
711
|
-
declare function UpdateTemplate(): UpdateTemplate;
|
|
712
|
-
type UpdateTemplate = {
|
|
713
|
-
pdf_type_id?: number;
|
|
714
|
-
/**
|
|
715
|
-
* - This is invoice document format such as A4, A6, POS, A5
|
|
716
|
-
*/
|
|
717
|
-
format?: string;
|
|
718
|
-
/**
|
|
719
|
-
* - This is iso code of a country
|
|
720
|
-
*/
|
|
721
|
-
country_code?: string;
|
|
722
|
-
/**
|
|
723
|
-
* - This is html template string
|
|
724
|
-
*/
|
|
725
|
-
template?: string;
|
|
726
|
-
/**
|
|
727
|
-
* - This flag is to identify store-os
|
|
728
|
-
*/
|
|
729
|
-
store_os?: boolean;
|
|
730
|
-
};
|
|
731
|
-
/** @returns {PdfDefaultTemplateById} */
|
|
732
|
-
declare function PdfDefaultTemplateById(): PdfDefaultTemplateById;
|
|
733
|
-
type PdfDefaultTemplateById = {
|
|
734
|
-
/**
|
|
735
|
-
* - The ID of the PDF default template
|
|
736
|
-
*/
|
|
737
|
-
_id?: string;
|
|
738
|
-
/**
|
|
739
|
-
* - The country code associated with the template
|
|
740
|
-
*/
|
|
741
|
-
country_code?: string;
|
|
742
|
-
/**
|
|
743
|
-
* - The format of the template (e.g., "A4")
|
|
744
|
-
*/
|
|
745
|
-
format?: string;
|
|
746
|
-
/**
|
|
747
|
-
* - The ID of the PDF type
|
|
748
|
-
*/
|
|
749
|
-
pdf_type_id?: number;
|
|
750
|
-
/**
|
|
751
|
-
* - Version number
|
|
752
|
-
*/
|
|
753
|
-
__v?: number;
|
|
754
|
-
/**
|
|
755
|
-
* - The HTML template content
|
|
756
|
-
*/
|
|
757
|
-
template?: string;
|
|
758
|
-
};
|
|
759
|
-
/** @returns {PdfTemplateCreateSuccess} */
|
|
760
|
-
declare function PdfTemplateCreateSuccess(): PdfTemplateCreateSuccess;
|
|
761
|
-
type PdfTemplateCreateSuccess = {
|
|
762
|
-
code?: number;
|
|
763
|
-
success?: boolean;
|
|
764
|
-
data?: PdfTemplateCreateSuccessData;
|
|
765
|
-
};
|
|
766
|
-
/** @returns {PdfTemplateCreateSuccessData} */
|
|
767
|
-
declare function PdfTemplateCreateSuccessData(): PdfTemplateCreateSuccessData;
|
|
768
|
-
type PdfTemplateCreateSuccessData = {
|
|
769
|
-
_id?: string;
|
|
770
|
-
pdf_type_id?: number;
|
|
771
|
-
format?: string;
|
|
772
|
-
template?: string;
|
|
773
|
-
country_code?: string;
|
|
774
|
-
__v?: number;
|
|
775
|
-
};
|
|
776
|
-
/** @returns {CreateTemplate} */
|
|
777
|
-
declare function CreateTemplate(): CreateTemplate;
|
|
778
|
-
type CreateTemplate = {
|
|
779
|
-
pdf_type_id: number;
|
|
780
|
-
/**
|
|
781
|
-
* - This is invoice document format such as A4, A6, POS, A5
|
|
782
|
-
*/
|
|
783
|
-
format: string;
|
|
784
|
-
/**
|
|
785
|
-
* - This is iso code of a country
|
|
786
|
-
*/
|
|
787
|
-
country_code: string;
|
|
788
|
-
/**
|
|
789
|
-
* - This is html template string
|
|
790
|
-
*/
|
|
791
|
-
template?: string;
|
|
792
|
-
};
|
|
793
|
-
/** @returns {PdfDefaultTemplateSuccess} */
|
|
794
|
-
declare function PdfDefaultTemplateSuccess(): PdfDefaultTemplateSuccess;
|
|
795
|
-
type PdfDefaultTemplateSuccess = {
|
|
796
|
-
data?: Document[];
|
|
797
|
-
/**
|
|
798
|
-
* - Indicates if the request was successful.
|
|
799
|
-
*/
|
|
800
|
-
success?: boolean;
|
|
801
|
-
};
|
|
802
207
|
/** @returns {FailedBrowseFilesResult} */
|
|
803
208
|
declare function FailedBrowseFilesResult(): FailedBrowseFilesResult;
|
|
804
209
|
type FailedBrowseFilesResult = {
|
|
@@ -898,492 +303,6 @@ type SignUrl = {
|
|
|
898
303
|
expiry: number;
|
|
899
304
|
urls: string[];
|
|
900
305
|
};
|
|
901
|
-
/** @returns {InvoiceTypesData} */
|
|
902
|
-
declare function InvoiceTypesData(): InvoiceTypesData;
|
|
903
|
-
type InvoiceTypesData = {
|
|
904
|
-
status?: boolean;
|
|
905
|
-
_id: string;
|
|
906
|
-
pdf_type_id: number;
|
|
907
|
-
name: string;
|
|
908
|
-
format: string[];
|
|
909
|
-
__v: number;
|
|
910
|
-
visibility: boolean;
|
|
911
|
-
store_os: boolean;
|
|
912
|
-
country_code: string;
|
|
913
|
-
};
|
|
914
|
-
/** @returns {InvoiceTypes} */
|
|
915
|
-
declare function InvoiceTypes(): InvoiceTypes;
|
|
916
|
-
type InvoiceTypes = {
|
|
917
|
-
data: InvoiceTypesData[];
|
|
918
|
-
success: boolean;
|
|
919
|
-
};
|
|
920
|
-
/** @returns {ConversionRate} */
|
|
921
|
-
declare function ConversionRate(): ConversionRate;
|
|
922
|
-
type ConversionRate = {
|
|
923
|
-
base?: string;
|
|
924
|
-
rates?: any;
|
|
925
|
-
timestamp?: number;
|
|
926
|
-
};
|
|
927
|
-
/** @returns {DeliveryPartnerDetail} */
|
|
928
|
-
declare function DeliveryPartnerDetail(): DeliveryPartnerDetail;
|
|
929
|
-
type DeliveryPartnerDetail = {
|
|
930
|
-
name?: string;
|
|
931
|
-
awb_number_barcode?: string;
|
|
932
|
-
awb_number?: string;
|
|
933
|
-
origin?: string;
|
|
934
|
-
destination?: string;
|
|
935
|
-
eway_bill_number?: string;
|
|
936
|
-
};
|
|
937
|
-
/** @returns {Image} */
|
|
938
|
-
declare function Image(): Image;
|
|
939
|
-
type Image = {
|
|
940
|
-
sales_channel_logo?: string;
|
|
941
|
-
};
|
|
942
|
-
/** @returns {PaymentData} */
|
|
943
|
-
declare function PaymentData(): PaymentData;
|
|
944
|
-
type PaymentData = {
|
|
945
|
-
payment_type?: string;
|
|
946
|
-
amount?: number;
|
|
947
|
-
date?: string;
|
|
948
|
-
transaction_id?: string;
|
|
949
|
-
time?: string;
|
|
950
|
-
mode?: string;
|
|
951
|
-
name?: string;
|
|
952
|
-
meta?: any;
|
|
953
|
-
};
|
|
954
|
-
/** @returns {InvoiceDetail} */
|
|
955
|
-
declare function InvoiceDetail(): InvoiceDetail;
|
|
956
|
-
type InvoiceDetail = {
|
|
957
|
-
invoice_id?: string;
|
|
958
|
-
invoice_date?: string;
|
|
959
|
-
irn?: string;
|
|
960
|
-
external_order_id?: string;
|
|
961
|
-
shipment_id?: string;
|
|
962
|
-
signed_qrcode?: string;
|
|
963
|
-
upi_qrcode?: string;
|
|
964
|
-
device_id?: string;
|
|
965
|
-
marketplace_invoice_id?: string;
|
|
966
|
-
marketplace_shipment_id?: string;
|
|
967
|
-
channel_order_id?: string;
|
|
968
|
-
};
|
|
969
|
-
/** @returns {CompanyDetail} */
|
|
970
|
-
declare function CompanyDetail(): CompanyDetail;
|
|
971
|
-
type CompanyDetail = {
|
|
972
|
-
/**
|
|
973
|
-
* - The official name of the company.
|
|
974
|
-
*/
|
|
975
|
-
name?: string;
|
|
976
|
-
/**
|
|
977
|
-
* - The physical street address of the company.
|
|
978
|
-
*/
|
|
979
|
-
address?: string;
|
|
980
|
-
/**
|
|
981
|
-
* - The city where the company is located.
|
|
982
|
-
*/
|
|
983
|
-
city?: string;
|
|
984
|
-
/**
|
|
985
|
-
* - The state or province where the company is located.
|
|
986
|
-
*/
|
|
987
|
-
state?: string;
|
|
988
|
-
/**
|
|
989
|
-
* - The country where the company is based.
|
|
990
|
-
*/
|
|
991
|
-
country?: string;
|
|
992
|
-
/**
|
|
993
|
-
* - The postal code for the company's location.
|
|
994
|
-
*/
|
|
995
|
-
zip_code?: number;
|
|
996
|
-
/**
|
|
997
|
-
* - A code representing the state, often used
|
|
998
|
-
* in official documents and forms.
|
|
999
|
-
*/
|
|
1000
|
-
state_code?: string;
|
|
1001
|
-
/**
|
|
1002
|
-
* - The code of the country.
|
|
1003
|
-
*/
|
|
1004
|
-
country_code?: string;
|
|
1005
|
-
/**
|
|
1006
|
-
* - The Goods and Services Tax Identification
|
|
1007
|
-
* Number, unique to each business in India.
|
|
1008
|
-
*/
|
|
1009
|
-
gstin?: string;
|
|
1010
|
-
/**
|
|
1011
|
-
* - The Permanent Account Number, unique to each
|
|
1012
|
-
* taxpayer in India.
|
|
1013
|
-
*/
|
|
1014
|
-
pan?: string;
|
|
1015
|
-
/**
|
|
1016
|
-
* - The primary contact phone number for the company.
|
|
1017
|
-
*/
|
|
1018
|
-
phone_no?: string;
|
|
1019
|
-
/**
|
|
1020
|
-
* - The Corporate Identification Number, unique to
|
|
1021
|
-
* each company registered in India.
|
|
1022
|
-
*/
|
|
1023
|
-
cin?: string;
|
|
1024
|
-
/**
|
|
1025
|
-
* - The URL to the company's official website.
|
|
1026
|
-
*/
|
|
1027
|
-
website_url?: string;
|
|
1028
|
-
/**
|
|
1029
|
-
* - The company's official email address.
|
|
1030
|
-
*/
|
|
1031
|
-
email?: string;
|
|
1032
|
-
/**
|
|
1033
|
-
* - The display address of the company.
|
|
1034
|
-
*/
|
|
1035
|
-
display_address?: string;
|
|
1036
|
-
/**
|
|
1037
|
-
* - The sector in which company is located.
|
|
1038
|
-
*/
|
|
1039
|
-
sector?: string;
|
|
1040
|
-
/**
|
|
1041
|
-
* - The provided phone no of country.
|
|
1042
|
-
*/
|
|
1043
|
-
phone?: any;
|
|
1044
|
-
/**
|
|
1045
|
-
* - The trn no of the company.
|
|
1046
|
-
*/
|
|
1047
|
-
trn?: string;
|
|
1048
|
-
/**
|
|
1049
|
-
* - The vat no of the company.
|
|
1050
|
-
*/
|
|
1051
|
-
vat?: string;
|
|
1052
|
-
/**
|
|
1053
|
-
* - The bussiness country timezone.
|
|
1054
|
-
*/
|
|
1055
|
-
business_country_timezone?: string;
|
|
1056
|
-
/**
|
|
1057
|
-
* - This object represents the
|
|
1058
|
-
* bussiness country currency.
|
|
1059
|
-
*/
|
|
1060
|
-
business_country_currency?: any;
|
|
1061
|
-
/**
|
|
1062
|
-
* - This object represents the meta fields for company.
|
|
1063
|
-
*/
|
|
1064
|
-
meta?: any;
|
|
1065
|
-
};
|
|
1066
|
-
/** @returns {StoreDetail} */
|
|
1067
|
-
declare function StoreDetail(): StoreDetail;
|
|
1068
|
-
type StoreDetail = {
|
|
1069
|
-
store_name?: string;
|
|
1070
|
-
address?: string;
|
|
1071
|
-
city?: string;
|
|
1072
|
-
state?: string;
|
|
1073
|
-
country?: string;
|
|
1074
|
-
country_code?: string;
|
|
1075
|
-
zip_code?: string;
|
|
1076
|
-
state_code?: string;
|
|
1077
|
-
gstin?: string;
|
|
1078
|
-
display_address?: string;
|
|
1079
|
-
sector?: string;
|
|
1080
|
-
store_id?: string;
|
|
1081
|
-
};
|
|
1082
|
-
/** @returns {CustomerBillingDetail} */
|
|
1083
|
-
declare function CustomerBillingDetail(): CustomerBillingDetail;
|
|
1084
|
-
type CustomerBillingDetail = {
|
|
1085
|
-
name?: string;
|
|
1086
|
-
phone_no?: string;
|
|
1087
|
-
address?: string;
|
|
1088
|
-
city?: string;
|
|
1089
|
-
state?: string;
|
|
1090
|
-
country?: string;
|
|
1091
|
-
country_code?: string;
|
|
1092
|
-
zip_code?: string;
|
|
1093
|
-
state_code?: string;
|
|
1094
|
-
gstin?: string;
|
|
1095
|
-
display_address?: string;
|
|
1096
|
-
sector?: string;
|
|
1097
|
-
email?: string;
|
|
1098
|
-
};
|
|
1099
|
-
/** @returns {CustomerShippingDetail} */
|
|
1100
|
-
declare function CustomerShippingDetail(): CustomerShippingDetail;
|
|
1101
|
-
type CustomerShippingDetail = {
|
|
1102
|
-
name?: string;
|
|
1103
|
-
phone_no?: string;
|
|
1104
|
-
address?: string;
|
|
1105
|
-
city?: string;
|
|
1106
|
-
state?: string;
|
|
1107
|
-
country?: string;
|
|
1108
|
-
country_code?: string;
|
|
1109
|
-
zip_code?: string;
|
|
1110
|
-
state_code?: string;
|
|
1111
|
-
gstin?: string;
|
|
1112
|
-
display_address?: string;
|
|
1113
|
-
sector?: string;
|
|
1114
|
-
};
|
|
1115
|
-
/** @returns {ReturnDetail} */
|
|
1116
|
-
declare function ReturnDetail(): ReturnDetail;
|
|
1117
|
-
type ReturnDetail = {
|
|
1118
|
-
address?: string;
|
|
1119
|
-
city?: string;
|
|
1120
|
-
state?: string;
|
|
1121
|
-
country?: string;
|
|
1122
|
-
country_code?: string;
|
|
1123
|
-
zip_code?: string;
|
|
1124
|
-
state_code?: string;
|
|
1125
|
-
gstin?: string;
|
|
1126
|
-
display_address?: string;
|
|
1127
|
-
sector?: string;
|
|
1128
|
-
};
|
|
1129
|
-
/** @returns {Brand} */
|
|
1130
|
-
declare function Brand(): Brand;
|
|
1131
|
-
type Brand = {
|
|
1132
|
-
logo?: string;
|
|
1133
|
-
name?: string;
|
|
1134
|
-
};
|
|
1135
|
-
/** @returns {Cgst} */
|
|
1136
|
-
declare function Cgst(): Cgst;
|
|
1137
|
-
type Cgst = {
|
|
1138
|
-
value?: number;
|
|
1139
|
-
percent?: number;
|
|
1140
|
-
};
|
|
1141
|
-
/** @returns {Sgst} */
|
|
1142
|
-
declare function Sgst(): Sgst;
|
|
1143
|
-
type Sgst = {
|
|
1144
|
-
value?: number;
|
|
1145
|
-
percent?: number;
|
|
1146
|
-
};
|
|
1147
|
-
/** @returns {Igst} */
|
|
1148
|
-
declare function Igst(): Igst;
|
|
1149
|
-
type Igst = {
|
|
1150
|
-
value?: number;
|
|
1151
|
-
percent?: number;
|
|
1152
|
-
};
|
|
1153
|
-
/** @returns {Tax} */
|
|
1154
|
-
declare function Tax(): Tax;
|
|
1155
|
-
type Tax = {
|
|
1156
|
-
cgst?: Cgst;
|
|
1157
|
-
sgst?: Sgst;
|
|
1158
|
-
igst?: Igst;
|
|
1159
|
-
};
|
|
1160
|
-
/** @returns {ItemsProductTable} */
|
|
1161
|
-
declare function ItemsProductTable(): ItemsProductTable;
|
|
1162
|
-
type ItemsProductTable = {
|
|
1163
|
-
name?: string;
|
|
1164
|
-
seller_identifier?: string;
|
|
1165
|
-
total?: number;
|
|
1166
|
-
brand?: Brand;
|
|
1167
|
-
hsn_code?: string;
|
|
1168
|
-
item_code?: string;
|
|
1169
|
-
total_units?: number;
|
|
1170
|
-
size?: string;
|
|
1171
|
-
mrp?: number;
|
|
1172
|
-
discount?: number;
|
|
1173
|
-
taxable_amount?: number;
|
|
1174
|
-
total_taxable_amount?: number;
|
|
1175
|
-
tax?: Tax;
|
|
1176
|
-
meta?: any;
|
|
1177
|
-
country_of_origin?: string;
|
|
1178
|
-
};
|
|
1179
|
-
/** @returns {ProductTable} */
|
|
1180
|
-
declare function ProductTable(): ProductTable;
|
|
1181
|
-
type ProductTable = {
|
|
1182
|
-
total_items?: number;
|
|
1183
|
-
products?: ItemsProductTable[];
|
|
1184
|
-
grand_total?: number;
|
|
1185
|
-
delivery_charges?: number;
|
|
1186
|
-
delivery_charge_text?: string;
|
|
1187
|
-
cod_charges?: number;
|
|
1188
|
-
fynd_discounts?: number;
|
|
1189
|
-
total_in_words?: string;
|
|
1190
|
-
gift_price?: number;
|
|
1191
|
-
total_quantity?: number;
|
|
1192
|
-
sub_total?: number;
|
|
1193
|
-
discount?: number;
|
|
1194
|
-
promotion?: number;
|
|
1195
|
-
coupon?: number;
|
|
1196
|
-
reward?: number;
|
|
1197
|
-
round_off?: number;
|
|
1198
|
-
total_value_of_goods?: number;
|
|
1199
|
-
};
|
|
1200
|
-
/** @returns {Taxes} */
|
|
1201
|
-
declare function Taxes(): Taxes;
|
|
1202
|
-
type Taxes = {
|
|
1203
|
-
hsn_code?: string;
|
|
1204
|
-
tax?: Tax;
|
|
1205
|
-
total_tax_value?: number;
|
|
1206
|
-
};
|
|
1207
|
-
/** @returns {TaxTable} */
|
|
1208
|
-
declare function TaxTable(): TaxTable;
|
|
1209
|
-
type TaxTable = {
|
|
1210
|
-
taxes?: Taxes[];
|
|
1211
|
-
total_tax?: number;
|
|
1212
|
-
tax_in_words?: string;
|
|
1213
|
-
};
|
|
1214
|
-
/** @returns {RegisteredCompanyDetail} */
|
|
1215
|
-
declare function RegisteredCompanyDetail(): RegisteredCompanyDetail;
|
|
1216
|
-
type RegisteredCompanyDetail = {
|
|
1217
|
-
address?: string;
|
|
1218
|
-
city?: string;
|
|
1219
|
-
state?: string;
|
|
1220
|
-
country?: string;
|
|
1221
|
-
country_code?: string;
|
|
1222
|
-
zip_code?: number;
|
|
1223
|
-
state_code?: string;
|
|
1224
|
-
display_address?: string;
|
|
1225
|
-
sector?: string;
|
|
1226
|
-
};
|
|
1227
|
-
/** @returns {Kwargs} */
|
|
1228
|
-
declare function Kwargs(): Kwargs;
|
|
1229
|
-
type Kwargs = {
|
|
1230
|
-
value?: string;
|
|
1231
|
-
};
|
|
1232
|
-
/** @returns {ShipmentIdBarcodeGenerator} */
|
|
1233
|
-
declare function ShipmentIdBarcodeGenerator(): ShipmentIdBarcodeGenerator;
|
|
1234
|
-
type ShipmentIdBarcodeGenerator = {
|
|
1235
|
-
method?: string;
|
|
1236
|
-
kwargs?: Kwargs;
|
|
1237
|
-
};
|
|
1238
|
-
/** @returns {SignedQrcodeGenerator} */
|
|
1239
|
-
declare function SignedQrcodeGenerator(): SignedQrcodeGenerator;
|
|
1240
|
-
type SignedQrcodeGenerator = {
|
|
1241
|
-
method?: string;
|
|
1242
|
-
kwargs?: Kwargs;
|
|
1243
|
-
};
|
|
1244
|
-
/** @returns {KwargsUpiQrcode} */
|
|
1245
|
-
declare function KwargsUpiQrcode(): KwargsUpiQrcode;
|
|
1246
|
-
type KwargsUpiQrcode = {
|
|
1247
|
-
qr_data?: string;
|
|
1248
|
-
qr_url?: string;
|
|
1249
|
-
};
|
|
1250
|
-
/** @returns {UpiQrcodeGenerator} */
|
|
1251
|
-
declare function UpiQrcodeGenerator(): UpiQrcodeGenerator;
|
|
1252
|
-
type UpiQrcodeGenerator = {
|
|
1253
|
-
method?: string;
|
|
1254
|
-
kwargs?: KwargsUpiQrcode;
|
|
1255
|
-
};
|
|
1256
|
-
/** @returns {DigitalsignatureGenerator} */
|
|
1257
|
-
declare function DigitalsignatureGenerator(): DigitalsignatureGenerator;
|
|
1258
|
-
type DigitalsignatureGenerator = {
|
|
1259
|
-
method?: string;
|
|
1260
|
-
kwargs?: Kwargs;
|
|
1261
|
-
};
|
|
1262
|
-
/** @returns {KwargsAwbNumber} */
|
|
1263
|
-
declare function KwargsAwbNumber(): KwargsAwbNumber;
|
|
1264
|
-
type KwargsAwbNumber = {
|
|
1265
|
-
value?: any[];
|
|
1266
|
-
};
|
|
1267
|
-
/** @returns {AwbNumberLabelBarcodeGenerator} */
|
|
1268
|
-
declare function AwbNumberLabelBarcodeGenerator(): AwbNumberLabelBarcodeGenerator;
|
|
1269
|
-
type AwbNumberLabelBarcodeGenerator = {
|
|
1270
|
-
method?: string;
|
|
1271
|
-
kwargs?: KwargsAwbNumber;
|
|
1272
|
-
};
|
|
1273
|
-
/** @returns {AwbNumberBarcodeGenerator} */
|
|
1274
|
-
declare function AwbNumberBarcodeGenerator(): AwbNumberBarcodeGenerator;
|
|
1275
|
-
type AwbNumberBarcodeGenerator = {
|
|
1276
|
-
method?: string;
|
|
1277
|
-
kwargs?: Kwargs;
|
|
1278
|
-
};
|
|
1279
|
-
/** @returns {MetaProperty} */
|
|
1280
|
-
declare function MetaProperty(): MetaProperty;
|
|
1281
|
-
type MetaProperty = {
|
|
1282
|
-
shipment_id_barcode_generator?: ShipmentIdBarcodeGenerator;
|
|
1283
|
-
signed_qrcode_generator?: SignedQrcodeGenerator;
|
|
1284
|
-
upi_qrcode_generator?: UpiQrcodeGenerator;
|
|
1285
|
-
digitalsignature_generator?: DigitalsignatureGenerator;
|
|
1286
|
-
awb_number_label_barcode_generator?: AwbNumberLabelBarcodeGenerator;
|
|
1287
|
-
awb_number_barcode_generator?: AwbNumberBarcodeGenerator;
|
|
1288
|
-
};
|
|
1289
|
-
/** @returns {Meta} */
|
|
1290
|
-
declare function Meta(): Meta;
|
|
1291
|
-
type Meta = {
|
|
1292
|
-
generator?: MetaProperty;
|
|
1293
|
-
};
|
|
1294
|
-
/** @returns {PdfPayloadDetails} */
|
|
1295
|
-
declare function PdfPayloadDetails(): PdfPayloadDetails;
|
|
1296
|
-
type PdfPayloadDetails = {
|
|
1297
|
-
is_export?: boolean;
|
|
1298
|
-
is_export_shipment?: boolean;
|
|
1299
|
-
app_domain_name?: string;
|
|
1300
|
-
txn_id?: string;
|
|
1301
|
-
utr?: string;
|
|
1302
|
-
po_number?: string;
|
|
1303
|
-
credit_note_id?: string;
|
|
1304
|
-
current_date?: string;
|
|
1305
|
-
total_value_of_goods?: number;
|
|
1306
|
-
b2b_buyer_details?: any;
|
|
1307
|
-
is_qwik?: any;
|
|
1308
|
-
order_type?: string;
|
|
1309
|
-
conversion_rate?: ConversionRate;
|
|
1310
|
-
currency_code?: string;
|
|
1311
|
-
shipment_id?: string;
|
|
1312
|
-
delivery_partner_detail?: DeliveryPartnerDetail;
|
|
1313
|
-
image?: Image;
|
|
1314
|
-
payments?: PaymentData[];
|
|
1315
|
-
invoice_detail?: InvoiceDetail;
|
|
1316
|
-
company_detail?: CompanyDetail;
|
|
1317
|
-
store_detail?: StoreDetail;
|
|
1318
|
-
customer_billing_detail?: CustomerBillingDetail;
|
|
1319
|
-
customer_shipping_detail?: CustomerShippingDetail;
|
|
1320
|
-
return_detail?: ReturnDetail;
|
|
1321
|
-
product_table?: ProductTable;
|
|
1322
|
-
tax_table?: TaxTable;
|
|
1323
|
-
declaration_texts?: string[];
|
|
1324
|
-
registered_company_detail?: RegisteredCompanyDetail;
|
|
1325
|
-
disclaimer?: string;
|
|
1326
|
-
meta?: Meta;
|
|
1327
|
-
is_self_ship?: boolean;
|
|
1328
|
-
mode?: string;
|
|
1329
|
-
is_self_pickup?: boolean;
|
|
1330
|
-
platform_name?: string;
|
|
1331
|
-
amount_to_be_collected?: number;
|
|
1332
|
-
amount_paid?: number;
|
|
1333
|
-
waybills?: any[];
|
|
1334
|
-
total_items?: number;
|
|
1335
|
-
brand_logo?: string;
|
|
1336
|
-
shipment_id_barcode?: string;
|
|
1337
|
-
signed_qrcode?: string;
|
|
1338
|
-
upi_qrcode?: string;
|
|
1339
|
-
digitalsignature?: string;
|
|
1340
|
-
awb_number_barcode?: string;
|
|
1341
|
-
uid?: string;
|
|
1342
|
-
};
|
|
1343
|
-
/** @returns {DummyTemplateData} */
|
|
1344
|
-
declare function DummyTemplateData(): DummyTemplateData;
|
|
1345
|
-
type DummyTemplateData = {
|
|
1346
|
-
/**
|
|
1347
|
-
* - This field contains the unique identifier for the
|
|
1348
|
-
* PDF payload.
|
|
1349
|
-
*/
|
|
1350
|
-
_id?: string;
|
|
1351
|
-
/**
|
|
1352
|
-
* - This is invoice unique id
|
|
1353
|
-
*/
|
|
1354
|
-
pdf_type_id?: number;
|
|
1355
|
-
payload: PdfPayloadDetails;
|
|
1356
|
-
/**
|
|
1357
|
-
* - This field represents the country code.
|
|
1358
|
-
*/
|
|
1359
|
-
country_code?: string;
|
|
1360
|
-
__v?: number;
|
|
1361
|
-
};
|
|
1362
|
-
/** @returns {savePdfPayload} */
|
|
1363
|
-
declare function savePdfPayload(): savePdfPayload;
|
|
1364
|
-
type savePdfPayload = {
|
|
1365
|
-
pdf_type_id?: number;
|
|
1366
|
-
payload?: PdfPayloadDetails;
|
|
1367
|
-
country_code?: string;
|
|
1368
|
-
};
|
|
1369
|
-
/** @returns {MapperDetails} */
|
|
1370
|
-
declare function MapperDetails(): MapperDetails;
|
|
1371
|
-
type MapperDetails = {
|
|
1372
|
-
_id?: string;
|
|
1373
|
-
pdf_type_id?: number;
|
|
1374
|
-
payload?: PdfPayloadDetails;
|
|
1375
|
-
country_code?: string;
|
|
1376
|
-
/**
|
|
1377
|
-
* - This field holds the version number.
|
|
1378
|
-
*/
|
|
1379
|
-
__v?: number;
|
|
1380
|
-
};
|
|
1381
|
-
/** @returns {PdfDataItemsDetails} */
|
|
1382
|
-
declare function PdfDataItemsDetails(): PdfDataItemsDetails;
|
|
1383
|
-
type PdfDataItemsDetails = {
|
|
1384
|
-
data: DummyTemplateData[];
|
|
1385
|
-
success: boolean;
|
|
1386
|
-
};
|
|
1387
306
|
/** @returns {PdfConfig} */
|
|
1388
307
|
declare function PdfConfig(): PdfConfig;
|
|
1389
308
|
type PdfConfig = {
|
|
@@ -1447,19 +366,6 @@ type PdfConfigSuccessData = {
|
|
|
1447
366
|
__v?: number;
|
|
1448
367
|
country_code?: string;
|
|
1449
368
|
};
|
|
1450
|
-
/** @returns {DeleteMapperById} */
|
|
1451
|
-
declare function DeleteMapperById(): DeleteMapperById;
|
|
1452
|
-
type DeleteMapperById = {
|
|
1453
|
-
/**
|
|
1454
|
-
* - This field represents the country code.
|
|
1455
|
-
*/
|
|
1456
|
-
message?: string;
|
|
1457
|
-
/**
|
|
1458
|
-
* - This field indicates whether the
|
|
1459
|
-
* HTML template is the default template.
|
|
1460
|
-
*/
|
|
1461
|
-
default_template?: boolean;
|
|
1462
|
-
};
|
|
1463
369
|
/** @returns {PdfConfigSuccess} */
|
|
1464
370
|
declare function PdfConfigSuccess(): PdfConfigSuccess;
|
|
1465
371
|
type PdfConfigSuccess = {
|
|
@@ -1483,16 +389,6 @@ type PdfConfigSaveSuccess = {
|
|
|
1483
389
|
data?: PdfConfigSaveSuccessData;
|
|
1484
390
|
success?: boolean;
|
|
1485
391
|
};
|
|
1486
|
-
/** @returns {Document} */
|
|
1487
|
-
declare function Document(): Document;
|
|
1488
|
-
type Document = {
|
|
1489
|
-
_id?: string;
|
|
1490
|
-
pdf_type_id?: number;
|
|
1491
|
-
format?: string;
|
|
1492
|
-
template?: string;
|
|
1493
|
-
country_code?: string;
|
|
1494
|
-
__v?: number;
|
|
1495
|
-
};
|
|
1496
392
|
/** @returns {PaymentReceiptRequestBody} */
|
|
1497
393
|
declare function PaymentReceiptRequestBody(): PaymentReceiptRequestBody;
|
|
1498
394
|
type PaymentReceiptRequestBody = {
|