Class: CyberSource::Boardingv1registrationsRegistrationInformation

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Boardingv1registrationsRegistrationInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 97

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?(:'boardingRegistrationId')
    self.boarding_registration_id = attributes[:'boardingRegistrationId']
  end

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

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

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

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

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

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

Instance Attribute Details

#boarding_flow ⇒ Object

Determines the boarding flow for this registration. Possible Values: - ‘ENTERPRISE’ - ‘SMB’ - ‘ADDPRODUCT’



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

def boarding_flow
  @boarding_flow
end

#boarding_package_id ⇒ Object

Returns the value of attribute boarding_package_id.



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

def boarding_package_id
  @boarding_package_id
end

#boarding_registration_id ⇒ Object

Returns the value of attribute boarding_registration_id.



16
17
18
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 16

def boarding_registration_id
  @boarding_registration_id
end

#mode ⇒ Object

In case mode is not provided the API will use COMPLETE as default Possible Values: - ‘COMPLETE’ - ‘PARTIAL’



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

def mode
  @mode
end

#sales_rep_id ⇒ Object

Returns the value of attribute sales_rep_id.



32
33
34
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 32

def sales_rep_id
  @sales_rep_id
end

#status ⇒ Object

The status of Registration request Possible Values: - ‘PROCESSING’: This status is for Registrations that are still in Progress, you can get the latest status by calling the GET endpoint using the Registration Id - ‘SUCCESS’: This status is for Registrations that were successfull on every step of the on boarding process. - ‘FAILURE’: This status is for Registrations that fail before the Organization was created; please refer to the details section in the reponse for more information. - ‘PARTIAL’: This status is for Registrations that created the Organization successfully but fail in at least on step while configuring it; please refer to the details section in the response for more information.



22
23
24
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 22

def status
  @status
end

#submit_time_utc ⇒ Object

Time of request 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.



19
20
21
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 19

def submit_time_utc
  @submit_time_utc
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 57

def self.attribute_map
  {
    :'boarding_registration_id' => :'boardingRegistrationId',
    :'submit_time_utc' => :'submitTimeUtc',
    :'status' => :'status',
    :'boarding_package_id' => :'boardingPackageId',
    :'boarding_flow' => :'boardingFlow',
    :'mode' => :'mode',
    :'sales_rep_id' => :'salesRepId'
  }
end

.json_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 70

def self.json_map
  {
    :'boarding_registration_id' => :'boarding_registration_id',
    :'submit_time_utc' => :'submit_time_utc',
    :'status' => :'status',
    :'boarding_package_id' => :'boarding_package_id',
    :'boarding_flow' => :'boarding_flow',
    :'mode' => :'mode',
    :'sales_rep_id' => :'sales_rep_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 83

def self.swagger_types
  {
    :'boarding_registration_id' => :'String',
    :'submit_time_utc' => :'Date',
    :'status' => :'String',
    :'boarding_package_id' => :'String',
    :'boarding_flow' => :'String',
    :'mode' => :'String',
    :'sales_rep_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 201

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      boarding_registration_id == o.boarding_registration_id &&
      submit_time_utc == o.submit_time_utc &&
      status == o.status &&
      boarding_package_id == o.boarding_package_id &&
      boarding_flow == o.boarding_flow &&
      mode == o.mode &&
      sales_rep_id == o.sales_rep_id
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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 249

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



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 315

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 228

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


215
216
217
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 215

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



221
222
223
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 221

def hash
  [boarding_registration_id, submit_time_utc, status, boarding_package_id, boarding_flow, mode, sales_rep_id].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



134
135
136
137
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 134

def list_invalid_properties
  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



295
296
297
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 295

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



301
302
303
304
305
306
307
308
309
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 301

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



289
290
291
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 289

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



141
142
143
144
145
146
147
148
149
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_registration_information.rb', line 141

def valid?
  status_validator = EnumAttributeValidator.new('String', ['PROCESSING', 'SUCCESS', 'FAILURE', 'PARTIAL'])
  return false unless status_validator.valid?(@status)
  boarding_flow_validator = EnumAttributeValidator.new('String', ['ENTERPRISE', 'SMB', 'ADDPRODUCT'])
  return false unless boarding_flow_validator.valid?(@boarding_flow)
  mode_validator = EnumAttributeValidator.new('String', ['COMPLETE', 'PARTIAL'])
  return false unless mode_validator.valid?(@mode)
  true
end