class ClickSendClient::PostLetterApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

post_letters_export_get(filename, opts = {}) click to toggle source

export post letter history export post letter history @param filename Filename to export to @param [Hash] opts the optional parameters @return [String]

# File lib/clicksend_client/api/post_letter_api.rb, line 27
def post_letters_export_get(filename, opts = {})
  data, _status_code, _headers = post_letters_export_get_with_http_info(filename, opts)
  data
end
post_letters_export_get_with_http_info(filename, opts = {}) click to toggle source

export post letter history export post letter history @param filename Filename to export to @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# File lib/clicksend_client/api/post_letter_api.rb, line 37
def post_letters_export_get_with_http_info(filename, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostLetterApi.post_letters_export_get ...'
  end
  # verify the required parameter 'filename' is set
  if @api_client.config.client_side_validation && filename.nil?
    fail ArgumentError, "Missing the required parameter 'filename' when calling PostLetterApi.post_letters_export_get"
  end
  # resource path
  local_var_path = '/post/letters/history/export'

  # query parameters
  query_params = {}
  query_params[:'filename'] = filename

  # 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: PostLetterApi#post_letters_export_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_letters_history_get(opts = {}) click to toggle source

Get all post letter history Get all post letter history @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/post_letter_api.rb, line 83
def post_letters_history_get(opts = {})
  data, _status_code, _headers = post_letters_history_get_with_http_info(opts)
  data
end
post_letters_history_get_with_http_info(opts = {}) click to toggle source

Get all post letter history Get all post letter history @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/post_letter_api.rb, line 94
def post_letters_history_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostLetterApi.post_letters_history_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PostLetterApi.post_letters_history_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 PostLetterApi.post_letters_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/post/letters/history'

  # 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: PostLetterApi#post_letters_history_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_letters_price_post(post_letter, opts = {}) click to toggle source

Calculate post letter price Calculate post letter price @param post_letter PostLetter model @param [Hash] opts the optional parameters @return [String]

# File lib/clicksend_client/api/post_letter_api.rb, line 144
def post_letters_price_post(post_letter, opts = {})
  data, _status_code, _headers = post_letters_price_post_with_http_info(post_letter, opts)
  data
end
post_letters_price_post_with_http_info(post_letter, opts = {}) click to toggle source

Calculate post letter price Calculate post letter price @param post_letter PostLetter 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/post_letter_api.rb, line 154
def post_letters_price_post_with_http_info(post_letter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostLetterApi.post_letters_price_post ...'
  end
  # verify the required parameter 'post_letter' is set
  if @api_client.config.client_side_validation && post_letter.nil?
    fail ArgumentError, "Missing the required parameter 'post_letter' when calling PostLetterApi.post_letters_price_post"
  end
  # resource path
  local_var_path = '/post/letters/price'

  # 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(post_letter)
  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: PostLetterApi#post_letters_price_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
post_letters_send_post(post_letter, opts = {}) click to toggle source

Send post letter Send post letter @param post_letter PostLetter model @param [Hash] opts the optional parameters @return [String]

# File lib/clicksend_client/api/post_letter_api.rb, line 198
def post_letters_send_post(post_letter, opts = {})
  data, _status_code, _headers = post_letters_send_post_with_http_info(post_letter, opts)
  data
end
post_letters_send_post_with_http_info(post_letter, opts = {}) click to toggle source

Send post letter Send post letter @param post_letter PostLetter 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/post_letter_api.rb, line 208
def post_letters_send_post_with_http_info(post_letter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostLetterApi.post_letters_send_post ...'
  end
  # verify the required parameter 'post_letter' is set
  if @api_client.config.client_side_validation && post_letter.nil?
    fail ArgumentError, "Missing the required parameter 'post_letter' when calling PostLetterApi.post_letters_send_post"
  end
  # resource path
  local_var_path = '/post/letters/send'

  # 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(post_letter)
  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: PostLetterApi#post_letters_send_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end