Class: CtdDocumentation::Authenticate

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/ctd_documentation/models/authenticate.rb

Overview

Authenticate Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(username = nil, password = nil) ⇒ Authenticate

Returns a new instance of Authenticate.



38
39
40
41
42
 
# File 'lib/ctd_documentation/models/authenticate.rb', line 38

def initialize(username = nil,
               password = nil)
  @username = username
  @password = password
end

Instance Attribute Details

#password ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


18
19
20
 
# File 'lib/ctd_documentation/models/authenticate.rb', line 18

def password
  @password
end

#username ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


14
15
16
 
# File 'lib/ctd_documentation/models/authenticate.rb', line 14

def username
  @username
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/ctd_documentation/models/authenticate.rb', line 45

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  username = hash.key?('username') ? hash['username'] : nil
  password = hash.key?('password') ? hash['password'] : nil

  # Create object from extracted values.

  Authenticate.new(username,
                   password)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/ctd_documentation/models/authenticate.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['username'] = 'username'
  @_hash['password'] = 'password'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



34
35
36
 
# File 'lib/ctd_documentation/models/authenticate.rb', line 34

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
 
# File 'lib/ctd_documentation/models/authenticate.rb', line 29

def self.optionals
  []
end