Class: ConnectWise::Campaign

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/models/campaign.rb

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



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
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
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 127

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#_info ⇒ Object

Metadata of the entity



58
59
60
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 58

def _info
  @_info
end

#actual_cost ⇒ Object

Returns the value of attribute actual_cost.



43
44
45
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 43

def actual_cost
  @actual_cost
end

#actual_gross_margin ⇒ Object

Returns the value of attribute actual_gross_margin.



51
52
53
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 51

def actual_gross_margin
  @actual_gross_margin
end

#actual_revenue ⇒ Object

Returns the value of attribute actual_revenue.



49
50
51
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 49

def actual_revenue
  @actual_revenue
end

#actual_roi ⇒ Object

Returns the value of attribute actual_roi.



53
54
55
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 53

def actual_roi
  @actual_roi
end

#budget_cost ⇒ Object

Returns the value of attribute budget_cost.



41
42
43
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 41

def budget_cost
  @budget_cost
end

#budget_gross_margin ⇒ Object

Returns the value of attribute budget_gross_margin.



45
46
47
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 45

def budget_gross_margin
  @budget_gross_margin
end

#budget_revenue ⇒ Object

Returns the value of attribute budget_revenue.



39
40
41
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 39

def budget_revenue
  @budget_revenue
end

#budget_roi ⇒ Object

Returns the value of attribute budget_roi.



47
48
49
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 47

def budget_roi
  @budget_roi
end

#default_group ⇒ Object

Returns the value of attribute default_group.



31
32
33
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 31

def default_group
  @default_group
end

#emails_sent ⇒ Object

Returns the value of attribute emails_sent.



55
56
57
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 55

def emails_sent
  @emails_sent
end

#end_date ⇒ Object

Returns the value of attribute end_date.



19
20
21
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 19

def end_date
  @end_date
end

#id ⇒ Object

Returns the value of attribute id.



7
8
9
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 7

def id
  @id
end

#impressions ⇒ Object

Returns the value of attribute impressions.



37
38
39
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 37

def impressions
  @impressions
end

#inactive ⇒ Object

Returns the value of attribute inactive.



25
26
27
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 25

def inactive
  @inactive
end

#inactive_days_after_end ⇒ Object

Returns the value of attribute inactive_days_after_end.



27
28
29
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 27

def inactive_days_after_end
  @inactive_days_after_end
end

#location_id ⇒ Object

Returns the value of attribute location_id.



21
22
23
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 21

def location_id
  @location_id
end

#marketing_manager_default_track_id ⇒ Object

Returns the value of attribute marketing_manager_default_track_id.



33
34
35
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 33

def marketing_manager_default_track_id
  @marketing_manager_default_track_id
end

#member ⇒ Object

Returns the value of attribute member.



23
24
25
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 23

def member
  @member
end

#name ⇒ Object

Returns the value of attribute name.



9
10
11
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 9

def name
  @name
end

#notes ⇒ Object

Returns the value of attribute notes.



29
30
31
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 29

def notes
  @notes
end

#opportunity_default_track_id ⇒ Object

Returns the value of attribute opportunity_default_track_id.



35
36
37
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 35

def opportunity_default_track_id
  @opportunity_default_track_id
end

#start_date ⇒ Object

Returns the value of attribute start_date.



17
18
19
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 17

def start_date
  @start_date
end

#status ⇒ Object

Returns the value of attribute status.



15
16
17
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 15

def status
  @status
end

#sub_type ⇒ Object

Returns the value of attribute sub_type.



13
14
15
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 13

def sub_type
  @sub_type
end

#type ⇒ Object

Returns the value of attribute type.



