class Bfwd::UsernamesApi
Attributes
api_client[RW]
Public Class Methods
new(api_client = ApiClient.default)
click to toggle source
# File lib/bf_ruby2/api/usernames_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
create_username(username, opts = {})
click to toggle source
Create a username. {"nickname":"Create","request":"createUsernameRequest.html","response":"createUsernameResponse.html"} @param username The username object to be created. @param [Hash] opts the optional parameters @return [UsernamePagedMetadata]
# File lib/bf_ruby2/api/usernames_api.rb, line 28 def create_username(username, opts = {}) data, _status_code, _headers = create_username_with_http_info(username, opts) return data end
create_username_with_http_info(username, opts = {})
click to toggle source
Create a username. {"nickname":"Create","request":"createUsernameRequest.html","response":"createUsernameResponse.html"} @param username The username object to be created. @param [Hash] opts the optional parameters @return [Array<(UsernamePagedMetadata
, Fixnum, Hash)>] UsernamePagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/usernames_api.rb, line 38 def create_username_with_http_info(username, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: UsernamesApi.create_username ..." end # verify the required parameter 'username' is set if @api_client.config.client_side_validation && username.nil? fail ArgumentError, "Missing the required parameter 'username' when calling UsernamesApi.create_username" end # resource path local_var_path = "/usernames" # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(username) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UsernamePagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: UsernamesApi#create_username\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end