sendblue 3.3.1 → 3.6.0

package/src/resources/contacts/contacts.ts

@@ -42,7 +42,8 @@ export class Contacts extends APIResource {
   }
 
   /**
-   * Update an existing contact
+   * Update an existing contact. You may set SMS opt-out with `opt_out` (boolean); it
+   * updates the same recipient record used for inbound keyword opt-outs.
    *
    * @example
    * ```ts
@@ -96,6 +97,23 @@ export class Contacts extends APIResource {
     return this._client.get('/api/v2/contacts/count', options);
   }
 
+  /**
+   * Opt a contact out (or back in) from receiving messages. When a recipient is
+   * opted out, outbound messages to that number will be blocked.
+   *
+   * Pass `opted_out: false` to opt a contact back in.
+   *
+   * @example
+   * ```ts
+   * const response = await client.contacts.optOut({
+   *   number: '+14155551234',
+   * });
+   * ```
+   */
+  optOut(body: ContactOptOutParams, options?: RequestOptions): APIPromise<ContactOptOutResponse> {
+    return this._client.post('/api/v2/contacts/opt-out', { body, ...options });
+  }
+
   /**
    * Send a verification message to a contact
    *
@@ -142,6 +160,11 @@ export interface Contact {
    */
   last_name?: string;
 
+  /**
+   * Whether the contact has opted out of SMS (from recipient opt-out state)
+   */
+  opt_out?: boolean;
+
   /**
    * Phone number in E.164 format
    */
@@ -194,6 +217,20 @@ export interface ContactCountResponse {
   count?: number;
 }
 
+export interface ContactOptOutResponse {
+  /**
+   * The normalized phone number
+   */
+  number?: string;
+
+  /**
+   * The current opt-out status
+   */
+  opted_out?: boolean;
+
+  status?: string;
+}
+
 export interface ContactVerifyResponse {
   status?: string;
 }
@@ -317,6 +354,17 @@ export interface ContactUpdateParams {
    */
   lastName?: string;
 
+  /**
+   * Whether the contact has opted out of SMS (updates the same recipient record used
+   * for inbound keyword opt-outs)
+   */
+  opt_out?: boolean;
+
+  /**
+   * @deprecated Deprecated, use opt_out
+   */
+  optOut?: boolean;
+
   /**
    * Associated Sendblue phone number (preferred)
    */
@@ -362,6 +410,18 @@ export interface ContactListParams {
   phone_number?: string;
 }
 
+export interface ContactOptOutParams {
+  /**
+   * Phone number in E.164 format
+   */
+  number: string;
+
+  /**
+   * Set to false to opt the contact back in (defaults to true)
+   */
+  opted_out?: boolean;
+}
+
 export interface ContactVerifyParams {
   /**
    * Phone number to verify
@@ -380,10 +440,12 @@ export declare namespace Contacts {
     type ContactListResponse as ContactListResponse,
     type ContactDeleteResponse as ContactDeleteResponse,
     type ContactCountResponse as ContactCountResponse,
+    type ContactOptOutResponse as ContactOptOutResponse,
     type ContactVerifyResponse as ContactVerifyResponse,
     type ContactCreateParams as ContactCreateParams,
     type ContactUpdateParams as ContactUpdateParams,
     type ContactListParams as ContactListParams,
+    type ContactOptOutParams as ContactOptOutParams,
     type ContactVerifyParams as ContactVerifyParams,
   };
 

package/src/resources/contacts/index.ts

@@ -16,9 +16,11 @@ export {
   type ContactListResponse,
   type ContactDeleteResponse,
   type ContactCountResponse,
+  type ContactOptOutResponse,
   type ContactVerifyResponse,
   type ContactCreateParams,
   type ContactUpdateParams,
   type ContactListParams,
+  type ContactOptOutParams,
   type ContactVerifyParams,
 } from './contacts';

package/src/resources/index.ts

@@ -9,10 +9,12 @@ export {
   type ContactListResponse,
   type ContactDeleteResponse,
   type ContactCountResponse,
+  type ContactOptOutResponse,
   type ContactVerifyResponse,
   type ContactCreateParams,
   type ContactUpdateParams,
   type ContactListParams,
+  type ContactOptOutParams,
   type ContactVerifyParams,
 } from './contacts/contacts';
 export {
@@ -33,6 +35,7 @@ export {
   type MessageGetStatusParams,
   type MessageSendParams,
 } from './messages';
+export { SendCarousel, type SendCarouselSendResponse, type SendCarouselSendParams } from './send-carousel';
 export {
   TypingIndicators,
   type TypingIndicatorSendResponse,

package/src/resources/send-carousel.ts

@@ -0,0 +1,117 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Operations for sending and managing messages
+ */
+export class SendCarousel extends APIResource {
+  /**
+   * Send a carousel of images to a single recipient. Requires a V2 (Mac Mini) line.
+   * The carousel must contain between 2 and 20 HTTPS image URLs. For sending a
+   * single image, use `/api/send-message` with `media_url` instead.
+   *
+   * @example
+   * ```ts
+   * const response = await client.sendCarousel.send({
+   *   from_number: '+19998887777',
+   *   media_urls: [
+   *     'https://example.com/image1.jpg',
+   *     'https://example.com/image2.jpg',
+   *     'https://example.com/image3.jpg',
+   *   ],
+   *   number: '+19998887777',
+   * });
+   * ```
+   */
+  send(body: SendCarouselSendParams, options?: RequestOptions): APIPromise<SendCarouselSendResponse> {
+    return this._client.post('/api/send-carousel', { body, ...options });
+  }
+}
+
+export interface SendCarouselSendResponse {
+  /**
+   * Email of the account that sent the message
+   */
+  accountEmail?: string;
+
+  /**
+   * Sending phone number
+   */
+  from_number?: string;
+
+  is_outbound?: boolean;
+
+  /**
+   * First media URL from the carousel
+   */
+  media_url?: string;
+
+  /**
+   * Unique identifier for tracking the message
+   */
+  message_handle?: string;
+
+  message_type?: string;
+
+  /**
+   * Recipient phone number
+   */
+  number?: string;
+
+  status?: string;
+}
+
+export interface SendCarouselSendParams {
+  /**
+   * Your Sendblue phone number in E.164 format (must be a V2/Mac Mini line)
+   */
+  from_number: string;
+
+  /**
+   * Array of HTTPS image URLs to send as a carousel (2-20 items)
+   */
+  media_urls: Array<string>;
+
+  /**
+   * Recipient phone number in E.164 format
+   */
+  number: string;
+
+  /**
+   * Additional metadata to attach to the message
+   */
+  metadata?: unknown;
+
+  /**
+   * The iMessage expressive message style
+   */
+  send_style?:
+    | 'celebration'
+    | 'shooting_star'
+    | 'fireworks'
+    | 'lasers'
+    | 'love'
+    | 'confetti'
+    | 'balloons'
+    | 'spotlight'
+    | 'echo'
+    | 'invisible'
+    | 'gentle'
+    | 'loud'
+    | 'slam';
+
+  /**
+   * Webhook URL for message status updates
+   */
+  status_callback?: string;
+}
+
+export declare namespace SendCarousel {
+  export {
+    type SendCarouselSendResponse as SendCarouselSendResponse,
+    type SendCarouselSendParams as SendCarouselSendParams,
+  };
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '3.3.1'; // x-release-please-version
+export const VERSION = '3.6.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "3.3.1";
+export declare const VERSION = "3.6.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 = '3.3.1'; // x-release-please-version
+exports.VERSION = '3.6.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

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