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

Class representing workflow step committee calls

Hierarchy

  • WorkflowStepCommitteeApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly apiRequest

apiRequest: ApiRequest

API request object for making the actual http requests

Methods

addDocumentRequirement

  • addDocumentRequirement(__namedParameters: { committeeId: number; description?: string; name: string; packetId: number; workflowStepId: number }): Promise<CommitteeDocumentRequirement>

  • A a document requirement to a particular workflow step committee

    example
    await api.Tenure.WorkflowStepCommittees.addDocumentRequirement({
  packetId: 9999,
  workflowStepId: 9999,
  committeeId: 9999,
  name: 'Document requirement',
  description: 'Required document for all cases'
}

    Parameters

    • __namedParameters: { committeeId: number; description?: string; name: string; packetId: number; workflowStepId: number }
      • committeeId: number

        ID of the committee

      • Optional description?: string

        description of the document requirement

      • name: string

        name of the document requirement

      • packetId: number

        ID of the packet

      • workflowStepId: number

        ID of the workflow step

    Returns Promise<CommitteeDocumentRequirement>

assign

  • assign(__namedParameters: { committeeId: number; note?: string; packetId: number; workflowStepId: number }): Promise<boolean>

  • Assign a committee to a workflow step

    example
    let added = await api.Tenure.WorkflowStepCommittees.assign({
 packetId: 9999,
 workflowStepId: 9999,
 committeeId: 9999,
 note: "Instructions to Committee"
});

    Parameters

    • __namedParameters: { committeeId: number; note?: string; packetId: number; workflowStepId: number }
      • committeeId: number

        id of the committee

      • Optional note?: string

        note to include as instructions for the committee

      • packetId: number

        id of the case packet

      • workflowStepId: number

        id of the workflow step

    Returns Promise<boolean>

copyDocumentRequirements

  • copyDocumentRequirements(__namedParameters: { documentRequirements: CommitteeDocumentRequirement[]; packetId: number; toCommitteeId: number; workflowStepId: number }): Promise<boolean>

  • copy defined required documents to workflow step committee

    example
     //retrieve the requirements
 let requirements = await api.Tenure.WorkflowStepCommittees.getRequirements({
  packetId: 9999,
  workflowStepId: 9999,
  committeeId: 9999
 })

 //copy them to the new committee
 await.api.Tenure.WorkflowStepCommittees.copyDocumentRequirements({
  packetId: 9999,
  workflowStepId: 9999,
  toCommitteeId: 9998,
  documentRequirements: requirements.required_documents
 })

    Parameters

    • __namedParameters: { documentRequirements: CommitteeDocumentRequirement[]; packetId: number; toCommitteeId: number; workflowStepId: number }
      • documentRequirements: CommitteeDocumentRequirement[]

        the document requirements retrieved from the first workflow step

      • packetId: number

        id of the packet

      • toCommitteeId: number

        id of the committee to copy the requr

      • workflowStepId: number

        id of the workflow step

    Returns Promise<boolean>

copyFormRequirements

  • copyFormRequirements(__namedParameters: { formRequirements: CommitteeFormRequirement[]; packetId: number; toCommitteeId: number; workflowStepId: number }): Promise<boolean>

  • copy all the form requirements to a second workflow step committee

    example
     //retrieve the requirements
 let requirements = await api.Tenure.WorkflowStepCommittees.getRequirements({
  packetId: 9999,
  workflowStepId: 9999,
  committeeId: 9999
 })

 //copy them to the new committee
 await.api.Tenure.WorkflowStepCommittees.copyFormRequirements({
  packetId: 9999,
  workflowStepId: 9999,
  toCommitteeId: 9998,
  documentRequirements: requirements.required_forms
 })

    Parameters

    • __namedParameters: { formRequirements: CommitteeFormRequirement[]; packetId: number; toCommitteeId: number; workflowStepId: number }
      • formRequirements: CommitteeFormRequirement[]

        the form requirements retrieved from the first workflow step

      • packetId: number

        id of the packet

      • toCommitteeId: number

        id of the committee to copy the required forms to

      • workflowStepId: number

        id of the workflow step

    Returns Promise<boolean>

copyRequirements

  • copyRequirements(__namedParameters: { fromCommitteeId: number; packetId: number; toCommitteeId: number; workflowStepId: number }): Promise<WorkflowStepCommitteeSummary>

  • Copy all the requirements from one workflow step committee to another workflow step committee assigned to the same step

    example
    let newCommittee = await api.Tenure.WorkflowStepCommittees.copy({
  packetId: 9999,
  workflowStepId: 9999,
  fromCommitteeId: 9999,
  toCommitteeId: 9999
})

    Parameters

    • __namedParameters: { fromCommitteeId: number; packetId: number; toCommitteeId: number; workflowStepId: number }
      • fromCommitteeId: number

        ID of the committee to copy requirements from

      • packetId: number

        Id of the packet

      • toCommitteeId: number

        ID of the committee to copy requirements to

      • workflowStepId: number

        ID of the workflow step

    Returns Promise<WorkflowStepCommitteeSummary>

delete

  • delete(__namedParameters: { committeeId: number; packetId: number; workflowStepId: number }): Promise<boolean>

  • Delete a workflow step committee

    example
    let deleted = await api.Tenure.WorkflowStepCommittees.delete({
 packetId: 9999,
 workflowStepId: 9999,
 committeeId: 9999
});

    Parameters

    • __namedParameters: { committeeId: number; packetId: number; workflowStepId: number }
      • committeeId: number

        id of the committee

      • packetId: number

        id of the packet

      • workflowStepId: number

        id of the workflow step

    Returns Promise<boolean>

deleteDocumentRequirement

  • deleteDocumentRequirement(__namedParameters: { committeeId: number; packetId: number; requirementId: number; workflowStepId: number }): Promise<boolean>

  • Delete a workflow step committee requirement for a document

    example
    const deleted = await api.Tenure.WorkflowStepCommittees.deleteDocumentRequirement({
  packetId: 9999,
  workflowStepId: 9999,
  committeeId: 9999,
  requirementId: 9999
}

    Parameters

    • __namedParameters: { committeeId: number; packetId: number; requirementId: number; workflowStepId: number }
      • committeeId: number

        ID of the committee

      • packetId: number

        ID of the packet

      • requirementId: number

        ID of the requirement to delete

      • workflowStepId: number

        ID of the workflow step

    Returns Promise<boolean>

fulfillDocumentRequirement

  • fulfillDocumentRequirement(__namedParameters: { attachmentId: number; committeeId: number; packetId: number; requirementId: number; workflowStepId: number }): Promise<boolean>

  • Fulfill a workflow step committee document requirement

    example
    const fulfilled = await api.Tenure.PacketAttachments.fulFillDocumentRequirement({
 packetId: 9999,
 workflowStepId: 9999,
 requirementId: 9999,
 attachmentId: 9999
})

    Parameters

    • __namedParameters: { attachmentId: number; committeeId: number; packetId: number; requirementId: number; workflowStepId: number }
      • attachmentId: number

        ID of the attachment

      • committeeId: number

        ID of the committee

      • packetId: number

        ID of the packet

      • requirementId: number

        ID of the requirement

      • workflowStepId: number

        ID of the workflow step

    Returns Promise<boolean>

getRequirements

  • getRequirements(__namedParameters: { committeeId: number; packetId: number; workflowStepId: number }): Promise<CommitteeRequirements>

  • Get the requirements for a workflow step

    example
    let requirements = await api.Tenure.WorkflowStepCommittees.getRequirements({
  packetId: 9999,
  workflowStepId: 9999,
  committeeId: 9999
}

    Parameters

    • __namedParameters: { committeeId: number; packetId: number; workflowStepId: number }
      • committeeId: number

        ID of the committee

      • packetId: number

        ID of the packet

      • workflowStepId: number

        ID of the workflowstep

    Returns Promise<CommitteeRequirements>

getWorkflowStepCommitteeSummary

  • getWorkflowStepCommitteeSummary(__namedParameters: { committeeId: number; packetId: number; workflowStepId: number }): Promise<WorkflowStepCommitteeSummary>

  • Get the workflow step committee summary

    example
    const committee = await api.Tenure.WorkflowStepCommittees.getWorkflowStepCommitteeSummary({
  packetId: 9999,
  workflowStepId: 9999,
  committeeId: 9999
});

    Parameters

    • __namedParameters: { committeeId: number; packetId: number; workflowStepId: number }
      • committeeId: number

        ID of the committee

      • packetId: number

        ID of the packet

      • workflowStepId: number

        ID of the workflow step

    Returns Promise<WorkflowStepCommitteeSummary>

swapCommittees

  • swapCommittees(__namedParameters: { fromCommitteeId: number; packetId: number; toCommitteeId: number; workflowStepId: number }): Promise<boolean>

  • Insert a workflow step committee and move all the requirements/forms/instructions to the new committee then delete the original committee

    Parameters

    • __namedParameters: { fromCommitteeId: number; packetId: number; toCommitteeId: number; workflowStepId: number }
      • fromCommitteeId: number
      • packetId: number
      • toCommitteeId: number
      • workflowStepId: number

    Returns Promise<boolean>

update

  • update(__namedParameters: { committeeId: number; note: string; packetId: number; workflowStepId: number }): Promise<boolean>

  • Update instructions/note for a workflows step committee - uses same call as "assign" function

    example
    const updated = await api.Tenure.WorkflowStepCommittees.update({
  packetId: 9999,
  workflowStepId: 9999,
  committeeId: 9999,
  note: "<p>here is my note</p><p>With a second paragraph</p>"
}

    Parameters

    • __namedParameters: { committeeId: number; note: string; packetId: number; workflowStepId: number }
      • committeeId: number

        ID of the committee

      • note: string

        Note for committee (can have simple html formatting)

      • packetId: number

        ID of the packet

      • workflowStepId: number

        ID of the workflow step

    Returns Promise<boolean>

Legend

  • Class
  • Constructor
  • Property
  • Method
  • Variable
  • Function
  • Type alias

Generated using TypeDoc