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

Class representing an Interfolio Position

Hierarchy

  • PositionApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly Applications

Applications: ApplicationApi

Readonly apiRequest

apiRequest: ApiRequest

API request object for making the actual http requests

Methods

create

delete

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

  • Delete the position

    example
    await api.Search.Positions.delete({id: 9999});

    Parameters

    • __namedParameters: { id: number }
      • id: number

        the ide of the position to delete

    Returns Promise<boolean>

filterPositions

  • filterPositions(__namedParameters: { archived?: null | boolean; current_status_name?: null | string; limit?: number; page?: number; position_type_id?: null | number; search_term?: null | string; sort_by?: string; sort_order?: string }): Promise<{ limit: number; page: number; results: any[]; total_count: number }>

  • Find a position based upon search term

    example
    let positions = await api.Search.Positions.filterPositions({
  limit: 100,
  page: 1,
  sort_by: "position_name",
  sort_order: "asc"
  search_term: "biology"
});

    Parameters

    • __namedParameters: { archived?: null | boolean; current_status_name?: null | string; limit?: number; page?: number; position_type_id?: null | number; search_term?: null | string; sort_by?: string; sort_order?: string }
      • Optional archived?: null | boolean

        if the results should include archived positions

      • Optional current_status_name?: null | string

        filter for the current status name of the position

      • Optional limit?: number

        the limit of the number of records to return

      • Optional page?: number

        the page number of the given paged results

      • Optional position_type_id?: null | number

        the id of the position type

      • Optional search_term?: null | string

        the search term to filter for

      • Optional sort_by?: string

        the field to sort by (default: "position_name")

      • Optional sort_order?: string

        the order in which to sort the results ("asc"|"desc")

    Returns Promise<{ limit: number; page: number; results: any[]; total_count: number }>

getPosition

  • getPosition(__namedParameters: { id: number }): Promise<PositionDetail>

  • Get a position from the positionId

    example
    let position = await api.Search.Positions.getPosition({id: 9999});

    Parameters

    • __namedParameters: { id: number }
      • id: number

        ID of the position

    Returns Promise<PositionDetail>

Static removePositionDetailNesting

  • removePositionDetailNesting<T>(apiResponse: ApiResponse): T

  • Remove the cumbersome second level for position detail

    Type parameters

    • T

    Parameters

    • apiResponse: ApiResponse

      The response from the API to remove the nesting from

    Returns T

Legend

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

Generated using TypeDoc