@sentdm/sentdm 0.3.5

package/src/resources/organizations/users.ts

@@ -0,0 +1,189 @@
+// 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 Users extends APIResource {
+  /**
+   * Retrieves a specific user by their ID. Requires appropriate permissions. The
+   * customerId can be either an organization ID or a profile ID.
+   *
+   * @example
+   * ```ts
+   * const customerUser =
+   *   await client.organizations.users.retrieve(
+   *     '650e8400-e29b-41d4-a716-446655440000',
+   *     { customerId: '550e8400-e29b-41d4-a716-446655440000' },
+   *   );
+   * ```
+   */
+  retrieve(userID: string, params: UserRetrieveParams, options?: RequestOptions): APIPromise<CustomerUser> {
+    const { customerId } = params;
+    return this._client.get(path`/v2/organizations/${customerId}/users/${userID}`, options);
+  }
+
+  /**
+   * Retrieves all users associated with an organization or sender profile. Requires
+   * appropriate permissions. Supports pagination.
+   *
+   * @example
+   * ```ts
+   * const users = await client.organizations.users.list(
+   *   '550e8400-e29b-41d4-a716-446655440000',
+   *   { page: 0, pageSize: 0 },
+   * );
+   * ```
+   */
+  list(customerID: string, query: UserListParams, options?: RequestOptions): APIPromise<UserListResponse> {
+    return this._client.get(path`/v2/organizations/${customerID}/users`, { query, ...options });
+  }
+
+  /**
+   * Removes a user from an organization or sender profile. Requires admin
+   * permissions. This action permanently deletes the user association.
+   *
+   * @example
+   * ```ts
+   * await client.organizations.users.delete(
+   *   '650e8400-e29b-41d4-a716-446655440000',
+   *   { customerId: '550e8400-e29b-41d4-a716-446655440000' },
+   * );
+   * ```
+   */
+  delete(userID: string, params: UserDeleteParams, options?: RequestOptions): APIPromise<void> {
+    const { customerId } = params;
+    return this._client.delete(path`/v2/organizations/${customerId}/users/${userID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+
+  /**
+   * Invites a user to an organization or sender profile with a specified role.
+   * Requires appropriate permissions. The customerId can be either an organization
+   * ID or a profile ID.
+   *
+   * @example
+   * ```ts
+   * const customerUser =
+   *   await client.organizations.users.invite(
+   *     '550e8400-e29b-41d4-a716-446655440000',
+   *   );
+   * ```
+   */
+  invite(customerID: string, body: UserInviteParams, options?: RequestOptions): APIPromise<CustomerUser> {
+    return this._client.post(path`/v2/organizations/${customerID}/users`, { body, ...options });
+  }
+
+  /**
+   * Updates a user's role within an organization or sender profile. Requires admin
+   * permissions. Valid roles are: admin, billing, developer.
+   *
+   * @example
+   * ```ts
+   * const customerUser =
+   *   await client.organizations.users.updateRole(
+   *     '650e8400-e29b-41d4-a716-446655440000',
+   *     { customerId: '550e8400-e29b-41d4-a716-446655440000' },
+   *   );
+   * ```
+   */
+  updateRole(
+    userID: string,
+    params: UserUpdateRoleParams,
+    options?: RequestOptions,
+  ): APIPromise<CustomerUser> {
+    const { customerId, ...body } = params;
+    return this._client.put(path`/v2/organizations/${customerId}/users/${userID}`, { body, ...options });
+  }
+}
+
+export interface CustomerUser {
+  /**
+   * Unique identifier
+   */
+  id?: string;
+
+  createdAt?: string;
+
+  customerId?: string;
+
+  email?: string;
+
+  invitationSentAt?: string | null;
+
+  invitationToken?: string | null;
+
+  invitationTokenExpiresAt?: string | null;
+
+  lastLoginAt?: string | null;
+
+  name?: string;
+
+  role?: string;
+
+  status?: string;
+
+  updatedAt?: string | null;
+}
+
+export interface UserListResponse {
+  page?: number;
+
+  pageSize?: number;
+
+  totalCount?: number;
+
+  users?: Array<CustomerUser>;
+}
+
+export interface UserRetrieveParams {
+  customerId: string;
+}
+
+export interface UserListParams {
+  page: number;
+
+  pageSize: number;
+}
+
+export interface UserDeleteParams {
+  customerId: string;
+}
+
+export interface UserInviteParams {
+  email?: string;
+
+  invitedBy?: string | null;
+
+  name?: string;
+
+  role?: string;
+}
+
+export interface UserUpdateRoleParams {
+  /**
+   * Path param
+   */
+  customerId: string;
+
+  /**
+   * Body param
+   */
+  role?: string;
+}
+
+export declare namespace Users {
+  export {
+    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,
+  };
+}

package/src/resources/organizations.ts

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

package/src/resources/templates.ts

@@ -0,0 +1,430 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as TemplatesAPI from './templates';
+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 Templates extends APIResource {
+  /**
+   * Creates a new message template for the authenticated customer with comprehensive
+   * template definitions including headers, body, footer, and interactive buttons.
+   * Supports automatic metadata generation using AI (display name, language,
+   * category). Optionally submits the template for WhatsApp review. The customer ID
+   * is extracted from the authentication token.
+   *
+   * @example
+   * ```ts
+   * const templateResponse = await client.templates.create({
+   *   definition: { body: {} },
+   * });
+   * ```
+   */
+  create(body: TemplateCreateParams, options?: RequestOptions): APIPromise<TemplateResponse> {
+    return this._client.post('/v2/templates', { body, ...options });
+  }
+
+  /**
+   * Retrieves a specific message template by its unique identifier for the
+   * authenticated customer with comprehensive template definitions including
+   * headers, body, footer, and interactive buttons. The customer ID is extracted
+   * from the authentication token.
+   *
+   * @example
+   * ```ts
+   * const templateResponse = await client.templates.retrieve(
+   *   '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<TemplateResponse> {
+    return this._client.get(path`/v2/templates/${id}`, options);
+  }
+
+  /**
+   * Retrieves all message templates available for the authenticated customer with
+   * comprehensive template definitions including headers, body, footer, and
+   * interactive buttons. Supports advanced filtering by search term, status, and
+   * category, plus pagination. The customer ID is extracted from the authentication
+   * token.
+   *
+   * @example
+   * ```ts
+   * const templates = await client.templates.list({
+   *   page: 0,
+   *   pageSize: 0,
+   * });
+   * ```
+   */
+  list(query: TemplateListParams, options?: RequestOptions): APIPromise<TemplateListResponse> {
+    return this._client.get('/v2/templates', { query, ...options });
+  }
+
+  /**
+   * Deletes a specific message template by its unique identifier for the
+   * authenticated customer with smart deletion strategy. Deletion behavior: - If
+   * template has NO messages: Permanently deleted from database (hard delete). - If
+   * template has messages: Marked as deleted but preserved for message history (soft
+   * delete with snapshot). The template must exist and belong to the authenticated
+   * customer to be deleted successfully. The customer ID is extracted from the
+   * authentication token.
+   *
+   * @example
+   * ```ts
+   * await client.templates.delete(
+   *   '7ba7b820-9dad-11d1-80b4-00c04fd430c8',
+   * );
+   * ```
+   */
+  delete(id: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/v2/templates/${id}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
+  }
+}
+
+export interface TemplateBodyContent {
+  template?: string;
+
+  type?: string | null;
+
+  variables?: Array<TemplateVariable> | null;
+}
+
+/**
+ * Complete definition of a message template including header, body, footer, and
+ * buttons
+ */
+export interface TemplateDefinition {
+  /**
+   * Required template body with content for different channels (multi-channel,
+   * SMS-specific, or WhatsApp-specific)
+   */
+  body: TemplateDefinition.Body;
+
+  /**
+   * Configuration specific to AUTHENTICATION category templates (optional)
+   */
+  authenticationConfig?: TemplateDefinition.AuthenticationConfig | null;
+
+  /**
+   * Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
+   */
+  buttons?: Array<TemplateDefinition.Button> | null;
+
+  /**
+   * The version of the template definition format
+   */
+  definitionVersion?: string | null;
+
+  /**
+   * Optional template footer with optional variables
+   */
+  footer?: TemplateDefinition.Footer | null;
+
+  /**
+   * Optional template header with optional variables
+   */
+  header?: TemplateDefinition.Header | null;
+}
+
+export namespace TemplateDefinition {
+  /**
+   * Required template body with content for different channels (multi-channel,
+   * SMS-specific, or WhatsApp-specific)
+   */
+  export interface Body {
+    /**
+     * Content that will be used for all channels (SMS and WhatsApp) unless
+     * channel-specific content is provided
+     */
+    multiChannel?: TemplatesAPI.TemplateBodyContent | null;
+
+    /**
+     * SMS-specific content that overrides multi-channel content for SMS messages
+     */
+    sms?: TemplatesAPI.TemplateBodyContent | null;
+
+    /**
+     * WhatsApp-specific content that overrides multi-channel content for WhatsApp
+     * messages
+     */
+    whatsapp?: TemplatesAPI.TemplateBodyContent | null;
+  }
+
+  /**
+   * Configuration specific to AUTHENTICATION category templates (optional)
+   */
+  export interface AuthenticationConfig {
+    /**
+     * Whether to add the security recommendation text: "For your security, do not
+     * share this code."
+     */
+    addSecurityRecommendation?: boolean;
+
+    /**
+     * Code expiration time in minutes (1-90). If set, adds footer: "This code expires
+     * in X minutes."
+     */
+    codeExpirationMinutes?: number | null;
+  }
+
+  /**
+   * Interactive button in a message template
+   */
+  export interface Button {
+    /**
+     * The unique identifier of the button (1-based index)
+     */
+    id?: number;
+
+    /**
+     * Properties specific to the button type
+     */
+    props?: Button.Props;
+
+    /**
+     * The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
+     */
+    type?: string;
+  }
+
+  export namespace Button {
+    /**
+     * Properties specific to the button type
+     */
+    export interface Props {
+      activeFor?: number | null;
+
+      autofillText?: string | null;
+
+      countryCode?: string | null;
+
+      offerCode?: string | null;
+
+      otpType?: string | null;
+
+      packageName?: string | null;
+
+      phoneNumber?: string | null;
+
+      quickReplyType?: string | null;
+
+      signatureHash?: string | null;
+
+      text?: string | null;
+
+      url?: string | null;
+
+      urlType?: string | null;
+    }
+  }
+
+  /**
+   * Optional template footer with optional variables
+   */
+  export interface Footer {
+    /**
+     * The footer template text with optional variable placeholders
+     */
+    template?: string;
+
+    /**
+     * The type of footer (typically "text")
+     */
+    type?: string | null;
+
+    /**
+     * List of variables used in the footer template
+     */
+    variables?: Array<TemplatesAPI.TemplateVariable> | null;
+  }
+
+  /**
+   * Optional template header with optional variables
+   */
+  export interface Header {
+    /**
+     * The header template text with optional variable placeholders (e.g., "Welcome to
+     * {{0:variable}}")
+     */
+    template?: string;
+
+    /**
+     * The type of header (e.g., "text", "image", "video", "document")
+     */
+    type?: string | null;
+
+    /**
+     * List of variables used in the header template
+     */
+    variables?: Array<TemplatesAPI.TemplateVariable> | null;
+  }
+}
+
+/**
+ * Represents a message template with comprehensive metadata including definition
+ * structure
+ */
+export interface TemplateResponse {
+  /**
+   * The unique identifier of the template
+   */
+  id?: string;
+
+  /**
+   * The template category (e.g., MARKETING, UTILITY, AUTHENTICATION)
+   */
+  category?: string;
+
+  /**
+   * The date and time when the template was created
+   */
+  createdAt?: string;
+
+  /**
+   * The complete template definition including header, body, footer, and buttons
+   */
+  definition?: TemplateDefinition;
+
+  /**
+   * The display name of the template (auto-generated if not provided)
+   */
+  displayName?: string;
+
+  /**
+   * Indicates whether the template is published and available for use
+   */
+  isPublished?: boolean;
+
+  /**
+   * The template language code (e.g., en_US, es_ES)
+   */
+  language?: string;
+
+  /**
+   * The approval status of the template (e.g., APPROVED, PENDING, REJECTED, DRAFT)
+   */
+  status?: string;
+
+  /**
+   * The date and time when the template was last updated
+   */
+  updatedAt?: string | null;
+
+  /**
+   * The WhatsApp Business API template ID from Meta
+   */
+  whatsappTemplateId?: string;
+
+  /**
+   * The WhatsApp template name as registered with Meta
+   */
+  whatsappTemplateName?: string;
+}
+
+export interface TemplateVariable {
+  id?: number;
+
+  name?: string;
+
+  props?: TemplateVariable.Props;
+
+  type?: string;
+}
+
+export namespace TemplateVariable {
+  export interface Props {
+    alt?: string | null;
+
+    mediaType?: string | null;
+
+    sample?: string | null;
+
+    shortUrl?: string | null;
+
+    url?: string | null;
+
+    variableType?: string | null;
+  }
+}
+
+export interface TemplateListResponse {
+  items?: Array<TemplateResponse>;
+
+  page?: number;
+
+  pageSize?: number;
+
+  totalCount?: number;
+
+  totalPages?: number;
+}
+
+export interface TemplateCreateParams {
+  /**
+   * Template definition containing header, body, footer, and buttons
+   */
+  definition: TemplateDefinition;
+
+  /**
+   * The template category (e.g., MARKETING, UTILITY, AUTHENTICATION). Can only be
+   * set when creating a new template. If not provided, will be auto-generated using
+   * AI.
+   */
+  category?: string | null;
+
+  /**
+   * The template language code (e.g., en_US, es_ES). Can only be set when creating a
+   * new template. If not provided, will be auto-detected using AI.
+   */
+  language?: string | null;
+
+  /**
+   * When false, the template will be saved as draft. When true, the template will be
+   * submitted for review.
+   */
+  submitForReview?: boolean;
+}
+
+export interface TemplateListParams {
+  /**
+   * The page number (zero-indexed). Default is 0.
+   */
+  page: number;
+
+  /**
+   * The number of items per page (1-1000). Default is 100.
+   */
+  pageSize: number;
+
+  /**
+   * Optional filter by template category (e.g., MARKETING, UTILITY, AUTHENTICATION)
+   */
+  category?: string | null;
+
+  /**
+   * Optional search term to filter templates by name or content
+   */
+  search?: string | null;
+
+  /**
+   * Optional filter by template status (e.g., APPROVED, PENDING, REJECTED, DRAFT)
+   */
+  status?: string | null;
+}
+
+export declare namespace Templates {
+  export {
+    type TemplateBodyContent as TemplateBodyContent,
+    type TemplateDefinition as TemplateDefinition,
+    type TemplateResponse as TemplateResponse,
+    type TemplateVariable as TemplateVariable,
+    type TemplateListResponse as TemplateListResponse,
+    type TemplateCreateParams as TemplateCreateParams,
+    type TemplateListParams as TemplateListParams,
+  };
+}

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}

package/src/uploads.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = '0.3.5'; // x-release-please-version

package/uploads.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.js";
+//# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/uploads instead */
+tslib_1.__exportStar(require("./core/uploads.js"), exports);
+//# sourceMappingURL=uploads.js.map

package/uploads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.js","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4DAA+B"}

package/uploads.mjs

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.mjs.map

package/uploads.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/version.d.mts

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

package/version.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.3.5";
+//# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
+exports.VERSION = '0.3.5'; // x-release-please-version
+//# sourceMappingURL=version.js.map