@gofynd/fdk-client-javascript 1.4.15-beta.2 → 1.4.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/application.d.ts +1 -2
- package/application.js +2 -3
- package/index.d.ts +1 -2
- package/index.js +7 -1
- package/package.json +2 -3
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -18
- package/sdk/application/Cart/CartApplicationClient.d.ts +75 -90
- package/sdk/application/Cart/CartApplicationClient.js +108 -1199
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +81 -142
- package/sdk/application/Catalog/CatalogApplicationClient.js +41 -1344
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
- package/sdk/application/Common/CommonApplicationClient.js +2 -92
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -148
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -727
- package/sdk/application/Content/ContentApplicationClient.d.ts +48 -111
- package/sdk/application/Content/ContentApplicationClient.js +43 -1065
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -13
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +8 -138
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +105 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
- package/sdk/application/Lead/LeadApplicationClient.js +5 -217
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +42 -39
- package/sdk/application/Logistic/LogisticApplicationClient.js +91 -493
- package/sdk/application/Order/OrderApplicationClient.d.ts +36 -46
- package/sdk/application/Order/OrderApplicationClient.js +52 -507
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +103 -213
- package/sdk/application/Payment/PaymentApplicationClient.js +84 -2105
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +15 -29
- package/sdk/application/Rewards/RewardsApplicationClient.js +8 -312
- package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
- package/sdk/application/Share/ShareApplicationClient.js +7 -309
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -176
- package/sdk/application/User/UserApplicationClient.d.ts +87 -138
- package/sdk/application/User/UserApplicationClient.js +44 -1820
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -7
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -52
- package/sdk/application/index.d.ts +0 -18
- package/sdk/application/index.js +0 -33
- 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 +157 -30
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +1177 -56
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1662 -249
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +774 -162
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +13 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +141 -12
- 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 +5060 -1300
- package/sdk/platform/Cart/CartPlatformModel.js +1985 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +178 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +468 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6554 -1772
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3264 -1690
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +116 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +85 -24
- 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 +122 -191
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +447 -831
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +174 -220
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +164 -199
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1233 -476
- package/sdk/platform/Content/ContentPlatformModel.js +514 -487
- 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 +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +424 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7747 -1342
- package/sdk/platform/Order/OrderPlatformModel.js +3960 -1262
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +292 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +145 -77
- 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 +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- 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 +46 -36
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +132 -41
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +132 -44
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +681 -64
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2458 -650
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1266 -572
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +176 -47
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +134 -28
- 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 +10 -7
- 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 +795 -7
- 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/Partner/PartnerPublicClient.js +4 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +12 -10
- 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/Cart/CartApplicationModel.d.ts +0 -3994
- package/sdk/application/Cart/CartApplicationModel.js +0 -2497
- package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
- package/sdk/application/Cart/CartApplicationValidator.js +0 -530
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
- package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
- package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
- package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
- package/sdk/application/Common/CommonApplicationModel.js +0 -308
- package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
- package/sdk/application/Common/CommonApplicationValidator.js +0 -38
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
- package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
- package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
- package/sdk/application/Content/ContentApplicationModel.js +0 -1589
- package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
- package/sdk/application/Content/ContentApplicationValidator.js +0 -264
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
- package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
- package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
- package/sdk/application/Lead/LeadApplicationModel.js +0 -480
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
- package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
- package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
- package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
- package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
- package/sdk/application/Order/OrderApplicationModel.js +0 -1471
- package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
- package/sdk/application/Order/OrderApplicationValidator.js +0 -197
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
- package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
- package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
- package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
- package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
- package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
- package/sdk/application/Share/ShareApplicationModel.js +0 -234
- package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
- package/sdk/application/Share/ShareApplicationValidator.js +0 -91
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
- package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
- package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
- package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
- package/sdk/application/User/UserApplicationModel.js +0 -1382
- package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
- package/sdk/application/User/UserApplicationValidator.js +0 -573
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
- package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
- package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
- package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
- package/sdk/common/Clickstream.d.ts +0 -1
- package/sdk/common/Clickstream.js +0 -464
- 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
|
@@ -18,7 +18,8 @@ class Order {
|
|
|
18
18
|
* @param {OrderPlatformValidator.AddStateManagerConfigParam} arg - Arg object
|
|
19
19
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
|
-
* @returns {Promise<OrderPlatformModel.
|
|
21
|
+
* @returns {Promise<OrderPlatformModel.ConfigUpdatedResponseSchema>} -
|
|
22
|
+
* Success response
|
|
22
23
|
* @name addStateManagerConfig
|
|
23
24
|
* @summary: Allows esm config updation
|
|
24
25
|
* @description: Update ESM config - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/addStateManagerConfig/).
|
|
@@ -74,10 +75,10 @@ class Order {
|
|
|
74
75
|
|
|
75
76
|
const {
|
|
76
77
|
error: res_error,
|
|
77
|
-
} = OrderPlatformModel.
|
|
78
|
-
|
|
79
|
-
allowUnknown: true
|
|
80
|
-
|
|
78
|
+
} = OrderPlatformModel.ConfigUpdatedResponseSchema().validate(
|
|
79
|
+
responseData,
|
|
80
|
+
{ abortEarly: false, allowUnknown: true }
|
|
81
|
+
);
|
|
81
82
|
|
|
82
83
|
if (res_error) {
|
|
83
84
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -97,7 +98,8 @@ class Order {
|
|
|
97
98
|
* @param {OrderPlatformValidator.AttachOrderUserParam} arg - Arg object
|
|
98
99
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
99
100
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
100
|
-
* @returns {Promise<OrderPlatformModel.
|
|
101
|
+
* @returns {Promise<OrderPlatformModel.AttachOrderUserResponseSchema>} -
|
|
102
|
+
* Success response
|
|
101
103
|
* @name attachOrderUser
|
|
102
104
|
* @summary: Attach order to a user
|
|
103
105
|
* @description: Attach an anonymous order to a customer based on OTP verification - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/attachOrderUser/).
|
|
@@ -153,10 +155,10 @@ class Order {
|
|
|
153
155
|
|
|
154
156
|
const {
|
|
155
157
|
error: res_error,
|
|
156
|
-
} = OrderPlatformModel.
|
|
157
|
-
|
|
158
|
-
allowUnknown: true
|
|
159
|
-
|
|
158
|
+
} = OrderPlatformModel.AttachOrderUserResponseSchema().validate(
|
|
159
|
+
responseData,
|
|
160
|
+
{ abortEarly: false, allowUnknown: true }
|
|
161
|
+
);
|
|
160
162
|
|
|
161
163
|
if (res_error) {
|
|
162
164
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -176,7 +178,7 @@ class Order {
|
|
|
176
178
|
* @param {OrderPlatformValidator.BulkListingParam} arg - Arg object
|
|
177
179
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
178
180
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
179
|
-
* @returns {Promise<OrderPlatformModel.
|
|
181
|
+
* @returns {Promise<OrderPlatformModel.BulkListingResponseSchema>} - Success response
|
|
180
182
|
* @name bulkListing
|
|
181
183
|
* @summary: Lists bulk operations
|
|
182
184
|
* @description: Get list of bulk operation that is initiated and completed as per the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/bulkListing/).
|
|
@@ -258,7 +260,7 @@ class Order {
|
|
|
258
260
|
|
|
259
261
|
const {
|
|
260
262
|
error: res_error,
|
|
261
|
-
} = OrderPlatformModel.
|
|
263
|
+
} = OrderPlatformModel.BulkListingResponseSchema().validate(responseData, {
|
|
262
264
|
abortEarly: false,
|
|
263
265
|
allowUnknown: true,
|
|
264
266
|
});
|
|
@@ -281,8 +283,9 @@ class Order {
|
|
|
281
283
|
* @param {OrderPlatformValidator.BulkStateTransistionParam} arg - Arg object
|
|
282
284
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
283
285
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
284
|
-
* @returns {Promise<OrderPlatformModel.
|
|
285
|
-
* Success response
|
|
286
|
+
* @returns {Promise<OrderPlatformModel.BulkStateTransistionResponseSchema>}
|
|
287
|
+
* - Success response
|
|
288
|
+
*
|
|
286
289
|
* @name bulkStateTransistion
|
|
287
290
|
* @summary: Upload bulk state transitions file
|
|
288
291
|
* @description: Performs state transisiton in bulk using the CSV or excel file for the given shipments. The bulk transition CSV or excel template can be downloaded using the seller template download method. Current supported format is excel and CSV. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/bulkStateTransistion/).
|
|
@@ -338,7 +341,7 @@ class Order {
|
|
|
338
341
|
|
|
339
342
|
const {
|
|
340
343
|
error: res_error,
|
|
341
|
-
} = OrderPlatformModel.
|
|
344
|
+
} = OrderPlatformModel.BulkStateTransistionResponseSchema().validate(
|
|
342
345
|
responseData,
|
|
343
346
|
{ abortEarly: false, allowUnknown: true }
|
|
344
347
|
);
|
|
@@ -436,11 +439,92 @@ class Order {
|
|
|
436
439
|
return response;
|
|
437
440
|
}
|
|
438
441
|
|
|
442
|
+
/**
|
|
443
|
+
* @param {OrderPlatformValidator.CreateChannelConfigParam} arg - Arg object
|
|
444
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
445
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
446
|
+
* @returns {Promise<OrderPlatformModel.CreateChannelConfigResponseSchema>}
|
|
447
|
+
* - Success response
|
|
448
|
+
*
|
|
449
|
+
* @name createChannelConfig
|
|
450
|
+
* @summary: Create channel configuration
|
|
451
|
+
* @description: Set up configuration for a channel specific to orders which has implications over how the order fulfilment happens in a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createChannelConfig/).
|
|
452
|
+
*/
|
|
453
|
+
async createChannelConfig(
|
|
454
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
455
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
456
|
+
) {
|
|
457
|
+
const { error } = OrderPlatformValidator.createChannelConfig().validate(
|
|
458
|
+
{
|
|
459
|
+
body,
|
|
460
|
+
},
|
|
461
|
+
{ abortEarly: false, allowUnknown: true }
|
|
462
|
+
);
|
|
463
|
+
if (error) {
|
|
464
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
465
|
+
}
|
|
466
|
+
|
|
467
|
+
// Showing warrnings if extra unknown parameters are found
|
|
468
|
+
const {
|
|
469
|
+
error: warrning,
|
|
470
|
+
} = OrderPlatformValidator.createChannelConfig().validate(
|
|
471
|
+
{
|
|
472
|
+
body,
|
|
473
|
+
},
|
|
474
|
+
{ abortEarly: false, allowUnknown: false }
|
|
475
|
+
);
|
|
476
|
+
if (warrning) {
|
|
477
|
+
Logger({
|
|
478
|
+
level: "WARN",
|
|
479
|
+
message: `Parameter Validation warrnings for platform > Order > createChannelConfig \n ${warrning}`,
|
|
480
|
+
});
|
|
481
|
+
}
|
|
482
|
+
|
|
483
|
+
const query_params = {};
|
|
484
|
+
|
|
485
|
+
const xHeaders = {};
|
|
486
|
+
|
|
487
|
+
const response = await PlatformAPIClient.execute(
|
|
488
|
+
this.config,
|
|
489
|
+
"post",
|
|
490
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/order-config`,
|
|
491
|
+
query_params,
|
|
492
|
+
body,
|
|
493
|
+
{ ...xHeaders, ...requestHeaders },
|
|
494
|
+
{ responseHeaders }
|
|
495
|
+
);
|
|
496
|
+
|
|
497
|
+
let responseData = response;
|
|
498
|
+
if (responseHeaders) {
|
|
499
|
+
responseData = response[0];
|
|
500
|
+
}
|
|
501
|
+
|
|
502
|
+
const {
|
|
503
|
+
error: res_error,
|
|
504
|
+
} = OrderPlatformModel.CreateChannelConfigResponseSchema().validate(
|
|
505
|
+
responseData,
|
|
506
|
+
{ abortEarly: false, allowUnknown: true }
|
|
507
|
+
);
|
|
508
|
+
|
|
509
|
+
if (res_error) {
|
|
510
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
511
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
512
|
+
} else {
|
|
513
|
+
Logger({
|
|
514
|
+
level: "WARN",
|
|
515
|
+
message: `Response Validation Warnings for platform > Order > createChannelConfig \n ${res_error}`,
|
|
516
|
+
});
|
|
517
|
+
}
|
|
518
|
+
}
|
|
519
|
+
|
|
520
|
+
return response;
|
|
521
|
+
}
|
|
522
|
+
|
|
439
523
|
/**
|
|
440
524
|
* @param {OrderPlatformValidator.CreateOrderParam} arg - Arg object
|
|
441
525
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
442
526
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
443
|
-
* @returns {Promise<OrderPlatformModel.
|
|
527
|
+
* @returns {Promise<OrderPlatformModel.CreateOrderResponseSchema>} - Success response
|
|
444
528
|
* @name createOrder
|
|
445
529
|
* @summary: Create order
|
|
446
530
|
* @description: Creates an order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/createOrder/).
|
|
@@ -494,7 +578,7 @@ class Order {
|
|
|
494
578
|
|
|
495
579
|
const {
|
|
496
580
|
error: res_error,
|
|
497
|
-
} = OrderPlatformModel.
|
|
581
|
+
} = OrderPlatformModel.CreateOrderResponseSchema().validate(responseData, {
|
|
498
582
|
abortEarly: false,
|
|
499
583
|
allowUnknown: true,
|
|
500
584
|
});
|
|
@@ -517,7 +601,7 @@ class Order {
|
|
|
517
601
|
* @param {OrderPlatformValidator.DispatchManifestsParam} arg - Arg object
|
|
518
602
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
519
603
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
520
|
-
* @returns {Promise<OrderPlatformModel.
|
|
604
|
+
* @returns {Promise<OrderPlatformModel.SuccessResponseSchema>} - Success response
|
|
521
605
|
* @name dispatchManifests
|
|
522
606
|
* @summary: Dispatch manifest
|
|
523
607
|
* @description: Updates the status of the manifest to processed and change the status of the shipments in the manifest to dispatch status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/dispatchManifests/).
|
|
@@ -573,7 +657,7 @@ class Order {
|
|
|
573
657
|
|
|
574
658
|
const {
|
|
575
659
|
error: res_error,
|
|
576
|
-
} = OrderPlatformModel.
|
|
660
|
+
} = OrderPlatformModel.SuccessResponseSchema().validate(responseData, {
|
|
577
661
|
abortEarly: false,
|
|
578
662
|
allowUnknown: true,
|
|
579
663
|
});
|
|
@@ -596,7 +680,7 @@ class Order {
|
|
|
596
680
|
* @param {OrderPlatformValidator.DownloadBulkActionTemplateParam} arg - Arg object
|
|
597
681
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
598
682
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
599
|
-
* @returns {Promise<OrderPlatformModel.
|
|
683
|
+
* @returns {Promise<OrderPlatformModel.FileResponseSchema>} - Success response
|
|
600
684
|
* @name downloadBulkActionTemplate
|
|
601
685
|
* @summary: Download bulk template
|
|
602
686
|
* @description: Download bulk seller templates which can be used to perform operations in bulk - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadBulkActionTemplate/).
|
|
@@ -655,7 +739,7 @@ class Order {
|
|
|
655
739
|
|
|
656
740
|
const {
|
|
657
741
|
error: res_error,
|
|
658
|
-
} = OrderPlatformModel.
|
|
742
|
+
} = OrderPlatformModel.FileResponseSchema().validate(responseData, {
|
|
659
743
|
abortEarly: false,
|
|
660
744
|
allowUnknown: true,
|
|
661
745
|
});
|
|
@@ -678,8 +762,9 @@ class Order {
|
|
|
678
762
|
* @param {OrderPlatformValidator.DownloadLanesReportParam} arg - Arg object
|
|
679
763
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
680
764
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
681
|
-
* @returns {Promise<OrderPlatformModel.
|
|
682
|
-
* Success response
|
|
765
|
+
* @returns {Promise<OrderPlatformModel.BulkReportsDownloadResponseSchema>}
|
|
766
|
+
* - Success response
|
|
767
|
+
*
|
|
683
768
|
* @name downloadLanesReport
|
|
684
769
|
* @summary: Download Lane report
|
|
685
770
|
* @description: Downloads shipments/orders present in the provided lane - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/downloadLanesReport/).
|
|
@@ -735,7 +820,7 @@ class Order {
|
|
|
735
820
|
|
|
736
821
|
const {
|
|
737
822
|
error: res_error,
|
|
738
|
-
} = OrderPlatformModel.
|
|
823
|
+
} = OrderPlatformModel.BulkReportsDownloadResponseSchema().validate(
|
|
739
824
|
responseData,
|
|
740
825
|
{ abortEarly: false, allowUnknown: true }
|
|
741
826
|
);
|
|
@@ -758,7 +843,8 @@ class Order {
|
|
|
758
843
|
* @param {OrderPlatformValidator.EInvoiceRetryParam} arg - Arg object
|
|
759
844
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
760
845
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
761
|
-
* @returns {Promise<OrderPlatformModel.
|
|
846
|
+
* @returns {Promise<OrderPlatformModel.EInvoiceRetryResponseSchema>} -
|
|
847
|
+
* Success response
|
|
762
848
|
* @name eInvoiceRetry
|
|
763
849
|
* @summary: Retry E-invoice
|
|
764
850
|
* @description: Reattempt the generation of an E-invoice - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/eInvoiceRetry/).
|
|
@@ -812,10 +898,10 @@ class Order {
|
|
|
812
898
|
|
|
813
899
|
const {
|
|
814
900
|
error: res_error,
|
|
815
|
-
} = OrderPlatformModel.
|
|
816
|
-
|
|
817
|
-
allowUnknown: true
|
|
818
|
-
|
|
901
|
+
} = OrderPlatformModel.EInvoiceRetryResponseSchema().validate(
|
|
902
|
+
responseData,
|
|
903
|
+
{ abortEarly: false, allowUnknown: true }
|
|
904
|
+
);
|
|
819
905
|
|
|
820
906
|
if (res_error) {
|
|
821
907
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -994,7 +1080,8 @@ class Order {
|
|
|
994
1080
|
* @param {OrderPlatformValidator.GenerateInvoiceIDParam} arg - Arg object
|
|
995
1081
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
996
1082
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
997
|
-
* @returns {Promise<OrderPlatformModel.
|
|
1083
|
+
* @returns {Promise<OrderPlatformModel.GenerateInvoiceIDResponseSchema>} -
|
|
1084
|
+
* Success response
|
|
998
1085
|
* @name generateInvoiceID
|
|
999
1086
|
* @summary: Generate and attach invoice Id
|
|
1000
1087
|
* @description: Generate and attach Invoice Ids against shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateInvoiceID/).
|
|
@@ -1052,10 +1139,10 @@ class Order {
|
|
|
1052
1139
|
|
|
1053
1140
|
const {
|
|
1054
1141
|
error: res_error,
|
|
1055
|
-
} = OrderPlatformModel.
|
|
1056
|
-
|
|
1057
|
-
allowUnknown: true
|
|
1058
|
-
|
|
1142
|
+
} = OrderPlatformModel.GenerateInvoiceIDResponseSchema().validate(
|
|
1143
|
+
responseData,
|
|
1144
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1145
|
+
);
|
|
1059
1146
|
|
|
1060
1147
|
if (res_error) {
|
|
1061
1148
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1075,8 +1162,9 @@ class Order {
|
|
|
1075
1162
|
* @param {OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam} arg - Arg object
|
|
1076
1163
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1077
1164
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1078
|
-
* @returns {Promise<OrderPlatformModel.
|
|
1079
|
-
* Success response
|
|
1165
|
+
* @returns {Promise<OrderPlatformModel.GeneratePosOrderReceiptResponseSchema>}
|
|
1166
|
+
* - Success response
|
|
1167
|
+
*
|
|
1080
1168
|
* @name generatePOSReceiptByOrderId
|
|
1081
1169
|
* @summary: Generate POS receipt by order Id
|
|
1082
1170
|
* @description: Create a point-of-sale (POS) receipt for a specific order by order Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generatePOSReceiptByOrderId/).
|
|
@@ -1142,7 +1230,7 @@ class Order {
|
|
|
1142
1230
|
|
|
1143
1231
|
const {
|
|
1144
1232
|
error: res_error,
|
|
1145
|
-
} = OrderPlatformModel.
|
|
1233
|
+
} = OrderPlatformModel.GeneratePosOrderReceiptResponseSchema().validate(
|
|
1146
1234
|
responseData,
|
|
1147
1235
|
{ abortEarly: false, allowUnknown: true }
|
|
1148
1236
|
);
|
|
@@ -1165,7 +1253,7 @@ class Order {
|
|
|
1165
1253
|
* @param {OrderPlatformValidator.GenerateProcessManifestParam} arg - Arg object
|
|
1166
1254
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1167
1255
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1168
|
-
* @returns {Promise<OrderPlatformModel.
|
|
1256
|
+
* @returns {Promise<OrderPlatformModel.ManifestResponseSchema>} - Success response
|
|
1169
1257
|
* @name generateProcessManifest
|
|
1170
1258
|
* @summary: Process Order Manifest
|
|
1171
1259
|
* @description: Endpoint to save and process order manifests. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateProcessManifest/).
|
|
@@ -1221,7 +1309,7 @@ class Order {
|
|
|
1221
1309
|
|
|
1222
1310
|
const {
|
|
1223
1311
|
error: res_error,
|
|
1224
|
-
} = OrderPlatformModel.
|
|
1312
|
+
} = OrderPlatformModel.ManifestResponseSchema().validate(responseData, {
|
|
1225
1313
|
abortEarly: false,
|
|
1226
1314
|
allowUnknown: true,
|
|
1227
1315
|
});
|
|
@@ -1330,7 +1418,8 @@ class Order {
|
|
|
1330
1418
|
* @param {OrderPlatformValidator.GetAllowedTemplatesForBulkParam} arg - Arg object
|
|
1331
1419
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1332
1420
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1333
|
-
* @returns {Promise<OrderPlatformModel.
|
|
1421
|
+
* @returns {Promise<OrderPlatformModel.AllowedTemplatesResponseSchema>} -
|
|
1422
|
+
* Success response
|
|
1334
1423
|
* @name getAllowedTemplatesForBulk
|
|
1335
1424
|
* @summary: List bulk operation templates
|
|
1336
1425
|
* @description: Gets all the allowed templates to perform bulk operations. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAllowedTemplatesForBulk/).
|
|
@@ -1384,10 +1473,10 @@ class Order {
|
|
|
1384
1473
|
|
|
1385
1474
|
const {
|
|
1386
1475
|
error: res_error,
|
|
1387
|
-
} = OrderPlatformModel.
|
|
1388
|
-
|
|
1389
|
-
allowUnknown: true
|
|
1390
|
-
|
|
1476
|
+
} = OrderPlatformModel.AllowedTemplatesResponseSchema().validate(
|
|
1477
|
+
responseData,
|
|
1478
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1479
|
+
);
|
|
1391
1480
|
|
|
1392
1481
|
if (res_error) {
|
|
1393
1482
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1407,7 +1496,8 @@ class Order {
|
|
|
1407
1496
|
* @param {OrderPlatformValidator.GetAnnouncementsParam} arg - Arg object
|
|
1408
1497
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1409
1498
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1410
|
-
* @returns {Promise<OrderPlatformModel.
|
|
1499
|
+
* @returns {Promise<OrderPlatformModel.AnnouncementsResponseSchema>} -
|
|
1500
|
+
* Success response
|
|
1411
1501
|
* @name getAnnouncements
|
|
1412
1502
|
* @summary: List announcements
|
|
1413
1503
|
* @description: Retrieve announcements related to orders fulfilment configured by platform or company admin - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getAnnouncements/).
|
|
@@ -1464,10 +1554,10 @@ class Order {
|
|
|
1464
1554
|
|
|
1465
1555
|
const {
|
|
1466
1556
|
error: res_error,
|
|
1467
|
-
} = OrderPlatformModel.
|
|
1468
|
-
|
|
1469
|
-
allowUnknown: true
|
|
1470
|
-
|
|
1557
|
+
} = OrderPlatformModel.AnnouncementsResponseSchema().validate(
|
|
1558
|
+
responseData,
|
|
1559
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1560
|
+
);
|
|
1471
1561
|
|
|
1472
1562
|
if (res_error) {
|
|
1473
1563
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1487,8 +1577,9 @@ class Order {
|
|
|
1487
1577
|
* @param {OrderPlatformValidator.GetBagByIdParam} arg - Arg object
|
|
1488
1578
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1489
1579
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1490
|
-
* @returns {Promise<OrderPlatformModel.
|
|
1491
|
-
* Success response
|
|
1580
|
+
* @returns {Promise<OrderPlatformModel.BagDetailsPlatformResponseSchema>}
|
|
1581
|
+
* - Success response
|
|
1582
|
+
*
|
|
1492
1583
|
* @name getBagById
|
|
1493
1584
|
* @summary: Get bag
|
|
1494
1585
|
* @description: Retrieve detailed information about a specific bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBagById/).
|
|
@@ -1549,10 +1640,10 @@ class Order {
|
|
|
1549
1640
|
|
|
1550
1641
|
const {
|
|
1551
1642
|
error: res_error,
|
|
1552
|
-
} = OrderPlatformModel.
|
|
1553
|
-
|
|
1554
|
-
allowUnknown: true
|
|
1555
|
-
|
|
1643
|
+
} = OrderPlatformModel.BagDetailsPlatformResponseSchema().validate(
|
|
1644
|
+
responseData,
|
|
1645
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1646
|
+
);
|
|
1556
1647
|
|
|
1557
1648
|
if (res_error) {
|
|
1558
1649
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1572,7 +1663,8 @@ class Order {
|
|
|
1572
1663
|
* @param {OrderPlatformValidator.GetBagsParam} arg - Arg object
|
|
1573
1664
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1574
1665
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1575
|
-
* @returns {Promise<OrderPlatformModel.
|
|
1666
|
+
* @returns {Promise<OrderPlatformModel.GetBagsPlatformResponseSchema>} -
|
|
1667
|
+
* Success response
|
|
1576
1668
|
* @name getBags
|
|
1577
1669
|
* @summary: List bags
|
|
1578
1670
|
* @description: Get paginated list of bags based on provided filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBags/).
|
|
@@ -1662,10 +1754,10 @@ class Order {
|
|
|
1662
1754
|
|
|
1663
1755
|
const {
|
|
1664
1756
|
error: res_error,
|
|
1665
|
-
} = OrderPlatformModel.
|
|
1666
|
-
|
|
1667
|
-
allowUnknown: true
|
|
1668
|
-
|
|
1757
|
+
} = OrderPlatformModel.GetBagsPlatformResponseSchema().validate(
|
|
1758
|
+
responseData,
|
|
1759
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1760
|
+
);
|
|
1669
1761
|
|
|
1670
1762
|
if (res_error) {
|
|
1671
1763
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1685,8 +1777,9 @@ class Order {
|
|
|
1685
1777
|
* @param {OrderPlatformValidator.GetBulkActionTemplateParam} arg - Arg object
|
|
1686
1778
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1687
1779
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1688
|
-
* @returns {Promise<OrderPlatformModel.
|
|
1689
|
-
* Success response
|
|
1780
|
+
* @returns {Promise<OrderPlatformModel.BulkActionTemplateResponseSchema>}
|
|
1781
|
+
* - Success response
|
|
1782
|
+
*
|
|
1690
1783
|
* @name getBulkActionTemplate
|
|
1691
1784
|
* @summary: List supported templates
|
|
1692
1785
|
* @description: Get list of templates so that users can download the required template - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkActionTemplate/).
|
|
@@ -1738,10 +1831,10 @@ class Order {
|
|
|
1738
1831
|
|
|
1739
1832
|
const {
|
|
1740
1833
|
error: res_error,
|
|
1741
|
-
} = OrderPlatformModel.
|
|
1742
|
-
|
|
1743
|
-
allowUnknown: true
|
|
1744
|
-
|
|
1834
|
+
} = OrderPlatformModel.BulkActionTemplateResponseSchema().validate(
|
|
1835
|
+
responseData,
|
|
1836
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1837
|
+
);
|
|
1745
1838
|
|
|
1746
1839
|
if (res_error) {
|
|
1747
1840
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -1761,7 +1854,7 @@ class Order {
|
|
|
1761
1854
|
* @param {OrderPlatformValidator.GetBulkShipmentExcelFileParam} arg - Arg object
|
|
1762
1855
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1763
1856
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1764
|
-
* @returns {Promise<OrderPlatformModel.
|
|
1857
|
+
* @returns {Promise<OrderPlatformModel.FileResponseSchema>} - Success response
|
|
1765
1858
|
* @name getBulkShipmentExcelFile
|
|
1766
1859
|
* @summary: Generate the report
|
|
1767
1860
|
* @description: Generates the report which can be filled and uploaded to perform the bulk operation based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getBulkShipmentExcelFile/).
|
|
@@ -1867,7 +1960,7 @@ class Order {
|
|
|
1867
1960
|
|
|
1868
1961
|
const {
|
|
1869
1962
|
error: res_error,
|
|
1870
|
-
} = OrderPlatformModel.
|
|
1963
|
+
} = OrderPlatformModel.FileResponseSchema().validate(responseData, {
|
|
1871
1964
|
abortEarly: false,
|
|
1872
1965
|
allowUnknown: true,
|
|
1873
1966
|
});
|
|
@@ -1886,11 +1979,86 @@ class Order {
|
|
|
1886
1979
|
return response;
|
|
1887
1980
|
}
|
|
1888
1981
|
|
|
1982
|
+
/**
|
|
1983
|
+
* @param {OrderPlatformValidator.GetChannelConfigParam} arg - Arg object
|
|
1984
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1985
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1986
|
+
* @returns {Promise<OrderPlatformModel.CreateChannelConfigData>} - Success response
|
|
1987
|
+
* @name getChannelConfig
|
|
1988
|
+
* @summary: Get channel configuration
|
|
1989
|
+
* @description: Retrieve configuration settings specific to orders for a channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getChannelConfig/).
|
|
1990
|
+
*/
|
|
1991
|
+
async getChannelConfig(
|
|
1992
|
+
{ requestHeaders } = { requestHeaders: {} },
|
|
1993
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1994
|
+
) {
|
|
1995
|
+
const { error } = OrderPlatformValidator.getChannelConfig().validate(
|
|
1996
|
+
{},
|
|
1997
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1998
|
+
);
|
|
1999
|
+
if (error) {
|
|
2000
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
2001
|
+
}
|
|
2002
|
+
|
|
2003
|
+
// Showing warrnings if extra unknown parameters are found
|
|
2004
|
+
const {
|
|
2005
|
+
error: warrning,
|
|
2006
|
+
} = OrderPlatformValidator.getChannelConfig().validate(
|
|
2007
|
+
{},
|
|
2008
|
+
{ abortEarly: false, allowUnknown: false }
|
|
2009
|
+
);
|
|
2010
|
+
if (warrning) {
|
|
2011
|
+
Logger({
|
|
2012
|
+
level: "WARN",
|
|
2013
|
+
message: `Parameter Validation warrnings for platform > Order > getChannelConfig \n ${warrning}`,
|
|
2014
|
+
});
|
|
2015
|
+
}
|
|
2016
|
+
|
|
2017
|
+
const query_params = {};
|
|
2018
|
+
|
|
2019
|
+
const xHeaders = {};
|
|
2020
|
+
|
|
2021
|
+
const response = await PlatformAPIClient.execute(
|
|
2022
|
+
this.config,
|
|
2023
|
+
"get",
|
|
2024
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/order-config`,
|
|
2025
|
+
query_params,
|
|
2026
|
+
undefined,
|
|
2027
|
+
{ ...xHeaders, ...requestHeaders },
|
|
2028
|
+
{ responseHeaders }
|
|
2029
|
+
);
|
|
2030
|
+
|
|
2031
|
+
let responseData = response;
|
|
2032
|
+
if (responseHeaders) {
|
|
2033
|
+
responseData = response[0];
|
|
2034
|
+
}
|
|
2035
|
+
|
|
2036
|
+
const {
|
|
2037
|
+
error: res_error,
|
|
2038
|
+
} = OrderPlatformModel.CreateChannelConfigData().validate(responseData, {
|
|
2039
|
+
abortEarly: false,
|
|
2040
|
+
allowUnknown: true,
|
|
2041
|
+
});
|
|
2042
|
+
|
|
2043
|
+
if (res_error) {
|
|
2044
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
2045
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
2046
|
+
} else {
|
|
2047
|
+
Logger({
|
|
2048
|
+
level: "WARN",
|
|
2049
|
+
message: `Response Validation Warnings for platform > Order > getChannelConfig \n ${res_error}`,
|
|
2050
|
+
});
|
|
2051
|
+
}
|
|
2052
|
+
}
|
|
2053
|
+
|
|
2054
|
+
return response;
|
|
2055
|
+
}
|
|
2056
|
+
|
|
1889
2057
|
/**
|
|
1890
2058
|
* @param {OrderPlatformValidator.GetFileByStatusParam} arg - Arg object
|
|
1891
2059
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1892
2060
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1893
|
-
* @returns {Promise<OrderPlatformModel.
|
|
2061
|
+
* @returns {Promise<OrderPlatformModel.JobFailedResponseSchema>} - Success response
|
|
1894
2062
|
* @name getFileByStatus
|
|
1895
2063
|
* @summary: Download file used for Bulk operation
|
|
1896
2064
|
* @description: Get the file download URL used for performing bulk operation - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getFileByStatus/).
|
|
@@ -1957,7 +2125,7 @@ class Order {
|
|
|
1957
2125
|
|
|
1958
2126
|
const {
|
|
1959
2127
|
error: res_error,
|
|
1960
|
-
} = OrderPlatformModel.
|
|
2128
|
+
} = OrderPlatformModel.JobFailedResponseSchema().validate(responseData, {
|
|
1961
2129
|
abortEarly: false,
|
|
1962
2130
|
allowUnknown: true,
|
|
1963
2131
|
});
|
|
@@ -1980,7 +2148,7 @@ class Order {
|
|
|
1980
2148
|
* @param {OrderPlatformValidator.GetLaneConfigParam} arg - Arg object
|
|
1981
2149
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1982
2150
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1983
|
-
* @returns {Promise<OrderPlatformModel.
|
|
2151
|
+
* @returns {Promise<OrderPlatformModel.LaneConfigResponseSchema>} - Success response
|
|
1984
2152
|
* @name getLaneConfig
|
|
1985
2153
|
* @summary: Get lane configuration
|
|
1986
2154
|
* @description: Get configuration settings for lanes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getLaneConfig/).
|
|
@@ -2110,7 +2278,7 @@ class Order {
|
|
|
2110
2278
|
|
|
2111
2279
|
const {
|
|
2112
2280
|
error: res_error,
|
|
2113
|
-
} = OrderPlatformModel.
|
|
2281
|
+
} = OrderPlatformModel.LaneConfigResponseSchema().validate(responseData, {
|
|
2114
2282
|
abortEarly: false,
|
|
2115
2283
|
allowUnknown: true,
|
|
2116
2284
|
});
|
|
@@ -2355,7 +2523,8 @@ class Order {
|
|
|
2355
2523
|
* @param {OrderPlatformValidator.GetManifestfiltersParam} arg - Arg object
|
|
2356
2524
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2357
2525
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2358
|
-
* @returns {Promise<OrderPlatformModel.
|
|
2526
|
+
* @returns {Promise<OrderPlatformModel.ManifestFiltersResponseSchema>} -
|
|
2527
|
+
* Success response
|
|
2359
2528
|
* @name getManifestfilters
|
|
2360
2529
|
* @summary: List filters
|
|
2361
2530
|
* @description: Get supported filter for listing manifests - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getManifestfilters/).
|
|
@@ -2412,10 +2581,10 @@ class Order {
|
|
|
2412
2581
|
|
|
2413
2582
|
const {
|
|
2414
2583
|
error: res_error,
|
|
2415
|
-
} = OrderPlatformModel.
|
|
2416
|
-
|
|
2417
|
-
allowUnknown: true
|
|
2418
|
-
|
|
2584
|
+
} = OrderPlatformModel.ManifestFiltersResponseSchema().validate(
|
|
2585
|
+
responseData,
|
|
2586
|
+
{ abortEarly: false, allowUnknown: true }
|
|
2587
|
+
);
|
|
2419
2588
|
|
|
2420
2589
|
if (res_error) {
|
|
2421
2590
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -2548,7 +2717,8 @@ class Order {
|
|
|
2548
2717
|
* @param {OrderPlatformValidator.GetOrderByIdParam} arg - Arg object
|
|
2549
2718
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2550
2719
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2551
|
-
* @returns {Promise<OrderPlatformModel.
|
|
2720
|
+
* @returns {Promise<OrderPlatformModel.OrderDetailsResponseSchema>} -
|
|
2721
|
+
* Success response
|
|
2552
2722
|
* @name getOrderById
|
|
2553
2723
|
* @summary: Get order
|
|
2554
2724
|
* @description: Get detailed information about a specific order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrderById/).
|
|
@@ -2611,7 +2781,7 @@ class Order {
|
|
|
2611
2781
|
|
|
2612
2782
|
const {
|
|
2613
2783
|
error: res_error,
|
|
2614
|
-
} = OrderPlatformModel.
|
|
2784
|
+
} = OrderPlatformModel.OrderDetailsResponseSchema().validate(responseData, {
|
|
2615
2785
|
abortEarly: false,
|
|
2616
2786
|
allowUnknown: true,
|
|
2617
2787
|
});
|
|
@@ -2634,10 +2804,11 @@ class Order {
|
|
|
2634
2804
|
* @param {OrderPlatformValidator.GetOrdersParam} arg - Arg object
|
|
2635
2805
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2636
2806
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2637
|
-
* @returns {Promise<OrderPlatformModel.
|
|
2807
|
+
* @returns {Promise<OrderPlatformModel.OrderListingResponseSchema>} -
|
|
2808
|
+
* Success response
|
|
2638
2809
|
* @name getOrders
|
|
2639
2810
|
* @summary: List orders
|
|
2640
|
-
* @description: Get a list of orders based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
|
|
2811
|
+
* @description: Get a list of orders based on the filters provided. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
|
|
2641
2812
|
*/
|
|
2642
2813
|
async getOrders(
|
|
2643
2814
|
{
|
|
@@ -2664,7 +2835,9 @@ class Order {
|
|
|
2664
2835
|
customerId,
|
|
2665
2836
|
orderType,
|
|
2666
2837
|
allowInactive,
|
|
2838
|
+
groupEntity,
|
|
2667
2839
|
enforceDateFilter,
|
|
2840
|
+
fulfillmentType,
|
|
2668
2841
|
requestHeaders,
|
|
2669
2842
|
} = { requestHeaders: {} },
|
|
2670
2843
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -2694,7 +2867,9 @@ class Order {
|
|
|
2694
2867
|
customerId,
|
|
2695
2868
|
orderType,
|
|
2696
2869
|
allowInactive,
|
|
2870
|
+
groupEntity,
|
|
2697
2871
|
enforceDateFilter,
|
|
2872
|
+
fulfillmentType,
|
|
2698
2873
|
},
|
|
2699
2874
|
{ abortEarly: false, allowUnknown: true }
|
|
2700
2875
|
);
|
|
@@ -2728,7 +2903,9 @@ class Order {
|
|
|
2728
2903
|
customerId,
|
|
2729
2904
|
orderType,
|
|
2730
2905
|
allowInactive,
|
|
2906
|
+
groupEntity,
|
|
2731
2907
|
enforceDateFilter,
|
|
2908
|
+
fulfillmentType,
|
|
2732
2909
|
},
|
|
2733
2910
|
{ abortEarly: false, allowUnknown: false }
|
|
2734
2911
|
);
|
|
@@ -2763,7 +2940,9 @@ class Order {
|
|
|
2763
2940
|
query_params["customer_id"] = customerId;
|
|
2764
2941
|
query_params["order_type"] = orderType;
|
|
2765
2942
|
query_params["allow_inactive"] = allowInactive;
|
|
2943
|
+
query_params["group_entity"] = groupEntity;
|
|
2766
2944
|
query_params["enforce_date_filter"] = enforceDateFilter;
|
|
2945
|
+
query_params["fulfillment_type"] = fulfillmentType;
|
|
2767
2946
|
|
|
2768
2947
|
const xHeaders = {};
|
|
2769
2948
|
|
|
@@ -2784,7 +2963,7 @@ class Order {
|
|
|
2784
2963
|
|
|
2785
2964
|
const {
|
|
2786
2965
|
error: res_error,
|
|
2787
|
-
} = OrderPlatformModel.
|
|
2966
|
+
} = OrderPlatformModel.OrderListingResponseSchema().validate(responseData, {
|
|
2788
2967
|
abortEarly: false,
|
|
2789
2968
|
allowUnknown: true,
|
|
2790
2969
|
});
|
|
@@ -2807,7 +2986,7 @@ class Order {
|
|
|
2807
2986
|
* @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
|
|
2808
2987
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2809
2988
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2810
|
-
* @returns {Promise<OrderPlatformModel.
|
|
2989
|
+
* @returns {Promise<OrderPlatformModel.GetActionsResponseSchema>} - Success response
|
|
2811
2990
|
* @name getRoleBasedActions
|
|
2812
2991
|
* @summary: Get role-based actions
|
|
2813
2992
|
* @description: Retrieve permissible actions based on user roles such as company_admin, company_operation, customer_care, and read_only. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getRoleBasedActions/).
|
|
@@ -2859,7 +3038,7 @@ class Order {
|
|
|
2859
3038
|
|
|
2860
3039
|
const {
|
|
2861
3040
|
error: res_error,
|
|
2862
|
-
} = OrderPlatformModel.
|
|
3041
|
+
} = OrderPlatformModel.GetActionsResponseSchema().validate(responseData, {
|
|
2863
3042
|
abortEarly: false,
|
|
2864
3043
|
allowUnknown: true,
|
|
2865
3044
|
});
|
|
@@ -2882,9 +3061,10 @@ class Order {
|
|
|
2882
3061
|
* @param {OrderPlatformValidator.GetShipmentByIdParam} arg - Arg object
|
|
2883
3062
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2884
3063
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2885
|
-
* @returns {Promise<OrderPlatformModel.
|
|
3064
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInfoResponseSchema>} -
|
|
3065
|
+
* Success response
|
|
2886
3066
|
* @name getShipmentById
|
|
2887
|
-
* @summary: Get shipment
|
|
3067
|
+
* @summary: Get shipment details
|
|
2888
3068
|
* @description: Get detailed information about a specific shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentById/).
|
|
2889
3069
|
*/
|
|
2890
3070
|
async getShipmentById(
|
|
@@ -2954,7 +3134,7 @@ class Order {
|
|
|
2954
3134
|
|
|
2955
3135
|
const {
|
|
2956
3136
|
error: res_error,
|
|
2957
|
-
} = OrderPlatformModel.
|
|
3137
|
+
} = OrderPlatformModel.ShipmentInfoResponseSchema().validate(responseData, {
|
|
2958
3138
|
abortEarly: false,
|
|
2959
3139
|
allowUnknown: true,
|
|
2960
3140
|
});
|
|
@@ -2977,7 +3157,8 @@ class Order {
|
|
|
2977
3157
|
* @param {OrderPlatformValidator.GetShipmentHistoryParam} arg - Arg object
|
|
2978
3158
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
2979
3159
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
2980
|
-
* @returns {Promise<OrderPlatformModel.
|
|
3160
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>} -
|
|
3161
|
+
* Success response
|
|
2981
3162
|
* @name getShipmentHistory
|
|
2982
3163
|
* @summary: Get a shipment's history
|
|
2983
3164
|
* @description: Get the history of the shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentHistory/).
|
|
@@ -3037,10 +3218,10 @@ class Order {
|
|
|
3037
3218
|
|
|
3038
3219
|
const {
|
|
3039
3220
|
error: res_error,
|
|
3040
|
-
} = OrderPlatformModel.
|
|
3041
|
-
|
|
3042
|
-
allowUnknown: true
|
|
3043
|
-
|
|
3221
|
+
} = OrderPlatformModel.ShipmentHistoryResponseSchema().validate(
|
|
3222
|
+
responseData,
|
|
3223
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3224
|
+
);
|
|
3044
3225
|
|
|
3045
3226
|
if (res_error) {
|
|
3046
3227
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -3060,8 +3241,9 @@ class Order {
|
|
|
3060
3241
|
* @param {OrderPlatformValidator.GetShipmentReasonsParam} arg - Arg object
|
|
3061
3242
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3062
3243
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3063
|
-
* @returns {Promise<OrderPlatformModel.
|
|
3064
|
-
* Success response
|
|
3244
|
+
* @returns {Promise<OrderPlatformModel.PlatformShipmentReasonsResponseSchema>}
|
|
3245
|
+
* - Success response
|
|
3246
|
+
*
|
|
3065
3247
|
* @name getShipmentReasons
|
|
3066
3248
|
* @summary: List bag cancellation reasons
|
|
3067
3249
|
* @description: Get reasons to perform full or partial cancellation of a bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentReasons/).
|
|
@@ -3121,7 +3303,7 @@ class Order {
|
|
|
3121
3303
|
|
|
3122
3304
|
const {
|
|
3123
3305
|
error: res_error,
|
|
3124
|
-
} = OrderPlatformModel.
|
|
3306
|
+
} = OrderPlatformModel.PlatformShipmentReasonsResponseSchema().validate(
|
|
3125
3307
|
responseData,
|
|
3126
3308
|
{ abortEarly: false, allowUnknown: true }
|
|
3127
3309
|
);
|
|
@@ -3144,7 +3326,7 @@ class Order {
|
|
|
3144
3326
|
* @param {OrderPlatformValidator.GetShipmentsParam} arg - Arg object
|
|
3145
3327
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3146
3328
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3147
|
-
* @returns {Promise<OrderPlatformModel.
|
|
3329
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
|
|
3148
3330
|
* - Success response
|
|
3149
3331
|
*
|
|
3150
3332
|
* @name getShipments
|
|
@@ -3184,7 +3366,9 @@ class Order {
|
|
|
3184
3366
|
tags,
|
|
3185
3367
|
customerId,
|
|
3186
3368
|
orderType,
|
|
3369
|
+
groupEntity,
|
|
3187
3370
|
enforceDateFilter,
|
|
3371
|
+
fulfillmentType,
|
|
3188
3372
|
requestHeaders,
|
|
3189
3373
|
} = { requestHeaders: {} },
|
|
3190
3374
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -3222,7 +3406,9 @@ class Order {
|
|
|
3222
3406
|
tags,
|
|
3223
3407
|
customerId,
|
|
3224
3408
|
orderType,
|
|
3409
|
+
groupEntity,
|
|
3225
3410
|
enforceDateFilter,
|
|
3411
|
+
fulfillmentType,
|
|
3226
3412
|
},
|
|
3227
3413
|
{ abortEarly: false, allowUnknown: true }
|
|
3228
3414
|
);
|
|
@@ -3264,7 +3450,9 @@ class Order {
|
|
|
3264
3450
|
tags,
|
|
3265
3451
|
customerId,
|
|
3266
3452
|
orderType,
|
|
3453
|
+
groupEntity,
|
|
3267
3454
|
enforceDateFilter,
|
|
3455
|
+
fulfillmentType,
|
|
3268
3456
|
},
|
|
3269
3457
|
{ abortEarly: false, allowUnknown: false }
|
|
3270
3458
|
);
|
|
@@ -3307,7 +3495,9 @@ class Order {
|
|
|
3307
3495
|
query_params["tags"] = tags;
|
|
3308
3496
|
query_params["customer_id"] = customerId;
|
|
3309
3497
|
query_params["order_type"] = orderType;
|
|
3498
|
+
query_params["group_entity"] = groupEntity;
|
|
3310
3499
|
query_params["enforce_date_filter"] = enforceDateFilter;
|
|
3500
|
+
query_params["fulfillment_type"] = fulfillmentType;
|
|
3311
3501
|
|
|
3312
3502
|
const xHeaders = {};
|
|
3313
3503
|
|
|
@@ -3328,7 +3518,7 @@ class Order {
|
|
|
3328
3518
|
|
|
3329
3519
|
const {
|
|
3330
3520
|
error: res_error,
|
|
3331
|
-
} = OrderPlatformModel.
|
|
3521
|
+
} = OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema().validate(
|
|
3332
3522
|
responseData,
|
|
3333
3523
|
{ abortEarly: false, allowUnknown: true }
|
|
3334
3524
|
);
|
|
@@ -3512,7 +3702,8 @@ class Order {
|
|
|
3512
3702
|
* @param {OrderPlatformValidator.GetTemplateParam} arg - Arg object
|
|
3513
3703
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3514
3704
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3515
|
-
* @returns {Promise<OrderPlatformModel.
|
|
3705
|
+
* @returns {Promise<OrderPlatformModel.TemplateDownloadResponseSchema>} -
|
|
3706
|
+
* Success response
|
|
3516
3707
|
* @name getTemplate
|
|
3517
3708
|
* @summary: Download bulk operation templates
|
|
3518
3709
|
* @description: Get the excel or CSV file URL for the template. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getTemplate/).
|
|
@@ -3566,10 +3757,10 @@ class Order {
|
|
|
3566
3757
|
|
|
3567
3758
|
const {
|
|
3568
3759
|
error: res_error,
|
|
3569
|
-
} = OrderPlatformModel.
|
|
3570
|
-
|
|
3571
|
-
allowUnknown: true
|
|
3572
|
-
|
|
3760
|
+
} = OrderPlatformModel.TemplateDownloadResponseSchema().validate(
|
|
3761
|
+
responseData,
|
|
3762
|
+
{ abortEarly: false, allowUnknown: true }
|
|
3763
|
+
);
|
|
3573
3764
|
|
|
3574
3765
|
if (res_error) {
|
|
3575
3766
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -3589,7 +3780,7 @@ class Order {
|
|
|
3589
3780
|
* @param {OrderPlatformValidator.GetfiltersParam} arg - Arg object
|
|
3590
3781
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3591
3782
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3592
|
-
* @returns {Promise<OrderPlatformModel.
|
|
3783
|
+
* @returns {Promise<OrderPlatformModel.FiltersResponseSchema>} - Success response
|
|
3593
3784
|
* @name getfilters
|
|
3594
3785
|
* @summary: List filters
|
|
3595
3786
|
* @description: Get supported filters for various listing operations - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getfilters/).
|
|
@@ -3647,7 +3838,7 @@ class Order {
|
|
|
3647
3838
|
|
|
3648
3839
|
const {
|
|
3649
3840
|
error: res_error,
|
|
3650
|
-
} = OrderPlatformModel.
|
|
3841
|
+
} = OrderPlatformModel.FiltersResponseSchema().validate(responseData, {
|
|
3651
3842
|
abortEarly: false,
|
|
3652
3843
|
allowUnknown: true,
|
|
3653
3844
|
});
|
|
@@ -3670,8 +3861,9 @@ class Order {
|
|
|
3670
3861
|
* @param {OrderPlatformValidator.InvalidateShipmentCacheParam} arg - Arg object
|
|
3671
3862
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3672
3863
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3673
|
-
* @returns {Promise<OrderPlatformModel.
|
|
3674
|
-
* Success response
|
|
3864
|
+
* @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponseSchema>}
|
|
3865
|
+
* - Success response
|
|
3866
|
+
*
|
|
3675
3867
|
* @name invalidateShipmentCache
|
|
3676
3868
|
* @summary: Invalidate shipment cache
|
|
3677
3869
|
* @description: Clear the existing shipment cache data stored in Redis and serialize the updated data for subsequent use. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/invalidateShipmentCache/).
|
|
@@ -3727,7 +3919,7 @@ class Order {
|
|
|
3727
3919
|
|
|
3728
3920
|
const {
|
|
3729
3921
|
error: res_error,
|
|
3730
|
-
} = OrderPlatformModel.
|
|
3922
|
+
} = OrderPlatformModel.InvalidateShipmentCacheResponseSchema().validate(
|
|
3731
3923
|
responseData,
|
|
3732
3924
|
{ abortEarly: false, allowUnknown: true }
|
|
3733
3925
|
);
|
|
@@ -3750,7 +3942,7 @@ class Order {
|
|
|
3750
3942
|
* @param {OrderPlatformValidator.JobDetailsParam} arg - Arg object
|
|
3751
3943
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3752
3944
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3753
|
-
* @returns {Promise<OrderPlatformModel.
|
|
3945
|
+
* @returns {Promise<OrderPlatformModel.JobDetailsResponseSchema>} - Success response
|
|
3754
3946
|
* @name jobDetails
|
|
3755
3947
|
* @summary: Get bulk operation details
|
|
3756
3948
|
* @description: Fetches details of the job for the provided batch Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/jobDetails/).
|
|
@@ -3804,7 +3996,7 @@ class Order {
|
|
|
3804
3996
|
|
|
3805
3997
|
const {
|
|
3806
3998
|
error: res_error,
|
|
3807
|
-
} = OrderPlatformModel.
|
|
3999
|
+
} = OrderPlatformModel.JobDetailsResponseSchema().validate(responseData, {
|
|
3808
4000
|
abortEarly: false,
|
|
3809
4001
|
allowUnknown: true,
|
|
3810
4002
|
});
|
|
@@ -3904,7 +4096,8 @@ class Order {
|
|
|
3904
4096
|
* @param {OrderPlatformValidator.PostShipmentHistoryParam} arg - Arg object
|
|
3905
4097
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3906
4098
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3907
|
-
* @returns {Promise<OrderPlatformModel.
|
|
4099
|
+
* @returns {Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>} -
|
|
4100
|
+
* Success response
|
|
3908
4101
|
* @name postShipmentHistory
|
|
3909
4102
|
* @summary: Create shipment history
|
|
3910
4103
|
* @description: Used to add logs in history for a bag for the provided Shipment ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/postShipmentHistory/).
|
|
@@ -3960,10 +4153,10 @@ class Order {
|
|
|
3960
4153
|
|
|
3961
4154
|
const {
|
|
3962
4155
|
error: res_error,
|
|
3963
|
-
} = OrderPlatformModel.
|
|
3964
|
-
|
|
3965
|
-
allowUnknown: true
|
|
3966
|
-
|
|
4156
|
+
} = OrderPlatformModel.ShipmentHistoryResponseSchema().validate(
|
|
4157
|
+
responseData,
|
|
4158
|
+
{ abortEarly: false, allowUnknown: true }
|
|
4159
|
+
);
|
|
3967
4160
|
|
|
3968
4161
|
if (res_error) {
|
|
3969
4162
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -3983,7 +4176,8 @@ class Order {
|
|
|
3983
4176
|
* @param {OrderPlatformValidator.ReassignLocationParam} arg - Arg object
|
|
3984
4177
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
3985
4178
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
3986
|
-
* @returns {Promise<OrderPlatformModel.
|
|
4179
|
+
* @returns {Promise<OrderPlatformModel.StoreReassignResponseSchema>} -
|
|
4180
|
+
* Success response
|
|
3987
4181
|
* @name reassignLocation
|
|
3988
4182
|
* @summary: Reassign location
|
|
3989
4183
|
* @description: Reassign the shipment to a another location and update its status to 'Store Reassigned.' - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/reassignLocation/).
|
|
@@ -4039,10 +4233,10 @@ class Order {
|
|
|
4039
4233
|
|
|
4040
4234
|
const {
|
|
4041
4235
|
error: res_error,
|
|
4042
|
-
} = OrderPlatformModel.
|
|
4043
|
-
|
|
4044
|
-
allowUnknown: true
|
|
4045
|
-
|
|
4236
|
+
} = OrderPlatformModel.StoreReassignResponseSchema().validate(
|
|
4237
|
+
responseData,
|
|
4238
|
+
{ abortEarly: false, allowUnknown: true }
|
|
4239
|
+
);
|
|
4046
4240
|
|
|
4047
4241
|
if (res_error) {
|
|
4048
4242
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -4062,7 +4256,7 @@ class Order {
|
|
|
4062
4256
|
* @param {OrderPlatformValidator.SendSmsNinjaParam} arg - Arg object
|
|
4063
4257
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4064
4258
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4065
|
-
* @returns {Promise<OrderPlatformModel.
|
|
4259
|
+
* @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
|
|
4066
4260
|
* @name sendSmsNinja
|
|
4067
4261
|
* @summary: Send SMS
|
|
4068
4262
|
* @description: Send SMS to customer based on the template that is selected - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendSmsNinja/).
|
|
@@ -4116,7 +4310,7 @@ class Order {
|
|
|
4116
4310
|
|
|
4117
4311
|
const {
|
|
4118
4312
|
error: res_error,
|
|
4119
|
-
} = OrderPlatformModel.
|
|
4313
|
+
} = OrderPlatformModel.BaseResponseSchema().validate(responseData, {
|
|
4120
4314
|
abortEarly: false,
|
|
4121
4315
|
allowUnknown: true,
|
|
4122
4316
|
});
|
|
@@ -4139,7 +4333,8 @@ class Order {
|
|
|
4139
4333
|
* @param {OrderPlatformValidator.SendUserMobileOTPParam} arg - Arg object
|
|
4140
4334
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4141
4335
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4142
|
-
* @returns {Promise<OrderPlatformModel.
|
|
4336
|
+
* @returns {Promise<OrderPlatformModel.SendUserMobileOtpResponseSchema>} -
|
|
4337
|
+
* Success response
|
|
4143
4338
|
* @name sendUserMobileOTP
|
|
4144
4339
|
* @summary: Send user mobile OTP
|
|
4145
4340
|
* @description: Send a one-time OTP to a customer mobile number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/sendUserMobileOTP/).
|
|
@@ -4195,10 +4390,10 @@ class Order {
|
|
|
4195
4390
|
|
|
4196
4391
|
const {
|
|
4197
4392
|
error: res_error,
|
|
4198
|
-
} = OrderPlatformModel.
|
|
4199
|
-
|
|
4200
|
-
allowUnknown: true
|
|
4201
|
-
|
|
4393
|
+
} = OrderPlatformModel.SendUserMobileOtpResponseSchema().validate(
|
|
4394
|
+
responseData,
|
|
4395
|
+
{ abortEarly: false, allowUnknown: true }
|
|
4396
|
+
);
|
|
4202
4397
|
|
|
4203
4398
|
if (res_error) {
|
|
4204
4399
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -4218,8 +4413,9 @@ class Order {
|
|
|
4218
4413
|
* @param {OrderPlatformValidator.TrackShipmentParam} arg - Arg object
|
|
4219
4414
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4220
4415
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4221
|
-
* @returns {Promise<OrderPlatformModel.
|
|
4222
|
-
* Success response
|
|
4416
|
+
* @returns {Promise<OrderPlatformModel.CourierPartnerTrackingResponseSchema>}
|
|
4417
|
+
* - Success response
|
|
4418
|
+
*
|
|
4223
4419
|
* @name trackShipment
|
|
4224
4420
|
* @summary: Track shipment
|
|
4225
4421
|
* @description: Retrieve courier partner tracking details for a given shipment Id or AWB number - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipment/).
|
|
@@ -4285,7 +4481,7 @@ class Order {
|
|
|
4285
4481
|
|
|
4286
4482
|
const {
|
|
4287
4483
|
error: res_error,
|
|
4288
|
-
} = OrderPlatformModel.
|
|
4484
|
+
} = OrderPlatformModel.CourierPartnerTrackingResponseSchema().validate(
|
|
4289
4485
|
responseData,
|
|
4290
4486
|
{ abortEarly: false, allowUnknown: true }
|
|
4291
4487
|
);
|
|
@@ -4308,44 +4504,19 @@ class Order {
|
|
|
4308
4504
|
* @param {OrderPlatformValidator.UpdateAddressParam} arg - Arg object
|
|
4309
4505
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4310
4506
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4311
|
-
* @returns {Promise<OrderPlatformModel.
|
|
4507
|
+
* @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
|
|
4312
4508
|
* @name updateAddress
|
|
4313
4509
|
* @summary: Update shipment address
|
|
4314
|
-
* @description:
|
|
4510
|
+
* @description: Update the address details of an existing shipment based on the provided address_category. This operation allows the modification of critical shipment details, potentially affecting delivery/billing accuracy and customer communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateAddress/).
|
|
4315
4511
|
*/
|
|
4316
4512
|
async updateAddress(
|
|
4317
|
-
{
|
|
4318
|
-
shipmentId,
|
|
4319
|
-
addressCategory,
|
|
4320
|
-
name,
|
|
4321
|
-
address,
|
|
4322
|
-
addressType,
|
|
4323
|
-
pincode,
|
|
4324
|
-
phone,
|
|
4325
|
-
email,
|
|
4326
|
-
landmark,
|
|
4327
|
-
city,
|
|
4328
|
-
state,
|
|
4329
|
-
country,
|
|
4330
|
-
requestHeaders,
|
|
4331
|
-
} = { requestHeaders: {} },
|
|
4513
|
+
{ shipmentId, body, requestHeaders } = { requestHeaders: {} },
|
|
4332
4514
|
{ responseHeaders } = { responseHeaders: false }
|
|
4333
4515
|
) {
|
|
4334
4516
|
const { error } = OrderPlatformValidator.updateAddress().validate(
|
|
4335
4517
|
{
|
|
4336
4518
|
shipmentId,
|
|
4337
|
-
|
|
4338
|
-
|
|
4339
|
-
name,
|
|
4340
|
-
address,
|
|
4341
|
-
addressType,
|
|
4342
|
-
pincode,
|
|
4343
|
-
phone,
|
|
4344
|
-
email,
|
|
4345
|
-
landmark,
|
|
4346
|
-
city,
|
|
4347
|
-
state,
|
|
4348
|
-
country,
|
|
4519
|
+
body,
|
|
4349
4520
|
},
|
|
4350
4521
|
{ abortEarly: false, allowUnknown: true }
|
|
4351
4522
|
);
|
|
@@ -4357,18 +4528,7 @@ class Order {
|
|
|
4357
4528
|
const { error: warrning } = OrderPlatformValidator.updateAddress().validate(
|
|
4358
4529
|
{
|
|
4359
4530
|
shipmentId,
|
|
4360
|
-
|
|
4361
|
-
|
|
4362
|
-
name,
|
|
4363
|
-
address,
|
|
4364
|
-
addressType,
|
|
4365
|
-
pincode,
|
|
4366
|
-
phone,
|
|
4367
|
-
email,
|
|
4368
|
-
landmark,
|
|
4369
|
-
city,
|
|
4370
|
-
state,
|
|
4371
|
-
country,
|
|
4531
|
+
body,
|
|
4372
4532
|
},
|
|
4373
4533
|
{ abortEarly: false, allowUnknown: false }
|
|
4374
4534
|
);
|
|
@@ -4380,27 +4540,15 @@ class Order {
|
|
|
4380
4540
|
}
|
|
4381
4541
|
|
|
4382
4542
|
const query_params = {};
|
|
4383
|
-
query_params["shipment_id"] = shipmentId;
|
|
4384
|
-
query_params["name"] = name;
|
|
4385
|
-
query_params["address"] = address;
|
|
4386
|
-
query_params["address_type"] = addressType;
|
|
4387
|
-
query_params["pincode"] = pincode;
|
|
4388
|
-
query_params["phone"] = phone;
|
|
4389
|
-
query_params["email"] = email;
|
|
4390
|
-
query_params["landmark"] = landmark;
|
|
4391
|
-
query_params["address_category"] = addressCategory;
|
|
4392
|
-
query_params["city"] = city;
|
|
4393
|
-
query_params["state"] = state;
|
|
4394
|
-
query_params["country"] = country;
|
|
4395
4543
|
|
|
4396
4544
|
const xHeaders = {};
|
|
4397
4545
|
|
|
4398
4546
|
const response = await PlatformAPIClient.execute(
|
|
4399
4547
|
this.config,
|
|
4400
|
-
"
|
|
4401
|
-
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/
|
|
4548
|
+
"put",
|
|
4549
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/shipment/${shipmentId}/address`,
|
|
4402
4550
|
query_params,
|
|
4403
|
-
|
|
4551
|
+
body,
|
|
4404
4552
|
{ ...xHeaders, ...requestHeaders },
|
|
4405
4553
|
{ responseHeaders }
|
|
4406
4554
|
);
|
|
@@ -4412,7 +4560,7 @@ class Order {
|
|
|
4412
4560
|
|
|
4413
4561
|
const {
|
|
4414
4562
|
error: res_error,
|
|
4415
|
-
} = OrderPlatformModel.
|
|
4563
|
+
} = OrderPlatformModel.BaseResponseSchema().validate(responseData, {
|
|
4416
4564
|
abortEarly: false,
|
|
4417
4565
|
allowUnknown: true,
|
|
4418
4566
|
});
|
|
@@ -4435,7 +4583,7 @@ class Order {
|
|
|
4435
4583
|
* @param {OrderPlatformValidator.UpdatePackagingDimensionsParam} arg - Arg object
|
|
4436
4584
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4437
4585
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4438
|
-
* @returns {Promise<OrderPlatformModel.
|
|
4586
|
+
* @returns {Promise<OrderPlatformModel.UpdatePackagingDimensionsResponseSchema>}
|
|
4439
4587
|
* - Success response
|
|
4440
4588
|
*
|
|
4441
4589
|
* @name updatePackagingDimensions
|
|
@@ -4495,7 +4643,7 @@ class Order {
|
|
|
4495
4643
|
|
|
4496
4644
|
const {
|
|
4497
4645
|
error: res_error,
|
|
4498
|
-
} = OrderPlatformModel.
|
|
4646
|
+
} = OrderPlatformModel.UpdatePackagingDimensionsResponseSchema().validate(
|
|
4499
4647
|
responseData,
|
|
4500
4648
|
{ abortEarly: false, allowUnknown: true }
|
|
4501
4649
|
);
|
|
@@ -4514,12 +4662,90 @@ class Order {
|
|
|
4514
4662
|
return response;
|
|
4515
4663
|
}
|
|
4516
4664
|
|
|
4665
|
+
/**
|
|
4666
|
+
* @param {OrderPlatformValidator.UpdatePaymentInfoParam} arg - Arg object
|
|
4667
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4668
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4669
|
+
* @returns {Promise<Object>} - Success response
|
|
4670
|
+
* @name updatePaymentInfo
|
|
4671
|
+
* @summary: Update payment details for an order, its shipments and its bags.
|
|
4672
|
+
* @description: Updates the payment mode for an order, its shipments and its bags. This endpoint allows for modifying payment methods, and associated details but not amount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updatePaymentInfo/).
|
|
4673
|
+
*/
|
|
4674
|
+
async updatePaymentInfo(
|
|
4675
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
4676
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
4677
|
+
) {
|
|
4678
|
+
const { error } = OrderPlatformValidator.updatePaymentInfo().validate(
|
|
4679
|
+
{
|
|
4680
|
+
body,
|
|
4681
|
+
},
|
|
4682
|
+
{ abortEarly: false, allowUnknown: true }
|
|
4683
|
+
);
|
|
4684
|
+
if (error) {
|
|
4685
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
4686
|
+
}
|
|
4687
|
+
|
|
4688
|
+
// Showing warrnings if extra unknown parameters are found
|
|
4689
|
+
const {
|
|
4690
|
+
error: warrning,
|
|
4691
|
+
} = OrderPlatformValidator.updatePaymentInfo().validate(
|
|
4692
|
+
{
|
|
4693
|
+
body,
|
|
4694
|
+
},
|
|
4695
|
+
{ abortEarly: false, allowUnknown: false }
|
|
4696
|
+
);
|
|
4697
|
+
if (warrning) {
|
|
4698
|
+
Logger({
|
|
4699
|
+
level: "WARN",
|
|
4700
|
+
message: `Parameter Validation warrnings for platform > Order > updatePaymentInfo \n ${warrning}`,
|
|
4701
|
+
});
|
|
4702
|
+
}
|
|
4703
|
+
|
|
4704
|
+
const query_params = {};
|
|
4705
|
+
|
|
4706
|
+
const xHeaders = {};
|
|
4707
|
+
|
|
4708
|
+
const response = await PlatformAPIClient.execute(
|
|
4709
|
+
this.config,
|
|
4710
|
+
"put",
|
|
4711
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/payment/update`,
|
|
4712
|
+
query_params,
|
|
4713
|
+
body,
|
|
4714
|
+
{ ...xHeaders, ...requestHeaders },
|
|
4715
|
+
{ responseHeaders }
|
|
4716
|
+
);
|
|
4717
|
+
|
|
4718
|
+
let responseData = response;
|
|
4719
|
+
if (responseHeaders) {
|
|
4720
|
+
responseData = response[0];
|
|
4721
|
+
}
|
|
4722
|
+
|
|
4723
|
+
const { error: res_error } = Joi.any().validate(responseData, {
|
|
4724
|
+
abortEarly: false,
|
|
4725
|
+
allowUnknown: true,
|
|
4726
|
+
});
|
|
4727
|
+
|
|
4728
|
+
if (res_error) {
|
|
4729
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
4730
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
4731
|
+
} else {
|
|
4732
|
+
Logger({
|
|
4733
|
+
level: "WARN",
|
|
4734
|
+
message: `Response Validation Warnings for platform > Order > updatePaymentInfo \n ${res_error}`,
|
|
4735
|
+
});
|
|
4736
|
+
}
|
|
4737
|
+
}
|
|
4738
|
+
|
|
4739
|
+
return response;
|
|
4740
|
+
}
|
|
4741
|
+
|
|
4517
4742
|
/**
|
|
4518
4743
|
* @param {OrderPlatformValidator.UpdateShipmentLockParam} arg - Arg object
|
|
4519
4744
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4520
4745
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4521
|
-
* @returns {Promise<OrderPlatformModel.
|
|
4522
|
-
* Success response
|
|
4746
|
+
* @returns {Promise<OrderPlatformModel.UpdateShipmentLockResponseSchema>}
|
|
4747
|
+
* - Success response
|
|
4748
|
+
*
|
|
4523
4749
|
* @name updateShipmentLock
|
|
4524
4750
|
* @summary: Update a shipment lock
|
|
4525
4751
|
* @description: Modify shipment/bag lock status and update lock/unlock messages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/updateShipmentLock/).
|
|
@@ -4575,10 +4801,10 @@ class Order {
|
|
|
4575
4801
|
|
|
4576
4802
|
const {
|
|
4577
4803
|
error: res_error,
|
|
4578
|
-
} = OrderPlatformModel.
|
|
4579
|
-
|
|
4580
|
-
allowUnknown: true
|
|
4581
|
-
|
|
4804
|
+
} = OrderPlatformModel.UpdateShipmentLockResponseSchema().validate(
|
|
4805
|
+
responseData,
|
|
4806
|
+
{ abortEarly: false, allowUnknown: true }
|
|
4807
|
+
);
|
|
4582
4808
|
|
|
4583
4809
|
if (res_error) {
|
|
4584
4810
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -4759,7 +4985,7 @@ class Order {
|
|
|
4759
4985
|
* @param {OrderPlatformValidator.UploadConsentsParam} arg - Arg object
|
|
4760
4986
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4761
4987
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4762
|
-
* @returns {Promise<OrderPlatformModel.
|
|
4988
|
+
* @returns {Promise<OrderPlatformModel.SuccessResponseSchema>} - Success response
|
|
4763
4989
|
* @name uploadConsents
|
|
4764
4990
|
* @summary: Upload consent
|
|
4765
4991
|
* @description: Uploads the consent signed by courier partner and seller to keep records - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/uploadConsents/).
|
|
@@ -4815,7 +5041,7 @@ class Order {
|
|
|
4815
5041
|
|
|
4816
5042
|
const {
|
|
4817
5043
|
error: res_error,
|
|
4818
|
-
} = OrderPlatformModel.
|
|
5044
|
+
} = OrderPlatformModel.SuccessResponseSchema().validate(responseData, {
|
|
4819
5045
|
abortEarly: false,
|
|
4820
5046
|
allowUnknown: true,
|
|
4821
5047
|
});
|
|
@@ -4838,7 +5064,7 @@ class Order {
|
|
|
4838
5064
|
* @param {OrderPlatformValidator.VerifyMobileOTPParam} arg - Arg object
|
|
4839
5065
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
4840
5066
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
4841
|
-
* @returns {Promise<OrderPlatformModel.
|
|
5067
|
+
* @returns {Promise<OrderPlatformModel.VerifyOtpResponseSchema>} - Success response
|
|
4842
5068
|
* @name verifyMobileOTP
|
|
4843
5069
|
* @summary: Verify mobile OTP
|
|
4844
5070
|
* @description: Perform OTP verification to link a user to an anonymous order - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/verifyMobileOTP/).
|
|
@@ -4894,7 +5120,7 @@ class Order {
|
|
|
4894
5120
|
|
|
4895
5121
|
const {
|
|
4896
5122
|
error: res_error,
|
|
4897
|
-
} = OrderPlatformModel.
|
|
5123
|
+
} = OrderPlatformModel.VerifyOtpResponseSchema().validate(responseData, {
|
|
4898
5124
|
abortEarly: false,
|
|
4899
5125
|
allowUnknown: true,
|
|
4900
5126
|
});
|