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

Class representing the Interfolio User

let user = await api.Users.getUser(99999);

Hierarchy

  • UserApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • Constructor for the object

    Parameters

    • config: ApiRequest | ApiConfig

      Configuration for API calls - of type either ApiConfig or ApiRequest

      note pass in ApiRequest to keep all errors in one object instance

    Returns UserApi

Properties

Readonly apiRequest

apiRequest: ApiRequest

API request object for making the actual http requests

Methods

create

  • create(__namedParameters: { copySelf?: boolean; email: string; externalUser?: boolean; firstName: string; lastName: string; suppressWelcomeEmail?: boolean; unitId?: number; userType?: string; welcomeMessage?: string }): Promise<User>

  • Create a new user

    example
    let user = await api.Tenure.Users.create({firstName: "Jane", lastName: "Doe", email: "janedoe@example.com"};

    Parameters

    • __namedParameters: { copySelf?: boolean; email: string; externalUser?: boolean; firstName: string; lastName: string; suppressWelcomeEmail?: boolean; unitId?: number; userType?: string; welcomeMessage?: string }
      • Optional copySelf?: boolean

        Flag Indicating if the welcome email should be copied to the current user

      • email: string

        Email Address of the user (must be unique)

      • Optional externalUser?: boolean

        Flag indicating if the user is external

      • firstName: string

        First Name of the user

      • lastName: string

        Last Name of the user

      • Optional suppressWelcomeEmail?: boolean

        Flag indicating if you want to suprress the welcome email (default true)

      • Optional unitId?: number

        Unit id of the user

      • Optional userType?: string

        Type of the user (external, internal, etc)

      • Optional welcomeMessage?: string

        Welcome message

    Returns Promise<User>

currentUser

  • currentUser(): Promise<User>

  • Get the current API User

    example
    let currentUser = await api.Tenure.Users.currentUser();

    Returns Promise<User>

findUserByEmail

  • findUserByEmail(__namedParameters: { email: string }): Promise<User>

  • Find the interfolio user by searching by email

    example
    let user = await api.Tenure.Users.findUserByEmail({email: "myemail@example.com"});

    Parameters

    • __namedParameters: { email: string }
      • email: string

        Email address of the user

    Returns Promise<User>

getUser

  • getUser(__namedParameters: { id: number }): Promise<User>

  • Get the user record

    example
    let user = await api.Tenure.Users.getUser({id: 9999});

    Parameters

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

        ID of the user

    Returns Promise<User>

searchUsers

  • searchUsers(__namedParameters: { limit?: number; page?: number; searchTerm: string }): Promise<UserSearchResults>

  • Search all users by search term

    example
    const searchResults = await api.Tenure.Users.searchUsers({searchTerm: "Bob Jones"});
console.log(searchResults.results[0]);

    Parameters

    • __namedParameters: { limit?: number; page?: number; searchTerm: string }
      • Optional limit?: number

        Number of results to return

      • Optional page?: number

        Page of results to return if results are greater than the limit

      • searchTerm: string

        String to search by

    Returns Promise<UserSearchResults>

Legend

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

Generated using TypeDoc