useyuva 0.0.14 → 0.0.16
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 +185 -0
- package/package.json +1 -1
|
@@ -1559,6 +1559,43 @@ export interface paths {
|
|
|
1559
1559
|
patch?: never;
|
|
1560
1560
|
trace?: never;
|
|
1561
1561
|
};
|
|
1562
|
+
"/v1/home": {
|
|
1563
|
+
parameters: {
|
|
1564
|
+
query?: never;
|
|
1565
|
+
header?: never;
|
|
1566
|
+
path?: never;
|
|
1567
|
+
cookie?: never;
|
|
1568
|
+
};
|
|
1569
|
+
/**
|
|
1570
|
+
* Everything the workspace has today, in one answer
|
|
1571
|
+
* @description The panel's Home page in one request, for the calling member and only what they may see.
|
|
1572
|
+
* Member sessions only (API keys and OAuth tokens answer `403 member_session_required`).
|
|
1573
|
+
* Every block is read from the counters and rollups the server keeps; none of it spends the
|
|
1574
|
+
* workspace's analytics query slots.
|
|
1575
|
+
*
|
|
1576
|
+
* - `inbox` (every member): open, unassigned and waiting conversations in the inboxes the
|
|
1577
|
+
* member can see, counted as `GET /v1/conversations/counts` counts them (spam left out),
|
|
1578
|
+
* and the conversation that has waited longest. A conversation waits while the contact's
|
|
1579
|
+
* last message has no reply from a member or bot after it; `since` is the contact's first
|
|
1580
|
+
* message after the last reply.
|
|
1581
|
+
* - `analytics` (when the server collects analytics): the properties the member can see, as
|
|
1582
|
+
* `GET /v1/analytics/properties` lists them, each with visitors today, visitors in the last
|
|
1583
|
+
* 30 minutes (as `GET /v1/analytics/properties/{id}/realtime` counts them) and visitors per
|
|
1584
|
+
* local day for the last seven days. Left out for an agent who can see no property.
|
|
1585
|
+
* - `broadcasts` (when the server sends broadcasts): the last sent broadcast of the inboxes
|
|
1586
|
+
* the member can see. There is no open tracking, so there are no opens.
|
|
1587
|
+
* - `setup` (owners and admins): the setup checklist, built from the same state as the MCP
|
|
1588
|
+
* `get_setup_state` tool.
|
|
1589
|
+
*/
|
|
1590
|
+
get: operations["getHome"];
|
|
1591
|
+
put?: never;
|
|
1592
|
+
post?: never;
|
|
1593
|
+
delete?: never;
|
|
1594
|
+
options?: never;
|
|
1595
|
+
head?: never;
|
|
1596
|
+
patch?: never;
|
|
1597
|
+
trace?: never;
|
|
1598
|
+
};
|
|
1562
1599
|
"/v1/stats": {
|
|
1563
1600
|
parameters: {
|
|
1564
1601
|
query?: never;
|
|
@@ -8685,6 +8722,129 @@ export interface components {
|
|
|
8685
8722
|
/** @description Per label id. */
|
|
8686
8723
|
labels: components["schemas"]["CountByID"][];
|
|
8687
8724
|
};
|
|
8725
|
+
/** @description The Home blocks; a block the member may not see is absent. */
|
|
8726
|
+
Home: {
|
|
8727
|
+
inbox: components["schemas"]["HomeInbox"];
|
|
8728
|
+
analytics?: components["schemas"]["HomeAnalytics"];
|
|
8729
|
+
broadcasts?: components["schemas"]["HomeBroadcasts"];
|
|
8730
|
+
setup?: components["schemas"]["HomeSetup"];
|
|
8731
|
+
};
|
|
8732
|
+
HomeInbox: {
|
|
8733
|
+
/**
|
|
8734
|
+
* Format: int64
|
|
8735
|
+
* @description Open conversations, spam left out (`all` in the conversation counts).
|
|
8736
|
+
*/
|
|
8737
|
+
open: number;
|
|
8738
|
+
/** Format: int64 */
|
|
8739
|
+
unassigned: number;
|
|
8740
|
+
/**
|
|
8741
|
+
* Format: int64
|
|
8742
|
+
* @description Open conversations whose contact waits for a reply.
|
|
8743
|
+
*/
|
|
8744
|
+
waiting: number;
|
|
8745
|
+
oldest_waiting?: components["schemas"]["HomeWaitingConversation"];
|
|
8746
|
+
};
|
|
8747
|
+
/** @description The open conversation that has waited longest; absent when none waits. */
|
|
8748
|
+
HomeWaitingConversation: {
|
|
8749
|
+
/** Format: uuid */
|
|
8750
|
+
id: string;
|
|
8751
|
+
/** Format: uuid */
|
|
8752
|
+
inbox_id: string;
|
|
8753
|
+
subject: string;
|
|
8754
|
+
contact: components["schemas"]["HomeContact"];
|
|
8755
|
+
/**
|
|
8756
|
+
* Format: date-time
|
|
8757
|
+
* @description The contact's first message after the last reply.
|
|
8758
|
+
*/
|
|
8759
|
+
since: string;
|
|
8760
|
+
};
|
|
8761
|
+
HomeContact: {
|
|
8762
|
+
/** Format: uuid */
|
|
8763
|
+
id: string;
|
|
8764
|
+
/** @description Empty when the contact has no name. */
|
|
8765
|
+
name: string;
|
|
8766
|
+
/**
|
|
8767
|
+
* Format: email
|
|
8768
|
+
* @description The contact's first address, when it has one.
|
|
8769
|
+
*/
|
|
8770
|
+
email?: string;
|
|
8771
|
+
};
|
|
8772
|
+
HomeAnalytics: {
|
|
8773
|
+
properties: components["schemas"]["HomeProperty"][];
|
|
8774
|
+
};
|
|
8775
|
+
HomeProperty: {
|
|
8776
|
+
/** Format: uuid */
|
|
8777
|
+
id: string;
|
|
8778
|
+
/** Format: uuid */
|
|
8779
|
+
inbox_id?: string;
|
|
8780
|
+
name: string;
|
|
8781
|
+
domains: components["schemas"]["AnalyticsDomain"][];
|
|
8782
|
+
platforms: components["schemas"]["AnalyticsPlatform"][];
|
|
8783
|
+
/** @description IANA time zone that defines the property's day. */
|
|
8784
|
+
timezone: string;
|
|
8785
|
+
/**
|
|
8786
|
+
* Format: int64
|
|
8787
|
+
* @description Distinct visitors so far today, in the property's time zone.
|
|
8788
|
+
*/
|
|
8789
|
+
visitors_today: number;
|
|
8790
|
+
/**
|
|
8791
|
+
* Format: int64
|
|
8792
|
+
* @description Distinct visitors in the last 30 minutes.
|
|
8793
|
+
*/
|
|
8794
|
+
realtime_visitors: number;
|
|
8795
|
+
/** @description Visitors per local day, the last seven days, oldest first; the last one is today. */
|
|
8796
|
+
days: components["schemas"]["HomeDay"][];
|
|
8797
|
+
};
|
|
8798
|
+
HomeDay: {
|
|
8799
|
+
/** Format: date */
|
|
8800
|
+
day: string;
|
|
8801
|
+
/** Format: int64 */
|
|
8802
|
+
visitors: number;
|
|
8803
|
+
};
|
|
8804
|
+
HomeBroadcasts: {
|
|
8805
|
+
last_sent?: components["schemas"]["HomeBroadcast"];
|
|
8806
|
+
};
|
|
8807
|
+
/** @description The broadcast that finished sending last; absent when none has. */
|
|
8808
|
+
HomeBroadcast: {
|
|
8809
|
+
/** Format: uuid */
|
|
8810
|
+
id: string;
|
|
8811
|
+
/** Format: uuid */
|
|
8812
|
+
inbox_id: string;
|
|
8813
|
+
name: string;
|
|
8814
|
+
subject: string;
|
|
8815
|
+
/**
|
|
8816
|
+
* Format: date-time
|
|
8817
|
+
* @description When sending finished.
|
|
8818
|
+
*/
|
|
8819
|
+
sent_at: string;
|
|
8820
|
+
/** @description Whether links were tracked; `clicked` stays `0` without it. */
|
|
8821
|
+
click_tracking: boolean;
|
|
8822
|
+
/** Format: int64 */
|
|
8823
|
+
recipients: number;
|
|
8824
|
+
/** Format: int64 */
|
|
8825
|
+
sent: number;
|
|
8826
|
+
/** Format: int64 */
|
|
8827
|
+
clicked: number;
|
|
8828
|
+
/** Format: int64 */
|
|
8829
|
+
replied: number;
|
|
8830
|
+
};
|
|
8831
|
+
HomeSetup: {
|
|
8832
|
+
/**
|
|
8833
|
+
* @description One item per part of the setup hub, in this order: `chat` (live chat channels),
|
|
8834
|
+
* `email` (e-mail channels), `app` (app channels), `docs` (chat channels that
|
|
8835
|
+
* documentation pages have used: ratings, feedback or discussions), `analytics`
|
|
8836
|
+
* (properties; only when the server collects analytics) and `newsletter` (mailing
|
|
8837
|
+
* lists that are not archived). An item is `done` when its `count` is above zero.
|
|
8838
|
+
*/
|
|
8839
|
+
items: components["schemas"]["HomeSetupItem"][];
|
|
8840
|
+
};
|
|
8841
|
+
HomeSetupItem: {
|
|
8842
|
+
/** @enum {string} */
|
|
8843
|
+
id: "chat" | "email" | "app" | "docs" | "analytics" | "newsletter";
|
|
8844
|
+
done: boolean;
|
|
8845
|
+
/** Format: int64 */
|
|
8846
|
+
count: number;
|
|
8847
|
+
};
|
|
8688
8848
|
ConversationReadCreate: {
|
|
8689
8849
|
/**
|
|
8690
8850
|
* Format: uuid
|
|
@@ -17474,6 +17634,31 @@ export interface operations {
|
|
|
17474
17634
|
403: components["responses"]["Problem"];
|
|
17475
17635
|
};
|
|
17476
17636
|
};
|
|
17637
|
+
getHome: {
|
|
17638
|
+
parameters: {
|
|
17639
|
+
query?: never;
|
|
17640
|
+
header?: {
|
|
17641
|
+
/** @description The workspace to act on; see "Workspace selection". */
|
|
17642
|
+
"Yuva-Workspace"?: components["parameters"]["WorkspaceHeader"];
|
|
17643
|
+
};
|
|
17644
|
+
path?: never;
|
|
17645
|
+
cookie?: never;
|
|
17646
|
+
};
|
|
17647
|
+
requestBody?: never;
|
|
17648
|
+
responses: {
|
|
17649
|
+
/** @description The Home blocks the member may see. */
|
|
17650
|
+
200: {
|
|
17651
|
+
headers: {
|
|
17652
|
+
[name: string]: unknown;
|
|
17653
|
+
};
|
|
17654
|
+
content: {
|
|
17655
|
+
"application/json": components["schemas"]["Home"];
|
|
17656
|
+
};
|
|
17657
|
+
};
|
|
17658
|
+
401: components["responses"]["Problem"];
|
|
17659
|
+
403: components["responses"]["Problem"];
|
|
17660
|
+
};
|
|
17661
|
+
};
|
|
17477
17662
|
getStats: {
|
|
17478
17663
|
parameters: {
|
|
17479
17664
|
query?: {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "useyuva",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.16",
|
|
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": {
|