Class: WalmartApIs::TokenResponse

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/walmart_ap_is/models/token_response.rb

Overview

TokenResponse 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(access_token:, expires_in:, refresh_token: SKIP, scope: SKIP, additional_properties: nil) ⇒ TokenResponse

Returns a new instance of TokenResponse.



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/walmart_ap_is/models/token_response.rb', line 59

def initialize(access_token:, expires_in:, refresh_token: SKIP, scope: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @access_token = access_token
  @token_type = 'Bearer'
  @expires_in = expires_in
  @refresh_token = refresh_token unless refresh_token == SKIP
  @scope = scope unless scope == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#access_token ⇒ String

Opaque Bearer access token. Treat as a secret; never log.

Returns:

  • (String) 


14
15
16
 
# File 'lib/walmart_ap_is/models/token_response.rb', line 14

def access_token
  @access_token
end

#expires_in ⇒ Integer

Access-token lifetime in seconds (≈900 today).

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/walmart_ap_is/models/token_response.rb', line 22

def expires_in
  @expires_in
end

#refresh_token ⇒ String

Rotated refresh token — replaces the one presented (OAuth 2.1 §4.3.1). Present only on delegated grants when offline_access was granted. Treat as a secret; never log.

Returns:

  • (String) 


28
29
30
 
# File 'lib/walmart_ap_is/models/token_response.rb', line 28

def refresh_token
  @refresh_token
end

#scope ⇒ String

Space-delimited granted scopes; present on delegated grants when narrowed from the original grant.

Returns:

  • (String) 


33
34
35
 
# File 'lib/walmart_ap_is/models/token_response.rb', line 33

def scope
  @scope
end

#token_type ⇒ String (readonly)

Always Bearer (RFC 6750).

Returns:

  • (String) 


18
19
20
 
# File 'lib/walmart_ap_is/models/token_response.rb', line 18

def token_type
  @token_type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/walmart_ap_is/models/token_response.rb', line 73

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  access_token = hash.key?('access_token') ? hash['access_token'] : nil
  expires_in = hash.key?('expires_in') ? hash['expires_in'] : nil
  refresh_token = hash.key?('refresh_token') ? hash['refresh_token'] : SKIP
  scope = hash.key?('scope') ? hash['scope'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  TokenResponse.new(access_token: access_token,
                    expires_in: expires_in,
                    refresh_token: refresh_token,
                    scope: scope,
                    additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



36
37
38
39
40
41
42
43
44
 
# File 'lib/walmart_ap_is/models/token_response.rb', line 36

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['access_token'] = 'access_token'
  @_hash['token_type'] = 'token_type'
  @_hash['expires_in'] = 'expires_in'
  @_hash['refresh_token'] = 'refresh_token'
  @_hash['scope'] = 'scope'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



55
56
57
 
# File 'lib/walmart_ap_is/models/token_response.rb', line 55

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



47
48
49
50
51
52
 
# File 'lib/walmart_ap_is/models/token_response.rb', line 47

def self.optionals
  %w[
    refresh_token
    scope
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



106
107
108
109
110
111
 
# File 'lib/walmart_ap_is/models/token_response.rb', line 106

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} access_token: #{@access_token.inspect}, token_type: #{@token_type.inspect},"\
  " expires_in: #{@expires_in.inspect}, refresh_token: #{@refresh_token.inspect}, scope:"\
  " #{@scope.inspect}, additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



98
99
100
101
102
103
 
# File 'lib/walmart_ap_is/models/token_response.rb', line 98

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} access_token: #{@access_token}, token_type: #{@token_type}, expires_in:"\
  " #{@expires_in}, refresh_token: #{@refresh_token}, scope: #{@scope}, additional_properties:"\
  " #{@additional_properties}>"
end