@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15
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 +23 -26
- package/package.json +5 -1
- package/sdk/application/ApplicationClient.d.ts +5 -6
- package/sdk/application/ApplicationClient.js +24 -20
- package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
- package/sdk/application/Cart/CartApplicationClient.js +444 -76
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
- package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
- package/sdk/application/Content/ContentApplicationClient.js +274 -111
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +6 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
- package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
- package/sdk/application/Order/OrderApplicationClient.js +217 -17
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
- package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
- package/sdk/application/User/UserApplicationClient.d.ts +103 -53
- package/sdk/application/User/UserApplicationClient.js +308 -49
- package/sdk/common/AxiosHelper.js +11 -4
- package/sdk/common/Constant.d.ts +27 -4
- package/sdk/common/Constant.js +33 -6
- package/sdk/common/utils.d.ts +10 -0
- package/sdk/common/utils.js +24 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
- package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
- package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
- package/sdk/partner/PartnerClient.d.ts +5 -2
- package/sdk/partner/PartnerClient.js +21 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
- package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
- package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
- package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
- package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
- package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
- package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9571 -2674
- package/sdk/platform/Catalog/CatalogPlatformModel.js +5081 -2019
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
- package/sdk/platform/Common/CommonPlatformModel.js +25 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
- package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
- package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
- package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
- package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
- package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
- package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
- package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
- package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
- package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
- package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
- package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
- package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/PlatformClient.d.ts +5 -4
- package/sdk/platform/PlatformClient.js +32 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
- package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
- package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
- package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
- package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
- package/sdk/platform/User/UserPlatformModel.js +607 -46
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
- package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
- package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -2
- package/sdk/platform/index.js +0 -4
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
- package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
- package/sdk/public/Content/ContentPublicClient.js +1067 -17
- package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
- package/sdk/public/Content/ContentPublicModel.js +751 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
- package/sdk/public/Content/ContentPublicValidator.js +119 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- 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/PublicClient.d.ts +5 -2
- package/sdk/public/PublicClient.js +16 -6
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
- package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/utility.d.ts +3 -0
- package/utility.js +7 -0
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
- package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
- package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
|
@@ -1,13 +1,7 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @typedef
|
|
5
|
-
* @property {Object} [data]
|
|
6
|
-
* @property {Object} [support]
|
|
7
|
-
*/
|
|
8
|
-
|
|
9
|
-
/**
|
|
10
|
-
* @typedef FailedResponse
|
|
4
|
+
* @typedef FailedBrowseFilesResult
|
|
11
5
|
* @property {string} message
|
|
12
6
|
*/
|
|
13
7
|
|
|
@@ -25,7 +19,7 @@ const Joi = require("joi");
|
|
|
25
19
|
*/
|
|
26
20
|
|
|
27
21
|
/**
|
|
28
|
-
* @typedef
|
|
22
|
+
* @typedef FileUpload
|
|
29
23
|
* @property {string} file_name
|
|
30
24
|
* @property {string} file_path
|
|
31
25
|
* @property {string} content_type
|
|
@@ -34,17 +28,11 @@ const Joi = require("joi");
|
|
|
34
28
|
* @property {string} operation
|
|
35
29
|
* @property {number} size
|
|
36
30
|
* @property {Upload} upload
|
|
37
|
-
* @property {CDN} cdn
|
|
38
31
|
* @property {string[]} [tags]
|
|
39
32
|
*/
|
|
40
33
|
|
|
41
34
|
/**
|
|
42
|
-
* @typedef
|
|
43
|
-
* @property {string} [subpath] - The subpath for the file.
|
|
44
|
-
*/
|
|
45
|
-
|
|
46
|
-
/**
|
|
47
|
-
* @typedef StartRequest
|
|
35
|
+
* @typedef FileUploadStart
|
|
48
36
|
* @property {string} file_name
|
|
49
37
|
* @property {string} content_type
|
|
50
38
|
* @property {number} size
|
|
@@ -58,7 +46,7 @@ const Joi = require("joi");
|
|
|
58
46
|
*/
|
|
59
47
|
|
|
60
48
|
/**
|
|
61
|
-
* @typedef
|
|
49
|
+
* @typedef FileUploadComplete
|
|
62
50
|
* @property {string} _id
|
|
63
51
|
* @property {string} file_name
|
|
64
52
|
* @property {string} file_path
|
|
@@ -76,6 +64,13 @@ const Joi = require("joi");
|
|
|
76
64
|
* @property {CreatedBy} [created_by]
|
|
77
65
|
*/
|
|
78
66
|
|
|
67
|
+
/**
|
|
68
|
+
* @typedef ProxyFileAccess
|
|
69
|
+
* @property {boolean} [success] - A boolean value indicating whether the proxy
|
|
70
|
+
* request was successful. Returns true when the external URL was successfully
|
|
71
|
+
* fetched and processed.
|
|
72
|
+
*/
|
|
73
|
+
|
|
79
74
|
/**
|
|
80
75
|
* @typedef DestinationNamespace
|
|
81
76
|
* @property {string} [namespace]
|
|
@@ -95,425 +90,40 @@ const Joi = require("joi");
|
|
|
95
90
|
*/
|
|
96
91
|
|
|
97
92
|
/**
|
|
98
|
-
* @typedef
|
|
93
|
+
* @typedef SignUrlResult
|
|
99
94
|
* @property {Urls[]} urls
|
|
100
95
|
*/
|
|
101
96
|
|
|
102
97
|
/**
|
|
103
|
-
* @typedef
|
|
98
|
+
* @typedef SignUrl
|
|
104
99
|
* @property {number} expiry
|
|
105
100
|
* @property {string[]} urls
|
|
106
101
|
*/
|
|
107
102
|
|
|
108
|
-
/**
|
|
109
|
-
* @typedef InvoiceTypesDataResponse
|
|
110
|
-
* @property {boolean} [status]
|
|
111
|
-
* @property {string} _id
|
|
112
|
-
* @property {number} pdf_type_id
|
|
113
|
-
* @property {string} name
|
|
114
|
-
* @property {string[]} format
|
|
115
|
-
* @property {number} __v
|
|
116
|
-
* @property {boolean} visibility
|
|
117
|
-
* @property {string} country_code
|
|
118
|
-
*/
|
|
119
|
-
|
|
120
|
-
/**
|
|
121
|
-
* @typedef InvoiceTypesResponse
|
|
122
|
-
* @property {InvoiceTypesDataResponse[]} data
|
|
123
|
-
* @property {boolean} success
|
|
124
|
-
*/
|
|
125
|
-
|
|
126
|
-
/**
|
|
127
|
-
* @typedef ConversionRate
|
|
128
|
-
* @property {string} [base]
|
|
129
|
-
* @property {Object} [rates]
|
|
130
|
-
* @property {number} [timestamp]
|
|
131
|
-
*/
|
|
132
|
-
|
|
133
|
-
/**
|
|
134
|
-
* @typedef DeliveryPartnerDetail
|
|
135
|
-
* @property {string} [name]
|
|
136
|
-
* @property {string} [awb_number_barcode]
|
|
137
|
-
* @property {string} [awb_number]
|
|
138
|
-
* @property {string} [origin]
|
|
139
|
-
* @property {string} [destination]
|
|
140
|
-
* @property {string} [eway_bill_number]
|
|
141
|
-
*/
|
|
142
|
-
|
|
143
|
-
/**
|
|
144
|
-
* @typedef Image
|
|
145
|
-
* @property {string} [sales_channel_logo]
|
|
146
|
-
*/
|
|
147
|
-
|
|
148
|
-
/**
|
|
149
|
-
* @typedef PaymentData
|
|
150
|
-
* @property {string} [payment_type]
|
|
151
|
-
* @property {number} [amount]
|
|
152
|
-
* @property {string} [date]
|
|
153
|
-
* @property {string} [transaction_id]
|
|
154
|
-
* @property {string} [time]
|
|
155
|
-
* @property {string} [mode]
|
|
156
|
-
* @property {string} [name]
|
|
157
|
-
* @property {Object} [meta]
|
|
158
|
-
*/
|
|
159
|
-
|
|
160
|
-
/**
|
|
161
|
-
* @typedef InvoiceDetail
|
|
162
|
-
* @property {string} [invoice_id]
|
|
163
|
-
* @property {string} [invoice_date]
|
|
164
|
-
* @property {string} [irn]
|
|
165
|
-
* @property {string} [external_order_id]
|
|
166
|
-
* @property {string} [shipment_id]
|
|
167
|
-
* @property {string} [signed_qrcode]
|
|
168
|
-
* @property {string} [upi_qrcode]
|
|
169
|
-
* @property {string} [device_id]
|
|
170
|
-
* @property {string} [marketplace_invoice_id]
|
|
171
|
-
* @property {string} [marketplace_shipment_id]
|
|
172
|
-
* @property {string} [channel_order_id]
|
|
173
|
-
*/
|
|
174
|
-
|
|
175
|
-
/**
|
|
176
|
-
* @typedef CompanyDetail
|
|
177
|
-
* @property {string} [name] - The official name of the company.
|
|
178
|
-
* @property {string} [address] - The physical street address of the company.
|
|
179
|
-
* @property {string} [city] - The city where the company is located.
|
|
180
|
-
* @property {string} [state] - The state or province where the company is located.
|
|
181
|
-
* @property {string} [country] - The country where the company is based.
|
|
182
|
-
* @property {number} [zip_code] - The postal code for the company's location.
|
|
183
|
-
* @property {string} [state_code] - A code representing the state, often used
|
|
184
|
-
* in official documents and forms.
|
|
185
|
-
* @property {string} [country_code] - The code of the country.
|
|
186
|
-
* @property {string} [gstin] - The Goods and Services Tax Identification
|
|
187
|
-
* Number, unique to each business in India.
|
|
188
|
-
* @property {string} [pan] - The Permanent Account Number, unique to each
|
|
189
|
-
* taxpayer in India.
|
|
190
|
-
* @property {string} [phone_no] - The primary contact phone number for the company.
|
|
191
|
-
* @property {string} [cin] - The Corporate Identification Number, unique to
|
|
192
|
-
* each company registered in India.
|
|
193
|
-
* @property {string} [website_url] - The URL to the company's official website.
|
|
194
|
-
* @property {string} [email] - The company's official email address.
|
|
195
|
-
* @property {string} [display_address] - The display address of the company.
|
|
196
|
-
* @property {string} [sector] - The sector in which company is located.
|
|
197
|
-
* @property {Object} [phone] - The provided phone no of country.
|
|
198
|
-
* @property {string} [trn] - The trn no of the company.
|
|
199
|
-
* @property {string} [vat] - The vat no of the company.
|
|
200
|
-
* @property {string} [business_country_timezone] - The bussiness country timezone.
|
|
201
|
-
* @property {Object} [business_country_currency] - This object represents the
|
|
202
|
-
* bussiness country currency.
|
|
203
|
-
* @property {Object} [meta] - This object represents the meta fields for company.
|
|
204
|
-
*/
|
|
205
|
-
|
|
206
|
-
/**
|
|
207
|
-
* @typedef StoreDetail
|
|
208
|
-
* @property {string} [store_name]
|
|
209
|
-
* @property {string} [address]
|
|
210
|
-
* @property {string} [city]
|
|
211
|
-
* @property {string} [state]
|
|
212
|
-
* @property {string} [country]
|
|
213
|
-
* @property {string} [country_code]
|
|
214
|
-
* @property {string} [zip_code]
|
|
215
|
-
* @property {string} [state_code]
|
|
216
|
-
* @property {string} [gstin]
|
|
217
|
-
* @property {string} [display_address]
|
|
218
|
-
* @property {string} [sector]
|
|
219
|
-
* @property {string} [store_id]
|
|
220
|
-
*/
|
|
221
|
-
|
|
222
|
-
/**
|
|
223
|
-
* @typedef CustomerBillingDetail
|
|
224
|
-
* @property {string} [name]
|
|
225
|
-
* @property {string} [phone_no]
|
|
226
|
-
* @property {string} [address]
|
|
227
|
-
* @property {string} [city]
|
|
228
|
-
* @property {string} [state]
|
|
229
|
-
* @property {string} [country]
|
|
230
|
-
* @property {string} [country_code]
|
|
231
|
-
* @property {string} [zip_code]
|
|
232
|
-
* @property {string} [state_code]
|
|
233
|
-
* @property {string} [gstin]
|
|
234
|
-
* @property {string} [display_address]
|
|
235
|
-
* @property {string} [sector]
|
|
236
|
-
* @property {string} [email]
|
|
237
|
-
*/
|
|
238
|
-
|
|
239
|
-
/**
|
|
240
|
-
* @typedef CustomerShippingDetail
|
|
241
|
-
* @property {string} [name]
|
|
242
|
-
* @property {string} [phone_no]
|
|
243
|
-
* @property {string} [address]
|
|
244
|
-
* @property {string} [city]
|
|
245
|
-
* @property {string} [state]
|
|
246
|
-
* @property {string} [country]
|
|
247
|
-
* @property {string} [country_code]
|
|
248
|
-
* @property {string} [zip_code]
|
|
249
|
-
* @property {string} [state_code]
|
|
250
|
-
* @property {string} [gstin]
|
|
251
|
-
* @property {string} [display_address]
|
|
252
|
-
* @property {string} [sector]
|
|
253
|
-
*/
|
|
254
|
-
|
|
255
|
-
/**
|
|
256
|
-
* @typedef ReturnDetail
|
|
257
|
-
* @property {string} [address]
|
|
258
|
-
* @property {string} [city]
|
|
259
|
-
* @property {string} [state]
|
|
260
|
-
* @property {string} [country]
|
|
261
|
-
* @property {string} [country_code]
|
|
262
|
-
* @property {string} [zip_code]
|
|
263
|
-
* @property {string} [state_code]
|
|
264
|
-
* @property {string} [gstin]
|
|
265
|
-
* @property {string} [display_address]
|
|
266
|
-
* @property {string} [sector]
|
|
267
|
-
*/
|
|
268
|
-
|
|
269
|
-
/**
|
|
270
|
-
* @typedef Brand
|
|
271
|
-
* @property {string} [logo]
|
|
272
|
-
* @property {string} [name]
|
|
273
|
-
*/
|
|
274
|
-
|
|
275
|
-
/**
|
|
276
|
-
* @typedef Cgst
|
|
277
|
-
* @property {number} [value]
|
|
278
|
-
* @property {number} [percent]
|
|
279
|
-
*/
|
|
280
|
-
|
|
281
|
-
/**
|
|
282
|
-
* @typedef Sgst
|
|
283
|
-
* @property {number} [value]
|
|
284
|
-
* @property {number} [percent]
|
|
285
|
-
*/
|
|
286
|
-
|
|
287
|
-
/**
|
|
288
|
-
* @typedef Igst
|
|
289
|
-
* @property {number} [value]
|
|
290
|
-
* @property {number} [percent]
|
|
291
|
-
*/
|
|
292
|
-
|
|
293
|
-
/**
|
|
294
|
-
* @typedef Tax
|
|
295
|
-
* @property {Cgst} [cgst]
|
|
296
|
-
* @property {Sgst} [sgst]
|
|
297
|
-
* @property {Igst} [igst]
|
|
298
|
-
*/
|
|
299
|
-
|
|
300
|
-
/**
|
|
301
|
-
* @typedef ItemsProductTable
|
|
302
|
-
* @property {string} [name]
|
|
303
|
-
* @property {string} [seller_identifier]
|
|
304
|
-
* @property {number} [total]
|
|
305
|
-
* @property {Brand} [brand]
|
|
306
|
-
* @property {string} [hsn_code]
|
|
307
|
-
* @property {string} [item_code]
|
|
308
|
-
* @property {number} [total_units]
|
|
309
|
-
* @property {string} [size]
|
|
310
|
-
* @property {number} [mrp]
|
|
311
|
-
* @property {number} [discount]
|
|
312
|
-
* @property {number} [taxable_amount]
|
|
313
|
-
* @property {number} [total_taxable_amount]
|
|
314
|
-
* @property {Tax} [tax]
|
|
315
|
-
* @property {Object} [meta]
|
|
316
|
-
* @property {string} [country_of_origin]
|
|
317
|
-
*/
|
|
318
|
-
|
|
319
|
-
/**
|
|
320
|
-
* @typedef ProductTable
|
|
321
|
-
* @property {number} [total_items]
|
|
322
|
-
* @property {ItemsProductTable[]} [products]
|
|
323
|
-
* @property {number} [grand_total]
|
|
324
|
-
* @property {number} [delivery_charges]
|
|
325
|
-
* @property {string} [delivery_charge_text]
|
|
326
|
-
* @property {number} [cod_charges]
|
|
327
|
-
* @property {number} [fynd_discounts]
|
|
328
|
-
* @property {string} [total_in_words]
|
|
329
|
-
* @property {number} [gift_price]
|
|
330
|
-
* @property {number} [total_quantity]
|
|
331
|
-
* @property {number} [sub_total]
|
|
332
|
-
* @property {number} [discount]
|
|
333
|
-
* @property {number} [promotion]
|
|
334
|
-
* @property {number} [coupon]
|
|
335
|
-
* @property {number} [reward]
|
|
336
|
-
* @property {number} [round_off]
|
|
337
|
-
* @property {number} [total_value_of_goods]
|
|
338
|
-
*/
|
|
339
|
-
|
|
340
|
-
/**
|
|
341
|
-
* @typedef Taxes
|
|
342
|
-
* @property {string} [hsn_code]
|
|
343
|
-
* @property {Tax} [tax]
|
|
344
|
-
* @property {number} [total_tax_value]
|
|
345
|
-
*/
|
|
346
|
-
|
|
347
|
-
/**
|
|
348
|
-
* @typedef TaxTable
|
|
349
|
-
* @property {Taxes[]} [taxes]
|
|
350
|
-
* @property {number} [total_tax]
|
|
351
|
-
* @property {string} [tax_in_words]
|
|
352
|
-
*/
|
|
353
|
-
|
|
354
|
-
/**
|
|
355
|
-
* @typedef RegisteredCompanyDetail
|
|
356
|
-
* @property {string} [address]
|
|
357
|
-
* @property {string} [city]
|
|
358
|
-
* @property {string} [state]
|
|
359
|
-
* @property {string} [country]
|
|
360
|
-
* @property {string} [country_code]
|
|
361
|
-
* @property {number} [zip_code]
|
|
362
|
-
* @property {string} [state_code]
|
|
363
|
-
* @property {string} [display_address]
|
|
364
|
-
* @property {string} [sector]
|
|
365
|
-
*/
|
|
366
|
-
|
|
367
|
-
/**
|
|
368
|
-
* @typedef Kwargs
|
|
369
|
-
* @property {string} [value]
|
|
370
|
-
*/
|
|
371
|
-
|
|
372
|
-
/**
|
|
373
|
-
* @typedef ShipmentIdBarcodeGenerator
|
|
374
|
-
* @property {string} [method]
|
|
375
|
-
* @property {Kwargs} [kwargs]
|
|
376
|
-
*/
|
|
377
|
-
|
|
378
|
-
/**
|
|
379
|
-
* @typedef SignedQrcodeGenerator
|
|
380
|
-
* @property {string} [method]
|
|
381
|
-
* @property {Kwargs} [kwargs]
|
|
382
|
-
*/
|
|
383
|
-
|
|
384
|
-
/**
|
|
385
|
-
* @typedef KwargsUpiQrcode
|
|
386
|
-
* @property {string} [qr_data]
|
|
387
|
-
* @property {string} [qr_url]
|
|
388
|
-
*/
|
|
389
|
-
|
|
390
|
-
/**
|
|
391
|
-
* @typedef UpiQrcodeGenerator
|
|
392
|
-
* @property {string} [method]
|
|
393
|
-
* @property {KwargsUpiQrcode} [kwargs]
|
|
394
|
-
*/
|
|
395
|
-
|
|
396
|
-
/**
|
|
397
|
-
* @typedef DigitalsignatureGenerator
|
|
398
|
-
* @property {string} [method]
|
|
399
|
-
* @property {Kwargs} [kwargs]
|
|
400
|
-
*/
|
|
401
|
-
|
|
402
|
-
/**
|
|
403
|
-
* @typedef KwargsAwbNumber
|
|
404
|
-
* @property {Object[]} [value]
|
|
405
|
-
*/
|
|
406
|
-
|
|
407
|
-
/**
|
|
408
|
-
* @typedef AwbNumberLabelBarcodeGenerator
|
|
409
|
-
* @property {string} [method]
|
|
410
|
-
* @property {KwargsAwbNumber} [kwargs]
|
|
411
|
-
*/
|
|
412
|
-
|
|
413
|
-
/**
|
|
414
|
-
* @typedef AwbNumberBarcodeGenerator
|
|
415
|
-
* @property {string} [method]
|
|
416
|
-
* @property {Kwargs} [kwargs]
|
|
417
|
-
*/
|
|
418
|
-
|
|
419
|
-
/**
|
|
420
|
-
* @typedef MetaProperty
|
|
421
|
-
* @property {ShipmentIdBarcodeGenerator} [shipment_id_barcode_generator]
|
|
422
|
-
* @property {SignedQrcodeGenerator} [signed_qrcode_generator]
|
|
423
|
-
* @property {UpiQrcodeGenerator} [upi_qrcode_generator]
|
|
424
|
-
* @property {DigitalsignatureGenerator} [digitalsignature_generator]
|
|
425
|
-
* @property {AwbNumberLabelBarcodeGenerator} [awb_number_label_barcode_generator]
|
|
426
|
-
* @property {AwbNumberBarcodeGenerator} [awb_number_barcode_generator]
|
|
427
|
-
*/
|
|
428
|
-
|
|
429
|
-
/**
|
|
430
|
-
* @typedef Meta
|
|
431
|
-
* @property {MetaProperty} [generator]
|
|
432
|
-
*/
|
|
433
|
-
|
|
434
|
-
/**
|
|
435
|
-
* @typedef DummyTemplateDataPayload
|
|
436
|
-
* @property {boolean} [is_export]
|
|
437
|
-
* @property {boolean} [is_export_shipment]
|
|
438
|
-
* @property {string} [app_domain_name]
|
|
439
|
-
* @property {string} [txn_id]
|
|
440
|
-
* @property {string} [utr]
|
|
441
|
-
* @property {string} [po_number]
|
|
442
|
-
* @property {string} [credit_note_id]
|
|
443
|
-
* @property {string} [current_date]
|
|
444
|
-
* @property {number} [total_value_of_goods]
|
|
445
|
-
* @property {Object} [b2b_buyer_details]
|
|
446
|
-
* @property {Object} [is_qwik]
|
|
447
|
-
* @property {string} [order_type]
|
|
448
|
-
* @property {ConversionRate} [conversion_rate]
|
|
449
|
-
* @property {string} [currency_code]
|
|
450
|
-
* @property {string} [shipment_id]
|
|
451
|
-
* @property {DeliveryPartnerDetail} [delivery_partner_detail]
|
|
452
|
-
* @property {Image} [image]
|
|
453
|
-
* @property {PaymentData[]} [payments]
|
|
454
|
-
* @property {InvoiceDetail} [invoice_detail]
|
|
455
|
-
* @property {CompanyDetail} [company_detail]
|
|
456
|
-
* @property {StoreDetail} [store_detail]
|
|
457
|
-
* @property {CustomerBillingDetail} [customer_billing_detail]
|
|
458
|
-
* @property {CustomerShippingDetail} [customer_shipping_detail]
|
|
459
|
-
* @property {ReturnDetail} [return_detail]
|
|
460
|
-
* @property {ProductTable} [product_table]
|
|
461
|
-
* @property {TaxTable} [tax_table]
|
|
462
|
-
* @property {string[]} [declaration_texts]
|
|
463
|
-
* @property {RegisteredCompanyDetail} [registered_company_detail]
|
|
464
|
-
* @property {string} [disclaimer]
|
|
465
|
-
* @property {Meta} [meta]
|
|
466
|
-
* @property {boolean} [is_self_ship]
|
|
467
|
-
* @property {string} [mode]
|
|
468
|
-
* @property {boolean} [is_self_pickup]
|
|
469
|
-
* @property {Object} [shipment_meta] - This field represents the shipment meta details
|
|
470
|
-
* @property {Object} [order_meta] - This field represents the order meta details
|
|
471
|
-
* @property {string} [platform_name]
|
|
472
|
-
* @property {number} [amount_to_be_collected]
|
|
473
|
-
* @property {number} [amount_paid]
|
|
474
|
-
* @property {Object[]} [waybills]
|
|
475
|
-
* @property {number} [total_items]
|
|
476
|
-
* @property {string} [brand_logo]
|
|
477
|
-
* @property {string} [shipment_id_barcode]
|
|
478
|
-
* @property {string} [signed_qrcode]
|
|
479
|
-
* @property {string} [upi_qrcode]
|
|
480
|
-
* @property {string} [digitalsignature]
|
|
481
|
-
* @property {string} [awb_number_barcode]
|
|
482
|
-
* @property {string} [uid]
|
|
483
|
-
*/
|
|
484
|
-
|
|
485
|
-
/**
|
|
486
|
-
* @typedef DummyTemplateData
|
|
487
|
-
* @property {string} [_id] - This field contains the unique identifier for the
|
|
488
|
-
* PDF payload.
|
|
489
|
-
* @property {number} [pdf_type_id] - This is invoice unique id
|
|
490
|
-
* @property {DummyTemplateDataPayload} payload
|
|
491
|
-
* @property {string} [country_code] - This field represents the country code.
|
|
492
|
-
* @property {number} [__v] - This field holds the version number.
|
|
493
|
-
*/
|
|
494
|
-
|
|
495
|
-
/**
|
|
496
|
-
* @typedef DummyTemplateDataItems
|
|
497
|
-
* @property {DummyTemplateData[]} data
|
|
498
|
-
* @property {boolean} success
|
|
499
|
-
*/
|
|
500
|
-
|
|
501
103
|
/**
|
|
502
104
|
* @typedef PdfConfig
|
|
503
105
|
* @property {string} [format] - This is invoice document format such as A4, A6, POS
|
|
504
|
-
* @property {string} [template] - This is html template string
|
|
505
|
-
* @property {number} [pdf_type_id]
|
|
106
|
+
* @property {string} [template] - This is html template string.
|
|
107
|
+
* @property {number} [pdf_type_id] - This field holds an identifier for the type of PDF.
|
|
108
|
+
* @property {string} [country_code] - This field contains the country code.
|
|
109
|
+
* @property {boolean} [default_template] - This field indicates whether the
|
|
110
|
+
* fetched HTML template is the default template.
|
|
506
111
|
*/
|
|
507
112
|
|
|
508
113
|
/**
|
|
509
114
|
* @typedef PdfConfigSuccessData
|
|
510
|
-
* @property {string} [_id]
|
|
511
|
-
*
|
|
512
|
-
* @property {
|
|
513
|
-
*
|
|
514
|
-
* @property {string} [
|
|
515
|
-
*
|
|
516
|
-
* @property {number} [
|
|
115
|
+
* @property {string} [_id] - This field contains the unique identifier for the
|
|
116
|
+
* PDF configuration.
|
|
117
|
+
* @property {number} [company_id] - This field holds the identifier for the
|
|
118
|
+
* company associated with the PDF configuration.
|
|
119
|
+
* @property {string} [application_id] - This field contains the identifier for
|
|
120
|
+
* the application that uses this PDF configuration.
|
|
121
|
+
* @property {number} [pdf_type_id] - This field holds an identifier for the type of PDF.
|
|
122
|
+
* @property {string} [format] - This field specifies the format of the invoice document.
|
|
123
|
+
* @property {string} [template] - This field contains the HTML template string
|
|
124
|
+
* for the PDF document.
|
|
125
|
+
* @property {number} [__v] - This field holds the version number of the PDF
|
|
126
|
+
* configuration document.
|
|
517
127
|
* @property {string} [country_code]
|
|
518
128
|
*/
|
|
519
129
|
|
|
@@ -540,22 +150,6 @@ const Joi = require("joi");
|
|
|
540
150
|
* @property {boolean} [success]
|
|
541
151
|
*/
|
|
542
152
|
|
|
543
|
-
/**
|
|
544
|
-
* @typedef PdfDefaultTemplateSuccess
|
|
545
|
-
* @property {Document[]} [data]
|
|
546
|
-
* @property {boolean} [success] - Indicates if the request was successful.
|
|
547
|
-
*/
|
|
548
|
-
|
|
549
|
-
/**
|
|
550
|
-
* @typedef Document
|
|
551
|
-
* @property {string} [_id]
|
|
552
|
-
* @property {number} [pdf_type_id]
|
|
553
|
-
* @property {string} [format]
|
|
554
|
-
* @property {string} [template]
|
|
555
|
-
* @property {string} [country_code]
|
|
556
|
-
* @property {number} [__v]
|
|
557
|
-
*/
|
|
558
|
-
|
|
559
153
|
/**
|
|
560
154
|
* @typedef PaymentReceiptRequestBody
|
|
561
155
|
* @property {PaymentReceiptPayload} [payload]
|
|
@@ -636,16 +230,8 @@ const Joi = require("joi");
|
|
|
636
230
|
*/
|
|
637
231
|
|
|
638
232
|
class FileStoragePlatformModel {
|
|
639
|
-
/** @returns {
|
|
640
|
-
static
|
|
641
|
-
return Joi.object({
|
|
642
|
-
data: Joi.object().pattern(/\S/, Joi.any()),
|
|
643
|
-
support: Joi.object().pattern(/\S/, Joi.any()),
|
|
644
|
-
});
|
|
645
|
-
}
|
|
646
|
-
|
|
647
|
-
/** @returns {FailedResponse} */
|
|
648
|
-
static FailedResponse() {
|
|
233
|
+
/** @returns {FailedBrowseFilesResult} */
|
|
234
|
+
static FailedBrowseFilesResult() {
|
|
649
235
|
return Joi.object({
|
|
650
236
|
message: Joi.string().allow("").required(),
|
|
651
237
|
});
|
|
@@ -668,8 +254,8 @@ class FileStoragePlatformModel {
|
|
|
668
254
|
});
|
|
669
255
|
}
|
|
670
256
|
|
|
671
|
-
/** @returns {
|
|
672
|
-
static
|
|
257
|
+
/** @returns {FileUpload} */
|
|
258
|
+
static FileUpload() {
|
|
673
259
|
return Joi.object({
|
|
674
260
|
file_name: Joi.string().allow("").required(),
|
|
675
261
|
file_path: Joi.string().allow("").required(),
|
|
@@ -679,20 +265,12 @@ class FileStoragePlatformModel {
|
|
|
679
265
|
operation: Joi.string().allow("").required(),
|
|
680
266
|
size: Joi.number().required(),
|
|
681
267
|
upload: FileStoragePlatformModel.Upload().required(),
|
|
682
|
-
cdn: FileStoragePlatformModel.CDN().required(),
|
|
683
268
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
684
269
|
});
|
|
685
270
|
}
|
|
686
271
|
|
|
687
|
-
/** @returns {
|
|
688
|
-
static
|
|
689
|
-
return Joi.object({
|
|
690
|
-
subpath: Joi.string().allow(""),
|
|
691
|
-
});
|
|
692
|
-
}
|
|
693
|
-
|
|
694
|
-
/** @returns {StartRequest} */
|
|
695
|
-
static StartRequest() {
|
|
272
|
+
/** @returns {FileUploadStart} */
|
|
273
|
+
static FileUploadStart() {
|
|
696
274
|
return Joi.object({
|
|
697
275
|
file_name: Joi.string().allow("").required(),
|
|
698
276
|
content_type: Joi.string().allow("").required(),
|
|
@@ -709,8 +287,8 @@ class FileStoragePlatformModel {
|
|
|
709
287
|
});
|
|
710
288
|
}
|
|
711
289
|
|
|
712
|
-
/** @returns {
|
|
713
|
-
static
|
|
290
|
+
/** @returns {FileUploadComplete} */
|
|
291
|
+
static FileUploadComplete() {
|
|
714
292
|
return Joi.object({
|
|
715
293
|
_id: Joi.string().allow("").required(),
|
|
716
294
|
file_name: Joi.string().allow("").required(),
|
|
@@ -730,6 +308,13 @@ class FileStoragePlatformModel {
|
|
|
730
308
|
});
|
|
731
309
|
}
|
|
732
310
|
|
|
311
|
+
/** @returns {ProxyFileAccess} */
|
|
312
|
+
static ProxyFileAccess() {
|
|
313
|
+
return Joi.object({
|
|
314
|
+
success: Joi.boolean(),
|
|
315
|
+
});
|
|
316
|
+
}
|
|
317
|
+
|
|
733
318
|
/** @returns {DestinationNamespace} */
|
|
734
319
|
static DestinationNamespace() {
|
|
735
320
|
return Joi.object({
|
|
@@ -754,490 +339,29 @@ class FileStoragePlatformModel {
|
|
|
754
339
|
});
|
|
755
340
|
}
|
|
756
341
|
|
|
757
|
-
/** @returns {
|
|
758
|
-
static
|
|
342
|
+
/** @returns {SignUrlResult} */
|
|
343
|
+
static SignUrlResult() {
|
|
759
344
|
return Joi.object({
|
|
760
345
|
urls: Joi.array().items(FileStoragePlatformModel.Urls()).required(),
|
|
761
346
|
});
|
|
762
347
|
}
|
|
763
348
|
|
|
764
|
-
/** @returns {
|
|
765
|
-
static
|
|
349
|
+
/** @returns {SignUrl} */
|
|
350
|
+
static SignUrl() {
|
|
766
351
|
return Joi.object({
|
|
767
352
|
expiry: Joi.number().required(),
|
|
768
353
|
urls: Joi.array().items(Joi.string().allow("")).required(),
|
|
769
354
|
});
|
|
770
355
|
}
|
|
771
356
|
|
|
772
|
-
/** @returns {InvoiceTypesDataResponse} */
|
|
773
|
-
static InvoiceTypesDataResponse() {
|
|
774
|
-
return Joi.object({
|
|
775
|
-
status: Joi.boolean(),
|
|
776
|
-
_id: Joi.string().allow("").required(),
|
|
777
|
-
pdf_type_id: Joi.number().required(),
|
|
778
|
-
name: Joi.string().allow("").required(),
|
|
779
|
-
format: Joi.array().items(Joi.string().allow("")).required(),
|
|
780
|
-
__v: Joi.number().required(),
|
|
781
|
-
visibility: Joi.boolean().required(),
|
|
782
|
-
country_code: Joi.string().allow("").required(),
|
|
783
|
-
});
|
|
784
|
-
}
|
|
785
|
-
|
|
786
|
-
/** @returns {InvoiceTypesResponse} */
|
|
787
|
-
static InvoiceTypesResponse() {
|
|
788
|
-
return Joi.object({
|
|
789
|
-
data: Joi.array()
|
|
790
|
-
.items(FileStoragePlatformModel.InvoiceTypesDataResponse())
|
|
791
|
-
.required(),
|
|
792
|
-
success: Joi.boolean().required(),
|
|
793
|
-
});
|
|
794
|
-
}
|
|
795
|
-
|
|
796
|
-
/** @returns {ConversionRate} */
|
|
797
|
-
static ConversionRate() {
|
|
798
|
-
return Joi.object({
|
|
799
|
-
base: Joi.string().allow(""),
|
|
800
|
-
rates: Joi.object().pattern(/\S/, Joi.any()),
|
|
801
|
-
timestamp: Joi.number(),
|
|
802
|
-
});
|
|
803
|
-
}
|
|
804
|
-
|
|
805
|
-
/** @returns {DeliveryPartnerDetail} */
|
|
806
|
-
static DeliveryPartnerDetail() {
|
|
807
|
-
return Joi.object({
|
|
808
|
-
name: Joi.string().allow(""),
|
|
809
|
-
awb_number_barcode: Joi.string().allow(""),
|
|
810
|
-
awb_number: Joi.string().allow(""),
|
|
811
|
-
origin: Joi.string().allow(""),
|
|
812
|
-
destination: Joi.string().allow(""),
|
|
813
|
-
eway_bill_number: Joi.string().allow("").allow(null),
|
|
814
|
-
});
|
|
815
|
-
}
|
|
816
|
-
|
|
817
|
-
/** @returns {Image} */
|
|
818
|
-
static Image() {
|
|
819
|
-
return Joi.object({
|
|
820
|
-
sales_channel_logo: Joi.string().allow(""),
|
|
821
|
-
});
|
|
822
|
-
}
|
|
823
|
-
|
|
824
|
-
/** @returns {PaymentData} */
|
|
825
|
-
static PaymentData() {
|
|
826
|
-
return Joi.object({
|
|
827
|
-
payment_type: Joi.string().allow(""),
|
|
828
|
-
amount: Joi.number(),
|
|
829
|
-
date: Joi.string().allow(""),
|
|
830
|
-
transaction_id: Joi.string().allow(""),
|
|
831
|
-
time: Joi.string().allow(""),
|
|
832
|
-
mode: Joi.string().allow(""),
|
|
833
|
-
name: Joi.string().allow(""),
|
|
834
|
-
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
835
|
-
});
|
|
836
|
-
}
|
|
837
|
-
|
|
838
|
-
/** @returns {InvoiceDetail} */
|
|
839
|
-
static InvoiceDetail() {
|
|
840
|
-
return Joi.object({
|
|
841
|
-
invoice_id: Joi.string().allow(""),
|
|
842
|
-
invoice_date: Joi.string().allow(""),
|
|
843
|
-
irn: Joi.string().allow(""),
|
|
844
|
-
external_order_id: Joi.string().allow(""),
|
|
845
|
-
shipment_id: Joi.string().allow(""),
|
|
846
|
-
signed_qrcode: Joi.string().allow(""),
|
|
847
|
-
upi_qrcode: Joi.string().allow(""),
|
|
848
|
-
device_id: Joi.string().allow(""),
|
|
849
|
-
marketplace_invoice_id: Joi.string().allow(""),
|
|
850
|
-
marketplace_shipment_id: Joi.string().allow(""),
|
|
851
|
-
channel_order_id: Joi.string().allow(""),
|
|
852
|
-
});
|
|
853
|
-
}
|
|
854
|
-
|
|
855
|
-
/** @returns {CompanyDetail} */
|
|
856
|
-
static CompanyDetail() {
|
|
857
|
-
return Joi.object({
|
|
858
|
-
name: Joi.string().allow(""),
|
|
859
|
-
address: Joi.string().allow(""),
|
|
860
|
-
city: Joi.string().allow(""),
|
|
861
|
-
state: Joi.string().allow(""),
|
|
862
|
-
country: Joi.string().allow(""),
|
|
863
|
-
zip_code: Joi.number(),
|
|
864
|
-
state_code: Joi.string().allow(""),
|
|
865
|
-
country_code: Joi.string().allow(""),
|
|
866
|
-
gstin: Joi.string().allow("").allow(null),
|
|
867
|
-
pan: Joi.string().allow("").allow(null),
|
|
868
|
-
phone_no: Joi.string().allow("").allow(null),
|
|
869
|
-
cin: Joi.string().allow(""),
|
|
870
|
-
website_url: Joi.string().allow(""),
|
|
871
|
-
email: Joi.string().allow(""),
|
|
872
|
-
display_address: Joi.string().allow(""),
|
|
873
|
-
sector: Joi.string().allow(""),
|
|
874
|
-
phone: Joi.object().pattern(/\S/, Joi.any()),
|
|
875
|
-
trn: Joi.string().allow(""),
|
|
876
|
-
vat: Joi.string().allow(""),
|
|
877
|
-
business_country_timezone: Joi.string().allow(""),
|
|
878
|
-
business_country_currency: Joi.object().pattern(/\S/, Joi.any()),
|
|
879
|
-
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
880
|
-
});
|
|
881
|
-
}
|
|
882
|
-
|
|
883
|
-
/** @returns {StoreDetail} */
|
|
884
|
-
static StoreDetail() {
|
|
885
|
-
return Joi.object({
|
|
886
|
-
store_name: Joi.string().allow(""),
|
|
887
|
-
address: Joi.string().allow(""),
|
|
888
|
-
city: Joi.string().allow(""),
|
|
889
|
-
state: Joi.string().allow(""),
|
|
890
|
-
country: Joi.string().allow(""),
|
|
891
|
-
country_code: Joi.string().allow(""),
|
|
892
|
-
zip_code: Joi.string().allow(""),
|
|
893
|
-
state_code: Joi.string().allow(""),
|
|
894
|
-
gstin: Joi.string().allow("").allow(null),
|
|
895
|
-
display_address: Joi.string().allow(""),
|
|
896
|
-
sector: Joi.string().allow(""),
|
|
897
|
-
store_id: Joi.string().allow(""),
|
|
898
|
-
});
|
|
899
|
-
}
|
|
900
|
-
|
|
901
|
-
/** @returns {CustomerBillingDetail} */
|
|
902
|
-
static CustomerBillingDetail() {
|
|
903
|
-
return Joi.object({
|
|
904
|
-
name: Joi.string().allow(""),
|
|
905
|
-
phone_no: Joi.string().allow(""),
|
|
906
|
-
address: Joi.string().allow(""),
|
|
907
|
-
city: Joi.string().allow(""),
|
|
908
|
-
state: Joi.string().allow(""),
|
|
909
|
-
country: Joi.string().allow(""),
|
|
910
|
-
country_code: Joi.string().allow(""),
|
|
911
|
-
zip_code: Joi.string().allow(""),
|
|
912
|
-
state_code: Joi.string().allow(""),
|
|
913
|
-
gstin: Joi.string().allow("").allow(null),
|
|
914
|
-
display_address: Joi.string().allow(""),
|
|
915
|
-
sector: Joi.string().allow(""),
|
|
916
|
-
email: Joi.string().allow(""),
|
|
917
|
-
});
|
|
918
|
-
}
|
|
919
|
-
|
|
920
|
-
/** @returns {CustomerShippingDetail} */
|
|
921
|
-
static CustomerShippingDetail() {
|
|
922
|
-
return Joi.object({
|
|
923
|
-
name: Joi.string().allow(""),
|
|
924
|
-
phone_no: Joi.string().allow(""),
|
|
925
|
-
address: Joi.string().allow(""),
|
|
926
|
-
city: Joi.string().allow(""),
|
|
927
|
-
state: Joi.string().allow(""),
|
|
928
|
-
country: Joi.string().allow(""),
|
|
929
|
-
country_code: Joi.string().allow(""),
|
|
930
|
-
zip_code: Joi.string().allow(""),
|
|
931
|
-
state_code: Joi.string().allow(""),
|
|
932
|
-
gstin: Joi.string().allow("").allow(null),
|
|
933
|
-
display_address: Joi.string().allow(""),
|
|
934
|
-
sector: Joi.string().allow(""),
|
|
935
|
-
});
|
|
936
|
-
}
|
|
937
|
-
|
|
938
|
-
/** @returns {ReturnDetail} */
|
|
939
|
-
static ReturnDetail() {
|
|
940
|
-
return Joi.object({
|
|
941
|
-
address: Joi.string().allow(""),
|
|
942
|
-
city: Joi.string().allow(""),
|
|
943
|
-
state: Joi.string().allow(""),
|
|
944
|
-
country: Joi.string().allow(""),
|
|
945
|
-
country_code: Joi.string().allow("").allow(null),
|
|
946
|
-
zip_code: Joi.string().allow(""),
|
|
947
|
-
state_code: Joi.string().allow(""),
|
|
948
|
-
gstin: Joi.string().allow("").allow(null),
|
|
949
|
-
display_address: Joi.string().allow(""),
|
|
950
|
-
sector: Joi.string().allow(""),
|
|
951
|
-
});
|
|
952
|
-
}
|
|
953
|
-
|
|
954
|
-
/** @returns {Brand} */
|
|
955
|
-
static Brand() {
|
|
956
|
-
return Joi.object({
|
|
957
|
-
logo: Joi.string().allow(""),
|
|
958
|
-
name: Joi.string().allow(""),
|
|
959
|
-
});
|
|
960
|
-
}
|
|
961
|
-
|
|
962
|
-
/** @returns {Cgst} */
|
|
963
|
-
static Cgst() {
|
|
964
|
-
return Joi.object({
|
|
965
|
-
value: Joi.number(),
|
|
966
|
-
percent: Joi.number(),
|
|
967
|
-
});
|
|
968
|
-
}
|
|
969
|
-
|
|
970
|
-
/** @returns {Sgst} */
|
|
971
|
-
static Sgst() {
|
|
972
|
-
return Joi.object({
|
|
973
|
-
value: Joi.number(),
|
|
974
|
-
percent: Joi.number(),
|
|
975
|
-
});
|
|
976
|
-
}
|
|
977
|
-
|
|
978
|
-
/** @returns {Igst} */
|
|
979
|
-
static Igst() {
|
|
980
|
-
return Joi.object({
|
|
981
|
-
value: Joi.number(),
|
|
982
|
-
percent: Joi.number(),
|
|
983
|
-
});
|
|
984
|
-
}
|
|
985
|
-
|
|
986
|
-
/** @returns {Tax} */
|
|
987
|
-
static Tax() {
|
|
988
|
-
return Joi.object({
|
|
989
|
-
cgst: FileStoragePlatformModel.Cgst(),
|
|
990
|
-
sgst: FileStoragePlatformModel.Sgst(),
|
|
991
|
-
igst: FileStoragePlatformModel.Igst(),
|
|
992
|
-
});
|
|
993
|
-
}
|
|
994
|
-
|
|
995
|
-
/** @returns {ItemsProductTable} */
|
|
996
|
-
static ItemsProductTable() {
|
|
997
|
-
return Joi.object({
|
|
998
|
-
name: Joi.string().allow(""),
|
|
999
|
-
seller_identifier: Joi.string().allow(""),
|
|
1000
|
-
total: Joi.number(),
|
|
1001
|
-
brand: FileStoragePlatformModel.Brand(),
|
|
1002
|
-
hsn_code: Joi.string().allow(""),
|
|
1003
|
-
item_code: Joi.string().allow(""),
|
|
1004
|
-
total_units: Joi.number(),
|
|
1005
|
-
size: Joi.string().allow(""),
|
|
1006
|
-
mrp: Joi.number(),
|
|
1007
|
-
discount: Joi.number(),
|
|
1008
|
-
taxable_amount: Joi.number(),
|
|
1009
|
-
total_taxable_amount: Joi.number(),
|
|
1010
|
-
tax: FileStoragePlatformModel.Tax(),
|
|
1011
|
-
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
1012
|
-
country_of_origin: Joi.string().allow(""),
|
|
1013
|
-
});
|
|
1014
|
-
}
|
|
1015
|
-
|
|
1016
|
-
/** @returns {ProductTable} */
|
|
1017
|
-
static ProductTable() {
|
|
1018
|
-
return Joi.object({
|
|
1019
|
-
total_items: Joi.number(),
|
|
1020
|
-
products: Joi.array().items(FileStoragePlatformModel.ItemsProductTable()),
|
|
1021
|
-
grand_total: Joi.number(),
|
|
1022
|
-
delivery_charges: Joi.number(),
|
|
1023
|
-
delivery_charge_text: Joi.string().allow(""),
|
|
1024
|
-
cod_charges: Joi.number(),
|
|
1025
|
-
fynd_discounts: Joi.number(),
|
|
1026
|
-
total_in_words: Joi.string().allow(""),
|
|
1027
|
-
gift_price: Joi.number(),
|
|
1028
|
-
total_quantity: Joi.number(),
|
|
1029
|
-
sub_total: Joi.number(),
|
|
1030
|
-
discount: Joi.number(),
|
|
1031
|
-
promotion: Joi.number(),
|
|
1032
|
-
coupon: Joi.number(),
|
|
1033
|
-
reward: Joi.number(),
|
|
1034
|
-
round_off: Joi.number(),
|
|
1035
|
-
total_value_of_goods: Joi.number(),
|
|
1036
|
-
});
|
|
1037
|
-
}
|
|
1038
|
-
|
|
1039
|
-
/** @returns {Taxes} */
|
|
1040
|
-
static Taxes() {
|
|
1041
|
-
return Joi.object({
|
|
1042
|
-
hsn_code: Joi.string().allow(""),
|
|
1043
|
-
tax: FileStoragePlatformModel.Tax(),
|
|
1044
|
-
total_tax_value: Joi.number(),
|
|
1045
|
-
});
|
|
1046
|
-
}
|
|
1047
|
-
|
|
1048
|
-
/** @returns {TaxTable} */
|
|
1049
|
-
static TaxTable() {
|
|
1050
|
-
return Joi.object({
|
|
1051
|
-
taxes: Joi.array().items(FileStoragePlatformModel.Taxes()),
|
|
1052
|
-
total_tax: Joi.number(),
|
|
1053
|
-
tax_in_words: Joi.string().allow(""),
|
|
1054
|
-
});
|
|
1055
|
-
}
|
|
1056
|
-
|
|
1057
|
-
/** @returns {RegisteredCompanyDetail} */
|
|
1058
|
-
static RegisteredCompanyDetail() {
|
|
1059
|
-
return Joi.object({
|
|
1060
|
-
address: Joi.string().allow(""),
|
|
1061
|
-
city: Joi.string().allow(""),
|
|
1062
|
-
state: Joi.string().allow(""),
|
|
1063
|
-
country: Joi.string().allow(""),
|
|
1064
|
-
country_code: Joi.string().allow(""),
|
|
1065
|
-
zip_code: Joi.number(),
|
|
1066
|
-
state_code: Joi.string().allow(""),
|
|
1067
|
-
display_address: Joi.string().allow(""),
|
|
1068
|
-
sector: Joi.string().allow(""),
|
|
1069
|
-
});
|
|
1070
|
-
}
|
|
1071
|
-
|
|
1072
|
-
/** @returns {Kwargs} */
|
|
1073
|
-
static Kwargs() {
|
|
1074
|
-
return Joi.object({
|
|
1075
|
-
value: Joi.string().allow(""),
|
|
1076
|
-
});
|
|
1077
|
-
}
|
|
1078
|
-
|
|
1079
|
-
/** @returns {ShipmentIdBarcodeGenerator} */
|
|
1080
|
-
static ShipmentIdBarcodeGenerator() {
|
|
1081
|
-
return Joi.object({
|
|
1082
|
-
method: Joi.string().allow(""),
|
|
1083
|
-
kwargs: FileStoragePlatformModel.Kwargs(),
|
|
1084
|
-
});
|
|
1085
|
-
}
|
|
1086
|
-
|
|
1087
|
-
/** @returns {SignedQrcodeGenerator} */
|
|
1088
|
-
static SignedQrcodeGenerator() {
|
|
1089
|
-
return Joi.object({
|
|
1090
|
-
method: Joi.string().allow(""),
|
|
1091
|
-
kwargs: FileStoragePlatformModel.Kwargs(),
|
|
1092
|
-
});
|
|
1093
|
-
}
|
|
1094
|
-
|
|
1095
|
-
/** @returns {KwargsUpiQrcode} */
|
|
1096
|
-
static KwargsUpiQrcode() {
|
|
1097
|
-
return Joi.object({
|
|
1098
|
-
qr_data: Joi.string().allow(""),
|
|
1099
|
-
qr_url: Joi.string().allow(""),
|
|
1100
|
-
});
|
|
1101
|
-
}
|
|
1102
|
-
|
|
1103
|
-
/** @returns {UpiQrcodeGenerator} */
|
|
1104
|
-
static UpiQrcodeGenerator() {
|
|
1105
|
-
return Joi.object({
|
|
1106
|
-
method: Joi.string().allow(""),
|
|
1107
|
-
kwargs: FileStoragePlatformModel.KwargsUpiQrcode(),
|
|
1108
|
-
});
|
|
1109
|
-
}
|
|
1110
|
-
|
|
1111
|
-
/** @returns {DigitalsignatureGenerator} */
|
|
1112
|
-
static DigitalsignatureGenerator() {
|
|
1113
|
-
return Joi.object({
|
|
1114
|
-
method: Joi.string().allow(""),
|
|
1115
|
-
kwargs: FileStoragePlatformModel.Kwargs(),
|
|
1116
|
-
});
|
|
1117
|
-
}
|
|
1118
|
-
|
|
1119
|
-
/** @returns {KwargsAwbNumber} */
|
|
1120
|
-
static KwargsAwbNumber() {
|
|
1121
|
-
return Joi.object({
|
|
1122
|
-
value: Joi.array().items(Joi.any()),
|
|
1123
|
-
});
|
|
1124
|
-
}
|
|
1125
|
-
|
|
1126
|
-
/** @returns {AwbNumberLabelBarcodeGenerator} */
|
|
1127
|
-
static AwbNumberLabelBarcodeGenerator() {
|
|
1128
|
-
return Joi.object({
|
|
1129
|
-
method: Joi.string().allow(""),
|
|
1130
|
-
kwargs: FileStoragePlatformModel.KwargsAwbNumber(),
|
|
1131
|
-
});
|
|
1132
|
-
}
|
|
1133
|
-
|
|
1134
|
-
/** @returns {AwbNumberBarcodeGenerator} */
|
|
1135
|
-
static AwbNumberBarcodeGenerator() {
|
|
1136
|
-
return Joi.object({
|
|
1137
|
-
method: Joi.string().allow(""),
|
|
1138
|
-
kwargs: FileStoragePlatformModel.Kwargs(),
|
|
1139
|
-
});
|
|
1140
|
-
}
|
|
1141
|
-
|
|
1142
|
-
/** @returns {MetaProperty} */
|
|
1143
|
-
static MetaProperty() {
|
|
1144
|
-
return Joi.object({
|
|
1145
|
-
shipment_id_barcode_generator: FileStoragePlatformModel.ShipmentIdBarcodeGenerator(),
|
|
1146
|
-
signed_qrcode_generator: FileStoragePlatformModel.SignedQrcodeGenerator(),
|
|
1147
|
-
upi_qrcode_generator: FileStoragePlatformModel.UpiQrcodeGenerator(),
|
|
1148
|
-
digitalsignature_generator: FileStoragePlatformModel.DigitalsignatureGenerator(),
|
|
1149
|
-
awb_number_label_barcode_generator: FileStoragePlatformModel.AwbNumberLabelBarcodeGenerator(),
|
|
1150
|
-
awb_number_barcode_generator: FileStoragePlatformModel.AwbNumberBarcodeGenerator(),
|
|
1151
|
-
});
|
|
1152
|
-
}
|
|
1153
|
-
|
|
1154
|
-
/** @returns {Meta} */
|
|
1155
|
-
static Meta() {
|
|
1156
|
-
return Joi.object({
|
|
1157
|
-
generator: FileStoragePlatformModel.MetaProperty(),
|
|
1158
|
-
});
|
|
1159
|
-
}
|
|
1160
|
-
|
|
1161
|
-
/** @returns {DummyTemplateDataPayload} */
|
|
1162
|
-
static DummyTemplateDataPayload() {
|
|
1163
|
-
return Joi.object({
|
|
1164
|
-
is_export: Joi.boolean(),
|
|
1165
|
-
is_export_shipment: Joi.boolean(),
|
|
1166
|
-
app_domain_name: Joi.string().allow(""),
|
|
1167
|
-
txn_id: Joi.string().allow(""),
|
|
1168
|
-
utr: Joi.string().allow(""),
|
|
1169
|
-
po_number: Joi.string().allow(""),
|
|
1170
|
-
credit_note_id: Joi.string().allow("").allow(null),
|
|
1171
|
-
current_date: Joi.string().allow(""),
|
|
1172
|
-
total_value_of_goods: Joi.number(),
|
|
1173
|
-
b2b_buyer_details: Joi.object().pattern(/\S/, Joi.any()),
|
|
1174
|
-
is_qwik: Joi.object().pattern(/\S/, Joi.any()),
|
|
1175
|
-
order_type: Joi.string().allow(""),
|
|
1176
|
-
conversion_rate: FileStoragePlatformModel.ConversionRate(),
|
|
1177
|
-
currency_code: Joi.string().allow(""),
|
|
1178
|
-
shipment_id: Joi.string().allow(""),
|
|
1179
|
-
delivery_partner_detail: FileStoragePlatformModel.DeliveryPartnerDetail(),
|
|
1180
|
-
image: FileStoragePlatformModel.Image(),
|
|
1181
|
-
payments: Joi.array().items(FileStoragePlatformModel.PaymentData()),
|
|
1182
|
-
invoice_detail: FileStoragePlatformModel.InvoiceDetail(),
|
|
1183
|
-
company_detail: FileStoragePlatformModel.CompanyDetail(),
|
|
1184
|
-
store_detail: FileStoragePlatformModel.StoreDetail(),
|
|
1185
|
-
customer_billing_detail: FileStoragePlatformModel.CustomerBillingDetail(),
|
|
1186
|
-
customer_shipping_detail: FileStoragePlatformModel.CustomerShippingDetail(),
|
|
1187
|
-
return_detail: FileStoragePlatformModel.ReturnDetail(),
|
|
1188
|
-
product_table: FileStoragePlatformModel.ProductTable(),
|
|
1189
|
-
tax_table: FileStoragePlatformModel.TaxTable(),
|
|
1190
|
-
declaration_texts: Joi.array().items(Joi.string().allow("")),
|
|
1191
|
-
registered_company_detail: FileStoragePlatformModel.RegisteredCompanyDetail(),
|
|
1192
|
-
disclaimer: Joi.string().allow(""),
|
|
1193
|
-
meta: FileStoragePlatformModel.Meta(),
|
|
1194
|
-
is_self_ship: Joi.boolean(),
|
|
1195
|
-
mode: Joi.string().allow(""),
|
|
1196
|
-
is_self_pickup: Joi.boolean(),
|
|
1197
|
-
shipment_meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
1198
|
-
order_meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
1199
|
-
platform_name: Joi.string().allow(""),
|
|
1200
|
-
amount_to_be_collected: Joi.number(),
|
|
1201
|
-
amount_paid: Joi.number(),
|
|
1202
|
-
waybills: Joi.array().items(Joi.any()),
|
|
1203
|
-
total_items: Joi.number(),
|
|
1204
|
-
brand_logo: Joi.string().allow(""),
|
|
1205
|
-
shipment_id_barcode: Joi.string().allow(""),
|
|
1206
|
-
signed_qrcode: Joi.string().allow(""),
|
|
1207
|
-
upi_qrcode: Joi.string().allow(""),
|
|
1208
|
-
digitalsignature: Joi.string().allow(""),
|
|
1209
|
-
awb_number_barcode: Joi.string().allow(""),
|
|
1210
|
-
uid: Joi.string().allow(""),
|
|
1211
|
-
});
|
|
1212
|
-
}
|
|
1213
|
-
|
|
1214
|
-
/** @returns {DummyTemplateData} */
|
|
1215
|
-
static DummyTemplateData() {
|
|
1216
|
-
return Joi.object({
|
|
1217
|
-
_id: Joi.string().allow(""),
|
|
1218
|
-
pdf_type_id: Joi.number(),
|
|
1219
|
-
payload: FileStoragePlatformModel.DummyTemplateDataPayload().required(),
|
|
1220
|
-
country_code: Joi.string().allow(""),
|
|
1221
|
-
__v: Joi.number(),
|
|
1222
|
-
});
|
|
1223
|
-
}
|
|
1224
|
-
|
|
1225
|
-
/** @returns {DummyTemplateDataItems} */
|
|
1226
|
-
static DummyTemplateDataItems() {
|
|
1227
|
-
return Joi.object({
|
|
1228
|
-
data: Joi.array()
|
|
1229
|
-
.items(FileStoragePlatformModel.DummyTemplateData())
|
|
1230
|
-
.required(),
|
|
1231
|
-
success: Joi.boolean().required(),
|
|
1232
|
-
});
|
|
1233
|
-
}
|
|
1234
|
-
|
|
1235
357
|
/** @returns {PdfConfig} */
|
|
1236
358
|
static PdfConfig() {
|
|
1237
359
|
return Joi.object({
|
|
1238
360
|
format: Joi.string().allow(""),
|
|
1239
361
|
template: Joi.string().allow(""),
|
|
1240
362
|
pdf_type_id: Joi.number(),
|
|
363
|
+
country_code: Joi.string().allow(""),
|
|
364
|
+
default_template: Joi.boolean(),
|
|
1241
365
|
});
|
|
1242
366
|
}
|
|
1243
367
|
|
|
@@ -1284,26 +408,6 @@ class FileStoragePlatformModel {
|
|
|
1284
408
|
});
|
|
1285
409
|
}
|
|
1286
410
|
|
|
1287
|
-
/** @returns {PdfDefaultTemplateSuccess} */
|
|
1288
|
-
static PdfDefaultTemplateSuccess() {
|
|
1289
|
-
return Joi.object({
|
|
1290
|
-
data: Joi.array().items(FileStoragePlatformModel.Document()),
|
|
1291
|
-
success: Joi.boolean(),
|
|
1292
|
-
});
|
|
1293
|
-
}
|
|
1294
|
-
|
|
1295
|
-
/** @returns {Document} */
|
|
1296
|
-
static Document() {
|
|
1297
|
-
return Joi.object({
|
|
1298
|
-
_id: Joi.string().allow(""),
|
|
1299
|
-
pdf_type_id: Joi.number(),
|
|
1300
|
-
format: Joi.string().allow(""),
|
|
1301
|
-
template: Joi.string().allow(""),
|
|
1302
|
-
country_code: Joi.string().allow(""),
|
|
1303
|
-
__v: Joi.number(),
|
|
1304
|
-
});
|
|
1305
|
-
}
|
|
1306
|
-
|
|
1307
411
|
/** @returns {PaymentReceiptRequestBody} */
|
|
1308
412
|
static PaymentReceiptRequestBody() {
|
|
1309
413
|
return Joi.object({
|
|
@@ -1385,7 +489,7 @@ class FileStoragePlatformModel {
|
|
|
1385
489
|
return Joi.object({
|
|
1386
490
|
job_type: Joi.string().allow(""),
|
|
1387
491
|
action: Joi.string().allow(""),
|
|
1388
|
-
event: Joi.any(),
|
|
492
|
+
event: Joi.object().pattern(/\S/, Joi.any()),
|
|
1389
493
|
organizaton_id: Joi.string().allow(""),
|
|
1390
494
|
company_id: Joi.number(),
|
|
1391
495
|
application_id: Joi.array().items(Joi.string().allow("")),
|
|
@@ -1393,7 +497,7 @@ class FileStoragePlatformModel {
|
|
|
1393
497
|
trace_id: Joi.array().items(Joi.string().allow("")),
|
|
1394
498
|
created_timestamp: Joi.number(),
|
|
1395
499
|
service: FileStoragePlatformModel.PaymentReceiptService(),
|
|
1396
|
-
event_trace_info: Joi.any(),
|
|
500
|
+
event_trace_info: Joi.object().pattern(/\S/, Joi.any()),
|
|
1397
501
|
trace: Joi.string().allow(""),
|
|
1398
502
|
});
|
|
1399
503
|
}
|