@sentdm/sentdm 0.7.2 → 0.15.0

package/src/client.ts

@@ -11,41 +11,111 @@ import type { APIResponseProps } from './internal/parse';
 import { getPlatformHeaders } from './internal/detect-platform';
 import * as Shims from './internal/shims';
 import * as Opts from './internal/request-options';
+import { stringifyQuery } from './internal/utils/query';
 import { VERSION } from './version';
 import * as Errors from './core/error';
 import * as Uploads from './core/uploads';
 import * as API from './resources/index';
 import { APIPromise } from './core/api-promise';
 import {
-  ContactListItem,
+  APIResponseOfContact,
+  ContactCreateParams,
+  ContactDeleteParams,
   ContactListParams,
   ContactListResponse,
-  ContactRetrieveByPhoneParams,
-  ContactRetrieveIDParams,
+  ContactResponse,
+  ContactRetrieveParams,
+  ContactUpdateParams,
   Contacts,
 } from './resources/contacts';
+import { Me, MeRetrieveParams, MeRetrieveResponse, ProfileSettings } from './resources/me';
 import {
-  MessageRetrieveResponse,
-  MessageSendQuickMessageParams,
-  MessageSendToContactParams,
-  MessageSendToPhoneParams,
+  MessageRetrieveActivitiesParams,
+  MessageRetrieveActivitiesResponse,
+  MessageRetrieveStatusParams,
+  MessageRetrieveStatusResponse,
+  MessageSendParams,
+  MessageSendResponse,
   Messages,
 } from './resources/messages';
+import { NumberLookupParams, NumberLookupResponse, Numbers } from './resources/numbers';
 import {
-  NumberLookup,
-  NumberLookupRetrieveParams,
-  NumberLookupRetrieveResponse,
-} from './resources/number-lookup';
-import {
+  APIResponseTemplate,
+  SentDmServicesCommonContractsPocOsAuthenticationConfig,
+  SentDmServicesCommonContractsPocOsTemplateBody,
+  SentDmServicesCommonContractsPocOsTemplateButton,
+  SentDmServicesCommonContractsPocOsTemplateButtonProps,
+  SentDmServicesCommonContractsPocOsTemplateFooter,
+  SentDmServicesCommonContractsPocOsTemplateHeader,
+  Template,
   TemplateBodyContent,
   TemplateCreateParams,
   TemplateDefinition,
+  TemplateDeleteParams,
   TemplateListParams,
   TemplateListResponse,
-  TemplateResponseV2,
+  TemplateRetrieveParams,
+  TemplateUpdateParams,
   TemplateVariable,
   Templates,
 } from './resources/templates';
+import {
+  APIResponseOfUser,
+  UserInviteParams,
+  UserListParams,
+  UserListResponse,
+  UserRemoveParams,
+  UserResponse,
+  UserRetrieveParams,
+  UserUpdateRoleParams,
+  Users,
+} from './resources/users';
+import {
+  APIMeta,
+  APIResponseWebhook,
+  ErrorDetail,
+  MutationRequest,
+  PaginationMeta,
+  WebhookCreateParams,
+  WebhookDeleteParams,
+  WebhookListEventTypesParams,
+  WebhookListEventTypesResponse,
+  WebhookListEventsParams,
+  WebhookListEventsResponse,
+  WebhookListParams,
+  WebhookListResponse,
+  WebhookResponse,
+  WebhookRetrieveParams,
+  WebhookRotateSecretParams,
+  WebhookRotateSecretResponse,
+  WebhookTestParams,
+  WebhookTestResponse,
+  WebhookToggleStatusParams,
+  WebhookUpdateParams,
+  Webhooks,
+} from './resources/webhooks';
+import {
+  APIResponseOfProfileDetail,
+  BillingContactInfo,
+  BrandsBrandData,
+  DestinationCountry,
+  PaymentDetails,
+  ProfileCompleteParams,
+  ProfileCompleteResponse,
+  ProfileCreateParams,
+  ProfileDeleteParams,
+  ProfileDetail,
+  ProfileListParams,
+  ProfileListResponse,
+  ProfileRetrieveParams,
+  ProfileUpdateParams,
+  Profiles,
+  SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo,
+  SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo,
+  SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo,
+  TcrBrandRelationship,
+  TcrVertical,
+} from './resources/profiles/profiles';
 import { type Fetch } from './internal/builtin-types';
 import { HeadersLike, NullableHeaders, buildHeaders } from './internal/headers';
 import { FinalRequestOptions, RequestOptions } from './internal/request-options';
