@surgeapi/node 0.25.7 → 0.27.0

package/resources/contacts.mjs

@@ -0,0 +1,48 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { path } from "../internal/utils/path.mjs";
+export class Contacts extends APIResource {
+    /**
+     * Creates a new Contact object.
+     *
+     * @example
+     * ```ts
+     * const contact = await client.contacts.create(
+     *   'acct_01j9a43avnfqzbjfch6pygv1td',
+     *   { phone_number: '+18015551234' },
+     * );
+     * ```
+     */
+    create(accountID, body, options) {
+        return this._client.post(path `/accounts/${accountID}/contacts`, { body, ...options });
+    }
+    /**
+     * Retrieves a Contact object.
+     *
+     * @example
+     * ```ts
+     * const contact = await client.contacts.retrieve(
+     *   'ctc_01j9dy8mdzfn3r0e8x1tbdrdrf',
+     * );
+     * ```
+     */
+    retrieve(id, options) {
+        return this._client.get(path `/contacts/${id}`, options);
+    }
+    /**
+     * Updates the specified contact by setting the values of the parameters passed.
+     * Any parameters not provided will be left unchanged.
+     *
+     * @example
+     * ```ts
+     * const contact = await client.contacts.update(
+     *   'ctc_01j9dy8mdzfn3r0e8x1tbdrdrf',
+     *   { phone_number: '+18015551234' },
+     * );
+     * ```
+     */
+    update(id, body, options) {
+        return this._client.patch(path `/contacts/${id}`, { body, ...options });
+    }
+}
+//# sourceMappingURL=contacts.mjs.map

package/resources/contacts.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"contacts.mjs","sourceRoot":"","sources":["../src/resources/contacts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,aAAa,SAAS,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,IAAyB,EAAE,OAAwB;QACpE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,aAAa,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzE,CAAC;CACF"}

package/resources/index.d.mts

@@ -0,0 +1,11 @@
+export * from "./shared.mjs";
+export { Accounts, type Account, type AccountStatus, type Organization, type AccountCreateParams, type AccountUpdateParams, type AccountRetrieveStatusParams, } from "./accounts.mjs";
+export { Blasts, type Blast, type BlastCreateParams } from "./blasts.mjs";
+export { Campaigns, type Campaign, type CampaignCreateParams } from "./campaigns.mjs";
+export { Contacts, type Contact, type ContactCreateParams, type ContactUpdateParams } from "./contacts.mjs";
+export { Messages, type Message, type MessageCreateParams } from "./messages.mjs";
+export { PhoneNumbers, type PhoneNumber, type PhoneNumberPurchaseParams } from "./phone-numbers.mjs";
+export { Users, type User, type UserTokenResponse, type UserCreateParams, type UserUpdateParams, type UserCreateTokenParams, } from "./users.mjs";
+export { Verifications, type Verification, type VerificationCheck, type VerificationCreateParams, type VerificationCheckParams, } from "./verifications.mjs";
+export { Webhooks, type CallEndedWebhookEvent, type CampaignApprovedWebhookEvent, type ContactOptedInWebhookEvent, type ContactOptedOutWebhookEvent, type ConversationCreatedWebhookEvent, type MessageDeliveredWebhookEvent, type MessageFailedWebhookEvent, type MessageReceivedWebhookEvent, type MessageSentWebhookEvent, type UnwrapWebhookEvent, } from "./webhooks.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";OAGO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,2BAA2B,GACjC;OACM,EAAE,MAAM,EAAE,KAAK,KAAK,EAAE,KAAK,iBAAiB,EAAE;OAC9C,EAAE,SAAS,EAAE,KAAK,QAAQ,EAAE,KAAK,oBAAoB,EAAE;OACvD,EAAE,QAAQ,EAAE,KAAK,OAAO,EAAE,KAAK,mBAAmB,EAAE,KAAK,mBAAmB,EAAE;OAC9E,EAAE,QAAQ,EAAE,KAAK,OAAO,EAAE,KAAK,mBAAmB,EAAE;OACpD,EAAE,YAAY,EAAE,KAAK,WAAW,EAAE,KAAK,yBAAyB,EAAE;OAClE,EACL,KAAK,EACL,KAAK,IAAI,EACT,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,GAC3B;OACM,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,GAC7B;OACM,EACL,QAAQ,EACR,KAAK,qBAAqB,EAC1B,KAAK,4BAA4B,EACjC,KAAK,0BAA0B,EAC/B,KAAK,2BAA2B,EAChC,KAAK,+BAA+B,EACpC,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,GACxB"}

