getricky 0.0.0-stage → 0.1.0

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

@@ -0,0 +1,493 @@
+"use strict";
+// This file is auto-generated by @hey-api/openapi-ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RickyApi = void 0;
+const client_gen_js_1 = require("./client.gen.js");
+class HeyApiClient {
+    client;
+    constructor(args) {
+        this.client = args?.client ?? client_gen_js_1.client;
+    }
+}
+class HeyApiRegistry {
+    defaultKey = 'default';
+    instances = new Map();
+    get(key) {
+        const instance = this.instances.get(key ?? this.defaultKey);
+        if (!instance) {
+            throw new Error(`No SDK client found. Create one with "new RickyApi()" to fix this error.`);
+        }
+        return instance;
+    }
+    set(value, key) {
+        this.instances.set(key ?? this.defaultKey, value);
+    }
+}
+class RickyApi extends HeyApiClient {
+    static __registry = new HeyApiRegistry();
+    constructor(args) {
+        super(args);
+        RickyApi.__registry.set(this, args?.key);
+    }
+    /**
+     * List contacts
+     *
+     * Most recently updated first. Filters combine.
+     *
+     * Scope: `contacts:read`.
+     */
+    listContacts(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/contacts',
+            ...options
+        });
+    }
+    /**
+     * Create a contact
+     *
+     * Creates a CRM contact. It does not message anyone; to reach a phone, start a conversation.
+     *
+     * Scope: `contacts:write`.
+     */
+    createContact(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/contacts',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Get a contact
+     *
+     * One contact with its tags, identities and custom values.
+     *
+     * Scope: `contacts:read`.
+     */
+    getContact(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/contacts/{contact_id}',
+            ...options
+        });
+    }
+    /**
+     * Update a contact
+     *
+     * Changes only the fields in the body. `tag_ids` replaces the whole tag set; `custom_values` merges by key.
+     *
+     * Scope: `contacts:write`.
+     */
+    updateContact(options) {
+        return (options.client ?? this.client).patch({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/contacts/{contact_id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Add a note to a contact
+     *
+     * Adds text after the current `notes`, separated by a blank line, and answers the contact. To replace the notes, update the contact.
+     *
+     * Scope: `contacts:write`.
+     */
+    addContactNote(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/contacts/{contact_id}/notes',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List contact fields
+     *
+     * The custom fields whose IDs key `custom_values`.
+     *
+     * Scope: `contacts:read`.
+     */
+    listContactFields(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/contact-fields',
+            ...options
+        });
+    }
+    /**
+     * List conversations
+     *
+     * Latest activity first.
+     *
+     * Scope: `conversations:read`.
+     */
+    listConversations(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/conversations',
+            ...options
+        });
+    }
+    /**
+     * Start a conversation
+     *
+     * Sends an approved WhatsApp template to a phone number. Ricky finds or creates the contact and reuses the number's conversation on that channel. Answers `202`: the send is queued; follow it with `GET /sends/{send_id}`.
+     *
+     * Scope: `messages:send`.
+     */
+    startConversation(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/conversations',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Get a conversation
+     *
+     * One conversation.
+     *
+     * Scope: `conversations:read`.
+     */
+    getConversation(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/conversations/{conversation_id}',
+            ...options
+        });
+    }
+    /**
+     * Assign a conversation
+     *
+     * Makes a member responsible for the conversation, or unassigns it.
+     *
+     * Scope: `conversations:write`.
+     */
+    assignConversation(options) {
+        return (options.client ?? this.client).patch({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/conversations/{conversation_id}/assignment',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Close a conversation
+     *
+     * Closing an already closed conversation changes nothing.
+     *
+     * Scope: `conversations:write`.
+     */
+    closeConversation(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/conversations/{conversation_id}/close',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Reopen a conversation
+     *
+     * Reopening an open conversation changes nothing. Send no body.
+     *
+     * Scope: `conversations:write`.
+     */
+    reopenConversation(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/conversations/{conversation_id}/reopen',
+            ...options
+        });
+    }
+    /**
+     * List messages
+     *
+     * Newest first.
+     *
+     * Scope: `conversations:read`.
+     */
+    listMessages(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/conversations/{conversation_id}/messages',
+            ...options
+        });
+    }
+    /**
+     * Send a message
+     *
+     * Sends text, a file on WhatsApp or Instagram, or a template on WhatsApp. For a file, Ricky downloads `media.url` before answering. Answers `202`: the send is queued; follow it with `GET /sends/{send_id}`. A `message.sent` webhook fires once the provider accepts it.
+     *
+     * Scope: `messages:send`.
+     */
+    sendMessage(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/conversations/{conversation_id}/messages',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Get a message
+     *
+     * One message, as the list shows it. A media `url` is signed again on each read.
+     *
+     * Scope: `conversations:read`.
+     */
+    getMessage(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/conversations/{conversation_id}/messages/{message_id}',
+            ...options
+        });
+    }
+    /**
+     * Get a send
+     *
+     * Whether the provider accepted a message, and why not if it failed.
+     *
+     * Scope: `messages:send`.
+     */
+    getSend(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/sends/{send_id}',
+            ...options
+        });
+    }
+    /**
+     * List channels
+     *
+     * WhatsApp numbers, Instagram accounts and Facebook pages.
+     *
+     * Scope: `conversations:read`.
+     */
+    listChannels(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/channels',
+            ...options
+        });
+    }
+    /**
+     * List members
+     *
+     * People in the organization; their IDs assign conversations and own contacts.
+     *
+     * Scope: `members:read`.
+     */
+    listMembers(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/members',
+            ...options
+        });
+    }
+    /**
+     * List tags
+     *
+     * Contact tags.
+     *
+     * Scope: `tags:read`.
+     */
+    listTags(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/tags',
+            ...options
+        });
+    }
+    /**
+     * Create a tag
+     *
+     * 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`.
+     */
+    createTag(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/tags',
+            ...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
+        });
+    }
+    /**
+     * List webhooks
+     *
+     * Newest first, at most 100.
+     *
+     * Scope: `webhooks:manage`.
+     */
+    listWebhooks(options) {
+        return (options?.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/webhooks',
+            ...options
+        });
+    }
+    /**
+     * Create a webhook
+     *
+     * The response carries `signing_secret`, the only time Ricky shows it.
+     *
+     * Scope: `webhooks:manage`.
+     */
+    createWebhook(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/webhooks',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Disable a webhook
+     *
+     * Stops new and pending deliveries. Disabling twice answers `404`.
+     *
+     * Scope: `webhooks:manage`.
+     */
+    disableWebhook(options) {
+        return (options.client ?? this.client).delete({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/webhooks/{webhook_id}',
+            ...options
+        });
+    }
+    /**
+     * Send a test event
+     *
+     * Sends one signed `webhook.test` event to the endpoint now and answers what it replied. It is not recorded as a delivery and is not retried.
+     *
+     * Scope: `webhooks:manage`.
+     */
+    testWebhook(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/webhooks/{webhook_id}/test',
+            ...options
+        });
+    }
+    /**
+     * Rotate the signing secret
+     *
+     * Returns a new `signing_secret`, the only time Ricky shows it. Until `expire_previous_after_hours` passes, every delivery carries two signatures in `X-Ricky-Signature`, new first, so you can deploy the new secret without missing events. The body is optional.
+     *
+     * Scope: `webhooks:manage`.
+     */
+    rotateWebhookSecret(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/webhooks/{webhook_id}/rotate-secret',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List deliveries
+     *
+     * The 100 most recent deliveries of a webhook.
+     *
+     * Scope: `webhooks:manage`.
+     */
+    listWebhookDeliveries(options) {
+        return (options.client ?? this.client).get({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/webhooks/{webhook_id}/deliveries',
+            ...options
+        });
+    }
+    /**
+     * Retry a delivery
+     *
+     * Queues a failed delivery again with a fresh attempt budget and sends it at once.
+     *
+     * Scope: `webhooks:manage`.
+     */
+    retryWebhookDelivery(options) {
+        return (options.client ?? this.client).post({
+            responseStyle: 'data',
+            security: [{ scheme: 'bearer', type: 'http' }],
+            url: '/webhooks/{webhook_id}/deliveries/{delivery_id}/retry',
+            ...options
+        });
+    }
+}
+exports.RickyApi = RickyApi;