Class: SamplifyAPIClient::AttributesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/samplify_api_client/api/attributes_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AttributesApi

Returns a new instance of AttributesApi.



19
20
21
 
# File 'lib/samplify_api_client/api/attributes_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/samplify_api_client/api/attributes_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#attributes_list(country_iso_code, language_iso_code, opts = {}) ⇒ Attributes

list attributes

Parameters:

  • country_iso_code —

    Country ISO code

  • language_iso_code —

    Language ISO code

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    Only return attributes with the given id

  • :limit (Integer) —

    Maximum number of attributes to return (default to 10)

  • :name (String) —

    Only return attributes with the given name

  • :offset (Integer) —

    The first zero-based offset attribute to return (default to 0)

  • :sort (Array<String>) —

    Sort the attributes by the given key(s)

  • :text (String) —

    Only return attributes with the given text

Returns:



33
34
35
36
 
# File 'lib/samplify_api_client/api/attributes_api.rb', line 33

def attributes_list(country_iso_code, language_iso_code, opts = {})
  data, _status_code, _headers = attributes_list_with_http_info(country_iso_code, language_iso_code, opts)
  data
end

#attributes_list_with_http_info(country_iso_code, language_iso_code, opts = {}) ⇒ Array<(Attributes, Fixnum, Hash)>

list attributes

Parameters:

  • country_iso_code —

    Country ISO code

  • language_iso_code —

    Language ISO code

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

    the optional parameters

Options Hash (opts):

  • :id (String) —

    Only return attributes with the given id

  • :limit (Integer) —

    Maximum number of attributes to return

  • :name (String) —

    Only return attributes with the given name

  • :offset (Integer) —

    The first zero-based offset attribute to return

  • :sort (Array<String>) —

    Sort the attributes by the given key(s)

  • :text (String) —

    Only return attributes with the given text

Returns:

  • (Array<(Attributes, Fixnum, Hash)>) —

    Attributes data, response status code and response headers



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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/samplify_api_client/api/attributes_api.rb', line 49

def attributes_list_with_http_info(country_iso_code, language_iso_code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AttributesApi.attributes_list ...'
  end
  # verify the required parameter 'country_iso_code' is set
  if @api_client.config.client_side_validation && country_iso_code.nil?
    fail ArgumentError, "Missing the required parameter 'country_iso_code' when calling AttributesApi.attributes_list"
  end
  # verify the required parameter 'language_iso_code' is set
  if @api_client.config.client_side_validation && language_iso_code.nil?
    fail ArgumentError, "Missing the required parameter 'language_iso_code' when calling AttributesApi.attributes_list"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AttributesApi.attributes_list, must be smaller than or equal to 1000.'
  end

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

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

  # resource path
  local_var_path = '/sample/v1/attributes/{countryIsoCode}/{languageIsoCode}'.sub('{' + 'countryIsoCode' + '}', country_iso_code.to_s).sub('{' + 'languageIsoCode' + '}', language_iso_code.to_s)

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.attributes+json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/xml', 'application/gob', 'application/x-gob'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['jwt']
  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 => 'Attributes')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AttributesApi#attributes_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end