@epilot/sdk 2.4.4-alpha.0 → 2.4.4

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 (222) hide show
  1. package/dist/access-token.d-CnmUTOlq.d.cts +552 -0
  2. package/dist/access-token.d-CnmUTOlq.d.ts +552 -0
  3. package/dist/address-suggestions.d-_YwTOR-9.d.cts +339 -0
  4. package/dist/address-suggestions.d-_YwTOR-9.d.ts +339 -0
  5. package/dist/address.d-CwAPOVxa.d.cts +437 -0
  6. package/dist/address.d-CwAPOVxa.d.ts +437 -0
  7. package/dist/ai-agents.d-OkXfr2bz.d.cts +1339 -0
  8. package/dist/ai-agents.d-OkXfr2bz.d.ts +1339 -0
  9. package/dist/apis/access-token.d.cts +18 -0
  10. package/dist/apis/access-token.d.ts +12 -9
  11. package/dist/apis/address-suggestions.d.cts +18 -0
  12. package/dist/apis/address-suggestions.d.ts +12 -9
  13. package/dist/apis/address.d.cts +18 -0
  14. package/dist/apis/address.d.ts +12 -9
  15. package/dist/apis/ai-agents.d.cts +18 -0
  16. package/dist/apis/ai-agents.d.ts +12 -9
  17. package/dist/apis/app.d.cts +18 -0
  18. package/dist/apis/app.d.ts +12 -9
  19. package/dist/apis/audit-logs.d.cts +18 -0
  20. package/dist/apis/audit-logs.d.ts +12 -9
  21. package/dist/apis/automation.d.cts +18 -0
  22. package/dist/apis/automation.d.ts +12 -9
  23. package/dist/apis/billing.d.cts +18 -0
  24. package/dist/apis/billing.d.ts +12 -9
  25. package/dist/apis/blueprint-manifest.d.cts +18 -0
  26. package/dist/apis/blueprint-manifest.d.ts +12 -9
  27. package/dist/apis/calendar.d.cts +18 -0
  28. package/dist/apis/calendar.d.ts +12 -9
  29. package/dist/apis/configuration-hub.d.cts +18 -0
  30. package/dist/apis/configuration-hub.d.ts +12 -9
  31. package/dist/apis/consent.d.cts +18 -0
  32. package/dist/apis/consent.d.ts +12 -9
  33. package/dist/apis/customer-portal.d.cts +18 -0
  34. package/dist/apis/customer-portal.d.ts +12 -9
  35. package/dist/apis/dashboard.d.cts +18 -0
  36. package/dist/apis/dashboard.d.ts +12 -9
  37. package/dist/apis/data-governance.d.cts +18 -0
  38. package/dist/apis/data-governance.d.ts +12 -9
  39. package/dist/apis/deduplication.d.cts +18 -0
  40. package/dist/apis/deduplication.d.ts +12 -9
  41. package/dist/apis/design.d.cts +18 -0
  42. package/dist/apis/design.d.ts +12 -9
  43. package/dist/apis/document.d.cts +18 -0
  44. package/dist/apis/document.d.ts +12 -9
  45. package/dist/apis/email-settings.d.cts +18 -0
  46. package/dist/apis/email-settings.d.ts +12 -9
  47. package/dist/apis/email-template.d.cts +18 -0
  48. package/dist/apis/email-template.d.ts +12 -9
  49. package/dist/apis/entity-mapping.d.cts +18 -0
  50. package/dist/apis/entity-mapping.d.ts +12 -9
  51. package/dist/apis/entity.d.cts +18 -0
  52. package/dist/apis/entity.d.ts +12 -9
  53. package/dist/apis/environments.d.cts +18 -0
  54. package/dist/apis/environments.d.ts +12 -9
  55. package/dist/apis/event-catalog.d.cts +18 -0
  56. package/dist/apis/event-catalog.d.ts +12 -9
  57. package/dist/apis/file.d.cts +18 -0
  58. package/dist/apis/file.d.ts +12 -9
  59. package/dist/apis/iban.d.cts +18 -0
  60. package/dist/apis/iban.d.ts +12 -9
  61. package/dist/apis/integration-toolkit.d.cts +18 -0
  62. package/dist/apis/integration-toolkit.d.ts +12 -9
  63. package/dist/apis/journey.d.cts +18 -0
  64. package/dist/apis/journey.d.ts +12 -9
  65. package/dist/apis/kanban.d.cts +18 -0
  66. package/dist/apis/kanban.d.ts +12 -9
  67. package/dist/apis/message.d.cts +18 -0
  68. package/dist/apis/message.d.ts +12 -9
  69. package/dist/apis/metering.d.cts +18 -0
  70. package/dist/apis/metering.d.ts +12 -9
  71. package/dist/apis/notes.d.cts +18 -0
  72. package/dist/apis/notes.d.ts +12 -9
  73. package/dist/apis/notification.d.cts +18 -0
  74. package/dist/apis/notification.d.ts +12 -9
  75. package/dist/apis/organization.d.cts +18 -0
  76. package/dist/apis/organization.d.ts +12 -9
  77. package/dist/apis/partner-directory.d.cts +18 -0
  78. package/dist/apis/partner-directory.d.ts +12 -9
  79. package/dist/apis/permissions.d.cts +18 -0
  80. package/dist/apis/permissions.d.ts +12 -9
  81. package/dist/apis/pricing-tier.d.cts +18 -0
  82. package/dist/apis/pricing-tier.d.ts +12 -9
  83. package/dist/apis/pricing.d.cts +18 -0
  84. package/dist/apis/pricing.d.ts +12 -9
  85. package/dist/apis/purpose.d.cts +18 -0
  86. package/dist/apis/purpose.d.ts +12 -9
  87. package/dist/apis/query.d.cts +18 -0
  88. package/dist/apis/query.d.ts +12 -9
  89. package/dist/apis/sandbox.d.cts +18 -0
  90. package/dist/apis/sandbox.d.ts +12 -9
  91. package/dist/apis/sharing.d.cts +18 -0
  92. package/dist/apis/sharing.d.ts +12 -9
  93. package/dist/apis/submission.d.cts +18 -0
  94. package/dist/apis/submission.d.ts +12 -9
  95. package/dist/apis/target.d.cts +597 -0
  96. package/dist/apis/target.d.ts +591 -9
  97. package/dist/apis/targeting.d.cts +18 -0
  98. package/dist/apis/targeting.d.ts +12 -9
  99. package/dist/apis/template-variables.d.cts +18 -0
  100. package/dist/apis/template-variables.d.ts +12 -9
  101. package/dist/apis/user.d.cts +18 -0
  102. package/dist/apis/user.d.ts +12 -9
  103. package/dist/apis/validation-rules.d.cts +18 -0
  104. package/dist/apis/validation-rules.d.ts +12 -9
  105. package/dist/apis/webhooks.d.cts +18 -0
  106. package/dist/apis/webhooks.d.ts +12 -9
  107. package/dist/apis/workflow-definition.d.cts +18 -0
  108. package/dist/apis/workflow-definition.d.ts +12 -9
  109. package/dist/apis/workflow.d.cts +18 -0
  110. package/dist/apis/workflow.d.ts +12 -9
  111. package/dist/app.d-u7Dq42kU.d.cts +3391 -0
  112. package/dist/app.d-u7Dq42kU.d.ts +3391 -0
  113. package/dist/audit-logs.d-BRToFqeX.d.cts +287 -0
  114. package/dist/audit-logs.d-BRToFqeX.d.ts +287 -0
  115. package/dist/automation.d-Du6-uiz5.d.cts +5283 -0
  116. package/dist/automation.d-Du6-uiz5.d.ts +5283 -0
  117. package/dist/billing.d-Bs8Ku9qE.d.cts +993 -0
  118. package/dist/billing.d-Bs8Ku9qE.d.ts +993 -0
  119. package/dist/blueprint-manifest.d-BPyzoR0X.d.cts +4343 -0
  120. package/dist/blueprint-manifest.d-BPyzoR0X.d.ts +4343 -0
  121. package/dist/calendar.d-BEjLDagH.d.cts +353 -0
  122. package/dist/calendar.d-BEjLDagH.d.ts +353 -0
  123. package/dist/configuration-hub.d-Cqaq2F-W.d.cts +478 -0
  124. package/dist/configuration-hub.d-Cqaq2F-W.d.ts +478 -0
  125. package/dist/consent.d-C2PROHhX.d.cts +265 -0
  126. package/dist/consent.d-C2PROHhX.d.ts +265 -0
  127. package/dist/customer-portal.d-DyZ2n2dW.d.cts +16728 -0
  128. package/dist/customer-portal.d-DyZ2n2dW.d.ts +16728 -0
  129. package/dist/dashboard.d-CsGcA74I.d.cts +440 -0
  130. package/dist/dashboard.d-CsGcA74I.d.ts +440 -0
  131. package/dist/data-governance.d-BbZ466j5.d.cts +1178 -0
  132. package/dist/data-governance.d-BbZ466j5.d.ts +1178 -0
  133. package/dist/deduplication.d-D5GYddVu.d.cts +218 -0
  134. package/dist/deduplication.d-D5GYddVu.d.ts +218 -0
  135. package/dist/design.d-BRre8iLg.d.cts +2346 -0
  136. package/dist/design.d-BRre8iLg.d.ts +2346 -0
  137. package/dist/document.d-DN37pjdx.d.cts +648 -0
  138. package/dist/document.d-DN37pjdx.d.ts +648 -0
  139. package/dist/email-settings.d-B7Q_xT25.d.cts +2417 -0
  140. package/dist/email-settings.d-B7Q_xT25.d.ts +2417 -0
  141. package/dist/email-template.d-gtQkdaXM.d.cts +1188 -0
  142. package/dist/email-template.d-gtQkdaXM.d.ts +1188 -0
  143. package/dist/entity-mapping.d-DKSW3sfy.d.cts +1092 -0
  144. package/dist/entity-mapping.d-DKSW3sfy.d.ts +1092 -0
  145. package/dist/entity.d-BHR9dEon.d.cts +18479 -0
  146. package/dist/entity.d-BHR9dEon.d.ts +18479 -0
  147. package/dist/environments.d-BvqvN-PD.d.cts +382 -0
  148. package/dist/environments.d-BvqvN-PD.d.ts +382 -0
  149. package/dist/event-catalog.d-ENw6HO-w.d.cts +1511 -0
  150. package/dist/event-catalog.d-ENw6HO-w.d.ts +1511 -0
  151. package/dist/file.d-DcTJxjp7.d.cts +2992 -0
  152. package/dist/file.d-DcTJxjp7.d.ts +2992 -0
  153. package/dist/iban.d-BwdiGbxi.d.cts +70 -0
  154. package/dist/iban.d-BwdiGbxi.d.ts +70 -0
  155. package/dist/index.d.cts +182 -0
  156. package/dist/index.d.ts +182 -12
  157. package/dist/integration-toolkit.d-Ry-KC9ow.d.cts +5796 -0
  158. package/dist/integration-toolkit.d-Ry-KC9ow.d.ts +5796 -0
  159. package/dist/journey.d-ClXO0xK8.d.cts +1931 -0
  160. package/dist/journey.d-ClXO0xK8.d.ts +1931 -0
  161. package/dist/kanban.d-BHnSRCYW.d.cts +760 -0
  162. package/dist/kanban.d-BHnSRCYW.d.ts +760 -0
  163. package/dist/message.d-B5UuSqgw.d.cts +3811 -0
  164. package/dist/message.d-B5UuSqgw.d.ts +3811 -0
  165. package/dist/metering.d-DvtPv7wk.d.cts +1841 -0
  166. package/dist/metering.d-DvtPv7wk.d.ts +1841 -0
  167. package/dist/notes.d-BC-scR42.d.cts +1046 -0
  168. package/dist/notes.d-BC-scR42.d.ts +1046 -0
  169. package/dist/notification.d-BfBL3lga.d.cts +1147 -0
  170. package/dist/notification.d-BfBL3lga.d.ts +1147 -0
  171. package/dist/organization.d-DqwnNxMg.d.cts +1271 -0
  172. package/dist/organization.d-DqwnNxMg.d.ts +1271 -0
  173. package/dist/partner-directory.d-BCIjHoGs.d.cts +2337 -0
  174. package/dist/partner-directory.d-BCIjHoGs.d.ts +2337 -0
  175. package/dist/permissions.d-l6AT8SYP.d.cts +1279 -0
  176. package/dist/permissions.d-l6AT8SYP.d.ts +1279 -0
  177. package/dist/pricing-tier.d-Cg0jl6n_.d.cts +81 -0
  178. package/dist/pricing-tier.d-Cg0jl6n_.d.ts +81 -0
  179. package/dist/pricing.d-BHpMU4KU.d.cts +12255 -0
  180. package/dist/pricing.d-BHpMU4KU.d.ts +12255 -0
  181. package/dist/purpose.d-CbIYfTua.d.cts +372 -0
  182. package/dist/purpose.d-CbIYfTua.d.ts +372 -0
  183. package/dist/query.d-Cmp78IhZ.d.cts +2375 -0
  184. package/dist/query.d-Cmp78IhZ.d.ts +2375 -0
  185. package/dist/sandbox.d-BdbOFzDu.d.cts +465 -0
  186. package/dist/sandbox.d-BdbOFzDu.d.ts +465 -0
  187. package/dist/sharing.d-sOXq-gtz.d.cts +571 -0
  188. package/dist/sharing.d-sOXq-gtz.d.ts +571 -0
  189. package/dist/submission.d-BamwfhXw.d.cts +469 -0
  190. package/dist/submission.d-BamwfhXw.d.ts +469 -0
  191. package/dist/targeting.d-BNmcVsNS.d.cts +2057 -0
  192. package/dist/targeting.d-BNmcVsNS.d.ts +2057 -0
  193. package/dist/template-variables.d-Ble9TSBa.d.cts +1320 -0
  194. package/dist/template-variables.d-Ble9TSBa.d.ts +1320 -0
  195. package/dist/types-ChU9Acbv.d.cts +37 -0
  196. package/dist/types-ChU9Acbv.d.ts +37 -0
  197. package/dist/user.d-D18fe97W.d.cts +2270 -0
  198. package/dist/user.d-D18fe97W.d.ts +2270 -0
  199. package/dist/validation-rules.d-Db5c5zTf.d.cts +807 -0
  200. package/dist/validation-rules.d-Db5c5zTf.d.ts +807 -0
  201. package/dist/webhooks.d-pLHIL_io.d.cts +1256 -0
  202. package/dist/webhooks.d-pLHIL_io.d.ts +1256 -0
  203. package/dist/workflow-definition.d-DOeb0KVV.d.cts +1922 -0
  204. package/dist/workflow-definition.d-DOeb0KVV.d.ts +1922 -0
  205. package/dist/workflow.d-CMSKt8oN.d.cts +3151 -0
  206. package/dist/workflow.d-CMSKt8oN.d.ts +3151 -0
  207. package/package.json +1 -1
  208. package/dist/apis/_registry.d.ts +0 -8
  209. package/dist/authorize.d.ts +0 -3
  210. package/dist/bin/cli.d.ts +0 -1
  211. package/dist/client-factory.d.ts +0 -9
  212. package/dist/client-map.d.ts +0 -102
  213. package/dist/compact.d.ts +0 -22
  214. package/dist/help.d.ts +0 -12
  215. package/dist/large-response.d.ts +0 -9
  216. package/dist/openapi.d.ts +0 -12
  217. package/dist/overrides.d.ts +0 -9
  218. package/dist/proxy.d.ts +0 -14
  219. package/dist/registry.d.ts +0 -19
  220. package/dist/retry.d.ts +0 -11
  221. package/dist/sdk.d.ts +0 -29
  222. package/dist/types.d.ts +0 -53
