Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientConfig

The Client configuration used to authenticate the User.

Hierarchy

  • ClientConfig

Index

Constructors

Properties

Accessors

Constructors

constructor

  • new ClientConfig(firmId?: number, username?: string, password?: string, apiKey?: string, compassUrl?: string): ClientConfig

  • Parameters

    • Optional firmId: number
    • Optional username: string
    • Optional password: string
    • Optional apiKey: string
    • Optional compassUrl: string

    Returns ClientConfig

Properties

Private _apiKey

_apiKey: string = ""

Private _compassUrl

_compassUrl: string = "https://compass.uat.cosential.com/api"

Private _firmId

_firmId: number = 0

Private _password

_password: string = ""

Private _username

_username: string = ""

Private apiKeyTest

apiKeyTest: RegExp = /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/

Private urlTest

urlTest: RegExp = /^(http|https):\/\/[^ "]+$/

Accessors

apiKey

  • get apiKey(): string
  • set apiKey(value: string): void

  • Returns string

  • Parameters

    • value: string

    Returns void

compassUrl

  • get compassUrl(): string
  • set compassUrl(value: string): void

  • Returns string

  • Parameters

    • value: string

    Returns void

firmId

  • get firmId(): number
  • set firmId(value: number): void

  • Returns number

  • Parameters

    • value: number

    Returns void

password

  • get password(): string
  • set password(value: string): void

  • Returns string

  • Parameters

    • value: string

    Returns void

username

  • get username(): string
  • set username(value: string): void

  • Returns string

  • Parameters

    • value: string

    Returns void

Generated using TypeDoc