Safety Net Blueprint — Client Reference: Client Management

Methods (5)

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

client-management.listPersons({
  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

▶ createPerson() Create a person API ref → #

client-management.createPerson({ body: { ... } })

Parameters

body

object

body

required

▶ deletePerson(personId) Delete a person API ref → #

client-management.deletePerson({ path: { personId: string } })

Parameters

personId

string

path

required

▶ getPerson(personId) Get a person API ref → #

client-management.getPerson({ path: { personId: string } })

Parameters

personId

string

path

required

▶ updatePerson(personId) Update a person API ref → #

client-management.updatePerson({
  path: { personId: string },
  body: { ... },
})

Parameters

personId	string	path	required
body	object	body	required

Constants (1)

▶ Annotations map — annotations compiled from client-management-annotations*.yaml at generation time #

client-management.Annotations.schema['field/path']      // field annotations
client-management.Annotations.operations['action-id']   // operation annotations
client-management.Annotations.events['event.type']      // event annotations

Sub-maps

schema	Field-level annotations keyed by JSON path
operations	State machine action and OpenAPI operation annotations
events	AsyncAPI event channel annotations

Types (2)

▶ PersonList 4 fields #

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

▶ PersonListWritable 4 fields #

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