@gofynd/fdk-client-javascript 1.4.15-beta.3 → 1.4.15-beta.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +0 -2
- package/sdk/application/ApplicationClient.js +0 -2
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -68
- package/sdk/application/Cart/CartApplicationClient.js +304 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +58 -59
- package/sdk/application/Catalog/CatalogApplicationClient.js +437 -30
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +22 -1
- package/sdk/application/Communication/CommunicationApplicationClient.js +29 -0
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +157 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +30 -19
- package/sdk/application/Content/ContentApplicationClient.js +297 -28
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -8
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +50 -7
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +74 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +15 -35
- package/sdk/application/Logistic/LogisticApplicationClient.js +159 -87
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -22
- package/sdk/application/Order/OrderApplicationClient.js +195 -47
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +473 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +75 -7
- package/sdk/application/Share/ShareApplicationClient.js +96 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +66 -4
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +418 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +16 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +12 -86
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +24 -582
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +19 -116
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +14 -121
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +1 -8
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +4 -51
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +20 -126
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +20 -970
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +167 -1200
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +160 -571
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +0 -10
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -121
- package/sdk/partner/OAuthClient.js +1 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +10 -8
- package/sdk/partner/Theme/ThemePartnerClient.js +16 -14
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +39 -135
- package/sdk/partner/Theme/ThemePartnerModel.js +38 -114
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +18 -28
- package/sdk/partner/Webhook/WebhookPartnerClient.js +18 -103
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +179 -612
- package/sdk/partner/Webhook/WebhookPartnerModel.js +150 -253
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +0 -1
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +3 -11
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +4 -5
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +8 -14
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +9 -59
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +4 -40
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +32 -2
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +243 -3
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +130 -11
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +152 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +39 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +35 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +388 -443
- package/sdk/platform/Billing/BillingPlatformModel.js +263 -280
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +18 -16
- package/sdk/platform/Billing/BillingPlatformValidator.js +9 -8
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +103 -134
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +115 -419
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +65 -118
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +44 -109
- package/sdk/platform/Cart/CartPlatformModel.d.ts +1298 -5037
- package/sdk/platform/Cart/CartPlatformModel.js +1217 -1976
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +183 -209
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +400 -457
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +142 -185
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +78 -96
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +117 -154
- package/sdk/platform/Catalog/CatalogPlatformClient.js +172 -292
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1647 -6385
- package/sdk/platform/Catalog/CatalogPlatformModel.js +1680 -3217
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +31 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +24 -50
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -3
- package/sdk/platform/Common/CommonPlatformClient.js +2 -3
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +17 -16
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +33 -43
- package/sdk/platform/Communication/CommunicationPlatformModel.js +34 -38
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +42 -46
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +43 -47
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +212 -210
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +33 -46
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +54 -67
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +24 -45
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -134
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +131 -283
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +97 -219
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +9 -37
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +8 -27
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +141 -124
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +422 -449
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +141 -179
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +130 -168
- package/sdk/platform/Content/ContentPlatformClient.d.ts +106 -142
- package/sdk/platform/Content/ContentPlatformClient.js +336 -523
- package/sdk/platform/Content/ContentPlatformModel.d.ts +395 -1241
- package/sdk/platform/Content/ContentPlatformModel.js +390 -521
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +117 -168
- package/sdk/platform/Content/ContentPlatformValidator.js +108 -162
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +12 -14
- package/sdk/platform/Discount/DiscountPlatformClient.js +12 -14
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +36 -94
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +60 -462
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +15 -62
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +13 -75
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +101 -370
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +84 -313
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +320 -0
- package/sdk/platform/Finance/FinancePlatformClient.js +2333 -0
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +2890 -0
- package/sdk/platform/Finance/FinancePlatformModel.js +2148 -0
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +284 -0
- package/sdk/platform/Finance/FinancePlatformValidator.js +354 -0
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +6 -17
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +7 -85
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +24 -95
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +19 -39
- package/sdk/platform/Order/OrderPlatformClient.d.ts +96 -153
- package/sdk/platform/Order/OrderPlatformClient.js +198 -416
- package/sdk/platform/Order/OrderPlatformModel.d.ts +1286 -7619
- package/sdk/platform/Order/OrderPlatformModel.js +1265 -3922
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +109 -270
- package/sdk/platform/Order/OrderPlatformValidator.js +77 -135
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +7 -9
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +105 -93
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +141 -129
- 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 +319 -333
- package/sdk/platform/Payment/PaymentPlatformModel.js +278 -288
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +2 -0
- package/sdk/platform/PlatformClient.js +4 -0
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +36 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +41 -132
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +17 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +14 -34
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +46 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +64 -58
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +612 -1845
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +554 -886
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +46 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +28 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +5 -36
- package/sdk/platform/Share/SharePlatformModel.js +4 -27
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -8
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -2
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +13 -76
- package/sdk/platform/Theme/ThemePlatformModel.js +17 -57
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +78 -25
- package/sdk/platform/Webhook/WebhookPlatformClient.js +470 -75
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +427 -720
- package/sdk/platform/Webhook/WebhookPlatformModel.js +386 -410
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +55 -10
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +72 -12
- package/sdk/platform/index.d.ts +1 -0
- package/sdk/platform/index.js +2 -0
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +21 -6
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -112
- package/sdk/public/Content/ContentPublicClient.js +20 -791
- package/sdk/public/Content/ContentPublicModel.d.ts +3 -549
- package/sdk/public/Content/ContentPublicModel.js +3 -649
- package/sdk/public/Content/ContentPublicValidator.d.ts +3 -69
- package/sdk/public/Content/ContentPublicValidator.js +2 -88
- package/sdk/public/Partner/PartnerPublicClient.js +15 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +48 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +0 -29
- package/sdk/application/Finance/FinanceApplicationClient.js +0 -105
|
@@ -2,14 +2,6 @@ const Joi = require("joi");
|
|
|
2
2
|
|
|
3
3
|
const WebhookModel = require("./WebhookPartnerModel");
|
|
4
4
|
class WebhookValidator {
|
|
5
|
-
static responseTimeSummary() {
|
|
6
|
-
return Joi.object({
|
|
7
|
-
extensionId: Joi.string().allow("").required(),
|
|
8
|
-
startDate: Joi.string().allow("").required(),
|
|
9
|
-
endDate: Joi.string().allow("").required(),
|
|
10
|
-
}).required();
|
|
11
|
-
}
|
|
12
|
-
|
|
13
5
|
static fetchDeliverySummary() {
|
|
14
6
|
return Joi.object({
|
|
15
7
|
extensionId: Joi.string().allow("").required(),
|
|
@@ -21,7 +13,7 @@ class WebhookValidator {
|
|
|
21
13
|
static getDeliveryDetailInsights() {
|
|
22
14
|
return Joi.object({
|
|
23
15
|
extensionId: Joi.string().allow("").required(),
|
|
24
|
-
body: WebhookModel.
|
|
16
|
+
body: WebhookModel.DeliveryDetailsRequest().required(),
|
|
25
17
|
}).required();
|
|
26
18
|
}
|
|
27
19
|
|
|
@@ -60,7 +52,7 @@ class WebhookValidator {
|
|
|
60
52
|
static getInvalidEventList() {
|
|
61
53
|
return Joi.object({
|
|
62
54
|
extensionId: Joi.string().allow("").required(),
|
|
63
|
-
body: WebhookModel.
|
|
55
|
+
body: WebhookModel.InvalidEventsRequest().required(),
|
|
64
56
|
}).required();
|
|
65
57
|
}
|
|
66
58
|
|
|
@@ -74,7 +66,7 @@ class WebhookValidator {
|
|
|
74
66
|
return Joi.object({
|
|
75
67
|
extensionId: Joi.string().allow("").required(),
|
|
76
68
|
subscriberId: Joi.number().required(),
|
|
77
|
-
body: WebhookModel.
|
|
69
|
+
body: WebhookModel.UpdateSubscriberRequest().required(),
|
|
78
70
|
}).required();
|
|
79
71
|
}
|
|
80
72
|
}
|
|
@@ -9,24 +9,24 @@ declare class Analytics {
|
|
|
9
9
|
*
|
|
10
10
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
11
11
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
12
|
-
* @returns {Promise<
|
|
12
|
+
* @returns {Promise<Object>} - Success response
|
|
13
13
|
* @name checkJobStatusByNameV2
|
|
14
14
|
* @summary: Checks download job status
|
|
15
15
|
* @description: Takes job name in path param to check the status of job Returns file URL if downloading is done else returns status of job - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/analytics/checkJobStatusByNameV2/).
|
|
16
16
|
*/
|
|
17
|
-
checkJobStatusByNameV2({ fileName, requestHeaders }?: AnalyticsPlatformApplicationValidator.CheckJobStatusByNameV2Param, { responseHeaders }?: object): Promise<
|
|
17
|
+
checkJobStatusByNameV2({ fileName, requestHeaders }?: AnalyticsPlatformApplicationValidator.CheckJobStatusByNameV2Param, { responseHeaders }?: object): Promise<any>;
|
|
18
18
|
/**
|
|
19
19
|
* @param {AnalyticsPlatformApplicationValidator.ExecuteJobForProvidedParametersV2Param} arg
|
|
20
20
|
* - Arg object
|
|
21
21
|
*
|
|
22
22
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
23
23
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
24
|
-
* @returns {Promise<
|
|
24
|
+
* @returns {Promise<Object>} - Success response
|
|
25
25
|
* @name executeJobForProvidedParametersV2
|
|
26
26
|
* @summary: Executes given sql(Base64 Encoded) query
|
|
27
27
|
* @description: Query click events data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/analytics/executeJobForProvidedParametersV2/).
|
|
28
28
|
*/
|
|
29
|
-
executeJobForProvidedParametersV2({ body, requestHeaders }?: AnalyticsPlatformApplicationValidator.ExecuteJobForProvidedParametersV2Param, { responseHeaders }?: object): Promise<
|
|
29
|
+
executeJobForProvidedParametersV2({ body, requestHeaders }?: AnalyticsPlatformApplicationValidator.ExecuteJobForProvidedParametersV2Param, { responseHeaders }?: object): Promise<any>;
|
|
30
30
|
/**
|
|
31
31
|
* @param {AnalyticsPlatformApplicationValidator.StartDownloadForQueryV2Param} arg
|
|
32
32
|
* - Arg object
|
|
@@ -41,4 +41,3 @@ declare class Analytics {
|
|
|
41
41
|
startDownloadForQueryV2({ exportType, body, requestHeaders }?: AnalyticsPlatformApplicationValidator.StartDownloadForQueryV2Param, { responseHeaders }?: object): Promise<any>;
|
|
42
42
|
}
|
|
43
43
|
import AnalyticsPlatformApplicationValidator = require("./AnalyticsPlatformApplicationValidator");
|
|
44
|
-
import AnalyticsPlatformModel = require("./AnalyticsPlatformModel");
|
|
@@ -21,7 +21,7 @@ class Analytics {
|
|
|
21
21
|
*
|
|
22
22
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
23
23
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
24
|
-
* @returns {Promise<
|
|
24
|
+
* @returns {Promise<Object>} - Success response
|
|
25
25
|
* @name checkJobStatusByNameV2
|
|
26
26
|
* @summary: Checks download job status
|
|
27
27
|
* @description: Takes job name in path param to check the status of job Returns file URL if downloading is done else returns status of job - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/analytics/checkJobStatusByNameV2/).
|
|
@@ -75,12 +75,9 @@ class Analytics {
|
|
|
75
75
|
responseData = response[0];
|
|
76
76
|
}
|
|
77
77
|
|
|
78
|
-
const {
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
abortEarly: false,
|
|
82
|
-
allowUnknown: true,
|
|
83
|
-
});
|
|
78
|
+
const { error: res_error } = Joi.object()
|
|
79
|
+
.pattern(/\S/, Joi.any())
|
|
80
|
+
.validate(responseData, { abortEarly: false, allowUnknown: true });
|
|
84
81
|
|
|
85
82
|
if (res_error) {
|
|
86
83
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -102,7 +99,7 @@ class Analytics {
|
|
|
102
99
|
*
|
|
103
100
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
104
101
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
105
|
-
* @returns {Promise<
|
|
102
|
+
* @returns {Promise<Object>} - Success response
|
|
106
103
|
* @name executeJobForProvidedParametersV2
|
|
107
104
|
* @summary: Executes given sql(Base64 Encoded) query
|
|
108
105
|
* @description: Query click events data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/analytics/executeJobForProvidedParametersV2/).
|
|
@@ -156,12 +153,9 @@ class Analytics {
|
|
|
156
153
|
responseData = response[0];
|
|
157
154
|
}
|
|
158
155
|
|
|
159
|
-
const {
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
abortEarly: false,
|
|
163
|
-
allowUnknown: true,
|
|
164
|
-
});
|
|
156
|
+
const { error: res_error } = Joi.object()
|
|
157
|
+
.pattern(/\S/, Joi.any())
|
|
158
|
+
.validate(responseData, { abortEarly: false, allowUnknown: true });
|
|
165
159
|
|
|
166
160
|
if (res_error) {
|
|
167
161
|
if (this.config.options.strictResponseCheck === true) {
|
|
@@ -11,34 +11,19 @@ export = AnalyticsPlatformModel;
|
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
13
|
* @typedef FileDownloadRequestBody
|
|
14
|
-
* @property {string} query - Base64 encoded
|
|
15
|
-
* @property {boolean} [split_files] - Flag
|
|
16
|
-
*
|
|
14
|
+
* @property {string} query - Base64 encoded query to execute on clickhouse.
|
|
15
|
+
* @property {boolean} [split_files] - Flag to indicate whether to split files
|
|
16
|
+
* for larger data.
|
|
17
17
|
*/
|
|
18
18
|
/**
|
|
19
19
|
* @typedef JobExecute
|
|
20
|
-
* @property {string} query - Base64 encoded
|
|
20
|
+
* @property {string} query - Base64 encoded query to execute on clickhouse.
|
|
21
21
|
* @property {Page} [page]
|
|
22
22
|
*/
|
|
23
|
-
/**
|
|
24
|
-
* @typedef JobExecutionResult
|
|
25
|
-
* @property {Object[]} [rows] - Array of rows resulting from the job execution.
|
|
26
|
-
* @property {Page} [page]
|
|
27
|
-
*/
|
|
28
|
-
/**
|
|
29
|
-
* @typedef JobStatus
|
|
30
|
-
* @property {string} [start_date] - The start date and time of the job.
|
|
31
|
-
* @property {string} [end_date] - The end date and time of the job.
|
|
32
|
-
* @property {string} [status] - The current status of the job.
|
|
33
|
-
* @property {string} [message] - Message providing additional details about the
|
|
34
|
-
* job status.
|
|
35
|
-
* @property {Object[]} [file_metadata] - Metadata about files associated with
|
|
36
|
-
* the job, if any.
|
|
37
|
-
*/
|
|
38
23
|
declare class AnalyticsPlatformModel {
|
|
39
24
|
}
|
|
40
25
|
declare namespace AnalyticsPlatformModel {
|
|
41
|
-
export { Page, FileDownloadRequestBody, JobExecute
|
|
26
|
+
export { Page, FileDownloadRequestBody, JobExecute };
|
|
42
27
|
}
|
|
43
28
|
/** @returns {Page} */
|
|
44
29
|
declare function Page(): Page;
|
|
@@ -76,12 +61,12 @@ type Page = {
|
|
|
76
61
|
declare function FileDownloadRequestBody(): FileDownloadRequestBody;
|
|
77
62
|
type FileDownloadRequestBody = {
|
|
78
63
|
/**
|
|
79
|
-
* - Base64 encoded
|
|
64
|
+
* - Base64 encoded query to execute on clickhouse.
|
|
80
65
|
*/
|
|
81
66
|
query: string;
|
|
82
67
|
/**
|
|
83
|
-
* - Flag
|
|
84
|
-
*
|
|
68
|
+
* - Flag to indicate whether to split files
|
|
69
|
+
* for larger data.
|
|
85
70
|
*/
|
|
86
71
|
split_files?: boolean;
|
|
87
72
|
};
|
|
@@ -89,43 +74,8 @@ type FileDownloadRequestBody = {
|
|
|
89
74
|
declare function JobExecute(): JobExecute;
|
|
90
75
|
type JobExecute = {
|
|
91
76
|
/**
|
|
92
|
-
* - Base64 encoded
|
|
77
|
+
* - Base64 encoded query to execute on clickhouse.
|
|
93
78
|
*/
|
|
94
79
|
query: string;
|
|
95
80
|
page?: Page;
|
|
96
81
|
};
|
|
97
|
-
/** @returns {JobExecutionResult} */
|
|
98
|
-
declare function JobExecutionResult(): JobExecutionResult;
|
|
99
|
-
type JobExecutionResult = {
|
|
100
|
-
/**
|
|
101
|
-
* - Array of rows resulting from the job execution.
|
|
102
|
-
*/
|
|
103
|
-
rows?: any[];
|
|
104
|
-
page?: Page;
|
|
105
|
-
};
|
|
106
|
-
/** @returns {JobStatus} */
|
|
107
|
-
declare function JobStatus(): JobStatus;
|
|
108
|
-
type JobStatus = {
|
|
109
|
-
/**
|
|
110
|
-
* - The start date and time of the job.
|
|
111
|
-
*/
|
|
112
|
-
start_date?: string;
|
|
113
|
-
/**
|
|
114
|
-
* - The end date and time of the job.
|
|
115
|
-
*/
|
|
116
|
-
end_date?: string;
|
|
117
|
-
/**
|
|
118
|
-
* - The current status of the job.
|
|
119
|
-
*/
|
|
120
|
-
status?: string;
|
|
121
|
-
/**
|
|
122
|
-
* - Message providing additional details about the
|
|
123
|
-
* job status.
|
|
124
|
-
*/
|
|
125
|
-
message?: string;
|
|
126
|
-
/**
|
|
127
|
-
* - Metadata about files associated with
|
|
128
|
-
* the job, if any.
|
|
129
|
-
*/
|
|
130
|
-
file_metadata?: any[];
|
|
131
|
-
};
|
|
@@ -13,34 +13,17 @@ const Joi = require("joi");
|
|
|
13
13
|
|
|
14
14
|
/**
|
|
15
15
|
* @typedef FileDownloadRequestBody
|
|
16
|
-
* @property {string} query - Base64 encoded
|
|
17
|
-
* @property {boolean} [split_files] - Flag
|
|
18
|
-
*
|
|
16
|
+
* @property {string} query - Base64 encoded query to execute on clickhouse.
|
|
17
|
+
* @property {boolean} [split_files] - Flag to indicate whether to split files
|
|
18
|
+
* for larger data.
|
|
19
19
|
*/
|
|
20
20
|
|
|
21
21
|
/**
|
|
22
22
|
* @typedef JobExecute
|
|
23
|
-
* @property {string} query - Base64 encoded
|
|
23
|
+
* @property {string} query - Base64 encoded query to execute on clickhouse.
|
|
24
24
|
* @property {Page} [page]
|
|
25
25
|
*/
|
|
26
26
|
|
|
27
|
-
/**
|
|
28
|
-
* @typedef JobExecutionResult
|
|
29
|
-
* @property {Object[]} [rows] - Array of rows resulting from the job execution.
|
|
30
|
-
* @property {Page} [page]
|
|
31
|
-
*/
|
|
32
|
-
|
|
33
|
-
/**
|
|
34
|
-
* @typedef JobStatus
|
|
35
|
-
* @property {string} [start_date] - The start date and time of the job.
|
|
36
|
-
* @property {string} [end_date] - The end date and time of the job.
|
|
37
|
-
* @property {string} [status] - The current status of the job.
|
|
38
|
-
* @property {string} [message] - Message providing additional details about the
|
|
39
|
-
* job status.
|
|
40
|
-
* @property {Object[]} [file_metadata] - Metadata about files associated with
|
|
41
|
-
* the job, if any.
|
|
42
|
-
*/
|
|
43
|
-
|
|
44
27
|
class AnalyticsPlatformModel {
|
|
45
28
|
/** @returns {Page} */
|
|
46
29
|
static Page() {
|
|
@@ -70,24 +53,5 @@ class AnalyticsPlatformModel {
|
|
|
70
53
|
page: AnalyticsPlatformModel.Page(),
|
|
71
54
|
});
|
|
72
55
|
}
|
|
73
|
-
|
|
74
|
-
/** @returns {JobExecutionResult} */
|
|
75
|
-
static JobExecutionResult() {
|
|
76
|
-
return Joi.object({
|
|
77
|
-
rows: Joi.array().items(Joi.any()),
|
|
78
|
-
page: AnalyticsPlatformModel.Page(),
|
|
79
|
-
});
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
/** @returns {JobStatus} */
|
|
83
|
-
static JobStatus() {
|
|
84
|
-
return Joi.object({
|
|
85
|
-
start_date: Joi.string().allow(""),
|
|
86
|
-
end_date: Joi.string().allow(""),
|
|
87
|
-
status: Joi.string().allow(""),
|
|
88
|
-
message: Joi.string().allow(""),
|
|
89
|
-
file_metadata: Joi.array().items(Joi.any()).allow(null, ""),
|
|
90
|
-
});
|
|
91
|
-
}
|
|
92
56
|
}
|
|
93
57
|
module.exports = AnalyticsPlatformModel;
|
|
@@ -6,12 +6,42 @@ declare class AuditTrail {
|
|
|
6
6
|
* @param {AuditTrailPlatformValidator.CreateAuditLogParam} arg - Arg object
|
|
7
7
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
8
8
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
9
|
-
* @returns {Promise<AuditTrailPlatformModel.
|
|
9
|
+
* @returns {Promise<AuditTrailPlatformModel.CreateLogResponse>} - Success response
|
|
10
10
|
* @name createAuditLog
|
|
11
11
|
* @summary: Create an audit log
|
|
12
12
|
* @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/createAuditLog/).
|
|
13
13
|
*/
|
|
14
|
-
createAuditLog({ body, requestHeaders }?: AuditTrailPlatformValidator.CreateAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.
|
|
14
|
+
createAuditLog({ body, requestHeaders }?: AuditTrailPlatformValidator.CreateAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.CreateLogResponse>;
|
|
15
|
+
/**
|
|
16
|
+
* @param {AuditTrailPlatformValidator.GetAuditLogParam} arg - Arg object
|
|
17
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
18
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
19
|
+
* @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
|
|
20
|
+
* @name getAuditLog
|
|
21
|
+
* @summary: Get an audit log
|
|
22
|
+
* @description: Retrieve a specific audit log entry. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
|
|
23
|
+
*/
|
|
24
|
+
getAuditLog({ id, requestHeaders }?: AuditTrailPlatformValidator.GetAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
|
|
25
|
+
/**
|
|
26
|
+
* @param {AuditTrailPlatformValidator.GetAuditLogsParam} arg - Arg object
|
|
27
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
28
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
29
|
+
* @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
|
|
30
|
+
* @name getAuditLogs
|
|
31
|
+
* @summary: Get audit logs
|
|
32
|
+
* @description: Retrieve audit logs for system events and actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLogs/).
|
|
33
|
+
*/
|
|
34
|
+
getAuditLogs({ qs, limit, sort, requestHeaders }?: AuditTrailPlatformValidator.GetAuditLogsParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.LogSchemaResponse>;
|
|
35
|
+
/**
|
|
36
|
+
* @param {AuditTrailPlatformValidator.GetEntityTypesParam} arg - Arg object
|
|
37
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
38
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
39
|
+
* @returns {Promise<AuditTrailPlatformModel.EntityTypesResponse>} - Success response
|
|
40
|
+
* @name getEntityTypes
|
|
41
|
+
* @summary: List entity types
|
|
42
|
+
* @description: List of entity types that can be audited within the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
|
|
43
|
+
*/
|
|
44
|
+
getEntityTypes({ requestHeaders }?: any, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.EntityTypesResponse>;
|
|
15
45
|
}
|
|
16
46
|
import AuditTrailPlatformValidator = require("./AuditTrailPlatformValidator");
|
|
17
47
|
import AuditTrailPlatformModel = require("./AuditTrailPlatformModel");
|
|
@@ -18,7 +18,7 @@ class AuditTrail {
|
|
|
18
18
|
* @param {AuditTrailPlatformValidator.CreateAuditLogParam} arg - Arg object
|
|
19
19
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
20
20
|
* @param {import("../PlatformAPIClient").Options} - Options
|
|
21
|
-
* @returns {Promise<AuditTrailPlatformModel.
|
|
21
|
+
* @returns {Promise<AuditTrailPlatformModel.CreateLogResponse>} - Success response
|
|
22
22
|
* @name createAuditLog
|
|
23
23
|
* @summary: Create an audit log
|
|
24
24
|
* @description: Generate and record an audit log entry for a specific event or action. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/createAuditLog/).
|
|
@@ -60,7 +60,7 @@ class AuditTrail {
|
|
|
60
60
|
const response = await PlatformAPIClient.execute(
|
|
61
61
|
this.config,
|
|
62
62
|
"post",
|
|
63
|
-
`/service/platform/
|
|
63
|
+
`/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs`,
|
|
64
64
|
query_params,
|
|
65
65
|
body,
|
|
66
66
|
{ ...xHeaders, ...requestHeaders },
|
|
@@ -74,7 +74,7 @@ class AuditTrail {
|
|
|
74
74
|
|
|
75
75
|
const {
|
|
76
76
|
error: res_error,
|
|
77
|
-
} = AuditTrailPlatformModel.
|
|
77
|
+
} = AuditTrailPlatformModel.CreateLogResponse().validate(responseData, {
|
|
78
78
|
abortEarly: false,
|
|
79
79
|
allowUnknown: true,
|
|
80
80
|
});
|
|
@@ -92,6 +92,246 @@ class AuditTrail {
|
|
|
92
92
|
|
|
93
93
|
return response;
|
|
94
94
|
}
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* @param {AuditTrailPlatformValidator.GetAuditLogParam} arg - Arg object
|
|
98
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
99
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
100
|
+
* @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
|
|
101
|
+
* @name getAuditLog
|
|
102
|
+
* @summary: Get an audit log
|
|
103
|
+
* @description: Retrieve a specific audit log entry. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLog/).
|
|
104
|
+
*/
|
|
105
|
+
async getAuditLog(
|
|
106
|
+
{ id, requestHeaders } = { requestHeaders: {} },
|
|
107
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
108
|
+
) {
|
|
109
|
+
const { error } = AuditTrailPlatformValidator.getAuditLog().validate(
|
|
110
|
+
{
|
|
111
|
+
id,
|
|
112
|
+
},
|
|
113
|
+
{ abortEarly: false, allowUnknown: true }
|
|
114
|
+
);
|
|
115
|
+
if (error) {
|
|
116
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
// Showing warrnings if extra unknown parameters are found
|
|
120
|
+
const {
|
|
121
|
+
error: warrning,
|
|
122
|
+
} = AuditTrailPlatformValidator.getAuditLog().validate(
|
|
123
|
+
{
|
|
124
|
+
id,
|
|
125
|
+
},
|
|
126
|
+
{ abortEarly: false, allowUnknown: false }
|
|
127
|
+
);
|
|
128
|
+
if (warrning) {
|
|
129
|
+
Logger({
|
|
130
|
+
level: "WARN",
|
|
131
|
+
message: `Parameter Validation warrnings for platform > AuditTrail > getAuditLog \n ${warrning}`,
|
|
132
|
+
});
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
const query_params = {};
|
|
136
|
+
|
|
137
|
+
const xHeaders = {};
|
|
138
|
+
|
|
139
|
+
const response = await PlatformAPIClient.execute(
|
|
140
|
+
this.config,
|
|
141
|
+
"get",
|
|
142
|
+
`/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs/${id}`,
|
|
143
|
+
query_params,
|
|
144
|
+
undefined,
|
|
145
|
+
{ ...xHeaders, ...requestHeaders },
|
|
146
|
+
{ responseHeaders }
|
|
147
|
+
);
|
|
148
|
+
|
|
149
|
+
let responseData = response;
|
|
150
|
+
if (responseHeaders) {
|
|
151
|
+
responseData = response[0];
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
const {
|
|
155
|
+
error: res_error,
|
|
156
|
+
} = AuditTrailPlatformModel.LogSchemaResponse().validate(responseData, {
|
|
157
|
+
abortEarly: false,
|
|
158
|
+
allowUnknown: true,
|
|
159
|
+
});
|
|
160
|
+
|
|
161
|
+
if (res_error) {
|
|
162
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
163
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
164
|
+
} else {
|
|
165
|
+
Logger({
|
|
166
|
+
level: "WARN",
|
|
167
|
+
message: `Response Validation Warnings for platform > AuditTrail > getAuditLog \n ${res_error}`,
|
|
168
|
+
});
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
return response;
|
|
173
|
+
}
|
|
174
|
+
|
|
175
|
+
/**
|
|
176
|
+
* @param {AuditTrailPlatformValidator.GetAuditLogsParam} arg - Arg object
|
|
177
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
178
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
179
|
+
* @returns {Promise<AuditTrailPlatformModel.LogSchemaResponse>} - Success response
|
|
180
|
+
* @name getAuditLogs
|
|
181
|
+
* @summary: Get audit logs
|
|
182
|
+
* @description: Retrieve audit logs for system events and actions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getAuditLogs/).
|
|
183
|
+
*/
|
|
184
|
+
async getAuditLogs(
|
|
185
|
+
{ qs, limit, sort, requestHeaders } = { requestHeaders: {} },
|
|
186
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
187
|
+
) {
|
|
188
|
+
const { error } = AuditTrailPlatformValidator.getAuditLogs().validate(
|
|
189
|
+
{
|
|
190
|
+
qs,
|
|
191
|
+
limit,
|
|
192
|
+
sort,
|
|
193
|
+
},
|
|
194
|
+
{ abortEarly: false, allowUnknown: true }
|
|
195
|
+
);
|
|
196
|
+
if (error) {
|
|
197
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
198
|
+
}
|
|
199
|
+
|
|
200
|
+
// Showing warrnings if extra unknown parameters are found
|
|
201
|
+
const {
|
|
202
|
+
error: warrning,
|
|
203
|
+
} = AuditTrailPlatformValidator.getAuditLogs().validate(
|
|
204
|
+
{
|
|
205
|
+
qs,
|
|
206
|
+
limit,
|
|
207
|
+
sort,
|
|
208
|
+
},
|
|
209
|
+
{ abortEarly: false, allowUnknown: false }
|
|
210
|
+
);
|
|
211
|
+
if (warrning) {
|
|
212
|
+
Logger({
|
|
213
|
+
level: "WARN",
|
|
214
|
+
message: `Parameter Validation warrnings for platform > AuditTrail > getAuditLogs \n ${warrning}`,
|
|
215
|
+
});
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
const query_params = {};
|
|
219
|
+
query_params["qs"] = qs;
|
|
220
|
+
query_params["limit"] = limit;
|
|
221
|
+
query_params["sort"] = sort;
|
|
222
|
+
|
|
223
|
+
const xHeaders = {};
|
|
224
|
+
|
|
225
|
+
const response = await PlatformAPIClient.execute(
|
|
226
|
+
this.config,
|
|
227
|
+
"get",
|
|
228
|
+
`/service/platform/audit-trail/v1.0/company/${this.config.companyId}/logs`,
|
|
229
|
+
query_params,
|
|
230
|
+
undefined,
|
|
231
|
+
{ ...xHeaders, ...requestHeaders },
|
|
232
|
+
{ responseHeaders }
|
|
233
|
+
);
|
|
234
|
+
|
|
235
|
+
let responseData = response;
|
|
236
|
+
if (responseHeaders) {
|
|
237
|
+
responseData = response[0];
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
const {
|
|
241
|
+
error: res_error,
|
|
242
|
+
} = AuditTrailPlatformModel.LogSchemaResponse().validate(responseData, {
|
|
243
|
+
abortEarly: false,
|
|
244
|
+
allowUnknown: true,
|
|
245
|
+
});
|
|
246
|
+
|
|
247
|
+
if (res_error) {
|
|
248
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
249
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
250
|
+
} else {
|
|
251
|
+
Logger({
|
|
252
|
+
level: "WARN",
|
|
253
|
+
message: `Response Validation Warnings for platform > AuditTrail > getAuditLogs \n ${res_error}`,
|
|
254
|
+
});
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
|
|
258
|
+
return response;
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
/**
|
|
262
|
+
* @param {AuditTrailPlatformValidator.GetEntityTypesParam} arg - Arg object
|
|
263
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
264
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
265
|
+
* @returns {Promise<AuditTrailPlatformModel.EntityTypesResponse>} - Success response
|
|
266
|
+
* @name getEntityTypes
|
|
267
|
+
* @summary: List entity types
|
|
268
|
+
* @description: List of entity types that can be audited within the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/audittrail/getEntityTypes/).
|
|
269
|
+
*/
|
|
270
|
+
async getEntityTypes(
|
|
271
|
+
{ requestHeaders } = { requestHeaders: {} },
|
|
272
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
273
|
+
) {
|
|
274
|
+
const { error } = AuditTrailPlatformValidator.getEntityTypes().validate(
|
|
275
|
+
{},
|
|
276
|
+
{ abortEarly: false, allowUnknown: true }
|
|
277
|
+
);
|
|
278
|
+
if (error) {
|
|
279
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
280
|
+
}
|
|
281
|
+
|
|
282
|
+
// Showing warrnings if extra unknown parameters are found
|
|
283
|
+
const {
|
|
284
|
+
error: warrning,
|
|
285
|
+
} = AuditTrailPlatformValidator.getEntityTypes().validate(
|
|
286
|
+
{},
|
|
287
|
+
{ abortEarly: false, allowUnknown: false }
|
|
288
|
+
);
|
|
289
|
+
if (warrning) {
|
|
290
|
+
Logger({
|
|
291
|
+
level: "WARN",
|
|
292
|
+
message: `Parameter Validation warrnings for platform > AuditTrail > getEntityTypes \n ${warrning}`,
|
|
293
|
+
});
|
|
294
|
+
}
|
|
295
|
+
|
|
296
|
+
const query_params = {};
|
|
297
|
+
|
|
298
|
+
const xHeaders = {};
|
|
299
|
+
|
|
300
|
+
const response = await PlatformAPIClient.execute(
|
|
301
|
+
this.config,
|
|
302
|
+
"get",
|
|
303
|
+
`/service/platform/audit-trail/v1.0/company/${this.config.companyId}/entity-types`,
|
|
304
|
+
query_params,
|
|
305
|
+
undefined,
|
|
306
|
+
{ ...xHeaders, ...requestHeaders },
|
|
307
|
+
{ responseHeaders }
|
|
308
|
+
);
|
|
309
|
+
|
|
310
|
+
let responseData = response;
|
|
311
|
+
if (responseHeaders) {
|
|
312
|
+
responseData = response[0];
|
|
313
|
+
}
|
|
314
|
+
|
|
315
|
+
const {
|
|
316
|
+
error: res_error,
|
|
317
|
+
} = AuditTrailPlatformModel.EntityTypesResponse().validate(responseData, {
|
|
318
|
+
abortEarly: false,
|
|
319
|
+
allowUnknown: true,
|
|
320
|
+
});
|
|
321
|
+
|
|
322
|
+
if (res_error) {
|
|
323
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
324
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
325
|
+
} else {
|
|
326
|
+
Logger({
|
|
327
|
+
level: "WARN",
|
|
328
|
+
message: `Response Validation Warnings for platform > AuditTrail > getEntityTypes \n ${res_error}`,
|
|
329
|
+
});
|
|
330
|
+
}
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
return response;
|
|
334
|
+
}
|
|
95
335
|
}
|
|
96
336
|
|
|
97
337
|
module.exports = AuditTrail;
|