@proteos/sdk 0.50.1 → 0.51.0

package/src/index.ts

@@ -133,15 +133,18 @@ export type {
   CreateApiKeyRequest,
   CreatedApiKey,
   CreateOrganizationRequest,
+  CreateProfileRequest,
   CreateRoleRequest,
   CreateTeamRequest,
   CreateUserRequest,
   ListOrganizationsOptions,
   ListOrgUserRoleAssignmentsOptions,
+  ListProfilesOptions,
   ListRolePermissionsOptions,
   ListRolesOptions,
   ListTeamMembersOptions,
   ListTeamsOptions,
+  ListUserProfileAssignmentsOptions,
   ListUserRoleAssignmentsOptions,
   ListUsersOptions,
   // Me (caller-scoped) service
@@ -153,10 +156,14 @@ export type {
   Permission,
   // Platform entities
   PlatformEntity,
+  // Profile types (the org's user-types, one per user)
+  Profile,
+  ProfileService,
   // Role types
   Role,
   RoleEntityPermission,
   RoleService,
+  SetProfileRequest,
   // Share types (instance-level access)
   SharePermission,
   ShareRow,
@@ -166,11 +173,14 @@ export type {
   TeamService,
   UpdateMeRequest,
   UpdateOrganizationRequest,
+  UpdateProfileRequest,
   UpdateRoleRequest,
   UpdateTeamRequest,
   UpdateUserRequest,
   // User types
   User,
+  UserProfileAssignment,
+  UserProfileAssignmentService,
   // User role assignment types
   UserRoleAssignment,
   UserRoleAssignmentService,
@@ -185,10 +195,12 @@ export {
   OrganizationSchema,
   PLATFORM_ENTITIES,
   PLATFORM_ENTITY_SLUGS,
+  ProfileSchema,
   RoleEntityPermissionSchema,
   RoleSchema,
   SCOPED_PLATFORM_ENTITY_SLUGS,
   shareRouteFor,
+  UserProfileAssignmentSchema,
   UserRoleAssignmentSchema,
   UserSchema,
 } from './auth/index.js'
@@ -224,10 +236,13 @@ export type {
   AllFilterConfig,
   ApplySendingLimitPresetRequest,
   AttachContactAddressRequest,
+  AttachConversationBriefRequest,
   Attachment,
   AutomatedFilterConfig,
   AutomatedSignal,
   BlockContactRequest,
+  BounceClassification,
+  BounceKind,
   CallStatus,
   CallTokenResponse,
   Channel,
@@ -239,6 +254,9 @@ export type {
   ChannelActionStatus,
   ChannelActionTargetKind,
   ChannelActionType,
+  ChannelEvent,
+  ChannelEventService,
+  ChannelEventType,
   Connection,
   ConnectionCredentials,
   ConnectionScope,
@@ -246,6 +264,7 @@ export type {
   ConnectionStatus,
   ConnectionSyncRange,
   ConnectionSyncStatus,
+  ConnectorCatalogEntry,
   ConnectorKey,
   ConnectorProvider,
   ConsentStatus,
@@ -265,6 +284,9 @@ export type {
   // Aliased: the agent module already exports its own ContentBlock.
   ContentBlock as MessageContentBlock,
   Conversation,
+  ConversationBrief,
+  ConversationBriefService,
+  ConversationBriefStatus,
   ConversationFilter,
   ConversationFilterAction,
   ConversationFilterConfig,
@@ -281,6 +303,8 @@ export type {
   CreateAgentListenerRequest,
   CreateConnectionRequest,
   CreateContactGroupRequest,
+  CreateContactRequest,
+  CreateConversationBriefRequest,
   CreateConversationFilterRequest,
   CreateConversationTypeRequest,
   CreateGlossaryTermRequest,
@@ -288,9 +312,23 @@ export type {
   CreateToneProfileSetupRequest,
   DispatchMeetingBotRequest,
   DomainFilterConfig,
+  EmailDnsRecord,
+  EmailDomainStatus,
+  EmailEngagementQuality,
+  EmailHealth,
+  EmailHealthWindow,
+  EmailIp,
+  EmailProviderHealth,
+  EmailProviderStats,
+  EmailSender,
+  EmailSenderStatus,
+  EmailSuppression,
+  EmailSuppressionCounts,
+  EmailSuppressionKind,
   ErasureRequestStatus,
   FilterMatchOn,
   FrequencyCapRuleConfig,
+  GetConnectionHealthQuery,
   GlossaryTerm,
   GlossaryTermService,
   InmailParams,
@@ -300,11 +338,13 @@ export type {
   LimitRuleConfig,
   ListAgentListenersQuery,
   ListChannelActionsQuery,
+  ListChannelEventsQuery,
   ListConnectionsQuery,
   ListContactAddressesQuery,
   ListContactGroupsQuery,
   ListContactMergeProposalsQuery,
   ListContactsQuery,
+  ListConversationBriefsQuery,
   ListConversationFilterEventsQuery,
   ListConversationFiltersQuery,
   ListConversationsQuery,
@@ -324,6 +364,8 @@ export type {
   MergeContactsRequest,
   MergeProposalStatus,
   Message,
+  MessageDelivery,
+  MessageDeliveryStatus,
   MessageDirection,
   MessagePreview,
   MessageRecipient,
@@ -363,6 +405,7 @@ export type {
   SendingRuleType,
   SendMessageRequest,
   SendRecipient,
+  SetDefaultSenderRequest,
   SyncConnectionRequest,
   ToneProfile,
   ToneProfileScope,
@@ -380,6 +423,7 @@ export type {
   UpdateConnectionRequest,
   UpdateContactGroupRequest,
   UpdateContactRequest,
+  UpdateConversationBriefRequest,
   UpdateConversationFilterRequest,
   UpdateConversationTypeRequest,
   UpdateDraftRequest,
@@ -388,6 +432,7 @@ export type {
   UpdateSendingRuleRequest,
   VoiceService,
   VoiceTranscriptionStream,
+  WarmupRuleConfig,
   Weekday,
   WindowDay,
   WindowRuleConfig,
@@ -535,6 +580,11 @@ export {
 export type {
   // App types
   App,
+  // AppConfiguration types
+  AppConfiguration,
+  AppConfigurationService,
+  AppHome,
+  AppHomeType,
   AppService,
   // Array/enum attribute metas (config_schema renderers narrow on these)
   ArrayAttributeMeta,
@@ -548,6 +598,7 @@ export type {
   // Component types
   Component,
   ComponentService,
+  CreateAppConfigurationRequest,
   CreateAppRequest,
   CreateComponentRequest,
   CreateDesignReferenceRequest,
@@ -579,6 +630,7 @@ export type {
   FilterGroup,
   // List types
   List,
+  ListAppConfigurationsOptions,
   ListAppsOptions,
   ListComponentsOptions,
   ListDesignReferencesOptions,
@@ -619,6 +671,7 @@ export type {
   RelationAttributeMeta,
   SortConfig,
   SortDirection,
+  UpdateAppConfigurationRequest,
   UpdateAppRequest,
   UpdateComponentRequest,
   UpdateDesignReferenceRequest,
@@ -636,6 +689,8 @@ export type {
 // Value-level constants from meta
 // Meta Zod schemas
 export {
+  AppConfigurationSchema,
+  AppHomeSchema,
   AppSchema,
   AttributeSchema,
   acceptsCurrentUserDefault,

package/src/meta/app-configurations.ts

@@ -0,0 +1,100 @@
+import type { ProteosClient } from '../client.js'
+import { PageIterator } from '../iterator.js'
+import type { ListResult } from '../types/common.js'
+import type {
+  AppConfiguration,
+  CreateAppConfigurationRequest,
+  ListAppConfigurationsOptions,
+  UpdateAppConfigurationRequest,
+} from './types.js'
+
+const APP_CONFIGURATIONS_BASE_PATH = '/meta/v1/app-configurations'
+
+/**
+ * Service for app configurations — the typed (app × profile) binding rows
+ * that say how an app presents itself: home, menu, agents, record pages.
+ * `profile_slug: ''` is the app's base configuration for everyone; a row with
+ * a profile is that profile's override (merged field-wise over the base).
+ */
+export interface AppConfigurationService {
+  /** Lists app configurations (auto-paginating iterator). */
+  list(
+    options?: ListAppConfigurationsOptions,
+  ): PageIterator<AppConfiguration, ListAppConfigurationsOptions>
+
+  /** Fetches a single page of app configurations. */
+  listPage(options?: ListAppConfigurationsOptions): Promise<ListResult<AppConfiguration>>
+
+  /** Gets an app configuration by slug (404 when unknown). */
+  get(slug: string): Promise<AppConfiguration>
+
+  /**
+   * Creates an app configuration. Every reference (app, home list/page, menu,
+   * record pages) must exist; `profile_slug` and agent keys are other
+   * services' and are not validated.
+   * @throws {ProteosError} 409 `app_configuration_already_exists` when the
+   *   (app_slug, profile_slug) pair is already bound.
+   */
+  create(request: CreateAppConfigurationRequest): Promise<AppConfiguration>
+
+  /**
+   * Creates or replaces an app configuration idempotently by slug
+   * (`PUT /meta/v1/app-configurations/:slug`). Replaces the whole
+   * configuration; the (app_slug, profile_slug) binding of an existing slug
+   * is immutable.
+   */
+  upsert(slug: string, request: CreateAppConfigurationRequest): Promise<AppConfiguration>
+
+  /** Partially updates an app configuration (`home: null` clears the home). */
+  update(slug: string, request: UpdateAppConfigurationRequest): Promise<AppConfiguration>
+
+  /** Deletes an app configuration. */
+  delete(slug: string): Promise<void>
+}
+
+export class AppConfigurationServiceImpl implements AppConfigurationService {
+  constructor(private readonly client: ProteosClient) {}
+
+  list(
+    options: ListAppConfigurationsOptions = {},
+  ): PageIterator<AppConfiguration, ListAppConfigurationsOptions> {
+    return new PageIterator((opts) => this.listPage(opts), options)
+  }
+
+  async listPage(
+    options: ListAppConfigurationsOptions = {},
+  ): Promise<ListResult<AppConfiguration>> {
+    return this.client.requestWithQuery<ListResult<AppConfiguration>>(
+      'GET',
+      APP_CONFIGURATIONS_BASE_PATH,
+      options,
+    )
+  }
+
+  async get(slug: string): Promise<AppConfiguration> {
+    return this.client.request<AppConfiguration>('GET', `${APP_CONFIGURATIONS_BASE_PATH}/${slug}`)
+  }
+
+  async create(request: CreateAppConfigurationRequest): Promise<AppConfiguration> {
+    return this.client.request<AppConfiguration>('POST', APP_CONFIGURATIONS_BASE_PATH, request)
+  }
+
+  async upsert(slug: string, request: CreateAppConfigurationRequest): Promise<AppConfiguration> {
+    return this.client.request<AppConfiguration>('PUT', `${APP_CONFIGURATIONS_BASE_PATH}/${slug}`, {
+      ...request,
+      slug,
+    })
+  }
+
+  async update(slug: string, request: UpdateAppConfigurationRequest): Promise<AppConfiguration> {
+    return this.client.request<AppConfiguration>(
+      'PATCH',
+      `${APP_CONFIGURATIONS_BASE_PATH}/${slug}`,
+      request,
+    )
+  }
+
+  async delete(slug: string): Promise<void> {
+    await this.client.request<void>('DELETE', `${APP_CONFIGURATIONS_BASE_PATH}/${slug}`)
+  }
+}

package/src/meta/index.ts

@@ -1,4 +1,5 @@
 import type { ProteosClient } from '../client.js'
+import { type AppConfigurationService, AppConfigurationServiceImpl } from './app-configurations.js'
 import { type AppService, AppServiceImpl } from './apps.js'
 import { type ComponentService, ComponentServiceImpl } from './components.js'
 import { type DesignReferenceService, DesignReferenceServiceImpl } from './design-references.js'
@@ -79,6 +80,12 @@ export class MetaClient {
    */
   readonly apps: AppService
 
+  /**
+   * Service for managing app configurations — the typed (app × profile)
+   * bindings: home, menu, agents, record pages.
+   */
+  readonly appConfigurations: AppConfigurationService
+
   /**
    * Service for managing design references (stored DESIGN.md documents).
    */
@@ -99,10 +106,12 @@ export class MetaClient {
     this.pages = new PageServiceImpl(client)
     this.menuConfigurations = new MenuConfigurationServiceImpl(client)
     this.apps = new AppServiceImpl(client)
+    this.appConfigurations = new AppConfigurationServiceImpl(client)
     this.designReferences = new DesignReferenceServiceImpl(client)
   }
 }
 
+export type { AppConfigurationService } from './app-configurations.js'
 export type { AppService } from './apps.js'
 export type { ComponentService } from './components.js'
 export * from './currency/index.js'
@@ -120,16 +129,21 @@ export type { PageService } from './pages.js'
 export type {
   // App types
   App,
+  // AppConfiguration types
+  AppConfiguration,
+  AppHome,
+  AppHomeType,
   ArrayAttributeMeta,
   Attribute,
-  AttributeMeta,
   AttributeAccessRule,
+  AttributeMeta,
   AttributeRestrictions,
   AttributeType,
   Column,
   ComparisonOperator,
   // Component types
   Component,
+  CreateAppConfigurationRequest,
   CreateAppRequest,
   CreateComponentRequest,
   CreateDesignReferenceRequest,
@@ -142,6 +156,7 @@ export type {
   // Currency attribute meta + value
   CurrencyAttributeMeta,
   CurrencyValue,
+  CurrentUserDefault,
   DatetimeAttributeMeta,
   DatetimeFormat,
   DeployModuleRequest,
@@ -159,6 +174,7 @@ export type {
   FilterGroup,
   // List types
   List,
+  ListAppConfigurationsOptions,
   ListAppsOptions,
   ListComponentsOptions,
   ListDesignReferencesOptions,
@@ -188,6 +204,10 @@ export type {
   PageAction,
   PageActionKind,
   PageType,
+  // User attribute meta
+  PrincipalAttributeMeta,
+  PrincipalRef,
+  PrincipalType,
   PublicAccessOperation,
   PublicPageComponent,
   PublicPageResponse,
@@ -197,6 +217,7 @@ export type {
   SortDirection,
   StringAttributeMeta,
   StringFormat,
+  UpdateAppConfigurationRequest,
   UpdateAppRequest,
   UpdateComponentRequest,
   UpdateDesignReferenceRequest,
@@ -206,11 +227,6 @@ export type {
   UpdateMenuConfigurationRequest,
   UpdatePageRequest,
   UpdateVariableRequest,
-  // User attribute meta
-  PrincipalAttributeMeta,
-  CurrentUserDefault,
-  PrincipalRef,
-  PrincipalType,
   UserAttributeMeta,
   // Variable types
   Variable,
@@ -218,10 +234,14 @@ export type {
 // Re-export value-level constants
 // Re-export Zod schemas
 export {
+  AppConfigurationSchema,
+  AppHomeSchema,
   AppSchema,
   AttributeSchema,
+  acceptsCurrentUserDefault,
   ColumnSchema,
   ComponentSchema,
+  CURRENT_USER_DEFAULT,
   CurrencyAttributeMetaSchema,
   DesignReferenceSchema,
   EntitySchema,
@@ -229,6 +249,7 @@ export {
   FileAttributeMetaSchema,
   FilterElementSchema,
   FilterGroupSchema,
+  isCurrentUserDefault,
   isPlatformAttributeName,
   ListSchema,
   ListViewSchema,
@@ -240,12 +261,9 @@ export {
   PageActionSchema,
   PageSchema,
   PLATFORM_ATTRIBUTE_NAMES,
-  CURRENT_USER_DEFAULT,
-  acceptsCurrentUserDefault,
-  isCurrentUserDefault,
   parseCurrencyMeta,
-  parsePrincipalMeta,
   parseFileMeta,
+  parsePrincipalMeta,
   parseRelationMeta,
   parseUserMeta,
   platformAttributes,

package/src/meta/types.ts

@@ -994,7 +994,6 @@ export interface List extends AuditFields {
   /** Row-selection affordance; absent normalizes to `on_demand`. */
   selection_mode?: SelectionMode
   /** Record page to open from this list; empty/absent = org default for the entity. */
-  default_page_slug?: string
   sorting: SortConfig[]
   filters: FilterGroup[]
 }
@@ -1018,7 +1017,6 @@ export const ListSchema = AuditFieldsSchema.extend({
   columns: z.array(ColumnSchema),
   actions: z.array(PageActionSchema).optional(),
   selection_mode: SelectionModeSchema.optional(),
-  default_page_slug: z.string().optional(),
   sorting: z.array(SortConfigSchema),
   filters: z.array(FilterGroupSchema),
 })
@@ -1044,7 +1042,6 @@ export interface CreateListRequest {
   columns: Column[]
   actions?: PageAction[]
   selection_mode?: SelectionMode
-  default_page_slug?: string
   sorting: SortConfig[]
   filters: FilterGroup[]
 }
@@ -1059,7 +1056,6 @@ export interface UpdateListRequest {
   actions?: PageAction[]
   selection_mode?: SelectionMode
   /** Set to '' to clear back to the org default. */
-  default_page_slug?: string
   sorting?: SortConfig[]
   filters?: FilterGroup[]
 }
@@ -1329,6 +1325,100 @@ export interface UpdateMenuConfigurationRequest {
   is_default?: boolean
 }
 
+// ============================================================================
+// AppConfiguration Types
+// ============================================================================
+
+/** What an app opens on: a list (records table) or a platform page. */
+export type AppHomeType = 'list' | 'page'
+
+export interface AppHome {
+  type: AppHomeType
+  reference: string
+}
+
+export const AppHomeSchema = z.object({
+  type: z.enum(['list', 'page']),
+  reference: z.string(),
+})
+
+/**
+ * AppConfiguration — a TYPED binding row: "how app X presents itself" to
+ * everyone (`profile_slug: ''` = the app's default configuration) or to one
+ * profile (an override). One row per (app, profile). The web merges
+ * override ⊕ default field-wise and falls through to structural defaults (menu
+ * `is_default`, first menu leaf, org-default agent, first page) for anything
+ * still unset.
+ */
+export interface AppConfiguration extends AuditFields {
+  slug: string
+  org_id: string
+  module_slug: string
+  app_slug: string
+  /** Bound profile; `''` = the default configuration for everyone. */
+  profile_slug: string
+  /** Home; absent = the first list/page leaf of the resolved menu. */
+  home?: AppHome | null
+  /** Menu to show; `''` = the app's `is_default` menu. */
+  menu_slug?: string
+  /** Agent Ask Proteos preselects in this app; `''` = the org default. */
+  default_agent_key?: string
+  /** Agents offered in this app; empty = every org agent. */
+  agent_keys?: string[]
+  /** entity_slug → record page slug opened from this app. */
+  record_pages?: Record<string, string>
+}
+
+export const AppConfigurationSchema = AuditFieldsSchema.extend({
+  slug: z.string(),
+  org_id: z.string(),
+  module_slug: z.string(),
+  app_slug: z.string(),
+  profile_slug: z.string(),
+  home: AppHomeSchema.nullable().optional(),
+  menu_slug: z.string().optional(),
+  default_agent_key: z.string().optional(),
+  agent_keys: z.array(z.string()).optional(),
+  record_pages: z.record(z.string()).optional(),
+})
+
+export interface ListAppConfigurationsOptions extends MetaListOptions {
+  slug?: string
+  module_slug?: string
+  app_slug?: string
+  profile_slug?: string
+  /** `true` = only default rows (no profile), `false` = only profile overrides.
+   *  An empty `profile_slug` is never sent, so this is how default rows are
+   *  selected. */
+  is_default?: boolean
+  menu_slug?: string
+}
+
+export interface CreateAppConfigurationRequest {
+  slug: string
+  module_slug?: string
+  app_slug: string
+  profile_slug?: string
+  home?: AppHome | null
+  menu_slug?: string
+  default_agent_key?: string
+  agent_keys?: string[]
+  record_pages?: Record<string, string>
+}
+
+/**
+ * Partial update. `home` is tri-state: absent = unchanged, `null` = clear,
+ * object = set. The (app_slug, profile_slug) binding is immutable.
+ */
+export interface UpdateAppConfigurationRequest {
+  module_slug?: string
+  home?: AppHome | null
+  menu_slug?: string
+  default_agent_key?: string
+  agent_keys?: string[]
+  record_pages?: Record<string, string>
+}
+
 // ============================================================================
 // App Types
 // ============================================================================

package/src/workflow/types.ts

@@ -456,6 +456,8 @@ export interface Workflow extends AuditFields {
   key: string
   name: string
   description: string
+  /** Slug of the module that deployed this workflow; empty when it is org-owned. */
+  module_slug: string
   status: WorkflowStatus
   graph: WorkflowGraph
   version: number
@@ -533,6 +535,15 @@ export interface ListWorkflowsOptions extends ListOptions {
   name?: string
   'name[contains]'?: string
   status?: WorkflowStatus
+  /**
+   * Restrict to one module's workflows. The empty string is meaningful: it
+   * matches only the org-owned workflows no module deployed.
+   *
+   * `sort_by` additionally accepts a comma-separated list of sortable fields
+   * (`module_slug,name`) so a grouped list can order by its grouping column
+   * first; `sort_direction` applies to all of them.
+   */
+  module_slug?: string
 }
 
 // ---------------------------------------------------------------------------