getricky 0.1.13 → 0.1.15

package/dist/cjs/generated/sdk.gen.d.ts

@@ -426,7 +426,7 @@ export declare class RickyApi extends HeyApiClient {
     /**
      * Create an agent
      *
-     * Creates an AI agent with its instructions, model, voice and capabilities. It answers no conversation until you assign it to one or make it a channel default in Ricky.
+     * Creates an AI agent with its instructions, voice and capabilities. It answers no conversation until you assign it to one or make it a channel default in Ricky.
      *
      * Scope: `agents:write`.
      */
@@ -458,7 +458,7 @@ export declare class RickyApi extends HeyApiClient {
     /**
      * Get agent options
      *
-     * The models, voices and capabilities an agent can be configured with.
+     * The voices and capabilities an agent can be configured with.
      *
      * Scope: `agents:read`.
      */

package/dist/cjs/generated/sdk.gen.js

@@ -823,7 +823,7 @@ class RickyApi extends HeyApiClient {
     /**
      * Create an agent
      *
-     * Creates an AI agent with its instructions, model, voice and capabilities. It answers no conversation until you assign it to one or make it a channel default in Ricky.
+     * Creates an AI agent with its instructions, voice and capabilities. It answers no conversation until you assign it to one or make it a channel default in Ricky.
      *
      * Scope: `agents:write`.
      */
@@ -891,7 +891,7 @@ class RickyApi extends HeyApiClient {
     /**
      * Get agent options
      *
-     * The models, voices and capabilities an agent can be configured with.
+     * The voices and capabilities an agent can be configured with.
      *
      * Scope: `agents:read`.
      */

package/dist/cjs/generated/types.gen.d.ts

@@ -45,10 +45,6 @@ export type Agent = {
      * How the agent answers customers.
      */
     instructions: string | null;
-    /**
-     * Model that writes its replies; one `id` of `GET /agent-options`.
-     */
-    model: string | null;
     /**
      * Voice on calls; one of `GET /agent-options`.
      */
@@ -78,27 +74,6 @@ export type Agent = {
  * What an agent can be configured with.
  */
 export type AgentOptions = {
-    /**
-     * Models an agent can use.
-     */
-    models: Array<{
-        /**
-         * Model ID, the value of `model`.
-         */
-        id: string;
-        /**
-         * Display name.
-         */
-        label: string;
-        /**
-         * What the model reads.
-         */
-        input: Array<'text' | 'image'>;
-    }>;
-    /**
-     * Model of an agent created without one.
-     */
-    default_model: string;
     /**
      * Voices an agent can use.
      */
@@ -157,7 +132,7 @@ export type ContactIdentity = {
     /**
      * Channel this identity belongs to.
      */
-    channel_type: 'whatsapp' | 'instagram' | 'messenger';
+    channel_type: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     /**
      * Address on that channel: phone digits for WhatsApp, account ID otherwise.
      */
@@ -312,7 +287,7 @@ export type Channel = {
     /**
      * Messaging channel.
      */
-    type: 'whatsapp' | 'instagram' | 'messenger';
+    type: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     /**
      * Name shown in Ricky.
      */
@@ -373,7 +348,7 @@ export type Conversation = {
          * Channel ID.
          */
         id: string;
-        type: 'whatsapp' | 'instagram' | 'messenger';
+        type: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     };
     contact: {
         id: string | null;
@@ -1238,7 +1213,7 @@ export type ConversationsReport = {
     /**
      * The channel filter the report applied.
      */
-    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     /**
      * The period.
      */
@@ -1288,7 +1263,7 @@ export type ConversationsReport = {
         /**
          * Channel.
          */
-        channel: 'whatsapp' | 'instagram' | 'messenger';
+        channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
         /**
          * Conversations with at least one customer message in the period.
          */
@@ -1354,7 +1329,7 @@ export type MessagesReport = {
     /**
      * The channel filter the report applied.
      */
-    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     /**
      * The period.
      */
@@ -1438,7 +1413,7 @@ export type MessagesReport = {
         /**
          * Channel.
          */
-        channel: 'whatsapp' | 'instagram' | 'messenger';
+        channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
         /**
          * Messages customers sent.
          */
@@ -1562,7 +1537,7 @@ export type DashboardReport = {
         /**
          * Channel.
          */
-        channel: 'whatsapp' | 'instagram' | 'messenger';
+        channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
         /**
          * Open conversations.
          */
@@ -1604,7 +1579,7 @@ export type DashboardReport = {
         /**
          * Channel.
          */
-        channel: 'whatsapp' | 'instagram' | 'messenger';
+        channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
         /**
          * Name the channel reports for the customer.
          */
@@ -1635,7 +1610,7 @@ export type TeamReport = {
     /**
      * The channel filter the report applied.
      */
-    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     /**
      * Every member and active AI agent, most messages and closes first.
      */
@@ -1951,7 +1926,7 @@ export type ResponsesReport = {
     /**
      * The channel filter the report applied.
      */
-    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     /**
      * The responder filter the report applied: `all`, `humans`, `agents` or an ID.
      */
@@ -2079,7 +2054,7 @@ export type ResponsesReport = {
         /**
          * Channel.
          */
-        channel: 'whatsapp' | 'instagram' | 'messenger';
+        channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
         /**
          * Responses in the period.
          */
@@ -2120,7 +2095,7 @@ export type ResponsesReport = {
         /**
          * The app an `external` responder used; null otherwise.
          */
-        channel: 'whatsapp' | 'instagram' | 'messenger' | null;
+        channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat' | null;
         /**
          * Responses in the period.
          */
@@ -2155,7 +2130,7 @@ export type ResolutionsReport = {
     /**
      * The channel filter the report applied.
      */
-    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     /**
      * The period.
      */
@@ -2230,7 +2205,7 @@ export type ResolutionsReport = {
         /**
          * Channel.
          */
-        channel: 'whatsapp' | 'instagram' | 'messenger';
+        channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
         /**
          * Closes in the period.
          */
@@ -2995,10 +2970,6 @@ export type CreateAgent = {
      * How the agent answers customers.
      */
     instructions?: string | null;
-    /**
-     * A model `id` of `GET /agent-options`. Without one, the default model.
-     */
-    model?: string;
     /**
      * A voice of `GET /agent-options`. Without one, the default voice.
      */
@@ -3028,10 +2999,6 @@ export type UpdateAgent = {
      * How the agent answers customers.
      */
     instructions?: string | null;
-    /**
-     * A model `id` of `GET /agent-options`. Without one, the default model.
-     */
-    model?: string;
     /**
      * A voice of `GET /agent-options`. Without one, the default voice.
      */
@@ -4816,7 +4783,7 @@ export type ListContactsData = {
         /**
          * Only contacts reachable on this channel.
          */
-        channel?: 'whatsapp' | 'instagram' | 'messenger';
+        channel?: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     };
     url: '/contacts';
 };
@@ -7091,7 +7058,7 @@ export type GetConversationsReportData = {
         /**
          * Only this channel.
          */
-        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     };
     url: '/reports/conversations';
 };
@@ -7142,7 +7109,7 @@ export type GetMessagesReportData = {
         /**
          * Only this channel.
          */
-        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     };
     url: '/reports/messages';
 };
@@ -7193,7 +7160,7 @@ export type GetResponsesReportData = {
         /**
          * Only this channel.
          */
-        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
         /**
          * 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.
          */
@@ -7248,7 +7215,7 @@ export type GetResolutionsReportData = {
         /**
          * Only this channel.
          */
-        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     };
     url: '/reports/resolutions';
 };
@@ -7299,7 +7266,7 @@ export type GetTeamReportData = {
         /**
          * Only this channel.
          */
-        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     };
     url: '/reports/team';
 };

package/dist/esm/generated/sdk.gen.d.ts

@@ -426,7 +426,7 @@ export declare class RickyApi extends HeyApiClient {
     /**
      * Create an agent
      *
-     * Creates an AI agent with its instructions, model, voice and capabilities. It answers no conversation until you assign it to one or make it a channel default in Ricky.
+     * Creates an AI agent with its instructions, voice and capabilities. It answers no conversation until you assign it to one or make it a channel default in Ricky.
      *
      * Scope: `agents:write`.
      */
@@ -458,7 +458,7 @@ export declare class RickyApi extends HeyApiClient {
     /**
      * Get agent options
      *
-     * The models, voices and capabilities an agent can be configured with.
+     * The voices and capabilities an agent can be configured with.
      *
      * Scope: `agents:read`.
      */

package/dist/esm/generated/sdk.gen.js

@@ -820,7 +820,7 @@ export class RickyApi extends HeyApiClient {
     /**
      * Create an agent
      *
-     * Creates an AI agent with its instructions, model, voice and capabilities. It answers no conversation until you assign it to one or make it a channel default in Ricky.
+     * Creates an AI agent with its instructions, voice and capabilities. It answers no conversation until you assign it to one or make it a channel default in Ricky.
      *
      * Scope: `agents:write`.
      */
@@ -888,7 +888,7 @@ export class RickyApi extends HeyApiClient {
     /**
      * Get agent options
      *
-     * The models, voices and capabilities an agent can be configured with.
+     * The voices and capabilities an agent can be configured with.
      *
      * Scope: `agents:read`.
      */

package/dist/esm/generated/types.gen.d.ts

@@ -45,10 +45,6 @@ export type Agent = {
      * How the agent answers customers.
      */
     instructions: string | null;
-    /**
-     * Model that writes its replies; one `id` of `GET /agent-options`.
-     */
-    model: string | null;
     /**
      * Voice on calls; one of `GET /agent-options`.
      */
@@ -78,27 +74,6 @@ export type Agent = {
  * What an agent can be configured with.
  */
 export type AgentOptions = {
-    /**
-     * Models an agent can use.
-     */
-    models: Array<{
-        /**
-         * Model ID, the value of `model`.
-         */
-        id: string;
-        /**
-         * Display name.
-         */
-        label: string;
-        /**
-         * What the model reads.
-         */
-        input: Array<'text' | 'image'>;
-    }>;
-    /**
-     * Model of an agent created without one.
-     */
-    default_model: string;
     /**
      * Voices an agent can use.
      */
@@ -157,7 +132,7 @@ export type ContactIdentity = {
     /**
      * Channel this identity belongs to.
      */
-    channel_type: 'whatsapp' | 'instagram' | 'messenger';
+    channel_type: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     /**
      * Address on that channel: phone digits for WhatsApp, account ID otherwise.
      */
@@ -312,7 +287,7 @@ export type Channel = {
     /**
      * Messaging channel.
      */
-    type: 'whatsapp' | 'instagram' | 'messenger';
+    type: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     /**
      * Name shown in Ricky.
      */
@@ -373,7 +348,7 @@ export type Conversation = {
          * Channel ID.
          */
         id: string;
-        type: 'whatsapp' | 'instagram' | 'messenger';
+        type: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     };
     contact: {
         id: string | null;
@@ -1238,7 +1213,7 @@ export type ConversationsReport = {
     /**
      * The channel filter the report applied.
      */
-    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     /**
      * The period.
      */
@@ -1288,7 +1263,7 @@ export type ConversationsReport = {
         /**
          * Channel.
          */
-        channel: 'whatsapp' | 'instagram' | 'messenger';
+        channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
         /**
          * Conversations with at least one customer message in the period.
          */
@@ -1354,7 +1329,7 @@ export type MessagesReport = {
     /**
      * The channel filter the report applied.
      */
-    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     /**
      * The period.
      */
@@ -1438,7 +1413,7 @@ export type MessagesReport = {
         /**
          * Channel.
          */
-        channel: 'whatsapp' | 'instagram' | 'messenger';
+        channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
         /**
          * Messages customers sent.
          */
@@ -1562,7 +1537,7 @@ export type DashboardReport = {
         /**
          * Channel.
          */
-        channel: 'whatsapp' | 'instagram' | 'messenger';
+        channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
         /**
          * Open conversations.
          */
@@ -1604,7 +1579,7 @@ export type DashboardReport = {
         /**
          * Channel.
          */
-        channel: 'whatsapp' | 'instagram' | 'messenger';
+        channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
         /**
          * Name the channel reports for the customer.
          */
@@ -1635,7 +1610,7 @@ export type TeamReport = {
     /**
      * The channel filter the report applied.
      */
-    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     /**
      * Every member and active AI agent, most messages and closes first.
      */
@@ -1951,7 +1926,7 @@ export type ResponsesReport = {
     /**
      * The channel filter the report applied.
      */
-    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     /**
      * The responder filter the report applied: `all`, `humans`, `agents` or an ID.
      */
@@ -2079,7 +2054,7 @@ export type ResponsesReport = {
         /**
          * Channel.
          */
-        channel: 'whatsapp' | 'instagram' | 'messenger';
+        channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
         /**
          * Responses in the period.
          */
@@ -2120,7 +2095,7 @@ export type ResponsesReport = {
         /**
          * The app an `external` responder used; null otherwise.
          */
-        channel: 'whatsapp' | 'instagram' | 'messenger' | null;
+        channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat' | null;
         /**
          * Responses in the period.
          */
@@ -2155,7 +2130,7 @@ export type ResolutionsReport = {
     /**
      * The channel filter the report applied.
      */
-    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+    channel: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     /**
      * The period.
      */
@@ -2230,7 +2205,7 @@ export type ResolutionsReport = {
         /**
          * Channel.
          */
-        channel: 'whatsapp' | 'instagram' | 'messenger';
+        channel: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
         /**
          * Closes in the period.
          */
@@ -2995,10 +2970,6 @@ export type CreateAgent = {
      * How the agent answers customers.
      */
     instructions?: string | null;
-    /**
-     * A model `id` of `GET /agent-options`. Without one, the default model.
-     */
-    model?: string;
     /**
      * A voice of `GET /agent-options`. Without one, the default voice.
      */
@@ -3028,10 +2999,6 @@ export type UpdateAgent = {
      * How the agent answers customers.
      */
     instructions?: string | null;
-    /**
-     * A model `id` of `GET /agent-options`. Without one, the default model.
-     */
-    model?: string;
     /**
      * A voice of `GET /agent-options`. Without one, the default voice.
      */
@@ -4816,7 +4783,7 @@ export type ListContactsData = {
         /**
          * Only contacts reachable on this channel.
          */
-        channel?: 'whatsapp' | 'instagram' | 'messenger';
+        channel?: 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     };
     url: '/contacts';
 };
@@ -7091,7 +7058,7 @@ export type GetConversationsReportData = {
         /**
          * Only this channel.
          */
-        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     };
     url: '/reports/conversations';
 };
@@ -7142,7 +7109,7 @@ export type GetMessagesReportData = {
         /**
          * Only this channel.
          */
-        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     };
     url: '/reports/messages';
 };
@@ -7193,7 +7160,7 @@ export type GetResponsesReportData = {
         /**
          * Only this channel.
          */
-        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
         /**
          * 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.
          */
@@ -7248,7 +7215,7 @@ export type GetResolutionsReportData = {
         /**
          * Only this channel.
          */
-        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     };
     url: '/reports/resolutions';
 };
@@ -7299,7 +7266,7 @@ export type GetTeamReportData = {
         /**
          * Only this channel.
          */
-        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger';
+        channel?: 'all' | 'whatsapp' | 'instagram' | 'messenger' | 'webchat';
     };
     url: '/reports/team';
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "getricky",
-  "version": "0.1.13",
+  "version": "0.1.15",
   "description": "Official TypeScript SDK for the Ricky REST API",
   "keywords": [
     "api",