@sentdm/sentdm 0.33.0 → 0.35.0

package/src/resources/users.ts

@@ -1,15 +1,15 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../core/resource';
-import * as UsersAPI from './users';
-import * as WebhooksAPI from './webhooks';
 import { APIPromise } from '../core/api-promise';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
 /**
- * Invite, update, and manage organization users and roles
+ * The people who can sign in to your organization, and what each may do.
+ *
+ * Users are dashboard access and nothing else — they do not send, and removing one does not affect traffic. An API key is not a user: it belongs to the organization or to a sender profile, so revoking a person's access leaves your integration running.
  */
 export class Users extends APIResource {
   /**
@@ -18,8 +18,8 @@ export class Users extends APIResource {
    *
    * @example
    * ```ts
-   * const apiResponseOfUser = await client.users.retrieve(
-   *   'userId',
+   * const user = await client.users.retrieve(
+   *   '880e8400-e29b-41d4-a716-446655440003',
    * );
    * ```
    */
@@ -27,7 +27,7 @@ export class Users extends APIResource {
     userID: string,
     params: UserRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<APIResponseOfUser> {
+  ): APIPromise<UserRetrieveResponse> {
     const { 'x-profile-id': xProfileID } = params ?? {};
     return this._client.get(path`/v3/users/${userID}`, {
       ...options,
@@ -69,10 +69,10 @@ export class Users extends APIResource {
    *
    * @example
    * ```ts
-   * const apiResponseOfUser = await client.users.invite();
+   * const response = await client.users.invite();
    * ```
    */
-  invite(params: UserInviteParams, options?: RequestOptions): APIPromise<APIResponseOfUser> {
+  invite(params: UserInviteParams, options?: RequestOptions): APIPromise<UserInviteResponse> {
     const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
     return this._client.post('/v3/users', {
       body,
@@ -93,7 +93,9 @@ export class Users extends APIResource {
    *
    * @example
    * ```ts
-   * await client.users.remove('userId');
+   * await client.users.remove(
+   *   'aa0e8400-e29b-41d4-a716-446655440005',
+   * );
    * ```
    */
   remove(userID: string, params: UserRemoveParams, options?: RequestOptions): APIPromise<void> {
@@ -114,8 +116,8 @@ export class Users extends APIResource {
    *
    * @example
    * ```ts
-   * const apiResponseOfUser = await client.users.updateRole(
-   *   'userId',
+   * const response = await client.users.updateRole(
+   *   'aa0e8400-e29b-41d4-a716-446655440005',
    * );
    * ```
    */
@@ -123,7 +125,7 @@ export class Users extends APIResource {
     userID: string,
     params: UserUpdateRoleParams,
     options?: RequestOptions,
-  ): APIPromise<APIResponseOfUser> {
+  ): APIPromise<UserUpdateRoleResponse> {
     const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
     return this._client.patch(path`/v3/users/${userID}`, {
       body,
@@ -142,21 +144,21 @@ export class Users extends APIResource {
 /**
  * Standard API response envelope for all v3 endpoints
  */
-export interface APIResponseOfUser {
+export interface UserRetrieveResponse {
   /**
    * User response for v3 API
    */
-  data?: UserResponse | null;
+  data?: UserRetrieveResponse.Data | null;
 
   /**
    * Error information
    */
-  error?: WebhooksAPI.ErrorDetail | null;
+  error?: UserRetrieveResponse.Error | null;
 
   /**
    * Request and response metadata
    */
-  meta?: WebhooksAPI.APIMeta;
+  meta?: UserRetrieveResponse.Meta;
 
   /**
    * Indicates whether the request was successful
@@ -164,74 +166,452 @@ export interface APIResponseOfUser {
   success?: boolean;
 }
 
+export namespace UserRetrieveResponse {
+  /**
+   * User response for v3 API
+   */
+  export interface Data {
+    /**
+     * User unique identifier
+     */
+    id?: string;
+
+    /**
+     * When the user was added to the organization
+     */
+    created_at?: string;
+
+    /**
+     * Which customer owns this — the key's own, or the profile named in x-profile-id.
+     * Says whose resource this is, which the resource's own id does not.
+     */
+    customer_id?: string;
+
+    /**
+     * User email address
+     */
+    email?: string;
+
+    /**
+     * When the user was invited
+     */
+    invited_at?: string | null;
+
+    /**
+     * When the user last logged in
+     */
+    last_login_at?: string | null;
+
+    /**
+     * User full name
+     */
+    name?: string;
+
+    /**
+     * User role in the organization: admin, billing, developer
+     */
+    role?: string;
+
+    /**
+     * User status: active, invited, suspended, rejected
+     */
+    status?: string;
+
+    /**
+     * When the user record was last updated
+     */
+    updated_at?: string | null;
+  }
+
+  /**
+   * Error information
+   */
+  export interface Error {
+    /**
+     * Machine-readable error code (e.g., "RESOURCE_001")
+     */
+    code?: string;
+
+    /**
+     * Additional validation error details (field-level errors)
+     */
+    details?: { [key: string]: Array<string> } | null;
+
+    /**
+     * URL to documentation about this error
+     */
+    doc_url?: string | null;
+
+    /**
+     * Human-readable error message
+     */
+    message?: string;
+  }
+
+  /**
+   * Request and response metadata
+   */
+  export interface Meta {
+    /**
+     * Unique identifier for this request (for tracing and support)
+     */
+    request_id?: string;
+
+    /**
+     * Server timestamp when the response was generated
+     */
+    timestamp?: string;
+
+    /**
+     * API version used for this request
+     */
+    version?: string;
+  }
+}
+
 /**
- * User response for v3 API
+ * Standard API response envelope for all v3 endpoints
  */
-export interface UserResponse {
+export interface UserListResponse {
   /**
-   * User unique identifier
+   * The users in the organization.
    */
-  id?: string;
+  data?: UserListResponse.Data | null;
 
   /**
-   * When the user was added to the organization
+   * Error information
    */
-  created_at?: string;
+  error?: UserListResponse.Error | null;
 
   /**
-   * User email address
+   * Request and response metadata
    */
-  email?: string;
+  meta?: UserListResponse.Meta;
 
   /**
-   * When the user was invited
+   * Indicates whether the request was successful
    */
-  invited_at?: string | null;
+  success?: boolean;
+}
 
+export namespace UserListResponse {
   /**
-   * When the user last logged in
+   * The users in the organization.
    */
-  last_login_at?: string | null;
+  export interface Data {
+    /**
+     * Pagination metadata for list responses
+     */
+    pagination?: Data.Pagination;
+
+    /**
+     * The users on this page.
+     */
+    users?: Array<Data.User>;
+  }
+
+  export namespace Data {
+    /**
+     * Pagination metadata for list responses
+     */
+    export interface Pagination {
+      /**
+       * @deprecated Cursor-based pagination. Never populated — see Cursors.
+       */
+      cursors?: Pagination.Cursors | null;
+
+      /**
+       * Whether there are more pages after this one
+       */
+      has_more?: boolean;
+
+      /**
+       * Current page number (1-indexed)
+       */
+      page?: number;
+
+      /**
+       * Number of items per page
+       */
+      page_size?: number;
+
+      /**
+       * Total number of items across all pages
+       */
+      total_count?: number;
+
+      /**
+       * Total number of pages
+       */
+      total_pages?: number;
+    }
+
+    export namespace Pagination {
+      /**
+       * @deprecated Cursor-based pagination. Never populated — see Cursors.
+       */
+      export interface Cursors {
+        /**
+         * Cursor to fetch the next page.
+         */
+        after?: string | null;
+
+        /**
+         * Cursor to fetch the previous page.
+         */
+        before?: string | null;
+      }
+    }
+
+    /**
+     * User response for v3 API
+     */
+    export interface User {
+      /**
+       * User unique identifier
+       */
+      id?: string;
+
+      /**
+       * When the user was added to the organization
+       */
+      created_at?: string;
+
+      /**
+       * Which customer owns this — the key's own, or the profile named in x-profile-id.
+       * Says whose resource this is, which the resource's own id does not.
+       */
+      customer_id?: string;
+
+      /**
+       * User email address
+       */
+      email?: string;
+
+      /**
+       * When the user was invited
+       */
+      invited_at?: string | null;
+
+      /**
+       * When the user last logged in
+       */
+      last_login_at?: string | null;
+
+      /**
+       * User full name
+       */
+      name?: string;
+
+      /**
+       * User role in the organization: admin, billing, developer
+       */
+      role?: string;
+
+      /**
+       * User status: active, invited, suspended, rejected
+       */
+      status?: string;
+
+      /**
+       * When the user record was last updated
+       */
+      updated_at?: string | null;
+    }
+  }
 
   /**
-   * User full name
+   * Error information
    */
-  name?: string;
+  export interface Error {
+    /**
+     * Machine-readable error code (e.g., "RESOURCE_001")
+     */
+    code?: string;
+
+    /**
+     * Additional validation error details (field-level errors)
+     */
+    details?: { [key: string]: Array<string> } | null;
+
+    /**
+     * URL to documentation about this error
+     */
+    doc_url?: string | null;
+
+    /**
+     * Human-readable error message
+     */
+    message?: string;
+  }
 
   /**
-   * User role in the organization: admin, billing, developer
+   * Request and response metadata
    */
-  role?: string;
+  export interface Meta {
+    /**
+     * Unique identifier for this request (for tracing and support)
+     */
+    request_id?: string;
+
+    /**
+     * Server timestamp when the response was generated
+     */
+    timestamp?: string;
+
+    /**
+     * API version used for this request
+     */
+    version?: string;
+  }
+}
+
+/**
+ * Standard API response envelope for all v3 endpoints
+ */
+export interface UserInviteResponse {
+  /**
+   * User response for v3 API
+   */
+  data?: UserInviteResponse.Data | null;
+
+  /**
+   * Error information
+   */
+  error?: UserInviteResponse.Error | null;
+
+  /**
+   * Request and response metadata
+   */
+  meta?: UserInviteResponse.Meta;
+
+  /**
+   * Indicates whether the request was successful
+   */
+  success?: boolean;
+}
+
+export namespace UserInviteResponse {
+  /**
+   * User response for v3 API
+   */
+  export interface Data {
+    /**
+     * User unique identifier
+     */
+    id?: string;
+
+    /**
+     * When the user was added to the organization
+     */
+    created_at?: string;
+
+    /**
+     * Which customer owns this — the key's own, or the profile named in x-profile-id.
+     * Says whose resource this is, which the resource's own id does not.
+     */
+    customer_id?: string;
+
+    /**
+     * User email address
+     */
+    email?: string;
+
+    /**
+     * When the user was invited
+     */
+    invited_at?: string | null;
+
+    /**
+     * When the user last logged in
+     */
+    last_login_at?: string | null;
+
+    /**
+     * User full name
+     */
+    name?: string;
+
+    /**
+     * User role in the organization: admin, billing, developer
+     */
+    role?: string;
+
+    /**
+     * User status: active, invited, suspended, rejected
+     */
+    status?: string;
+
+    /**
+     * When the user record was last updated
+     */
+    updated_at?: string | null;
+  }
 
   /**
-   * User status: active, invited, suspended, rejected
+   * Error information
    */
-  status?: string;
+  export interface Error {
+    /**
+     * Machine-readable error code (e.g., "RESOURCE_001")
+     */
+    code?: string;
+
+    /**
+     * Additional validation error details (field-level errors)
+     */
+    details?: { [key: string]: Array<string> } | null;
+
+    /**
+     * URL to documentation about this error
+     */
+    doc_url?: string | null;
+
+    /**
+     * Human-readable error message
+     */
+    message?: string;
+  }
 
   /**
-   * When the user record was last updated
+   * Request and response metadata
    */
-  updated_at?: string | null;
+  export interface Meta {
+    /**
+     * Unique identifier for this request (for tracing and support)
+     */
+    request_id?: string;
+
+    /**
+     * Server timestamp when the response was generated
+     */
+    timestamp?: string;
+
+    /**
+     * API version used for this request
+     */
+    version?: string;
+  }
 }
 
 /**
  * Standard API response envelope for all v3 endpoints
  */
-export interface UserListResponse {
+export interface UserUpdateRoleResponse {
   /**
-   * List of users response
+   * User response for v3 API
    */
-  data?: UserListResponse.Data | null;
+  data?: UserUpdateRoleResponse.Data | null;
 
   /**
    * Error information
    */
-  error?: WebhooksAPI.ErrorDetail | null;
+  error?: UserUpdateRoleResponse.Error | null;
 
   /**
    * Request and response metadata
    */
-  meta?: WebhooksAPI.APIMeta;
+  meta?: UserUpdateRoleResponse.Meta;
 
   /**
    * Indicates whether the request was successful
@@ -239,15 +619,106 @@ export interface UserListResponse {
   success?: boolean;
 }
 
-export namespace UserListResponse {
+export namespace UserUpdateRoleResponse {
   /**
-   * List of users response
+   * User response for v3 API
    */
   export interface Data {
     /**
-     * List of users in the organization
+     * User unique identifier
+     */
+    id?: string;
+
+    /**
+     * When the user was added to the organization
+     */
+    created_at?: string;
+
+    /**
+     * Which customer owns this — the key's own, or the profile named in x-profile-id.
+     * Says whose resource this is, which the resource's own id does not.
+     */
+    customer_id?: string;
+
+    /**
+     * User email address
+     */
+    email?: string;
+
+    /**
+     * When the user was invited
+     */
+    invited_at?: string | null;
+
+    /**
+     * When the user last logged in
+     */
+    last_login_at?: string | null;
+
+    /**
+     * User full name
+     */
+    name?: string;
+
+    /**
+     * User role in the organization: admin, billing, developer
+     */
+    role?: string;
+
+    /**
+     * User status: active, invited, suspended, rejected
+     */
+    status?: string;
+
+    /**
+     * When the user record was last updated
+     */
+    updated_at?: string | null;
+  }
+
+  /**
+   * Error information
+   */
+  export interface Error {
+    /**
+     * Machine-readable error code (e.g., "RESOURCE_001")
+     */
+    code?: string;
+
+    /**
+     * Additional validation error details (field-level errors)
+     */
+    details?: { [key: string]: Array<string> } | null;
+
+    /**
+     * URL to documentation about this error
+     */
+    doc_url?: string | null;
+
+    /**
+     * Human-readable error message
+     */
+    message?: string;
+  }
+
+  /**
+   * Request and response metadata
+   */
+  export interface Meta {
+    /**
+     * Unique identifier for this request (for tracing and support)
+     */
+    request_id?: string;
+
+    /**
+     * Server timestamp when the response was generated
+     */
+    timestamp?: string;
+
+    /**
+     * API version used for this request
      */
-    users?: Array<UsersAPI.UserResponse>;
+    version?: string;
   }
 }
 
@@ -348,9 +819,10 @@ export interface UserUpdateRoleParams {
 
 export declare namespace Users {
   export {
-    type APIResponseOfUser as APIResponseOfUser,
-    type UserResponse as UserResponse,
+    type UserRetrieveResponse as UserRetrieveResponse,
     type UserListResponse as UserListResponse,
+    type UserInviteResponse as UserInviteResponse,
+    type UserUpdateRoleResponse as UserUpdateRoleResponse,
     type UserRetrieveParams as UserRetrieveParams,
     type UserListParams as UserListParams,
     type UserInviteParams as UserInviteParams,