Class: Propertyware::Campaign

Inherits:
Object
  • Object
show all
Defined in:
lib/propertyware/models/campaign.rb

Overview

Campaign

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Campaign

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
208
209
210
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
248
249
250
251
252
253
254
255
 
# File 'lib/propertyware/models/campaign.rb', line 153

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accepted_call_tracking_terms ⇒ Object

Indicates if the call tracking terms have been accepted.



20
21
22
 
# File 'lib/propertyware/models/campaign.rb', line 20

def accepted_call_tracking_terms
  @accepted_call_tracking_terms
end

#call_tracking_campaign_id ⇒ Object

Campaign ID used for call tracking.



23
24
25
 
# File 'lib/propertyware/models/campaign.rb', line 23

def call_tracking_campaign_id
  @call_tracking_campaign_id
end

#call_tracking_enabled ⇒ Object

Indicates if call tracking is enabled for the campaign.



26
27
28
 
# File 'lib/propertyware/models/campaign.rb', line 26

def call_tracking_enabled
  @call_tracking_enabled
end

#call_tracking_forwar ⇒ Object

Number to which call tracking calls are forwarded.



29
30
31
 
# File 'lib/propertyware/models/campaign.rb', line 29

def call_tracking_forwar
  @call_tracking_forwar
end

#call_tracking_forwar_after_hours ⇒ Object

Number to which call tracking calls are forwarded after hours.



32
33
34
 
# File 'lib/propertyware/models/campaign.rb', line 32

def call_tracking_forwar_after_hours
  @call_tracking_forwar_after_hours
end

#call_tracking_phone_number ⇒ Object

Phone number used for call tracking.



35
36
37
 
# File 'lib/propertyware/models/campaign.rb', line 35

def call_tracking_phone_number
  @call_tracking_phone_number
end

#call_tracking_referrer ⇒ Object

Referrer for call tracking.



38
39
40
 
# File 'lib/propertyware/models/campaign.rb', line 38

def call_tracking_referrer
  @call_tracking_referrer
end

#call_tracking_search_phrase ⇒ Object

Search phrase for call tracking.



41
42
43
 
# File 'lib/propertyware/models/campaign.rb', line 41

def call_tracking_search_phrase
  @call_tracking_search_phrase
end

#campaign_source ⇒ Object

Returns the value of attribute campaign_source.



43
44
45
 
# File 'lib/propertyware/models/campaign.rb', line 43

def campaign_source
  @campaign_source
end

#code ⇒ Object

Code of the campaign.



46
47
48
 
# File 'lib/propertyware/models/campaign.rb', line 46

def code
  @code
end

#created_by ⇒ Object

User who created the record.



49
50
51
 
# File 'lib/propertyware/models/campaign.rb', line 49

def created_by
  @created_by
end

#created_date_time ⇒ Object

Date and time the record was created. (Timezone: UTC)



52
53
54
 
# File 'lib/propertyware/models/campaign.rb', line 52

def created_date_time
  @created_date_time
end

#custom_fields ⇒ Object

Custom fields.



55
56
57
 
# File 'lib/propertyware/models/campaign.rb', line 55

def custom_fields
  @custom_fields
end

#description ⇒ Object

Description of the campaign.



58
59
60
 
# File 'lib/propertyware/models/campaign.rb', line 58

def description
  @description
end

#end_date ⇒ Object

End date of the campaign.



61
62
63
 
# File 'lib/propertyware/models/campaign.rb', line 61

def end_date
  @end_date
end

#id ⇒ Object

Unique identifier.



64
65
66
 
# File 'lib/propertyware/models/campaign.rb', line 64

def id
  @id
end

#last_modified_by ⇒ Object

User who last modified the record.



67
68
69
 
# File 'lib/propertyware/models/campaign.rb', line 67

def last_modified_by
  @last_modified_by
end

#last_modified_date_time ⇒ Object

Date and time the record was last modified. (Timezone: UTC)



70
71
72
 
# File 'lib/propertyware/models/campaign.rb', line 70

def last_modified_date_time
  @last_modified_date_time
end

#name ⇒ Object

Name of the campaign.



73
74
75
 
# File 'lib/propertyware/models/campaign.rb', line 73

def name
  @name
end

#start_date ⇒ Object

Start date of the campaign.



76
77
78
 
# File 'lib/propertyware/models/campaign.rb', line 76

def start_date
  @start_date
end

#target_prospect_type ⇒ Object

Type of the targeted prospect.



79
80
81
 
# File 'lib/propertyware/models/campaign.rb', line 79

def target_prospect_type
  @target_prospect_type
end

#timezone ⇒ Object

Time zone of the campaign.



82
83
84
 
# File 'lib/propertyware/models/campaign.rb', line 82

def timezone
  @timezone
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



113
114
115
 
# File 'lib/propertyware/models/campaign.rb', line 113

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/propertyware/models/campaign.rb', line 85

