@sentdm/sentdm 0.26.0 → 0.27.2

package/src/resources/users.ts

@@ -1,6 +1,8 @@
 // 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';
@@ -16,14 +18,16 @@ export class Users extends APIResource {
    *
    * @example
    * ```ts
-   * const user = await client.users.retrieve('userId');
+   * const apiResponseOfUser = await client.users.retrieve(
+   *   'userId',
+   * );
    * ```
    */
   retrieve(
     userID: string,
     params: UserRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<UserRetrieveResponse> {
+  ): APIPromise<APIResponseOfUser> {
     const { 'x-profile-id': xProfileID } = params ?? {};
     return this._client.get(path`/v3/users/${userID}`, {
       ...options,
@@ -65,10 +69,10 @@ export class Users extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.users.invite();
+   * const apiResponseOfUser = await client.users.invite();
    * ```
    */
-  invite(params: UserInviteParams, options?: RequestOptions): APIPromise<UserInviteResponse> {
+  invite(params: UserInviteParams, options?: RequestOptions): APIPromise<APIResponseOfUser> {
     const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
     return this._client.post('/v3/users', {
       body,
@@ -110,14 +114,16 @@ export class Users extends APIResource {
    *
    * @example
    * ```ts
-   * const response = await client.users.updateRole('userId');
+   * const apiResponseOfUser = await client.users.updateRole(
+   *   'userId',
+   * );
    * ```
    */
   updateRole(
     userID: string,
     params: UserUpdateRoleParams,
     options?: RequestOptions,
-  ): APIPromise<UserUpdateRoleResponse> {
+  ): APIPromise<APIResponseOfUser> {
     const { 'Idempotency-Key': idempotencyKey, 'x-profile-id': xProfileID, ...body } = params;
     return this._client.patch(path`/v3/users/${userID}`, {
       body,
@@ -136,21 +142,21 @@ export class Users extends APIResource {
 /**
  * Standard API response envelope for all v3 endpoints
  */
-export interface UserRetrieveResponse {
+export interface APIResponseOfUser {
   /**
    * User response for v3 API
    */
-  data?: UserRetrieveResponse.Data | null;
+  data?: UserResponse | null;
 
   /**
    * Error information
    */
-  error?: UserRetrieveResponse.Error | null;
+  error?: WebhooksAPI.ErrorDetail | null;
 
   /**
    * Request and response metadata
    */
-  meta?: UserRetrieveResponse.Meta;
+  meta?: WebhooksAPI.APIMeta;
 
   /**
    * Indicates whether the request was successful
@@ -158,377 +164,74 @@ export interface UserRetrieveResponse {
   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;
-
-    /**
-     * 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;
-  }
-}
-
 /**
- * Standard API response envelope for all v3 endpoints
+ * User response for v3 API
  */
-export interface UserListResponse {
-  /**
-   * List of users response
-   */
-  data?: UserListResponse.Data | null;
-
-  /**
-   * Error information
-   */
-  error?: UserListResponse.Error | null;
-
+export interface UserResponse {
   /**
-   * Request and response metadata
+   * User unique identifier
    */
-  meta?: UserListResponse.Meta;
+  id?: string;
 
   /**
-   * Indicates whether the request was successful
+   * When the user was added to the organization
    */
-  success?: boolean;
-}
+  created_at?: string;
 
-export namespace UserListResponse {
-  /**
-   * List of users response
-   */
-  export interface Data {
-    /**
-     * List of users in the organization
-     */
-    users?: Array<Data.User>;
-  }
-
-  export namespace Data {
-    /**
-     * User response for v3 API
-     */
-    export interface User {
-      /**
-       * User unique identifier
-       */
-      id?: string;
-
-      /**
-       * When the user was added to the organization
-       */
-      created_at?: 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;
-  }
-}
-
-/**
- * Standard API response envelope for all v3 endpoints
- */
-export interface UserInviteResponse {
   /**
-   * User response for v3 API
+   * User email address
    */
-  data?: UserInviteResponse.Data | null;
+  email?: string;
 
   /**
-   * Error information
+   * When the user was invited
    */
-  error?: UserInviteResponse.Error | null;
+  invited_at?: string | null;
 
   /**
-   * Request and response metadata
+   * When the user last logged in
    */
-  meta?: UserInviteResponse.Meta;
+  last_login_at?: string | null;
 
   /**
-   * Indicates whether the request was successful
+   * User full name
    */
-  success?: boolean;
-}
+  name?: string;
 
-export namespace UserInviteResponse {
   /**
-   * User response for v3 API
+   * User role in the organization: admin, billing, developer
    */
-  export interface Data {
-    /**
-     * User unique identifier
-     */
-    id?: string;
-
-    /**
-     * When the user was added to the organization
-     */
-    created_at?: 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;
-  }
+  role?: string;
 
   /**
-   * Error information
+   * User status: active, invited, suspended, rejected
    */
-  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;
-  }
+  status?: string;
 
   /**
-   * Request and response metadata
+   * When the user record was last updated
    */
-  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;
-  }
+  updated_at?: string | null;
 }
 
 /**
  * Standard API response envelope for all v3 endpoints
  */
-export interface UserUpdateRoleResponse {
+export interface UserListResponse {
   /**
-   * User response for v3 API
+   * List of users response
    */
-  data?: UserUpdateRoleResponse.Data | null;
+  data?: UserListResponse.Data | null;
 
   /**
    * Error information
    */
-  error?: UserUpdateRoleResponse.Error | null;
+  error?: WebhooksAPI.ErrorDetail | null;
 
   /**
    * Request and response metadata
    */
-  meta?: UserUpdateRoleResponse.Meta;
+  meta?: WebhooksAPI.APIMeta;
 
   /**
    * Indicates whether the request was successful
@@ -536,100 +239,15 @@ export interface UserUpdateRoleResponse {
   success?: boolean;
 }
 
-export namespace UserUpdateRoleResponse {
+export namespace UserListResponse {
   /**
-   * User response for v3 API
+   * List of users response
    */
   export interface Data {
     /**
-     * User unique identifier
-     */
-    id?: string;
-
-    /**
-     * When the user was added to the organization
-     */
-    created_at?: 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
+     * List of users in the organization
      */
-    version?: string;
+    users?: Array<UsersAPI.UserResponse>;
   }
 }
 
@@ -730,10 +348,9 @@ export interface UserUpdateRoleParams {
 
 export declare namespace Users {
   export {
-    type UserRetrieveResponse as UserRetrieveResponse,
+    type APIResponseOfUser as APIResponseOfUser,
+    type UserResponse as UserResponse,
     type UserListResponse as UserListResponse,
-    type UserInviteResponse as UserInviteResponse,
-    type UserUpdateRoleResponse as UserUpdateRoleResponse,
     type UserRetrieveParams as UserRetrieveParams,
     type UserListParams as UserListParams,
     type UserInviteParams as UserInviteParams,