@dossier-wiki/os-sdk 0.1.1 → 0.7.0

package/dist/types.d.ts

@@ -2,6 +2,124 @@ export interface Paginated<T> {
     data: T[];
     pagination: PaginationMeta;
 }
+/** A resource tag assignment: slugified `value` + snapshotted `label`. */
+export interface TagValue {
+    /** Slugified, stable key (catalogue value). */
+    value: string;
+    /** Human-readable label snapshot at assignment time. */
+    label: string;
+}
+/**
+ * Tag assignment input. Pass `label` only and the slug `value` is derived
+ * server-side, or pass both to pin a specific catalogue value.
+ */
+export interface TagValueInput {
+    label: string;
+    value?: string;
+}
+/** The eight catalogue-governed tag field-keys. */
+export type TagFieldKey = 'customer.tags' | 'customer.riskTags' | 'counterparty.tags' | 'counterparty.riskTags' | 'alert.dispositionTags' | 'address.tags' | 'rule.tags' | 'identificationDocument.tags';
+export type TagCatalogueEnforcement = 'open' | 'strict';
+export interface TagCatalogueEntry {
+    id: string;
+    fieldKey: TagFieldKey;
+    value: string;
+    label: string;
+    color?: string | null;
+    description?: string | null;
+    archivedAt?: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface TagCatalogueEntryInput {
+    fieldKey: TagFieldKey;
+    label: string;
+    value?: string;
+    color?: string;
+    description?: string;
+}
+export interface UpdateTagCatalogueEntryInput {
+    label?: string;
+    color?: string;
+    description?: string;
+}
+export interface TagFieldEnforcement {
+    fieldKey: TagFieldKey;
+    enforcement: TagCatalogueEnforcement;
+}
+export interface SetTagEnforcementInput {
+    fieldKey: TagFieldKey;
+    enforcement: TagCatalogueEnforcement;
+}
+export type TypedFieldType = 'TEXT' | 'NUMBER' | 'BOOLEAN' | 'DATE' | 'SET' | 'CURRENCY' | 'MONETARY';
+/** Schema declaration carried on a parent resource (e.g. `Product.typedAccountFieldConfig`). */
+export interface TypedFieldDefinition {
+    key: string;
+    displayName: string;
+    type: TypedFieldType;
+    required: boolean;
+    /** Default applied at write time when the caller omits the key. Raw value, validated against `type`. */
+    defaultValue?: unknown;
+    description?: string | null;
+}
+/**
+ * Caller-facing input for one typed key/value entry. `type` tells the
+ * backend validator how to interpret `value`:
+ *   - TEXT / DATE / CURRENCY → string
+ *   - NUMBER → finite JS number
+ *   - BOOLEAN → boolean
+ *   - SET → string[]
+ *   - MONETARY → denominated literal `"<amount>@<TYPE:CODE>"`, e.g. `"50000.00@FIAT:USD"`
+ */
+export interface TypedFieldValueInput {
+    key: string;
+    type: TypedFieldType;
+    value: unknown;
+}
+/** Untyped escape-hatch input (Tier C). Stored verbatim. */
+export interface UntypedKeyValueInput {
+    key: string;
+    value: unknown;
+}
+/**
+ * Read shape for one typed key/value entry. Wire-format `type` strings use
+ * the lowercase form. Monetary carries pre-resolved minor units.
+ */
+export type TypedFieldStored = {
+    key: string;
+    type: 'text';
+    value: string;
+} | {
+    key: string;
+    type: 'number';
+    value: number;
+} | {
+    key: string;
+    type: 'boolean';
+    value: boolean;
+} | {
+    key: string;
+    type: 'date';
+    value: string;
+} | {
+    key: string;
+    type: 'set';
+    value: string[];
+} | {
+    key: string;
+    type: 'currency';
+    value: string;
+} | {
+    key: string;
+    type: 'monetary';
+    amountMinor: number;
+    currency: string;
+    precision: number;
+};
+export interface UntypedKeyValueDto {
+    key: string;
+    value: unknown;
+}
 export interface AccountResponseDto {
     id: string;
     externalId?: string;
@@ -12,11 +130,10 @@ export interface AccountResponseDto {
     accountType: 'CHECKING' | 'SAVINGS' | 'OPERATING' | 'TRUST' | 'INVESTMENT' | 'ESCROW' | 'CREDIT_CARD' | 'LINE_OF_CREDIT' | 'PERSONAL_LOAN' | 'MORTGAGE' | 'AUTO_LOAN' | 'BUSINESS_LOAN' | 'CRYPTO_WALLET' | 'MOBILE_WALLET' | 'PREPAID_CARD' | 'E_WALLET' | 'BROKERAGE' | 'FUND' | 'OTHER';
     status: 'ACTIVE' | 'FROZEN' | 'CLOSED' | 'DORMANT';
     currency?: string;
-    bankName?: string;
-    bankSwift?: string;
-    iban?: string;
-    accountNumber?: string;
-    customProperties?: Record<string, unknown>;
+    /** Typed Field bag (Tier A). Validated against `Product.typedAccountFieldConfig`. */
+    fields?: TypedFieldStored[];
+    /** Untyped escape hatch (Tier C). */
+    otherProperties?: UntypedKeyValueDto[];
     openedAt: string;
     closedAt?: string;
 }
@@ -67,7 +184,7 @@ export interface AddressDto {
     ownerResourceId: string;
     category?: AddressCategory | null;
     iso20022Type?: Iso20022AddressType | null;
-    tags: string[];
+    tags: TagValue[];
     note?: string | null;
     line1?: string | null;
     line2?: string | null;
@@ -106,7 +223,7 @@ export interface AddressDto {
 export interface AddressInputDto {
     category?: AddressCategory;
     iso20022Type?: Iso20022AddressType;
-    tags?: string[];
+    tags?: TagValueInput[];
     note?: string;
     line1?: string;
     line2?: string;
@@ -302,7 +419,8 @@ export interface CounterpartyResponseDto {
     identity: 'INDIVIDUAL' | 'ENTITY' | 'UNKNOWN';
     classification: 'BANK_ACCOUNT' | 'WALLET' | 'MERCHANT' | 'FINANCIAL_INSTITUTION' | 'PAYMENT_NETWORK' | 'UNKNOWN';
     country?: string;
-    riskLevel: 'HIGH' | 'MEDIUM' | 'LOW' | 'UNRATED';
+    /** Unified risk rating; null = unrated (was `riskLevel` with UNRATED). */
+    riskRating: 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL' | null;
     source: 'MANUAL' | 'SYSTEM';
     linkedCustomerIds: string[];
     /** ID of the transaction that first created this counterparty */
@@ -313,25 +431,34 @@ export interface CounterpartyResponseDto {
     institution?: InstitutionDetailsDto;
     firstTransactionAt?: string;
     lastTransactionAt?: string;
+    /** Untyped escape hatch (Tier C). */
+    otherProperties?: UntypedKeyValueDto[];
     createdAt: string;
     updatedAt: string;
 }
 export interface CreateAccountDto {
-    /** Your external identifier */
+    /**
+     * Customer to register as the PRIMARY owner. Written into
+     * `account_owners`, not stored on the accounts row (D18).
+     */
+    primaryCustomerId: string;
+    /** Your external identifier. Defaults to `ACC-${timestamp}`. */
     externalId?: string;
-    /** Product ID this account is based on */
+    /**
+     * Product this account is instantiated from. Determines `accountCategory`
+     * / `accountType` and the required typed-field schema — those are NOT
+     * accepted from the caller (Phase 3b).
+     */
     productId?: string;
     label: string;
-    accountCategory: 'DEPOSIT' | 'CREDIT' | 'LOAN' | 'WALLET' | 'SECURITIES' | 'OTHER';
-    accountType: 'CHECKING' | 'SAVINGS' | 'OPERATING' | 'TRUST' | 'INVESTMENT' | 'ESCROW' | 'CREDIT_CARD' | 'LINE_OF_CREDIT' | 'PERSONAL_LOAN' | 'MORTGAGE' | 'AUTO_LOAN' | 'BUSINESS_LOAN' | 'CRYPTO_WALLET' | 'MOBILE_WALLET' | 'PREPAID_CARD' | 'E_WALLET' | 'BROKERAGE' | 'FUND' | 'OTHER';
-    /** Currency code (ISO 4217) */
+    /** Currency code (ISO 4217 / `TYPE:CODE`). Falls back to `product.defaultCurrency`. */
     currency?: string;
-    bankName?: string;
-    bankSwift?: string;
-    iban?: string;
-    accountNumber?: string;
-    /** Arbitrary key-value properties */
-    customProperties?: Record<string, unknown>;
+    /** Typed Field write input (Tier A). Validated against `Product.typedAccountFieldConfig`. */
+    fields?: TypedFieldValueInput[];
+    /** Untyped escape hatch (Tier C). Stored verbatim. */
+    otherProperties?: UntypedKeyValueInput[];
+    /** Customer IDs to add as JOINT owners alongside the primary. */
+    additionalOwnerIds?: string[];
     /** Override account opening timestamp (ISO 8601). Used by data-loading tools to backfill historical accounts. */
     openedAt?: string;
 }
@@ -351,7 +478,7 @@ export interface CreateConstantDto {
     /** Scope (derived from name if omitted). */
     scope?: 'global' | 'product' | 'customer' | 'account' | 'counterparty' | 'instrument' | 'device';
     /** Constant type. Determines the required shape of `value`. */
-    type: 'scalar' | 'monetary' | 'set' | 'range' | 'text' | 'number' | 'boolean' | 'date' | 'currency';
+    type: 'scalar' | 'monetary' | 'set' | 'range' | 'text' | 'number' | 'boolean' | 'date' | 'currency' | 'regex';
     /** Payload shape depends on the constant's `type`. Pick the matching variant below. Validated at write time. */
     value: {
         /** e.g. `"1000000@FIAT:USD"` = $10,000.00. Precision implied by currency: USD=2, JPY=0, BTC=8, ETH=9, USDT/USDC=6. */
@@ -458,22 +585,29 @@ export interface CreateProductDto {
     country?: string;
     /** Supported transaction method IDs. */
     supportedMethodIds: string[];
-    /** Arbitrary product metadata. */
-    metadata?: Record<string, unknown>;
+    /**
+     * Typed Field schema for accounts of this product (Tier A). Each entry is
+     * a `TypedFieldDefinition`; validates `Account.fields` writes.
+     */
+    typedAccountFieldConfig?: TypedFieldDefinition[];
+    /** Product-level typed bag (Tier B, self-declaring). */
+    fields?: TypedFieldValueInput[];
+    /** Untyped escape hatch (Tier C). */
+    otherProperties?: UntypedKeyValueInput[];
     /** Sync key for config-as-code management. */
     syncKey?: string;
 }
 export interface CreateRiskAssessmentDto {
     answers: RiskAssessmentAnswerDto[];
-    resultingRiskLevel: 'HIGH' | 'MEDIUM' | 'LOW' | 'UNRATED';
-    computedRiskLevel?: 'HIGH' | 'MEDIUM' | 'LOW' | 'UNRATED';
+    resultingRiskRating: 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL';
+    computedRiskRating?: 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL';
     ratingOverridden?: boolean;
     overrideJustification?: string;
     narrative?: string;
-    riskTags?: string[];
+    riskTags?: TagValueInput[];
 }
-export interface CreateRiskQuestionnaireDto {
-    answers: RiskQuestionnaireAnswerDto[];
+export interface CreateCustomerRiskAssessmentDto {
+    answers: CustomerRiskAssessmentAnswerDto[];
     /** Optional narrative summary */
     narrative?: string;
 }
@@ -488,8 +622,8 @@ export interface CreateRuleDto {
     trigger?: string;
     /** Rule severity. */
     severity: 'HIGH' | 'MEDIUM' | 'LOW';
-    /** Tags for categorisation. */
-    tags?: string[];
+    /** Tags for categorisation (tag catalogue). */
+    tags?: TagValueInput[];
     /** Condition tree (AND/OR logic with leaf conditions). */
     conditionTree?: Record<string, unknown>;
     /** Actions to execute when the rule triggers. */
@@ -742,7 +876,7 @@ export interface IdentificationDocument {
     status: IdentificationDocumentStatus;
     effectiveStatus: IdentificationDocumentEffectiveStatus;
     rejectionNarrative?: string;
-    tags: string[];
+    tags: TagValue[];
     attachments: IdDocFileAttachment[];
     /** @deprecated Use attachments[].fileId instead. */
     fileIds?: string[];
@@ -775,7 +909,7 @@ export interface CreateIdentificationDocumentInput {
     sex?: string;
     /** Free-form key/value metadata. */
     other?: Record<string, unknown>;
-    tags?: string[];
+    tags?: TagValueInput[];
     attachments?: IdDocFileAttachmentInput[];
     notes?: string;
 }
@@ -791,7 +925,7 @@ export interface UpdateIdentificationDocumentInput {
     dateOfBirth?: string;
     sex?: string;
     other?: Record<string, unknown>;
-    tags?: string[];
+    tags?: TagValueInput[];
     attachments?: IdDocFileAttachmentInput[];
     notes?: string;
 }
@@ -946,8 +1080,11 @@ export interface IngestEventDto {
     deviceId?: string;
     /** Session identifier for session-context rules. */
     sessionId?: string;
-    /** Event-specific payload data. Schema depends on event type. */
-    data?: Record<string, unknown>;
+    /**
+     * Typed payload (Typed Fields primitive, Tier B). Validated via the
+     * canonical TypedFields validator and stored in `events.fields`.
+     */
+    fields?: TypedFieldValueInput[];
 }
 export interface IngestTransactionDto {
     /** Your unique identifier for this transaction. Used for idempotency. */
@@ -1253,7 +1390,7 @@ export interface RiskAssessmentAnswerDto {
     selectedOptionId?: string;
     notes?: string;
 }
-export interface RiskQuestionnaireAnswerDto {
+export interface CustomerRiskAssessmentAnswerDto {
     questionId: string;
     question: string;
     answer: string;
@@ -1302,23 +1439,22 @@ export interface TransactionBodyDto {
     metadata?: Record<string, string | number | boolean | MetadataTextWrapperDto | MetadataNumberWrapperDto | MetadataBooleanWrapperDto | MetadataDateWrapperDto | MetadataSetWrapperDto | MetadataCurrencyWrapperDto | MetadataMonetaryWrapperDto>;
 }
 export interface UpdateAccountDto {
-    /** Product ID this account is based on */
-    productId?: string;
     label?: string;
-    /** Currency code (ISO 4217) */
-    currency?: string;
-    bankName?: string;
-    bankSwift?: string;
-    iban?: string;
-    accountNumber?: string;
-    /** Arbitrary key-value properties */
-    customProperties?: Record<string, unknown>;
     /** Override account opening timestamp (ISO 8601). Used by data-loading tools to backfill historical accounts. */
     openedAt?: string;
+    /**
+     * Typed Field write input (Tier A). Merge semantics — supplied keys
+     * overwrite the stored bag, absent keys are preserved. Pass `[]` to clear.
+     * Banking-style values (IBAN, SWIFT, account number, …) live here now,
+     * not as flat columns (Phase 3b).
+     */
+    fields?: TypedFieldValueInput[];
+    /** Untyped escape hatch (Tier C). Stored verbatim. */
+    otherProperties?: UntypedKeyValueInput[];
 }
 export interface UpdateConstantDto {
     /** Constant type. If changed, `value` must be re-supplied in the new shape. */
-    type?: 'scalar' | 'monetary' | 'set' | 'range' | 'text' | 'number' | 'boolean' | 'date' | 'currency';
+    type?: 'scalar' | 'monetary' | 'set' | 'range' | 'text' | 'number' | 'boolean' | 'date' | 'currency' | 'regex';
     /** Payload shape depends on the constant's `type`. Pick the matching variant below. Validated at write time. */
     value?: {
         /** e.g. `"1000000@FIAT:USD"` = $10,000.00. Precision implied by currency: USD=2, JPY=0, BTC=8, ETH=9, USDT/USDC=6. */
@@ -1483,14 +1619,32 @@ export interface UpdateProductDto {
     status?: string;
     /** Supported transaction method IDs. */
     supportedMethodIds?: string[];
-    /** Arbitrary product metadata. */
-    metadata?: Record<string, unknown>;
+    /** Typed Field schema for accounts of this product (Tier A). */
+    typedAccountFieldConfig?: TypedFieldDefinition[];
+    /** Product-level typed bag (Tier B, self-declaring). */
+    fields?: TypedFieldValueInput[];
+    /** Untyped escape hatch (Tier C). */
+    otherProperties?: UntypedKeyValueInput[];
 }
 export interface UpdateRiskRatingDto {
     riskRating: 'LOW' | 'MEDIUM' | 'HIGH' | 'CRITICAL';
     /** Justification for the override */
     justification?: string;
 }
+/** Lifecycle status of a customer (individual or entity). */
+export type CustomerStatus = 'ONBOARDING' | 'IN_REVIEW' | 'ACTIVE' | 'INACTIVE' | 'SUSPENDED' | 'REJECTED';
+export interface UpdateCustomerStatusDto {
+    /** New lifecycle status for the customer. */
+    status: CustomerStatus;
+    /** Audit reason for the status change. */
+    reason?: string;
+}
+export interface UpdateCustomerStatusResponse {
+    customerId: string;
+    status: CustomerStatus;
+    statusReason: string | null;
+    updatedAt: string;
+}
 export interface UpdateRuleDto {
     /** Rule name. */
     name?: string;
@@ -1502,8 +1656,8 @@ export interface UpdateRuleDto {
     trigger?: string;
     /** Rule severity. */
     severity?: 'HIGH' | 'MEDIUM' | 'LOW';
-    /** Tags for categorisation. */
-    tags?: string[];
+    /** Tags for categorisation (tag catalogue). */
+    tags?: TagValueInput[];
     /** Rule status. */
     status?: 'DRAFT' | 'ACTIVE' | 'DISABLED';
     /** Condition tree. */
@@ -1599,6 +1753,11 @@ export interface GetCustomerQuery {
     /** If true, treat the path id as an external customer ID. */
     isExternal?: boolean;
 }
+/**
+ * Response DTOs not enumerated in the public OpenAPI schema. The backend
+ * returns these as full objects but the OpenAPI spec does not publish their
+ * shape. Treated as opaque records — narrow on the caller side.
+ */
 export type OpaqueResponse = Record<string, unknown>;
 export type ApiKeyResponseDto = OpaqueResponse;
 export type TokenResponseDto = OpaqueResponse;
@@ -1642,7 +1801,7 @@ export type PlatformConfirmUploadResponseDto = OpaqueResponse;
 export type StakeholderResponseDto = OpaqueResponse;
 export type DeviceResponseDto = OpaqueResponse;
 export type DeviceSummaryDto = OpaqueResponse;
-export type RiskQuestionnaireResponseDto = OpaqueResponse;
+export type CustomerRiskAssessmentResponseDto = OpaqueResponse;
 export type RiskAssessmentResponseDto = OpaqueResponse;
 export type ExpectedActivityResponseDto = OpaqueResponse;
 export type ScreeningResultDto = OpaqueResponse;
@@ -1653,7 +1812,6 @@ export type ProductResponseDto = OpaqueResponse;
 export type CurrencyResponseDto = OpaqueResponse;
 export type EventDefinitionResponseDto = OpaqueResponse;
 export type WebhookResponseDto = OpaqueResponse;
-export type SyncExportDto = OpaqueResponse;
 export interface SyncSnapshotActor {
     userId: string;
     name: string;
@@ -1677,6 +1835,137 @@ export interface SyncDriftDto {
 export interface CreateSyncSnapshotInput {
     note?: string;
 }
+export interface SyncConfig {
+    $schema?: string;
+    version: number;
+    tenant: {
+        organizationId: string;
+        baseCurrency?: string;
+        displayName?: string;
+    };
+    productDefinitions?: Record<string, SyncProductDefinitionConfig | string>;
+    constants?: Record<string, SyncConstantConfig>;
+    eventDefinitions?: Record<string, SyncEventDefConfig>;
+    webhooks?: Record<string, SyncWebhookConfig>;
+    rules?: Record<string, SyncRuleConfig>;
+    /** Keyed by TYPE:CODE (e.g. "FIAT:USD", "CRYPTO:BTC"). */
+    currencies?: Record<string, SyncCurrencyConfig>;
+    customerFieldPolicy?: Record<string, SyncCustomerFieldPolicyConfig>;
+    accountStatusPolicy?: SyncAccountStatusPolicyConfig;
+}
+export interface SyncCurrencyConfig {
+    name: string;
+    symbol?: string;
+    precision: number;
+    enabled?: boolean;
+    custom?: boolean;
+}
+export interface SyncConstantConfig {
+    type: 'scalar' | 'monetary' | 'set' | 'range' | 'text' | 'number' | 'boolean' | 'date' | 'currency' | 'regex';
+    description: string;
+    values?: string[];
+    value?: string | number | boolean | null;
+    min?: number;
+    max?: number;
+}
+export interface SyncProductDefinitionConfig {
+    name: string;
+    description?: string;
+    category: string;
+    baseType: string;
+    defaultCurrency: string;
+    country?: string;
+    supportedMethods: string[];
+    metadata?: Record<string, unknown>;
+}
+export interface SyncEventDefConfig {
+    name: string;
+    description: string;
+    subject: 'CUSTOMER' | 'ACCOUNT' | 'TRANSACTION';
+}
+export interface SyncWebhookConfig {
+    description: string;
+    url: string;
+    headers?: Record<string, string>;
+    events: string[];
+}
+export interface SyncRuleConfig {
+    name: string;
+    description: string;
+    subject: string;
+    trigger: string;
+    severity: 'HIGH' | 'MEDIUM' | 'LOW';
+    tags?: string[];
+    conditionTree: unknown;
+    actions?: Array<Record<string, unknown>>;
+    initialStatus?: 'DRAFT' | 'ACTIVE' | 'DISABLED';
+    status?: 'DRAFT' | 'ACTIVE' | 'DISABLED';
+}
+export interface SyncCustomerFieldPolicyConfig {
+    source: string;
+    syncTrigger: string;
+    usedBy: string[];
+}
+export interface SyncAccountStatusPolicyConfig {
+    statuses: string[];
+    dormancyThresholdDays?: number;
+    dormancyStrategy?: 'MANUAL' | 'AUTO';
+    usedBy?: Record<string, string[]>;
+}
+/** Request body for `validate` / `plan` / `apply`. */
+export interface SyncConfigBody {
+    config: SyncConfig;
+}
+export type SyncDiffOpType = 'create' | 'update' | 'destroy' | 'archive' | 'tombstone';
+export interface SyncDiffOp {
+    type: SyncDiffOpType;
+    key: string;
+    config?: unknown;
+    changes?: string[];
+}
+export interface SyncImmutableViolation {
+    section: string;
+    key: string;
+    field: string;
+    liveValue: unknown;
+    configValue: unknown;
+}
+export interface SyncPlan {
+    products: SyncDiffOp[];
+    constants: SyncDiffOp[];
+    eventDefs: SyncDiffOp[];
+    webhooks: SyncDiffOp[];
+    rules: SyncDiffOp[];
+    currencies: SyncDiffOp[];
+    immutableViolations: SyncImmutableViolation[];
+}
+/** `POST /v1/config/sync/validate` response. */
+export interface SyncValidationResult {
+    errors: string[];
+    warnings: string[];
+}
+/** `POST /v1/config/sync/plan` response (validation + advisory diff). */
+export interface SyncPlanResult extends SyncValidationResult {
+    plan: SyncPlan;
+}
+export interface SyncApplyResultItem {
+    section: string;
+    key: string;
+    type: SyncDiffOpType;
+    status: 'applied' | 'failed';
+    error?: string;
+}
+/** `POST /v1/config/sync/apply` response. */
+export interface SyncApplyResult {
+    succeeded: number;
+    failed: number;
+    results: SyncApplyResultItem[];
+    immutableViolations: SyncImmutableViolation[];
+}
+export interface SyncExportQuery {
+    /** Include rows without a sync key (keyed by natural id). Used by import/pull. */
+    includeUnsynced?: boolean;
+}
 export type ResetConfigResponseDto = OpaqueResponse;
 export type PushExchangeRatesResponseDto = OpaqueResponse;
 export type BulkCurrencyStatusResponseDto = OpaqueResponse;