Class: OryClient::UpdateFedcmFlowBody

Inherits:
ApiModelBase show all
Defined in:
lib/ory-client/models/update_fedcm_flow_body.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ UpdateFedcmFlowBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
73
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
# File 'lib/ory-client/models/update_fedcm_flow_body.rb', line 68

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

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

  if attributes.key?(:'csrf_token')
    self.csrf_token = attributes[:'csrf_token']
  else
    self.csrf_token = nil
  end

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

  if attributes.key?(:'token')
    self.token = attributes[:'token']
  else
    self.token = nil
  end

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

Instance Attribute Details

#csrf_tokenObject

CSRFToken is the anti-CSRF token.



19
20
21
# File 'lib/ory-client/models/update_fedcm_flow_body.rb', line 19

def csrf_token
  @csrf_token
end

#nonceObject

Nonce is the nonce that was used in the navigator.credentials.get call. If specified, it must match the nonce claim in the token.



22
23
24
# File 'lib/ory-client/models/update_fedcm_flow_body.rb', line 22

def nonce
  @nonce
end

#tokenObject

Token contains the result of navigator.credentials.get.



25
26
27
# File 'lib/ory-client/models/update_fedcm_flow_body.rb', line 25

def token
  @token
end

#transient_payloadObject

Transient data to pass along to any webhooks.



28
29
30
# File 'lib/ory-client/models/update_fedcm_flow_body.rb', line 28

def transient_payload
  @transient_payload
end

Class Method Details

.acceptable_attribute_mapObject

Returns attribute mapping this model knows about



41
42
43
# File 'lib/ory-client/models/update_fedcm_flow_body.rb', line 41

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



46
47
48
# File 'lib/ory-client/models/update_fedcm_flow_body.rb', line 46

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_mapObject

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



31
32
33
34
35
36
37
38
# File 'lib/ory-client/models/update_fedcm_flow_body.rb', line 31

def self.attribute_map
  {
    :'csrf_token' => :'csrf_token',
    :'nonce' => :'nonce',
    :'token' => :'token',
    :'transient_payload' => :'transient_payload'
  }
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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/ory-client/models/update_fedcm_flow_body.rb', line 174

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_nullableObject

List of attributes with nullable: true



61
62
63
64
# File 'lib/ory-client/models/update_fedcm_flow_body.rb', line 61

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

.openapi_typesObject

Attribute type mapping.



51
52
53
54
55
56
57
58
# File 'lib/ory-client/models/update_fedcm_flow_body.rb', line 51

def self.openapi_types
  {
    :'csrf_token' => :'String',
    :'nonce' => :'String',
    :'token' => :'String',
    :'transient_payload' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



150
151
152
153
154
155
156
157
# File 'lib/ory-client/models/update_fedcm_flow_body.rb', line 150

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      csrf_token == o.csrf_token &&
      nonce == o.nonce &&
      token == o.token &&
      transient_payload == o.transient_payload
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


161
162
163
# File 'lib/ory-client/models/update_fedcm_flow_body.rb', line 161

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



167
168
169
# File 'lib/ory-client/models/update_fedcm_flow_body.rb', line 167

def hash
  [csrf_token, nonce, token, transient_payload].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/ory-client/models/update_fedcm_flow_body.rb', line 105

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @csrf_token.nil?
    invalid_properties.push('invalid value for "csrf_token", csrf_token cannot be nil.')
  end

  if @token.nil?
    invalid_properties.push('invalid value for "token", token cannot be nil.')
  end

  invalid_properties
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



196
197
198
199
200
201
202
203
204
205
206
207
208
# File 'lib/ory-client/models/update_fedcm_flow_body.rb', line 196

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

#valid?Boolean

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

Returns:

  • (Boolean)

    true if the model is valid



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

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @csrf_token.nil?
  return false if @token.nil?
  true
end