def self.attribute_map
  {
    :'accepted_call_tracking_terms' => :'acceptedCallTrackingTerms',
    :'call_tracking_campaign_id' => :'callTrackingCampaignID',
    :'call_tracking_enabled' => :'callTrackingEnabled',
    :'call_tracking_forwar' => :'callTrackingForwar',
    :'call_tracking_forwar_after_hours' => :'callTrackingForwarAfterHours',
    :'call_tracking_phone_number' => :'callTrackingPhoneNumber',
    :'call_tracking_referrer' => :'callTrackingReferrer',
    :'call_tracking_search_phrase' => :'callTrackingSearchPhrase',
    :'campaign_source' => :'campaignSource',
    :'code' => :'code',
    :'created_by' => :'createdBy',
    :'created_date_time' => :'createdDateTime',
    :'custom_fields' => :'customFields',
    :'description' => :'description',
    :'end_date' => :'endDate',
    :'id' => :'id',
    :'last_modified_by' => :'lastModifiedBy',
    :'last_modified_date_time' => :'lastModifiedDateTime',
    :'name' => :'name',
    :'start_date' => :'startDate',
    :'target_prospect_type' => :'targetProspectType',
    :'timezone' => :'timezone'
  }
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



314
315
316
 
# File 'lib/propertyware/models/campaign.rb', line 314

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



146
147
148
149
 
# File 'lib/propertyware/models/campaign.rb', line 146

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

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/propertyware/models/campaign.rb', line 118

def self.openapi_types
  {
    :'accepted_call_tracking_terms' => :'Boolean',
    :'call_tracking_campaign_id' => :'String',
    :'call_tracking_enabled' => :'Boolean',
    :'call_tracking_forwar' => :'String',
    :'call_tracking_forwar_after_hours' => :'String',
    :'call_tracking_phone_number' => :'String',
    :'call_tracking_referrer' => :'String',
    :'call_tracking_search_phrase' => :'String',
    :'campaign_source' => :'CampaignSource',
    :'code' => :'String',
    :'created_by' => :'String',
    :'created_date_time' => :'Time',
    :'custom_fields' => :'Array<CustomField>',
    :'description' => :'String',
    :'end_date' => :'Date',
    :'id' => :'Integer',
    :'last_modified_by' => :'String',
    :'last_modified_date_time' => :'Time',
    :'name' => :'String',
    :'start_date' => :'Date',
    :'target_prospect_type' => :'String',
    :'timezone' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/propertyware/models/campaign.rb', line 272

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accepted_call_tracking_terms == o.accepted_call_tracking_terms &&
      call_tracking_campaign_id == o.call_tracking_campaign_id &&
      call_tracking_enabled == o.call_tracking_enabled &&
      call_tracking_forwar == o.call_tracking_forwar &&
      call_tracking_forwar_after_hours == o.call_tracking_forwar_after_hours &&
      call_tracking_phone_number == o.call_tracking_phone_number &&
      call_tracking_referrer == o.call_tracking_referrer &&
      call_tracking_search_phrase == o.call_tracking_search_phrase &&
      campaign_source == o.campaign_source &&
      code == o.code &&
      created_by == o.created_by &&
      created_date_time == o.created_date_time &&
      custom_fields == o.custom_fields &&
      description == o.description &&
      end_date == o.end_date &&
      id == o.id &&
      last_modified_by == o.last_modified_by &&
      last_modified_date_time == o.last_modified_date_time &&
      name == o.name &&
      start_date == o.start_date &&
      target_prospect_type == o.target_prospect_type &&
      timezone == o.timezone
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



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/propertyware/models/campaign.rb', line 345

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Propertyware.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/propertyware/models/campaign.rb', line 416

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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/propertyware/models/campaign.rb', line 321

def build_from_hash(attributes)
  return unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


301
302
303
 
# File 'lib/propertyware/models/campaign.rb', line 301

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



307
308
309
 
# File 'lib/propertyware/models/campaign.rb', line 307

def hash
  [accepted_call_tracking_terms, call_tracking_campaign_id, call_tracking_enabled, call_tracking_forwar, call_tracking_forwar_after_hours, call_tracking_phone_number, call_tracking_referrer, call_tracking_search_phrase, campaign_source, code, created_by, created_date_time, custom_fields, description, end_date, id, last_modified_by, last_modified_date_time, name, start_date, target_prospect_type, timezone].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



259
260
261
262
 
# File 'lib/propertyware/models/campaign.rb', line 259

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



392
393
394
 
# File 'lib/propertyware/models/campaign.rb', line 392

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



398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/propertyware/models/campaign.rb', line 398

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



386
387
388
 
# File 'lib/propertyware/models/campaign.rb', line 386

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



266
267
268
 
# File 'lib/propertyware/models/campaign.rb', line 266

def valid?
  true
end