@sentdm/sentdm 0.33.0 → 0.35.0

package/resources/users.d.ts

@@ -1,10 +1,10 @@
 import { APIResource } from "../core/resource.js";
-import * as UsersAPI from "./users.js";
-import * as WebhooksAPI from "./webhooks.js";
 import { APIPromise } from "../core/api-promise.js";
 import { RequestOptions } from "../internal/request-options.js";
 /**
- * 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 declare class Users extends APIResource {
     /**
@@ -13,12 +13,12 @@ export declare class Users extends APIResource {
      *
      * @example
      * ```ts
-     * const apiResponseOfUser = await client.users.retrieve(
-     *   'userId',
+     * const user = await client.users.retrieve(
+     *   '880e8400-e29b-41d4-a716-446655440003',
      * );
      * ```
      */
-    retrieve(userID: string, params?: UserRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<APIResponseOfUser>;
+    retrieve(userID: string, params?: UserRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<UserRetrieveResponse>;
     /**
      * Retrieves all users who have access to the organization or profile identified by
      * the API key, including their roles and status. Shows invited users (pending
@@ -37,17 +37,19 @@ export declare 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>;
     /**
      * Removes a user's access to an organization or profile. Requires admin role. You
      * cannot remove yourself or remove the last admin.
      *
      * @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>;
@@ -57,105 +59,506 @@ export declare class Users extends APIResource {
      *
      * @example
      * ```ts
-     * const apiResponseOfUser = await client.users.updateRole(
-     *   'userId',
+     * const response = await client.users.updateRole(
+     *   'aa0e8400-e29b-41d4-a716-446655440005',
      * );
      * ```
      */
-    updateRole(userID: string, params: UserUpdateRoleParams, options?: RequestOptions): APIPromise<APIResponseOfUser>;
+    updateRole(userID: string, params: UserUpdateRoleParams, options?: RequestOptions): APIPromise<UserUpdateRoleResponse>;
 }
 /**
  * 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
      */
     success?: boolean;
 }
