sendblue 1.1.9 → 2.0.1

package/src/resources/contacts/bulk.ts

@@ -0,0 +1,85 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as ContactsAPI from './contacts';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+
+export class Bulk extends APIResource {
+  /**
+   * Create multiple contacts in bulk
+   *
+   * @example
+   * ```ts
+   * const bulk = await client.contacts.bulk.create({
+   *   contacts: [{ phone: 'phone' }],
+   * });
+   * ```
+   */
+  create(body: BulkCreateParams, options?: RequestOptions): APIPromise<BulkCreateResponse> {
+    return this._client.post('/api/v2/contacts/bulk', { body, ...options });
+  }
+
+  /**
+   * Delete multiple contacts by their IDs
+   *
+   * @example
+   * ```ts
+   * const bulk = await client.contacts.bulk.delete({
+   *   contact_ids: ['+1234567890', '+0987654321'],
+   * });
+   * ```
+   */
+  delete(body: BulkDeleteParams, options?: RequestOptions): APIPromise<BulkDeleteResponse> {
+    return this._client.delete('/api/v2/contacts', { body, ...options });
+  }
+}
+
+export interface BulkCreateResponse {
+  contacts?: Array<ContactsAPI.Contact>;
+
+  status?: string;
+}
+
+export interface BulkDeleteResponse {
+  /**
+   * Number of contacts deleted
+   */
+  amount?: number;
+
+  status?: string;
+}
+
+export interface BulkCreateParams {
+  contacts: Array<BulkCreateParams.Contact>;
+}
+
+export namespace BulkCreateParams {
+  export interface Contact {
+    phone: string;
+
+    company?: string;
+
+    firstName?: string;
+
+    lastName?: string;
+
+    tags?: Array<string>;
+  }
+}
+
+export interface BulkDeleteParams {
+  /**
+   * Array of phone numbers in E.164 format to delete
+   */
+  contact_ids: Array<string>;
+}
+
+export declare namespace Bulk {
+  export {
+    type BulkCreateResponse as BulkCreateResponse,
+    type BulkDeleteResponse as BulkDeleteResponse,
+    type BulkCreateParams as BulkCreateParams,
+    type BulkDeleteParams as BulkDeleteParams,
+  };
+}

package/src/resources/contacts/contacts.ts