package/resources/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./shared.js";
+export { Accounts, type Account, type AccountStatus, type Organization, type AccountCreateParams, type AccountUpdateParams, type AccountRetrieveStatusParams, } from "./accounts.js";
+export { Blasts, type Blast, type BlastCreateParams } from "./blasts.js";
+export { Campaigns, type Campaign, type CampaignCreateParams } from "./campaigns.js";
+export { Contacts, type Contact, type ContactCreateParams, type ContactUpdateParams } from "./contacts.js";
+export { Messages, type Message, type MessageCreateParams } from "./messages.js";
+export { PhoneNumbers, type PhoneNumber, type PhoneNumberPurchaseParams } from "./phone-numbers.js";
+export { Users, type User, type UserTokenResponse, type UserCreateParams, type UserUpdateParams, type UserCreateTokenParams, } from "./users.js";
+export { Verifications, type Verification, type VerificationCheck, type VerificationCreateParams, type VerificationCheckParams, } from "./verifications.js";
+export { Webhooks, type CallEndedWebhookEvent, type CampaignApprovedWebhookEvent, type ContactOptedInWebhookEvent, type ContactOptedOutWebhookEvent, type ConversationCreatedWebhookEvent, type MessageDeliveredWebhookEvent, type MessageFailedWebhookEvent, type MessageReceivedWebhookEvent, type MessageSentWebhookEvent, type UnwrapWebhookEvent, } from "./webhooks.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";OAGO,EACL,QAAQ,EACR,KAAK,OAAO,EACZ,KAAK,aAAa,EAClB,KAAK,YAAY,EACjB,KAAK,mBAAmB,EACxB,KAAK,mBAAmB,EACxB,KAAK,2BAA2B,GACjC;OACM,EAAE,MAAM,EAAE,KAAK,KAAK,EAAE,KAAK,iBAAiB,EAAE;OAC9C,EAAE,SAAS,EAAE,KAAK,QAAQ,EAAE,KAAK,oBAAoB,EAAE;OACvD,EAAE,QAAQ,EAAE,KAAK,OAAO,EAAE,KAAK,mBAAmB,EAAE,KAAK,mBAAmB,EAAE;OAC9E,EAAE,QAAQ,EAAE,KAAK,OAAO,EAAE,KAAK,mBAAmB,EAAE;OACpD,EAAE,YAAY,EAAE,KAAK,WAAW,EAAE,KAAK,yBAAyB,EAAE;OAClE,EACL,KAAK,EACL,KAAK,IAAI,EACT,KAAK,iBAAiB,EACtB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,qBAAqB,GAC3B;OACM,EACL,aAAa,EACb,KAAK,YAAY,EACjB,KAAK,iBAAiB,EACtB,KAAK,wBAAwB,EAC7B,KAAK,uBAAuB,GAC7B;OACM,EACL,QAAQ,EACR,KAAK,qBAAqB,EAC1B,KAAK,4BAA4B,EACjC,KAAK,0BAA0B,EAC/B,KAAK,2BAA2B,EAChC,KAAK,+BAA+B,EACpC,KAAK,4BAA4B,EACjC,KAAK,yBAAyB,EAC9B,KAAK,2BAA2B,EAChC,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,GACxB"}

package/resources/index.js

@@ -0,0 +1,25 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Webhooks = exports.Verifications = exports.Users = exports.PhoneNumbers = exports.Messages = exports.Contacts = exports.Campaigns = exports.Blasts = exports.Accounts = void 0;
+const tslib_1 = require("../internal/tslib.js");
+tslib_1.__exportStar(require("./shared.js"), exports);
+var accounts_1 = require("./accounts.js");
+Object.defineProperty(exports, "Accounts", { enumerable: true, get: function () { return accounts_1.Accounts; } });
+var blasts_1 = require("./blasts.js");
+Object.defineProperty(exports, "Blasts", { enumerable: true, get: function () { return blasts_1.Blasts; } });
+var campaigns_1 = require("./campaigns.js");
+Object.defineProperty(exports, "Campaigns", { enumerable: true, get: function () { return campaigns_1.Campaigns; } });
+var contacts_1 = require("./contacts.js");
+Object.defineProperty(exports, "Contacts", { enumerable: true, get: function () { return contacts_1.Contacts; } });
+var messages_1 = require("./messages.js");
+Object.defineProperty(exports, "Messages", { enumerable: true, get: function () { return messages_1.Messages; } });
+var phone_numbers_1 = require("./phone-numbers.js");
+Object.defineProperty(exports, "PhoneNumbers", { enumerable: true, get: function () { return phone_numbers_1.PhoneNumbers; } });
+var users_1 = require("./users.js");
+Object.defineProperty(exports, "Users", { enumerable: true, get: function () { return users_1.Users; } });
+var verifications_1 = require("./verifications.js");
+Object.defineProperty(exports, "Verifications", { enumerable: true, get: function () { return verifications_1.Verifications; } });
+var webhooks_1 = require("./webhooks.js");
+Object.defineProperty(exports, "Webhooks", { enumerable: true, get: function () { return webhooks_1.Webhooks; } });
+//# sourceMappingURL=index.js.map