+export declare namespace UserRetrieveResponse {
+    /**
+     * User response for v3 API
+     */
+    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
+     */
+    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
+     */
+    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 declare namespace UserListResponse {
     /**
-     * When the user last logged in
+     * The users in the organization.
      */
-    last_login_at?: string | null;
+    interface Data {
+        /**
+         * Pagination metadata for list responses
+         */
+        pagination?: Data.Pagination;
+        /**
+         * The users on this page.
+         */
+        users?: Array<Data.User>;
+    }
+    namespace Data {
+        /**
+         * Pagination metadata for list responses
+         */
+        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;
+        }
+        namespace Pagination {
+            /**
+             * @deprecated Cursor-based pagination. Never populated — see Cursors.
+             */
+            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
+         */
+        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;
+    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;
+    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;
     /**
-     * User status: active, invited, suspended, rejected
+     * Request and response metadata
      */
-    status?: string;
+    meta?: UserInviteResponse.Meta;
     /**
-     * When the user record was last updated
+     * Indicates whether the request was successful
      */
-    updated_at?: string | null;
+    success?: boolean;
+}
+export declare namespace UserInviteResponse {
+    /**
+     * User response for v3 API
+     */
+    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
+     */
+    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
+     */
+    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
      */
     success?: boolean;
 }
-export declare namespace UserListResponse {
+export declare namespace UserUpdateRoleResponse {
     /**
-     * List of users response
+     * User response for v3 API
      */
     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
+     */
+    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
+     */
+    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;
     }
 }
 export interface UserRetrieveParams {
@@ -240,6 +643,6 @@ export interface UserUpdateRoleParams {
     'x-profile-id'?: string;
 }
 export declare namespace Users {
-    export { 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 { 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, type UserRemoveParams as UserRemoveParams, type UserUpdateRoleParams as UserUpdateRoleParams, };
 }
 //# sourceMappingURL=users.d.ts.map

package/resources/users.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,QAAQ,mBAAgB;AACpC,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;IAWhC;;;;;;;;;OASG;IACH,IAAI,CACF,MAAM,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAW/B;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAezF;;;;;;;;OAQG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAY5F;;;;;;;;;;OAUG;IACH,UAAU,CACR,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,iBAAiB,CAAC;CAcjC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC,WAAW,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;IAE3B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;KACtC;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../src/resources/users.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,+BAA4B;AAEjD,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;;;GAIG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;OAUG;IACH,QAAQ,CACN,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAClD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,oBAAoB,CAAC;IAWnC;;;;;;;;;OASG;IACH,IAAI,CACF,MAAM,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,gBAAgB,CAAC;IAW/B;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAe1F;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAY5F;;;;;;;;;;OAUG;IACH,UAAU,CACR,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,oBAAoB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,sBAAsB,CAAC;CActC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,oBAAoB,CAAC,IAAI,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,KAAK,CAAC,EAAE,oBAAoB,CAAC,KAAK,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,IAAI,CAAC,EAAE,oBAAoB,CAAC,IAAI,CAAC;IAEjC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;SAAE,GAAG,IAAI,CAAC;QAElD;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC,KAAK,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,IAAI,CAAC,EAAE,gBAAgB,CAAC,IAAI,CAAC;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,UAAU,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC;QAE7B;;WAEG;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;KAC1B;IAED,UAAiB,IAAI,CAAC;QACpB;;WAEG;QACH,UAAiB,UAAU;YACzB;;eAEG;YACH,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC;YAEpC;;eAEG;YACH,QAAQ,CAAC,EAAE,OAAO,CAAC;YAEnB;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;YAEnB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB;QAED,UAAiB,UAAU,CAAC;YAC1B;;eAEG;YACH,UAAiB,OAAO;gBACtB;;mBAEG;gBACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEtB;;mBAEG;gBACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;aACxB;SACF;QAED;;WAEG;QACH,UAAiB,IAAI;YACnB;;eAEG;YACH,EAAE,CAAC,EAAE,MAAM,CAAC;YAEZ;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YAEpB;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YAErB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE3B;;eAEG;YACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;YAE9B;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;eAEG;YACH,MAAM,CAAC,EAAE,MAAM,CAAC;YAEhB;;eAEG;YACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;SAC5B;KACF;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;SAAE,GAAG,IAAI,CAAC;QAElD;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,kBAAkB,CAAC,IAAI,GAAG,IAAI,CAAC;IAEtC;;OAEG;IACH,KAAK,CAAC,EAAE,kBAAkB,CAAC,KAAK,GAAG,IAAI,CAAC;IAExC;;OAEG;IACH,IAAI,CAAC,EAAE,kBAAkB,CAAC,IAAI,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;SAAE,GAAG,IAAI,CAAC;QAElD;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,CAAC,EAAE,sBAAsB,CAAC,IAAI,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,KAAK,CAAC,EAAE,sBAAsB,CAAC,KAAK,GAAG,IAAI,CAAC;IAE5C;;OAEG;IACH,IAAI,CAAC,EAAE,sBAAsB,CAAC,IAAI,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,yBAAiB,sBAAsB,CAAC;IACtC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE3B;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE9B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KAC5B;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;SAAE,GAAG,IAAI,CAAC;QAElD;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;CACH"}

package/resources/users.js

@@ -6,7 +6,9 @@ const resource_1 = require("../core/resource.js");
 const headers_1 = require("../internal/headers.js");
 const path_1 = require("../internal/utils/path.js");
 /**
- * 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.
  */
 class Users extends resource_1.APIResource {
     /**
@@ -15,8 +17,8 @@ class Users extends resource_1.APIResource {
      *
      * @example
      * ```ts
-     * const apiResponseOfUser = await client.users.retrieve(
-     *   'userId',
+     * const user = await client.users.retrieve(
+     *   '880e8400-e29b-41d4-a716-446655440003',
      * );
      * ```
      */
@@ -57,7 +59,7 @@ class Users extends resource_1.APIResource {
      *
      * @example
      * ```ts
-     * const apiResponseOfUser = await client.users.invite();
+     * const response = await client.users.invite();
      * ```
      */
     invite(params, options) {
@@ -80,7 +82,9 @@ class Users extends resource_1.APIResource {
      *
      * @example
      * ```ts
-     * await client.users.remove('userId');
+     * await client.users.remove(
+     *   'aa0e8400-e29b-41d4-a716-446655440005',
+     * );
      * ```
      */
     remove(userID, params, options) {
@@ -100,8 +104,8 @@ class Users extends resource_1.APIResource {
      *
      * @example
      * ```ts
-     * const apiResponseOfUser = await client.users.updateRole(
-     *   'userId',
+     * const response = await client.users.updateRole(
+     *   'aa0e8400-e29b-41d4-a716-446655440005',
      * );
      * ```
      */