Class: BudgeaClient::TermsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/budgea_client/api/terms_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TermsApi

Returns a new instance of TermsApi.



19
20
21
 
# File 'lib/budgea_client/api/terms_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/budgea_client/api/terms_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#terms_get(opts = {}) ⇒ InlineResponse20021

Return the current terms and the content of the associated file

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



27
28
29
30
 
# File 'lib/budgea_client/api/terms_api.rb', line 27

def terms_get(opts = {})
  data, _status_code, _headers = terms_get_with_http_info(opts)
  data
end

#terms_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse20021, Fixnum, Hash)>

Return the current terms and the content of the associated file

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20021 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
 
# File 'lib/budgea_client/api/terms_api.rb', line 37

def terms_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TermsApi.terms_get ...'
  end
  # resource path
  local_var_path = '/terms'

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#terms_id_term_post(id_term, opts = {}) ⇒ TermsOfService

Add terms content for a language. Only for the active terms, there is no use to update obsolete terms

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :language (String) —

    two letter code of the language to inserted

  • :file_content (File) —

    file containing the terms

  • :expand (String)

Returns:



81
82
83
84
 
# File 'lib/budgea_client/api/terms_api.rb', line 81

def terms_id_term_post(id_term, opts = {})
  data, _status_code, _headers = terms_id_term_post_with_http_info(id_term, opts)
  data
end

#terms_id_term_post_with_http_info(id_term, opts = {}) ⇒ Array<(TermsOfService, Fixnum, Hash)>

Add terms content for a language. Only for the active terms, there is no use to update obsolete terms

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :language (String) —

    two letter code of the language to inserted

  • :file_content (File) —

    file containing the terms

  • :expand (String)

Returns:

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

    TermsOfService data, response status code and response headers



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/budgea_client/api/terms_api.rb', line 94

def terms_id_term_post_with_http_info(id_term, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TermsApi.terms_id_term_post ...'
  end
  # verify the required parameter 'id_term' is set
  if @api_client.config.client_side_validation && id_term.nil?
    fail ArgumentError, "Missing the required parameter 'id_term' when calling TermsApi.terms_id_term_post"
  end
  # resource path
  local_var_path = '/terms/{id_term}'.sub('{' + 'id_term' + '}', id_term.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['language'] = opts[:'language'] if !opts[:'language'].nil?
  form_params['file_content'] = opts[:'file_content'] if !opts[:'file_content'].nil?

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

#terms_post(opts = {}) ⇒ TermsOfService

Register a version of ‘Terms of Service’ in database

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :version (String) —

    Number of version

  • :file_content (File) —

    file containing the terms, optional

  • :language (String) —

    two letters code of the language of the inserted terms if provided. default: &#39;fr&#39;

  • :expand (String)

Returns:



144
145
146
147
 
# File 'lib/budgea_client/api/terms_api.rb', line 144

def terms_post(opts = {})
  data, _status_code, _headers = terms_post_with_http_info(opts)
  data
end

#terms_post_with_http_info(opts = {}) ⇒ Array<(TermsOfService, Fixnum, Hash)>

Register a version of &#39;Terms of Service&#39; in database

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :version (String) —

    Number of version

  • :file_content (File) —

    file containing the terms, optional

  • :language (String) —

    two letters code of the language of the inserted terms if provided. default: &#39;fr&#39;

  • :expand (String)

Returns:

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

    TermsOfService data, response status code and response headers



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/budgea_client/api/terms_api.rb', line 157

def terms_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TermsApi.terms_post ...'
  end
  # resource path
  local_var_path = '/terms'

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params['version'] = opts[:'version'] if !opts[:'version'].nil?
  form_params['file_content'] = opts[:'file_content'] if !opts[:'file_content'].nil?
  form_params['language'] = opts[:'language'] if !opts[:'language'].nil?

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

#users_id_user_terms_get(id_user, opts = {}) ⇒ InlineResponse20021

Get active terms object for a specific user, only one terms can be active

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:



202
203
204
205
 
# File 'lib/budgea_client/api/terms_api.rb', line 202

def users_id_user_terms_get(id_user, opts = {})
  data, _status_code, _headers = users_id_user_terms_get_with_http_info(id_user, opts)
  data
end

#users_id_user_terms_get_with_http_info(id_user, opts = {}) ⇒ Array<(InlineResponse20021, Fixnum, Hash)>

Get active terms object for a specific user, only one terms can be active

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :expand (String)

Returns:

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

    InlineResponse20021 data, response status code and response headers



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/budgea_client/api/terms_api.rb', line 213

def users_id_user_terms_get_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TermsApi.users_id_user_terms_get ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling TermsApi.users_id_user_terms_get"
  end
  # resource path
  local_var_path = '/users/{id_user}/terms'.sub('{' + 'id_user' + '}', id_user.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}

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

#users_id_user_terms_post(id_user, opts = {}) ⇒ TermsOfService

Register user’s consent for a specific terms id

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :id_terms (Integer) —

    terms id

  • :expand (String)

Returns:



260
261
262
263
 
# File 'lib/budgea_client/api/terms_api.rb', line 260

def users_id_user_terms_post(id_user, opts = {})
  data, _status_code, _headers = users_id_user_terms_post_with_http_info(id_user, opts)
  data
end

#users_id_user_terms_post_with_http_info(id_user, opts = {}) ⇒ Array<(TermsOfService, Fixnum, Hash)>

Register user&#39;s consent for a specific terms id

Parameters:

  • id_user —

    Hint: you can use &#39;me&#39; or &#39;all&#39;

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

    the optional parameters

Options Hash (opts):

  • :id_terms (Integer) —

    terms id

  • :expand (String)

Returns:

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

    TermsOfService data, response status code and response headers



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/budgea_client/api/terms_api.rb', line 272

def users_id_user_terms_post_with_http_info(id_user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TermsApi.users_id_user_terms_post ...'
  end
  # verify the required parameter 'id_user' is set
  if @api_client.config.client_side_validation && id_user.nil?
    fail ArgumentError, "Missing the required parameter 'id_user' when calling TermsApi.users_id_user_terms_post"
  end
  # resource path
  local_var_path = '/users/{id_user}/terms'.sub('{' + 'id_user' + '}', id_user.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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/x-www-form-urlencoded'])

  # form parameters
  form_params = {}
  form_params['id_terms'] = opts[:'id_terms'] if !opts[:'id_terms'].nil?

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