@gofynd/fdk-client-javascript 1.4.15-beta.13 → 1.4.15-beta.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -26
- package/package.json +5 -1
- package/sdk/application/ApplicationClient.d.ts +5 -6
- package/sdk/application/ApplicationClient.js +24 -20
- package/sdk/application/Cart/CartApplicationClient.d.ts +133 -83
- package/sdk/application/Cart/CartApplicationClient.js +444 -76
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +132 -114
- package/sdk/application/Catalog/CatalogApplicationClient.js +209 -126
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +58 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +73 -29
- package/sdk/application/Content/ContentApplicationClient.d.ts +95 -66
- package/sdk/application/Content/ContentApplicationClient.js +274 -111
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +11 -11
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +10 -10
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +111 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +7 -7
- package/sdk/application/Lead/LeadApplicationClient.js +6 -6
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +37 -57
- package/sdk/application/Logistic/LogisticApplicationClient.js +117 -180
- package/sdk/application/Order/OrderApplicationClient.d.ts +63 -21
- package/sdk/application/Order/OrderApplicationClient.js +217 -17
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +179 -149
- package/sdk/application/Payment/PaymentApplicationClient.js +301 -167
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.js +10 -6
- package/sdk/application/User/UserApplicationClient.d.ts +103 -53
- package/sdk/application/User/UserApplicationClient.js +308 -49
- package/sdk/common/AxiosHelper.js +11 -4
- package/sdk/common/Constant.d.ts +27 -4
- package/sdk/common/Constant.js +33 -6
- package/sdk/common/utils.d.ts +10 -0
- package/sdk/common/utils.js +24 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +46 -16
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +266 -40
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +163 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +158 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +5 -2
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +23 -7
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +9 -9
- package/sdk/partner/Lead/LeadPartnerClient.js +9 -9
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +14 -9
- package/sdk/partner/Lead/LeadPartnerModel.js +19 -17
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +264 -49
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +2116 -252
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2256 -258
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1187 -230
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +21 -1
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +218 -13
- package/sdk/partner/PartnerClient.d.ts +5 -2
- package/sdk/partner/PartnerClient.js +21 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +32 -34
- package/sdk/partner/Theme/ThemePartnerClient.js +42 -44
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +142 -43
- package/sdk/partner/Theme/ThemePartnerModel.js +129 -44
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +83 -27
- package/sdk/partner/Webhook/WebhookPartnerClient.js +446 -27
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +920 -185
- package/sdk/partner/Webhook/WebhookPartnerModel.js +462 -154
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +41 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +8 -7
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +17 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +4 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +68 -13
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +44 -6
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +3 -33
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +4 -244
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +49 -145
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +20 -171
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +18 -18
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +266 -203
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +1446 -500
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +729 -100
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +446 -82
- package/sdk/platform/Cart/CartPlatformModel.d.ts +6927 -1396
- package/sdk/platform/Cart/CartPlatformModel.js +3065 -1316
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +433 -248
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1662 -559
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +464 -159
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +304 -87
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +383 -234
- package/sdk/platform/Catalog/CatalogPlatformClient.js +2475 -1557
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +9571 -2674
- package/sdk/platform/Catalog/CatalogPlatformModel.js +5081 -2019
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +364 -117
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +281 -104
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -4
- package/sdk/platform/Common/CommonPlatformClient.js +6 -5
- package/sdk/platform/Common/CommonPlatformModel.d.ts +36 -25
- package/sdk/platform/Common/CommonPlatformModel.js +25 -14
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -153
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +102 -541
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +36 -49
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +20 -60
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +189 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +165 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +58 -81
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +68 -116
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +291 -249
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +243 -234
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +78 -65
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +101 -88
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +20 -20
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +19 -19
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +68 -34
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +174 -41
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +667 -244
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +474 -155
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +366 -280
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +1435 -753
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +323 -223
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +335 -205
- package/sdk/platform/Content/ContentPlatformClient.d.ts +304 -106
- package/sdk/platform/Content/ContentPlatformClient.js +1842 -450
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2582 -566
- package/sdk/platform/Content/ContentPlatformModel.js +1426 -558
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +293 -114
- package/sdk/platform/Content/ContentPlatformValidator.js +328 -101
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +59 -23
- package/sdk/platform/Discount/DiscountPlatformClient.js +84 -23
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +403 -110
- package/sdk/platform/Discount/DiscountPlatformModel.js +121 -107
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +56 -36
- package/sdk/platform/Discount/DiscountPlatformValidator.js +29 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +12 -110
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +14 -684
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +5 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +4 -115
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +20 -20
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +22 -22
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +90 -920
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +53 -949
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +11 -11
- package/sdk/platform/Lead/LeadPlatformClient.js +11 -11
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +14 -9
- package/sdk/platform/Lead/LeadPlatformModel.js +20 -18
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +56 -9
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +340 -10
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +128 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +81 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +517 -160
- package/sdk/platform/Order/OrderPlatformClient.js +1623 -384
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10372 -1587
- package/sdk/platform/Order/OrderPlatformModel.js +5726 -1512
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +539 -123
- package/sdk/platform/Order/OrderPlatformValidator.js +323 -92
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +8 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +11 -9
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +77 -25
- package/sdk/platform/Partner/PartnerPlatformModel.js +32 -21
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +144 -219
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +307 -796
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +86 -121
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +80 -138
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +30 -30
- package/sdk/platform/Payment/PaymentPlatformClient.js +30 -30
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +901 -761
- package/sdk/platform/Payment/PaymentPlatformModel.js +663 -583
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
- package/sdk/platform/PlatformApplicationClient.js +0 -4
- package/sdk/platform/PlatformClient.d.ts +5 -4
- package/sdk/platform/PlatformClient.js +32 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +526 -69
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +3337 -337
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +603 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +529 -32
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +184 -133
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +780 -491
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +9408 -1666
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +5720 -1765
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +257 -180
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +185 -127
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
- package/sdk/platform/Share/SharePlatformModel.d.ts +45 -9
- package/sdk/platform/Share/SharePlatformModel.js +31 -6
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +26 -26
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +38 -29
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +18 -3
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +10 -2
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -17
- package/sdk/platform/Theme/ThemePlatformModel.js +92 -23
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +167 -45
- package/sdk/platform/User/UserPlatformApplicationClient.js +950 -67
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +189 -3
- package/sdk/platform/User/UserPlatformApplicationValidator.js +157 -3
- package/sdk/platform/User/UserPlatformModel.d.ts +880 -47
- package/sdk/platform/User/UserPlatformModel.js +607 -46
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +33 -86
- package/sdk/platform/Webhook/WebhookPlatformClient.js +79 -474
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +861 -422
- package/sdk/platform/Webhook/WebhookPlatformModel.js +469 -391
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -2
- package/sdk/platform/index.js +0 -4
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +22 -0
- package/sdk/public/Catalog/CatalogPublicClient.js +133 -0
- package/sdk/public/Catalog/CatalogPublicModel.d.ts +158 -0
- package/sdk/public/Catalog/CatalogPublicModel.js +116 -0
- package/sdk/public/Catalog/CatalogPublicValidator.d.ts +55 -0
- package/sdk/public/Catalog/CatalogPublicValidator.js +35 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -4
- package/sdk/public/Configuration/ConfigurationPublicClient.js +9 -8
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +41 -21
- package/sdk/public/Configuration/ConfigurationPublicModel.js +28 -12
- package/sdk/public/Content/ContentPublicClient.d.ts +145 -2
- package/sdk/public/Content/ContentPublicClient.js +1067 -17
- package/sdk/public/Content/ContentPublicModel.d.ts +704 -3
- package/sdk/public/Content/ContentPublicModel.js +751 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +94 -3
- package/sdk/public/Content/ContentPublicValidator.js +119 -2
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
- package/sdk/public/Partner/PartnerPublicModel.js +81 -71
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
- package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
- package/sdk/public/PublicClient.d.ts +5 -2
- package/sdk/public/PublicClient.js +16 -6
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +13 -13
- package/sdk/public/Webhook/WebhookPublicClient.js +13 -13
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +249 -67
- package/sdk/public/Webhook/WebhookPublicModel.js +81 -61
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/utility.d.ts +3 -0
- package/utility.js +7 -0
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
- package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +0 -19
- package/sdk/application/Webhook/WebhookApplicationClient.js +0 -72
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -382
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -408
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
const Joi = require("joi");
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* @typedef
|
|
4
|
+
* @typedef GeneralConfigDetails
|
|
5
5
|
* @property {string} [_id]
|
|
6
6
|
* @property {SupportCommunicationSchema[]} [support_communication]
|
|
7
7
|
* @property {boolean} [show_communication_info]
|
|
@@ -46,13 +46,14 @@ const Joi = require("joi");
|
|
|
46
46
|
|
|
47
47
|
/**
|
|
48
48
|
* @typedef Page
|
|
49
|
-
* @property {number} [item_total] - The total number of items
|
|
49
|
+
* @property {number} [item_total] - The total number of all items across all pages.
|
|
50
50
|
* @property {string} [next_id] - The identifier for the next page.
|
|
51
51
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
52
52
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
53
53
|
* @property {number} [current] - The current page number.
|
|
54
|
-
* @property {string} type - The type of the page,
|
|
54
|
+
* @property {string} type - The type of the page, can be 'cursor' or 'number'.
|
|
55
55
|
* @property {number} [size] - The number of items per page.
|
|
56
|
+
* @property {number} [page_size] - The number of items per page.
|
|
56
57
|
*/
|
|
57
58
|
|
|
58
59
|
/**
|
|
@@ -325,8 +326,8 @@ const Joi = require("joi");
|
|
|
325
326
|
/** @typedef {"platform_panel" | "sales_channel"} TicketSourceEnum */
|
|
326
327
|
|
|
327
328
|
class LeadPlatformModel {
|
|
328
|
-
/** @returns {
|
|
329
|
-
static
|
|
329
|
+
/** @returns {GeneralConfigDetails} */
|
|
330
|
+
static GeneralConfigDetails() {
|
|
330
331
|
return Joi.object({
|
|
331
332
|
_id: Joi.string().allow(""),
|
|
332
333
|
support_communication: Joi.array().items(
|
|
@@ -391,6 +392,7 @@ class LeadPlatformModel {
|
|
|
391
392
|
current: Joi.number(),
|
|
392
393
|
type: Joi.string().allow("").required(),
|
|
393
394
|
size: Joi.number(),
|
|
395
|
+
page_size: Joi.number(),
|
|
394
396
|
});
|
|
395
397
|
}
|
|
396
398
|
|
|
@@ -474,7 +476,7 @@ class LeadPlatformModel {
|
|
|
474
476
|
/** @returns {TicketHistoryPayload} */
|
|
475
477
|
static TicketHistoryPayload() {
|
|
476
478
|
return Joi.object({
|
|
477
|
-
value: Joi.any().required(),
|
|
479
|
+
value: Joi.object().pattern(/\S/, Joi.any()).required(),
|
|
478
480
|
type: LeadPlatformModel.HistoryTypeEnum().required(),
|
|
479
481
|
});
|
|
480
482
|
}
|
|
@@ -515,12 +517,12 @@ class LeadPlatformModel {
|
|
|
515
517
|
/** @returns {AddTicketPayload} */
|
|
516
518
|
static AddTicketPayload() {
|
|
517
519
|
return Joi.object({
|
|
518
|
-
created_by: Joi.any(),
|
|
520
|
+
created_by: Joi.object().pattern(/\S/, Joi.any()),
|
|
519
521
|
status: Joi.string().allow(""),
|
|
520
522
|
priority: LeadPlatformModel.PriorityEnum(),
|
|
521
523
|
category: Joi.string().allow("").required(),
|
|
522
524
|
content: LeadPlatformModel.TicketContent().required(),
|
|
523
|
-
_custom_json: Joi.any(),
|
|
525
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
524
526
|
});
|
|
525
527
|
}
|
|
526
528
|
|
|
@@ -559,7 +561,7 @@ class LeadPlatformModel {
|
|
|
559
561
|
/** @returns {TicketFeedbackPayload} */
|
|
560
562
|
static TicketFeedbackPayload() {
|
|
561
563
|
return Joi.object({
|
|
562
|
-
form_response: Joi.any(),
|
|
564
|
+
form_response: Joi.object().pattern(/\S/, Joi.any()),
|
|
563
565
|
});
|
|
564
566
|
}
|
|
565
567
|
|
|
@@ -605,9 +607,9 @@ class LeadPlatformModel {
|
|
|
605
607
|
/** @returns {FeedbackForm} */
|
|
606
608
|
static FeedbackForm() {
|
|
607
609
|
return Joi.object({
|
|
608
|
-
inputs: Joi.any(),
|
|
610
|
+
inputs: Joi.object().pattern(/\S/, Joi.any()),
|
|
609
611
|
title: Joi.string().allow(""),
|
|
610
|
-
timestamps: Joi.any(),
|
|
612
|
+
timestamps: Joi.object().pattern(/\S/, Joi.any()),
|
|
611
613
|
});
|
|
612
614
|
}
|
|
613
615
|
|
|
@@ -641,7 +643,7 @@ class LeadPlatformModel {
|
|
|
641
643
|
.items(LeadPlatformModel.FeedbackResponseItem())
|
|
642
644
|
.required(),
|
|
643
645
|
category: Joi.string().allow(""),
|
|
644
|
-
user: Joi.any(),
|
|
646
|
+
user: Joi.object().pattern(/\S/, Joi.any()),
|
|
645
647
|
updated_at: Joi.string().allow(""),
|
|
646
648
|
created_at: Joi.string().allow(""),
|
|
647
649
|
});
|
|
@@ -651,10 +653,10 @@ class LeadPlatformModel {
|
|
|
651
653
|
static TicketHistory() {
|
|
652
654
|
return Joi.object({
|
|
653
655
|
type: Joi.string().allow("").required(),
|
|
654
|
-
value: Joi.any().required(),
|
|
656
|
+
value: Joi.object().pattern(/\S/, Joi.any()).required(),
|
|
655
657
|
ticket_id: Joi.string().allow("").required(),
|
|
656
658
|
created_on: LeadPlatformModel.CreatedOn(),
|
|
657
|
-
created_by: Joi.any(),
|
|
659
|
+
created_by: Joi.object().pattern(/\S/, Joi.any()),
|
|
658
660
|
_id: Joi.string().allow("").required(),
|
|
659
661
|
updated_at: Joi.string().allow(""),
|
|
660
662
|
created_at: Joi.string().allow(""),
|
|
@@ -674,12 +676,12 @@ class LeadPlatformModel {
|
|
|
674
676
|
status: LeadPlatformModel.Status().required(),
|
|
675
677
|
priority: LeadPlatformModel.Priority().required(),
|
|
676
678
|
sla: LeadPlatformModel.SLA(),
|
|
677
|
-
created_by: Joi.any(),
|
|
678
|
-
assigned_to: Joi.any(),
|
|
679
|
+
created_by: Joi.object().pattern(/\S/, Joi.any()),
|
|
680
|
+
assigned_to: Joi.object().pattern(/\S/, Joi.any()),
|
|
679
681
|
tags: Joi.array().items(Joi.string().allow("")),
|
|
680
|
-
_custom_json: Joi.any(),
|
|
682
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
681
683
|
is_feedback_pending: Joi.boolean(),
|
|
682
|
-
integration: Joi.any(),
|
|
684
|
+
integration: Joi.object().pattern(/\S/, Joi.any()),
|
|
683
685
|
_id: Joi.string().allow("").required(),
|
|
684
686
|
updated_at: Joi.string().allow(""),
|
|
685
687
|
created_at: Joi.string().allow(""),
|
|
@@ -9,26 +9,49 @@ declare class Order {
|
|
|
9
9
|
*
|
|
10
10
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
11
11
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
12
|
-
* @returns {Promise<OrderPlatformModel.
|
|
12
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
|
|
13
13
|
* - Success response
|
|
14
14
|
*
|
|
15
15
|
* @name getApplicationShipments
|
|
16
16
|
* @summary: List sales channel shipments
|
|
17
|
-
* @description: Get shipments of a particular sales channel based on the filters provided - Check out [method documentation](https://
|
|
17
|
+
* @description: Get shipments of a particular sales channel based on the filters provided - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getApplicationShipments/).
|
|
18
18
|
*/
|
|
19
|
-
getApplicationShipments({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, excludeLockedShipments, requestHeaders, }?: OrderPlatformApplicationValidator.GetApplicationShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
19
|
+
getApplicationShipments({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, excludeLockedShipments, requestHeaders, }?: OrderPlatformApplicationValidator.GetApplicationShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
|
|
20
|
+
/**
|
|
21
|
+
* @param {OrderPlatformApplicationValidator.GetOrderingSourceConfigBySlugParam} arg
|
|
22
|
+
* - Arg object
|
|
23
|
+
*
|
|
24
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
25
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
26
|
+
* @returns {Promise<OrderPlatformModel.OrderingSourceConfig>} - Success response
|
|
27
|
+
* @name getOrderingSourceConfigBySlug
|
|
28
|
+
* @summary: Get ordering source config for a given company and application.
|
|
29
|
+
* @description: Retrieves the ordering source config for a given company and application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getOrderingSourceConfigBySlug/).
|
|
30
|
+
*/
|
|
31
|
+
getOrderingSourceConfigBySlug({ slug, requestHeaders }?: OrderPlatformApplicationValidator.GetOrderingSourceConfigBySlugParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderingSourceConfig>;
|
|
20
32
|
/**
|
|
21
33
|
* @param {OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam} arg
|
|
22
34
|
* - Arg object
|
|
23
35
|
*
|
|
24
36
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
25
37
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
26
|
-
* @returns {Promise<OrderPlatformModel.
|
|
38
|
+
* @returns {Promise<OrderPlatformModel.ShipmentReasonsResponseSchema>} -
|
|
39
|
+
* Success response
|
|
27
40
|
* @name getPlatformShipmentReasons
|
|
28
41
|
* @summary: List shipment cancellation reasons
|
|
29
|
-
* @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://
|
|
42
|
+
* @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getPlatformShipmentReasons/).
|
|
30
43
|
*/
|
|
31
|
-
getPlatformShipmentReasons({ action, requestHeaders }?: OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.
|
|
44
|
+
getPlatformShipmentReasons({ action, requestHeaders }?: OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentReasonsResponseSchema>;
|
|
45
|
+
/**
|
|
46
|
+
* @param {OrderPlatformApplicationValidator.GetRulesParam} arg - Arg object
|
|
47
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
48
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
49
|
+
* @returns {Promise<OrderPlatformModel.RuleListResponseSchema>} - Success response
|
|
50
|
+
* @name getRules
|
|
51
|
+
* @summary: List of RMA rules based on the given input conditions.
|
|
52
|
+
* @description: Retrieves a comprehensive list of RMA (Return Merchandise Authorization) rules associated with a specific company and application. These rules dictate the processes for handling returns, including actions, reasons, quality control (QC) types, and associated questions. The endpoint allows for filtering and pagination based on input conditions, providing a tailored set of rules that match the criteria specified. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getRules/).
|
|
53
|
+
*/
|
|
54
|
+
getRules({ body, requestHeaders }?: OrderPlatformApplicationValidator.GetRulesParam, { responseHeaders }?: object): Promise<OrderPlatformModel.RuleListResponseSchema>;
|
|
32
55
|
/**
|
|
33
56
|
* @param {OrderPlatformApplicationValidator.GetShipmentBagReasonsParam} arg
|
|
34
57
|
* - Arg object
|
|
@@ -37,10 +60,22 @@ declare class Order {
|
|
|
37
60
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
38
61
|
* @returns {Promise<OrderPlatformModel.ShipmentBagReasons>} - Success response
|
|
39
62
|
* @name getShipmentBagReasons
|
|
40
|
-
* @summary:
|
|
41
|
-
* @description:
|
|
63
|
+
* @summary: Retrieve Reasons for Cancellation and Return journey
|
|
64
|
+
* @description: Allows users to retrieve a comprehensive list of reasons for cancellation or returning a shipment. It provides both cancellation and return reasons, with an emphasis on Quality Control (QC) evaluations. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipmentBagReasons/).
|
|
42
65
|
*/
|
|
43
66
|
getShipmentBagReasons({ shipmentId, lineNumber, requestHeaders }?: OrderPlatformApplicationValidator.GetShipmentBagReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentBagReasons>;
|
|
67
|
+
/**
|
|
68
|
+
* @param {OrderPlatformApplicationValidator.ListOrderingSourcesParam} arg
|
|
69
|
+
* - Arg object
|
|
70
|
+
*
|
|
71
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
72
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
73
|
+
* @returns {Promise<OrderPlatformModel.ListOrderingSources>} - Success response
|
|
74
|
+
* @name listOrderingSources
|
|
75
|
+
* @summary: List ordering sources for a given company and application.
|
|
76
|
+
* @description: Retrieves the list of ordering sources for a given company and application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/listOrderingSources/).
|
|
77
|
+
*/
|
|
78
|
+
listOrderingSources({ type, pageNo, pageSize, requestHeaders }?: OrderPlatformApplicationValidator.ListOrderingSourcesParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ListOrderingSources>;
|
|
44
79
|
/**
|
|
45
80
|
* @param {OrderPlatformApplicationValidator.TrackShipmentPlatformParam} arg
|
|
46
81
|
* - Arg object
|
|
@@ -50,9 +85,21 @@ declare class Order {
|
|
|
50
85
|
* @returns {Promise<OrderPlatformModel.PlatformShipmentTrack>} - Success response
|
|
51
86
|
* @name trackShipmentPlatform
|
|
52
87
|
* @summary: Track shipment
|
|
53
|
-
* @description: Track shipment by shipment Id for an application - Check out [method documentation](https://
|
|
88
|
+
* @description: Track shipment by shipment Id for an application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/trackShipmentPlatform/).
|
|
54
89
|
*/
|
|
55
90
|
trackShipmentPlatform({ shipmentId, requestHeaders }?: OrderPlatformApplicationValidator.TrackShipmentPlatformParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentTrack>;
|
|
91
|
+
/**
|
|
92
|
+
* @param {OrderPlatformApplicationValidator.UpdateOrderingSourceConfigBySlugParam} arg
|
|
93
|
+
* - Arg object
|
|
94
|
+
*
|
|
95
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
96
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
97
|
+
* @returns {Promise<OrderPlatformModel.OrderingSourceConfig>} - Success response
|
|
98
|
+
* @name updateOrderingSourceConfigBySlug
|
|
99
|
+
* @summary: Update ordering source config for a given company and application.
|
|
100
|
+
* @description: Updates the ordering source config for a given company and application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateOrderingSourceConfigBySlug/).
|
|
101
|
+
*/
|
|
102
|
+
updateOrderingSourceConfigBySlug({ slug, body, requestHeaders }?: OrderPlatformApplicationValidator.UpdateOrderingSourceConfigBySlugParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderingSourceConfig>;
|
|
56
103
|
}
|
|
57
104
|
import OrderPlatformApplicationValidator = require("./OrderPlatformApplicationValidator");
|
|
58
105
|
import OrderPlatformModel = require("./OrderPlatformModel");
|
|
@@ -21,12 +21,12 @@ class Order {
|
|
|
21
21
|
*
|
|
22
22
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
23
23
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
24
|
-
* @returns {Promise<OrderPlatformModel.
|
|
24
|
+
* @returns {Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>}
|
|
25
25
|
* - Success response
|
|
26
26
|
*
|
|
27
27
|
* @name getApplicationShipments
|
|
28
28
|
* @summary: List sales channel shipments
|
|
29
|
-
* @description: Get shipments of a particular sales channel based on the filters provided - Check out [method documentation](https://
|
|
29
|
+
* @description: Get shipments of a particular sales channel based on the filters provided - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getApplicationShipments/).
|
|
30
30
|
*/
|
|
31
31
|
async getApplicationShipments(
|
|
32
32
|
{
|
|
@@ -139,7 +139,7 @@ class Order {
|
|
|
139
139
|
|
|
140
140
|
const {
|
|
141
141
|
error: res_error,
|
|
142
|
-
} = OrderPlatformModel.
|
|
142
|
+
} = OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema().validate(
|
|
143
143
|
responseData,
|
|
144
144
|
{ abortEarly: false, allowUnknown: true }
|
|
145
145
|
);
|
|
@@ -158,16 +158,98 @@ class Order {
|
|
|
158
158
|
return response;
|
|
159
159
|
}
|
|
160
160
|
|
|
161
|
+
/**
|
|
162
|
+
* @param {OrderPlatformApplicationValidator.GetOrderingSourceConfigBySlugParam} arg
|
|
163
|
+
* - Arg object
|
|
164
|
+
*
|
|
165
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
166
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
167
|
+
* @returns {Promise<OrderPlatformModel.OrderingSourceConfig>} - Success response
|
|
168
|
+
* @name getOrderingSourceConfigBySlug
|
|
169
|
+
* @summary: Get ordering source config for a given company and application.
|
|
170
|
+
* @description: Retrieves the ordering source config for a given company and application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getOrderingSourceConfigBySlug/).
|
|
171
|
+
*/
|
|
172
|
+
async getOrderingSourceConfigBySlug(
|
|
173
|
+
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
174
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
175
|
+
) {
|
|
176
|
+
const {
|
|
177
|
+
error,
|
|
178
|
+
} = OrderPlatformApplicationValidator.getOrderingSourceConfigBySlug().validate(
|
|
179
|
+
{
|
|
180
|
+
slug,
|
|
181
|
+
},
|
|
182
|
+
{ abortEarly: false, allowUnknown: true }
|
|
183
|
+
);
|
|
184
|
+
if (error) {
|
|
185
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
// Showing warrnings if extra unknown parameters are found
|
|
189
|
+
const {
|
|
190
|
+
error: warrning,
|
|
191
|
+
} = OrderPlatformApplicationValidator.getOrderingSourceConfigBySlug().validate(
|
|
192
|
+
{
|
|
193
|
+
slug,
|
|
194
|
+
},
|
|
195
|
+
{ abortEarly: false, allowUnknown: false }
|
|
196
|
+
);
|
|
197
|
+
if (warrning) {
|
|
198
|
+
Logger({
|
|
199
|
+
level: "WARN",
|
|
200
|
+
message: `Parameter Validation warrnings for platform > Order > getOrderingSourceConfigBySlug \n ${warrning}`,
|
|
201
|
+
});
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
const query_params = {};
|
|
205
|
+
|
|
206
|
+
const response = await PlatformAPIClient.execute(
|
|
207
|
+
this.config,
|
|
208
|
+
"get",
|
|
209
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/application/${this.applicationId}/ordering-sources/${slug}`,
|
|
210
|
+
query_params,
|
|
211
|
+
undefined,
|
|
212
|
+
requestHeaders,
|
|
213
|
+
{ responseHeaders }
|
|
214
|
+
);
|
|
215
|
+
|
|
216
|
+
let responseData = response;
|
|
217
|
+
if (responseHeaders) {
|
|
218
|
+
responseData = response[0];
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
const {
|
|
222
|
+
error: res_error,
|
|
223
|
+
} = OrderPlatformModel.OrderingSourceConfig().validate(responseData, {
|
|
224
|
+
abortEarly: false,
|
|
225
|
+
allowUnknown: true,
|
|
226
|
+
});
|
|
227
|
+
|
|
228
|
+
if (res_error) {
|
|
229
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
230
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
231
|
+
} else {
|
|
232
|
+
Logger({
|
|
233
|
+
level: "WARN",
|
|
234
|
+
message: `Response Validation Warnings for platform > Order > getOrderingSourceConfigBySlug \n ${res_error}`,
|
|
235
|
+
});
|
|
236
|
+
}
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
return response;
|
|
240
|
+
}
|
|
241
|
+
|
|
161
242
|
/**
|
|
162
243
|
* @param {OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam} arg
|
|
163
244
|
* - Arg object
|
|
164
245
|
*
|
|
165
246
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
166
247
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
167
|
-
* @returns {Promise<OrderPlatformModel.
|
|
248
|
+
* @returns {Promise<OrderPlatformModel.ShipmentReasonsResponseSchema>} -
|
|
249
|
+
* Success response
|
|
168
250
|
* @name getPlatformShipmentReasons
|
|
169
251
|
* @summary: List shipment cancellation reasons
|
|
170
|
-
* @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://
|
|
252
|
+
* @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getPlatformShipmentReasons/).
|
|
171
253
|
*/
|
|
172
254
|
async getPlatformShipmentReasons(
|
|
173
255
|
{ action, requestHeaders } = { requestHeaders: {} },
|
|
@@ -220,7 +302,84 @@ class Order {
|
|
|
220
302
|
|
|
221
303
|
const {
|
|
222
304
|
error: res_error,
|
|
223
|
-
} = OrderPlatformModel.
|
|
305
|
+
} = OrderPlatformModel.ShipmentReasonsResponseSchema().validate(
|
|
306
|
+
responseData,
|
|
307
|
+
{ abortEarly: false, allowUnknown: true }
|
|
308
|
+
);
|
|
309
|
+
|
|
310
|
+
if (res_error) {
|
|
311
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
312
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
313
|
+
} else {
|
|
314
|
+
Logger({
|
|
315
|
+
level: "WARN",
|
|
316
|
+
message: `Response Validation Warnings for platform > Order > getPlatformShipmentReasons \n ${res_error}`,
|
|
317
|
+
});
|
|
318
|
+
}
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
return response;
|
|
322
|
+
}
|
|
323
|
+
|
|
324
|
+
/**
|
|
325
|
+
* @param {OrderPlatformApplicationValidator.GetRulesParam} arg - Arg object
|
|
326
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
327
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
328
|
+
* @returns {Promise<OrderPlatformModel.RuleListResponseSchema>} - Success response
|
|
329
|
+
* @name getRules
|
|
330
|
+
* @summary: List of RMA rules based on the given input conditions.
|
|
331
|
+
* @description: Retrieves a comprehensive list of RMA (Return Merchandise Authorization) rules associated with a specific company and application. These rules dictate the processes for handling returns, including actions, reasons, quality control (QC) types, and associated questions. The endpoint allows for filtering and pagination based on input conditions, providing a tailored set of rules that match the criteria specified. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getRules/).
|
|
332
|
+
*/
|
|
333
|
+
async getRules(
|
|
334
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
335
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
336
|
+
) {
|
|
337
|
+
const { error } = OrderPlatformApplicationValidator.getRules().validate(
|
|
338
|
+
{
|
|
339
|
+
body,
|
|
340
|
+
},
|
|
341
|
+
{ abortEarly: false, allowUnknown: true }
|
|
342
|
+
);
|
|
343
|
+
if (error) {
|
|
344
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
345
|
+
}
|
|
346
|
+
|
|
347
|
+
// Showing warrnings if extra unknown parameters are found
|
|
348
|
+
const {
|
|
349
|
+
error: warrning,
|
|
350
|
+
} = OrderPlatformApplicationValidator.getRules().validate(
|
|
351
|
+
{
|
|
352
|
+
body,
|
|
353
|
+
},
|
|
354
|
+
{ abortEarly: false, allowUnknown: false }
|
|
355
|
+
);
|
|
356
|
+
if (warrning) {
|
|
357
|
+
Logger({
|
|
358
|
+
level: "WARN",
|
|
359
|
+
message: `Parameter Validation warrnings for platform > Order > getRules \n ${warrning}`,
|
|
360
|
+
});
|
|
361
|
+
}
|
|
362
|
+
|
|
363
|
+
const query_params = {};
|
|
364
|
+
|
|
365
|
+
const response = await PlatformAPIClient.execute(
|
|
366
|
+
this.config,
|
|
367
|
+
"post",
|
|
368
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/application/${this.applicationId}/rule_list`,
|
|
369
|
+
query_params,
|
|
370
|
+
body,
|
|
371
|
+
requestHeaders,
|
|
372
|
+
{ responseHeaders }
|
|
373
|
+
);
|
|
374
|
+
|
|
375
|
+
let responseData = response;
|
|
376
|
+
if (responseHeaders) {
|
|
377
|
+
responseData = response[0];
|
|
378
|
+
}
|
|
379
|
+
|
|
380
|
+
const {
|
|
381
|
+
error: res_error,
|
|
382
|
+
} = OrderPlatformModel.RuleListResponseSchema().validate(responseData, {
|
|
224
383
|
abortEarly: false,
|
|
225
384
|
allowUnknown: true,
|
|
226
385
|
});
|
|
@@ -231,7 +390,7 @@ class Order {
|
|
|
231
390
|
} else {
|
|
232
391
|
Logger({
|
|
233
392
|
level: "WARN",
|
|
234
|
-
message: `Response Validation Warnings for platform > Order >
|
|
393
|
+
message: `Response Validation Warnings for platform > Order > getRules \n ${res_error}`,
|
|
235
394
|
});
|
|
236
395
|
}
|
|
237
396
|
}
|
|
@@ -247,8 +406,8 @@ class Order {
|
|
|
247
406
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
248
407
|
* @returns {Promise<OrderPlatformModel.ShipmentBagReasons>} - Success response
|
|
249
408
|
* @name getShipmentBagReasons
|
|
250
|
-
* @summary:
|
|
251
|
-
* @description:
|
|
409
|
+
* @summary: Retrieve Reasons for Cancellation and Return journey
|
|
410
|
+
* @description: Allows users to retrieve a comprehensive list of reasons for cancellation or returning a shipment. It provides both cancellation and return reasons, with an emphasis on Quality Control (QC) evaluations. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipmentBagReasons/).
|
|
252
411
|
*/
|
|
253
412
|
async getShipmentBagReasons(
|
|
254
413
|
{ shipmentId, lineNumber, requestHeaders } = { requestHeaders: {} },
|
|
@@ -322,6 +481,94 @@ class Order {
|
|
|
322
481
|
return response;
|
|
323
482
|
}
|
|
324
483
|
|
|
484
|
+
/**
|
|
485
|
+
* @param {OrderPlatformApplicationValidator.ListOrderingSourcesParam} arg
|
|
486
|
+
* - Arg object
|
|
487
|
+
*
|
|
488
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
489
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
490
|
+
* @returns {Promise<OrderPlatformModel.ListOrderingSources>} - Success response
|
|
491
|
+
* @name listOrderingSources
|
|
492
|
+
* @summary: List ordering sources for a given company and application.
|
|
493
|
+
* @description: Retrieves the list of ordering sources for a given company and application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/listOrderingSources/).
|
|
494
|
+
*/
|
|
495
|
+
async listOrderingSources(
|
|
496
|
+
{ type, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
|
|
497
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
498
|
+
) {
|
|
499
|
+
const {
|
|
500
|
+
error,
|
|
501
|
+
} = OrderPlatformApplicationValidator.listOrderingSources().validate(
|
|
502
|
+
{
|
|
503
|
+
type,
|
|
504
|
+
pageNo,
|
|
505
|
+
pageSize,
|
|
506
|
+
},
|
|
507
|
+
{ abortEarly: false, allowUnknown: true }
|
|
508
|
+
);
|
|
509
|
+
if (error) {
|
|
510
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
511
|
+
}
|
|
512
|
+
|
|
513
|
+
// Showing warrnings if extra unknown parameters are found
|
|
514
|
+
const {
|
|
515
|
+
error: warrning,
|
|
516
|
+
} = OrderPlatformApplicationValidator.listOrderingSources().validate(
|
|
517
|
+
{
|
|
518
|
+
type,
|
|
519
|
+
pageNo,
|
|
520
|
+
pageSize,
|
|
521
|
+
},
|
|
522
|
+
{ abortEarly: false, allowUnknown: false }
|
|
523
|
+
);
|
|
524
|
+
if (warrning) {
|
|
525
|
+
Logger({
|
|
526
|
+
level: "WARN",
|
|
527
|
+
message: `Parameter Validation warrnings for platform > Order > listOrderingSources \n ${warrning}`,
|
|
528
|
+
});
|
|
529
|
+
}
|
|
530
|
+
|
|
531
|
+
const query_params = {};
|
|
532
|
+
query_params["type"] = type;
|
|
533
|
+
query_params["page_no"] = pageNo;
|
|
534
|
+
query_params["page_size"] = pageSize;
|
|
535
|
+
|
|
536
|
+
const response = await PlatformAPIClient.execute(
|
|
537
|
+
this.config,
|
|
538
|
+
"get",
|
|
539
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/application/${this.applicationId}/ordering-sources`,
|
|
540
|
+
query_params,
|
|
541
|
+
undefined,
|
|
542
|
+
requestHeaders,
|
|
543
|
+
{ responseHeaders }
|
|
544
|
+
);
|
|
545
|
+
|
|
546
|
+
let responseData = response;
|
|
547
|
+
if (responseHeaders) {
|
|
548
|
+
responseData = response[0];
|
|
549
|
+
}
|
|
550
|
+
|
|
551
|
+
const {
|
|
552
|
+
error: res_error,
|
|
553
|
+
} = OrderPlatformModel.ListOrderingSources().validate(responseData, {
|
|
554
|
+
abortEarly: false,
|
|
555
|
+
allowUnknown: true,
|
|
556
|
+
});
|
|
557
|
+
|
|
558
|
+
if (res_error) {
|
|
559
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
560
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
561
|
+
} else {
|
|
562
|
+
Logger({
|
|
563
|
+
level: "WARN",
|
|
564
|
+
message: `Response Validation Warnings for platform > Order > listOrderingSources \n ${res_error}`,
|
|
565
|
+
});
|
|
566
|
+
}
|
|
567
|
+
}
|
|
568
|
+
|
|
569
|
+
return response;
|
|
570
|
+
}
|
|
571
|
+
|
|
325
572
|
/**
|
|
326
573
|
* @param {OrderPlatformApplicationValidator.TrackShipmentPlatformParam} arg
|
|
327
574
|
* - Arg object
|
|
@@ -331,7 +578,7 @@ class Order {
|
|
|
331
578
|
* @returns {Promise<OrderPlatformModel.PlatformShipmentTrack>} - Success response
|
|
332
579
|
* @name trackShipmentPlatform
|
|
333
580
|
* @summary: Track shipment
|
|
334
|
-
* @description: Track shipment by shipment Id for an application - Check out [method documentation](https://
|
|
581
|
+
* @description: Track shipment by shipment Id for an application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/trackShipmentPlatform/).
|
|
335
582
|
*/
|
|
336
583
|
async trackShipmentPlatform(
|
|
337
584
|
{ shipmentId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -402,6 +649,89 @@ class Order {
|
|
|
402
649
|
|
|
403
650
|
return response;
|
|
404
651
|
}
|
|
652
|
+
|
|
653
|
+
/**
|
|
654
|
+
* @param {OrderPlatformApplicationValidator.UpdateOrderingSourceConfigBySlugParam} arg
|
|
655
|
+
* - Arg object
|
|
656
|
+
*
|
|
657
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
658
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
659
|
+
* @returns {Promise<OrderPlatformModel.OrderingSourceConfig>} - Success response
|
|
660
|
+
* @name updateOrderingSourceConfigBySlug
|
|
661
|
+
* @summary: Update ordering source config for a given company and application.
|
|
662
|
+
* @description: Updates the ordering source config for a given company and application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateOrderingSourceConfigBySlug/).
|
|
663
|
+
*/
|
|
664
|
+
async updateOrderingSourceConfigBySlug(
|
|
665
|
+
{ slug, body, requestHeaders } = { requestHeaders: {} },
|
|
666
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
667
|
+
) {
|
|
668
|
+
const {
|
|
669
|
+
error,
|
|
670
|
+
} = OrderPlatformApplicationValidator.updateOrderingSourceConfigBySlug().validate(
|
|
671
|
+
{
|
|
672
|
+
slug,
|
|
673
|
+
body,
|
|
674
|
+
},
|
|
675
|
+
{ abortEarly: false, allowUnknown: true }
|
|
676
|
+
);
|
|
677
|
+
if (error) {
|
|
678
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
679
|
+
}
|
|
680
|
+
|
|
681
|
+
// Showing warrnings if extra unknown parameters are found
|
|
682
|
+
const {
|
|
683
|
+
error: warrning,
|
|
684
|
+
} = OrderPlatformApplicationValidator.updateOrderingSourceConfigBySlug().validate(
|
|
685
|
+
{
|
|
686
|
+
slug,
|
|
687
|
+
body,
|
|
688
|
+
},
|
|
689
|
+
{ abortEarly: false, allowUnknown: false }
|
|
690
|
+
);
|
|
691
|
+
if (warrning) {
|
|
692
|
+
Logger({
|
|
693
|
+
level: "WARN",
|
|
694
|
+
message: `Parameter Validation warrnings for platform > Order > updateOrderingSourceConfigBySlug \n ${warrning}`,
|
|
695
|
+
});
|
|
696
|
+
}
|
|
697
|
+
|
|
698
|
+
const query_params = {};
|
|
699
|
+
|
|
700
|
+
const response = await PlatformAPIClient.execute(
|
|
701
|
+
this.config,
|
|
702
|
+
"put",
|
|
703
|
+
`/service/platform/order-manage/v1.0/company/${this.config.companyId}/application/${this.applicationId}/ordering-sources/${slug}`,
|
|
704
|
+
query_params,
|
|
705
|
+
body,
|
|
706
|
+
requestHeaders,
|
|
707
|
+
{ responseHeaders }
|
|
708
|
+
);
|
|
709
|
+
|
|
710
|
+
let responseData = response;
|
|
711
|
+
if (responseHeaders) {
|
|
712
|
+
responseData = response[0];
|
|
713
|
+
}
|
|
714
|
+
|
|
715
|
+
const {
|
|
716
|
+
error: res_error,
|
|
717
|
+
} = OrderPlatformModel.OrderingSourceConfig().validate(responseData, {
|
|
718
|
+
abortEarly: false,
|
|
719
|
+
allowUnknown: true,
|
|
720
|
+
});
|
|
721
|
+
|
|
722
|
+
if (res_error) {
|
|
723
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
724
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
725
|
+
} else {
|
|
726
|
+
Logger({
|
|
727
|
+
level: "WARN",
|
|
728
|
+
message: `Response Validation Warnings for platform > Order > updateOrderingSourceConfigBySlug \n ${res_error}`,
|
|
729
|
+
});
|
|
730
|
+
}
|
|
731
|
+
}
|
|
732
|
+
|
|
733
|
+
return response;
|
|
734
|
+
}
|
|
405
735
|
}
|
|
406
736
|
|
|
407
737
|
module.exports = Order;
|