@@ -0,0 +1,338 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as BulkAPI from './bulk';
+import { Bulk, BulkCreateParams, BulkCreateResponse, BulkDeleteParams, BulkDeleteResponse } from './bulk';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Contacts extends APIResource {
+  bulk: BulkAPI.Bulk = new BulkAPI.Bulk(this._client);
+
+  /**
+   * Create a new contact or update existing if update_if_exists is true
+   *
+   * @example
+   * ```ts
+   * const contact = await client.contacts.create({
+   *   number: 'number',
+   * });
+   * ```
+   */
+  create(body: ContactCreateParams, options?: RequestOptions): APIPromise<ContactCreateResponse> {
+    return this._client.post('/api/v2/contacts', { body, ...options });
+  }
+
+  /**
+   * Retrieve a specific contact by phone number
+   *
+   * @example
+   * ```ts
+   * const contact = await client.contacts.retrieve(
+   *   '+1234567890',
+   * );
+   * ```
+   */
+  retrieve(phoneNumber: string, options?: RequestOptions): APIPromise<ContactRetrieveResponse> {
+    return this._client.get(path`/api/v2/contacts/${phoneNumber}`, options);
+  }
+
+  /**
+   * Update an existing contact
+   *
+   * @example
+   * ```ts
+   * const contact = await client.contacts.update('+1234567890');
+   * ```
+   */
+  update(
+    phoneNumber: string,
+    body: ContactUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ContactUpdateResponse> {
+    return this._client.put(path`/api/v2/contacts/${phoneNumber}`, { body, ...options });
+  }
+
+  /**
+   * Retrieve a list of contacts for the authenticated account
+   *
+   * @example
+   * ```ts
+   * const contacts = await client.contacts.list();
+   * ```
+   */
+  list(
+    query: ContactListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ContactListResponse> {
+    return this._client.get('/api/v2/contacts', { query, ...options });
+  }
+
+  /**
+   * Delete a specific contact
+   *
+   * @example
+   * ```ts
+   * const contact = await client.contacts.delete('+1234567890');
+   * ```
+   */
+  delete(phoneNumber: string, options?: RequestOptions): APIPromise<ContactDeleteResponse> {
+    return this._client.delete(path`/api/v2/contacts/${phoneNumber}`, options);
+  }
+
+  /**
+   * Get the total number of contacts
+   *
+   * @example
+   * ```ts
+   * const response = await client.contacts.count();
+   * ```
+   */
+  count(options?: RequestOptions): APIPromise<ContactCountResponse> {
+    return this._client.get('/api/v2/contacts/count', options);
+  }
+
+  /**
+   * Send a verification message to a contact
+   *
+   * @example
+   * ```ts
+   * const response = await client.contacts.verify({
+   *   number: 'number',
+   * });
+   * ```
+   */
+  verify(body: ContactVerifyParams, options?: RequestOptions): APIPromise<ContactVerifyResponse> {
+    return this._client.post('/api/v2/contacts/verify', { body, ...options });
+  }
+}
+
+export interface Contact {
+  /**
+   * Email of assigned user
+   */
+  assignedToEmail?: string;
+
+  /**
+   * Company name
+   */
+  companyName?: string;
+
+  /**
+   * When the contact was created
+   */
+  created_at?: string;
+
+  /**
+   * First name
+   */
+  firstName?: string;
+
+  /**
+   * Last name
+   */
+  lastName?: string;
+
+  /**
+   * Phone number in E.164 format
+   */
+  phone?: string;
+
+  /**
+   * Associated Sendblue phone number
+   */
+  sendblueNumber?: string;
+
+  /**
+   * Tags associated with the contact
+   */
+  tags?: Array<string>;
+
+  /**
+   * Whether the contact is verified
+   */
+  verified?: boolean;
+}
+
+export interface ContactCreateResponse {
+  contact?: Contact;
+
+  status?: string;
+}
+
+export interface ContactRetrieveResponse {
+  contact?: Contact;
+
+  status?: string;
+}
+
+export interface ContactUpdateResponse {
+  contact?: Contact;
+
+  status?: string;
+}
+
+export type ContactListResponse = Array<Contact>;
+
+export interface ContactDeleteResponse {
+  status?: string;
+}
+
+export interface ContactCountResponse {
+  /**
+   * Total number of contacts
+   */
+  count?: number;
+}
+
+export interface ContactVerifyResponse {
+  status?: string;
+}
+
+export interface ContactCreateParams {
+  /**
+   * Contact's phone number in E.164 format
+   */
+  number: string;
+
+  /**
+   * Email of assigned user
+   */
+  assigned_to_email?: string;
+
+  /**
+   * Email of assigned user (alternative)
+   */
+  assignedToEmail?: string;
+
+  /**
+   * Contact's first name
+   */
+  first_name?: string;
+
+  /**
+   * Contact's first name (alternative)
+   */
+  firstName?: string;
+
+  /**
+   * Contact's last name
+   */
+  last_name?: string;
+
+  /**
+   * Contact's last name (alternative)
+   */
+  lastName?: string;
+
+  /**
+   * Contact's phone number (alternative)
+   */
+  phone_number?: string;
+
+  /**
+   * Contact's phone number (alternative)
+   */
+  phoneNumber?: string;
+
+  /**
+   * Associated Sendblue phone number
+   */
+  sendblue_number?: string;
+
+  /**
+   * Associated Sendblue phone number (alternative)
+   */
+  sendblueNumber?: string;
+
+  /**
+   * Tags for the contact
+   */
+  tags?: Array<string>;
+
+  /**
+   * If true, updates the contact if it already exists
+   */
+  update_if_exists?: boolean;
+}
+
+export interface ContactUpdateParams {
+  assignedToEmail?: string;
+
+  companyName?: string;
+
+  firstName?: string;
+
+  lastName?: string;
+
+  sendblueNumber?: string;
+
+  tags?: Array<string>;
+}
+
+export interface ContactListParams {
+  /**
+   * Filter by contact ID
+   */
+  cid?: string;
+
+  /**
+   * Maximum number of contacts to return
+   */
+  limit?: number;
+
+  /**
+   * Number of contacts to skip
+   */
+  offset?: number;
+
+  /**
+   * Field to sort by
+   */
+  order_by?: string;
+
+  /**
+   * Sort direction
+   */
+  order_direction?: 'asc' | 'desc';
+
+  /**
+   * Filter by phone number
+   */
+  phone_number?: string;
+}
+
+export interface ContactVerifyParams {
+  /**
+   * Phone number to verify
+   */
+  number: string;
+}
+
+Contacts.Bulk = Bulk;
+
+export declare namespace Contacts {
+  export {
+    type Contact as Contact,
+    type ContactCreateResponse as ContactCreateResponse,
+    type ContactRetrieveResponse as ContactRetrieveResponse,
+    type ContactUpdateResponse as ContactUpdateResponse,
+    type ContactListResponse as ContactListResponse,
+    type ContactDeleteResponse as ContactDeleteResponse,
+    type ContactCountResponse as ContactCountResponse,
+    type ContactVerifyResponse as ContactVerifyResponse,
+    type ContactCreateParams as ContactCreateParams,
+    type ContactUpdateParams as ContactUpdateParams,
+    type ContactListParams as ContactListParams,
+    type ContactVerifyParams as ContactVerifyParams,
+  };
+
+  export {
+    Bulk as Bulk,
+    type BulkCreateResponse as BulkCreateResponse,
+    type BulkDeleteResponse as BulkDeleteResponse,
+    type BulkCreateParams as BulkCreateParams,
+    type BulkDeleteParams as BulkDeleteParams,
+  };
+}

package/src/resources/contacts/index.ts

@@ -0,0 +1,24 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Bulk,
+  type BulkCreateResponse,
+  type BulkDeleteResponse,
+  type BulkCreateParams,
+  type BulkDeleteParams,
+} from './bulk';
+export {
+  Contacts,
+  type Contact,
+  type ContactCreateResponse,
+  type ContactRetrieveResponse,
+  type ContactUpdateResponse,
+  type ContactListResponse,
+  type ContactDeleteResponse,
+  type ContactCountResponse,
+  type ContactVerifyResponse,
+  type ContactCreateParams,
+  type ContactUpdateParams,
+  type ContactListParams,
+  type ContactVerifyParams,
+} from './contacts';

package/src/resources/contacts.ts

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

package/src/resources/groups.ts

@@ -0,0 +1,102 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as MessagesAPI from './messages';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Groups extends APIResource {
+  /**
+   * Add or manage participants in a group chat (beta feature)
+   *
+   * @example
+   * ```ts
+   * const response = await client.groups.modify({
+   *   group_id: 'group_123456',
+   *   modify_type: 'add_recipient',
+   *   number: '+19998887777',
+   * });
+   * ```
+   */
+  modify(body: GroupModifyParams, options?: RequestOptions): APIPromise<GroupModifyResponse> {
+    return this._client.post('/api/modify-group', { body, ...options });
+  }
+
+  /**
+   * Send a message to a group of recipients (beta feature)
+   *
+   * @example
+   * ```ts
+   * const messageResponse = await client.groups.sendMessage({
+   *   content: 'Hello, everyone!',
+   *   from_number: '+19998887777',
+   * });
+   * ```
+   */
+  sendMessage(
+    body: GroupSendMessageParams,
+    options?: RequestOptions,
+  ): APIPromise<MessagesAPI.MessageResponse> {
+    return this._client.post('/api/send-group-message', { body, ...options });
+  }
+}
+
+export interface GroupModifyResponse {
+  message?: string;
+
+  status?: string;
+}
+
+export interface GroupModifyParams {
+  /**
+   * Group identifier
+   */
+  group_id: string;
+
+  /**
+   * Type of modification to perform
+   */
+  modify_type: 'add_recipient';
+
+  /**
+   * Phone number to add/modify in E.164 format
+   */
+  number: string;
+}
+
+export interface GroupSendMessageParams {
+  /**
+   * Message text content
+   */
+  content: string;
+
+  /**
+   * **REQUIRED** - The phone number to send from. Must be one of your registered
+   * Sendblue phone numbers in E.164 format. Without this parameter, the message will
+   * fail to send.
+   */
+  from_number: string;
+
+  /**
+   * Unique identifier for an existing group
+   */
+  group_id?: string;
+
+  /**
+   * URL of media file to send
+   */
+  media_url?: string;
+
+  /**
+   * Array of recipient phone numbers in E.164 format
+   */
+  numbers?: Array<string>;
+}
+
+export declare namespace Groups {
+  export {
+    type GroupModifyResponse as GroupModifyResponse,
+    type GroupModifyParams as GroupModifyParams,
+    type GroupSendMessageParams as GroupSendMessageParams,
+  };
+}

package/src/resources/index.ts

@@ -0,0 +1,40 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Contacts,
+  type Contact,
+  type ContactCreateResponse,
+  type ContactRetrieveResponse,
+  type ContactUpdateResponse,
+  type ContactListResponse,
+  type ContactDeleteResponse,
+  type ContactCountResponse,
+  type ContactVerifyResponse,
+  type ContactCreateParams,
+  type ContactUpdateParams,
+  type ContactListParams,
+  type ContactVerifyParams,
+} from './contacts/contacts';
+export {
+  Groups,
+  type GroupModifyResponse,
+  type GroupModifyParams,
+  type GroupSendMessageParams,
+} from './groups';
+export { Lookups, type LookupLookupNumberResponse, type LookupLookupNumberParams } from './lookups';
+export { MediaObjects, type MediaObjectUploadResponse, type MediaObjectUploadParams } from './media-objects';
+export {
+  Messages,
+  type MessageContent,
+  type MessageResponse,
+  type MessageRetrieveResponse,
+  type MessageListResponse,
+  type MessageListParams,
+  type MessageGetStatusParams,
+  type MessageSendParams,
+} from './messages';
+export {
+  TypingIndicators,
+  type TypingIndicatorSendResponse,
+  type TypingIndicatorSendParams,
+} from './typing-indicators';

