class PhoneComClient::AccountsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/phone_com_client/api/accounts_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_account(account_id, opts = {}) click to toggle source

Retrieve details of an individual account Retrieve details of an individual account. See Accounts for more info on the properties. @param account_id Account ID @param [Hash] opts the optional parameters @return [AccountFull]

# File lib/phone_com_client/api/accounts_api.rb, line 27
def get_account(account_id, opts = {})
  data, _status_code, _headers = get_account_with_http_info(account_id, opts)
  data
end
get_account_with_http_info(account_id, opts = {}) click to toggle source

Retrieve details of an individual account Retrieve details of an individual account. See Accounts for more info on the properties. @param account_id Account ID @param [Hash] opts the optional parameters @return [Array<(AccountFull, Fixnum, Hash)>] AccountFull data, response status code and response headers

# File lib/phone_com_client/api/accounts_api.rb, line 37
def get_account_with_http_info(account_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.get_account ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && account_id.nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling AccountsApi.get_account"
  end
  # resource path
  local_var_path = '/accounts/{account_id}'.sub('{' + 'account_id' + '}', account_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AccountFull')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#get_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list_accounts(opts = {}) click to toggle source

Get a list of accounts visible to the authenticated user or client. Get a list of accounts visible to the authenticated user or client. In most cases, there will only be one such account. See Accounts for more info on the properties. @param [Hash] opts the optional parameters @option opts [Array<String>] :filters_id ID filter @option opts [String] :sort_id ID sorting @option opts [Integer] :limit Max results @option opts [Integer] :offset Results to skip @option opts [String] :fields Field set @return [ListAccounts]

# File lib/phone_com_client/api/accounts_api.rb, line 85
def list_accounts(opts = {})
  data, _status_code, _headers = list_accounts_with_http_info(opts)
  data
end
list_accounts_with_http_info(opts = {}) click to toggle source

Get a list of accounts visible to the authenticated user or client. Get a list of accounts visible to the authenticated user or client. In most cases, there will only be one such account. See Accounts for more info on the properties. @param [Hash] opts the optional parameters @option opts [Array<String>] :filters_id ID filter @option opts [String] :sort_id ID sorting @option opts [Integer] :limit Max results @option opts [Integer] :offset Results to skip @option opts [String] :fields Field set @return [Array<(ListAccounts, Fixnum, Hash)>] ListAccounts data, response status code and response headers

# File lib/phone_com_client/api/accounts_api.rb, line 99
def list_accounts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AccountsApi.list_accounts ...'
  end
  if @api_client.config.client_side_validation && !opts[:'sort_id'].nil? && opts[:'sort_id'] !~ Regexp.new(/asc|desc/)
    fail ArgumentError, "invalid value for 'opts[:\"sort_id\"]' when calling AccountsApi.list_accounts, must conform to the pattern /asc|desc/."
  end

  # resource path
  local_var_path = '/accounts'

  # query parameters
  query_params = {}
  query_params[:'filters[id]'] = @api_client.build_collection_param(opts[:'filters_id'], :multi) if !opts[:'filters_id'].nil?
  query_params[:'sort[id]'] = opts[:'sort_id'] if !opts[:'sort_id'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apiKey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListAccounts')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AccountsApi#list_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end