@gofynd/fdk-client-javascript 1.4.1 → 1.4.2-beta.10
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 +3 -2
- package/sdk/application/ApplicationClient.js +20 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +1 -1
- package/sdk/application/Cart/CartApplicationClient.js +3 -5
- package/sdk/application/Cart/CartApplicationModel.d.ts +1634 -1742
- package/sdk/application/Cart/CartApplicationModel.js +1388 -1464
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -4
- package/sdk/application/Cart/CartApplicationValidator.js +0 -4
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +6 -3
- package/sdk/application/Catalog/CatalogApplicationClient.js +20 -7
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
- package/sdk/application/Catalog/CatalogApplicationModel.js +1613 -1613
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +14 -0
- package/sdk/application/Catalog/CatalogApplicationValidator.js +6 -0
- package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
- package/sdk/application/Common/CommonApplicationModel.js +172 -172
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
- package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1492 -1626
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +1038 -1180
- package/sdk/application/Content/ContentApplicationClient.d.ts +0 -36
- package/sdk/application/Content/ContentApplicationClient.js +0 -246
- package/sdk/application/Content/ContentApplicationModel.d.ts +546 -753
- package/sdk/application/Content/ContentApplicationModel.js +565 -817
- package/sdk/application/Content/ContentApplicationValidator.d.ts +1 -40
- package/sdk/application/Content/ContentApplicationValidator.js +0 -41
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
- package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
- package/sdk/application/Lead/LeadApplicationModel.js +301 -301
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +0 -67
- package/sdk/application/Logistic/LogisticApplicationClient.js +0 -547
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +257 -712
- package/sdk/application/Logistic/LogisticApplicationModel.js +267 -755
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -211
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -131
- package/sdk/application/Order/OrderApplicationClient.d.ts +3 -3
- package/sdk/application/Order/OrderApplicationClient.js +8 -32
- package/sdk/application/Order/OrderApplicationModel.d.ts +845 -853
- package/sdk/application/Order/OrderApplicationModel.js +816 -824
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -20
- package/sdk/application/Order/OrderApplicationValidator.js +0 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +2 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +10 -341
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +1892 -2199
- package/sdk/application/Payment/PaymentApplicationModel.js +1235 -1506
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +14 -59
- package/sdk/application/Payment/PaymentApplicationValidator.js +10 -64
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1396 -1429
- package/sdk/application/PosCart/PosCartApplicationModel.js +1233 -1257
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
- package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
- package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
- package/sdk/application/Share/ShareApplicationModel.js +121 -121
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.js +3 -7
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +783 -969
- package/sdk/application/Theme/ThemeApplicationModel.js +571 -867
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -10
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -4
- package/sdk/application/User/UserApplicationClient.d.ts +0 -33
- package/sdk/application/User/UserApplicationClient.js +0 -239
- package/sdk/application/User/UserApplicationModel.d.ts +753 -768
- package/sdk/application/User/UserApplicationModel.js +731 -755
- package/sdk/application/User/UserApplicationValidator.d.ts +1 -34
- package/sdk/application/User/UserApplicationValidator.js +0 -36
- package/sdk/common/Clickstream.d.ts +1 -0
- package/sdk/common/Clickstream.js +254 -0
- package/sdk/common/Utility.js +1 -4
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +72 -60
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +70 -58
- package/sdk/partner/PartnerClient.d.ts +0 -6
- package/sdk/partner/PartnerClient.js +0 -9
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +0 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +0 -80
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1178 -1153
- package/sdk/partner/Theme/ThemePartnerModel.js +830 -974
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +0 -1
- package/sdk/partner/Theme/ThemePartnerValidator.js +0 -9
- package/sdk/partner/index.d.ts +0 -3
- package/sdk/partner/index.js +0 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +2 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +1 -11
- package/sdk/platform/Billing/BillingPlatformClient.js +3 -110
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +734 -800
- package/sdk/platform/Billing/BillingPlatformModel.js +732 -810
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +4 -43
- package/sdk/platform/Billing/BillingPlatformValidator.js +2 -29
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +11 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +81 -7
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +13 -5
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +12 -4
- package/sdk/platform/Cart/CartPlatformModel.d.ts +3223 -3328
- package/sdk/platform/Cart/CartPlatformModel.js +2875 -2946
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +11 -15
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +21 -52
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +0 -27
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +0 -11
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +15 -27
- package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -189
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +617 -920
- package/sdk/platform/Catalog/CatalogPlatformModel.js +584 -919
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +27 -41
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +19 -31
- package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
- package/sdk/platform/Common/CommonPlatformModel.js +187 -187
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +37 -139
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +52 -737
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +3 -133
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +1 -113
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1079 -1228
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1090 -1262
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +2 -8
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +4 -32
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +629 -658
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +641 -675
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +0 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +0 -6
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +8 -8
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2992 -3231
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2092 -2303
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +2 -2
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -391
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1074 -3656
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -351
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -410
- package/sdk/platform/Content/ContentPlatformModel.d.ts +972 -2071
- package/sdk/platform/Content/ContentPlatformModel.js +1039 -2355
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformClient.js +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +174 -259
- package/sdk/platform/Discount/DiscountPlatformModel.js +163 -257
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +6 -16
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +8 -117
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +4 -55
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -39
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +821 -892
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +833 -901
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -33
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -240
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +910 -1056
- package/sdk/platform/Finance/FinancePlatformModel.js +884 -1070
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -38
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -38
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
- package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +28 -38
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +56 -137
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +29 -41
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.js +21 -33
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +601 -610
- package/sdk/platform/Lead/LeadPlatformModel.js +457 -471
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +1 -11
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +1 -93
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
- package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -143
- package/sdk/platform/Order/OrderPlatformClient.js +160 -1190
- package/sdk/platform/Order/OrderPlatformModel.d.ts +4451 -5275
- package/sdk/platform/Order/OrderPlatformModel.js +4039 -4994
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +21 -257
- package/sdk/platform/Order/OrderPlatformValidator.js +15 -216
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
- package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +13 -119
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +40 -750
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +7 -143
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +6 -133
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.js +1 -1
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2067 -2929
- package/sdk/platform/Payment/PaymentPlatformModel.js +1427 -2090
- package/sdk/platform/PlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/PlatformApplicationClient.js +4 -4
- package/sdk/platform/PlatformClient.d.ts +2 -4
- package/sdk/platform/PlatformClient.js +4 -8
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
- package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +66 -142
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +147 -645
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +63 -131
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +47 -126
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +105 -217
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +349 -1138
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +990 -1589
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +986 -1702
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +133 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +102 -266
- package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
- package/sdk/platform/Share/SharePlatformModel.js +139 -139
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +1 -11
- package/sdk/platform/Theme/ThemePlatformClient.js +3 -87
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +765 -1133
- package/sdk/platform/Theme/ThemePlatformModel.js +561 -1009
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +4 -28
- package/sdk/platform/Theme/ThemePlatformValidator.js +2 -21
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +1 -116
- package/sdk/platform/User/UserPlatformApplicationClient.js +86 -932
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -224
- package/sdk/platform/User/UserPlatformApplicationValidator.js +5 -173
- package/sdk/platform/User/UserPlatformModel.d.ts +428 -765
- package/sdk/platform/User/UserPlatformModel.js +428 -679
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +37 -45
- package/sdk/platform/Webhook/WebhookPlatformClient.js +57 -61
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +403 -448
- package/sdk/platform/Webhook/WebhookPlatformModel.js +309 -369
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +6 -6
- package/sdk/platform/index.d.ts +1 -1
- package/sdk/platform/index.js +2 -2
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
- package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
- package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
- package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
- package/sdk/public/Partner/PartnerPublicModel.js +113 -113
- package/sdk/public/PublicClient.d.ts +0 -4
- package/sdk/public/PublicClient.js +0 -8
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +0 -33
- package/sdk/public/Webhook/WebhookPublicClient.js +0 -242
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +15 -161
- package/sdk/public/Webhook/WebhookPublicModel.js +13 -189
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -23
- package/sdk/public/Webhook/WebhookPublicValidator.js +0 -31
- package/sdk/public/index.d.ts +0 -2
- package/sdk/public/index.js +0 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +0 -125
- package/sdk/partner/Lead/LeadPartnerClient.js +0 -785
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +0 -1127
- package/sdk/partner/Lead/LeadPartnerModel.js +0 -896
- package/sdk/partner/Lead/LeadPartnerValidator.d.ts +0 -12
- package/sdk/partner/Lead/LeadPartnerValidator.js +0 -67
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +0 -155
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +0 -1195
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +0 -372
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +0 -442
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -16
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +0 -123
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +0 -99
- package/sdk/partner/Webhook/WebhookPartnerClient.js +0 -753
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +0 -566
- package/sdk/partner/Webhook/WebhookPartnerModel.js +0 -583
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -12
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +0 -74
- package/sdk/platform/Content/ContentPlatformClient.d.ts +0 -277
- package/sdk/platform/Content/ContentPlatformClient.js +0 -2011
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +0 -247
- package/sdk/platform/Content/ContentPlatformValidator.js +0 -319
- package/sdk/public/Billing/BillingPublicClient.d.ts +0 -23
- package/sdk/public/Billing/BillingPublicClient.js +0 -116
- package/sdk/public/Billing/BillingPublicModel.d.ts +0 -92
- package/sdk/public/Billing/BillingPublicModel.js +0 -96
- package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -18
- package/sdk/public/Billing/BillingPublicValidator.js +0 -19
- package/sdk/public/Content/ContentPublicClient.d.ts +0 -22
- package/sdk/public/Content/ContentPublicClient.js +0 -114
- package/sdk/public/Content/ContentPublicModel.d.ts +0 -53
- package/sdk/public/Content/ContentPublicModel.js +0 -60
- package/sdk/public/Content/ContentPublicValidator.d.ts +0 -18
- package/sdk/public/Content/ContentPublicValidator.js +0 -19
|
@@ -1,862 +1,874 @@
|
|
|
1
1
|
export = FileStoragePlatformModel;
|
|
2
2
|
/**
|
|
3
|
-
* @typedef
|
|
4
|
-
* @property {
|
|
5
|
-
* @property {string} [method]
|
|
6
|
-
*/
|
|
7
|
-
/**
|
|
8
|
-
* @typedef AwbNumberLabelBarcodeGenerator
|
|
9
|
-
* @property {KwargsAwbNumber} [kwargs]
|
|
10
|
-
* @property {string} [method]
|
|
11
|
-
*/
|
|
12
|
-
/**
|
|
13
|
-
* @typedef Brand
|
|
14
|
-
* @property {string} [logo]
|
|
15
|
-
* @property {string} [name]
|
|
3
|
+
* @typedef FailedResponse
|
|
4
|
+
* @property {string} message
|
|
16
5
|
*/
|
|
17
6
|
/**
|
|
18
7
|
* @typedef CDN
|
|
8
|
+
* @property {string} url
|
|
19
9
|
* @property {string} absolute_url
|
|
20
10
|
* @property {string} relative_url
|
|
21
|
-
* @property {string} url
|
|
22
11
|
*/
|
|
23
12
|
/**
|
|
24
|
-
* @typedef
|
|
25
|
-
* @property {number}
|
|
26
|
-
* @property {
|
|
27
|
-
*/
|
|
28
|
-
/**
|
|
29
|
-
* @typedef CompanyDetail
|
|
30
|
-
* @property {string} [address]
|
|
31
|
-
* @property {Object} [business_country_currency]
|
|
32
|
-
* @property {string} [business_country_timezone]
|
|
33
|
-
* @property {string} [cin]
|
|
34
|
-
* @property {string} [city]
|
|
35
|
-
* @property {string} [country]
|
|
36
|
-
* @property {string} [country_code]
|
|
37
|
-
* @property {string} [display_address]
|
|
38
|
-
* @property {string} [email]
|
|
39
|
-
* @property {string} [gstin]
|
|
40
|
-
* @property {string} [name]
|
|
41
|
-
* @property {string} [pan]
|
|
42
|
-
* @property {Object} [phone]
|
|
43
|
-
* @property {string} [phone_no]
|
|
44
|
-
* @property {string} [sector]
|
|
45
|
-
* @property {string} [state]
|
|
46
|
-
* @property {string} [state_code]
|
|
47
|
-
* @property {string} [trn]
|
|
48
|
-
* @property {string} [vat]
|
|
49
|
-
* @property {string} [website_url]
|
|
50
|
-
* @property {number} [zip_code]
|
|
13
|
+
* @typedef Upload
|
|
14
|
+
* @property {number} expiry
|
|
15
|
+
* @property {string} url
|
|
51
16
|
*/
|
|
52
17
|
/**
|
|
53
|
-
* @typedef
|
|
54
|
-
* @property {string} _id
|
|
55
|
-
* @property {CDN} cdn
|
|
56
|
-
* @property {number} company_id
|
|
57
|
-
* @property {string} content_type
|
|
58
|
-
* @property {CreatedBy} [created_by]
|
|
59
|
-
* @property {string} created_on
|
|
18
|
+
* @typedef StartResponse
|
|
60
19
|
* @property {string} file_name
|
|
61
20
|
* @property {string} file_path
|
|
62
|
-
* @property {string}
|
|
21
|
+
* @property {string} content_type
|
|
22
|
+
* @property {string} [method]
|
|
63
23
|
* @property {string} namespace
|
|
64
24
|
* @property {string} operation
|
|
65
25
|
* @property {number} size
|
|
66
|
-
* @property {boolean} success
|
|
67
|
-
* @property {string[]} [tags]
|
|
68
26
|
* @property {Upload} upload
|
|
27
|
+
* @property {CDN} cdn
|
|
28
|
+
* @property {string[]} [tags]
|
|
69
29
|
*/
|
|
70
30
|
/**
|
|
71
|
-
* @typedef
|
|
72
|
-
* @property {string} [
|
|
73
|
-
* @property {Object} [rates]
|
|
74
|
-
* @property {number} [timestamp]
|
|
31
|
+
* @typedef Params
|
|
32
|
+
* @property {string} [subpath] - The subpath for the file.
|
|
75
33
|
*/
|
|
76
34
|
/**
|
|
77
|
-
* @typedef
|
|
78
|
-
* @property {
|
|
79
|
-
* @property {string
|
|
35
|
+
* @typedef StartRequest
|
|
36
|
+
* @property {string} file_name
|
|
37
|
+
* @property {string} content_type
|
|
38
|
+
* @property {number} size
|
|
39
|
+
* @property {string[]} [tags]
|
|
40
|
+
* @property {Params} [params]
|
|
80
41
|
*/
|
|
81
42
|
/**
|
|
82
43
|
* @typedef CreatedBy
|
|
83
44
|
* @property {string} [username]
|
|
84
45
|
*/
|
|
85
46
|
/**
|
|
86
|
-
* @typedef
|
|
87
|
-
* @property {string}
|
|
88
|
-
* @property {string}
|
|
89
|
-
* @property {string}
|
|
90
|
-
* @property {string}
|
|
91
|
-
* @property {string}
|
|
92
|
-
* @property {string}
|
|
93
|
-
* @property {
|
|
94
|
-
* @property {
|
|
95
|
-
* @property {
|
|
96
|
-
* @property {
|
|
97
|
-
* @property {
|
|
98
|
-
* @property {string} [
|
|
99
|
-
* @property {string}
|
|
47
|
+
* @typedef CompleteResponse
|
|
48
|
+
* @property {string} _id
|
|
49
|
+
* @property {string} file_name
|
|
50
|
+
* @property {string} file_path
|
|
51
|
+
* @property {string} content_type
|
|
52
|
+
* @property {string} namespace
|
|
53
|
+
* @property {string} operation
|
|
54
|
+
* @property {number} company_id
|
|
55
|
+
* @property {number} size
|
|
56
|
+
* @property {Upload} upload
|
|
57
|
+
* @property {CDN} cdn
|
|
58
|
+
* @property {boolean} success
|
|
59
|
+
* @property {string[]} [tags]
|
|
60
|
+
* @property {string} created_on
|
|
61
|
+
* @property {string} modified_on
|
|
62
|
+
* @property {CreatedBy} [created_by]
|
|
100
63
|
*/
|
|
101
64
|
/**
|
|
102
|
-
* @typedef
|
|
103
|
-
* @property {string} [
|
|
104
|
-
* @property {string} [city]
|
|
105
|
-
* @property {string} [country]
|
|
106
|
-
* @property {string} [country_code]
|
|
107
|
-
* @property {string} [display_address]
|
|
108
|
-
* @property {string} [gstin]
|
|
109
|
-
* @property {string} [name]
|
|
110
|
-
* @property {string} [phone_no]
|
|
111
|
-
* @property {string} [sector]
|
|
112
|
-
* @property {string} [state]
|
|
113
|
-
* @property {string} [state_code]
|
|
114
|
-
* @property {string} [zip_code]
|
|
65
|
+
* @typedef DestinationNamespace
|
|
66
|
+
* @property {string} [namespace]
|
|
115
67
|
*/
|
|
116
68
|
/**
|
|
117
|
-
* @typedef
|
|
118
|
-
* @property {string} [
|
|
119
|
-
* @property {
|
|
120
|
-
* @property {string} [destination]
|
|
121
|
-
* @property {string} [eway_bill_number]
|
|
122
|
-
* @property {string} [name]
|
|
123
|
-
* @property {string} [origin]
|
|
69
|
+
* @typedef CopyFiles
|
|
70
|
+
* @property {string[]} [urls]
|
|
71
|
+
* @property {DestinationNamespace} destination
|
|
124
72
|
*/
|
|
125
73
|
/**
|
|
126
|
-
* @typedef
|
|
127
|
-
* @property {string}
|
|
74
|
+
* @typedef Urls
|
|
75
|
+
* @property {string} url
|
|
76
|
+
* @property {string} signed_url
|
|
77
|
+
* @property {number} expiry
|
|
128
78
|
*/
|
|
129
79
|
/**
|
|
130
|
-
* @typedef
|
|
131
|
-
* @property {
|
|
132
|
-
* @property {string} [method]
|
|
80
|
+
* @typedef SignUrlResponse
|
|
81
|
+
* @property {Urls[]} urls
|
|
133
82
|
*/
|
|
134
83
|
/**
|
|
135
|
-
* @typedef
|
|
136
|
-
* @property {number}
|
|
137
|
-
* @property {string}
|
|
138
|
-
* @property {string} [country_code]
|
|
139
|
-
* @property {string} [format]
|
|
140
|
-
* @property {number} [pdf_type_id]
|
|
141
|
-
* @property {string} [template]
|
|
84
|
+
* @typedef SignUrlRequest
|
|
85
|
+
* @property {number} expiry
|
|
86
|
+
* @property {string[]} urls
|
|
142
87
|
*/
|
|
143
88
|
/**
|
|
144
|
-
* @typedef
|
|
145
|
-
* @property {
|
|
146
|
-
* @property {string}
|
|
89
|
+
* @typedef InvoiceTypesDataResponse
|
|
90
|
+
* @property {boolean} [status]
|
|
91
|
+
* @property {string} _id
|
|
92
|
+
* @property {number} pdf_type_id
|
|
93
|
+
* @property {string} name
|
|
94
|
+
* @property {string[]} format
|
|
95
|
+
* @property {number} __v
|
|
96
|
+
* @property {boolean} visibility
|
|
147
97
|
* @property {string} [country_code]
|
|
148
|
-
* @property {DummyTemplateDataPayload} payload
|
|
149
|
-
* @property {number} [pdf_type_id]
|
|
150
98
|
*/
|
|
151
99
|
/**
|
|
152
|
-
* @typedef
|
|
153
|
-
* @property {
|
|
100
|
+
* @typedef InvoiceTypesResponse
|
|
101
|
+
* @property {InvoiceTypesDataResponse[]} data
|
|
154
102
|
* @property {boolean} success
|
|
155
103
|
*/
|
|
156
104
|
/**
|
|
157
|
-
* @typedef
|
|
158
|
-
* @property {
|
|
159
|
-
* @property {number} [
|
|
160
|
-
* @property {string} [
|
|
161
|
-
* @property {string} [
|
|
162
|
-
* @property {Object} [b2b_buyer_details]
|
|
163
|
-
* @property {string} [brand_logo]
|
|
164
|
-
* @property {CompanyDetail} [company_detail]
|
|
165
|
-
* @property {ConversionRate} [conversion_rate]
|
|
166
|
-
* @property {string} [credit_note_id]
|
|
167
|
-
* @property {string} [currency_code]
|
|
168
|
-
* @property {string} [current_date]
|
|
169
|
-
* @property {CustomerBillingDetail} [customer_billing_detail]
|
|
170
|
-
* @property {CustomerShippingDetail} [customer_shipping_detail]
|
|
171
|
-
* @property {string[]} [declaration_texts]
|
|
172
|
-
* @property {DeliveryPartnerDetail} [delivery_partner_detail]
|
|
173
|
-
* @property {string} [digitalsignature]
|
|
174
|
-
* @property {string} [disclaimer]
|
|
175
|
-
* @property {Image} [image]
|
|
176
|
-
* @property {InvoiceDetail} [invoice_detail]
|
|
177
|
-
* @property {boolean} [is_export]
|
|
178
|
-
* @property {boolean} [is_export_shipment]
|
|
179
|
-
* @property {Object} [is_qwik]
|
|
180
|
-
* @property {boolean} [is_self_pickup]
|
|
181
|
-
* @property {boolean} [is_self_ship]
|
|
182
|
-
* @property {Meta} [meta]
|
|
183
|
-
* @property {string} [mode]
|
|
184
|
-
* @property {string} [order_type]
|
|
185
|
-
* @property {PaymentData[]} [payments]
|
|
186
|
-
* @property {string} [platform_name]
|
|
187
|
-
* @property {string} [po_number]
|
|
188
|
-
* @property {ProductTable} [product_table]
|
|
189
|
-
* @property {RegisteredCompanyDetail} [registered_company_detail]
|
|
190
|
-
* @property {ReturnDetail} [return_detail]
|
|
191
|
-
* @property {string} [shipment_id]
|
|
192
|
-
* @property {string} [shipment_id_barcode]
|
|
193
|
-
* @property {string} [signed_qrcode]
|
|
194
|
-
* @property {StoreDetail} [store_detail]
|
|
195
|
-
* @property {TaxTable} [tax_table]
|
|
196
|
-
* @property {number} [total_items]
|
|
197
|
-
* @property {number} [total_value_of_goods]
|
|
198
|
-
* @property {string} [txn_id]
|
|
199
|
-
* @property {string} [uid]
|
|
200
|
-
* @property {string} [upi_qrcode]
|
|
201
|
-
* @property {string} [utr]
|
|
202
|
-
* @property {Object[]} [waybills]
|
|
105
|
+
* @typedef Inr
|
|
106
|
+
* @property {string} [name]
|
|
107
|
+
* @property {number} [value]
|
|
108
|
+
* @property {string} [symbol]
|
|
109
|
+
* @property {string} [sub_unit]
|
|
203
110
|
*/
|
|
204
111
|
/**
|
|
205
|
-
* @typedef
|
|
206
|
-
* @property {string} [
|
|
112
|
+
* @typedef Usd
|
|
113
|
+
* @property {string} [name]
|
|
114
|
+
* @property {number} [value]
|
|
115
|
+
* @property {string} [symbol]
|
|
116
|
+
* @property {string} [sub_unit]
|
|
207
117
|
*/
|
|
208
118
|
/**
|
|
209
|
-
* @typedef
|
|
210
|
-
* @property {
|
|
119
|
+
* @typedef Rates
|
|
120
|
+
* @property {Inr} [inr]
|
|
121
|
+
* @property {Usd} [usd]
|
|
211
122
|
*/
|
|
212
123
|
/**
|
|
213
|
-
* @typedef
|
|
214
|
-
* @property {
|
|
215
|
-
* @property {
|
|
124
|
+
* @typedef ConversionRate
|
|
125
|
+
* @property {string} [base]
|
|
126
|
+
* @property {Rates} [rates]
|
|
127
|
+
* @property {number} [timestamp]
|
|
128
|
+
*/
|
|
129
|
+
/**
|
|
130
|
+
* @typedef DeliveryPartnerDetail
|
|
131
|
+
* @property {string} [name]
|
|
132
|
+
* @property {string} [awb_number_barcode]
|
|
133
|
+
* @property {string} [awb_number]
|
|
134
|
+
* @property {string} [eway_bill_number]
|
|
216
135
|
*/
|
|
217
136
|
/**
|
|
218
137
|
* @typedef Image
|
|
219
138
|
* @property {string} [sales_channel_logo]
|
|
220
139
|
*/
|
|
140
|
+
/**
|
|
141
|
+
* @typedef PaymentData
|
|
142
|
+
* @property {string} [payment_type]
|
|
143
|
+
* @property {number} [amount]
|
|
144
|
+
* @property {string} [date]
|
|
145
|
+
* @property {string} [transaction_id]
|
|
146
|
+
*/
|
|
221
147
|
/**
|
|
222
148
|
* @typedef InvoiceDetail
|
|
223
|
-
* @property {string} [channel_order_id]
|
|
224
|
-
* @property {string} [device_id]
|
|
225
|
-
* @property {string} [external_order_id]
|
|
226
|
-
* @property {string} [invoice_date]
|
|
227
149
|
* @property {string} [invoice_id]
|
|
150
|
+
* @property {string} [invoice_date]
|
|
228
151
|
* @property {string} [irn]
|
|
229
|
-
* @property {string} [
|
|
230
|
-
* @property {string} [marketplace_shipment_id]
|
|
152
|
+
* @property {string} [external_order_id]
|
|
231
153
|
* @property {string} [shipment_id]
|
|
232
154
|
* @property {string} [signed_qrcode]
|
|
233
155
|
* @property {string} [upi_qrcode]
|
|
234
156
|
*/
|
|
235
157
|
/**
|
|
236
|
-
* @typedef
|
|
237
|
-
* @property {
|
|
238
|
-
* @property {string}
|
|
239
|
-
* @property {string}
|
|
240
|
-
* @property {string[]
|
|
241
|
-
* @property {string}
|
|
242
|
-
* @property {number}
|
|
243
|
-
* @property {
|
|
244
|
-
* @property {
|
|
158
|
+
* @typedef CompanyDetail
|
|
159
|
+
* @property {string} [name]
|
|
160
|
+
* @property {string} [address]
|
|
161
|
+
* @property {string} [city]
|
|
162
|
+
* @property {string} [state]
|
|
163
|
+
* @property {string} [country]
|
|
164
|
+
* @property {number} [zip_code]
|
|
165
|
+
* @property {string} [state_code]
|
|
166
|
+
* @property {string} [country_code]
|
|
167
|
+
* @property {string} [gstin]
|
|
168
|
+
* @property {string} [pan]
|
|
169
|
+
* @property {string} [phone_no]
|
|
170
|
+
* @property {string} [cin]
|
|
171
|
+
* @property {string} [website_url]
|
|
172
|
+
* @property {string} [email]
|
|
245
173
|
*/
|
|
246
174
|
/**
|
|
247
|
-
* @typedef
|
|
248
|
-
* @property {
|
|
249
|
-
* @property {
|
|
175
|
+
* @typedef StoreDetail
|
|
176
|
+
* @property {string} [store_name]
|
|
177
|
+
* @property {string} [address]
|
|
178
|
+
* @property {string} [city]
|
|
179
|
+
* @property {string} [state]
|
|
180
|
+
* @property {string} [country]
|
|
181
|
+
* @property {string} [country_code]
|
|
182
|
+
* @property {string} [zip_code]
|
|
183
|
+
* @property {string} [state_code]
|
|
184
|
+
* @property {string} [gstin]
|
|
250
185
|
*/
|
|
251
186
|
/**
|
|
252
|
-
* @typedef
|
|
253
|
-
* @property {Brand} [brand]
|
|
254
|
-
* @property {string} [country_of_origin]
|
|
255
|
-
* @property {number} [discount]
|
|
256
|
-
* @property {string} [hsn_code]
|
|
257
|
-
* @property {string} [item_code]
|
|
258
|
-
* @property {Object} [meta]
|
|
259
|
-
* @property {number} [mrp]
|
|
260
|
-
* @property {string} [name]
|
|
261
|
-
* @property {string} [seller_identifier]
|
|
262
|
-
* @property {string} [size]
|
|
263
|
-
* @property {Tax} [tax]
|
|
264
|
-
* @property {number} [taxable_amount]
|
|
265
|
-
* @property {number} [total]
|
|
266
|
-
* @property {number} [total_taxable_amount]
|
|
267
|
-
* @property {number} [total_units]
|
|
268
|
-
*/
|
|
269
|
-
/**
|
|
270
|
-
* @typedef Kwargs
|
|
271
|
-
* @property {string} [value]
|
|
272
|
-
*/
|
|
273
|
-
/**
|
|
274
|
-
* @typedef KwargsAwbNumber
|
|
275
|
-
* @property {Object[]} [value]
|
|
276
|
-
*/
|
|
277
|
-
/**
|
|
278
|
-
* @typedef KwargsUpiQrcode
|
|
279
|
-
* @property {string} [qr_data]
|
|
280
|
-
* @property {string} [qr_url]
|
|
281
|
-
*/
|
|
282
|
-
/**
|
|
283
|
-
* @typedef Meta
|
|
284
|
-
* @property {MetaProperty} [generator]
|
|
285
|
-
*/
|
|
286
|
-
/**
|
|
287
|
-
* @typedef MetaProperty
|
|
288
|
-
* @property {AwbNumberBarcodeGenerator} [awb_number_barcode_generator]
|
|
289
|
-
* @property {AwbNumberLabelBarcodeGenerator} [awb_number_label_barcode_generator]
|
|
290
|
-
* @property {DigitalsignatureGenerator} [digitalsignature_generator]
|
|
291
|
-
* @property {ShipmentIdBarcodeGenerator} [shipment_id_barcode_generator]
|
|
292
|
-
* @property {SignedQrcodeGenerator} [signed_qrcode_generator]
|
|
293
|
-
* @property {UpiQrcodeGenerator} [upi_qrcode_generator]
|
|
294
|
-
*/
|
|
295
|
-
/**
|
|
296
|
-
* @typedef PaymentData
|
|
297
|
-
* @property {number} [amount]
|
|
298
|
-
* @property {string} [date]
|
|
299
|
-
* @property {Object} [meta]
|
|
300
|
-
* @property {string} [mode]
|
|
187
|
+
* @typedef CustomerBillingDetail
|
|
301
188
|
* @property {string} [name]
|
|
302
|
-
* @property {string} [
|
|
303
|
-
* @property {string} [
|
|
304
|
-
* @property {string} [
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
* @
|
|
308
|
-
* @property {string} [
|
|
309
|
-
* @property {string} [
|
|
310
|
-
* @property {string} [
|
|
311
|
-
* @property {string} [last_name]
|
|
312
|
-
* @property {string} [mobile_number]
|
|
313
|
-
*/
|
|
314
|
-
/**
|
|
315
|
-
* @typedef PaymentReceiptFormat
|
|
316
|
-
* @property {string[]} [payment_receipt]
|
|
317
|
-
*/
|
|
318
|
-
/**
|
|
319
|
-
* @typedef PaymentReceiptMeta
|
|
320
|
-
* @property {string} [action]
|
|
321
|
-
* @property {string[]} [application_id]
|
|
322
|
-
* @property {number} [company_id]
|
|
323
|
-
* @property {number} [created_timestamp]
|
|
324
|
-
* @property {Object} [event]
|
|
325
|
-
* @property {Object} [event_trace_info]
|
|
326
|
-
* @property {PaymentReceiptFormat} [format]
|
|
327
|
-
* @property {string} [job_type]
|
|
328
|
-
* @property {string} [organizaton_id]
|
|
329
|
-
* @property {PaymentReceiptService} [service]
|
|
330
|
-
* @property {string} [trace]
|
|
331
|
-
* @property {string[]} [trace_id]
|
|
332
|
-
*/
|
|
333
|
-
/**
|
|
334
|
-
* @typedef PaymentReceiptOrderDetails
|
|
335
|
-
* @property {number} [final_amount]
|
|
336
|
-
* @property {string} [final_amount_in_words]
|
|
337
|
-
* @property {string} [jiomart_order_id]
|
|
338
|
-
* @property {string} [order_created_date]
|
|
339
|
-
* @property {string} [order_created_time]
|
|
340
|
-
* @property {string} [prm_id]
|
|
341
|
-
* @property {string} [receipt_no]
|
|
342
|
-
* @property {PaymentReceiptTaxes} [taxes]
|
|
343
|
-
* @property {number} [total_items]
|
|
344
|
-
*/
|
|
345
|
-
/**
|
|
346
|
-
* @typedef PaymentReceiptPayload
|
|
347
|
-
* @property {PaymentReceiptCustomerDetails} [customer_detail]
|
|
348
|
-
* @property {PaymentReceiptOrderDetails} [order_detail]
|
|
349
|
-
* @property {PaymentReceiptPayments[]} [payments]
|
|
350
|
-
* @property {string} [uid]
|
|
351
|
-
*/
|
|
352
|
-
/**
|
|
353
|
-
* @typedef PaymentReceiptPayments
|
|
354
|
-
* @property {string} [payment_desc]
|
|
355
|
-
* @property {string} [txn_date]
|
|
356
|
-
*/
|
|
357
|
-
/**
|
|
358
|
-
* @typedef PaymentReceiptRequestBody
|
|
359
|
-
* @property {PaymentReceiptMeta} [meta]
|
|
360
|
-
* @property {PaymentReceiptPayload} [payload]
|
|
189
|
+
* @property {string} [phone_no]
|
|
190
|
+
* @property {string} [address]
|
|
191
|
+
* @property {string} [city]
|
|
192
|
+
* @property {string} [state]
|
|
193
|
+
* @property {string} [country]
|
|
194
|
+
* @property {string} [country_code]
|
|
195
|
+
* @property {string} [zip_code]
|
|
196
|
+
* @property {string} [state_code]
|
|
197
|
+
* @property {string} [gstin]
|
|
361
198
|
*/
|
|
362
199
|
/**
|
|
363
|
-
* @typedef
|
|
200
|
+
* @typedef CustomerShippingDetail
|
|
364
201
|
* @property {string} [name]
|
|
202
|
+
* @property {string} [phone_no]
|
|
203
|
+
* @property {string} [address]
|
|
204
|
+
* @property {string} [city]
|
|
205
|
+
* @property {string} [state]
|
|
206
|
+
* @property {string} [country]
|
|
207
|
+
* @property {string} [country_code]
|
|
208
|
+
* @property {string} [zip_code]
|
|
209
|
+
* @property {string} [state_code]
|
|
210
|
+
* @property {string} [gstin]
|
|
365
211
|
*/
|
|
366
212
|
/**
|
|
367
|
-
* @typedef
|
|
213
|
+
* @typedef ReturnDetail
|
|
214
|
+
* @property {string} [address]
|
|
215
|
+
* @property {string} [city]
|
|
216
|
+
* @property {string} [state]
|
|
217
|
+
* @property {string} [country]
|
|
218
|
+
* @property {string} [country_code]
|
|
219
|
+
* @property {string} [zip_code]
|
|
220
|
+
* @property {string} [state_code]
|
|
368
221
|
* @property {string} [gstin]
|
|
369
|
-
* @property {string} [pancard]
|
|
370
222
|
*/
|
|
371
223
|
/**
|
|
372
|
-
* @typedef
|
|
373
|
-
* @property {string} [
|
|
374
|
-
* @property {
|
|
375
|
-
* @property {string} [template] - This is html template string
|
|
224
|
+
* @typedef Brand
|
|
225
|
+
* @property {string} [logo]
|
|
226
|
+
* @property {string} [name]
|
|
376
227
|
*/
|
|
377
228
|
/**
|
|
378
|
-
* @typedef
|
|
379
|
-
* @property {
|
|
380
|
-
* @property {
|
|
229
|
+
* @typedef Cgst
|
|
230
|
+
* @property {number} [value]
|
|
231
|
+
* @property {number} [percent]
|
|
381
232
|
*/
|
|
382
233
|
/**
|
|
383
|
-
* @typedef
|
|
384
|
-
* @property {number} [
|
|
385
|
-
* @property {
|
|
386
|
-
* @property {string} [application_id]
|
|
387
|
-
* @property {number} [company_id]
|
|
388
|
-
* @property {string} [format]
|
|
389
|
-
* @property {number} [pdf_type_id]
|
|
390
|
-
* @property {string} [template]
|
|
234
|
+
* @typedef Sgst
|
|
235
|
+
* @property {number} [value]
|
|
236
|
+
* @property {number} [percent]
|
|
391
237
|
*/
|
|
392
238
|
/**
|
|
393
|
-
* @typedef
|
|
394
|
-
* @property {
|
|
395
|
-
* @property {
|
|
239
|
+
* @typedef Igst
|
|
240
|
+
* @property {number} [value]
|
|
241
|
+
* @property {number} [percent]
|
|
396
242
|
*/
|
|
397
243
|
/**
|
|
398
|
-
* @typedef
|
|
399
|
-
* @property {
|
|
400
|
-
* @property {
|
|
401
|
-
* @property {
|
|
402
|
-
* @property {number} [company_id]
|
|
403
|
-
* @property {string} [country_code]
|
|
404
|
-
* @property {string} [format]
|
|
405
|
-
* @property {number} [pdf_type_id]
|
|
406
|
-
* @property {string} [template]
|
|
244
|
+
* @typedef Tax
|
|
245
|
+
* @property {Cgst} [cgst]
|
|
246
|
+
* @property {Sgst} [sgst]
|
|
247
|
+
* @property {Igst} [igst]
|
|
407
248
|
*/
|
|
408
249
|
/**
|
|
409
|
-
* @typedef
|
|
410
|
-
* @property {
|
|
411
|
-
* @property {
|
|
250
|
+
* @typedef ItemsProductTable
|
|
251
|
+
* @property {string} [name]
|
|
252
|
+
* @property {string} [seller_identifier]
|
|
253
|
+
* @property {number} [total]
|
|
254
|
+
* @property {Brand} [brand]
|
|
255
|
+
* @property {string} [hsn_code]
|
|
256
|
+
* @property {string} [item_code]
|
|
257
|
+
* @property {number} [total_units]
|
|
258
|
+
* @property {string} [size]
|
|
259
|
+
* @property {number} [mrp]
|
|
260
|
+
* @property {number} [discount]
|
|
261
|
+
* @property {number} [taxable_amount]
|
|
262
|
+
* @property {number} [total_taxable_amount]
|
|
263
|
+
* @property {Tax} [tax]
|
|
412
264
|
*/
|
|
413
265
|
/**
|
|
414
266
|
* @typedef ProductTable
|
|
415
|
-
* @property {number} [
|
|
416
|
-
* @property {
|
|
417
|
-
* @property {
|
|
267
|
+
* @property {number} [total_items]
|
|
268
|
+
* @property {ItemsProductTable[]} [products]
|
|
269
|
+
* @property {number} [grand_total]
|
|
418
270
|
* @property {number} [delivery_charges]
|
|
419
|
-
* @property {
|
|
271
|
+
* @property {string} [delivery_charge_text]
|
|
272
|
+
* @property {number} [cod_charges]
|
|
420
273
|
* @property {number} [fynd_discounts]
|
|
421
|
-
* @property {number} [gift_price]
|
|
422
|
-
* @property {number} [grand_total]
|
|
423
|
-
* @property {ItemsProductTable[]} [products]
|
|
424
|
-
* @property {number} [promotion]
|
|
425
|
-
* @property {number} [reward]
|
|
426
|
-
* @property {number} [round_off]
|
|
427
|
-
* @property {number} [sub_total]
|
|
428
274
|
* @property {string} [total_in_words]
|
|
429
|
-
* @property {number} [total_items]
|
|
430
|
-
* @property {number} [total_quantity]
|
|
431
|
-
* @property {number} [total_value_of_goods]
|
|
432
275
|
*/
|
|
433
276
|
/**
|
|
434
|
-
* @typedef
|
|
435
|
-
* @property {string} [
|
|
436
|
-
* @property {
|
|
437
|
-
* @property {
|
|
438
|
-
* @property {string} [country_code]
|
|
439
|
-
* @property {string} [display_address]
|
|
440
|
-
* @property {string} [sector]
|
|
441
|
-
* @property {string} [state]
|
|
442
|
-
* @property {string} [state_code]
|
|
443
|
-
* @property {number} [zip_code]
|
|
277
|
+
* @typedef Taxes
|
|
278
|
+
* @property {string} [hsn_code]
|
|
279
|
+
* @property {Tax} [tax]
|
|
280
|
+
* @property {number} [total_tax_value]
|
|
444
281
|
*/
|
|
445
282
|
/**
|
|
446
|
-
* @typedef
|
|
283
|
+
* @typedef TaxTable
|
|
284
|
+
* @property {Taxes[]} [taxes]
|
|
285
|
+
* @property {number} [total_tax]
|
|
286
|
+
* @property {string} [tax_in_words]
|
|
287
|
+
*/
|
|
288
|
+
/**
|
|
289
|
+
* @typedef RegisteredCompanyDetail
|
|
447
290
|
* @property {string} [address]
|
|
448
291
|
* @property {string} [city]
|
|
292
|
+
* @property {string} [state]
|
|
449
293
|
* @property {string} [country]
|
|
450
294
|
* @property {string} [country_code]
|
|
451
|
-
* @property {
|
|
452
|
-
* @property {string} [gstin]
|
|
453
|
-
* @property {string} [sector]
|
|
454
|
-
* @property {string} [state]
|
|
295
|
+
* @property {number} [zip_code]
|
|
455
296
|
* @property {string} [state_code]
|
|
456
|
-
* @property {string} [zip_code]
|
|
457
297
|
*/
|
|
458
298
|
/**
|
|
459
|
-
* @typedef
|
|
460
|
-
* @property {
|
|
461
|
-
* @property {number} [value]
|
|
299
|
+
* @typedef Kwargs
|
|
300
|
+
* @property {string} [value]
|
|
462
301
|
*/
|
|
463
302
|
/**
|
|
464
303
|
* @typedef ShipmentIdBarcodeGenerator
|
|
465
|
-
* @property {Kwargs} [kwargs]
|
|
466
304
|
* @property {string} [method]
|
|
305
|
+
* @property {Kwargs} [kwargs]
|
|
467
306
|
*/
|
|
468
307
|
/**
|
|
469
308
|
* @typedef SignedQrcodeGenerator
|
|
470
|
-
* @property {Kwargs} [kwargs]
|
|
471
309
|
* @property {string} [method]
|
|
310
|
+
* @property {Kwargs} [kwargs]
|
|
472
311
|
*/
|
|
473
312
|
/**
|
|
474
|
-
* @typedef
|
|
475
|
-
* @property {
|
|
476
|
-
* @property {string[]
|
|
313
|
+
* @typedef KwargsUpiQrcode
|
|
314
|
+
* @property {string} [qr_data]
|
|
315
|
+
* @property {string} [qr_url]
|
|
477
316
|
*/
|
|
478
317
|
/**
|
|
479
|
-
* @typedef
|
|
480
|
-
* @property {
|
|
318
|
+
* @typedef UpiQrcodeGenerator
|
|
319
|
+
* @property {string} [method]
|
|
320
|
+
* @property {KwargsUpiQrcode} [kwargs]
|
|
481
321
|
*/
|
|
482
322
|
/**
|
|
483
|
-
* @typedef
|
|
484
|
-
* @property {string}
|
|
485
|
-
* @property {
|
|
486
|
-
* @property {Object} [params]
|
|
487
|
-
* @property {number} size
|
|
488
|
-
* @property {string[]} [tags]
|
|
323
|
+
* @typedef DigitalsignatureGenerator
|
|
324
|
+
* @property {string} [method]
|
|
325
|
+
* @property {Kwargs} [kwargs]
|
|
489
326
|
*/
|
|
490
327
|
/**
|
|
491
|
-
* @typedef
|
|
492
|
-
* @property {
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
* @
|
|
328
|
+
* @typedef KwargsAwbNumber
|
|
329
|
+
* @property {Object[]} [value]
|
|
330
|
+
*/
|
|
331
|
+
/**
|
|
332
|
+
* @typedef AwbNumberLabelBarcodeGenerator
|
|
496
333
|
* @property {string} [method]
|
|
497
|
-
* @property {
|
|
498
|
-
* @property {string} operation
|
|
499
|
-
* @property {number} size
|
|
500
|
-
* @property {string[]} [tags]
|
|
501
|
-
* @property {Upload} upload
|
|
334
|
+
* @property {KwargsAwbNumber} [kwargs]
|
|
502
335
|
*/
|
|
503
336
|
/**
|
|
504
|
-
* @typedef
|
|
505
|
-
* @property {
|
|
506
|
-
* @property {
|
|
507
|
-
* @property {
|
|
337
|
+
* @typedef MetaProperty
|
|
338
|
+
* @property {ShipmentIdBarcodeGenerator} [shipment_id_barcode_generator]
|
|
339
|
+
* @property {SignedQrcodeGenerator} [signed_qrcode_generator]
|
|
340
|
+
* @property {UpiQrcodeGenerator} [upi_qrcode_generator]
|
|
341
|
+
* @property {DigitalsignatureGenerator} [digitalsignature_generator]
|
|
342
|
+
* @property {AwbNumberLabelBarcodeGenerator} [awb_number_label_barcode_generator]
|
|
343
|
+
*/
|
|
344
|
+
/**
|
|
345
|
+
* @typedef Meta
|
|
346
|
+
* @property {MetaProperty} [generator]
|
|
347
|
+
*/
|
|
348
|
+
/**
|
|
349
|
+
* @typedef DummyTemplateDataPayload
|
|
350
|
+
* @property {boolean} [is_international]
|
|
351
|
+
* @property {string} [app_domain_name]
|
|
352
|
+
* @property {ConversionRate} [conversion_rate]
|
|
353
|
+
* @property {string} [currency_code]
|
|
354
|
+
* @property {string} [shipment_id]
|
|
355
|
+
* @property {DeliveryPartnerDetail} [delivery_partner_detail]
|
|
356
|
+
* @property {Image} [image]
|
|
357
|
+
* @property {PaymentData[]} [payments]
|
|
358
|
+
* @property {InvoiceDetail} [invoice_detail]
|
|
359
|
+
* @property {CompanyDetail} [company_detail]
|
|
360
|
+
* @property {StoreDetail} [store_detail]
|
|
361
|
+
* @property {CustomerBillingDetail} [customer_billing_detail]
|
|
362
|
+
* @property {CustomerShippingDetail} [customer_shipping_detail]
|
|
363
|
+
* @property {ReturnDetail} [return_detail]
|
|
364
|
+
* @property {ProductTable} [product_table]
|
|
365
|
+
* @property {TaxTable} [tax_table]
|
|
366
|
+
* @property {string[]} [declaration_texts]
|
|
367
|
+
* @property {RegisteredCompanyDetail} [registered_company_detail]
|
|
368
|
+
* @property {string} [disclaimer]
|
|
369
|
+
* @property {Meta} [meta]
|
|
370
|
+
* @property {boolean} [is_self_ship]
|
|
371
|
+
* @property {string} [mode]
|
|
372
|
+
* @property {boolean} [is_self_pickup]
|
|
373
|
+
* @property {string} [platform_name]
|
|
374
|
+
* @property {number} [amount_to_be_collected]
|
|
375
|
+
* @property {number} [amount_paid]
|
|
376
|
+
* @property {Object[]} [waybills]
|
|
377
|
+
* @property {number} [total_items]
|
|
378
|
+
* @property {string} [brand_logo]
|
|
379
|
+
* @property {string} [shipment_id_barcode]
|
|
380
|
+
* @property {string} [signed_qrcode]
|
|
381
|
+
* @property {string} [upi_qrcode]
|
|
382
|
+
* @property {string} [digitalsignature]
|
|
383
|
+
* @property {string} [awb_number_barcode]
|
|
384
|
+
* @property {string} [uid]
|
|
385
|
+
*/
|
|
386
|
+
/**
|
|
387
|
+
* @typedef DummyTemplateData
|
|
388
|
+
* @property {string} [_id]
|
|
389
|
+
* @property {number} [pdf_type_id]
|
|
390
|
+
* @property {DummyTemplateDataPayload} payload
|
|
391
|
+
* @property {number} [__v]
|
|
392
|
+
*/
|
|
393
|
+
/**
|
|
394
|
+
* @typedef DummyTemplateDataItems
|
|
395
|
+
* @property {DummyTemplateData[]} data
|
|
396
|
+
* @property {boolean} success
|
|
397
|
+
*/
|
|
398
|
+
/**
|
|
399
|
+
* @typedef PdfConfig
|
|
400
|
+
* @property {string} [format] - This is invoice document format such as A4, A6, POS
|
|
401
|
+
* @property {string} [template] - This is html template string
|
|
402
|
+
* @property {number} [pdf_type_id]
|
|
403
|
+
*/
|
|
404
|
+
/**
|
|
405
|
+
* @typedef PdfConfigSuccessData
|
|
406
|
+
* @property {string} [_id]
|
|
407
|
+
* @property {number} [company_id]
|
|
408
|
+
* @property {string} [application_id]
|
|
409
|
+
* @property {number} [pdf_type_id]
|
|
410
|
+
* @property {string} [format]
|
|
411
|
+
* @property {string} [template]
|
|
412
|
+
* @property {number} [__v]
|
|
508
413
|
* @property {string} [country_code]
|
|
509
|
-
* @property {string} [display_address]
|
|
510
|
-
* @property {string} [gstin]
|
|
511
|
-
* @property {string} [sector]
|
|
512
|
-
* @property {string} [state]
|
|
513
|
-
* @property {string} [state_code]
|
|
514
|
-
* @property {string} [store_id]
|
|
515
|
-
* @property {string} [store_name]
|
|
516
|
-
* @property {string} [zip_code]
|
|
517
414
|
*/
|
|
518
415
|
/**
|
|
519
|
-
* @typedef
|
|
520
|
-
* @property {
|
|
521
|
-
* @property {
|
|
522
|
-
* @property {Sgst} [sgst]
|
|
416
|
+
* @typedef PdfConfigSuccess
|
|
417
|
+
* @property {PdfConfigSuccessData[]} [data]
|
|
418
|
+
* @property {boolean} [success]
|
|
523
419
|
*/
|
|
524
420
|
/**
|
|
525
|
-
* @typedef
|
|
526
|
-
* @property {string} [
|
|
527
|
-
* @property {
|
|
528
|
-
* @property {
|
|
421
|
+
* @typedef PdfConfigSaveSuccessData
|
|
422
|
+
* @property {string} [_id]
|
|
423
|
+
* @property {number} [company_id]
|
|
424
|
+
* @property {string} [application_id]
|
|
425
|
+
* @property {number} [pdf_type_id]
|
|
426
|
+
* @property {string} [format]
|
|
427
|
+
* @property {string} [template]
|
|
428
|
+
* @property {number} [__v]
|
|
529
429
|
*/
|
|
530
430
|
/**
|
|
531
|
-
* @typedef
|
|
532
|
-
* @property {
|
|
533
|
-
* @property {
|
|
534
|
-
* @property {number} [total_tax]
|
|
431
|
+
* @typedef PdfConfigSaveSuccess
|
|
432
|
+
* @property {PdfConfigSaveSuccessData} [data]
|
|
433
|
+
* @property {boolean} [success]
|
|
535
434
|
*/
|
|
536
435
|
/**
|
|
537
|
-
* @typedef
|
|
538
|
-
* @property {
|
|
539
|
-
* @property {
|
|
436
|
+
* @typedef PdfDefaultTemplateSuccess
|
|
437
|
+
* @property {Document[]} [data]
|
|
438
|
+
* @property {boolean} [success] - Indicates if the request was successful.
|
|
540
439
|
*/
|
|
541
440
|
/**
|
|
542
|
-
* @typedef
|
|
543
|
-
* @property {
|
|
544
|
-
* @property {
|
|
441
|
+
* @typedef Document
|
|
442
|
+
* @property {string} [_id]
|
|
443
|
+
* @property {number} [pdf_type_id]
|
|
444
|
+
* @property {string} [format]
|
|
445
|
+
* @property {string} [template]
|
|
446
|
+
* @property {string} [country_code]
|
|
447
|
+
* @property {number} [__v]
|
|
545
448
|
*/
|
|
546
449
|
/**
|
|
547
|
-
* @typedef
|
|
548
|
-
* @property {
|
|
549
|
-
* @property {
|
|
550
|
-
|
|
450
|
+
* @typedef PaymentReceiptRequestBody
|
|
451
|
+
* @property {PaymentReceiptPayload} [payload]
|
|
452
|
+
* @property {PaymentReceiptMeta} [meta]
|
|
453
|
+
*/
|
|
454
|
+
/**
|
|
455
|
+
* @typedef PaymentReceiptOrderDetails
|
|
456
|
+
* @property {string} [jiomart_order_id]
|
|
457
|
+
* @property {number} [total_items]
|
|
458
|
+
* @property {number} [final_amount]
|
|
459
|
+
* @property {string} [final_amount_in_words]
|
|
460
|
+
* @property {string} [order_created_date]
|
|
461
|
+
* @property {string} [order_created_time]
|
|
462
|
+
* @property {string} [prm_id]
|
|
463
|
+
* @property {string} [receipt_no]
|
|
464
|
+
* @property {PaymentReceiptTaxes} [taxes]
|
|
465
|
+
*/
|
|
466
|
+
/**
|
|
467
|
+
* @typedef PaymentReceiptCustomerDetails
|
|
468
|
+
* @property {string} [id]
|
|
469
|
+
* @property {string} [email_id]
|
|
470
|
+
* @property {string} [last_name]
|
|
471
|
+
* @property {string} [first_name]
|
|
472
|
+
* @property {string} [mobile_number]
|
|
473
|
+
*/
|
|
474
|
+
/**
|
|
475
|
+
* @typedef PaymentReceiptPayments
|
|
476
|
+
* @property {string} [payment_desc]
|
|
477
|
+
* @property {string} [txn_date]
|
|
478
|
+
*/
|
|
479
|
+
/**
|
|
480
|
+
* @typedef PaymentReceiptFormat
|
|
481
|
+
* @property {string[]} [payment_receipt]
|
|
482
|
+
*/
|
|
483
|
+
/**
|
|
484
|
+
* @typedef PaymentReceiptService
|
|
485
|
+
* @property {string} [name]
|
|
486
|
+
*/
|
|
487
|
+
/**
|
|
488
|
+
* @typedef PaymentReceiptTaxes
|
|
489
|
+
* @property {string} [gstin]
|
|
490
|
+
* @property {string} [pancard]
|
|
491
|
+
*/
|
|
492
|
+
/**
|
|
493
|
+
* @typedef PaymentReceiptPayload
|
|
494
|
+
* @property {string} [uid]
|
|
495
|
+
* @property {PaymentReceiptOrderDetails} [order_detail]
|
|
496
|
+
* @property {PaymentReceiptCustomerDetails} [customer_detail]
|
|
497
|
+
* @property {PaymentReceiptPayments[]} [payments]
|
|
498
|
+
*/
|
|
499
|
+
/**
|
|
500
|
+
* @typedef PaymentReceiptMeta
|
|
501
|
+
* @property {string} [job_type]
|
|
502
|
+
* @property {string} [action]
|
|
503
|
+
* @property {Object} [event]
|
|
504
|
+
* @property {string} [organizaton_id]
|
|
505
|
+
* @property {number} [company_id]
|
|
506
|
+
* @property {string[]} [application_id]
|
|
507
|
+
* @property {PaymentReceiptFormat} [format]
|
|
508
|
+
* @property {string[]} [trace_id]
|
|
509
|
+
* @property {number} [created_timestamp]
|
|
510
|
+
* @property {PaymentReceiptService} [service]
|
|
511
|
+
* @property {Object} [event_trace_info]
|
|
512
|
+
* @property {string} [trace]
|
|
551
513
|
*/
|
|
552
514
|
declare class FileStoragePlatformModel {
|
|
553
515
|
}
|
|
554
516
|
declare namespace FileStoragePlatformModel {
|
|
555
|
-
export {
|
|
517
|
+
export { FailedResponse, CDN, Upload, StartResponse, Params, StartRequest, CreatedBy, CompleteResponse, DestinationNamespace, CopyFiles, Urls, SignUrlResponse, SignUrlRequest, InvoiceTypesDataResponse, InvoiceTypesResponse, Inr, Usd, Rates, ConversionRate, DeliveryPartnerDetail, Image, PaymentData, InvoiceDetail, CompanyDetail, StoreDetail, CustomerBillingDetail, CustomerShippingDetail, ReturnDetail, Brand, Cgst, Sgst, Igst, Tax, ItemsProductTable, ProductTable, Taxes, TaxTable, RegisteredCompanyDetail, Kwargs, ShipmentIdBarcodeGenerator, SignedQrcodeGenerator, KwargsUpiQrcode, UpiQrcodeGenerator, DigitalsignatureGenerator, KwargsAwbNumber, AwbNumberLabelBarcodeGenerator, MetaProperty, Meta, DummyTemplateDataPayload, DummyTemplateData, DummyTemplateDataItems, PdfConfig, PdfConfigSuccessData, PdfConfigSuccess, PdfConfigSaveSuccessData, PdfConfigSaveSuccess, PdfDefaultTemplateSuccess, Document, PaymentReceiptRequestBody, PaymentReceiptOrderDetails, PaymentReceiptCustomerDetails, PaymentReceiptPayments, PaymentReceiptFormat, PaymentReceiptService, PaymentReceiptTaxes, PaymentReceiptPayload, PaymentReceiptMeta };
|
|
556
518
|
}
|
|
557
|
-
/** @returns {
|
|
558
|
-
declare function
|
|
559
|
-
type
|
|
560
|
-
|
|
561
|
-
method?: string;
|
|
562
|
-
};
|
|
563
|
-
/** @returns {AwbNumberLabelBarcodeGenerator} */
|
|
564
|
-
declare function AwbNumberLabelBarcodeGenerator(): AwbNumberLabelBarcodeGenerator;
|
|
565
|
-
type AwbNumberLabelBarcodeGenerator = {
|
|
566
|
-
kwargs?: KwargsAwbNumber;
|
|
567
|
-
method?: string;
|
|
568
|
-
};
|
|
569
|
-
/** @returns {Brand} */
|
|
570
|
-
declare function Brand(): Brand;
|
|
571
|
-
type Brand = {
|
|
572
|
-
logo?: string;
|
|
573
|
-
name?: string;
|
|
519
|
+
/** @returns {FailedResponse} */
|
|
520
|
+
declare function FailedResponse(): FailedResponse;
|
|
521
|
+
type FailedResponse = {
|
|
522
|
+
message: string;
|
|
574
523
|
};
|
|
575
524
|
/** @returns {CDN} */
|
|
576
525
|
declare function CDN(): CDN;
|
|
577
526
|
type CDN = {
|
|
527
|
+
url: string;
|
|
578
528
|
absolute_url: string;
|
|
579
529
|
relative_url: string;
|
|
530
|
+
};
|
|
531
|
+
/** @returns {Upload} */
|
|
532
|
+
declare function Upload(): Upload;
|
|
533
|
+
type Upload = {
|
|
534
|
+
expiry: number;
|
|
580
535
|
url: string;
|
|
581
536
|
};
|
|
582
|
-
/** @returns {
|
|
583
|
-
declare function
|
|
584
|
-
type
|
|
585
|
-
|
|
586
|
-
|
|
537
|
+
/** @returns {StartResponse} */
|
|
538
|
+
declare function StartResponse(): StartResponse;
|
|
539
|
+
type StartResponse = {
|
|
540
|
+
file_name: string;
|
|
541
|
+
file_path: string;
|
|
542
|
+
content_type: string;
|
|
543
|
+
method?: string;
|
|
544
|
+
namespace: string;
|
|
545
|
+
operation: string;
|
|
546
|
+
size: number;
|
|
547
|
+
upload: Upload;
|
|
548
|
+
cdn: CDN;
|
|
549
|
+
tags?: string[];
|
|
587
550
|
};
|
|
588
|
-
/** @returns {
|
|
589
|
-
declare function
|
|
590
|
-
type
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
vat?: string;
|
|
610
|
-
website_url?: string;
|
|
611
|
-
zip_code?: number;
|
|
551
|
+
/** @returns {Params} */
|
|
552
|
+
declare function Params(): Params;
|
|
553
|
+
type Params = {
|
|
554
|
+
/**
|
|
555
|
+
* - The subpath for the file.
|
|
556
|
+
*/
|
|
557
|
+
subpath?: string;
|
|
558
|
+
};
|
|
559
|
+
/** @returns {StartRequest} */
|
|
560
|
+
declare function StartRequest(): StartRequest;
|
|
561
|
+
type StartRequest = {
|
|
562
|
+
file_name: string;
|
|
563
|
+
content_type: string;
|
|
564
|
+
size: number;
|
|
565
|
+
tags?: string[];
|
|
566
|
+
params?: Params;
|
|
567
|
+
};
|
|
568
|
+
/** @returns {CreatedBy} */
|
|
569
|
+
declare function CreatedBy(): CreatedBy;
|
|
570
|
+
type CreatedBy = {
|
|
571
|
+
username?: string;
|
|
612
572
|
};
|
|
613
573
|
/** @returns {CompleteResponse} */
|
|
614
574
|
declare function CompleteResponse(): CompleteResponse;
|
|
615
575
|
type CompleteResponse = {
|
|
616
576
|
_id: string;
|
|
617
|
-
cdn: CDN;
|
|
618
|
-
company_id: number;
|
|
619
|
-
content_type: string;
|
|
620
|
-
created_by?: CreatedBy;
|
|
621
|
-
created_on: string;
|
|
622
577
|
file_name: string;
|
|
623
578
|
file_path: string;
|
|
624
|
-
|
|
579
|
+
content_type: string;
|
|
625
580
|
namespace: string;
|
|
626
581
|
operation: string;
|
|
582
|
+
company_id: number;
|
|
627
583
|
size: number;
|
|
584
|
+
upload: Upload;
|
|
585
|
+
cdn: CDN;
|
|
628
586
|
success: boolean;
|
|
629
587
|
tags?: string[];
|
|
630
|
-
|
|
588
|
+
created_on: string;
|
|
589
|
+
modified_on: string;
|
|
590
|
+
created_by?: CreatedBy;
|
|
591
|
+
};
|
|
592
|
+
/** @returns {DestinationNamespace} */
|
|
593
|
+
declare function DestinationNamespace(): DestinationNamespace;
|
|
594
|
+
type DestinationNamespace = {
|
|
595
|
+
namespace?: string;
|
|
596
|
+
};
|
|
597
|
+
/** @returns {CopyFiles} */
|
|
598
|
+
declare function CopyFiles(): CopyFiles;
|
|
599
|
+
type CopyFiles = {
|
|
600
|
+
urls?: string[];
|
|
601
|
+
destination: DestinationNamespace;
|
|
602
|
+
};
|
|
603
|
+
/** @returns {Urls} */
|
|
604
|
+
declare function Urls(): Urls;
|
|
605
|
+
type Urls = {
|
|
606
|
+
url: string;
|
|
607
|
+
signed_url: string;
|
|
608
|
+
expiry: number;
|
|
609
|
+
};
|
|
610
|
+
/** @returns {SignUrlResponse} */
|
|
611
|
+
declare function SignUrlResponse(): SignUrlResponse;
|
|
612
|
+
type SignUrlResponse = {
|
|
613
|
+
urls: Urls[];
|
|
614
|
+
};
|
|
615
|
+
/** @returns {SignUrlRequest} */
|
|
616
|
+
declare function SignUrlRequest(): SignUrlRequest;
|
|
617
|
+
type SignUrlRequest = {
|
|
618
|
+
expiry: number;
|
|
619
|
+
urls: string[];
|
|
620
|
+
};
|
|
621
|
+
/** @returns {InvoiceTypesDataResponse} */
|
|
622
|
+
declare function InvoiceTypesDataResponse(): InvoiceTypesDataResponse;
|
|
623
|
+
type InvoiceTypesDataResponse = {
|
|
624
|
+
status?: boolean;
|
|
625
|
+
_id: string;
|
|
626
|
+
pdf_type_id: number;
|
|
627
|
+
name: string;
|
|
628
|
+
format: string[];
|
|
629
|
+
__v: number;
|
|
630
|
+
visibility: boolean;
|
|
631
|
+
country_code?: string;
|
|
632
|
+
};
|
|
633
|
+
/** @returns {InvoiceTypesResponse} */
|
|
634
|
+
declare function InvoiceTypesResponse(): InvoiceTypesResponse;
|
|
635
|
+
type InvoiceTypesResponse = {
|
|
636
|
+
data: InvoiceTypesDataResponse[];
|
|
637
|
+
success: boolean;
|
|
638
|
+
};
|
|
639
|
+
/** @returns {Inr} */
|
|
640
|
+
declare function Inr(): Inr;
|
|
641
|
+
type Inr = {
|
|
642
|
+
name?: string;
|
|
643
|
+
value?: number;
|
|
644
|
+
symbol?: string;
|
|
645
|
+
sub_unit?: string;
|
|
646
|
+
};
|
|
647
|
+
/** @returns {Usd} */
|
|
648
|
+
declare function Usd(): Usd;
|
|
649
|
+
type Usd = {
|
|
650
|
+
name?: string;
|
|
651
|
+
value?: number;
|
|
652
|
+
symbol?: string;
|
|
653
|
+
sub_unit?: string;
|
|
654
|
+
};
|
|
655
|
+
/** @returns {Rates} */
|
|
656
|
+
declare function Rates(): Rates;
|
|
657
|
+
type Rates = {
|
|
658
|
+
inr?: Inr;
|
|
659
|
+
usd?: Usd;
|
|
631
660
|
};
|
|
632
661
|
/** @returns {ConversionRate} */
|
|
633
662
|
declare function ConversionRate(): ConversionRate;
|
|
634
663
|
type ConversionRate = {
|
|
635
664
|
base?: string;
|
|
636
|
-
rates?:
|
|
665
|
+
rates?: Rates;
|
|
637
666
|
timestamp?: number;
|
|
638
667
|
};
|
|
639
|
-
/** @returns {
|
|
640
|
-
declare function
|
|
641
|
-
type
|
|
642
|
-
|
|
643
|
-
|
|
668
|
+
/** @returns {DeliveryPartnerDetail} */
|
|
669
|
+
declare function DeliveryPartnerDetail(): DeliveryPartnerDetail;
|
|
670
|
+
type DeliveryPartnerDetail = {
|
|
671
|
+
name?: string;
|
|
672
|
+
awb_number_barcode?: string;
|
|
673
|
+
awb_number?: string;
|
|
674
|
+
eway_bill_number?: string;
|
|
644
675
|
};
|
|
645
|
-
/** @returns {
|
|
646
|
-
declare function
|
|
647
|
-
type
|
|
648
|
-
|
|
676
|
+
/** @returns {Image} */
|
|
677
|
+
declare function Image(): Image;
|
|
678
|
+
type Image = {
|
|
679
|
+
sales_channel_logo?: string;
|
|
649
680
|
};
|
|
650
|
-
/** @returns {
|
|
651
|
-
declare function
|
|
652
|
-
type
|
|
681
|
+
/** @returns {PaymentData} */
|
|
682
|
+
declare function PaymentData(): PaymentData;
|
|
683
|
+
type PaymentData = {
|
|
684
|
+
payment_type?: string;
|
|
685
|
+
amount?: number;
|
|
686
|
+
date?: string;
|
|
687
|
+
transaction_id?: string;
|
|
688
|
+
};
|
|
689
|
+
/** @returns {InvoiceDetail} */
|
|
690
|
+
declare function InvoiceDetail(): InvoiceDetail;
|
|
691
|
+
type InvoiceDetail = {
|
|
692
|
+
invoice_id?: string;
|
|
693
|
+
invoice_date?: string;
|
|
694
|
+
irn?: string;
|
|
695
|
+
external_order_id?: string;
|
|
696
|
+
shipment_id?: string;
|
|
697
|
+
signed_qrcode?: string;
|
|
698
|
+
upi_qrcode?: string;
|
|
699
|
+
};
|
|
700
|
+
/** @returns {CompanyDetail} */
|
|
701
|
+
declare function CompanyDetail(): CompanyDetail;
|
|
702
|
+
type CompanyDetail = {
|
|
703
|
+
name?: string;
|
|
653
704
|
address?: string;
|
|
654
705
|
city?: string;
|
|
706
|
+
state?: string;
|
|
655
707
|
country?: string;
|
|
708
|
+
zip_code?: number;
|
|
709
|
+
state_code?: string;
|
|
656
710
|
country_code?: string;
|
|
657
|
-
|
|
711
|
+
gstin?: string;
|
|
712
|
+
pan?: string;
|
|
713
|
+
phone_no?: string;
|
|
714
|
+
cin?: string;
|
|
715
|
+
website_url?: string;
|
|
658
716
|
email?: string;
|
|
717
|
+
};
|
|
718
|
+
/** @returns {StoreDetail} */
|
|
719
|
+
declare function StoreDetail(): StoreDetail;
|
|
720
|
+
type StoreDetail = {
|
|
721
|
+
store_name?: string;
|
|
722
|
+
address?: string;
|
|
723
|
+
city?: string;
|
|
724
|
+
state?: string;
|
|
725
|
+
country?: string;
|
|
726
|
+
country_code?: string;
|
|
727
|
+
zip_code?: string;
|
|
728
|
+
state_code?: string;
|
|
659
729
|
gstin?: string;
|
|
730
|
+
};
|
|
731
|
+
/** @returns {CustomerBillingDetail} */
|
|
732
|
+
declare function CustomerBillingDetail(): CustomerBillingDetail;
|
|
733
|
+
type CustomerBillingDetail = {
|
|
660
734
|
name?: string;
|
|
661
735
|
phone_no?: string;
|
|
662
|
-
|
|
736
|
+
address?: string;
|
|
737
|
+
city?: string;
|
|
663
738
|
state?: string;
|
|
664
|
-
|
|
739
|
+
country?: string;
|
|
740
|
+
country_code?: string;
|
|
665
741
|
zip_code?: string;
|
|
742
|
+
state_code?: string;
|
|
743
|
+
gstin?: string;
|
|
666
744
|
};
|
|
667
745
|
/** @returns {CustomerShippingDetail} */
|
|
668
746
|
declare function CustomerShippingDetail(): CustomerShippingDetail;
|
|
669
747
|
type CustomerShippingDetail = {
|
|
748
|
+
name?: string;
|
|
749
|
+
phone_no?: string;
|
|
670
750
|
address?: string;
|
|
671
751
|
city?: string;
|
|
752
|
+
state?: string;
|
|
672
753
|
country?: string;
|
|
673
754
|
country_code?: string;
|
|
674
|
-
|
|
755
|
+
zip_code?: string;
|
|
756
|
+
state_code?: string;
|
|
675
757
|
gstin?: string;
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
758
|
+
};
|
|
759
|
+
/** @returns {ReturnDetail} */
|
|
760
|
+
declare function ReturnDetail(): ReturnDetail;
|
|
761
|
+
type ReturnDetail = {
|
|
762
|
+
address?: string;
|
|
763
|
+
city?: string;
|
|
679
764
|
state?: string;
|
|
680
|
-
|
|
765
|
+
country?: string;
|
|
766
|
+
country_code?: string;
|
|
681
767
|
zip_code?: string;
|
|
768
|
+
state_code?: string;
|
|
769
|
+
gstin?: string;
|
|
682
770
|
};
|
|
683
|
-
/** @returns {
|
|
684
|
-
declare function
|
|
685
|
-
type
|
|
686
|
-
|
|
687
|
-
awb_number_barcode?: string;
|
|
688
|
-
destination?: string;
|
|
689
|
-
eway_bill_number?: string;
|
|
771
|
+
/** @returns {Brand} */
|
|
772
|
+
declare function Brand(): Brand;
|
|
773
|
+
type Brand = {
|
|
774
|
+
logo?: string;
|
|
690
775
|
name?: string;
|
|
691
|
-
origin?: string;
|
|
692
|
-
};
|
|
693
|
-
/** @returns {DestinationNamespace} */
|
|
694
|
-
declare function DestinationNamespace(): DestinationNamespace;
|
|
695
|
-
type DestinationNamespace = {
|
|
696
|
-
namespace?: string;
|
|
697
|
-
};
|
|
698
|
-
/** @returns {DigitalsignatureGenerator} */
|
|
699
|
-
declare function DigitalsignatureGenerator(): DigitalsignatureGenerator;
|
|
700
|
-
type DigitalsignatureGenerator = {
|
|
701
|
-
kwargs?: Kwargs;
|
|
702
|
-
method?: string;
|
|
703
|
-
};
|
|
704
|
-
/** @returns {Document} */
|
|
705
|
-
declare function Document(): Document;
|
|
706
|
-
type Document = {
|
|
707
|
-
__v?: number;
|
|
708
|
-
_id?: string;
|
|
709
|
-
country_code?: string;
|
|
710
|
-
format?: string;
|
|
711
|
-
pdf_type_id?: number;
|
|
712
|
-
template?: string;
|
|
713
|
-
};
|
|
714
|
-
/** @returns {DummyTemplateData} */
|
|
715
|
-
declare function DummyTemplateData(): DummyTemplateData;
|
|
716
|
-
type DummyTemplateData = {
|
|
717
|
-
__v?: number;
|
|
718
|
-
_id?: string;
|
|
719
|
-
country_code?: string;
|
|
720
|
-
payload: DummyTemplateDataPayload;
|
|
721
|
-
pdf_type_id?: number;
|
|
722
|
-
};
|
|
723
|
-
/** @returns {DummyTemplateDataItems} */
|
|
724
|
-
declare function DummyTemplateDataItems(): DummyTemplateDataItems;
|
|
725
|
-
type DummyTemplateDataItems = {
|
|
726
|
-
data: DummyTemplateData[];
|
|
727
|
-
success: boolean;
|
|
728
|
-
};
|
|
729
|
-
/** @returns {DummyTemplateDataPayload} */
|
|
730
|
-
declare function DummyTemplateDataPayload(): DummyTemplateDataPayload;
|
|
731
|
-
type DummyTemplateDataPayload = {
|
|
732
|
-
amount_paid?: number;
|
|
733
|
-
amount_to_be_collected?: number;
|
|
734
|
-
app_domain_name?: string;
|
|
735
|
-
awb_number_barcode?: string;
|
|
736
|
-
b2b_buyer_details?: any;
|
|
737
|
-
brand_logo?: string;
|
|
738
|
-
company_detail?: CompanyDetail;
|
|
739
|
-
conversion_rate?: ConversionRate;
|
|
740
|
-
credit_note_id?: string;
|
|
741
|
-
currency_code?: string;
|
|
742
|
-
current_date?: string;
|
|
743
|
-
customer_billing_detail?: CustomerBillingDetail;
|
|
744
|
-
customer_shipping_detail?: CustomerShippingDetail;
|
|
745
|
-
declaration_texts?: string[];
|
|
746
|
-
delivery_partner_detail?: DeliveryPartnerDetail;
|
|
747
|
-
digitalsignature?: string;
|
|
748
|
-
disclaimer?: string;
|
|
749
|
-
image?: Image;
|
|
750
|
-
invoice_detail?: InvoiceDetail;
|
|
751
|
-
is_export?: boolean;
|
|
752
|
-
is_export_shipment?: boolean;
|
|
753
|
-
is_qwik?: any;
|
|
754
|
-
is_self_pickup?: boolean;
|
|
755
|
-
is_self_ship?: boolean;
|
|
756
|
-
meta?: Meta;
|
|
757
|
-
mode?: string;
|
|
758
|
-
order_type?: string;
|
|
759
|
-
payments?: PaymentData[];
|
|
760
|
-
platform_name?: string;
|
|
761
|
-
po_number?: string;
|
|
762
|
-
product_table?: ProductTable;
|
|
763
|
-
registered_company_detail?: RegisteredCompanyDetail;
|
|
764
|
-
return_detail?: ReturnDetail;
|
|
765
|
-
shipment_id?: string;
|
|
766
|
-
shipment_id_barcode?: string;
|
|
767
|
-
signed_qrcode?: string;
|
|
768
|
-
store_detail?: StoreDetail;
|
|
769
|
-
tax_table?: TaxTable;
|
|
770
|
-
total_items?: number;
|
|
771
|
-
total_value_of_goods?: number;
|
|
772
|
-
txn_id?: string;
|
|
773
|
-
uid?: string;
|
|
774
|
-
upi_qrcode?: string;
|
|
775
|
-
utr?: string;
|
|
776
|
-
waybills?: any[];
|
|
777
|
-
};
|
|
778
|
-
/** @returns {ExtensionSlug} */
|
|
779
|
-
declare function ExtensionSlug(): ExtensionSlug;
|
|
780
|
-
type ExtensionSlug = {
|
|
781
|
-
extension_slug?: string;
|
|
782
776
|
};
|
|
783
|
-
/** @returns {
|
|
784
|
-
declare function
|
|
785
|
-
type
|
|
786
|
-
|
|
777
|
+
/** @returns {Cgst} */
|
|
778
|
+
declare function Cgst(): Cgst;
|
|
779
|
+
type Cgst = {
|
|
780
|
+
value?: number;
|
|
781
|
+
percent?: number;
|
|
782
|
+
};
|
|
783
|
+
/** @returns {Sgst} */
|
|
784
|
+
declare function Sgst(): Sgst;
|
|
785
|
+
type Sgst = {
|
|
786
|
+
value?: number;
|
|
787
|
+
percent?: number;
|
|
787
788
|
};
|
|
788
789
|
/** @returns {Igst} */
|
|
789
790
|
declare function Igst(): Igst;
|
|
790
791
|
type Igst = {
|
|
791
|
-
percent?: number;
|
|
792
792
|
value?: number;
|
|
793
|
+
percent?: number;
|
|
793
794
|
};
|
|
794
|
-
/** @returns {
|
|
795
|
-
declare function
|
|
796
|
-
type
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
declare function InvoiceDetail(): InvoiceDetail;
|
|
801
|
-
type InvoiceDetail = {
|
|
802
|
-
channel_order_id?: string;
|
|
803
|
-
device_id?: string;
|
|
804
|
-
external_order_id?: string;
|
|
805
|
-
invoice_date?: string;
|
|
806
|
-
invoice_id?: string;
|
|
807
|
-
irn?: string;
|
|
808
|
-
marketplace_invoice_id?: string;
|
|
809
|
-
marketplace_shipment_id?: string;
|
|
810
|
-
shipment_id?: string;
|
|
811
|
-
signed_qrcode?: string;
|
|
812
|
-
upi_qrcode?: string;
|
|
813
|
-
};
|
|
814
|
-
/** @returns {InvoiceTypesDataResponse} */
|
|
815
|
-
declare function InvoiceTypesDataResponse(): InvoiceTypesDataResponse;
|
|
816
|
-
type InvoiceTypesDataResponse = {
|
|
817
|
-
__v: number;
|
|
818
|
-
_id: string;
|
|
819
|
-
country_code: string;
|
|
820
|
-
format: string[];
|
|
821
|
-
name: string;
|
|
822
|
-
pdf_type_id: number;
|
|
823
|
-
status?: boolean;
|
|
824
|
-
visibility: boolean;
|
|
825
|
-
};
|
|
826
|
-
/** @returns {InvoiceTypesResponse} */
|
|
827
|
-
declare function InvoiceTypesResponse(): InvoiceTypesResponse;
|
|
828
|
-
type InvoiceTypesResponse = {
|
|
829
|
-
data: InvoiceTypesDataResponse[];
|
|
830
|
-
success: boolean;
|
|
795
|
+
/** @returns {Tax} */
|
|
796
|
+
declare function Tax(): Tax;
|
|
797
|
+
type Tax = {
|
|
798
|
+
cgst?: Cgst;
|
|
799
|
+
sgst?: Sgst;
|
|
800
|
+
igst?: Igst;
|
|
831
801
|
};
|
|
832
802
|
/** @returns {ItemsProductTable} */
|
|
833
803
|
declare function ItemsProductTable(): ItemsProductTable;
|
|
834
804
|
type ItemsProductTable = {
|
|
805
|
+
name?: string;
|
|
806
|
+
seller_identifier?: string;
|
|
807
|
+
total?: number;
|
|
835
808
|
brand?: Brand;
|
|
836
|
-
country_of_origin?: string;
|
|
837
|
-
discount?: number;
|
|
838
809
|
hsn_code?: string;
|
|
839
810
|
item_code?: string;
|
|
840
|
-
|
|
841
|
-
mrp?: number;
|
|
842
|
-
name?: string;
|
|
843
|
-
seller_identifier?: string;
|
|
811
|
+
total_units?: number;
|
|
844
812
|
size?: string;
|
|
845
|
-
|
|
813
|
+
mrp?: number;
|
|
814
|
+
discount?: number;
|
|
846
815
|
taxable_amount?: number;
|
|
847
|
-
total?: number;
|
|
848
816
|
total_taxable_amount?: number;
|
|
849
|
-
|
|
817
|
+
tax?: Tax;
|
|
818
|
+
};
|
|
819
|
+
/** @returns {ProductTable} */
|
|
820
|
+
declare function ProductTable(): ProductTable;
|
|
821
|
+
type ProductTable = {
|
|
822
|
+
total_items?: number;
|
|
823
|
+
products?: ItemsProductTable[];
|
|
824
|
+
grand_total?: number;
|
|
825
|
+
delivery_charges?: number;
|
|
826
|
+
delivery_charge_text?: string;
|
|
827
|
+
cod_charges?: number;
|
|
828
|
+
fynd_discounts?: number;
|
|
829
|
+
total_in_words?: string;
|
|
830
|
+
};
|
|
831
|
+
/** @returns {Taxes} */
|
|
832
|
+
declare function Taxes(): Taxes;
|
|
833
|
+
type Taxes = {
|
|
834
|
+
hsn_code?: string;
|
|
835
|
+
tax?: Tax;
|
|
836
|
+
total_tax_value?: number;
|
|
837
|
+
};
|
|
838
|
+
/** @returns {TaxTable} */
|
|
839
|
+
declare function TaxTable(): TaxTable;
|
|
840
|
+
type TaxTable = {
|
|
841
|
+
taxes?: Taxes[];
|
|
842
|
+
total_tax?: number;
|
|
843
|
+
tax_in_words?: string;
|
|
844
|
+
};
|
|
845
|
+
/** @returns {RegisteredCompanyDetail} */
|
|
846
|
+
declare function RegisteredCompanyDetail(): RegisteredCompanyDetail;
|
|
847
|
+
type RegisteredCompanyDetail = {
|
|
848
|
+
address?: string;
|
|
849
|
+
city?: string;
|
|
850
|
+
state?: string;
|
|
851
|
+
country?: string;
|
|
852
|
+
country_code?: string;
|
|
853
|
+
zip_code?: number;
|
|
854
|
+
state_code?: string;
|
|
850
855
|
};
|
|
851
856
|
/** @returns {Kwargs} */
|
|
852
857
|
declare function Kwargs(): Kwargs;
|
|
853
858
|
type Kwargs = {
|
|
854
859
|
value?: string;
|
|
855
860
|
};
|
|
856
|
-
/** @returns {
|
|
857
|
-
declare function
|
|
858
|
-
type
|
|
859
|
-
|
|
861
|
+
/** @returns {ShipmentIdBarcodeGenerator} */
|
|
862
|
+
declare function ShipmentIdBarcodeGenerator(): ShipmentIdBarcodeGenerator;
|
|
863
|
+
type ShipmentIdBarcodeGenerator = {
|
|
864
|
+
method?: string;
|
|
865
|
+
kwargs?: Kwargs;
|
|
866
|
+
};
|
|
867
|
+
/** @returns {SignedQrcodeGenerator} */
|
|
868
|
+
declare function SignedQrcodeGenerator(): SignedQrcodeGenerator;
|
|
869
|
+
type SignedQrcodeGenerator = {
|
|
870
|
+
method?: string;
|
|
871
|
+
kwargs?: Kwargs;
|
|
860
872
|
};
|
|
861
873
|
/** @returns {KwargsUpiQrcode} */
|
|
862
874
|
declare function KwargsUpiQrcode(): KwargsUpiQrcode;
|
|
@@ -864,106 +876,95 @@ type KwargsUpiQrcode = {
|
|
|
864
876
|
qr_data?: string;
|
|
865
877
|
qr_url?: string;
|
|
866
878
|
};
|
|
867
|
-
/** @returns {
|
|
868
|
-
declare function
|
|
869
|
-
type
|
|
870
|
-
|
|
879
|
+
/** @returns {UpiQrcodeGenerator} */
|
|
880
|
+
declare function UpiQrcodeGenerator(): UpiQrcodeGenerator;
|
|
881
|
+
type UpiQrcodeGenerator = {
|
|
882
|
+
method?: string;
|
|
883
|
+
kwargs?: KwargsUpiQrcode;
|
|
884
|
+
};
|
|
885
|
+
/** @returns {DigitalsignatureGenerator} */
|
|
886
|
+
declare function DigitalsignatureGenerator(): DigitalsignatureGenerator;
|
|
887
|
+
type DigitalsignatureGenerator = {
|
|
888
|
+
method?: string;
|
|
889
|
+
kwargs?: Kwargs;
|
|
890
|
+
};
|
|
891
|
+
/** @returns {KwargsAwbNumber} */
|
|
892
|
+
declare function KwargsAwbNumber(): KwargsAwbNumber;
|
|
893
|
+
type KwargsAwbNumber = {
|
|
894
|
+
value?: any[];
|
|
895
|
+
};
|
|
896
|
+
/** @returns {AwbNumberLabelBarcodeGenerator} */
|
|
897
|
+
declare function AwbNumberLabelBarcodeGenerator(): AwbNumberLabelBarcodeGenerator;
|
|
898
|
+
type AwbNumberLabelBarcodeGenerator = {
|
|
899
|
+
method?: string;
|
|
900
|
+
kwargs?: KwargsAwbNumber;
|
|
871
901
|
};
|
|
872
902
|
/** @returns {MetaProperty} */
|
|
873
903
|
declare function MetaProperty(): MetaProperty;
|
|
874
904
|
type MetaProperty = {
|
|
875
|
-
awb_number_barcode_generator?: AwbNumberBarcodeGenerator;
|
|
876
|
-
awb_number_label_barcode_generator?: AwbNumberLabelBarcodeGenerator;
|
|
877
|
-
digitalsignature_generator?: DigitalsignatureGenerator;
|
|
878
905
|
shipment_id_barcode_generator?: ShipmentIdBarcodeGenerator;
|
|
879
906
|
signed_qrcode_generator?: SignedQrcodeGenerator;
|
|
880
907
|
upi_qrcode_generator?: UpiQrcodeGenerator;
|
|
908
|
+
digitalsignature_generator?: DigitalsignatureGenerator;
|
|
909
|
+
awb_number_label_barcode_generator?: AwbNumberLabelBarcodeGenerator;
|
|
881
910
|
};
|
|
882
|
-
/** @returns {
|
|
883
|
-
declare function
|
|
884
|
-
type
|
|
885
|
-
|
|
886
|
-
date?: string;
|
|
887
|
-
meta?: any;
|
|
888
|
-
mode?: string;
|
|
889
|
-
name?: string;
|
|
890
|
-
payment_type?: string;
|
|
891
|
-
time?: string;
|
|
892
|
-
transaction_id?: string;
|
|
893
|
-
};
|
|
894
|
-
/** @returns {PaymentReceiptCustomerDetails} */
|
|
895
|
-
declare function PaymentReceiptCustomerDetails(): PaymentReceiptCustomerDetails;
|
|
896
|
-
type PaymentReceiptCustomerDetails = {
|
|
897
|
-
email_id?: string;
|
|
898
|
-
first_name?: string;
|
|
899
|
-
id?: string;
|
|
900
|
-
last_name?: string;
|
|
901
|
-
mobile_number?: string;
|
|
902
|
-
};
|
|
903
|
-
/** @returns {PaymentReceiptFormat} */
|
|
904
|
-
declare function PaymentReceiptFormat(): PaymentReceiptFormat;
|
|
905
|
-
type PaymentReceiptFormat = {
|
|
906
|
-
payment_receipt?: string[];
|
|
907
|
-
};
|
|
908
|
-
/** @returns {PaymentReceiptMeta} */
|
|
909
|
-
declare function PaymentReceiptMeta(): PaymentReceiptMeta;
|
|
910
|
-
type PaymentReceiptMeta = {
|
|
911
|
-
action?: string;
|
|
912
|
-
application_id?: string[];
|
|
913
|
-
company_id?: number;
|
|
914
|
-
created_timestamp?: number;
|
|
915
|
-
event?: any;
|
|
916
|
-
event_trace_info?: any;
|
|
917
|
-
format?: PaymentReceiptFormat;
|
|
918
|
-
job_type?: string;
|
|
919
|
-
organizaton_id?: string;
|
|
920
|
-
service?: PaymentReceiptService;
|
|
921
|
-
trace?: string;
|
|
922
|
-
trace_id?: string[];
|
|
911
|
+
/** @returns {Meta} */
|
|
912
|
+
declare function Meta(): Meta;
|
|
913
|
+
type Meta = {
|
|
914
|
+
generator?: MetaProperty;
|
|
923
915
|
};
|
|
924
|
-
/** @returns {
|
|
925
|
-
declare function
|
|
926
|
-
type
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
916
|
+
/** @returns {DummyTemplateDataPayload} */
|
|
917
|
+
declare function DummyTemplateDataPayload(): DummyTemplateDataPayload;
|
|
918
|
+
type DummyTemplateDataPayload = {
|
|
919
|
+
is_international?: boolean;
|
|
920
|
+
app_domain_name?: string;
|
|
921
|
+
conversion_rate?: ConversionRate;
|
|
922
|
+
currency_code?: string;
|
|
923
|
+
shipment_id?: string;
|
|
924
|
+
delivery_partner_detail?: DeliveryPartnerDetail;
|
|
925
|
+
image?: Image;
|
|
926
|
+
payments?: PaymentData[];
|
|
927
|
+
invoice_detail?: InvoiceDetail;
|
|
928
|
+
company_detail?: CompanyDetail;
|
|
929
|
+
store_detail?: StoreDetail;
|
|
930
|
+
customer_billing_detail?: CustomerBillingDetail;
|
|
931
|
+
customer_shipping_detail?: CustomerShippingDetail;
|
|
932
|
+
return_detail?: ReturnDetail;
|
|
933
|
+
product_table?: ProductTable;
|
|
934
|
+
tax_table?: TaxTable;
|
|
935
|
+
declaration_texts?: string[];
|
|
936
|
+
registered_company_detail?: RegisteredCompanyDetail;
|
|
937
|
+
disclaimer?: string;
|
|
938
|
+
meta?: Meta;
|
|
939
|
+
is_self_ship?: boolean;
|
|
940
|
+
mode?: string;
|
|
941
|
+
is_self_pickup?: boolean;
|
|
942
|
+
platform_name?: string;
|
|
943
|
+
amount_to_be_collected?: number;
|
|
944
|
+
amount_paid?: number;
|
|
945
|
+
waybills?: any[];
|
|
935
946
|
total_items?: number;
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
|
|
941
|
-
|
|
942
|
-
payments?: PaymentReceiptPayments[];
|
|
947
|
+
brand_logo?: string;
|
|
948
|
+
shipment_id_barcode?: string;
|
|
949
|
+
signed_qrcode?: string;
|
|
950
|
+
upi_qrcode?: string;
|
|
951
|
+
digitalsignature?: string;
|
|
952
|
+
awb_number_barcode?: string;
|
|
943
953
|
uid?: string;
|
|
944
954
|
};
|
|
945
|
-
/** @returns {
|
|
946
|
-
declare function
|
|
947
|
-
type
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
declare function PaymentReceiptRequestBody(): PaymentReceiptRequestBody;
|
|
953
|
-
type PaymentReceiptRequestBody = {
|
|
954
|
-
meta?: PaymentReceiptMeta;
|
|
955
|
-
payload?: PaymentReceiptPayload;
|
|
956
|
-
};
|
|
957
|
-
/** @returns {PaymentReceiptService} */
|
|
958
|
-
declare function PaymentReceiptService(): PaymentReceiptService;
|
|
959
|
-
type PaymentReceiptService = {
|
|
960
|
-
name?: string;
|
|
955
|
+
/** @returns {DummyTemplateData} */
|
|
956
|
+
declare function DummyTemplateData(): DummyTemplateData;
|
|
957
|
+
type DummyTemplateData = {
|
|
958
|
+
_id?: string;
|
|
959
|
+
pdf_type_id?: number;
|
|
960
|
+
payload: DummyTemplateDataPayload;
|
|
961
|
+
__v?: number;
|
|
961
962
|
};
|
|
962
|
-
/** @returns {
|
|
963
|
-
declare function
|
|
964
|
-
type
|
|
965
|
-
|
|
966
|
-
|
|
963
|
+
/** @returns {DummyTemplateDataItems} */
|
|
964
|
+
declare function DummyTemplateDataItems(): DummyTemplateDataItems;
|
|
965
|
+
type DummyTemplateDataItems = {
|
|
966
|
+
data: DummyTemplateData[];
|
|
967
|
+
success: boolean;
|
|
967
968
|
};
|
|
968
969
|
/** @returns {PdfConfig} */
|
|
969
970
|
declare function PdfConfig(): PdfConfig;
|
|
@@ -972,28 +973,23 @@ type PdfConfig = {
|
|
|
972
973
|
* - This is invoice document format such as A4, A6, POS
|
|
973
974
|
*/
|
|
974
975
|
format?: string;
|
|
975
|
-
pdf_type_id?: number;
|
|
976
976
|
/**
|
|
977
977
|
* - This is html template string
|
|
978
978
|
*/
|
|
979
979
|
template?: string;
|
|
980
|
+
pdf_type_id?: number;
|
|
980
981
|
};
|
|
981
|
-
/** @returns {
|
|
982
|
-
declare function
|
|
983
|
-
type
|
|
984
|
-
data?: PdfConfigSaveSuccessData;
|
|
985
|
-
success?: boolean;
|
|
986
|
-
};
|
|
987
|
-
/** @returns {PdfConfigSaveSuccessData} */
|
|
988
|
-
declare function PdfConfigSaveSuccessData(): PdfConfigSaveSuccessData;
|
|
989
|
-
type PdfConfigSaveSuccessData = {
|
|
990
|
-
__v?: number;
|
|
982
|
+
/** @returns {PdfConfigSuccessData} */
|
|
983
|
+
declare function PdfConfigSuccessData(): PdfConfigSuccessData;
|
|
984
|
+
type PdfConfigSuccessData = {
|
|
991
985
|
_id?: string;
|
|
992
|
-
application_id?: string;
|
|
993
986
|
company_id?: number;
|
|
994
|
-
|
|
987
|
+
application_id?: string;
|
|
995
988
|
pdf_type_id?: number;
|
|
989
|
+
format?: string;
|
|
996
990
|
template?: string;
|
|
991
|
+
__v?: number;
|
|
992
|
+
country_code?: string;
|
|
997
993
|
};
|
|
998
994
|
/** @returns {PdfConfigSuccess} */
|
|
999
995
|
declare function PdfConfigSuccess(): PdfConfigSuccess;
|
|
@@ -1001,17 +997,22 @@ type PdfConfigSuccess = {
|
|
|
1001
997
|
data?: PdfConfigSuccessData[];
|
|
1002
998
|
success?: boolean;
|
|
1003
999
|
};
|
|
1004
|
-
/** @returns {
|
|
1005
|
-
declare function
|
|
1006
|
-
type
|
|
1007
|
-
__v?: number;
|
|
1000
|
+
/** @returns {PdfConfigSaveSuccessData} */
|
|
1001
|
+
declare function PdfConfigSaveSuccessData(): PdfConfigSaveSuccessData;
|
|
1002
|
+
type PdfConfigSaveSuccessData = {
|
|
1008
1003
|
_id?: string;
|
|
1009
|
-
application_id?: string;
|
|
1010
1004
|
company_id?: number;
|
|
1011
|
-
|
|
1012
|
-
format?: string;
|
|
1005
|
+
application_id?: string;
|
|
1013
1006
|
pdf_type_id?: number;
|
|
1007
|
+
format?: string;
|
|
1014
1008
|
template?: string;
|
|
1009
|
+
__v?: number;
|
|
1010
|
+
};
|
|
1011
|
+
/** @returns {PdfConfigSaveSuccess} */
|
|
1012
|
+
declare function PdfConfigSaveSuccess(): PdfConfigSaveSuccess;
|
|
1013
|
+
type PdfConfigSaveSuccess = {
|
|
1014
|
+
data?: PdfConfigSaveSuccessData;
|
|
1015
|
+
success?: boolean;
|
|
1015
1016
|
};
|
|
1016
1017
|
/** @returns {PdfDefaultTemplateSuccess} */
|
|
1017
1018
|
declare function PdfDefaultTemplateSuccess(): PdfDefaultTemplateSuccess;
|
|
@@ -1022,159 +1023,87 @@ type PdfDefaultTemplateSuccess = {
|
|
|
1022
1023
|
*/
|
|
1023
1024
|
success?: boolean;
|
|
1024
1025
|
};
|
|
1025
|
-
/** @returns {
|
|
1026
|
-
declare function
|
|
1027
|
-
type
|
|
1028
|
-
|
|
1029
|
-
|
|
1030
|
-
|
|
1031
|
-
|
|
1032
|
-
discount?: number;
|
|
1033
|
-
fynd_discounts?: number;
|
|
1034
|
-
gift_price?: number;
|
|
1035
|
-
grand_total?: number;
|
|
1036
|
-
products?: ItemsProductTable[];
|
|
1037
|
-
promotion?: number;
|
|
1038
|
-
reward?: number;
|
|
1039
|
-
round_off?: number;
|
|
1040
|
-
sub_total?: number;
|
|
1041
|
-
total_in_words?: string;
|
|
1042
|
-
total_items?: number;
|
|
1043
|
-
total_quantity?: number;
|
|
1044
|
-
total_value_of_goods?: number;
|
|
1045
|
-
};
|
|
1046
|
-
/** @returns {RegisteredCompanyDetail} */
|
|
1047
|
-
declare function RegisteredCompanyDetail(): RegisteredCompanyDetail;
|
|
1048
|
-
type RegisteredCompanyDetail = {
|
|
1049
|
-
address?: string;
|
|
1050
|
-
city?: string;
|
|
1051
|
-
country?: string;
|
|
1052
|
-
country_code?: string;
|
|
1053
|
-
display_address?: string;
|
|
1054
|
-
sector?: string;
|
|
1055
|
-
state?: string;
|
|
1056
|
-
state_code?: string;
|
|
1057
|
-
zip_code?: number;
|
|
1058
|
-
};
|
|
1059
|
-
/** @returns {ReturnDetail} */
|
|
1060
|
-
declare function ReturnDetail(): ReturnDetail;
|
|
1061
|
-
type ReturnDetail = {
|
|
1062
|
-
address?: string;
|
|
1063
|
-
city?: string;
|
|
1064
|
-
country?: string;
|
|
1026
|
+
/** @returns {Document} */
|
|
1027
|
+
declare function Document(): Document;
|
|
1028
|
+
type Document = {
|
|
1029
|
+
_id?: string;
|
|
1030
|
+
pdf_type_id?: number;
|
|
1031
|
+
format?: string;
|
|
1032
|
+
template?: string;
|
|
1065
1033
|
country_code?: string;
|
|
1066
|
-
|
|
1067
|
-
gstin?: string;
|
|
1068
|
-
sector?: string;
|
|
1069
|
-
state?: string;
|
|
1070
|
-
state_code?: string;
|
|
1071
|
-
zip_code?: string;
|
|
1072
|
-
};
|
|
1073
|
-
/** @returns {Sgst} */
|
|
1074
|
-
declare function Sgst(): Sgst;
|
|
1075
|
-
type Sgst = {
|
|
1076
|
-
percent?: number;
|
|
1077
|
-
value?: number;
|
|
1034
|
+
__v?: number;
|
|
1078
1035
|
};
|
|
1079
|
-
/** @returns {
|
|
1080
|
-
declare function
|
|
1081
|
-
type
|
|
1082
|
-
|
|
1083
|
-
|
|
1036
|
+
/** @returns {PaymentReceiptRequestBody} */
|
|
1037
|
+
declare function PaymentReceiptRequestBody(): PaymentReceiptRequestBody;
|
|
1038
|
+
type PaymentReceiptRequestBody = {
|
|
1039
|
+
payload?: PaymentReceiptPayload;
|
|
1040
|
+
meta?: PaymentReceiptMeta;
|
|
1084
1041
|
};
|
|
1085
|
-
/** @returns {
|
|
1086
|
-
declare function
|
|
1087
|
-
type
|
|
1088
|
-
|
|
1089
|
-
|
|
1042
|
+
/** @returns {PaymentReceiptOrderDetails} */
|
|
1043
|
+
declare function PaymentReceiptOrderDetails(): PaymentReceiptOrderDetails;
|
|
1044
|
+
type PaymentReceiptOrderDetails = {
|
|
1045
|
+
jiomart_order_id?: string;
|
|
1046
|
+
total_items?: number;
|
|
1047
|
+
final_amount?: number;
|
|
1048
|
+
final_amount_in_words?: string;
|
|
1049
|
+
order_created_date?: string;
|
|
1050
|
+
order_created_time?: string;
|
|
1051
|
+
prm_id?: string;
|
|
1052
|
+
receipt_no?: string;
|
|
1053
|
+
taxes?: PaymentReceiptTaxes;
|
|
1090
1054
|
};
|
|
1091
|
-
/** @returns {
|
|
1092
|
-
declare function
|
|
1093
|
-
type
|
|
1094
|
-
|
|
1095
|
-
|
|
1055
|
+
/** @returns {PaymentReceiptCustomerDetails} */
|
|
1056
|
+
declare function PaymentReceiptCustomerDetails(): PaymentReceiptCustomerDetails;
|
|
1057
|
+
type PaymentReceiptCustomerDetails = {
|
|
1058
|
+
id?: string;
|
|
1059
|
+
email_id?: string;
|
|
1060
|
+
last_name?: string;
|
|
1061
|
+
first_name?: string;
|
|
1062
|
+
mobile_number?: string;
|
|
1096
1063
|
};
|
|
1097
|
-
/** @returns {
|
|
1098
|
-
declare function
|
|
1099
|
-
type
|
|
1100
|
-
|
|
1064
|
+
/** @returns {PaymentReceiptPayments} */
|
|
1065
|
+
declare function PaymentReceiptPayments(): PaymentReceiptPayments;
|
|
1066
|
+
type PaymentReceiptPayments = {
|
|
1067
|
+
payment_desc?: string;
|
|
1068
|
+
txn_date?: string;
|
|
1101
1069
|
};
|
|
1102
|
-
/** @returns {
|
|
1103
|
-
declare function
|
|
1104
|
-
type
|
|
1105
|
-
|
|
1106
|
-
file_name: string;
|
|
1107
|
-
params?: any;
|
|
1108
|
-
size: number;
|
|
1109
|
-
tags?: string[];
|
|
1070
|
+
/** @returns {PaymentReceiptFormat} */
|
|
1071
|
+
declare function PaymentReceiptFormat(): PaymentReceiptFormat;
|
|
1072
|
+
type PaymentReceiptFormat = {
|
|
1073
|
+
payment_receipt?: string[];
|
|
1110
1074
|
};
|
|
1111
|
-
/** @returns {
|
|
1112
|
-
declare function
|
|
1113
|
-
type
|
|
1114
|
-
|
|
1115
|
-
content_type: string;
|
|
1116
|
-
file_name: string;
|
|
1117
|
-
file_path: string;
|
|
1118
|
-
method?: string;
|
|
1119
|
-
namespace: string;
|
|
1120
|
-
operation: string;
|
|
1121
|
-
size: number;
|
|
1122
|
-
tags?: string[];
|
|
1123
|
-
upload: Upload;
|
|
1075
|
+
/** @returns {PaymentReceiptService} */
|
|
1076
|
+
declare function PaymentReceiptService(): PaymentReceiptService;
|
|
1077
|
+
type PaymentReceiptService = {
|
|
1078
|
+
name?: string;
|
|
1124
1079
|
};
|
|
1125
|
-
/** @returns {
|
|
1126
|
-
declare function
|
|
1127
|
-
type
|
|
1128
|
-
address?: string;
|
|
1129
|
-
city?: string;
|
|
1130
|
-
country?: string;
|
|
1131
|
-
country_code?: string;
|
|
1132
|
-
display_address?: string;
|
|
1080
|
+
/** @returns {PaymentReceiptTaxes} */
|
|
1081
|
+
declare function PaymentReceiptTaxes(): PaymentReceiptTaxes;
|
|
1082
|
+
type PaymentReceiptTaxes = {
|
|
1133
1083
|
gstin?: string;
|
|
1134
|
-
|
|
1135
|
-
state?: string;
|
|
1136
|
-
state_code?: string;
|
|
1137
|
-
store_id?: string;
|
|
1138
|
-
store_name?: string;
|
|
1139
|
-
zip_code?: string;
|
|
1140
|
-
};
|
|
1141
|
-
/** @returns {Tax} */
|
|
1142
|
-
declare function Tax(): Tax;
|
|
1143
|
-
type Tax = {
|
|
1144
|
-
cgst?: Cgst;
|
|
1145
|
-
igst?: Igst;
|
|
1146
|
-
sgst?: Sgst;
|
|
1147
|
-
};
|
|
1148
|
-
/** @returns {Taxes} */
|
|
1149
|
-
declare function Taxes(): Taxes;
|
|
1150
|
-
type Taxes = {
|
|
1151
|
-
hsn_code?: string;
|
|
1152
|
-
tax?: Tax;
|
|
1153
|
-
total_tax_value?: number;
|
|
1154
|
-
};
|
|
1155
|
-
/** @returns {TaxTable} */
|
|
1156
|
-
declare function TaxTable(): TaxTable;
|
|
1157
|
-
type TaxTable = {
|
|
1158
|
-
tax_in_words?: string;
|
|
1159
|
-
taxes?: Taxes[];
|
|
1160
|
-
total_tax?: number;
|
|
1161
|
-
};
|
|
1162
|
-
/** @returns {UpiQrcodeGenerator} */
|
|
1163
|
-
declare function UpiQrcodeGenerator(): UpiQrcodeGenerator;
|
|
1164
|
-
type UpiQrcodeGenerator = {
|
|
1165
|
-
kwargs?: KwargsUpiQrcode;
|
|
1166
|
-
method?: string;
|
|
1084
|
+
pancard?: string;
|
|
1167
1085
|
};
|
|
1168
|
-
/** @returns {
|
|
1169
|
-
declare function
|
|
1170
|
-
type
|
|
1171
|
-
|
|
1172
|
-
|
|
1086
|
+
/** @returns {PaymentReceiptPayload} */
|
|
1087
|
+
declare function PaymentReceiptPayload(): PaymentReceiptPayload;
|
|
1088
|
+
type PaymentReceiptPayload = {
|
|
1089
|
+
uid?: string;
|
|
1090
|
+
order_detail?: PaymentReceiptOrderDetails;
|
|
1091
|
+
customer_detail?: PaymentReceiptCustomerDetails;
|
|
1092
|
+
payments?: PaymentReceiptPayments[];
|
|
1173
1093
|
};
|
|
1174
|
-
/** @returns {
|
|
1175
|
-
declare function
|
|
1176
|
-
type
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
|
|
1094
|
+
/** @returns {PaymentReceiptMeta} */
|
|
1095
|
+
declare function PaymentReceiptMeta(): PaymentReceiptMeta;
|
|
1096
|
+
type PaymentReceiptMeta = {
|
|
1097
|
+
job_type?: string;
|
|
1098
|
+
action?: string;
|
|
1099
|
+
event?: any;
|
|
1100
|
+
organizaton_id?: string;
|
|
1101
|
+
company_id?: number;
|
|
1102
|
+
application_id?: string[];
|
|
1103
|
+
format?: PaymentReceiptFormat;
|
|
1104
|
+
trace_id?: string[];
|
|
1105
|
+
created_timestamp?: number;
|
|
1106
|
+
service?: PaymentReceiptService;
|
|
1107
|
+
event_trace_info?: any;
|
|
1108
|
+
trace?: string;
|
|
1180
1109
|
};
|