Class: CyberSource::KmsV2KeysAsymPost201ResponseKeyInformation

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb

Overview

key information

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ KmsV2KeysAsymPost201ResponseKeyInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



90
91
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
126
127
128
129
130
131
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 90

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key

  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'organizationId')
    self.organization_id = attributes[:'organizationId']
  end

  if attributes.has_key?(:'referenceNumber')
    self.reference_number = attributes[:'referenceNumber']
  end

  if attributes.has_key?(:'keyId')
    self.key_id = attributes[:'keyId']
  end

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

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'expirationDate')
    self.expiration_date = attributes[:'expirationDate']
  end

  if attributes.has_key?(:'message')
    self.message = attributes[:'message']
  end

  if attributes.has_key?(:'alias')
    self._alias = attributes[:'alias']
  end

  if attributes.has_key?(:'errorInformation')
    self.error_information = attributes[:'errorInformation']
  end
end

Instance Attribute Details

#_aliasObject

Key alias



39
40
41
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 39

def _alias
  @_alias
end

#error_informationObject

Returns the value of attribute error_information.



41
42
43
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 41

def error_information
  @error_information
end

#expiration_dateObject

The expiration time in UTC. ‘Format: YYYY-MM-DDThh:mm:ssZ` Example 2016-08-11T22:47:57Z equals August 11, 2016, at 22:47:57 (10:47:57 p.m.). The T separates the date and the time. The Z indicates UTC.



33
34
35
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 33

def expiration_date
  @expiration_date
end

#keyObject

value of the key



27
28
29
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 27

def key
  @key
end

#key_idObject

Key Serial Number



24
25
26
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 24

def key_id
  @key_id
end

#messageObject

message in case of failed key



36
37
38
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 36

def message
  @message
end

#organization_idObject

Merchant Id



18
19
20
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 18

def organization_id
  @organization_id
end

#reference_numberObject

Reference number is a unique identifier provided by the client along with the organization Id. This is an optional field provided solely for the client’s convenience. If client specifies value for this field in the request, it is expected to be available in the response.



21
22
23
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 21

def reference_number
  @reference_number
end

#statusObject

The status of the key. Possible values: - FAILED - ACTIVE



30
31
32
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 30

def status
  @status
end

Class Method Details

.attribute_mapObject

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



44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 44

def self.attribute_map
  {
    :'organization_id' => :'organizationId',
    :'reference_number' => :'referenceNumber',
    :'key_id' => :'keyId',
    :'key' => :'key',
    :'status' => :'status',
    :'expiration_date' => :'expirationDate',
    :'message' => :'message',
    :'_alias' => :'alias',
    :'error_information' => :'errorInformation'
  }
end

.json_mapObject

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



59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 59

def self.json_map
  {
    :'organization_id' => :'organization_id',
    :'reference_number' => :'reference_number',
    :'key_id' => :'key_id',
    :'key' => :'key',
    :'status' => :'status',
    :'expiration_date' => :'expiration_date',
    :'message' => :'message',
    :'_alias' => :'_alias',
    :'error_information' => :'error_information'
  }
end

.swagger_typesObject

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 74

def self.swagger_types
  {
    :'organization_id' => :'String',
    :'reference_number' => :'String',
    :'key_id' => :'String',
    :'key' => :'String',
    :'status' => :'String',
    :'expiration_date' => :'String',
    :'message' => :'String',
    :'_alias' => :'String',
    :'error_information' => :'KmsV2KeysSymPost201ResponseErrorInformation'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



148
149
150
151
152
153
154
155
156
157
158
159
160
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 148

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      organization_id == o.organization_id &&
      reference_number == o.reference_number &&
      key_id == o.key_id &&
      key == o.key &&
      status == o.status &&
      expiration_date == o.expiration_date &&
      message == o.message &&
      _alias == o._alias &&
      error_information == o.error_information
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



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
227
228
229
230
231
232
233
234
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 198

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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

    temp_model = CyberSource.const_get(type).new
    temp_model.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



264
265
266
267
268
269
270
271
272
273
274
275
276
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 264

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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 177

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute

      # is documented as an array but the input is not

      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[key]}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional

  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


164
165
166
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 164

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



170
171
172
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 170

def hash
  [organization_id, reference_number, key_id, key, status, expiration_date, message, _alias, error_information].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



135
136
137
138
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 135

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



244
245
246
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 244

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



250
251
252
253
254
255
256
257
258
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 250

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



238
239
240
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 238

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



142
143
144
# File 'lib/cybersource_rest_client/models/kms_v2_keys_asym_post201_response_key_information.rb', line 142

def valid?
  true
end