package/resources/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,sDAAyB;AACzB,0CAQoB;AAPlB,oGAAA,QAAQ,OAAA;AAQV,sCAAsE;AAA7D,gGAAA,MAAM,OAAA;AACf,4CAAkF;AAAzE,sGAAA,SAAS,OAAA;AAClB,0CAAwG;AAA/F,oGAAA,QAAQ,OAAA;AACjB,0CAA8E;AAArE,oGAAA,QAAQ,OAAA;AACjB,oDAAiG;AAAxF,6GAAA,YAAY,OAAA;AACrB,oCAOiB;AANf,8FAAA,KAAK,OAAA;AAOP,oDAMyB;AALvB,8GAAA,aAAa,OAAA;AAMf,0CAYoB;AAXlB,oGAAA,QAAQ,OAAA"}

package/resources/index.mjs

@@ -0,0 +1,12 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export * from "./shared.mjs";
+export { Accounts, } from "./accounts.mjs";
+export { Blasts } from "./blasts.mjs";
+export { Campaigns } from "./campaigns.mjs";
+export { Contacts } from "./contacts.mjs";
+export { Messages } from "./messages.mjs";
+export { PhoneNumbers } from "./phone-numbers.mjs";
+export { Users, } from "./users.mjs";
+export { Verifications, } from "./verifications.mjs";
+export { Webhooks, } from "./webhooks.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,EACL,QAAQ,GAOT;OACM,EAAE,MAAM,EAAsC;OAC9C,EAAE,SAAS,EAA4C;OACvD,EAAE,QAAQ,EAAoE;OAC9E,EAAE,QAAQ,EAA0C;OACpD,EAAE,YAAY,EAAoD;OAClE,EACL,KAAK,GAMN;OACM,EACL,aAAa,GAKd;OACM,EACL,QAAQ,GAWT"}

package/resources/messages.d.mts

