@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,2057 @@
1
+ import { OpenAPIClient, Parameters, AxiosRequestConfig, OperationResponse, UnknownParamsObject } from 'openapi-client-axios';
2
+
3
+ /* Auto-copied from targeting-client */
4
+ /* eslint-disable */
5
+
6
+
7
+
8
+ declare namespace Components {
9
+ namespace Parameters {
10
+ export type CampaignIdPathParam = /**
11
+ * example:
12
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
13
+ */
14
+ Schemas.BaseUUID /* uuid */;
15
+ export type RecipientIdPathParam = /**
16
+ * example:
17
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
18
+ */
19
+ Schemas.BaseUUID /* uuid */;
20
+ }
21
+ export interface PathParameters {
22
+ CampaignIdPathParam?: Parameters.CampaignIdPathParam;
23
+ RecipientIdPathParam?: Parameters.RecipientIdPathParam;
24
+ }
25
+ namespace Responses {
26
+ export type CampaignPortalsResponse = {
27
+ portal: {
28
+ /**
29
+ * The origin of the portal
30
+ */
31
+ origin?: string;
32
+ /**
33
+ * The domain of the portal
34
+ */
35
+ domain?: string;
36
+ /**
37
+ * The name of the portal
38
+ */
39
+ name?: string;
40
+ };
41
+ widgets: {
42
+ /**
43
+ * The ID of the widget
44
+ */
45
+ id: string;
46
+ headline?: {
47
+ /**
48
+ * The headline in English
49
+ */
50
+ en?: string;
51
+ /**
52
+ * The headline in German
53
+ */
54
+ de?: string;
55
+ };
56
+ }[];
57
+ }[];
58
+ export interface CampaignResponse {
59
+ campaign?: Schemas.Campaign;
60
+ }
61
+ export type ClientErrorResponse = /**
62
+ * Describes the structure of a client error response, which can be one of several types:
63
+ * 1. `MessageError`: Contains a 'message' field for general descriptive errors.
64
+ * 2. `CodeError`: Contains a 'code' field for specific, machine-readable error codes.
65
+ * 3. `StatusedError`: Contains 'error' and 'status' fields.
66
+ * The HTTP status code of the response itself (e.g., 400, 404, 409) will always indicate the overall error category.
67
+ *
68
+ */
69
+ Schemas.ClientError;
70
+ export interface GetTargetQueriesResponse {
71
+ /**
72
+ * List of target query results.
73
+ */
74
+ results: Schemas.TargetQueryResult[];
75
+ }
76
+ export type JobStatusResponse = Schemas.JobStatus;
77
+ export interface MatchCampaignsResponse {
78
+ /**
79
+ * Number of matching campaigns.
80
+ */
81
+ hits?: number;
82
+ /**
83
+ * List of matching campaigns.
84
+ */
85
+ results?: {
86
+ campaign: Schemas.Campaign;
87
+ }[];
88
+ }
89
+ export interface MatchTargetsResponse {
90
+ /**
91
+ * Number of matching targets.
92
+ */
93
+ hits?: number;
94
+ /**
95
+ * List of matching targets.
96
+ */
97
+ results?: {
98
+ target: Schemas.Target;
99
+ }[];
100
+ }
101
+ export type RecipientResponse = Schemas.Recipient;
102
+ export interface RecipientsResponse {
103
+ results?: Schemas.Recipient[];
104
+ /**
105
+ * Cursor for next page of results
106
+ */
107
+ next?: string | null;
108
+ /**
109
+ * Total number of recipients
110
+ */
111
+ total?: number;
112
+ }
113
+ export interface RetriggerAutomationsResponse {
114
+ /**
115
+ * A confirmation message indicating the request was received and processed
116
+ */
117
+ message: string;
118
+ /**
119
+ * List of retriggering results
120
+ */
121
+ results: Schemas.RetriggerAutomationsResult[];
122
+ }
123
+ export type ServerErrorResponse = Schemas.ServerError;
124
+ }
125
+ namespace Schemas {
126
+ export interface AutomationRecipientPayload {
127
+ automation_status: AutomationStatus;
128
+ automation_execution_id: string;
129
+ }
130
+ export type AutomationStatus = "pending" | "in_progress" | "success" | "failed" | "cancelled";
131
+ /**
132
+ * Access control list (ACL) for an entity. Defines sharing access to external orgs or users.
133
+ */
134
+ export interface BaseEntityAcl {
135
+ [name: string]: any;
136
+ view?: string[];
137
+ edit?: string[];
138
+ delete?: string[];
139
+ }
140
+ /**
141
+ * The user / organization owning this entity.
142
+ *
143
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
144
+ *
145
+ */
146
+ export interface BaseEntityOwner {
147
+ /**
148
+ * example:
149
+ * 123
150
+ */
151
+ org_id: string;
152
+ /**
153
+ * example:
154
+ * 123
155
+ */
156
+ user_id?: string;
157
+ }
158
+ export interface BaseError {
159
+ /**
160
+ * example:
161
+ * 404
162
+ */
163
+ status: number;
164
+ /**
165
+ * example:
166
+ * Entity not found
167
+ */
168
+ message: string;
169
+ }
170
+ /**
171
+ * example:
172
+ * xHcOoJCa07eysJ1GaQeSb
173
+ */
174
+ export type BaseNanoID = string;
175
+ export interface BaseRecipientPayload {
176
+ entity_id: /**
177
+ * example:
178
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
179
+ */
180
+ BaseUUID /* uuid */;
181
+ entity_schema: string;
182
+ }
183
+ export interface BaseRelation {
184
+ $relation?: {
185
+ entity_id?: /**
186
+ * example:
187
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
188
+ */
189
+ BaseUUID /* uuid */;
190
+ _tags?: BaseTags;
191
+ }[];
192
+ }
193
+ export interface BaseSystemFields {
194
+ _id?: /**
195
+ * example:
196
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
197
+ */
198
+ BaseUUID /* uuid */;
199
+ /**
200
+ * Organization Id the entity belongs to
201
+ */
202
+ _org?: string;
203
+ _owners?: /**
204
+ * The user / organization owning this entity.
205
+ *
206
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
207
+ *
208
+ */
209
+ BaseEntityOwner[];
210
+ _schema?: string;
211
+ _title?: string;
212
+ _tags?: BaseTags;
213
+ _created_at?: string; // date-time
214
+ _updated_at?: string; // date-time
215
+ _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ BaseEntityAcl;
216
+ }
217
+ export interface BaseSystemFieldsRequired {
218
+ }
219
+ export interface BaseSystemId {
220
+ _id: /**
221
+ * example:
222
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
223
+ */
224
+ BaseUUID /* uuid */;
225
+ }
226
+ export type BaseTags = string[] | null;
227
+ /**
228
+ * example:
229
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
230
+ */
231
+ export type BaseUUID = string; // uuid
232
+ export interface Campaign {
233
+ _id?: /**
234
+ * example:
235
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
236
+ */
237
+ BaseUUID /* uuid */;
238
+ /**
239
+ * Organization Id the entity belongs to
240
+ */
241
+ _org?: string;
242
+ _owners?: /**
243
+ * The user / organization owning this entity.
244
+ *
245
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
246
+ *
247
+ */
248
+ BaseEntityOwner[];
249
+ _schema?: string;
250
+ _title?: string;
251
+ _tags?: BaseTags;
252
+ _created_at?: string; // date-time
253
+ _updated_at?: string; // date-time
254
+ _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ BaseEntityAcl;
255
+ name?: string;
256
+ goal?: string;
257
+ status?: CampaignStatus;
258
+ start_date?: string; // date
259
+ end_date?: string; // date
260
+ flow_id?: string;
261
+ job_id?: string;
262
+ target?: BaseRelation;
263
+ }
264
+ export type CampaignStatus = "draft" | "activating" | "active" | "inactive";
265
+ /**
266
+ * Describes the structure of a client error response, which can be one of several types:
267
+ * 1. `MessageError`: Contains a 'message' field for general descriptive errors.
268
+ * 2. `CodeError`: Contains a 'code' field for specific, machine-readable error codes.
269
+ * 3. `StatusedError`: Contains 'error' and 'status' fields.
270
+ * The HTTP status code of the response itself (e.g., 400, 404, 409) will always indicate the overall error category.
271
+ *
272
+ */
273
+ export type ClientError = /**
274
+ * Describes the structure of a client error response, which can be one of several types:
275
+ * 1. `MessageError`: Contains a 'message' field for general descriptive errors.
276
+ * 2. `CodeError`: Contains a 'code' field for specific, machine-readable error codes.
277
+ * 3. `StatusedError`: Contains 'error' and 'status' fields.
278
+ * The HTTP status code of the response itself (e.g., 400, 404, 409) will always indicate the overall error category.
279
+ *
280
+ */
281
+ {
282
+ /**
283
+ * A descriptive error message.
284
+ * example:
285
+ * The provided input was invalid.
286
+ */
287
+ message: string;
288
+ } | {
289
+ /**
290
+ * A specific machine-readable error code indicating a known error condition.
291
+ * example:
292
+ * CAMPAIGN_NOT_FOUND
293
+ */
294
+ code: "CAMPAIGN_NOT_FOUND" | "CAMPAIGN_HAS_NO_TARGET" | "CAMPAIGN_HAS_NO_DELIVERY_METHOD" | "CAMPAIGN_HAS_JOB_IN_PROGRESS" | "CAMPAIGN_HAS_UNEXPECTED_STATUS" | "JOB_TOKEN_MISSING" | "TARGET_WITHOUT_FILTERS";
295
+ } | {
296
+ /**
297
+ * A descriptive error message.
298
+ * example:
299
+ * An unexpected error occurred during processing.
300
+ */
301
+ error: string;
302
+ /**
303
+ * An explicit status code in the body, often mirroring the HTTP status but provided for programmatic access.
304
+ * example:
305
+ * 400
306
+ */
307
+ status: number;
308
+ };
309
+ export type CreateRecipientPayload = {
310
+ entity_id: /**
311
+ * example:
312
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
313
+ */
314
+ BaseUUID /* uuid */;
315
+ entity_schema: string;
316
+ automation_status: AutomationStatus;
317
+ automation_execution_id: string;
318
+ } | {
319
+ entity_id: /**
320
+ * example:
321
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
322
+ */
323
+ BaseUUID /* uuid */;
324
+ entity_schema: string;
325
+ portal_status: PortalStatus;
326
+ portal_state?: {
327
+ [name: string]: any;
328
+ };
329
+ } | {
330
+ entity_id: /**
331
+ * example:
332
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
333
+ */
334
+ BaseUUID /* uuid */;
335
+ entity_schema: string;
336
+ automation_status: AutomationStatus;
337
+ automation_execution_id: string;
338
+ portal_status: PortalStatus;
339
+ portal_state?: {
340
+ [name: string]: any;
341
+ };
342
+ };
343
+ export interface ExecutionSummaryItem {
344
+ execution_id?: string;
345
+ execution_status?: string;
346
+ }
347
+ export interface GetTargetQueriesParams {
348
+ /**
349
+ * List of target IDs to transform into queries.
350
+ * example:
351
+ * [
352
+ * "b8c01433-5556-4e2b-aad4-6f5348d1df84"
353
+ * ]
354
+ */
355
+ target_ids: [
356
+ /**
357
+ * example:
358
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
359
+ */
360
+ BaseUUID /* uuid */,
361
+ .../**
362
+ * example:
363
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
364
+ */
365
+ BaseUUID /* uuid */[]
366
+ ];
367
+ }
368
+ export interface JobStatus {
369
+ /**
370
+ * The status of the automation job
371
+ */
372
+ status?: "queued" | "processing" | "finished" | "failed" | "cancelled" | "send_report";
373
+ execution_summary?: ExecutionSummaryItem[];
374
+ }
375
+ export interface MatchCampaignParams {
376
+ /**
377
+ * List of entities (e.g. Contacts or Contracts) that should be part of the campaign target.
378
+ */
379
+ entity_refs: {
380
+ entity_id: /**
381
+ * example:
382
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
383
+ */
384
+ BaseUUID /* uuid */;
385
+ entity_schema: string;
386
+ }[];
387
+ /**
388
+ * List of campaign IDs to check.
389
+ * example:
390
+ * [
391
+ * "b8c01433-5556-4e2b-aad4-6f5348d1df84"
392
+ * ]
393
+ */
394
+ campaign_ids: [
395
+ /**
396
+ * example:
397
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
398
+ */
399
+ BaseUUID /* uuid */,
400
+ /**
401
+ * example:
402
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
403
+ */
404
+ BaseUUID /* uuid */?,
405
+ /**
406
+ * example:
407
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
408
+ */
409
+ BaseUUID /* uuid */?,
410
+ /**
411
+ * example:
412
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
413
+ */
414
+ BaseUUID /* uuid */?,
415
+ /**
416
+ * example:
417
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
418
+ */
419
+ BaseUUID /* uuid */?,
420
+ /**
421
+ * example:
422
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
423
+ */
424
+ BaseUUID /* uuid */?,
425
+ /**
426
+ * example:
427
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
428
+ */
429
+ BaseUUID /* uuid */?,
430
+ /**
431
+ * example:
432
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
433
+ */
434
+ BaseUUID /* uuid */?,
435
+ /**
436
+ * example:
437
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
438
+ */
439
+ BaseUUID /* uuid */?,
440
+ /**
441
+ * example:
442
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
443
+ */
444
+ BaseUUID /* uuid */?,
445
+ /**
446
+ * example:
447
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
448
+ */
449
+ BaseUUID /* uuid */?,
450
+ /**
451
+ * example:
452
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
453
+ */
454
+ BaseUUID /* uuid */?,
455
+ /**
456
+ * example:
457
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
458
+ */
459
+ BaseUUID /* uuid */?,
460
+ /**
461
+ * example:
462
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
463
+ */
464
+ BaseUUID /* uuid */?,
465
+ /**
466
+ * example:
467
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
468
+ */
469
+ BaseUUID /* uuid */?,
470
+ /**
471
+ * example:
472
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
473
+ */
474
+ BaseUUID /* uuid */?,
475
+ /**
476
+ * example:
477
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
478
+ */
479
+ BaseUUID /* uuid */?,
480
+ /**
481
+ * example:
482
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
483
+ */
484
+ BaseUUID /* uuid */?,
485
+ /**
486
+ * example:
487
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
488
+ */
489
+ BaseUUID /* uuid */?,
490
+ /**
491
+ * example:
492
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
493
+ */
494
+ BaseUUID /* uuid */?,
495
+ /**
496
+ * example:
497
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
498
+ */
499
+ BaseUUID /* uuid */?,
500
+ /**
501
+ * example:
502
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
503
+ */
504
+ BaseUUID /* uuid */?,
505
+ /**
506
+ * example:
507
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
508
+ */
509
+ BaseUUID /* uuid */?,
510
+ /**
511
+ * example:
512
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
513
+ */
514
+ BaseUUID /* uuid */?,
515
+ /**
516
+ * example:
517
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
518
+ */
519
+ BaseUUID /* uuid */?,
520
+ /**
521
+ * example:
522
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
523
+ */
524
+ BaseUUID /* uuid */?,
525
+ /**
526
+ * example:
527
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
528
+ */
529
+ BaseUUID /* uuid */?,
530
+ /**
531
+ * example:
532
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
533
+ */
534
+ BaseUUID /* uuid */?,
535
+ /**
536
+ * example:
537
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
538
+ */
539
+ BaseUUID /* uuid */?,
540
+ /**
541
+ * example:
542
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
543
+ */
544
+ BaseUUID /* uuid */?,
545
+ /**
546
+ * example:
547
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
548
+ */
549
+ BaseUUID /* uuid */?,
550
+ /**
551
+ * example:
552
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
553
+ */
554
+ BaseUUID /* uuid */?,
555
+ /**
556
+ * example:
557
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
558
+ */
559
+ BaseUUID /* uuid */?,
560
+ /**
561
+ * example:
562
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
563
+ */
564
+ BaseUUID /* uuid */?,
565
+ /**
566
+ * example:
567
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
568
+ */
569
+ BaseUUID /* uuid */?,
570
+ /**
571
+ * example:
572
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
573
+ */
574
+ BaseUUID /* uuid */?,
575
+ /**
576
+ * example:
577
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
578
+ */
579
+ BaseUUID /* uuid */?,
580
+ /**
581
+ * example:
582
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
583
+ */
584
+ BaseUUID /* uuid */?,
585
+ /**
586
+ * example:
587
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
588
+ */
589
+ BaseUUID /* uuid */?,
590
+ /**
591
+ * example:
592
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
593
+ */
594
+ BaseUUID /* uuid */?,
595
+ /**
596
+ * example:
597
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
598
+ */
599
+ BaseUUID /* uuid */?,
600
+ /**
601
+ * example:
602
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
603
+ */
604
+ BaseUUID /* uuid */?,
605
+ /**
606
+ * example:
607
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
608
+ */
609
+ BaseUUID /* uuid */?,
610
+ /**
611
+ * example:
612
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
613
+ */
614
+ BaseUUID /* uuid */?,
615
+ /**
616
+ * example:
617
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
618
+ */
619
+ BaseUUID /* uuid */?,
620
+ /**
621
+ * example:
622
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
623
+ */
624
+ BaseUUID /* uuid */?,
625
+ /**
626
+ * example:
627
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
628
+ */
629
+ BaseUUID /* uuid */?,
630
+ /**
631
+ * example:
632
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
633
+ */
634
+ BaseUUID /* uuid */?,
635
+ /**
636
+ * example:
637
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
638
+ */
639
+ BaseUUID /* uuid */?,
640
+ /**
641
+ * example:
642
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
643
+ */
644
+ BaseUUID /* uuid */?,
645
+ /**
646
+ * example:
647
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
648
+ */
649
+ BaseUUID /* uuid */?,
650
+ /**
651
+ * example:
652
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
653
+ */
654
+ BaseUUID /* uuid */?,
655
+ /**
656
+ * example:
657
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
658
+ */
659
+ BaseUUID /* uuid */?,
660
+ /**
661
+ * example:
662
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
663
+ */
664
+ BaseUUID /* uuid */?,
665
+ /**
666
+ * example:
667
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
668
+ */
669
+ BaseUUID /* uuid */?,
670
+ /**
671
+ * example:
672
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
673
+ */
674
+ BaseUUID /* uuid */?,
675
+ /**
676
+ * example:
677
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
678
+ */
679
+ BaseUUID /* uuid */?,
680
+ /**
681
+ * example:
682
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
683
+ */
684
+ BaseUUID /* uuid */?,
685
+ /**
686
+ * example:
687
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
688
+ */
689
+ BaseUUID /* uuid */?,
690
+ /**
691
+ * example:
692
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
693
+ */
694
+ BaseUUID /* uuid */?,
695
+ /**
696
+ * example:
697
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
698
+ */
699
+ BaseUUID /* uuid */?,
700
+ /**
701
+ * example:
702
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
703
+ */
704
+ BaseUUID /* uuid */?,
705
+ /**
706
+ * example:
707
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
708
+ */
709
+ BaseUUID /* uuid */?,
710
+ /**
711
+ * example:
712
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
713
+ */
714
+ BaseUUID /* uuid */?,
715
+ /**
716
+ * example:
717
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
718
+ */
719
+ BaseUUID /* uuid */?,
720
+ /**
721
+ * example:
722
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
723
+ */
724
+ BaseUUID /* uuid */?,
725
+ /**
726
+ * example:
727
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
728
+ */
729
+ BaseUUID /* uuid */?,
730
+ /**
731
+ * example:
732
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
733
+ */
734
+ BaseUUID /* uuid */?,
735
+ /**
736
+ * example:
737
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
738
+ */
739
+ BaseUUID /* uuid */?,
740
+ /**
741
+ * example:
742
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
743
+ */
744
+ BaseUUID /* uuid */?,
745
+ /**
746
+ * example:
747
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
748
+ */
749
+ BaseUUID /* uuid */?,
750
+ /**
751
+ * example:
752
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
753
+ */
754
+ BaseUUID /* uuid */?,
755
+ /**
756
+ * example:
757
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
758
+ */
759
+ BaseUUID /* uuid */?,
760
+ /**
761
+ * example:
762
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
763
+ */
764
+ BaseUUID /* uuid */?,
765
+ /**
766
+ * example:
767
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
768
+ */
769
+ BaseUUID /* uuid */?,
770
+ /**
771
+ * example:
772
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
773
+ */
774
+ BaseUUID /* uuid */?,
775
+ /**
776
+ * example:
777
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
778
+ */
779
+ BaseUUID /* uuid */?,
780
+ /**
781
+ * example:
782
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
783
+ */
784
+ BaseUUID /* uuid */?,
785
+ /**
786
+ * example:
787
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
788
+ */
789
+ BaseUUID /* uuid */?,
790
+ /**
791
+ * example:
792
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
793
+ */
794
+ BaseUUID /* uuid */?,
795
+ /**
796
+ * example:
797
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
798
+ */
799
+ BaseUUID /* uuid */?,
800
+ /**
801
+ * example:
802
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
803
+ */
804
+ BaseUUID /* uuid */?,
805
+ /**
806
+ * example:
807
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
808
+ */
809
+ BaseUUID /* uuid */?,
810
+ /**
811
+ * example:
812
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
813
+ */
814
+ BaseUUID /* uuid */?,
815
+ /**
816
+ * example:
817
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
818
+ */
819
+ BaseUUID /* uuid */?,
820
+ /**
821
+ * example:
822
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
823
+ */
824
+ BaseUUID /* uuid */?,
825
+ /**
826
+ * example:
827
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
828
+ */
829
+ BaseUUID /* uuid */?,
830
+ /**
831
+ * example:
832
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
833
+ */
834
+ BaseUUID /* uuid */?,
835
+ /**
836
+ * example:
837
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
838
+ */
839
+ BaseUUID /* uuid */?,
840
+ /**
841
+ * example:
842
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
843
+ */
844
+ BaseUUID /* uuid */?,
845
+ /**
846
+ * example:
847
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
848
+ */
849
+ BaseUUID /* uuid */?,
850
+ /**
851
+ * example:
852
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
853
+ */
854
+ BaseUUID /* uuid */?,
855
+ /**
856
+ * example:
857
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
858
+ */
859
+ BaseUUID /* uuid */?,
860
+ /**
861
+ * example:
862
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
863
+ */
864
+ BaseUUID /* uuid */?,
865
+ /**
866
+ * example:
867
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
868
+ */
869
+ BaseUUID /* uuid */?,
870
+ /**
871
+ * example:
872
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
873
+ */
874
+ BaseUUID /* uuid */?,
875
+ /**
876
+ * example:
877
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
878
+ */
879
+ BaseUUID /* uuid */?,
880
+ /**
881
+ * example:
882
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
883
+ */
884
+ BaseUUID /* uuid */?,
885
+ /**
886
+ * example:
887
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
888
+ */
889
+ BaseUUID /* uuid */?,
890
+ /**
891
+ * example:
892
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
893
+ */
894
+ BaseUUID /* uuid */?
895
+ ];
896
+ }
897
+ export interface MatchTargetParams {
898
+ /**
899
+ * List of entities (e.g. Contacts or Contracts) that should be part of the targets.
900
+ */
901
+ entity_refs: {
902
+ entity_id: /**
903
+ * example:
904
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
905
+ */
906
+ BaseUUID /* uuid */;
907
+ entity_schema: string;
908
+ }[];
909
+ /**
910
+ * List of target IDs to check.
911
+ * example:
912
+ * [
913
+ * "b8c01433-5556-4e2b-aad4-6f5348d1df84"
914
+ * ]
915
+ */
916
+ target_ids: [
917
+ /**
918
+ * example:
919
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
920
+ */
921
+ BaseUUID /* uuid */,
922
+ /**
923
+ * example:
924
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
925
+ */
926
+ BaseUUID /* uuid */?,
927
+ /**
928
+ * example:
929
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
930
+ */
931
+ BaseUUID /* uuid */?,
932
+ /**
933
+ * example:
934
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
935
+ */
936
+ BaseUUID /* uuid */?,
937
+ /**
938
+ * example:
939
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
940
+ */
941
+ BaseUUID /* uuid */?,
942
+ /**
943
+ * example:
944
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
945
+ */
946
+ BaseUUID /* uuid */?,
947
+ /**
948
+ * example:
949
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
950
+ */
951
+ BaseUUID /* uuid */?,
952
+ /**
953
+ * example:
954
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
955
+ */
956
+ BaseUUID /* uuid */?,
957
+ /**
958
+ * example:
959
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
960
+ */
961
+ BaseUUID /* uuid */?,
962
+ /**
963
+ * example:
964
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
965
+ */
966
+ BaseUUID /* uuid */?,
967
+ /**
968
+ * example:
969
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
970
+ */
971
+ BaseUUID /* uuid */?,
972
+ /**
973
+ * example:
974
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
975
+ */
976
+ BaseUUID /* uuid */?,
977
+ /**
978
+ * example:
979
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
980
+ */
981
+ BaseUUID /* uuid */?,
982
+ /**
983
+ * example:
984
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
985
+ */
986
+ BaseUUID /* uuid */?,
987
+ /**
988
+ * example:
989
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
990
+ */
991
+ BaseUUID /* uuid */?,
992
+ /**
993
+ * example:
994
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
995
+ */
996
+ BaseUUID /* uuid */?,
997
+ /**
998
+ * example:
999
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1000
+ */
1001
+ BaseUUID /* uuid */?,
1002
+ /**
1003
+ * example:
1004
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1005
+ */
1006
+ BaseUUID /* uuid */?,
1007
+ /**
1008
+ * example:
1009
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1010
+ */
1011
+ BaseUUID /* uuid */?,
1012
+ /**
1013
+ * example:
1014
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1015
+ */
1016
+ BaseUUID /* uuid */?,
1017
+ /**
1018
+ * example:
1019
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1020
+ */
1021
+ BaseUUID /* uuid */?,
1022
+ /**
1023
+ * example:
1024
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1025
+ */
1026
+ BaseUUID /* uuid */?,
1027
+ /**
1028
+ * example:
1029
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1030
+ */
1031
+ BaseUUID /* uuid */?,
1032
+ /**
1033
+ * example:
1034
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1035
+ */
1036
+ BaseUUID /* uuid */?,
1037
+ /**
1038
+ * example:
1039
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1040
+ */
1041
+ BaseUUID /* uuid */?,
1042
+ /**
1043
+ * example:
1044
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1045
+ */
1046
+ BaseUUID /* uuid */?,
1047
+ /**
1048
+ * example:
1049
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1050
+ */
1051
+ BaseUUID /* uuid */?,
1052
+ /**
1053
+ * example:
1054
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1055
+ */
1056
+ BaseUUID /* uuid */?,
1057
+ /**
1058
+ * example:
1059
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1060
+ */
1061
+ BaseUUID /* uuid */?,
1062
+ /**
1063
+ * example:
1064
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1065
+ */
1066
+ BaseUUID /* uuid */?,
1067
+ /**
1068
+ * example:
1069
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1070
+ */
1071
+ BaseUUID /* uuid */?,
1072
+ /**
1073
+ * example:
1074
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1075
+ */
1076
+ BaseUUID /* uuid */?,
1077
+ /**
1078
+ * example:
1079
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1080
+ */
1081
+ BaseUUID /* uuid */?,
1082
+ /**
1083
+ * example:
1084
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1085
+ */
1086
+ BaseUUID /* uuid */?,
1087
+ /**
1088
+ * example:
1089
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1090
+ */
1091
+ BaseUUID /* uuid */?,
1092
+ /**
1093
+ * example:
1094
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1095
+ */
1096
+ BaseUUID /* uuid */?,
1097
+ /**
1098
+ * example:
1099
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1100
+ */
1101
+ BaseUUID /* uuid */?,
1102
+ /**
1103
+ * example:
1104
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1105
+ */
1106
+ BaseUUID /* uuid */?,
1107
+ /**
1108
+ * example:
1109
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1110
+ */
1111
+ BaseUUID /* uuid */?,
1112
+ /**
1113
+ * example:
1114
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1115
+ */
1116
+ BaseUUID /* uuid */?,
1117
+ /**
1118
+ * example:
1119
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1120
+ */
1121
+ BaseUUID /* uuid */?,
1122
+ /**
1123
+ * example:
1124
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1125
+ */
1126
+ BaseUUID /* uuid */?,
1127
+ /**
1128
+ * example:
1129
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1130
+ */
1131
+ BaseUUID /* uuid */?,
1132
+ /**
1133
+ * example:
1134
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1135
+ */
1136
+ BaseUUID /* uuid */?,
1137
+ /**
1138
+ * example:
1139
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1140
+ */
1141
+ BaseUUID /* uuid */?,
1142
+ /**
1143
+ * example:
1144
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1145
+ */
1146
+ BaseUUID /* uuid */?,
1147
+ /**
1148
+ * example:
1149
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1150
+ */
1151
+ BaseUUID /* uuid */?,
1152
+ /**
1153
+ * example:
1154
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1155
+ */
1156
+ BaseUUID /* uuid */?,
1157
+ /**
1158
+ * example:
1159
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1160
+ */
1161
+ BaseUUID /* uuid */?,
1162
+ /**
1163
+ * example:
1164
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1165
+ */
1166
+ BaseUUID /* uuid */?,
1167
+ /**
1168
+ * example:
1169
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1170
+ */
1171
+ BaseUUID /* uuid */?,
1172
+ /**
1173
+ * example:
1174
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1175
+ */
1176
+ BaseUUID /* uuid */?,
1177
+ /**
1178
+ * example:
1179
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1180
+ */
1181
+ BaseUUID /* uuid */?,
1182
+ /**
1183
+ * example:
1184
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1185
+ */
1186
+ BaseUUID /* uuid */?,
1187
+ /**
1188
+ * example:
1189
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1190
+ */
1191
+ BaseUUID /* uuid */?,
1192
+ /**
1193
+ * example:
1194
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1195
+ */
1196
+ BaseUUID /* uuid */?,
1197
+ /**
1198
+ * example:
1199
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1200
+ */
1201
+ BaseUUID /* uuid */?,
1202
+ /**
1203
+ * example:
1204
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1205
+ */
1206
+ BaseUUID /* uuid */?,
1207
+ /**
1208
+ * example:
1209
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1210
+ */
1211
+ BaseUUID /* uuid */?,
1212
+ /**
1213
+ * example:
1214
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1215
+ */
1216
+ BaseUUID /* uuid */?,
1217
+ /**
1218
+ * example:
1219
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1220
+ */
1221
+ BaseUUID /* uuid */?,
1222
+ /**
1223
+ * example:
1224
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1225
+ */
1226
+ BaseUUID /* uuid */?,
1227
+ /**
1228
+ * example:
1229
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1230
+ */
1231
+ BaseUUID /* uuid */?,
1232
+ /**
1233
+ * example:
1234
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1235
+ */
1236
+ BaseUUID /* uuid */?,
1237
+ /**
1238
+ * example:
1239
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1240
+ */
1241
+ BaseUUID /* uuid */?,
1242
+ /**
1243
+ * example:
1244
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1245
+ */
1246
+ BaseUUID /* uuid */?,
1247
+ /**
1248
+ * example:
1249
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1250
+ */
1251
+ BaseUUID /* uuid */?,
1252
+ /**
1253
+ * example:
1254
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1255
+ */
1256
+ BaseUUID /* uuid */?,
1257
+ /**
1258
+ * example:
1259
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1260
+ */
1261
+ BaseUUID /* uuid */?,
1262
+ /**
1263
+ * example:
1264
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1265
+ */
1266
+ BaseUUID /* uuid */?,
1267
+ /**
1268
+ * example:
1269
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1270
+ */
1271
+ BaseUUID /* uuid */?,
1272
+ /**
1273
+ * example:
1274
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1275
+ */
1276
+ BaseUUID /* uuid */?,
1277
+ /**
1278
+ * example:
1279
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1280
+ */
1281
+ BaseUUID /* uuid */?,
1282
+ /**
1283
+ * example:
1284
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1285
+ */
1286
+ BaseUUID /* uuid */?,
1287
+ /**
1288
+ * example:
1289
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1290
+ */
1291
+ BaseUUID /* uuid */?,
1292
+ /**
1293
+ * example:
1294
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1295
+ */
1296
+ BaseUUID /* uuid */?,
1297
+ /**
1298
+ * example:
1299
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1300
+ */
1301
+ BaseUUID /* uuid */?,
1302
+ /**
1303
+ * example:
1304
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1305
+ */
1306
+ BaseUUID /* uuid */?,
1307
+ /**
1308
+ * example:
1309
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1310
+ */
1311
+ BaseUUID /* uuid */?,
1312
+ /**
1313
+ * example:
1314
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1315
+ */
1316
+ BaseUUID /* uuid */?,
1317
+ /**
1318
+ * example:
1319
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1320
+ */
1321
+ BaseUUID /* uuid */?,
1322
+ /**
1323
+ * example:
1324
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1325
+ */
1326
+ BaseUUID /* uuid */?,
1327
+ /**
1328
+ * example:
1329
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1330
+ */
1331
+ BaseUUID /* uuid */?,
1332
+ /**
1333
+ * example:
1334
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1335
+ */
1336
+ BaseUUID /* uuid */?,
1337
+ /**
1338
+ * example:
1339
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1340
+ */
1341
+ BaseUUID /* uuid */?,
1342
+ /**
1343
+ * example:
1344
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1345
+ */
1346
+ BaseUUID /* uuid */?,
1347
+ /**
1348
+ * example:
1349
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1350
+ */
1351
+ BaseUUID /* uuid */?,
1352
+ /**
1353
+ * example:
1354
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1355
+ */
1356
+ BaseUUID /* uuid */?,
1357
+ /**
1358
+ * example:
1359
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1360
+ */
1361
+ BaseUUID /* uuid */?,
1362
+ /**
1363
+ * example:
1364
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1365
+ */
1366
+ BaseUUID /* uuid */?,
1367
+ /**
1368
+ * example:
1369
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1370
+ */
1371
+ BaseUUID /* uuid */?,
1372
+ /**
1373
+ * example:
1374
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1375
+ */
1376
+ BaseUUID /* uuid */?,
1377
+ /**
1378
+ * example:
1379
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1380
+ */
1381
+ BaseUUID /* uuid */?,
1382
+ /**
1383
+ * example:
1384
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1385
+ */
1386
+ BaseUUID /* uuid */?,
1387
+ /**
1388
+ * example:
1389
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1390
+ */
1391
+ BaseUUID /* uuid */?,
1392
+ /**
1393
+ * example:
1394
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1395
+ */
1396
+ BaseUUID /* uuid */?,
1397
+ /**
1398
+ * example:
1399
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1400
+ */
1401
+ BaseUUID /* uuid */?,
1402
+ /**
1403
+ * example:
1404
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1405
+ */
1406
+ BaseUUID /* uuid */?,
1407
+ /**
1408
+ * example:
1409
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1410
+ */
1411
+ BaseUUID /* uuid */?,
1412
+ /**
1413
+ * example:
1414
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1415
+ */
1416
+ BaseUUID /* uuid */?
1417
+ ];
1418
+ }
1419
+ export interface PortalRecipientPayload {
1420
+ portal_status: PortalStatus;
1421
+ portal_state?: {
1422
+ [name: string]: any;
1423
+ };
1424
+ }
1425
+ export type PortalStatus = "sent" | "seen" | "dismissed" | "clicked";
1426
+ export interface Recipient {
1427
+ entity_id?: /**
1428
+ * example:
1429
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1430
+ */
1431
+ BaseUUID /* uuid */;
1432
+ entity_schema?: string;
1433
+ title?: string;
1434
+ automation_status?: AutomationStatus;
1435
+ automation_execution_id?: string;
1436
+ portal_status?: PortalStatus;
1437
+ portal_status_updated_at?: string; // date-time
1438
+ portal_state?: {
1439
+ [name: string]: any;
1440
+ };
1441
+ updated_at?: string; // date-time
1442
+ }
1443
+ export interface RetriggerAutomationsRequest {
1444
+ /**
1445
+ * List of recipient IDs to retrigger automations for
1446
+ */
1447
+ recipient_ids: string /* uuid */[];
1448
+ }
1449
+ export interface RetriggerAutomationsResult {
1450
+ /**
1451
+ * The ID of the recipient
1452
+ */
1453
+ recipient_id: string; // uuid
1454
+ /**
1455
+ * The result of the retriggering operation
1456
+ */
1457
+ result: "success" | "failure" | "not_found" | "invalid_status";
1458
+ /**
1459
+ * The ID of the new automation execution (if successful)
1460
+ */
1461
+ execution_id?: string;
1462
+ /**
1463
+ * The error message if the operation failed
1464
+ */
1465
+ error?: string;
1466
+ }
1467
+ export type ServerError = BaseError;
1468
+ export interface Target {
1469
+ _id?: /**
1470
+ * example:
1471
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1472
+ */
1473
+ BaseUUID /* uuid */;
1474
+ /**
1475
+ * Organization Id the entity belongs to
1476
+ */
1477
+ _org?: string;
1478
+ _owners?: /**
1479
+ * The user / organization owning this entity.
1480
+ *
1481
+ * Note: Owner implicitly has access to the entity regardless of ACLs.
1482
+ *
1483
+ */
1484
+ BaseEntityOwner[];
1485
+ _schema?: string;
1486
+ _title?: string;
1487
+ _tags?: BaseTags;
1488
+ _created_at?: string; // date-time
1489
+ _updated_at?: string; // date-time
1490
+ _acl?: /* Access control list (ACL) for an entity. Defines sharing access to external orgs or users. */ BaseEntityAcl;
1491
+ name?: string;
1492
+ description?: string;
1493
+ entity_schema?: string;
1494
+ entity_filters?: {
1495
+ [name: string]: any;
1496
+ };
1497
+ }
1498
+ export interface TargetQueryResult {
1499
+ target_id: /**
1500
+ * example:
1501
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1502
+ */
1503
+ BaseUUID /* uuid */;
1504
+ /**
1505
+ * Transformed query string, or null if transformation failed.
1506
+ */
1507
+ query: string | null;
1508
+ /**
1509
+ * Error message if query transformation failed.
1510
+ */
1511
+ error?: string;
1512
+ }
1513
+ export interface UpdatePortalStatusRequest {
1514
+ status: PortalStatus;
1515
+ }
1516
+ export interface UpdateRecipientPayload {
1517
+ automation_status?: AutomationStatus;
1518
+ automation_execution_id?: string;
1519
+ portal_status?: PortalStatus;
1520
+ portal_state?: {
1521
+ [name: string]: any;
1522
+ };
1523
+ }
1524
+ }
1525
+ }
1526
+ declare namespace Paths {
1527
+ namespace ChangeCampaignStatus {
1528
+ namespace Parameters {
1529
+ export type CampaignId = /**
1530
+ * example:
1531
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1532
+ */
1533
+ Components.Schemas.BaseUUID /* uuid */;
1534
+ }
1535
+ export interface PathParameters {
1536
+ campaign_id: Parameters.CampaignId;
1537
+ }
1538
+ namespace Responses {
1539
+ export type $200 = Components.Responses.CampaignResponse;
1540
+ export type $400 = Components.Responses.ClientErrorResponse;
1541
+ export type $500 = Components.Responses.ServerErrorResponse;
1542
+ }
1543
+ }
1544
+ namespace CreateRecipient {
1545
+ namespace Parameters {
1546
+ export type CampaignId = /**
1547
+ * example:
1548
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1549
+ */
1550
+ Components.Schemas.BaseUUID /* uuid */;
1551
+ }
1552
+ export interface PathParameters {
1553
+ campaign_id: Parameters.CampaignId;
1554
+ }
1555
+ export type RequestBody = Components.Schemas.CreateRecipientPayload;
1556
+ namespace Responses {
1557
+ export type $201 = Components.Responses.RecipientResponse;
1558
+ export type $400 = Components.Responses.ClientErrorResponse;
1559
+ export type $500 = Components.Responses.ServerErrorResponse;
1560
+ }
1561
+ }
1562
+ namespace GetCampaignJobStatus {
1563
+ namespace Parameters {
1564
+ export type CampaignId = /**
1565
+ * example:
1566
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1567
+ */
1568
+ Components.Schemas.BaseUUID /* uuid */;
1569
+ }
1570
+ export interface PathParameters {
1571
+ campaign_id: Parameters.CampaignId;
1572
+ }
1573
+ namespace Responses {
1574
+ export type $200 = Components.Responses.JobStatusResponse;
1575
+ export type $400 = Components.Responses.ClientErrorResponse;
1576
+ export type $500 = Components.Responses.ServerErrorResponse;
1577
+ }
1578
+ }
1579
+ namespace GetCampaignPortals {
1580
+ namespace Parameters {
1581
+ export type CampaignId = /**
1582
+ * example:
1583
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1584
+ */
1585
+ Components.Schemas.BaseUUID /* uuid */;
1586
+ }
1587
+ export interface PathParameters {
1588
+ campaign_id: Parameters.CampaignId;
1589
+ }
1590
+ namespace Responses {
1591
+ export type $200 = Components.Responses.CampaignPortalsResponse;
1592
+ export type $400 = Components.Responses.ClientErrorResponse;
1593
+ export type $500 = Components.Responses.ServerErrorResponse;
1594
+ }
1595
+ }
1596
+ namespace GetRecipients {
1597
+ namespace Parameters {
1598
+ export type AutomationStatus = Components.Schemas.AutomationStatus;
1599
+ export type CampaignId = /**
1600
+ * example:
1601
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1602
+ */
1603
+ Components.Schemas.BaseUUID /* uuid */;
1604
+ export type Limit = number;
1605
+ export type Next = string;
1606
+ export type PortalStatus = Components.Schemas.PortalStatus;
1607
+ export type Q = string;
1608
+ }
1609
+ export interface PathParameters {
1610
+ campaign_id: Parameters.CampaignId;
1611
+ }
1612
+ export interface QueryParameters {
1613
+ limit?: Parameters.Limit;
1614
+ next?: Parameters.Next;
1615
+ q?: Parameters.Q;
1616
+ automation_status?: Parameters.AutomationStatus;
1617
+ portal_status?: Parameters.PortalStatus;
1618
+ }
1619
+ namespace Responses {
1620
+ export type $200 = Components.Responses.RecipientsResponse;
1621
+ export type $400 = Components.Responses.ClientErrorResponse;
1622
+ export type $500 = Components.Responses.ServerErrorResponse;
1623
+ }
1624
+ }
1625
+ namespace GetTargetQueries {
1626
+ export type RequestBody = Components.Schemas.GetTargetQueriesParams;
1627
+ namespace Responses {
1628
+ export type $200 = Components.Responses.GetTargetQueriesResponse;
1629
+ export type $400 = Components.Responses.ClientErrorResponse;
1630
+ export type $500 = Components.Responses.ServerErrorResponse;
1631
+ }
1632
+ }
1633
+ namespace MatchCampaigns {
1634
+ export type RequestBody = Components.Schemas.MatchCampaignParams;
1635
+ namespace Responses {
1636
+ export type $200 = Components.Responses.MatchCampaignsResponse;
1637
+ export type $400 = Components.Responses.ClientErrorResponse;
1638
+ export type $500 = Components.Responses.ServerErrorResponse;
1639
+ }
1640
+ }
1641
+ namespace MatchTargets {
1642
+ export type RequestBody = Components.Schemas.MatchTargetParams;
1643
+ namespace Responses {
1644
+ export type $200 = Components.Responses.MatchTargetsResponse;
1645
+ export type $400 = Components.Responses.ClientErrorResponse;
1646
+ export type $500 = Components.Responses.ServerErrorResponse;
1647
+ }
1648
+ }
1649
+ namespace RetriggerCampaignAutomations {
1650
+ namespace Parameters {
1651
+ export type CampaignId = /**
1652
+ * example:
1653
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1654
+ */
1655
+ Components.Schemas.BaseUUID /* uuid */;
1656
+ }
1657
+ export interface PathParameters {
1658
+ campaign_id: Parameters.CampaignId;
1659
+ }
1660
+ export type RequestBody = Components.Schemas.RetriggerAutomationsRequest;
1661
+ namespace Responses {
1662
+ export type $200 = Components.Responses.RetriggerAutomationsResponse;
1663
+ export type $400 = Components.Responses.ClientErrorResponse;
1664
+ export type $404 = Components.Responses.ServerErrorResponse;
1665
+ export type $500 = Components.Responses.ServerErrorResponse;
1666
+ }
1667
+ }
1668
+ namespace UpdateRecipient {
1669
+ namespace Parameters {
1670
+ export type CampaignId = /**
1671
+ * example:
1672
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1673
+ */
1674
+ Components.Schemas.BaseUUID /* uuid */;
1675
+ export type RecipientId = /**
1676
+ * example:
1677
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1678
+ */
1679
+ Components.Schemas.BaseUUID /* uuid */;
1680
+ }
1681
+ export interface PathParameters {
1682
+ campaign_id: Parameters.CampaignId;
1683
+ recipient_id: Parameters.RecipientId;
1684
+ }
1685
+ export type RequestBody = Components.Schemas.UpdateRecipientPayload;
1686
+ namespace Responses {
1687
+ export type $200 = Components.Responses.RecipientResponse;
1688
+ export type $400 = Components.Responses.ClientErrorResponse;
1689
+ export type $500 = Components.Responses.ServerErrorResponse;
1690
+ }
1691
+ }
1692
+ namespace UpdateRecipientPortalStatus {
1693
+ namespace Parameters {
1694
+ export type CampaignId = /**
1695
+ * example:
1696
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1697
+ */
1698
+ Components.Schemas.BaseUUID /* uuid */;
1699
+ export type RecipientId = /**
1700
+ * example:
1701
+ * b8c01433-5556-4e2b-aad4-6f5348d1df84
1702
+ */
1703
+ Components.Schemas.BaseUUID /* uuid */;
1704
+ }
1705
+ export interface PathParameters {
1706
+ campaign_id: Parameters.CampaignId;
1707
+ recipient_id: Parameters.RecipientId;
1708
+ }
1709
+ export type RequestBody = Components.Schemas.UpdatePortalStatusRequest;
1710
+ namespace Responses {
1711
+ export type $200 = Components.Responses.RecipientResponse;
1712
+ export type $400 = Components.Responses.ClientErrorResponse;
1713
+ export type $404 = Components.Responses.ClientErrorResponse;
1714
+ export type $409 = Components.Responses.ClientErrorResponse;
1715
+ export type $500 = Components.Responses.ServerErrorResponse;
1716
+ }
1717
+ }
1718
+ }
1719
+
1720
+
1721
+ interface OperationMethods {
1722
+ /**
1723
+ * changeCampaignStatus - Change the status of a campaign
1724
+ *
1725
+ * Change the status of a campaign to a desired status.
1726
+ *
1727
+ * The status can be one of the following: active, inactive.
1728
+ *
1729
+ * Status transition is accompanied by side effects, e.g., automation execution.
1730
+ *
1731
+ */
1732
+ 'changeCampaignStatus'(
1733
+ parameters?: Parameters<Paths.ChangeCampaignStatus.PathParameters> | null,
1734
+ data?: any,
1735
+ config?: AxiosRequestConfig
1736
+ ): OperationResponse<Paths.ChangeCampaignStatus.Responses.$200>
1737
+ /**
1738
+ * getCampaignJobStatus - Get the status of a campaign's automation job
1739
+ *
1740
+ * Get the status of a campaign's automation job
1741
+ */
1742
+ 'getCampaignJobStatus'(
1743
+ parameters?: Parameters<Paths.GetCampaignJobStatus.PathParameters> | null,
1744
+ data?: any,
1745
+ config?: AxiosRequestConfig
1746
+ ): OperationResponse<Paths.GetCampaignJobStatus.Responses.$200>
1747
+ /**
1748
+ * getCampaignPortals - Get portals usage info for a campaign
1749
+ *
1750
+ * Get the list of portals and its widgets where the campaign is used.
1751
+ *
1752
+ */
1753
+ 'getCampaignPortals'(
1754
+ parameters?: Parameters<Paths.GetCampaignPortals.PathParameters> | null,
1755
+ data?: any,
1756
+ config?: AxiosRequestConfig
1757
+ ): OperationResponse<Paths.GetCampaignPortals.Responses.$200>
1758
+ /**
1759
+ * retriggerCampaignAutomations - Retrigger automations for campaign recipients
1760
+ *
1761
+ * Retrigger automation executions for specific campaign recipients that have failed.
1762
+ *
1763
+ * This endpoint starts new automation executions for the specified recipients
1764
+ * using the campaign's associated automation flow. Only recipients with
1765
+ * automation_status 'failed' will be processed. Recipients with other statuses
1766
+ * (success, pending, in_progress, cancelled) will be skipped to prevent
1767
+ * accidentally retriggering successful or ongoing automations.
1768
+ *
1769
+ */
1770
+ 'retriggerCampaignAutomations'(
1771
+ parameters?: Parameters<Paths.RetriggerCampaignAutomations.PathParameters> | null,
1772
+ data?: Paths.RetriggerCampaignAutomations.RequestBody,
1773
+ config?: AxiosRequestConfig
1774
+ ): OperationResponse<Paths.RetriggerCampaignAutomations.Responses.$200>
1775
+ /**
1776
+ * matchCampaigns - Match campaigns
1777
+ *
1778
+ * Match campaigns based on target entities.
1779
+ *
1780
+ * This endpoint returns the list of campaigns where the provided entities are part of the target.
1781
+ *
1782
+ */
1783
+ 'matchCampaigns'(
1784
+ parameters?: Parameters<UnknownParamsObject> | null,
1785
+ data?: Paths.MatchCampaigns.RequestBody,
1786
+ config?: AxiosRequestConfig
1787
+ ): OperationResponse<Paths.MatchCampaigns.Responses.$200>
1788
+ /**
1789
+ * matchTargets - Match targets
1790
+ *
1791
+ * Find targets from the provided list that include the provide entities.
1792
+ *
1793
+ */
1794
+ 'matchTargets'(
1795
+ parameters?: Parameters<UnknownParamsObject> | null,
1796
+ data?: Paths.MatchTargets.RequestBody,
1797
+ config?: AxiosRequestConfig
1798
+ ): OperationResponse<Paths.MatchTargets.Responses.$200>
1799
+ /**
1800
+ * getTargetQueries - Get target queries
1801
+ *
1802
+ * Transform target filters into Lucene queries for the provided target IDs.
1803
+ * Returns the transformed query string for each target along with any errors encountered.
1804
+ *
1805
+ */
1806
+ 'getTargetQueries'(
1807
+ parameters?: Parameters<UnknownParamsObject> | null,
1808
+ data?: Paths.GetTargetQueries.RequestBody,
1809
+ config?: AxiosRequestConfig
1810
+ ): OperationResponse<Paths.GetTargetQueries.Responses.$200>
1811
+ /**
1812
+ * createRecipient - Create a recipient associated with a campaign
1813
+ *
1814
+ * Creates a new recipient associated with a campaign.
1815
+ */
1816
+ 'createRecipient'(
1817
+ parameters?: Parameters<Paths.CreateRecipient.PathParameters> | null,
1818
+ data?: Paths.CreateRecipient.RequestBody,
1819
+ config?: AxiosRequestConfig
1820
+ ): OperationResponse<Paths.CreateRecipient.Responses.$201>
1821
+ /**
1822
+ * updateRecipient - Update a recipient
1823
+ *
1824
+ * Updates a recipient's attributes.
1825
+ */
1826
+ 'updateRecipient'(
1827
+ parameters?: Parameters<Paths.UpdateRecipient.PathParameters> | null,
1828
+ data?: Paths.UpdateRecipient.RequestBody,
1829
+ config?: AxiosRequestConfig
1830
+ ): OperationResponse<Paths.UpdateRecipient.Responses.$200>
1831
+ /**
1832
+ * updateRecipientPortalStatus - Update portal status for a campaign recipient
1833
+ *
1834
+ * Updates the portal status for a specific campaign recipient.
1835
+ * The portal_status_updated_at timestamp is automatically set when the status changes.
1836
+ *
1837
+ * Status transition rules:
1838
+ * - From 'sent': can change to 'seen', 'dismissed', or 'clicked'
1839
+ * - From 'seen': can change to 'dismissed' or 'clicked'
1840
+ * - From 'dismissed' or 'clicked': cannot be changed (final states)
1841
+ *
1842
+ */
1843
+ 'updateRecipientPortalStatus'(
1844
+ parameters?: Parameters<Paths.UpdateRecipientPortalStatus.PathParameters> | null,
1845
+ data?: Paths.UpdateRecipientPortalStatus.RequestBody,
1846
+ config?: AxiosRequestConfig
1847
+ ): OperationResponse<Paths.UpdateRecipientPortalStatus.Responses.$200>
1848
+ /**
1849
+ * getRecipients - Get campaign recipients
1850
+ *
1851
+ * Get a paginated list of recipients for a campaign.
1852
+ */
1853
+ 'getRecipients'(
1854
+ parameters?: Parameters<Paths.GetRecipients.QueryParameters & Paths.GetRecipients.PathParameters> | null,
1855
+ data?: any,
1856
+ config?: AxiosRequestConfig
1857
+ ): OperationResponse<Paths.GetRecipients.Responses.$200>
1858
+ }
1859
+
1860
+ interface PathsDictionary {
1861
+ ['/v1/campaign/{campaign_id}/status']: {
1862
+ /**
1863
+ * changeCampaignStatus - Change the status of a campaign
1864
+ *
1865
+ * Change the status of a campaign to a desired status.
1866
+ *
1867
+ * The status can be one of the following: active, inactive.
1868
+ *
1869
+ * Status transition is accompanied by side effects, e.g., automation execution.
1870
+ *
1871
+ */
1872
+ 'post'(
1873
+ parameters?: Parameters<Paths.ChangeCampaignStatus.PathParameters> | null,
1874
+ data?: any,
1875
+ config?: AxiosRequestConfig
1876
+ ): OperationResponse<Paths.ChangeCampaignStatus.Responses.$200>
1877
+ }
1878
+ ['/v1/campaign/{campaign_id}/job']: {
1879
+ /**
1880
+ * getCampaignJobStatus - Get the status of a campaign's automation job
1881
+ *
1882
+ * Get the status of a campaign's automation job
1883
+ */
1884
+ 'get'(
1885
+ parameters?: Parameters<Paths.GetCampaignJobStatus.PathParameters> | null,
1886
+ data?: any,
1887
+ config?: AxiosRequestConfig
1888
+ ): OperationResponse<Paths.GetCampaignJobStatus.Responses.$200>
1889
+ }
1890
+ ['/v1/campaign/{campaign_id}/portals']: {
1891
+ /**
1892
+ * getCampaignPortals - Get portals usage info for a campaign
1893
+ *
1894
+ * Get the list of portals and its widgets where the campaign is used.
1895
+ *
1896
+ */
1897
+ 'get'(
1898
+ parameters?: Parameters<Paths.GetCampaignPortals.PathParameters> | null,
1899
+ data?: any,
1900
+ config?: AxiosRequestConfig
1901
+ ): OperationResponse<Paths.GetCampaignPortals.Responses.$200>
1902
+ }
1903
+ ['/v1/campaign/{campaign_id}/automations:retrigger']: {
1904
+ /**
1905
+ * retriggerCampaignAutomations - Retrigger automations for campaign recipients
1906
+ *
1907
+ * Retrigger automation executions for specific campaign recipients that have failed.
1908
+ *
1909
+ * This endpoint starts new automation executions for the specified recipients
1910
+ * using the campaign's associated automation flow. Only recipients with
1911
+ * automation_status 'failed' will be processed. Recipients with other statuses
1912
+ * (success, pending, in_progress, cancelled) will be skipped to prevent
1913
+ * accidentally retriggering successful or ongoing automations.
1914
+ *
1915
+ */
1916
+ 'post'(
1917
+ parameters?: Parameters<Paths.RetriggerCampaignAutomations.PathParameters> | null,
1918
+ data?: Paths.RetriggerCampaignAutomations.RequestBody,
1919
+ config?: AxiosRequestConfig
1920
+ ): OperationResponse<Paths.RetriggerCampaignAutomations.Responses.$200>
1921
+ }
1922
+ ['/v1/campaign:match']: {
1923
+ /**
1924
+ * matchCampaigns - Match campaigns
1925
+ *
1926
+ * Match campaigns based on target entities.
1927
+ *
1928
+ * This endpoint returns the list of campaigns where the provided entities are part of the target.
1929
+ *
1930
+ */
1931
+ 'post'(
1932
+ parameters?: Parameters<UnknownParamsObject> | null,
1933
+ data?: Paths.MatchCampaigns.RequestBody,
1934
+ config?: AxiosRequestConfig
1935
+ ): OperationResponse<Paths.MatchCampaigns.Responses.$200>
1936
+ }
1937
+ ['/v1/target:match']: {
1938
+ /**
1939
+ * matchTargets - Match targets
1940
+ *
1941
+ * Find targets from the provided list that include the provide entities.
1942
+ *
1943
+ */
1944
+ 'post'(
1945
+ parameters?: Parameters<UnknownParamsObject> | null,
1946
+ data?: Paths.MatchTargets.RequestBody,
1947
+ config?: AxiosRequestConfig
1948
+ ): OperationResponse<Paths.MatchTargets.Responses.$200>
1949
+ }
1950
+ ['/v1/target/queries']: {
1951
+ /**
1952
+ * getTargetQueries - Get target queries
1953
+ *
1954
+ * Transform target filters into Lucene queries for the provided target IDs.
1955
+ * Returns the transformed query string for each target along with any errors encountered.
1956
+ *
1957
+ */
1958
+ 'post'(
1959
+ parameters?: Parameters<UnknownParamsObject> | null,
1960
+ data?: Paths.GetTargetQueries.RequestBody,
1961
+ config?: AxiosRequestConfig
1962
+ ): OperationResponse<Paths.GetTargetQueries.Responses.$200>
1963
+ }
1964
+ ['/v1/campaign/{campaign_id}/recipient']: {
1965
+ /**
1966
+ * createRecipient - Create a recipient associated with a campaign
1967
+ *
1968
+ * Creates a new recipient associated with a campaign.
1969
+ */
1970
+ 'post'(
1971
+ parameters?: Parameters<Paths.CreateRecipient.PathParameters> | null,
1972
+ data?: Paths.CreateRecipient.RequestBody,
1973
+ config?: AxiosRequestConfig
1974
+ ): OperationResponse<Paths.CreateRecipient.Responses.$201>
1975
+ }
1976
+ ['/v1/campaign/{campaign_id}/recipient/{recipient_id}']: {
1977
+ /**
1978
+ * updateRecipient - Update a recipient
1979
+ *
1980
+ * Updates a recipient's attributes.
1981
+ */
1982
+ 'patch'(
1983
+ parameters?: Parameters<Paths.UpdateRecipient.PathParameters> | null,
1984
+ data?: Paths.UpdateRecipient.RequestBody,
1985
+ config?: AxiosRequestConfig
1986
+ ): OperationResponse<Paths.UpdateRecipient.Responses.$200>
1987
+ }
1988
+ ['/v1/campaign/{campaign_id}/recipient/{recipient_id}/portal:status']: {
1989
+ /**
1990
+ * updateRecipientPortalStatus - Update portal status for a campaign recipient
1991
+ *
1992
+ * Updates the portal status for a specific campaign recipient.
1993
+ * The portal_status_updated_at timestamp is automatically set when the status changes.
1994
+ *
1995
+ * Status transition rules:
1996
+ * - From 'sent': can change to 'seen', 'dismissed', or 'clicked'
1997
+ * - From 'seen': can change to 'dismissed' or 'clicked'
1998
+ * - From 'dismissed' or 'clicked': cannot be changed (final states)
1999
+ *
2000
+ */
2001
+ 'patch'(
2002
+ parameters?: Parameters<Paths.UpdateRecipientPortalStatus.PathParameters> | null,
2003
+ data?: Paths.UpdateRecipientPortalStatus.RequestBody,
2004
+ config?: AxiosRequestConfig
2005
+ ): OperationResponse<Paths.UpdateRecipientPortalStatus.Responses.$200>
2006
+ }
2007
+ ['/v1/campaign/{campaign_id}/recipients']: {
2008
+ /**
2009
+ * getRecipients - Get campaign recipients
2010
+ *
2011
+ * Get a paginated list of recipients for a campaign.
2012
+ */
2013
+ 'get'(
2014
+ parameters?: Parameters<Paths.GetRecipients.QueryParameters & Paths.GetRecipients.PathParameters> | null,
2015
+ data?: any,
2016
+ config?: AxiosRequestConfig
2017
+ ): OperationResponse<Paths.GetRecipients.Responses.$200>
2018
+ }
2019
+ }
2020
+
2021
+ type Client = OpenAPIClient<OperationMethods, PathsDictionary>
2022
+
2023
+
2024
+ type AutomationRecipientPayload = Components.Schemas.AutomationRecipientPayload;
2025
+ type AutomationStatus = Components.Schemas.AutomationStatus;
2026
+ type BaseEntityAcl = Components.Schemas.BaseEntityAcl;
2027
+ type BaseEntityOwner = Components.Schemas.BaseEntityOwner;
2028
+ type BaseError = Components.Schemas.BaseError;
2029
+ type BaseNanoID = Components.Schemas.BaseNanoID;
2030
+ type BaseRecipientPayload = Components.Schemas.BaseRecipientPayload;
2031
+ type BaseRelation = Components.Schemas.BaseRelation;
2032
+ type BaseSystemFields = Components.Schemas.BaseSystemFields;
2033
+ type BaseSystemFieldsRequired = Components.Schemas.BaseSystemFieldsRequired;
2034
+ type BaseSystemId = Components.Schemas.BaseSystemId;
2035
+ type BaseTags = Components.Schemas.BaseTags;
2036
+ type BaseUUID = Components.Schemas.BaseUUID;
2037
+ type Campaign = Components.Schemas.Campaign;
2038
+ type CampaignStatus = Components.Schemas.CampaignStatus;
2039
+ type ClientError = Components.Schemas.ClientError;
2040
+ type CreateRecipientPayload = Components.Schemas.CreateRecipientPayload;
2041
+ type ExecutionSummaryItem = Components.Schemas.ExecutionSummaryItem;
2042
+ type GetTargetQueriesParams = Components.Schemas.GetTargetQueriesParams;
2043
+ type JobStatus = Components.Schemas.JobStatus;
2044
+ type MatchCampaignParams = Components.Schemas.MatchCampaignParams;
2045
+ type MatchTargetParams = Components.Schemas.MatchTargetParams;
2046
+ type PortalRecipientPayload = Components.Schemas.PortalRecipientPayload;
2047
+ type PortalStatus = Components.Schemas.PortalStatus;
2048
+ type Recipient = Components.Schemas.Recipient;
2049
+ type RetriggerAutomationsRequest = Components.Schemas.RetriggerAutomationsRequest;
2050
+ type RetriggerAutomationsResult = Components.Schemas.RetriggerAutomationsResult;
2051
+ type ServerError = Components.Schemas.ServerError;
2052
+ type Target = Components.Schemas.Target;
2053
+ type TargetQueryResult = Components.Schemas.TargetQueryResult;
2054
+ type UpdatePortalStatusRequest = Components.Schemas.UpdatePortalStatusRequest;
2055
+ type UpdateRecipientPayload = Components.Schemas.UpdateRecipientPayload;
2056
+
2057
+ export { type AutomationRecipientPayload as A, type BaseEntityAcl as B, type Client as C, type ExecutionSummaryItem as E, type GetTargetQueriesParams as G, type JobStatus as J, type MatchCampaignParams as M, type OperationMethods as O, Paths as P, type Recipient as R, type ServerError as S, type Target as T, type UpdatePortalStatusRequest as U, Components as a, type PathsDictionary as b, type AutomationStatus as c, type BaseEntityOwner as d, type BaseError as e, type BaseNanoID as f, type BaseRecipientPayload as g, type BaseRelation as h, type BaseSystemFields as i, type BaseSystemFieldsRequired as j, type BaseSystemId as k, type BaseTags as l, type BaseUUID as m, type Campaign as n, type CampaignStatus as o, type ClientError as p, type CreateRecipientPayload as q, type MatchTargetParams as r, type PortalRecipientPayload as s, type PortalStatus as t, type RetriggerAutomationsRequest as u, type RetriggerAutomationsResult as v, type TargetQueryResult as w, type UpdateRecipientPayload as x };