getricky 0.1.2 → 0.1.4

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

@@ -617,5 +617,510 @@ class RickyApi extends HeyApiClient {
             ...options
         });
     }
+    /**
+     * Get the live dashboard
+     *
+     * Open conversations, who holds them and who is waiting for a reply, right now. "Today" is the America/Panama day.
+     *
+     * Scope: `reports:read`.
+     */
+    getDashboardReport(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/reports/dashboard',
+            ...options
+        });
+    }
+    /**
+     * Get the conversations report
+     *
+     * Customers who wrote in the period, new or returning, per channel, day and hour. Days and hours are America/Panama time, like the Reports pages; each number is compared with the previous period of the same length.
+     *
+     * Scope: `reports:read`.
+     */
+    getConversationsReport(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/reports/conversations',
+            ...options
+        });
+    }
+    /**
+     * Get the messages report
+     *
+     * Messages received and sent in the period, and who sent them. Days and hours are America/Panama time, like the Reports pages; each number is compared with the previous period of the same length.
+     *
+     * Scope: `reports:read`.
+     */
+    getMessagesReport(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/reports/messages',
+            ...options
+        });
+    }
+    /**
+     * Get the responses report
+     *
+     * How fast people and AI agents answered customers in the period, per channel and responder. Days and hours are America/Panama time, like the Reports pages; each number is compared with the previous period of the same length.
+     *
+     * Scope: `reports:read`.
+     */
+    getResponsesReport(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/reports/responses',
+            ...options
+        });
+    }
+    /**
+     * Get the resolutions report
+     *
+     * Conversations closed in the period and how long they were open. Days and hours are America/Panama time, like the Reports pages; each number is compared with the previous period of the same length.
+     *
+     * Scope: `reports:read`.
+     */
+    getResolutionsReport(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/reports/resolutions',
+            ...options
+        });
+    }
+    /**
+     * Get the team report
+     *
+     * Assignments, messages, closes and medians per member and AI agent in the period. Days are America/Panama time, like the Reports pages.
+     *
+     * Scope: `reports:read`.
+     */
+    getTeamReport(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/reports/team',
+            ...options
+        });
+    }
+    /**
+     * Get the broadcasts report
+     *
+     * WhatsApp broadcasts created in the period and their recipients' outcomes. Days and hours are America/Panama time, like the Reports pages; each number is compared with the previous period of the same length.
+     *
+     * Scope: `reports:read`.
+     */
+    getBroadcastsReport(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/reports/broadcasts',
+            ...options
+        });
+    }
+    /**
+     * Get the ads report
+     *
+     * Meta ad spend and the conversations each ad brought in the period. Days and hours are America/Panama time, like the Reports pages; each number is compared with the previous period of the same length.
+     *
+     * Scope: `reports:read`.
+     */
+    getAdsReport(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/reports/ads',
+            ...options
+        });
+    }
+    /**
+     * List agents
+     *
+     * Active agents, newest first. Archived agents are not listed.
+     *
+     * Scope: `agents:read`.
+     */
+    listAgents(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/agents',
+            ...options
+        });
+    }
+    /**
+     * 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.
+     *
+     * Scope: `agents:write`.
+     */
+    createAgent(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/agents',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Archive an agent
+     *
+     * Archives the agent and answers it as it was, with `archived_at`. Its conversations stop being answered by it and workflows that assign it are paused. Archiving twice answers `404`.
+     *
+     * Scope: `agents:write`.
+     */
+    archiveAgent(options) {
+        return (options.client ?? this.client).delete({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/agents/{agent_id}',
+            ...options
+        });
+    }
+    /**
+     * Get an agent
+     *
+     * One active agent with its full settings.
+     *
+     * Scope: `agents:read`.
+     */
+    getAgent(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/agents/{agent_id}',
+            ...options
+        });
+    }
+    /**
+     * Update an agent
+     *
+     * Changes only the fields in the body. `capabilities` and `handoff_user_ids` replace their whole sets.
+     *
+     * Scope: `agents:write`.
+     */
+    updateAgent(options) {
+        return (options.client ?? this.client).patch({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/agents/{agent_id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Get agent options
+     *
+     * The models, voices and capabilities an agent can be configured with.
+     *
+     * Scope: `agents:read`.
+     */
+    getAgentOptions(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/agent-options',
+            ...options
+        });
+    }
+    /**
+     * Set the AI agent of a conversation
+     *
+     * Makes an agent answer the conversation, or turns the AI off with `null`. Either way the conversation is no longer assigned to a member; the contact owner stays.
+     *
+     * Scope: `conversations:write`.
+     */
+    assignConversationAgent(options) {
+        return (options.client ?? this.client).patch({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/conversations/{conversation_id}/agent',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List locations
+     *
+     * Branches and places, newest first.
+     *
+     * Scope: `knowledge:read`.
+     */
+    listKnowledgeLocations(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/knowledge/locations',
+            ...options
+        });
+    }
+    /**
+     * Create a location
+     *
+     * Adds a branch or place the agents can share.
+     *
+     * Scope: `knowledge:write`.
+     */
+    createKnowledgeLocation(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/knowledge/locations',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete a location
+     *
+     * Deletes it for good and answers it as it was.
+     *
+     * Scope: `knowledge:write`.
+     */
+    deleteKnowledgeLocation(options) {
+        return (options.client ?? this.client).delete({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/knowledge/locations/{location_id}',
+            ...options
+        });
+    }
+    /**
+     * Get a location
+     *
+     * One location.
+     *
+     * Scope: `knowledge:read`.
+     */
+    getKnowledgeLocation(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/knowledge/locations/{location_id}',
+            ...options
+        });
+    }
+    /**
+     * Update a location
+     *
+     * Changes only the fields in the body.
+     *
+     * Scope: `knowledge:write`.
+     */
+    updateKnowledgeLocation(options) {
+        return (options.client ?? this.client).patch({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/knowledge/locations/{location_id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List directory contacts
+     *
+     * Contact cards of the knowledge directory, by display name. These are not CRM contacts.
+     *
+     * Scope: `knowledge:read`.
+     */
+    listKnowledgeContacts(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/knowledge/contacts',
+            ...options
+        });
+    }
+    /**
+     * Create a directory contact
+     *
+     * Adds a contact card the agents can send to customers.
+     *
+     * Scope: `knowledge:write`.
+     */
+    createKnowledgeContact(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/knowledge/contacts',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete a directory contact
+     *
+     * Deletes it for good and answers it as it was.
+     *
+     * Scope: `knowledge:write`.
+     */
+    deleteKnowledgeContact(options) {
+        return (options.client ?? this.client).delete({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/knowledge/contacts/{knowledge_contact_id}',
+            ...options
+        });
+    }
+    /**
+     * Get a directory contact
+     *
+     * One contact card.
+     *
+     * Scope: `knowledge:read`.
+     */
+    getKnowledgeContact(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/knowledge/contacts/{knowledge_contact_id}',
+            ...options
+        });
+    }
+    /**
+     * Update a directory contact
+     *
+     * Changes only the fields in the body.
+     *
+     * Scope: `knowledge:write`.
+     */
+    updateKnowledgeContact(options) {
+        return (options.client ?? this.client).patch({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/knowledge/contacts/{knowledge_contact_id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List files
+     *
+     * Documents and images the agents can consult or send, newest first.
+     *
+     * Scope: `knowledge:read`.
+     */
+    listKnowledgeFiles(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/knowledge/files',
+            ...options
+        });
+    }
+    /**
+     * Upload a file
+     *
+     * Begins an upload in three steps: this call answers the file, `uploading`, and an `upload_url`; `PUT` the bytes there; then call `POST /knowledge/files/{file_id}/complete`.
+     *
+     * Scope: `knowledge:write`.
+     */
+    createKnowledgeFile(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/knowledge/files',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Complete an upload
+     *
+     * Checks the uploaded bytes against the declared type and size, reads the content for the agents and answers the file, `ready`. Reading a long PDF can take minutes. Completing a `ready` file changes nothing.
+     *
+     * Scope: `knowledge:write`.
+     */
+    completeKnowledgeFile(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/knowledge/files/{file_id}/complete',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete a file
+     *
+     * Deletes it for good and answers it as it was. Copies already sent in conversations stay there.
+     *
+     * Scope: `knowledge:write`.
+     */
+    deleteKnowledgeFile(options) {
+        return (options.client ?? this.client).delete({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/knowledge/files/{file_id}',
+            ...options
+        });
+    }
+    /**
+     * Get a file
+     *
+     * One file; a `ready` one carries a `download_url`.
+     *
+     * Scope: `knowledge:read`.
+     */
+    getKnowledgeFile(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/knowledge/files/{file_id}',
+            ...options
+        });
+    }
+    /**
+     * Update a file
+     *
+     * Changes its title, description or what the agents may do with it. Only a `ready` file changes; otherwise `409 conflict`.
+     *
+     * Scope: `knowledge:write`.
+     */
+    updateKnowledgeFile(options) {
+        return (options.client ?? this.client).patch({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/knowledge/files/{file_id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
 }
 exports.RickyApi = RickyApi;