Class: CropwisePlatformSdk::WorkerApi
- Inherits:
-
Object
- Object
- CropwisePlatformSdk::WorkerApi
- Defined in:
- lib/cropwise-platform-sdk/api/worker_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#delete_worker_by_id(id, org_id, opts = {}) ⇒ nil
Delete the specified Worker.
-
#delete_worker_by_id_with_http_info(id, org_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete the specified Worker.
-
#get_worker(id, org_id, opts = {}) ⇒ WorkerResponse
Get worker Get Worker.
-
#get_worker_with_http_info(id, org_id, opts = {}) ⇒ Array<(WorkerResponse, Integer, Hash)>
Get worker Get Worker.
-
#get_workers(org_id, opts = {}) ⇒ PagedWorker
List Organization Workers List Organization Workers.
-
#get_workers_by_org_id_and_properties_ids(org_id, opts = {}) ⇒ PagedWorker
List Organization Workers by Property Id and Name List Worker in a Organization by properties ids.
-
#get_workers_by_org_id_and_properties_ids_with_http_info(org_id, opts = {}) ⇒ Array<(PagedWorker, Integer, Hash)>
List Organization Workers by Property Id and Name List Worker in a Organization by properties ids.
-
#get_workers_extended_search(org_id, include_extended, opts = {}) ⇒ PagedWorker
List Organization Workers with filtered extra_attribute List Organization Workers.
-
#get_workers_extended_search_with_http_info(org_id, include_extended, opts = {}) ⇒ Array<(PagedWorker, Integer, Hash)>
List Organization Workers with filtered extra_attribute List Organization Workers.
-
#get_workers_with_http_info(org_id, opts = {}) ⇒ Array<(PagedWorker, Integer, Hash)>
List Organization Workers List Organization Workers.
-
#initialize(api_client = ApiClient.default) ⇒ WorkerApi
constructor
A new instance of WorkerApi.
-
#post_worker(org_id, opts = {}) ⇒ WorkerResponse
Create worker Create Worker.
-
#post_worker_with_http_info(org_id, opts = {}) ⇒ Array<(WorkerResponse, Integer, Hash)>
Create worker Create Worker.
-
#update_worker(id, org_id, opts = {}) ⇒ WorkerResponse
Update worker Update Worker.
-
#update_worker_with_http_info(id, org_id, opts = {}) ⇒ Array<(WorkerResponse, Integer, Hash)>
Update worker Update Worker.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/cropwise-platform-sdk/api/worker_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#delete_worker_by_id(id, org_id, opts = {}) ⇒ nil
Delete the specified Worker.
28 29 30 31 |
# File 'lib/cropwise-platform-sdk/api/worker_api.rb', line 28 def delete_worker_by_id(id, org_id, opts = {}) delete_worker_by_id_with_http_info(id, org_id, opts) nil end |
#delete_worker_by_id_with_http_info(id, org_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete the specified Worker.
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 |
# File 'lib/cropwise-platform-sdk/api/worker_api.rb', line 39 def delete_worker_by_id_with_http_info(id, org_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WorkerApi.delete_worker_by_id ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling WorkerApi.delete_worker_by_id" 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 WorkerApi.delete_worker_by_id" end # resource path local_var_path = '/v2/orgs/{orgId}/workers/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # 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] || [] = opts.merge( :operation => :"WorkerApi.delete_worker_by_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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WorkerApi#delete_worker_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_worker(id, org_id, opts = {}) ⇒ WorkerResponse
Get worker Get Worker
95 96 97 98 |
# File 'lib/cropwise-platform-sdk/api/worker_api.rb', line 95 def get_worker(id, org_id, opts = {}) data, _status_code, _headers = get_worker_with_http_info(id, org_id, opts) data end |
#get_worker_with_http_info(id, org_id, opts = {}) ⇒ Array<(WorkerResponse, Integer, Hash)>
Get worker Get Worker
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 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 |
# File 'lib/cropwise-platform-sdk/api/worker_api.rb', line 106 def get_worker_with_http_info(id, org_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WorkerApi.get_worker ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling WorkerApi.get_worker" 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 WorkerApi.get_worker" end # resource path local_var_path = '/v2/orgs/{orgId}/workers/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'orgId' + '}', CGI.escape(org_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] || 'WorkerResponse' # auth_names auth_names = opts[:debug_auth_names] || [] = opts.merge( :operation => :"WorkerApi.get_worker", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WorkerApi#get_worker\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_workers(org_id, opts = {}) ⇒ PagedWorker
List Organization Workers List Organization Workers
167 168 169 170 |
# File 'lib/cropwise-platform-sdk/api/worker_api.rb', line 167 def get_workers(org_id, opts = {}) data, _status_code, _headers = get_workers_with_http_info(org_id, opts) data end |
#get_workers_by_org_id_and_properties_ids(org_id, opts = {}) ⇒ PagedWorker
List Organization Workers by Property Id and Name List Worker in a Organization by properties ids. If an empty list is sent, it return all workers from that organization
240 241 242 243 |
# File 'lib/cropwise-platform-sdk/api/worker_api.rb', line 240 def get_workers_by_org_id_and_properties_ids(org_id, opts = {}) data, _status_code, _headers = get_workers_by_org_id_and_properties_ids_with_http_info(org_id, opts) data end |
#get_workers_by_org_id_and_properties_ids_with_http_info(org_id, opts = {}) ⇒ Array<(PagedWorker, Integer, Hash)>
List Organization Workers by Property Id and Name List Worker in a Organization by properties ids. If an empty list is sent, it return all workers from that organization
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 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 |
# File 'lib/cropwise-platform-sdk/api/worker_api.rb', line 252 def get_workers_by_org_id_and_properties_ids_with_http_info(org_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WorkerApi.get_workers_by_org_id_and_properties_ids ...' 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 WorkerApi.get_workers_by_org_id_and_properties_ids" end # resource path local_var_path = '/v2/orgs/{org_id}/properties/ids/workers'.sub('{' + 'org_id' + '}', CGI.escape(org_id.to_s)) # query parameters query_params = opts[:query_params] || {} 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']) # 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[:'uuid_list_model']) # return_type return_type = opts[:debug_return_type] || 'PagedWorker' # auth_names auth_names = opts[:debug_auth_names] || [] = opts.merge( :operation => :"WorkerApi.get_workers_by_org_id_and_properties_ids", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WorkerApi#get_workers_by_org_id_and_properties_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_workers_extended_search(org_id, include_extended, opts = {}) ⇒ PagedWorker
List Organization Workers with filtered extra_attribute List Organization Workers
318 319 320 321 |
# File 'lib/cropwise-platform-sdk/api/worker_api.rb', line 318 def get_workers_extended_search(org_id, include_extended, opts = {}) data, _status_code, _headers = get_workers_extended_search_with_http_info(org_id, include_extended, opts) data end |
#get_workers_extended_search_with_http_info(org_id, include_extended, opts = {}) ⇒ Array<(PagedWorker, Integer, Hash)>
List Organization Workers with filtered extra_attribute List Organization Workers
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 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 |
# File 'lib/cropwise-platform-sdk/api/worker_api.rb', line 335 def get_workers_extended_search_with_http_info(org_id, include_extended, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WorkerApi.get_workers_extended_search ...' 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 WorkerApi.get_workers_extended_search" end # verify the required parameter 'include_extended' is set if @api_client.config.client_side_validation && include_extended.nil? fail ArgumentError, "Missing the required parameter 'include_extended' when calling WorkerApi.get_workers_extended_search" end # resource path local_var_path = '/v2/orgs/{org_id}/workers/extended-search'.sub('{' + 'org_id' + '}', CGI.escape(org_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'include_extended'] = include_extended query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil? query_params[:'extra_attribute'] = opts[:'extra_attribute'] if !opts[:'extra_attribute'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil? header_params[:'client-id'] = opts[:'client_id'] if !opts[:'client_id'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'PagedWorker' # auth_names auth_names = opts[:debug_auth_names] || [] = opts.merge( :operation => :"WorkerApi.get_workers_extended_search", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WorkerApi#get_workers_extended_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_workers_with_http_info(org_id, opts = {}) ⇒ Array<(PagedWorker, Integer, Hash)>
List Organization Workers List Organization Workers
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 218 219 220 221 222 223 224 225 226 227 228 229 230 231 |
# File 'lib/cropwise-platform-sdk/api/worker_api.rb', line 181 def get_workers_with_http_info(org_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WorkerApi.get_workers ...' 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 WorkerApi.get_workers" end # resource path local_var_path = '/v2/orgs/{org_id}/workers'.sub('{' + 'org_id' + '}', 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? 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']) header_params[:'Accept-Language'] = opts[:'accept_language'] if !opts[:'accept_language'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'PagedWorker' # auth_names auth_names = opts[:debug_auth_names] || [] = opts.merge( :operation => :"WorkerApi.get_workers", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WorkerApi#get_workers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#post_worker(org_id, opts = {}) ⇒ WorkerResponse
Create worker Create Worker
401 402 403 404 |
# File 'lib/cropwise-platform-sdk/api/worker_api.rb', line 401 def post_worker(org_id, opts = {}) data, _status_code, _headers = post_worker_with_http_info(org_id, opts) data end |
#post_worker_with_http_info(org_id, opts = {}) ⇒ Array<(WorkerResponse, Integer, Hash)>
Create worker Create Worker
413 414 415 416 417 418 419 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 |
# File 'lib/cropwise-platform-sdk/api/worker_api.rb', line 413 def post_worker_with_http_info(org_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WorkerApi.post_worker ...' 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 WorkerApi.post_worker" end # resource path local_var_path = '/v2/orgs/{orgId}/workers'.sub('{' + 'orgId' + '}', CGI.escape(org_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 header_params[:'client-id'] = opts[:'client_id'] if !opts[:'client_id'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'worker']) # return_type return_type = opts[:debug_return_type] || 'WorkerResponse' # auth_names auth_names = opts[:debug_auth_names] || [] = opts.merge( :operation => :"WorkerApi.post_worker", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WorkerApi#post_worker\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#update_worker(id, org_id, opts = {}) ⇒ WorkerResponse
Update worker Update Worker
475 476 477 478 |
# File 'lib/cropwise-platform-sdk/api/worker_api.rb', line 475 def update_worker(id, org_id, opts = {}) data, _status_code, _headers = update_worker_with_http_info(id, org_id, opts) data end |
#update_worker_with_http_info(id, org_id, opts = {}) ⇒ Array<(WorkerResponse, Integer, Hash)>
Update worker Update Worker
488 489 490 491 492 493 494 495 496 497 498 499 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 |
# File 'lib/cropwise-platform-sdk/api/worker_api.rb', line 488 def update_worker_with_http_info(id, org_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: WorkerApi.update_worker ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling WorkerApi.update_worker" 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 WorkerApi.update_worker" end # resource path local_var_path = '/v2/orgs/{orgId}/workers/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'orgId' + '}', CGI.escape(org_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 header_params[:'client-id'] = opts[:'client_id'] if !opts[:'client_id'].nil? # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'worker']) # return_type return_type = opts[:debug_return_type] || 'WorkerResponse' # auth_names auth_names = opts[:debug_auth_names] || [] = opts.merge( :operation => :"WorkerApi.update_worker", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: WorkerApi#update_worker\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |