Class: LoyaltyApIs::ClientAuthTokenRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/loyalty_ap_is/models/client_auth_token_request.rb

Overview

ClientAuthTokenRequest Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(client_id:, client_secret:, grant_type:) ⇒ ClientAuthTokenRequest

Returns a new instance of ClientAuthTokenRequest.



43
44
45
46
47
 
# File 'lib/loyalty_ap_is/models/client_auth_token_request.rb', line 43

def initialize(client_id:, client_secret:, grant_type:)
  @client_id = client_id
  @client_secret = client_secret
  @grant_type = grant_type
end

Instance Attribute Details

#client_id ⇒ String

Client ID provided by Shell

Returns:

  • (String) 


14
15
16
 
# File 'lib/loyalty_ap_is/models/client_auth_token_request.rb', line 14

def client_id
  @client_id
end

#client_secret ⇒ String

Client Secret provided by Shell

Returns:

  • (String) 


18
19
20
 
# File 'lib/loyalty_ap_is/models/client_auth_token_request.rb', line 18

def client_secret
  @client_secret
end

#grant_type ⇒ String

Grant type value for access

Returns:

  • (String) 


22
23
24
 
# File 'lib/loyalty_ap_is/models/client_auth_token_request.rb', line 22

def grant_type
  @grant_type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/loyalty_ap_is/models/client_auth_token_request.rb', line 50

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  client_id = hash.key?('client_id') ? hash['client_id'] : nil
  client_secret = hash.key?('client_secret') ? hash['client_secret'] : nil
  grant_type = hash.key?('grant_type') ? hash['grant_type'] : nil

  # Create object from extracted values.
  ClientAuthTokenRequest.new(client_id: client_id,
                             client_secret: client_secret,
                             grant_type: grant_type)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/loyalty_ap_is/models/client_auth_token_request.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['client_id'] = 'client_id'
  @_hash['client_secret'] = 'client_secret'
  @_hash['grant_type'] = 'grant_type'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



39
40
41
 
# File 'lib/loyalty_ap_is/models/client_auth_token_request.rb', line 39

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
 
# File 'lib/loyalty_ap_is/models/client_auth_token_request.rb', line 34

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



72
73
74
75
76
 
# File 'lib/loyalty_ap_is/models/client_auth_token_request.rb', line 72

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} client_id: #{@client_id.inspect}, client_secret: #{@client_secret.inspect},"\
  " grant_type: #{@grant_type.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



65
66
67
68
69
 
# File 'lib/loyalty_ap_is/models/client_auth_token_request.rb', line 65

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} client_id: #{@client_id}, client_secret: #{@client_secret}, grant_type:"\
  " #{@grant_type}>"
end