@@ -0,0 +1,231 @@
+import { APIResource } from "../core/resource.mjs";
+import * as ContactsAPI from "./contacts.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Messages extends APIResource {
+    /**
+     * Creates and enqueues a new message to be sent.
+     *
+     * Messages are always sent asynchronously. When you hit this endpoint, the message
+     * will be created within Surge's system and enqueued for sending, and then the id
+     * for the new message will be returned. When the message is actually sent, a
+     * `message.sent` webhook event will be triggered and sent to any webhook endpoints
+     * that you have subscribed to this event type. Then a `message.delivered` webhook
+     * event will be triggered when the carrier sends us a delivery receipt.
+     *
+     * By default all messages will be sent immediately. If you would like to schedule
+     * sending for some time up to 60 days in the future, you can do that by providing
+     * a value for the `send_at` field. This should be formatted as an ISO8601 datetime
+     * like `2028-10-14T18:06:00Z`.
+     *
+     * You must include either a `body` or `attachments` field (or both) in the request
+     * body. The `body` field should contain the text of the message you want to send,
+     * and the `attachments` field should be an array of objects with a `url` field
+     * pointing to the file you want to attach. Surge will download these files and
+     * send them as attachments in the message.
+     *
+     * You can provide either a `conversation` object or a `to` field to specify the
+     * intended recipient of the message, but an error will be returned if both fields
+     * are provided. Similarly the `from` field cannot be used together with the
+     * `conversation` field, and `conversation.phone_number` should be specified
+     * instead.
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.create(
+     *   'acct_01j9a43avnfqzbjfch6pygv1td',
+     *   {
+     *     conversation: {
+     *       contact: { phone_number: '+18015551234' },
+     *     },
+     *   },
+     * );
+     * ```
+     */
+    create(accountID: string, body: MessageCreateParams, options?: RequestOptions): APIPromise<Message>;
+}
+/**
+ * A Message is a communication sent to a Contact.
+ */
+export interface Message {
+    /**
+     * Unique identifier for the object.
+     */
+    id?: string;
+    attachments?: Array<Message.Attachment>;
+    /**
+     * The message body.
+     */
+    body?: string;
+    /**
+     * A conversation with a Contact
+     */
+    conversation?: Message.Conversation;
+}
+export declare namespace Message {
+    /**
+     * An Attachment is a file that can be sent with a message.
+     */
+    interface Attachment {
+        /**
+         * Unique identifier for the object.
+         */
+        id?: string;
+        /**
+         * The type of attachment.
+         */
+        type?: string;
+        /**
+         * The URL of the attachment.
+         */
+        url?: string;
+    }
+    /**
+     * A conversation with a Contact
+     */
+    interface Conversation {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+        /**
+         * A contact who has consented to receive messages
+         */
+        contact: ContactsAPI.Contact;
+        /**
+         * This is the phone number tied to the Surge account.
+         */
+        phone_number?: Conversation.PhoneNumber;
+    }
+    namespace Conversation {
+        /**
+         * This is the phone number tied to the Surge account.
+         */
+        interface PhoneNumber {
+            /**
+             * Unique identifier for the phone number
+             */
+            id: string;
+            /**
+             * The canonical format of the phone number.
+             */
+            number: string;
+            /**
+             * Whether the phone number is local, toll-free, or short code
+             */
+            type: 'local' | 'toll_free' | 'short_code' | 'demo';
+        }
+    }
+}
+export type MessageCreateParams = MessageCreateParams.MessageParamsWithConversation | MessageCreateParams.SimpleMessageParams;
+export declare namespace MessageCreateParams {
+    interface MessageParamsWithConversation {
+        /**
+         * Params for selecting or creating a new conversation. Either the id or the
+         * Contact must be given.
+         */
+        conversation: MessageParamsWithConversation.Conversation;
+        attachments?: Array<MessageParamsWithConversation.Attachment>;
+        /**
+         * The message body.
+         */
+        body?: string;
+        /**
+         * An optional datetime for scheduling message up to a couple of months in the
+         * future.
+         */
+        send_at?: string;
+    }
+    namespace MessageParamsWithConversation {
+        /**
+         * Params for selecting or creating a new conversation. Either the id or the
+         * Contact must be given.
+         */
+        interface Conversation {
+            /**
+             * Parameters for creating a contact
+             */
+            contact: Conversation.Contact;
+            /**
+             * The phone number from which to send the message. This can be either the phone
+             * number in E.164 format or a Surge phone number id.
+             */
+            phone_number?: string;
+        }
+        namespace Conversation {
+            /**
+             * Parameters for creating a contact
+             */
+            interface Contact {
+                /**
+                 * The contact's phone number in E.164 format.
+                 */
+                phone_number: string;
+                /**
+                 * The contact's email address.
+                 */
+                email?: string;
+                /**
+                 * The contact's first name.
+                 */
+                first_name?: string;
+                /**
+                 * The contact's last name.
+                 */
+                last_name?: string;
+                /**
+                 * Set of key-value pairs that will be stored with the object.
+                 */
+                metadata?: {
+                    [key: string]: string;
+                };
+            }
+        }
+        /**
+         * Params for creating an attachment
+         */
+        interface Attachment {
+            /**
+             * The URL of the attachment.
+             */
+            url: string;
+        }
+    }
+    interface SimpleMessageParams {
+        /**
+         * The recipient's phone number in E.164 format. Cannot be used together with
+         * 'conversation'.
+         */
+        to: string;
+        attachments?: Array<SimpleMessageParams.Attachment>;
+        /**
+         * The message body.
+         */
+        body?: string;
+        /**
+         * The sender's phone number in E.164 format or phone number ID. If omitted, uses
+         * the account's default phone number. Cannot be used together with 'conversation'.
+         */
+        from?: string;
+        /**
+         * An optional datetime for scheduling message up to a couple of months in the
+         * future.
+         */
+        send_at?: string;
+    }
+    namespace SimpleMessageParams {
+        /**
+         * Params for creating an attachment
+         */
+        interface Attachment {
+            /**
+             * The URL of the attachment.
+             */
+            url: string;
+        }
+    }
+}
+export declare namespace Messages {
+    export { type Message as Message, type MessageCreateParams as MessageCreateParams };
+}
+//# sourceMappingURL=messages.d.mts.map

