@gofynd/fdk-client-javascript 1.4.15-beta.6 → 1.4.16-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (237) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +2 -0
  4. package/sdk/application/ApplicationClient.js +2 -0
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
  6. package/sdk/application/Cart/CartApplicationClient.js +130 -27
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
  10. package/sdk/application/Common/CommonApplicationClient.js +1 -1
  11. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
  12. package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
  13. package/sdk/application/Content/ContentApplicationClient.d.ts +19 -30
  14. package/sdk/application/Content/ContentApplicationClient.js +40 -60
  15. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -8
  16. package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -7
  17. package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
  18. package/sdk/application/Finance/FinanceApplicationClient.js +126 -0
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
  20. package/sdk/application/Lead/LeadApplicationClient.js +1 -1
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +118 -8
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
  24. package/sdk/application/Order/OrderApplicationClient.js +62 -8
  25. package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
  26. package/sdk/application/Payment/PaymentApplicationClient.js +65 -46
  27. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
  28. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  29. package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
  30. package/sdk/application/Theme/ThemeApplicationClient.js +4 -2
  31. package/sdk/application/User/UserApplicationClient.d.ts +10 -10
  32. package/sdk/application/User/UserApplicationClient.js +6 -6
  33. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
  34. package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
  35. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
  36. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
  37. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
  38. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
  39. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
  40. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
  41. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  42. package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
  43. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
  44. package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
  45. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
  46. package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
  47. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
  48. package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
  49. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
  50. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
  51. package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
  52. package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
  53. package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
  54. package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
  55. package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
  56. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
  57. package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
  58. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
  59. package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
  60. package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
  61. package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
  62. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
  63. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
  64. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
  65. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
  66. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
  67. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
  68. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
  69. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
  70. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
  71. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
  72. package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
  73. package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
  74. package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
  75. package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
  76. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
  77. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
  78. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
  79. package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
  80. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
  81. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
  82. package/sdk/platform/Cart/CartPlatformModel.d.ts +5039 -1300
  83. package/sdk/platform/Cart/CartPlatformModel.js +1976 -1217
  84. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
  85. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
  86. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
  87. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
  88. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
  89. package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
  90. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6941 -2203
  91. package/sdk/platform/Catalog/CatalogPlatformModel.js +3224 -1687
  92. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
  93. package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
  94. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
  95. package/sdk/platform/Common/CommonPlatformClient.js +3 -2
  96. package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
  97. package/sdk/platform/Common/CommonPlatformModel.js +6 -6
  98. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
  99. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
  100. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
  101. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
  102. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
  103. package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
  104. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
  105. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
  106. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
  107. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
  108. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
  109. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
  110. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
  111. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
  112. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
  113. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
  114. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
  115. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
  116. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
  117. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
  118. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
  119. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
  120. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
  121. package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
  122. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
  123. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
  124. package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
  125. package/sdk/platform/Content/ContentPlatformClient.js +523 -336
  126. package/sdk/platform/Content/ContentPlatformModel.d.ts +1241 -395
  127. package/sdk/platform/Content/ContentPlatformModel.js +521 -390
  128. package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
  129. package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
  130. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
  131. package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
  132. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
  133. package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
  134. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
  135. package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
  136. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
  137. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
  138. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
  139. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
  140. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
  141. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
  142. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
  143. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
  144. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
  145. package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
  146. package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
  147. package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
  148. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
  149. package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
  150. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
  151. package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
  152. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
  153. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
  154. package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
  155. package/sdk/platform/Order/OrderPlatformClient.js +416 -198
  156. package/sdk/platform/Order/OrderPlatformModel.d.ts +7602 -1269
  157. package/sdk/platform/Order/OrderPlatformModel.js +3926 -1269
  158. package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
  159. package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
  160. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
  161. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
  162. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
  163. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  164. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
  165. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
  166. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
  167. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
  168. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  169. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  170. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
  171. package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
  172. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
  173. package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
  174. package/sdk/platform/PlatformClient.d.ts +0 -2
  175. package/sdk/platform/PlatformClient.js +0 -4
  176. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
  177. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
  178. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
  179. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
  180. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
  181. package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
  182. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +48 -38
  183. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +134 -43
  184. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
  185. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
  186. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +38 -44
  187. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +56 -62
  188. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
  189. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
  190. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
  191. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
  192. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
  193. package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
  194. package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
  195. package/sdk/platform/Share/SharePlatformModel.js +27 -4
  196. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
  197. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
  198. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
  199. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
  200. package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
  201. package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
  202. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
  203. package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
  204. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
  205. package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
  206. package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
  207. package/sdk/platform/User/UserPlatformModel.js +23 -23
  208. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
  209. package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
  210. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
  211. package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
  212. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
  213. package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
  214. package/sdk/platform/index.d.ts +0 -1
  215. package/sdk/platform/index.js +0 -2
  216. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
  217. package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
  218. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
  219. package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
  220. package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
  221. package/sdk/public/Content/ContentPublicClient.js +895 -8
  222. package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
  223. package/sdk/public/Content/ContentPublicModel.js +649 -3
  224. package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
  225. package/sdk/public/Content/ContentPublicValidator.js +88 -2
  226. package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
  227. package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
  228. package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
  229. package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
  230. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
  231. package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
  232. package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
  233. package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
  234. package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
  235. package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
  236. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
  237. package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
