@getlatedev/node 0.2.13 → 0.2.15
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/dist/index.d.mts +222 -28
- package/dist/index.d.ts +222 -28
- package/package.json +1 -1
- package/src/generated/types.gen.ts +208 -14
package/dist/index.d.mts
CHANGED
|
@@ -428,30 +428,30 @@ declare class Zernio {
|
|
|
428
428
|
*/
|
|
429
429
|
broadcasts: {
|
|
430
430
|
listBroadcasts: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListBroadcastsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListBroadcastsResponse, ListBroadcastsError, ThrowOnError>;
|
|
431
|
-
createBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
432
|
-
getBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
433
|
-
updateBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
431
|
+
createBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateBroadcastResponse, CreateBroadcastError, ThrowOnError>;
|
|
432
|
+
getBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetBroadcastResponse, GetBroadcastError, ThrowOnError>;
|
|
433
|
+
updateBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateBroadcastResponse, UpdateBroadcastError, ThrowOnError>;
|
|
434
434
|
deleteBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, DeleteBroadcastError, ThrowOnError>;
|
|
435
435
|
sendBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SendBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SendBroadcastResponse, unknown, ThrowOnError>;
|
|
436
|
-
scheduleBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ScheduleBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
437
|
-
cancelBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CancelBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
438
|
-
listBroadcastRecipients: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListBroadcastRecipientsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
439
|
-
addBroadcastRecipients: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AddBroadcastRecipientsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
436
|
+
scheduleBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ScheduleBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ScheduleBroadcastResponse, unknown, ThrowOnError>;
|
|
437
|
+
cancelBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CancelBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CancelBroadcastResponse, unknown, ThrowOnError>;
|
|
438
|
+
listBroadcastRecipients: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListBroadcastRecipientsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListBroadcastRecipientsResponse, ListBroadcastRecipientsError, ThrowOnError>;
|
|
439
|
+
addBroadcastRecipients: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AddBroadcastRecipientsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AddBroadcastRecipientsResponse, AddBroadcastRecipientsError, ThrowOnError>;
|
|
440
440
|
};
|
|
441
441
|
/**
|
|
442
442
|
* sequences API
|
|
443
443
|
*/
|
|
444
444
|
sequences: {
|
|
445
445
|
listSequences: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListSequencesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSequencesResponse, ListSequencesError, ThrowOnError>;
|
|
446
|
-
createSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
447
|
-
getSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
448
|
-
updateSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
446
|
+
createSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateSequenceResponse, CreateSequenceError, ThrowOnError>;
|
|
447
|
+
getSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetSequenceResponse, GetSequenceError, ThrowOnError>;
|
|
448
|
+
updateSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateSequenceResponse, UpdateSequenceError, ThrowOnError>;
|
|
449
449
|
deleteSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, DeleteSequenceError, ThrowOnError>;
|
|
450
|
-
activateSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ActivateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
451
|
-
pauseSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<PauseSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
452
|
-
enrollContacts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EnrollContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
450
|
+
activateSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ActivateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ActivateSequenceResponse, unknown, ThrowOnError>;
|
|
451
|
+
pauseSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<PauseSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PauseSequenceResponse, unknown, ThrowOnError>;
|
|
452
|
+
enrollContacts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EnrollContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EnrollContactsResponse, EnrollContactsError, ThrowOnError>;
|
|
453
453
|
unenrollContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UnenrollContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, UnenrollContactError, ThrowOnError>;
|
|
454
|
-
listSequenceEnrollments: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListSequenceEnrollmentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
454
|
+
listSequenceEnrollments: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListSequenceEnrollmentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSequenceEnrollmentsResponse, ListSequenceEnrollmentsError, ThrowOnError>;
|
|
455
455
|
};
|
|
456
456
|
/**
|
|
457
457
|
* commentautomations API
|
|
@@ -9096,7 +9096,18 @@ type CreateBroadcastData = {
|
|
|
9096
9096
|
};
|
|
9097
9097
|
};
|
|
9098
9098
|
};
|
|
9099
|
-
type CreateBroadcastResponse = (
|
|
9099
|
+
type CreateBroadcastResponse = ({
|
|
9100
|
+
success?: boolean;
|
|
9101
|
+
broadcast?: {
|
|
9102
|
+
id?: string;
|
|
9103
|
+
name?: string;
|
|
9104
|
+
description?: string;
|
|
9105
|
+
platform?: string;
|
|
9106
|
+
accountId?: string;
|
|
9107
|
+
status?: string;
|
|
9108
|
+
createdAt?: string;
|
|
9109
|
+
};
|
|
9110
|
+
});
|
|
9100
9111
|
type CreateBroadcastError = ({
|
|
9101
9112
|
error?: string;
|
|
9102
9113
|
});
|
|
@@ -9105,7 +9116,37 @@ type GetBroadcastData = {
|
|
|
9105
9116
|
broadcastId: string;
|
|
9106
9117
|
};
|
|
9107
9118
|
};
|
|
9108
|
-
type GetBroadcastResponse = (
|
|
9119
|
+
type GetBroadcastResponse = ({
|
|
9120
|
+
success?: boolean;
|
|
9121
|
+
broadcast?: {
|
|
9122
|
+
id?: string;
|
|
9123
|
+
name?: string;
|
|
9124
|
+
description?: string;
|
|
9125
|
+
platform?: string;
|
|
9126
|
+
accountId?: string;
|
|
9127
|
+
message?: {
|
|
9128
|
+
text?: string;
|
|
9129
|
+
};
|
|
9130
|
+
template?: {
|
|
9131
|
+
name?: string;
|
|
9132
|
+
language?: string;
|
|
9133
|
+
};
|
|
9134
|
+
segmentFilters?: {
|
|
9135
|
+
tags?: Array<(string)>;
|
|
9136
|
+
};
|
|
9137
|
+
status?: 'draft' | 'scheduled' | 'sending' | 'completed' | 'failed' | 'cancelled';
|
|
9138
|
+
scheduledAt?: string;
|
|
9139
|
+
startedAt?: string;
|
|
9140
|
+
completedAt?: string;
|
|
9141
|
+
recipientCount?: number;
|
|
9142
|
+
sentCount?: number;
|
|
9143
|
+
deliveredCount?: number;
|
|
9144
|
+
readCount?: number;
|
|
9145
|
+
failedCount?: number;
|
|
9146
|
+
createdAt?: string;
|
|
9147
|
+
updatedAt?: string;
|
|
9148
|
+
};
|
|
9149
|
+
});
|
|
9109
9150
|
type GetBroadcastError = ({
|
|
9110
9151
|
error?: string;
|
|
9111
9152
|
});
|
|
@@ -9114,7 +9155,16 @@ type UpdateBroadcastData = {
|
|
|
9114
9155
|
broadcastId: string;
|
|
9115
9156
|
};
|
|
9116
9157
|
};
|
|
9117
|
-
type UpdateBroadcastResponse = (
|
|
9158
|
+
type UpdateBroadcastResponse = ({
|
|
9159
|
+
success?: boolean;
|
|
9160
|
+
broadcast?: {
|
|
9161
|
+
id?: string;
|
|
9162
|
+
name?: string;
|
|
9163
|
+
description?: string;
|
|
9164
|
+
status?: string;
|
|
9165
|
+
updatedAt?: string;
|
|
9166
|
+
};
|
|
9167
|
+
});
|
|
9118
9168
|
type UpdateBroadcastError = ({
|
|
9119
9169
|
error?: string;
|
|
9120
9170
|
});
|
|
@@ -9162,7 +9212,14 @@ type ScheduleBroadcastData = {
|
|
|
9162
9212
|
broadcastId: string;
|
|
9163
9213
|
};
|
|
9164
9214
|
};
|
|
9165
|
-
type ScheduleBroadcastResponse = (
|
|
9215
|
+
type ScheduleBroadcastResponse = ({
|
|
9216
|
+
success?: boolean;
|
|
9217
|
+
broadcast?: {
|
|
9218
|
+
id?: string;
|
|
9219
|
+
status?: string;
|
|
9220
|
+
scheduledAt?: string;
|
|
9221
|
+
};
|
|
9222
|
+
});
|
|
9166
9223
|
type ScheduleBroadcastError = (unknown | {
|
|
9167
9224
|
error?: string;
|
|
9168
9225
|
});
|
|
@@ -9171,7 +9228,13 @@ type CancelBroadcastData = {
|
|
|
9171
9228
|
broadcastId: string;
|
|
9172
9229
|
};
|
|
9173
9230
|
};
|
|
9174
|
-
type CancelBroadcastResponse = (
|
|
9231
|
+
type CancelBroadcastResponse = ({
|
|
9232
|
+
success?: boolean;
|
|
9233
|
+
broadcast?: {
|
|
9234
|
+
id?: string;
|
|
9235
|
+
status?: string;
|
|
9236
|
+
};
|
|
9237
|
+
});
|
|
9175
9238
|
type CancelBroadcastError = (unknown | {
|
|
9176
9239
|
error?: string;
|
|
9177
9240
|
});
|
|
@@ -9185,7 +9248,28 @@ type ListBroadcastRecipientsData = {
|
|
|
9185
9248
|
status?: 'pending' | 'sent' | 'delivered' | 'read' | 'failed';
|
|
9186
9249
|
};
|
|
9187
9250
|
};
|
|
9188
|
-
type ListBroadcastRecipientsResponse = (
|
|
9251
|
+
type ListBroadcastRecipientsResponse = ({
|
|
9252
|
+
success?: boolean;
|
|
9253
|
+
recipients?: Array<{
|
|
9254
|
+
id?: string;
|
|
9255
|
+
contactId?: string;
|
|
9256
|
+
channelId?: string;
|
|
9257
|
+
platformIdentifier?: string;
|
|
9258
|
+
contactName?: string;
|
|
9259
|
+
status?: 'pending' | 'sent' | 'delivered' | 'read' | 'failed';
|
|
9260
|
+
messageId?: string;
|
|
9261
|
+
error?: string;
|
|
9262
|
+
sentAt?: string;
|
|
9263
|
+
deliveredAt?: string;
|
|
9264
|
+
readAt?: string;
|
|
9265
|
+
}>;
|
|
9266
|
+
pagination?: {
|
|
9267
|
+
total?: number;
|
|
9268
|
+
limit?: number;
|
|
9269
|
+
skip?: number;
|
|
9270
|
+
hasMore?: boolean;
|
|
9271
|
+
};
|
|
9272
|
+
});
|
|
9189
9273
|
type ListBroadcastRecipientsError = ({
|
|
9190
9274
|
error?: string;
|
|
9191
9275
|
});
|
|
@@ -9208,7 +9292,17 @@ type AddBroadcastRecipientsData = {
|
|
|
9208
9292
|
broadcastId: string;
|
|
9209
9293
|
};
|
|
9210
9294
|
};
|
|
9211
|
-
type AddBroadcastRecipientsResponse = (
|
|
9295
|
+
type AddBroadcastRecipientsResponse = ({
|
|
9296
|
+
success?: boolean;
|
|
9297
|
+
/**
|
|
9298
|
+
* Number of recipients successfully added
|
|
9299
|
+
*/
|
|
9300
|
+
added?: number;
|
|
9301
|
+
/**
|
|
9302
|
+
* Number skipped (duplicates or missing channels)
|
|
9303
|
+
*/
|
|
9304
|
+
skipped?: number;
|
|
9305
|
+
});
|
|
9212
9306
|
type AddBroadcastRecipientsError = ({
|
|
9213
9307
|
error?: string;
|
|
9214
9308
|
});
|
|
@@ -9292,7 +9386,18 @@ type CreateSequenceData = {
|
|
|
9292
9386
|
exitOnUnsubscribe?: boolean;
|
|
9293
9387
|
};
|
|
9294
9388
|
};
|
|
9295
|
-
type CreateSequenceResponse = (
|
|
9389
|
+
type CreateSequenceResponse = ({
|
|
9390
|
+
success?: boolean;
|
|
9391
|
+
sequence?: {
|
|
9392
|
+
id?: string;
|
|
9393
|
+
name?: string;
|
|
9394
|
+
description?: string;
|
|
9395
|
+
platform?: string;
|
|
9396
|
+
status?: string;
|
|
9397
|
+
stepsCount?: number;
|
|
9398
|
+
createdAt?: string;
|
|
9399
|
+
};
|
|
9400
|
+
});
|
|
9296
9401
|
type CreateSequenceError = ({
|
|
9297
9402
|
error?: string;
|
|
9298
9403
|
});
|
|
@@ -9301,7 +9406,38 @@ type GetSequenceData = {
|
|
|
9301
9406
|
sequenceId: string;
|
|
9302
9407
|
};
|
|
9303
9408
|
};
|
|
9304
|
-
type GetSequenceResponse = (
|
|
9409
|
+
type GetSequenceResponse = ({
|
|
9410
|
+
success?: boolean;
|
|
9411
|
+
sequence?: {
|
|
9412
|
+
id?: string;
|
|
9413
|
+
name?: string;
|
|
9414
|
+
description?: string;
|
|
9415
|
+
platform?: string;
|
|
9416
|
+
accountId?: string;
|
|
9417
|
+
status?: 'draft' | 'active' | 'paused';
|
|
9418
|
+
steps?: Array<{
|
|
9419
|
+
order?: number;
|
|
9420
|
+
delayMinutes?: number;
|
|
9421
|
+
message?: {
|
|
9422
|
+
text?: string;
|
|
9423
|
+
};
|
|
9424
|
+
template?: {
|
|
9425
|
+
name?: string;
|
|
9426
|
+
language?: string;
|
|
9427
|
+
variableMapping?: {
|
|
9428
|
+
[key: string]: unknown;
|
|
9429
|
+
};
|
|
9430
|
+
};
|
|
9431
|
+
}>;
|
|
9432
|
+
exitOnReply?: boolean;
|
|
9433
|
+
exitOnUnsubscribe?: boolean;
|
|
9434
|
+
totalEnrolled?: number;
|
|
9435
|
+
totalCompleted?: number;
|
|
9436
|
+
totalExited?: number;
|
|
9437
|
+
createdAt?: string;
|
|
9438
|
+
updatedAt?: string;
|
|
9439
|
+
};
|
|
9440
|
+
});
|
|
9305
9441
|
type GetSequenceError = ({
|
|
9306
9442
|
error?: string;
|
|
9307
9443
|
});
|
|
@@ -9310,7 +9446,21 @@ type UpdateSequenceData = {
|
|
|
9310
9446
|
sequenceId: string;
|
|
9311
9447
|
};
|
|
9312
9448
|
};
|
|
9313
|
-
type UpdateSequenceResponse = (
|
|
9449
|
+
type UpdateSequenceResponse = ({
|
|
9450
|
+
success?: boolean;
|
|
9451
|
+
sequence?: {
|
|
9452
|
+
id?: string;
|
|
9453
|
+
name?: string;
|
|
9454
|
+
description?: string;
|
|
9455
|
+
status?: string;
|
|
9456
|
+
steps?: Array<{
|
|
9457
|
+
[key: string]: unknown;
|
|
9458
|
+
}>;
|
|
9459
|
+
exitOnReply?: boolean;
|
|
9460
|
+
exitOnUnsubscribe?: boolean;
|
|
9461
|
+
updatedAt?: string;
|
|
9462
|
+
};
|
|
9463
|
+
});
|
|
9314
9464
|
type UpdateSequenceError = ({
|
|
9315
9465
|
error?: string;
|
|
9316
9466
|
});
|
|
@@ -9328,7 +9478,13 @@ type ActivateSequenceData = {
|
|
|
9328
9478
|
sequenceId: string;
|
|
9329
9479
|
};
|
|
9330
9480
|
};
|
|
9331
|
-
type ActivateSequenceResponse = (
|
|
9481
|
+
type ActivateSequenceResponse = ({
|
|
9482
|
+
success?: boolean;
|
|
9483
|
+
sequence?: {
|
|
9484
|
+
id?: string;
|
|
9485
|
+
status?: string;
|
|
9486
|
+
};
|
|
9487
|
+
});
|
|
9332
9488
|
type ActivateSequenceError = (unknown | {
|
|
9333
9489
|
error?: string;
|
|
9334
9490
|
});
|
|
@@ -9337,7 +9493,13 @@ type PauseSequenceData = {
|
|
|
9337
9493
|
sequenceId: string;
|
|
9338
9494
|
};
|
|
9339
9495
|
};
|
|
9340
|
-
type PauseSequenceResponse = (
|
|
9496
|
+
type PauseSequenceResponse = ({
|
|
9497
|
+
success?: boolean;
|
|
9498
|
+
sequence?: {
|
|
9499
|
+
id?: string;
|
|
9500
|
+
status?: string;
|
|
9501
|
+
};
|
|
9502
|
+
});
|
|
9341
9503
|
type PauseSequenceError = (unknown | {
|
|
9342
9504
|
error?: string;
|
|
9343
9505
|
});
|
|
@@ -9353,7 +9515,17 @@ type EnrollContactsData = {
|
|
|
9353
9515
|
sequenceId: string;
|
|
9354
9516
|
};
|
|
9355
9517
|
};
|
|
9356
|
-
type EnrollContactsResponse = (
|
|
9518
|
+
type EnrollContactsResponse = ({
|
|
9519
|
+
success?: boolean;
|
|
9520
|
+
/**
|
|
9521
|
+
* Number of contacts successfully enrolled
|
|
9522
|
+
*/
|
|
9523
|
+
enrolled?: number;
|
|
9524
|
+
/**
|
|
9525
|
+
* Number skipped (already enrolled or missing channel)
|
|
9526
|
+
*/
|
|
9527
|
+
skipped?: number;
|
|
9528
|
+
});
|
|
9357
9529
|
type EnrollContactsError = ({
|
|
9358
9530
|
error?: string;
|
|
9359
9531
|
});
|
|
@@ -9377,7 +9549,29 @@ type ListSequenceEnrollmentsData = {
|
|
|
9377
9549
|
status?: 'active' | 'completed' | 'exited' | 'paused';
|
|
9378
9550
|
};
|
|
9379
9551
|
};
|
|
9380
|
-
type ListSequenceEnrollmentsResponse = (
|
|
9552
|
+
type ListSequenceEnrollmentsResponse = ({
|
|
9553
|
+
success?: boolean;
|
|
9554
|
+
enrollments?: Array<{
|
|
9555
|
+
id?: string;
|
|
9556
|
+
contactId?: string;
|
|
9557
|
+
channelId?: string;
|
|
9558
|
+
platformIdentifier?: string;
|
|
9559
|
+
contactName?: string;
|
|
9560
|
+
currentStepIndex?: number;
|
|
9561
|
+
status?: 'active' | 'completed' | 'exited' | 'paused';
|
|
9562
|
+
exitReason?: string;
|
|
9563
|
+
nextStepAt?: string;
|
|
9564
|
+
stepsSent?: number;
|
|
9565
|
+
lastStepSentAt?: string;
|
|
9566
|
+
createdAt?: string;
|
|
9567
|
+
}>;
|
|
9568
|
+
pagination?: {
|
|
9569
|
+
total?: number;
|
|
9570
|
+
limit?: number;
|
|
9571
|
+
skip?: number;
|
|
9572
|
+
hasMore?: boolean;
|
|
9573
|
+
};
|
|
9574
|
+
});
|
|
9381
9575
|
type ListSequenceEnrollmentsError = ({
|
|
9382
9576
|
error?: string;
|
|
9383
9577
|
});
|
package/dist/index.d.ts
CHANGED
|
@@ -428,30 +428,30 @@ declare class Zernio {
|
|
|
428
428
|
*/
|
|
429
429
|
broadcasts: {
|
|
430
430
|
listBroadcasts: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListBroadcastsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListBroadcastsResponse, ListBroadcastsError, ThrowOnError>;
|
|
431
|
-
createBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
432
|
-
getBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
433
|
-
updateBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
431
|
+
createBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateBroadcastResponse, CreateBroadcastError, ThrowOnError>;
|
|
432
|
+
getBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetBroadcastResponse, GetBroadcastError, ThrowOnError>;
|
|
433
|
+
updateBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateBroadcastResponse, UpdateBroadcastError, ThrowOnError>;
|
|
434
434
|
deleteBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, DeleteBroadcastError, ThrowOnError>;
|
|
435
435
|
sendBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<SendBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<SendBroadcastResponse, unknown, ThrowOnError>;
|
|
436
|
-
scheduleBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ScheduleBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
437
|
-
cancelBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CancelBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
438
|
-
listBroadcastRecipients: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListBroadcastRecipientsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
439
|
-
addBroadcastRecipients: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AddBroadcastRecipientsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
436
|
+
scheduleBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ScheduleBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ScheduleBroadcastResponse, unknown, ThrowOnError>;
|
|
437
|
+
cancelBroadcast: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CancelBroadcastData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CancelBroadcastResponse, unknown, ThrowOnError>;
|
|
438
|
+
listBroadcastRecipients: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListBroadcastRecipientsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListBroadcastRecipientsResponse, ListBroadcastRecipientsError, ThrowOnError>;
|
|
439
|
+
addBroadcastRecipients: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<AddBroadcastRecipientsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<AddBroadcastRecipientsResponse, AddBroadcastRecipientsError, ThrowOnError>;
|
|
440
440
|
};
|
|
441
441
|
/**
|
|
442
442
|
* sequences API
|
|
443
443
|
*/
|
|
444
444
|
sequences: {
|
|
445
445
|
listSequences: <ThrowOnError extends boolean = false>(options?: _hey_api_client_fetch.OptionsLegacyParser<ListSequencesData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSequencesResponse, ListSequencesError, ThrowOnError>;
|
|
446
|
-
createSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
447
|
-
getSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
448
|
-
updateSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
446
|
+
createSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<CreateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<CreateSequenceResponse, CreateSequenceError, ThrowOnError>;
|
|
447
|
+
getSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<GetSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<GetSequenceResponse, GetSequenceError, ThrowOnError>;
|
|
448
|
+
updateSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UpdateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<UpdateSequenceResponse, UpdateSequenceError, ThrowOnError>;
|
|
449
449
|
deleteSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<DeleteSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, DeleteSequenceError, ThrowOnError>;
|
|
450
|
-
activateSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ActivateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
451
|
-
pauseSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<PauseSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
452
|
-
enrollContacts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EnrollContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
450
|
+
activateSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ActivateSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ActivateSequenceResponse, unknown, ThrowOnError>;
|
|
451
|
+
pauseSequence: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<PauseSequenceData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<PauseSequenceResponse, unknown, ThrowOnError>;
|
|
452
|
+
enrollContacts: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<EnrollContactsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<EnrollContactsResponse, EnrollContactsError, ThrowOnError>;
|
|
453
453
|
unenrollContact: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<UnenrollContactData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<unknown, UnenrollContactError, ThrowOnError>;
|
|
454
|
-
listSequenceEnrollments: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListSequenceEnrollmentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<
|
|
454
|
+
listSequenceEnrollments: <ThrowOnError extends boolean = false>(options: _hey_api_client_fetch.OptionsLegacyParser<ListSequenceEnrollmentsData, ThrowOnError>) => _hey_api_client_fetch.RequestResult<ListSequenceEnrollmentsResponse, ListSequenceEnrollmentsError, ThrowOnError>;
|
|
455
455
|
};
|
|
456
456
|
/**
|
|
457
457
|
* commentautomations API
|
|
@@ -9096,7 +9096,18 @@ type CreateBroadcastData = {
|
|
|
9096
9096
|
};
|
|
9097
9097
|
};
|
|
9098
9098
|
};
|
|
9099
|
-
type CreateBroadcastResponse = (
|
|
9099
|
+
type CreateBroadcastResponse = ({
|
|
9100
|
+
success?: boolean;
|
|
9101
|
+
broadcast?: {
|
|
9102
|
+
id?: string;
|
|
9103
|
+
name?: string;
|
|
9104
|
+
description?: string;
|
|
9105
|
+
platform?: string;
|
|
9106
|
+
accountId?: string;
|
|
9107
|
+
status?: string;
|
|
9108
|
+
createdAt?: string;
|
|
9109
|
+
};
|
|
9110
|
+
});
|
|
9100
9111
|
type CreateBroadcastError = ({
|
|
9101
9112
|
error?: string;
|
|
9102
9113
|
});
|
|
@@ -9105,7 +9116,37 @@ type GetBroadcastData = {
|
|
|
9105
9116
|
broadcastId: string;
|
|
9106
9117
|
};
|
|
9107
9118
|
};
|
|
9108
|
-
type GetBroadcastResponse = (
|
|
9119
|
+
type GetBroadcastResponse = ({
|
|
9120
|
+
success?: boolean;
|
|
9121
|
+
broadcast?: {
|
|
9122
|
+
id?: string;
|
|
9123
|
+
name?: string;
|
|
9124
|
+
description?: string;
|
|
9125
|
+
platform?: string;
|
|
9126
|
+
accountId?: string;
|
|
9127
|
+
message?: {
|
|
9128
|
+
text?: string;
|
|
9129
|
+
};
|
|
9130
|
+
template?: {
|
|
9131
|
+
name?: string;
|
|
9132
|
+
language?: string;
|
|
9133
|
+
};
|
|
9134
|
+
segmentFilters?: {
|
|
9135
|
+
tags?: Array<(string)>;
|
|
9136
|
+
};
|
|
9137
|
+
status?: 'draft' | 'scheduled' | 'sending' | 'completed' | 'failed' | 'cancelled';
|
|
9138
|
+
scheduledAt?: string;
|
|
9139
|
+
startedAt?: string;
|
|
9140
|
+
completedAt?: string;
|
|
9141
|
+
recipientCount?: number;
|
|
9142
|
+
sentCount?: number;
|
|
9143
|
+
deliveredCount?: number;
|
|
9144
|
+
readCount?: number;
|
|
9145
|
+
failedCount?: number;
|
|
9146
|
+
createdAt?: string;
|
|
9147
|
+
updatedAt?: string;
|
|
9148
|
+
};
|
|
9149
|
+
});
|
|
9109
9150
|
type GetBroadcastError = ({
|
|
9110
9151
|
error?: string;
|
|
9111
9152
|
});
|
|
@@ -9114,7 +9155,16 @@ type UpdateBroadcastData = {
|
|
|
9114
9155
|
broadcastId: string;
|
|
9115
9156
|
};
|
|
9116
9157
|
};
|
|
9117
|
-
type UpdateBroadcastResponse = (
|
|
9158
|
+
type UpdateBroadcastResponse = ({
|
|
9159
|
+
success?: boolean;
|
|
9160
|
+
broadcast?: {
|
|
9161
|
+
id?: string;
|
|
9162
|
+
name?: string;
|
|
9163
|
+
description?: string;
|
|
9164
|
+
status?: string;
|
|
9165
|
+
updatedAt?: string;
|
|
9166
|
+
};
|
|
9167
|
+
});
|
|
9118
9168
|
type UpdateBroadcastError = ({
|
|
9119
9169
|
error?: string;
|
|
9120
9170
|
});
|
|
@@ -9162,7 +9212,14 @@ type ScheduleBroadcastData = {
|
|
|
9162
9212
|
broadcastId: string;
|
|
9163
9213
|
};
|
|
9164
9214
|
};
|
|
9165
|
-
type ScheduleBroadcastResponse = (
|
|
9215
|
+
type ScheduleBroadcastResponse = ({
|
|
9216
|
+
success?: boolean;
|
|
9217
|
+
broadcast?: {
|
|
9218
|
+
id?: string;
|
|
9219
|
+
status?: string;
|
|
9220
|
+
scheduledAt?: string;
|
|
9221
|
+
};
|
|
9222
|
+
});
|
|
9166
9223
|
type ScheduleBroadcastError = (unknown | {
|
|
9167
9224
|
error?: string;
|
|
9168
9225
|
});
|
|
@@ -9171,7 +9228,13 @@ type CancelBroadcastData = {
|
|
|
9171
9228
|
broadcastId: string;
|
|
9172
9229
|
};
|
|
9173
9230
|
};
|
|
9174
|
-
type CancelBroadcastResponse = (
|
|
9231
|
+
type CancelBroadcastResponse = ({
|
|
9232
|
+
success?: boolean;
|
|
9233
|
+
broadcast?: {
|
|
9234
|
+
id?: string;
|
|
9235
|
+
status?: string;
|
|
9236
|
+
};
|
|
9237
|
+
});
|
|
9175
9238
|
type CancelBroadcastError = (unknown | {
|
|
9176
9239
|
error?: string;
|
|
9177
9240
|
});
|
|
@@ -9185,7 +9248,28 @@ type ListBroadcastRecipientsData = {
|
|
|
9185
9248
|
status?: 'pending' | 'sent' | 'delivered' | 'read' | 'failed';
|
|
9186
9249
|
};
|
|
9187
9250
|
};
|
|
9188
|
-
type ListBroadcastRecipientsResponse = (
|
|
9251
|
+
type ListBroadcastRecipientsResponse = ({
|
|
9252
|
+
success?: boolean;
|
|
9253
|
+
recipients?: Array<{
|
|
9254
|
+
id?: string;
|
|
9255
|
+
contactId?: string;
|
|
9256
|
+
channelId?: string;
|
|
9257
|
+
platformIdentifier?: string;
|
|
9258
|
+
contactName?: string;
|
|
9259
|
+
status?: 'pending' | 'sent' | 'delivered' | 'read' | 'failed';
|
|
9260
|
+
messageId?: string;
|
|
9261
|
+
error?: string;
|
|
9262
|
+
sentAt?: string;
|
|
9263
|
+
deliveredAt?: string;
|
|
9264
|
+
readAt?: string;
|
|
9265
|
+
}>;
|
|
9266
|
+
pagination?: {
|
|
9267
|
+
total?: number;
|
|
9268
|
+
limit?: number;
|
|
9269
|
+
skip?: number;
|
|
9270
|
+
hasMore?: boolean;
|
|
9271
|
+
};
|
|
9272
|
+
});
|
|
9189
9273
|
type ListBroadcastRecipientsError = ({
|
|
9190
9274
|
error?: string;
|
|
9191
9275
|
});
|
|
@@ -9208,7 +9292,17 @@ type AddBroadcastRecipientsData = {
|
|
|
9208
9292
|
broadcastId: string;
|
|
9209
9293
|
};
|
|
9210
9294
|
};
|
|
9211
|
-
type AddBroadcastRecipientsResponse = (
|
|
9295
|
+
type AddBroadcastRecipientsResponse = ({
|
|
9296
|
+
success?: boolean;
|
|
9297
|
+
/**
|
|
9298
|
+
* Number of recipients successfully added
|
|
9299
|
+
*/
|
|
9300
|
+
added?: number;
|
|
9301
|
+
/**
|
|
9302
|
+
* Number skipped (duplicates or missing channels)
|
|
9303
|
+
*/
|
|
9304
|
+
skipped?: number;
|
|
9305
|
+
});
|
|
9212
9306
|
type AddBroadcastRecipientsError = ({
|
|
9213
9307
|
error?: string;
|
|
9214
9308
|
});
|
|
@@ -9292,7 +9386,18 @@ type CreateSequenceData = {
|
|
|
9292
9386
|
exitOnUnsubscribe?: boolean;
|
|
9293
9387
|
};
|
|
9294
9388
|
};
|
|
9295
|
-
type CreateSequenceResponse = (
|
|
9389
|
+
type CreateSequenceResponse = ({
|
|
9390
|
+
success?: boolean;
|
|
9391
|
+
sequence?: {
|
|
9392
|
+
id?: string;
|
|
9393
|
+
name?: string;
|
|
9394
|
+
description?: string;
|
|
9395
|
+
platform?: string;
|
|
9396
|
+
status?: string;
|
|
9397
|
+
stepsCount?: number;
|
|
9398
|
+
createdAt?: string;
|
|
9399
|
+
};
|
|
9400
|
+
});
|
|
9296
9401
|
type CreateSequenceError = ({
|
|
9297
9402
|
error?: string;
|
|
9298
9403
|
});
|
|
@@ -9301,7 +9406,38 @@ type GetSequenceData = {
|
|
|
9301
9406
|
sequenceId: string;
|
|
9302
9407
|
};
|
|
9303
9408
|
};
|
|
9304
|
-
type GetSequenceResponse = (
|
|
9409
|
+
type GetSequenceResponse = ({
|
|
9410
|
+
success?: boolean;
|
|
9411
|
+
sequence?: {
|
|
9412
|
+
id?: string;
|
|
9413
|
+
name?: string;
|
|
9414
|
+
description?: string;
|
|
9415
|
+
platform?: string;
|
|
9416
|
+
accountId?: string;
|
|
9417
|
+
status?: 'draft' | 'active' | 'paused';
|
|
9418
|
+
steps?: Array<{
|
|
9419
|
+
order?: number;
|
|
9420
|
+
delayMinutes?: number;
|
|
9421
|
+
message?: {
|
|
9422
|
+
text?: string;
|
|
9423
|
+
};
|
|
9424
|
+
template?: {
|
|
9425
|
+
name?: string;
|
|
9426
|
+
language?: string;
|
|
9427
|
+
variableMapping?: {
|
|
9428
|
+
[key: string]: unknown;
|
|
9429
|
+
};
|
|
9430
|
+
};
|
|
9431
|
+
}>;
|
|
9432
|
+
exitOnReply?: boolean;
|
|
9433
|
+
exitOnUnsubscribe?: boolean;
|
|
9434
|
+
totalEnrolled?: number;
|
|
9435
|
+
totalCompleted?: number;
|
|
9436
|
+
totalExited?: number;
|
|
9437
|
+
createdAt?: string;
|
|
9438
|
+
updatedAt?: string;
|
|
9439
|
+
};
|
|
9440
|
+
});
|
|
9305
9441
|
type GetSequenceError = ({
|
|
9306
9442
|
error?: string;
|
|
9307
9443
|
});
|
|
@@ -9310,7 +9446,21 @@ type UpdateSequenceData = {
|
|
|
9310
9446
|
sequenceId: string;
|
|
9311
9447
|
};
|
|
9312
9448
|
};
|
|
9313
|
-
type UpdateSequenceResponse = (
|
|
9449
|
+
type UpdateSequenceResponse = ({
|
|
9450
|
+
success?: boolean;
|
|
9451
|
+
sequence?: {
|
|
9452
|
+
id?: string;
|
|
9453
|
+
name?: string;
|
|
9454
|
+
description?: string;
|
|
9455
|
+
status?: string;
|
|
9456
|
+
steps?: Array<{
|
|
9457
|
+
[key: string]: unknown;
|
|
9458
|
+
}>;
|
|
9459
|
+
exitOnReply?: boolean;
|
|
9460
|
+
exitOnUnsubscribe?: boolean;
|
|
9461
|
+
updatedAt?: string;
|
|
9462
|
+
};
|
|
9463
|
+
});
|
|
9314
9464
|
type UpdateSequenceError = ({
|
|
9315
9465
|
error?: string;
|
|
9316
9466
|
});
|
|
@@ -9328,7 +9478,13 @@ type ActivateSequenceData = {
|
|
|
9328
9478
|
sequenceId: string;
|
|
9329
9479
|
};
|
|
9330
9480
|
};
|
|
9331
|
-
type ActivateSequenceResponse = (
|
|
9481
|
+
type ActivateSequenceResponse = ({
|
|
9482
|
+
success?: boolean;
|
|
9483
|
+
sequence?: {
|
|
9484
|
+
id?: string;
|
|
9485
|
+
status?: string;
|
|
9486
|
+
};
|
|
9487
|
+
});
|
|
9332
9488
|
type ActivateSequenceError = (unknown | {
|
|
9333
9489
|
error?: string;
|
|
9334
9490
|
});
|
|
@@ -9337,7 +9493,13 @@ type PauseSequenceData = {
|
|
|
9337
9493
|
sequenceId: string;
|
|
9338
9494
|
};
|
|
9339
9495
|
};
|
|
9340
|
-
type PauseSequenceResponse = (
|
|
9496
|
+
type PauseSequenceResponse = ({
|
|
9497
|
+
success?: boolean;
|
|
9498
|
+
sequence?: {
|
|
9499
|
+
id?: string;
|
|
9500
|
+
status?: string;
|
|
9501
|
+
};
|
|
9502
|
+
});
|
|
9341
9503
|
type PauseSequenceError = (unknown | {
|
|
9342
9504
|
error?: string;
|
|
9343
9505
|
});
|
|
@@ -9353,7 +9515,17 @@ type EnrollContactsData = {
|
|
|
9353
9515
|
sequenceId: string;
|
|
9354
9516
|
};
|
|
9355
9517
|
};
|
|
9356
|
-
type EnrollContactsResponse = (
|
|
9518
|
+
type EnrollContactsResponse = ({
|
|
9519
|
+
success?: boolean;
|
|
9520
|
+
/**
|
|
9521
|
+
* Number of contacts successfully enrolled
|
|
9522
|
+
*/
|
|
9523
|
+
enrolled?: number;
|
|
9524
|
+
/**
|
|
9525
|
+
* Number skipped (already enrolled or missing channel)
|
|
9526
|
+
*/
|
|
9527
|
+
skipped?: number;
|
|
9528
|
+
});
|
|
9357
9529
|
type EnrollContactsError = ({
|
|
9358
9530
|
error?: string;
|
|
9359
9531
|
});
|
|
@@ -9377,7 +9549,29 @@ type ListSequenceEnrollmentsData = {
|
|
|
9377
9549
|
status?: 'active' | 'completed' | 'exited' | 'paused';
|
|
9378
9550
|
};
|
|
9379
9551
|
};
|
|
9380
|
-
type ListSequenceEnrollmentsResponse = (
|
|
9552
|
+
type ListSequenceEnrollmentsResponse = ({
|
|
9553
|
+
success?: boolean;
|
|
9554
|
+
enrollments?: Array<{
|
|
9555
|
+
id?: string;
|
|
9556
|
+
contactId?: string;
|
|
9557
|
+
channelId?: string;
|
|
9558
|
+
platformIdentifier?: string;
|
|
9559
|
+
contactName?: string;
|
|
9560
|
+
currentStepIndex?: number;
|
|
9561
|
+
status?: 'active' | 'completed' | 'exited' | 'paused';
|
|
9562
|
+
exitReason?: string;
|
|
9563
|
+
nextStepAt?: string;
|
|
9564
|
+
stepsSent?: number;
|
|
9565
|
+
lastStepSentAt?: string;
|
|
9566
|
+
createdAt?: string;
|
|
9567
|
+
}>;
|
|
9568
|
+
pagination?: {
|
|
9569
|
+
total?: number;
|
|
9570
|
+
limit?: number;
|
|
9571
|
+
skip?: number;
|
|
9572
|
+
hasMore?: boolean;
|
|
9573
|
+
};
|
|
9574
|
+
});
|
|
9381
9575
|
type ListSequenceEnrollmentsError = ({
|
|
9382
9576
|
error?: string;
|
|
9383
9577
|
});
|
package/package.json
CHANGED
|
@@ -9290,7 +9290,18 @@ export type CreateBroadcastData = {
|
|
|
9290
9290
|
};
|
|
9291
9291
|
};
|
|
9292
9292
|
|
|
9293
|
-
export type CreateBroadcastResponse = (
|
|
9293
|
+
export type CreateBroadcastResponse = ({
|
|
9294
|
+
success?: boolean;
|
|
9295
|
+
broadcast?: {
|
|
9296
|
+
id?: string;
|
|
9297
|
+
name?: string;
|
|
9298
|
+
description?: string;
|
|
9299
|
+
platform?: string;
|
|
9300
|
+
accountId?: string;
|
|
9301
|
+
status?: string;
|
|
9302
|
+
createdAt?: string;
|
|
9303
|
+
};
|
|
9304
|
+
});
|
|
9294
9305
|
|
|
9295
9306
|
export type CreateBroadcastError = ({
|
|
9296
9307
|
error?: string;
|
|
@@ -9302,7 +9313,37 @@ export type GetBroadcastData = {
|
|
|
9302
9313
|
};
|
|
9303
9314
|
};
|
|
9304
9315
|
|
|
9305
|
-
export type GetBroadcastResponse = (
|
|
9316
|
+
export type GetBroadcastResponse = ({
|
|
9317
|
+
success?: boolean;
|
|
9318
|
+
broadcast?: {
|
|
9319
|
+
id?: string;
|
|
9320
|
+
name?: string;
|
|
9321
|
+
description?: string;
|
|
9322
|
+
platform?: string;
|
|
9323
|
+
accountId?: string;
|
|
9324
|
+
message?: {
|
|
9325
|
+
text?: string;
|
|
9326
|
+
};
|
|
9327
|
+
template?: {
|
|
9328
|
+
name?: string;
|
|
9329
|
+
language?: string;
|
|
9330
|
+
};
|
|
9331
|
+
segmentFilters?: {
|
|
9332
|
+
tags?: Array<(string)>;
|
|
9333
|
+
};
|
|
9334
|
+
status?: 'draft' | 'scheduled' | 'sending' | 'completed' | 'failed' | 'cancelled';
|
|
9335
|
+
scheduledAt?: string;
|
|
9336
|
+
startedAt?: string;
|
|
9337
|
+
completedAt?: string;
|
|
9338
|
+
recipientCount?: number;
|
|
9339
|
+
sentCount?: number;
|
|
9340
|
+
deliveredCount?: number;
|
|
9341
|
+
readCount?: number;
|
|
9342
|
+
failedCount?: number;
|
|
9343
|
+
createdAt?: string;
|
|
9344
|
+
updatedAt?: string;
|
|
9345
|
+
};
|
|
9346
|
+
});
|
|
9306
9347
|
|
|
9307
9348
|
export type GetBroadcastError = ({
|
|
9308
9349
|
error?: string;
|
|
@@ -9314,7 +9355,16 @@ export type UpdateBroadcastData = {
|
|
|
9314
9355
|
};
|
|
9315
9356
|
};
|
|
9316
9357
|
|
|
9317
|
-
export type UpdateBroadcastResponse = (
|
|
9358
|
+
export type UpdateBroadcastResponse = ({
|
|
9359
|
+
success?: boolean;
|
|
9360
|
+
broadcast?: {
|
|
9361
|
+
id?: string;
|
|
9362
|
+
name?: string;
|
|
9363
|
+
description?: string;
|
|
9364
|
+
status?: string;
|
|
9365
|
+
updatedAt?: string;
|
|
9366
|
+
};
|
|
9367
|
+
});
|
|
9318
9368
|
|
|
9319
9369
|
export type UpdateBroadcastError = ({
|
|
9320
9370
|
error?: string;
|
|
@@ -9371,7 +9421,14 @@ export type ScheduleBroadcastData = {
|
|
|
9371
9421
|
};
|
|
9372
9422
|
};
|
|
9373
9423
|
|
|
9374
|
-
export type ScheduleBroadcastResponse = (
|
|
9424
|
+
export type ScheduleBroadcastResponse = ({
|
|
9425
|
+
success?: boolean;
|
|
9426
|
+
broadcast?: {
|
|
9427
|
+
id?: string;
|
|
9428
|
+
status?: string;
|
|
9429
|
+
scheduledAt?: string;
|
|
9430
|
+
};
|
|
9431
|
+
});
|
|
9375
9432
|
|
|
9376
9433
|
export type ScheduleBroadcastError = (unknown | {
|
|
9377
9434
|
error?: string;
|
|
@@ -9383,7 +9440,13 @@ export type CancelBroadcastData = {
|
|
|
9383
9440
|
};
|
|
9384
9441
|
};
|
|
9385
9442
|
|
|
9386
|
-
export type CancelBroadcastResponse = (
|
|
9443
|
+
export type CancelBroadcastResponse = ({
|
|
9444
|
+
success?: boolean;
|
|
9445
|
+
broadcast?: {
|
|
9446
|
+
id?: string;
|
|
9447
|
+
status?: string;
|
|
9448
|
+
};
|
|
9449
|
+
});
|
|
9387
9450
|
|
|
9388
9451
|
export type CancelBroadcastError = (unknown | {
|
|
9389
9452
|
error?: string;
|
|
@@ -9400,7 +9463,28 @@ export type ListBroadcastRecipientsData = {
|
|
|
9400
9463
|
};
|
|
9401
9464
|
};
|
|
9402
9465
|
|
|
9403
|
-
export type ListBroadcastRecipientsResponse = (
|
|
9466
|
+
export type ListBroadcastRecipientsResponse = ({
|
|
9467
|
+
success?: boolean;
|
|
9468
|
+
recipients?: Array<{
|
|
9469
|
+
id?: string;
|
|
9470
|
+
contactId?: string;
|
|
9471
|
+
channelId?: string;
|
|
9472
|
+
platformIdentifier?: string;
|
|
9473
|
+
contactName?: string;
|
|
9474
|
+
status?: 'pending' | 'sent' | 'delivered' | 'read' | 'failed';
|
|
9475
|
+
messageId?: string;
|
|
9476
|
+
error?: string;
|
|
9477
|
+
sentAt?: string;
|
|
9478
|
+
deliveredAt?: string;
|
|
9479
|
+
readAt?: string;
|
|
9480
|
+
}>;
|
|
9481
|
+
pagination?: {
|
|
9482
|
+
total?: number;
|
|
9483
|
+
limit?: number;
|
|
9484
|
+
skip?: number;
|
|
9485
|
+
hasMore?: boolean;
|
|
9486
|
+
};
|
|
9487
|
+
});
|
|
9404
9488
|
|
|
9405
9489
|
export type ListBroadcastRecipientsError = ({
|
|
9406
9490
|
error?: string;
|
|
@@ -9426,7 +9510,17 @@ export type AddBroadcastRecipientsData = {
|
|
|
9426
9510
|
};
|
|
9427
9511
|
};
|
|
9428
9512
|
|
|
9429
|
-
export type AddBroadcastRecipientsResponse = (
|
|
9513
|
+
export type AddBroadcastRecipientsResponse = ({
|
|
9514
|
+
success?: boolean;
|
|
9515
|
+
/**
|
|
9516
|
+
* Number of recipients successfully added
|
|
9517
|
+
*/
|
|
9518
|
+
added?: number;
|
|
9519
|
+
/**
|
|
9520
|
+
* Number skipped (duplicates or missing channels)
|
|
9521
|
+
*/
|
|
9522
|
+
skipped?: number;
|
|
9523
|
+
});
|
|
9430
9524
|
|
|
9431
9525
|
export type AddBroadcastRecipientsError = ({
|
|
9432
9526
|
error?: string;
|
|
@@ -9516,7 +9610,18 @@ export type CreateSequenceData = {
|
|
|
9516
9610
|
};
|
|
9517
9611
|
};
|
|
9518
9612
|
|
|
9519
|
-
export type CreateSequenceResponse = (
|
|
9613
|
+
export type CreateSequenceResponse = ({
|
|
9614
|
+
success?: boolean;
|
|
9615
|
+
sequence?: {
|
|
9616
|
+
id?: string;
|
|
9617
|
+
name?: string;
|
|
9618
|
+
description?: string;
|
|
9619
|
+
platform?: string;
|
|
9620
|
+
status?: string;
|
|
9621
|
+
stepsCount?: number;
|
|
9622
|
+
createdAt?: string;
|
|
9623
|
+
};
|
|
9624
|
+
});
|
|
9520
9625
|
|
|
9521
9626
|
export type CreateSequenceError = ({
|
|
9522
9627
|
error?: string;
|
|
@@ -9528,7 +9633,38 @@ export type GetSequenceData = {
|
|
|
9528
9633
|
};
|
|
9529
9634
|
};
|
|
9530
9635
|
|
|
9531
|
-
export type GetSequenceResponse = (
|
|
9636
|
+
export type GetSequenceResponse = ({
|
|
9637
|
+
success?: boolean;
|
|
9638
|
+
sequence?: {
|
|
9639
|
+
id?: string;
|
|
9640
|
+
name?: string;
|
|
9641
|
+
description?: string;
|
|
9642
|
+
platform?: string;
|
|
9643
|
+
accountId?: string;
|
|
9644
|
+
status?: 'draft' | 'active' | 'paused';
|
|
9645
|
+
steps?: Array<{
|
|
9646
|
+
order?: number;
|
|
9647
|
+
delayMinutes?: number;
|
|
9648
|
+
message?: {
|
|
9649
|
+
text?: string;
|
|
9650
|
+
};
|
|
9651
|
+
template?: {
|
|
9652
|
+
name?: string;
|
|
9653
|
+
language?: string;
|
|
9654
|
+
variableMapping?: {
|
|
9655
|
+
[key: string]: unknown;
|
|
9656
|
+
};
|
|
9657
|
+
};
|
|
9658
|
+
}>;
|
|
9659
|
+
exitOnReply?: boolean;
|
|
9660
|
+
exitOnUnsubscribe?: boolean;
|
|
9661
|
+
totalEnrolled?: number;
|
|
9662
|
+
totalCompleted?: number;
|
|
9663
|
+
totalExited?: number;
|
|
9664
|
+
createdAt?: string;
|
|
9665
|
+
updatedAt?: string;
|
|
9666
|
+
};
|
|
9667
|
+
});
|
|
9532
9668
|
|
|
9533
9669
|
export type GetSequenceError = ({
|
|
9534
9670
|
error?: string;
|
|
@@ -9540,7 +9676,21 @@ export type UpdateSequenceData = {
|
|
|
9540
9676
|
};
|
|
9541
9677
|
};
|
|
9542
9678
|
|
|
9543
|
-
export type UpdateSequenceResponse = (
|
|
9679
|
+
export type UpdateSequenceResponse = ({
|
|
9680
|
+
success?: boolean;
|
|
9681
|
+
sequence?: {
|
|
9682
|
+
id?: string;
|
|
9683
|
+
name?: string;
|
|
9684
|
+
description?: string;
|
|
9685
|
+
status?: string;
|
|
9686
|
+
steps?: Array<{
|
|
9687
|
+
[key: string]: unknown;
|
|
9688
|
+
}>;
|
|
9689
|
+
exitOnReply?: boolean;
|
|
9690
|
+
exitOnUnsubscribe?: boolean;
|
|
9691
|
+
updatedAt?: string;
|
|
9692
|
+
};
|
|
9693
|
+
});
|
|
9544
9694
|
|
|
9545
9695
|
export type UpdateSequenceError = ({
|
|
9546
9696
|
error?: string;
|
|
@@ -9564,7 +9714,13 @@ export type ActivateSequenceData = {
|
|
|
9564
9714
|
};
|
|
9565
9715
|
};
|
|
9566
9716
|
|
|
9567
|
-
export type ActivateSequenceResponse = (
|
|
9717
|
+
export type ActivateSequenceResponse = ({
|
|
9718
|
+
success?: boolean;
|
|
9719
|
+
sequence?: {
|
|
9720
|
+
id?: string;
|
|
9721
|
+
status?: string;
|
|
9722
|
+
};
|
|
9723
|
+
});
|
|
9568
9724
|
|
|
9569
9725
|
export type ActivateSequenceError = (unknown | {
|
|
9570
9726
|
error?: string;
|
|
@@ -9576,7 +9732,13 @@ export type PauseSequenceData = {
|
|
|
9576
9732
|
};
|
|
9577
9733
|
};
|
|
9578
9734
|
|
|
9579
|
-
export type PauseSequenceResponse = (
|
|
9735
|
+
export type PauseSequenceResponse = ({
|
|
9736
|
+
success?: boolean;
|
|
9737
|
+
sequence?: {
|
|
9738
|
+
id?: string;
|
|
9739
|
+
status?: string;
|
|
9740
|
+
};
|
|
9741
|
+
});
|
|
9580
9742
|
|
|
9581
9743
|
export type PauseSequenceError = (unknown | {
|
|
9582
9744
|
error?: string;
|
|
@@ -9595,7 +9757,17 @@ export type EnrollContactsData = {
|
|
|
9595
9757
|
};
|
|
9596
9758
|
};
|
|
9597
9759
|
|
|
9598
|
-
export type EnrollContactsResponse = (
|
|
9760
|
+
export type EnrollContactsResponse = ({
|
|
9761
|
+
success?: boolean;
|
|
9762
|
+
/**
|
|
9763
|
+
* Number of contacts successfully enrolled
|
|
9764
|
+
*/
|
|
9765
|
+
enrolled?: number;
|
|
9766
|
+
/**
|
|
9767
|
+
* Number skipped (already enrolled or missing channel)
|
|
9768
|
+
*/
|
|
9769
|
+
skipped?: number;
|
|
9770
|
+
});
|
|
9599
9771
|
|
|
9600
9772
|
export type EnrollContactsError = ({
|
|
9601
9773
|
error?: string;
|
|
@@ -9625,7 +9797,29 @@ export type ListSequenceEnrollmentsData = {
|
|
|
9625
9797
|
};
|
|
9626
9798
|
};
|
|
9627
9799
|
|
|
9628
|
-
export type ListSequenceEnrollmentsResponse = (
|
|
9800
|
+
export type ListSequenceEnrollmentsResponse = ({
|
|
9801
|
+
success?: boolean;
|
|
9802
|
+
enrollments?: Array<{
|
|
9803
|
+
id?: string;
|
|
9804
|
+
contactId?: string;
|
|
9805
|
+
channelId?: string;
|
|
9806
|
+
platformIdentifier?: string;
|
|
9807
|
+
contactName?: string;
|
|
9808
|
+
currentStepIndex?: number;
|
|
9809
|
+
status?: 'active' | 'completed' | 'exited' | 'paused';
|
|
9810
|
+
exitReason?: string;
|
|
9811
|
+
nextStepAt?: string;
|
|
9812
|
+
stepsSent?: number;
|
|
9813
|
+
lastStepSentAt?: string;
|
|
9814
|
+
createdAt?: string;
|
|
9815
|
+
}>;
|
|
9816
|
+
pagination?: {
|
|
9817
|
+
total?: number;
|
|
9818
|
+
limit?: number;
|
|
9819
|
+
skip?: number;
|
|
9820
|
+
hasMore?: boolean;
|
|
9821
|
+
};
|
|
9822
|
+
});
|
|
9629
9823
|
|
|
9630
9824
|
export type ListSequenceEnrollmentsError = ({
|
|
9631
9825
|
error?: string;
|