@@ -0,0 +1,807 @@
1
+ import { OpenAPIClient, Parameters, UnknownParamsObject, AxiosRequestConfig, OperationResponse } from 'openapi-client-axios';
2
+
3
+ /* Auto-copied from validation-rules-client */
4
+ /* eslint-disable */
5
+
6
+
7
+
8
+ declare namespace Components {
9
+ namespace Schemas {
10
+ export interface CreateValidationRuleRequest {
11
+ /**
12
+ * Title of the validation rule.
13
+ */
14
+ title: string;
15
+ /**
16
+ * Placeholder for the validation rule.
17
+ */
18
+ placeholder?: string;
19
+ /**
20
+ * Describes where and how a validation rule is applied.
21
+ */
22
+ used_by?: /* Describes where and how a validation rule is applied. */ UsedBy[];
23
+ rule: /* Validation rule that uses a regular expression to validate input. */ RegexRuleType | /* Validation rule that uses a sequence of patterns to validate input. */ PatternRuleType | /* Validation rule for numeric values, supporting range and digit count constraints. */ NumericRuleType;
24
+ }
25
+ export interface GetValidationRulesResponse {
26
+ results?: /* The Validation rule definition. */ ValidationRule[];
27
+ }
28
+ /**
29
+ * Condition definition for a numeric-based validation rule (2 levels deep)
30
+ */
31
+ export type NumericCondition = /* Condition definition for a numeric-based validation rule (2 levels deep) */ {
32
+ all: (/* Fact-based condition for numeric validation */ NumericFactCondition | /* Nested condition with logical operators (level 2 only) */ NumericNestedCondition)[];
33
+ } | {
34
+ any: (/* Fact-based condition for numeric validation */ NumericFactCondition | /* Nested condition with logical operators (level 2 only) */ NumericNestedCondition)[];
35
+ } | {
36
+ not: /* Fact-based condition for numeric validation */ NumericFactCondition | /* Nested condition with logical operators (level 2 only) */ NumericNestedCondition;
37
+ };
38
+ /**
39
+ * Fact-based condition for numeric validation
40
+ */
41
+ export type NumericFactCondition = /* Fact-based condition for numeric validation */ {
42
+ /**
43
+ * The numeric value extracted from input; The amount of digits
44
+ */
45
+ fact: "numeric-value" | "total-length";
46
+ /**
47
+ * Numeric comparison operator
48
+ */
49
+ operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive";
50
+ /**
51
+ * Numeric value to compare against
52
+ */
53
+ value: number;
54
+ /**
55
+ * Additional parameters for the condition
56
+ */
57
+ params?: {
58
+ /**
59
+ * Custom error message
60
+ */
61
+ errorMessage?: string;
62
+ };
63
+ } | {
64
+ /**
65
+ * Count of integer digits (excludes leading zeros unless allowed)
66
+ */
67
+ fact: "integer-digits-count";
68
+ /**
69
+ * Digit count comparison operator
70
+ */
71
+ operator: "equal" | "exactlyNDigits" | "minIntegerDigits" | "maxIntegerDigits";
72
+ /**
73
+ * Expected number of integer digits
74
+ */
75
+ value: number;
76
+ /**
77
+ * Additional parameters for the condition
78
+ */
79
+ params?: {
80
+ /**
81
+ * Custom error message
82
+ */
83
+ errorMessage?: string;
84
+ /**
85
+ * Whether to count leading zeroes in digit count
86
+ */
87
+ allowLeadingZeroes?: boolean;
88
+ };
89
+ } | {
90
+ /**
91
+ * Count of decimal digits
92
+ */
93
+ fact: "decimal-digits-count";
94
+ /**
95
+ * Decimal digit count comparison operator
96
+ */
97
+ operator: "equal" | "minDecimalDigits" | "maxDecimalDigits";
98
+ /**
99
+ * Expected number of decimal digits
100
+ */
101
+ value: number;
102
+ /**
103
+ * Additional parameters for the condition
104
+ */
105
+ params?: {
106
+ /**
107
+ * Custom error message
108
+ */
109
+ errorMessage?: string;
110
+ };
111
+ } | {
112
+ /**
113
+ * Whether the input has leading zeros
114
+ */
115
+ fact: "has-leading-zeroes";
116
+ /**
117
+ * Leading zeros check operator
118
+ */
119
+ operator: "equal" | "notAllowed";
120
+ /**
121
+ * Whether leading zeros should be present or not
122
+ */
123
+ value: boolean;
124
+ /**
125
+ * Additional parameters for the condition
126
+ */
127
+ params?: {
128
+ /**
129
+ * Custom error message
130
+ */
131
+ errorMessage?: string;
132
+ };
133
+ };
134
+ /**
135
+ * Nested condition with logical operators (level 2 only)
136
+ */
137
+ export type NumericNestedCondition = /* Nested condition with logical operators (level 2 only) */ {
138
+ all: /* Fact-based condition for numeric validation */ NumericFactCondition[];
139
+ } | {
140
+ any: /* Fact-based condition for numeric validation */ NumericFactCondition[];
141
+ } | {
142
+ not: /* Fact-based condition for numeric validation */ NumericFactCondition;
143
+ };
144
+ /**
145
+ * Validation rule for numeric values, supporting range and digit count constraints.
146
+ */
147
+ export interface NumericRuleType {
148
+ /**
149
+ * Indicates this is a numeric-based validation rule.
150
+ */
151
+ type: "numeric";
152
+ /**
153
+ * The conditions that must be met for the rule to trigger
154
+ */
155
+ conditions: /* Condition definition for a numeric-based validation rule (2 levels deep) */ NumericCondition;
156
+ }
157
+ /**
158
+ * Condition definition for a pattern-based validation rule (2 levels deep)
159
+ */
160
+ export type PatternCondition = /* Condition definition for a pattern-based validation rule (2 levels deep) */ {
161
+ all: (/* Fact-based condition for pattern validation */ PatternFactCondition | /* Nested condition with logical operators (level 2 only) */ PatternNestedCondition)[];
162
+ } | {
163
+ any: (/* Fact-based condition for pattern validation */ PatternFactCondition | /* Nested condition with logical operators (level 2 only) */ PatternNestedCondition)[];
164
+ } | {
165
+ not: /* Fact-based condition for pattern validation */ PatternFactCondition | /* Nested condition with logical operators (level 2 only) */ PatternNestedCondition;
166
+ };
167
+ /**
168
+ * Fact-based condition for pattern validation
169
+ */
170
+ export type PatternFactCondition = /* Fact-based condition for pattern validation */ {
171
+ /**
172
+ * The name of the value to validate.
173
+ */
174
+ fact: "total-length";
175
+ /**
176
+ * Numeric comparison operator
177
+ */
178
+ operator: "equal" | "notEqual" | "lessThan" | "lessThanInclusive" | "greaterThan" | "greaterThanInclusive";
179
+ /**
180
+ * Numeric value to compare against
181
+ */
182
+ value: number;
183
+ /**
184
+ * Additional parameters for the condition
185
+ */
186
+ params?: {
187
+ /**
188
+ * Custom error message
189
+ */
190
+ errorMessage?: string;
191
+ /**
192
+ * From where to check
193
+ */
194
+ start?: number;
195
+ /**
196
+ * To where to check
197
+ */
198
+ end?: number;
199
+ };
200
+ } | {
201
+ /**
202
+ * The name of the value to validate.
203
+ */
204
+ fact: "static-check" | "total-length";
205
+ /**
206
+ * Exact digit count operator
207
+ */
208
+ operator: "exactlyNDigits";
209
+ /**
210
+ * Number of digits required
211
+ */
212
+ value: number;
213
+ /**
214
+ * Additional parameters for the condition
215
+ */
216
+ params?: {
217
+ /**
218
+ * Custom error message
219
+ */
220
+ errorMessage?: string;
221
+ /**
222
+ * From where to check
223
+ */
224
+ start?: number;
225
+ /**
226
+ * To where to check
227
+ */
228
+ end?: number;
229
+ };
230
+ } | {
231
+ /**
232
+ * The name of the value to validate.
233
+ */
234
+ fact: "static-check";
235
+ /**
236
+ * Array-based comparison operator
237
+ */
238
+ operator: "in" | "notIn" | "contains" | "doesNotContain";
239
+ /**
240
+ * Array of string values for array-based operators
241
+ */
242
+ value: string[];
243
+ /**
244
+ * Additional parameters for the condition
245
+ */
246
+ params?: {
247
+ /**
248
+ * Custom error message
249
+ */
250
+ errorMessage?: string;
251
+ /**
252
+ * From where to check
253
+ */
254
+ start?: number;
255
+ /**
256
+ * To where to check
257
+ */
258
+ end?: number;
259
+ };
260
+ } | {
261
+ /**
262
+ * The name of the value to validate.
263
+ */
264
+ fact: "static-check";
265
+ /**
266
+ * String comparison operator
267
+ */
268
+ operator: "equal" | "notEqual";
269
+ /**
270
+ * String value to compare against
271
+ */
272
+ value: string;
273
+ /**
274
+ * Additional parameters for the condition
275
+ */
276
+ params?: {
277
+ /**
278
+ * Custom error message
279
+ */
280
+ errorMessage?: string;
281
+ /**
282
+ * From where to check
283
+ */
284
+ start?: number;
285
+ /**
286
+ * To where to check
287
+ */
288
+ end?: number;
289
+ };
290
+ };
291
+ /**
292
+ * Nested condition with logical operators (level 2 only)
293
+ */
294
+ export type PatternNestedCondition = /* Nested condition with logical operators (level 2 only) */ {
295
+ all: /* Fact-based condition for pattern validation */ PatternFactCondition[];
296
+ } | {
297
+ any: /* Fact-based condition for pattern validation */ PatternFactCondition[];
298
+ } | {
299
+ not: /* Fact-based condition for pattern validation */ PatternFactCondition;
300
+ };
301
+ /**
302
+ * Validation rule that uses a sequence of patterns to validate input.
303
+ */
304
+ export interface PatternRuleType {
305
+ /**
306
+ * Indicates this is a pattern-based validation rule.
307
+ */
308
+ type: "pattern";
309
+ /**
310
+ * The conditions that must be met for the rule to trigger
311
+ */
312
+ conditions: /* Condition definition for a pattern-based validation rule (2 levels deep) */ PatternCondition;
313
+ }
314
+ /**
315
+ * Condition definition for a regex-based validation rule (2 levels deep)
316
+ */
317
+ export type RegexCondition = /* Condition definition for a regex-based validation rule (2 levels deep) */ {
318
+ all: (/* Fact-based condition for regex validation */ RegexFactCondition | /* Nested condition with logical operators (level 2 only) */ RegexNestedCondition)[];
319
+ } | {
320
+ any: (/* Fact-based condition for regex validation */ RegexFactCondition | /* Nested condition with logical operators (level 2 only) */ RegexNestedCondition)[];
321
+ } | {
322
+ not: /* Fact-based condition for regex validation */ RegexFactCondition | /* Nested condition with logical operators (level 2 only) */ RegexNestedCondition;
323
+ };
324
+ /**
325
+ * Fact-based condition for regex validation
326
+ */
327
+ export interface RegexFactCondition {
328
+ /**
329
+ * The name of the value to validate. Should always be 'inputValue' because this property name is passed to the engine
330
+ */
331
+ fact: "inputValue";
332
+ /**
333
+ * The operator to use for comparison
334
+ */
335
+ operator: "regexMatch";
336
+ /**
337
+ * The actual regex
338
+ */
339
+ value: string;
340
+ /**
341
+ * Additional parameters for the condition
342
+ */
343
+ params?: {
344
+ /**
345
+ * Custom error message
346
+ */
347
+ errorMessage?: string;
348
+ };
349
+ }
350
+ /**
351
+ * Nested condition with logical operators (level 2 only)
352
+ */
353
+ export type RegexNestedCondition = /* Nested condition with logical operators (level 2 only) */ {
354
+ all: /* Fact-based condition for regex validation */ RegexFactCondition[];
355
+ } | {
356
+ any: /* Fact-based condition for regex validation */ RegexFactCondition[];
357
+ } | {
358
+ not: /* Fact-based condition for regex validation */ RegexFactCondition;
359
+ };
360
+ /**
361
+ * Validation rule that uses a regular expression to validate input.
362
+ */
363
+ export interface RegexRuleType {
364
+ /**
365
+ * Indicates this is a regex-based validation rule.
366
+ */
367
+ type: "regex";
368
+ /**
369
+ * The conditions that must be met for the rule to trigger
370
+ */
371
+ conditions: /* Condition definition for a regex-based validation rule (2 levels deep) */ RegexCondition;
372
+ }
373
+ export interface UpdateValidationRuleRequest {
374
+ /**
375
+ * Title of the validation rule.
376
+ */
377
+ title?: string;
378
+ /**
379
+ * Placeholder for the validation rule.
380
+ */
381
+ placeholder?: string;
382
+ /**
383
+ * Describes where and how a validation rule is applied.
384
+ */
385
+ used_by?: /* Describes where and how a validation rule is applied. */ UsedBy[];
386
+ rule?: /* Validation rule that uses a regular expression to validate input. */ RegexRuleType | /* Validation rule that uses a sequence of patterns to validate input. */ PatternRuleType | /* Validation rule for numeric values, supporting range and digit count constraints. */ NumericRuleType;
387
+ }
388
+ /**
389
+ * Describes where and how a validation rule is applied.
390
+ */
391
+ export interface UsedBy {
392
+ /**
393
+ * The context in which the rule is used (e.g., journey or entity).
394
+ */
395
+ type: "journey" | "entity";
396
+ /**
397
+ * Slug of the schema using this rule for entities.
398
+ */
399
+ schema_slug?: string;
400
+ /**
401
+ * Source identifier for the usage context.
402
+ */
403
+ source_id?: string;
404
+ }
405
+ /**
406
+ * The Validation rule definition.
407
+ */
408
+ export interface ValidationRule {
409
+ /**
410
+ * Title of the validation rule.
411
+ */
412
+ title: string;
413
+ /**
414
+ * Placeholder for the validation rule.
415
+ */
416
+ placeholder?: string;
417
+ /**
418
+ * Describes where and how a validation rule is applied.
419
+ */
420
+ used_by?: /* Describes where and how a validation rule is applied. */ UsedBy[];
421
+ rule?: /* Validation rule that uses a regular expression to validate input. */ RegexRuleType | /* Validation rule that uses a sequence of patterns to validate input. */ PatternRuleType | /* Validation rule for numeric values, supporting range and digit count constraints. */ NumericRuleType;
422
+ /**
423
+ * Schema version of the validation rule.
424
+ */
425
+ _schema_version: string;
426
+ /**
427
+ * Unique identifier for the validation rule.
428
+ */
429
+ _id: string;
430
+ /**
431
+ * Organization ID that owns this rule.
432
+ */
433
+ _organization_id: string;
434
+ /**
435
+ * ISO timestamp when the rule was created.
436
+ */
437
+ created_at: string;
438
+ /**
439
+ * ISO timestamp when the rule was last updated.
440
+ */
441
+ updated_at: string;
442
+ /**
443
+ * User ID of the creator.
444
+ */
445
+ created_by: string;
446
+ /**
447
+ * User ID of the last updater.
448
+ */
449
+ updated_by: string;
450
+ }
451
+ export interface ValidationRuleBase {
452
+ /**
453
+ * Title of the validation rule.
454
+ */
455
+ title?: string;
456
+ /**
457
+ * Placeholder for the validation rule.
458
+ */
459
+ placeholder?: string;
460
+ /**
461
+ * Describes where and how a validation rule is applied.
462
+ */
463
+ used_by?: /* Describes where and how a validation rule is applied. */ UsedBy[];
464
+ rule?: /* Validation rule that uses a regular expression to validate input. */ RegexRuleType | /* Validation rule that uses a sequence of patterns to validate input. */ PatternRuleType | /* Validation rule for numeric values, supporting range and digit count constraints. */ NumericRuleType;
465
+ }
466
+ }
467
+ }
468
+ declare namespace Paths {
469
+ namespace AddUsedByReference {
470
+ namespace Parameters {
471
+ export type RuleId = string;
472
+ }
473
+ export interface PathParameters {
474
+ ruleId: Parameters.RuleId;
475
+ }
476
+ export type RequestBody = /* Describes where and how a validation rule is applied. */ Components.Schemas.UsedBy;
477
+ namespace Responses {
478
+ export type $200 = /* The Validation rule definition. */ Components.Schemas.ValidationRule;
479
+ export interface $400 {
480
+ /**
481
+ * example:
482
+ * Invalid request body
483
+ */
484
+ message?: string;
485
+ }
486
+ export interface $404 {
487
+ /**
488
+ * example:
489
+ * Validation rule not found
490
+ */
491
+ message?: string;
492
+ }
493
+ export interface $500 {
494
+ /**
495
+ * example:
496
+ * Unknown API Error
497
+ */
498
+ message?: string;
499
+ }
500
+ }
501
+ }
502
+ namespace CreateValidationRule {
503
+ export type RequestBody = Components.Schemas.CreateValidationRuleRequest;
504
+ namespace Responses {
505
+ export type $201 = /* The Validation rule definition. */ Components.Schemas.ValidationRule;
506
+ }
507
+ }
508
+ namespace DeleteValidationRule {
509
+ namespace Parameters {
510
+ export type RuleId = string;
511
+ }
512
+ export interface PathParameters {
513
+ ruleId: Parameters.RuleId;
514
+ }
515
+ namespace Responses {
516
+ export interface $204 {
517
+ }
518
+ export interface $500 {
519
+ /**
520
+ * example:
521
+ * Unknown API Error
522
+ */
523
+ message?: string;
524
+ }
525
+ }
526
+ }
527
+ namespace GetValidationRuleById {
528
+ namespace Parameters {
529
+ export type RuleId = string;
530
+ }
531
+ export interface PathParameters {
532
+ ruleId: Parameters.RuleId;
533
+ }
534
+ namespace Responses {
535
+ export type $200 = /* The Validation rule definition. */ Components.Schemas.ValidationRule;
536
+ export interface $404 {
537
+ /**
538
+ * example:
539
+ * Validation rule not found
540
+ */
541
+ message?: string;
542
+ }
543
+ export interface $500 {
544
+ /**
545
+ * example:
546
+ * Unknown API Error
547
+ */
548
+ message?: string;
549
+ }
550
+ }
551
+ }
552
+ namespace GetValidationRules {
553
+ namespace Responses {
554
+ export type $200 = Components.Schemas.GetValidationRulesResponse;
555
+ export interface $400 {
556
+ /**
557
+ * example:
558
+ * Invalid request body
559
+ */
560
+ message?: string;
561
+ }
562
+ export interface $500 {
563
+ /**
564
+ * example:
565
+ * Unknown API Error
566
+ */
567
+ message?: string;
568
+ }
569
+ }
570
+ }
571
+ namespace RemoveUsedByReference {
572
+ namespace Parameters {
573
+ export type RuleId = string;
574
+ }
575
+ export interface PathParameters {
576
+ ruleId: Parameters.RuleId;
577
+ }
578
+ export type RequestBody = /* Describes where and how a validation rule is applied. */ Components.Schemas.UsedBy;
579
+ namespace Responses {
580
+ export type $200 = /* The Validation rule definition. */ Components.Schemas.ValidationRule;
581
+ export interface $400 {
582
+ /**
583
+ * example:
584
+ * Invalid request body
585
+ */
586
+ message?: string;
587
+ }
588
+ export interface $404 {
589
+ /**
590
+ * example:
591
+ * Validation rule not found
592
+ */
593
+ message?: string;
594
+ }
595
+ export interface $500 {
596
+ /**
597
+ * example:
598
+ * Unknown API Error
599
+ */
600
+ message?: string;
601
+ }
602
+ }
603
+ }
604
+ namespace UpdateValidationRule {
605
+ namespace Parameters {
606
+ export type RuleId = string;
607
+ }
608
+ export interface PathParameters {
609
+ ruleId: Parameters.RuleId;
610
+ }
611
+ export type RequestBody = Components.Schemas.UpdateValidationRuleRequest;
612
+ namespace Responses {
613
+ export type $200 = /* The Validation rule definition. */ Components.Schemas.ValidationRule;
614
+ export interface $400 {
615
+ /**
616
+ * example:
617
+ * Invalid request body
618
+ */
619
+ message?: string;
620
+ }
621
+ export interface $500 {
622
+ /**
623
+ * example:
624
+ * Unknown API Error
625
+ */
626
+ message?: string;
627
+ }
628
+ }
629
+ }
630
+ }
631
+
632
+
633
+ interface OperationMethods {
634
+ /**
635
+ * getValidationRules - Get all validation rules by organization Id
636
+ *
637
+ * Gets all validation rules by organization Id
638
+ */
639
+ 'getValidationRules'(
640
+ parameters?: Parameters<UnknownParamsObject> | null,
641
+ data?: any,
642
+ config?: AxiosRequestConfig
643
+ ): OperationResponse<Paths.GetValidationRules.Responses.$200>
644
+ /**
645
+ * createValidationRule - Create Validation Rule
646
+ *
647
+ * Creates a new validation rule
648
+ */
649
+ 'createValidationRule'(
650
+ parameters?: Parameters<UnknownParamsObject> | null,
651
+ data?: Paths.CreateValidationRule.RequestBody,
652
+ config?: AxiosRequestConfig
653
+ ): OperationResponse<Paths.CreateValidationRule.Responses.$201>
654
+ /**
655
+ * getValidationRuleById - Get validation rule by ID
656
+ *
657
+ * Retrieves a specific validation rule by its ID
658
+ */
659
+ 'getValidationRuleById'(
660
+ parameters?: Parameters<Paths.GetValidationRuleById.PathParameters> | null,
661
+ data?: any,
662
+ config?: AxiosRequestConfig
663
+ ): OperationResponse<Paths.GetValidationRuleById.Responses.$200>
664
+ /**
665
+ * updateValidationRule - Update Validation Rule (partial update)
666
+ *
667
+ * Updates an existing validation rule partially by ID
668
+ */
669
+ 'updateValidationRule'(
670
+ parameters?: Parameters<Paths.UpdateValidationRule.PathParameters> | null,
671
+ data?: Paths.UpdateValidationRule.RequestBody,
672
+ config?: AxiosRequestConfig
673
+ ): OperationResponse<Paths.UpdateValidationRule.Responses.$200>
674
+ /**
675
+ * deleteValidationRule - Delete Validation Rule
676
+ *
677
+ * Deletes a validation rule by ID
678
+ */
679
+ 'deleteValidationRule'(
680
+ parameters?: Parameters<Paths.DeleteValidationRule.PathParameters> | null,
681
+ data?: any,
682
+ config?: AxiosRequestConfig
683
+ ): OperationResponse<Paths.DeleteValidationRule.Responses.$204>
684
+ /**
685
+ * addUsedByReference - Add a reference to the usedBy array
686
+ *
687
+ * Adds a single reference to the usedBy array of a validation rule
688
+ */
689
+ 'addUsedByReference'(
690
+ parameters?: Parameters<Paths.AddUsedByReference.PathParameters> | null,
691
+ data?: Paths.AddUsedByReference.RequestBody,
692
+ config?: AxiosRequestConfig
693
+ ): OperationResponse<Paths.AddUsedByReference.Responses.$200>
694
+ /**
695
+ * removeUsedByReference - Remove a reference from the usedBy array
696
+ *
697
+ * Removes a specific reference from the usedBy array of a validation rule
698
+ */
699
+ 'removeUsedByReference'(
700
+ parameters?: Parameters<Paths.RemoveUsedByReference.PathParameters> | null,
701
+ data?: Paths.RemoveUsedByReference.RequestBody,
702
+ config?: AxiosRequestConfig
703
+ ): OperationResponse<Paths.RemoveUsedByReference.Responses.$200>
704
+ }
705
+
706
+ interface PathsDictionary {
707
+ ['/v1/validation-rules']: {
708
+ /**
709
+ * getValidationRules - Get all validation rules by organization Id
710
+ *
711
+ * Gets all validation rules by organization Id
712
+ */
713
+ 'get'(
714
+ parameters?: Parameters<UnknownParamsObject> | null,
715
+ data?: any,
716
+ config?: AxiosRequestConfig
717
+ ): OperationResponse<Paths.GetValidationRules.Responses.$200>
718
+ /**
719
+ * createValidationRule - Create Validation Rule
720
+ *
721
+ * Creates a new validation rule
722
+ */
723
+ 'post'(
724
+ parameters?: Parameters<UnknownParamsObject> | null,
725
+ data?: Paths.CreateValidationRule.RequestBody,
726
+ config?: AxiosRequestConfig
727
+ ): OperationResponse<Paths.CreateValidationRule.Responses.$201>
728
+ }
729
+ ['/v1/validation-rules/{ruleId}']: {
730
+ /**
731
+ * getValidationRuleById - Get validation rule by ID
732
+ *
733
+ * Retrieves a specific validation rule by its ID
734
+ */
735
+ 'get'(
736
+ parameters?: Parameters<Paths.GetValidationRuleById.PathParameters> | null,
737
+ data?: any,
738
+ config?: AxiosRequestConfig
739
+ ): OperationResponse<Paths.GetValidationRuleById.Responses.$200>
740
+ /**
741
+ * updateValidationRule - Update Validation Rule (partial update)
742
+ *
743
+ * Updates an existing validation rule partially by ID
744
+ */
745
+ 'patch'(
746
+ parameters?: Parameters<Paths.UpdateValidationRule.PathParameters> | null,
747
+ data?: Paths.UpdateValidationRule.RequestBody,
748
+ config?: AxiosRequestConfig
749
+ ): OperationResponse<Paths.UpdateValidationRule.Responses.$200>
750
+ /**
751
+ * deleteValidationRule - Delete Validation Rule
752
+ *
753
+ * Deletes a validation rule by ID
754
+ */
755
+ 'delete'(
756
+ parameters?: Parameters<Paths.DeleteValidationRule.PathParameters> | null,
757
+ data?: any,
758
+ config?: AxiosRequestConfig
759
+ ): OperationResponse<Paths.DeleteValidationRule.Responses.$204>
760
+ }
761
+ ['/v1/validation-rules/{ruleId}/used-by']: {
762
+ /**
763
+ * addUsedByReference - Add a reference to the usedBy array
764
+ *
765
+ * Adds a single reference to the usedBy array of a validation rule
766
+ */
767
+ 'post'(
768
+ parameters?: Parameters<Paths.AddUsedByReference.PathParameters> | null,
769
+ data?: Paths.AddUsedByReference.RequestBody,
770
+ config?: AxiosRequestConfig
771
+ ): OperationResponse<Paths.AddUsedByReference.Responses.$200>
772
+ /**
773
+ * removeUsedByReference - Remove a reference from the usedBy array
774
+ *
775
+ * Removes a specific reference from the usedBy array of a validation rule
776
+ */
777
+ 'delete'(
778
+ parameters?: Parameters<Paths.RemoveUsedByReference.PathParameters> | null,
779
+ data?: Paths.RemoveUsedByReference.RequestBody,
780
+ config?: AxiosRequestConfig
781
+ ): OperationResponse<Paths.RemoveUsedByReference.Responses.$200>
782
+ }
783
+ }
784
+
785
+ type Client = OpenAPIClient<OperationMethods, PathsDictionary>
786
+
787
+
788
+ type CreateValidationRuleRequest = Components.Schemas.CreateValidationRuleRequest;
789
+ type GetValidationRulesResponse = Components.Schemas.GetValidationRulesResponse;
790
+ type NumericCondition = Components.Schemas.NumericCondition;
791
+ type NumericFactCondition = Components.Schemas.NumericFactCondition;
792
+ type NumericNestedCondition = Components.Schemas.NumericNestedCondition;
793
+ type NumericRuleType = Components.Schemas.NumericRuleType;
794
+ type PatternCondition = Components.Schemas.PatternCondition;
795
+ type PatternFactCondition = Components.Schemas.PatternFactCondition;
796
+ type PatternNestedCondition = Components.Schemas.PatternNestedCondition;
797
+ type PatternRuleType = Components.Schemas.PatternRuleType;
798
+ type RegexCondition = Components.Schemas.RegexCondition;
799
+ type RegexFactCondition = Components.Schemas.RegexFactCondition;
800
+ type RegexNestedCondition = Components.Schemas.RegexNestedCondition;
801
+ type RegexRuleType = Components.Schemas.RegexRuleType;
802
+ type UpdateValidationRuleRequest = Components.Schemas.UpdateValidationRuleRequest;
803
+ type UsedBy = Components.Schemas.UsedBy;
804
+ type ValidationRule = Components.Schemas.ValidationRule;
805
+ type ValidationRuleBase = Components.Schemas.ValidationRuleBase;
806
+
807
+ export { type Client as C, type GetValidationRulesResponse as G, type NumericCondition as N, type OperationMethods as O, Paths as P, type RegexCondition as R, type UpdateValidationRuleRequest as U, type ValidationRule as V, Components as a, type PathsDictionary as b, type CreateValidationRuleRequest as c, type NumericFactCondition as d, type NumericNestedCondition as e, type NumericRuleType as f, type PatternCondition as g, type PatternFactCondition as h, type PatternNestedCondition as i, type PatternRuleType as j, type RegexFactCondition as k, type RegexNestedCondition as l, type RegexRuleType as m, type UsedBy as n, type ValidationRuleBase as o };