Class: MergeTicketingClient::ModelOperation

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ticketing_client/models/model_operation.rb

Overview

# The ModelOperation Object ### Description The ‘ModelOperation` object is used to represent the operations that are currently supported for a given model. ### Usage Example View what operations are supported for the `Candidate` endpoint.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ModelOperation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



60
61
62
63
64
65
66
67
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
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 60

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

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

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

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

Instance Attribute Details

#available_operations ⇒ Object

Returns the value of attribute available_operations.



21
22
23
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 21

def available_operations
  @available_operations
end

#model_name ⇒ Object

Returns the value of attribute model_name.



19
20
21
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 19

def model_name
  @model_name
end

#required_post_parameters ⇒ Object

Returns the value of attribute required_post_parameters.



23
24
25
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 23

def required_post_parameters
  @required_post_parameters
end

#supported_fields ⇒ Object

Returns the value of attribute supported_fields.



25
26
27
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 25

def supported_fields
  @supported_fields
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



38
39
40
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 38

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 28

def self.attribute_map
  {
    :'model_name' => :'model_name',
    :'available_operations' => :'available_operations',
    :'required_post_parameters' => :'required_post_parameters',
    :'supported_fields' => :'supported_fields'
  }
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
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 155

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



53
54
55
56
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 53

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

.openapi_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 43

def self.openapi_types
  {
    :'model_name' => :'String',
    :'available_operations' => :'Array<String>',
    :'required_post_parameters' => :'Array<String>',
    :'supported_fields' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



131
132
133
134
135
136
137
138
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 131

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      model_name == o.model_name &&
      available_operations == o.available_operations &&
      required_post_parameters == o.required_post_parameters &&
      supported_fields == o.supported_fields
end

#_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



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
217
218
219
220
221
222
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 185

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value
  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 = MergeTicketingClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
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



256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 256

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

#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



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 162

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


142
143
144
 
# File 'lib/merge_ticketing_client/models/model_operation.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/merge_ticketing_client/models/model_operation.rb', line 148

def hash
  [model_name, available_operations, required_post_parameters, supported_fields].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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 98

def list_invalid_properties
  invalid_properties = Array.new
  if @model_name.nil?
    invalid_properties.push('invalid value for "model_name", model_name cannot be nil.')
  end

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

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

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

  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



232
233
234
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 232

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



238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 238

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



226
227
228
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 226

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



121
122
123
124
125
126
127
 
# File 'lib/merge_ticketing_client/models/model_operation.rb', line 121

def valid?
  return false if @model_name.nil?
  return false if @available_operations.nil?
  return false if @required_post_parameters.nil?
  return false if @supported_fields.nil?
  true
end