Class: OryClient::RejectOAuth2Request

Inherits:
ApiModelBase show all
Defined in:
lib/ory-client/models/reject_o_auth2_request.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 = {}) ⇒ RejectOAuth2Request

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
102
103
104
105
106
 
# File 'lib/ory-client/models/reject_o_auth2_request.rb', line 73

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OryClient::RejectOAuth2Request` 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::RejectOAuth2Request`. 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?(:'error')
    self.error = attributes[:'error']
  end

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

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

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

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

Instance Attribute Details

#error ⇒ Object

The error should follow the OAuth2 error format (e.g. invalid_request, login_required). Defaults to request_denied.



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

def error
  @error
end

#error_debug ⇒ Object

Debug contains information to help resolve the problem as a developer. Usually not exposed to the public but only in the server logs.



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

def error_debug
  @error_debug
end

#error_description ⇒ Object

Description of the error in a human readable format.



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

def error_description
  @error_description
end

#error_hint ⇒ Object

Hint to help resolve the error.



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

def error_hint
  @error_hint
end

#status_code ⇒ Object

Represents the HTTP status code of the error (e.g. 401 or 403) Defaults to 400



31
32
33
 
# File 'lib/ory-client/models/reject_o_auth2_request.rb', line 31

def status_code
  @status_code
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



45
46
47
 
# File 'lib/ory-client/models/reject_o_auth2_request.rb', line 45

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/ory-client/models/reject_o_auth2_request.rb', line 34

def self.attribute_map
  {
    :'error' => :'error',
    :'error_debug' => :'error_debug',
    :'error_description' => :'error_description',
    :'error_hint' => :'error_hint',
    :'status_code' => :'status_code'
  }
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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/ory-client/models/reject_o_auth2_request.rb', line 150

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



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

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'error' => :'String',
    :'error_debug' => :'String',
    :'error_description' => :'String',
    :'error_hint' => :'String',
    :'status_code' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



125
126
127
128
129
130
131
132
133
 
# File 'lib/ory-client/models/reject_o_auth2_request.rb', line 125

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      error == o.error &&
      error_debug == o.error_debug &&
      error_description == o.error_description &&
      error_hint == o.error_hint &&
      status_code == o.status_code
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


137
138
139
 
# File 'lib/ory-client/models/reject_o_auth2_request.rb', line 137

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



143
144
145
 
# File 'lib/ory-client/models/reject_o_auth2_request.rb', line 143

def hash
  [error, error_debug, error_description, error_hint, status_code].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



110
111
112
113
114
 
# File 'lib/ory-client/models/reject_o_auth2_request.rb', line 110

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/ory-client/models/reject_o_auth2_request.rb', line 172

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



118
119
120
121
 
# File 'lib/ory-client/models/reject_o_auth2_request.rb', line 118

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