Class: XbimAim::AdminApi
- Inherits:
-
Object
- Object
- XbimAim::AdminApi
- Defined in:
- lib/xbim_aim/api/admin_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#admin_applied_updates(region, opts = {}) ⇒ Array<DbUpdate>
Lists the Database schema updates already installed <span style=‘font-size: 17px;’>Summary:</span>Lists the Database schema updates already installed.<br/>This can only be used by users in the Flex Superuser role.<br/>Return Type: DbUpdate<br/><br/>.
-
#admin_applied_updates_with_http_info(region, opts = {}) ⇒ Array<(Array<DbUpdate>, Integer, Hash)>
Lists the Database schema updates already installed <span style='font-size: 17px;'>Summary:</span>Lists the Database schema updates already installed.<br/>This can only be used by users in the Flex Superuser role.<br/>Return Type: <b>DbUpdate</b><br/><br/>.
-
#admin_flush_caches(region, opts = {}) ⇒ nil
Flushes the Flex caches <span style=‘font-size: 17px;’>Summary:</span>Flushes the Flex caches.<br/>This can only be used by users in the Flex Superuser role.<br/>Return Type: <br/><br/>.
-
#admin_flush_caches_with_http_info(region, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Flushes the Flex caches <span style='font-size: 17px;'>Summary:</span>Flushes the Flex caches.<br/>This can only be used by users in the Flex Superuser role.<br/>Return Type: <b></b><br/><br/>.
-
#admin_get_is_current(region, opts = {}) ⇒ Boolean
Returns a flag indicating if the database schema requires an upgrade <span style=‘font-size: 17px;’>Summary:</span>Returns a flag indicating if the database schema requires an upgrade.<br/>This service can be used by any client.
-
#admin_get_is_current_with_http_info(region, opts = {}) ⇒ Array<(Boolean, Integer, Hash)>
Returns a flag indicating if the database schema requires an upgrade <span style='font-size: 17px;'>Summary:</span>Returns a flag indicating if the database schema requires an upgrade.<br/>This service can be used by any client.
-
#admin_pending_updates(region, opts = {}) ⇒ Array<DbUpdate>
Lists the Database schema updates required <span style=‘font-size: 17px;’>Summary:</span>Lists the Database schema updates required.<br/>This can only be used by users in the Flex Superuser role.<br/>Return Type: DbUpdate<br/><br/>.
-
#admin_pending_updates_with_http_info(region, opts = {}) ⇒ Array<(Array<DbUpdate>, Integer, Hash)>
Lists the Database schema updates required <span style='font-size: 17px;'>Summary:</span>Lists the Database schema updates required.<br/>This can only be used by users in the Flex Superuser role.<br/>Return Type: <b>DbUpdate</b><br/><br/>.
-
#admin_update_schema(region, opts = {}) ⇒ nil
Updates the Database schemas to the latest version <span style=‘font-size: 17px;’>Summary:</span>Updates the Database schemas to the latest version.<br/>This can only be used by users in the Flex Superuser role.<br/>Return Type: <br/><br/>.
-
#admin_update_schema_with_http_info(region, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Updates the Database schemas to the latest version <span style='font-size: 17px;'>Summary:</span>Updates the Database schemas to the latest version.<br/>This can only be used by users in the Flex Superuser role.<br/>Return Type: <b></b><br/><br/>.
-
#initialize(api_client = ApiClient.default) ⇒ AdminApi
constructor
A new instance of AdminApi.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/xbim_aim/api/admin_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#admin_applied_updates(region, opts = {}) ⇒ Array<DbUpdate>
Lists the Database schema updates already installed <span style=‘font-size: 17px;’>Summary:</span>Lists the Database schema updates already installed.<br/>This can only be used by users in the Flex Superuser role.<br/>Return Type: DbUpdate<br/><br/>
27 28 29 30 |
# File 'lib/xbim_aim/api/admin_api.rb', line 27 def admin_applied_updates(region, opts = {}) data, _status_code, _headers = admin_applied_updates_with_http_info(region, opts) data end |
#admin_applied_updates_with_http_info(region, opts = {}) ⇒ Array<(Array<DbUpdate>, Integer, Hash)>
Lists the Database schema updates already installed <span style='font-size: 17px;'>Summary:</span>Lists the Database schema updates already installed.<br/>This can only be used by users in the Flex Superuser role.<br/>Return Type: <b>DbUpdate</b><br/><br/>
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/xbim_aim/api/admin_api.rb', line 37 def admin_applied_updates_with_http_info(region, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AdminApi.admin_applied_updates ...' end # verify the required parameter 'region' is set if @api_client.config.client_side_validation && region.nil? fail ArgumentError, "Missing the required parameter 'region' when calling AdminApi.admin_applied_updates" end # verify enum value allowable_values = ["UK", "WestEurope", "Sandbox"] if @api_client.config.client_side_validation && !allowable_values.include?(region) fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}" end # resource path local_var_path = '/{region}/aim/2.0/admin/schema/AppliedUpdates'.sub('{' + 'region' + '}', CGI.escape(region.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', 'text/json', 'application/xml', 'text/xml']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Array<DbUpdate>' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"AdminApi.admin_applied_updates", :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: AdminApi#admin_applied_updates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#admin_flush_caches(region, opts = {}) ⇒ nil
Flushes the Flex caches <span style=‘font-size: 17px;’>Summary:</span>Flushes the Flex caches.<br/>This can only be used by users in the Flex Superuser role.<br/>Return Type: <br/><br/>
95 96 97 98 |
# File 'lib/xbim_aim/api/admin_api.rb', line 95 def admin_flush_caches(region, opts = {}) admin_flush_caches_with_http_info(region, opts) nil end |
#admin_flush_caches_with_http_info(region, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Flushes the Flex caches <span style='font-size: 17px;'>Summary:</span>Flushes the Flex caches.<br/>This can only be used by users in the Flex Superuser role.<br/>Return Type: <b></b><br/><br/>
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
# File 'lib/xbim_aim/api/admin_api.rb', line 105 def admin_flush_caches_with_http_info(region, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AdminApi.admin_flush_caches ...' end # verify the required parameter 'region' is set if @api_client.config.client_side_validation && region.nil? fail ArgumentError, "Missing the required parameter 'region' when calling AdminApi.admin_flush_caches" end # verify enum value allowable_values = ["UK", "WestEurope", "Sandbox"] if @api_client.config.client_side_validation && !allowable_values.include?(region) fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}" end # resource path local_var_path = '/{region}/aim/2.0/admin/schema/FlushCaches'.sub('{' + 'region' + '}', CGI.escape(region.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] || ['oauth2'] = opts.merge( :operation => :"AdminApi.admin_flush_caches", :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: AdminApi#admin_flush_caches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#admin_get_is_current(region, opts = {}) ⇒ Boolean
Returns a flag indicating if the database schema requires an upgrade <span style=‘font-size: 17px;’>Summary:</span>Returns a flag indicating if the database schema requires an upgrade.<br/>This service can be used by any client. SuperUser role is not required.<br/>Return Type: boolean<br/><br/>
161 162 163 164 |
# File 'lib/xbim_aim/api/admin_api.rb', line 161 def admin_get_is_current(region, opts = {}) data, _status_code, _headers = admin_get_is_current_with_http_info(region, opts) data end |
#admin_get_is_current_with_http_info(region, opts = {}) ⇒ Array<(Boolean, Integer, Hash)>
Returns a flag indicating if the database schema requires an upgrade <span style='font-size: 17px;'>Summary:</span>Returns a flag indicating if the database schema requires an upgrade.<br/>This service can be used by any client. SuperUser role is not required.<br/>Return Type: <b>boolean</b><br/><br/>
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 |
# File 'lib/xbim_aim/api/admin_api.rb', line 171 def admin_get_is_current_with_http_info(region, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AdminApi.admin_get_is_current ...' end # verify the required parameter 'region' is set if @api_client.config.client_side_validation && region.nil? fail ArgumentError, "Missing the required parameter 'region' when calling AdminApi.admin_get_is_current" end # verify enum value allowable_values = ["UK", "WestEurope", "Sandbox"] if @api_client.config.client_side_validation && !allowable_values.include?(region) fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}" end # resource path local_var_path = '/{region}/aim/2.0/admin/schema/IsCurrent'.sub('{' + 'region' + '}', CGI.escape(region.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', 'text/json', 'application/xml', 'text/xml']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Boolean' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"AdminApi.admin_get_is_current", :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: AdminApi#admin_get_is_current\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#admin_pending_updates(region, opts = {}) ⇒ Array<DbUpdate>
Lists the Database schema updates required <span style=‘font-size: 17px;’>Summary:</span>Lists the Database schema updates required.<br/>This can only be used by users in the Flex Superuser role.<br/>Return Type: DbUpdate<br/><br/>
229 230 231 232 |
# File 'lib/xbim_aim/api/admin_api.rb', line 229 def admin_pending_updates(region, opts = {}) data, _status_code, _headers = admin_pending_updates_with_http_info(region, opts) data end |
#admin_pending_updates_with_http_info(region, opts = {}) ⇒ Array<(Array<DbUpdate>, Integer, Hash)>
Lists the Database schema updates required <span style='font-size: 17px;'>Summary:</span>Lists the Database schema updates required.<br/>This can only be used by users in the Flex Superuser role.<br/>Return Type: <b>DbUpdate</b><br/><br/>
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/xbim_aim/api/admin_api.rb', line 239 def admin_pending_updates_with_http_info(region, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AdminApi.admin_pending_updates ...' end # verify the required parameter 'region' is set if @api_client.config.client_side_validation && region.nil? fail ArgumentError, "Missing the required parameter 'region' when calling AdminApi.admin_pending_updates" end # verify enum value allowable_values = ["UK", "WestEurope", "Sandbox"] if @api_client.config.client_side_validation && !allowable_values.include?(region) fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}" end # resource path local_var_path = '/{region}/aim/2.0/admin/schema/PendingUpdates'.sub('{' + 'region' + '}', CGI.escape(region.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', 'text/json', 'application/xml', 'text/xml']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'Array<DbUpdate>' # auth_names auth_names = opts[:debug_auth_names] || ['oauth2'] = opts.merge( :operation => :"AdminApi.admin_pending_updates", :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: AdminApi#admin_pending_updates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#admin_update_schema(region, opts = {}) ⇒ nil
Updates the Database schemas to the latest version <span style=‘font-size: 17px;’>Summary:</span>Updates the Database schemas to the latest version.<br/>This can only be used by users in the Flex Superuser role.<br/>Return Type: <br/><br/>
297 298 299 300 |
# File 'lib/xbim_aim/api/admin_api.rb', line 297 def admin_update_schema(region, opts = {}) admin_update_schema_with_http_info(region, opts) nil end |
#admin_update_schema_with_http_info(region, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Updates the Database schemas to the latest version <span style='font-size: 17px;'>Summary:</span>Updates the Database schemas to the latest version.<br/>This can only be used by users in the Flex Superuser role.<br/>Return Type: <b></b><br/><br/>
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 |
# File 'lib/xbim_aim/api/admin_api.rb', line 307 def admin_update_schema_with_http_info(region, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AdminApi.admin_update_schema ...' end # verify the required parameter 'region' is set if @api_client.config.client_side_validation && region.nil? fail ArgumentError, "Missing the required parameter 'region' when calling AdminApi.admin_update_schema" end # verify enum value allowable_values = ["UK", "WestEurope", "Sandbox"] if @api_client.config.client_side_validation && !allowable_values.include?(region) fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}" end # resource path local_var_path = '/{region}/aim/2.0/admin/schema/UpdateSchema'.sub('{' + 'region' + '}', CGI.escape(region.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] || ['oauth2'] = opts.merge( :operation => :"AdminApi.admin_update_schema", :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: AdminApi#admin_update_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |