@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +53 -60
- package/sdk/application/Cart/CartApplicationClient.js +53 -130
- package/sdk/application/Cart/CartApplicationModel.d.ts +143 -489
- package/sdk/application/Cart/CartApplicationModel.js +159 -380
- package/sdk/application/Cart/CartApplicationValidator.d.ts +19 -38
- package/sdk/application/Cart/CartApplicationValidator.js +18 -34
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +68 -88
- package/sdk/application/Catalog/CatalogApplicationClient.js +94 -114
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +142 -194
- package/sdk/application/Catalog/CatalogApplicationModel.js +133 -171
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -3
- package/sdk/application/Common/CommonApplicationClient.js +5 -6
- package/sdk/application/Common/CommonApplicationModel.d.ts +9 -9
- package/sdk/application/Common/CommonApplicationModel.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +27 -34
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +27 -34
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +57 -45
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +47 -35
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +2 -2
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +2 -2
- package/sdk/application/Content/ContentApplicationClient.d.ts +33 -23
- package/sdk/application/Content/ContentApplicationClient.js +75 -54
- package/sdk/application/Content/ContentApplicationModel.d.ts +37 -93
- package/sdk/application/Content/ContentApplicationModel.js +32 -83
- package/sdk/application/Content/ContentApplicationValidator.d.ts +17 -23
- package/sdk/application/Content/ContentApplicationValidator.js +10 -15
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -9
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +13 -14
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +25 -23
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +18 -16
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +6 -6
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +6 -6
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -2
- package/sdk/application/Lead/LeadApplicationClient.js +3 -2
- package/sdk/application/Lead/LeadApplicationModel.d.ts +11 -11
- package/sdk/application/Lead/LeadApplicationModel.js +19 -19
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +16 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +21 -189
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +173 -532
- package/sdk/application/Logistic/LogisticApplicationModel.js +139 -409
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +9 -54
- package/sdk/application/Logistic/LogisticApplicationValidator.js +8 -42
- package/sdk/application/Order/OrderApplicationClient.d.ts +10 -24
- package/sdk/application/Order/OrderApplicationClient.js +13 -96
- package/sdk/application/Order/OrderApplicationModel.d.ts +120 -436
- package/sdk/application/Order/OrderApplicationModel.js +81 -279
- package/sdk/application/Order/OrderApplicationValidator.d.ts +3 -17
- package/sdk/application/Order/OrderApplicationValidator.js +2 -15
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +99 -96
- package/sdk/application/Payment/PaymentApplicationClient.js +114 -111
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +289 -293
- package/sdk/application/Payment/PaymentApplicationModel.js +241 -243
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationValidator.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +22 -19
- 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 +6 -8
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +17 -48
- package/sdk/application/Theme/ThemeApplicationModel.js +22 -42
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +3 -16
- package/sdk/application/Theme/ThemeApplicationValidator.js +2 -9
- 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 +9 -11
- package/sdk/application/Webhook/WebhookApplicationModel.js +6 -8
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +2 -2
- package/sdk/application/Webhook/WebhookApplicationValidator.js +2 -2
- package/sdk/application/index.d.ts +0 -1
- package/sdk/application/index.js +0 -2
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +19 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +14 -121
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
- 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 +20 -126
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +85 -767
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +76 -429
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +6 -120
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +37 -96
- package/sdk/partner/Theme/ThemePartnerModel.js +36 -90
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +112 -407
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -111
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -106
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1304 -4979
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1922
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -208
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +358 -383
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +126 -122
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +68 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +118 -141
- package/sdk/platform/Catalog/CatalogPlatformClient.js +170 -193
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1751 -1501
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1224 -1393
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +18 -18
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +18 -18
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
- package/sdk/platform/Common/CommonPlatformClient.js +2 -3
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +124 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +94 -219
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -124
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
- package/sdk/platform/Content/ContentPlatformModel.js +390 -521
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
- package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
- package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
- 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 +36 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +60 -462
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +101 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +84 -313
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- 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 +4 -15
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -83
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +4 -25
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +3 -16
- package/sdk/platform/Order/OrderPlatformClient.d.ts +97 -178
- package/sdk/platform/Order/OrderPlatformClient.js +245 -597
- package/sdk/platform/Order/OrderPlatformModel.d.ts +3071 -5449
- package/sdk/platform/Order/OrderPlatformModel.js +1656 -3501
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +190 -237
- package/sdk/platform/Order/OrderPlatformValidator.js +105 -153
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +106 -94
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +146 -131
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +93 -64
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +70 -62
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +507 -386
- package/sdk/platform/Payment/PaymentPlatformModel.js +376 -323
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformValidator.js +10 -10
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- 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 +35 -45
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +38 -117
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +13 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +12 -24
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +64 -58
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +341 -602
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +284 -483
- 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 +5 -36
- package/sdk/platform/Share/SharePlatformModel.js +4 -27
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +11 -37
- package/sdk/platform/Theme/ThemePlatformModel.js +15 -33
- 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 +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
- package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -6
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
- package/sdk/public/Content/ContentPublicClient.js +5 -791
- package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
- package/sdk/public/Content/ContentPublicModel.js +3 -649
- package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
- package/sdk/public/Content/ContentPublicValidator.js +2 -88
- 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/application/Finance/FinanceApplicationClient.d.ts +0 -36
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -202
- package/sdk/application/Finance/FinanceApplicationModel.d.ts +0 -289
- package/sdk/application/Finance/FinanceApplicationModel.js +0 -208
- package/sdk/application/Finance/FinanceApplicationValidator.d.ts +0 -25
- package/sdk/application/Finance/FinanceApplicationValidator.js +0 -31
|
@@ -35,12 +35,7 @@ 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.
|
|
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.
|
|
38
|
+
* representing the currency used for the value.
|
|
44
39
|
*/
|
|
45
40
|
|
|
46
41
|
/**
|
|
@@ -84,47 +79,8 @@ const Joi = require("joi");
|
|
|
84
79
|
* @property {string} [code] - A code associated with the store.
|
|
85
80
|
* @property {string} [name] - The name of the store.
|
|
86
81
|
* @property {string} [company_name] - The name of the company associated with the store.
|
|
87
|
-
* @property {number} [company_id] -
|
|
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
|
|
82
|
+
* @property {number} [company_id] - The identifier of the company associated
|
|
83
|
+
* with the store.
|
|
128
84
|
*/
|
|
129
85
|
|
|
130
86
|
/**
|
|
@@ -134,10 +90,7 @@ const Joi = require("joi");
|
|
|
134
90
|
* @property {string} [title] - The title or display name representing the
|
|
135
91
|
* shipment status.
|
|
136
92
|
* @property {string} [hex_code] - The hexadecimal color code associated with
|
|
137
|
-
* the shipment status.
|
|
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.
|
|
93
|
+
* the shipment status.
|
|
141
94
|
*/
|
|
142
95
|
|
|
143
96
|
/**
|
|
@@ -217,12 +170,7 @@ const Joi = require("joi");
|
|
|
217
170
|
* @property {number} [promotion_effective_discount] - The effective discount
|
|
218
171
|
* from promotions.
|
|
219
172
|
* @property {number} [refund_amount] - The amount refunded to the customer.
|
|
220
|
-
* @property {string} [currency_code] -
|
|
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.
|
|
173
|
+
* @property {string} [currency_code] - The code of the currency used.
|
|
226
174
|
* @property {number} [fynd_credits] - The amount of Fynd credits used.
|
|
227
175
|
* @property {number} [amount_to_be_collected] - The total amount that needs to
|
|
228
176
|
* be collected from the customer.
|
|
@@ -237,15 +185,18 @@ const Joi = require("joi");
|
|
|
237
185
|
/**
|
|
238
186
|
* @typedef Item
|
|
239
187
|
* @property {string[]} [image] - An array of URLs pointing to images of the item.
|
|
240
|
-
* @property {string[]} [l1_categories] - An array of level 1 categories
|
|
188
|
+
* @property {string[]} [l1_categories] - An array of level 1 categories to
|
|
189
|
+
* which the item belongs.
|
|
190
|
+
* @property {string[]} [l2_category] - An array of level 2 categories to which
|
|
191
|
+
* the item belongs.
|
|
192
|
+
* @property {number} [l2_category_id] - ID representing the level 2 category
|
|
193
|
+
* classification of the item
|
|
241
194
|
* @property {ItemBrand} [brand]
|
|
242
195
|
* @property {string} [seller_identifier] - The identifier for the seller .
|
|
243
196
|
* @property {string} [code] - The code or SKU of the item.
|
|
244
197
|
* @property {number} [id] - The unique identifier of the item.
|
|
245
198
|
* @property {string} [name] - The name of the item.
|
|
246
|
-
* @property {string} [l3_category_name] -
|
|
247
|
-
* third-level category under which the product is listed, offering a more
|
|
248
|
-
* detailed classification within the e-commerce platform's hierarchy.
|
|
199
|
+
* @property {string} [l3_category_name] - The level 3 category name.
|
|
249
200
|
* @property {string} [slug_key] - A unique key or identifier for the item slug.
|
|
250
201
|
* @property {string[]} [l2_categories] - An array of level 2 categories the
|
|
251
202
|
* item belongs to.
|
|
@@ -271,22 +222,7 @@ const Joi = require("joi");
|
|
|
271
222
|
* qualify for the promotion.
|
|
272
223
|
* @property {string} [promo_id] - The unique identifier for the promotion.
|
|
273
224
|
* @property {number} [amount] - The discount amount provided by the promotion.
|
|
274
|
-
* @property {string} [promotion_type] -
|
|
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.
|
|
225
|
+
* @property {string} [promotion_type] - The type of promotion.
|
|
290
226
|
* @property {AppliedFreeArticles[]} [applied_free_articles] - An array
|
|
291
227
|
* containing details of free articles applied under the promotion.
|
|
292
228
|
*/
|
|
@@ -294,12 +230,7 @@ const Joi = require("joi");
|
|
|
294
230
|
/**
|
|
295
231
|
* @typedef Identifiers
|
|
296
232
|
* @property {string} [ean] - The European Article Number (EAN) 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.
|
|
233
|
+
* @property {string} [sku_code] - The Stock Keeping Unit (SKU) code of the item.
|
|
303
234
|
*/
|
|
304
235
|
|
|
305
236
|
/**
|
|
@@ -311,12 +242,8 @@ const Joi = require("joi");
|
|
|
311
242
|
* other charges.
|
|
312
243
|
* @property {number} [price_marked] - The original marked price of the item.
|
|
313
244
|
* @property {number} [coupon_effective_discount] - The effective discount from coupons.
|
|
314
|
-
* @property {string} [hsn_code] - The HSN
|
|
315
|
-
*
|
|
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.
|
|
245
|
+
* @property {string} [hsn_code] - The HSN (Harmonized System of Nomenclature)
|
|
246
|
+
* code of the item.
|
|
320
247
|
* @property {number} [discount] - The discount applied to the item.
|
|
321
248
|
* @property {number} [gst_tax_percentage] - The GST tax percentage applied .
|
|
322
249
|
* @property {number} [cod_charges] - The cash on delivery charges, if applicable.
|
|
@@ -349,13 +276,8 @@ const Joi = require("joi");
|
|
|
349
276
|
* @property {string} [updated_at] - The date and time when the status was last updated.
|
|
350
277
|
* @property {string} [name] - The name or label indicating the current state or status.
|
|
351
278
|
* @property {string} [status] - The current status of the bag.
|
|
352
|
-
* @property {string} [journey_type] -
|
|
353
|
-
*
|
|
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.
|
|
279
|
+
* @property {string} [journey_type] - The type of journey for the shipment,
|
|
280
|
+
* indicating the direction of the shipment.
|
|
359
281
|
*/
|
|
360
282
|
|
|
361
283
|
/**
|
|
@@ -378,19 +300,11 @@ const Joi = require("joi");
|
|
|
378
300
|
* financial details of the item.
|
|
379
301
|
* @property {Object} [parent_promo_bags] - An object containing details of
|
|
380
302
|
* parent promotional bags.
|
|
381
|
-
* @property {Object} [meta] -
|
|
382
|
-
*
|
|
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.
|
|
303
|
+
* @property {Object} [meta] - An object containing metadata for the item.
|
|
304
|
+
* @property {string} [currency_code] - The code of the currency used.
|
|
390
305
|
* @property {string} [seller_identifier] - The identifier for the seller.
|
|
391
306
|
* @property {CurrentStatus} [current_status]
|
|
392
307
|
* @property {Article} [article]
|
|
393
|
-
* @property {PriceAdjustmentCharge[]} [charges]
|
|
394
308
|
*/
|
|
395
309
|
|
|
396
310
|
/**
|
|
@@ -415,7 +329,7 @@ const Joi = require("joi");
|
|
|
415
329
|
* @property {string} [area] - The area or locality.
|
|
416
330
|
* @property {string} [city] - The city of the address.
|
|
417
331
|
* @property {string} [address] - The full address.
|
|
418
|
-
* @property {string} [address_type] - The type of
|
|
332
|
+
* @property {string} [address_type] - The type of address.
|
|
419
333
|
* @property {number} [longitude] - The longitude coordinate.
|
|
420
334
|
* @property {string} [country_iso_code] - The ISO code for the country.
|
|
421
335
|
* @property {string} [state] - The state of the address.
|
|
@@ -425,20 +339,7 @@ const Joi = require("joi");
|
|
|
425
339
|
* typically used for printing or displaying in user interfaces.
|
|
426
340
|
* @property {string} [name] - The name of the person associated with the address.
|
|
427
341
|
* @property {string} [contact_person] - The name of the contact person.
|
|
428
|
-
* @property {string} [address_category] -
|
|
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
|
-
*
|
|
342
|
+
* @property {string} [address_category] - The category of the address.
|
|
442
343
|
* @property {string} [email] - The email address.
|
|
443
344
|
* @property {string} [country_phone_code] - The country phone code.
|
|
444
345
|
* @property {string} [version] - The version of the address format.
|
|
@@ -452,25 +353,8 @@ const Joi = require("joi");
|
|
|
452
353
|
* @property {ShipmentPaymentInfo[]} [payment_info] - Array of objects
|
|
453
354
|
* containing payment methods used for placing an order. Each object will
|
|
454
355
|
* provide information about corresponding payment method with relevant details.
|
|
455
|
-
* @property {string} [order_type] -
|
|
456
|
-
*
|
|
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.
|
|
356
|
+
* @property {string} [order_type] - The type of order.
|
|
357
|
+
* @property {string} [gstin_code] - The GSTIN code for the shipment.
|
|
474
358
|
* @property {boolean} [show_download_invoice] - Indicates if the download
|
|
475
359
|
* invoice option should be shown.
|
|
476
360
|
* @property {boolean} [can_cancel] - Indicates if the shipment can be canceled.
|
|
@@ -517,8 +401,7 @@ const Joi = require("joi");
|
|
|
517
401
|
* @property {Object} [return_meta] - An object containing metadata about the
|
|
518
402
|
* return process.
|
|
519
403
|
* @property {string} [delivery_date] - The expected delivery date.
|
|
520
|
-
* @property {
|
|
521
|
-
* @property {PriceAdjustmentCharge[]} [charges]
|
|
404
|
+
* @property {OrderRequest} [order]
|
|
522
405
|
*/
|
|
523
406
|
|
|
524
407
|
/**
|
|
@@ -541,12 +424,7 @@ const Joi = require("joi");
|
|
|
541
424
|
* @typedef OrderSchema
|
|
542
425
|
* @property {number} [total_shipments_in_order] - The total number of shipments
|
|
543
426
|
* in the order.
|
|
544
|
-
* @property {string} [gstin_code] -
|
|
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.
|
|
427
|
+
* @property {string} [gstin_code] - The GSTIN code for the shipment.
|
|
550
428
|
* @property {UserInfo} [user_info]
|
|
551
429
|
* @property {BreakupValues[]} [breakup_values] - An array containing the
|
|
552
430
|
* breakup of various charges and discounts.
|
|
@@ -555,8 +433,7 @@ const Joi = require("joi");
|
|
|
555
433
|
* @property {string} [order_id] - The unique identifier for the order.
|
|
556
434
|
* @property {Shipments[]} [shipments] - An array containing details of
|
|
557
435
|
* individual shipments within the order.
|
|
558
|
-
* @property {BagsForReorder[]} [bags_for_reorder] -
|
|
559
|
-
* @property {PriceAdjustmentCharge[]} [charges] - An array containing details
|
|
436
|
+
* @property {BagsForReorder[]} [bags_for_reorder] - An array containing details
|
|
560
437
|
* of bags available for reorder.
|
|
561
438
|
* @property {Object} [meta] - An object containing additional metadata for the order.
|
|
562
439
|
*/
|
|
@@ -626,7 +503,7 @@ const Joi = require("joi");
|
|
|
626
503
|
*/
|
|
627
504
|
|
|
628
505
|
/**
|
|
629
|
-
* @typedef
|
|
506
|
+
* @typedef CustomerDetailsResponse
|
|
630
507
|
* @property {string} [phone] - Customer's phone number.
|
|
631
508
|
* @property {string} [shipment_id] - Unique identifier of the shipment.
|
|
632
509
|
* @property {string} [name] - Customer's name.
|
|
@@ -635,7 +512,7 @@ const Joi = require("joi");
|
|
|
635
512
|
*/
|
|
636
513
|
|
|
637
514
|
/**
|
|
638
|
-
* @typedef
|
|
515
|
+
* @typedef SendOtpToCustomerResponse
|
|
639
516
|
* @property {string} [request_id] - Unique identifier for the request.
|
|
640
517
|
* @property {string} [message] - Message indicating the result of the request.
|
|
641
518
|
* @property {boolean} [success] - Indicates whether the request was successful.
|
|
@@ -649,7 +526,7 @@ const Joi = require("joi");
|
|
|
649
526
|
*/
|
|
650
527
|
|
|
651
528
|
/**
|
|
652
|
-
* @typedef
|
|
529
|
+
* @typedef VerifyOtpResponse
|
|
653
530
|
* @property {boolean} [success] - Indicates whether the request was successful.
|
|
654
531
|
*/
|
|
655
532
|
|
|
@@ -667,20 +544,7 @@ const Joi = require("joi");
|
|
|
667
544
|
|
|
668
545
|
/**
|
|
669
546
|
* @typedef BagReasons
|
|
670
|
-
* @property {string[]} [qc_type] -
|
|
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.
|
|
547
|
+
* @property {string[]} [qc_type] - A list of quality check types.
|
|
684
548
|
* @property {number} [id] - The unique identifier.
|
|
685
549
|
* @property {string} [display_name] - The text displayed.
|
|
686
550
|
* @property {BagReasonMeta} [meta]
|
|
@@ -692,9 +556,6 @@ const Joi = require("joi");
|
|
|
692
556
|
* @typedef ShipmentBagReasons
|
|
693
557
|
* @property {BagReasons[]} [reasons] - A list of shipment's bag reasons.
|
|
694
558
|
* @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.
|
|
698
559
|
*/
|
|
699
560
|
|
|
700
561
|
/**
|
|
@@ -760,16 +621,8 @@ const Joi = require("joi");
|
|
|
760
621
|
|
|
761
622
|
/**
|
|
762
623
|
* @typedef ProductsDataUpdatesFilters
|
|
763
|
-
* @property {number} [line_number] -
|
|
764
|
-
*
|
|
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.
|
|
624
|
+
* @property {number} [line_number] - The specific line item of bag.
|
|
625
|
+
* @property {string} [identifier] - The quantity of the product.
|
|
773
626
|
*/
|
|
774
627
|
|
|
775
628
|
/**
|
|
@@ -792,7 +645,7 @@ const Joi = require("joi");
|
|
|
792
645
|
*/
|
|
793
646
|
|
|
794
647
|
/**
|
|
795
|
-
* @typedef
|
|
648
|
+
* @typedef ShipmentsRequest
|
|
796
649
|
* @property {ReasonsData} [reasons]
|
|
797
650
|
* @property {Products[]} [products] - Specific bag to be updated.
|
|
798
651
|
* @property {DataUpdates} [data_updates]
|
|
@@ -801,23 +654,22 @@ const Joi = require("joi");
|
|
|
801
654
|
*/
|
|
802
655
|
|
|
803
656
|
/**
|
|
804
|
-
* @typedef
|
|
805
|
-
* @property {
|
|
806
|
-
*
|
|
657
|
+
* @typedef StatuesRequest
|
|
658
|
+
* @property {ShipmentsRequest[]} [shipments] - A list containing information
|
|
659
|
+
* about shipments.
|
|
807
660
|
* @property {string} [exclude_bags_next_state] - State to be change for
|
|
808
661
|
* Remaining Bag/Products.
|
|
809
662
|
* @property {string} [status] - The status to which the entity is to be transitioned.
|
|
810
663
|
*/
|
|
811
664
|
|
|
812
665
|
/**
|
|
813
|
-
* @typedef
|
|
666
|
+
* @typedef OrderRequest
|
|
814
667
|
* @property {Object} [meta] - Metadata for the order.
|
|
815
668
|
*/
|
|
816
669
|
|
|
817
670
|
/**
|
|
818
|
-
* @typedef
|
|
819
|
-
* @property {
|
|
820
|
-
* status details.
|
|
671
|
+
* @typedef UpdateShipmentStatusRequest
|
|
672
|
+
* @property {StatuesRequest[]} [statuses] - An array containing different status details.
|
|
821
673
|
* @property {boolean} [task] - Indicates whether the task is active or required.
|
|
822
674
|
* @property {boolean} [lock_after_transition] - Indicates whether the status
|
|
823
675
|
* should be locked after the transition.
|
|
@@ -828,18 +680,18 @@ const Joi = require("joi");
|
|
|
828
680
|
*/
|
|
829
681
|
|
|
830
682
|
/**
|
|
831
|
-
* @typedef
|
|
683
|
+
* @typedef StatusesBodyResponse
|
|
832
684
|
* @property {Object[]} [shipments] - List of shipments.
|
|
833
685
|
*/
|
|
834
686
|
|
|
835
687
|
/**
|
|
836
|
-
* @typedef
|
|
837
|
-
* @property {
|
|
838
|
-
*
|
|
688
|
+
* @typedef ShipmentApplicationStatusResponse
|
|
689
|
+
* @property {StatusesBodyResponse[]} [statuses] - An array containing different
|
|
690
|
+
* status options of shipments.
|
|
839
691
|
*/
|
|
840
692
|
|
|
841
693
|
/**
|
|
842
|
-
* @typedef
|
|
694
|
+
* @typedef ErrorResponse
|
|
843
695
|
* @property {string} [code] - The HTTP status code of the response.
|
|
844
696
|
* @property {string} [message] - A message providing details about the response.
|
|
845
697
|
* @property {number} [status] - An additional code providing more context about
|
|
@@ -931,49 +783,6 @@ class OrderApplicationModel {
|
|
|
931
783
|
});
|
|
932
784
|
}
|
|
933
785
|
|
|
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
|
-
|
|
977
786
|
/** @returns {ShipmentStatus} */
|
|
978
787
|
static ShipmentStatus() {
|
|
979
788
|
return Joi.object({
|
|
@@ -1084,6 +893,8 @@ class OrderApplicationModel {
|
|
|
1084
893
|
return Joi.object({
|
|
1085
894
|
image: Joi.array().items(Joi.string().allow("")),
|
|
1086
895
|
l1_categories: Joi.array().items(Joi.string().allow("")),
|
|
896
|
+
l2_category: Joi.array().items(Joi.string().allow("")),
|
|
897
|
+
l2_category_id: Joi.number(),
|
|
1087
898
|
brand: OrderApplicationModel.ItemBrand(),
|
|
1088
899
|
seller_identifier: Joi.string().allow(""),
|
|
1089
900
|
code: Joi.string().allow(""),
|
|
@@ -1101,7 +912,7 @@ class OrderApplicationModel {
|
|
|
1101
912
|
static AppliedFreeArticles() {
|
|
1102
913
|
return Joi.object({
|
|
1103
914
|
article_id: Joi.string().allow(""),
|
|
1104
|
-
free_gift_item_details: Joi.
|
|
915
|
+
free_gift_item_details: Joi.any(),
|
|
1105
916
|
parent_item_identifier: Joi.string().allow(""),
|
|
1106
917
|
quantity: Joi.number(),
|
|
1107
918
|
});
|
|
@@ -1191,13 +1002,12 @@ class OrderApplicationModel {
|
|
|
1191
1002
|
financial_breakup: Joi.array().items(
|
|
1192
1003
|
OrderApplicationModel.FinancialBreakup()
|
|
1193
1004
|
),
|
|
1194
|
-
parent_promo_bags: Joi.
|
|
1195
|
-
meta: Joi.
|
|
1005
|
+
parent_promo_bags: Joi.any(),
|
|
1006
|
+
meta: Joi.any(),
|
|
1196
1007
|
currency_code: Joi.string().allow(""),
|
|
1197
1008
|
seller_identifier: Joi.string().allow(""),
|
|
1198
1009
|
current_status: OrderApplicationModel.CurrentStatus(),
|
|
1199
1010
|
article: OrderApplicationModel.Article(),
|
|
1200
|
-
charges: Joi.array().items(OrderApplicationModel.PriceAdjustmentCharge()),
|
|
1201
1011
|
});
|
|
1202
1012
|
}
|
|
1203
1013
|
|
|
@@ -1264,9 +1074,9 @@ class OrderApplicationModel {
|
|
|
1264
1074
|
comment: Joi.string().allow(""),
|
|
1265
1075
|
invoice: OrderApplicationModel.Invoice(),
|
|
1266
1076
|
show_track_link: Joi.boolean(),
|
|
1267
|
-
refund_details: Joi.
|
|
1077
|
+
refund_details: Joi.any(),
|
|
1268
1078
|
breakup_values: Joi.array().items(OrderApplicationModel.BreakupValues()),
|
|
1269
|
-
can_break: Joi.
|
|
1079
|
+
can_break: Joi.any(),
|
|
1270
1080
|
traking_no: Joi.string().allow(""),
|
|
1271
1081
|
tracking_details: Joi.array().items(
|
|
1272
1082
|
OrderApplicationModel.TrackingDetails()
|
|
@@ -1278,7 +1088,7 @@ class OrderApplicationModel {
|
|
|
1278
1088
|
returnable_date: Joi.string().allow("").allow(null),
|
|
1279
1089
|
shipment_created_at: Joi.string().allow(""),
|
|
1280
1090
|
shipment_created_ts: Joi.string().allow(""),
|
|
1281
|
-
size_info: Joi.
|
|
1091
|
+
size_info: Joi.any(),
|
|
1282
1092
|
bags: Joi.array().items(OrderApplicationModel.Bags()),
|
|
1283
1093
|
dp_name: Joi.string().allow(""),
|
|
1284
1094
|
awb_no: Joi.string().allow(""),
|
|
@@ -1290,10 +1100,9 @@ class OrderApplicationModel {
|
|
|
1290
1100
|
track_url: Joi.string().allow(""),
|
|
1291
1101
|
order_id: Joi.string().allow(""),
|
|
1292
1102
|
need_help_url: Joi.string().allow(""),
|
|
1293
|
-
return_meta: Joi.
|
|
1103
|
+
return_meta: Joi.any(),
|
|
1294
1104
|
delivery_date: Joi.string().allow("").allow(null),
|
|
1295
|
-
order: OrderApplicationModel.
|
|
1296
|
-
charges: Joi.array().items(OrderApplicationModel.PriceAdjustmentCharge()),
|
|
1105
|
+
order: OrderApplicationModel.OrderRequest(),
|
|
1297
1106
|
});
|
|
1298
1107
|
}
|
|
1299
1108
|
|
|
@@ -1331,7 +1140,6 @@ class OrderApplicationModel {
|
|
|
1331
1140
|
bags_for_reorder: Joi.array().items(
|
|
1332
1141
|
OrderApplicationModel.BagsForReorder()
|
|
1333
1142
|
),
|
|
1334
|
-
charges: Joi.array().items(OrderApplicationModel.PriceAdjustmentCharge()),
|
|
1335
1143
|
meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
1336
1144
|
});
|
|
1337
1145
|
}
|
|
@@ -1414,8 +1222,8 @@ class OrderApplicationModel {
|
|
|
1414
1222
|
});
|
|
1415
1223
|
}
|
|
1416
1224
|
|
|
1417
|
-
/** @returns {
|
|
1418
|
-
static
|
|
1225
|
+
/** @returns {CustomerDetailsResponse} */
|
|
1226
|
+
static CustomerDetailsResponse() {
|
|
1419
1227
|
return Joi.object({
|
|
1420
1228
|
phone: Joi.string().allow(""),
|
|
1421
1229
|
shipment_id: Joi.string().allow(""),
|
|
@@ -1425,8 +1233,8 @@ class OrderApplicationModel {
|
|
|
1425
1233
|
});
|
|
1426
1234
|
}
|
|
1427
1235
|
|
|
1428
|
-
/** @returns {
|
|
1429
|
-
static
|
|
1236
|
+
/** @returns {SendOtpToCustomerResponse} */
|
|
1237
|
+
static SendOtpToCustomerResponse() {
|
|
1430
1238
|
return Joi.object({
|
|
1431
1239
|
request_id: Joi.string().allow(""),
|
|
1432
1240
|
message: Joi.string().allow(""),
|
|
@@ -1443,8 +1251,8 @@ class OrderApplicationModel {
|
|
|
1443
1251
|
});
|
|
1444
1252
|
}
|
|
1445
1253
|
|
|
1446
|
-
/** @returns {
|
|
1447
|
-
static
|
|
1254
|
+
/** @returns {VerifyOtpResponse} */
|
|
1255
|
+
static VerifyOtpResponse() {
|
|
1448
1256
|
return Joi.object({
|
|
1449
1257
|
success: Joi.boolean(),
|
|
1450
1258
|
});
|
|
@@ -1482,7 +1290,6 @@ class OrderApplicationModel {
|
|
|
1482
1290
|
return Joi.object({
|
|
1483
1291
|
reasons: Joi.array().items(OrderApplicationModel.BagReasons()),
|
|
1484
1292
|
success: Joi.boolean(),
|
|
1485
|
-
rule_id: Joi.number().allow(null),
|
|
1486
1293
|
});
|
|
1487
1294
|
}
|
|
1488
1295
|
|
|
@@ -1570,14 +1377,13 @@ class OrderApplicationModel {
|
|
|
1570
1377
|
return Joi.object({
|
|
1571
1378
|
line_number: Joi.number(),
|
|
1572
1379
|
identifier: Joi.string().allow(""),
|
|
1573
|
-
quantity: Joi.number(),
|
|
1574
1380
|
});
|
|
1575
1381
|
}
|
|
1576
1382
|
|
|
1577
1383
|
/** @returns {ProductsDataUpdates} */
|
|
1578
1384
|
static ProductsDataUpdates() {
|
|
1579
1385
|
return Joi.object({
|
|
1580
|
-
data: Joi.
|
|
1386
|
+
data: Joi.any(),
|
|
1581
1387
|
filters: Joi.array().items(
|
|
1582
1388
|
OrderApplicationModel.ProductsDataUpdatesFilters()
|
|
1583
1389
|
),
|
|
@@ -1587,7 +1393,7 @@ class OrderApplicationModel {
|
|
|
1587
1393
|
/** @returns {EntitiesDataUpdates} */
|
|
1588
1394
|
static EntitiesDataUpdates() {
|
|
1589
1395
|
return Joi.object({
|
|
1590
|
-
data: Joi.
|
|
1396
|
+
data: Joi.any(),
|
|
1591
1397
|
filters: Joi.array().items(Joi.any()),
|
|
1592
1398
|
});
|
|
1593
1399
|
}
|
|
@@ -1600,8 +1406,8 @@ class OrderApplicationModel {
|
|
|
1600
1406
|
});
|
|
1601
1407
|
}
|
|
1602
1408
|
|
|
1603
|
-
/** @returns {
|
|
1604
|
-
static
|
|
1409
|
+
/** @returns {ShipmentsRequest} */
|
|
1410
|
+
static ShipmentsRequest() {
|
|
1605
1411
|
return Joi.object({
|
|
1606
1412
|
reasons: OrderApplicationModel.ReasonsData(),
|
|
1607
1413
|
products: Joi.array().items(OrderApplicationModel.Products()),
|
|
@@ -1610,28 +1416,26 @@ class OrderApplicationModel {
|
|
|
1610
1416
|
});
|
|
1611
1417
|
}
|
|
1612
1418
|
|
|
1613
|
-
/** @returns {
|
|
1614
|
-
static
|
|
1419
|
+
/** @returns {StatuesRequest} */
|
|
1420
|
+
static StatuesRequest() {
|
|
1615
1421
|
return Joi.object({
|
|
1616
|
-
shipments: Joi.array().items(
|
|
1617
|
-
OrderApplicationModel.ShipmentsRequestSchema()
|
|
1618
|
-
),
|
|
1422
|
+
shipments: Joi.array().items(OrderApplicationModel.ShipmentsRequest()),
|
|
1619
1423
|
exclude_bags_next_state: Joi.string().allow(""),
|
|
1620
1424
|
status: Joi.string().allow(""),
|
|
1621
1425
|
});
|
|
1622
1426
|
}
|
|
1623
1427
|
|
|
1624
|
-
/** @returns {
|
|
1625
|
-
static
|
|
1428
|
+
/** @returns {OrderRequest} */
|
|
1429
|
+
static OrderRequest() {
|
|
1626
1430
|
return Joi.object({
|
|
1627
|
-
meta: Joi.
|
|
1431
|
+
meta: Joi.any(),
|
|
1628
1432
|
});
|
|
1629
1433
|
}
|
|
1630
1434
|
|
|
1631
|
-
/** @returns {
|
|
1632
|
-
static
|
|
1435
|
+
/** @returns {UpdateShipmentStatusRequest} */
|
|
1436
|
+
static UpdateShipmentStatusRequest() {
|
|
1633
1437
|
return Joi.object({
|
|
1634
|
-
statuses: Joi.array().items(OrderApplicationModel.
|
|
1438
|
+
statuses: Joi.array().items(OrderApplicationModel.StatuesRequest()),
|
|
1635
1439
|
task: Joi.boolean(),
|
|
1636
1440
|
lock_after_transition: Joi.boolean(),
|
|
1637
1441
|
force_transition: Joi.boolean(),
|
|
@@ -1639,24 +1443,22 @@ class OrderApplicationModel {
|
|
|
1639
1443
|
});
|
|
1640
1444
|
}
|
|
1641
1445
|
|
|
1642
|
-
/** @returns {
|
|
1643
|
-
static
|
|
1446
|
+
/** @returns {StatusesBodyResponse} */
|
|
1447
|
+
static StatusesBodyResponse() {
|
|
1644
1448
|
return Joi.object({
|
|
1645
1449
|
shipments: Joi.array().items(Joi.any()),
|
|
1646
1450
|
});
|
|
1647
1451
|
}
|
|
1648
1452
|
|
|
1649
|
-
/** @returns {
|
|
1650
|
-
static
|
|
1453
|
+
/** @returns {ShipmentApplicationStatusResponse} */
|
|
1454
|
+
static ShipmentApplicationStatusResponse() {
|
|
1651
1455
|
return Joi.object({
|
|
1652
|
-
statuses: Joi.array().items(
|
|
1653
|
-
OrderApplicationModel.StatusesBodyResponseSchema()
|
|
1654
|
-
),
|
|
1456
|
+
statuses: Joi.array().items(OrderApplicationModel.StatusesBodyResponse()),
|
|
1655
1457
|
});
|
|
1656
1458
|
}
|
|
1657
1459
|
|
|
1658
|
-
/** @returns {
|
|
1659
|
-
static
|
|
1460
|
+
/** @returns {ErrorResponse} */
|
|
1461
|
+
static ErrorResponse() {
|
|
1660
1462
|
return Joi.object({
|
|
1661
1463
|
code: Joi.string().allow("").allow(null),
|
|
1662
1464
|
message: Joi.string().allow("").allow(null),
|