Safety Net Blueprint — Client Reference: Platform

Events (4)

▶ listEvents() You can provide a client instance returned by `createClient()` instead of API ref → #

platform.listEvents({
  query: { q?: string, sort?: string, type?: string, source?: string, subject?: string, traceid?: string, start?: string, end?: string, limit?: number, offset?: number },
})

Parameters

q search →	string	query	optional
sort	string	query	optional
type	string	query	optional
source	string	query	optional
subject	string	query	optional
traceid	string	query	optional
start	string	query	optional
end	string	query	optional
limit	number	query	optional
offset	number	query	optional

▶ publishEvent() Publish an event API ref → #

platform.publishEvent({ body: { ... } })

Parameters

body

object

body

required

▶ streamEvents() Stream domain events (SSE) API ref → #

platform.streamEvents()

▶ getEvent(eventId) Get a domain event API ref → #

platform.getEvent({ path: { eventId: string } })

Parameters

eventId

string

path

required

Registry (1)

▶ listPolicies() List policies API ref → #

platform.listPolicies({
  query: { q?: string, limit?: number, offset?: number, sort?: string },
})

Parameters

q search →	string	query	optional
limit	number	query	optional
offset	number	query	optional
sort	string	query	optional

Policies (1)

▶ getPolicy(policyId) Get a policy API ref → #

platform.getPolicy({ path: { policyId: string } })

Parameters

policyId

string

path

required

Search (1)

▶ search() Search across resources API ref → #

platform.search({
  query: { q?: string, limit?: number, offset?: number, types?: array[enum: },
})

Parameters

q search →	string	query	optional
limit	number	query	optional
offset	number	query	optional
types	array[enum: "person", "case", "application", "task", "appointment"]	query	optional

Constants (1)

▶ SearchResultType enum (5 values) #

'person'
'case'
'application'
'task'
'appointment'

Types (8)

▶ Event 2 fields #

interface Event {
  type: string
  description?: string
}

▶ Policy 5 fields #

interface Policy {
  id: string
  citation: string
  citationUrl?: string
  description: string
  programs?: array[string]
}

▶ SearchResult 7 fields #

interface SearchResult {
  id: string
  type: enum: "person", "case", "application", "task", "appointment"
  title: string
  score?: number
  attributes: array[object]
  createdAt: string
  updatedAt: string
}

▶ EventList 4 fields #

interface EventList {
  total: number
  limit: number
  offset: number
  hasNext?: boolean
}

▶ PolicyList 4 fields #

interface PolicyList {
  total: number
  limit: number
  offset: number
  hasNext?: boolean
}

▶ SearchFacet 2 fields #

interface SearchFacet {
  type: enum: "person", "case", "application", "task", "appointment"
  count: number
}

▶ SearchResultAttribute 4 fields #

interface SearchResultAttribute {
  field: string
  label?: string
  value: string
  type: enum: "string", "date", "currency"
}

▶ SearchResultList 6 fields #

interface SearchResultList {
  items: array[object]
  total: number
  limit: number
  offset: number
  hasNext?: boolean
  facets?: array[object]
}