Class: ConnectWise::MenuEntriesApi
- Inherits:
-
Object
- Object
- ConnectWise::MenuEntriesApi
- Defined in:
- lib/connectwise-ruby-sdk/api/menu_entries_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#initialize(api_client = ApiClient.default) ⇒ MenuEntriesApi
constructor
A new instance of MenuEntriesApi.
-
#system_menuentries_count_get(opts = {}) ⇒ Count
Get Menu Entries Count.
-
#system_menuentries_count_get_with_http_info(opts = {}) ⇒ Array<(Count, Fixnum, Hash)>
Get Menu Entries Count.
-
#system_menuentries_get(opts = {}) ⇒ Array<MenuEntry>
Get Menu Entries.
-
#system_menuentries_get_with_http_info(opts = {}) ⇒ Array<(Array<MenuEntry>, Fixnum, Hash)>
Get Menu Entries.
-
#system_menuentries_id_delete(id, opts = {}) ⇒ nil
Delete Menu Entry By Id.
-
#system_menuentries_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete Menu Entry By Id.
-
#system_menuentries_id_get(id, opts = {}) ⇒ MenuEntry
Get Menu Entry By Id.
-
#system_menuentries_id_get_with_http_info(id, opts = {}) ⇒ Array<(MenuEntry, Fixnum, Hash)>
Get Menu Entry By Id.
-
#system_menuentries_id_image_get(id, opts = {}) ⇒ nil
Get Menu Entry Image.
-
#system_menuentries_id_image_get_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Get Menu Entry Image.
-
#system_menuentries_id_image_post(id, opts = {}) ⇒ nil
Upload Menu Entry Image.
-
#system_menuentries_id_image_post_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Upload Menu Entry Image.
-
#system_menuentries_id_patch(id, operations, opts = {}) ⇒ MenuEntry
Update Menu Entry.
-
#system_menuentries_id_patch_with_http_info(id, operations, opts = {}) ⇒ Array<(MenuEntry, Fixnum, Hash)>
Update Menu Entry.
-
#system_menuentries_id_put(id, menu_entry, opts = {}) ⇒ MenuEntry
Replace Menu Entry.
-
#system_menuentries_id_put_with_http_info(id, menu_entry, opts = {}) ⇒ Array<(MenuEntry, Fixnum, Hash)>
Replace Menu Entry.
-
#system_menuentries_post(menu_entry, opts = {}) ⇒ MenuEntry
Create Menu Entry.
-
#system_menuentries_post_with_http_info(menu_entry, opts = {}) ⇒ Array<(MenuEntry, Fixnum, Hash)>
Create Menu Entry.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ MenuEntriesApi
Returns a new instance of MenuEntriesApi.
8 9 10 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 8 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
6 7 8 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 6 def api_client @api_client end |
Instance Method Details
#system_menuentries_count_get(opts = {}) ⇒ Count
Get Menu Entries Count
17 18 19 20 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 17 def (opts = {}) data, _status_code, _headers = (opts) return data end |
#system_menuentries_count_get_with_http_info(opts = {}) ⇒ Array<(Count, Fixnum, Hash)>
Get Menu Entries Count
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 27 def (opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: MenuEntriesApi.system_menuentries_count_get ..." end # resource path local_var_path = "/system/menuentries/count" # query parameters query_params = {} query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['BasicAuth'] 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 => 'Count') if @api_client.config.debugging @api_client.config.logger.debug "API called: MenuEntriesApi#system_menuentries_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#system_menuentries_get(opts = {}) ⇒ Array<MenuEntry>
Get Menu Entries
72 73 74 75 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 72 def (opts = {}) data, _status_code, _headers = (opts) return data end |
#system_menuentries_get_with_http_info(opts = {}) ⇒ Array<(Array<MenuEntry>, Fixnum, Hash)>
Get Menu Entries
87 88 89 90 91 92 93 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 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 87 def (opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: MenuEntriesApi.system_menuentries_get ..." end # resource path local_var_path = "/system/menuentries" # query parameters query_params = {} query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil? query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil? query_params[:'childconditions'] = opts[:'childconditions'] if !opts[:'childconditions'].nil? query_params[:'customfieldconditions'] = opts[:'customfieldconditions'] if !opts[:'customfieldconditions'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['BasicAuth'] 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 => 'Array<MenuEntry>') if @api_client.config.debugging @api_client.config.logger.debug "API called: MenuEntriesApi#system_menuentries_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#system_menuentries_id_delete(id, opts = {}) ⇒ nil
Delete Menu Entry By Id
132 133 134 135 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 132 def (id, opts = {}) (id, opts) return nil end |
#system_menuentries_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Delete Menu Entry By Id
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 142 def (id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: MenuEntriesApi.system_menuentries_id_delete ..." 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 MenuEntriesApi.system_menuentries_id_delete" end # resource path local_var_path = "/system/menuentries/{id}".sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['BasicAuth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: MenuEntriesApi#system_menuentries_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#system_menuentries_id_get(id, opts = {}) ⇒ MenuEntry
Get Menu Entry By Id
182 183 184 185 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 182 def (id, opts = {}) data, _status_code, _headers = (id, opts) return data end |
#system_menuentries_id_get_with_http_info(id, opts = {}) ⇒ Array<(MenuEntry, Fixnum, Hash)>
Get Menu Entry By Id
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 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 192 def (id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: MenuEntriesApi.system_menuentries_id_get ..." 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 MenuEntriesApi.system_menuentries_id_get" end # resource path local_var_path = "/system/menuentries/{id}".sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['BasicAuth'] 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 => 'MenuEntry') if @api_client.config.debugging @api_client.config.logger.debug "API called: MenuEntriesApi#system_menuentries_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#system_menuentries_id_image_get(id, opts = {}) ⇒ nil
Get Menu Entry Image
237 238 239 240 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 237 def (id, opts = {}) (id, opts) return nil end |
#system_menuentries_id_image_get_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Get Menu Entry Image
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 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 249 def (id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: MenuEntriesApi.system_menuentries_id_image_get ..." 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 MenuEntriesApi.system_menuentries_id_image_get" end # resource path local_var_path = "/system/menuentries/{id}/image".sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} query_params[:'lastmodified'] = opts[:'lastmodified'] if !opts[:'lastmodified'].nil? query_params[:'largeFlag'] = opts[:'large_flag'] if !opts[:'large_flag'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['BasicAuth'] 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) if @api_client.config.debugging @api_client.config.logger.debug "API called: MenuEntriesApi#system_menuentries_id_image_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#system_menuentries_id_image_post(id, opts = {}) ⇒ nil
Upload Menu Entry Image
294 295 296 297 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 294 def (id, opts = {}) (id, opts) return nil end |
#system_menuentries_id_image_post_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>
Upload Menu Entry Image
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 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 305 def (id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: MenuEntriesApi.system_menuentries_id_image_post ..." 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 MenuEntriesApi.system_menuentries_id_image_post" end # resource path local_var_path = "/system/menuentries/{id}/image".sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data']) # form parameters form_params = {} form_params["file"] = opts[:'file'] if !opts[:'file'].nil? # http body (model) post_body = nil auth_names = ['BasicAuth'] 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) if @api_client.config.debugging @api_client.config.logger.debug "API called: MenuEntriesApi#system_menuentries_id_image_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#system_menuentries_id_patch(id, operations, opts = {}) ⇒ MenuEntry
Update Menu Entry
349 350 351 352 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 349 def (id, operations, opts = {}) data, _status_code, _headers = (id, operations, opts) return data end |
#system_menuentries_id_patch_with_http_info(id, operations, opts = {}) ⇒ Array<(MenuEntry, Fixnum, Hash)>
Update Menu Entry
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 402 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 360 def (id, operations, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: MenuEntriesApi.system_menuentries_id_patch ..." 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 MenuEntriesApi.system_menuentries_id_patch" end # verify the required parameter 'operations' is set if @api_client.config.client_side_validation && operations.nil? fail ArgumentError, "Missing the required parameter 'operations' when calling MenuEntriesApi.system_menuentries_id_patch" end # resource path local_var_path = "/system/menuentries/{id}".sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # 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/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(operations) auth_names = ['BasicAuth'] data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'MenuEntry') if @api_client.config.debugging @api_client.config.logger.debug "API called: MenuEntriesApi#system_menuentries_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#system_menuentries_id_put(id, menu_entry, opts = {}) ⇒ MenuEntry
Replace Menu Entry
410 411 412 413 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 410 def (id, , opts = {}) data, _status_code, _headers = (id, , opts) return data end |
#system_menuentries_id_put_with_http_info(id, menu_entry, opts = {}) ⇒ Array<(MenuEntry, Fixnum, Hash)>
Replace Menu Entry
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 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 421 def (id, , opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: MenuEntriesApi.system_menuentries_id_put ..." 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 MenuEntriesApi.system_menuentries_id_put" end # verify the required parameter 'menu_entry' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'menu_entry' when calling MenuEntriesApi.system_menuentries_id_put" end # resource path local_var_path = "/system/menuentries/{id}".sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} # 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/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body() auth_names = ['BasicAuth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'MenuEntry') if @api_client.config.debugging @api_client.config.logger.debug "API called: MenuEntriesApi#system_menuentries_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#system_menuentries_post(menu_entry, opts = {}) ⇒ MenuEntry
Create Menu Entry
470 471 472 473 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 470 def (, opts = {}) data, _status_code, _headers = (, opts) return data end |
#system_menuentries_post_with_http_info(menu_entry, opts = {}) ⇒ Array<(MenuEntry, Fixnum, Hash)>
Create Menu Entry
480 481 482 483 484 485 486 487 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 |
# File 'lib/connectwise-ruby-sdk/api/menu_entries_api.rb', line 480 def (, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: MenuEntriesApi.system_menuentries_post ..." end # verify the required parameter 'menu_entry' is set if @api_client.config.client_side_validation && .nil? fail ArgumentError, "Missing the required parameter 'menu_entry' when calling MenuEntriesApi.system_menuentries_post" end # resource path local_var_path = "/system/menuentries" # query parameters query_params = {} # 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/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body() auth_names = ['BasicAuth'] 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 => 'MenuEntry') if @api_client.config.debugging @api_client.config.logger.debug "API called: MenuEntriesApi#system_menuentries_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |