Skip to content

Latest commit

 

History

History
383 lines (271 loc) · 12.2 KB

AccountsApi.md

File metadata and controls

383 lines (271 loc) · 12.2 KB

bombbomb.AccountsApi

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

Method HTTP request Description
account_details GET /accounts Get account details.
create_account POST /accounts Create Account
get_client_statistics GET /accounts/stats Get Client Statistics
get_user_country GET /accounts/{clientId}/country Gets user country
reset_api_key PUT /accounts/apikey Reset API key
subscription_purchase_allowed GET /accounts/purchaseable Check if subscription purchase allowed.
update_profile_data POST /account/profile/ Add profile information.

account_details

account_details()

Get account details.

Get the details of the user's account.

Example

from __future__ import print_function
import time
import bombbomb
from bombbomb.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: BBOAuth2
configuration = bombbomb.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = bombbomb.AccountsApi(bombbomb.ApiClient(configuration))

try:
    # Get account details.
    api_instance.account_details()
except ApiException as e:
    print("Exception when calling AccountsApi->account_details: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

BBOAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_account

str create_account(team_id, first_name, last_name, email_address, company_name, phone, country=country, industry=industry, address=address, city=city, postal_code=postal_code, prevent_welcome_email=prevent_welcome_email)

Create Account

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

Example

from __future__ import print_function
import time
import bombbomb
from bombbomb.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: BBOAuth2
configuration = bombbomb.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = bombbomb.AccountsApi(bombbomb.ApiClient(configuration))
team_id = 'team_id_example' # str | The team id
first_name = 'first_name_example' # str | First name of the user.
last_name = 'last_name_example' # str | Last name of the user.
email_address = 'email_address_example' # str | Email address of the user.
company_name = 'company_name_example' # str | Company of the user.
phone = 'phone_example' # str | Phone number of the user.
country = 'country_example' # str | Country of the user. (optional)
industry = 'industry_example' # str | Industry of the user. (optional)
address = 'address_example' # str | Street Address of the user. (optional)
city = 'city_example' # str | City of the user. (optional)
postal_code = 'postal_code_example' # str | Postal/Zip code of the user. (optional)
prevent_welcome_email = true # bool | prevent an email with login credentials from being sent to the new account. must be set to 'true' (optional)

try:
    # Create Account
    api_response = api_instance.create_account(team_id, first_name, last_name, email_address, company_name, phone, country=country, industry=industry, address=address, city=city, postal_code=postal_code, prevent_welcome_email=prevent_welcome_email)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AccountsApi->create_account: %s\n" % e)

Parameters

Name Type Description Notes
team_id str The team id
first_name str First name of the user.
last_name str Last name of the user.
email_address str Email address of the user.
company_name str Company of the user.
phone str Phone number of the user.
country str Country of the user. [optional]
industry str Industry of the user. [optional]
address str Street Address of the user. [optional]
city str City of the user. [optional]
postal_code str Postal/Zip code of the user. [optional]
prevent_welcome_email bool prevent an email with login credentials from being sent to the new account. must be set to 'true' [optional]

Return type

str

Authorization

BBOAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_client_statistics

get_client_statistics(client_id=client_id, refresh=refresh, statistic_values=statistic_values)

Get Client Statistics

Gets general statics for a Client

Example

from __future__ import print_function
import time
import bombbomb
from bombbomb.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: BBOAuth2
configuration = bombbomb.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = bombbomb.AccountsApi(bombbomb.ApiClient(configuration))
client_id = 'client_id_example' # str | Client ID of the account to retrieve. Defaults to yourself. (optional)
refresh = true # bool | Boolean for whether data returned should be from cache or not. (optional)
statistic_values = 'statistic_values_example' # str | Array of data that should be returned, used exclusively for cacheless data (optional)

try:
    # Get Client Statistics
    api_instance.get_client_statistics(client_id=client_id, refresh=refresh, statistic_values=statistic_values)
except ApiException as e:
    print("Exception when calling AccountsApi->get_client_statistics: %s\n" % e)

Parameters

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

Return type

void (empty response body)

Authorization

BBOAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_user_country

get_user_country()

Gets user country

Gets the users country

Example

from __future__ import print_function
import time
import bombbomb
from bombbomb.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: BBOAuth2
configuration = bombbomb.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = bombbomb.AccountsApi(bombbomb.ApiClient(configuration))

try:
    # Gets user country
    api_instance.get_user_country()
except ApiException as e:
    print("Exception when calling AccountsApi->get_user_country: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

BBOAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

reset_api_key

reset_api_key()

Reset API key

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

Example

from __future__ import print_function
import time
import bombbomb
from bombbomb.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: BBOAuth2
configuration = bombbomb.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = bombbomb.AccountsApi(bombbomb.ApiClient(configuration))

try:
    # Reset API key
    api_instance.reset_api_key()
except ApiException as e:
    print("Exception when calling AccountsApi->reset_api_key: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

BBOAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

subscription_purchase_allowed

subscription_purchase_allowed()

Check if subscription purchase allowed.

Check whether the user can purchase a subscription.

Example

from __future__ import print_function
import time
import bombbomb
from bombbomb.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: BBOAuth2
configuration = bombbomb.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = bombbomb.AccountsApi(bombbomb.ApiClient(configuration))

try:
    # Check if subscription purchase allowed.
    api_instance.subscription_purchase_allowed()
except ApiException as e:
    print("Exception when calling AccountsApi->subscription_purchase_allowed: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

BBOAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_profile_data

update_profile_data(profile_data=profile_data)

Add profile information.

Add profile information to this users account

Example

from __future__ import print_function
import time
import bombbomb
from bombbomb.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: BBOAuth2
configuration = bombbomb.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = bombbomb.AccountsApi(bombbomb.ApiClient(configuration))
profile_data = 'profile_data_example' # str | Profile field information for the account (optional)

try:
    # Add profile information.
    api_instance.update_profile_data(profile_data=profile_data)
except ApiException as e:
    print("Exception when calling AccountsApi->update_profile_data: %s\n" % e)

Parameters

Name Type Description Notes
profile_data str Profile field information for the account [optional]

Return type

void (empty response body)

Authorization

BBOAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]