getricky 0.1.7 → 0.1.9
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/cjs/generated/idempotency.gen.js +3 -0
- package/dist/cjs/generated/index.d.ts +1 -1
- package/dist/cjs/generated/sdk.gen.d.ts +34 -2
- package/dist/cjs/generated/sdk.gen.js +69 -1
- package/dist/cjs/generated/types.gen.d.ts +375 -2
- package/dist/esm/generated/idempotency.gen.js +3 -0
- package/dist/esm/generated/index.d.ts +1 -1
- package/dist/esm/generated/sdk.gen.d.ts +34 -2
- package/dist/esm/generated/sdk.gen.js +69 -1
- package/dist/esm/generated/types.gen.d.ts +375 -2
- package/package.json +1 -1
|
@@ -330,6 +330,36 @@ export type Channel = {
|
|
|
330
330
|
*/
|
|
331
331
|
connected_at: string | null;
|
|
332
332
|
};
|
|
333
|
+
/**
|
|
334
|
+
* A request for a person to take over from the AI agent, not resolved yet.
|
|
335
|
+
*/
|
|
336
|
+
export type ConversationHandoff = {
|
|
337
|
+
/**
|
|
338
|
+
* Handoff ID.
|
|
339
|
+
*/
|
|
340
|
+
id: string;
|
|
341
|
+
/**
|
|
342
|
+
* `requested` until a member takes it; `assigned` once someone is responsible.
|
|
343
|
+
*/
|
|
344
|
+
status: 'requested' | 'assigned';
|
|
345
|
+
/**
|
|
346
|
+
* Whether the AI agent or a member asked for it.
|
|
347
|
+
*/
|
|
348
|
+
requested_by: 'agent' | 'operator';
|
|
349
|
+
/**
|
|
350
|
+
* Why the conversation needs a person.
|
|
351
|
+
*/
|
|
352
|
+
reason: 'customer_requested' | 'low_confidence' | 'manual_takeover' | 'out_of_scope' | 'sensitive' | 'other';
|
|
353
|
+
/**
|
|
354
|
+
* What the person taking over needs to know.
|
|
355
|
+
*/
|
|
356
|
+
summary: string;
|
|
357
|
+
assigned_user_id: string | null;
|
|
358
|
+
/**
|
|
359
|
+
* When it was requested.
|
|
360
|
+
*/
|
|
361
|
+
requested_at: string;
|
|
362
|
+
};
|
|
333
363
|
/**
|
|
334
364
|
* One contact talking to the organization on one channel.
|
|
335
365
|
*/
|
|
@@ -387,6 +417,14 @@ export type Conversation = {
|
|
|
387
417
|
* Text of the latest message.
|
|
388
418
|
*/
|
|
389
419
|
last_activity_preview: string | null;
|
|
420
|
+
/**
|
|
421
|
+
* Whether it has messages the team has not read.
|
|
422
|
+
*/
|
|
423
|
+
unread: boolean;
|
|
424
|
+
/**
|
|
425
|
+
* The handoff to a person waiting to be resolved; null when there is none.
|
|
426
|
+
*/
|
|
427
|
+
active_handoff: ConversationHandoff | null;
|
|
390
428
|
};
|
|
391
429
|
/**
|
|
392
430
|
* One message in a conversation.
|
|
@@ -912,6 +950,23 @@ export type QuickReply = {
|
|
|
912
950
|
*/
|
|
913
951
|
body: string;
|
|
914
952
|
};
|
|
953
|
+
/**
|
|
954
|
+
* What a bulk assignment did to one conversation.
|
|
955
|
+
*/
|
|
956
|
+
export type ConversationAssignmentResult = {
|
|
957
|
+
/**
|
|
958
|
+
* Conversation ID.
|
|
959
|
+
*/
|
|
960
|
+
conversation_id: string;
|
|
961
|
+
/**
|
|
962
|
+
* Member it was to be assigned to.
|
|
963
|
+
*/
|
|
964
|
+
assigned_user_id: string;
|
|
965
|
+
/**
|
|
966
|
+
* `assigned`; `not_found` when the organization has no such conversation; `failed` when Ricky could not save it, so retry that conversation.
|
|
967
|
+
*/
|
|
968
|
+
status: 'assigned' | 'not_found' | 'failed';
|
|
969
|
+
};
|
|
915
970
|
/**
|
|
916
971
|
* A branch or place the agents can send as a WhatsApp location.
|
|
917
972
|
*/
|
|
@@ -2271,11 +2326,11 @@ export type WhatsAppNumber = {
|
|
|
2271
2326
|
*/
|
|
2272
2327
|
messaging_health: 'available' | 'limited' | 'blocked';
|
|
2273
2328
|
/**
|
|
2274
|
-
* Quality rating at Meta: `
|
|
2329
|
+
* Quality rating at Meta: `green`, `yellow`, `red`, `not_yet_determined` or `unknown`.
|
|
2275
2330
|
*/
|
|
2276
2331
|
quality_rating: string | null;
|
|
2277
2332
|
/**
|
|
2278
|
-
* Messaging limit tier at Meta, for example `TIER_1K` or `TIER_UNLIMITED
|
|
2333
|
+
* Messaging limit tier at Meta, for example `TIER_1K` or `TIER_UNLIMITED`; `UNKNOWN` when Meta has not reported it.
|
|
2279
2334
|
*/
|
|
2280
2335
|
messaging_limit: string | null;
|
|
2281
2336
|
/**
|
|
@@ -2690,6 +2745,33 @@ export type AssignConversationAgent = {
|
|
|
2690
2745
|
*/
|
|
2691
2746
|
agent_id: string | null;
|
|
2692
2747
|
};
|
|
2748
|
+
/**
|
|
2749
|
+
* How the handoff ends.
|
|
2750
|
+
*/
|
|
2751
|
+
export type ResolveHandoff = {
|
|
2752
|
+
/**
|
|
2753
|
+
* `returned_to_ai` gives the conversation back to the AI agent that asked for the handoff and unassigns the member; `stayed_with_human` leaves it with the member.
|
|
2754
|
+
*/
|
|
2755
|
+
resolution: 'returned_to_ai' | 'stayed_with_human';
|
|
2756
|
+
};
|
|
2757
|
+
/**
|
|
2758
|
+
* Makes members responsible for many conversations at once. Each member also becomes the contact's owner.
|
|
2759
|
+
*/
|
|
2760
|
+
export type AssignConversations = {
|
|
2761
|
+
/**
|
|
2762
|
+
* Up to 100 conversations, each once, with the member for each.
|
|
2763
|
+
*/
|
|
2764
|
+
assignments: Array<{
|
|
2765
|
+
/**
|
|
2766
|
+
* Conversation to assign.
|
|
2767
|
+
*/
|
|
2768
|
+
conversation_id: string;
|
|
2769
|
+
/**
|
|
2770
|
+
* Member who becomes responsible for it.
|
|
2771
|
+
*/
|
|
2772
|
+
assigned_user_id: string;
|
|
2773
|
+
}>;
|
|
2774
|
+
};
|
|
2693
2775
|
/**
|
|
2694
2776
|
* A contact needs at least a name, a phone or an email.
|
|
2695
2777
|
*/
|
|
@@ -2964,12 +3046,20 @@ export type SendMessage = {
|
|
|
2964
3046
|
* Message text.
|
|
2965
3047
|
*/
|
|
2966
3048
|
text: string;
|
|
3049
|
+
/**
|
|
3050
|
+
* Message of this conversation to quote, from `GET /conversations/{conversation_id}/messages`. WhatsApp only.
|
|
3051
|
+
*/
|
|
3052
|
+
reply_to_message_id?: string;
|
|
2967
3053
|
} | {
|
|
2968
3054
|
type: 'template';
|
|
2969
3055
|
template: TemplateMessage;
|
|
2970
3056
|
} | {
|
|
2971
3057
|
type: 'media';
|
|
2972
3058
|
media: MediaMessage;
|
|
3059
|
+
/**
|
|
3060
|
+
* Message of this conversation to quote, from `GET /conversations/{conversation_id}/messages`. WhatsApp only.
|
|
3061
|
+
*/
|
|
3062
|
+
reply_to_message_id?: string;
|
|
2973
3063
|
};
|
|
2974
3064
|
/**
|
|
2975
3065
|
* Sends a template to a phone number.
|
|
@@ -4562,6 +4652,34 @@ export type ListConversationsData = {
|
|
|
4562
4652
|
* Only conversations assigned to this member.
|
|
4563
4653
|
*/
|
|
4564
4654
|
assigned_user_id?: string;
|
|
4655
|
+
/**
|
|
4656
|
+
* Only conversations this AI agent answers and no member is assigned to.
|
|
4657
|
+
*/
|
|
4658
|
+
agent_id?: string;
|
|
4659
|
+
/**
|
|
4660
|
+
* `true`: only conversations with no member and no AI agent assigned.
|
|
4661
|
+
*/
|
|
4662
|
+
unassigned?: 'true' | 'false';
|
|
4663
|
+
/**
|
|
4664
|
+
* Only conversations on this channel, including earlier connections of the same number or account. See `GET /channels`.
|
|
4665
|
+
*/
|
|
4666
|
+
channel_id?: string;
|
|
4667
|
+
/**
|
|
4668
|
+
* Only conversations whose contact has this tag.
|
|
4669
|
+
*/
|
|
4670
|
+
tag_id?: string;
|
|
4671
|
+
/**
|
|
4672
|
+
* `true`: only conversations with messages the team has not read.
|
|
4673
|
+
*/
|
|
4674
|
+
unread?: 'true' | 'false';
|
|
4675
|
+
/**
|
|
4676
|
+
* `true`: only conversations with a handoff to a person not resolved yet.
|
|
4677
|
+
*/
|
|
4678
|
+
pending_handoff?: 'true' | 'false';
|
|
4679
|
+
/**
|
|
4680
|
+
* `customer`: only conversations whose latest message came from the contact.
|
|
4681
|
+
*/
|
|
4682
|
+
last_message_from?: 'customer';
|
|
4565
4683
|
};
|
|
4566
4684
|
url: '/conversations';
|
|
4567
4685
|
};
|
|
@@ -8098,6 +8216,65 @@ export type ChangeConversationTagsResponses = {
|
|
|
8098
8216
|
};
|
|
8099
8217
|
};
|
|
8100
8218
|
export type ChangeConversationTagsResponse = ChangeConversationTagsResponses[keyof ChangeConversationTagsResponses];
|
|
8219
|
+
export type MarkConversationUnreadData = {
|
|
8220
|
+
body?: never;
|
|
8221
|
+
headers?: {
|
|
8222
|
+
/**
|
|
8223
|
+
* Optional. A value you choose, unique per logical write, 8–200 characters: a UUID or an ID from your system such as `order-10482-ready`. Retrying with the same key and body replays the first response instead of repeating the write.
|
|
8224
|
+
*/
|
|
8225
|
+
'Idempotency-Key'?: string;
|
|
8226
|
+
};
|
|
8227
|
+
path: {
|
|
8228
|
+
/**
|
|
8229
|
+
* Conversation ID.
|
|
8230
|
+
*/
|
|
8231
|
+
conversation_id: string;
|
|
8232
|
+
};
|
|
8233
|
+
query?: never;
|
|
8234
|
+
url: '/conversations/{conversation_id}/read';
|
|
8235
|
+
};
|
|
8236
|
+
export type MarkConversationUnreadErrors = {
|
|
8237
|
+
/**
|
|
8238
|
+
* `invalid_input`: A parameter or body field is invalid; `param` names it when known.
|
|
8239
|
+
*/
|
|
8240
|
+
400: Error;
|
|
8241
|
+
/**
|
|
8242
|
+
* `unauthorized`: The `Authorization` header is missing, malformed, expired or revoked.
|
|
8243
|
+
*/
|
|
8244
|
+
401: Error;
|
|
8245
|
+
/**
|
|
8246
|
+
* `insufficient_scope`: The key lacks the scope this operation requires.
|
|
8247
|
+
*/
|
|
8248
|
+
403: Error;
|
|
8249
|
+
/**
|
|
8250
|
+
* `not_found`: The resource does not exist in this organization.
|
|
8251
|
+
*/
|
|
8252
|
+
404: Error;
|
|
8253
|
+
/**
|
|
8254
|
+
* `idempotency_conflict`: The `Idempotency-Key` was used for a different request.
|
|
8255
|
+
*
|
|
8256
|
+
* `request_processing`: A request with this `Idempotency-Key` is still processing or ended in an unknown state.
|
|
8257
|
+
*/
|
|
8258
|
+
409: Error;
|
|
8259
|
+
/**
|
|
8260
|
+
* `rate_limited`: More than 120 requests this minute with this key; see `Retry-After`.
|
|
8261
|
+
*/
|
|
8262
|
+
429: Error;
|
|
8263
|
+
/**
|
|
8264
|
+
* `internal_error`: Ricky failed. Retry a read. Before retrying a write, read the resource: the same `Idempotency-Key` answers `request_processing`.
|
|
8265
|
+
*/
|
|
8266
|
+
500: Error;
|
|
8267
|
+
};
|
|
8268
|
+
export type MarkConversationUnreadError = MarkConversationUnreadErrors[keyof MarkConversationUnreadErrors];
|
|
8269
|
+
export type MarkConversationUnreadResponses = {
|
|
8270
|
+
/**
|
|
8271
|
+
* Success.
|
|
8272
|
+
*/
|
|
8273
|
+
200: {
|
|
8274
|
+
data: Conversation;
|
|
8275
|
+
};
|
|
8276
|
+
};
|
|
8277
|
+
export type MarkConversationUnreadResponse = MarkConversationUnreadResponses[keyof MarkConversationUnreadResponses];
|
|
8101
8278
|
export type MarkConversationReadData = {
|
|
8102
8279
|
body?: never;
|
|
8103
8280
|
headers?: {
|
|
@@ -9230,6 +9407,202 @@ export type ListBroadcastRecipientsResponses = {
|
|
|
9230
9407
|
};
|
|
9231
9408
|
};
|
|
9232
9409
|
export type ListBroadcastRecipientsResponse = ListBroadcastRecipientsResponses[keyof ListBroadcastRecipientsResponses];
|
|
9410
|
+
export type AssignConversationsData = {
|
|
9411
|
+
body: AssignConversations;
|
|
9412
|
+
headers?: {
|
|
9413
|
+
/**
|
|
9414
|
+
* Optional. A value you choose, unique per logical write, 8–200 characters: a UUID or an ID from your system such as `order-10482-ready`. Retrying with the same key and body replays the first response instead of repeating the write.
|
|
9415
|
+
*/
|
|
9416
|
+
'Idempotency-Key'?: string;
|
|
9417
|
+
};
|
|
9418
|
+
path?: never;
|
|
9419
|
+
query?: never;
|
|
9420
|
+
url: '/conversations/assignments';
|
|
9421
|
+
};
|
|
9422
|
+
export type AssignConversationsErrors = {
|
|
9423
|
+
/**
|
|
9424
|
+
* `invalid_json`: The body is not valid JSON.
|
|
9425
|
+
*
|
|
9426
|
+
* `invalid_input`: A parameter or body field is invalid; `param` names it when known.
|
|
9427
|
+
*/
|
|
9428
|
+
400: Error;
|
|
9429
|
+
/**
|
|
9430
|
+
* `unauthorized`: The `Authorization` header is missing, malformed, expired or revoked.
|
|
9431
|
+
*/
|
|
9432
|
+
401: Error;
|
|
9433
|
+
/**
|
|
9434
|
+
* `insufficient_scope`: The key lacks the scope this operation requires.
|
|
9435
|
+
*/
|
|
9436
|
+
403: Error;
|
|
9437
|
+
/**
|
|
9438
|
+
* `idempotency_conflict`: The `Idempotency-Key` was used for a different request.
|
|
9439
|
+
*
|
|
9440
|
+
* `request_processing`: A request with this `Idempotency-Key` is still processing or ended in an unknown state.
|
|
9441
|
+
*/
|
|
9442
|
+
409: Error;
|
|
9443
|
+
/**
|
|
9444
|
+
* `body_too_large`: The JSON body exceeds 64 KiB.
|
|
9445
|
+
*/
|
|
9446
|
+
413: Error;
|
|
9447
|
+
/**
|
|
9448
|
+
* `unsupported_media_type`: The body must be `application/json`.
|
|
9449
|
+
*/
|
|
9450
|
+
415: Error;
|
|
9451
|
+
/**
|
|
9452
|
+
* `rate_limited`: More than 120 requests this minute with this key; see `Retry-After`.
|
|
9453
|
+
*/
|
|
9454
|
+
429: Error;
|
|
9455
|
+
/**
|
|
9456
|
+
* `internal_error`: Ricky failed. Retry a read. Before retrying a write, read the resource: the same `Idempotency-Key` answers `request_processing`.
|
|
9457
|
+
*/
|
|
9458
|
+
500: Error;
|
|
9459
|
+
};
|
|
9460
|
+
export type AssignConversationsError = AssignConversationsErrors[keyof AssignConversationsErrors];
|
|
9461
|
+
export type AssignConversationsResponses = {
|
|
9462
|
+
/**
|
|
9463
|
+
* Success.
|
|
9464
|
+
*/
|
|
9465
|
+
200: {
|
|
9466
|
+
data: Array<ConversationAssignmentResult>;
|
|
9467
|
+
/**
|
|
9468
|
+
* Pass as `cursor` for the next page; null on the last page.
|
|
9469
|
+
*/
|
|
9470
|
+
next_cursor: string | null;
|
|
9471
|
+
};
|
|
9472
|
+
};
|
|
9473
|
+
export type AssignConversationsResponse = AssignConversationsResponses[keyof AssignConversationsResponses];
|
|
9474
|
+
export type ResolveConversationHandoffData = {
|
|
9475
|
+
body: ResolveHandoff;
|
|
9476
|
+
headers?: {
|
|
9477
|
+
/**
|
|
9478
|
+
* Optional. A value you choose, unique per logical write, 8–200 characters: a UUID or an ID from your system such as `order-10482-ready`. Retrying with the same key and body replays the first response instead of repeating the write.
|
|
9479
|
+
*/
|
|
9480
|
+
'Idempotency-Key'?: string;
|
|
9481
|
+
};
|
|
9482
|
+
path: {
|
|
9483
|
+
/**
|
|
9484
|
+
* Conversation ID.
|
|
9485
|
+
*/
|
|
9486
|
+
conversation_id: string;
|
|
9487
|
+
};
|
|
9488
|
+
query?: never;
|
|
9489
|
+
url: '/conversations/{conversation_id}/handoff/resolve';
|
|
9490
|
+
};
|
|
9491
|
+
export type ResolveConversationHandoffErrors = {
|
|
9492
|
+
/**
|
|
9493
|
+
* `invalid_json`: The body is not valid JSON.
|
|
9494
|
+
*
|
|
9495
|
+
* `invalid_input`: A parameter or body field is invalid; `param` names it when known.
|
|
9496
|
+
*/
|
|
9497
|
+
400: Error;
|
|
9498
|
+
/**
|
|
9499
|
+
* `unauthorized`: The `Authorization` header is missing, malformed, expired or revoked.
|
|
9500
|
+
*/
|
|
9501
|
+
401: Error;
|
|
9502
|
+
/**
|
|
9503
|
+
* `insufficient_scope`: The key lacks the scope this operation requires.
|
|
9504
|
+
*/
|
|
9505
|
+
403: Error;
|
|
9506
|
+
/**
|
|
9507
|
+
* `not_found`: The resource does not exist in this organization.
|
|
9508
|
+
*/
|
|
9509
|
+
404: Error;
|
|
9510
|
+
/**
|
|
9511
|
+
* `idempotency_conflict`: The `Idempotency-Key` was used for a different request.
|
|
9512
|
+
*
|
|
9513
|
+
* `request_processing`: A request with this `Idempotency-Key` is still processing or ended in an unknown state.
|
|
9514
|
+
*/
|
|
9515
|
+
409: Error;
|
|
9516
|
+
/**
|
|
9517
|
+
* `body_too_large`: The JSON body exceeds 64 KiB.
|
|
9518
|
+
*/
|
|
9519
|
+
413: Error;
|
|
9520
|
+
/**
|
|
9521
|
+
* `unsupported_media_type`: The body must be `application/json`.
|
|
9522
|
+
*/
|
|
9523
|
+
415: Error;
|
|
9524
|
+
/**
|
|
9525
|
+
* `rule_violation`: The request breaks a business rule; `message` says which.
|
|
9526
|
+
*/
|
|
9527
|
+
422: Error;
|
|
9528
|
+
/**
|
|
9529
|
+
* `rate_limited`: More than 120 requests this minute with this key; see `Retry-After`.
|
|
9530
|
+
*/
|
|
9531
|
+
429: Error;
|
|
9532
|
+
/**
|
|
9533
|
+
* `internal_error`: Ricky failed. Retry a read. Before retrying a write, read the resource: the same `Idempotency-Key` answers `request_processing`.
|
|
9534
|
+
*/
|
|
9535
|
+
500: Error;
|
|
9536
|
+
};
|
|
9537
|
+
export type ResolveConversationHandoffError = ResolveConversationHandoffErrors[keyof ResolveConversationHandoffErrors];
|
|
9538
|
+
export type ResolveConversationHandoffResponses = {
|
|
9539
|
+
/**
|
|
9540
|
+
* Success.
|
|
9541
|
+
*/
|
|
9542
|
+
200: {
|
|
9543
|
+
data: Conversation;
|
|
9544
|
+
};
|
|
9545
|
+
};
|
|
9546
|
+
export type ResolveConversationHandoffResponse = ResolveConversationHandoffResponses[keyof ResolveConversationHandoffResponses];
|
|
9547
|
+
export type FetchMessageMediaData = {
|
|
9548
|
+
body?: never;
|
|
9549
|
+
path: {
|
|
9550
|
+
/**
|
|
9551
|
+
* Conversation ID.
|
|
9552
|
+
*/
|
|
9553
|
+
conversation_id: string;
|
|
9554
|
+
/**
|
|
9555
|
+
* Message ID.
|
|
9556
|
+
*/
|
|
9557
|
+
message_id: string;
|
|
9558
|
+
};
|
|
9559
|
+
query?: never;
|
|
9560
|
+
url: '/conversations/{conversation_id}/messages/{message_id}/media';
|
|
9561
|
+
};
|
|
9562
|
+
export type FetchMessageMediaErrors = {
|
|
9563
|
+
/**
|
|
9564
|
+
* `invalid_input`: A parameter or body field is invalid; `param` names it when known.
|
|
9565
|
+
*/
|
|
9566
|
+
400: Error;
|
|
9567
|
+
/**
|
|
9568
|
+
* `unauthorized`: The `Authorization` header is missing, malformed, expired or revoked.
|
|
9569
|
+
*/
|
|
9570
|
+
401: Error;
|
|
9571
|
+
/**
|
|
9572
|
+
* `insufficient_scope`: The key lacks the scope this operation requires.
|
|
9573
|
+
*/
|
|
9574
|
+
403: Error;
|
|
9575
|
+
/**
|
|
9576
|
+
* `not_found`: The resource does not exist in this organization.
|
|
9577
|
+
*/
|
|
9578
|
+
404: Error;
|
|
9579
|
+
/**
|
|
9580
|
+
* `rule_violation`: The request breaks a business rule; `message` says which.
|
|
9581
|
+
*/
|
|
9582
|
+
422: Error;
|
|
9583
|
+
/**
|
|
9584
|
+
* `rate_limited`: More than 120 requests this minute with this key; see `Retry-After`.
|
|
9585
|
+
*/
|
|
9586
|
+
429: Error;
|
|
9587
|
+
/**
|
|
9588
|
+
* `internal_error`: Ricky failed. Retry a read. Before retrying a write, read the resource: the same `Idempotency-Key` answers `request_processing`.
|
|
9589
|
+
*/
|
|
9590
|
+
500: Error;
|
|
9591
|
+
/**
|
|
9592
|
+
* `upstream_error`: The messaging provider failed. Retry later.
|
|
9593
|
+
*/
|
|
9594
|
+
502: Error;
|
|
9595
|
+
};
|
|
9596
|
+
export type FetchMessageMediaError = FetchMessageMediaErrors[keyof FetchMessageMediaErrors];
|
|
9597
|
+
export type FetchMessageMediaResponses = {
|
|
9598
|
+
/**
|
|
9599
|
+
* Success.
|
|
9600
|
+
*/
|
|
9601
|
+
200: {
|
|
9602
|
+
data: Message;
|
|
9603
|
+
};
|
|
9604
|
+
};
|
|
9605
|
+
export type FetchMessageMediaResponse = FetchMessageMediaResponses[keyof FetchMessageMediaResponses];
|
|
9233
9606
|
export type WebhookMessageReceivedWebhookPayload = WebhookEvent;
|
|
9234
9607
|
export type WebhookMessageReceivedWebhookRequest = {
|
|
9235
9608
|
body: WebhookMessageReceivedWebhookPayload;
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
/** `METHOD /path/{template}` of every write that accepts an `Idempotency-Key` header. */
|
|
3
3
|
export const idempotentOperations = new Set([
|
|
4
4
|
'DELETE /contact-fields/{field_id}',
|
|
5
|
+
'DELETE /conversations/{conversation_id}/read',
|
|
5
6
|
'DELETE /quick-replies/{quick_reply_id}',
|
|
6
7
|
'DELETE /tags/{tag_id}',
|
|
7
8
|
'DELETE /templates/{template_id}',
|
|
@@ -25,7 +26,9 @@ export const idempotentOperations = new Set([
|
|
|
25
26
|
'POST /contacts/tags',
|
|
26
27
|
'POST /contacts/{contact_id}/notes',
|
|
27
28
|
'POST /conversations',
|
|
29
|
+
'POST /conversations/assignments',
|
|
28
30
|
'POST /conversations/{conversation_id}/close',
|
|
31
|
+
'POST /conversations/{conversation_id}/handoff/resolve',
|
|
29
32
|
'POST /conversations/{conversation_id}/messages',
|
|
30
33
|
'POST /conversations/{conversation_id}/read',
|
|
31
34
|
'POST /conversations/{conversation_id}/reopen',
|
|
@@ -1,2 +1,2 @@
|
|
|
1
1
|
export { type Options, RickyApi } from './sdk.gen.js';
|
|
2
|
-
export type { ActivateWorkflowData, ActivateWorkflowError, ActivateWorkflowErrors, ActivateWorkflowResponse, ActivateWorkflowResponses, AddContactNote, AddContactNoteData, AddContactNoteError, AddContactNoteErrors, AddContactNoteResponse, AddContactNoteResponses, AdsReport, Agent, AgentOptions, ArchiveAgentData, ArchiveAgentError, ArchiveAgentErrors, ArchiveAgentResponse, ArchiveAgentResponses, AssignConversation, AssignConversationAgent, AssignConversationAgentData, AssignConversationAgentError, AssignConversationAgentErrors, AssignConversationAgentResponse, AssignConversationAgentResponses, AssignConversationData, AssignConversationError, AssignConversationErrors, AssignConversationResponse, AssignConversationResponses, Broadcast, BroadcastRecipient, BroadcastsReport, CancelBroadcastData, CancelBroadcastError, CancelBroadcastErrors, CancelBroadcastResponse, CancelBroadcastResponses, ChangeContactsTags, ChangeContactsTagsData, ChangeContactsTagsError, ChangeContactsTagsErrors, ChangeContactsTagsResponse, ChangeContactsTagsResponses, ChangeConversationTags, ChangeConversationTagsData, ChangeConversationTagsError, ChangeConversationTagsErrors, ChangeConversationTagsResponse, ChangeConversationTagsResponses, Channel, ClientOptions, CloseConversation, CloseConversationData, CloseConversationError, CloseConversationErrors, CloseConversationResponse, CloseConversationResponses, CompleteKnowledgeFile, CompleteKnowledgeFileData, CompleteKnowledgeFileError, CompleteKnowledgeFileErrors, CompleteKnowledgeFileResponse, CompleteKnowledgeFileResponses, Contact, ContactField, ContactIdentity, ContactTagChange, Conversation, ConversationsReport, CreateAgent, CreateAgentData, CreateAgentError, CreateAgentErrors, CreateAgentResponse, CreateAgentResponses, CreateBroadcast, CreateBroadcastData, CreateBroadcastError, CreateBroadcastErrors, CreateBroadcastResponse, CreateBroadcastResponses, CreateContact, CreateContactData, CreateContactError, CreateContactErrors, CreateContactField, CreateContactFieldData, CreateContactFieldError, CreateContactFieldErrors, CreateContactFieldResponse, CreateContactFieldResponses, CreateContactResponse, CreateContactResponses, CreatedWebhook, CreateKnowledgeContact, CreateKnowledgeContactData, CreateKnowledgeContactError, CreateKnowledgeContactErrors, CreateKnowledgeContactResponse, CreateKnowledgeContactResponses, CreateKnowledgeFile, CreateKnowledgeFileData, CreateKnowledgeFileError, CreateKnowledgeFileErrors, CreateKnowledgeFileResponse, CreateKnowledgeFileResponses, CreateKnowledgeLocation, CreateKnowledgeLocationData, CreateKnowledgeLocationError, CreateKnowledgeLocationErrors, CreateKnowledgeLocationResponse, CreateKnowledgeLocationResponses, CreateQuickReply, CreateQuickReplyData, CreateQuickReplyError, CreateQuickReplyErrors, CreateQuickReplyResponse, CreateQuickReplyResponses, CreateTag, CreateTagData, CreateTagError, CreateTagErrors, CreateTagResponse, CreateTagResponses, CreateTemplate, CreateTemplateData, CreateTemplateError, CreateTemplateErrors, CreateTemplateResponse, CreateTemplateResponses, CreateWebhook, CreateWebhookData, CreateWebhookError, CreateWebhookErrors, CreateWebhookResponse, CreateWebhookResponses, CreateWorkflow, CreateWorkflowData, CreateWorkflowError, CreateWorkflowErrors, CreateWorkflowResponse, CreateWorkflowResponses, DashboardReport, DeleteContactFieldData, DeleteContactFieldError, DeleteContactFieldErrors, DeleteContactFieldResponse, DeleteContactFieldResponses, DeletedTemplate, DeleteKnowledgeContactData, DeleteKnowledgeContactError, DeleteKnowledgeContactErrors, DeleteKnowledgeContactResponse, DeleteKnowledgeContactResponses, DeleteKnowledgeFileData, DeleteKnowledgeFileError, DeleteKnowledgeFileErrors, DeleteKnowledgeFileResponse, DeleteKnowledgeFileResponses, DeleteKnowledgeLocationData, DeleteKnowledgeLocationError, DeleteKnowledgeLocationErrors, DeleteKnowledgeLocationResponse, DeleteKnowledgeLocationResponses, DeleteQuickReplyData, DeleteQuickReplyError, DeleteQuickReplyErrors, DeleteQuickReplyResponse, DeleteQuickReplyResponses, DeleteTagData, DeleteTagError, DeleteTagErrors, DeleteTagResponse, DeleteTagResponses, DeleteTemplateData, DeleteTemplateError, DeleteTemplateErrors, DeleteTemplateResponse, DeleteTemplateResponses, DeleteWorkflowData, DeleteWorkflowError, DeleteWorkflowErrors, DeleteWorkflowResponse, DeleteWorkflowResponses, DisableWebhookData, DisableWebhookError, DisableWebhookErrors, DisableWebhookResponse, DisableWebhookResponses, Error, GetAdsReportData, GetAdsReportError, GetAdsReportErrors, GetAdsReportResponse, GetAdsReportResponses, GetAgentData, GetAgentError, GetAgentErrors, GetAgentOptionsData, GetAgentOptionsError, GetAgentOptionsErrors, GetAgentOptionsResponse, GetAgentOptionsResponses, GetAgentResponse, GetAgentResponses, GetBroadcastData, GetBroadcastError, GetBroadcastErrors, GetBroadcastResponse, GetBroadcastResponses, GetBroadcastsReportData, GetBroadcastsReportError, GetBroadcastsReportErrors, GetBroadcastsReportResponse, GetBroadcastsReportResponses, GetContactData, GetContactError, GetContactErrors, GetContactResponse, GetContactResponses, GetConversationData, GetConversationError, GetConversationErrors, GetConversationResponse, GetConversationResponses, GetConversationsReportData, GetConversationsReportError, GetConversationsReportErrors, GetConversationsReportResponse, GetConversationsReportResponses, GetDashboardReportData, GetDashboardReportError, GetDashboardReportErrors, GetDashboardReportResponse, GetDashboardReportResponses, GetKnowledgeContactData, GetKnowledgeContactError, GetKnowledgeContactErrors, GetKnowledgeContactResponse, GetKnowledgeContactResponses, GetKnowledgeFileData, GetKnowledgeFileError, GetKnowledgeFileErrors, GetKnowledgeFileResponse, GetKnowledgeFileResponses, GetKnowledgeLocationData, GetKnowledgeLocationError, GetKnowledgeLocationErrors, GetKnowledgeLocationResponse, GetKnowledgeLocationResponses, GetMessageData, GetMessageError, GetMessageErrors, GetMessageResponse, GetMessageResponses, GetMessagesReportData, GetMessagesReportError, GetMessagesReportErrors, GetMessagesReportResponse, GetMessagesReportResponses, GetQuickReplyData, GetQuickReplyError, GetQuickReplyErrors, GetQuickReplyResponse, GetQuickReplyResponses, GetResolutionsReportData, GetResolutionsReportError, GetResolutionsReportErrors, GetResolutionsReportResponse, GetResolutionsReportResponses, GetResponsesReportData, GetResponsesReportError, GetResponsesReportErrors, GetResponsesReportResponse, GetResponsesReportResponses, GetSendData, GetSendError, GetSendErrors, GetSendResponse, GetSendResponses, GetTeamReportData, GetTeamReportError, GetTeamReportErrors, GetTeamReportResponse, GetTeamReportResponses, GetTemplateData, GetTemplateError, GetTemplateErrors, GetTemplateResponse, GetTemplateResponses, GetWhatsAppNumberData, GetWhatsAppNumberError, GetWhatsAppNumberErrors, GetWhatsAppNumberResponse, GetWhatsAppNumberResponses, GetWorkflowData, GetWorkflowError, GetWorkflowErrors, GetWorkflowResponse, GetWorkflowResponses, IdempotencyKey, KnowledgeContact, KnowledgeFile, KnowledgeFileUpload, KnowledgeLocation, ListAgentsData, ListAgentsError, ListAgentsErrors, ListAgentsResponse, ListAgentsResponses, ListBroadcastRecipientsData, ListBroadcastRecipientsError, ListBroadcastRecipientsErrors, ListBroadcastRecipientsResponse, ListBroadcastRecipientsResponses, ListBroadcastsData, ListBroadcastsError, ListBroadcastsErrors, ListBroadcastsResponse, ListBroadcastsResponses, ListChannelsData, ListChannelsError, ListChannelsErrors, ListChannelsResponse, ListChannelsResponses, ListContactFieldsData, ListContactFieldsError, ListContactFieldsErrors, ListContactFieldsResponse, ListContactFieldsResponses, ListContactsData, ListContactsError, ListContactsErrors, ListContactsResponse, ListContactsResponses, ListConversationsData, ListConversationsError, ListConversationsErrors, ListConversationsResponse, ListConversationsResponses, ListKnowledgeContactsData, ListKnowledgeContactsError, ListKnowledgeContactsErrors, ListKnowledgeContactsResponse, ListKnowledgeContactsResponses, ListKnowledgeFilesData, ListKnowledgeFilesError, ListKnowledgeFilesErrors, ListKnowledgeFilesResponse, ListKnowledgeFilesResponses, ListKnowledgeLocationsData, ListKnowledgeLocationsError, ListKnowledgeLocationsErrors, ListKnowledgeLocationsResponse, ListKnowledgeLocationsResponses, ListMembersData, ListMembersError, ListMembersErrors, ListMembersResponse, ListMembersResponses, ListMessagesData, ListMessagesError, ListMessagesErrors, ListMessagesResponse, ListMessagesResponses, ListQuickRepliesData, ListQuickRepliesError, ListQuickRepliesErrors, ListQuickRepliesResponse, ListQuickRepliesResponses, ListTagsData, ListTagsError, ListTagsErrors, ListTagsResponse, ListTagsResponses, ListTemplatesData, ListTemplatesError, ListTemplatesErrors, ListTemplatesResponse, ListTemplatesResponses, ListWebhookDeliveriesData, ListWebhookDeliveriesError, ListWebhookDeliveriesErrors, ListWebhookDeliveriesResponse, ListWebhookDeliveriesResponses, ListWebhooksData, ListWebhooksError, ListWebhooksErrors, ListWebhooksResponse, ListWebhooksResponses, ListWhatsAppNumbersData, ListWhatsAppNumbersError, ListWhatsAppNumbersErrors, ListWhatsAppNumbersResponse, ListWhatsAppNumbersResponses, ListWorkflowExecutionsData, ListWorkflowExecutionsError, ListWorkflowExecutionsErrors, ListWorkflowExecutionsResponse, ListWorkflowExecutionsResponses, ListWorkflowsData, ListWorkflowsError, ListWorkflowsErrors, ListWorkflowsResponse, ListWorkflowsResponses, MarkConversationReadData, MarkConversationReadError, MarkConversationReadErrors, MarkConversationReadResponse, MarkConversationReadResponses, MediaMessage, Member, Message, MessageSearchResult, MessagesReport, PauseWorkflowData, PauseWorkflowError, PauseWorkflowErrors, PauseWorkflowResponse, PauseWorkflowResponses, QuickReply, ReopenConversationData, ReopenConversationError, ReopenConversationErrors, ReopenConversationResponse, ReopenConversationResponses, ReportPeriod, ResolutionsReport, ResponsesReport, RetryWebhookDeliveryData, RetryWebhookDeliveryError, RetryWebhookDeliveryErrors, RetryWebhookDeliveryResponse, RetryWebhookDeliveryResponses, RotateWebhookSecret, RotateWebhookSecretData, RotateWebhookSecretError, RotateWebhookSecretErrors, RotateWebhookSecretResponse, RotateWebhookSecretResponses, SearchConversationsData, SearchConversationsError, SearchConversationsErrors, SearchConversationsResponse, SearchConversationsResponses, SearchMessagesData, SearchMessagesError, SearchMessagesErrors, SearchMessagesResponse, SearchMessagesResponses, Send, SendMessage, SendMessageData, SendMessageError, SendMessageErrors, SendMessageResponse, SendMessageResponses, StartConversation, StartConversationData, StartConversationError, StartConversationErrors, StartConversationResponse, StartConversationResponses, Tag, TeamReport, Template, TemplateMessage, TemplateValidation, TestWebhookData, TestWebhookError, TestWebhookErrors, TestWebhookResponse, TestWebhookResponses, UpdateAgent, UpdateAgentData, UpdateAgentError, UpdateAgentErrors, UpdateAgentResponse, UpdateAgentResponses, UpdateContact, UpdateContactData, UpdateContactError, UpdateContactErrors, UpdateContactResponse, UpdateContactResponses, UpdateKnowledgeContact, UpdateKnowledgeContactData, UpdateKnowledgeContactError, UpdateKnowledgeContactErrors, UpdateKnowledgeContactResponse, UpdateKnowledgeContactResponses, UpdateKnowledgeFile, UpdateKnowledgeFileData, UpdateKnowledgeFileError, UpdateKnowledgeFileErrors, UpdateKnowledgeFileResponse, UpdateKnowledgeFileResponses, UpdateKnowledgeLocation, UpdateKnowledgeLocationData, UpdateKnowledgeLocationError, UpdateKnowledgeLocationErrors, UpdateKnowledgeLocationResponse, UpdateKnowledgeLocationResponses, UpdateQuickReply, UpdateQuickReplyData, UpdateQuickReplyError, UpdateQuickReplyErrors, UpdateQuickReplyResponse, UpdateQuickReplyResponses, UpdateTag, UpdateTagData, UpdateTagError, UpdateTagErrors, UpdateTagResponse, UpdateTagResponses, UpdateTemplate, UpdateTemplateData, UpdateTemplateError, UpdateTemplateErrors, UpdateTemplateResponse, UpdateTemplateResponses, UpdateWorkflow, UpdateWorkflowData, UpdateWorkflowError, UpdateWorkflowErrors, UpdateWorkflowResponse, UpdateWorkflowResponses, ValidateTemplate, ValidateTemplateData, ValidateTemplateError, ValidateTemplateErrors, ValidateTemplateResponse, ValidateTemplateResponses, Webhook, WebhookContactCreatedWebhookPayload, WebhookContactCreatedWebhookRequest, WebhookContactUpdatedWebhookPayload, WebhookContactUpdatedWebhookRequest, WebhookConversationAssignmentChangedWebhookPayload, WebhookConversationAssignmentChangedWebhookRequest, WebhookConversationClosedWebhookPayload, WebhookConversationClosedWebhookRequest, WebhookConversationOpenedWebhookPayload, WebhookConversationOpenedWebhookRequest, WebhookDelivery, WebhookEvent, WebhookMessageDeliveredWebhookPayload, WebhookMessageDeliveredWebhookRequest, WebhookMessageFailedWebhookPayload, WebhookMessageFailedWebhookRequest, WebhookMessageReadWebhookPayload, WebhookMessageReadWebhookRequest, WebhookMessageReceivedWebhookPayload, WebhookMessageReceivedWebhookRequest, WebhookMessageSentWebhookPayload, WebhookMessageSentWebhookRequest, Webhooks, WebhookTestResult, WebhookWebhookTestWebhookPayload, WebhookWebhookTestWebhookRequest, WhatsAppNumber, Workflow, WorkflowExecution } from './types.gen.js';
|
|
2
|
+
export type { ActivateWorkflowData, ActivateWorkflowError, ActivateWorkflowErrors, ActivateWorkflowResponse, ActivateWorkflowResponses, AddContactNote, AddContactNoteData, AddContactNoteError, AddContactNoteErrors, AddContactNoteResponse, AddContactNoteResponses, AdsReport, Agent, AgentOptions, ArchiveAgentData, ArchiveAgentError, ArchiveAgentErrors, ArchiveAgentResponse, ArchiveAgentResponses, AssignConversation, AssignConversationAgent, AssignConversationAgentData, AssignConversationAgentError, AssignConversationAgentErrors, AssignConversationAgentResponse, AssignConversationAgentResponses, AssignConversationData, AssignConversationError, AssignConversationErrors, AssignConversationResponse, AssignConversationResponses, AssignConversations, AssignConversationsData, AssignConversationsError, AssignConversationsErrors, AssignConversationsResponse, AssignConversationsResponses, Broadcast, BroadcastRecipient, BroadcastsReport, CancelBroadcastData, CancelBroadcastError, CancelBroadcastErrors, CancelBroadcastResponse, CancelBroadcastResponses, ChangeContactsTags, ChangeContactsTagsData, ChangeContactsTagsError, ChangeContactsTagsErrors, ChangeContactsTagsResponse, ChangeContactsTagsResponses, ChangeConversationTags, ChangeConversationTagsData, ChangeConversationTagsError, ChangeConversationTagsErrors, ChangeConversationTagsResponse, ChangeConversationTagsResponses, Channel, ClientOptions, CloseConversation, CloseConversationData, CloseConversationError, CloseConversationErrors, CloseConversationResponse, CloseConversationResponses, CompleteKnowledgeFile, CompleteKnowledgeFileData, CompleteKnowledgeFileError, CompleteKnowledgeFileErrors, CompleteKnowledgeFileResponse, CompleteKnowledgeFileResponses, Contact, ContactField, ContactIdentity, ContactTagChange, Conversation, ConversationAssignmentResult, ConversationHandoff, ConversationsReport, CreateAgent, CreateAgentData, CreateAgentError, CreateAgentErrors, CreateAgentResponse, CreateAgentResponses, CreateBroadcast, CreateBroadcastData, CreateBroadcastError, CreateBroadcastErrors, CreateBroadcastResponse, CreateBroadcastResponses, CreateContact, CreateContactData, CreateContactError, CreateContactErrors, CreateContactField, CreateContactFieldData, CreateContactFieldError, CreateContactFieldErrors, CreateContactFieldResponse, CreateContactFieldResponses, CreateContactResponse, CreateContactResponses, CreatedWebhook, CreateKnowledgeContact, CreateKnowledgeContactData, CreateKnowledgeContactError, CreateKnowledgeContactErrors, CreateKnowledgeContactResponse, CreateKnowledgeContactResponses, CreateKnowledgeFile, CreateKnowledgeFileData, CreateKnowledgeFileError, CreateKnowledgeFileErrors, CreateKnowledgeFileResponse, CreateKnowledgeFileResponses, CreateKnowledgeLocation, CreateKnowledgeLocationData, CreateKnowledgeLocationError, CreateKnowledgeLocationErrors, CreateKnowledgeLocationResponse, CreateKnowledgeLocationResponses, CreateQuickReply, CreateQuickReplyData, CreateQuickReplyError, CreateQuickReplyErrors, CreateQuickReplyResponse, CreateQuickReplyResponses, CreateTag, CreateTagData, CreateTagError, CreateTagErrors, CreateTagResponse, CreateTagResponses, CreateTemplate, CreateTemplateData, CreateTemplateError, CreateTemplateErrors, CreateTemplateResponse, CreateTemplateResponses, CreateWebhook, CreateWebhookData, CreateWebhookError, CreateWebhookErrors, CreateWebhookResponse, CreateWebhookResponses, CreateWorkflow, CreateWorkflowData, CreateWorkflowError, CreateWorkflowErrors, CreateWorkflowResponse, CreateWorkflowResponses, DashboardReport, DeleteContactFieldData, DeleteContactFieldError, DeleteContactFieldErrors, DeleteContactFieldResponse, DeleteContactFieldResponses, DeletedTemplate, DeleteKnowledgeContactData, DeleteKnowledgeContactError, DeleteKnowledgeContactErrors, DeleteKnowledgeContactResponse, DeleteKnowledgeContactResponses, DeleteKnowledgeFileData, DeleteKnowledgeFileError, DeleteKnowledgeFileErrors, DeleteKnowledgeFileResponse, DeleteKnowledgeFileResponses, DeleteKnowledgeLocationData, DeleteKnowledgeLocationError, DeleteKnowledgeLocationErrors, DeleteKnowledgeLocationResponse, DeleteKnowledgeLocationResponses, DeleteQuickReplyData, DeleteQuickReplyError, DeleteQuickReplyErrors, DeleteQuickReplyResponse, DeleteQuickReplyResponses, DeleteTagData, DeleteTagError, DeleteTagErrors, DeleteTagResponse, DeleteTagResponses, DeleteTemplateData, DeleteTemplateError, DeleteTemplateErrors, DeleteTemplateResponse, DeleteTemplateResponses, DeleteWorkflowData, DeleteWorkflowError, DeleteWorkflowErrors, DeleteWorkflowResponse, DeleteWorkflowResponses, DisableWebhookData, DisableWebhookError, DisableWebhookErrors, DisableWebhookResponse, DisableWebhookResponses, Error, FetchMessageMediaData, FetchMessageMediaError, FetchMessageMediaErrors, FetchMessageMediaResponse, FetchMessageMediaResponses, GetAdsReportData, GetAdsReportError, GetAdsReportErrors, GetAdsReportResponse, GetAdsReportResponses, GetAgentData, GetAgentError, GetAgentErrors, GetAgentOptionsData, GetAgentOptionsError, GetAgentOptionsErrors, GetAgentOptionsResponse, GetAgentOptionsResponses, GetAgentResponse, GetAgentResponses, GetBroadcastData, GetBroadcastError, GetBroadcastErrors, GetBroadcastResponse, GetBroadcastResponses, GetBroadcastsReportData, GetBroadcastsReportError, GetBroadcastsReportErrors, GetBroadcastsReportResponse, GetBroadcastsReportResponses, GetContactData, GetContactError, GetContactErrors, GetContactResponse, GetContactResponses, GetConversationData, GetConversationError, GetConversationErrors, GetConversationResponse, GetConversationResponses, GetConversationsReportData, GetConversationsReportError, GetConversationsReportErrors, GetConversationsReportResponse, GetConversationsReportResponses, GetDashboardReportData, GetDashboardReportError, GetDashboardReportErrors, GetDashboardReportResponse, GetDashboardReportResponses, GetKnowledgeContactData, GetKnowledgeContactError, GetKnowledgeContactErrors, GetKnowledgeContactResponse, GetKnowledgeContactResponses, GetKnowledgeFileData, GetKnowledgeFileError, GetKnowledgeFileErrors, GetKnowledgeFileResponse, GetKnowledgeFileResponses, GetKnowledgeLocationData, GetKnowledgeLocationError, GetKnowledgeLocationErrors, GetKnowledgeLocationResponse, GetKnowledgeLocationResponses, GetMessageData, GetMessageError, GetMessageErrors, GetMessageResponse, GetMessageResponses, GetMessagesReportData, GetMessagesReportError, GetMessagesReportErrors, GetMessagesReportResponse, GetMessagesReportResponses, GetQuickReplyData, GetQuickReplyError, GetQuickReplyErrors, GetQuickReplyResponse, GetQuickReplyResponses, GetResolutionsReportData, GetResolutionsReportError, GetResolutionsReportErrors, GetResolutionsReportResponse, GetResolutionsReportResponses, GetResponsesReportData, GetResponsesReportError, GetResponsesReportErrors, GetResponsesReportResponse, GetResponsesReportResponses, GetSendData, GetSendError, GetSendErrors, GetSendResponse, GetSendResponses, GetTeamReportData, GetTeamReportError, GetTeamReportErrors, GetTeamReportResponse, GetTeamReportResponses, GetTemplateData, GetTemplateError, GetTemplateErrors, GetTemplateResponse, GetTemplateResponses, GetWhatsAppNumberData, GetWhatsAppNumberError, GetWhatsAppNumberErrors, GetWhatsAppNumberResponse, GetWhatsAppNumberResponses, GetWorkflowData, GetWorkflowError, GetWorkflowErrors, GetWorkflowResponse, GetWorkflowResponses, IdempotencyKey, KnowledgeContact, KnowledgeFile, KnowledgeFileUpload, KnowledgeLocation, ListAgentsData, ListAgentsError, ListAgentsErrors, ListAgentsResponse, ListAgentsResponses, ListBroadcastRecipientsData, ListBroadcastRecipientsError, ListBroadcastRecipientsErrors, ListBroadcastRecipientsResponse, ListBroadcastRecipientsResponses, ListBroadcastsData, ListBroadcastsError, ListBroadcastsErrors, ListBroadcastsResponse, ListBroadcastsResponses, ListChannelsData, ListChannelsError, ListChannelsErrors, ListChannelsResponse, ListChannelsResponses, ListContactFieldsData, ListContactFieldsError, ListContactFieldsErrors, ListContactFieldsResponse, ListContactFieldsResponses, ListContactsData, ListContactsError, ListContactsErrors, ListContactsResponse, ListContactsResponses, ListConversationsData, ListConversationsError, ListConversationsErrors, ListConversationsResponse, ListConversationsResponses, ListKnowledgeContactsData, ListKnowledgeContactsError, ListKnowledgeContactsErrors, ListKnowledgeContactsResponse, ListKnowledgeContactsResponses, ListKnowledgeFilesData, ListKnowledgeFilesError, ListKnowledgeFilesErrors, ListKnowledgeFilesResponse, ListKnowledgeFilesResponses, ListKnowledgeLocationsData, ListKnowledgeLocationsError, ListKnowledgeLocationsErrors, ListKnowledgeLocationsResponse, ListKnowledgeLocationsResponses, ListMembersData, ListMembersError, ListMembersErrors, ListMembersResponse, ListMembersResponses, ListMessagesData, ListMessagesError, ListMessagesErrors, ListMessagesResponse, ListMessagesResponses, ListQuickRepliesData, ListQuickRepliesError, ListQuickRepliesErrors, ListQuickRepliesResponse, ListQuickRepliesResponses, ListTagsData, ListTagsError, ListTagsErrors, ListTagsResponse, ListTagsResponses, ListTemplatesData, ListTemplatesError, ListTemplatesErrors, ListTemplatesResponse, ListTemplatesResponses, ListWebhookDeliveriesData, ListWebhookDeliveriesError, ListWebhookDeliveriesErrors, ListWebhookDeliveriesResponse, ListWebhookDeliveriesResponses, ListWebhooksData, ListWebhooksError, ListWebhooksErrors, ListWebhooksResponse, ListWebhooksResponses, ListWhatsAppNumbersData, ListWhatsAppNumbersError, ListWhatsAppNumbersErrors, ListWhatsAppNumbersResponse, ListWhatsAppNumbersResponses, ListWorkflowExecutionsData, ListWorkflowExecutionsError, ListWorkflowExecutionsErrors, ListWorkflowExecutionsResponse, ListWorkflowExecutionsResponses, ListWorkflowsData, ListWorkflowsError, ListWorkflowsErrors, ListWorkflowsResponse, ListWorkflowsResponses, MarkConversationReadData, MarkConversationReadError, MarkConversationReadErrors, MarkConversationReadResponse, MarkConversationReadResponses, MarkConversationUnreadData, MarkConversationUnreadError, MarkConversationUnreadErrors, MarkConversationUnreadResponse, MarkConversationUnreadResponses, MediaMessage, Member, Message, MessageSearchResult, MessagesReport, PauseWorkflowData, PauseWorkflowError, PauseWorkflowErrors, PauseWorkflowResponse, PauseWorkflowResponses, QuickReply, ReopenConversationData, ReopenConversationError, ReopenConversationErrors, ReopenConversationResponse, ReopenConversationResponses, ReportPeriod, ResolutionsReport, ResolveConversationHandoffData, ResolveConversationHandoffError, ResolveConversationHandoffErrors, ResolveConversationHandoffResponse, ResolveConversationHandoffResponses, ResolveHandoff, ResponsesReport, RetryWebhookDeliveryData, RetryWebhookDeliveryError, RetryWebhookDeliveryErrors, RetryWebhookDeliveryResponse, RetryWebhookDeliveryResponses, RotateWebhookSecret, RotateWebhookSecretData, RotateWebhookSecretError, RotateWebhookSecretErrors, RotateWebhookSecretResponse, RotateWebhookSecretResponses, SearchConversationsData, SearchConversationsError, SearchConversationsErrors, SearchConversationsResponse, SearchConversationsResponses, SearchMessagesData, SearchMessagesError, SearchMessagesErrors, SearchMessagesResponse, SearchMessagesResponses, Send, SendMessage, SendMessageData, SendMessageError, SendMessageErrors, SendMessageResponse, SendMessageResponses, StartConversation, StartConversationData, StartConversationError, StartConversationErrors, StartConversationResponse, StartConversationResponses, Tag, TeamReport, Template, TemplateMessage, TemplateValidation, TestWebhookData, TestWebhookError, TestWebhookErrors, TestWebhookResponse, TestWebhookResponses, UpdateAgent, UpdateAgentData, UpdateAgentError, UpdateAgentErrors, UpdateAgentResponse, UpdateAgentResponses, UpdateContact, UpdateContactData, UpdateContactError, UpdateContactErrors, UpdateContactResponse, UpdateContactResponses, UpdateKnowledgeContact, UpdateKnowledgeContactData, UpdateKnowledgeContactError, UpdateKnowledgeContactErrors, UpdateKnowledgeContactResponse, UpdateKnowledgeContactResponses, UpdateKnowledgeFile, UpdateKnowledgeFileData, UpdateKnowledgeFileError, UpdateKnowledgeFileErrors, UpdateKnowledgeFileResponse, UpdateKnowledgeFileResponses, UpdateKnowledgeLocation, UpdateKnowledgeLocationData, UpdateKnowledgeLocationError, UpdateKnowledgeLocationErrors, UpdateKnowledgeLocationResponse, UpdateKnowledgeLocationResponses, UpdateQuickReply, UpdateQuickReplyData, UpdateQuickReplyError, UpdateQuickReplyErrors, UpdateQuickReplyResponse, UpdateQuickReplyResponses, UpdateTag, UpdateTagData, UpdateTagError, UpdateTagErrors, UpdateTagResponse, UpdateTagResponses, UpdateTemplate, UpdateTemplateData, UpdateTemplateError, UpdateTemplateErrors, UpdateTemplateResponse, UpdateTemplateResponses, UpdateWorkflow, UpdateWorkflowData, UpdateWorkflowError, UpdateWorkflowErrors, UpdateWorkflowResponse, UpdateWorkflowResponses, ValidateTemplate, ValidateTemplateData, ValidateTemplateError, ValidateTemplateErrors, ValidateTemplateResponse, ValidateTemplateResponses, Webhook, WebhookContactCreatedWebhookPayload, WebhookContactCreatedWebhookRequest, WebhookContactUpdatedWebhookPayload, WebhookContactUpdatedWebhookRequest, WebhookConversationAssignmentChangedWebhookPayload, WebhookConversationAssignmentChangedWebhookRequest, WebhookConversationClosedWebhookPayload, WebhookConversationClosedWebhookRequest, WebhookConversationOpenedWebhookPayload, WebhookConversationOpenedWebhookRequest, WebhookDelivery, WebhookEvent, WebhookMessageDeliveredWebhookPayload, WebhookMessageDeliveredWebhookRequest, WebhookMessageFailedWebhookPayload, WebhookMessageFailedWebhookRequest, WebhookMessageReadWebhookPayload, WebhookMessageReadWebhookRequest, WebhookMessageReceivedWebhookPayload, WebhookMessageReceivedWebhookRequest, WebhookMessageSentWebhookPayload, WebhookMessageSentWebhookRequest, Webhooks, WebhookTestResult, WebhookWebhookTestWebhookPayload, WebhookWebhookTestWebhookRequest, WhatsAppNumber, Workflow, WorkflowExecution } from './types.gen.js';
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Client, ClientMeta, Options as Options2, RequestResult, TDataShape } from './client/index.js';
|
|
2
|
-
import type { ActivateWorkflowData, ActivateWorkflowErrors, ActivateWorkflowResponses, AddContactNoteData, AddContactNoteErrors, AddContactNoteResponses, ArchiveAgentData, ArchiveAgentErrors, ArchiveAgentResponses, AssignConversationAgentData, AssignConversationAgentErrors, AssignConversationAgentResponses, AssignConversationData, AssignConversationErrors, AssignConversationResponses, CancelBroadcastData, CancelBroadcastErrors, CancelBroadcastResponses, ChangeContactsTagsData, ChangeContactsTagsErrors, ChangeContactsTagsResponses, ChangeConversationTagsData, ChangeConversationTagsErrors, ChangeConversationTagsResponses, CloseConversationData, CloseConversationErrors, CloseConversationResponses, CompleteKnowledgeFileData, CompleteKnowledgeFileErrors, CompleteKnowledgeFileResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateBroadcastData, CreateBroadcastErrors, CreateBroadcastResponses, CreateContactData, CreateContactErrors, CreateContactFieldData, CreateContactFieldErrors, CreateContactFieldResponses, CreateContactResponses, CreateKnowledgeContactData, CreateKnowledgeContactErrors, CreateKnowledgeContactResponses, CreateKnowledgeFileData, CreateKnowledgeFileErrors, CreateKnowledgeFileResponses, CreateKnowledgeLocationData, CreateKnowledgeLocationErrors, CreateKnowledgeLocationResponses, CreateQuickReplyData, CreateQuickReplyErrors, CreateQuickReplyResponses, CreateTagData, CreateTagErrors, CreateTagResponses, CreateTemplateData, CreateTemplateErrors, CreateTemplateResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookResponses, CreateWorkflowData, CreateWorkflowErrors, CreateWorkflowResponses, DeleteContactFieldData, DeleteContactFieldErrors, DeleteContactFieldResponses, DeleteKnowledgeContactData, DeleteKnowledgeContactErrors, DeleteKnowledgeContactResponses, DeleteKnowledgeFileData, DeleteKnowledgeFileErrors, DeleteKnowledgeFileResponses, DeleteKnowledgeLocationData, DeleteKnowledgeLocationErrors, DeleteKnowledgeLocationResponses, DeleteQuickReplyData, DeleteQuickReplyErrors, DeleteQuickReplyResponses, DeleteTagData, DeleteTagErrors, DeleteTagResponses, DeleteTemplateData, DeleteTemplateErrors, DeleteTemplateResponses, DeleteWorkflowData, DeleteWorkflowErrors, DeleteWorkflowResponses, DisableWebhookData, DisableWebhookErrors, DisableWebhookResponses, GetAdsReportData, GetAdsReportErrors, GetAdsReportResponses, GetAgentData, GetAgentErrors, GetAgentOptionsData, GetAgentOptionsErrors, GetAgentOptionsResponses, GetAgentResponses, GetBroadcastData, GetBroadcastErrors, GetBroadcastResponses, GetBroadcastsReportData, GetBroadcastsReportErrors, GetBroadcastsReportResponses, GetContactData, GetContactErrors, GetContactResponses, GetConversationData, GetConversationErrors, GetConversationResponses, GetConversationsReportData, GetConversationsReportErrors, GetConversationsReportResponses, GetDashboardReportData, GetDashboardReportErrors, GetDashboardReportResponses, GetKnowledgeContactData, GetKnowledgeContactErrors, GetKnowledgeContactResponses, GetKnowledgeFileData, GetKnowledgeFileErrors, GetKnowledgeFileResponses, GetKnowledgeLocationData, GetKnowledgeLocationErrors, GetKnowledgeLocationResponses, GetMessageData, GetMessageErrors, GetMessageResponses, GetMessagesReportData, GetMessagesReportErrors, GetMessagesReportResponses, GetQuickReplyData, GetQuickReplyErrors, GetQuickReplyResponses, GetResolutionsReportData, GetResolutionsReportErrors, GetResolutionsReportResponses, GetResponsesReportData, GetResponsesReportErrors, GetResponsesReportResponses, GetSendData, GetSendErrors, GetSendResponses, GetTeamReportData, GetTeamReportErrors, GetTeamReportResponses, GetTemplateData, GetTemplateErrors, GetTemplateResponses, GetWhatsAppNumberData, GetWhatsAppNumberErrors, GetWhatsAppNumberResponses, GetWorkflowData, GetWorkflowErrors, GetWorkflowResponses, ListAgentsData, ListAgentsErrors, ListAgentsResponses, ListBroadcastRecipientsData, ListBroadcastRecipientsErrors, ListBroadcastRecipientsResponses, ListBroadcastsData, ListBroadcastsErrors, ListBroadcastsResponses, ListChannelsData, ListChannelsErrors, ListChannelsResponses, ListContactFieldsData, ListContactFieldsErrors, ListContactFieldsResponses, ListContactsData, ListContactsErrors, ListContactsResponses, ListConversationsData, ListConversationsErrors, ListConversationsResponses, ListKnowledgeContactsData, ListKnowledgeContactsErrors, ListKnowledgeContactsResponses, ListKnowledgeFilesData, ListKnowledgeFilesErrors, ListKnowledgeFilesResponses, ListKnowledgeLocationsData, ListKnowledgeLocationsErrors, ListKnowledgeLocationsResponses, ListMembersData, ListMembersErrors, ListMembersResponses, ListMessagesData, ListMessagesErrors, ListMessagesResponses, ListQuickRepliesData, ListQuickRepliesErrors, ListQuickRepliesResponses, ListTagsData, ListTagsErrors, ListTagsResponses, ListTemplatesData, ListTemplatesErrors, ListTemplatesResponses, ListWebhookDeliveriesData, ListWebhookDeliveriesErrors, ListWebhookDeliveriesResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponses, ListWhatsAppNumbersData, ListWhatsAppNumbersErrors, ListWhatsAppNumbersResponses, ListWorkflowExecutionsData, ListWorkflowExecutionsErrors, ListWorkflowExecutionsResponses, ListWorkflowsData, ListWorkflowsErrors, ListWorkflowsResponses, MarkConversationReadData, MarkConversationReadErrors, MarkConversationReadResponses, PauseWorkflowData, PauseWorkflowErrors, PauseWorkflowResponses, ReopenConversationData, ReopenConversationErrors, ReopenConversationResponses, RetryWebhookDeliveryData, RetryWebhookDeliveryErrors, RetryWebhookDeliveryResponses, RotateWebhookSecretData, RotateWebhookSecretErrors, RotateWebhookSecretResponses, SearchConversationsData, SearchConversationsErrors, SearchConversationsResponses, SearchMessagesData, SearchMessagesErrors, SearchMessagesResponses, SendMessageData, SendMessageErrors, SendMessageResponses, StartConversationData, StartConversationErrors, StartConversationResponses, TestWebhookData, TestWebhookErrors, TestWebhookResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateContactData, UpdateContactErrors, UpdateContactResponses, UpdateKnowledgeContactData, UpdateKnowledgeContactErrors, UpdateKnowledgeContactResponses, UpdateKnowledgeFileData, UpdateKnowledgeFileErrors, UpdateKnowledgeFileResponses, UpdateKnowledgeLocationData, UpdateKnowledgeLocationErrors, UpdateKnowledgeLocationResponses, UpdateQuickReplyData, UpdateQuickReplyErrors, UpdateQuickReplyResponses, UpdateTagData, UpdateTagErrors, UpdateTagResponses, UpdateTemplateData, UpdateTemplateErrors, UpdateTemplateResponses, UpdateWorkflowData, UpdateWorkflowErrors, UpdateWorkflowResponses, ValidateTemplateData, ValidateTemplateErrors, ValidateTemplateResponses } from './types.gen.js';
|
|
2
|
+
import type { ActivateWorkflowData, ActivateWorkflowErrors, ActivateWorkflowResponses, AddContactNoteData, AddContactNoteErrors, AddContactNoteResponses, ArchiveAgentData, ArchiveAgentErrors, ArchiveAgentResponses, AssignConversationAgentData, AssignConversationAgentErrors, AssignConversationAgentResponses, AssignConversationData, AssignConversationErrors, AssignConversationResponses, AssignConversationsData, AssignConversationsErrors, AssignConversationsResponses, CancelBroadcastData, CancelBroadcastErrors, CancelBroadcastResponses, ChangeContactsTagsData, ChangeContactsTagsErrors, ChangeContactsTagsResponses, ChangeConversationTagsData, ChangeConversationTagsErrors, ChangeConversationTagsResponses, CloseConversationData, CloseConversationErrors, CloseConversationResponses, CompleteKnowledgeFileData, CompleteKnowledgeFileErrors, CompleteKnowledgeFileResponses, CreateAgentData, CreateAgentErrors, CreateAgentResponses, CreateBroadcastData, CreateBroadcastErrors, CreateBroadcastResponses, CreateContactData, CreateContactErrors, CreateContactFieldData, CreateContactFieldErrors, CreateContactFieldResponses, CreateContactResponses, CreateKnowledgeContactData, CreateKnowledgeContactErrors, CreateKnowledgeContactResponses, CreateKnowledgeFileData, CreateKnowledgeFileErrors, CreateKnowledgeFileResponses, CreateKnowledgeLocationData, CreateKnowledgeLocationErrors, CreateKnowledgeLocationResponses, CreateQuickReplyData, CreateQuickReplyErrors, CreateQuickReplyResponses, CreateTagData, CreateTagErrors, CreateTagResponses, CreateTemplateData, CreateTemplateErrors, CreateTemplateResponses, CreateWebhookData, CreateWebhookErrors, CreateWebhookResponses, CreateWorkflowData, CreateWorkflowErrors, CreateWorkflowResponses, DeleteContactFieldData, DeleteContactFieldErrors, DeleteContactFieldResponses, DeleteKnowledgeContactData, DeleteKnowledgeContactErrors, DeleteKnowledgeContactResponses, DeleteKnowledgeFileData, DeleteKnowledgeFileErrors, DeleteKnowledgeFileResponses, DeleteKnowledgeLocationData, DeleteKnowledgeLocationErrors, DeleteKnowledgeLocationResponses, DeleteQuickReplyData, DeleteQuickReplyErrors, DeleteQuickReplyResponses, DeleteTagData, DeleteTagErrors, DeleteTagResponses, DeleteTemplateData, DeleteTemplateErrors, DeleteTemplateResponses, DeleteWorkflowData, DeleteWorkflowErrors, DeleteWorkflowResponses, DisableWebhookData, DisableWebhookErrors, DisableWebhookResponses, FetchMessageMediaData, FetchMessageMediaErrors, FetchMessageMediaResponses, GetAdsReportData, GetAdsReportErrors, GetAdsReportResponses, GetAgentData, GetAgentErrors, GetAgentOptionsData, GetAgentOptionsErrors, GetAgentOptionsResponses, GetAgentResponses, GetBroadcastData, GetBroadcastErrors, GetBroadcastResponses, GetBroadcastsReportData, GetBroadcastsReportErrors, GetBroadcastsReportResponses, GetContactData, GetContactErrors, GetContactResponses, GetConversationData, GetConversationErrors, GetConversationResponses, GetConversationsReportData, GetConversationsReportErrors, GetConversationsReportResponses, GetDashboardReportData, GetDashboardReportErrors, GetDashboardReportResponses, GetKnowledgeContactData, GetKnowledgeContactErrors, GetKnowledgeContactResponses, GetKnowledgeFileData, GetKnowledgeFileErrors, GetKnowledgeFileResponses, GetKnowledgeLocationData, GetKnowledgeLocationErrors, GetKnowledgeLocationResponses, GetMessageData, GetMessageErrors, GetMessageResponses, GetMessagesReportData, GetMessagesReportErrors, GetMessagesReportResponses, GetQuickReplyData, GetQuickReplyErrors, GetQuickReplyResponses, GetResolutionsReportData, GetResolutionsReportErrors, GetResolutionsReportResponses, GetResponsesReportData, GetResponsesReportErrors, GetResponsesReportResponses, GetSendData, GetSendErrors, GetSendResponses, GetTeamReportData, GetTeamReportErrors, GetTeamReportResponses, GetTemplateData, GetTemplateErrors, GetTemplateResponses, GetWhatsAppNumberData, GetWhatsAppNumberErrors, GetWhatsAppNumberResponses, GetWorkflowData, GetWorkflowErrors, GetWorkflowResponses, ListAgentsData, ListAgentsErrors, ListAgentsResponses, ListBroadcastRecipientsData, ListBroadcastRecipientsErrors, ListBroadcastRecipientsResponses, ListBroadcastsData, ListBroadcastsErrors, ListBroadcastsResponses, ListChannelsData, ListChannelsErrors, ListChannelsResponses, ListContactFieldsData, ListContactFieldsErrors, ListContactFieldsResponses, ListContactsData, ListContactsErrors, ListContactsResponses, ListConversationsData, ListConversationsErrors, ListConversationsResponses, ListKnowledgeContactsData, ListKnowledgeContactsErrors, ListKnowledgeContactsResponses, ListKnowledgeFilesData, ListKnowledgeFilesErrors, ListKnowledgeFilesResponses, ListKnowledgeLocationsData, ListKnowledgeLocationsErrors, ListKnowledgeLocationsResponses, ListMembersData, ListMembersErrors, ListMembersResponses, ListMessagesData, ListMessagesErrors, ListMessagesResponses, ListQuickRepliesData, ListQuickRepliesErrors, ListQuickRepliesResponses, ListTagsData, ListTagsErrors, ListTagsResponses, ListTemplatesData, ListTemplatesErrors, ListTemplatesResponses, ListWebhookDeliveriesData, ListWebhookDeliveriesErrors, ListWebhookDeliveriesResponses, ListWebhooksData, ListWebhooksErrors, ListWebhooksResponses, ListWhatsAppNumbersData, ListWhatsAppNumbersErrors, ListWhatsAppNumbersResponses, ListWorkflowExecutionsData, ListWorkflowExecutionsErrors, ListWorkflowExecutionsResponses, ListWorkflowsData, ListWorkflowsErrors, ListWorkflowsResponses, MarkConversationReadData, MarkConversationReadErrors, MarkConversationReadResponses, MarkConversationUnreadData, MarkConversationUnreadErrors, MarkConversationUnreadResponses, PauseWorkflowData, PauseWorkflowErrors, PauseWorkflowResponses, ReopenConversationData, ReopenConversationErrors, ReopenConversationResponses, ResolveConversationHandoffData, ResolveConversationHandoffErrors, ResolveConversationHandoffResponses, RetryWebhookDeliveryData, RetryWebhookDeliveryErrors, RetryWebhookDeliveryResponses, RotateWebhookSecretData, RotateWebhookSecretErrors, RotateWebhookSecretResponses, SearchConversationsData, SearchConversationsErrors, SearchConversationsResponses, SearchMessagesData, SearchMessagesErrors, SearchMessagesResponses, SendMessageData, SendMessageErrors, SendMessageResponses, StartConversationData, StartConversationErrors, StartConversationResponses, TestWebhookData, TestWebhookErrors, TestWebhookResponses, UpdateAgentData, UpdateAgentErrors, UpdateAgentResponses, UpdateContactData, UpdateContactErrors, UpdateContactResponses, UpdateKnowledgeContactData, UpdateKnowledgeContactErrors, UpdateKnowledgeContactResponses, UpdateKnowledgeFileData, UpdateKnowledgeFileErrors, UpdateKnowledgeFileResponses, UpdateKnowledgeLocationData, UpdateKnowledgeLocationErrors, UpdateKnowledgeLocationResponses, UpdateQuickReplyData, UpdateQuickReplyErrors, UpdateQuickReplyResponses, UpdateTagData, UpdateTagErrors, UpdateTagResponses, UpdateTemplateData, UpdateTemplateErrors, UpdateTemplateResponses, UpdateWorkflowData, UpdateWorkflowErrors, UpdateWorkflowResponses, ValidateTemplateData, ValidateTemplateErrors, ValidateTemplateResponses } from './types.gen.js';
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -90,7 +90,7 @@ export declare class RickyApi extends HeyApiClient {
|
|
|
90
90
|
/**
|
|
91
91
|
* List conversations
|
|
92
92
|
*
|
|
93
|
-
* Latest activity first.
|
|
93
|
+
* Latest activity first. The filters are the inbox's and combine with each other; send the same ones with `cursor`.
|
|
94
94
|
*
|
|
95
95
|
* Scope: `conversations:read`.
|
|
96
96
|
*/
|
|
@@ -615,6 +615,14 @@ export declare class RickyApi extends HeyApiClient {
|
|
|
615
615
|
* Scope: `contacts:write`.
|
|
616
616
|
*/
|
|
617
617
|
changeConversationTags<ThrowOnError extends boolean = true>(options: Options<ChangeConversationTagsData, ThrowOnError>): RequestResult<ChangeConversationTagsResponses, ChangeConversationTagsErrors, ThrowOnError, 'data'>;
|
|
618
|
+
/**
|
|
619
|
+
* Mark a conversation unread
|
|
620
|
+
*
|
|
621
|
+
* Marks it unread for the whole team, as the inbox does. The contact sees nothing. Send no body.
|
|
622
|
+
*
|
|
623
|
+
* Scope: `conversations:write`.
|
|
624
|
+
*/
|
|
625
|
+
markConversationUnread<ThrowOnError extends boolean = true>(options: Options<MarkConversationUnreadData, ThrowOnError>): RequestResult<MarkConversationUnreadResponses, MarkConversationUnreadErrors, ThrowOnError, 'data'>;
|
|
618
626
|
/**
|
|
619
627
|
* Mark a conversation read
|
|
620
628
|
*
|
|
@@ -775,5 +783,29 @@ export declare class RickyApi extends HeyApiClient {
|
|
|
775
783
|
* Scope: `broadcasts:read`.
|
|
776
784
|
*/
|
|
777
785
|
listBroadcastRecipients<ThrowOnError extends boolean = true>(options: Options<ListBroadcastRecipientsData, ThrowOnError>): RequestResult<ListBroadcastRecipientsResponses, ListBroadcastRecipientsErrors, ThrowOnError, 'data'>;
|
|
786
|
+
/**
|
|
787
|
+
* Assign many conversations
|
|
788
|
+
*
|
|
789
|
+
* Makes members responsible for up to 100 conversations, as assigning each one does, and answers one result per conversation, in order. Each member also becomes the contact's owner. A member outside the organization refuses the whole request before any conversation changes.
|
|
790
|
+
*
|
|
791
|
+
* Scope: `conversations:write`.
|
|
792
|
+
*/
|
|
793
|
+
assignConversations<ThrowOnError extends boolean = true>(options: Options<AssignConversationsData, ThrowOnError>): RequestResult<AssignConversationsResponses, AssignConversationsErrors, ThrowOnError, 'data'>;
|
|
794
|
+
/**
|
|
795
|
+
* Resolve a handoff
|
|
796
|
+
*
|
|
797
|
+
* Ends the conversation's `active_handoff` as the inbox does: back to the AI agent that asked for it, or with the member. A conversation with no handoff waiting answers `422 rule_violation`, and so does `returned_to_ai` when no AI agent asked for it.
|
|
798
|
+
*
|
|
799
|
+
* Scope: `conversations:write`.
|
|
800
|
+
*/
|
|
801
|
+
resolveConversationHandoff<ThrowOnError extends boolean = true>(options: Options<ResolveConversationHandoffData, ThrowOnError>): RequestResult<ResolveConversationHandoffResponses, ResolveConversationHandoffErrors, ThrowOnError, 'data'>;
|
|
802
|
+
/**
|
|
803
|
+
* Fetch a message's file
|
|
804
|
+
*
|
|
805
|
+
* Ricky stores the file of each message it receives in the background, and `media.url` is null until it has. This stores it now from the provider and answers the message with its `url`; a file already stored answers at once. A message without a received file, or whose file the provider says expired (it keeps them about 30 days), answers `422 rule_violation`; other provider failures answer `502 upstream_error`. Send no body.
|
|
806
|
+
*
|
|
807
|
+
* Scope: `conversations:read`.
|
|
808
|
+
*/
|
|
809
|
+
fetchMessageMedia<ThrowOnError extends boolean = true>(options: Options<FetchMessageMediaData, ThrowOnError>): RequestResult<FetchMessageMediaResponses, FetchMessageMediaErrors, ThrowOnError, 'data'>;
|
|
778
810
|
}
|
|
779
811
|
export {};
|