package/resources/messages.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.d.mts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAGpG;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAExC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC;CACrC;AAED,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC;QAE7B;;WAEG;QACH,YAAY,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC;KACzC;IAED,UAAiB,YAAY,CAAC;QAC5B;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,IAAI,EAAE,OAAO,GAAG,WAAW,GAAG,YAAY,GAAG,MAAM,CAAC;SACrD;KACF;CACF;AAED,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,6BAA6B,GACjD,mBAAmB,CAAC,mBAAmB,CAAC;AAE5C,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,6BAA6B;QAC5C;;;WAGG;QACH,YAAY,EAAE,6BAA6B,CAAC,YAAY,CAAC;QAEzD,WAAW,CAAC,EAAE,KAAK,CAAC,6BAA6B,CAAC,UAAU,CAAC,CAAC;QAE9D;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED,UAAiB,6BAA6B,CAAC;QAC7C;;;WAGG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;YAE9B;;;eAGG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;QAED,UAAiB,YAAY,CAAC;YAC5B;;eAEG;YACH,UAAiB,OAAO;gBACtB;;mBAEG;gBACH,YAAY,EAAE,MAAM,CAAC;gBAErB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,CAAC;gBAEf;;mBAEG;gBACH,UAAU,CAAC,EAAE,MAAM,CAAC;gBAEpB;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,QAAQ,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACtC;SACF;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;IAED,UAAiB,mBAAmB;QAClC;;;WAGG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAEpD;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED,UAAiB,mBAAmB,CAAC;QACnC;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EAAE,KAAK,OAAO,IAAI,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CACrF"}

package/resources/messages.d.ts

