@proteos/sdk 0.49.0 → 0.51.0

package/src/auth/index.ts

@@ -1,9 +1,14 @@
 import type { ProteosClient } from '../client.js'
 import { type MeService, MeServiceImpl } from './me.js'
 import { type OrganizationService, OrganizationServiceImpl } from './organizations.js'
+import { type ProfileService, ProfileServiceImpl } from './profiles.js'
 import { type RoleService, RoleServiceImpl } from './roles.js'
 import { type ShareService, ShareServiceImpl } from './shares.js'
 import { type TeamService, TeamServiceImpl } from './teams.js'
+import {
+  type UserProfileAssignmentService,
+  UserProfileAssignmentServiceImpl,
+} from './user-profile-assignments.js'
 import {
   type UserRoleAssignmentService,
   UserRoleAssignmentServiceImpl,
@@ -53,6 +58,16 @@ export class AccountClient {
    */
   readonly userRoleAssignments: UserRoleAssignmentService
 
+  /**
+   * Service for managing profiles (the org's user-types, one per user).
+   */
+  readonly profiles: ProfileService
+
+  /**
+   * Service for the org-wide user-profile-assignment listing.
+   */
+  readonly userProfileAssignments: UserProfileAssignmentService
+
   /**
    * Service for managing organizations.
    */
@@ -83,6 +98,8 @@ export class AccountClient {
     this.users = new UserServiceImpl(client)
     this.roles = new RoleServiceImpl(client)
     this.userRoleAssignments = new UserRoleAssignmentServiceImpl(client)
+    this.profiles = new ProfileServiceImpl(client)
+    this.userProfileAssignments = new UserProfileAssignmentServiceImpl(client)
     this.organizations = new OrganizationServiceImpl(client)
     this.teams = new TeamServiceImpl(client)
     this.shares = new ShareServiceImpl(client)
@@ -99,14 +116,16 @@ export {
   PLATFORM_ENTITY_SLUGS,
   SCOPED_PLATFORM_ENTITY_SLUGS,
 } from './platform-entities.js'
+export type { ProfileService } from './profiles.js'
 export type { RoleService } from './roles.js'
+// Share routing — exported so a UI can hide a share affordance it cannot serve.
+export { isShareable, type ShareService, shareRouteFor } from './shares.js'
 export type { TeamService } from './teams.js'
-export type { UserRoleAssignmentService } from './user-role-assignments.js'
 // Re-export types
 export type {
+  AddTeamMemberRequest,
   // Api key types
   ApiKey,
-  AddTeamMemberRequest,
   AssignPermissionRequest,
   AssignRoleRequest,
   // Shared types
@@ -114,38 +133,46 @@ export type {
   CreateApiKeyRequest,
   CreatedApiKey,
   CreateOrganizationRequest,
+  CreateProfileRequest,
   CreateRoleRequest,
   CreateTeamRequest,
   CreateUserRequest,
   ListOrganizationsOptions,
+  ListOrgUserRoleAssignmentsOptions,
+  ListProfilesOptions,
   ListRolePermissionsOptions,
   ListRolesOptions,
   ListTeamMembersOptions,
   ListTeamsOptions,
-  ListOrgUserRoleAssignmentsOptions,
+  ListUserProfileAssignmentsOptions,
   ListUserRoleAssignmentsOptions,
   ListUsersOptions,
   // Organization types
   Organization,
   // Permission types
   Permission,
+  // Profile types
+  Profile,
   // Role types
   Role,
   RoleEntityPermission,
+  SetProfileRequest,
+  // Share types
+  SharePermission,
+  ShareRequest,
+  ShareRow,
   // Team types
   Team,
   TeamMember,
   UpdateMeRequest,
   UpdateOrganizationRequest,
+  UpdateProfileRequest,
   UpdateRoleRequest,
   UpdateTeamRequest,
   UpdateUserRequest,
   // User types
   User,
-  // Share types
-  SharePermission,
-  ShareRequest,
-  ShareRow,
+  UserProfileAssignment,
   // User role assignment types
   UserRoleAssignment,
 } from './types.js'
@@ -153,16 +180,18 @@ export type {
 export {
   ApiKeySchema,
   OrganizationSchema,
-  SharePermissionSchema,
-  ShareRequestSchema,
+  ProfileSchema,
   RoleEntityPermissionSchema,
   RoleSchema,
+  SharePermissionSchema,
+  ShareRequestSchema,
   TeamMemberSchema,
   TeamSchema,
+  UserProfileAssignmentSchema,
   UserRoleAssignmentSchema,
   UserSchema,
 } from './types.js'
+export type { UserProfileAssignmentService } from './user-profile-assignments.js'
+export type { UserRoleAssignmentService } from './user-role-assignments.js'
 // Re-export service interfaces
 export type { UserService } from './users.js'
-// Share routing — exported so a UI can hide a share affordance it cannot serve.
-export { isShareable, type ShareService, shareRouteFor } from './shares.js'

package/src/auth/me.ts

@@ -1,5 +1,5 @@
 import type { ProteosClient } from '../client.js'
-import type { Organization, UpdateMeRequest, User } from './types.js'
+import type { Organization, Profile, UpdateMeRequest, User } from './types.js'
 
 const ME_BASE_PATH = '/accounts/v1/me'
 
@@ -33,6 +33,14 @@ export interface MeService {
    * @returns The caller's organizations
    */
   organizations(): Promise<Organization[]>
+
+  /**
+   * Gets the caller's profile in the token org — the subject app
+   * configurations are resolved against.
+   *
+   * @throws {ProteosError} 404 when the caller has no profile
+   */
+  profile(): Promise<Profile>
 }
 
 /**
@@ -56,4 +64,8 @@ export class MeServiceImpl implements MeService {
     )
     return response.data
   }
+
+  async profile(): Promise<Profile> {
+    return this.client.request<Profile>('GET', `${ME_BASE_PATH}/profile`)
+  }
 }

package/src/auth/platform-entities.ts

@@ -27,12 +27,18 @@ export const PLATFORM_ENTITIES: readonly PlatformEntity[] = [
   // who is in it are different decisions, and membership is what moves access.
   { slug: 'teams', name: 'Teams' },
   { slug: 'team-members', name: 'Team Members' },
+  // Profiles are the org's user-types (UI defaults; app configurations key on
+  // them). ONE per user per org. Managing and assigning are separate grants.
+  { slug: 'profiles', name: 'Profiles' },
+  { slug: 'user-profile-assignments', name: 'User Profile Assignments' },
   // The share audit trail — a distinct grant from the resources it references.
   // Schema / content (metadata-service)
   { slug: 'entities', name: 'Entities' },
   { slug: 'pages', name: 'Pages' },
   { slug: 'menu-configurations', name: 'Menu Configurations' },
   { slug: 'apps', name: 'Apps' },
+  // Typed (app × profile) binding rows: home, menu, agents, record pages.
+  { slug: 'app-configurations', name: 'App Configurations' },
   { slug: 'components', name: 'Components' },
   { slug: 'lists', name: 'Lists' },
   { slug: 'list-views', name: 'List Views' },
@@ -88,6 +94,17 @@ export const PLATFORM_ENTITIES: readonly PlatformEntity[] = [
   { slug: 'contact-groups', name: 'Contact Groups' },
   // Tone-of-voice synthesis: per-user setups + generated instruction profiles.
   { slug: 'tone-profiles', name: 'Tone Profiles' },
+  // Outbound send constraints (windows, connection limits, frequency caps) +
+  // their preset catalog.
+  { slug: 'sending-rules', name: 'Sending Rules' },
+  // The channel_action ledger: acts through a connection that are neither a
+  // message nor a reaction (LinkedIn invitations, profile visits, InMail).
+  { slug: 'channel-actions', name: 'Channel Actions' },
+  // The channel_event ledger: provider-observed delivery / engagement events
+  // about outbound messages (delivered, bounced, opened, unsubscribed).
+  { slug: 'channel-events', name: 'Channel Events' },
+  // Conversation briefs: guidance prepared ahead of a conversation (call, meeting) with a contact.
+  { slug: 'conversation-briefs', name: 'Conversation Briefs' },
   // Connectors (connector-service). `connections` above is shared; this is the
   // manifest catalog.
   { slug: 'connectors', name: 'Connectors' },

package/src/auth/profiles.ts

@@ -0,0 +1,82 @@
+import type { ProteosClient } from '../client.js'
+import { PageIterator } from '../iterator.js'
+import type { ListResult } from '../types/common.js'
+import type {
+  CreateProfileRequest,
+  ListProfilesOptions,
+  Profile,
+  UpdateProfileRequest,
+} from './types.js'
+
+const PROFILES_BASE_PATH = '/accounts/v1/profiles'
+
+/**
+ * Service for managing profiles — the org's user-types (ONE per user per
+ * org). Per-user assignment lives on {@link UserService} (`getProfile` /
+ * `setProfile` / `clearProfile`); the org-wide roster on
+ * {@link UserProfileAssignmentService}.
+ */
+export interface ProfileService {
+  /** Lists profiles (auto-paginating iterator). */
+  list(options?: ListProfilesOptions): PageIterator<Profile, ListProfilesOptions>
+
+  /** Fetches a single page of profiles. */
+  listPage(options?: ListProfilesOptions): Promise<ListResult<Profile>>
+
+  /** Gets a profile by slug (404 when unknown). */
+  get(slug: string): Promise<Profile>
+
+  /** Creates a profile. The org is taken from the caller's token. */
+  create(request: CreateProfileRequest): Promise<Profile>
+
+  /**
+   * Creates or updates a profile idempotently by slug
+   * (`PUT /accounts/v1/profiles/:slug`). The URL slug wins on mismatch.
+   */
+  upsert(slug: string, request: CreateProfileRequest): Promise<Profile>
+
+  /** Partially updates a profile. */
+  update(slug: string, request: UpdateProfileRequest): Promise<Profile>
+
+  /**
+   * Deletes a profile.
+   * @throws {ProteosError} 409 `profile_in_use` while users still hold it —
+   *   move them first.
+   */
+  delete(slug: string): Promise<void>
+}
+
+export class ProfileServiceImpl implements ProfileService {
+  constructor(private readonly client: ProteosClient) {}
+
+  list(options: ListProfilesOptions = {}): PageIterator<Profile, ListProfilesOptions> {
+    return new PageIterator((opts) => this.listPage(opts), options)
+  }
+
+  async listPage(options: ListProfilesOptions = {}): Promise<ListResult<Profile>> {
+    return this.client.requestWithQuery<ListResult<Profile>>('GET', PROFILES_BASE_PATH, options)
+  }
+
+  async get(slug: string): Promise<Profile> {
+    return this.client.request<Profile>('GET', `${PROFILES_BASE_PATH}/${slug}`)
+  }
+
+  async create(request: CreateProfileRequest): Promise<Profile> {
+    return this.client.request<Profile>('POST', PROFILES_BASE_PATH, request)
+  }
+
+  async upsert(slug: string, request: CreateProfileRequest): Promise<Profile> {
+    return this.client.request<Profile>('PUT', `${PROFILES_BASE_PATH}/${slug}`, {
+      ...request,
+      slug,
+    })
+  }
+
+  async update(slug: string, request: UpdateProfileRequest): Promise<Profile> {
+    return this.client.request<Profile>('PATCH', `${PROFILES_BASE_PATH}/${slug}`, request)
+  }
+
+  async delete(slug: string): Promise<void> {
+    await this.client.request<void>('DELETE', `${PROFILES_BASE_PATH}/${slug}`)
+  }
+}

package/src/auth/types.ts

@@ -248,6 +248,93 @@ export interface CreateApiKeyRequest {
   expires_at?: string
 }
 
+// ============================================================================
+// Profile Types
+// ============================================================================
+
+/**
+ * Profile — the org's user-type. ONE per user per org (unlike roles, which
+ * are many and only decide access). Owns the defaults keyed by subject alone:
+ * the app opened after login and the app-switcher allowlist. Metadata app
+ * configurations bind per-app defaults (home, menu, agents, record pages) to a
+ * profile by slug.
+ */
+export interface Profile extends AuditFields {
+  slug: string
+  name: string
+  org_id: string
+  description: string
+  /** Module that shipped the profile; '' when authored in the org. */
+  module_slug: string
+  /** App opened after login; clients fail open to the first visible app. */
+  default_app_slug: string
+  /** App-switcher allowlist; empty = every app in the org. */
+  app_slugs: string[]
+}
+
+export const ProfileSchema = AuditFieldsSchema.extend({
+  slug: z.string(),
+  name: z.string(),
+  org_id: z.string(),
+  description: z.string(),
+  module_slug: z.string(),
+  default_app_slug: z.string(),
+  app_slugs: z.array(z.string()),
+})
+
+export interface CreateProfileRequest {
+  slug: string
+  name: string
+  description?: string
+  module_slug?: string
+  default_app_slug?: string
+  app_slugs?: string[]
+}
+
+export interface UpdateProfileRequest {
+  name?: string
+  description?: string
+  module_slug?: string
+  default_app_slug?: string
+  app_slugs?: string[]
+}
+
+export interface ListProfilesOptions extends AuthListOptions {
+  slug?: string
+  name?: string
+  module_slug?: string
+  default_app_slug?: string
+}
+
+/**
+ * User profile assignment — a user's ONE profile in an org.
+ */
+export interface UserProfileAssignment extends AuditFields {
+  id: string
+  user_id: string
+  profile_slug: string
+  org_id: string
+}
+
+export const UserProfileAssignmentSchema = AuditFieldsSchema.extend({
+  id: z.string(),
+  user_id: z.string(),
+  profile_slug: z.string(),
+  org_id: z.string(),
+})
+
+/** Body of `PUT /users/:id/profile` — replaces the user's profile. */
+export interface SetProfileRequest {
+  profile_slug: string
+}
+
+/** Filters for the org-wide `GET /user-profile-assignments` listing. */
+export interface ListUserProfileAssignmentsOptions extends AuthListOptions {
+  id?: string
+  user_id?: string
+  profile_slug?: string
+}
+
 // ============================================================================
 // Role Types
 // ============================================================================

package/src/auth/user-profile-assignments.ts

@@ -0,0 +1,41 @@
+import type { ProteosClient } from '../client.js'
+import { PageIterator } from '../iterator.js'
+import type { ListResult } from '../types/common.js'
+import type { ListUserProfileAssignmentsOptions, UserProfileAssignment } from './types.js'
+
+const USER_PROFILE_ASSIGNMENTS_BASE_PATH = '/accounts/v1/user-profile-assignments'
+
+/**
+ * Service for the org-wide user-profile-assignment listing: "who holds which
+ * profile" in one request (a profile's member roster, profile badges on a
+ * user list). Per-user reads and writes stay on {@link UserService}.
+ */
+export interface UserProfileAssignmentService {
+  /** Lists profile assignments across all users of the caller's org. */
+  list(
+    options?: ListUserProfileAssignmentsOptions,
+  ): PageIterator<UserProfileAssignment, ListUserProfileAssignmentsOptions>
+
+  /** Fetches a single page of profile assignments. */
+  listPage(options?: ListUserProfileAssignmentsOptions): Promise<ListResult<UserProfileAssignment>>
+}
+
+export class UserProfileAssignmentServiceImpl implements UserProfileAssignmentService {
+  constructor(private readonly client: ProteosClient) {}
+
+  list(
+    options: ListUserProfileAssignmentsOptions = {},
+  ): PageIterator<UserProfileAssignment, ListUserProfileAssignmentsOptions> {
+    return new PageIterator((opts) => this.listPage(opts), options)
+  }
+
+  async listPage(
+    options: ListUserProfileAssignmentsOptions = {},
+  ): Promise<ListResult<UserProfileAssignment>> {
+    return this.client.requestWithQuery<ListResult<UserProfileAssignment>>(
+      'GET',
+      USER_PROFILE_ASSIGNMENTS_BASE_PATH,
+      options,
+    )
+  }
+}

package/src/auth/users.ts

@@ -9,8 +9,10 @@ import type {
   CreateUserRequest,
   ListUserRoleAssignmentsOptions,
   ListUsersOptions,
+  SetProfileRequest,
   UpdateUserRequest,
   User,
+  UserProfileAssignment,
   UserRoleAssignment,
 } from './types.js'
 
@@ -120,6 +122,25 @@ export interface UserService {
    */
   unassignRole(userId: string, roleSlug: string): Promise<void>
 
+  /**
+   * Gets the user's profile assignment in the caller's org.
+   *
+   * @throws {ProteosError} 404 when the user has no profile
+   */
+  getProfile(userId: string): Promise<UserProfileAssignment>
+
+  /**
+   * Sets (replaces) the user's profile in the caller's org — one profile per
+   * user per org.
+   *
+   * @throws {ProteosError} 404 when the user or the profile slug is unknown;
+   *   400 `user_not_in_org` when the user holds no role in the org
+   */
+  setProfile(userId: string, request: SetProfileRequest): Promise<UserProfileAssignment>
+
+  /** Clears the user's profile (back to every app's default configuration). */
+  clearProfile(userId: string): Promise<void>
+
   /**
    * Lists a user's API keys (display hints only — never tokens).
    *
@@ -193,6 +214,22 @@ export class UserServiceImpl implements UserService {
     await this.client.request<void>('DELETE', `${USERS_BASE_PATH}/${userId}/roles/${roleSlug}`)
   }
 
+  async getProfile(userId: string): Promise<UserProfileAssignment> {
+    return this.client.request<UserProfileAssignment>('GET', `${USERS_BASE_PATH}/${userId}/profile`)
+  }
+
+  async setProfile(userId: string, request: SetProfileRequest): Promise<UserProfileAssignment> {
+    return this.client.request<UserProfileAssignment>(
+      'PUT',
+      `${USERS_BASE_PATH}/${userId}/profile`,
+      request,
+    )
+  }
+
+  async clearProfile(userId: string): Promise<void> {
+    await this.client.request<void>('DELETE', `${USERS_BASE_PATH}/${userId}/profile`)
+  }
+
   async listApiKeys(userId: string): Promise<ApiKey[]> {
     const response = await this.client.request<{ data: ApiKey[] }>(
       'GET',