getricky 0.1.15 → 0.1.17

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.
@@ -866,7 +866,7 @@ export declare class RickyApi extends HeyApiClient {
866
866
  /**
867
867
  * Create a broadcast
868
868
  *
869
- * Sends an approved WhatsApp template to an audience, now or at `scheduled_at`. Ricky fixes the recipient list now and sends through each number’s conversation, as a template sent from the inbox; variables the template maps to contact fields in Ricky are filled per contact. Answers `201` with the broadcast `queued` or `scheduled`; follow it with `GET /broadcasts/{broadcast_id}`. An audience without any WhatsApp number answers `422 rule_violation`.
869
+ * Sends an approved WhatsApp template to an audience, now or at `scheduled_at`. Ricky fixes the recipient list now and sends through each number’s conversation, as a template sent from the inbox; variables the template maps to contact fields in Ricky are filled per contact. Answers `201` with the broadcast `queued` or `scheduled`; follow it with `GET /broadcasts/{broadcast_id}`. An audience without any WhatsApp number, or a number that is disconnected or lacks its Meta access, answers `422 rule_violation`.
870
870
  *
871
871
  * Scope: `broadcasts:write`.
872
872
  */
@@ -1752,7 +1752,7 @@ class RickyApi extends HeyApiClient {
1752
1752
  /**
1753
1753
  * Create a broadcast
1754
1754
  *
1755
- * Sends an approved WhatsApp template to an audience, now or at `scheduled_at`. Ricky fixes the recipient list now and sends through each number’s conversation, as a template sent from the inbox; variables the template maps to contact fields in Ricky are filled per contact. Answers `201` with the broadcast `queued` or `scheduled`; follow it with `GET /broadcasts/{broadcast_id}`. An audience without any WhatsApp number answers `422 rule_violation`.
1755
+ * Sends an approved WhatsApp template to an audience, now or at `scheduled_at`. Ricky fixes the recipient list now and sends through each number’s conversation, as a template sent from the inbox; variables the template maps to contact fields in Ricky are filled per contact. Answers `201` with the broadcast `queued` or `scheduled`; follow it with `GET /broadcasts/{broadcast_id}`. An audience without any WhatsApp number, or a number that is disconnected or lacks its Meta access, answers `422 rule_violation`.
1756
1756
  *
1757
1757
  * Scope: `broadcasts:write`.
1758
1758
  */
@@ -1636,7 +1636,7 @@ export type TeamReport = {
1636
1636
  */
1637
1637
  messages_sent: number;
1638
1638
  /**
1639
- * Closes in the period while they held the conversation.
1639
+ * Closes in the period they made.
1640
1640
  */
1641
1641
  closed: number;
1642
1642
  /**
@@ -1644,7 +1644,7 @@ export type TeamReport = {
1644
1644
  */
1645
1645
  open_now: number;
1646
1646
  /**
1647
- * For conversations opened in the period, median time from the opening to the first message a person or AI agent sent, counted for whoever sent it, in seconds. Not narrowed by `channel`.
1647
+ * Median wait of the messages customers sent in a row, started in the period, that they answered: from the first of those messages to their answer, in seconds.
1648
1648
  */
1649
1649
  median_first_response_seconds: number | null;
1650
1650
  /**
@@ -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
  */
@@ -1919,7 +1927,7 @@ export type AdsReport = {
1919
1927
  generated_at: string;
1920
1928
  };
1921
1929
  /**
1922
- * How fast people and AI agents answer customers. A response is the first message sent to the customer, other than a reaction, right after a customer message that is not a reaction; its response time is the wait since that customer message. Later messages in a row are follow-ups, and automations and templates are not responses. Responses are dated when they were sent. Conversation openings, closes and assignments play no part.
1930
+ * How fast people and AI agents answer customers, by the definition of the Atención and Equipo tabs. A response is the answer to messages a customer sent in a row (reactions aside): the first message after them that a person in Ricky, an AI agent or a person in the app of the channel itself sent. Its response time is the wait since the first of those customer messages. Later messages are follow-ups; automations, broadcasts and templates are never responses. Responses are dated when they were sent. Conversation openings, closes and assignments play no part.
1923
1931
  */
1924
1932
  export type ResponsesReport = {
1925
1933
  period: ReportPeriod;
@@ -866,7 +866,7 @@ export declare class RickyApi extends HeyApiClient {
866
866
  /**
867
867
  * Create a broadcast
868
868
  *
869
- * Sends an approved WhatsApp template to an audience, now or at `scheduled_at`. Ricky fixes the recipient list now and sends through each number’s conversation, as a template sent from the inbox; variables the template maps to contact fields in Ricky are filled per contact. Answers `201` with the broadcast `queued` or `scheduled`; follow it with `GET /broadcasts/{broadcast_id}`. An audience without any WhatsApp number answers `422 rule_violation`.
869
+ * Sends an approved WhatsApp template to an audience, now or at `scheduled_at`. Ricky fixes the recipient list now and sends through each number’s conversation, as a template sent from the inbox; variables the template maps to contact fields in Ricky are filled per contact. Answers `201` with the broadcast `queued` or `scheduled`; follow it with `GET /broadcasts/{broadcast_id}`. An audience without any WhatsApp number, or a number that is disconnected or lacks its Meta access, answers `422 rule_violation`.
870
870
  *
871
871
  * Scope: `broadcasts:write`.
872
872
  */
@@ -1749,7 +1749,7 @@ export class RickyApi extends HeyApiClient {
1749
1749
  /**
1750
1750
  * Create a broadcast
1751
1751
  *
1752
- * Sends an approved WhatsApp template to an audience, now or at `scheduled_at`. Ricky fixes the recipient list now and sends through each number’s conversation, as a template sent from the inbox; variables the template maps to contact fields in Ricky are filled per contact. Answers `201` with the broadcast `queued` or `scheduled`; follow it with `GET /broadcasts/{broadcast_id}`. An audience without any WhatsApp number answers `422 rule_violation`.
1752
+ * Sends an approved WhatsApp template to an audience, now or at `scheduled_at`. Ricky fixes the recipient list now and sends through each number’s conversation, as a template sent from the inbox; variables the template maps to contact fields in Ricky are filled per contact. Answers `201` with the broadcast `queued` or `scheduled`; follow it with `GET /broadcasts/{broadcast_id}`. An audience without any WhatsApp number, or a number that is disconnected or lacks its Meta access, answers `422 rule_violation`.
1753
1753
  *
1754
1754
  * Scope: `broadcasts:write`.
1755
1755
  */
@@ -1636,7 +1636,7 @@ export type TeamReport = {
1636
1636
  */
1637
1637
  messages_sent: number;
1638
1638
  /**
1639
- * Closes in the period while they held the conversation.
1639
+ * Closes in the period they made.
1640
1640
  */
1641
1641
  closed: number;
1642
1642
  /**
@@ -1644,7 +1644,7 @@ export type TeamReport = {
1644
1644
  */
1645
1645
  open_now: number;
1646
1646
  /**
1647
- * For conversations opened in the period, median time from the opening to the first message a person or AI agent sent, counted for whoever sent it, in seconds. Not narrowed by `channel`.
1647
+ * Median wait of the messages customers sent in a row, started in the period, that they answered: from the first of those messages to their answer, in seconds.
1648
1648
  */
1649
1649
  median_first_response_seconds: number | null;
1650
1650
  /**
@@ -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
  */
@@ -1919,7 +1927,7 @@ export type AdsReport = {
1919
1927
  generated_at: string;
1920
1928
  };
1921
1929
  /**
1922
- * How fast people and AI agents answer customers. A response is the first message sent to the customer, other than a reaction, right after a customer message that is not a reaction; its response time is the wait since that customer message. Later messages in a row are follow-ups, and automations and templates are not responses. Responses are dated when they were sent. Conversation openings, closes and assignments play no part.
1930
+ * How fast people and AI agents answer customers, by the definition of the Atención and Equipo tabs. A response is the answer to messages a customer sent in a row (reactions aside): the first message after them that a person in Ricky, an AI agent or a person in the app of the channel itself sent. Its response time is the wait since the first of those customer messages. Later messages are follow-ups; automations, broadcasts and templates are never responses. Responses are dated when they were sent. Conversation openings, closes and assignments play no part.
1923
1931
  */
1924
1932
  export type ResponsesReport = {
1925
1933
  period: ReportPeriod;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "getricky",
3
- "version": "0.1.15",
3
+ "version": "0.1.17",
4
4
  "description": "Official TypeScript SDK for the Ricky REST API",
5
5
  "keywords": [
6
6
  "api",