@sentdm/sentdm 0.3.5

package/src/resources/contacts.ts

@@ -0,0 +1,142 @@
+// 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 Contacts extends APIResource {
+  /**
+   * Retrieves a paginated list of contacts for the authenticated customer. Supports
+   * server-side pagination with configurable page size. The customer ID is extracted
+   * from the authentication token.
+   */
+  list(query: ContactListParams, options?: RequestOptions): APIPromise<ContactListResponse> {
+    return this._client.get('/v2/contacts', { query, ...options });
+  }
+
+  /**
+   * Retrieves a contact by their phone number for the authenticated customer. Phone
+   * number should be in international format (e.g., +1234567890). The customer ID is
+   * extracted from the authentication token.
+   */
+  retrieveByPhone(
+    query: ContactRetrieveByPhoneParams,
+    options?: RequestOptions,
+  ): APIPromise<ContactListItem> {
+    return this._client.get('/v2/contacts/phone', { query, ...options });
+  }
+
+  /**
+   * Retrieves a specific contact by their unique identifier for the authenticated
+   * customer. The customer ID is extracted from the authentication token. Returns
+   * detailed contact information including phone number and creation timestamp.
+   */
+  retrieveID(query: ContactRetrieveIDParams, options?: RequestOptions): APIPromise<ContactListItem> {
+    return this._client.get('/v2/contacts/id', { query, ...options });
+  }
+}
+
+/**
+ * Represents a contact in the customer's contact list
+ */
+export interface ContactListItem {
+  /**
+   * The unique identifier of the contact
+   */
+  id?: string;
+
+  /**
+   * Comma-separated list of available messaging channels for this contact (e.g.,
+   * "sms,whatsapp")
+   */
+  availableChannels?: string;
+
+  /**
+   * The country calling code (e.g., 1 for US/Canada)
+   */
+  countryCode?: string;
+
+  /**
+   * The default messaging channel to use for this contact (e.g., "sms" or
+   * "whatsapp")
+   */
+  defaultChannel?: string;
+
+  /**
+   * The phone number formatted in E.164 standard (e.g., +1234567890)
+   */
+  formatE164?: string;
+
+  /**
+   * The phone number formatted for international dialing (e.g., +1 234-567-890)
+   */
+  formatInternational?: string;
+
+  /**
+   * The phone number formatted for national dialing (e.g., (234) 567-890)
+   */
+  formatNational?: string;
+
+  /**
+   * The phone number formatted according to RFC 3966 (e.g., tel:+1-234-567-890)
+   */
+  formatRfc?: string;
+
+  /**
+   * The phone number in its original format
+   */
+  phoneNumber?: string;
+
+  /**
+   * The ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+   */
+  regionCode?: string;
+}
+
+export interface ContactListResponse {
+  items?: Array<ContactListItem>;
+
+  page?: number;
+
+  pageSize?: number;
+
+  totalCount?: number;
+
+  totalPages?: number;
+}
+
+export interface ContactListParams {
+  /**
+   * The page number (zero-indexed). Default is 0.
+   */
+  page: number;
+
+  /**
+   * The number of items per page. Default is 20.
+   */
+  pageSize: number;
+}
+
+export interface ContactRetrieveByPhoneParams {
+  /**
+   * The phone number in international format (e.g., +1234567890)
+   */
+  phoneNumber: string;
+}
+
+export interface ContactRetrieveIDParams {
+  /**
+   * The unique identifier (GUID) of the resource to retrieve
+   */
+  id: string;
+}
+
+export declare namespace Contacts {
+  export {
+    type ContactListItem as ContactListItem,
+    type ContactListResponse as ContactListResponse,
+    type ContactListParams as ContactListParams,
+    type ContactRetrieveByPhoneParams as ContactRetrieveByPhoneParams,
+    type ContactRetrieveIDParams as ContactRetrieveIDParams,
+  };
+}

package/src/resources/index.ts

