getricky 0.1.14 → 0.1.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.
Files changed (3) hide show
  1. package/dist/cjs/generated/types.gen.d.ts +29 -21
  2. package/dist/esm/generated/types.gen.d.ts +29 -21
  3. package/package.json +1 -1
package/dist/cjs/generated/types.gen.d.ts CHANGED
@@ -132,7 +132,7 @@ export type ContactIdentity = {
132
132
  /**
133
133
  * Channel this identity belongs to.
134
134
  */
135
- channel_type: 'whatsapp' | 'instagram' | 'messenger';
135
+ channel_type: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
136
136
  /**
137
137
  * Address on that channel: phone digits for WhatsApp, account ID otherwise.
138
138
  */
@@ -287,7 +287,7 @@ export type Channel = {
287
287
  /**
288
288
  * Messaging channel.
289
289
  */
290
- type: 'whatsapp' | 'instagram' | 'messenger';
290
+ type: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
291
291
  /**
292
292
  * Name shown in Ricky.
293
293
  */
@@ -348,7 +348,7 @@ export type Conversation = {
348
348
  * Channel ID.
349
349
  */
350
350
  id: string;
351
- type: 'whatsapp' | 'instagram' | 'messenger';
351
+ type: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
352
352
  };
353
353
  contact: {
354
354
  id: string | null;
@@ -1213,7 +1213,7 @@ export type ConversationsReport = {
1213
1213
  /**
1214
1214
  * The channel filter the report applied.
1215
1215
  */
1216
- channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
1216
+ channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
1217
1217
  /**
1218
1218
  * The period.
1219
1219
  */
@@ -1263,7 +1263,7 @@ export type ConversationsReport = {
1263
1263
  /**
1264
1264
  * Channel.
1265
1265
  */
1266
- channel: 'whatsapp' | 'instagram' | 'messenger';
1266
+ channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
1267
1267
  /**
1268
1268
  * Conversations with at least one customer message in the period.
1269
1269
  */
@@ -1329,7 +1329,7 @@ export type MessagesReport = {
1329
1329
  /**
1330
1330
  * The channel filter the report applied.
1331
1331
  */
1332
- channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
1332
+ channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
1333
1333
  /**
1334
1334
  * The period.
1335
1335
  */
@@ -1413,7 +1413,7 @@ export type MessagesReport = {
1413
1413
  /**
1414
1414
  * Channel.
1415
1415
  */
1416
- channel: 'whatsapp' | 'instagram' | 'messenger';
1416
+ channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
1417
1417
  /**
1418
1418
  * Messages customers sent.
1419
1419
  */
@@ -1537,7 +1537,7 @@ export type DashboardReport = {
1537
1537
  /**
1538
1538
  * Channel.
1539
1539
  */
1540
- channel: 'whatsapp' | 'instagram' | 'messenger';
1540
+ channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
1541
1541
  /**
1542
1542
  * Open conversations.
1543
1543
  */
@@ -1579,7 +1579,7 @@ export type DashboardReport = {
1579
1579
  /**
1580
1580
  * Channel.
1581
1581
  */
1582
- channel: 'whatsapp' | 'instagram' | 'messenger';
1582
+ channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
1583
1583
  /**
1584
1584
  * Name the channel reports for the customer.
1585
1585
  */
@@ -1610,7 +1610,7 @@ export type TeamReport = {
1610
1610
  /**
1611
1611
  * The channel filter the report applied.
1612
1612
  */
1613
- channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
1613
+ channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
1614
1614
  /**
1615
1615
  * Every member and active AI agent, most messages and closes first.
1616
1616
  */
@@ -1846,6 +1846,14 @@ export type AdsReport = {
1846
1846
  * Spend.
1847
1847
  */
1848
1848
  spend: number | null;
1849
+ /**
1850
+ * Impressions.
1851
+ */
1852
+ impressions: number | null;
1853
+ /**
1854
+ * Clicks.
1855
+ */
1856
+ clicks: number | null;
1849
1857
  /**
1850
1858
  * Conversations ads brought.
1851
1859
  */
@@ -1926,7 +1934,7 @@ export type ResponsesReport = {
1926
1934
  /**
1927
1935
  * The channel filter the report applied.
1928
1936
  */
1929
- channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
1937
+ channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
1930
1938
  /**
1931
1939
  * The responder filter the report applied: `all`, `humans`, `agents` or an ID.
1932
1940
  */
@@ -2054,7 +2062,7 @@ export type ResponsesReport = {
2054
2062
  /**
2055
2063
  * Channel.
2056
2064
  */
2057
- channel: 'whatsapp' | 'instagram' | 'messenger';
2065
+ channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
2058
2066
  /**
2059
2067
  * Responses in the period.
2060
2068
  */
@@ -2095,7 +2103,7 @@ export type ResponsesReport = {
2095
2103
  /**
2096
2104
  * The app an `external` responder used; null otherwise.
2097
2105
  */
2098
- channel: 'whatsapp' | 'instagram' | 'messenger' | null;
2106
+ channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat' | null;
2099
2107
  /**
2100
2108
  * Responses in the period.
2101
2109
  */
@@ -2130,7 +2138,7 @@ export type ResolutionsReport = {
2130
2138
  /**
2131
2139
  * The channel filter the report applied.
2132
2140
  */
2133
- channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
2141
+ channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
2134
2142
  /**
2135
2143
  * The period.
2136
2144
  */
@@ -2205,7 +2213,7 @@ export type ResolutionsReport = {
2205
2213
  /**
2206
2214
  * Channel.
2207
2215
  */
2208
- channel: 'whatsapp' | 'instagram' | 'messenger';
2216
+ channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
2209
2217
  /**
2210
2218
  * Closes in the period.
2211
2219
  */
@@ -4783,7 +4791,7 @@ export type ListContactsData = {
4783
4791
  /**
4784
4792
  * Only contacts reachable on this channel.
4785
4793
  */
4786
- channel?: 'whatsapp' | 'instagram' | 'messenger';
4794
+ channel?: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
4787
4795
  };
4788
4796
  url: '/contacts';
4789
4797
  };
@@ -7058,7 +7066,7 @@ export type GetConversationsReportData = {
7058
7066
  /**
7059
7067
  * Only this channel.
7060
7068
  */
7061
- channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
7069
+ channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
7062
7070
  };
7063
7071
  url: '/reports/conversations';
7064
7072
  };
@@ -7109,7 +7117,7 @@ export type GetMessagesReportData = {
7109
7117
  /**
7110
7118
  * Only this channel.
7111
7119
  */
7112
- channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
7120
+ channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
7113
7121
  };
7114
7122
  url: '/reports/messages';
7115
7123
  };
@@ -7160,7 +7168,7 @@ export type GetResponsesReportData = {
7160
7168
  /**
7161
7169
  * Only this channel.
7162
7170
  */
7163
- channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
7171
+ channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
7164
7172
  /**
7165
7173
  * Only responses from people, in Ricky or in the channel's own app (`humans`), from AI agents (`agents`), or from one member or AI agent by ID.
7166
7174
  */
@@ -7215,7 +7223,7 @@ export type GetResolutionsReportData = {
7215
7223
  /**
7216
7224
  * Only this channel.
7217
7225
  */
7218
- channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
7226
+ channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
7219
7227
  };
7220
7228
  url: '/reports/resolutions';
7221
7229
  };
@@ -7266,7 +7274,7 @@ export type GetTeamReportData = {
7266
7274
  /**
7267
7275
  * Only this channel.
7268
7276
  */
7269
- channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
7277
+ channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
7270
7278
  };
7271
7279
  url: '/reports/team';
7272
7280
  };
package/dist/esm/generated/types.gen.d.ts CHANGED
@@ -132,7 +132,7 @@ export type ContactIdentity = {
132
132
  /**
133
133
  * Channel this identity belongs to.
134
134
  */
135
- channel_type: 'whatsapp' | 'instagram' | 'messenger';
135
+ channel_type: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
136
136
  /**
137
137
  * Address on that channel: phone digits for WhatsApp, account ID otherwise.
138
138
  */
@@ -287,7 +287,7 @@ export type Channel = {
287
287
  /**
288
288
  * Messaging channel.
289
289
  */
290
- type: 'whatsapp' | 'instagram' | 'messenger';
290
+ type: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
291
291
  /**
292
292
  * Name shown in Ricky.
293
293
  */
@@ -348,7 +348,7 @@ export type Conversation = {
348
348
  * Channel ID.
349
349
  */
350
350
  id: string;
351
- type: 'whatsapp' | 'instagram' | 'messenger';
351
+ type: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
352
352
  };
353
353
  contact: {
354
354
  id: string | null;
@@ -1213,7 +1213,7 @@ export type ConversationsReport = {
1213
1213
  /**
1214
1214
  * The channel filter the report applied.
1215
1215
  */
1216
- channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
1216
+ channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
1217
1217
  /**
1218
1218
  * The period.
1219
1219
  */
@@ -1263,7 +1263,7 @@ export type ConversationsReport = {
1263
1263
  /**
1264
1264
  * Channel.
1265
1265
  */
1266
- channel: 'whatsapp' | 'instagram' | 'messenger';
1266
+ channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
1267
1267
  /**
1268
1268
  * Conversations with at least one customer message in the period.
1269
1269
  */
@@ -1329,7 +1329,7 @@ export type MessagesReport = {
1329
1329
  /**
1330
1330
  * The channel filter the report applied.
1331
1331
  */
1332
- channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
1332
+ channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
1333
1333
  /**
1334
1334
  * The period.
1335
1335
  */
@@ -1413,7 +1413,7 @@ export type MessagesReport = {
1413
1413
  /**
1414
1414
  * Channel.
1415
1415
  */
1416
- channel: 'whatsapp' | 'instagram' | 'messenger';
1416
+ channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
1417
1417
  /**
1418
1418
  * Messages customers sent.
1419
1419
  */
@@ -1537,7 +1537,7 @@ export type DashboardReport = {
1537
1537
  /**
1538
1538
  * Channel.
1539
1539
  */
1540
- channel: 'whatsapp' | 'instagram' | 'messenger';
1540
+ channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
1541
1541
  /**
1542
1542
  * Open conversations.
1543
1543
  */
@@ -1579,7 +1579,7 @@ export type DashboardReport = {
1579
1579
  /**
1580
1580
  * Channel.
1581
1581
  */
1582
- channel: 'whatsapp' | 'instagram' | 'messenger';
1582
+ channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
1583
1583
  /**
1584
1584
  * Name the channel reports for the customer.
1585
1585
  */
@@ -1610,7 +1610,7 @@ export type TeamReport = {
1610
1610
  /**
1611
1611
  * The channel filter the report applied.
1612
1612
  */
1613
- channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
1613
+ channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
1614
1614
  /**
1615
1615
  * Every member and active AI agent, most messages and closes first.
1616
1616
  */
@@ -1846,6 +1846,14 @@ export type AdsReport = {
1846
1846
  * Spend.
1847
1847
  */
1848
1848
  spend: number | null;
1849
+ /**
1850
+ * Impressions.
1851
+ */
1852
+ impressions: number | null;
1853
+ /**
1854
+ * Clicks.
1855
+ */
1856
+ clicks: number | null;
1849
1857
  /**
1850
1858
  * Conversations ads brought.
1851
1859
  */
@@ -1926,7 +1934,7 @@ export type ResponsesReport = {
1926
1934
  /**
1927
1935
  * The channel filter the report applied.
1928
1936
  */
1929
- channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
1937
+ channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
1930
1938
  /**
1931
1939
  * The responder filter the report applied: `all`, `humans`, `agents` or an ID.
1932
1940
  */
@@ -2054,7 +2062,7 @@ export type ResponsesReport = {
2054
2062
  /**
2055
2063
  * Channel.
2056
2064
  */
2057
- channel: 'whatsapp' | 'instagram' | 'messenger';
2065
+ channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
2058
2066
  /**
2059
2067
  * Responses in the period.
2060
2068
  */
@@ -2095,7 +2103,7 @@ export type ResponsesReport = {
2095
2103
  /**
2096
2104
  * The app an `external` responder used; null otherwise.
2097
2105
  */
2098
- channel: 'whatsapp' | 'instagram' | 'messenger' | null;
2106
+ channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat' | null;
2099
2107
  /**
2100
2108
  * Responses in the period.
2101
2109
  */
@@ -2130,7 +2138,7 @@ export type ResolutionsReport = {
2130
2138
  /**
2131
2139
  * The channel filter the report applied.
2132
2140
  */
2133
- channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
2141
+ channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
2134
2142
  /**
2135
2143
  * The period.
2136
2144
  */
@@ -2205,7 +2213,7 @@ export type ResolutionsReport = {
2205
2213
  /**
2206
2214
  * Channel.
2207
2215
  */
2208
- channel: 'whatsapp' | 'instagram' | 'messenger';
2216
+ channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
2209
2217
  /**
2210
2218
  * Closes in the period.
2211
2219
  */
@@ -4783,7 +4791,7 @@ export type ListContactsData = {
4783
4791
  /**
4784
4792
  * Only contacts reachable on this channel.
4785
4793
  */
4786
- channel?: 'whatsapp' | 'instagram' | 'messenger';
4794
+ channel?: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
4787
4795
  };
4788
4796
  url: '/contacts';
4789
4797
  };
@@ -7058,7 +7066,7 @@ export type GetConversationsReportData = {
7058
7066
  /**
7059
7067
  * Only this channel.
7060
7068
  */
7061
- channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
7069
+ channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
7062
7070
  };
7063
7071
  url: '/reports/conversations';
7064
7072
  };
@@ -7109,7 +7117,7 @@ export type GetMessagesReportData = {
7109
7117
  /**
7110
7118
  * Only this channel.
7111
7119
  */
7112
- channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
7120
+ channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
7113
7121
  };
7114
7122
  url: '/reports/messages';
7115
7123
  };
@@ -7160,7 +7168,7 @@ export type GetResponsesReportData = {
7160
7168
  /**
7161
7169
  * Only this channel.
7162
7170
  */
7163
- channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
7171
+ channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
7164
7172
  /**
7165
7173
  * Only responses from people, in Ricky or in the channel's own app (`humans`), from AI agents (`agents`), or from one member or AI agent by ID.
7166
7174
  */
@@ -7215,7 +7223,7 @@ export type GetResolutionsReportData = {
7215
7223
  /**
7216
7224
  * Only this channel.
7217
7225
  */
7218
- channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
7226
+ channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
7219
7227
  };
7220
7228
  url: '/reports/resolutions';
7221
7229
  };
@@ -7266,7 +7274,7 @@ export type GetTeamReportData = {
7266
7274
  /**
7267
7275
  * Only this channel.
7268
7276
  */
7269
- channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
7277
+ channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
7270
7278
  };
7271
7279
  url: '/reports/team';
7272
7280
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "getricky",
3
- "version": "0.1.14",
3
+ "version": "0.1.16",
4
4
  "description": "Official TypeScript SDK for the Ricky REST API",
5
5
  "keywords": [
6
6
  "api",