Skip to content

Latest commit

 

History

History
383 lines (269 loc) · 10.3 KB

AccountsApi.md

File metadata and controls

383 lines (269 loc) · 10.3 KB
Raw

Bombbomb.AccountsApi

All URIs are relative to https://api.bombbomb.com/v2

Method HTTP request Description
accountDetails GET /accounts Get account details.
createAccount POST /accounts Create Account
getClientStatistics GET /accounts/stats Get Client Statistics
getUserCountry GET /accounts/{clientId}/country Gets user country
resetApiKey PUT /accounts/apikey Reset API key
subscriptionPurchaseAllowed GET /accounts/purchaseable Check if subscription purchase allowed.
updateProfileData POST /account/profile/ Add profile information.

accountDetails

accountDetails()

Get account details.

Get the details of the user's account.

Example

var Bombbomb = require('bombbomb');
var defaultClient = Bombbomb.ApiClient.instance;

// Configure OAuth2 access token for authorization: BBOAuth2
var BBOAuth2 = defaultClient.authentications['BBOAuth2'];
BBOAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new Bombbomb.AccountsApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.accountDetails(callback);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

createAccount

'String' createAccount(teamId, firstName, lastName, emailAddress, companyName, phone, opts)

Create Account

Creates a new BombBomb account. This method is currently only available to paid seat admins.

Example

var Bombbomb = require('bombbomb');
var defaultClient = Bombbomb.ApiClient.instance;

// Configure OAuth2 access token for authorization: BBOAuth2
var BBOAuth2 = defaultClient.authentications['BBOAuth2'];
BBOAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new Bombbomb.AccountsApi();

var teamId = "teamId_example"; // String | The team id

var firstName = "firstName_example"; // String | First name of the user.

var lastName = "lastName_example"; // String | Last name of the user.

var emailAddress = "emailAddress_example"; // String | Email address of the user.

var companyName = "companyName_example"; // String | Company of the user.

var phone = "phone_example"; // String | Phone number of the user.

var opts = { 
  'country': "country_example", // String | Country of the user.
  'industry': "industry_example", // String | Industry of the user.
  'address': "address_example", // String | Street Address of the user.
  'city': "city_example", // String | City of the user.
  'postalCode': "postalCode_example", // String | Postal/Zip code of the user.
  'preventWelcomeEmail': true // Boolean | prevent an email with login credentials from being sent to the new account. must be set to 'true'
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createAccount(teamId, firstName, lastName, emailAddress, companyName, phone, opts, callback);

Parameters

Name Type Description Notes
teamId String The team id
firstName String First name of the user.
lastName String Last name of the user.
emailAddress String Email address of the user.
companyName String Company of the user.
phone String Phone number of the user.
country String Country of the user. [optional]
industry String Industry of the user. [optional]
address String Street Address of the user. [optional]
city String City of the user. [optional]
postalCode String Postal/Zip code of the user. [optional]
preventWelcomeEmail Boolean prevent an email with login credentials from being sent to the new account. must be set to 'true' [optional]

Return type

'String'

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

getClientStatistics

getClientStatistics(opts)

Get Client Statistics

Gets general statics for a Client

Example

var Bombbomb = require('bombbomb');
var defaultClient = Bombbomb.ApiClient.instance;

// Configure OAuth2 access token for authorization: BBOAuth2
var BBOAuth2 = defaultClient.authentications['BBOAuth2'];
BBOAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new Bombbomb.AccountsApi();

var opts = { 
  'clientId': "clientId_example", // String | Client ID of the account to retrieve. Defaults to yourself.
  'refresh': true, // Boolean | Boolean for whether data returned should be from cache or not.
  'statisticValues': "statisticValues_example" // String | Array of data that should be returned, used exclusively for cacheless data
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.getClientStatistics(opts, callback);

Parameters

Name Type Description Notes
clientId String Client ID of the account to retrieve. Defaults to yourself. [optional]
refresh Boolean Boolean for whether data returned should be from cache or not. [optional]
statisticValues String Array of data that should be returned, used exclusively for cacheless data [optional]

Return type

null (empty response body)

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

getUserCountry

getUserCountry()

Gets user country

Gets the users country

Example

var Bombbomb = require('bombbomb');
var defaultClient = Bombbomb.ApiClient.instance;

// Configure OAuth2 access token for authorization: BBOAuth2
var BBOAuth2 = defaultClient.authentications['BBOAuth2'];
BBOAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new Bombbomb.AccountsApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.getUserCountry(callback);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

resetApiKey

resetApiKey()

Reset API key

Resets the current user's API key and returns the new key

Example

var Bombbomb = require('bombbomb');
var defaultClient = Bombbomb.ApiClient.instance;

// Configure OAuth2 access token for authorization: BBOAuth2
var BBOAuth2 = defaultClient.authentications['BBOAuth2'];
BBOAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new Bombbomb.AccountsApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.resetApiKey(callback);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

subscriptionPurchaseAllowed

subscriptionPurchaseAllowed()

Check if subscription purchase allowed.

Check whether the user can purchase a subscription.

Example

var Bombbomb = require('bombbomb');
var defaultClient = Bombbomb.ApiClient.instance;

// Configure OAuth2 access token for authorization: BBOAuth2
var BBOAuth2 = defaultClient.authentications['BBOAuth2'];
BBOAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new Bombbomb.AccountsApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.subscriptionPurchaseAllowed(callback);

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

updateProfileData

updateProfileData(opts)

Add profile information.

Add profile information to this users account

Example

var Bombbomb = require('bombbomb');
var defaultClient = Bombbomb.ApiClient.instance;

// Configure OAuth2 access token for authorization: BBOAuth2
var BBOAuth2 = defaultClient.authentications['BBOAuth2'];
BBOAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new Bombbomb.AccountsApi();

var opts = { 
  'profileData': "profileData_example" // String | Profile field information for the account
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.updateProfileData(opts, callback);

Parameters

Name Type Description Notes
profileData String Profile field information for the account [optional]

Return type

null (empty response body)

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json