Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

References

default

Renames and exports ApiRequest

Type aliases

ApiResponse

ApiResponse: {}

The general type of response that is returned from an API Call

Type declaration

GraphQlRequest

GraphQlRequest: { operationName: string; query: string; variables?: any }

The definition of the paramenters necessary for a GraphQL Api Call

Type declaration

  • operationName: string

    The operation name e.g. "getForms"

  • query: string

    The GraphQL query itself e.g. "query getForms($searchText: String!) {forms(searchText: $searchText...) {results {description id }}}

  • Optional variables?: any

    Any variables required for the query e.g. {searchText: "Form Name"}

RestRequest

RestRequest: { body?: string | Readable | Buffer; form?: string | any; json?: any; method?: Method; responseType?: "text" | "json" | "buffer"; url: string }

The definition of the parameters necessary for a REST API call

Type declaration

  • Optional body?: string | Readable | Buffer

    The body of the request

  • Optional form?: string | any

    The form elements to submit with the request

  • Optional json?: any

    The json object to submit with the request

  • Optional method?: Method

    The http method to execute -defaults to GET

  • Optional responseType?: "text" | "json" | "buffer"

    The response type expected from the call

  • url: string

    The relative url for the endpoint

Variables

Const INTERFOLIO_BYC_TENURE_V1

INTERFOLIO_BYC_TENURE_V1: "/byc-tenure/{tenant_id}" = '/byc-tenure/{tenant_id}'

the v1 tenure information endpoint root

Const INTERFOLIO_BYC_TENURE_V2

INTERFOLIO_BYC_TENURE_V2: "/byc-tenure/v2/{tenant_id}" = '/byc-tenure/v2/{tenant_id}'

the v2 tenure information endpoint root

Const INTERFOLIO_CORE_URL_V1

INTERFOLIO_CORE_URL_V1: "/byc/core/{module}/{tenant_id}" = '/byc/core/{module}/{tenant_id}'

The v1 core interfolio for global objects such as users and units

Const INTERFOLIO_CORE_URL_V2

INTERFOLIO_CORE_URL_V2: "/byc/core/v2/{module}/{tenant_id}" = '/byc/core/v2/{module}/{tenant_id}'

the v2 core interfolio url for global objects such as users/ units)

Const INTERFOLIO_GRAPHQL_URLS

INTERFOLIO_GRAPHQL_URLS: { BETA: string; PRODUCTION: string; SANDBOX: string } = ...

The current Interfolio base URLs for GraphQL Calls

Type declaration

  • BETA: string
  • PRODUCTION: string
  • SANDBOX: string

Const INTERFOLIO_REST_URLS

INTERFOLIO_REST_URLS: { BETA: string; PRODUCTION: string; SANDBOX: string } = ...

The current Interfolio base urls for REST calls

Type declaration

  • BETA: string
  • PRODUCTION: string
  • SANDBOX: string

Const INTERFOLIO_SEARCH_V1

INTERFOLIO_SEARCH_V1: "/byc-search/{tenant_id}" = '/byc-search/{tenant_id}'

the v1 search information endpoint root

Const INTERFOLIO_SEARCH_V2

INTERFOLIO_SEARCH_V2: "/byc-search/v2/{tenant_id}" = '/byc-search/v2/{tenant_id}'

the v2 serach information endpoint root

Legend

  • Variable
  • Function
  • Type alias
  • Class

Generated using TypeDoc