Skip to content

system/collections

system/collections

Interfaces

PlatformUserCreateInput

Defined in: platform-utils/src/system/collections.ts:21

Properties

avatar_url?
readonly optional avatar_url?: string | null;

Defined in: platform-utils/src/system/collections.ts:24

email
readonly email: string;

Defined in: platform-utils/src/system/collections.ts:22

kind?
readonly optional kind?: string | null;

Defined in: platform-utils/src/system/collections.ts:27

metadata?
readonly optional metadata?: JsonObject | null;

Defined in: platform-utils/src/system/collections.ts:29

name?
readonly optional name?: string | null;

Defined in: platform-utils/src/system/collections.ts:23

phone?
readonly optional phone?: string | null;

Defined in: platform-utils/src/system/collections.ts:28

role?
readonly optional role?: string | null;

Defined in: platform-utils/src/system/collections.ts:26

status?
readonly optional status?: string | null;

Defined in: platform-utils/src/system/collections.ts:25

PlatformUserRow

Defined in: platform-utils/src/system/collections.ts:10

Extends

Properties

avatar_url
readonly avatar_url: string | null;

Defined in: platform-utils/src/system/collections.ts:13

email
readonly email: string;

Defined in: platform-utils/src/system/collections.ts:11

kind
readonly kind: string | null;

Defined in: platform-utils/src/system/collections.ts:16

metadata
readonly metadata: JsonObject | null;

Defined in: platform-utils/src/system/collections.ts:18

name
readonly name: string | null;

Defined in: platform-utils/src/system/collections.ts:12

norbital_approval_id
norbital_approval_id: string | null;

Defined in: platform-utils/src/system/columns.ts:135

Inherited from
SystemRecordFields.norbital_approval_id

norbital_created_at
norbital_created_at: string = StoredTimestampSchema;

Defined in: platform-utils/src/system/columns.ts:131

Inherited from
SystemRecordFields.norbital_created_at

norbital_id
norbital_id: string;

Defined in: platform-utils/src/system/columns.ts:130

Inherited from
SystemRecordFields.norbital_id

norbital_row_version
norbital_row_version: number;

Defined in: platform-utils/src/system/columns.ts:134

Inherited from
SystemRecordFields.norbital_row_version

norbital_sys_period
norbital_sys_period: string;

Defined in: platform-utils/src/system/columns.ts:133

Inherited from
SystemRecordFields.norbital_sys_period

norbital_updated_at
norbital_updated_at: string = StoredTimestampSchema;

Defined in: platform-utils/src/system/columns.ts:132

Inherited from
SystemRecordFields.norbital_updated_at

phone
readonly phone: string | null;

Defined in: platform-utils/src/system/collections.ts:17

role
readonly role: string | null;

Defined in: platform-utils/src/system/collections.ts:15

status
readonly status: string | null;

Defined in: platform-utils/src/system/collections.ts:14

PlatformUserUpdateInput

Defined in: platform-utils/src/system/collections.ts:32

Properties

avatar_url?
readonly optional avatar_url?: string | null;

Defined in: platform-utils/src/system/collections.ts:35

email?
readonly optional email?: string;

Defined in: platform-utils/src/system/collections.ts:33

kind?
readonly optional kind?: string | null;

Defined in: platform-utils/src/system/collections.ts:38

metadata?
readonly optional metadata?: JsonObject | null;

Defined in: platform-utils/src/system/collections.ts:40

name?
readonly optional name?: string | null;

Defined in: platform-utils/src/system/collections.ts:34

phone?
readonly optional phone?: string | null;

Defined in: platform-utils/src/system/collections.ts:39

role?
readonly optional role?: string | null;

Defined in: platform-utils/src/system/collections.ts:37

status?
readonly optional status?: string | null;

Defined in: platform-utils/src/system/collections.ts:36

Type Aliases

PlatformCollections

type PlatformCollections = { readonly [TName in SystemCollectionName]: TName extends "user" ? CollectionType<PlatformUserRow, PlatformUserCreateInput, PlatformUserUpdateInput> : CollectionType<PlatformSystemRows[TName], CollectionRecord, CollectionRecord> };

Defined in: platform-utils/src/system/collections.ts:171

SystemCollectionName

