sendblue 3.10.1 → 3.11.0

package/src/resources/request-location.ts

@@ -0,0 +1,72 @@
+// 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 RequestLocation extends APIResource {
+  /**
+   * Send a Find My location request to an iMessage recipient from a dedicated
+   * Mac-backed Sendblue line. Shared lines cannot initiate location sharing. The
+   * request is queued like a normal outbound iMessage. If the recipient accepts and
+   * shares, the location is delivered later as an inbound `message_type: location`
+   * webhook. Passive inbound location webhooks remain available on shared lines as
+   * part of the iMessage conversation.
+   *
+   * @example
+   * ```ts
+   * const requestLocation = await client.requestLocation.create(
+   *   { from_number: '+18887776666', number: '+19998887777' },
+   * );
+   * ```
+   */
+  create(
+    body: RequestLocationCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<RequestLocationCreateResponse> {
+    return this._client.post('/api/request-location', { body, ...options });
+  }
+}
+
+export interface RequestLocationCreateResponse {
+  message?: string;
+
+  /**
+   * Unique identifier for tracking the request message
+   */
+  message_handle?: string;
+
+  /**
+   * Recipient phone number
+   */
+  number?: string;
+
+  status?: 'QUEUED';
+
+  /**
+   * Unique identifier for tracking the request message
+   */
+  uuid?: string;
+}
+
+export interface RequestLocationCreateParams {
+  /**
+   * Your supported Sendblue number in E.164 format
+   */
+  from_number: string;
+
+  /**
+   * Recipient phone number in E.164 format
+   */
+  number: string;
+}
+
+export declare namespace RequestLocation {
+  export {
+    type RequestLocationCreateResponse as RequestLocationCreateResponse,
+    type RequestLocationCreateParams as RequestLocationCreateParams,
+  };
+}

package/src/resources/send-carousel.ts

