Class: KatapultAPI::Certificate

Inherits:
Object
  • Object
show all
Defined in:
lib/katapult-ruby/models/certificate.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Certificate

Initializes the object

Parameters:

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

    Model attributes in the form of hash



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/katapult-ruby/models/certificate.rb', line 130

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_names ⇒ Object

Returns the value of attribute additional_names.



22
23
24
 
# File 'lib/katapult-ruby/models/certificate.rb', line 22

def additional_names
  @additional_names
end

#authorization_method ⇒ Object

Returns the value of attribute authorization_method.



36
37
38
 
# File 'lib/katapult-ruby/models/certificate.rb', line 36

def authorization_method
  @authorization_method
end

#certificate ⇒ Object

Returns the value of attribute certificate.



41
42
43
 
# File 'lib/katapult-ruby/models/certificate.rb', line 41

def certificate
  @certificate
end

#certificate_api_url ⇒ Object

This is the URL that can be used to access this certificate’s details. through the certificate API (a different API to this one). If null, this means that it is no longer available. If that is the case, you can get a new URL by resetting the API token for this certificate.



39
40
41
 
# File 'lib/katapult-ruby/models/certificate.rb', line 39

def certificate_api_url
  @certificate_api_url
end

#chain ⇒ Object

Returns the value of attribute chain.



43
44
45
 
# File 'lib/katapult-ruby/models/certificate.rb', line 43

def chain
  @chain
end

#created_at ⇒ Object

Returns the value of attribute created_at.



28
29
30
 
# File 'lib/katapult-ruby/models/certificate.rb', line 28

def created_at
  @created_at
end

#expires_at ⇒ Object

Returns the value of attribute expires_at.



30
31
32
 
# File 'lib/katapult-ruby/models/certificate.rb', line 30

def expires_at
  @expires_at
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/katapult-ruby/models/certificate.rb', line 18

def id
  @id
end

#issue_error ⇒ Object

Returns the value of attribute issue_error.



34
35
36
 
# File 'lib/katapult-ruby/models/certificate.rb', line 34

def issue_error
  @issue_error
end

#issuer ⇒ Object

Returns the value of attribute issuer.



24
25
26
 
# File 'lib/katapult-ruby/models/certificate.rb', line 24

def issuer
  @issuer
end

#last_issued_at ⇒ Object

Returns the value of attribute last_issued_at.



32
33
34
 
# File 'lib/katapult-ruby/models/certificate.rb', line 32

def last_issued_at
  @last_issued_at
end

#name ⇒ Object

Returns the value of attribute name.



20
21
22
 
# File 'lib/katapult-ruby/models/certificate.rb', line 20

def name
  @name
end

#private_key ⇒ Object

Returns the value of attribute private_key.



45
46
47
 
# File 'lib/katapult-ruby/models/certificate.rb', line 45

def private_key
  @private_key
end

#state ⇒ Object

Returns the value of attribute state.



26
27
28
 
# File 'lib/katapult-ruby/models/certificate.rb', line 26

def state
  @state
end

Class Method Details

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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/katapult-ruby/models/certificate.rb', line 277

def self._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 = KatapultAPI.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



90
91
92
 
# File 'lib/katapult-ruby/models/certificate.rb', line 90

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/katapult-ruby/models/certificate.rb', line 70

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'additional_names' => :'additional_names',
    :'issuer' => :'issuer',
    :'state' => :'state',
    :'created_at' => :'created_at',
    :'expires_at' => :'expires_at',
    :'last_issued_at' => :'last_issued_at',
    :'issue_error' => :'issue_error',
    :'authorization_method' => :'authorization_method',
    :'certificate_api_url' => :'certificate_api_url',
    :'certificate' => :'certificate',
    :'chain' => :'chain',
    :'private_key' => :'private_key'
  }
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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/katapult-ruby/models/certificate.rb', line 253

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



115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/katapult-ruby/models/certificate.rb', line 115

def self.openapi_nullable
  Set.new([
    :'expires_at',
    :'last_issued_at',
    :'issue_error',
    :'authorization_method',
    :'certificate_api_url',
    :'certificate',
    :'chain',
    :'private_key'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/katapult-ruby/models/certificate.rb', line 95

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'additional_names' => :'Array<String>',
    :'issuer' => :'IssuerEnum',
    :'state' => :'CertificateStateEnum',
    :'created_at' => :'Integer',
    :'expires_at' => :'Integer',
    :'last_issued_at' => :'Integer',
    :'issue_error' => :'String',
    :'authorization_method' => :'String',
    :'certificate_api_url' => :'String',
    :'certificate' => :'String',
    :'chain' => :'String',
    :'private_key' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/katapult-ruby/models/certificate.rb', line 219

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      additional_names == o.additional_names &&
      issuer == o.issuer &&
      state == o.state &&
      created_at == o.created_at &&
      expires_at == o.expires_at &&
      last_issued_at == o.last_issued_at &&
      issue_error == o.issue_error &&
      authorization_method == o.authorization_method &&
      certificate_api_url == o.certificate_api_url &&
      certificate == o.certificate &&
      chain == o.chain &&
      private_key == o.private_key
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



348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/katapult-ruby/models/certificate.rb', line 348

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


240
241
242
 
# File 'lib/katapult-ruby/models/certificate.rb', line 240

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



246
247
248
 
# File 'lib/katapult-ruby/models/certificate.rb', line 246

def hash
  [id, name, additional_names, issuer, state, created_at, expires_at, last_issued_at, issue_error, authorization_method, certificate_api_url, certificate, chain, private_key].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



204
205
206
207
208
 
# File 'lib/katapult-ruby/models/certificate.rb', line 204

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



324
325
326
 
# File 'lib/katapult-ruby/models/certificate.rb', line 324

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



330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/katapult-ruby/models/certificate.rb', line 330

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



318
319
320
 
# File 'lib/katapult-ruby/models/certificate.rb', line 318

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



212
213
214
215
 
# File 'lib/katapult-ruby/models/certificate.rb', line 212

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