Interfolio API
Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

References

Classes

Type aliases

Variables

References

default

Renames and exports WorkflowStepApi

Type aliases

WorkflowStep

WorkflowStep: { administrators: { email: string; first_name: string; last_name: string; pid: number; recused: boolean; unit: { id: number; name: string; parent_unit_id: number | null }; user_id: number }[]; committees: WorkflowStepCommitteeSummary[]; created_at: string; current: boolean; due_date: string | null; due_date_display: string | null; id: number; name: string | null; note: string | null; step_number: number }

Workflow step

Type declaration

  • administrators: { email: string; first_name: string; last_name: string; pid: number; recused: boolean; unit: { id: number; name: string; parent_unit_id: number | null }; user_id: number }[]

    list of administrators who have access over this packets/workflow step

  • committees: WorkflowStepCommitteeSummary[]

    committees assigned to this workflow step

  • created_at: string

    time the workflow step was created

  • current: boolean

    if this is the currently workflow step

  • due_date: string | null

    due date for the workflow step

  • due_date_display: string | null

    displayed due date

  • id: number

    id of the workflow step

  • name: string | null

    name of the workflow step

  • note: string | null

    note for this workflow step

  • step_number: number

    step number order

WorkflowStepCommitteeSummary

WorkflowStepCommitteeSummary: { committee_member_count: number; committee_members: CommitteeMember[]; form_requirements_count: number; id: number; individual_committee: boolean; name: string; note: string | null; recused_committee_members: CommitteeMember[]; requirements_count: number; requirements_fulfilled: boolean; restricted: boolean; standing: boolean; type: string; unit_id: number }

Summary data for a workflow step committee

Type declaration

  • committee_member_count: number

    number of members assigned to this committee

  • committee_members: CommitteeMember[]

    list of committee members

  • form_requirements_count: number

    number of form requirements for this committee for this step

  • id: number

    id of the committee

  • individual_committee: boolean

    if this committee represents an indvidual

  • name: string

    name of the committee

  • note: string | null

    note related to the workflow step for this committee

  • recused_committee_members: CommitteeMember[]

    list of recused committee members

  • requirements_count: number

    list of committee required documents

  • requirements_fulfilled: boolean

    if all committee requiremenst have been fulfilled

  • restricted: boolean

    if this committee is restricted

  • standing: boolean

    if this is a standing committee

  • type: string

    the type of committee eg. StandingCommittee

  • unit_id: number

    unit id of the committee

Variables

Const WORKFLOW_STEP_BASE_URL

WORKFLOW_STEP_BASE_URL: string = ...

Const WORKFLOW_STEP_URL

WORKFLOW_STEP_URL: string = ...

Legend

  • Variable
  • Function
  • Type alias
  • Class

Generated using TypeDoc