type SystemCollectionName = typeof SYSTEM_COLLECTION_NAMES[number];

Defined in: platform-utils/src/system/collections.ts:169

Variables

SYSTEM_COLLECTION_DEFINITIONS

const SYSTEM_COLLECTION_DEFINITIONS: object;

Defined in: platform-utils/src/system/collections.ts:186

Type Declaration

approval_request
approval_request: object;
approval_request.fields
fields: (
  | {
  kind: "uuid";
  name: "norbital_id";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_created_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_updated_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "tstzrange";
  name: "norbital_sys_period";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "integer";
  name: "norbital_row_version";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "uuid";
  name: "norbital_approval_id";
  nullable: true;
  readOnly: true;
}
  | {
  array?: undefined;
  kind: string;
  name: "organization_id";
  nullable: false;
}
  | {
  array?: undefined;
  kind: string;
  name: "label";
  nullable: false;
}
  | {
  array?: undefined;
  kind: string;
  name: "approval_config_id";
  nullable: false;
}
  | {
  array?: undefined;
  kind: string;
  name: "collection_name";
  nullable: false;
}
  | {
  array?: undefined;
  kind: string;
  name: "status";
  nullable: false;
}
  | {
  array: true;
  kind: string;
  name: "approval_step_nodes";
  nullable: false;
}
  | {
  array: true;
  kind: string;
  name: "locked_record_refs";
  nullable: false;
}
  | {
  array?: undefined;
  kind: string;
  name: "closed_at";
  nullable: true;
})[];
approval_request.name
name: string = 'approval_request';

audit_event
audit_event: object;
audit_event.fields
fields: (
  | {
  kind: "uuid";
  name: "norbital_id";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_created_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_updated_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "tstzrange";
  name: "norbital_sys_period";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "integer";
  name: "norbital_row_version";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "uuid";
  name: "norbital_approval_id";
  nullable: true;
  readOnly: true;
}
  | {
  kind: string;
  name: "event_type";
  nullable: false;
}
  | {
  kind: string;
  name: "collection_name";
  nullable: true;
}
  | {
  kind: string;
  name: "record_id";
  nullable: true;
}
  | {
  kind: string;
  name: "details";
  nullable: true;
}
  | {
  kind: string;
  name: "actor_id";
  nullable: true;
})[];
audit_event.name
name: string = 'audit_event';
audit_event.recordLabel
recordLabel: string = 'event_type';
audit_event.system
system: true = true;

automation_run
automation_run: object;
automation_run.fields
fields: (
  | {
  kind: "uuid";
  name: "norbital_id";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_created_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_updated_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "tstzrange";
  name: "norbital_sys_period";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "integer";
  name: "norbital_row_version";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "uuid";
  name: "norbital_approval_id";
  nullable: true;
  readOnly: true;
}
  | {
  kind: string;
  name: "automation_name";
  nullable: false;
}
  | {
  kind: string;
  name: "status";
  nullable: false;
}
  | {
  kind: string;
  name: "input";
  nullable: true;
}
  | {
  kind: string;
  name: "output";
  nullable: true;
}
  | {
  kind: string;
  name: "error";
  nullable: true;
}
  | {
  kind: string;
  name: "started_at";
  nullable: true;
}
  | {
  kind: string;
  name: "completed_at";
  nullable: true;
})[];
automation_run.name
name: string = 'automation_run';

chat_session
chat_session: object;
chat_session.fields
fields: (
  | {
  kind: "uuid";
  name: "norbital_id";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_created_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_updated_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "tstzrange";
  name: "norbital_sys_period";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "integer";
  name: "norbital_row_version";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "uuid";
  name: "norbital_approval_id";
  nullable: true;
  readOnly: true;
}
  | {
  array?: undefined;
  kind: string;
  name: "title";
  nullable: true;
}
  | {
  array: true;
  kind: string;
  name: "messages";
  nullable: true;
}
  | {
  array?: undefined;
  kind: string;
  name: "context";
  nullable: true;
})[];
chat_session.name
name: string = 'chat_session';

