Class: Pipedrive::CurrenciesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pipedrive-openapi-client/api/currencies_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CurrenciesApi

Returns a new instance of CurrenciesApi.



19
20
21
 
# File 'lib/pipedrive-openapi-client/api/currencies_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/pipedrive-openapi-client/api/currencies_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#currencies_get(opts = {}) ⇒ Currencies

Get all supported currencies Returns all supported currencies in given account which should be used when saving monetary values with other objects. The ‘code’ parameter of the returning objects is the currency code according to ISO 4217 for all non-custom currencies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :term (String) —

    Optional search term that is searched for from currency's name and/or code.

Returns:



27
28
29
30
 
# File 'lib/pipedrive-openapi-client/api/currencies_api.rb', line 27

def currencies_get(opts = {})
  data, _status_code, _headers = currencies_get_with_http_info(opts)
  data
end

#currencies_get_with_http_info(opts = {}) ⇒ Array<(Currencies, Integer, Hash)>

Get all supported currencies Returns all supported currencies in given account which should be used when saving monetary values with other objects. The &#39;code&#39; parameter of the returning objects is the currency code according to ISO 4217 for all non-custom currencies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :term (String) —

    Optional search term that is searched for from currency&#39;s name and/or code.

Returns:

  • (Array<(Currencies, Integer, Hash)>) —

    Currencies data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/pipedrive-openapi-client/api/currencies_api.rb', line 37

def currencies_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CurrenciesApi.currencies_get ...'
  end
  # resource path
  local_var_path = '/currencies'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'term'] = opts[:'term'] if !opts[:'term'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Currencies' 

  # auth_names
  auth_names = opts[:auth_names] || ['api_key', 'oauth2']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CurrenciesApi#currencies_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end