Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServiceabilityClient

Client to access Kyrio Serviceability API

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected _account

_account: KyrioAccount

Kyrio account associated with this client

Static Private BASE_ROUTE

BASE_ROUTE: "/business/api/v1" = "/business/api/v1"

Methods

determineBusinessServiceability

  • determineBusinessServiceability(addressLine1: string, addressLine2: string, city: string, state: string, postalCode: string, countryCode: string, callback: function): void

  • Determines cable providers that serve location specified by it's postal address. The method supports incomplete addresses: addressLine1 and postalCode or addressLine1, city and state.

    throws

    KyrioException returned by the server.

    Parameters

    • addressLine1: string

      Street number, pre-directional, street name, suffix, post-directional.

    • addressLine2: string

      Secondary address line such as Apt, Suite or Lot.

    • city: string

      City or town name.

    • state: string

      For US addresses, use the standard 2-character state abbreviation.

    • postalCode: string

      For US addresses, use the 5-digit ZIP code.

    • countryCode: string

      Use ‘US’ to indicate US addresses. If the argument is omitted, ‘US’ will be assumed. Refer to ISO 3166 Country Code Standardfor non-US addresses.

    • callback: function

    Returns void

    Array of serviceability results from cable providers.

determineBusinessServiceabilityForAddress

  • determineBusinessServiceabilityForAddress(address: Address, callback: function): void

Protected invoke

  • invoke(method: string, route: string, params: any, body: any, callback: function): void

  • Invokes REST operation on the server and handles the response.

    Parameters

    • method: string

      Operation method: GET, POST, PUT or DELETE

    • route: string

      Operation base route.

    • params: any
    • body: any

      Value to be sent in request body.

    • callback: function

    Returns void

    Value returned by the server of expected type.

Private mockDetermineBusinessServiceability

  • mockDetermineBusinessServiceability(address: Address, callback: function): void

Generated using TypeDoc