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

Class representing an Interfolio Committee Memmber

Hierarchy

  • CommitteeMemberApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly apiRequest

apiRequest: ApiRequest

API request object for making the actual http requests

Methods

create

  • create(__namedParameters: { committeeId: number; manager?: boolean; userId: number }): Promise<CommitteeMember>

  • Creates a new committee member

    example
    let member = await api.Tenure.CommitteeMembers.create({committeeId: 9999, userId: 9999});

    Parameters

    • __namedParameters: { committeeId: number; manager?: boolean; userId: number }
      • committeeId: number

        ID of the committee

      • Optional manager?: boolean

        Flag indicating if the user is a committee manager (defaults to false)

      • userId: number

        Id of the user

    Returns Promise<CommitteeMember>

delete

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

  • Delete the committee member (remove from committee)

    example
    await api.Committeess.CommitteeeMembers.delete({id: 9999, committeeId: 9999});

    Parameters

    • __namedParameters: { committeeId: number; id: number }
      • committeeId: number

        ID of the committee

      • id: number

        ID of the committee membership (not the userId)

    Returns Promise<boolean>

Legend

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

Generated using TypeDoc