import type { constants_ApiObject } from './constants_ApiObject'; export type api_ClientItem = { /** * AvatarImageUrl is the URL of the client's avatar image. Read-only. */ avatarImageUrl?: string; /** * CompanyID is the ID of the company the client belongs to. In multi-company portals see companyIds. */ companyId?: string; /** * CompanyIDs lists every company the client belongs to in multi-company portals. */ companyIds?: Array; /** * Created is the RFC 3339 timestamp at which the object was created. */ createdAt?: string; /** * CreationMethod records how the client was created. Read-only. */ creationMethod?: api_ClientItem.creationMethod; /** * CustomFields holds custom field values for the client, keyed by custom field key. */ customFields?: any; /** * Deleted is true when the object has been deleted; present only on delete responses. */ deleted?: boolean; /** * Email is the client's email address, used as the unique login identifier within the portal. */ email?: string; /** * FallbackColor is the hex color (e.g. "#4F46E5") used as the avatar background when * no avatar image is set. The native pattern documents intent; the constraint is * re-applied to the spec by the enrich-openapi post-processing step. */ fallbackColor?: string; /** * FamilyName is the client's last (family) name. */ familyName?: string; /** * FirstLogin is the timestamp of the client's first login. Read-only. */ firstLoginDate?: string; /** * GivenName is the client's first (given) name. */ givenName?: string; /** * ID is the unique identifier of the object. */ id?: string; /** * InviteUrl is the one-time invite link, returned only when an invite has just been sent. Read-only. */ inviteUrl?: string; /** * InvitedBy is the ID of the internal user who invited the client, when applicable. Read-only. */ invitedBy?: string; /** * LastLogin is the timestamp of the client's most recent login. Read-only. */ lastLoginDate?: string; /** * Object is the type of the object (e.g. "client", "company"). */ object?: constants_ApiObject; /** * Status is the client's lifecycle status. Server-managed (read-only). */ status?: api_ClientItem.status; /** * Updated is the RFC 3339 timestamp at which the object was last updated. */ updatedAt?: string; }; export declare namespace api_ClientItem { /** * CreationMethod records how the client was created. Read-only. */ enum creationMethod { CLIENT = "client", DIRECT_SIGN_UP = "directSignUp", IMPORT = "import", INTERNAL_USER = "internalUser" } /** * Status is the client's lifecycle status. Server-managed (read-only). */ enum status { UNKNOWN = "unknown", DELETED = "deleted", ACTIVE = "active", NOT_INVITED = "notInvited", INVITED = "invited" } }