Class: TalonOne::ReferralRejectionReason

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/referral_rejection_reason.rb

Overview

Holds a reference to the campaign, the referral and the reason for which that referral was rejected. Should only be present when there is a ‘rejectReferral’ effect.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReferralRejectionReason

Initializes the object

Parameters:

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

    Model attributes in the form of hash



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 72

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

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

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

Instance Attribute Details

#campaign_id ⇒ Object

Returns the value of attribute campaign_id.



18
19
20
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 18

def campaign_id
  @campaign_id
end

#reason ⇒ Object

Returns the value of attribute reason.



22
23
24
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 22

def reason
  @reason
end

#referral_id ⇒ Object

Returns the value of attribute referral_id.



20
21
22
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 20

def referral_id
  @referral_id
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 47

def self.attribute_map
  {
    :'campaign_id' => :'campaignId',
    :'referral_id' => :'referralId',
    :'reason' => :'reason'
  }
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



163
164
165
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 163

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



65
66
67
68
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 65

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 56

def self.openapi_types
  {
    :'campaign_id' => :'Integer',
    :'referral_id' => :'Integer',
    :'reason' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



140
141
142
143
144
145
146
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 140

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      campaign_id == o.campaign_id &&
      referral_id == o.referral_id &&
      reason == o.reason
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



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
220
221
222
223
224
225
226
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 191

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
    TalonOne.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



260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 260

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



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 170

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


150
151
152
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 150

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



156
157
158
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 156

def hash
  [campaign_id, referral_id, reason].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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 100

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

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

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



236
237
238
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 236

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



242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 242

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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



230
231
232
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 230

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



119
120
121
122
123
124
125
126
 
# File 'lib/talon_one/models/referral_rejection_reason.rb', line 119

def valid?
  return false if @campaign_id.nil?
  return false if @referral_id.nil?
  return false if @reason.nil?
  reason_validator = EnumAttributeValidator.new('String', ["ReferralNotFound", "ReferralRecipientIdSameAsAdvocate", "ReferralPartOfNotRunningCampaign", "ReferralLimitReached", "CampaignLimitReached", "ProfileLimitReached", "ReferralRecipientDoesNotMatch", "ReferralExpired", "ReferralStartDateInFuture", "ReferralRejectedByCondition", "EffectCouldNotBeApplied", "ReferralPartOfNotTriggeredCampaign"])
  return false unless reason_validator.valid?(@reason)
  true
end