Class: OryClient::OAuth2TokenExchange

Inherits:
Object
  • Object
show all
Defined in:
lib/ory-client/models/o_auth2_token_exchange.rb

Overview

OAuth2 Token Exchange Result

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OAuth2TokenExchange

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 74

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryClient::OAuth2TokenExchange` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OryClient::OAuth2TokenExchange`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'access_token')
    self.access_token = attributes[:'access_token']
  end

  if attributes.key?(:'expires_in')
    self.expires_in = attributes[:'expires_in']
  end

  if attributes.key?(:'id_token')
    self.id_token = attributes[:'id_token']
  end

  if attributes.key?(:'refresh_token')
    self.refresh_token = attributes[:'refresh_token']
  end

  if attributes.key?(:'scope')
    self.scope = attributes[:'scope']
  end

  if attributes.key?(:'token_type')
    self.token_type = attributes[:'token_type']
  end
end

Instance Attribute Details

#access_token ⇒ Object

The access token issued by the authorization server.



20
21
22
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 20

def access_token
  @access_token
end

#expires_in ⇒ Object

The lifetime in seconds of the access token. For example, the value "3600" denotes that the access token will expire in one hour from the time the response was generated.



23
24
25
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 23

def expires_in
  @expires_in
end

#id_token ⇒ Object

To retrieve a refresh token request the id_token scope.



26
27
28
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 26

def id_token
  @id_token
end

#refresh_token ⇒ Object

The refresh token, which can be used to obtain new access tokens. To retrieve it add the scope "offline" to your access token request.



29
30
31
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 29

def refresh_token
  @refresh_token
end

#scope ⇒ Object

The scope of the access token



32
33
34
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 32

def scope
  @scope
end

#token_type ⇒ Object

The type of the token issued



35
36
37
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 35

def token_type
  @token_type
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 179

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = OryClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



50
51
52
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 50

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 38

def self.attribute_map
  {
    :'access_token' => :'access_token',
    :'expires_in' => :'expires_in',
    :'id_token' => :'id_token',
    :'refresh_token' => :'refresh_token',
    :'scope' => :'scope',
    :'token_type' => :'token_type'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 155

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
70
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 67

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 55

def self.openapi_types
  {
    :'access_token' => :'String',
    :'expires_in' => :'Integer',
    :'id_token' => :'String',
    :'refresh_token' => :'String',
    :'scope' => :'String',
    :'token_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



129
130
131
132
133
134
135
136
137
138
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 129

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_token == o.access_token &&
      expires_in == o.expires_in &&
      id_token == o.id_token &&
      refresh_token == o.refresh_token &&
      scope == o.scope &&
      token_type == o.token_type
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 250

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


142
143
144
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 142

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



148
149
150
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 148

def hash
  [access_token, expires_in, id_token, refresh_token, scope, token_type].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



114
115
116
117
118
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 114

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



226
227
228
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 226

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 232

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



220
221
222
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 220

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



122
123
124
125
 
# File 'lib/ory-client/models/o_auth2_token_exchange.rb', line 122

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end