class Pipedrive::CurrenciesApi
Attributes
Public Class Methods
# File lib/pipedrive-openapi-client/api/currencies_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
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. @param [Hash] opts the optional parameters @option opts [String] :term Optional search term that is searched for from currency's name and/or code. @return [Currencies]
# 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
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. @param [Hash] opts the optional parameters @option opts [String] :term Optional search term that is searched for from currency's name and/or code. @return [Array<(Currencies
, Integer, Hash)>] Currencies
data, response status code and response headers
# 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