getricky 0.1.4 → 0.1.6

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({
@@ -361,21 +380,6 @@ class RickyApi extends HeyApiClient {
             }
         });
     }
-    /**
-     * List templates
-     *
-     * WhatsApp templates of every connected business account, read live from Meta.
-     *
-     * Scope: `templates:read`.
-     */
-    listTemplates(options) {
-        return (options?.client ?? this.client).get({
-            responseStyle: 'data',
-            security: [{ scheme: 'bearer', type: 'http' }],
-            url: '/templates',
-            ...options
-        });
-    }
     /**
      * List webhooks
      *
@@ -1122,5 +1126,352 @@ class RickyApi extends HeyApiClient {
             }
         });
     }
+    /**
+     * 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
+            }
+        });
+    }
+    /**
+     * List templates
+     *
+     * WhatsApp templates of every connected business account, read live from Meta.
+     *
+     * Scope: `templates:read`.
+     */
+    listTemplates(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/templates',
+            ...options
+        });
+    }
+    /**
+     * Create a template
+     *
+     * Submits a template to Meta for review from the business account of `channel_id`. It answers the template as Meta has it, usually `PENDING`; follow it with `GET /templates/{template_id}`. A draft that breaks a rule answers `400` with the first problem; Meta refusing it answers `422 rule_violation` with its reason.
+     *
+     * Scope: `templates:write`.
+     */
+    createTemplate(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/templates',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete a template
+     *
+     * Deletes the template at Meta. Meta deletes it in every language that shares its name, and the name cannot be used again for 30 days.
+     *
+     * Scope: `templates:write`.
+     */
+    deleteTemplate(options) {
+        return (options.client ?? this.client).delete({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/templates/{template_id}',
+            ...options
+        });
+    }
+    /**
+     * Get a template
+     *
+     * One template, read live from Meta, with its review `status`: `PENDING` while Meta reviews it, then `APPROVED`, `REJECTED` or `PAUSED`. Read it again to follow Meta's review.
+     *
+     * Scope: `templates:read`.
+     */
+    getTemplate(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/templates/{template_id}',
+            ...options
+        });
+    }
+    /**
+     * Edit a template
+     *
+     * Changes the category or content of a template and sends it to Meta for review again. Meta allows it only for `APPROVED`, `REJECTED` and `PAUSED` templates, and limits how often an approved one can change; otherwise it answers `422 rule_violation`. Templates with a media header, or with buttons and components Ricky’s editor does not build, cannot be edited here.
+     *
+     * Scope: `templates:write`.
+     */
+    updateTemplate(options) {
+        return (options.client ?? this.client).patch({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/templates/{template_id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Validate a template draft
+     *
+     * Checks a draft with the rules of Ricky’s template editor and answers every problem found, without submitting anything to Meta. A body that is not a draft answers `400`; a draft that breaks a rule answers `200` with `valid: false`. Meta can still reject a valid draft in its review.
+     *
+     * Scope: `templates:read`.
+     */
+    validateTemplate(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/templates/validate',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List WhatsApp numbers
+     *
+     * Every WhatsApp number of the organization, also disconnected ones, with its status, quality rating and messaging limit as Ricky last read them from Meta.
+     *
+     * Scope: `conversations:read`.
+     */
+    listWhatsAppNumbers(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/whatsapp-numbers',
+            ...options
+        });
+    }
+    /**
+     * Get a WhatsApp number
+     *
+     * One WhatsApp number by its channel ID.
+     *
+     * Scope: `conversations:read`.
+     */
+    getWhatsAppNumber(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/whatsapp-numbers/{channel_id}',
+            ...options
+        });
+    }
 }
 exports.RickyApi = RickyApi;