Home

Serviceability

Module for the MCC serviceability check.

Kind: global class

• Serviceability
  • new Serviceability(config)
  • instance
    • .check(address, [callback])
    • .select(address, [callback])
  • inner
    • ~callback : function

new Serviceability(config)

Constructs a Serviceability client with the supplied configuration.

Param	Type	Description
config	Object	Configuration for the module.
config.endpoint	string	Full endpoint for the MCC serviceability API.
[config.verbose]	boolean	Whether to output detailed logging to stderr.

serviceability.check(address, [callback])

Checks an address for its serviceability.

Kind: instance method of Serviceability

Param	Type	Description
address	Object	A string containing the username to authenticate.
address.Address1	string	The first line of the address to check.
[address.City]	string	The city of the address to check.
[address.State]	string	The two-letter state code of the address to check.
[address.UnitNumber]	string	The unit number of the address to check.
address.Zip	string	The zip code of the address to check.
[callback]	callback	A response handler to be called when the function completes.

serviceability.select(address, [callback])

Select a serviceable address.

Kind: instance method of Serviceability

Param	Type	Description
address	Object	An object containing the selected address.
address.Address1	string	The first line of the address to select.
[address.City]	string	The city of the address to select.
[address.State]	string	The two-letter state code of the address to select.
[address.UnitNumber]	string	The unit number of the address to select.
address.Zip	string	The zip code of the address to select.
address.LocationId	string	The opaque location identifier of the address to select.
address.UnitId	string	The opaque unit identifier of the address to select.
[callback]	callback	A response handler to be called when the function completes.

Serviceability~callback : function

A callback to handle both successful and failed requests.

Kind: inner typedef of Serviceability

Param	Type	Description
err	Error	An Error object containing information about a failure, or null if the call succeeded.
response	Object	An object created from the body of the successful response.