@@ -0,0 +1,231 @@
+import { APIResource } from "../core/resource.js";
+import * as ContactsAPI from "./contacts.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Messages extends APIResource {
+    /**
+     * Creates and enqueues a new message to be sent.
+     *
+     * Messages are always sent asynchronously. When you hit this endpoint, the message
+     * will be created within Surge's system and enqueued for sending, and then the id
+     * for the new message will be returned. When the message is actually sent, a
+     * `message.sent` webhook event will be triggered and sent to any webhook endpoints
+     * that you have subscribed to this event type. Then a `message.delivered` webhook
+     * event will be triggered when the carrier sends us a delivery receipt.
+     *
+     * By default all messages will be sent immediately. If you would like to schedule
+     * sending for some time up to 60 days in the future, you can do that by providing
+     * a value for the `send_at` field. This should be formatted as an ISO8601 datetime
+     * like `2028-10-14T18:06:00Z`.
+     *
+     * You must include either a `body` or `attachments` field (or both) in the request
+     * body. The `body` field should contain the text of the message you want to send,
+     * and the `attachments` field should be an array of objects with a `url` field
+     * pointing to the file you want to attach. Surge will download these files and
+     * send them as attachments in the message.
+     *
+     * You can provide either a `conversation` object or a `to` field to specify the
+     * intended recipient of the message, but an error will be returned if both fields
+     * are provided. Similarly the `from` field cannot be used together with the
+     * `conversation` field, and `conversation.phone_number` should be specified
+     * instead.
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.create(
+     *   'acct_01j9a43avnfqzbjfch6pygv1td',
+     *   {
+     *     conversation: {
+     *       contact: { phone_number: '+18015551234' },
+     *     },
+     *   },
+     * );
+     * ```
+     */
+    create(accountID: string, body: MessageCreateParams, options?: RequestOptions): APIPromise<Message>;
+}
+/**
+ * A Message is a communication sent to a Contact.
+ */
+export interface Message {
+    /**
+     * Unique identifier for the object.
+     */
+    id?: string;
+    attachments?: Array<Message.Attachment>;
+    /**
+     * The message body.
+     */
+    body?: string;
+    /**
+     * A conversation with a Contact
+     */
+    conversation?: Message.Conversation;
+}
+export declare namespace Message {
+    /**
+     * An Attachment is a file that can be sent with a message.
+     */
+    interface Attachment {
+        /**
+         * Unique identifier for the object.
+         */
+        id?: string;
+        /**
+         * The type of attachment.
+         */
+        type?: string;
+        /**
+         * The URL of the attachment.
+         */
+        url?: string;
+    }
+    /**
+     * A conversation with a Contact
+     */
+    interface Conversation {
+        /**
+         * Unique identifier for the object.
+         */
+        id: string;
+        /**
+         * A contact who has consented to receive messages
+         */
+        contact: ContactsAPI.Contact;
+        /**
+         * This is the phone number tied to the Surge account.
+         */
+        phone_number?: Conversation.PhoneNumber;
+    }
+    namespace Conversation {
+        /**
+         * This is the phone number tied to the Surge account.
+         */
+        interface PhoneNumber {
+            /**
+             * Unique identifier for the phone number
+             */
+            id: string;
+            /**
+             * The canonical format of the phone number.
+             */
+            number: string;
+            /**
+             * Whether the phone number is local, toll-free, or short code
+             */
+            type: 'local' | 'toll_free' | 'short_code' | 'demo';
+        }
+    }
+}
+export type MessageCreateParams = MessageCreateParams.MessageParamsWithConversation | MessageCreateParams.SimpleMessageParams;
+export declare namespace MessageCreateParams {
+    interface MessageParamsWithConversation {
+        /**
+         * Params for selecting or creating a new conversation. Either the id or the
+         * Contact must be given.
+         */
+        conversation: MessageParamsWithConversation.Conversation;
+        attachments?: Array<MessageParamsWithConversation.Attachment>;
+        /**
+         * The message body.
+         */
+        body?: string;
+        /**
+         * An optional datetime for scheduling message up to a couple of months in the
+         * future.
+         */
+        send_at?: string;
+    }
+    namespace MessageParamsWithConversation {
+        /**
+         * Params for selecting or creating a new conversation. Either the id or the
+         * Contact must be given.
+         */
+        interface Conversation {
+            /**
+             * Parameters for creating a contact
+             */
+            contact: Conversation.Contact;
+            /**
+             * The phone number from which to send the message. This can be either the phone
+             * number in E.164 format or a Surge phone number id.
+             */
+            phone_number?: string;
+        }
+        namespace Conversation {
+            /**
+             * Parameters for creating a contact
+             */
+            interface Contact {
+                /**
+                 * The contact's phone number in E.164 format.
+                 */
+                phone_number: string;
+                /**
+                 * The contact's email address.
+                 */
+                email?: string;
+                /**
+                 * The contact's first name.
+                 */
+                first_name?: string;
+                /**
+                 * The contact's last name.
+                 */
+                last_name?: string;
+                /**
+                 * Set of key-value pairs that will be stored with the object.
+                 */
+                metadata?: {
+                    [key: string]: string;
+                };
+            }
+        }
+        /**
+         * Params for creating an attachment
+         */
+        interface Attachment {
+            /**
+             * The URL of the attachment.
+             */
+            url: string;
+        }
+    }
+    interface SimpleMessageParams {
+        /**
+         * The recipient's phone number in E.164 format. Cannot be used together with
+         * 'conversation'.
+         */
+        to: string;
+        attachments?: Array<SimpleMessageParams.Attachment>;
+        /**
+         * The message body.
+         */
+        body?: string;
+        /**
+         * The sender's phone number in E.164 format or phone number ID. If omitted, uses
+         * the account's default phone number. Cannot be used together with 'conversation'.
+         */
+        from?: string;
+        /**
+         * An optional datetime for scheduling message up to a couple of months in the
+         * future.
+         */
+        send_at?: string;
+    }
+    namespace SimpleMessageParams {
+        /**
+         * Params for creating an attachment
+         */
+        interface Attachment {
+            /**
+             * The URL of the attachment.
+             */
+            url: string;
+        }
+    }
+}
+export declare namespace Messages {
+    export { type Message as Message, type MessageCreateParams as MessageCreateParams };
+}
+//# sourceMappingURL=messages.d.ts.map

package/resources/messages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.d.ts","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,WAAW;OAChB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,QAAS,SAAQ,WAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;CAGpG;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,WAAW,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAExC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC;CACrC;AAED,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACH,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,OAAO,EAAE,WAAW,CAAC,OAAO,CAAC;QAE7B;;WAEG;QACH,YAAY,CAAC,EAAE,YAAY,CAAC,WAAW,CAAC;KACzC;IAED,UAAiB,YAAY,CAAC;QAC5B;;WAEG;QACH,UAAiB,WAAW;YAC1B;;eAEG;YACH,EAAE,EAAE,MAAM,CAAC;YAEX;;eAEG;YACH,MAAM,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,IAAI,EAAE,OAAO,GAAG,WAAW,GAAG,YAAY,GAAG,MAAM,CAAC;SACrD;KACF;CACF;AAED,MAAM,MAAM,mBAAmB,GAC3B,mBAAmB,CAAC,6BAA6B,GACjD,mBAAmB,CAAC,mBAAmB,CAAC;AAE5C,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,UAAiB,6BAA6B;QAC5C;;;WAGG;QACH,YAAY,EAAE,6BAA6B,CAAC,YAAY,CAAC;QAEzD,WAAW,CAAC,EAAE,KAAK,CAAC,6BAA6B,CAAC,UAAU,CAAC,CAAC;QAE9D;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED,UAAiB,6BAA6B,CAAC;QAC7C;;;WAGG;QACH,UAAiB,YAAY;YAC3B;;eAEG;YACH,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;YAE9B;;;eAGG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;SACvB;QAED,UAAiB,YAAY,CAAC;YAC5B;;eAEG;YACH,UAAiB,OAAO;gBACtB;;mBAEG;gBACH,YAAY,EAAE,MAAM,CAAC;gBAErB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,CAAC;gBAEf;;mBAEG;gBACH,UAAU,CAAC,EAAE,MAAM,CAAC;gBAEpB;;mBAEG;gBACH,SAAS,CAAC,EAAE,MAAM,CAAC;gBAEnB;;mBAEG;gBACH,QAAQ,CAAC,EAAE;oBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;iBAAE,CAAC;aACtC;SACF;QAED;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;IAED,UAAiB,mBAAmB;QAClC;;;WAGG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,WAAW,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,CAAC;QAEpD;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED,UAAiB,mBAAmB,CAAC;QACnC;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,GAAG,EAAE,MAAM,CAAC;SACb;KACF;CACF;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EAAE,KAAK,OAAO,IAAI,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CACrF"}

package/resources/messages.js

@@ -0,0 +1,52 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Messages = void 0;
+const resource_1 = require("../core/resource.js");
+const path_1 = require("../internal/utils/path.js");
+class Messages extends resource_1.APIResource {
+    /**
+     * Creates and enqueues a new message to be sent.
+     *
+     * Messages are always sent asynchronously. When you hit this endpoint, the message
+     * will be created within Surge's system and enqueued for sending, and then the id
+     * for the new message will be returned. When the message is actually sent, a
+     * `message.sent` webhook event will be triggered and sent to any webhook endpoints
+     * that you have subscribed to this event type. Then a `message.delivered` webhook
+     * event will be triggered when the carrier sends us a delivery receipt.
+     *
+     * By default all messages will be sent immediately. If you would like to schedule
+     * sending for some time up to 60 days in the future, you can do that by providing
+     * a value for the `send_at` field. This should be formatted as an ISO8601 datetime
+     * like `2028-10-14T18:06:00Z`.
+     *
+     * You must include either a `body` or `attachments` field (or both) in the request
+     * body. The `body` field should contain the text of the message you want to send,
+     * and the `attachments` field should be an array of objects with a `url` field
+     * pointing to the file you want to attach. Surge will download these files and
+     * send them as attachments in the message.
+     *
+     * You can provide either a `conversation` object or a `to` field to specify the
+     * intended recipient of the message, but an error will be returned if both fields
+     * are provided. Similarly the `from` field cannot be used together with the
+     * `conversation` field, and `conversation.phone_number` should be specified
+     * instead.
+     *
+     * @example
+     * ```ts
+     * const message = await client.messages.create(
+     *   'acct_01j9a43avnfqzbjfch6pygv1td',
+     *   {
+     *     conversation: {
+     *       contact: { phone_number: '+18015551234' },
+     *     },
+     *   },
+     * );
+     * ```
+     */
+    create(accountID, body, options) {
+        return this._client.post((0, path_1.path) `/accounts/${accountID}/messages`, { body, ...options });
+    }
+}
+exports.Messages = Messages;
+//# sourceMappingURL=messages.js.map

package/resources/messages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messages.js","sourceRoot":"","sources":["../src/resources/messages.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,oDAA8C;AAE9C,MAAa,QAAS,SAAQ,sBAAW;IACvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAsCG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,aAAa,SAAS,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxF,CAAC;CACF;AA3CD,4BA2CC"}