Class: Yapstone::BusinessApplicantAdminResource

Inherits:
Object
  • Object
show all
Defined in:
lib/yapstone-so/models/business_applicant_admin_resource.rb

Overview

The Business Applicant resource.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BusinessApplicantAdminResource

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
201
202
203
204
205
206
207
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 117

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'no_post_booking')
    self.no_post_booking = attributes[:'no_post_booking']
  else
    self.no_post_booking = false
  end

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

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

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

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

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

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

Instance Attribute Details

#additional_owners ⇒ Object

A list of additional beneficial owners



57
58
59
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 57

def additional_owners
  @additional_owners
end

#auto_graduated ⇒ Object

value for graduation policy



60
61
62
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 60

def auto_graduated
  @auto_graduated
end

#brand ⇒ Object

brand id



37
38
39
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 37

def brand
  @brand
end

#business_profile ⇒ Object

Returns the value of attribute business_profile.



52
53
54
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 52

def business_profile
  @business_profile
end

#consents ⇒ Object

Returns the value of attribute consents.



39
40
41
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 39

def consents
  @consents
end

#external_id ⇒ Object

The partners externalId id for the Applicant.



26
27
28
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 26

def external_id
  @external_id
end

#id ⇒ Object

The resource identifier for the applicant.



19
20
21
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 19

def id
  @id
end

#language ⇒ Object

supported language



34
35
36
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 34

def language
  @language
end

#mkt_place_applicant ⇒ Object

Returns the value of attribute mkt_place_applicant.



28
29
30
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 28

def mkt_place_applicant
  @mkt_place_applicant
end

#no_post_booking ⇒ Object

At the time of creation, value is defaulted to False.



45
46
47
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 45

def no_post_booking
  @no_post_booking
end

#primary_contact ⇒ Object

Returns the value of attribute primary_contact.



50
51
52
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 50

def primary_contact
  @primary_contact
end

#principal_owner ⇒ Object

Returns the value of attribute principal_owner.



54
55
56
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 54

def principal_owner
  @principal_owner
end

#products ⇒ Object

Products requested by marketplace.



48
49
50
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 48

def products
  @products
end

#reporting_tag ⇒ Object

The reportingTag for the applicant.



42
43
44
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 42

def reporting_tag
  @reporting_tag
end

#social_networks ⇒ Object

A list of social networks the applicant belongs to.



31
32
33
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 31

def social_networks
  @social_networks
end

#status ⇒ Object

Returns the value of attribute status.



21
22
23
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 21

def status
  @status
end

#type ⇒ Object

Returns the value of attribute type.



23
24
25
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 23

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 63

def self.attribute_map
  {
    :'id' => :'id',
    :'status' => :'status',
    :'type' => :'type',
    :'external_id' => :'externalId',
    :'mkt_place_applicant' => :'mktPlaceApplicant',
    :'social_networks' => :'socialNetworks',
    :'language' => :'language',
    :'brand' => :'brand',
    :'consents' => :'consents',
    :'reporting_tag' => :'reportingTag',
    :'no_post_booking' => :'noPostBooking',
    :'products' => :'products',
    :'primary_contact' => :'primaryContact',
    :'business_profile' => :'businessProfile',
    :'principal_owner' => :'principalOwner',
    :'additional_owners' => :'additionalOwners',
    :'auto_graduated' => :'autoGraduated'
  }
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



335
336
337
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 335

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



109
110
111
112
113
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 109

def self.openapi_all_of
  [
  :'BusinessApplicantResource'
  ]
end

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 86

def self.openapi_types
  {
    :'id' => :'String',
    :'status' => :'EntityProductStatusResource',
    :'type' => :'String',
    :'external_id' => :'String',
    :'mkt_place_applicant' => :'MarketPlaceApplicantResource',
    :'social_networks' => :'Array<SocialNetworkResource>',
    :'language' => :'String',
    :'brand' => :'String',
    :'consents' => :'Array<ApplicantConsentResource>',
    :'reporting_tag' => :'String',
    :'no_post_booking' => :'Boolean',
    :'products' => :'Array<Product>',
    :'primary_contact' => :'ProfileResource',
    :'business_profile' => :'BusinessProfileResource',
    :'principal_owner' => :'BeneficialOwnerResource',
    :'additional_owners' => :'Array<BeneficialOwnerResource>',
    :'auto_graduated' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 298

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      status == o.status &&
      type == o.type &&
      external_id == o.external_id &&
      mkt_place_applicant == o.mkt_place_applicant &&
      social_networks == o.social_networks &&
      language == o.language &&
      brand == o.brand &&
      consents == o.consents &&
      reporting_tag == o.reporting_tag &&
      no_post_booking == o.no_post_booking &&
      products == o.products &&
      primary_contact == o.primary_contact &&
      business_profile == o.business_profile &&
      principal_owner == o.principal_owner &&
      additional_owners == o.additional_owners &&
      auto_graduated == o.auto_graduated
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



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 363

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
    Yapstone.const_get(type).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



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 428

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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 342

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if 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 # 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


322
323
324
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 322

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



328
329
330
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 328

def hash
  [id, status, type, external_id, mkt_place_applicant, social_networks, language, brand, consents, reporting_tag, no_post_booking, products, primary_contact, business_profile, principal_owner, additional_owners, auto_graduated].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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 211

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

  if !@external_id.nil? && @external_id.to_s.length > 255
    invalid_properties.push('invalid value for "external_id", the character length must be smaller than or equal to 255.')
  end

  if !@external_id.nil? && @external_id.to_s.length < 1
    invalid_properties.push('invalid value for "external_id", the character length must be great than or equal to 1.')
  end

  pattern = Regexp.new(/.*[^\s].*/)
  if !@external_id.nil? && @external_id !~ pattern
    invalid_properties.push("invalid value for \"external_id\", must conform to the pattern #{pattern}.")
  end

  if @language.nil?
    invalid_properties.push('invalid value for "language", language cannot be nil.')
  end

  if @brand.nil?
    invalid_properties.push('invalid value for "brand", brand cannot be nil.')
  end

  if !@reporting_tag.nil? && @reporting_tag.to_s.length > 100
    invalid_properties.push('invalid value for "reporting_tag", the character length must be smaller than or equal to 100.')
  end

  if !@reporting_tag.nil? && @reporting_tag.to_s.length < 2
    invalid_properties.push('invalid value for "reporting_tag", the character length must be great than or equal to 2.')
  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



408
409
410
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 408

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



414
415
416
417
418
419
420
421
422
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 414

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



402
403
404
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 402

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



251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/yapstone-so/models/business_applicant_admin_resource.rb', line 251

def valid?
  return false if @type.nil?
  return false if !@external_id.nil? && @external_id.to_s.length > 255
  return false if !@external_id.nil? && @external_id.to_s.length < 1
  return false if !@external_id.nil? && @external_id !~ Regexp.new(/.*[^\s].*/)
  return false if @language.nil?
  return false if @brand.nil?
  return false if !@reporting_tag.nil? && @reporting_tag.to_s.length > 100
  return false if !@reporting_tag.nil? && @reporting_tag.to_s.length < 2
  true
end