Class: CropwisePlatformSdk::TermsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cropwise-platform-sdk/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/cropwise-platform-sdk/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/cropwise-platform-sdk/api/terms_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_terms_terms_id(terms_id, opts = {}) ⇒ DeleteEntitlements200Response

Delete Terms Removes a single term

Parameters:

  • terms_id (String) —

    Numeric ID of the term to remove

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/cropwise-platform-sdk/api/terms_api.rb', line 27

def delete_terms_terms_id(terms_id, opts = {})
  data, _status_code, _headers = delete_terms_terms_id_with_http_info(terms_id, opts)
  data
end

#delete_terms_terms_id_with_http_info(terms_id, opts = {}) ⇒ Array<(DeleteEntitlements200Response, Integer, Hash)>

Delete Terms Removes a single term

Parameters:

  • terms_id (String) —

    Numeric ID of the term to remove

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

    the optional parameters

Returns:



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
80
81
82
83
 
# File 'lib/cropwise-platform-sdk/api/terms_api.rb', line 37

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

  # query parameters
  query_params = opts[:query_params] || {}

  # 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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DeleteEntitlements200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TermsApi.delete_terms_terms_id",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TermsApi#delete_terms_terms_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_terms(opts = {}) ⇒ GetTerms200Response

List User Terms Get all terms from the current user

Parameters:

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

    the optional parameters

Returns:



89
90
91
92
 
# File 'lib/cropwise-platform-sdk/api/terms_api.rb', line 89

def get_terms(opts = {})
  data, _status_code, _headers = get_terms_with_http_info(opts)
  data
end

#get_terms_terms_id(terms_id, opts = {}) ⇒ Term

Get Terms By Id Get a single term

Parameters:

  • terms_id (String) —

    Numeric ID of the term to get

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

    the optional parameters

Returns:



147
148
149
150
 
# File 'lib/cropwise-platform-sdk/api/terms_api.rb', line 147

def get_terms_terms_id(terms_id, opts = {})
  data, _status_code, _headers = get_terms_terms_id_with_http_info(terms_id, opts)
  data
end

#get_terms_terms_id_with_http_info(terms_id, opts = {}) ⇒ Array<(Term, Integer, Hash)>

Get Terms By Id Get a single term

Parameters:

  • terms_id (String) —

    Numeric ID of the term to get

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

    the optional parameters

Returns:

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

    Term 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
196
197
198
199
200
201
202
203
 
# File 'lib/cropwise-platform-sdk/api/terms_api.rb', line 157

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

  # query parameters
  query_params = opts[:query_params] || {}

  # 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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Term'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TermsApi.get_terms_terms_id",
    :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: TermsApi#get_terms_terms_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_terms_with_http_info(opts = {}) ⇒ Array<(GetTerms200Response, Integer, Hash)>

List User Terms Get all terms from the current user

Parameters:

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

    the optional parameters

Returns:

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

    GetTerms200Response data, response status code and response headers



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
136
137
138
139
140
 
# File 'lib/cropwise-platform-sdk/api/terms_api.rb', line 98

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

  # query parameters
  query_params = opts[:query_params] || {}

  # 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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'GetTerms200Response'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TermsApi.get_terms",
    :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: TermsApi#get_terms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_termsall(opts = {}) ⇒ PageableTerms

List All Terms Get all terms

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :size (Integer) —

    Number of terms to return

  • :last_key (String) —

    Id of the last term returned by the previous query

  • :name (String) —

    Case insensitive term title or term title fragment

Returns:



212
213
214
215
 
# File 'lib/cropwise-platform-sdk/api/terms_api.rb', line 212

def get_termsall(opts = {})
  data, _status_code, _headers = get_termsall_with_http_info(opts)
  data
end

#get_termsall_with_http_info(opts = {}) ⇒ Array<(PageableTerms, Integer, Hash)>

List All Terms Get all terms

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :size (Integer) —

    Number of terms to return

  • :last_key (String) —

    Id of the last term returned by the previous query

  • :name (String) —

    Case insensitive term title or term title fragment

Returns:

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

    PageableTerms data, response status code and response headers



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
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/cropwise-platform-sdk/api/terms_api.rb', line 224

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
  query_params[:'last_key'] = opts[:'last_key'] if !opts[:'last_key'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PageableTerms'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TermsApi.get_termsall",
    :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: TermsApi#get_termsall\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_terms(put_terms_terms_id_request, opts = {}) ⇒ Term

Create a New Term Creates a new term

Parameters:

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

    the optional parameters

Returns:



276
277
278
279
 
# File 'lib/cropwise-platform-sdk/api/terms_api.rb', line 276

def post_terms(put_terms_terms_id_request, opts = {})
  data, _status_code, _headers = post_terms_with_http_info(put_terms_terms_id_request, opts)
  data
end

#post_terms_with_http_info(put_terms_terms_id_request, opts = {}) ⇒ Array<(Term, Integer, Hash)>

Create a New Term Creates a new term

Parameters:

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

    the optional parameters

Returns:

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

    Term data, response status code and response headers



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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/cropwise-platform-sdk/api/terms_api.rb', line 286

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

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(put_terms_terms_id_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Term'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TermsApi.post_terms",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TermsApi#post_terms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_termssign(opts = {}) ⇒ Array<SignTermAndPlan>

Sign terms and Plans Sign the term and plan

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



344
345
346
347
 
# File 'lib/cropwise-platform-sdk/api/terms_api.rb', line 344

def post_termssign(opts = {})
  data, _status_code, _headers = post_termssign_with_http_info(opts)
  data
end

#post_termssign_with_http_info(opts = {}) ⇒ Array<(Array<SignTermAndPlan>, Integer, Hash)>

Sign terms and Plans Sign the term and plan

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    Array<SignTermAndPlan> data, response status code and response headers



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/cropwise-platform-sdk/api/terms_api.rb', line 354

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

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/xml'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'sign_term_and_plan'])

  # return_type
  return_type = opts[:debug_return_type] || 'Array<SignTermAndPlan>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TermsApi.post_termssign",
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TermsApi#post_termssign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_terms_terms_id(terms_id, put_terms_terms_id_request, opts = {}) ⇒ Term

Edit Terms Updates a single term

Parameters:

  • terms_id (String) —

    Numeric ID of the term to update

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

    the optional parameters

Returns:



409
410
411
412
 
# File 'lib/cropwise-platform-sdk/api/terms_api.rb', line 409

def put_terms_terms_id(terms_id, put_terms_terms_id_request, opts = {})
  data, _status_code, _headers = put_terms_terms_id_with_http_info(terms_id, put_terms_terms_id_request, opts)
  data
end

#put_terms_terms_id_with_http_info(terms_id, put_terms_terms_id_request, opts = {}) ⇒ Array<(Term, Integer, Hash)>

Edit Terms Updates a single term

Parameters:

  • terms_id (String) —

    Numeric ID of the term to update

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

    the optional parameters

Returns:

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

    Term data, response status code and response headers



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/cropwise-platform-sdk/api/terms_api.rb', line 420

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

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(put_terms_terms_id_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Term'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"TermsApi.put_terms_terms_id",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TermsApi#put_terms_terms_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end