Class: CropwisePlatformSdk::CycleApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cropwise-platform-sdk/api/cycle_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CycleApi

Returns a new instance of CycleApi.



19
20
21
 
# File 'lib/cropwise-platform-sdk/api/cycle_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/cycle_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#attach_cycle_seasons(cycle_id, opts = {}) ⇒ AttachSeasonResultDTO

Attach/Deattach Cycle’s season Attach/Deattach Cycle’s season

Parameters:

  • cycle_id (String) —

    Cycle ID.

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

    the optional parameters

Options Hash (opts):

Returns:



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

def attach_cycle_seasons(cycle_id, opts = {})
  data, _status_code, _headers = attach_cycle_seasons_with_http_info(cycle_id, opts)
  data
end

#attach_cycle_seasons_with_http_info(cycle_id, opts = {}) ⇒ Array<(AttachSeasonResultDTO, Integer, Hash)>

Attach/Deattach Cycle&#39;s season Attach/Deattach Cycle&#39;s season

Parameters:

  • cycle_id (String) —

    Cycle ID.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    AttachSeasonResultDTO data, response status code and response headers



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
84
85
86
87
88
89
90
 
# File 'lib/cropwise-platform-sdk/api/cycle_api.rb', line 39

def attach_cycle_seasons_with_http_info(cycle_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CycleApi.attach_cycle_seasons ...'
  end
  # verify the required parameter 'cycle_id' is set
  if @api_client.config.client_side_validation && cycle_id.nil?
    fail ArgumentError, "Missing the required parameter 'cycle_id' when calling CycleApi.attach_cycle_seasons"
  end
  # resource path
  local_var_path = '/v2/cycles/{cycleId}/seasons'.sub('{' + 'cycleId' + '}', CGI.escape(cycle_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(opts[:'attach_season_dto'])

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

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

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

#create_cycle(opts = {}) ⇒ CycleDTO

Create a Cycle Create a Cycle

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



97
98
99
100
 
# File 'lib/cropwise-platform-sdk/api/cycle_api.rb', line 97

def create_cycle(opts = {})
  data, _status_code, _headers = create_cycle_with_http_info(opts)
  data
end

#create_cycle_with_http_info(opts = {}) ⇒ Array<(CycleDTO, Integer, Hash)>

Create a Cycle Create a Cycle

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    CycleDTO data, response status code and response headers



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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/cropwise-platform-sdk/api/cycle_api.rb', line 107

def create_cycle_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CycleApi.create_cycle ...'
  end
  # resource path
  local_var_path = '/v2/cycles'

  # 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(opts[:'create_cycle_dto'])

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

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

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

#delete_cycle(cycle_id, opts = {}) ⇒ nil

Delete a Cycle Delete a Cycle

Parameters:

  • cycle_id (String) —

    Cycle ID.

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

    the optional parameters

Returns:

  • (nil) 


161
162
163
164
 
# File 'lib/cropwise-platform-sdk/api/cycle_api.rb', line 161

def delete_cycle(cycle_id, opts = {})
  delete_cycle_with_http_info(cycle_id, opts)
  nil
end

#delete_cycle_with_http_info(cycle_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a Cycle Delete a Cycle

Parameters:

  • cycle_id (String) —

    Cycle ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/cropwise-platform-sdk/api/cycle_api.rb', line 171

def delete_cycle_with_http_info(cycle_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CycleApi.delete_cycle ...'
  end
  # verify the required parameter 'cycle_id' is set
  if @api_client.config.client_side_validation && cycle_id.nil?
    fail ArgumentError, "Missing the required parameter 'cycle_id' when calling CycleApi.delete_cycle"
  end
  # resource path
  local_var_path = '/v2/cycles/{cycleId}'.sub('{' + 'cycleId' + '}', CGI.escape(cycle_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]

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

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

#edit_cycle(cycle_id, opts = {}) ⇒ CycleDTO

Edit a Cycle Edit a Cycle

Parameters:

  • cycle_id (String) —

    Cycle ID.

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

    the optional parameters

Options Hash (opts):

  • :edit_cycle_dto (EditCycleDTO) —

    Edit cycle&#39;s details

Returns:



225
226
227
228
 
# File 'lib/cropwise-platform-sdk/api/cycle_api.rb', line 225

def edit_cycle(cycle_id, opts = {})
  data, _status_code, _headers = edit_cycle_with_http_info(cycle_id, opts)
  data
end

#edit_cycle_with_http_info(cycle_id, opts = {}) ⇒ Array<(CycleDTO, Integer, Hash)>

Edit a Cycle Edit a Cycle

Parameters:

  • cycle_id (String) —

    Cycle ID.

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

    the optional parameters

Options Hash (opts):

  • :edit_cycle_dto (EditCycleDTO) —

    Edit cycle&#39;s details

Returns:

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

    CycleDTO data, response status code and response headers



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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/cropwise-platform-sdk/api/cycle_api.rb', line 236

def edit_cycle_with_http_info(cycle_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CycleApi.edit_cycle ...'
  end
  # verify the required parameter 'cycle_id' is set
  if @api_client.config.client_side_validation && cycle_id.nil?
    fail ArgumentError, "Missing the required parameter 'cycle_id' when calling CycleApi.edit_cycle"
  end
  # resource path
  local_var_path = '/v2/cycles/{cycleId}'.sub('{' + 'cycleId' + '}', CGI.escape(cycle_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(opts[:'edit_cycle_dto'])

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

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

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

#get_cycle(cycle_id, opts = {}) ⇒ CycleDTO

Get a Cycle Get a Cycle

Parameters:

  • cycle_id (String) —

    Cycle ID.

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

    the optional parameters

Returns:



294
295
296
297
 
# File 'lib/cropwise-platform-sdk/api/cycle_api.rb', line 294

def get_cycle(cycle_id, opts = {})
  data, _status_code, _headers = get_cycle_with_http_info(cycle_id, opts)
  data
end

#get_cycle_season_fields(cycle_id, opts = {}) ⇒ PagedSeasonField

Get Cycle’s season-fields Get Cycle’s Season-fields

Parameters:

  • cycle_id (String) —

    Cycle ID.

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

    the optional parameters

Returns:



357
358
359
360
 
# File 'lib/cropwise-platform-sdk/api/cycle_api.rb', line 357

def get_cycle_season_fields(cycle_id, opts = {})
  data, _status_code, _headers = get_cycle_season_fields_with_http_info(cycle_id, opts)
  data
end

#get_cycle_season_fields_with_http_info(cycle_id, opts = {}) ⇒ Array<(PagedSeasonField, Integer, Hash)>

Get Cycle&#39;s season-fields Get Cycle&#39;s Season-fields

Parameters:

  • cycle_id (String) —

    Cycle ID.

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

    the optional parameters

Returns:

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

    PagedSeasonField data, response status code and response headers



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
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/cropwise-platform-sdk/api/cycle_api.rb', line 367

def get_cycle_season_fields_with_http_info(cycle_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CycleApi.get_cycle_season_fields ...'
  end
  # verify the required parameter 'cycle_id' is set
  if @api_client.config.client_side_validation && cycle_id.nil?
    fail ArgumentError, "Missing the required parameter 'cycle_id' when calling CycleApi.get_cycle_season_fields"
  end
  # resource path
  local_var_path = '/v2/cycles/{cycleId}/season-fields'.sub('{' + 'cycleId' + '}', CGI.escape(cycle_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] || 'PagedSeasonField'

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

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

#get_cycle_seasons(cycle_id, opts = {}) ⇒ PagedSeason

Get Cycle’s season Get Cycle’s Seasons

Parameters:

  • cycle_id (String) —

    Cycle ID.

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

    the optional parameters

Options Hash (opts):

  • :include_deleted (Boolean)

Returns:



421
422
423
424
 
# File 'lib/cropwise-platform-sdk/api/cycle_api.rb', line 421

def get_cycle_seasons(cycle_id, opts = {})
  data, _status_code, _headers = get_cycle_seasons_with_http_info(cycle_id, opts)
  data
end

#get_cycle_seasons_with_http_info(cycle_id, opts = {}) ⇒ Array<(PagedSeason, Integer, Hash)>

Get Cycle&#39;s season Get Cycle&#39;s Seasons

Parameters:

  • cycle_id (String) —

    Cycle ID.

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

    the optional parameters

Options Hash (opts):

  • :include_deleted (Boolean)

Returns:

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

    PagedSeason data, response status code and response headers



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
476
477
478
479
 
# File 'lib/cropwise-platform-sdk/api/cycle_api.rb', line 432

def get_cycle_seasons_with_http_info(cycle_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CycleApi.get_cycle_seasons ...'
  end
  # verify the required parameter 'cycle_id' is set
  if @api_client.config.client_side_validation && cycle_id.nil?
    fail ArgumentError, "Missing the required parameter 'cycle_id' when calling CycleApi.get_cycle_seasons"
  end
  # resource path
  local_var_path = '/v2/cycles/{cycleId}/seasons'.sub('{' + 'cycleId' + '}', CGI.escape(cycle_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include_deleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].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] || 'PagedSeason'

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

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

#get_cycle_with_http_info(cycle_id, opts = {}) ⇒ Array<(CycleDTO, Integer, Hash)>

Get a Cycle Get a Cycle

Parameters:

  • cycle_id (String) —

    Cycle ID.

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

    the optional parameters

Returns:

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

    CycleDTO data, response status code and response headers



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
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/cropwise-platform-sdk/api/cycle_api.rb', line 304

def get_cycle_with_http_info(cycle_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CycleApi.get_cycle ...'
  end
  # verify the required parameter 'cycle_id' is set
  if @api_client.config.client_side_validation && cycle_id.nil?
    fail ArgumentError, "Missing the required parameter 'cycle_id' when calling CycleApi.get_cycle"
  end
  # resource path
  local_var_path = '/v2/cycles/{cycleId}'.sub('{' + 'cycleId' + '}', CGI.escape(cycle_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] || 'CycleDTO'

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

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

#get_org_cycles(org_id, opts = {}) ⇒ PagedCycleDTO

List Organization’s Cycles Gets all cycles of an ‘Organization`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Requested page number. Starting from zero. Default is zero.

  • :size (Integer) —

    Requested page size. Default is unpaged

Returns:



488
489
490
491
 
# File 'lib/cropwise-platform-sdk/api/cycle_api.rb', line 488

def get_org_cycles(org_id, opts = {})
  data, _status_code, _headers = get_org_cycles_with_http_info(org_id, opts)
  data
end

#get_org_cycles_with_http_info(org_id, opts = {}) ⇒ Array<(PagedCycleDTO, Integer, Hash)>

List Organization&#39;s Cycles Gets all cycles of an &#x60;Organization&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Requested page number. Starting from zero. Default is zero.

  • :size (Integer) —

    Requested page size. Default is unpaged

Returns:

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

    PagedCycleDTO data, response status code and response headers



500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/cropwise-platform-sdk/api/cycle_api.rb', line 500

def get_org_cycles_with_http_info(org_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CycleApi.get_org_cycles ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling CycleApi.get_org_cycles"
  end
  # resource path
  local_var_path = '/v2/orgs/{orgId}/cycles'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s))

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

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

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

#get_property_cycles(property_id, opts = {}) ⇒ PagedCycleDTO

List Property’s Cycles Gets all cycles of an ‘Property`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Requested page number. Starting from zero. Default is zero.

  • :size (Integer) —

    Requested page size. Default is unpaged

Returns:



557
558
559
560
 
# File 'lib/cropwise-platform-sdk/api/cycle_api.rb', line 557

def get_property_cycles(property_id, opts = {})
  data, _status_code, _headers = get_property_cycles_with_http_info(property_id, opts)
  data
end

#get_property_cycles_with_http_info(property_id, opts = {}) ⇒ Array<(PagedCycleDTO, Integer, Hash)>

List Property&#39;s Cycles Gets all cycles of an &#x60;Property&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Requested page number. Starting from zero. Default is zero.

  • :size (Integer) —

    Requested page size. Default is unpaged

Returns:

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

    PagedCycleDTO data, response status code and response headers



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
 
# File 'lib/cropwise-platform-sdk/api/cycle_api.rb', line 569

def get_property_cycles_with_http_info(property_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CycleApi.get_property_cycles ...'
  end
  # verify the required parameter 'property_id' is set
  if @api_client.config.client_side_validation && property_id.nil?
    fail ArgumentError, "Missing the required parameter 'property_id' when calling CycleApi.get_property_cycles"
  end
  # resource path
  local_var_path = '/v2/properties/{propertyId}/cycles'.sub('{' + 'propertyId' + '}', CGI.escape(property_id.to_s))

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

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

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