class ClickSendClient::SubaccountApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

subaccounts_by_subaccount_id_delete(subaccount_id, opts = {}) click to toggle source

Delete a subaccount Delete a subaccount @param subaccount_id ID of subaccount to delete @param [Hash] opts the optional parameters @return [String]

# File lib/clicksend_client/api/subaccount_api.rb, line 27
def subaccounts_by_subaccount_id_delete(subaccount_id, opts = {})
  data, _status_code, _headers = subaccounts_by_subaccount_id_delete_with_http_info(subaccount_id, opts)
  data
end
subaccounts_by_subaccount_id_delete_with_http_info(subaccount_id, opts = {}) click to toggle source

Delete a subaccount Delete a subaccount @param subaccount_id ID of subaccount to delete @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/clicksend_client/api/subaccount_api.rb, line 37
def subaccounts_by_subaccount_id_delete_with_http_info(subaccount_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubaccountApi.subaccounts_by_subaccount_id_delete ...'
  end
  # verify the required parameter 'subaccount_id' is set
  if @api_client.config.client_side_validation && subaccount_id.nil?
    fail ArgumentError, "Missing the required parameter 'subaccount_id' when calling SubaccountApi.subaccounts_by_subaccount_id_delete"
  end
  # resource path
  local_var_path = '/subaccounts/{subaccount_id}'.sub('{' + 'subaccount_id' + '}', subaccount_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 = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubaccountApi#subaccounts_by_subaccount_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
subaccounts_by_subaccount_id_get(subaccount_id, opts = {}) click to toggle source

Get specific subaccount Get specific subaccount @param subaccount_id ID of subaccount to get @param [Hash] opts the optional parameters @return [String]

# File lib/clicksend_client/api/subaccount_api.rb, line 81
def subaccounts_by_subaccount_id_get(subaccount_id, opts = {})
  data, _status_code, _headers = subaccounts_by_subaccount_id_get_with_http_info(subaccount_id, opts)
  data
end
subaccounts_by_subaccount_id_get_with_http_info(subaccount_id, opts = {}) click to toggle source

Get specific subaccount Get specific subaccount @param subaccount_id ID of subaccount to get @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/clicksend_client/api/subaccount_api.rb, line 91
def subaccounts_by_subaccount_id_get_with_http_info(subaccount_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubaccountApi.subaccounts_by_subaccount_id_get ...'
  end
  # verify the required parameter 'subaccount_id' is set
  if @api_client.config.client_side_validation && subaccount_id.nil?
    fail ArgumentError, "Missing the required parameter 'subaccount_id' when calling SubaccountApi.subaccounts_by_subaccount_id_get"
  end
  # resource path
  local_var_path = '/subaccounts/{subaccount_id}'.sub('{' + 'subaccount_id' + '}', subaccount_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 = ['BasicAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubaccountApi#subaccounts_by_subaccount_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
subaccounts_by_subaccount_id_put(subaccount_id, subaccount, opts = {}) click to toggle source

Update subaccount Update subaccount @param subaccount_id ID of subaccount to update @param subaccount Subaccount model @param [Hash] opts the optional parameters @return [String]

# File lib/clicksend_client/api/subaccount_api.rb, line 136
def subaccounts_by_subaccount_id_put(subaccount_id, subaccount, opts = {})
  data, _status_code, _headers = subaccounts_by_subaccount_id_put_with_http_info(subaccount_id, subaccount, opts)
  data
end
subaccounts_by_subaccount_id_put_with_http_info(subaccount_id, subaccount, opts = {}) click to toggle source

Update subaccount Update subaccount @param subaccount_id ID of subaccount to update @param subaccount Subaccount model @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/clicksend_client/api/subaccount_api.rb, line 147
def subaccounts_by_subaccount_id_put_with_http_info(subaccount_id, subaccount, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubaccountApi.subaccounts_by_subaccount_id_put ...'
  end
  # verify the required parameter 'subaccount_id' is set
  if @api_client.config.client_side_validation && subaccount_id.nil?
    fail ArgumentError, "Missing the required parameter 'subaccount_id' when calling SubaccountApi.subaccounts_by_subaccount_id_put"
  end
  # verify the required parameter 'subaccount' is set
  if @api_client.config.client_side_validation && subaccount.nil?
    fail ArgumentError, "Missing the required parameter 'subaccount' when calling SubaccountApi.subaccounts_by_subaccount_id_put"
  end
  # resource path
  local_var_path = '/subaccounts/{subaccount_id}'.sub('{' + 'subaccount_id' + '}', subaccount_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 = @api_client.object_to_http_body(subaccount)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubaccountApi#subaccounts_by_subaccount_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
subaccounts_get(opts = {}) click to toggle source

Get all subaccounts Get all subaccounts @param [Hash] opts the optional parameters @option opts [Integer] :page Page number (default to 1) @option opts [Integer] :limit Number of records per page (default to 10) @return [String]

# File lib/clicksend_client/api/subaccount_api.rb, line 196
def subaccounts_get(opts = {})
  data, _status_code, _headers = subaccounts_get_with_http_info(opts)
  data
end
subaccounts_get_with_http_info(opts = {}) click to toggle source

Get all subaccounts Get all subaccounts @param [Hash] opts the optional parameters @option opts [Integer] :page Page number @option opts [Integer] :limit Number of records per page @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/clicksend_client/api/subaccount_api.rb, line 207
def subaccounts_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubaccountApi.subaccounts_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling SubaccountApi.subaccounts_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SubaccountApi.subaccounts_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/subaccounts'

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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 = ['BasicAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubaccountApi#subaccounts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
subaccounts_post(subaccount, opts = {}) click to toggle source

Create new subaccount Create new subaccount @param subaccount Subaccount model @param [Hash] opts the optional parameters @return [String]

# File lib/clicksend_client/api/subaccount_api.rb, line 257
def subaccounts_post(subaccount, opts = {})
  data, _status_code, _headers = subaccounts_post_with_http_info(subaccount, opts)
  data
end
subaccounts_post_with_http_info(subaccount, opts = {}) click to toggle source

Create new subaccount Create new subaccount @param subaccount Subaccount model @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/clicksend_client/api/subaccount_api.rb, line 267
def subaccounts_post_with_http_info(subaccount, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubaccountApi.subaccounts_post ...'
  end
  # verify the required parameter 'subaccount' is set
  if @api_client.config.client_side_validation && subaccount.nil?
    fail ArgumentError, "Missing the required parameter 'subaccount' when calling SubaccountApi.subaccounts_post"
  end
  # resource path
  local_var_path = '/subaccounts'

  # 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 = @api_client.object_to_http_body(subaccount)
  auth_names = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubaccountApi#subaccounts_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
subaccounts_regen_api_key_by_subaccount_id_put(subaccount_id, opts = {}) click to toggle source

Regenerate an API Key Regenerate an API Key @param subaccount_id ID of subaccount to regenerate API key for @param [Hash] opts the optional parameters @return [String]

# File lib/clicksend_client/api/subaccount_api.rb, line 311
def subaccounts_regen_api_key_by_subaccount_id_put(subaccount_id, opts = {})
  data, _status_code, _headers = subaccounts_regen_api_key_by_subaccount_id_put_with_http_info(subaccount_id, opts)
  data
end
subaccounts_regen_api_key_by_subaccount_id_put_with_http_info(subaccount_id, opts = {}) click to toggle source

Regenerate an API Key Regenerate an API Key @param subaccount_id ID of subaccount to regenerate API key for @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/clicksend_client/api/subaccount_api.rb, line 321
def subaccounts_regen_api_key_by_subaccount_id_put_with_http_info(subaccount_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubaccountApi.subaccounts_regen_api_key_by_subaccount_id_put ...'
  end
  # verify the required parameter 'subaccount_id' is set
  if @api_client.config.client_side_validation && subaccount_id.nil?
    fail ArgumentError, "Missing the required parameter 'subaccount_id' when calling SubaccountApi.subaccounts_regen_api_key_by_subaccount_id_put"
  end
  # resource path
  local_var_path = '/subaccounts/{subaccount_id}/regen-api-key'.sub('{' + 'subaccount_id' + '}', subaccount_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 = ['BasicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubaccountApi#subaccounts_regen_api_key_by_subaccount_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end