Class: OryClient::JsonPatch

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

Overview

A JSONPatch document as defined by RFC 6902

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ JsonPatch

Initializes the object

Parameters:

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

    Model attributes in the form of hash



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/ory-client/models/json_patch.rb', line 92

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

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

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

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

Instance Attribute Details

#from ⇒ Object

This field is used together with operation "move" and uses JSON Pointer notation. Learn more [about JSON Pointers](datatracker.ietf.org/doc/html/rfc6901#section-5).



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

def from
  @from
end

#op ⇒ Object

The operation to be performed. One of "add", "remove", "replace", "move", "copy", or "test".



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

def op
  @op
end

#path ⇒ Object

The path to the target path. Uses JSON pointer notation. Learn more [about JSON Pointers](datatracker.ietf.org/doc/html/rfc6901#section-5).



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

def path
  @path
end

#value ⇒ Object

The value to be used within the operations. Learn more [about JSON Pointers](datatracker.ietf.org/doc/html/rfc6901#section-5).



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

def value
  @value
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



64
65
66
 
# File 'lib/ory-client/models/json_patch.rb', line 64

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



69
70
71
 
# File 'lib/ory-client/models/json_patch.rb', line 69

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'from' => :'from',
    :'op' => :'op',
    :'path' => :'path',
    :'value' => :'value'
  }
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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/ory-client/models/json_patch.rb', line 200

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



84
85
86
87
88
 
# File 'lib/ory-client/models/json_patch.rb', line 84

def self.openapi_nullable
  Set.new([
    :'value'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
 
# File 'lib/ory-client/models/json_patch.rb', line 74

def self.openapi_types
  {
    :'from' => :'String',
    :'op' => :'String',
    :'path' => :'String',
    :'value' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



176
177
178
179
180
181
182
183
 
# File 'lib/ory-client/models/json_patch.rb', line 176

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      from == o.from &&
      op == o.op &&
      path == o.path &&
      value == o.value
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


187
188
189
 
# File 'lib/ory-client/models/json_patch.rb', line 187

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



193
194
195
 
# File 'lib/ory-client/models/json_patch.rb', line 193

def hash
  [from, op, path, value].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



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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/ory-client/models/json_patch.rb', line 222

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



145
146
147
148
149
150
151
152
 
# File 'lib/ory-client/models/json_patch.rb', line 145

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @op.nil?
  op_validator = EnumAttributeValidator.new('String', ["add", "remove", "replace", "move", "copy", "test"])
  return false unless op_validator.valid?(@op)
  return false if @path.nil?
  true
end