Class: CyberSource::Boardingv1registrationsOrganizationInformation

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Boardingv1registrationsOrganizationInformation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_organization_information.rb', line 107

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

  if attributes.has_key?(:'childOrganizations')
    if (value = attributes[:'childOrganizations']).is_a?(Array)
      self.child_organizations = value
    end
  end

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

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

  if attributes.has_key?(:'configurable')
    self.configurable = attributes[:'configurable']
  else
    self.configurable = false
  end

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

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

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

Instance Attribute Details

#business_information ⇒ Object

Returns the value of attribute business_information.



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

def business_information
  @business_information
end

#child_organizations ⇒ Object

Returns the value of attribute child_organizations.



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

def child_organizations
  @child_organizations
end

#configurable ⇒ Object

This denotes the one organization, with exception to the TRANSACTING types, that is allowed to be used for configuration purposes against products. Eventually this field will be deprecated and all organizations will be allowed for product configuration.



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

def configurable
  @configurable
end

#kyc ⇒ Object

Returns the value of attribute kyc.



34
35
36
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_organization_information.rb', line 34

def kyc
  @kyc
end

#organization_id ⇒ Object

Returns the value of attribute organization_id.



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

def organization_id
  @organization_id
end

#owners ⇒ Object

Returns the value of attribute owners.



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

def owners
  @owners
end

#parent_organization_id ⇒ Object

This field is required for Organization Types: MERCHANT, TRANSACTING



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

def parent_organization_id
  @parent_organization_id
end

#status ⇒ Object

Determines the status that the organization will be after being onboarded Possible Values: - ‘LIVE’ - ‘TEST’ - ‘DRAFT’



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

def status
  @status
end

#type ⇒ Object

Determines the type of organization in the hirarchy that this registration will use to onboard this Organization Possible Values: - ‘TRANSACTING’ - ‘STRUCTURAL’ - ‘MERCHANT’



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_organization_information.rb', line 61

def self.attribute_map
  {
    :'organization_id' => :'organizationId',
    :'parent_organization_id' => :'parentOrganizationId',
    :'child_organizations' => :'childOrganizations',
    :'type' => :'type',
    :'status' => :'status',
    :'configurable' => :'configurable',
    :'business_information' => :'businessInformation',
    :'kyc' => :'KYC',
    :'owners' => :'owners'
  }
end

.json_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_organization_information.rb', line 76

def self.json_map
  {
    :'organization_id' => :'organization_id',
    :'parent_organization_id' => :'parent_organization_id',
    :'child_organizations' => :'child_organizations',
    :'type' => :'type',
    :'status' => :'status',
    :'configurable' => :'configurable',
    :'business_information' => :'business_information',
    :'kyc' => :'kyc',
    :'owners' => :'owners'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_organization_information.rb', line 91

def self.swagger_types
  {
    :'organization_id' => :'String',
    :'parent_organization_id' => :'String',
    :'child_organizations' => :'Array<String>',
    :'type' => :'String',
    :'status' => :'String',
    :'configurable' => :'BOOLEAN',
    :'business_information' => :'Boardingv1registrationsOrganizationInformationBusinessInformation',
    :'kyc' => :'Boardingv1registrationsOrganizationInformationKYC',
    :'owners' => :'Array<Boardingv1registrationsOrganizationInformationOwners>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      organization_id == o.organization_id &&
      parent_organization_id == o.parent_organization_id &&
      child_organizations == o.child_organizations &&
      type == o.type &&
      status == o.status &&
      configurable == o.configurable &&
      business_information == o.business_information &&
      kyc == o.kyc &&
      owners == o.owners
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



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
315
316
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_organization_information.rb', line 280

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



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_organization_information.rb', line 346

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



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_organization_information.rb', line 259

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


246
247
248
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_organization_information.rb', line 246

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



252
253
254
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_organization_information.rb', line 252

def hash
  [organization_id, parent_organization_id, child_organizations, type, status, configurable, business_information, kyc, owners].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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_organization_information.rb', line 158

def list_invalid_properties
  invalid_properties = Array.new
  #if !@organization_id.nil? && @organization_id !~ Regexp.new(/^[0-9a-zA-Z_]+$/)
    #invalid_properties.push('invalid value for "organization_id", must conform to the pattern /^[0-9a-zA-Z_]+$/.')
  #end

  #if !@parent_organization_id.nil? && @parent_organization_id !~ Regexp.new(/^[0-9a-zA-Z_]+$/)
    #invalid_properties.push('invalid value for "parent_organization_id", must conform to the pattern /^[0-9a-zA-Z_]+$/.')
  #end

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



326
327
328
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_organization_information.rb', line 326

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



332
333
334
335
336
337
338
339
340
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_organization_information.rb', line 332

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



320
321
322
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_organization_information.rb', line 320

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



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/cybersource_rest_client/models/boardingv1registrations_organization_information.rb', line 177

def valid?
  #return false if !@organization_id.nil? && @organization_id !~ Regexp.new(/^[0-9a-zA-Z_]+$/)
  #return false if !@parent_organization_id.nil? && @parent_organization_id !~ Regexp.new(/^[0-9a-zA-Z_]+$/)
  type_validator = EnumAttributeValidator.new('String', ['TRANSACTING', 'STRUCTURAL', 'MERCHANT'])
  return false unless type_validator.valid?(@type)
  status_validator = EnumAttributeValidator.new('String', ['LIVE', 'TEST', 'DRAFT'])
  return false unless status_validator.valid?(@status)
  return false if @business_information.nil?
  true
end