package/src/resources/lookups.ts

@@ -0,0 +1,44 @@
+// 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';
+
+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.
+   */
+  lookupNumber(
+    query: LookupLookupNumberParams,
+    options?: RequestOptions,
+  ): APIPromise<LookupLookupNumberResponse> {
+    return this._client.get('/api/evaluate-service', { query, ...options });
+  }
+}
+
+export interface LookupLookupNumberResponse {
+  /**
+   * The number you evaluated in E.164 format
+   */
+  number?: string;
+
+  /**
+   * The service the number supports
+   */
+  service?: 'iMessage' | 'SMS';
+}
+
+export interface LookupLookupNumberParams {
+  /**
+   * The number you want to evaluate in E.164 format
+   */
+  number: string;
+}
+
+export declare namespace Lookups {
+  export {
+    type LookupLookupNumberResponse as LookupLookupNumberResponse,
+    type LookupLookupNumberParams as LookupLookupNumberParams,
+  };
+}

package/src/resources/media-objects.ts

@@ -0,0 +1,43 @@
+// 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';
+
+export class MediaObjects extends APIResource {
+  /**
+   * Upload a media file to Sendblue's CDN for use in messages
+   *
+   * @example
+   * ```ts
+   * const response = await client.mediaObjects.upload({
+   *   media_url: 'https://example.com/image.jpg',
+   * });
+   * ```
+   */
+  upload(body: MediaObjectUploadParams, options?: RequestOptions): APIPromise<MediaObjectUploadResponse> {
+    return this._client.post('/api/upload-media-object', { body, ...options });
+  }
+}
+
+export interface MediaObjectUploadResponse {
+  mediaObjectId?: string;
+
+  message?: string;
+
+  status?: string;
+}
+
+export interface MediaObjectUploadParams {
+  /**
+   * URL of the media file to upload
+   */
+  media_url: string;
+}
+
+export declare namespace MediaObjects {
+  export {
+    type MediaObjectUploadResponse as MediaObjectUploadResponse,
+    type MediaObjectUploadParams as MediaObjectUploadParams,
+  };
+}