@gofynd/fdk-client-javascript 1.4.13 → 1.4.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +60 -53
- package/sdk/application/Cart/CartApplicationClient.js +130 -53
- package/sdk/application/Cart/CartApplicationModel.d.ts +489 -143
- package/sdk/application/Cart/CartApplicationModel.js +380 -159
- package/sdk/application/Cart/CartApplicationValidator.d.ts +38 -19
- package/sdk/application/Cart/CartApplicationValidator.js +34 -18
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +88 -68
- package/sdk/application/Catalog/CatalogApplicationClient.js +114 -94
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +194 -142
- package/sdk/application/Catalog/CatalogApplicationModel.js +171 -133
- package/sdk/application/Common/CommonApplicationClient.d.ts +3 -2
- package/sdk/application/Common/CommonApplicationClient.js +6 -5
- package/sdk/application/Common/CommonApplicationModel.d.ts +9 -9
- package/sdk/application/Common/CommonApplicationModel.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -27
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +34 -27
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +45 -57
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +35 -47
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +2 -2
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +2 -2
- package/sdk/application/Content/ContentApplicationClient.d.ts +23 -33
- package/sdk/application/Content/ContentApplicationClient.js +54 -75
- package/sdk/application/Content/ContentApplicationModel.d.ts +93 -37
- package/sdk/application/Content/ContentApplicationModel.js +83 -32
- package/sdk/application/Content/ContentApplicationValidator.d.ts +23 -17
- package/sdk/application/Content/ContentApplicationValidator.js +15 -10
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -8
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +14 -13
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +23 -25
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +16 -18
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +6 -6
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +36 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +202 -0
- package/sdk/application/Finance/FinanceApplicationModel.d.ts +289 -0
- package/sdk/application/Finance/FinanceApplicationModel.js +208 -0
- package/sdk/application/Finance/FinanceApplicationValidator.d.ts +25 -0
- package/sdk/application/Finance/FinanceApplicationValidator.js +31 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -3
- package/sdk/application/Lead/LeadApplicationClient.js +2 -3
- package/sdk/application/Lead/LeadApplicationModel.d.ts +11 -11
- package/sdk/application/Lead/LeadApplicationModel.js +19 -19
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +39 -16
- package/sdk/application/Logistic/LogisticApplicationClient.js +189 -21
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +532 -173
- package/sdk/application/Logistic/LogisticApplicationModel.js +409 -139
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +54 -9
- package/sdk/application/Logistic/LogisticApplicationValidator.js +42 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -10
- package/sdk/application/Order/OrderApplicationClient.js +96 -13
- package/sdk/application/Order/OrderApplicationModel.d.ts +434 -102
- package/sdk/application/Order/OrderApplicationModel.js +278 -73
- package/sdk/application/Order/OrderApplicationValidator.d.ts +17 -3
- package/sdk/application/Order/OrderApplicationValidator.js +15 -2
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +96 -99
- package/sdk/application/Payment/PaymentApplicationClient.js +111 -114
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +293 -289
- package/sdk/application/Payment/PaymentApplicationModel.js +243 -241
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationValidator.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -16
- package/sdk/application/Rewards/RewardsApplicationClient.js +19 -22
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +37 -37
- package/sdk/application/Rewards/RewardsApplicationModel.js +29 -29
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +6 -6
- package/sdk/application/Rewards/RewardsApplicationValidator.js +6 -6
- package/sdk/application/Share/ShareApplicationModel.js +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -6
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +48 -17
- package/sdk/application/Theme/ThemeApplicationModel.js +42 -22
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +16 -3
- package/sdk/application/Theme/ThemeApplicationValidator.js +9 -2
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +10 -10
- package/sdk/application/User/UserApplicationModel.d.ts +17 -17
- package/sdk/application/User/UserApplicationModel.js +16 -16
- package/sdk/application/User/UserApplicationValidator.d.ts +2 -2
- package/sdk/application/User/UserApplicationValidator.js +2 -2
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +4 -4
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +11 -9
- package/sdk/application/Webhook/WebhookApplicationModel.js +8 -6
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +2 -2
- package/sdk/application/Webhook/WebhookApplicationValidator.js +2 -2
- package/sdk/application/index.d.ts +1 -0
- package/sdk/application/index.js +2 -0
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +767 -85
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +429 -76
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +120 -6
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- 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 +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +407 -112
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +111 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +106 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +4978 -1303
- package/sdk/platform/Cart/CartPlatformModel.js +1922 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +208 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +383 -358
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +122 -126
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +66 -68
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +141 -118
- package/sdk/platform/Catalog/CatalogPlatformClient.js +193 -170
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1516 -1766
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1393 -1224
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +18 -18
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +18 -18
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1241 -395
- package/sdk/platform/Content/ContentPlatformModel.js +521 -390
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +15 -4
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +83 -5
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +25 -4
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +16 -3
- package/sdk/platform/Order/OrderPlatformClient.d.ts +178 -97
- package/sdk/platform/Order/OrderPlatformClient.js +589 -229
- package/sdk/platform/Order/OrderPlatformModel.d.ts +5447 -3071
- package/sdk/platform/Order/OrderPlatformModel.js +3496 -1653
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +241 -176
- package/sdk/platform/Order/OrderPlatformValidator.js +153 -97
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +327 -313
- package/sdk/platform/Payment/PaymentPlatformModel.js +283 -273
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +45 -35
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +117 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +22 -13
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +24 -12
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +40 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +58 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +602 -341
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +483 -284
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +8 -8
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
- package/sdk/platform/Share/SharePlatformModel.js +27 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +791 -5
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- 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
|
@@ -35,7 +35,12 @@ const Joi = require("joi");
|
|
|
35
35
|
* @property {string} [name] - The official name of the entity.
|
|
36
36
|
* @property {string} [display] - The name of the entity as it should be displayed.
|
|
37
37
|
* @property {string} [currency_code] - The international currency code
|
|
38
|
-
* representing the currency used for the value.
|
|
38
|
+
* representing the currency used for the value. This specifies the currency
|
|
39
|
+
* code for all amounts. The currency_code field will hold a string value
|
|
40
|
+
* representing the code for the currency in which all monetary amounts are
|
|
41
|
+
* denominated. This code typically follows the ISO 4217 standard, which uses
|
|
42
|
+
* three-letter alphabetic codes to define different currencies around the
|
|
43
|
+
* world. For example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
|
|
39
44
|
*/
|
|
40
45
|
|
|
41
46
|
/**
|
|
@@ -79,8 +84,47 @@ const Joi = require("joi");
|
|
|
79
84
|
* @property {string} [code] - A code associated with the store.
|
|
80
85
|
* @property {string} [name] - The name of the store.
|
|
81
86
|
* @property {string} [company_name] - The name of the company associated with the store.
|
|
82
|
-
* @property {number} [company_id] -
|
|
83
|
-
|
|
87
|
+
* @property {number} [company_id] - Schema for fulfilling store.
|
|
88
|
+
*/
|
|
89
|
+
|
|
90
|
+
/**
|
|
91
|
+
* @typedef ChargeDistributionSchema
|
|
92
|
+
* @property {string} type - This field defines the distribution type, e.g
|
|
93
|
+
* values('multi', 'single') multi: distribute the changes across all entity
|
|
94
|
+
* single: distribute the changes across to any one single entity
|
|
95
|
+
* @property {string} logic - This field defines the distribution logic e.g
|
|
96
|
+
* values('apportion', 'equally') apportion: distribute charge amount based of
|
|
97
|
+
* weighted average amount of all the entity (like article with [10, 20] will
|
|
98
|
+
* get charge of 9 as [3, 6]) equally: distribute charge amount 'equally' to
|
|
99
|
+
* all the entity
|
|
100
|
+
*/
|
|
101
|
+
|
|
102
|
+
/**
|
|
103
|
+
* @typedef ChargeDistributionLogic
|
|
104
|
+
* @property {ChargeDistributionSchema} distribution
|
|
105
|
+
* @property {string} distribution_level - This field defines the distribution
|
|
106
|
+
* level, e.g distribution level is (order, shipment, article)
|
|
107
|
+
*/
|
|
108
|
+
|
|
109
|
+
/**
|
|
110
|
+
* @typedef ChargeAmountCurrency
|
|
111
|
+
* @property {number} value - Charge currency value or amount
|
|
112
|
+
* @property {string} currency - Charge currency code
|
|
113
|
+
*/
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* @typedef ChargeAmount
|
|
117
|
+
* @property {ChargeAmountCurrency} base_currency
|
|
118
|
+
* @property {ChargeAmountCurrency} ordering_currency
|
|
119
|
+
*/
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* @typedef PriceAdjustmentCharge
|
|
123
|
+
* @property {string} [code] - Code defined for charge
|
|
124
|
+
* @property {string} name - Display name for charge (charge is unique by the name)
|
|
125
|
+
* @property {string} [type] - Type defined for charge
|
|
126
|
+
* @property {ChargeAmount} amount
|
|
127
|
+
* @property {ChargeDistributionLogic} distribution_logic
|
|
84
128
|
*/
|
|
85
129
|
|
|
86
130
|
/**
|
|
@@ -90,7 +134,10 @@ const Joi = require("joi");
|
|
|
90
134
|
* @property {string} [title] - The title or display name representing the
|
|
91
135
|
* shipment status.
|
|
92
136
|
* @property {string} [hex_code] - The hexadecimal color code associated with
|
|
93
|
-
* the shipment status.
|
|
137
|
+
* the shipment status. Each state of a shipment (like "processing",
|
|
138
|
+
* "cancelled", "delivered", etc.) is associated with a unique color,
|
|
139
|
+
* represented by a hex code. This color coding makes it visually intuitive
|
|
140
|
+
* for users to understand the status of their shipment at a glance.
|
|
94
141
|
*/
|
|
95
142
|
|
|
96
143
|
/**
|
|
@@ -170,7 +217,12 @@ const Joi = require("joi");
|
|
|
170
217
|
* @property {number} [promotion_effective_discount] - The effective discount
|
|
171
218
|
* from promotions.
|
|
172
219
|
* @property {number} [refund_amount] - The amount refunded to the customer.
|
|
173
|
-
* @property {string} [currency_code] -
|
|
220
|
+
* @property {string} [currency_code] - This specifies the currency code for all
|
|
221
|
+
* amounts. The currency_code field will hold a string value representing the
|
|
222
|
+
* code for the currency in which all monetary amounts are denominated. This
|
|
223
|
+
* code typically follows the ISO 4217 standard, which uses three-letter
|
|
224
|
+
* alphabetic codes to define different currencies around the world. For
|
|
225
|
+
* example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
|
|
174
226
|
* @property {number} [fynd_credits] - The amount of Fynd credits used.
|
|
175
227
|
* @property {number} [amount_to_be_collected] - The total amount that needs to
|
|
176
228
|
* be collected from the customer.
|
|
@@ -191,7 +243,9 @@ const Joi = require("joi");
|
|
|
191
243
|
* @property {string} [code] - The code or SKU of the item.
|
|
192
244
|
* @property {number} [id] - The unique identifier of the item.
|
|
193
245
|
* @property {string} [name] - The name of the item.
|
|
194
|
-
* @property {string} [l3_category_name] -
|
|
246
|
+
* @property {string} [l3_category_name] - This key specifies the name of the
|
|
247
|
+
* third-level category under which the product is listed, offering a more
|
|
248
|
+
* detailed classification within the e-commerce platform's hierarchy.
|
|
195
249
|
* @property {string} [slug_key] - A unique key or identifier for the item slug.
|
|
196
250
|
* @property {string[]} [l2_categories] - An array of level 2 categories the
|
|
197
251
|
* item belongs to.
|
|
@@ -217,7 +271,22 @@ const Joi = require("joi");
|
|
|
217
271
|
* qualify for the promotion.
|
|
218
272
|
* @property {string} [promo_id] - The unique identifier for the promotion.
|
|
219
273
|
* @property {number} [amount] - The discount amount provided by the promotion.
|
|
220
|
-
* @property {string} [promotion_type] -
|
|
274
|
+
* @property {string} [promotion_type] - Specifies the type of discount or deal
|
|
275
|
+
* applied to the current promotion, defining how the promotion modifies the
|
|
276
|
+
* price or adds value to the purchase. Each type represents a different
|
|
277
|
+
* promotional strategy - percentage- Discount by a percentage of the original
|
|
278
|
+
* price. - amount- Discount by a specific amount off the original price. -
|
|
279
|
+
* fixed_price- Sets the price to a specific fixed amount. - bogo- Buy One Get
|
|
280
|
+
* One or at a discount. - contract_price- Special pricing based on a contract
|
|
281
|
+
* or agreement. - shipping_price- Discount or deal related to the shipping
|
|
282
|
+
* cost. - ladder_price- Price changes based on quantity purchased. -
|
|
283
|
+
* bundle_price_percentage- Discount on a bundle purchase by a percentage. -
|
|
284
|
+
* bundle_price_amount- Discount on a bundle purchase by a specific amount. -
|
|
285
|
+
* bundle_amount_percentage- A percentage of the purchase amount is applied as
|
|
286
|
+
* a discount when buying in a bundle. - custom- A custom promotion not
|
|
287
|
+
* covered by other types. - free_gift_items- Free gift items are included
|
|
288
|
+
* with the purchase. - free_non_sellable_items- Free items that are not for
|
|
289
|
+
* sale are included with the purchase.
|
|
221
290
|
* @property {AppliedFreeArticles[]} [applied_free_articles] - An array
|
|
222
291
|
* containing details of free articles applied under the promotion.
|
|
223
292
|
*/
|
|
@@ -225,7 +294,12 @@ const Joi = require("joi");
|
|
|
225
294
|
/**
|
|
226
295
|
* @typedef Identifiers
|
|
227
296
|
* @property {string} [ean] - The European Article Number (EAN) of the item.
|
|
228
|
-
* @property {string} [sku_code] - The Stock Keeping Unit (SKU) code of the item
|
|
297
|
+
* @property {string} [sku_code] - The Stock Keeping Unit (SKU) code of the item
|
|
298
|
+
* - uniquely identifies each distinct product. SKUs are used to track
|
|
299
|
+
* inventory levels, facilitate accurate stocktaking, and streamline order
|
|
300
|
+
* fulfillment processes. This code is essential for inventory management,
|
|
301
|
+
* allowing for the differentiation between products based on attributes such
|
|
302
|
+
* as price, color, and size.
|
|
229
303
|
*/
|
|
230
304
|
|
|
231
305
|
/**
|
|
@@ -237,8 +311,12 @@ const Joi = require("joi");
|
|
|
237
311
|
* other charges.
|
|
238
312
|
* @property {number} [price_marked] - The original marked price of the item.
|
|
239
313
|
* @property {number} [coupon_effective_discount] - The effective discount from coupons.
|
|
240
|
-
* @property {string} [hsn_code] - The HSN (Harmonized System of
|
|
241
|
-
*
|
|
314
|
+
* @property {string} [hsn_code] - The HSN Code (Harmonized System of
|
|
315
|
+
* Nomenclature Code) is an internationally standardized system for
|
|
316
|
+
* classifying goods. It is used in trade and commerce to identify products
|
|
317
|
+
* and services uniformly across different countries and industries. The
|
|
318
|
+
* system was developed by the World Customs Organization (WCO) and is widely
|
|
319
|
+
* used in customs processes and tax systems.
|
|
242
320
|
* @property {number} [discount] - The discount applied to the item.
|
|
243
321
|
* @property {number} [gst_tax_percentage] - The GST tax percentage applied .
|
|
244
322
|
* @property {number} [cod_charges] - The cash on delivery charges, if applicable.
|
|
@@ -271,8 +349,13 @@ const Joi = require("joi");
|
|
|
271
349
|
* @property {string} [updated_at] - The date and time when the status was last updated.
|
|
272
350
|
* @property {string} [name] - The name or label indicating the current state or status.
|
|
273
351
|
* @property {string} [status] - The current status of the bag.
|
|
274
|
-
* @property {string} [journey_type] -
|
|
275
|
-
*
|
|
352
|
+
* @property {string} [journey_type] - It is a type being used to represent the
|
|
353
|
+
* journey of shipment through the performed status transition. Forward
|
|
354
|
+
* Journey: The forward journey encompasses all the stages of shipping,
|
|
355
|
+
* including order placement, packing, dispatch, in-transit updates, and
|
|
356
|
+
* delivery. Return Journey: Contrary to the forward journey, the return
|
|
357
|
+
* journey involves the process of sending items back from the customer to the
|
|
358
|
+
* original sender or a designated return facility.
|
|
276
359
|
*/
|
|
277
360
|
|
|
278
361
|
/**
|
|
@@ -295,11 +378,19 @@ const Joi = require("joi");
|
|
|
295
378
|
* financial details of the item.
|
|
296
379
|
* @property {Object} [parent_promo_bags] - An object containing details of
|
|
297
380
|
* parent promotional bags.
|
|
298
|
-
* @property {Object} [meta] -
|
|
299
|
-
*
|
|
381
|
+
* @property {Object} [meta] - It contains the additional properties related to
|
|
382
|
+
* shipment status transition like Kafka_emission_status, user_name, etc.
|
|
383
|
+
* Additionally it is dynamic.
|
|
384
|
+
* @property {string} [currency_code] - This specifies the currency code for all
|
|
385
|
+
* amounts. The currency_code field will hold a string value representing the
|
|
386
|
+
* code for the currency in which all monetary amounts are denominated. This
|
|
387
|
+
* code typically follows the ISO 4217 standard, which uses three-letter
|
|
388
|
+
* alphabetic codes to define different currencies around the world. For
|
|
389
|
+
* example, 'USD' for United States Dollar, 'INR' for Indian Rupees.
|
|
300
390
|
* @property {string} [seller_identifier] - The identifier for the seller.
|
|
301
391
|
* @property {CurrentStatus} [current_status]
|
|
302
392
|
* @property {Article} [article]
|
|
393
|
+
* @property {PriceAdjustmentCharge[]} [charges]
|
|
303
394
|
*/
|
|
304
395
|
|
|
305
396
|
/**
|
|
@@ -324,7 +415,7 @@ const Joi = require("joi");
|
|
|
324
415
|
* @property {string} [area] - The area or locality.
|
|
325
416
|
* @property {string} [city] - The city of the address.
|
|
326
417
|
* @property {string} [address] - The full address.
|
|
327
|
-
* @property {string} [address_type] - The type of address.
|
|
418
|
+
* @property {string} [address_type] - The type of the address (e.g., home, office).
|
|
328
419
|
* @property {number} [longitude] - The longitude coordinate.
|
|
329
420
|
* @property {string} [country_iso_code] - The ISO code for the country.
|
|
330
421
|
* @property {string} [state] - The state of the address.
|
|
@@ -334,7 +425,20 @@ const Joi = require("joi");
|
|
|
334
425
|
* typically used for printing or displaying in user interfaces.
|
|
335
426
|
* @property {string} [name] - The name of the person associated with the address.
|
|
336
427
|
* @property {string} [contact_person] - The name of the contact person.
|
|
337
|
-
* @property {string} [address_category] -
|
|
428
|
+
* @property {string} [address_category] - Category or classification of the
|
|
429
|
+
* address. The address_category field that includes "store", "delivery", and
|
|
430
|
+
* "billing" serves to classify addresses based on various business processes
|
|
431
|
+
*
|
|
432
|
+
* - 'store': Identifies addresses associated with physical retail locations or
|
|
433
|
+
* warehouses which is essential for inventory management, order
|
|
434
|
+
* fulfillment, and facilitating in-store pickups or returns.
|
|
435
|
+
* - 'delivery': Identifies addresses where orders are shipped to customers which
|
|
436
|
+
* ensures successful delivery, enhancing customer satisfaction, and
|
|
437
|
+
* optimizing logistics operations.
|
|
438
|
+
* - 'billing': Identifies addresses used for billing and financial transactions
|
|
439
|
+
* which are essential for payment processing, invoice generation, and
|
|
440
|
+
* maintaining financial accuracy.
|
|
441
|
+
*
|
|
338
442
|
* @property {string} [email] - The email address.
|
|
339
443
|
* @property {string} [country_phone_code] - The country phone code.
|
|
340
444
|
* @property {string} [version] - The version of the address format.
|
|
@@ -348,8 +452,25 @@ const Joi = require("joi");
|
|
|
348
452
|
* @property {ShipmentPaymentInfo[]} [payment_info] - Array of objects
|
|
349
453
|
* containing payment methods used for placing an order. Each object will
|
|
350
454
|
* provide information about corresponding payment method with relevant details.
|
|
351
|
-
* @property {string} [order_type] -
|
|
352
|
-
*
|
|
455
|
+
* @property {string} [order_type] - Defines the specific journey a shipment
|
|
456
|
+
* will follow based on the application's operational needs and customer
|
|
457
|
+
* preferences. This field categorizes orders into distinct types, each
|
|
458
|
+
* associated with a unique processing flow. For example:
|
|
459
|
+
*
|
|
460
|
+
* - "HomeDelivery": The order undergoes all state transitions typical for a
|
|
461
|
+
* delivery, from processing the shipment to final delivery at the
|
|
462
|
+
* customer's address.
|
|
463
|
+
* - "PickAtStore": The order is prepared for pickup and moved to a state where it
|
|
464
|
+
* is ready to be handed over directly to the customer at the store. This
|
|
465
|
+
* type streamlines the process by bypassing traditional shipping stages
|
|
466
|
+
* and facilitating a quicker transition to the final handover stage.
|
|
467
|
+
*
|
|
468
|
+
* @property {string} [gstin_code] - A GST Number (Goods and Services Tax
|
|
469
|
+
* Identification Number, often abbreviated as GSTIN) is a unique identifier
|
|
470
|
+
* assigned to a business or individual registered under the Goods and
|
|
471
|
+
* Services Tax (GST) system in countries like India. The GST number is
|
|
472
|
+
* essential for businesses to comply with tax regulations and for the
|
|
473
|
+
* government to track tax payments and returns.
|
|
353
474
|
* @property {boolean} [show_download_invoice] - Indicates if the download
|
|
354
475
|
* invoice option should be shown.
|
|
355
476
|
* @property {boolean} [can_cancel] - Indicates if the shipment can be canceled.
|
|
@@ -396,7 +517,8 @@ const Joi = require("joi");
|
|
|
396
517
|
* @property {Object} [return_meta] - An object containing metadata about the
|
|
397
518
|
* return process.
|
|
398
519
|
* @property {string} [delivery_date] - The expected delivery date.
|
|
399
|
-
* @property {
|
|
520
|
+
* @property {OrderRequestSchema} [order]
|
|
521
|
+
* @property {PriceAdjustmentCharge[]} [charges]
|
|
400
522
|
*/
|
|
401
523
|
|
|
402
524
|
/**
|
|
@@ -419,7 +541,12 @@ const Joi = require("joi");
|
|
|
419
541
|
* @typedef OrderSchema
|
|
420
542
|
* @property {number} [total_shipments_in_order] - The total number of shipments
|
|
421
543
|
* in the order.
|
|
422
|
-
* @property {string} [gstin_code] -
|
|
544
|
+
* @property {string} [gstin_code] - A GST Number (Goods and Services Tax
|
|
545
|
+
* Identification Number, often abbreviated as GSTIN) is a unique identifier
|
|
546
|
+
* assigned to a business or individual registered under the Goods and
|
|
547
|
+
* Services Tax (GST) system in countries like India. The GST number is
|
|
548
|
+
* essential for businesses to comply with tax regulations and for the
|
|
549
|
+
* government to track tax payments and returns.
|
|
423
550
|
* @property {UserInfo} [user_info]
|
|
424
551
|
* @property {BreakupValues[]} [breakup_values] - An array containing the
|
|
425
552
|
* breakup of various charges and discounts.
|
|
@@ -428,7 +555,8 @@ const Joi = require("joi");
|
|
|
428
555
|
* @property {string} [order_id] - The unique identifier for the order.
|
|
429
556
|
* @property {Shipments[]} [shipments] - An array containing details of
|
|
430
557
|
* individual shipments within the order.
|
|
431
|
-
* @property {BagsForReorder[]} [bags_for_reorder] -
|
|
558
|
+
* @property {BagsForReorder[]} [bags_for_reorder] - Order details.
|
|
559
|
+
* @property {PriceAdjustmentCharge[]} [charges] - An array containing details
|
|
432
560
|
* of bags available for reorder.
|
|
433
561
|
* @property {Object} [meta] - An object containing additional metadata for the order.
|
|
434
562
|
*/
|
|
@@ -498,7 +626,7 @@ const Joi = require("joi");
|
|
|
498
626
|
*/
|
|
499
627
|
|
|
500
628
|
/**
|
|
501
|
-
* @typedef
|
|
629
|
+
* @typedef CustomerDetailsResponseSchema
|
|
502
630
|
* @property {string} [phone] - Customer's phone number.
|
|
503
631
|
* @property {string} [shipment_id] - Unique identifier of the shipment.
|
|
504
632
|
* @property {string} [name] - Customer's name.
|
|
@@ -507,7 +635,7 @@ const Joi = require("joi");
|
|
|
507
635
|
*/
|
|
508
636
|
|
|
509
637
|
/**
|
|
510
|
-
* @typedef
|
|
638
|
+
* @typedef SendOtpToCustomerResponseSchema
|
|
511
639
|
* @property {string} [request_id] - Unique identifier for the request.
|
|
512
640
|
* @property {string} [message] - Message indicating the result of the request.
|
|
513
641
|
* @property {boolean} [success] - Indicates whether the request was successful.
|
|
@@ -521,7 +649,7 @@ const Joi = require("joi");
|
|
|
521
649
|
*/
|
|
522
650
|
|
|
523
651
|
/**
|
|
524
|
-
* @typedef
|
|
652
|
+
* @typedef VerifyOtpResponseSchema
|
|
525
653
|
* @property {boolean} [success] - Indicates whether the request was successful.
|
|
526
654
|
*/
|
|
527
655
|
|
|
@@ -539,7 +667,20 @@ const Joi = require("joi");
|
|
|
539
667
|
|
|
540
668
|
/**
|
|
541
669
|
* @typedef BagReasons
|
|
542
|
-
* @property {string[]} [qc_type] -
|
|
670
|
+
* @property {string[]} [qc_type] - List of QC (Quality Control) types -- having
|
|
671
|
+
* return reason types indicating the stage at which QC is performed. -
|
|
672
|
+
* "Doorstep QC" refers to the quality control checks that occur at the
|
|
673
|
+
* customer's doorstep. This could be part of a delivery process where the
|
|
674
|
+
* product is inspected for any damages, defects, or discrepancies in the
|
|
675
|
+
* presence of the customer before the final handover. - "Pre QC" represents a
|
|
676
|
+
* proactive quality control approach where the customer plays an active role
|
|
677
|
+
* in the QC process before the product is collected for return or exchange.
|
|
678
|
+
* In this procedure, customers are required to upload photos of the product
|
|
679
|
+
* for a preliminary quality check by the operations team. Approval from this
|
|
680
|
+
* team is necessary before a delivery partner is dispatched to pick up the
|
|
681
|
+
* product. This innovative method ensures that the product meets return or
|
|
682
|
+
* exchange criteria, streamlining the process for both the customer and the
|
|
683
|
+
* operations team, and minimizing unnecessary logistics movements.
|
|
543
684
|
* @property {number} [id] - The unique identifier.
|
|
544
685
|
* @property {string} [display_name] - The text displayed.
|
|
545
686
|
* @property {BagReasonMeta} [meta]
|
|
@@ -551,6 +692,9 @@ const Joi = require("joi");
|
|
|
551
692
|
* @typedef ShipmentBagReasons
|
|
552
693
|
* @property {BagReasons[]} [reasons] - A list of shipment's bag reasons.
|
|
553
694
|
* @property {boolean} [success] - Indicates if the operation was successful.
|
|
695
|
+
* @property {number} [rule_id] - The unique identifier for the rule that is
|
|
696
|
+
* associated with the given reasons. This ID serves as a reference to the
|
|
697
|
+
* specific rule within the RMA system that governs or influences the reasons listed.
|
|
554
698
|
*/
|
|
555
699
|
|
|
556
700
|
/**
|
|
@@ -616,8 +760,16 @@ const Joi = require("joi");
|
|
|
616
760
|
|
|
617
761
|
/**
|
|
618
762
|
* @typedef ProductsDataUpdatesFilters
|
|
619
|
-
* @property {number} [line_number] -
|
|
620
|
-
*
|
|
763
|
+
* @property {number} [line_number] - Represents the specific line item within a
|
|
764
|
+
* bag, used to identify and reference a particular product in a list. This
|
|
765
|
+
* helps in pinpointing the exact item being updated or processed.
|
|
766
|
+
* @property {string} [identifier] - A unique string that serves as the
|
|
767
|
+
* product’s identifier, such as a SKU, barcode, or another distinct code.
|
|
768
|
+
* This ensures the product is correctly identified and distinguished from
|
|
769
|
+
* other items in the system.
|
|
770
|
+
* @property {number} [quantity] - The quantity of the product or item,
|
|
771
|
+
* specified as an integer. This indicates how many units of the product are
|
|
772
|
+
* being referenced or processed, such as the number of items in a bag or shipment.
|
|
621
773
|
*/
|
|
622
774
|
|
|
623
775
|
/**
|
|
@@ -640,7 +792,7 @@ const Joi = require("joi");
|
|
|
640
792
|
*/
|
|
641
793
|
|
|
642
794
|
/**
|
|
643
|
-
* @typedef
|
|
795
|
+
* @typedef ShipmentsRequestSchema
|
|
644
796
|
* @property {ReasonsData} [reasons]
|
|
645
797
|
* @property {Products[]} [products] - Specific bag to be updated.
|
|
646
798
|
* @property {DataUpdates} [data_updates]
|
|
@@ -649,22 +801,23 @@ const Joi = require("joi");
|
|
|
649
801
|
*/
|
|
650
802
|
|
|
651
803
|
/**
|
|
652
|
-
* @typedef
|
|
653
|
-
* @property {
|
|
654
|
-
* about shipments.
|
|
804
|
+
* @typedef StatuesRequestSchema
|
|
805
|
+
* @property {ShipmentsRequestSchema[]} [shipments] - A list containing
|
|
806
|
+
* information about shipments.
|
|
655
807
|
* @property {string} [exclude_bags_next_state] - State to be change for
|
|
656
808
|
* Remaining Bag/Products.
|
|
657
809
|
* @property {string} [status] - The status to which the entity is to be transitioned.
|
|
658
810
|
*/
|
|
659
811
|
|
|
660
812
|
/**
|
|
661
|
-
* @typedef
|
|
813
|
+
* @typedef OrderRequestSchema
|
|
662
814
|
* @property {Object} [meta] - Metadata for the order.
|
|
663
815
|
*/
|
|
664
816
|
|
|
665
817
|
/**
|
|
666
|
-
* @typedef
|
|
667
|
-
* @property {
|
|
818
|
+
* @typedef UpdateShipmentStatusRequestSchema
|
|
819
|
+
* @property {StatuesRequestSchema[]} [statuses] - An array containing different
|
|
820
|
+
* status details.
|
|
668
821
|
* @property {boolean} [task] - Indicates whether the task is active or required.
|
|
669
822
|
* @property {boolean} [lock_after_transition] - Indicates whether the status
|
|
670
823
|
* should be locked after the transition.
|
|
@@ -675,18 +828,18 @@ const Joi = require("joi");
|
|
|
675
828
|
*/
|
|
676
829
|
|
|
677
830
|
/**
|
|
678
|
-
* @typedef
|
|
831
|
+
* @typedef StatusesBodyResponseSchema
|
|
679
832
|
* @property {Object[]} [shipments] - List of shipments.
|
|
680
833
|
*/
|
|
681
834
|
|
|
682
835
|
/**
|
|
683
|
-
* @typedef
|
|
684
|
-
* @property {
|
|
685
|
-
* status options of shipments.
|
|
836
|
+
* @typedef ShipmentApplicationStatusResponseSchema
|
|
837
|
+
* @property {StatusesBodyResponseSchema[]} [statuses] - An array containing
|
|
838
|
+
* different status options of shipments.
|
|
686
839
|
*/
|
|
687
840
|
|
|
688
841
|
/**
|
|
689
|
-
* @typedef
|
|
842
|
+
* @typedef ErrorResponseSchema
|
|
690
843
|
* @property {string} [code] - The HTTP status code of the response.
|
|
691
844
|
* @property {string} [message] - A message providing details about the response.
|
|
692
845
|
* @property {number} [status] - An additional code providing more context about
|
|
@@ -778,6 +931,49 @@ class OrderApplicationModel {
|
|
|
778
931
|
});
|
|
779
932
|
}
|
|
780
933
|
|
|
934
|
+
/** @returns {ChargeDistributionSchema} */
|
|
935
|
+
static ChargeDistributionSchema() {
|
|
936
|
+
return Joi.object({
|
|
937
|
+
type: Joi.string().allow("").required(),
|
|
938
|
+
logic: Joi.string().allow("").required(),
|
|
939
|
+
});
|
|
940
|
+
}
|
|
941
|
+
|
|
942
|
+
/** @returns {ChargeDistributionLogic} */
|
|
943
|
+
static ChargeDistributionLogic() {
|
|
944
|
+
return Joi.object({
|
|
945
|
+
distribution: OrderApplicationModel.ChargeDistributionSchema().required(),
|
|
946
|
+
distribution_level: Joi.string().allow("").required(),
|
|
947
|
+
});
|
|
948
|
+
}
|
|
949
|
+
|
|
950
|
+
/** @returns {ChargeAmountCurrency} */
|
|
951
|
+
static ChargeAmountCurrency() {
|
|
952
|
+
return Joi.object({
|
|
953
|
+
value: Joi.number().required(),
|
|
954
|
+
currency: Joi.string().allow("").required(),
|
|
955
|
+
});
|
|
956
|
+
}
|
|
957
|
+
|
|
958
|
+
/** @returns {ChargeAmount} */
|
|
959
|
+
static ChargeAmount() {
|
|
960
|
+
return Joi.object({
|
|
961
|
+
base_currency: OrderApplicationModel.ChargeAmountCurrency().required(),
|
|
962
|
+
ordering_currency: OrderApplicationModel.ChargeAmountCurrency().required(),
|
|
963
|
+
});
|
|
964
|
+
}
|
|
965
|
+
|
|
966
|
+
/** @returns {PriceAdjustmentCharge} */
|
|
967
|
+
static PriceAdjustmentCharge() {
|
|
968
|
+
return Joi.object({
|
|
969
|
+
code: Joi.string().allow("").allow(null),
|
|
970
|
+
name: Joi.string().allow("").required(),
|
|
971
|
+
type: Joi.string().allow("").allow(null),
|
|
972
|
+
amount: OrderApplicationModel.ChargeAmount().required(),
|
|
973
|
+
distribution_logic: OrderApplicationModel.ChargeDistributionLogic().required(),
|
|
974
|
+
});
|
|
975
|
+
}
|
|
976
|
+
|
|
781
977
|
/** @returns {ShipmentStatus} */
|
|
782
978
|
static ShipmentStatus() {
|
|
783
979
|
return Joi.object({
|
|
@@ -905,7 +1101,7 @@ class OrderApplicationModel {
|
|
|
905
1101
|
static AppliedFreeArticles() {
|
|
906
1102
|
return Joi.object({
|
|
907
1103
|
article_id: Joi.string().allow(""),
|
|
908
|
-
free_gift_item_details: Joi.any(),
|
|
1104
|
+
free_gift_item_details: Joi.object().pattern(/\S/, Joi.any()),
|
|
909
1105
|
parent_item_identifier: Joi.string().allow(""),
|
|
910
1106
|
quantity: Joi.number(),
|
|
911
1107
|
});
|
|
@@ -995,12 +1191,13 @@ class OrderApplicationModel {
|
|
|
995
1191
|
financial_breakup: Joi.array().items(
|
|
996
1192
|
OrderApplicationModel.FinancialBreakup()
|
|
997
1193
|
),
|
|
998
|
-
parent_promo_bags: Joi.any(),
|
|
999
|
-
meta: Joi.any(),
|
|
1194
|
+
parent_promo_bags: Joi.object().pattern(/\S/, Joi.any()),
|
|
1195
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
1000
1196
|
currency_code: Joi.string().allow(""),
|
|
1001
1197
|
seller_identifier: Joi.string().allow(""),
|
|
1002
1198
|
current_status: OrderApplicationModel.CurrentStatus(),
|
|
1003
1199
|
article: OrderApplicationModel.Article(),
|
|
1200
|
+
charges: Joi.array().items(OrderApplicationModel.PriceAdjustmentCharge()),
|
|
1004
1201
|
});
|
|
1005
1202
|
}
|
|
1006
1203
|
|
|
@@ -1067,9 +1264,9 @@ class OrderApplicationModel {
|
|
|
1067
1264
|
comment: Joi.string().allow(""),
|
|
1068
1265
|
invoice: OrderApplicationModel.Invoice(),
|
|
1069
1266
|
show_track_link: Joi.boolean(),
|
|
1070
|
-
refund_details: Joi.any(),
|
|
1267
|
+
refund_details: Joi.object().pattern(/\S/, Joi.any()),
|
|
1071
1268
|
breakup_values: Joi.array().items(OrderApplicationModel.BreakupValues()),
|
|
1072
|
-
can_break: Joi.any(),
|
|
1269
|
+
can_break: Joi.object().pattern(/\S/, Joi.any()),
|
|
1073
1270
|
traking_no: Joi.string().allow(""),
|
|
1074
1271
|
tracking_details: Joi.array().items(
|
|
1075
1272
|
OrderApplicationModel.TrackingDetails()
|
|
@@ -1081,7 +1278,7 @@ class OrderApplicationModel {
|
|
|
1081
1278
|
returnable_date: Joi.string().allow("").allow(null),
|
|
1082
1279
|
shipment_created_at: Joi.string().allow(""),
|
|
1083
1280
|
shipment_created_ts: Joi.string().allow(""),
|
|
1084
|
-
size_info: Joi.any(),
|
|
1281
|
+
size_info: Joi.object().pattern(/\S/, Joi.any()),
|
|
1085
1282
|
bags: Joi.array().items(OrderApplicationModel.Bags()),
|
|
1086
1283
|
dp_name: Joi.string().allow(""),
|
|
1087
1284
|
awb_no: Joi.string().allow(""),
|
|
@@ -1093,9 +1290,10 @@ class OrderApplicationModel {
|
|
|
1093
1290
|
track_url: Joi.string().allow(""),
|
|
1094
1291
|
order_id: Joi.string().allow(""),
|
|
1095
1292
|
need_help_url: Joi.string().allow(""),
|
|
1096
|
-
return_meta: Joi.any(),
|
|
1293
|
+
return_meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
1097
1294
|
delivery_date: Joi.string().allow("").allow(null),
|
|
1098
|
-
order: OrderApplicationModel.
|
|
1295
|
+
order: OrderApplicationModel.OrderRequestSchema(),
|
|
1296
|
+
charges: Joi.array().items(OrderApplicationModel.PriceAdjustmentCharge()),
|
|
1099
1297
|
});
|
|
1100
1298
|
}
|
|
1101
1299
|
|
|
@@ -1133,6 +1331,7 @@ class OrderApplicationModel {
|
|
|
1133
1331
|
bags_for_reorder: Joi.array().items(
|
|
1134
1332
|
OrderApplicationModel.BagsForReorder()
|
|
1135
1333
|
),
|
|
1334
|
+
charges: Joi.array().items(OrderApplicationModel.PriceAdjustmentCharge()),
|
|
1136
1335
|
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
1137
1336
|
});
|
|
1138
1337
|
}
|
|
@@ -1215,8 +1414,8 @@ class OrderApplicationModel {
|
|
|
1215
1414
|
});
|
|
1216
1415
|
}
|
|
1217
1416
|
|
|
1218
|
-
/** @returns {
|
|
1219
|
-
static
|
|
1417
|
+
/** @returns {CustomerDetailsResponseSchema} */
|
|
1418
|
+
static CustomerDetailsResponseSchema() {
|
|
1220
1419
|
return Joi.object({
|
|
1221
1420
|
phone: Joi.string().allow(""),
|
|
1222
1421
|
shipment_id: Joi.string().allow(""),
|
|
@@ -1226,8 +1425,8 @@ class OrderApplicationModel {
|
|
|
1226
1425
|
});
|
|
1227
1426
|
}
|
|
1228
1427
|
|
|
1229
|
-
/** @returns {
|
|
1230
|
-
static
|
|
1428
|
+
/** @returns {SendOtpToCustomerResponseSchema} */
|
|
1429
|
+
static SendOtpToCustomerResponseSchema() {
|
|
1231
1430
|
return Joi.object({
|
|
1232
1431
|
request_id: Joi.string().allow(""),
|
|
1233
1432
|
message: Joi.string().allow(""),
|
|
@@ -1244,8 +1443,8 @@ class OrderApplicationModel {
|
|
|
1244
1443
|
});
|
|
1245
1444
|
}
|
|
1246
1445
|
|
|
1247
|
-
/** @returns {
|
|
1248
|
-
static
|
|
1446
|
+
/** @returns {VerifyOtpResponseSchema} */
|
|
1447
|
+
static VerifyOtpResponseSchema() {
|
|
1249
1448
|
return Joi.object({
|
|
1250
1449
|
success: Joi.boolean(),
|
|
1251
1450
|
});
|
|
@@ -1283,6 +1482,7 @@ class OrderApplicationModel {
|
|
|
1283
1482
|
return Joi.object({
|
|
1284
1483
|
reasons: Joi.array().items(OrderApplicationModel.BagReasons()),
|
|
1285
1484
|
success: Joi.boolean(),
|
|
1485
|
+
rule_id: Joi.number().allow(null),
|
|
1286
1486
|
});
|
|
1287
1487
|
}
|
|
1288
1488
|
|
|
@@ -1370,13 +1570,14 @@ class OrderApplicationModel {
|
|
|
1370
1570
|
return Joi.object({
|
|
1371
1571
|
line_number: Joi.number(),
|
|
1372
1572
|
identifier: Joi.string().allow(""),
|
|
1573
|
+
quantity: Joi.number(),
|
|
1373
1574
|
});
|
|
1374
1575
|
}
|
|
1375
1576
|
|
|
1376
1577
|
/** @returns {ProductsDataUpdates} */
|
|
1377
1578
|
static ProductsDataUpdates() {
|
|
1378
1579
|
return Joi.object({
|
|
1379
|
-
data: Joi.any(),
|
|
1580
|
+
data: Joi.object().pattern(/\S/, Joi.any()),
|
|
1380
1581
|
filters: Joi.array().items(
|
|
1381
1582
|
OrderApplicationModel.ProductsDataUpdatesFilters()
|
|
1382
1583
|
),
|
|
@@ -1386,7 +1587,7 @@ class OrderApplicationModel {
|
|
|
1386
1587
|
/** @returns {EntitiesDataUpdates} */
|
|
1387
1588
|
static EntitiesDataUpdates() {
|
|
1388
1589
|
return Joi.object({
|
|
1389
|
-
data: Joi.any(),
|
|
1590
|
+
data: Joi.object().pattern(/\S/, Joi.any()),
|
|
1390
1591
|
filters: Joi.array().items(Joi.any()),
|
|
1391
1592
|
});
|
|
1392
1593
|
}
|
|
@@ -1399,8 +1600,8 @@ class OrderApplicationModel {
|
|
|
1399
1600
|
});
|
|
1400
1601
|
}
|
|
1401
1602
|
|
|
1402
|
-
/** @returns {
|
|
1403
|
-
static
|
|
1603
|
+
/** @returns {ShipmentsRequestSchema} */
|
|
1604
|
+
static ShipmentsRequestSchema() {
|
|
1404
1605
|
return Joi.object({
|
|
1405
1606
|
reasons: OrderApplicationModel.ReasonsData(),
|
|
1406
1607
|
products: Joi.array().items(OrderApplicationModel.Products()),
|
|
@@ -1409,26 +1610,28 @@ class OrderApplicationModel {
|
|
|
1409
1610
|
});
|
|
1410
1611
|
}
|
|
1411
1612
|
|
|
1412
|
-
/** @returns {
|
|
1413
|
-
static
|
|
1613
|
+
/** @returns {StatuesRequestSchema} */
|
|
1614
|
+
static StatuesRequestSchema() {
|
|
1414
1615
|
return Joi.object({
|
|
1415
|
-
shipments: Joi.array().items(
|
|
1616
|
+
shipments: Joi.array().items(
|
|
1617
|
+
OrderApplicationModel.ShipmentsRequestSchema()
|
|
1618
|
+
),
|
|
1416
1619
|
exclude_bags_next_state: Joi.string().allow(""),
|
|
1417
1620
|
status: Joi.string().allow(""),
|
|
1418
1621
|
});
|
|
1419
1622
|
}
|
|
1420
1623
|
|
|
1421
|
-
/** @returns {
|
|
1422
|
-
static
|
|
1624
|
+
/** @returns {OrderRequestSchema} */
|
|
1625
|
+
static OrderRequestSchema() {
|
|
1423
1626
|
return Joi.object({
|
|
1424
|
-
meta: Joi.any(),
|
|
1627
|
+
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
1425
1628
|
});
|
|
1426
1629
|
}
|
|
1427
1630
|
|
|
1428
|
-
/** @returns {
|
|
1429
|
-
static
|
|
1631
|
+
/** @returns {UpdateShipmentStatusRequestSchema} */
|
|
1632
|
+
static UpdateShipmentStatusRequestSchema() {
|
|
1430
1633
|
return Joi.object({
|
|
1431
|
-
statuses: Joi.array().items(OrderApplicationModel.
|
|
1634
|
+
statuses: Joi.array().items(OrderApplicationModel.StatuesRequestSchema()),
|
|
1432
1635
|
task: Joi.boolean(),
|
|
1433
1636
|
lock_after_transition: Joi.boolean(),
|
|
1434
1637
|
force_transition: Joi.boolean(),
|
|
@@ -1436,22 +1639,24 @@ class OrderApplicationModel {
|
|
|
1436
1639
|
});
|
|
1437
1640
|
}
|
|
1438
1641
|
|
|
1439
|
-
/** @returns {
|
|
1440
|
-
static
|
|
1642
|
+
/** @returns {StatusesBodyResponseSchema} */
|
|
1643
|
+
static StatusesBodyResponseSchema() {
|
|
1441
1644
|
return Joi.object({
|
|
1442
1645
|
shipments: Joi.array().items(Joi.any()),
|
|
1443
1646
|
});
|
|
1444
1647
|
}
|
|
1445
1648
|
|
|
1446
|
-
/** @returns {
|
|
1447
|
-
static
|
|
1649
|
+
/** @returns {ShipmentApplicationStatusResponseSchema} */
|
|
1650
|
+
static ShipmentApplicationStatusResponseSchema() {
|
|
1448
1651
|
return Joi.object({
|
|
1449
|
-
statuses: Joi.array().items(
|
|
1652
|
+
statuses: Joi.array().items(
|
|
1653
|
+
OrderApplicationModel.StatusesBodyResponseSchema()
|
|
1654
|
+
),
|
|
1450
1655
|
});
|
|
1451
1656
|
}
|
|
1452
1657
|
|
|
1453
|
-
/** @returns {
|
|
1454
|
-
static
|
|
1658
|
+
/** @returns {ErrorResponseSchema} */
|
|
1659
|
+
static ErrorResponseSchema() {
|
|
1455
1660
|
return Joi.object({
|
|
1456
1661
|
code: Joi.string().allow("").allow(null),
|
|
1457
1662
|
message: Joi.string().allow("").allow(null),
|