Class: PostfinancecheckoutRubySdk::SingleSignOnUsersService
- Inherits:
-
Object
- Object
- PostfinancecheckoutRubySdk::SingleSignOnUsersService
- Defined in:
- lib/postfinancecheckout-ruby-sdk/service/single_sign_on_users_service.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#delete_single_sign_on_users_id(id, opts = {}) ⇒ nil
Delete a single sign-on user Permanently deletes a single sign-on user.
-
#delete_single_sign_on_users_id_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Nil, response status code and response headers.
-
#get_single_sign_on_users(opts = {}) ⇒ SingleSignOnUserListResponse
List all single sign-on users.
-
#get_single_sign_on_users_id(id, opts = {}) ⇒ SingleSignOnUser
Retrieve a single sign-on user.
-
#get_single_sign_on_users_id_with_http_info(id, opts = {}) ⇒ Array<(SingleSignOnUser, Integer, Hash)>
SingleSignOnUser data, response status code and response headers.
-
#get_single_sign_on_users_search(opts = {}) ⇒ SingleSignOnUserSearchResponse
Search single sign-on users.
-
#get_single_sign_on_users_search_with_http_info(opts = {}) ⇒ Array<(SingleSignOnUserSearchResponse, Integer, Hash)>
SingleSignOnUserSearchResponse data, response status code and response headers.
-
#get_single_sign_on_users_with_http_info(opts = {}) ⇒ Array<(SingleSignOnUserListResponse, Integer, Hash)>
SingleSignOnUserListResponse data, response status code and response headers.
-
#initialize(api_client = ApiClient.default) ⇒ SingleSignOnUsersService
constructor
A new instance of SingleSignOnUsersService.
-
#patch_single_sign_on_users_id(id, single_sign_on_user_update, opts = {}) ⇒ SingleSignOnUser
Update a single sign-on user.
-
#patch_single_sign_on_users_id_with_http_info(id, single_sign_on_user_update, opts = {}) ⇒ Array<(SingleSignOnUser, Integer, Hash)>
SingleSignOnUser data, response status code and response headers.
-
#post_single_sign_on_users(single_sign_on_user_create, opts = {}) ⇒ SingleSignOnUser
Create a single sign-on user.
-
#post_single_sign_on_users_with_http_info(single_sign_on_user_create, opts = {}) ⇒ Array<(SingleSignOnUser, Integer, Hash)>
SingleSignOnUser data, response status code and response headers.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ SingleSignOnUsersService
Returns a new instance of SingleSignOnUsersService.
28 29 30 |
# File 'lib/postfinancecheckout-ruby-sdk/service/single_sign_on_users_service.rb', line 28 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
25 26 27 |
# File 'lib/postfinancecheckout-ruby-sdk/service/single_sign_on_users_service.rb', line 25 def api_client @api_client end |
Instance Method Details
#delete_single_sign_on_users_id(id, opts = {}) ⇒ nil
Delete a single sign-on user Permanently deletes a single sign-on user. It cannot be undone.
36 37 38 39 |
# File 'lib/postfinancecheckout-ruby-sdk/service/single_sign_on_users_service.rb', line 36 def delete_single_sign_on_users_id(id, opts = {}) delete_single_sign_on_users_id_with_http_info(id, opts) nil end |
#delete_single_sign_on_users_id_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Returns nil, response status code and response headers.
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/postfinancecheckout-ruby-sdk/service/single_sign_on_users_service.rb', line 47 def delete_single_sign_on_users_id_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SingleSignOnUsersService.delete_single_sign_on_users_id ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling SingleSignOnUsersService.delete_single_sign_on_users_id" end # resource path local_var_path = '/single-sign-on-users/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] # form parameters form_params = opts[:form_params] || {} # connection timeout connection_timeout = @api_client.config.timeout # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] = opts.merge( :operation => :"SingleSignOnUsersService.delete_single_sign_on_users_id", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE.to_sym.downcase, local_var_path, , connection_timeout) if @api_client.config.debugging @api_client.config.logger.debug "API called: SingleSignOnUsersService#delete_single_sign_on_users_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}" end return data, status_code, headers end |
#get_single_sign_on_users(opts = {}) ⇒ SingleSignOnUserListResponse
List all single sign-on users
103 104 105 106 |
# File 'lib/postfinancecheckout-ruby-sdk/service/single_sign_on_users_service.rb', line 103 def get_single_sign_on_users(opts = {}) data, _status_code, _headers = get_single_sign_on_users_with_http_info(opts) data end |
#get_single_sign_on_users_id(id, opts = {}) ⇒ SingleSignOnUser
Retrieve a single sign-on user
187 188 189 190 |
# File 'lib/postfinancecheckout-ruby-sdk/service/single_sign_on_users_service.rb', line 187 def get_single_sign_on_users_id(id, opts = {}) data, _status_code, _headers = get_single_sign_on_users_id_with_http_info(id, opts) data end |
#get_single_sign_on_users_id_with_http_info(id, opts = {}) ⇒ Array<(SingleSignOnUser, Integer, Hash)>
Returns SingleSignOnUser data, response status code and response headers.
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 |
# File 'lib/postfinancecheckout-ruby-sdk/service/single_sign_on_users_service.rb', line 198 def get_single_sign_on_users_id_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SingleSignOnUsersService.get_single_sign_on_users_id ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling SingleSignOnUsersService.get_single_sign_on_users_id" end # resource path local_var_path = '/single-sign-on-users/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] # form parameters form_params = opts[:form_params] || {} # connection timeout connection_timeout = @api_client.config.timeout # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'SingleSignOnUser' = opts.merge( :operation => :"SingleSignOnUsersService.get_single_sign_on_users_id", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, , connection_timeout) if @api_client.config.debugging @api_client.config.logger.debug "API called: SingleSignOnUsersService#get_single_sign_on_users_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}" end return data, status_code, headers end |
#get_single_sign_on_users_search(opts = {}) ⇒ SingleSignOnUserSearchResponse
Search single sign-on users
255 256 257 258 |
# File 'lib/postfinancecheckout-ruby-sdk/service/single_sign_on_users_service.rb', line 255 def get_single_sign_on_users_search(opts = {}) data, _status_code, _headers = get_single_sign_on_users_search_with_http_info(opts) data end |
#get_single_sign_on_users_search_with_http_info(opts = {}) ⇒ Array<(SingleSignOnUserSearchResponse, Integer, Hash)>
Returns SingleSignOnUserSearchResponse data, response status code and response headers.
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 |
# File 'lib/postfinancecheckout-ruby-sdk/service/single_sign_on_users_service.rb', line 269 def get_single_sign_on_users_search_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SingleSignOnUsersService.get_single_sign_on_users_search ...' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SingleSignOnUsersService.get_single_sign_on_users_search, must be smaller than or equal to 100.' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SingleSignOnUsersService.get_single_sign_on_users_search, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] > 10000 fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling SingleSignOnUsersService.get_single_sign_on_users_search, must be smaller than or equal to 10000.' end # resource path local_var_path = '/single-sign-on-users/search' # query parameters query_params = opts[:query_params] || {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil? query_params[:'limit'] = opts[:'limit'] unless opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] unless opts[:'offset'].nil? query_params[:'order'] = opts[:'order'] unless opts[:'order'].nil? query_params[:'query'] = opts[:'query'] unless opts[:'query'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] # form parameters form_params = opts[:form_params] || {} # connection timeout connection_timeout = @api_client.config.timeout # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'SingleSignOnUserSearchResponse' = opts.merge( :operation => :"SingleSignOnUsersService.get_single_sign_on_users_search", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, , connection_timeout) if @api_client.config.debugging @api_client.config.logger.debug "API called: SingleSignOnUsersService#get_single_sign_on_users_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}" end return data, status_code, headers end |
#get_single_sign_on_users_with_http_info(opts = {}) ⇒ Array<(SingleSignOnUserListResponse, Integer, Hash)>
Returns SingleSignOnUserListResponse data, response status code and response headers.
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/postfinancecheckout-ruby-sdk/service/single_sign_on_users_service.rb', line 117 def get_single_sign_on_users_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SingleSignOnUsersService.get_single_sign_on_users ...' end if @api_client.config.client_side_validation && !opts[:'after'].nil? && opts[:'after'] < 1 fail ArgumentError, 'invalid value for "opts[:"after"]" when calling SingleSignOnUsersService.get_single_sign_on_users, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && !opts[:'before'].nil? && opts[:'before'] < 1 fail ArgumentError, 'invalid value for "opts[:"before"]" when calling SingleSignOnUsersService.get_single_sign_on_users, must be greater than or equal to 1.' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SingleSignOnUsersService.get_single_sign_on_users, must be smaller than or equal to 100.' end if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1 fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SingleSignOnUsersService.get_single_sign_on_users, must be greater than or equal to 1.' end # resource path local_var_path = '/single-sign-on-users' # query parameters query_params = opts[:query_params] || {} query_params[:'after'] = opts[:'after'] unless opts[:'after'].nil? query_params[:'before'] = opts[:'before'] unless opts[:'before'].nil? query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil? query_params[:'limit'] = opts[:'limit'] unless opts[:'limit'].nil? query_params[:'order'] = opts[:'order'] unless opts[:'order'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] # form parameters form_params = opts[:form_params] || {} # connection timeout connection_timeout = @api_client.config.timeout # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'SingleSignOnUserListResponse' = opts.merge( :operation => :"SingleSignOnUsersService.get_single_sign_on_users", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET.to_sym.downcase, local_var_path, , connection_timeout) if @api_client.config.debugging @api_client.config.logger.debug "API called: SingleSignOnUsersService#get_single_sign_on_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}" end return data, status_code, headers end |
#patch_single_sign_on_users_id(id, single_sign_on_user_update, opts = {}) ⇒ SingleSignOnUser
Update a single sign-on user
336 337 338 339 |
# File 'lib/postfinancecheckout-ruby-sdk/service/single_sign_on_users_service.rb', line 336 def patch_single_sign_on_users_id(id, single_sign_on_user_update, opts = {}) data, _status_code, _headers = patch_single_sign_on_users_id_with_http_info(id, single_sign_on_user_update, opts) data end |
#patch_single_sign_on_users_id_with_http_info(id, single_sign_on_user_update, opts = {}) ⇒ Array<(SingleSignOnUser, Integer, Hash)>
Returns SingleSignOnUser data, response status code and response headers.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 |
# File 'lib/postfinancecheckout-ruby-sdk/service/single_sign_on_users_service.rb', line 348 def patch_single_sign_on_users_id_with_http_info(id, single_sign_on_user_update, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SingleSignOnUsersService.patch_single_sign_on_users_id ...' end # verify the required parameter 'id' is set if @api_client.config.client_side_validation && id.nil? fail ArgumentError, "Missing the required parameter 'id' when calling SingleSignOnUsersService.patch_single_sign_on_users_id" end # verify the required parameter 'single_sign_on_user_update' is set if @api_client.config.client_side_validation && single_sign_on_user_update.nil? fail ArgumentError, "Missing the required parameter 'single_sign_on_user_update' when calling SingleSignOnUsersService.patch_single_sign_on_users_id" end # resource path local_var_path = '/single-sign-on-users/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) unless content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # connection timeout connection_timeout = @api_client.config.timeout # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(single_sign_on_user_update) # return_type return_type = opts[:debug_return_type] || 'SingleSignOnUser' = opts.merge( :operation => :"SingleSignOnUsersService.patch_single_sign_on_users_id", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PATCH.to_sym.downcase, local_var_path, , connection_timeout) if @api_client.config.debugging @api_client.config.logger.debug "API called: SingleSignOnUsersService#patch_single_sign_on_users_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}" end return data, status_code, headers end |
#post_single_sign_on_users(single_sign_on_user_create, opts = {}) ⇒ SingleSignOnUser
Create a single sign-on user
411 412 413 414 |
# File 'lib/postfinancecheckout-ruby-sdk/service/single_sign_on_users_service.rb', line 411 def post_single_sign_on_users(single_sign_on_user_create, opts = {}) data, _status_code, _headers = post_single_sign_on_users_with_http_info(single_sign_on_user_create, opts) data end |
#post_single_sign_on_users_with_http_info(single_sign_on_user_create, opts = {}) ⇒ Array<(SingleSignOnUser, Integer, Hash)>
Returns SingleSignOnUser data, response status code and response headers.
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 |
# File 'lib/postfinancecheckout-ruby-sdk/service/single_sign_on_users_service.rb', line 422 def post_single_sign_on_users_with_http_info(single_sign_on_user_create, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SingleSignOnUsersService.post_single_sign_on_users ...' end # verify the required parameter 'single_sign_on_user_create' is set if @api_client.config.client_side_validation && single_sign_on_user_create.nil? fail ArgumentError, "Missing the required parameter 'single_sign_on_user_create' when calling SingleSignOnUsersService.post_single_sign_on_users" end # resource path local_var_path = '/single-sign-on-users' # query parameters query_params = opts[:query_params] || {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) unless opts[:'expand'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) unless content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # connection timeout connection_timeout = @api_client.config.timeout # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(single_sign_on_user_create) # return_type return_type = opts[:debug_return_type] || 'SingleSignOnUser' = opts.merge( :operation => :"SingleSignOnUsersService.post_single_sign_on_users", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST.to_sym.downcase, local_var_path, , connection_timeout) if @api_client.config.debugging @api_client.config.logger.debug "API called: SingleSignOnUsersService#post_single_sign_on_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}\nConnection Timeout: #{connection_timeout}" end return data, status_code, headers end |