BmltClient 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (113) hide show
  1. checksums.yaml +7 -0
  2. data/BmltClient.gemspec +38 -0
  3. data/Gemfile +9 -0
  4. data/Makefile +22 -0
  5. data/README.md +157 -0
  6. data/Rakefile +10 -0
  7. data/docs/AuthenticationError.md +18 -0
  8. data/docs/AuthorizationError.md +18 -0
  9. data/docs/ErrorTest.md +22 -0
  10. data/docs/Format.md +24 -0
  11. data/docs/FormatAllOf.md +18 -0
  12. data/docs/FormatBase.md +22 -0
  13. data/docs/FormatCreate.md +22 -0
  14. data/docs/FormatPartialUpdate.md +22 -0
  15. data/docs/FormatTranslation.md +24 -0
  16. data/docs/FormatUpdate.md +22 -0
  17. data/docs/Meeting.md +90 -0
  18. data/docs/MeetingBase.md +88 -0
  19. data/docs/MeetingCreate.md +88 -0
  20. data/docs/MeetingPartialUpdate.md +88 -0
  21. data/docs/MeetingUpdate.md +88 -0
  22. data/docs/NotFoundError.md +18 -0
  23. data/docs/RootServerApi.md +1958 -0
  24. data/docs/ServerError.md +18 -0
  25. data/docs/ServiceBody.md +38 -0
  26. data/docs/ServiceBodyBase.md +36 -0
  27. data/docs/ServiceBodyCreate.md +36 -0
  28. data/docs/ServiceBodyPartialUpdate.md +36 -0
  29. data/docs/ServiceBodyUpdate.md +36 -0
  30. data/docs/Token.md +24 -0
  31. data/docs/TokenCredentials.md +20 -0
  32. data/docs/User.md +30 -0
  33. data/docs/UserBase.md +28 -0
  34. data/docs/UserCreate.md +30 -0
  35. data/docs/UserCreateAllOf.md +18 -0
  36. data/docs/UserPartialUpdate.md +30 -0
  37. data/docs/UserUpdate.md +30 -0
  38. data/docs/ValidationError.md +20 -0
  39. data/git_push.sh +57 -0
  40. data/lib/BmltClient/api/root_server_api.rb +1880 -0
  41. data/lib/BmltClient/api_client.rb +392 -0
  42. data/lib/BmltClient/api_error.rb +57 -0
  43. data/lib/BmltClient/configuration.rb +279 -0
  44. data/lib/BmltClient/models/authentication_error.rb +224 -0
  45. data/lib/BmltClient/models/authorization_error.rb +224 -0
  46. data/lib/BmltClient/models/error_test.rb +237 -0
  47. data/lib/BmltClient/models/format.rb +276 -0
  48. data/lib/BmltClient/models/format_all_of.rb +219 -0
  49. data/lib/BmltClient/models/format_base.rb +239 -0
  50. data/lib/BmltClient/models/format_create.rb +251 -0
  51. data/lib/BmltClient/models/format_partial_update.rb +246 -0
  52. data/lib/BmltClient/models/format_translation.rb +266 -0
  53. data/lib/BmltClient/models/format_update.rb +251 -0
  54. data/lib/BmltClient/models/meeting.rb +628 -0
  55. data/lib/BmltClient/models/meeting_base.rb +536 -0
  56. data/lib/BmltClient/models/meeting_create.rb +593 -0
  57. data/lib/BmltClient/models/meeting_partial_update.rb +593 -0
  58. data/lib/BmltClient/models/meeting_update.rb +593 -0
  59. data/lib/BmltClient/models/not_found_error.rb +224 -0
  60. data/lib/BmltClient/models/server_error.rb +224 -0
  61. data/lib/BmltClient/models/service_body.rb +374 -0
  62. data/lib/BmltClient/models/service_body_base.rb +302 -0
  63. data/lib/BmltClient/models/service_body_create.rb +339 -0
  64. data/lib/BmltClient/models/service_body_partial_update.rb +309 -0
  65. data/lib/BmltClient/models/service_body_update.rb +339 -0
  66. data/lib/BmltClient/models/token.rb +266 -0
  67. data/lib/BmltClient/models/token_credentials.rb +238 -0
  68. data/lib/BmltClient/models/user.rb +316 -0
  69. data/lib/BmltClient/models/user_base.rb +264 -0
  70. data/lib/BmltClient/models/user_create.rb +301 -0
  71. data/lib/BmltClient/models/user_create_all_of.rb +219 -0
  72. data/lib/BmltClient/models/user_partial_update.rb +281 -0
  73. data/lib/BmltClient/models/user_update.rb +296 -0
  74. data/lib/BmltClient/models/validation_error.rb +240 -0
  75. data/lib/BmltClient/version.rb +15 -0
  76. data/lib/BmltClient.rb +71 -0
  77. data/openapi.json +1 -0
  78. data/spec/api/root_server_api_spec.rb +377 -0
  79. data/spec/api_client_spec.rb +226 -0
  80. data/spec/configuration_spec.rb +42 -0
  81. data/spec/models/authentication_error_spec.rb +34 -0
  82. data/spec/models/authorization_error_spec.rb +34 -0
  83. data/spec/models/error_test_spec.rb +46 -0
  84. data/spec/models/format_all_of_spec.rb +34 -0
  85. data/spec/models/format_base_spec.rb +46 -0
  86. data/spec/models/format_create_spec.rb +46 -0
  87. data/spec/models/format_partial_update_spec.rb +46 -0
  88. data/spec/models/format_spec.rb +52 -0
  89. data/spec/models/format_translation_spec.rb +52 -0
  90. data/spec/models/format_update_spec.rb +46 -0
  91. data/spec/models/meeting_base_spec.rb +244 -0
  92. data/spec/models/meeting_create_spec.rb +244 -0
  93. data/spec/models/meeting_partial_update_spec.rb +244 -0
  94. data/spec/models/meeting_spec.rb +250 -0
  95. data/spec/models/meeting_update_spec.rb +244 -0
  96. data/spec/models/not_found_error_spec.rb +34 -0
  97. data/spec/models/server_error_spec.rb +34 -0
  98. data/spec/models/service_body_base_spec.rb +88 -0
  99. data/spec/models/service_body_create_spec.rb +88 -0
  100. data/spec/models/service_body_partial_update_spec.rb +88 -0
  101. data/spec/models/service_body_spec.rb +94 -0
  102. data/spec/models/service_body_update_spec.rb +88 -0
  103. data/spec/models/token_credentials_spec.rb +40 -0
  104. data/spec/models/token_spec.rb +52 -0
  105. data/spec/models/user_base_spec.rb +64 -0
  106. data/spec/models/user_create_all_of_spec.rb +34 -0
  107. data/spec/models/user_create_spec.rb +70 -0
  108. data/spec/models/user_partial_update_spec.rb +70 -0
  109. data/spec/models/user_spec.rb +70 -0
  110. data/spec/models/user_update_spec.rb +70 -0
  111. data/spec/models/validation_error_spec.rb +40 -0
  112. data/spec/spec_helper.rb +111 -0
  113. metadata +229 -0
@@ -0,0 +1,1958 @@
1
+ # BmltClient::RootServerApi
2
+
3
+ All URIs are relative to *http://localhost:8000/main_server*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**auth_logout**](RootServerApi.md#auth_logout) | **POST** /api/v1/auth/logout | Revokes a token |
8
+ | [**auth_refresh**](RootServerApi.md#auth_refresh) | **POST** /api/v1/auth/refresh | Revokes and issues a new token |
9
+ | [**auth_token**](RootServerApi.md#auth_token) | **POST** /api/v1/auth/token | Creates a token |
10
+ | [**create_error_test**](RootServerApi.md#create_error_test) | **POST** /api/v1/errortest | Tests some errors |
11
+ | [**create_format**](RootServerApi.md#create_format) | **POST** /api/v1/formats | Creates a format |
12
+ | [**create_meeting**](RootServerApi.md#create_meeting) | **POST** /api/v1/meetings | Creates a meeting |
13
+ | [**create_service_body**](RootServerApi.md#create_service_body) | **POST** /api/v1/servicebodies | Creates a service body |
14
+ | [**create_user**](RootServerApi.md#create_user) | **POST** /api/v1/users | Creates a user |
15
+ | [**delete_format**](RootServerApi.md#delete_format) | **DELETE** /api/v1/formats/{formatId} | Deletes a format |
16
+ | [**delete_meeting**](RootServerApi.md#delete_meeting) | **DELETE** /api/v1/meetings/{meetingId} | Deletes a meeting |
17
+ | [**delete_service_body**](RootServerApi.md#delete_service_body) | **DELETE** /api/v1/servicebodies/{serviceBodyId} | Deletes a service body |
18
+ | [**delete_user**](RootServerApi.md#delete_user) | **DELETE** /api/v1/users/{userId} | Deletes a user |
19
+ | [**get_format**](RootServerApi.md#get_format) | **GET** /api/v1/formats/{formatId} | Retrieves a format |
20
+ | [**get_formats**](RootServerApi.md#get_formats) | **GET** /api/v1/formats | Retrieves formats |
21
+ | [**get_meeting**](RootServerApi.md#get_meeting) | **GET** /api/v1/meetings/{meetingId} | Retrieves a meeting |
22
+ | [**get_meetings**](RootServerApi.md#get_meetings) | **GET** /api/v1/meetings | Retrieves meetings |
23
+ | [**get_service_bodies**](RootServerApi.md#get_service_bodies) | **GET** /api/v1/servicebodies | Retrieves service bodies |
24
+ | [**get_service_body**](RootServerApi.md#get_service_body) | **GET** /api/v1/servicebodies/{serviceBodyId} | Retrieves a service body |
25
+ | [**get_user**](RootServerApi.md#get_user) | **GET** /api/v1/users/{userId} | Retrieves a single user |
26
+ | [**get_users**](RootServerApi.md#get_users) | **GET** /api/v1/users | Retrieves users |
27
+ | [**partial_update_user**](RootServerApi.md#partial_update_user) | **PATCH** /api/v1/users/{userId} | Patches a user |
28
+ | [**patch_format**](RootServerApi.md#patch_format) | **PATCH** /api/v1/formats/{formatId} | Patches a format |
29
+ | [**patch_meeting**](RootServerApi.md#patch_meeting) | **PATCH** /api/v1/meetings/{meetingId} | Patches a meeting |
30
+ | [**patch_service_body**](RootServerApi.md#patch_service_body) | **PATCH** /api/v1/servicebodies/{serviceBodyId} | Patches a service body |
31
+ | [**update_format**](RootServerApi.md#update_format) | **PUT** /api/v1/formats/{formatId} | Updates a format |
32
+ | [**update_meeting**](RootServerApi.md#update_meeting) | **PUT** /api/v1/meetings/{meetingId} | Updates a meeting |
33
+ | [**update_service_body**](RootServerApi.md#update_service_body) | **PUT** /api/v1/servicebodies/{serviceBodyId} | Updates a Service Body |
34
+ | [**update_user**](RootServerApi.md#update_user) | **PUT** /api/v1/users/{userId} | Update single user |
35
+
36
+
37
+ ## auth_logout
38
+
39
+ > auth_logout
40
+
41
+ Revokes a token
42
+
43
+ Revoke token and logout.
44
+
45
+ ### Examples
46
+
47
+ ```ruby
48
+ require 'time'
49
+ require 'BmltClient'
50
+ # setup authorization
51
+ BmltClient.configure do |config|
52
+ # Configure OAuth2 access token for authorization: bmltToken
53
+ config.access_token = 'YOUR ACCESS TOKEN'
54
+ end
55
+
56
+ api_instance = BmltClient::RootServerApi.new
57
+
58
+ begin
59
+ # Revokes a token
60
+ api_instance.auth_logout
61
+ rescue BmltClient::ApiError => e
62
+ puts "Error when calling RootServerApi->auth_logout: #{e}"
63
+ end
64
+ ```
65
+
66
+ #### Using the auth_logout_with_http_info variant
67
+
68
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
69
+
70
+ > <Array(nil, Integer, Hash)> auth_logout_with_http_info
71
+
72
+ ```ruby
73
+ begin
74
+ # Revokes a token
75
+ data, status_code, headers = api_instance.auth_logout_with_http_info
76
+ p status_code # => 2xx
77
+ p headers # => { ... }
78
+ p data # => nil
79
+ rescue BmltClient::ApiError => e
80
+ puts "Error when calling RootServerApi->auth_logout_with_http_info: #{e}"
81
+ end
82
+ ```
83
+
84
+ ### Parameters
85
+
86
+ This endpoint does not need any parameter.
87
+
88
+ ### Return type
89
+
90
+ nil (empty response body)
91
+
92
+ ### Authorization
93
+
94
+ [bmltToken](../README.md#bmltToken)
95
+
96
+ ### HTTP request headers
97
+
98
+ - **Content-Type**: Not defined
99
+ - **Accept**: application/json
100
+
101
+
102
+ ## auth_refresh
103
+
104
+ > <Token> auth_refresh
105
+
106
+ Revokes and issues a new token
107
+
108
+ Refresh token.
109
+
110
+ ### Examples
111
+
112
+ ```ruby
113
+ require 'time'
114
+ require 'BmltClient'
115
+ # setup authorization
116
+ BmltClient.configure do |config|
117
+ # Configure OAuth2 access token for authorization: bmltToken
118
+ config.access_token = 'YOUR ACCESS TOKEN'
119
+ end
120
+
121
+ api_instance = BmltClient::RootServerApi.new
122
+
123
+ begin
124
+ # Revokes and issues a new token
125
+ result = api_instance.auth_refresh
126
+ p result
127
+ rescue BmltClient::ApiError => e
128
+ puts "Error when calling RootServerApi->auth_refresh: #{e}"
129
+ end
130
+ ```
131
+
132
+ #### Using the auth_refresh_with_http_info variant
133
+
134
+ This returns an Array which contains the response data, status code and headers.
135
+
136
+ > <Array(<Token>, Integer, Hash)> auth_refresh_with_http_info
137
+
138
+ ```ruby
139
+ begin
140
+ # Revokes and issues a new token
141
+ data, status_code, headers = api_instance.auth_refresh_with_http_info
142
+ p status_code # => 2xx
143
+ p headers # => { ... }
144
+ p data # => <Token>
145
+ rescue BmltClient::ApiError => e
146
+ puts "Error when calling RootServerApi->auth_refresh_with_http_info: #{e}"
147
+ end
148
+ ```
149
+
150
+ ### Parameters
151
+
152
+ This endpoint does not need any parameter.
153
+
154
+ ### Return type
155
+
156
+ [**Token**](Token.md)
157
+
158
+ ### Authorization
159
+
160
+ [bmltToken](../README.md#bmltToken)
161
+
162
+ ### HTTP request headers
163
+
164
+ - **Content-Type**: Not defined
165
+ - **Accept**: application/json
166
+
167
+
168
+ ## auth_token
169
+
170
+ > <Token> auth_token(token_credentials)
171
+
172
+ Creates a token
173
+
174
+ Exchange credentials for a new token
175
+
176
+ ### Examples
177
+
178
+ ```ruby
179
+ require 'time'
180
+ require 'BmltClient'
181
+
182
+ api_instance = BmltClient::RootServerApi.new
183
+ token_credentials = BmltClient::TokenCredentials.new({password: 'PassWord12345', username: 'MyUsername'}) # TokenCredentials | User credentials
184
+
185
+ begin
186
+ # Creates a token
187
+ result = api_instance.auth_token(token_credentials)
188
+ p result
189
+ rescue BmltClient::ApiError => e
190
+ puts "Error when calling RootServerApi->auth_token: #{e}"
191
+ end
192
+ ```
193
+
194
+ #### Using the auth_token_with_http_info variant
195
+
196
+ This returns an Array which contains the response data, status code and headers.
197
+
198
+ > <Array(<Token>, Integer, Hash)> auth_token_with_http_info(token_credentials)
199
+
200
+ ```ruby
201
+ begin
202
+ # Creates a token
203
+ data, status_code, headers = api_instance.auth_token_with_http_info(token_credentials)
204
+ p status_code # => 2xx
205
+ p headers # => { ... }
206
+ p data # => <Token>
207
+ rescue BmltClient::ApiError => e
208
+ puts "Error when calling RootServerApi->auth_token_with_http_info: #{e}"
209
+ end
210
+ ```
211
+
212
+ ### Parameters
213
+
214
+ | Name | Type | Description | Notes |
215
+ | ---- | ---- | ----------- | ----- |
216
+ | **token_credentials** | [**TokenCredentials**](TokenCredentials.md) | User credentials | |
217
+
218
+ ### Return type
219
+
220
+ [**Token**](Token.md)
221
+
222
+ ### Authorization
223
+
224
+ No authorization required
225
+
226
+ ### HTTP request headers
227
+
228
+ - **Content-Type**: application/json
229
+ - **Accept**: application/json
230
+
231
+
232
+ ## create_error_test
233
+
234
+ > <ErrorTest> create_error_test(error_test)
235
+
236
+ Tests some errors
237
+
238
+ Tests some errors.
239
+
240
+ ### Examples
241
+
242
+ ```ruby
243
+ require 'time'
244
+ require 'BmltClient'
245
+ # setup authorization
246
+ BmltClient.configure do |config|
247
+ # Configure OAuth2 access token for authorization: bmltToken
248
+ config.access_token = 'YOUR ACCESS TOKEN'
249
+ end
250
+
251
+ api_instance = BmltClient::RootServerApi.new
252
+ error_test = BmltClient::ErrorTest.new # ErrorTest | Pass in error test object.
253
+
254
+ begin
255
+ # Tests some errors
256
+ result = api_instance.create_error_test(error_test)
257
+ p result
258
+ rescue BmltClient::ApiError => e
259
+ puts "Error when calling RootServerApi->create_error_test: #{e}"
260
+ end
261
+ ```
262
+
263
+ #### Using the create_error_test_with_http_info variant
264
+
265
+ This returns an Array which contains the response data, status code and headers.
266
+
267
+ > <Array(<ErrorTest>, Integer, Hash)> create_error_test_with_http_info(error_test)
268
+
269
+ ```ruby
270
+ begin
271
+ # Tests some errors
272
+ data, status_code, headers = api_instance.create_error_test_with_http_info(error_test)
273
+ p status_code # => 2xx
274
+ p headers # => { ... }
275
+ p data # => <ErrorTest>
276
+ rescue BmltClient::ApiError => e
277
+ puts "Error when calling RootServerApi->create_error_test_with_http_info: #{e}"
278
+ end
279
+ ```
280
+
281
+ ### Parameters
282
+
283
+ | Name | Type | Description | Notes |
284
+ | ---- | ---- | ----------- | ----- |
285
+ | **error_test** | [**ErrorTest**](ErrorTest.md) | Pass in error test object. | |
286
+
287
+ ### Return type
288
+
289
+ [**ErrorTest**](ErrorTest.md)
290
+
291
+ ### Authorization
292
+
293
+ [bmltToken](../README.md#bmltToken)
294
+
295
+ ### HTTP request headers
296
+
297
+ - **Content-Type**: application/json
298
+ - **Accept**: application/json
299
+
300
+
301
+ ## create_format
302
+
303
+ > <Format> create_format(format_create)
304
+
305
+ Creates a format
306
+
307
+ Creates a format.
308
+
309
+ ### Examples
310
+
311
+ ```ruby
312
+ require 'time'
313
+ require 'BmltClient'
314
+ # setup authorization
315
+ BmltClient.configure do |config|
316
+ # Configure OAuth2 access token for authorization: bmltToken
317
+ config.access_token = 'YOUR ACCESS TOKEN'
318
+ end
319
+
320
+ api_instance = BmltClient::RootServerApi.new
321
+ format_create = BmltClient::FormatCreate.new({translations: [BmltClient::FormatTranslation.new({key: 'key_example', name: 'name_example', description: 'description_example', language: 'language_example'})]}) # FormatCreate | Pass in format object
322
+
323
+ begin
324
+ # Creates a format
325
+ result = api_instance.create_format(format_create)
326
+ p result
327
+ rescue BmltClient::ApiError => e
328
+ puts "Error when calling RootServerApi->create_format: #{e}"
329
+ end
330
+ ```
331
+
332
+ #### Using the create_format_with_http_info variant
333
+
334
+ This returns an Array which contains the response data, status code and headers.
335
+
336
+ > <Array(<Format>, Integer, Hash)> create_format_with_http_info(format_create)
337
+
338
+ ```ruby
339
+ begin
340
+ # Creates a format
341
+ data, status_code, headers = api_instance.create_format_with_http_info(format_create)
342
+ p status_code # => 2xx
343
+ p headers # => { ... }
344
+ p data # => <Format>
345
+ rescue BmltClient::ApiError => e
346
+ puts "Error when calling RootServerApi->create_format_with_http_info: #{e}"
347
+ end
348
+ ```
349
+
350
+ ### Parameters
351
+
352
+ | Name | Type | Description | Notes |
353
+ | ---- | ---- | ----------- | ----- |
354
+ | **format_create** | [**FormatCreate**](FormatCreate.md) | Pass in format object | |
355
+
356
+ ### Return type
357
+
358
+ [**Format**](Format.md)
359
+
360
+ ### Authorization
361
+
362
+ [bmltToken](../README.md#bmltToken)
363
+
364
+ ### HTTP request headers
365
+
366
+ - **Content-Type**: application/json
367
+ - **Accept**: application/json
368
+
369
+
370
+ ## create_meeting
371
+
372
+ > <Meeting> create_meeting(meeting_create)
373
+
374
+ Creates a meeting
375
+
376
+ Creates a meeting.
377
+
378
+ ### Examples
379
+
380
+ ```ruby
381
+ require 'time'
382
+ require 'BmltClient'
383
+ # setup authorization
384
+ BmltClient.configure do |config|
385
+ # Configure OAuth2 access token for authorization: bmltToken
386
+ config.access_token = 'YOUR ACCESS TOKEN'
387
+ end
388
+
389
+ api_instance = BmltClient::RootServerApi.new
390
+ meeting_create = BmltClient::MeetingCreate.new({service_body_id: 0, format_ids: [37], venue_type: 1, day: 0, start_time: 'string', duration: '01:00', latitude: 35.698741, longitude: -81.26273, published: true, name: 'string'}) # MeetingCreate | Pass in meeting object
391
+
392
+ begin
393
+ # Creates a meeting
394
+ result = api_instance.create_meeting(meeting_create)
395
+ p result
396
+ rescue BmltClient::ApiError => e
397
+ puts "Error when calling RootServerApi->create_meeting: #{e}"
398
+ end
399
+ ```
400
+
401
+ #### Using the create_meeting_with_http_info variant
402
+
403
+ This returns an Array which contains the response data, status code and headers.
404
+
405
+ > <Array(<Meeting>, Integer, Hash)> create_meeting_with_http_info(meeting_create)
406
+
407
+ ```ruby
408
+ begin
409
+ # Creates a meeting
410
+ data, status_code, headers = api_instance.create_meeting_with_http_info(meeting_create)
411
+ p status_code # => 2xx
412
+ p headers # => { ... }
413
+ p data # => <Meeting>
414
+ rescue BmltClient::ApiError => e
415
+ puts "Error when calling RootServerApi->create_meeting_with_http_info: #{e}"
416
+ end
417
+ ```
418
+
419
+ ### Parameters
420
+
421
+ | Name | Type | Description | Notes |
422
+ | ---- | ---- | ----------- | ----- |
423
+ | **meeting_create** | [**MeetingCreate**](MeetingCreate.md) | Pass in meeting object | |
424
+
425
+ ### Return type
426
+
427
+ [**Meeting**](Meeting.md)
428
+
429
+ ### Authorization
430
+
431
+ [bmltToken](../README.md#bmltToken)
432
+
433
+ ### HTTP request headers
434
+
435
+ - **Content-Type**: application/json
436
+ - **Accept**: application/json
437
+
438
+
439
+ ## create_service_body
440
+
441
+ > <ServiceBody> create_service_body(service_body_create)
442
+
443
+ Creates a service body
444
+
445
+ Creates a service body.
446
+
447
+ ### Examples
448
+
449
+ ```ruby
450
+ require 'time'
451
+ require 'BmltClient'
452
+ # setup authorization
453
+ BmltClient.configure do |config|
454
+ # Configure OAuth2 access token for authorization: bmltToken
455
+ config.access_token = 'YOUR ACCESS TOKEN'
456
+ end
457
+
458
+ api_instance = BmltClient::RootServerApi.new
459
+ service_body_create = BmltClient::ServiceBodyCreate.new({parent_id: 0, name: 'string', description: 'string', type: 'string', admin_user_id: 0, assigned_user_ids: [0]}) # ServiceBodyCreate | Pass in service body object
460
+
461
+ begin
462
+ # Creates a service body
463
+ result = api_instance.create_service_body(service_body_create)
464
+ p result
465
+ rescue BmltClient::ApiError => e
466
+ puts "Error when calling RootServerApi->create_service_body: #{e}"
467
+ end
468
+ ```
469
+
470
+ #### Using the create_service_body_with_http_info variant
471
+
472
+ This returns an Array which contains the response data, status code and headers.
473
+
474
+ > <Array(<ServiceBody>, Integer, Hash)> create_service_body_with_http_info(service_body_create)
475
+
476
+ ```ruby
477
+ begin
478
+ # Creates a service body
479
+ data, status_code, headers = api_instance.create_service_body_with_http_info(service_body_create)
480
+ p status_code # => 2xx
481
+ p headers # => { ... }
482
+ p data # => <ServiceBody>
483
+ rescue BmltClient::ApiError => e
484
+ puts "Error when calling RootServerApi->create_service_body_with_http_info: #{e}"
485
+ end
486
+ ```
487
+
488
+ ### Parameters
489
+
490
+ | Name | Type | Description | Notes |
491
+ | ---- | ---- | ----------- | ----- |
492
+ | **service_body_create** | [**ServiceBodyCreate**](ServiceBodyCreate.md) | Pass in service body object | |
493
+
494
+ ### Return type
495
+
496
+ [**ServiceBody**](ServiceBody.md)
497
+
498
+ ### Authorization
499
+
500
+ [bmltToken](../README.md#bmltToken)
501
+
502
+ ### HTTP request headers
503
+
504
+ - **Content-Type**: application/json
505
+ - **Accept**: application/json
506
+
507
+
508
+ ## create_user
509
+
510
+ > <User> create_user(user_create)
511
+
512
+ Creates a user
513
+
514
+ Creates a user.
515
+
516
+ ### Examples
517
+
518
+ ```ruby
519
+ require 'time'
520
+ require 'BmltClient'
521
+ # setup authorization
522
+ BmltClient.configure do |config|
523
+ # Configure OAuth2 access token for authorization: bmltToken
524
+ config.access_token = 'YOUR ACCESS TOKEN'
525
+ end
526
+
527
+ api_instance = BmltClient::RootServerApi.new
528
+ user_create = BmltClient::UserCreate.new({username: 'string', type: 'string', display_name: 'string', password: 'string'}) # UserCreate | Pass in user object
529
+
530
+ begin
531
+ # Creates a user
532
+ result = api_instance.create_user(user_create)
533
+ p result
534
+ rescue BmltClient::ApiError => e
535
+ puts "Error when calling RootServerApi->create_user: #{e}"
536
+ end
537
+ ```
538
+
539
+ #### Using the create_user_with_http_info variant
540
+
541
+ This returns an Array which contains the response data, status code and headers.
542
+
543
+ > <Array(<User>, Integer, Hash)> create_user_with_http_info(user_create)
544
+
545
+ ```ruby
546
+ begin
547
+ # Creates a user
548
+ data, status_code, headers = api_instance.create_user_with_http_info(user_create)
549
+ p status_code # => 2xx
550
+ p headers # => { ... }
551
+ p data # => <User>
552
+ rescue BmltClient::ApiError => e
553
+ puts "Error when calling RootServerApi->create_user_with_http_info: #{e}"
554
+ end
555
+ ```
556
+
557
+ ### Parameters
558
+
559
+ | Name | Type | Description | Notes |
560
+ | ---- | ---- | ----------- | ----- |
561
+ | **user_create** | [**UserCreate**](UserCreate.md) | Pass in user object | |
562
+
563
+ ### Return type
564
+
565
+ [**User**](User.md)
566
+
567
+ ### Authorization
568
+
569
+ [bmltToken](../README.md#bmltToken)
570
+
571
+ ### HTTP request headers
572
+
573
+ - **Content-Type**: application/json
574
+ - **Accept**: application/json
575
+
576
+
577
+ ## delete_format
578
+
579
+ > delete_format(format_id)
580
+
581
+ Deletes a format
582
+
583
+ Deletes a format by id.
584
+
585
+ ### Examples
586
+
587
+ ```ruby
588
+ require 'time'
589
+ require 'BmltClient'
590
+ # setup authorization
591
+ BmltClient.configure do |config|
592
+ # Configure OAuth2 access token for authorization: bmltToken
593
+ config.access_token = 'YOUR ACCESS TOKEN'
594
+ end
595
+
596
+ api_instance = BmltClient::RootServerApi.new
597
+ format_id = 1 # Integer | ID of format
598
+
599
+ begin
600
+ # Deletes a format
601
+ api_instance.delete_format(format_id)
602
+ rescue BmltClient::ApiError => e
603
+ puts "Error when calling RootServerApi->delete_format: #{e}"
604
+ end
605
+ ```
606
+
607
+ #### Using the delete_format_with_http_info variant
608
+
609
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
610
+
611
+ > <Array(nil, Integer, Hash)> delete_format_with_http_info(format_id)
612
+
613
+ ```ruby
614
+ begin
615
+ # Deletes a format
616
+ data, status_code, headers = api_instance.delete_format_with_http_info(format_id)
617
+ p status_code # => 2xx
618
+ p headers # => { ... }
619
+ p data # => nil
620
+ rescue BmltClient::ApiError => e
621
+ puts "Error when calling RootServerApi->delete_format_with_http_info: #{e}"
622
+ end
623
+ ```
624
+
625
+ ### Parameters
626
+
627
+ | Name | Type | Description | Notes |
628
+ | ---- | ---- | ----------- | ----- |
629
+ | **format_id** | **Integer** | ID of format | |
630
+
631
+ ### Return type
632
+
633
+ nil (empty response body)
634
+
635
+ ### Authorization
636
+
637
+ [bmltToken](../README.md#bmltToken)
638
+
639
+ ### HTTP request headers
640
+
641
+ - **Content-Type**: Not defined
642
+ - **Accept**: application/json
643
+
644
+
645
+ ## delete_meeting
646
+
647
+ > delete_meeting(meeting_id)
648
+
649
+ Deletes a meeting
650
+
651
+ Deletes a meeting by id.
652
+
653
+ ### Examples
654
+
655
+ ```ruby
656
+ require 'time'
657
+ require 'BmltClient'
658
+ # setup authorization
659
+ BmltClient.configure do |config|
660
+ # Configure OAuth2 access token for authorization: bmltToken
661
+ config.access_token = 'YOUR ACCESS TOKEN'
662
+ end
663
+
664
+ api_instance = BmltClient::RootServerApi.new
665
+ meeting_id = 1 # Integer | ID of meeting
666
+
667
+ begin
668
+ # Deletes a meeting
669
+ api_instance.delete_meeting(meeting_id)
670
+ rescue BmltClient::ApiError => e
671
+ puts "Error when calling RootServerApi->delete_meeting: #{e}"
672
+ end
673
+ ```
674
+
675
+ #### Using the delete_meeting_with_http_info variant
676
+
677
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
678
+
679
+ > <Array(nil, Integer, Hash)> delete_meeting_with_http_info(meeting_id)
680
+
681
+ ```ruby
682
+ begin
683
+ # Deletes a meeting
684
+ data, status_code, headers = api_instance.delete_meeting_with_http_info(meeting_id)
685
+ p status_code # => 2xx
686
+ p headers # => { ... }
687
+ p data # => nil
688
+ rescue BmltClient::ApiError => e
689
+ puts "Error when calling RootServerApi->delete_meeting_with_http_info: #{e}"
690
+ end
691
+ ```
692
+
693
+ ### Parameters
694
+
695
+ | Name | Type | Description | Notes |
696
+ | ---- | ---- | ----------- | ----- |
697
+ | **meeting_id** | **Integer** | ID of meeting | |
698
+
699
+ ### Return type
700
+
701
+ nil (empty response body)
702
+
703
+ ### Authorization
704
+
705
+ [bmltToken](../README.md#bmltToken)
706
+
707
+ ### HTTP request headers
708
+
709
+ - **Content-Type**: Not defined
710
+ - **Accept**: application/json
711
+
712
+
713
+ ## delete_service_body
714
+
715
+ > delete_service_body(service_body_id)
716
+
717
+ Deletes a service body
718
+
719
+ Deletes a service body by id.
720
+
721
+ ### Examples
722
+
723
+ ```ruby
724
+ require 'time'
725
+ require 'BmltClient'
726
+ # setup authorization
727
+ BmltClient.configure do |config|
728
+ # Configure OAuth2 access token for authorization: bmltToken
729
+ config.access_token = 'YOUR ACCESS TOKEN'
730
+ end
731
+
732
+ api_instance = BmltClient::RootServerApi.new
733
+ service_body_id = 1 # Integer | ID of service body
734
+
735
+ begin
736
+ # Deletes a service body
737
+ api_instance.delete_service_body(service_body_id)
738
+ rescue BmltClient::ApiError => e
739
+ puts "Error when calling RootServerApi->delete_service_body: #{e}"
740
+ end
741
+ ```
742
+
743
+ #### Using the delete_service_body_with_http_info variant
744
+
745
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
746
+
747
+ > <Array(nil, Integer, Hash)> delete_service_body_with_http_info(service_body_id)
748
+
749
+ ```ruby
750
+ begin
751
+ # Deletes a service body
752
+ data, status_code, headers = api_instance.delete_service_body_with_http_info(service_body_id)
753
+ p status_code # => 2xx
754
+ p headers # => { ... }
755
+ p data # => nil
756
+ rescue BmltClient::ApiError => e
757
+ puts "Error when calling RootServerApi->delete_service_body_with_http_info: #{e}"
758
+ end
759
+ ```
760
+
761
+ ### Parameters
762
+
763
+ | Name | Type | Description | Notes |
764
+ | ---- | ---- | ----------- | ----- |
765
+ | **service_body_id** | **Integer** | ID of service body | |
766
+
767
+ ### Return type
768
+
769
+ nil (empty response body)
770
+
771
+ ### Authorization
772
+
773
+ [bmltToken](../README.md#bmltToken)
774
+
775
+ ### HTTP request headers
776
+
777
+ - **Content-Type**: Not defined
778
+ - **Accept**: application/json
779
+
780
+
781
+ ## delete_user
782
+
783
+ > delete_user(user_id)
784
+
785
+ Deletes a user
786
+
787
+ Deletes a user by id
788
+
789
+ ### Examples
790
+
791
+ ```ruby
792
+ require 'time'
793
+ require 'BmltClient'
794
+ # setup authorization
795
+ BmltClient.configure do |config|
796
+ # Configure OAuth2 access token for authorization: bmltToken
797
+ config.access_token = 'YOUR ACCESS TOKEN'
798
+ end
799
+
800
+ api_instance = BmltClient::RootServerApi.new
801
+ user_id = 1 # Integer | ID of user
802
+
803
+ begin
804
+ # Deletes a user
805
+ api_instance.delete_user(user_id)
806
+ rescue BmltClient::ApiError => e
807
+ puts "Error when calling RootServerApi->delete_user: #{e}"
808
+ end
809
+ ```
810
+
811
+ #### Using the delete_user_with_http_info variant
812
+
813
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
814
+
815
+ > <Array(nil, Integer, Hash)> delete_user_with_http_info(user_id)
816
+
817
+ ```ruby
818
+ begin
819
+ # Deletes a user
820
+ data, status_code, headers = api_instance.delete_user_with_http_info(user_id)
821
+ p status_code # => 2xx
822
+ p headers # => { ... }
823
+ p data # => nil
824
+ rescue BmltClient::ApiError => e
825
+ puts "Error when calling RootServerApi->delete_user_with_http_info: #{e}"
826
+ end
827
+ ```
828
+
829
+ ### Parameters
830
+
831
+ | Name | Type | Description | Notes |
832
+ | ---- | ---- | ----------- | ----- |
833
+ | **user_id** | **Integer** | ID of user | |
834
+
835
+ ### Return type
836
+
837
+ nil (empty response body)
838
+
839
+ ### Authorization
840
+
841
+ [bmltToken](../README.md#bmltToken)
842
+
843
+ ### HTTP request headers
844
+
845
+ - **Content-Type**: Not defined
846
+ - **Accept**: application/json
847
+
848
+
849
+ ## get_format
850
+
851
+ > <Format> get_format(format_id)
852
+
853
+ Retrieves a format
854
+
855
+ Retrieve a format
856
+
857
+ ### Examples
858
+
859
+ ```ruby
860
+ require 'time'
861
+ require 'BmltClient'
862
+ # setup authorization
863
+ BmltClient.configure do |config|
864
+ # Configure OAuth2 access token for authorization: bmltToken
865
+ config.access_token = 'YOUR ACCESS TOKEN'
866
+ end
867
+
868
+ api_instance = BmltClient::RootServerApi.new
869
+ format_id = 1 # Integer | ID of format
870
+
871
+ begin
872
+ # Retrieves a format
873
+ result = api_instance.get_format(format_id)
874
+ p result
875
+ rescue BmltClient::ApiError => e
876
+ puts "Error when calling RootServerApi->get_format: #{e}"
877
+ end
878
+ ```
879
+
880
+ #### Using the get_format_with_http_info variant
881
+
882
+ This returns an Array which contains the response data, status code and headers.
883
+
884
+ > <Array(<Format>, Integer, Hash)> get_format_with_http_info(format_id)
885
+
886
+ ```ruby
887
+ begin
888
+ # Retrieves a format
889
+ data, status_code, headers = api_instance.get_format_with_http_info(format_id)
890
+ p status_code # => 2xx
891
+ p headers # => { ... }
892
+ p data # => <Format>
893
+ rescue BmltClient::ApiError => e
894
+ puts "Error when calling RootServerApi->get_format_with_http_info: #{e}"
895
+ end
896
+ ```
897
+
898
+ ### Parameters
899
+
900
+ | Name | Type | Description | Notes |
901
+ | ---- | ---- | ----------- | ----- |
902
+ | **format_id** | **Integer** | ID of format | |
903
+
904
+ ### Return type
905
+
906
+ [**Format**](Format.md)
907
+
908
+ ### Authorization
909
+
910
+ [bmltToken](../README.md#bmltToken)
911
+
912
+ ### HTTP request headers
913
+
914
+ - **Content-Type**: Not defined
915
+ - **Accept**: application/json
916
+
917
+
918
+ ## get_formats
919
+
920
+ > <Array<Format>> get_formats
921
+
922
+ Retrieves formats
923
+
924
+ Retrieve formats
925
+
926
+ ### Examples
927
+
928
+ ```ruby
929
+ require 'time'
930
+ require 'BmltClient'
931
+ # setup authorization
932
+ BmltClient.configure do |config|
933
+ # Configure OAuth2 access token for authorization: bmltToken
934
+ config.access_token = 'YOUR ACCESS TOKEN'
935
+ end
936
+
937
+ api_instance = BmltClient::RootServerApi.new
938
+
939
+ begin
940
+ # Retrieves formats
941
+ result = api_instance.get_formats
942
+ p result
943
+ rescue BmltClient::ApiError => e
944
+ puts "Error when calling RootServerApi->get_formats: #{e}"
945
+ end
946
+ ```
947
+
948
+ #### Using the get_formats_with_http_info variant
949
+
950
+ This returns an Array which contains the response data, status code and headers.
951
+
952
+ > <Array(<Array<Format>>, Integer, Hash)> get_formats_with_http_info
953
+
954
+ ```ruby
955
+ begin
956
+ # Retrieves formats
957
+ data, status_code, headers = api_instance.get_formats_with_http_info
958
+ p status_code # => 2xx
959
+ p headers # => { ... }
960
+ p data # => <Array<Format>>
961
+ rescue BmltClient::ApiError => e
962
+ puts "Error when calling RootServerApi->get_formats_with_http_info: #{e}"
963
+ end
964
+ ```
965
+
966
+ ### Parameters
967
+
968
+ This endpoint does not need any parameter.
969
+
970
+ ### Return type
971
+
972
+ [**Array&lt;Format&gt;**](Format.md)
973
+
974
+ ### Authorization
975
+
976
+ [bmltToken](../README.md#bmltToken)
977
+
978
+ ### HTTP request headers
979
+
980
+ - **Content-Type**: Not defined
981
+ - **Accept**: application/json
982
+
983
+
984
+ ## get_meeting
985
+
986
+ > <Meeting> get_meeting(meeting_id)
987
+
988
+ Retrieves a meeting
989
+
990
+ Retrieve a meeting.
991
+
992
+ ### Examples
993
+
994
+ ```ruby
995
+ require 'time'
996
+ require 'BmltClient'
997
+ # setup authorization
998
+ BmltClient.configure do |config|
999
+ # Configure OAuth2 access token for authorization: bmltToken
1000
+ config.access_token = 'YOUR ACCESS TOKEN'
1001
+ end
1002
+
1003
+ api_instance = BmltClient::RootServerApi.new
1004
+ meeting_id = 1 # Integer | ID of meeting
1005
+
1006
+ begin
1007
+ # Retrieves a meeting
1008
+ result = api_instance.get_meeting(meeting_id)
1009
+ p result
1010
+ rescue BmltClient::ApiError => e
1011
+ puts "Error when calling RootServerApi->get_meeting: #{e}"
1012
+ end
1013
+ ```
1014
+
1015
+ #### Using the get_meeting_with_http_info variant
1016
+
1017
+ This returns an Array which contains the response data, status code and headers.
1018
+
1019
+ > <Array(<Meeting>, Integer, Hash)> get_meeting_with_http_info(meeting_id)
1020
+
1021
+ ```ruby
1022
+ begin
1023
+ # Retrieves a meeting
1024
+ data, status_code, headers = api_instance.get_meeting_with_http_info(meeting_id)
1025
+ p status_code # => 2xx
1026
+ p headers # => { ... }
1027
+ p data # => <Meeting>
1028
+ rescue BmltClient::ApiError => e
1029
+ puts "Error when calling RootServerApi->get_meeting_with_http_info: #{e}"
1030
+ end
1031
+ ```
1032
+
1033
+ ### Parameters
1034
+
1035
+ | Name | Type | Description | Notes |
1036
+ | ---- | ---- | ----------- | ----- |
1037
+ | **meeting_id** | **Integer** | ID of meeting | |
1038
+
1039
+ ### Return type
1040
+
1041
+ [**Meeting**](Meeting.md)
1042
+
1043
+ ### Authorization
1044
+
1045
+ [bmltToken](../README.md#bmltToken)
1046
+
1047
+ ### HTTP request headers
1048
+
1049
+ - **Content-Type**: Not defined
1050
+ - **Accept**: application/json
1051
+
1052
+
1053
+ ## get_meetings
1054
+
1055
+ > <Array<Meeting>> get_meetings(opts)
1056
+
1057
+ Retrieves meetings
1058
+
1059
+ Retrieve meetings for authenticated user.
1060
+
1061
+ ### Examples
1062
+
1063
+ ```ruby
1064
+ require 'time'
1065
+ require 'BmltClient'
1066
+ # setup authorization
1067
+ BmltClient.configure do |config|
1068
+ # Configure OAuth2 access token for authorization: bmltToken
1069
+ config.access_token = 'YOUR ACCESS TOKEN'
1070
+ end
1071
+
1072
+ api_instance = BmltClient::RootServerApi.new
1073
+ opts = {
1074
+ meeting_ids: '1,2', # String | comma delimited meeting ids
1075
+ days: '0,1', # String | comma delimited day ids between 0-6
1076
+ service_body_ids: '3,4', # String | comma delimited service body ids
1077
+ search_string: 'Just for Today' # String | string
1078
+ }
1079
+
1080
+ begin
1081
+ # Retrieves meetings
1082
+ result = api_instance.get_meetings(opts)
1083
+ p result
1084
+ rescue BmltClient::ApiError => e
1085
+ puts "Error when calling RootServerApi->get_meetings: #{e}"
1086
+ end
1087
+ ```
1088
+
1089
+ #### Using the get_meetings_with_http_info variant
1090
+
1091
+ This returns an Array which contains the response data, status code and headers.
1092
+
1093
+ > <Array(<Array<Meeting>>, Integer, Hash)> get_meetings_with_http_info(opts)
1094
+
1095
+ ```ruby
1096
+ begin
1097
+ # Retrieves meetings
1098
+ data, status_code, headers = api_instance.get_meetings_with_http_info(opts)
1099
+ p status_code # => 2xx
1100
+ p headers # => { ... }
1101
+ p data # => <Array<Meeting>>
1102
+ rescue BmltClient::ApiError => e
1103
+ puts "Error when calling RootServerApi->get_meetings_with_http_info: #{e}"
1104
+ end
1105
+ ```
1106
+
1107
+ ### Parameters
1108
+
1109
+ | Name | Type | Description | Notes |
1110
+ | ---- | ---- | ----------- | ----- |
1111
+ | **meeting_ids** | **String** | comma delimited meeting ids | [optional] |
1112
+ | **days** | **String** | comma delimited day ids between 0-6 | [optional] |
1113
+ | **service_body_ids** | **String** | comma delimited service body ids | [optional] |
1114
+ | **search_string** | **String** | string | [optional] |
1115
+
1116
+ ### Return type
1117
+
1118
+ [**Array&lt;Meeting&gt;**](Meeting.md)
1119
+
1120
+ ### Authorization
1121
+
1122
+ [bmltToken](../README.md#bmltToken)
1123
+
1124
+ ### HTTP request headers
1125
+
1126
+ - **Content-Type**: Not defined
1127
+ - **Accept**: application/json
1128
+
1129
+
1130
+ ## get_service_bodies
1131
+
1132
+ > <Array<ServiceBody>> get_service_bodies
1133
+
1134
+ Retrieves service bodies
1135
+
1136
+ Retrieve service bodies for authenticated user.
1137
+
1138
+ ### Examples
1139
+
1140
+ ```ruby
1141
+ require 'time'
1142
+ require 'BmltClient'
1143
+ # setup authorization
1144
+ BmltClient.configure do |config|
1145
+ # Configure OAuth2 access token for authorization: bmltToken
1146
+ config.access_token = 'YOUR ACCESS TOKEN'
1147
+ end
1148
+
1149
+ api_instance = BmltClient::RootServerApi.new
1150
+
1151
+ begin
1152
+ # Retrieves service bodies
1153
+ result = api_instance.get_service_bodies
1154
+ p result
1155
+ rescue BmltClient::ApiError => e
1156
+ puts "Error when calling RootServerApi->get_service_bodies: #{e}"
1157
+ end
1158
+ ```
1159
+
1160
+ #### Using the get_service_bodies_with_http_info variant
1161
+
1162
+ This returns an Array which contains the response data, status code and headers.
1163
+
1164
+ > <Array(<Array<ServiceBody>>, Integer, Hash)> get_service_bodies_with_http_info
1165
+
1166
+ ```ruby
1167
+ begin
1168
+ # Retrieves service bodies
1169
+ data, status_code, headers = api_instance.get_service_bodies_with_http_info
1170
+ p status_code # => 2xx
1171
+ p headers # => { ... }
1172
+ p data # => <Array<ServiceBody>>
1173
+ rescue BmltClient::ApiError => e
1174
+ puts "Error when calling RootServerApi->get_service_bodies_with_http_info: #{e}"
1175
+ end
1176
+ ```
1177
+
1178
+ ### Parameters
1179
+
1180
+ This endpoint does not need any parameter.
1181
+
1182
+ ### Return type
1183
+
1184
+ [**Array&lt;ServiceBody&gt;**](ServiceBody.md)
1185
+
1186
+ ### Authorization
1187
+
1188
+ [bmltToken](../README.md#bmltToken)
1189
+
1190
+ ### HTTP request headers
1191
+
1192
+ - **Content-Type**: Not defined
1193
+ - **Accept**: application/json
1194
+
1195
+
1196
+ ## get_service_body
1197
+
1198
+ > <ServiceBody> get_service_body(service_body_id)
1199
+
1200
+ Retrieves a service body
1201
+
1202
+ Retrieve a single service body by id.
1203
+
1204
+ ### Examples
1205
+
1206
+ ```ruby
1207
+ require 'time'
1208
+ require 'BmltClient'
1209
+ # setup authorization
1210
+ BmltClient.configure do |config|
1211
+ # Configure OAuth2 access token for authorization: bmltToken
1212
+ config.access_token = 'YOUR ACCESS TOKEN'
1213
+ end
1214
+
1215
+ api_instance = BmltClient::RootServerApi.new
1216
+ service_body_id = 1 # Integer | ID of service body
1217
+
1218
+ begin
1219
+ # Retrieves a service body
1220
+ result = api_instance.get_service_body(service_body_id)
1221
+ p result
1222
+ rescue BmltClient::ApiError => e
1223
+ puts "Error when calling RootServerApi->get_service_body: #{e}"
1224
+ end
1225
+ ```
1226
+
1227
+ #### Using the get_service_body_with_http_info variant
1228
+
1229
+ This returns an Array which contains the response data, status code and headers.
1230
+
1231
+ > <Array(<ServiceBody>, Integer, Hash)> get_service_body_with_http_info(service_body_id)
1232
+
1233
+ ```ruby
1234
+ begin
1235
+ # Retrieves a service body
1236
+ data, status_code, headers = api_instance.get_service_body_with_http_info(service_body_id)
1237
+ p status_code # => 2xx
1238
+ p headers # => { ... }
1239
+ p data # => <ServiceBody>
1240
+ rescue BmltClient::ApiError => e
1241
+ puts "Error when calling RootServerApi->get_service_body_with_http_info: #{e}"
1242
+ end
1243
+ ```
1244
+
1245
+ ### Parameters
1246
+
1247
+ | Name | Type | Description | Notes |
1248
+ | ---- | ---- | ----------- | ----- |
1249
+ | **service_body_id** | **Integer** | ID of service body | |
1250
+
1251
+ ### Return type
1252
+
1253
+ [**ServiceBody**](ServiceBody.md)
1254
+
1255
+ ### Authorization
1256
+
1257
+ [bmltToken](../README.md#bmltToken)
1258
+
1259
+ ### HTTP request headers
1260
+
1261
+ - **Content-Type**: Not defined
1262
+ - **Accept**: application/json
1263
+
1264
+
1265
+ ## get_user
1266
+
1267
+ > <User> get_user(user_id)
1268
+
1269
+ Retrieves a single user
1270
+
1271
+ Retrieve single user.
1272
+
1273
+ ### Examples
1274
+
1275
+ ```ruby
1276
+ require 'time'
1277
+ require 'BmltClient'
1278
+ # setup authorization
1279
+ BmltClient.configure do |config|
1280
+ # Configure OAuth2 access token for authorization: bmltToken
1281
+ config.access_token = 'YOUR ACCESS TOKEN'
1282
+ end
1283
+
1284
+ api_instance = BmltClient::RootServerApi.new
1285
+ user_id = 1 # Integer | ID of user
1286
+
1287
+ begin
1288
+ # Retrieves a single user
1289
+ result = api_instance.get_user(user_id)
1290
+ p result
1291
+ rescue BmltClient::ApiError => e
1292
+ puts "Error when calling RootServerApi->get_user: #{e}"
1293
+ end
1294
+ ```
1295
+
1296
+ #### Using the get_user_with_http_info variant
1297
+
1298
+ This returns an Array which contains the response data, status code and headers.
1299
+
1300
+ > <Array(<User>, Integer, Hash)> get_user_with_http_info(user_id)
1301
+
1302
+ ```ruby
1303
+ begin
1304
+ # Retrieves a single user
1305
+ data, status_code, headers = api_instance.get_user_with_http_info(user_id)
1306
+ p status_code # => 2xx
1307
+ p headers # => { ... }
1308
+ p data # => <User>
1309
+ rescue BmltClient::ApiError => e
1310
+ puts "Error when calling RootServerApi->get_user_with_http_info: #{e}"
1311
+ end
1312
+ ```
1313
+
1314
+ ### Parameters
1315
+
1316
+ | Name | Type | Description | Notes |
1317
+ | ---- | ---- | ----------- | ----- |
1318
+ | **user_id** | **Integer** | ID of user | |
1319
+
1320
+ ### Return type
1321
+
1322
+ [**User**](User.md)
1323
+
1324
+ ### Authorization
1325
+
1326
+ [bmltToken](../README.md#bmltToken)
1327
+
1328
+ ### HTTP request headers
1329
+
1330
+ - **Content-Type**: Not defined
1331
+ - **Accept**: application/json
1332
+
1333
+
1334
+ ## get_users
1335
+
1336
+ > <Array<User>> get_users
1337
+
1338
+ Retrieves users
1339
+
1340
+ Retrieve users for authenticated user.
1341
+
1342
+ ### Examples
1343
+
1344
+ ```ruby
1345
+ require 'time'
1346
+ require 'BmltClient'
1347
+ # setup authorization
1348
+ BmltClient.configure do |config|
1349
+ # Configure OAuth2 access token for authorization: bmltToken
1350
+ config.access_token = 'YOUR ACCESS TOKEN'
1351
+ end
1352
+
1353
+ api_instance = BmltClient::RootServerApi.new
1354
+
1355
+ begin
1356
+ # Retrieves users
1357
+ result = api_instance.get_users
1358
+ p result
1359
+ rescue BmltClient::ApiError => e
1360
+ puts "Error when calling RootServerApi->get_users: #{e}"
1361
+ end
1362
+ ```
1363
+
1364
+ #### Using the get_users_with_http_info variant
1365
+
1366
+ This returns an Array which contains the response data, status code and headers.
1367
+
1368
+ > <Array(<Array<User>>, Integer, Hash)> get_users_with_http_info
1369
+
1370
+ ```ruby
1371
+ begin
1372
+ # Retrieves users
1373
+ data, status_code, headers = api_instance.get_users_with_http_info
1374
+ p status_code # => 2xx
1375
+ p headers # => { ... }
1376
+ p data # => <Array<User>>
1377
+ rescue BmltClient::ApiError => e
1378
+ puts "Error when calling RootServerApi->get_users_with_http_info: #{e}"
1379
+ end
1380
+ ```
1381
+
1382
+ ### Parameters
1383
+
1384
+ This endpoint does not need any parameter.
1385
+
1386
+ ### Return type
1387
+
1388
+ [**Array&lt;User&gt;**](User.md)
1389
+
1390
+ ### Authorization
1391
+
1392
+ [bmltToken](../README.md#bmltToken)
1393
+
1394
+ ### HTTP request headers
1395
+
1396
+ - **Content-Type**: Not defined
1397
+ - **Accept**: application/json
1398
+
1399
+
1400
+ ## partial_update_user
1401
+
1402
+ > partial_update_user(user_id, user_partial_update)
1403
+
1404
+ Patches a user
1405
+
1406
+ Patches a user by id.
1407
+
1408
+ ### Examples
1409
+
1410
+ ```ruby
1411
+ require 'time'
1412
+ require 'BmltClient'
1413
+ # setup authorization
1414
+ BmltClient.configure do |config|
1415
+ # Configure OAuth2 access token for authorization: bmltToken
1416
+ config.access_token = 'YOUR ACCESS TOKEN'
1417
+ end
1418
+
1419
+ api_instance = BmltClient::RootServerApi.new
1420
+ user_id = 1 # Integer | ID of user
1421
+ user_partial_update = BmltClient::UserPartialUpdate.new # UserPartialUpdate | Pass in fields you want to update.
1422
+
1423
+ begin
1424
+ # Patches a user
1425
+ api_instance.partial_update_user(user_id, user_partial_update)
1426
+ rescue BmltClient::ApiError => e
1427
+ puts "Error when calling RootServerApi->partial_update_user: #{e}"
1428
+ end
1429
+ ```
1430
+
1431
+ #### Using the partial_update_user_with_http_info variant
1432
+
1433
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1434
+
1435
+ > <Array(nil, Integer, Hash)> partial_update_user_with_http_info(user_id, user_partial_update)
1436
+
1437
+ ```ruby
1438
+ begin
1439
+ # Patches a user
1440
+ data, status_code, headers = api_instance.partial_update_user_with_http_info(user_id, user_partial_update)
1441
+ p status_code # => 2xx
1442
+ p headers # => { ... }
1443
+ p data # => nil
1444
+ rescue BmltClient::ApiError => e
1445
+ puts "Error when calling RootServerApi->partial_update_user_with_http_info: #{e}"
1446
+ end
1447
+ ```
1448
+
1449
+ ### Parameters
1450
+
1451
+ | Name | Type | Description | Notes |
1452
+ | ---- | ---- | ----------- | ----- |
1453
+ | **user_id** | **Integer** | ID of user | |
1454
+ | **user_partial_update** | [**UserPartialUpdate**](UserPartialUpdate.md) | Pass in fields you want to update. | |
1455
+
1456
+ ### Return type
1457
+
1458
+ nil (empty response body)
1459
+
1460
+ ### Authorization
1461
+
1462
+ [bmltToken](../README.md#bmltToken)
1463
+
1464
+ ### HTTP request headers
1465
+
1466
+ - **Content-Type**: application/json
1467
+ - **Accept**: application/json
1468
+
1469
+
1470
+ ## patch_format
1471
+
1472
+ > patch_format(format_id, format_partial_update)
1473
+
1474
+ Patches a format
1475
+
1476
+ Patches a single format by id.
1477
+
1478
+ ### Examples
1479
+
1480
+ ```ruby
1481
+ require 'time'
1482
+ require 'BmltClient'
1483
+ # setup authorization
1484
+ BmltClient.configure do |config|
1485
+ # Configure OAuth2 access token for authorization: bmltToken
1486
+ config.access_token = 'YOUR ACCESS TOKEN'
1487
+ end
1488
+
1489
+ api_instance = BmltClient::RootServerApi.new
1490
+ format_id = 1 # Integer | ID of format
1491
+ format_partial_update = BmltClient::FormatPartialUpdate.new # FormatPartialUpdate | Pass in fields you want to update.
1492
+
1493
+ begin
1494
+ # Patches a format
1495
+ api_instance.patch_format(format_id, format_partial_update)
1496
+ rescue BmltClient::ApiError => e
1497
+ puts "Error when calling RootServerApi->patch_format: #{e}"
1498
+ end
1499
+ ```
1500
+
1501
+ #### Using the patch_format_with_http_info variant
1502
+
1503
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1504
+
1505
+ > <Array(nil, Integer, Hash)> patch_format_with_http_info(format_id, format_partial_update)
1506
+
1507
+ ```ruby
1508
+ begin
1509
+ # Patches a format
1510
+ data, status_code, headers = api_instance.patch_format_with_http_info(format_id, format_partial_update)
1511
+ p status_code # => 2xx
1512
+ p headers # => { ... }
1513
+ p data # => nil
1514
+ rescue BmltClient::ApiError => e
1515
+ puts "Error when calling RootServerApi->patch_format_with_http_info: #{e}"
1516
+ end
1517
+ ```
1518
+
1519
+ ### Parameters
1520
+
1521
+ | Name | Type | Description | Notes |
1522
+ | ---- | ---- | ----------- | ----- |
1523
+ | **format_id** | **Integer** | ID of format | |
1524
+ | **format_partial_update** | [**FormatPartialUpdate**](FormatPartialUpdate.md) | Pass in fields you want to update. | |
1525
+
1526
+ ### Return type
1527
+
1528
+ nil (empty response body)
1529
+
1530
+ ### Authorization
1531
+
1532
+ [bmltToken](../README.md#bmltToken)
1533
+
1534
+ ### HTTP request headers
1535
+
1536
+ - **Content-Type**: application/json
1537
+ - **Accept**: application/json
1538
+
1539
+
1540
+ ## patch_meeting
1541
+
1542
+ > patch_meeting(meeting_id, meeting_partial_update)
1543
+
1544
+ Patches a meeting
1545
+
1546
+ Patches a meeting by id
1547
+
1548
+ ### Examples
1549
+
1550
+ ```ruby
1551
+ require 'time'
1552
+ require 'BmltClient'
1553
+ # setup authorization
1554
+ BmltClient.configure do |config|
1555
+ # Configure OAuth2 access token for authorization: bmltToken
1556
+ config.access_token = 'YOUR ACCESS TOKEN'
1557
+ end
1558
+
1559
+ api_instance = BmltClient::RootServerApi.new
1560
+ meeting_id = 1 # Integer | ID of meeting
1561
+ meeting_partial_update = BmltClient::MeetingPartialUpdate.new({service_body_id: 0, format_ids: [37], venue_type: 1, day: 0, start_time: 'string', duration: '01:00', latitude: 35.698741, longitude: -81.26273, published: true, name: 'string'}) # MeetingPartialUpdate | Pass in fields you want to update.
1562
+
1563
+ begin
1564
+ # Patches a meeting
1565
+ api_instance.patch_meeting(meeting_id, meeting_partial_update)
1566
+ rescue BmltClient::ApiError => e
1567
+ puts "Error when calling RootServerApi->patch_meeting: #{e}"
1568
+ end
1569
+ ```
1570
+
1571
+ #### Using the patch_meeting_with_http_info variant
1572
+
1573
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1574
+
1575
+ > <Array(nil, Integer, Hash)> patch_meeting_with_http_info(meeting_id, meeting_partial_update)
1576
+
1577
+ ```ruby
1578
+ begin
1579
+ # Patches a meeting
1580
+ data, status_code, headers = api_instance.patch_meeting_with_http_info(meeting_id, meeting_partial_update)
1581
+ p status_code # => 2xx
1582
+ p headers # => { ... }
1583
+ p data # => nil
1584
+ rescue BmltClient::ApiError => e
1585
+ puts "Error when calling RootServerApi->patch_meeting_with_http_info: #{e}"
1586
+ end
1587
+ ```
1588
+
1589
+ ### Parameters
1590
+
1591
+ | Name | Type | Description | Notes |
1592
+ | ---- | ---- | ----------- | ----- |
1593
+ | **meeting_id** | **Integer** | ID of meeting | |
1594
+ | **meeting_partial_update** | [**MeetingPartialUpdate**](MeetingPartialUpdate.md) | Pass in fields you want to update. | |
1595
+
1596
+ ### Return type
1597
+
1598
+ nil (empty response body)
1599
+
1600
+ ### Authorization
1601
+
1602
+ [bmltToken](../README.md#bmltToken)
1603
+
1604
+ ### HTTP request headers
1605
+
1606
+ - **Content-Type**: application/json
1607
+ - **Accept**: application/json
1608
+
1609
+
1610
+ ## patch_service_body
1611
+
1612
+ > patch_service_body(service_body_id, service_body_partial_update)
1613
+
1614
+ Patches a service body
1615
+
1616
+ Patches a single service body by id.
1617
+
1618
+ ### Examples
1619
+
1620
+ ```ruby
1621
+ require 'time'
1622
+ require 'BmltClient'
1623
+ # setup authorization
1624
+ BmltClient.configure do |config|
1625
+ # Configure OAuth2 access token for authorization: bmltToken
1626
+ config.access_token = 'YOUR ACCESS TOKEN'
1627
+ end
1628
+
1629
+ api_instance = BmltClient::RootServerApi.new
1630
+ service_body_id = 1 # Integer | ID of service body
1631
+ service_body_partial_update = BmltClient::ServiceBodyPartialUpdate.new # ServiceBodyPartialUpdate | Pass in fields you want to update.
1632
+
1633
+ begin
1634
+ # Patches a service body
1635
+ api_instance.patch_service_body(service_body_id, service_body_partial_update)
1636
+ rescue BmltClient::ApiError => e
1637
+ puts "Error when calling RootServerApi->patch_service_body: #{e}"
1638
+ end
1639
+ ```
1640
+
1641
+ #### Using the patch_service_body_with_http_info variant
1642
+
1643
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1644
+
1645
+ > <Array(nil, Integer, Hash)> patch_service_body_with_http_info(service_body_id, service_body_partial_update)
1646
+
1647
+ ```ruby
1648
+ begin
1649
+ # Patches a service body
1650
+ data, status_code, headers = api_instance.patch_service_body_with_http_info(service_body_id, service_body_partial_update)
1651
+ p status_code # => 2xx
1652
+ p headers # => { ... }
1653
+ p data # => nil
1654
+ rescue BmltClient::ApiError => e
1655
+ puts "Error when calling RootServerApi->patch_service_body_with_http_info: #{e}"
1656
+ end
1657
+ ```
1658
+
1659
+ ### Parameters
1660
+
1661
+ | Name | Type | Description | Notes |
1662
+ | ---- | ---- | ----------- | ----- |
1663
+ | **service_body_id** | **Integer** | ID of service body | |
1664
+ | **service_body_partial_update** | [**ServiceBodyPartialUpdate**](ServiceBodyPartialUpdate.md) | Pass in fields you want to update. | |
1665
+
1666
+ ### Return type
1667
+
1668
+ nil (empty response body)
1669
+
1670
+ ### Authorization
1671
+
1672
+ [bmltToken](../README.md#bmltToken)
1673
+
1674
+ ### HTTP request headers
1675
+
1676
+ - **Content-Type**: application/json
1677
+ - **Accept**: application/json
1678
+
1679
+
1680
+ ## update_format
1681
+
1682
+ > update_format(format_id, format_update)
1683
+
1684
+ Updates a format
1685
+
1686
+ Updates a format.
1687
+
1688
+ ### Examples
1689
+
1690
+ ```ruby
1691
+ require 'time'
1692
+ require 'BmltClient'
1693
+ # setup authorization
1694
+ BmltClient.configure do |config|
1695
+ # Configure OAuth2 access token for authorization: bmltToken
1696
+ config.access_token = 'YOUR ACCESS TOKEN'
1697
+ end
1698
+
1699
+ api_instance = BmltClient::RootServerApi.new
1700
+ format_id = 1 # Integer | ID of format
1701
+ format_update = BmltClient::FormatUpdate.new({translations: [BmltClient::FormatTranslation.new({key: 'key_example', name: 'name_example', description: 'description_example', language: 'language_example'})]}) # FormatUpdate | Pass in format object
1702
+
1703
+ begin
1704
+ # Updates a format
1705
+ api_instance.update_format(format_id, format_update)
1706
+ rescue BmltClient::ApiError => e
1707
+ puts "Error when calling RootServerApi->update_format: #{e}"
1708
+ end
1709
+ ```
1710
+
1711
+ #### Using the update_format_with_http_info variant
1712
+
1713
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1714
+
1715
+ > <Array(nil, Integer, Hash)> update_format_with_http_info(format_id, format_update)
1716
+
1717
+ ```ruby
1718
+ begin
1719
+ # Updates a format
1720
+ data, status_code, headers = api_instance.update_format_with_http_info(format_id, format_update)
1721
+ p status_code # => 2xx
1722
+ p headers # => { ... }
1723
+ p data # => nil
1724
+ rescue BmltClient::ApiError => e
1725
+ puts "Error when calling RootServerApi->update_format_with_http_info: #{e}"
1726
+ end
1727
+ ```
1728
+
1729
+ ### Parameters
1730
+
1731
+ | Name | Type | Description | Notes |
1732
+ | ---- | ---- | ----------- | ----- |
1733
+ | **format_id** | **Integer** | ID of format | |
1734
+ | **format_update** | [**FormatUpdate**](FormatUpdate.md) | Pass in format object | |
1735
+
1736
+ ### Return type
1737
+
1738
+ nil (empty response body)
1739
+
1740
+ ### Authorization
1741
+
1742
+ [bmltToken](../README.md#bmltToken)
1743
+
1744
+ ### HTTP request headers
1745
+
1746
+ - **Content-Type**: application/json
1747
+ - **Accept**: application/json
1748
+
1749
+
1750
+ ## update_meeting
1751
+
1752
+ > update_meeting(meeting_id, meeting_update)
1753
+
1754
+ Updates a meeting
1755
+
1756
+ Updates a meeting.
1757
+
1758
+ ### Examples
1759
+
1760
+ ```ruby
1761
+ require 'time'
1762
+ require 'BmltClient'
1763
+ # setup authorization
1764
+ BmltClient.configure do |config|
1765
+ # Configure OAuth2 access token for authorization: bmltToken
1766
+ config.access_token = 'YOUR ACCESS TOKEN'
1767
+ end
1768
+
1769
+ api_instance = BmltClient::RootServerApi.new
1770
+ meeting_id = 1 # Integer | ID of meeting
1771
+ meeting_update = BmltClient::MeetingUpdate.new({service_body_id: 0, format_ids: [37], venue_type: 1, day: 0, start_time: 'string', duration: '01:00', latitude: 35.698741, longitude: -81.26273, published: true, name: 'string'}) # MeetingUpdate | Pass in meeting object
1772
+
1773
+ begin
1774
+ # Updates a meeting
1775
+ api_instance.update_meeting(meeting_id, meeting_update)
1776
+ rescue BmltClient::ApiError => e
1777
+ puts "Error when calling RootServerApi->update_meeting: #{e}"
1778
+ end
1779
+ ```
1780
+
1781
+ #### Using the update_meeting_with_http_info variant
1782
+
1783
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1784
+
1785
+ > <Array(nil, Integer, Hash)> update_meeting_with_http_info(meeting_id, meeting_update)
1786
+
1787
+ ```ruby
1788
+ begin
1789
+ # Updates a meeting
1790
+ data, status_code, headers = api_instance.update_meeting_with_http_info(meeting_id, meeting_update)
1791
+ p status_code # => 2xx
1792
+ p headers # => { ... }
1793
+ p data # => nil
1794
+ rescue BmltClient::ApiError => e
1795
+ puts "Error when calling RootServerApi->update_meeting_with_http_info: #{e}"
1796
+ end
1797
+ ```
1798
+
1799
+ ### Parameters
1800
+
1801
+ | Name | Type | Description | Notes |
1802
+ | ---- | ---- | ----------- | ----- |
1803
+ | **meeting_id** | **Integer** | ID of meeting | |
1804
+ | **meeting_update** | [**MeetingUpdate**](MeetingUpdate.md) | Pass in meeting object | |
1805
+
1806
+ ### Return type
1807
+
1808
+ nil (empty response body)
1809
+
1810
+ ### Authorization
1811
+
1812
+ [bmltToken](../README.md#bmltToken)
1813
+
1814
+ ### HTTP request headers
1815
+
1816
+ - **Content-Type**: application/json
1817
+ - **Accept**: application/json
1818
+
1819
+
1820
+ ## update_service_body
1821
+
1822
+ > update_service_body(service_body_id, service_body_update)
1823
+
1824
+ Updates a Service Body
1825
+
1826
+ Updates a single service body.
1827
+
1828
+ ### Examples
1829
+
1830
+ ```ruby
1831
+ require 'time'
1832
+ require 'BmltClient'
1833
+ # setup authorization
1834
+ BmltClient.configure do |config|
1835
+ # Configure OAuth2 access token for authorization: bmltToken
1836
+ config.access_token = 'YOUR ACCESS TOKEN'
1837
+ end
1838
+
1839
+ api_instance = BmltClient::RootServerApi.new
1840
+ service_body_id = 1 # Integer | ID of service body
1841
+ service_body_update = BmltClient::ServiceBodyUpdate.new({parent_id: 0, name: 'string', description: 'string', type: 'string', admin_user_id: 0, assigned_user_ids: [0]}) # ServiceBodyUpdate | Pass in service body object
1842
+
1843
+ begin
1844
+ # Updates a Service Body
1845
+ api_instance.update_service_body(service_body_id, service_body_update)
1846
+ rescue BmltClient::ApiError => e
1847
+ puts "Error when calling RootServerApi->update_service_body: #{e}"
1848
+ end
1849
+ ```
1850
+
1851
+ #### Using the update_service_body_with_http_info variant
1852
+
1853
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1854
+
1855
+ > <Array(nil, Integer, Hash)> update_service_body_with_http_info(service_body_id, service_body_update)
1856
+
1857
+ ```ruby
1858
+ begin
1859
+ # Updates a Service Body
1860
+ data, status_code, headers = api_instance.update_service_body_with_http_info(service_body_id, service_body_update)
1861
+ p status_code # => 2xx
1862
+ p headers # => { ... }
1863
+ p data # => nil
1864
+ rescue BmltClient::ApiError => e
1865
+ puts "Error when calling RootServerApi->update_service_body_with_http_info: #{e}"
1866
+ end
1867
+ ```
1868
+
1869
+ ### Parameters
1870
+
1871
+ | Name | Type | Description | Notes |
1872
+ | ---- | ---- | ----------- | ----- |
1873
+ | **service_body_id** | **Integer** | ID of service body | |
1874
+ | **service_body_update** | [**ServiceBodyUpdate**](ServiceBodyUpdate.md) | Pass in service body object | |
1875
+
1876
+ ### Return type
1877
+
1878
+ nil (empty response body)
1879
+
1880
+ ### Authorization
1881
+
1882
+ [bmltToken](../README.md#bmltToken)
1883
+
1884
+ ### HTTP request headers
1885
+
1886
+ - **Content-Type**: application/json
1887
+ - **Accept**: application/json
1888
+
1889
+
1890
+ ## update_user
1891
+
1892
+ > update_user(user_id, user_update)
1893
+
1894
+ Update single user
1895
+
1896
+ Updates a user.
1897
+
1898
+ ### Examples
1899
+
1900
+ ```ruby
1901
+ require 'time'
1902
+ require 'BmltClient'
1903
+ # setup authorization
1904
+ BmltClient.configure do |config|
1905
+ # Configure OAuth2 access token for authorization: bmltToken
1906
+ config.access_token = 'YOUR ACCESS TOKEN'
1907
+ end
1908
+
1909
+ api_instance = BmltClient::RootServerApi.new
1910
+ user_id = 1 # Integer | ID of user
1911
+ user_update = BmltClient::UserUpdate.new({username: 'string', type: 'string', display_name: 'string'}) # UserUpdate | Pass in user object
1912
+
1913
+ begin
1914
+ # Update single user
1915
+ api_instance.update_user(user_id, user_update)
1916
+ rescue BmltClient::ApiError => e
1917
+ puts "Error when calling RootServerApi->update_user: #{e}"
1918
+ end
1919
+ ```
1920
+
1921
+ #### Using the update_user_with_http_info variant
1922
+
1923
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1924
+
1925
+ > <Array(nil, Integer, Hash)> update_user_with_http_info(user_id, user_update)
1926
+
1927
+ ```ruby
1928
+ begin
1929
+ # Update single user
1930
+ data, status_code, headers = api_instance.update_user_with_http_info(user_id, user_update)
1931
+ p status_code # => 2xx
1932
+ p headers # => { ... }
1933
+ p data # => nil
1934
+ rescue BmltClient::ApiError => e
1935
+ puts "Error when calling RootServerApi->update_user_with_http_info: #{e}"
1936
+ end
1937
+ ```
1938
+
1939
+ ### Parameters
1940
+
1941
+ | Name | Type | Description | Notes |
1942
+ | ---- | ---- | ----------- | ----- |
1943
+ | **user_id** | **Integer** | ID of user | |
1944
+ | **user_update** | [**UserUpdate**](UserUpdate.md) | Pass in user object | |
1945
+
1946
+ ### Return type
1947
+
1948
+ nil (empty response body)
1949
+
1950
+ ### Authorization
1951
+
1952
+ [bmltToken](../README.md#bmltToken)
1953
+
1954
+ ### HTTP request headers
1955
+
1956
+ - **Content-Type**: application/json
1957
+ - **Accept**: application/json
1958
+