@surgeapi/node 0.26.0 → 0.27.1

package/src/resources/messages.ts

@@ -1,7 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import * as MessagesAPI from './messages';
 import * as ContactsAPI from './contacts';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
@@ -52,16 +51,6 @@ export class Messages extends APIResource {
   }
 }
 
-/**
- * Params for creating an attachment
- */
-export interface AttachmentParams {
-  /**
-   * The URL of the attachment.
-   */
-  url: string;
-}
-
 /**
  * A Message is a communication sent to a Contact.
  */
@@ -148,18 +137,11 @@ export namespace Message {
   }
 }
 
-/**
- * Payload for creating a message. Either an attachment or the body must be given.
- * You can specify the recipient either using the 'conversation' parameter or the
- * 'to'/'from' parameters, but not both.
- */
-export type MessageParams = MessageParams.MessageParamsWithConversation | MessageParams.SimpleMessageParams;
+export type MessageCreateParams =
+  | MessageCreateParams.MessageParamsWithConversation
+  | MessageCreateParams.SimpleMessageParams;
 
-export namespace MessageParams {
-  /**
-   * Create a message while including parameters for the conversation in which the
-   * message should be sent.
-   */
+export declare namespace MessageCreateParams {
   export interface MessageParamsWithConversation {
     /**
      * Params for selecting or creating a new conversation. Either the id or the
@@ -167,7 +149,7 @@ export namespace MessageParams {
      */
     conversation: MessageParamsWithConversation.Conversation;
 
-    attachments?: Array<MessagesAPI.AttachmentParams>;
+    attachments?: Array<MessageParamsWithConversation.Attachment>;
 
     /**
      * The message body.
@@ -190,7 +172,7 @@ export namespace MessageParams {
       /**
        * Parameters for creating a contact
        */
-      contact: ContactsAPI.ContactParams;
+      contact: Conversation.Contact;
 
       /**
        * The phone number from which to send the message. This can be either the phone
@@ -198,81 +180,47 @@ export namespace MessageParams {
        */
       phone_number?: string;
     }
-  }
-
-  /**
-   * Create a basic message by specifying just the to/from phone numbers.
-   */
-  export interface SimpleMessageParams {
-    /**
-     * The recipient's phone number in E.164 format. Cannot be used together with
-     * 'conversation'.
-     */
-    to: string;
-
-    attachments?: Array<MessagesAPI.AttachmentParams>;
-
-    /**
-     * 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;
-  }
-}
 
-export type MessageCreateParams =
-  | MessageCreateParams.MessageParamsWithConversation
-  | MessageCreateParams.SimpleMessageParams;
-
-export declare namespace MessageCreateParams {
-  export interface MessageParamsWithConversation {
-    /**
-     * Params for selecting or creating a new conversation. Either the id or the
-     * Contact must be given.
-     */
-    conversation: MessageParamsWithConversation.Conversation;
-
-    attachments?: Array<AttachmentParams>;
-
-    /**
-     * The message body.
-     */
-    body?: string;
-
-    /**
-     * An optional datetime for scheduling message up to a couple of months in the
-     * future.
-     */
-    send_at?: string;
-  }
-
-  export namespace MessageParamsWithConversation {
-    /**
-     * Params for selecting or creating a new conversation. Either the id or the
-     * Contact must be given.
-     */
-    export interface Conversation {
+    export namespace Conversation {
       /**
        * Parameters for creating a contact
        */
-      contact: ContactsAPI.ContactParams;
+      export 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
+     */
+    export interface Attachment {
       /**
-       * 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.
+       * The URL of the attachment.
        */
-      phone_number?: string;
+      url: string;
     }
   }
 
@@ -283,7 +231,7 @@ export declare namespace MessageCreateParams {
      */
     to: string;
 
-    attachments?: Array<AttachmentParams>;
+    attachments?: Array<SimpleMessageParams.Attachment>;
 
     /**
      * The message body.
@@ -302,13 +250,20 @@ export declare namespace MessageCreateParams {
      */
     send_at?: string;
   }
+
+  export namespace SimpleMessageParams {
+    /**
+     * Params for creating an attachment
+     */
+    export interface Attachment {
+      /**
+       * The URL of the attachment.
+       */
+      url: string;
+    }
+  }
 }
 
 export declare namespace Messages {
-  export {
-    type AttachmentParams as AttachmentParams,
-    type Message as Message,
-    type MessageParams as MessageParams,
-    type MessageCreateParams as MessageCreateParams,
-  };
+  export { type Message as Message, type MessageCreateParams as MessageCreateParams };
 }

package/src/resources/phone-numbers.ts

@@ -46,40 +46,6 @@ export interface PhoneNumber {
   type: 'local' | 'toll_free';
 }
 
-/**
- * Parameters for purchasing a new phone number. The system will automatically
- * infer the type in certain cases:
- *
- * - If only area_code is provided, type is inferred from the area code
- * - If only latitude/longitude are provided, type is inferred as 'local'
- * - Otherwise, type must be explicitly specified
- */
-export interface PhoneNumberPurchaseParams {
-  /**
-   * The desired area code for this phone number. If provided without type, the type
-   * will be inferred.
-   */
-  area_code?: string;
-
-  /**
-   * Latitude to search for nearby phone numbers. Must be used with longitude. If
-   * provided without type, type will be inferred as 'local'.
-   */
-  latitude?: number;
-
-  /**
-   * Longitude to search for nearby phone numbers. Must be used with latitude. If
-   * provided without type, type will be inferred as 'local'.
-   */
-  longitude?: number;
-
-  /**
-   * Whether the phone number is local or toll-free. Can be omitted if area_code or
-   * latitude/longitude are provided.
-   */
-  type?: 'local' | 'toll_free';
-}
-
 export interface PhoneNumberPurchaseParams {
   /**
    * The desired area code for this phone number. If provided without type, the type

package/src/resources/users.ts

@@ -100,41 +100,6 @@ export interface User {
   photo_url?: string;
 }
 
-/**
- * POST body for creating a user
- */
-export interface UserParams {
-  /**
-   * The user's first name.
-   */
-  first_name: string;
-
-  /**
-   * The user's last name.
-   */
-  last_name?: string;
-
-  /**
-   * Set of key-value pairs that will be stored with the object.
-   */
-  metadata?: { [key: string]: string };
-
-  /**
-   * URL of a photo to be used as the user's avatar.
-   */
-  photo_url?: string;
-}
-
-/**
- * A request to create a token
- */
-export interface UserTokenParams {
-  /**
-   * For how many seconds the token should be accepted. Defaults to 15 minutes.
-   */
-  duration_seconds?: number;
-}
-
 /**
  * Response when token has been created successfully
  */
@@ -199,8 +164,6 @@ export interface UserCreateTokenParams {
 export declare namespace Users {
   export {
     type User as User,
-    type UserParams as UserParams,
-    type UserTokenParams as UserTokenParams,
     type UserTokenResponse as UserTokenResponse,
     type UserCreateParams as UserCreateParams,
     type UserUpdateParams as UserUpdateParams,

package/src/resources/verifications.ts

@@ -76,26 +76,6 @@ export interface VerificationCheck {
   verification?: Verification;
 }
 
-/**
- * Parameters for checking a Verification code
- */
-export interface VerificationCheckParams {
-  /**
-   * The Verification code that was received.
-   */
-  code: string;
-}
-
-/**
- * Parameters for creating a Verification
- */
-export interface VerificationParams {
-  /**
-   * The phone number to be verified. In E.164 format.
-   */
-  phone_number: string;
-}
-
 export interface VerificationCreateParams {
   /**
    * The phone number to be verified. In E.164 format.
@@ -114,8 +94,7 @@ export declare namespace Verifications {
   export {
     type Verification as Verification,
     type VerificationCheck as VerificationCheck,
-    type VerificationCheckParams as VerificationCheckParams,
-    type VerificationParams as VerificationParams,
     type VerificationCreateParams as VerificationCreateParams,
+    type VerificationCheckParams as VerificationCheckParams,
   };
 }

package/src/resources/webhooks.ts

@@ -20,10 +20,6 @@ export class Webhooks extends APIResource {
   }
 }
 
-/**
- * The `call.ended` event is delivered whenever a call is completed between a Surge
- * number you own and another phone number.
- */
 export interface CallEndedWebhookEvent {
   /**
    * The ID of the account in which this event occurred
@@ -87,10 +83,6 @@ export namespace CallEndedWebhookEvent {
   }
 }
 
-/**
- * The `campaign.approved` event is delivered whenever a campaign is approved by
- * all of the US carriers and able to start sending text messages.
- */
 export interface CampaignApprovedWebhookEvent {
   /**
    * The ID of the account in which this event occurred
@@ -130,13 +122,74 @@ export namespace CampaignApprovedWebhookEvent {
   }
 }
 
-/**
- * The `conversation.created` event is delivered whenever a new conversation is
- * started with a contact. This could be when either the contact sends a message to
- * your Surge number or when you create a conversation, whether by sending an
- * initial message to the contact or by manually creating the conversation using
- * the API.
- */
+export interface ContactOptedInWebhookEvent {
+  /**
+   * The ID of the account in which this event occurred
+   */
+  account_id: string;
+
+  /**
+   * The data associated with the event
+   */
+  data: ContactOptedInWebhookEvent.Data;
+
+  /**
+   * The timestamp when this event occurred, in ISO8601 format
+   */
+  timestamp: string;
+
+  /**
+   * The type of the event. Always `contact.opted_in` for this event.
+   */
+  type: 'contact.opted_in';
+}
+
+export namespace ContactOptedInWebhookEvent {
+  /**
+   * The data associated with the event
+   */
+  export interface Data {
+    /**
+     * The unique identifier for the contact
+     */
+    id: string;
+  }
+}
+
+export interface ContactOptedOutWebhookEvent {
+  /**
+   * The ID of the account in which this event occurred
+   */
+  account_id: string;
+
+  /**
+   * The data associated with the event
+   */
+  data: ContactOptedOutWebhookEvent.Data;
+
+  /**
+   * The timestamp when this event occurred, in ISO8601 format
+   */
+  timestamp: string;
+
+  /**
+   * The type of the event. Always `contact.opted_out` for this event.
+   */
+  type: 'contact.opted_out';
+}
+
+export namespace ContactOptedOutWebhookEvent {
+  /**
+   * The data associated with the event
+   */
+  export interface Data {
+    /**
+     * The unique identifier for the contact
+     */
+    id: string;
+  }
+}
+
 export interface ConversationCreatedWebhookEvent {
   /**
    * The ID of the account in which this event occurred
@@ -181,14 +234,6 @@ export namespace ConversationCreatedWebhookEvent {
   }
 }
 
-/**
- * The `message.delivered` event is delivered whenever a message sent from a Surge
- * number is successfully delivered to the recipient. When the message is sent from
- * a short code or toll-free number, this means that the message arrived on the
- * recipient's device. When sent from a local number, this means that the message
- * was successfully handed off to the recipient's mobile carrier, but does not
- * guarantee that it arrived on the recipient's device.
- */
 export interface MessageDeliveredWebhookEvent {
   /**
    * The ID of the account in which this event occurred
@@ -282,10 +327,6 @@ export namespace MessageDeliveredWebhookEvent {
   }
 }
 
-/**
- * The `message.failed` event is delivered whenever a message sent from your Surge
- * number fails to be delivered.
- */
 export interface MessageFailedWebhookEvent {
   /**
    * The ID of the account in which this event occurred
@@ -384,10 +425,6 @@ export namespace MessageFailedWebhookEvent {
   }
 }
 
-/**
- * The `message.received` event is delivered whenever a message is received at a
- * Surge number from a contact.
- */
 export interface MessageReceivedWebhookEvent {
   /**
    * The ID of the account in which this event occurred
@@ -481,10 +518,6 @@ export namespace MessageReceivedWebhookEvent {
   }
 }
 
-/**
- * The `message.sent` event is delivered whenever a message is sent from a Surge
- * number to a contact.
- */
 export interface MessageSentWebhookEvent {
   /**
    * The ID of the account in which this event occurred
@@ -578,13 +611,11 @@ export namespace MessageSentWebhookEvent {
   }
 }
 
-/**
- * The `call.ended` event is delivered whenever a call is completed between a Surge
- * number you own and another phone number.
- */
 export type UnwrapWebhookEvent =
   | CallEndedWebhookEvent
   | CampaignApprovedWebhookEvent
+  | ContactOptedInWebhookEvent
+  | ContactOptedOutWebhookEvent
   | ConversationCreatedWebhookEvent
   | MessageDeliveredWebhookEvent
   | MessageFailedWebhookEvent
@@ -595,6 +626,8 @@ export declare namespace Webhooks {
   export {
     type CallEndedWebhookEvent as CallEndedWebhookEvent,
     type CampaignApprovedWebhookEvent as CampaignApprovedWebhookEvent,
+    type ContactOptedInWebhookEvent as ContactOptedInWebhookEvent,
+    type ContactOptedOutWebhookEvent as ContactOptedOutWebhookEvent,
     type ConversationCreatedWebhookEvent as ConversationCreatedWebhookEvent,
     type MessageDeliveredWebhookEvent as MessageDeliveredWebhookEvent,
     type MessageFailedWebhookEvent as MessageFailedWebhookEvent,

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.26.0'; // x-release-please-version
+export const VERSION = '0.27.1'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.26.0";
+export declare const VERSION = "0.27.1";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.26.0";
+export declare const VERSION = "0.27.1";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.26.0'; // x-release-please-version
+exports.VERSION = '0.27.1'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.26.0'; // x-release-please-version
+export const VERSION = '0.27.1'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map