Class: Yapstone::IndividualApplicantAdminResource

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ IndividualApplicantAdminResource

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 103

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

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

Instance Attribute Details

#auto_graduatedObject

value for graduation policy



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

def auto_graduated
  @auto_graduated
end

#brandObject

brand id



36
37
38
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 36

def brand
  @brand
end

#consentsObject

Returns the value of attribute consents.



38
39
40
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 38

def consents
  @consents
end

#external_idObject

The partners externalId id for the Applicant.



25
26
27
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 25

def external_id
  @external_id
end

#idObject

The resource identifier for the applicant.



18
19
20
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 18

def id
  @id
end

#individual_profileObject

Returns the value of attribute individual_profile.



49
50
51
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 49

def individual_profile
  @individual_profile
end

#languageObject

supported language



33
34
35
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 33

def language
  @language
end

#mkt_place_applicantObject

Returns the value of attribute mkt_place_applicant.



27
28
29
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 27

def mkt_place_applicant
  @mkt_place_applicant
end

#no_post_bookingObject

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



44
45
46
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 44

def no_post_booking
  @no_post_booking
end

#productsObject

Products requested by marketplace.



47
48
49
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 47

def products
  @products
end

#reporting_tagObject

The reportingTag for the applicant.



41
42
43
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 41

def reporting_tag
  @reporting_tag
end

#social_networksObject

A list of social networks the applicant belongs to.



30
31
32
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 30

def social_networks
  @social_networks
end

#statusObject

Returns the value of attribute status.



20
21
22
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 20

def status
  @status
end

#typeObject

Returns the value of attribute type.



22
23
24
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 22

def type
  @type
end

Class Method Details

.attribute_mapObject

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 55

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',
    :'individual_profile' => :'individualProfile',
    :'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



304
305
306
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 304

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

.openapi_all_ofObject

List of class defined in allOf (OpenAPI v3)



95
96
97
98
99
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 95

def self.openapi_all_of
  [
  :'IndividualApplicantResource'
  ]
end

.openapi_typesObject

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 75

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>',
    :'individual_profile' => :'ProfileResource',
    :'auto_graduated' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 270

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 &&
      individual_profile == o.individual_profile &&
      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



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 332

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



397
398
399
400
401
402
403
404
405
406
407
408
409
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 397

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



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 311

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


291
292
293
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 291

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



297
298
299
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 297

def hash
  [id, status, type, external_id, mkt_place_applicant, social_networks, language, brand, consents, reporting_tag, no_post_booking, products, individual_profile, auto_graduated].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



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
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 183

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_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



377
378
379
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 377

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



383
384
385
386
387
388
389
390
391
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 383

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



371
372
373
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 371

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



223
224
225
226
227
228
229
230
231
232
233
# File 'lib/yapstone-so/models/individual_applicant_admin_resource.rb', line 223

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