@@ -61,7 +61,55 @@ export interface SendCarouselSendResponse {
    */
   number?: string;
 
+  /**
+   * Immediate parent of an iMessage inline reply. The target must belong to the same
+   * account, conversation, and sending line.
+   */
+  reply_to?: SendCarouselSendResponse.ReplyTo;
+
   status?: string;
+
+  /**
+   * Message that originated an iMessage inline-reply thread.
+   */
+  thread_originator?: SendCarouselSendResponse.ThreadOriginator;
+}
+
+export namespace SendCarouselSendResponse {
+  /**
+   * Immediate parent of an iMessage inline reply. The target must belong to the same
+   * account, conversation, and sending line.
+   */
+  export interface ReplyTo {
+    /**
+     * Public handle of the immediate parent message
+     */
+    message_handle: string;
+
+    /**
+     * Advanced override for a known part of a multipart target. Omit this in normal
+     * reply requests and never guess it; requests default to 0. When replying to an
+     * attachment represented by its own webhook, use that webhook's `message_handle`
+     * and omit `part_index` so Sendblue can use the stored authoritative part.
+     * Responses omit it when no authoritative immediate-parent part is available.
+     */
+    part_index?: number;
+  }
+
+  /**
+   * Message that originated an iMessage inline-reply thread.
+   */
+  export interface ThreadOriginator {
+    /**
+     * Public handle of the thread's root message
+     */
+    message_handle: string;
+
+    /**
+     * Opaque Apple thread-originator part descriptor
+     */
+    part?: string;
+  }
 }
 
 export interface SendCarouselSendParams {
@@ -85,6 +133,12 @@ export interface SendCarouselSendParams {
    */
   metadata?: unknown;
 
+  /**
+   * Immediate parent of an iMessage inline reply. The target must belong to the same
+   * account, conversation, and sending line.
+   */
+  reply_to?: SendCarouselSendParams.ReplyTo;
+
   /**
    * Optional. Identifies the seat (user) sending the carousel so it is attributed to
    * a specific rep. Accepts either the seat UUID or the Firebase Auth subject. When
@@ -117,6 +171,28 @@ export interface SendCarouselSendParams {
   status_callback?: string;
 }
 
+export namespace SendCarouselSendParams {
+  /**
+   * Immediate parent of an iMessage inline reply. The target must belong to the same
+   * account, conversation, and sending line.
+   */
+  export interface ReplyTo {
+    /**
+     * Public handle of the immediate parent message
+     */
+    message_handle: string;
+
+    /**
+     * Advanced override for a known part of a multipart target. Omit this in normal
+     * reply requests and never guess it; requests default to 0. When replying to an
+     * attachment represented by its own webhook, use that webhook's `message_handle`
+     * and omit `part_index` so Sendblue can use the stored authoritative part.
+     * Responses omit it when no authoritative immediate-parent part is available.
+     */
+    part_index?: number;
+  }
+}
+
 export declare namespace SendCarousel {
   export {
     type SendCarouselSendResponse as SendCarouselSendResponse,

package/src/resources/v2/groups.ts

@@ -0,0 +1,106 @@
+// 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';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Operations for group messaging (beta)
+ */
+export class Groups extends APIResource {
+  /**
+   * Retrieve the current complete membership for a group owned by the authenticated
+   * account.
+   *
+   * @example
+   * ```ts
+   * const group = await client.v2.groups.retrieve(
+   *   'sb_group_608acc54-d0d7-4b41-8092-9ff6e1e70455',
+   * );
+   * ```
+   */
+  retrieve(groupID: string, options?: RequestOptions): APIPromise<GroupRetrieveResponse> {
+    return this._client.get(path`/api/v2/groups/${groupID}`, options);
+  }
+}
+
+export interface GroupRetrieveResponse {
+  data?: GroupRetrieveResponse.Data;
+
+  status?: string;
+}
+
+export namespace GroupRetrieveResponse {
+  export interface Data {
+    created_at?: string;
+
+    group_id?: string;
+
+    group_name?: string;
+
+    latest_comm_at?: string | null;
+
+    latest_message_id?: string | null;
+
+    /**
+     * Convenience list of resolved participant phone numbers. Participants with
+     * email-only handles remain in participants but are omitted here.
+     */
+    participant_numbers?: Array<string>;
+
+    participants?: Array<Data.Participant>;
+
+    updated_at?: string;
+
+    /**
+     * Worker-local iMessage group identifier when known
+     */
+    worker_group_id?: string | null;
+  }
+
+  export namespace Data {
+    export interface Participant {
+      /**
+       * Contact ID when this participant is linked to a contact
+       */
+      contact_id?: string | null;
+
+      /**
+       * Raw participant handle, usually an E.164 phone number but sometimes an iMessage
+       * email handle
+       */
+      handle?: string | null;
+
+      /**
+       * Contact or seat display name when available
+       */
+      name?: string | null;
+
+      /**
+       * Unique participant row identifier
+       */
+      participant_id?: string;
+
+      /**
+       * Resolved participant phone number, preferring the stored group phone handle and
+       * falling back to contact phone. Email handles remain available in handle.
+       */
+      phone?: string | null;
+
+      /**
+       * Seat ID when this participant is a team member
+       */
+      seat_id?: string | null;
+
+      /**
+       * Participant kind
+       */
+      type?: 'contact' | 'seat';
+    }
+  }
+}
+
+export declare namespace Groups {
+  export { type GroupRetrieveResponse as GroupRetrieveResponse };
+}

package/src/resources/v2/index.ts

@@ -1,5 +1,6 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
+export { Groups, type GroupRetrieveResponse } from './groups';
 export {
   Seats,
   type SeatRetrieveResponse,

package/src/resources/v2/v2.ts

@@ -1,6 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as GroupsAPI from './groups';
+import { GroupRetrieveResponse, Groups } from './groups';
 import * as SeatsAPI from './seats';
 import {
   SeatCountParams,
@@ -16,10 +18,12 @@ import { Totp, TotpGetCodeResponse } from './totp/totp';
 export class V2 extends APIResource {
   totp: TotpAPI.Totp = new TotpAPI.Totp(this._client);
   seats: SeatsAPI.Seats = new SeatsAPI.Seats(this._client);
+  groups: GroupsAPI.Groups = new GroupsAPI.Groups(this._client);
 }
 
 V2.Totp = Totp;
 V2.Seats = Seats;
+V2.Groups = Groups;
 
 export declare namespace V2 {
   export { Totp as Totp, type TotpGetCodeResponse as TotpGetCodeResponse };
@@ -32,4 +36,6 @@ export declare namespace V2 {
     type SeatListParams as SeatListParams,
     type SeatCountParams as SeatCountParams,
   };
+
+  export { Groups as Groups, type GroupRetrieveResponse as GroupRetrieveResponse };
 }

package/src/resources/verified-contacts.ts

@@ -0,0 +1,204 @@
+// 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';
+import { path } from '../internal/utils/path';
+
+/**
+ * Operations for managing verified-contact access to shared iMessage lines
+ */
+export class VerifiedContacts extends APIResource {
+  /**
+   * Creates or returns a verified-contact route for the authenticated account's
+   * shared iMessage line. Pending contacts become verified after the recipient sends
+   * an inbound iMessage or SMS to the returned line phone number.
+   *
+   * @example
+   * ```ts
+   * const verifiedContact =
+   *   await client.verifiedContacts.create({
+   *     phone_number: '+12125550199',
+   *   });
+   * ```
+   */
+  create(
+    body: VerifiedContactCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<VerifiedContactCreateResponse> {
+    return this._client.post('/v3/verified-contacts', { body, ...options });
+  }
+
+  /**
+   * Retrieve one verified-contact route by phone number for the authenticated
+   * account.
+   *
+   * @example
+   * ```ts
+   * const verifiedContact =
+   *   await client.verifiedContacts.retrieve('+12125550199');
+   * ```
+   */
+  retrieve(phoneNumber: string, options?: RequestOptions): APIPromise<VerifiedContactRetrieveResponse> {
+    return this._client.get(path`/v3/verified-contacts/${phoneNumber}`, options);
+  }
+
+  /**
+   * Lists contacts attached to the authenticated account's shared iMessage line.
+   * Contacts start as `pending`; they become `verified` after the recipient sends an
+   * inbound iMessage or SMS to the shared line.
+   *
+   * @example
+   * ```ts
+   * const verifiedContacts =
+   *   await client.verifiedContacts.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<VerifiedContactListResponse> {
+    return this._client.get('/v3/verified-contacts', options);
+  }
+}
+
+export interface VerifiedContactCreateResponse {
+  data?: VerifiedContactCreateResponse.Data;
+}
+
+export namespace VerifiedContactCreateResponse {
+  export interface Data {
+    contact: Data.Contact;
+
+    line: Data.Line | null;
+
+    /**
+     * Null when the contact is already verified
+     */
+    verification_instructions: string | null;
+  }
+
+  export namespace Data {
+    export interface Contact {
+      created_at: string;
+
+      /**
+       * Contact phone number in E.164 format
+       */
+      phone_number: string;
+
+      updated_at: string;
+
+      verification_status: 'pending' | 'verified';
+
+      /**
+       * Whether this contact has completed verification by messaging the shared line
+       */
+      verified: boolean;
+    }
+
+    export interface Line {
+      /**
+       * Shared Sendblue line the contact must message to complete verification
+       */
+      phone_number: string | null;
+
+      type: 'shared';
+    }
+  }
+}
+
+export interface VerifiedContactRetrieveResponse {
+  data?: VerifiedContactRetrieveResponse.Data;
+}
+
+export namespace VerifiedContactRetrieveResponse {
+  export interface Data {
+    contact: Data.Contact | null;
+
+    line: Data.Line | null;
+  }
+
+  export namespace Data {
+    export interface Contact {
+      created_at: string;
+
+      /**
+       * Contact phone number in E.164 format
+       */
+      phone_number: string;
+
+      updated_at: string;
+
+      verification_status: 'pending' | 'verified';
+
+      /**
+       * Whether this contact has completed verification by messaging the shared line
+       */
+      verified: boolean;
+    }
+
+    export interface Line {
+      /**
+       * Shared Sendblue line the contact must message to complete verification
+       */
+      phone_number: string | null;
+
+      type: 'shared';
+    }
+  }
+}
+
+export interface VerifiedContactListResponse {
+  data?: VerifiedContactListResponse.Data;
+}
+
+export namespace VerifiedContactListResponse {
+  export interface Data {
+    contacts: Array<Data.Contact>;
+
+    line: Data.Line | null;
+  }
+
+  export namespace Data {
+    export interface Contact {
+      created_at: string;
+
+      /**
+       * Contact phone number in E.164 format
+       */
+      phone_number: string;
+
+      updated_at: string;
+
+      verification_status: 'pending' | 'verified';
+
+      /**
+       * Whether this contact has completed verification by messaging the shared line
+       */
+      verified: boolean;
+    }
+
+    export interface Line {
+      /**
+       * Shared Sendblue line the contact must message to complete verification
+       */
+      phone_number: string | null;
+
+      type: 'shared';
+    }
+  }
+}
+
+export interface VerifiedContactCreateParams {
+  /**
+   * Contact phone number. E.164 is recommended; US local numbers are accepted.
+   */
+  phone_number: string;
+}
+
+export declare namespace VerifiedContacts {
+  export {
+    type VerifiedContactCreateResponse as VerifiedContactCreateResponse,
+    type VerifiedContactRetrieveResponse as VerifiedContactRetrieveResponse,
+    type VerifiedContactListResponse as VerifiedContactListResponse,
+    type VerifiedContactCreateParams as VerifiedContactCreateParams,
+  };
+}

package/src/resources/verify/index.ts

@@ -0,0 +1,9 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Verifications,
+  type VerificationState,
+  type VerificationListResponse,
+  type VerificationListParams,
+} from './verifications';
+export { Verify } from './verify';

package/src/resources/verify/verifications.ts

@@ -0,0 +1,75 @@
+// 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';
+
+/**
+ * Sendblue Verify issuance and recovery state
+ */
+export class Verifications extends APIResource {
+  /**
+   * Account-scoped verification state used to recover terminal Verify events after
+   * an SSE gap.
+   */
+  list(
+    query: VerificationListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<VerificationListResponse> {
+    return this._client.get('/api/v2/verify/verifications', { query, ...options });
+  }
+}
+
+export interface VerificationState {
+  channel: string;
+
+  date_created: string;
+
+  date_updated: string;
+
+  service_sid: string;
+
+  sid: string;
+
+  status: string;
+
+  date_completed?: string | null;
+
+  to?: string | null;
+}
+
+export interface VerificationListResponse {
+  data: Array<VerificationState>;
+
+  pagination: VerificationListResponse.Pagination;
+
+  status: 'OK';
+}
+
+export namespace VerificationListResponse {
+  export interface Pagination {
+    count?: number;
+
+    has_more?: boolean;
+
+    limit?: number;
+
+    offset?: number;
+  }
+}
+
+export interface VerificationListParams {
+  limit?: number;
+
+  offset?: number;
+
+  updated_at_gte?: string;
+}
+
+export declare namespace Verifications {
+  export {
+    type VerificationState as VerificationState,
+    type VerificationListResponse as VerificationListResponse,
+    type VerificationListParams as VerificationListParams,
+  };
+}

package/src/resources/verify/verify.ts

@@ -0,0 +1,25 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as VerificationsAPI from './verifications';
+import {
+  VerificationListParams,
+  VerificationListResponse,
+  VerificationState,
+  Verifications,
+} from './verifications';
+
+export class Verify extends APIResource {
+  verifications: VerificationsAPI.Verifications = new VerificationsAPI.Verifications(this._client);
+}
+
+Verify.Verifications = Verifications;
+
+export declare namespace Verify {
+  export {
+    Verifications as Verifications,
+    type VerificationState as VerificationState,
+    type VerificationListResponse as VerificationListResponse,
+    type VerificationListParams as VerificationListParams,
+  };
+}

package/src/resources/verify.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './verify/index';