@surgeapi/node 0.26.0 → 0.27.0

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.0'; // 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.0";
 //# 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.0";
 //# 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.0'; // 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.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map