getricky 0.1.3 → 0.1.5

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

@@ -131,6 +131,25 @@ class RickyApi extends HeyApiClient {
             ...options
         });
     }
+    /**
+     * Create a contact field
+     *
+     * Adds a custom field to every contact, after the existing ones. A name already in use, in any case, answers `409 conflict`.
+     *
+     * Scope: `contacts:write`.
+     */
+    createContactField(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/contact-fields',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * List conversations
      *
@@ -347,7 +366,7 @@ class RickyApi extends HeyApiClient {
      *
      * Creates a contact tag. Apply it with `tag_ids` on a contact. A name already in use, in any case, answers `409 conflict`.
      *
-     * Scope: `contacts:write`.
+     * Scope: `tags:write` or, on older keys, `contacts:write`.
      */
     createTag(options) {
         return (options.client ?? this.client).post({
@@ -737,5 +756,605 @@ class RickyApi extends HeyApiClient {
             ...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
+            }
+        });
+    }
+    /**
+     * Change tags on many contacts
+     *
+     * Adds and removes the same tags on up to 100 contacts and answers one result per contact, in order. A tag ID the organization does not have refuses the whole request before any contact changes.
+     *
+     * Scope: `contacts:write`.
+     */
+    changeContactsTags(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/contacts/tags',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete a contact field
+     *
+     * Deletes the field and its value on every contact, and answers the field as it was. It cannot be undone.
+     *
+     * Scope: `contacts:write`.
+     */
+    deleteContactField(options) {
+        return (options.client ?? this.client).delete({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/contact-fields/{field_id}',
+            ...options
+        });
+    }
+    /**
+     * Delete a tag
+     *
+     * Deletes the tag and removes it from every contact, and answers the tag as it was. It cannot be undone.
+     *
+     * Scope: `tags:write`.
+     */
+    deleteTag(options) {
+        return (options.client ?? this.client).delete({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/tags/{tag_id}',
+            ...options
+        });
+    }
+    /**
+     * Update a tag
+     *
+     * Renames or recolors a tag on every contact that has it. A name already in use, in any case, answers `409 conflict`.
+     *
+     * Scope: `tags:write`.
+     */
+    updateTag(options) {
+        return (options.client ?? this.client).patch({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/tags/{tag_id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Search conversations
+     *
+     * Conversations whose contact or messages contain the text, latest activity first. Answers one page of at most `limit`; `next_cursor` is always null.
+     *
+     * Scope: `conversations:read`.
+     */
+    searchConversations(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/conversations/search',
+            ...options
+        });
+    }
+    /**
+     * Change a conversation's tags
+     *
+     * Tags belong to the conversation's contact: this adds and removes tags on it and answers the contact.
+     *
+     * Scope: `contacts:write`.
+     */
+    changeConversationTags(options) {
+        return (options.client ?? this.client).patch({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/conversations/{conversation_id}/tags',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Mark a conversation read
+     *
+     * Marks it read for the whole team through its latest message, as opening it in the inbox does. On WhatsApp the contact sees the read receipt. Send no body.
+     *
+     * Scope: `conversations:write`.
+     */
+    markConversationRead(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/conversations/{conversation_id}/read',
+            ...options
+        });
+    }
+    /**
+     * Search messages
+     *
+     * Messages of every conversation that contain the words, newest first. Answers one page of at most `limit`; `next_cursor` is always null.
+     *
+     * Scope: `conversations:read`.
+     */
+    searchMessages(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/messages/search',
+            ...options
+        });
+    }
+    /**
+     * List quick replies
+     *
+     * Every quick reply of the organization, by title.
+     *
+     * Scope: `quick_replies:read`.
+     */
+    listQuickReplies(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/quick-replies',
+            ...options
+        });
+    }
+    /**
+     * Create a quick reply
+     *
+     * Saves an answer operators can insert in the inbox. A title already in use, in any case, answers `409 conflict`.
+     *
+     * Scope: `quick_replies:write`.
+     */
+    createQuickReply(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/quick-replies',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete a quick reply
+     *
+     * Deletes it and answers it as it was. It cannot be undone.
+     *
+     * Scope: `quick_replies:write`.
+     */
+    deleteQuickReply(options) {
+        return (options.client ?? this.client).delete({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/quick-replies/{quick_reply_id}',
+            ...options
+        });
+    }
+    /**
+     * Get a quick reply
+     *
+     * One quick reply.
+     *
+     * Scope: `quick_replies:read`.
+     */
+    getQuickReply(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/quick-replies/{quick_reply_id}',
+            ...options
+        });
+    }
+    /**
+     * Update a quick reply
+     *
+     * Changes only the fields in the body. A title already in use, in any case, answers `409 conflict`.
+     *
+     * Scope: `quick_replies:write`.
+     */
+    updateQuickReply(options) {
+        return (options.client ?? this.client).patch({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/quick-replies/{quick_reply_id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
 }
 exports.RickyApi = RickyApi;