sendblue 3.16.0 → 3.17.0

package/src/client.ts

@@ -18,7 +18,13 @@ import * as Uploads from './core/uploads';
 import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
 import { AccountEvent, EventStreamParams, Events } from './resources/events';
-import { GroupModifyParams, GroupModifyResponse, GroupSendMessageParams, Groups } from './resources/groups';
+import {
+  GroupModifyParams,
+  GroupModifyResponse,
+  GroupPhoto,
+  GroupSendMessageParams,
+  Groups,
+} from './resources/groups';
 import {
   Location,
   LocationListParams,
@@ -944,6 +950,7 @@ export declare namespace SendblueAPI {
 
   export {
     Groups as Groups,
+    type GroupPhoto as GroupPhoto,
     type GroupModifyResponse as GroupModifyResponse,
     type GroupModifyParams as GroupModifyParams,
     type GroupSendMessageParams as GroupSendMessageParams,

package/src/resources/groups.ts

@@ -49,6 +49,19 @@ export class Groups extends APIResource {
   }
 }
 
+export interface GroupPhoto {
+  /**
+   * Device-verified identifier of the current Apple group photo
+   */
+  photo_guid: string;
+
+  /**
+   * Direct URL for downloading the current photo; anyone with the exact URL can
+   * download it while the image exists
+   */
+  url: string;
+}
+
 export interface GroupModifyResponse {
   error?: string | null;
 
@@ -158,6 +171,7 @@ export namespace GroupSendMessageParams {
 
 export declare namespace Groups {
   export {
+    type GroupPhoto as GroupPhoto,
     type GroupModifyResponse as GroupModifyResponse,
     type GroupModifyParams as GroupModifyParams,
     type GroupSendMessageParams as GroupSendMessageParams,

package/src/resources/index.ts

@@ -21,6 +21,7 @@ export {
 export { Events, type AccountEvent, type EventStreamParams } from './events';
 export {
   Groups,
+  type GroupPhoto,
   type GroupModifyResponse,
   type GroupModifyParams,
   type GroupSendMessageParams,

package/src/resources/lookups.ts

@@ -9,8 +9,13 @@ import { RequestOptions } from '../internal/request-options';
  */
 export class Lookups extends APIResource {
   /**
-   * Determine if a phone number supports iMessage or SMS. Useful for checking if a
-   * number is an iPhone, if it is real, or which provider to use.
+   * Check iMessage support for a phone number or email address. A successful result
+   * does not guarantee delivery. For email addresses, SMS means iMessage was not
+   * detected; it does not mean the address can receive SMS. The from_number query
+   * parameter does not select a sending line for this endpoint. Email results
+   * indicating no iMessage support are not cached. An inconclusive lookup returns a
+   * retryable error. Limit retries and use backoff after an inconclusive response. A
+   * lookup does not guarantee that upstream availability data was freshly refreshed.
    */
   lookupNumber(
     query: LookupLookupNumberParams,
@@ -22,19 +27,19 @@ export class Lookups extends APIResource {
 
 export interface LookupLookupNumberResponse {
   /**
-   * The number you evaluated in E.164 format
+   * The normalized phone number or email address evaluated
    */
   number?: string;
 
   /**
-   * The service the number supports
+   * Whether iMessage support was detected
    */
   service?: 'iMessage' | 'SMS';
 }
 
 export interface LookupLookupNumberParams {
   /**
-   * The number you want to evaluate in E.164 format
+   * The phone number in E.164 format or email address to evaluate
    */
   number: string;
 }

package/src/resources/v2/groups.ts

@@ -1,8 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as GroupsAPI from '../groups';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
+import { maybeMultipartFormRequestOptions } from '../../internal/uploads';
 import { path } from '../../internal/utils/path';
 
 /**
@@ -33,11 +35,17 @@ export class Groups extends APIResource {
    * must be online and support group name changes. Failed requests are not replayed
    * automatically; retrying the same desired state is safe.
    *
+   * By default an eligible Sendblue line in the group is selected automatically.
+   * Pass `from_number` to require a specific Sendblue line: it must have an iMessage
+   * mapping for this group, and if that line cannot act the request fails without
+   * falling back to another line. The success response reports the line that
+   * performed the change as `from_number`.
+   *
    * @example
    * ```ts
    * const response = await client.v2.groups.rename(
    *   'sb_group_608acc54-d0d7-4b41-8092-9ff6e1e70455',
-   *   { name: 'Project Falcon' },
+   *   { group_name: 'Project Falcon' },
    * );
    * ```
    */
@@ -48,6 +56,48 @@ export class Groups extends APIResource {
   ): APIPromise<GroupRenameResponse> {
     return this._client.post(path`/api/v2/groups/${groupID}/name`, { body, ...options });
   }
+
+  /**
+   * Sets the Apple-visible photo of an existing iMessage group and waits for the
+   * Sendblue line to verify the resulting device state. Pass `null` to clear the
+   * photo. A set is verified only when the device-created photo transfer becomes the
+   * chat's current photo; the verified photo is then persisted with the group and
+   * returned on group retrieval with an image URL.
+   *
+   * Set the photo with either a JSON `photo_url` or raw image bytes in the `file`
+   * field of a multipart form. Images must be JPEG, PNG, or GIF, at most 5 MB, and
+   * no more than 25 million aggregate decoded pixels. URL images must use a direct,
+   * publicly resolvable https URL; redirects are not followed. Replacing or clearing
+   * the photo replaces the current stored reference and attempts to delete the
+   * superseded object; no history is exposed through the API. Supported line types
+   * are checked automatically; ineligible lines return `unsupported_line`. Failed
+   * requests are not replayed automatically; retrying the same desired state is
+   * safe.
+   *
+   * By default an eligible Sendblue line in the group is selected automatically.
+   * Pass `from_number` to require a specific Sendblue line: it must have an iMessage
+   * mapping for this group, and if that line cannot act the request fails without
+   * falling back to another line. The success response reports the line that
+   * performed the change as `from_number`.
+   *
+   * @example
+   * ```ts
+   * const response = await client.v2.groups.setPhoto(
+   *   'sb_group_608acc54-d0d7-4b41-8092-9ff6e1e70455',
+   *   { photo_url: 'https://example.com/team-photo.png' },
+   * );
+   * ```
+   */
+  setPhoto(
+    groupID: string,
+    body: GroupSetPhotoParams,
+    options?: RequestOptions,
+  ): APIPromise<GroupSetPhotoResponse> {
+    return this._client.post(
+      path`/api/v2/groups/${groupID}/photo`,
+      maybeMultipartFormRequestOptions({ body, ...options }, this._client),
+    );
+  }
 }
 
 export interface GroupRetrieveResponse {
@@ -64,6 +114,12 @@ export namespace GroupRetrieveResponse {
 
     group_name?: string;
 
+    /**
+     * Device-verified current group photo metadata; null when the group has no
+     * verified photo
+     */
+    group_photo?: GroupsAPI.GroupPhoto | null;
+
     latest_comm_at?: string | null;
 
     latest_message_id?: string | null;
@@ -134,28 +190,79 @@ export interface GroupRenameResponse {
 
 export namespace GroupRenameResponse {
   export interface Data {
+    /**
+     * Sendblue line that performed the change
+     */
+    from_number: string | null;
+
     group_id: string;
 
     /**
      * Device-verified name; empty when cleared
      */
     group_name: string;
+  }
+}
 
-    service: 'iMessage';
+export interface GroupSetPhotoResponse {
+  data: GroupSetPhotoResponse.Data;
+
+  status: 'OK';
+}
+
+export namespace GroupSetPhotoResponse {
+  export interface Data {
+    /**
+     * Sendblue line that performed the change
+     */
+    from_number: string | null;
+
+    group_id: string;
+
+    /**
+     * Device-verified current photo; null after a verified clear
+     */
+    group_photo: GroupsAPI.GroupPhoto | null;
   }
 }
 
 export interface GroupRenameParams {
   /**
-   * New group name, or null/empty string to clear it
+   * New group name; whitespace-only values are rejected, while null or an empty
+   * string clears it
+   */
+  group_name: string | null;
+
+  /**
+   * Sendblue line that must perform the change; it must have an iMessage mapping for
+   * this group, and no other line is used if it cannot act. Omit or pass null for
+   * automatic selection
+   */
+  from_number?: string | null;
+}
+
+export interface GroupSetPhotoParams {
+  /**
+   * Direct, publicly resolvable https URL of the image to set (JPEG, PNG, or GIF, at
+   * most 5 MB and 25 million aggregate decoded pixels; redirects are not followed);
+   * null clears the group photo
+   */
+  photo_url: string | null;
+
+  /**
+   * Sendblue line that must perform the change; it must have an iMessage mapping for
+   * this group, and no other line is used if it cannot act. Omit or pass null for
+   * automatic selection
    */
-  name: string | null;
+  from_number?: string | null;
 }
 
 export declare namespace Groups {
   export {
     type GroupRetrieveResponse as GroupRetrieveResponse,
     type GroupRenameResponse as GroupRenameResponse,
+    type GroupSetPhotoResponse as GroupSetPhotoResponse,
     type GroupRenameParams as GroupRenameParams,
+    type GroupSetPhotoParams as GroupSetPhotoParams,
   };
 }

package/src/resources/v2/index.ts

@@ -4,7 +4,9 @@ export {
   Groups,
   type GroupRetrieveResponse,
   type GroupRenameResponse,
+  type GroupSetPhotoResponse,
   type GroupRenameParams,
+  type GroupSetPhotoParams,
 } from './groups';
 export {
   Seats,

package/src/resources/v2/v2.ts

@@ -2,7 +2,14 @@
 
 import { APIResource } from '../../core/resource';
 import * as GroupsAPI from './groups';
-import { GroupRenameParams, GroupRenameResponse, GroupRetrieveResponse, Groups } from './groups';
+import {
+  GroupRenameParams,
+  GroupRenameResponse,
+  GroupRetrieveResponse,
+  GroupSetPhotoParams,
+  GroupSetPhotoResponse,
+  Groups,
+} from './groups';
 import * as SeatsAPI from './seats';
 import {
   SeatCountParams,
@@ -41,6 +48,8 @@ export declare namespace V2 {
     Groups as Groups,
     type GroupRetrieveResponse as GroupRetrieveResponse,
     type GroupRenameResponse as GroupRenameResponse,
+    type GroupSetPhotoResponse as GroupSetPhotoResponse,
     type GroupRenameParams as GroupRenameParams,
+    type GroupSetPhotoParams as GroupSetPhotoParams,
   };
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '3.16.0'; // x-release-please-version
+export const VERSION = '3.17.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.mjs

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