useyuva 0.0.20 → 0.0.22
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/types/schema.gen.d.ts +55 -7
- package/package.json +1 -1
|
@@ -1551,6 +1551,10 @@ export interface paths {
|
|
|
1551
1551
|
* label. Inboxes, assignees and labels without open conversations are left out of their lists. Conversations flagged as
|
|
1552
1552
|
* spam are counted only in `spam`.
|
|
1553
1553
|
*
|
|
1554
|
+
* `kind` limits every count to conversations of those kinds, as on `GET /v1/conversations`:
|
|
1555
|
+
* the panel's Conversations view sends `kind=conversation`, its Feedback section
|
|
1556
|
+
* `kind=feedback`. Without it every kind is counted.
|
|
1557
|
+
*
|
|
1554
1558
|
* Scope: `conversations:read`.
|
|
1555
1559
|
*/
|
|
1556
1560
|
get: operations["getConversationCounts"];
|
|
@@ -1612,7 +1616,7 @@ export interface paths {
|
|
|
1612
1616
|
* now: replies sent by members (messages members wrote or drafts they sent; not notes, not
|
|
1613
1617
|
* bots' own messages), conversations closed, the median time from a contact's first
|
|
1614
1618
|
* message to the first member reply, over the conversations whose first reply falls in the
|
|
1615
|
-
* window, and the ratings contacts gave in it. `members` breaks replies and closes down per member, leaving out members with
|
|
1619
|
+
* window, and the ratings contacts gave in it (feedback is never rated and left out). `members` breaks replies and closes down per member, leaving out members with
|
|
1616
1620
|
* neither. Nothing is stored for it; it is counted from the messages each time.
|
|
1617
1621
|
*
|
|
1618
1622
|
* `since` defaults to the start of today in `timezone` (an IANA name, `UTC` by default); the
|
|
@@ -6049,7 +6053,8 @@ export interface paths {
|
|
|
6049
6053
|
/**
|
|
6050
6054
|
* List the contact's conversations
|
|
6051
6055
|
* @description The contact's conversations in the session's inbox, on any channel, latest message first.
|
|
6052
|
-
* Members' notes and internal events are never shown to contacts.
|
|
6056
|
+
* Members' notes and internal events are never shown to contacts. `kind` keeps only
|
|
6057
|
+
* conversations of those kinds, e.g. `kind=feedback` for the feedback the contact sent.
|
|
6053
6058
|
*/
|
|
6054
6059
|
get: operations["listClientConversations"];
|
|
6055
6060
|
put?: never;
|
|
@@ -6159,7 +6164,7 @@ export interface paths {
|
|
|
6159
6164
|
* whose `can_rate` is true. It is stored once per close: members see it in the thread as a
|
|
6160
6165
|
* `rated` event and on the conversation, and it sends the `conversation.rated` webhook.
|
|
6161
6166
|
* Answers `409 rating_unavailable` when `can_rate` is false (the inbox does not ask for
|
|
6162
|
-
* ratings, the conversation is open
|
|
6167
|
+
* ratings, the conversation is open or a `feedback`, the close is older than 30 days) and
|
|
6163
6168
|
* `409 already_rated` when the contact already rated this close.
|
|
6164
6169
|
*/
|
|
6165
6170
|
post: operations["rateClientConversation"];
|
|
@@ -7662,6 +7667,7 @@ export interface components {
|
|
|
7662
7667
|
* the widget and the mobile SDKs offer it, and e-mail contacts get a request with two
|
|
7663
7668
|
* links after a member's conversation is closed. Off by default. Only conversations
|
|
7664
7669
|
* closed after it was turned on can be rated; turning it off and on again starts over.
|
|
7670
|
+
* Feedback is never rated.
|
|
7665
7671
|
*/
|
|
7666
7672
|
ask_for_rating: boolean;
|
|
7667
7673
|
sender: components["schemas"]["InboxSender"];
|
|
@@ -10863,6 +10869,16 @@ export interface components {
|
|
|
10863
10869
|
/** @description What a `feedback` conversation was sent with. Absent fields were not sent. */
|
|
10864
10870
|
Feedback: {
|
|
10865
10871
|
category: components["schemas"]["FeedbackCategory"];
|
|
10872
|
+
/**
|
|
10873
|
+
* @description The first line of the contact's first message, trimmed and cut to 200 characters; empty
|
|
10874
|
+
* when that message has no text. For a triage row; the message itself is in the thread.
|
|
10875
|
+
*/
|
|
10876
|
+
text: string;
|
|
10877
|
+
/**
|
|
10878
|
+
* Format: int32
|
|
10879
|
+
* @description Files (e.g. screenshots) attached to the contact's first message.
|
|
10880
|
+
*/
|
|
10881
|
+
attachment_count: number;
|
|
10866
10882
|
/** @description The contact allowed replies by e-mail. */
|
|
10867
10883
|
allow_email: boolean;
|
|
10868
10884
|
app_version?: string;
|
|
@@ -12713,7 +12729,8 @@ export interface components {
|
|
|
12713
12729
|
last_read_by_member_at?: string;
|
|
12714
12730
|
/**
|
|
12715
12731
|
* @description The contact may rate it now with `POST /client/v1/conversations/{id}/rating`: the inbox
|
|
12716
|
-
* asks for ratings (`ask_for_rating`), the conversation is
|
|
12732
|
+
* asks for ratings (`ask_for_rating`), the conversation is not a `feedback` (feedback is
|
|
12733
|
+
* never rated), it is closed, was closed at most 30
|
|
12717
12734
|
* days ago and after the inbox started asking, and has no rating since it was closed. A message from the contact reopens it,
|
|
12718
12735
|
* and the next close allows a new rating.
|
|
12719
12736
|
*/
|
|
@@ -14574,6 +14591,13 @@ export interface components {
|
|
|
14574
14591
|
* @enum {string}
|
|
14575
14592
|
*/
|
|
14576
14593
|
signup: "invite" | "open";
|
|
14594
|
+
/**
|
|
14595
|
+
* @description The domain, without a leading dot, on which the panel writes its `yuva_locale` cookie so
|
|
14596
|
+
* a site on the same domain can open in the person's language. Omitted when
|
|
14597
|
+
* `YUVA_LOCALE_COOKIE_DOMAIN` is not set.
|
|
14598
|
+
* @example example.com
|
|
14599
|
+
*/
|
|
14600
|
+
locale_cookie_domain?: string;
|
|
14577
14601
|
};
|
|
14578
14602
|
/** @example #2563eb */
|
|
14579
14603
|
EmailColor: string;
|
|
@@ -15267,6 +15291,12 @@ export interface components {
|
|
|
15267
15291
|
Search: string;
|
|
15268
15292
|
/** @description The `next_cursor` of the previous page. */
|
|
15269
15293
|
Cursor: string;
|
|
15294
|
+
/**
|
|
15295
|
+
* @description Only conversations of these kinds, e.g. `feedback` for the feedback view. Repeat the
|
|
15296
|
+
* parameter (`kind=feedback&kind=conversation`) or give a comma-separated list
|
|
15297
|
+
* (`kind=feedback,conversation`).
|
|
15298
|
+
*/
|
|
15299
|
+
ConversationKinds: components["schemas"]["ConversationKind"][];
|
|
15270
15300
|
/** @description Page size, 1 to 100; 25 by default. */
|
|
15271
15301
|
Limit: number;
|
|
15272
15302
|
};
|
|
@@ -17635,7 +17665,12 @@ export interface operations {
|
|
|
17635
17665
|
inbox_id?: string;
|
|
17636
17666
|
/** @description Only this contact's conversations. A contact of another workspace answers `404`. */
|
|
17637
17667
|
contact_id?: string;
|
|
17638
|
-
|
|
17668
|
+
/**
|
|
17669
|
+
* @description Only conversations in these statuses, e.g. `status=open,pending` for what is still to
|
|
17670
|
+
* do. Repeat the parameter or give a comma-separated list. Without it every status is
|
|
17671
|
+
* listed, snoozed included.
|
|
17672
|
+
*/
|
|
17673
|
+
status?: components["schemas"]["ConversationStatus"][];
|
|
17639
17674
|
/** @description A member id, `me` (member sessions only) or `unassigned`. */
|
|
17640
17675
|
assignee?: string;
|
|
17641
17676
|
label_id?: string;
|
|
@@ -17649,7 +17684,7 @@ export interface operations {
|
|
|
17649
17684
|
* parameter (`kind=feedback&kind=conversation`) or give a comma-separated list
|
|
17650
17685
|
* (`kind=feedback,conversation`).
|
|
17651
17686
|
*/
|
|
17652
|
-
kind?: components["
|
|
17687
|
+
kind?: components["parameters"]["ConversationKinds"];
|
|
17653
17688
|
/**
|
|
17654
17689
|
* @description Only conversations that started on a channel of these kinds (`channel_kind` on the
|
|
17655
17690
|
* conversation). Repeat the parameter or give a comma-separated list. Conversations
|
|
@@ -17744,7 +17779,14 @@ export interface operations {
|
|
|
17744
17779
|
};
|
|
17745
17780
|
getConversationCounts: {
|
|
17746
17781
|
parameters: {
|
|
17747
|
-
query?:
|
|
17782
|
+
query?: {
|
|
17783
|
+
/**
|
|
17784
|
+
* @description Only conversations of these kinds, e.g. `feedback` for the feedback view. Repeat the
|
|
17785
|
+
* parameter (`kind=feedback&kind=conversation`) or give a comma-separated list
|
|
17786
|
+
* (`kind=feedback,conversation`).
|
|
17787
|
+
*/
|
|
17788
|
+
kind?: components["parameters"]["ConversationKinds"];
|
|
17789
|
+
};
|
|
17748
17790
|
header?: {
|
|
17749
17791
|
/** @description The workspace to act on; see "Workspace selection". */
|
|
17750
17792
|
"Yuva-Workspace"?: components["parameters"]["WorkspaceHeader"];
|
|
@@ -24327,6 +24369,12 @@ export interface operations {
|
|
|
24327
24369
|
listClientConversations: {
|
|
24328
24370
|
parameters: {
|
|
24329
24371
|
query?: {
|
|
24372
|
+
/**
|
|
24373
|
+
* @description Only conversations of these kinds, e.g. `feedback` for the feedback view. Repeat the
|
|
24374
|
+
* parameter (`kind=feedback&kind=conversation`) or give a comma-separated list
|
|
24375
|
+
* (`kind=feedback,conversation`).
|
|
24376
|
+
*/
|
|
24377
|
+
kind?: components["parameters"]["ConversationKinds"];
|
|
24330
24378
|
/** @description The `next_cursor` of the previous page. */
|
|
24331
24379
|
cursor?: components["parameters"]["Cursor"];
|
|
24332
24380
|
/** @description Page size, 1 to 100; 25 by default. */
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "useyuva",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.22",
|
|
4
4
|
"description": "Yuva for the web: a headless client for contacts, the <yuva-chat> element, documentation page feedback and discussions, the <yuva-subscribe> mailing list form, cookieless web analytics, React hooks, a Nuxt module, a typed /v1 client and server helpers for identity tokens, webhooks and server-side analytics.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|