@@ -2,6 +2,14 @@ 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
+
5
13
  static fetchDeliverySummary() {
6
14
  return Joi.object({
7
15
  extensionId: Joi.string().allow("").required(),
@@ -13,7 +21,7 @@ class WebhookValidator {
13
21
  static getDeliveryDetailInsights() {
14
22
  return Joi.object({
15
23
  extensionId: Joi.string().allow("").required(),
16
- body: WebhookModel.DeliveryDetailsRequest().required(),
24
+ body: WebhookModel.DeliveryDetailsPayload().required(),
17
25
  }).required();
18
26
  }
19
27
 
@@ -52,7 +60,7 @@ class WebhookValidator {
52
60
  static getInvalidEventList() {
53
61
  return Joi.object({
54
62
  extensionId: Joi.string().allow("").required(),
55
- body: WebhookModel.InvalidEventsRequest().required(),
63
+ body: WebhookModel.InvalidEventsPayload().required(),
56
64
  }).required();
57
65
  }
58
66
 
@@ -66,7 +74,7 @@ class WebhookValidator {
66
74
  return Joi.object({
67
75
  extensionId: Joi.string().allow("").required(),
68
76
  subscriberId: Joi.number().required(),
69
- body: WebhookModel.UpdateSubscriberRequest().required(),
77
+ body: WebhookModel.SubscriberUpdate().required(),
70
78
  }).required();
71
79
  }
72
80
  }
@@ -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<Object>} - Success response
12
+ * @returns {Promise<AnalyticsPlatformModel.JobStatus>} - 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<any>;
17
+ checkJobStatusByNameV2({ fileName, requestHeaders }?: AnalyticsPlatformApplicationValidator.CheckJobStatusByNameV2Param, { responseHeaders }?: object): Promise<AnalyticsPlatformModel.JobStatus>;
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<Object>} - Success response
24
+ * @returns {Promise<AnalyticsPlatformModel.JobExecutionResult>} - 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<any>;
29
+ executeJobForProvidedParametersV2({ body, requestHeaders }?: AnalyticsPlatformApplicationValidator.ExecuteJobForProvidedParametersV2Param, { responseHeaders }?: object): Promise<AnalyticsPlatformModel.JobExecutionResult>;
30
30
  /**
31
31
  * @param {AnalyticsPlatformApplicationValidator.StartDownloadForQueryV2Param} arg
32
32
  * - Arg object
@@ -41,3 +41,4 @@ 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<Object>} - Success response
24
+ * @returns {Promise<AnalyticsPlatformModel.JobStatus>} - 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,9 +75,12 @@ class Analytics {
75
75
  responseData = response[0];
76
76
  }
77
77
 
78
- const { error: res_error } = Joi.object()
79
- .pattern(/\S/, Joi.any())
80
- .validate(responseData, { abortEarly: false, allowUnknown: true });
78
+ const {
79
+ error: res_error,
80
+ } = AnalyticsPlatformModel.JobStatus().validate(responseData, {
81
+ abortEarly: false,
82
+ allowUnknown: true,
83
+ });
81
84
 
82
85
  if (res_error) {
83
86
  if (this.config.options.strictResponseCheck === true) {
@@ -99,7 +102,7 @@ class Analytics {
99
102
  *
100
103
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
101
104
  * @param {import("../PlatformAPIClient").Options} - Options
102
- * @returns {Promise<Object>} - Success response
105
+ * @returns {Promise<AnalyticsPlatformModel.JobExecutionResult>} - Success response
103
106
  * @name executeJobForProvidedParametersV2
104
107
  * @summary: Executes given sql(Base64 Encoded) query
105
108
  * @description: Query click events data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/analytics/executeJobForProvidedParametersV2/).
@@ -153,9 +156,12 @@ class Analytics {
153
156
  responseData = response[0];
154
157
  }
155
158
 
156
- const { error: res_error } = Joi.object()
157
- .pattern(/\S/, Joi.any())
158
- .validate(responseData, { abortEarly: false, allowUnknown: true });
159
+ const {
160
+ error: res_error,
161
+ } = AnalyticsPlatformModel.JobExecutionResult().validate(responseData, {
162
+ abortEarly: false,
163
+ allowUnknown: true,
164
+ });
159
165
 
160
166
  if (res_error) {
161
167
  if (this.config.options.strictResponseCheck === true) {
@@ -11,19 +11,34 @@ export = AnalyticsPlatformModel;
11
11
  */
12
12
  /**
13
13
  * @typedef FileDownloadRequestBody
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.
14
+ * @property {string} query - Base64 encoded SQL query to execute on ClickHouse.
15
+ * @property {boolean} [split_files] - Flag indicating whether to split the
16
+ * files for larger datasets.
17
17
  */
18
18
  /**
19
19
  * @typedef JobExecute
20
- * @property {string} query - Base64 encoded query to execute on clickhouse.
20
+ * @property {string} query - Base64 encoded SQL 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
+ */
23
38
  declare class AnalyticsPlatformModel {
24
39
  }
25
40
  declare namespace AnalyticsPlatformModel {
26
- export { Page, FileDownloadRequestBody, JobExecute };
41
+ export { Page, FileDownloadRequestBody, JobExecute, JobExecutionResult, JobStatus };
27
42
  }
28
43
  /** @returns {Page} */
29
44
  declare function Page(): Page;
@@ -61,12 +76,12 @@ type Page = {
61
76
  declare function FileDownloadRequestBody(): FileDownloadRequestBody;
62
77
  type FileDownloadRequestBody = {
63
78
  /**
64
- * - Base64 encoded query to execute on clickhouse.
79
+ * - Base64 encoded SQL query to execute on ClickHouse.
65
80
  */
66
81
  query: string;
67
82
  /**
68
- * - Flag to indicate whether to split files
69
- * for larger data.
83
+ * - Flag indicating whether to split the
84
+ * files for larger datasets.
70
85
  */
71
86
  split_files?: boolean;
72
87
  };
@@ -74,8 +89,43 @@ type FileDownloadRequestBody = {
74
89
  declare function JobExecute(): JobExecute;
75
90
  type JobExecute = {
76
91
  /**
77
- * - Base64 encoded query to execute on clickhouse.
92
+ * - Base64 encoded SQL query to execute on ClickHouse.
78
93
  */
79
94
  query: string;
80
95
  page?: Page;
81
96
  };
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,17 +13,34 @@ const Joi = require("joi");
13
13
 
14
14
  /**
15
15
  * @typedef FileDownloadRequestBody
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.
16
+ * @property {string} query - Base64 encoded SQL query to execute on ClickHouse.
17
+ * @property {boolean} [split_files] - Flag indicating whether to split the
18
+ * files for larger datasets.
19
19
  */
20
20
 
21
21
  /**
22
22
  * @typedef JobExecute
23
- * @property {string} query - Base64 encoded query to execute on clickhouse.
23
+ * @property {string} query - Base64 encoded SQL 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
+
27
44
  class AnalyticsPlatformModel {
28
45
  /** @returns {Page} */
29
46
  static Page() {
@@ -53,5 +70,24 @@ class AnalyticsPlatformModel {
53
70
  page: AnalyticsPlatformModel.Page(),
54
71
  });
55
72
  }
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
+ }
56
92
  }
57
93
  module.exports = AnalyticsPlatformModel;
@@ -6,42 +6,12 @@ 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.CreateLogResponse>} - Success response
9
+ * @returns {Promise<AuditTrailPlatformModel.CreateLogResp>} - 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.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>;
14
+ createAuditLog({ body, requestHeaders }?: AuditTrailPlatformValidator.CreateAuditLogParam, { responseHeaders }?: object): Promise<AuditTrailPlatformModel.CreateLogResp>;
45
15
  }
46
16
  import AuditTrailPlatformValidator = require("./AuditTrailPlatformValidator");
47
17
  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.CreateLogResponse>} - Success response
21
+ * @returns {Promise<AuditTrailPlatformModel.CreateLogResp>} - 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/audit-trail/v1.0/company/${this.config.companyId}/logs`,
63
+ `/service/platform/webhook/v1.0/company/${this.config.companyId}/audit/logs/create`,
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.CreateLogResponse().validate(responseData, {
77
+ } = AuditTrailPlatformModel.CreateLogResp().validate(responseData, {
78
78
  abortEarly: false,
79
79
  allowUnknown: true,
80
80
  });
@@ -92,246 +92,6 @@ 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
- }
335
95
  }
336
96
 
337
97
  module.exports = AuditTrail;