TenantManager

management. TenantManager

Abstracts interaction with the tenant endpoint.

Constructor

new TenantManager(options)

Parameters:
Name Type Description
options Object The client options.
Properties
Name Type Attributes Description
baseUrl String The URL of the API.
headers Object <optional>
 Headers to be included in all requests.
Source:

Members

tenant :external:RestClient

Provides an abstraction layer for consuming the Stats endpoint.
Type:
Source:

Methods

getSettings(cbopt) → {Promise|undefined}

Get the tenant settings..
Parameters:
Name Type Attributes Description
cb function <optional>
 Callback function.
Source:
Returns:
Type
Promise | undefined
Example
management.tenant.getSettings(function (err, settings) {
  if (err) {
    // Handle error.
  }

  console.log(settings);
});

updateSettings(data, cbopt) → {Promise|undefined}

Update the tenant settings.
Parameters:
Name Type Attributes Description
data Object The new tenant settings.
cb function <optional>
 Callback function.
Source:
Returns:
Type
Promise | undefined
Example
management.tenant.updateSettings(data, function (err) {
  if (err) {
    // Handle error.
  }
});