@@ -0,0 +1,38 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Contacts,
+  type ContactListItem,
+  type ContactListResponse,
+  type ContactListParams,
+  type ContactRetrieveByPhoneParams,
+  type ContactRetrieveIDParams,
+} from './contacts';
+export {
+  Messages,
+  type MessageRetrieveResponse,
+  type MessageSendQuickMessageParams,
+  type MessageSendToContactParams,
+  type MessageSendToPhoneParams,
+} from './messages';
+export {
+  NumberLookup,
+  type NumberLookupRetrieveResponse,
+  type NumberLookupRetrieveParams,
+} from './number-lookup';
+export {
+  Organizations,
+  type ProfileSummary,
+  type OrganizationListResponse,
+  type OrganizationRetrieveProfilesResponse,
+} from './organizations/organizations';
+export {
+  Templates,
+  type TemplateBodyContent,
+  type TemplateDefinition,
+  type TemplateResponse,
+  type TemplateVariable,
+  type TemplateListResponse,
+  type TemplateCreateParams,
+  type TemplateListParams,
+} from './templates';

package/src/resources/messages.ts

@@ -0,0 +1,283 @@
+// 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 { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Messages extends APIResource {
+  /**
+   * Retrieves comprehensive details about a specific message using the message ID.
+   * Returns complete message data including delivery status, channel information,
+   * template details, contact information, and pricing. The customer ID is extracted
+   * from the authentication token to ensure the message belongs to the authenticated
+   * customer.
+   *
+   * @example
+   * ```ts
+   * const message = await client.messages.retrieve(
+   *   '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<MessageRetrieveResponse> {
+    return this._client.get(path`/v2/messages/${id}`, options);
+  }
+
+  /**
+   * Sends a message to a phone number using the default template. This endpoint is
+   * rate limited to 5 messages per customer per day. The customer ID is extracted
+   * from the authentication token.
+   *
+   * @example
+   * ```ts
+   * await client.messages.sendQuickMessage({
+   *   customMessage: 'Hello, this is a test message!',
+   *   phoneNumber: '+1234567890',
+   * });
+   * ```
+   */
+  sendQuickMessage(body: MessageSendQuickMessageParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post('/v2/messages/quick-message', {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Sends a message to a specific contact using a template. The message can be sent
+   * via SMS or WhatsApp depending on the contact's capabilities. Optionally specify
+   * a webhook URL to receive delivery status updates. The customer ID is extracted
+   * from the authentication token.
+   *
+   * @example
+   * ```ts
+   * await client.messages.sendToContact({
+   *   contactId: '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
+   *   templateId: '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
+   * });
+   * ```
+   */
+  sendToContact(body: MessageSendToContactParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post('/v2/messages/contact', {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Sends a message to a phone number using a template. The phone number doesn't
+   * need to be a pre-existing contact. The message can be sent via SMS or WhatsApp.
+   * Optionally specify a webhook URL to receive delivery status updates. The
+   * customer ID is extracted from the authentication token.
+   *
+   * @example
+   * ```ts
+   * await client.messages.sendToPhone({
+   *   phoneNumber: '+1234567890',
+   *   templateId: '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
+   * });
+   * ```
+   */
+  sendToPhone(body: MessageSendToPhoneParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post('/v2/messages/phone', {
+      body,
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+/**
+ * Represents a sent message with comprehensive delivery and template information
+ * (v2)
+ */
+export interface MessageRetrieveResponse {
+  /**
+   * The unique identifier of the message
+   */
+  id?: string;
+
+  /**
+   * The messaging channel used (e.g., SMS, WhatsApp)
+   */
+  channel?: string;
+
+  /**
+   * The unique identifier of the contact who received the message
+   */
+  contactId?: string;
+
+  /**
+   * The final price charged for sending this message
+   */
+  correctedPrice?: number | null;
+
+  /**
+   * The date and time when the message was created
+   */
+  createdAt?: string;
+
+  /**
+   * The unique identifier of the customer who sent the message
+   */
+  customerId?: string;
+
+  /**
+   * A chronological list of status change events for this message. Each event
+   * includes a status and timestamp, following industry standards (Twilio, SendGrid,
+   * Mailgun). Events are ordered chronologically from oldest to newest.
+   */
+  events?: Array<MessageRetrieveResponse.Event> | null;
+
+  /**
+   * The message body content with variables substituted
+   */
+  messageBody?: MessageRetrieveResponse.MessageBody | null;
+
+  /**
+   * The phone number of the recipient (E.164 format)
+   */
+  phoneNumber?: string;
+
+  /**
+   * The phone number in international format
+   */
+  phoneNumberInternational?: string;
+
+  /**
+   * The region code of the phone number (e.g., US, GB, DE)
+   */
+  regionCode?: string;
+
+  /**
+   * The delivery status of the message (e.g., sent, delivered, failed, read)
+   */
+  status?: string;
+
+  /**
+   * The category of the template (e.g., MARKETING, UTILITY, AUTHENTICATION)
+   */
+  templateCategory?: string;
+
+  /**
+   * The unique identifier of the template used for this message (null if no template
+   * was used)
+   */
+  templateId?: string | null;
+
+  /**
+   * The display name of the template
+   */
+  templateName?: string;
+}
+
+export namespace MessageRetrieveResponse {
+  /**
+   * Represents a status change event in a message's lifecycle Follows industry
+   * standards (Twilio, SendGrid, Mailgun pattern)
+   */
+  export interface Event {
+    /**
+     * Optional human-readable description of the event Useful for error messages or
+     * additional context
+     */
+    description?: string | null;
+
+    /**
+     * The status of the message at this point in time Examples: "queued", "sent",
+     * "delivered", "read", "failed"
+     */
+    status?: string;
+
+    /**
+     * When this status change occurred (ISO 8601 format)
+     */
+    timestamp?: string;
+  }
+
+  /**
+   * The message body content with variables substituted
+   */
+  export interface MessageBody {
+    buttons?: Array<MessageBody.Button> | null;
+
+    content?: string;
+
+    footer?: string | null;
+
+    header?: string | null;
+  }
+
+  export namespace MessageBody {
+    export interface Button {
+      type?: string;
+
+      value?: string;
+    }
+  }
+}
+
+export interface MessageSendQuickMessageParams {
+  /**
+   * The custom message content to include in the template
+   */
+  customMessage: string;
+
+  /**
+   * The phone number to send the message to, in international format (e.g.,
+   * +1234567890)
+   */
+  phoneNumber: string;
+}
+
+export interface MessageSendToContactParams {
+  /**
+   * The unique identifier of the contact to send the message to
+   */
+  contactId: string;
+
+  /**
+   * The unique identifier of the template to use for the message
+   */
+  templateId: string;
+
+  /**
+   * Optional key-value pairs of template variables to replace in the template body.
+   * For example, if your template contains "Hello {{name}}", you would provide {
+   * "name": "John Doe" }
+   */
+  templateVariables?: { [key: string]: string } | null;
+}
+
+export interface MessageSendToPhoneParams {
+  /**
+   * The phone number to send the message to, in international format (e.g.,
+   * +1234567890)
+   */
+  phoneNumber: string;
+
+  /**
+   * The unique identifier of the template to use for the message
+   */
+  templateId: string;
+
+  /**
+   * Optional key-value pairs of template variables to replace in the template body.
+   * For example, if your template contains "Hello {{name}}", you would provide {
+   * "name": "John Doe" }
+   */
+  templateVariables?: { [key: string]: string } | null;
+}
+
+export declare namespace Messages {
+  export {
+    type MessageRetrieveResponse as MessageRetrieveResponse,
+    type MessageSendQuickMessageParams as MessageSendQuickMessageParams,
+    type MessageSendToContactParams as MessageSendToContactParams,
+    type MessageSendToPhoneParams as MessageSendToPhoneParams,
+  };
+}

package/src/resources/number-lookup.ts

@@ -0,0 +1,80 @@
+// 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 NumberLookup extends APIResource {
+  /**
+   * Retrieves detailed information about a phone number including validation,
+   * formatting, country information, and available messaging channels. The customer
+   * ID is extracted from the authentication token.
+   */
+  retrieve(
+    query: NumberLookupRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<NumberLookupRetrieveResponse> {
+    return this._client.get('/v2/number-lookup', { query, ...options });
+  }
+}
+
+/**
+ * Response containing phone number lookup data
+ */
+export interface NumberLookupRetrieveResponse {
+  /**
+   * The country calling code (e.g., 1 for US/Canada)
+   */
+  countryCode?: string;
+
+  /**
+   * The phone number formatted in E.164 standard (e.g., +1234567890)
+   */
+  formatE164?: string;
+
+  /**
+   * The phone number formatted for international dialing (e.g., +1 234-567-890)
+   */
+  formatInternational?: string;
+
+  /**
+   * The phone number formatted for national dialing (e.g., (234) 567-890)
+   */
+  formatNational?: string;
+
+  /**
+   * The phone number formatted according to RFC 3966 (e.g., tel:+1-234-567-890)
+   */
+  formatRfc?: string;
+
+  /**
+   * The type of phone number (e.g., mobile, fixed_line, voip)
+   */
+  numberType?: string;
+
+  /**
+   * The phone number in its original format
+   */
+  phoneNumber?: string;
+
+  /**
+   * The timezones associated with the phone number
+   */
+  phoneTimezones?: string;
+
+  /**
+   * The ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+   */
+  regionCode?: string;
+}
+
+export interface NumberLookupRetrieveParams {
+  phoneNumber: string;
+}
+
+export declare namespace NumberLookup {
+  export {
+    type NumberLookupRetrieveResponse as NumberLookupRetrieveResponse,
+    type NumberLookupRetrieveParams as NumberLookupRetrieveParams,
+  };
+}

package/src/resources/organizations/index.ts

@@ -0,0 +1,18 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Organizations,
+  type ProfileSummary,
+  type OrganizationListResponse,
+  type OrganizationRetrieveProfilesResponse,
+} from './organizations';
+export {
+  Users,
+  type CustomerUser,
+  type UserListResponse,
+  type UserRetrieveParams,
+  type UserListParams,
+  type UserDeleteParams,
+  type UserInviteParams,
+  type UserUpdateRoleParams,
+} from './users';

package/src/resources/organizations/organizations.ts

@@ -0,0 +1,116 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as OrganizationsAPI from './organizations';
+import * as UsersAPI from './users';
+import {
+  CustomerUser,
+  UserDeleteParams,
+  UserInviteParams,
+  UserListParams,
+  UserListResponse,
+  UserRetrieveParams,
+  UserUpdateRoleParams,
+  Users,
+} from './users';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+export class Organizations extends APIResource {
+  users: UsersAPI.Users = new UsersAPI.Users(this._client);
+
+  /**
+   * Retrieves all organizations that the authenticated user has access to, including
+   * the sender profiles within each organization that the user can access. Returns
+   * organization details with nested profiles filtered by user permissions.
+   *
+   * @example
+   * ```ts
+   * const organizations = await client.organizations.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<OrganizationListResponse> {
+    return this._client.get('/v2/organizations', options);
+  }
+
+  /**
+   * Retrieves all sender profiles within an organization that the authenticated user
+   * has access to. Returns filtered list based on user's permissions.
+   *
+   * @example
+   * ```ts
+   * const response =
+   *   await client.organizations.retrieveProfiles(
+   *     '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
+   *   );
+   * ```
+   */
+  retrieveProfiles(
+    orgID: string,
+    options?: RequestOptions,
+  ): APIPromise<OrganizationRetrieveProfilesResponse> {
+    return this._client.get(path`/v2/organizations/${orgID}/profiles`, options);
+  }
+}
+
+export interface ProfileSummary {
+  id?: string;
+
+  createdAt?: string;
+
+  description?: string | null;
+
+  icon?: string | null;
+
+  name?: string;
+
+  shortName?: string | null;
+}
+
+export interface OrganizationListResponse {
+  organizations?: Array<OrganizationListResponse.Organization>;
+}
+
+export namespace OrganizationListResponse {
+  export interface Organization {
+    id?: string;
+
+    createdAt?: string;
+
+    description?: string | null;
+
+    icon?: string | null;
+
+    name?: string;
+
+    profiles?: Array<OrganizationsAPI.ProfileSummary>;
+  }
+}
+
+export interface OrganizationRetrieveProfilesResponse {
+  organizationId?: string;
+
+  profiles?: Array<ProfileSummary>;
+}
+
+Organizations.Users = Users;
+
+export declare namespace Organizations {
+  export {
+    type ProfileSummary as ProfileSummary,
+    type OrganizationListResponse as OrganizationListResponse,
+    type OrganizationRetrieveProfilesResponse as OrganizationRetrieveProfilesResponse,
+  };
+
+  export {
+    Users as Users,
+    type CustomerUser as CustomerUser,
+    type UserListResponse as UserListResponse,
+    type UserRetrieveParams as UserRetrieveParams,
+    type UserListParams as UserListParams,
+    type UserDeleteParams as UserDeleteParams,
+    type UserInviteParams as UserInviteParams,
+    type UserUpdateRoleParams as UserUpdateRoleParams,
+  };
+}