Class: TalonOne::BulkOperationOnCampaigns

Inherits:
ApiModelBase show all
Defined in:
lib/talon_one_sdk/models/bulk_operation_on_campaigns.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ BulkOperationOnCampaigns

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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_sdk/models/bulk_operation_on_campaigns.rb', line 85

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::BulkOperationOnCampaigns` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::BulkOperationOnCampaigns`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'operation')
    self.operation = attributes[:'operation']
  else
    self.operation = nil
  end

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

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

Instance Attribute Details

#activate_at ⇒ Object

Timestamp when the revisions are finalized after the ‘activate_revision` operation. The current time is used when left blank. Note: It must be an RFC3339 timestamp string.



25
26
27
 
# File 'lib/talon_one_sdk/models/bulk_operation_on_campaigns.rb', line 25

def activate_at
  @activate_at
end

#campaign_ids ⇒ Object

The list of campaign IDs on which the operation will be performed.



22
23
24
 
# File 'lib/talon_one_sdk/models/bulk_operation_on_campaigns.rb', line 22

def campaign_ids
  @campaign_ids
end

#operation ⇒ Object

The operation to perform on the specified campaign IDs.



19
20
21
 
# File 'lib/talon_one_sdk/models/bulk_operation_on_campaigns.rb', line 19

def operation
  @operation
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



59
60
61
 
# File 'lib/talon_one_sdk/models/bulk_operation_on_campaigns.rb', line 59

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



64
65
66
 
# File 'lib/talon_one_sdk/models/bulk_operation_on_campaigns.rb', line 64

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
 
# File 'lib/talon_one_sdk/models/bulk_operation_on_campaigns.rb', line 50

def self.attribute_map
  {
    :'operation' => :'operation',
    :'campaign_ids' => :'campaignIds',
    :'activate_at' => :'activateAt'
  }
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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/talon_one_sdk/models/bulk_operation_on_campaigns.rb', line 199

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



78
79
80
81
 
# File 'lib/talon_one_sdk/models/bulk_operation_on_campaigns.rb', line 78

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

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
 
# File 'lib/talon_one_sdk/models/bulk_operation_on_campaigns.rb', line 69

def self.openapi_types
  {
    :'operation' => :'String',
    :'campaign_ids' => :'Array<Integer>',
    :'activate_at' => :'Time'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



176
177
178
179
180
181
182
 
# File 'lib/talon_one_sdk/models/bulk_operation_on_campaigns.rb', line 176

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      operation == o.operation &&
      campaign_ids == o.campaign_ids &&
      activate_at == o.activate_at
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


186
187
188
 
# File 'lib/talon_one_sdk/models/bulk_operation_on_campaigns.rb', line 186

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



192
193
194
 
# File 'lib/talon_one_sdk/models/bulk_operation_on_campaigns.rb', line 192

def hash
  [operation, campaign_ids, activate_at].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
128
129
130
131
132
133
134
135
136
 
# File 'lib/talon_one_sdk/models/bulk_operation_on_campaigns.rb', line 120

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @operation.nil?
    invalid_properties.push('invalid value for "operation", operation cannot be nil.')
  end

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

  if @campaign_ids.length > 50
    invalid_properties.push('invalid value for "campaign_ids", number of items must be less than or equal to 50.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/talon_one_sdk/models/bulk_operation_on_campaigns.rb', line 221

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



140
141
142
143
144
145
146
147
148
 
# File 'lib/talon_one_sdk/models/bulk_operation_on_campaigns.rb', line 140

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @operation.nil?
  operation_validator = EnumAttributeValidator.new('String', ["disable", "delete", "activate_revision"])
  return false unless operation_validator.valid?(@operation)
  return false if @campaign_ids.nil?
  return false if @campaign_ids.length > 50
  true
end