Class: Bfwd::UsernamesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/api/usernames_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsernamesApi

Returns a new instance of UsernamesApi.



19
20
21
 
# File 'lib/bf_ruby2/api/usernames_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/bf_ruby2/api/usernames_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_username(username, opts = {}) ⇒ UsernamePagedMetadata

Create a username. Bfwd::UsernamesApi."nickname":"Create","request":"createUsernameRequest.html","response":"createUsernameResponse"nickname":"Create","request":"createUsernameRequest.html","response":"createUsernameResponse.html"

Parameters:

  • username —

    The username object to be created.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# 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 = {}) ⇒ Array<(UsernamePagedMetadata, Fixnum, Hash)>

Create a username. Bfwd::UsernamesApi.&quot;nickname&quot;:&quot;Create&quot;,&quot;request&quot;:&quot;createUsernameRequest.html&quot;,&quot;response&quot;:&quot;createUsernameResponse&quot;nickname&quot;:&quot;Create&quot;,&quot;request&quot;:&quot;createUsernameRequest.html&quot;,&quot;response&quot;:&quot;createUsernameResponse.html&quot;

Parameters:

  • username —

    The username object to be created.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(UsernamePagedMetadata, Fixnum, Hash)>) —

    UsernamePagedMetadata data, response status code and response headers



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
 
# 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