document_asset
document_asset: object;
document_asset.fields
fields: (
  | {
  kind: "uuid";
  name: "norbital_id";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_created_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_updated_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "tstzrange";
  name: "norbital_sys_period";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "integer";
  name: "norbital_row_version";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "uuid";
  name: "norbital_approval_id";
  nullable: true;
  readOnly: true;
}
  | {
  kind: string;
  name: "file_name";
  nullable: false;
}
  | {
  kind: string;
  name: "mime_type";
  nullable: true;
}
  | {
  kind: string;
  name: "file_size";
  nullable: true;
}
  | {
  kind: string;
  name: "storage_key";
  nullable: false;
}
  | {
  kind: string;
  name: "storage_provider";
  nullable: true;
}
  | {
  kind: string;
  name: "metadata";
  nullable: true;
}
  | {
  kind: string;
  name: "embedding_model";
  nullable: true;
})[];
document_asset.name
name: string = 'document_asset';

integration_outbox
integration_outbox: object;
integration_outbox.fields
fields: (
  | {
  kind: "uuid";
  name: "norbital_id";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_created_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_updated_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "tstzrange";
  name: "norbital_sys_period";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "integer";
  name: "norbital_row_version";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "uuid";
  name: "norbital_approval_id";
  nullable: true;
  readOnly: true;
}
  | {
  kind: string;
  name: "integration_name";
  nullable: false;
}
  | {
  kind: string;
  name: "binding_name";
  nullable: false;
}
  | {
  kind: string;
  name: "collection_name";
  nullable: false;
}
  | {
  kind: string;
  name: "record_id";
  nullable: false;
}
  | {
  kind: string;
  name: "action";
  nullable: false;
}
  | {
  kind: string;
  name: "payload";
  nullable: false;
}
  | {
  kind: string;
  name: "status";
  nullable: false;
}
  | {
  kind: string;
  name: "attempts";
  nullable: false;
}
  | {
  kind: string;
  name: "available_at";
  nullable: false;
}
  | {
  kind: string;
  name: "claimed_at";
  nullable: true;
}
  | {
  kind: string;
  name: "delivered_at";
  nullable: true;
}
  | {
  kind: string;
  name: "last_error";
  nullable: true;
})[];
integration_outbox.name
name: string = 'integration_outbox';

mutation_log
mutation_log: object;
mutation_log.fields
fields: (
  | {
  kind: "uuid";
  name: "norbital_id";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_created_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_updated_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "tstzrange";
  name: "norbital_sys_period";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "integer";
  name: "norbital_row_version";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "uuid";
  name: "norbital_approval_id";
  nullable: true;
  readOnly: true;
}
  | {
  kind: string;
  name: "collection_name";
  nullable: false;
}
  | {
  kind: string;
  name: "record_id";
  nullable: false;
}
  | {
  kind: string;
  name: "action";
  nullable: false;
}
  | {
  kind: string;
  name: "payload";
  nullable: true;
}
  | {
  kind: string;
  name: "result";
  nullable: true;
}
  | {
  kind: string;
  name: "actor_id";
  nullable: true;
})[];
mutation_log.name
name: string = 'mutation_log';

notification
notification: object;
notification.fields
fields: (
  | {
  kind: "uuid";
  name: "norbital_id";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_created_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_updated_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "tstzrange";
  name: "norbital_sys_period";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "integer";
  name: "norbital_row_version";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "uuid";
  name: "norbital_approval_id";
  nullable: true;
  readOnly: true;
}
  | {
  array?: undefined;
  kind: string;
  name: "recipient_user_id";
  nullable: false;
}
  | {
  array?: undefined;
  kind: string;
  name: "subject";
  nullable: false;
}
  | {
  array?: undefined;
  kind: string;
  name: "message";
  nullable: false;
}
  | {
  array: true;
  kind: string;
  name: "channels";
  nullable: true;
}
  | {
  array?: undefined;
  kind: string;
  name: "cta_label";
  nullable: true;
}
  | {
  array?: undefined;
  kind: string;
  name: "cta_url";
  nullable: true;
}
  | {
  array?: undefined;
  kind: string;
  name: "notification_category";
  nullable: true;
}
  | {
  array?: undefined;
  kind: string;
  name: "read_at";
  nullable: true;
})[];
notification.name
name: string = 'notification';

policy
policy: object;
policy.fields
fields: (
  | {
  kind: "uuid";
  name: "norbital_id";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_created_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_updated_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "tstzrange";
  name: "norbital_sys_period";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "integer";
  name: "norbital_row_version";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "uuid";
  name: "norbital_approval_id";
  nullable: true;
  readOnly: true;
}
  | {
  array?: undefined;
  kind: string;
  name: "key";
  nullable: false;
}
  | {
  array?: undefined;
  kind: string;
  name: "name";
  nullable: false;
}
  | {
  array?: undefined;
  kind: string;
  name: "description";
  nullable: true;
}
  | {
  array?: undefined;
  kind: string;
  name: "is_active";
  nullable: false;
}
  | {
  array: true;
  kind: string;
  name: "accessible_applications";
  nullable: true;
}
  | {
  array: true;
  kind: string;
  name: "grants";
  nullable: true;
})[];
policy.name
name: string = 'policy';

requestor
requestor: object;
requestor.fields
fields: (
  | {
  kind: "uuid";
  name: "norbital_id";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_created_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_updated_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "tstzrange";
  name: "norbital_sys_period";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "integer";
  name: "norbital_row_version";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "uuid";
  name: "norbital_approval_id";
  nullable: true;
  readOnly: true;
}
  | {
  kind: string;
  name: "approval_request_id";
  nullable: false;
}
  | {
  kind: string;
  name: "user_id";
  nullable: false;
})[];
requestor.name
name: string = 'requestor';

team
team: object;
team.fields
fields: (
  | {
  kind: "uuid";
  name: "norbital_id";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_created_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_updated_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "tstzrange";
  name: "norbital_sys_period";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "integer";
  name: "norbital_row_version";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "uuid";
  name: "norbital_approval_id";
  nullable: true;
  readOnly: true;
}
  | {
  kind: string;
  name: "name";
  nullable: false;
}
  | {
  kind: string;
  name: "description";
  nullable: true;
}
  | {
  kind: string;
  name: "parent_id";
  nullable: true;
}
  | {
  kind: string;
  name: "is_active";
  nullable: false;
}
  | {
  kind: string;
  name: "kind";
  nullable: true;
}
  | {
  kind: string;
  name: "policy_id";
  nullable: false;
})[];
team.name
name: string = 'team';

team_members
team_members: object;
team_members.fields
fields: (
  | {
  kind: "uuid";
  name: "norbital_id";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_created_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_updated_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "tstzrange";
  name: "norbital_sys_period";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "integer";
  name: "norbital_row_version";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "uuid";
  name: "norbital_approval_id";
  nullable: true;
  readOnly: true;
}
  | {
  kind: string;
  name: "user_id";
  nullable: false;
}
  | {
  kind: string;
  name: "team_id";
  nullable: false;
})[];
team_members.name
name: string = 'team_members';

user
user: object;
user.fields
fields: (
  | {
  kind: "uuid";
  name: "norbital_id";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_created_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "timestamptz";
  name: "norbital_updated_at";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "tstzrange";
  name: "norbital_sys_period";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "integer";
  name: "norbital_row_version";
  nullable: false;
  readOnly: true;
}
  | {
  kind: "uuid";
  name: "norbital_approval_id";
  nullable: true;
  readOnly: true;
}
  | {
  kind: string;
  label: string;
  name: "email";
  nullable: false;
}
  | {
  kind: string;
  label: string;
  name: "name";
  nullable: true;
}
  | {
  kind: string;
  label: string;
  name: "avatar_url";
  nullable: true;
}
  | {
  kind: string;
  label: string;
  name: "status";
  nullable: true;
}
  | {
  kind: string;
  label: string;
  name: "role";
  nullable: true;
}
  | {
  kind: string;
  label: string;
  name: "kind";
  nullable: true;
}
  | {
  kind: string;
  label: string;
  name: "phone";
  nullable: true;
}
  | {
  kind: string;
  label: string;
  name: "metadata";
  nullable: true;
})[];
user.name
name: string = 'user';

SYSTEM_COLLECTION_NAMES

const SYSTEM_COLLECTION_NAMES: readonly ["approval_request", "requestor", "automation_run", "user", "team", "policy", "chat_session", "mutation_log", "audit_event", "integration_outbox", "notification", "document_asset", "team_members"];

Defined in: platform-utils/src/system/collections.ts:153