@epilot/sdk 2.19.6-alpha.0 → 2.19.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/environments.json +17 -135
- package/definitions/targeting.json +65 -2
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +6 -6
- package/dist/apis/document.js +1 -1
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.d.cts +2 -2
- package/dist/apis/environments.d.ts +2 -2
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.d.cts +2 -2
- package/dist/apis/targeting.d.ts +2 -2
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/bin/cli.js +1 -1
- package/dist/{chunk-JCBXIJ45.js → chunk-2NCWQL55.js} +2 -2
- package/dist/{chunk-F4OENWBE.cjs → chunk-QVK7PWME.cjs} +2 -2
- package/dist/environments-PXJOTQVM.js +7 -0
- package/dist/environments-QJ4UMJ5C.cjs +7 -0
- package/dist/{environments.d-840_mC07.d.ts → environments.d-BvqvN-PD.d.cts} +32 -144
- package/dist/{environments.d-840_mC07.d.cts → environments.d-BvqvN-PD.d.ts} +32 -144
- package/dist/index.cjs +8 -8
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/dist/{js-yaml-UPZKYVRY.js → js-yaml-DLCVPJ7G.js} +17 -15
- package/dist/targeting-2JCGF4IR.cjs +7 -0
- package/dist/targeting-2NHAG7B5.js +7 -0
- package/dist/{targeting.d-KcawmWBB.d.cts → targeting.d-BYVSahmV.d.cts} +44 -1
- package/dist/{targeting.d-KcawmWBB.d.ts → targeting.d-BYVSahmV.d.ts} +44 -1
- package/docs/environments.md +20 -128
- package/docs/targeting.md +80 -1
- package/package.json +11 -12
- package/dist/environments-JP2CPDH2.cjs +0 -7
- package/dist/environments-PGRMZY5G.js +0 -7
- package/dist/targeting-5U4XGOXY.cjs +0 -7
- package/dist/targeting-R3G32HI4.js +0 -7
|
@@ -17,129 +17,44 @@ declare namespace Components {
|
|
|
17
17
|
export interface EnvironmentGroupUpsertRequest {
|
|
18
18
|
description?: string;
|
|
19
19
|
}
|
|
20
|
-
export type
|
|
21
|
-
value: string;
|
|
22
|
-
label: string;
|
|
23
|
-
} | {
|
|
24
|
-
value: string;
|
|
25
|
-
labels: {
|
|
26
|
-
[name: string]: string;
|
|
27
|
-
};
|
|
28
|
-
};
|
|
29
|
-
/**
|
|
30
|
-
* A variable's value. The JSON type corresponds to the variable's `type`:
|
|
31
|
-
* `String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
32
|
-
* `Boolean` is a boolean, and `Options` is an object. Numbers are IEEE 754
|
|
33
|
-
* doubles; integers above 2^53 may lose precision on round-trip.
|
|
34
|
-
*
|
|
35
|
-
*/
|
|
36
|
-
export type EnvironmentValue = /**
|
|
37
|
-
* A variable's value. The JSON type corresponds to the variable's `type`:
|
|
38
|
-
* `String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
39
|
-
* `Boolean` is a boolean, and `Options` is an object. Numbers are IEEE 754
|
|
40
|
-
* doubles; integers above 2^53 may lose precision on round-trip.
|
|
41
|
-
*
|
|
42
|
-
*/
|
|
43
|
-
string | number | boolean | OptionsValue;
|
|
44
|
-
/**
|
|
45
|
-
* The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
46
|
-
* its value is never returned. `Text`, `Number`, `Boolean` and `Options` may be
|
|
47
|
-
* served to browser-facing consumers; `String` and `SecretString` may not.
|
|
48
|
-
*
|
|
49
|
-
*/
|
|
50
|
-
export type EnvironmentValueType = "String" | "SecretString" | "Text" | "Number" | "Boolean" | "Options";
|
|
20
|
+
export type EnvironmentValueType = "String" | "SecretString";
|
|
51
21
|
export interface EnvironmentVariable {
|
|
52
22
|
key: string; // ^[a-z0-9][a-z0-9_.\-]{0,127}$
|
|
53
|
-
type:
|
|
54
|
-
* The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
55
|
-
* its value is never returned. `Text`, `Number`, `Boolean` and `Options` may be
|
|
56
|
-
* served to browser-facing consumers; `String` and `SecretString` may not.
|
|
57
|
-
*
|
|
58
|
-
*/
|
|
59
|
-
EnvironmentValueType;
|
|
23
|
+
type: EnvironmentValueType;
|
|
60
24
|
description?: string;
|
|
61
25
|
/**
|
|
62
26
|
* Optional group name for organising variables in the UI
|
|
63
27
|
*/
|
|
64
28
|
group?: string;
|
|
65
29
|
/**
|
|
66
|
-
*
|
|
67
|
-
* the variable has been created without a value — for example by a blueprint
|
|
68
|
-
* install, which syncs a variable's key and type but never its value.
|
|
69
|
-
*
|
|
70
|
-
*/
|
|
71
|
-
value?: /**
|
|
72
|
-
* Returned for non-secret types, omitted for SecretString. Also omitted when
|
|
73
|
-
* the variable has been created without a value — for example by a blueprint
|
|
74
|
-
* install, which syncs a variable's key and type but never its value.
|
|
75
|
-
*
|
|
30
|
+
* Value is returned for String type, omitted for SecretString
|
|
76
31
|
*/
|
|
77
|
-
string
|
|
78
|
-
/**
|
|
79
|
-
* Whether the variable is protected from editing
|
|
80
|
-
*/
|
|
81
|
-
protected?: boolean;
|
|
32
|
+
value?: string;
|
|
82
33
|
created_at: string; // date-time
|
|
83
34
|
updated_at: string; // date-time
|
|
84
35
|
}
|
|
85
36
|
export interface EnvironmentVariableCreateRequest {
|
|
86
37
|
key: string; // ^[a-z0-9][a-z0-9_.\-]{0,127}$
|
|
87
|
-
type:
|
|
88
|
-
* The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
89
|
-
* its value is never returned. `Text`, `Number`, `Boolean` and `Options` may be
|
|
90
|
-
* served to browser-facing consumers; `String` and `SecretString` may not.
|
|
91
|
-
*
|
|
92
|
-
*/
|
|
93
|
-
EnvironmentValueType;
|
|
38
|
+
type: EnvironmentValueType;
|
|
94
39
|
description?: string;
|
|
95
40
|
group?: string;
|
|
96
|
-
value?:
|
|
97
|
-
* A variable's value. The JSON type corresponds to the variable's `type`:
|
|
98
|
-
* `String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
99
|
-
* `Boolean` is a boolean, and `Options` is an object. Numbers are IEEE 754
|
|
100
|
-
* doubles; integers above 2^53 may lose precision on round-trip.
|
|
101
|
-
*
|
|
102
|
-
*/
|
|
103
|
-
EnvironmentValue;
|
|
104
|
-
/**
|
|
105
|
-
* Whether the variable is protected from editing
|
|
106
|
-
*/
|
|
107
|
-
protected?: boolean;
|
|
41
|
+
value?: string;
|
|
108
42
|
}
|
|
109
43
|
export interface EnvironmentVariableList {
|
|
110
44
|
items: EnvironmentVariableListItem[];
|
|
111
45
|
}
|
|
112
46
|
export interface EnvironmentVariableListItem {
|
|
113
47
|
key: string;
|
|
114
|
-
type:
|
|
115
|
-
* The structure a variable's value holds. `SecretString` is encrypted at rest and
|
|
116
|
-
* its value is never returned. `Text`, `Number`, `Boolean` and `Options` may be
|
|
117
|
-
* served to browser-facing consumers; `String` and `SecretString` may not.
|
|
118
|
-
*
|
|
119
|
-
*/
|
|
120
|
-
EnvironmentValueType;
|
|
48
|
+
type: EnvironmentValueType;
|
|
121
49
|
description?: string;
|
|
122
50
|
/**
|
|
123
51
|
* Optional group name for organising variables in the UI
|
|
124
52
|
*/
|
|
125
53
|
group?: string;
|
|
126
54
|
/**
|
|
127
|
-
*
|
|
128
|
-
* the variable has been created without a value — for example by a blueprint
|
|
129
|
-
* install, which syncs a variable's key and type but never its value.
|
|
130
|
-
*
|
|
131
|
-
*/
|
|
132
|
-
value?: /**
|
|
133
|
-
* Returned for non-secret types, omitted for SecretString. Also omitted when
|
|
134
|
-
* the variable has been created without a value — for example by a blueprint
|
|
135
|
-
* install, which syncs a variable's key and type but never its value.
|
|
136
|
-
*
|
|
137
|
-
*/
|
|
138
|
-
string | number | boolean | OptionsValue;
|
|
139
|
-
/**
|
|
140
|
-
* Whether the variable is protected from editing
|
|
55
|
+
* Value is returned for String type, omitted for SecretString
|
|
141
56
|
*/
|
|
142
|
-
|
|
57
|
+
value?: string;
|
|
143
58
|
created_at: string; // date-time
|
|
144
59
|
updated_at: string; // date-time
|
|
145
60
|
}
|
|
@@ -147,28 +62,10 @@ declare namespace Components {
|
|
|
147
62
|
/**
|
|
148
63
|
* Type of variable. Used when creating a new variable. Defaults to String.
|
|
149
64
|
*/
|
|
150
|
-
type?: "String" | "SecretString"
|
|
151
|
-
value?:
|
|
152
|
-
* A variable's value. The JSON type corresponds to the variable's `type`:
|
|
153
|
-
* `String`, `SecretString` and `Text` are strings, `Number` is a number,
|
|
154
|
-
* `Boolean` is a boolean, and `Options` is an object. Numbers are IEEE 754
|
|
155
|
-
* doubles; integers above 2^53 may lose precision on round-trip.
|
|
156
|
-
*
|
|
157
|
-
*/
|
|
158
|
-
EnvironmentValue;
|
|
65
|
+
type?: "String" | "SecretString";
|
|
66
|
+
value?: string;
|
|
159
67
|
description?: string;
|
|
160
68
|
group?: string;
|
|
161
|
-
/**
|
|
162
|
-
* Whether the variable is protected from editing
|
|
163
|
-
*/
|
|
164
|
-
protected?: boolean;
|
|
165
|
-
}
|
|
166
|
-
export interface OptionsValue {
|
|
167
|
-
fallbackLanguage?: string;
|
|
168
|
-
options: [
|
|
169
|
-
EnvironmentOption,
|
|
170
|
-
...EnvironmentOption[]
|
|
171
|
-
];
|
|
172
69
|
}
|
|
173
70
|
}
|
|
174
71
|
}
|
|
@@ -276,8 +173,6 @@ declare namespace Paths {
|
|
|
276
173
|
}
|
|
277
174
|
export interface $403 {
|
|
278
175
|
}
|
|
279
|
-
export interface $409 {
|
|
280
|
-
}
|
|
281
176
|
export interface $500 {
|
|
282
177
|
}
|
|
283
178
|
}
|
|
@@ -303,7 +198,7 @@ declare namespace Paths {
|
|
|
303
198
|
|
|
304
199
|
interface OperationMethods {
|
|
305
200
|
/**
|
|
306
|
-
* listEnvironmentVariables -
|
|
201
|
+
* listEnvironmentVariables - List environment variables
|
|
307
202
|
*
|
|
308
203
|
* List all environment variables for the organization. Returns metadata only, no secret values.
|
|
309
204
|
*/
|
|
@@ -313,9 +208,9 @@ interface OperationMethods {
|
|
|
313
208
|
config?: AxiosRequestConfig
|
|
314
209
|
): OperationResponse<Paths.ListEnvironmentVariables.Responses.$200>
|
|
315
210
|
/**
|
|
316
|
-
* createEnvironmentVariable -
|
|
211
|
+
* createEnvironmentVariable - Create environment variable
|
|
317
212
|
*
|
|
318
|
-
* Create a new environment variable or secret for the organization.
|
|
213
|
+
* Create a new environment variable or secret for the organization.
|
|
319
214
|
*/
|
|
320
215
|
'createEnvironmentVariable'(
|
|
321
216
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -323,7 +218,7 @@ interface OperationMethods {
|
|
|
323
218
|
config?: AxiosRequestConfig
|
|
324
219
|
): OperationResponse<Paths.CreateEnvironmentVariable.Responses.$201>
|
|
325
220
|
/**
|
|
326
|
-
* listEnvironmentGroups -
|
|
221
|
+
* listEnvironmentGroups - List environment groups
|
|
327
222
|
*
|
|
328
223
|
* List all environment groups for the organization.
|
|
329
224
|
*/
|
|
@@ -334,8 +229,6 @@ interface OperationMethods {
|
|
|
334
229
|
): OperationResponse<Paths.ListEnvironmentGroups.Responses.$200>
|
|
335
230
|
/**
|
|
336
231
|
* putEnvironmentGroup - putEnvironmentGroup
|
|
337
|
-
*
|
|
338
|
-
* Create or update an environment group by name. Acts as an upsert — creates the group if it does not exist.
|
|
339
232
|
*/
|
|
340
233
|
'putEnvironmentGroup'(
|
|
341
234
|
parameters?: Parameters<Paths.V1EnvironmentsGroups$Name.PathParameters> | null,
|
|
@@ -343,7 +236,7 @@ interface OperationMethods {
|
|
|
343
236
|
config?: AxiosRequestConfig
|
|
344
237
|
): OperationResponse<Paths.PutEnvironmentGroup.Responses.$200 | Paths.PutEnvironmentGroup.Responses.$201>
|
|
345
238
|
/**
|
|
346
|
-
* deleteEnvironmentGroup -
|
|
239
|
+
* deleteEnvironmentGroup - Delete an environment group
|
|
347
240
|
*
|
|
348
241
|
* Deletes a group. Variables assigned to this group become ungrouped.
|
|
349
242
|
*/
|
|
@@ -353,9 +246,9 @@ interface OperationMethods {
|
|
|
353
246
|
config?: AxiosRequestConfig
|
|
354
247
|
): OperationResponse<Paths.DeleteEnvironmentGroup.Responses.$204>
|
|
355
248
|
/**
|
|
356
|
-
* getEnvironmentVariable -
|
|
249
|
+
* getEnvironmentVariable - Get environment variable
|
|
357
250
|
*
|
|
358
|
-
* Get an environment variable by key. Returns value for
|
|
251
|
+
* Get an environment variable by key. Returns value only for String type, omitted for SecretString.
|
|
359
252
|
*/
|
|
360
253
|
'getEnvironmentVariable'(
|
|
361
254
|
parameters?: Parameters<Paths.V1Environments$Key.PathParameters> | null,
|
|
@@ -363,9 +256,9 @@ interface OperationMethods {
|
|
|
363
256
|
config?: AxiosRequestConfig
|
|
364
257
|
): OperationResponse<Paths.GetEnvironmentVariable.Responses.$200>
|
|
365
258
|
/**
|
|
366
|
-
* updateEnvironmentVariable -
|
|
259
|
+
* updateEnvironmentVariable - Update environment variable
|
|
367
260
|
*
|
|
368
|
-
* Create or update an environment variable. Acts as an upsert — creates the variable if it does not exist.
|
|
261
|
+
* Create or update an environment variable. Acts as an upsert — creates the variable if it does not exist.
|
|
369
262
|
*/
|
|
370
263
|
'updateEnvironmentVariable'(
|
|
371
264
|
parameters?: Parameters<Paths.V1Environments$Key.PathParameters> | null,
|
|
@@ -373,7 +266,7 @@ interface OperationMethods {
|
|
|
373
266
|
config?: AxiosRequestConfig
|
|
374
267
|
): OperationResponse<Paths.UpdateEnvironmentVariable.Responses.$200 | Paths.UpdateEnvironmentVariable.Responses.$201>
|
|
375
268
|
/**
|
|
376
|
-
* deleteEnvironmentVariable -
|
|
269
|
+
* deleteEnvironmentVariable - Delete environment variable
|
|
377
270
|
*
|
|
378
271
|
* Delete an environment variable by key.
|
|
379
272
|
*/
|
|
@@ -387,7 +280,7 @@ interface OperationMethods {
|
|
|
387
280
|
interface PathsDictionary {
|
|
388
281
|
['/v1/environments']: {
|
|
389
282
|
/**
|
|
390
|
-
* listEnvironmentVariables -
|
|
283
|
+
* listEnvironmentVariables - List environment variables
|
|
391
284
|
*
|
|
392
285
|
* List all environment variables for the organization. Returns metadata only, no secret values.
|
|
393
286
|
*/
|
|
@@ -397,9 +290,9 @@ interface PathsDictionary {
|
|
|
397
290
|
config?: AxiosRequestConfig
|
|
398
291
|
): OperationResponse<Paths.ListEnvironmentVariables.Responses.$200>
|
|
399
292
|
/**
|
|
400
|
-
* createEnvironmentVariable -
|
|
293
|
+
* createEnvironmentVariable - Create environment variable
|
|
401
294
|
*
|
|
402
|
-
* Create a new environment variable or secret for the organization.
|
|
295
|
+
* Create a new environment variable or secret for the organization.
|
|
403
296
|
*/
|
|
404
297
|
'post'(
|
|
405
298
|
parameters?: Parameters<UnknownParamsObject> | null,
|
|
@@ -409,7 +302,7 @@ interface PathsDictionary {
|
|
|
409
302
|
}
|
|
410
303
|
['/v1/environments/groups']: {
|
|
411
304
|
/**
|
|
412
|
-
* listEnvironmentGroups -
|
|
305
|
+
* listEnvironmentGroups - List environment groups
|
|
413
306
|
*
|
|
414
307
|
* List all environment groups for the organization.
|
|
415
308
|
*/
|
|
@@ -422,8 +315,6 @@ interface PathsDictionary {
|
|
|
422
315
|
['/v1/environments/groups/{name}']: {
|
|
423
316
|
/**
|
|
424
317
|
* putEnvironmentGroup - putEnvironmentGroup
|
|
425
|
-
*
|
|
426
|
-
* Create or update an environment group by name. Acts as an upsert — creates the group if it does not exist.
|
|
427
318
|
*/
|
|
428
319
|
'put'(
|
|
429
320
|
parameters?: Parameters<Paths.V1EnvironmentsGroups$Name.PathParameters> | null,
|
|
@@ -431,7 +322,7 @@ interface PathsDictionary {
|
|
|
431
322
|
config?: AxiosRequestConfig
|
|
432
323
|
): OperationResponse<Paths.PutEnvironmentGroup.Responses.$200 | Paths.PutEnvironmentGroup.Responses.$201>
|
|
433
324
|
/**
|
|
434
|
-
* deleteEnvironmentGroup -
|
|
325
|
+
* deleteEnvironmentGroup - Delete an environment group
|
|
435
326
|
*
|
|
436
327
|
* Deletes a group. Variables assigned to this group become ungrouped.
|
|
437
328
|
*/
|
|
@@ -443,9 +334,9 @@ interface PathsDictionary {
|
|
|
443
334
|
}
|
|
444
335
|
['/v1/environments/{key}']: {
|
|
445
336
|
/**
|
|
446
|
-
* getEnvironmentVariable -
|
|
337
|
+
* getEnvironmentVariable - Get environment variable
|
|
447
338
|
*
|
|
448
|
-
* Get an environment variable by key. Returns value for
|
|
339
|
+
* Get an environment variable by key. Returns value only for String type, omitted for SecretString.
|
|
449
340
|
*/
|
|
450
341
|
'get'(
|
|
451
342
|
parameters?: Parameters<Paths.V1Environments$Key.PathParameters> | null,
|
|
@@ -453,9 +344,9 @@ interface PathsDictionary {
|
|
|
453
344
|
config?: AxiosRequestConfig
|
|
454
345
|
): OperationResponse<Paths.GetEnvironmentVariable.Responses.$200>
|
|
455
346
|
/**
|
|
456
|
-
* updateEnvironmentVariable -
|
|
347
|
+
* updateEnvironmentVariable - Update environment variable
|
|
457
348
|
*
|
|
458
|
-
* Create or update an environment variable. Acts as an upsert — creates the variable if it does not exist.
|
|
349
|
+
* Create or update an environment variable. Acts as an upsert — creates the variable if it does not exist.
|
|
459
350
|
*/
|
|
460
351
|
'put'(
|
|
461
352
|
parameters?: Parameters<Paths.V1Environments$Key.PathParameters> | null,
|
|
@@ -463,7 +354,7 @@ interface PathsDictionary {
|
|
|
463
354
|
config?: AxiosRequestConfig
|
|
464
355
|
): OperationResponse<Paths.UpdateEnvironmentVariable.Responses.$200 | Paths.UpdateEnvironmentVariable.Responses.$201>
|
|
465
356
|
/**
|
|
466
|
-
* deleteEnvironmentVariable -
|
|
357
|
+
* deleteEnvironmentVariable - Delete environment variable
|
|
467
358
|
*
|
|
468
359
|
* Delete an environment variable by key.
|
|
469
360
|
*/
|
|
@@ -481,14 +372,11 @@ type Client = OpenAPIClient<OperationMethods, PathsDictionary>
|
|
|
481
372
|
type EnvironmentGroup = Components.Schemas.EnvironmentGroup;
|
|
482
373
|
type EnvironmentGroupList = Components.Schemas.EnvironmentGroupList;
|
|
483
374
|
type EnvironmentGroupUpsertRequest = Components.Schemas.EnvironmentGroupUpsertRequest;
|
|
484
|
-
type EnvironmentOption = Components.Schemas.EnvironmentOption;
|
|
485
|
-
type EnvironmentValue = Components.Schemas.EnvironmentValue;
|
|
486
375
|
type EnvironmentValueType = Components.Schemas.EnvironmentValueType;
|
|
487
376
|
type EnvironmentVariable = Components.Schemas.EnvironmentVariable;
|
|
488
377
|
type EnvironmentVariableCreateRequest = Components.Schemas.EnvironmentVariableCreateRequest;
|
|
489
378
|
type EnvironmentVariableList = Components.Schemas.EnvironmentVariableList;
|
|
490
379
|
type EnvironmentVariableListItem = Components.Schemas.EnvironmentVariableListItem;
|
|
491
380
|
type EnvironmentVariableUpdateRequest = Components.Schemas.EnvironmentVariableUpdateRequest;
|
|
492
|
-
type OptionsValue = Components.Schemas.OptionsValue;
|
|
493
381
|
|
|
494
|
-
export { type Client as C, type EnvironmentGroup as E, type OperationMethods as O, Paths as P, Components as a, type PathsDictionary as b, type EnvironmentGroupList as c, type EnvironmentGroupUpsertRequest as d, type
|
|
382
|
+
export { type Client as C, type EnvironmentGroup as E, type OperationMethods as O, Paths as P, Components as a, type PathsDictionary as b, type EnvironmentGroupList as c, type EnvironmentGroupUpsertRequest as d, type EnvironmentValueType as e, type EnvironmentVariable as f, type EnvironmentVariableCreateRequest as g, type EnvironmentVariableList as h, type EnvironmentVariableListItem as i, type EnvironmentVariableUpdateRequest as j };
|
package/dist/index.cjs
CHANGED
|
@@ -158,7 +158,7 @@ var _chunkADSWGLIVcjs = require('./chunk-ADSWGLIV.cjs');
|
|
|
158
158
|
|
|
159
159
|
|
|
160
160
|
|
|
161
|
-
var
|
|
161
|
+
var _chunkQVK7PWMEcjs = require('./chunk-QVK7PWME.cjs');
|
|
162
162
|
|
|
163
163
|
|
|
164
164
|
var _chunkNJK5F5TFcjs = require('./chunk-NJK5F5TF.cjs');
|
|
@@ -225,7 +225,7 @@ var resolveClient = (params) => {
|
|
|
225
225
|
}
|
|
226
226
|
if (!entry.instance) {
|
|
227
227
|
const definition = entry.loader();
|
|
228
|
-
entry.instance =
|
|
228
|
+
entry.instance = _chunkQVK7PWMEcjs.createApiClient.call(void 0, {
|
|
229
229
|
definition,
|
|
230
230
|
token: state.token,
|
|
231
231
|
headers: state.globalHeaders,
|
|
@@ -258,7 +258,7 @@ var resetAllClients = (registry) => {
|
|
|
258
258
|
};
|
|
259
259
|
|
|
260
260
|
// src/apis/_registry.ts
|
|
261
|
-
var expandDef = (mod) =>
|
|
261
|
+
var expandDef = (mod) => _chunkQVK7PWMEcjs.expand.call(void 0, _nullishCoalesce(mod.default, () => ( mod)));
|
|
262
262
|
var registerBuiltinApis = (registry) => {
|
|
263
263
|
registerApi({
|
|
264
264
|
registry,
|
|
@@ -601,9 +601,9 @@ var createSDK = () => {
|
|
|
601
601
|
const available = [...registry.keys()].join(", ");
|
|
602
602
|
throw new Error(`Unknown API: "${name}". Available: ${available}`);
|
|
603
603
|
}
|
|
604
|
-
return
|
|
604
|
+
return _chunkQVK7PWMEcjs.createApiHandle.call(void 0, {
|
|
605
605
|
resolveClient: () => resolveClient({ registry, name, state }),
|
|
606
|
-
createClient: () =>
|
|
606
|
+
createClient: () => _chunkQVK7PWMEcjs.createApiClient.call(void 0, { definition: entry.loader(), apiName: name }),
|
|
607
607
|
apiName: name
|
|
608
608
|
});
|
|
609
609
|
};
|
|
@@ -651,9 +651,9 @@ var createSDK = () => {
|
|
|
651
651
|
return interceptorUse;
|
|
652
652
|
}
|
|
653
653
|
case "help":
|
|
654
|
-
return (apiName) =>
|
|
654
|
+
return (apiName) => _chunkQVK7PWMEcjs.help.call(void 0, apiName);
|
|
655
655
|
case "openapi":
|
|
656
|
-
return (apiName) =>
|
|
656
|
+
return (apiName) => _chunkQVK7PWMEcjs.openapi.call(void 0, apiName);
|
|
657
657
|
case "then":
|
|
658
658
|
case "catch":
|
|
659
659
|
case "finally":
|
|
@@ -683,4 +683,4 @@ var epilot = createSDK();
|
|
|
683
683
|
|
|
684
684
|
|
|
685
685
|
|
|
686
|
-
exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize =
|
|
686
|
+
exports.applyLargeResponseInterceptor = applyLargeResponseInterceptor; exports.applyRetryInterceptor = applyRetryInterceptor; exports.authorize = _chunkQVK7PWMEcjs.authorize; exports.createSDK = createSDK; exports.epilot = epilot; exports.help = _chunkQVK7PWMEcjs.help; exports.openapi = _chunkQVK7PWMEcjs.openapi;
|
package/dist/index.d.cts
CHANGED
|
@@ -25,7 +25,7 @@ import { C as Client$i } from './email-settings.d-DViLYaOl.cjs';
|
|
|
25
25
|
import { C as Client$j } from './email-template.d-gtQkdaXM.cjs';
|
|
26
26
|
import { C as Client$k } from './entity.d-CQXFlO3D.cjs';
|
|
27
27
|
import { C as Client$l } from './entity-mapping.d-DKSW3sfy.cjs';
|
|
28
|
-
import { C as Client$m } from './environments.d-
|
|
28
|
+
import { C as Client$m } from './environments.d-BvqvN-PD.cjs';
|
|
29
29
|
import { C as Client$n } from './event-catalog.d-QIhhewVH.cjs';
|
|
30
30
|
import { C as Client$o } from './file.d-CBsXF4W8.cjs';
|
|
31
31
|
import { C as Client$p } from './iban.d-BwdiGbxi.cjs';
|
|
@@ -47,7 +47,7 @@ import { C as Client$E } from './sandbox.d-BdbOFzDu.cjs';
|
|
|
47
47
|
import { C as Client$F } from './sharing.d-sOXq-gtz.cjs';
|
|
48
48
|
import { C as Client$G } from './snapshot.d-DT0zg2CS.cjs';
|
|
49
49
|
import { C as Client$H } from './submission.d-BamwfhXw.cjs';
|
|
50
|
-
import { C as Client$I } from './targeting.d-
|
|
50
|
+
import { C as Client$I } from './targeting.d-BYVSahmV.cjs';
|
|
51
51
|
import { C as Client$J } from './template-variables.d-Ble9TSBa.cjs';
|
|
52
52
|
import { C as Client$K } from './user.d-rqYtwsCz.cjs';
|
|
53
53
|
import { C as Client$L } from './validation-rules.d-CvGvBnMX.cjs';
|
package/dist/index.d.ts
CHANGED
|
@@ -25,7 +25,7 @@ import { C as Client$i } from './email-settings.d-DViLYaOl.js';
|
|
|
25
25
|
import { C as Client$j } from './email-template.d-gtQkdaXM.js';
|
|
26
26
|
import { C as Client$k } from './entity.d-CQXFlO3D.js';
|
|
27
27
|
import { C as Client$l } from './entity-mapping.d-DKSW3sfy.js';
|
|
28
|
-
import { C as Client$m } from './environments.d-
|
|
28
|
+
import { C as Client$m } from './environments.d-BvqvN-PD.js';
|
|
29
29
|
import { C as Client$n } from './event-catalog.d-QIhhewVH.js';
|
|
30
30
|
import { C as Client$o } from './file.d-CBsXF4W8.js';
|
|
31
31
|
import { C as Client$p } from './iban.d-BwdiGbxi.js';
|
|
@@ -47,7 +47,7 @@ import { C as Client$E } from './sandbox.d-BdbOFzDu.js';
|
|
|
47
47
|
import { C as Client$F } from './sharing.d-sOXq-gtz.js';
|
|
48
48
|
import { C as Client$G } from './snapshot.d-DT0zg2CS.js';
|
|
49
49
|
import { C as Client$H } from './submission.d-BamwfhXw.js';
|
|
50
|
-
import { C as Client$I } from './targeting.d-
|
|
50
|
+
import { C as Client$I } from './targeting.d-BYVSahmV.js';
|
|
51
51
|
import { C as Client$J } from './template-variables.d-Ble9TSBa.js';
|
|
52
52
|
import { C as Client$K } from './user.d-rqYtwsCz.js';
|
|
53
53
|
import { C as Client$L } from './validation-rules.d-CvGvBnMX.js';
|
package/dist/index.js
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
|
|
3
|
-
// ../../node_modules/js-yaml/dist/js-yaml.mjs
|
|
3
|
+
// ../../node_modules/.pnpm/js-yaml@4.1.1/node_modules/js-yaml/dist/js-yaml.mjs
|
|
4
4
|
function isNothing(subject) {
|
|
5
5
|
return typeof subject === "undefined" || subject === null;
|
|
6
6
|
}
|
|
@@ -864,6 +864,18 @@ function charFromCodepoint(c) {
|
|
|
864
864
|
(c - 65536 & 1023) + 56320
|
|
865
865
|
);
|
|
866
866
|
}
|
|
867
|
+
function setProperty(object, key, value) {
|
|
868
|
+
if (key === "__proto__") {
|
|
869
|
+
Object.defineProperty(object, key, {
|
|
870
|
+
configurable: true,
|
|
871
|
+
enumerable: true,
|
|
872
|
+
writable: true,
|
|
873
|
+
value
|
|
874
|
+
});
|
|
875
|
+
} else {
|
|
876
|
+
object[key] = value;
|
|
877
|
+
}
|
|
878
|
+
}
|
|
867
879
|
var simpleEscapeCheck = new Array(256);
|
|
868
880
|
var simpleEscapeMap = new Array(256);
|
|
869
881
|
for (i = 0; i < 256; i++) {
|
|
@@ -983,7 +995,7 @@ function mergeMappings(state, destination, source, overridableKeys) {
|
|
|
983
995
|
for (index = 0, quantity = sourceKeys.length; index < quantity; index += 1) {
|
|
984
996
|
key = sourceKeys[index];
|
|
985
997
|
if (!_hasOwnProperty$1.call(destination, key)) {
|
|
986
|
-
destination
|
|
998
|
+
setProperty(destination, key, source[key]);
|
|
987
999
|
overridableKeys[key] = true;
|
|
988
1000
|
}
|
|
989
1001
|
}
|
|
@@ -1023,16 +1035,7 @@ function storeMappingPair(state, _result, overridableKeys, keyTag, keyNode, valu
|
|
|
1023
1035
|
state.position = startPos || state.position;
|
|
1024
1036
|
throwError(state, "duplicated mapping key");
|
|
1025
1037
|
}
|
|
1026
|
-
|
|
1027
|
-
Object.defineProperty(_result, keyNode, {
|
|
1028
|
-
configurable: true,
|
|
1029
|
-
enumerable: true,
|
|
1030
|
-
writable: true,
|
|
1031
|
-
value: valueNode
|
|
1032
|
-
});
|
|
1033
|
-
} else {
|
|
1034
|
-
_result[keyNode] = valueNode;
|
|
1035
|
-
}
|
|
1038
|
+
setProperty(_result, keyNode, valueNode);
|
|
1036
1039
|
delete overridableKeys[keyNode];
|
|
1037
1040
|
}
|
|
1038
1041
|
return _result;
|
|
@@ -2620,7 +2623,6 @@ var jsYaml = {
|
|
|
2620
2623
|
safeLoadAll,
|
|
2621
2624
|
safeDump
|
|
2622
2625
|
};
|
|
2623
|
-
var js_yaml_default = jsYaml;
|
|
2624
2626
|
export {
|
|
2625
2627
|
CORE_SCHEMA,
|
|
2626
2628
|
DEFAULT_SCHEMA,
|
|
@@ -2629,7 +2631,7 @@ export {
|
|
|
2629
2631
|
Schema,
|
|
2630
2632
|
Type,
|
|
2631
2633
|
YAMLException,
|
|
2632
|
-
|
|
2634
|
+
jsYaml as default,
|
|
2633
2635
|
dump,
|
|
2634
2636
|
load,
|
|
2635
2637
|
loadAll,
|
|
@@ -2641,5 +2643,5 @@ export {
|
|
|
2641
2643
|
/*! Bundled license information:
|
|
2642
2644
|
|
|
2643
2645
|
js-yaml/dist/js-yaml.mjs:
|
|
2644
|
-
(*! js-yaml 4.1.
|
|
2646
|
+
(*! js-yaml 4.1.1 https://github.com/nodeca/js-yaml @license MIT *)
|
|
2645
2647
|
*/
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";Object.defineProperty(exports, "__esModule", {value: true});require('./chunk-NJK5F5TF.cjs');
|
|
2
|
+
|
|
3
|
+
// src/docs/targeting.json
|
|
4
|
+
var targeting_default = '# Targeting API\n\n- **Base URL:** `https://targeting.sls.epilot.io`\n- **Full API Docs:** [https://docs.epilot.io/api/targeting](https://docs.epilot.io/api/targeting)\n\n## Usage\n\n```ts\nimport { epilot } from \'@epilot/sdk\'\n\nepilot.authorize(() => \'<token>\')\nconst { data } = await epilot.targeting.changeCampaignStatus(...)\n```\n\n### Tree-shakeable import\n\n```ts\nimport { getClient, authorize } from \'@epilot/sdk/targeting\'\n\nconst targetingClient = getClient()\nauthorize(targetingClient, () => \'<token>\')\nconst { data } = await targetingClient.changeCampaignStatus(...)\n```\n\n## Operations\n\n**Campaign**\n- [`changeCampaignStatus`](#changecampaignstatus)\n- [`getCampaignJobStatus`](#getcampaignjobstatus)\n- [`getCampaignPortals`](#getcampaignportals)\n- [`setupCampaign`](#setupcampaign)\n- [`matchCampaigns`](#matchcampaigns)\n- [`discoverCampaigns`](#discovercampaigns)\n\n**Campaign Delivery**\n- [`retriggerCampaignAutomations`](#retriggercampaignautomations)\n\n**Target**\n- [`matchTargets`](#matchtargets)\n- [`getTargetQueries`](#gettargetqueries)\n\n**Campaign Recipient**\n- [`createRecipient`](#createrecipient)\n- [`updateRecipient`](#updaterecipient)\n- [`updateRecipientPortalStatus`](#updaterecipientportalstatus)\n- [`updateRecipientEntityUiStatus`](#updaterecipiententityuistatus)\n- [`restoreRecipientEntityUiStatus`](#restorerecipiententityuistatus)\n- [`getRecipients`](#getrecipients)\n- [`getEmailStats`](#getemailstats)\n\n**Schemas**\n- [`BaseError`](#baseerror)\n- [`ServerError`](#servererror)\n- [`ClientError`](#clienterror)\n- [`BaseUUID`](#baseuuid)\n- [`BaseNanoID`](#basenanoid)\n- [`BaseTags`](#basetags)\n- [`BaseRelation`](#baserelation)\n- [`BaseSystemId`](#basesystemid)\n- [`BaseEntityOwner`](#baseentityowner)\n- [`BaseEntityAcl`](#baseentityacl)\n- [`BaseSystemFields`](#basesystemfields)\n- [`BaseSystemFieldsRequired`](#basesystemfieldsrequired)\n- [`CampaignStatus`](#campaignstatus)\n- [`ExecutionSummaryItem`](#executionsummaryitem)\n- [`JobStatus`](#jobstatus)\n- [`Campaign`](#campaign)\n- [`Target`](#target)\n- [`MatchCampaignParams`](#matchcampaignparams)\n- [`NextBestAction`](#nextbestaction)\n- [`DiscoverCampaignsParams`](#discovercampaignsparams)\n- [`DiscoverResult`](#discoverresult)\n- [`MatchTargetParams`](#matchtargetparams)\n- [`GetTargetQueriesParams`](#gettargetqueriesparams)\n- [`TargetQueryResult`](#targetqueryresult)\n- [`AutomationStatus`](#automationstatus)\n- [`PortalStatus`](#portalstatus)\n- [`EntityUiStatus`](#entityuistatus)\n- [`EmailStatus`](#emailstatus)\n- [`EmailBounceType`](#emailbouncetype)\n- [`Recipient`](#recipient)\n- [`BaseRecipientPayload`](#baserecipientpayload)\n- [`AutomationRecipientPayload`](#automationrecipientpayload)\n- [`PortalRecipientPayload`](#portalrecipientpayload)\n- [`CreateRecipientPayload`](#createrecipientpayload)\n- [`UpdateRecipientPayload`](#updaterecipientpayload)\n- [`RetriggerAutomationsRequest`](#retriggerautomationsrequest)\n- [`RetriggerAutomationsResult`](#retriggerautomationsresult)\n- [`UpdatePortalStatusRequest`](#updateportalstatusrequest)\n- [`UpdateEntityUiStatusRequest`](#updateentityuistatusrequest)\n- [`SetupCampaignRequest`](#setupcampaignrequest)\n- [`SetupTariffChangeCampaignRequest`](#setuptariffchangecampaignrequest)\n- [`SetupTariffChangeCampaignResponse`](#setuptariffchangecampaignresponse)\n\n### `changeCampaignStatus`\n\nChange the status of a campaign to a desired status.\n\n`POST /v1/campaign/{campaign_id}/status`\n\n```ts\nconst { data } = await client.changeCampaignStatus({\n campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "campaign": {\n "_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "_org": "string",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "string",\n "_title": "string",\n "_tags": ["string"],\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_acl": {\n "view": ["org:456"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "name": "string",\n "goal": "string",\n "status": "draft",\n "start_date": "1970-01-01",\n "end_date": "1970-01-01",\n "flow_id": "string",\n "job_id": "string",\n "target": {\n "$relation": [\n {\n "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "_tags": ["string"]\n }\n ]\n }\n }\n}\n```\n\n</details>\n\n---\n\n### `getCampaignJobStatus`\n\nGet the status of a campaign\'s automation job\n\n`GET /v1/campaign/{campaign_id}/job`\n\n```ts\nconst { data } = await client.getCampaignJobStatus({\n campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "status": "queued",\n "execution_summary": [\n {\n "execution_id": "string",\n "execution_status": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getCampaignPortals`\n\nGet the list of portals and its widgets where the campaign is used.\n\n`GET /v1/campaign/{campaign_id}/portals`\n\n```ts\nconst { data } = await client.getCampaignPortals({\n campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n[\n {\n "portal": {\n "origin": "string",\n "domain": "string",\n "name": "string"\n },\n "widgets": [\n {\n "id": "string",\n "headline": {\n "en": "string",\n "de": "string"\n }\n }\n ]\n }\n]\n```\n\n</details>\n\n---\n\n### `retriggerCampaignAutomations`\n\nRetrigger automation executions for specific campaign recipients that have failed.\n\n`POST /v1/campaign/{campaign_id}/automations:retrigger`\n\n```ts\nconst { data } = await client.retriggerCampaignAutomations(\n {\n campaign_id: \'example\',\n },\n {\n recipient_ids: [\'3fa85f64-5717-4562-b3fc-2c963f66afa6\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "message": "string",\n "results": [\n {\n "recipient_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\n "result": "success",\n "execution_id": "string",\n "error": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `setupCampaign`\n\nCreates a `campaign` entity together with its related entities and configurations in a single call.\nUsed by the campaign wizard UI, but not restricted to it.\n\n`POST /v1/campaign:setup`\n\n```ts\nconst { data } = await client.setupCampaign(\n null,\n {\n type: \'tariff_change\',\n product_recommendation: {\n name: \'string\',\n source_product_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n source_price_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n offers: [\n {\n target_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n items: [\n {\n product_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n price_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n highlight_config: {}\n }\n ]\n }\n ]\n },\n campaign: {\n name: \'string\',\n goal: \'string\',\n target_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n },\n journey: {\n journey_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\'\n },\n channels: {\n portal_widget: {\n portal_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n block_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\'\n },\n email: {\n automation_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n template_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\'\n }\n }\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "type": "tariff_change",\n "product_recommendation_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "campaign_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "journey_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "portal_widget_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84"\n}\n```\n\n</details>\n\n---\n\n### `matchCampaigns`\n\nMatch campaigns based on target entities.\n\n`POST /v1/campaign:match`\n\n```ts\nconst { data } = await client.matchCampaigns(\n null,\n {\n entity_refs: [\n {\n entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n entity_schema: \'string\'\n }\n ],\n campaign_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 0,\n "results": [\n {\n "campaign": {\n "_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "_org": "string",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "string",\n "_title": "string",\n "_tags": ["string"],\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_acl": {\n "view": ["org:456"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "name": "string",\n "goal": "string",\n "status": "draft",\n "start_date": "1970-01-01",\n "end_date": "1970-01-01",\n "flow_id": "string",\n "job_id": "string",\n "target": {\n "$relation": [\n {\n "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "_tags": ["string"]\n }\n ]\n }\n }\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `discoverCampaigns`\n\nGiven an entity, returns the Next Best Actions it should see on the Entity-UI channel.\n\n`POST /v1/campaign:discover`\n\n```ts\nconst { data } = await client.discoverCampaigns(\n null,\n {\n entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n entity_schema: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 0,\n "results": [\n {\n "campaign_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "nba": {\n "category": "string",\n "icon": {\n "name": "string",\n "color": "string"\n },\n "title": "string",\n "body": "string",\n "priority": "medium",\n "is_dismissable": true,\n "cta": {\n "type": "journey",\n "target": "string",\n "context_params": [\n {\n "key": "string",\n "value": "string"\n }\n ]\n }\n },\n "status": "seen",\n "status_updated_at": "1970-01-01T00:00:00.000Z"\n }\n ],\n "dismissed": [\n {\n "campaign_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "nba": {\n "category": "string",\n "icon": {\n "name": "string",\n "color": "string"\n },\n "title": "string",\n "body": "string",\n "priority": "medium",\n "is_dismissable": true,\n "cta": {\n "type": "journey",\n "target": "string",\n "context_params": [\n {\n "key": "string",\n "value": "string"\n }\n ]\n }\n },\n "status": "seen",\n "status_updated_at": "1970-01-01T00:00:00.000Z"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `matchTargets`\n\nFind targets from the provided list that include the provide entities.\n\n`POST /v1/target:match`\n\n```ts\nconst { data } = await client.matchTargets(\n null,\n {\n entity_refs: [\n {\n entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n entity_schema: \'string\'\n }\n ],\n target_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "hits": 0,\n "results": [\n {\n "target": {\n "_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "_org": "string",\n "_owners": [\n {\n "org_id": "123",\n "user_id": "123"\n }\n ],\n "_schema": "string",\n "_title": "string",\n "_tags": ["string"],\n "_created_at": "1970-01-01T00:00:00.000Z",\n "_updated_at": "1970-01-01T00:00:00.000Z",\n "_acl": {\n "view": ["org:456"],\n "edit": ["org:456"],\n "delete": ["org:456"]\n },\n "name": "string",\n "description": "string",\n "entity_schema": "string",\n "entity_filters": {}\n }\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `getTargetQueries`\n\nTransform target filters into Lucene queries for the provided target IDs.\nReturns the transformed query string for each target along with any errors encountered.\n\n`POST /v1/target/queries`\n\n```ts\nconst { data } = await client.getTargetQueries(\n null,\n {\n target_ids: [\'b8c01433-5556-4e2b-aad4-6f5348d1df84\']\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "target_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "query": "string",\n "error": "string"\n }\n ]\n}\n```\n\n</details>\n\n---\n\n### `createRecipient`\n\nCreates a new recipient associated with a campaign.\n\n`POST /v1/campaign/{campaign_id}/recipient`\n\n```ts\nconst { data } = await client.createRecipient(\n {\n campaign_id: \'example\',\n },\n {\n entity_id: \'b8c01433-5556-4e2b-aad4-6f5348d1df84\',\n entity_schema: \'string\',\n automation_status: \'pending\',\n automation_execution_id: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "entity_schema": "string",\n "title": "string",\n "automation_status": "pending",\n "automation_execution_id": "string",\n "portal_status": "sent",\n "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n "portal_state": {},\n "entity_ui_status": "seen",\n "entity_ui_status_updated_at": "1970-01-01T00:00:00.000Z",\n "entity_ui_status_before_dismiss": "seen",\n "message_entity_id": "string",\n "email_status": "sent",\n "email_status_updated_at": "1970-01-01T00:00:00.000Z",\n "email_bounce_type": "permanent",\n "email_bounce_subtype": "string",\n "email_complaint_type": "string",\n "email_bounce_reason": "string",\n "email_send_error": {},\n "email_unsubscribed_at": "1970-01-01T00:00:00.000Z",\n "email_open_count": 0,\n "email_first_opened_at": "1970-01-01T00:00:00.000Z",\n "email_last_opened_at": "1970-01-01T00:00:00.000Z",\n "email_click_count": 0,\n "email_first_clicked_at": "1970-01-01T00:00:00.000Z",\n "email_clicked_links": [\n {\n "url": "string",\n "clicked_at": "1970-01-01T00:00:00.000Z"\n }\n ],\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateRecipient`\n\nUpdates a recipient\'s attributes.\n\n`PATCH /v1/campaign/{campaign_id}/recipient/{recipient_id}`\n\n```ts\nconst { data } = await client.updateRecipient(\n {\n campaign_id: \'example\',\n recipient_id: \'example\',\n },\n {\n automation_status: \'pending\',\n automation_execution_id: \'string\',\n portal_status: \'sent\',\n portal_state: {}\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "entity_schema": "string",\n "title": "string",\n "automation_status": "pending",\n "automation_execution_id": "string",\n "portal_status": "sent",\n "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n "portal_state": {},\n "entity_ui_status": "seen",\n "entity_ui_status_updated_at": "1970-01-01T00:00:00.000Z",\n "entity_ui_status_before_dismiss": "seen",\n "message_entity_id": "string",\n "email_status": "sent",\n "email_status_updated_at": "1970-01-01T00:00:00.000Z",\n "email_bounce_type": "permanent",\n "email_bounce_subtype": "string",\n "email_complaint_type": "string",\n "email_bounce_reason": "string",\n "email_send_error": {},\n "email_unsubscribed_at": "1970-01-01T00:00:00.000Z",\n "email_open_count": 0,\n "email_first_opened_at": "1970-01-01T00:00:00.000Z",\n "email_last_opened_at": "1970-01-01T00:00:00.000Z",\n "email_click_count": 0,\n "email_first_clicked_at": "1970-01-01T00:00:00.000Z",\n "email_clicked_links": [\n {\n "url": "string",\n "clicked_at": "1970-01-01T00:00:00.000Z"\n }\n ],\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateRecipientPortalStatus`\n\nUpdates the portal status for a specific campaign recipient.\nThe portal_status_updated_at timestamp is automatically set when the status changes.\n\n`PATCH /v1/campaign/{campaign_id}/recipient/{recipient_id}/portal:status`\n\n```ts\nconst { data } = await client.updateRecipientPortalStatus(\n {\n campaign_id: \'example\',\n recipient_id: \'example\',\n },\n {\n status: \'sent\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "entity_schema": "string",\n "title": "string",\n "automation_status": "pending",\n "automation_execution_id": "string",\n "portal_status": "sent",\n "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n "portal_state": {},\n "entity_ui_status": "seen",\n "entity_ui_status_updated_at": "1970-01-01T00:00:00.000Z",\n "entity_ui_status_before_dismiss": "seen",\n "message_entity_id": "string",\n "email_status": "sent",\n "email_status_updated_at": "1970-01-01T00:00:00.000Z",\n "email_bounce_type": "permanent",\n "email_bounce_subtype": "string",\n "email_complaint_type": "string",\n "email_bounce_reason": "string",\n "email_send_error": {},\n "email_unsubscribed_at": "1970-01-01T00:00:00.000Z",\n "email_open_count": 0,\n "email_first_opened_at": "1970-01-01T00:00:00.000Z",\n "email_last_opened_at": "1970-01-01T00:00:00.000Z",\n "email_click_count": 0,\n "email_first_clicked_at": "1970-01-01T00:00:00.000Z",\n "email_clicked_links": [\n {\n "url": "string",\n "clicked_at": "1970-01-01T00:00:00.000Z"\n }\n ],\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `updateRecipientEntityUiStatus`\n\nRecords a Next Best Action interaction for a recipient on the Entity-UI channel.\n\n`PATCH /v1/campaign/{campaign_id}/recipient/{recipient_id}/entity_ui:status`\n\n```ts\nconst { data } = await client.updateRecipientEntityUiStatus(\n {\n campaign_id: \'example\',\n recipient_id: \'example\',\n },\n {\n status: \'seen\',\n entity_schema: \'string\'\n },\n)\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "entity_schema": "string",\n "title": "string",\n "automation_status": "pending",\n "automation_execution_id": "string",\n "portal_status": "sent",\n "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n "portal_state": {},\n "entity_ui_status": "seen",\n "entity_ui_status_updated_at": "1970-01-01T00:00:00.000Z",\n "entity_ui_status_before_dismiss": "seen",\n "message_entity_id": "string",\n "email_status": "sent",\n "email_status_updated_at": "1970-01-01T00:00:00.000Z",\n "email_bounce_type": "permanent",\n "email_bounce_subtype": "string",\n "email_complaint_type": "string",\n "email_bounce_reason": "string",\n "email_send_error": {},\n "email_unsubscribed_at": "1970-01-01T00:00:00.000Z",\n "email_open_count": 0,\n "email_first_opened_at": "1970-01-01T00:00:00.000Z",\n "email_last_opened_at": "1970-01-01T00:00:00.000Z",\n "email_click_count": 0,\n "email_first_clicked_at": "1970-01-01T00:00:00.000Z",\n "email_clicked_links": [\n {\n "url": "string",\n "clicked_at": "1970-01-01T00:00:00.000Z"\n }\n ],\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `restoreRecipientEntityUiStatus`\n\nUndo a dismissal on the Entity-UI (Next Best Action) channel\n\n`POST /v1/campaign/{campaign_id}/recipient/{recipient_id}/entity_ui:restore`\n\n```ts\nconst { data } = await client.restoreRecipientEntityUiStatus({\n campaign_id: \'example\',\n recipient_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "entity_schema": "string",\n "title": "string",\n "automation_status": "pending",\n "automation_execution_id": "string",\n "portal_status": "sent",\n "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n "portal_state": {},\n "entity_ui_status": "seen",\n "entity_ui_status_updated_at": "1970-01-01T00:00:00.000Z",\n "entity_ui_status_before_dismiss": "seen",\n "message_entity_id": "string",\n "email_status": "sent",\n "email_status_updated_at": "1970-01-01T00:00:00.000Z",\n "email_bounce_type": "permanent",\n "email_bounce_subtype": "string",\n "email_complaint_type": "string",\n "email_bounce_reason": "string",\n "email_send_error": {},\n "email_unsubscribed_at": "1970-01-01T00:00:00.000Z",\n "email_open_count": 0,\n "email_first_opened_at": "1970-01-01T00:00:00.000Z",\n "email_last_opened_at": "1970-01-01T00:00:00.000Z",\n "email_click_count": 0,\n "email_first_clicked_at": "1970-01-01T00:00:00.000Z",\n "email_clicked_links": [\n {\n "url": "string",\n "clicked_at": "1970-01-01T00:00:00.000Z"\n }\n ],\n "updated_at": "1970-01-01T00:00:00.000Z"\n}\n```\n\n</details>\n\n---\n\n### `getRecipients`\n\nGet a paginated list of recipients for a campaign.\n\n`GET /v1/campaign/{campaign_id}/recipients`\n\n```ts\nconst { data } = await client.getRecipients({\n campaign_id: \'example\',\n limit: 1,\n next: \'example\',\n q: \'example\',\n automation_status: [\'...\'],\n portal_status: \'example\',\n email_status: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "results": [\n {\n "entity_id": "b8c01433-5556-4e2b-aad4-6f5348d1df84",\n "entity_schema": "string",\n "title": "string",\n "automation_status": "pending",\n "automation_execution_id": "string",\n "portal_status": "sent",\n "portal_status_updated_at": "1970-01-01T00:00:00.000Z",\n "portal_state": {},\n "entity_ui_status": "seen",\n "entity_ui_status_updated_at": "1970-01-01T00:00:00.000Z",\n "entity_ui_status_before_dismiss": "seen",\n "message_entity_id": "string",\n "email_status": "sent",\n "email_status_updated_at": "1970-01-01T00:00:00.000Z",\n "email_bounce_type": "permanent",\n "email_bounce_subtype": "string",\n "email_complaint_type": "string",\n "email_bounce_reason": "string",\n "email_send_error": {},\n "email_unsubscribed_at": "1970-01-01T00:00:00.000Z",\n "email_open_count": 0,\n "email_first_opened_at": "1970-01-01T00:00:00.000Z",\n "email_last_opened_at": "1970-01-01T00:00:00.000Z",\n "email_click_count": 0,\n "email_first_clicked_at": "1970-01-01T00:00:00.000Z",\n "email_clicked_links": [\n {\n "url": "string",\n "clicked_at": "1970-01-01T00:00:00.000Z"\n }\n ],\n "updated_at": "1970-01-01T00:00:00.000Z"\n }\n ],\n "next": "string",\n "total": 0\n}\n```\n\n</details>\n\n---\n\n### `getEmailStats`\n\nAggregate email delivery counts for a campaign, for the KPI summary on the campaign UI.\nCounts cover the email (automation) channel only; `total_emailed` is the number of\nrecipients with a recorded em\n\n`GET /v1/campaign/{campaign_id}/email-stats`\n\n```ts\nconst { data } = await client.getEmailStats({\n campaign_id: \'example\',\n})\n```\n\n<details>\n<summary>Response</summary>\n\n```json\n{\n "total_emailed": 0,\n "sent": 0,\n "delivered": 0,\n "bounced": 0,\n "bounced_hard": 0,\n "bounced_soft": 0,\n "complained": 0,\n "failed": 0,\n "unsubscribed": 0,\n "opened": 0,\n "clicked": 0,\n "total_opens": 0,\n "total_clicks": 0\n}\n```\n\n</details>\n\n---\n\n## Schemas\n\n### `BaseError`\n\n```ts\ntype BaseError = {\n status: number\n message: string\n}\n```\n\n### `ServerError`\n\n```ts\ntype ServerError = {\n status: number\n message: string\n}\n```\n\n### `ClientError`\n\nDescribes the structure of a client error response, which can be one of several types:\n1. `MessageError`: Contains a \'message\' field for general descriptive errors.\n2. `CodeError`: Contains a \'code\' field for specific, machine-readable error codes.\n3. `StatusedError`: Contains \'error\' and \'status\' f\n\n```ts\ntype ClientError = {\n message: string\n} | {\n code: "CAMPAIGN_NOT_FOUND" | "CAMPAIGN_HAS_NO_TARGET" | "CAMPAIGN_HAS_NO_DELIVERY_METHOD" | "INVALID_NEXT_BEST_ACTION" | "CAMPAIGN_HAS_JOB_IN_PROGRESS" | "CAMPAIGN_HAS_UNEXPECTED_STATUS" | "JOB_TOKEN_MISSING" | "TARGET_WITHOUT_FILTERS"\n} | {\n error: string\n status: number\n}\n```\n\n### `BaseUUID`\n\n```ts\ntype BaseUUID = string // uuid\n```\n\n### `BaseNanoID`\n\n```ts\ntype BaseNanoID = string\n```\n\n### `BaseTags`\n\n```ts\ntype BaseTags = string[]\n```\n\n### `BaseRelation`\n\n```ts\ntype BaseRelation = {\n $relation?: Array<{\n entity_id?: string // uuid\n _tags?: string[]\n }>\n}\n```\n\n### `BaseSystemId`\n\n```ts\ntype BaseSystemId = {\n _id: string // uuid\n}\n```\n\n### `BaseEntityOwner`\n\nThe user / organization owning this entity.\n\nNote: Owner implicitly has access to the entity regardless of ACLs.\n\n\n```ts\ntype BaseEntityOwner = {\n org_id: string\n user_id?: string\n}\n```\n\n### `BaseEntityAcl`\n\nAccess control list (ACL) for an entity. Defines sharing access to external orgs or users.\n\n```ts\ntype BaseEntityAcl = {\n view?: string[]\n edit?: string[]\n delete?: string[]\n}\n```\n\n### `BaseSystemFields`\n\n```ts\ntype BaseSystemFields = {\n _id?: string // uuid\n _org?: string\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n}\n```\n\n### `BaseSystemFieldsRequired`\n\n```ts\ntype BaseSystemFieldsRequired = object\n```\n\n### `CampaignStatus`\n\n```ts\ntype CampaignStatus = "draft" | "activating" | "active" | "inactive"\n```\n\n### `ExecutionSummaryItem`\n\n```ts\ntype ExecutionSummaryItem = {\n execution_id?: string\n execution_status?: string\n}\n```\n\n### `JobStatus`\n\n```ts\ntype JobStatus = {\n status?: "queued" | "processing" | "finished" | "failed" | "cancelled" | "send_report"\n execution_summary?: Array<{\n execution_id?: string\n execution_status?: string\n }>\n}\n```\n\n### `Campaign`\n\n```ts\ntype Campaign = {\n _id?: string // uuid\n _org?: string\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n name?: string\n goal?: string\n status?: "draft" | "activating" | "active" | "inactive"\n start_date?: string // date\n end_date?: string // date\n flow_id?: string\n job_id?: string\n target?: {\n $relation?: Array<{\n entity_id?: { ... }\n _tags?: { ... }\n }>\n }\n}\n```\n\n### `Target`\n\n```ts\ntype Target = {\n _id?: string // uuid\n _org?: string\n _owners?: Array<{\n org_id: string\n user_id?: string\n }>\n _schema?: string\n _title?: string\n _tags?: string[]\n _created_at?: string // date-time\n _updated_at?: string // date-time\n _acl?: {\n view?: string[]\n edit?: string[]\n delete?: string[]\n }\n name?: string\n description?: string\n entity_schema?: string\n entity_filters?: Record<string, unknown>\n}\n```\n\n### `MatchCampaignParams`\n\n```ts\ntype MatchCampaignParams = {\n entity_refs: Array<{\n entity_id: string // uuid\n entity_schema: string\n }>\n campaign_ids: string // uuid[]\n}\n```\n\n### `NextBestAction`\n\nA Next Best Action configured on a campaign\'s Entity-UI channel.\nThis is the canonical NBA contract shared by discovery (this API), authoring, and rendering.\nNBA content is single-language in v1; text fields may contain `{{placeholders}}` resolved at render time.\n\n\n```ts\ntype NextBestAction = {\n category?: string\n icon?: {\n name: string\n color?: string\n }\n title: string\n body?: string\n priority?: "low" | "medium" | "high"\n is_dismissable?: boolean\n cta: {\n type: "journey" | "workflow" | "flow"\n target: string\n context_params?: Array<{\n key: { ... }\n value: { ... }\n }>\n }\n}\n```\n\n### `DiscoverCampaignsParams`\n\n```ts\ntype DiscoverCampaignsParams = {\n entity_id: string // uuid\n entity_schema: string\n}\n```\n\n### `DiscoverResult`\n\nOne discovered Next Best Action, plus this entity\'s interaction state for it.\n\n```ts\ntype DiscoverResult = {\n campaign_id: string // uuid\n nba: {\n category?: string\n icon?: {\n name: { ... }\n color?: { ... }\n }\n title: string\n body?: string\n priority?: "low" | "medium" | "high"\n is_dismissable?: boolean\n cta: {\n type: { ... }\n target: { ... }\n context_params?: { ... }\n }\n }\n status?: "seen" | "dismissed" | "clicked"\n status_updated_at?: string // date-time\n}\n```\n\n### `MatchTargetParams`\n\n```ts\ntype MatchTargetParams = {\n entity_refs: Array<{\n entity_id: string // uuid\n entity_schema: string\n }>\n target_ids: string // uuid[]\n}\n```\n\n### `GetTargetQueriesParams`\n\n```ts\ntype GetTargetQueriesParams = {\n target_ids: string // uuid[]\n}\n```\n\n### `TargetQueryResult`\n\n```ts\ntype TargetQueryResult = {\n target_id: string // uuid\n query: string\n error?: string\n}\n```\n\n### `AutomationStatus`\n\n```ts\ntype AutomationStatus = "pending" | "in_progress" | "success" | "failed" | "cancelled"\n```\n\n### `PortalStatus`\n\n```ts\ntype PortalStatus = "sent" | "seen" | "dismissed" | "clicked"\n```\n\n### `EntityUiStatus`\n\nLifecycle status of a Next Best Action on the Entity-UI channel. Unlike the portal\nchannel there is no `sent` state: an NBA recipient is born at `seen`, the moment the\naction is first rendered to an agent.\n\n\n```ts\ntype EntityUiStatus = "seen" | "dismissed" | "clicked"\n```\n\n### `EmailStatus`\n\nDelivery status of the email a campaign\'s automation sends to a recipient. Set to `sent`\nonce the automation hands the email off, then updated asynchronously as SES notifications\narrive (`bounced` / `complained`; an SES Reject maps to `bounced`). `failed` is a send-time\nfailure (the automation execu\n\n```ts\ntype EmailStatus = "sent" | "delivered" | "bounced" | "complained" | "failed"\n```\n\n### `EmailBounceType`\n\nSES bounce classification: `permanent` (hard) or `transient` (soft).\n\n```ts\ntype EmailBounceType = "permanent" | "transient"\n```\n\n### `Recipient`\n\n```ts\ntype Recipient = {\n entity_id?: string // uuid\n entity_schema?: string\n title?: string\n automation_status?: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n automation_execution_id?: string\n portal_status?: "sent" | "seen" | "dismissed" | "clicked"\n portal_status_updated_at?: string // date-time\n portal_state?: Record<string, unknown>\n entity_ui_status?: "seen" | "dismissed" | "clicked"\n entity_ui_status_updated_at?: string // date-time\n entity_ui_status_before_dismiss?: "seen" | "dismissed" | "clicked"\n message_entity_id?: string\n email_status?: "sent" | "delivered" | "bounced" | "complained" | "failed"\n email_status_updated_at?: string // date-time\n email_bounce_type?: "permanent" | "transient"\n email_bounce_subtype?: string\n email_complaint_type?: string\n email_bounce_reason?: string\n email_send_error?: Record<string, unknown>\n email_unsubscribed_at?: string // date-time\n email_open_count?: number\n email_first_opened_at?: string // date-time\n email_last_opened_at?: string // date-time\n email_click_count?: number\n email_first_clicked_at?: string // date-time\n email_clicked_links?: Array<{\n url: string\n clicked_at: string // date-time\n }>\n updated_at?: string // date-time\n}\n```\n\n### `BaseRecipientPayload`\n\n```ts\ntype BaseRecipientPayload = {\n entity_id: string // uuid\n entity_schema: string\n}\n```\n\n### `AutomationRecipientPayload`\n\n```ts\ntype AutomationRecipientPayload = {\n automation_status: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n automation_execution_id: string\n}\n```\n\n### `PortalRecipientPayload`\n\n```ts\ntype PortalRecipientPayload = {\n portal_status: "sent" | "seen" | "dismissed" | "clicked"\n portal_state?: Record<string, unknown>\n}\n```\n\n### `CreateRecipientPayload`\n\n```ts\ntype CreateRecipientPayload = {\n entity_id: string // uuid\n entity_schema: string\n automation_status: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n automation_execution_id: string\n} | {\n entity_id: string // uuid\n entity_schema: string\n portal_status: "sent" | "seen" | "dismissed" | "clicked"\n portal_state?: Record<string, unknown>\n} | {\n entity_id: string // uuid\n entity_schema: string\n automation_status: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n automation_execution_id: string\n portal_status: "sent" | "seen" | "dismissed" | "clicked"\n portal_state?: Record<string, unknown>\n}\n```\n\n### `UpdateRecipientPayload`\n\n```ts\ntype UpdateRecipientPayload = {\n automation_status?: "pending" | "in_progress" | "success" | "failed" | "cancelled"\n automation_execution_id?: string\n portal_status?: "sent" | "seen" | "dismissed" | "clicked"\n portal_state?: Record<string, unknown>\n}\n```\n\n### `RetriggerAutomationsRequest`\n\n```ts\ntype RetriggerAutomationsRequest = {\n recipient_ids: string // uuid[]\n}\n```\n\n### `RetriggerAutomationsResult`\n\n```ts\ntype RetriggerAutomationsResult = {\n recipient_id: string // uuid\n result: "success" | "failure" | "not_found" | "invalid_status"\n execution_id?: string\n error?: string\n}\n```\n\n### `UpdatePortalStatusRequest`\n\n```ts\ntype UpdatePortalStatusRequest = {\n status: "sent" | "seen" | "dismissed" | "clicked"\n}\n```\n\n### `UpdateEntityUiStatusRequest`\n\n```ts\ntype UpdateEntityUiStatusRequest = {\n status: "seen" | "dismissed" | "clicked"\n entity_schema?: string\n}\n```\n\n### `SetupCampaignRequest`\n\nDiscriminated by `type`. Each campaign variant has its own request shape;\nnew variants are added by introducing a new schema and extending the `oneOf` list.\n\n\n```ts\ntype SetupCampaignRequest = {\n type: "tariff_change"\n product_recommendation: {\n name?: string\n source_product_id?: string // uuid\n source_price_id?: string // uuid\n offers?: Array<{\n target_id?: { ... }\n items: { ... }\n }>\n }\n campaign: {\n name: string\n goal?: string\n target_ids: string // uuid[]\n }\n journey?: {\n journey_id: string // uuid\n }\n channels?: {\n portal_widget?: {\n portal_id: { ... }\n block_id: { ... }\n }\n email?: {\n automation_id?: { ... }\n template_id?: { ... }\n }\n }\n}\n```\n\n### `SetupTariffChangeCampaignRequest`\n\n```ts\ntype SetupTariffChangeCampaignRequest = {\n type: "tariff_change"\n product_recommendation: {\n name?: string\n source_product_id?: string // uuid\n source_price_id?: string // uuid\n offers?: Array<{\n target_id?: { ... }\n items: { ... }\n }>\n }\n campaign: {\n name: string\n goal?: string\n target_ids: string // uuid[]\n }\n journey?: {\n journey_id: string // uuid\n }\n channels?: {\n portal_widget?: {\n portal_id: { ... }\n block_id: { ... }\n }\n email?: {\n automation_id?: { ... }\n template_id?: { ... }\n }\n }\n}\n```\n\n### `SetupTariffChangeCampaignResponse`\n\n```ts\ntype SetupTariffChangeCampaignResponse = {\n type: "tariff_change"\n product_recommendation_id: string // uuid\n campaign_id: string // uuid\n journey_id?: string // uuid\n portal_widget_id?: string // uuid\n}\n```\n';
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
exports.default = targeting_default;
|