@augno/sdk 0.1.6 → 0.7.0

package/src/resources/identity/account-users/account-users.ts

@@ -16,28 +16,19 @@ export class AccountUsers extends APIResource {
   actions: ActionsAPI.Actions = new ActionsAPI.Actions(this._client);
 
   /**
-   * Creates a new account user and invites them to the target account.
+   * Returns a paginated list of account users for the current account.
    *
    * @example
    * ```ts
-   * const accountUser =
-   *   await client.identity.accountUsers.create({
-   *     email: 'jdoe@augno.com',
-   *     name: 'John Doe',
-   *     password: 'QgS7Z8Hhj3&1',
-   *     username: 'jdoe',
-   *     preferences: [
-   *       {
-   *         notification_type: 'order_acknowledgement',
-   *         enabled: true,
-   *       },
-   *     ],
-   *   });
+   * const listAccountUser =
+   *   await client.identity.accountUsers.list();
    * ```
    */
-  create(params: AccountUserCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.AccountUser> {
-    const { include, ...body } = params;
-    return this._client.post('/v1/identity/account-users', { query: { include }, body, ...options });
+  list(
+    query: AccountUserListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ListAccountUser> {
+    return this._client.get('/v1/identity/account-users', { query, ...options });
   }
 
   /**
@@ -59,15 +50,56 @@ export class AccountUsers extends APIResource {
     return this._client.get(path`/v1/identity/account-users/${id}`, { query, ...options });
   }
 
+  /**
+   * Adds a user to the target account.
+   *
+   * If no user with the given email or username exists, a new user is created and
+   * sent a welcome email containing a generated password. If a matching user already
+   * exists, that user is added to the account instead.
+   *
+   * @example
+   * ```ts
+   * const accountUser =
+   *   await client.identity.accountUsers.create({
+   *     email: 'jdoe@augno.com',
+   *     name: 'John Doe',
+   *     password: 'QgS7Z8Hhj3&1',
+   *     preferences: [
+   *       {
+   *         notification_type: 'order_acknowledgement',
+   *         enabled: true,
+   *       },
+   *     ],
+   *     role_id: 'rl_01c16d2eb637c0d1f3a372937c',
+   *     username: 'jdoe',
+   *   });
+   * ```
+   */
+  create(
+    params: AccountUserCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.AccountUser> {
+    const { include, ...body } = params ?? {};
+    return this._client.post('/v1/identity/account-users', { query: { include }, body, ...options });
+  }
+
   /**
    * Partially updates an account user.
    *
+   * Omitted fields are left unchanged. Profile fields (`name`, `email`, `username`)
+   * update the underlying user, which is shared across every account the user
+   * belongs to.
+   *
    * @example
    * ```ts
    * const accountUser =
    *   await client.identity.accountUsers.update(
    *     'acus_01ea9983ddb41dacc44ecf997c',
-   *     { name: 'John Doe' },
+   *     {
+   *       department_id: 'dp_01791c25ab59da4704cba61874',
+   *       name: 'John Doe',
+   *       role_id: 'rl_01c16d2eb637c0d1f3a372937c',
+   *     },
    *   );
    * ```
    */
@@ -83,22 +115,6 @@ export class AccountUsers extends APIResource {
       ...options,
     });
   }
-
-  /**
-   * Returns a paginated list of account users for the current account.
-   *
-   * @example
-   * ```ts
-   * const listAccountUser =
-   *   await client.identity.accountUsers.list();
-   * ```
-   */
-  list(
-    query: AccountUserListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<ListAccountUser> {
-    return this._client.get('/v1/identity/account-users', { query, ...options });
-  }
 }
 
 /**
@@ -106,40 +122,56 @@ export class AccountUsers extends APIResource {
  */
 export interface CreateAccountUserRequest {
   /**
-   * User email address.
+   * ID of the department to assign to the user.
    */
-  email: string | null;
+  department_id?: string;
 
   /**
-   * User display name.
+   * User email address.
+   *
+   * Either `email` or `username` must be provided. If a user with this email already
+   * exists, that user is added to the account instead of a new user being created.
    */
-  name: string | null;
+  email?: string;
 
   /**
-   * Password. Only used for scanner-role users (scanning stations). Must be 8–72
-   * chars and include upper, lower, number, and special character.
+   * User display name.
    */
-  password: string | null;
+  name?: string;
 
   /**
-   * Unique username (3–255 chars; letters, numbers, underscores, hyphens).
+   * Password for scanning station users.
+   *
+   * Required when creating a scanning station user (username without email) and
+   * rejected for all other users, who instead receive a generated password in their
+   * welcome email. Must be 8–72 characters and include an uppercase letter, a
+   * lowercase letter, a number, and a special character.
    */
-  username: string | null;
+  password?: string;
 
   /**
-   * Department assigned to the user.
+   * Notification preference toggles for the new user.
+   *
+   * Only applies when creating a user in another account you manage (cross-account);
+   * ignored when creating a user in your own account.
    */
-  department_id?: string | null;
+  preferences?: Array<NotificationPreferenceItem>;
 
   /**
-   * Notification preferences for the user (external targets only).
+   * ID of the role to assign to the user.
+   *
+   * Ignored for scanning station users, which are always assigned the scanner role.
    */
-  preferences?: Array<NotificationPreferenceItem>;
+  role_id?: string;
 
   /**
-   * Role assigned to the user.
+   * Unique username.
+   *
+   * 3–255 characters; letters, numbers, underscores, and hyphens. Either `email` or
+   * `username` must be provided. Providing a username without an email creates a
+   * scanning station user.
    */
-  role_id?: string | null;
+  username?: string;
 }
 
 /**
@@ -182,12 +214,16 @@ export interface NotificationPreferenceItem {
  */
 export interface UpdateAccountUserRequest {
   /**
-   * Department assigned to the user.
+   * ID of the department to assign to the user.
+   *
+   * Set to `null` to clear the department.
    */
   department_id?: string | null;
 
   /**
    * User email address.
+   *
+   * Must not already be in use by another user.
    */
   email?: string;
 
@@ -197,64 +233,75 @@ export interface UpdateAccountUserRequest {
   name?: string;
 
   /**
-   * Notification preferences to update (external targets only).
+   * Notification preference toggles to apply.
+   *
+   * Only allowed when updating a user in another account you manage (cross-account);
+   * rejected otherwise. Notification types omitted from the list are left unchanged.
    */
   preferences?: Array<NotificationPreferenceItem>;
 
   /**
-   * Role assigned to the user.
+   * ID of the role to assign to the user.
+   *
+   * Set to `null` to clear the role.
    */
   role_id?: string | null;
 
   /**
-   * Unique username (3–255 chars; letters, numbers, underscores, hyphens).
+   * Unique username.
+   *
+   * 3–255 characters; letters, numbers, underscores, and hyphens. Must not already
+   * be in use by another user.
    */
   username?: string;
 }
 
-export interface AccountUserCreateParams {
-  /**
-   * Body param: User email address.
-   */
-  email: string | null;
-
-  /**
-   * Body param: User display name.
-   */
-  name: string | null;
-
+export interface AccountUserListParams {
   /**
-   * Body param: Password. Only used for scanner-role users (scanning stations). Must
-   * be 8–72 chars and include upper, lower, number, and special character.
+   * Opaque cursor token identifying where the page of results starts.
+   *
+   * Use the `cursor` value embedded in a previous response's `next_page_url` or
+   * `previous_page_url` to fetch the adjacent page. Omit to start from the first
+   * page.
    */
-  password: string | null;
+  cursor?: string;
 
   /**
-   * Body param: Unique username (3–255 chars; letters, numbers, underscores,
-   * hyphens).
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
    */
-  username: string | null;
+  include?: Array<'user' | 'role' | 'department'>;
 
   /**
-   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-   * are returned as `null`.
+   * Maximum number of results to return in a single page.
    */
-  include?: Array<'role' | 'department'>;
+  limit?: number;
 
   /**
-   * Body param: Department assigned to the user.
+   * Free-text search term used to filter results.
+   *
+   * Which fields are matched against the term varies by endpoint.
    */
-  department_id?: string | null;
+  q?: string;
 
   /**
-   * Body param: Notification preferences for the user (external targets only).
+   * Controls whether removed (soft-deleted) account users appear in the list.
+   *
+   * - `excluded`: only active and disabled users (default).
+   * - `included`: removed users are listed as well.
    */
-  preferences?: Array<NotificationPreferenceItem>;
+  removed_scope?: 'excluded' | 'included';
 
   /**
-   * Body param: Role assigned to the user.
+   * Filter by role type.
+   *
+   * - `admin`: account administrators.
+   * - `user`: users with a custom role.
+   * - `scanner`: scanning station users.
+   * - `sales_rep`: sales representatives.
+   * - `agent`: automated agents.
    */
-  role_id?: string | null;
+  role_type?: 'admin' | 'user' | 'scanner' | 'sales_rep' | 'agent';
 }
 
 export interface AccountUserRetrieveParams {
@@ -262,23 +309,26 @@ export interface AccountUserRetrieveParams {
    * Sub-objects to expand in the response. When omitted, sub-objects are returned as
    * `null`.
    */
-  include?: Array<'role' | 'department'>;
+  include?: Array<'user' | 'role' | 'department'>;
 }
 
-export interface AccountUserUpdateParams {
+export interface AccountUserCreateParams {
   /**
    * Query param: Sub-objects to expand in the response. When omitted, sub-objects
    * are returned as `null`.
    */
-  include?: Array<'role' | 'department'>;
+  include?: Array<'user' | 'role' | 'department'>;
 
   /**
-   * Body param: Department assigned to the user.
+   * Body param: ID of the department to assign to the user.
    */
-  department_id?: string | null;
+  department_id?: string;
 
   /**
    * Body param: User email address.
+   *
+   * Either `email` or `username` must be provided. If a user with this email already
+   * exists, that user is added to the account instead of a new user being created.
    */
   email?: string;
 
@@ -288,53 +338,88 @@ export interface AccountUserUpdateParams {
   name?: string;
 
   /**
-   * Body param: Notification preferences to update (external targets only).
+   * Body param: Password for scanning station users.
+   *
+   * Required when creating a scanning station user (username without email) and
+   * rejected for all other users, who instead receive a generated password in their
+   * welcome email. Must be 8–72 characters and include an uppercase letter, a
+   * lowercase letter, a number, and a special character.
+   */
+  password?: string;
+
+  /**
+   * Body param: Notification preference toggles for the new user.
+   *
+   * Only applies when creating a user in another account you manage (cross-account);
+   * ignored when creating a user in your own account.
    */
   preferences?: Array<NotificationPreferenceItem>;
 
   /**
-   * Body param: Role assigned to the user.
+   * Body param: ID of the role to assign to the user.
+   *
+   * Ignored for scanning station users, which are always assigned the scanner role.
    */
-  role_id?: string | null;
+  role_id?: string;
 
   /**
-   * Body param: Unique username (3–255 chars; letters, numbers, underscores,
-   * hyphens).
+   * Body param: Unique username.
+   *
+   * 3–255 characters; letters, numbers, underscores, and hyphens. Either `email` or
+   * `username` must be provided. Providing a username without an email creates a
+   * scanning station user.
    */
   username?: string;
 }
 
-export interface AccountUserListParams {
+export interface AccountUserUpdateParams {
   /**
-   * Cursor token used to retrieve the next or previous page of results.
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
    */
-  cursor?: string;
+  include?: Array<'user' | 'role' | 'department'>;
 
   /**
-   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
-   * `null`.
+   * Body param: ID of the department to assign to the user.
+   *
+   * Set to `null` to clear the department.
    */
-  include?: Array<'role' | 'department'>;
+  department_id?: string | null;
 
   /**
-   * Maximum number of results per page (default: 100, max: 1000).
+   * Body param: User email address.
+   *
+   * Must not already be in use by another user.
    */
-  limit?: number;
+  email?: string;
 
   /**
-   * Search query used to filter results.
+   * Body param: User display name.
    */
-  q?: string;
+  name?: string;
 
   /**
-   * Controls whether removed account users are included.
+   * Body param: Notification preference toggles to apply.
+   *
+   * Only allowed when updating a user in another account you manage (cross-account);
+   * rejected otherwise. Notification types omitted from the list are left unchanged.
    */
-  removed_scope?: 'excluded' | 'included';
+  preferences?: Array<NotificationPreferenceItem>;
 
   /**
-   * Filter by role type code.
+   * Body param: ID of the role to assign to the user.
+   *
+   * Set to `null` to clear the role.
    */
-  role_type?: 'admin' | 'user' | 'scanner' | 'sales_rep' | 'agent';
+  role_id?: string | null;
+
+  /**
+   * Body param: Unique username.
+   *
+   * 3–255 characters; letters, numbers, underscores, and hyphens. Must not already
+   * be in use by another user.
+   */
+  username?: string;
 }
 
 AccountUsers.Actions = Actions;
@@ -345,10 +430,10 @@ export declare namespace AccountUsers {
     type ListAccountUser as ListAccountUser,
     type NotificationPreferenceItem as NotificationPreferenceItem,
     type UpdateAccountUserRequest as UpdateAccountUserRequest,
-    type AccountUserCreateParams as AccountUserCreateParams,
+    type AccountUserListParams as AccountUserListParams,
     type AccountUserRetrieveParams as AccountUserRetrieveParams,
+    type AccountUserCreateParams as AccountUserCreateParams,
     type AccountUserUpdateParams as AccountUserUpdateParams,
-    type AccountUserListParams as AccountUserListParams,
   };
 
   export {

package/src/resources/identity/account-users/actions.ts

@@ -10,7 +10,11 @@ import { path } from '../../../internal/utils/path';
  */
 export class Actions extends APIResource {
   /**
-   * Activates a disabled or removed account user.
+   * Activates a disabled or removed account user, restoring their access to the
+   * target account.
+   *
+   * Reactivation consumes a seat, so the request fails if the account is at its seat
+   * limit. Activating an already-active user is a no-op.
    *
    * @example
    * ```ts
@@ -25,8 +29,11 @@ export class Actions extends APIResource {
   }
 
   /**
-   * Disables an account user. Disabled users will not be able to access the target
-   * account.
+   * Disables (locks) an account user.
+   *
+   * Disabled users cannot access the target account and their active sessions are
+   * revoked. Admin users cannot be disabled, you cannot disable yourself, and
+   * removed users must be activated before they can be disabled.
    *
    * @example
    * ```ts
@@ -43,6 +50,9 @@ export class Actions extends APIResource {
   /**
    * Removes a user from the target account.
    *
+   * Removal is a soft delete: removed users are excluded from listings unless
+   * requested via `removed_scope`, and can be restored with the activate action.
+   *
    * @example
    * ```ts
    * const action =

package/src/resources/identity/account-users/index.ts

@@ -6,10 +6,10 @@ export {
   type ListAccountUser,
   type NotificationPreferenceItem,
   type UpdateAccountUserRequest,
-  type AccountUserCreateParams,
+  type AccountUserListParams,
   type AccountUserRetrieveParams,
+  type AccountUserCreateParams,
   type AccountUserUpdateParams,
-  type AccountUserListParams,
 } from './account-users';
 export {
   Actions,

package/src/resources/identity/identity.ts

@@ -41,10 +41,10 @@ export declare namespace Identity {
     type ListAccountUser as ListAccountUser,
     type NotificationPreferenceItem as NotificationPreferenceItem,
     type UpdateAccountUserRequest as UpdateAccountUserRequest,
-    type AccountUserCreateParams as AccountUserCreateParams,
+    type AccountUserListParams as AccountUserListParams,
     type AccountUserRetrieveParams as AccountUserRetrieveParams,
+    type AccountUserCreateParams as AccountUserCreateParams,
     type AccountUserUpdateParams as AccountUserUpdateParams,
-    type AccountUserListParams as AccountUserListParams,
   };
 
   export {
@@ -53,9 +53,9 @@ export declare namespace Identity {
     type ListRole as ListRole,
     type UpdateRoleRequest as UpdateRoleRequest,
     type RoleDeleteResponse as RoleDeleteResponse,
-    type RoleCreateParams as RoleCreateParams,
+    type RoleListParams as RoleListParams,
     type RoleRetrieveParams as RoleRetrieveParams,
+    type RoleCreateParams as RoleCreateParams,
     type RoleUpdateParams as RoleUpdateParams,
-    type RoleListParams as RoleListParams,
   };
 }

package/src/resources/identity/index.ts

@@ -6,10 +6,10 @@ export {
   type ListAccountUser,
   type NotificationPreferenceItem,
   type UpdateAccountUserRequest,
-  type AccountUserCreateParams,
+  type AccountUserListParams,
   type AccountUserRetrieveParams,
+  type AccountUserCreateParams,
   type AccountUserUpdateParams,
-  type AccountUserListParams,
 } from './account-users/index';
 export { Identity } from './identity';
 export {
@@ -18,8 +18,8 @@ export {
   type ListRole,
   type UpdateRoleRequest,
   type RoleDeleteResponse,
-  type RoleCreateParams,
+  type RoleListParams,
   type RoleRetrieveParams,
+  type RoleCreateParams,
   type RoleUpdateParams,
-  type RoleListParams,
 } from './roles';