sendblue 3.12.0 → 3.13.0

package/src/resources/v2/groups.ts

@@ -1,106 +1,3 @@
 // 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 };
-}
+export * from './groups/index';

package/src/resources/v2/index.ts

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

package/src/resources/v2/v2.ts

@@ -1,8 +1,6 @@
 // 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,
@@ -12,6 +10,8 @@ import {
   SeatRetrieveResponse,
   Seats,
 } from './seats';
+import * as GroupsAPI from './groups/groups';
+import { GroupRetrieveResponse, Groups } from './groups/groups';
 import * as TotpAPI from './totp/totp';
 import { Totp, TotpGetCodeResponse } from './totp/totp';
 

package/src/resources/verify/index.ts

@@ -3,7 +3,13 @@
 export {
   Verifications,
   type VerificationState,
+  type DeliveryTarget,
+  type HostedVerification,
+  type VerificationCreateResponse,
+  type VerificationRetrieveResponse,
   type VerificationListResponse,
+  type VerificationCreateParams,
+  type VerificationRetrieveParams,
   type VerificationListParams,
 } from './verifications';
 export { Verify } from './verify';

package/src/resources/verify/verifications.ts

@@ -3,14 +3,78 @@
 import { APIResource } from '../../core/resource';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
 
 /**
  * Sendblue Verify issuance and recovery state
  */
 export class Verifications extends APIResource {
+  /**
+   * Creates an inverted-OTP verification for the supplied E.164 phone number. The
+   * user must send the returned code from that exact phone number to the returned
+   * Sendblue destination number.
+   *
+   * Include `hosted` to create an origin-bound Hosted Verify widget session.
+   * Sendblue API credentials must remain on the customer's backend; only the
+   * returned `hosted` values may be sent to the browser. Twilio-compatible clients
+   * may alternatively send the API Key ID and API Secret Key with HTTP Basic
+   * authentication. Temporary bearer authentication is supported for account-scoped
+   * tokens; line-scoped temporary tokens cannot create account-wide Verifications.
+   *
+   * @example
+   * ```ts
+   * const verification =
+   *   await client.verify.verifications.create(
+   *     'SVE1CB97d8EBbDbaAae6d9B1ca0D1cFaAD',
+   *     { to: '+14155551212' },
+   *   );
+   * ```
+   */
+  create(
+    serviceSid: string,
+    body: VerificationCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<VerificationCreateResponse> {
+    return this._client.post(path`/api/v2/verify/services/${serviceSid}/verifications`, { body, ...options });
+  }
+
+  /**
+   * Returns the authoritative status for one Verification owned by the authenticated
+   * account. Twilio-compatible clients may send the API Key ID and API Secret Key
+   * with HTTP Basic authentication. Temporary bearer authentication is supported for
+   * account-scoped tokens; line-scoped temporary tokens cannot retrieve account-wide
+   * Verification state.
+   *
+   * @example
+   * ```ts
+   * const verification =
+   *   await client.verify.verifications.retrieve(
+   *     'VRE1CB97d8EBbDbaAae6d9B1ca0D1cFaAD',
+   *     { service_sid: 'SVE1CB97d8EBbDbaAae6d9B1ca0D1cFaAD' },
+   *   );
+   * ```
+   */
+  retrieve(
+    verificationSid: string,
+    params: VerificationRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<VerificationRetrieveResponse> {
+    const { service_sid } = params;
+    return this._client.get(
+      path`/api/v2/verify/services/${service_sid}/verifications/${verificationSid}`,
+      options,
+    );
+  }
+
   /**
    * Account-scoped verification state used to recover terminal Verify events after
    * an SSE gap.
+   *
+   * @example
+   * ```ts
+   * const verifications =
+   *   await client.verify.verifications.list();
+   * ```
    */
   list(
     query: VerificationListParams | null | undefined = {},
@@ -38,6 +102,117 @@ export interface VerificationState {
   to?: string | null;
 }
 
+export interface DeliveryTarget {
+  /**
+   * Code the expected sender must text to `pool_number`.
+   */
+  code: string;
+
+  /**
+   * Sendblue phone number that should receive the verification code.
+   */
+  pool_number: string;
+
+  /**
+   * Messages/SMS deep link with the destination and code prefilled.
+   */
+  sms_deep_link: string;
+}
+
+export interface HostedVerification {
+  /**
+   * Web-component script URL. Load this value exactly as returned.
+   */
+  component_script: string;
+
+  /**
+   * ISO timestamp when the Verification expires.
+   */
+  expires_at: string;
+
+  /**
+   * Hosted widget session identifier.
+   */
+  session_id: string;
+
+  /**
+   * Origin-bound widget URL containing a one-session bearer token in its fragment.
+   * Do not log, persist, or move the token into a query parameter.
+   */
+  url: string;
+}
+
+export interface VerificationCreateResponse {
+  account_sid: string;
+
+  channel: 'imessage';
+
+  date_created: string;
+
+  date_updated: string;
+
+  /**
+   * ISO timestamp when the Verification expires.
+   */
+  expires_at: string;
+
+  service_sid: string;
+
+  sid: string;
+
+  status: 'pending' | 'approved' | 'expired' | 'canceled';
+
+  /**
+   * Expected sender in E.164 format; older durable terminal records may return null.
+   */
+  to: string | null;
+
+  url: string;
+
+  /**
+   * Present while the Verification is pending.
+   */
+  delivery_target?: DeliveryTarget;
+
+  /**
+   * Present only when hosted options were supplied during creation.
+   */
+  hosted?: HostedVerification;
+}
+
+export interface VerificationRetrieveResponse {
+  account_sid: string;
+
+  channel: 'imessage';
+
+  date_created: string;
+
+  date_updated: string;
+
+  /**
+   * ISO timestamp when the Verification expires.
+   */
+  expires_at: string;
+
+  service_sid: string;
+
+  sid: string;
+
+  status: 'pending' | 'approved' | 'expired' | 'canceled';
+
+  /**
+   * Expected sender in E.164 format; older durable terminal records may return null.
+   */
+  to: string | null;
+
+  url: string;
+
+  /**
+   * Present while the Verification is pending.
+   */
+  delivery_target?: DeliveryTarget;
+}
+
 export interface VerificationListResponse {
   data: Array<VerificationState>;
 
@@ -58,6 +233,58 @@ export namespace VerificationListResponse {
   }
 }
 
+export interface VerificationCreateParams {
+  /**
+   * E.164 phone number that must send the verification message.
+   */
+  to: string;
+
+  /**
+   * Options for an origin-bound Hosted Verify widget session. Nested keys are strict
+   * snake_case. `parent_origin` must be an exact HTTPS origin with a DNS hostname.
+   * `127.0.0.1` is also accepted, and HTTP is allowed only for `localhost` or
+   * `127.0.0.1` development origins. Wildcards and other IP literals are rejected
+   * because browsers cannot enforce them as exact CSP `frame-ancestors` sources.
+   */
+  hosted?: VerificationCreateParams.Hosted;
+}
+
+export namespace VerificationCreateParams {
+  /**
+   * Options for an origin-bound Hosted Verify widget session. Nested keys are strict
+   * snake_case. `parent_origin` must be an exact HTTPS origin with a DNS hostname.
+   * `127.0.0.1` is also accepted, and HTTP is allowed only for `localhost` or
+   * `127.0.0.1` development origins. Wildcards and other IP literals are rejected
+   * because browsers cannot enforce them as exact CSP `frame-ancestors` sources.
+   */
+  export interface Hosted {
+    /**
+     * Exact website origin allowed to embed the widget, with no path, query, or
+     * fragment.
+     */
+    parent_origin: string;
+
+    /**
+     * Six-digit hexadecimal accent color.
+     */
+    accent_color?: string;
+
+    /**
+     * Brand name displayed by the widget. Defaults to Sendblue.
+     */
+    brand_name?: string;
+
+    theme?: 'light' | 'dark' | 'auto';
+  }
+}
+
+export interface VerificationRetrieveParams {
+  /**
+   * Verify Service SID.
+   */
+  service_sid: string;
+}
+
 export interface VerificationListParams {
   limit?: number;
 
@@ -69,7 +296,13 @@ export interface VerificationListParams {
 export declare namespace Verifications {
   export {
     type VerificationState as VerificationState,
+    type DeliveryTarget as DeliveryTarget,
+    type HostedVerification as HostedVerification,
+    type VerificationCreateResponse as VerificationCreateResponse,
+    type VerificationRetrieveResponse as VerificationRetrieveResponse,
     type VerificationListResponse as VerificationListResponse,
+    type VerificationCreateParams as VerificationCreateParams,
+    type VerificationRetrieveParams as VerificationRetrieveParams,
     type VerificationListParams as VerificationListParams,
   };
 }

package/src/resources/verify/verify.ts

@@ -3,8 +3,14 @@
 import { APIResource } from '../../core/resource';
 import * as VerificationsAPI from './verifications';
 import {
+  DeliveryTarget,
+  HostedVerification,
+  VerificationCreateParams,
+  VerificationCreateResponse,
   VerificationListParams,
   VerificationListResponse,
+  VerificationRetrieveParams,
+  VerificationRetrieveResponse,
   VerificationState,
   Verifications,
 } from './verifications';
@@ -19,7 +25,13 @@ export declare namespace Verify {
   export {
     Verifications as Verifications,
     type VerificationState as VerificationState,
+    type DeliveryTarget as DeliveryTarget,
+    type HostedVerification as HostedVerification,
+    type VerificationCreateResponse as VerificationCreateResponse,
+    type VerificationRetrieveResponse as VerificationRetrieveResponse,
     type VerificationListResponse as VerificationListResponse,
+    type VerificationCreateParams as VerificationCreateParams,
+    type VerificationRetrieveParams as VerificationRetrieveParams,
     type VerificationListParams as VerificationListParams,
   };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '3.12.0'; // x-release-please-version
+export const VERSION = '3.13.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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