Skip to main content

Purpose API

Usage​

import { epilot } from '@epilot/sdk'

epilot.authorize(() => '<token>')
const { data } = await epilot.purpose.createPurpose(...)

Tree-shakeable import​

import { getClient, authorize } from '@epilot/sdk/purpose'

const purposeClient = getClient()
authorize(purposeClient, () => '<token>')
const { data } = await purposeClient.createPurpose(...)

Operations​

Purpose

Schemas

createPurpose​

Create Purpose

POST /v1/purpose

const { data } = await client.createPurpose(
  null,
  {
    name: 'Electricity Contract'
  },
)
Response
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Electricity Contract",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z"
}

searchPurposes​

Search Purposes

GET /v1/purpose:search

const { data } = await client.searchPurposes({
  query: 'example',
  size: 1,
})
Response
{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Electricity Contract",
      "created_at": "1970-01-01T00:00:00.000Z",
      "updated_at": "1970-01-01T00:00:00.000Z"
    }
  ]
}

batchGetPurposes​

Batch Get Purposes

POST /v1/purpose:batchGet

const { data } = await client.batchGetPurposes(
  null,
  {
    purposeIds: ['123e4567-e89b-12d3-a456-426614174000']
  },
)
Response
{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Electricity Contract",
      "created_at": "1970-01-01T00:00:00.000Z",
      "updated_at": "1970-01-01T00:00:00.000Z"
    }
  ],
  "hits": 0
}

getPurpose​

Get Purpose

GET /v1/purpose/{purposeId}

const { data } = await client.getPurpose({
  purposeId: 'example',
})
Response
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Electricity Contract",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z"
}

updatePurpose​

Update Purpose

PUT /v1/purpose/{purposeId}

const { data } = await client.updatePurpose(
  {
    purposeId: 'example',
  },
  {
    name: 'string'
  },
)
Response
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Electricity Contract",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z"
}

deletePurpose​

Delete Purpose

DELETE /v1/purpose/{purposeId}

const { data } = await client.deletePurpose({
  purposeId: 'example',
})
Response
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Electricity Contract",
  "created_at": "1970-01-01T00:00:00.000Z",
  "updated_at": "1970-01-01T00:00:00.000Z"
}

Schemas​

Purpose​

A purpose used to tag and organize entities

type Purpose = {
  id: string // uuid
  name: string
  created_at?: string // date-time
  updated_at?: string // date-time
}

CreatePurposeInput​

Input for creating a new purpose

type CreatePurposeInput = {
  name: string
}

UpdatePurposeInput​

Input for updating an existing purpose

type UpdatePurposeInput = {
  name?: string
}

BatchGetPurposesInput​

Input for batch getting purposes

type BatchGetPurposesInput = {
  purposeIds: string[]
}

Error​

type Error = {
  status?: number
  error?: string
}