@proteos/sdk 0.49.0 → 0.51.0

package/src/errors.ts

@@ -23,12 +23,24 @@ export class ProteosError extends Error {
   readonly httpStatus: number
   /** API error code (e.g., 'not_found', 'unauthorized') */
   readonly code: ErrorCodeType | string
-
-  constructor(message: string, httpStatus: number, code: ErrorCodeType | string) {
+  /**
+   * Optional machine-readable payload beside the message — e.g. a denied send's
+   * `earliest_allowed_at` / `rule_id`, the offending `contact_id`. Absent on
+   * most errors.
+   */
+  readonly details: Record<string, unknown> | undefined
+
+  constructor(
+    message: string,
+    httpStatus: number,
+    code: ErrorCodeType | string,
+    details?: Record<string, unknown>,
+  ) {
     super(message)
     this.name = 'ProteosError'
     this.httpStatus = httpStatus
     this.code = code
+    this.details = details
 
     // V8-specific API for cleaner stack traces; not present in all runtimes
     const v8Capture = (Error as unknown as { captureStackTrace?: (t: object, c: unknown) => void })
@@ -112,6 +124,7 @@ export function getDefaultErrorCode(httpStatus: number): ErrorCodeType | string
 export interface ApiErrorResponse {
   code?: string
   message?: string
+  details?: Record<string, unknown>
 }
 
 /**
@@ -121,6 +134,7 @@ export async function parseErrorResponse(response: Response): Promise<ProteosErr
   const httpStatus = response.status
   let code: string = getDefaultErrorCode(httpStatus)
   let message = 'Unknown error'
+  let details: Record<string, unknown> | undefined
 
   try {
     const body = await response.text()
@@ -136,6 +150,9 @@ export async function parseErrorResponse(response: Response): Promise<ProteosErr
       } else {
         message = body || `HTTP ${httpStatus}`
       }
+      if (json.details && typeof json.details === 'object') {
+        details = json.details
+      }
     } catch {
       // Not JSON, use body as message
       message = body.trim() || `HTTP ${httpStatus}`
@@ -144,5 +161,5 @@ export async function parseErrorResponse(response: Response): Promise<ProteosErr
     message = `HTTP ${httpStatus}`
   }
 
-  return new ProteosError(message, httpStatus, code)
+  return new ProteosError(message, httpStatus, code, details)
 }

package/src/index.ts

@@ -64,8 +64,8 @@ export type {
   ListPromptsOptions,
   ListSessionsOptions,
   ListSkillsOptions,
-  ListToolsOptions,
   ListToolsetsOptions,
+  ListToolsOptions,
   McpBinding,
   McpConnectionState,
   McpConnectionStatus,
@@ -78,9 +78,11 @@ export type {
   ModelRequestEndPayload,
   ModelRequestStartPayload,
   ModelUsage,
+  PlatformBinding,
   Prompt,
   PromptService,
   PromptVersion,
+  QueryBinding,
   ReasoningPayload,
   ResultBlock,
   Session,
@@ -99,18 +101,16 @@ export type {
   StartMcpOAuthResponse,
   StopReason,
   TextBlock,
-  PlatformBinding,
-  QueryBinding,
   Tool,
   ToolBinding,
   ToolConfirmationPayload,
   ToolKind,
   ToolResultPayload,
+  ToolService,
   Toolset,
   ToolsetKind,
   ToolsetService,
   ToolsetToolSummary,
-  ToolService,
   ToolUsePayload,
   Turn,
   UpdateAgentRequest,
@@ -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,24 +156,31 @@ 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,
+  ShareService,
   Team,
   TeamMember,
   TeamService,
   UpdateMeRequest,
   UpdateOrganizationRequest,
+  UpdateProfileRequest,
   UpdateRoleRequest,
   UpdateTeamRequest,
   UpdateUserRequest,
-  // Share types (instance-level access)
-  SharePermission,
-  ShareRow,
-  ShareService,
   // User types
   User,
+  UserProfileAssignment,
+  UserProfileAssignmentService,
   // User role assignment types
   UserRoleAssignment,
   UserRoleAssignmentService,
@@ -185,10 +195,12 @@ export {
   OrganizationSchema,
   PLATFORM_ENTITIES,
   PLATFORM_ENTITY_SLUGS,
-  SCOPED_PLATFORM_ENTITY_SLUGS,
+  ProfileSchema,
   RoleEntityPermissionSchema,
   RoleSchema,
+  SCOPED_PLATFORM_ENTITY_SLUGS,
   shareRouteFor,
+  UserProfileAssignmentSchema,
   UserRoleAssignmentSchema,
   UserSchema,
 } from './auth/index.js'
@@ -222,14 +234,29 @@ export type {
   AgentListenerService,
   AgentListenerTriggerType,
   AllFilterConfig,
+  ApplySendingLimitPresetRequest,
   AttachContactAddressRequest,
+  AttachConversationBriefRequest,
   Attachment,
   AutomatedFilterConfig,
   AutomatedSignal,
   BlockContactRequest,
+  BounceClassification,
+  BounceKind,
   CallStatus,
   CallTokenResponse,
   Channel,
+  ChannelAction,
+  ChannelActionCapability,
+  ChannelActionParams,
+  ChannelActionResponse,
+  ChannelActionService,
+  ChannelActionStatus,
+  ChannelActionTargetKind,
+  ChannelActionType,
+  ChannelEvent,
+  ChannelEventService,
+  ChannelEventType,
   Connection,
   ConnectionCredentials,
   ConnectionScope,
@@ -237,6 +264,7 @@ export type {
   ConnectionStatus,
   ConnectionSyncRange,
   ConnectionSyncStatus,
+  ConnectorCatalogEntry,
   ConnectorKey,
   ConnectorProvider,
   ConsentStatus,
@@ -256,6 +284,9 @@ export type {
   // Aliased: the agent module already exports its own ContentBlock.
   ContentBlock as MessageContentBlock,
   Conversation,
+  ConversationBrief,
+  ConversationBriefService,
+  ConversationBriefStatus,
   ConversationFilter,
   ConversationFilterAction,
   ConversationFilterConfig,
@@ -272,24 +303,48 @@ export type {
   CreateAgentListenerRequest,
   CreateConnectionRequest,
   CreateContactGroupRequest,
+  CreateContactRequest,
+  CreateConversationBriefRequest,
   CreateConversationFilterRequest,
   CreateConversationTypeRequest,
   CreateGlossaryTermRequest,
+  CreateSendingRuleRequest,
   CreateToneProfileSetupRequest,
   DispatchMeetingBotRequest,
   DomainFilterConfig,
+  EmailDnsRecord,
+  EmailDomainStatus,
+  EmailEngagementQuality,
+  EmailHealth,
+  EmailHealthWindow,
+  EmailIp,
+  EmailProviderHealth,
+  EmailProviderStats,
+  EmailSender,
+  EmailSenderStatus,
+  EmailSuppression,
+  EmailSuppressionCounts,
+  EmailSuppressionKind,
   ErasureRequestStatus,
   FilterMatchOn,
+  FrequencyCapRuleConfig,
+  GetConnectionHealthQuery,
   GlossaryTerm,
   GlossaryTermService,
+  InmailParams,
   InstallConnectionResponse,
   InternalConversationsFilterConfig,
+  InvitationParams,
+  LimitRuleConfig,
   ListAgentListenersQuery,
+  ListChannelActionsQuery,
+  ListChannelEventsQuery,
   ListConnectionsQuery,
   ListContactAddressesQuery,
   ListContactGroupsQuery,
   ListContactMergeProposalsQuery,
   ListContactsQuery,
+  ListConversationBriefsQuery,
   ListConversationFilterEventsQuery,
   ListConversationFiltersQuery,
   ListConversationsQuery,
@@ -301,12 +356,16 @@ export type {
   // PageIterator-based ListResult used by the other modules.
   ListResponse,
   ListRoomsQuery,
+  ListSendingLimitPresetsQuery,
+  ListSendingRulesQuery,
   ListToneProfileSetupsQuery,
   ListToneProfilesQuery,
   MeetingService,
   MergeContactsRequest,
   MergeProposalStatus,
   Message,
+  MessageDelivery,
+  MessageDeliveryStatus,
   MessageDirection,
   MessagePreview,
   MessageRecipient,
@@ -314,15 +373,16 @@ export type {
   MessageStatus,
   MintCallTokenRequest,
   MistranscribedTerm,
-  PhoneNumber,
-  PhoneNumberRouting,
-  PhoneNumberStatus,
-  RoutingTarget,
   MistranscribedTermService,
   MistranscribedTermStatus,
   MistranscriptionSuggestionSource,
+  PerformChannelActionRequest,
   PermissionEventSource,
   PermissionEventType,
+  PhoneNumber,
+  PhoneNumberRouting,
+  PhoneNumberStatus,
+  ProfileVisitParams,
   Reaction,
   ReactionCapability,
   ReactionOption,
@@ -331,10 +391,21 @@ export type {
   RecipientRole,
   RecordPermissionEventRequest,
   ResolveToneProfileQuery,
+  RespondChannelActionRequest,
   RoleBasedFilterConfig,
   Room,
+  RoutingTarget,
+  SendEligibility,
+  SendEligibilityRequest,
+  SendingLimitPreset,
+  SendingPeriod,
+  SendingRule,
+  SendingRuleConfig,
+  SendingRuleService,
+  SendingRuleType,
   SendMessageRequest,
   SendRecipient,
+  SetDefaultSenderRequest,
   SyncConnectionRequest,
   ToneProfile,
   ToneProfileScope,
@@ -352,13 +423,19 @@ export type {
   UpdateConnectionRequest,
   UpdateContactGroupRequest,
   UpdateContactRequest,
+  UpdateConversationBriefRequest,
   UpdateConversationFilterRequest,
   UpdateConversationTypeRequest,
   UpdateDraftRequest,
   UpdateGlossaryTermRequest,
   UpdatePhoneNumberRequest,
+  UpdateSendingRuleRequest,
   VoiceService,
   VoiceTranscriptionStream,
+  WarmupRuleConfig,
+  Weekday,
+  WindowDay,
+  WindowRuleConfig,
 } from './conversation/index.js'
 // Conversation client (conversation-service)
 export { ConversationClient } from './conversation/index.js'
@@ -503,11 +580,15 @@ export {
 export type {
   // App types
   App,
+  // AppConfiguration types
+  AppConfiguration,
+  AppConfigurationService,
+  AppHome,
+  AppHomeType,
   AppService,
   // Array/enum attribute metas (config_schema renderers narrow on these)
   ArrayAttributeMeta,
   Attribute,
-  CurrentUserDefault,
   // Attribute-level access restrictions (read/write allow-lists of role + team slugs)
   AttributeAccessRule,
   AttributeRestrictions,
@@ -517,6 +598,7 @@ export type {
   // Component types
   Component,
   ComponentService,
+  CreateAppConfigurationRequest,
   CreateAppRequest,
   CreateComponentRequest,
   CreateDesignReferenceRequest,
@@ -530,6 +612,7 @@ export type {
   CurrencyAttributeMeta,
   CurrencySymbolSide,
   CurrencyValue,
+  CurrentUserDefault,
   DeployModuleRequest,
   // DesignReference types
   DesignReference,
@@ -547,6 +630,7 @@ export type {
   FilterGroup,
   // List types
   List,
+  ListAppConfigurationsOptions,
   ListAppsOptions,
   ListComponentsOptions,
   ListDesignReferencesOptions,
@@ -587,6 +671,7 @@ export type {
   RelationAttributeMeta,
   SortConfig,
   SortDirection,
+  UpdateAppConfigurationRequest,
   UpdateAppRequest,
   UpdateComponentRequest,
   UpdateDesignReferenceRequest,
@@ -604,11 +689,15 @@ export type {
 // Value-level constants from meta
 // Meta Zod schemas
 export {
+  AppConfigurationSchema,
+  AppHomeSchema,
   AppSchema,
   AttributeSchema,
+  acceptsCurrentUserDefault,
   allCurrencyCodes,
   ColumnSchema,
   ComponentSchema,
+  CURRENT_USER_DEFAULT,
   CurrencyAttributeMetaSchema,
   currencyLabel,
   currencySymbol,
@@ -620,10 +709,8 @@ export {
   FilterGroupSchema,
   formatAmount,
   formatMoney,
-  isPlatformAttributeName,
-  CURRENT_USER_DEFAULT,
-  acceptsCurrentUserDefault,
   isCurrentUserDefault,
+  isPlatformAttributeName,
   ListSchema,
   ListViewSchema,
   localeNumberSeparators,

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,