Safety Net Blueprint — Client Reference: Case Management

Methods (5)

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

case-management.listCases({
  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

▶ createCase() Create a case API ref → #

case-management.createCase({ body: { ... } })

Parameters

body

object

body

required

▶ deleteCase(caseId) Delete a case API ref → #

case-management.deleteCase({ path: { caseId: string } })

Parameters

caseId

string

path

required

▶ getCase(caseId) Get a case API ref → #

case-management.getCase({ path: { caseId: string } })

Parameters

caseId

string

path

required

▶ updateCase(caseId) Update a case API ref → #

case-management.updateCase({ path: { caseId: string }, body: { ... } })

Parameters

caseId	string	path	required
body	object	body	required

Constants (1)

▶ CaseStatus enum (2 values) #

'active'
'closed'

Types (7)

▶ Case 6 fields #

interface Case {
  status: enum: "active", "closed"
  effectiveStartDate?: string
  effectiveEndDate?: string
  primaryApplicantId: string
  members?: array[object]
  assignedToId?: string
}

▶ CaseMember 2 fields #

interface CaseMember {
  personId: string
  relationship: string
}

▶ CaseCreate 6 fields #

interface CaseCreate {
  status?: enum: "active", "closed"
  effectiveStartDate?: string
  effectiveEndDate?: string
  primaryApplicantId?: string
  members?: array[object]
  assignedToId?: string
}

▶ CaseUpdate 6 fields #

interface CaseUpdate {
  status?: enum: "active", "closed"
  effectiveStartDate?: string
  effectiveEndDate?: string
  primaryApplicantId?: string
  members?: array[object]
  assignedToId?: string
}

▶ CaseList 4 fields #

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

▶ CaseWritable 6 fields #

interface CaseWritable {
  status: enum: "active", "closed"
  effectiveStartDate?: string
  effectiveEndDate?: string
  primaryApplicantId: string
  members?: array[object]
  assignedToId?: string
}

▶ CaseListWritable 4 fields #

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