Class: MailSafePro::APIKeyListResponse

Inherits:
ApiModelBase show all
Defined in:
lib/mailsafepro/models/api_key_list_response.rb

Overview

API Key list response

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
95
96
97
 
# File 'lib/mailsafepro/models/api_key_list_response.rb', line 64

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

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

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

Instance Attribute Details

#active_count ⇒ Object

Number of active keys



26
27
28
 
# File 'lib/mailsafepro/models/api_key_list_response.rb', line 26

def active_count
  @active_count
end

#keys ⇒ Object

List of API keys



20
21
22
 
# File 'lib/mailsafepro/models/api_key_list_response.rb', line 20

def keys
  @keys
end

#total_count ⇒ Object

Total number of keys



23
24
25
 
# File 'lib/mailsafepro/models/api_key_list_response.rb', line 23

def total_count
  @total_count
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



38
39
40
 
# File 'lib/mailsafepro/models/api_key_list_response.rb', line 38

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



43
44
45
 
# File 'lib/mailsafepro/models/api_key_list_response.rb', line 43

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
 
# File 'lib/mailsafepro/models/api_key_list_response.rb', line 29

def self.attribute_map
  {
    :'keys' => :'keys',
    :'total_count' => :'total_count',
    :'active_count' => :'active_count'
  }
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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/mailsafepro/models/api_key_list_response.rb', line 202

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



57
58
59
60
 
# File 'lib/mailsafepro/models/api_key_list_response.rb', line 57

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

.openapi_types ⇒ Object

Attribute type mapping.



48
49
50
51
52
53
54
 
# File 'lib/mailsafepro/models/api_key_list_response.rb', line 48

def self.openapi_types
  {
    :'keys' => :'Array<APIKeyMeta>',
    :'total_count' => :'Integer',
    :'active_count' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



179
180
181
182
183
184
185
 
# File 'lib/mailsafepro/models/api_key_list_response.rb', line 179

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      keys == o.keys &&
      total_count == o.total_count &&
      active_count == o.active_count
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


189
190
191
 
# File 'lib/mailsafepro/models/api_key_list_response.rb', line 189

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



195
196
197
 
# File 'lib/mailsafepro/models/api_key_list_response.rb', line 195

def hash
  [keys, total_count, active_count].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



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/mailsafepro/models/api_key_list_response.rb', line 101

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

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

  if @total_count < 0
    invalid_properties.push('invalid value for "total_count", must be greater than or equal to 0.')
  end

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

  if @active_count < 0
    invalid_properties.push('invalid value for "active_count", must be greater than or equal to 0.')
  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



224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/mailsafepro/models/api_key_list_response.rb', line 224

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



129
130
131
132
133
134
135
136
137
 
# File 'lib/mailsafepro/models/api_key_list_response.rb', line 129

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @keys.nil?
  return false if @total_count.nil?
  return false if @total_count < 0
  return false if @active_count.nil?
  return false if @active_count < 0
  true
end