@@ -65,11 +135,6 @@ export interface ClientOptions {
    */
   apiKey?: string | undefined;
 
-  /**
-   * Customer sender ID (UUID) identifying the customer account. Obtain this from your account settings. Pass via the `x-sender-id` header.
-   */
-  senderID?: string | undefined;
-
   /**
    * Override the default base URL for the API, e.g., "https://api.example.com/v2/"
    *
@@ -144,7 +209,6 @@ export interface ClientOptions {
  */
 export class SentDm {
   apiKey: string;
-  senderID: string;
 
   baseURL: string;
   maxRetries: number;
@@ -162,7 +226,6 @@ export class SentDm {
    * API Client for interfacing with the Sent Dm API.
    *
    * @param {string | undefined} [opts.apiKey=process.env['SENT_DM_API_KEY'] ?? undefined]
-   * @param {string | undefined} [opts.senderID=process.env['SENT_DM_SENDER_ID'] ?? undefined]
    * @param {string} [opts.baseURL=process.env['SENT_DM_BASE_URL'] ?? https://api.sent.dm] - Override the default base URL for the API.
    * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out.
    * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls.
@@ -174,7 +237,6 @@ export class SentDm {
   constructor({
     baseURL = readEnv('SENT_DM_BASE_URL'),
     apiKey = readEnv('SENT_DM_API_KEY'),
-    senderID = readEnv('SENT_DM_SENDER_ID'),
     ...opts
   }: ClientOptions = {}) {
     if (apiKey === undefined) {
@@ -182,15 +244,9 @@ export class SentDm {
         "The SENT_DM_API_KEY environment variable is missing or empty; either provide it, or instantiate the SentDm client with an apiKey option, like new SentDm({ apiKey: 'My API Key' }).",
       );
     }
-    if (senderID === undefined) {
-      throw new Errors.SentDmError(
-        "The SENT_DM_SENDER_ID environment variable is missing or empty; either provide it, or instantiate the SentDm client with an senderID option, like new SentDm({ senderID: 'My Sender ID' }).",
-      );
-    }
 
     const options: ClientOptions = {
       apiKey,
-      senderID,
       ...opts,
       baseURL: baseURL || `https://api.sent.dm`,
     };
@@ -213,7 +269,6 @@ export class SentDm {
     this._options = options;
 
     this.apiKey = apiKey;
-    this.senderID = senderID;
   }
 
   /**
@@ -230,7 +285,6 @@ export class SentDm {
       fetch: this.fetch,
       fetchOptions: this.fetchOptions,
       apiKey: this.apiKey,
-      senderID: this.senderID,
       ...options,
     });
     return client;
@@ -252,35 +306,14 @@ export class SentDm {
   }
 
   protected async authHeaders(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
-    return buildHeaders([await this.customerAPIKeyAuth(opts), await this.customerSenderIDAuth(opts)]);
-  }
-
-  protected async customerAPIKeyAuth(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
     return buildHeaders([{ 'x-api-key': this.apiKey }]);
   }
 
-  protected async customerSenderIDAuth(opts: FinalRequestOptions): Promise<NullableHeaders | undefined> {
-    return buildHeaders([{ 'x-sender-id': this.senderID }]);
-  }
-
   /**
    * Basic re-implementation of `qs.stringify` for primitive types.
    */
-  protected stringifyQuery(query: Record<string, unknown>): string {
-    return Object.entries(query)
-      .filter(([_, value]) => typeof value !== 'undefined')
-      .map(([key, value]) => {
-        if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
-          return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
-        }
-        if (value === null) {
-          return `${encodeURIComponent(key)}=`;
-        }
-        throw new Errors.SentDmError(
-          `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
-        );
-      })
-      .join('&');
+  protected stringifyQuery(query: object | Record<string, unknown>): string {
+    return stringifyQuery(query);
   }
 
   private getUserAgent(): string {
@@ -312,12 +345,13 @@ export class SentDm {
       : new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
 
     const defaultQuery = this.defaultQuery();
-    if (!isEmptyObj(defaultQuery)) {
-      query = { ...defaultQuery, ...query };
+    const pathQuery = Object.fromEntries(url.searchParams);
+    if (!isEmptyObj(defaultQuery) || !isEmptyObj(pathQuery)) {
+      query = { ...pathQuery, ...defaultQuery, ...query };
     }
 
     if (typeof query === 'object' && query && !Array.isArray(query)) {
-      url.search = this.stringifyQuery(query as Record<string, unknown>);
+      url.search = this.stringifyQuery(query);
     }
 
     return url.toString();
@@ -622,9 +656,9 @@ export class SentDm {
       }
     }
 
-    // If the API asks us to wait a certain amount of time (and it's a reasonable amount),
-    // just do what it says, but otherwise calculate a default
-    if (!(timeoutMillis && 0 <= timeoutMillis && timeoutMillis < 60 * 1000)) {
+    // If the API asks us to wait a certain amount of time, just do what it
+    // says, but otherwise calculate a default
+    if (timeoutMillis === undefined) {
       const maxRetries = options.maxRetries ?? this.maxRetries;
       timeoutMillis = this.calculateDefaultRetryTimeoutMillis(retriesRemaining, maxRetries);
     }
@@ -756,7 +790,7 @@ export class SentDm {
     ) {
       return {
         bodyHeaders: { 'content-type': 'application/x-www-form-urlencoded' },
-        body: this.stringifyQuery(body as Record<string, unknown>),
+        body: this.stringifyQuery(body),
       };
     } else {
       return this.#encoder({ body, headers });
@@ -782,51 +816,165 @@ export class SentDm {
 
   static toFile = Uploads.toFile;
 
-  contacts: API.Contacts = new API.Contacts(this);
-  messages: API.Messages = new API.Messages(this);
+  /**
+   * Configure webhook endpoints for real-time event delivery
+   */
+  webhooks: API.Webhooks = new API.Webhooks(this);
+  /**
+   * Invite, update, and manage organization users and roles
+   */
+  users: API.Users = new API.Users(this);
+  /**
+   * Manage message templates with variable substitution
+   */
   templates: API.Templates = new API.Templates(this);
-  numberLookup: API.NumberLookup = new API.NumberLookup(this);
+  /**
+   * Manage organization profiles
+   */
+  profiles: API.Profiles = new API.Profiles(this);
+  /**
+   * Manage and lookup phone numbers
+   */
+  numbers: API.Numbers = new API.Numbers(this);
+  /**
+   * Send and track SMS and WhatsApp messages
+   */
+  messages: API.Messages = new API.Messages(this);
+  /**
+   * Create, update, and manage customer contact lists
+   */
+  contacts: API.Contacts = new API.Contacts(this);
+  /**
+   * Retrieve account details
+   */
+  me: API.Me = new API.Me(this);
 }
 
-SentDm.Contacts = Contacts;
-SentDm.Messages = Messages;
+SentDm.Webhooks = Webhooks;
+SentDm.Users = Users;
 SentDm.Templates = Templates;
-SentDm.NumberLookup = NumberLookup;
+SentDm.Profiles = Profiles;
+SentDm.Numbers = Numbers;
+SentDm.Messages = Messages;
+SentDm.Contacts = Contacts;
+SentDm.Me = Me;
 
 export declare namespace SentDm {
   export type RequestOptions = Opts.RequestOptions;
 
   export {
-    Contacts as Contacts,
-    type ContactListItem as ContactListItem,
-    type ContactListResponse as ContactListResponse,
-    type ContactListParams as ContactListParams,
-    type ContactRetrieveByPhoneParams as ContactRetrieveByPhoneParams,
-    type ContactRetrieveIDParams as ContactRetrieveIDParams,
+    Webhooks as Webhooks,
+    type APIMeta as APIMeta,
+    type APIResponseWebhook as APIResponseWebhook,
+    type ErrorDetail as ErrorDetail,
+    type MutationRequest as MutationRequest,
+    type PaginationMeta as PaginationMeta,
+    type WebhookResponse as WebhookResponse,
+    type WebhookListResponse as WebhookListResponse,
+    type WebhookListEventTypesResponse as WebhookListEventTypesResponse,
+    type WebhookListEventsResponse as WebhookListEventsResponse,
+    type WebhookRotateSecretResponse as WebhookRotateSecretResponse,
+    type WebhookTestResponse as WebhookTestResponse,
+    type WebhookCreateParams as WebhookCreateParams,
+    type WebhookRetrieveParams as WebhookRetrieveParams,
+    type WebhookUpdateParams as WebhookUpdateParams,
+    type WebhookListParams as WebhookListParams,
+    type WebhookDeleteParams as WebhookDeleteParams,
+    type WebhookListEventTypesParams as WebhookListEventTypesParams,
+    type WebhookListEventsParams as WebhookListEventsParams,
+    type WebhookRotateSecretParams as WebhookRotateSecretParams,
+    type WebhookTestParams as WebhookTestParams,
+    type WebhookToggleStatusParams as WebhookToggleStatusParams,
   };
 
   export {
-    Messages as Messages,
-    type MessageRetrieveResponse as MessageRetrieveResponse,
-    type MessageSendQuickMessageParams as MessageSendQuickMessageParams,
-    type MessageSendToContactParams as MessageSendToContactParams,
-    type MessageSendToPhoneParams as MessageSendToPhoneParams,
+    Users as Users,
+    type APIResponseOfUser as APIResponseOfUser,
+    type UserResponse as UserResponse,
+    type UserListResponse as UserListResponse,
+    type UserRetrieveParams as UserRetrieveParams,
+    type UserListParams as UserListParams,
+    type UserInviteParams as UserInviteParams,
+    type UserRemoveParams as UserRemoveParams,
+    type UserUpdateRoleParams as UserUpdateRoleParams,
   };
 
   export {
     Templates as Templates,
+    type APIResponseTemplate as APIResponseTemplate,
+    type SentDmServicesCommonContractsPocOsAuthenticationConfig as SentDmServicesCommonContractsPocOsAuthenticationConfig,
+    type SentDmServicesCommonContractsPocOsTemplateBody as SentDmServicesCommonContractsPocOsTemplateBody,
+    type SentDmServicesCommonContractsPocOsTemplateButton as SentDmServicesCommonContractsPocOsTemplateButton,
+    type SentDmServicesCommonContractsPocOsTemplateButtonProps as SentDmServicesCommonContractsPocOsTemplateButtonProps,
+    type SentDmServicesCommonContractsPocOsTemplateFooter as SentDmServicesCommonContractsPocOsTemplateFooter,
+    type SentDmServicesCommonContractsPocOsTemplateHeader as SentDmServicesCommonContractsPocOsTemplateHeader,
+    type Template as Template,
     type TemplateBodyContent as TemplateBodyContent,
     type TemplateDefinition as TemplateDefinition,
-    type TemplateResponseV2 as TemplateResponseV2,
     type TemplateVariable as TemplateVariable,
     type TemplateListResponse as TemplateListResponse,
     type TemplateCreateParams as TemplateCreateParams,
+    type TemplateRetrieveParams as TemplateRetrieveParams,
+    type TemplateUpdateParams as TemplateUpdateParams,
     type TemplateListParams as TemplateListParams,
+    type TemplateDeleteParams as TemplateDeleteParams,
+  };
+
+  export {
+    Profiles as Profiles,
+    type APIResponseOfProfileDetail as APIResponseOfProfileDetail,
+    type BillingContactInfo as BillingContactInfo,
+    type BrandsBrandData as BrandsBrandData,
+    type DestinationCountry as DestinationCountry,
+    type PaymentDetails as PaymentDetails,
+    type ProfileDetail as ProfileDetail,
+    type SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo as SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo,
+    type SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo as SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo,
+    type SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo as SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo,
+    type TcrBrandRelationship as TcrBrandRelationship,
+    type TcrVertical as TcrVertical,
+    type ProfileListResponse as ProfileListResponse,
+    type ProfileCompleteResponse as ProfileCompleteResponse,
+    type ProfileCreateParams as ProfileCreateParams,
+    type ProfileRetrieveParams as ProfileRetrieveParams,
+    type ProfileUpdateParams as ProfileUpdateParams,
+    type ProfileListParams as ProfileListParams,
+    type ProfileDeleteParams as ProfileDeleteParams,
+    type ProfileCompleteParams as ProfileCompleteParams,
+  };
+
+  export {
+    Numbers as Numbers,
+    type NumberLookupResponse as NumberLookupResponse,
+    type NumberLookupParams as NumberLookupParams,
+  };
+
+  export {
+    Messages as Messages,
+    type MessageRetrieveActivitiesResponse as MessageRetrieveActivitiesResponse,
+    type MessageRetrieveStatusResponse as MessageRetrieveStatusResponse,
+    type MessageSendResponse as MessageSendResponse,
+    type MessageRetrieveActivitiesParams as MessageRetrieveActivitiesParams,
+    type MessageRetrieveStatusParams as MessageRetrieveStatusParams,
+    type MessageSendParams as MessageSendParams,
+  };
+
+  export {
+    Contacts as Contacts,
+    type APIResponseOfContact as APIResponseOfContact,
+    type ContactResponse as ContactResponse,
+    type ContactListResponse as ContactListResponse,
+    type ContactCreateParams as ContactCreateParams,
+    type ContactRetrieveParams as ContactRetrieveParams,
+    type ContactUpdateParams as ContactUpdateParams,
+    type ContactListParams as ContactListParams,
+    type ContactDeleteParams as ContactDeleteParams,
   };
 
   export {
-    NumberLookup as NumberLookup,
-    type NumberLookupRetrieveResponse as NumberLookupRetrieveResponse,
-    type NumberLookupRetrieveParams as NumberLookupRetrieveParams,
+    Me as Me,
+    type ProfileSettings as ProfileSettings,
+    type MeRetrieveResponse as MeRetrieveResponse,
+    type MeRetrieveParams as MeRetrieveParams,
   };
 }

package/src/internal/utils/log.ts

@@ -107,7 +107,6 @@ export const formatRequestDetails = (details: {
           name,
           (
             name.toLowerCase() === 'x-api-key' ||
-            name.toLowerCase() === 'x-sender-id' ||
             name.toLowerCase() === 'authorization' ||
             name.toLowerCase() === 'cookie' ||
             name.toLowerCase() === 'set-cookie'

package/src/internal/utils/query.ts

@@ -0,0 +1,23 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { SentDmError } from '../../core/error';
+
+/**
+ * Basic re-implementation of `qs.stringify` for primitive types.
+ */
+export function stringifyQuery(query: object | Record<string, unknown>) {
+  return Object.entries(query)
+    .filter(([_, value]) => typeof value !== 'undefined')
+    .map(([key, value]) => {
+      if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
+        return `${encodeURIComponent(key)}=${encodeURIComponent(value)}`;
+      }
+      if (value === null) {
+        return `${encodeURIComponent(key)}=`;
+      }
+      throw new SentDmError(
+        `Cannot stringify type ${typeof value}; Expected string, number, boolean, or null. If you need to pass nested query parameters, you can manually encode them, e.g. { query: { 'foo[key1]': value1, 'foo[key2]': value2 } }, and please open a GitHub issue requesting better support for your use case.`,
+      );
+    })
+    .join('&');
+}

package/src/internal/utils.ts

@@ -6,3 +6,4 @@ export * from './utils/env';
 export * from './utils/log';
 export * from './utils/uuid';
 export * from './utils/sleep';
+export * from './utils/query';