11
12
13
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 11

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 62

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'type' => :'type',
    :'sub_type' => :'subType',
    :'status' => :'status',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'location_id' => :'locationId',
    :'member' => :'member',
    :'inactive' => :'inactive',
    :'inactive_days_after_end' => :'inactiveDaysAfterEnd',
    :'notes' => :'notes',
    :'default_group' => :'defaultGroup',
    :'marketing_manager_default_track_id' => :'marketingManagerDefaultTrackId',
    :'opportunity_default_track_id' => :'opportunityDefaultTrackId',
    :'impressions' => :'impressions',
    :'budget_revenue' => :'budgetRevenue',
    :'budget_cost' => :'budgetCost',
    :'actual_cost' => :'actualCost',
    :'budget_gross_margin' => :'budgetGrossMargin',
    :'budget_roi' => :'budgetROI',
    :'actual_revenue' => :'actualRevenue',
    :'actual_gross_margin' => :'actualGrossMargin',
    :'actual_roi' => :'actualROI',
    :'emails_sent' => :'emailsSent',
    :'_info' => :'_info'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 94

def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'type' => :'CampaignTypeReference',
    :'sub_type' => :'CampaignSubTypeReference',
    :'status' => :'CampaignStatusReference',
    :'start_date' => :'DateTime',
    :'end_date' => :'DateTime',
    :'location_id' => :'Integer',
    :'member' => :'MemberReference',
    :'inactive' => :'BOOLEAN',
    :'inactive_days_after_end' => :'Integer',
    :'notes' => :'String',
    :'default_group' => :'GroupReference',
    :'marketing_manager_default_track_id' => :'Integer',
    :'opportunity_default_track_id' => :'Integer',
    :'impressions' => :'Integer',
    :'budget_revenue' => :'Float',
    :'budget_cost' => :'Float',
    :'actual_cost' => :'Float',
    :'budget_gross_margin' => :'Float',
    :'budget_roi' => :'Float',
    :'actual_revenue' => :'Float',
    :'actual_gross_margin' => :'Float',
    :'actual_roi' => :'Float',
    :'emails_sent' => :'Integer',
    :'_info' => :'Metadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 293

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      type == o.type &&
      sub_type == o.sub_type &&
      status == o.status &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      location_id == o.location_id &&
      member == o.member &&
      inactive == o.inactive &&
      inactive_days_after_end == o.inactive_days_after_end &&
      notes == o.notes &&
      default_group == o.default_group &&
      marketing_manager_default_track_id == o.marketing_manager_default_track_id &&
      opportunity_default_track_id == o.opportunity_default_track_id &&
      impressions == o.impressions &&
      budget_revenue == o.budget_revenue &&
      budget_cost == o.budget_cost &&
      actual_cost == o.actual_cost &&
      budget_gross_margin == o.budget_gross_margin &&
      budget_roi == o.budget_roi &&
      actual_revenue == o.actual_revenue &&
      actual_gross_margin == o.actual_gross_margin &&
      actual_roi == o.actual_roi &&
      emails_sent == o.emails_sent &&
      _info == o._info
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



360
361
362
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
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 360

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 = ConnectWise.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



426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 426

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



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 339

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("#{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


326
327
328
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 326

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



332
333
334
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 332

def hash
  [id, name, type, sub_type, status, start_date, end_date, location_id, member, inactive, inactive_days_after_end, notes, default_group, marketing_manager_default_track_id, opportunity_default_track_id, impressions, budget_revenue, budget_cost, actual_cost, budget_gross_margin, budget_roi, actual_revenue, actual_gross_margin, actual_roi, emails_sent, _info].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 241

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

  if @name.to_s.length > 50
    invalid_properties.push("invalid value for 'name', the character length must be smaller than or equal to 50.")
  end

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

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

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

  return 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



406
407
408
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 406

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



412
413
414
415
416
417
418
419
420
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 412

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



400
401
402
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 400

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



268
269
270
271
272
273
274
275
 
# File 'lib/connectwise-ruby-sdk/models/campaign.rb', line 268

def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 50
  return false if @type.nil?
  return false if @sub_type.nil?
  return false if @start_date.nil?
  return true
end