Class: ElasticEmail::ApiKeyPayload

Inherits:
Object
  • Object
show all
Defined in:
lib/ElasticEmail/models/api_key_payload.rb

Overview

Create a new ApiKey

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApiKeyPayload

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
102
103
104
105
106
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 70

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

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

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

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

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

Instance Attribute Details

#access_level ⇒ Object

Access level or permission to be assigned to this ApiKey.



23
24
25
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 23

def access_level
  @access_level
end

#expires ⇒ Object

Date this ApiKey expires.



26
27
28
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 26

def expires
  @expires
end

#name ⇒ Object

Name of the ApiKey for ease of reference.



20
21
22
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 20

def name
  @name
end

#restrict_access_to_ip_range ⇒ Object

Which IPs can use this ApiKey



29
30
31
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 29

def restrict_access_to_ip_range
  @restrict_access_to_ip_range
end

#subaccount ⇒ Object

Email of the subaccount for which this ApiKey should be created



32
33
34
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 32

def subaccount
  @subaccount
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



46
47
48
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 46

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 35

def self.attribute_map
  {
    :'name' => :'Name',
    :'access_level' => :'AccessLevel',
    :'expires' => :'Expires',
    :'restrict_access_to_ip_range' => :'RestrictAccessToIPRange',
    :'subaccount' => :'Subaccount'
  }
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



158
159
160
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 158

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
66
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 62

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

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 51

def self.openapi_types
  {
    :'name' => :'String',
    :'access_level' => :'Array<AccessLevel>',
    :'expires' => :'Time',
    :'restrict_access_to_ip_range' => :'Array<String>',
    :'subaccount' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



133
134
135
136
137
138
139
140
141
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 133

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      access_level == o.access_level &&
      expires == o.expires &&
      restrict_access_to_ip_range == o.restrict_access_to_ip_range &&
      subaccount == o.subaccount
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



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
223
224
225
226
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 189

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  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 = ElasticEmail.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



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 260

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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 165

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  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


145
146
147
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 145

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



151
152
153
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 151

def hash
  [name, access_level, expires, restrict_access_to_ip_range, subaccount].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
115
116
117
118
119
120
121
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 110

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

  if @access_level.nil?
    invalid_properties.push('invalid value for "access_level", access_level 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



236
237
238
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 236

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



242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 242

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



230
231
232
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 230

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



125
126
127
128
129
 
# File 'lib/ElasticEmail/models/api_key_payload.rb', line 125

def valid?
  return false if @name.nil?
  return false if @access_level.nil?
  true
end