Class: TalonOne::CampaignCopy

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CampaignCopy

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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/talon_one/models/campaign_copy.rb', line 72

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

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

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

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

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

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

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

Instance Attribute Details

#application_ids ⇒ Object

Application IDs of the applications to which a campaign should be copied to.



21
22
23
 
# File 'lib/talon_one/models/campaign_copy.rb', line 21

def application_ids
  @application_ids
end

#description ⇒ Object

A detailed description of the campaign.



24
25
26
 
# File 'lib/talon_one/models/campaign_copy.rb', line 24

def description
  @description
end

#end_time ⇒ Object

Timestamp when the campaign will become inactive.



30
31
32
 
# File 'lib/talon_one/models/campaign_copy.rb', line 30

def end_time
  @end_time
end

#evaluation_group_id ⇒ Object

The ID of the campaign evaluation group the campaign belongs to.



36
37
38
 
# File 'lib/talon_one/models/campaign_copy.rb', line 36

def evaluation_group_id
  @evaluation_group_id
end

#name ⇒ Object

Name of the copied campaign (Defaults to "Copy of original campaign name").



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

def name
  @name
end

#start_time ⇒ Object

Timestamp when the campaign will become active.



27
28
29
 
# File 'lib/talon_one/models/campaign_copy.rb', line 27

def start_time
  @start_time
end

#tags ⇒ Object

A list of tags for the campaign.



33
34
35
 
# File 'lib/talon_one/models/campaign_copy.rb', line 33

def tags
  @tags
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/talon_one/models/campaign_copy.rb', line 39

def self.attribute_map
  {
    :'name' => :'name',
    :'application_ids' => :'applicationIds',
    :'description' => :'description',
    :'start_time' => :'startTime',
    :'end_time' => :'endTime',
    :'tags' => :'tags',
    :'evaluation_group_id' => :'evaluationGroupId'
  }
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



165
166
167
 
# File 'lib/talon_one/models/campaign_copy.rb', line 165

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/campaign_copy.rb', line 65

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

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/talon_one/models/campaign_copy.rb', line 52

def self.openapi_types
  {
    :'name' => :'String',
    :'application_ids' => :'Array<Integer>',
    :'description' => :'String',
    :'start_time' => :'DateTime',
    :'end_time' => :'DateTime',
    :'tags' => :'Array<String>',
    :'evaluation_group_id' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/talon_one/models/campaign_copy.rb', line 138

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      application_ids == o.application_ids &&
      description == o.description &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      tags == o.tags &&
      evaluation_group_id == o.evaluation_group_id
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



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
 
# File 'lib/talon_one/models/campaign_copy.rb', line 193

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



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/talon_one/models/campaign_copy.rb', line 262

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



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

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


152
153
154
 
# File 'lib/talon_one/models/campaign_copy.rb', line 152

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



158
159
160
 
# File 'lib/talon_one/models/campaign_copy.rb', line 158

def hash
  [name, application_ids, description, start_time, end_time, tags, evaluation_group_id].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



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

def list_invalid_properties
  invalid_properties = Array.new
  if @application_ids.nil?
    invalid_properties.push('invalid value for "application_ids", application_ids 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



238
239
240
 
# File 'lib/talon_one/models/campaign_copy.rb', line 238

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



244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/talon_one/models/campaign_copy.rb', line 244

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



232
233
234
 
# File 'lib/talon_one/models/campaign_copy.rb', line 232

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



131
132
133
134
 
# File 'lib/talon_one/models/campaign_copy.rb', line 131

def valid?
  return false if @application_ids.nil?
  true
end