Class: Zernio::DuplicateAdCampaignRequest

Inherits:
ApiModelBase show all
Defined in:
lib/zernio-sdk/models/duplicate_ad_campaign_request.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 = {}) ⇒ DuplicateAdCampaignRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



110
111
112
113
114
115
116
117
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 110

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

  if attributes.key?(:'deep_copy')
    self.deep_copy = attributes[:'deep_copy']
  else
    self.deep_copy = true
  end

  if attributes.key?(:'status_option')
    self.status_option = attributes[:'status_option']
  else
    self.status_option = 'PAUSED'
  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?(:'rename_strategy')
    self.rename_strategy = attributes[:'rename_strategy']
  end

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

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

  if attributes.key?(:'sync_after')
    self.sync_after = attributes[:'sync_after']
  else
    self.sync_after = true
  end
end

Instance Attribute Details

#deep_copy ⇒ Object

Copy child ad sets + ads + creatives + targeting



21
22
23
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 21

def deep_copy
  @deep_copy
end

#end_time ⇒ Object

Returns the value of attribute end_time.



29
30
31
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 29

def end_time
  @end_time
end

#platform ⇒ Object

Returns the value of attribute platform.



18
19
20
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 18

def platform
  @platform
end

#rename_prefix ⇒ Object

Returns the value of attribute rename_prefix.



33
34
35
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 33

def rename_prefix
  @rename_prefix
end

#rename_strategy ⇒ Object

Returns the value of attribute rename_strategy.



31
32
33
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 31

def rename_strategy
  @rename_strategy
end

#rename_suffix ⇒ Object

Returns the value of attribute rename_suffix.



35
36
37
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 35

def rename_suffix
  @rename_suffix
end

#start_time ⇒ Object

Reschedule the copied hierarchy's start time



27
28
29
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 27

def start_time
  @start_time
end

#status_option ⇒ Object

ACTIVE = launch the clone immediately (spends the moment LinkedIn approves it). PAUSED = clone stays DRAFT, safe default. INHERITED_FROM_SOURCE = mirror each entity's source status per-entity. Duplicating an ACTIVE campaign this way starts a second front of spend.



24
25
26
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 24

def status_option
  @status_option
end

#sync_after ⇒ Object

Trigger ads discovery on the owning account after the copy succeeds



38
39
40
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 38

def sync_after
  @sync_after
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



78
79
80
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 78

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



83
84
85
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 83

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 63

def self.attribute_map
  {
    :'platform' => :'platform',
    :'deep_copy' => :'deepCopy',
    :'status_option' => :'statusOption',
    :'start_time' => :'startTime',
    :'end_time' => :'endTime',
    :'rename_strategy' => :'renameStrategy',
    :'rename_prefix' => :'renamePrefix',
    :'rename_suffix' => :'renameSuffix',
    :'sync_after' => :'syncAfter'
  }
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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 256

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



103
104
105
106
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 103

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

.openapi_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 88

def self.openapi_types
  {
    :'platform' => :'String',
    :'deep_copy' => :'Boolean',
    :'status_option' => :'String',
    :'start_time' => :'Time',
    :'end_time' => :'Time',
    :'rename_strategy' => :'String',
    :'rename_prefix' => :'String',
    :'rename_suffix' => :'String',
    :'sync_after' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 227

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      platform == o.platform &&
      deep_copy == o.deep_copy &&
      status_option == o.status_option &&
      start_time == o.start_time &&
      end_time == o.end_time &&
      rename_strategy == o.rename_strategy &&
      rename_prefix == o.rename_prefix &&
      rename_suffix == o.rename_suffix &&
      sync_after == o.sync_after
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


243
244
245
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 243

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



249
250
251
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 249

def hash
  [platform, deep_copy, status_option, start_time, end_time, rename_strategy, rename_prefix, rename_suffix, sync_after].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



171
172
173
174
175
176
177
178
179
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 171

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @platform.nil?
    invalid_properties.push('invalid value for "platform", platform cannot be nil.')
  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



278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 278

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



183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/zernio-sdk/models/duplicate_ad_campaign_request.rb', line 183

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @platform.nil?
  platform_validator = EnumAttributeValidator.new('String', ["facebook", "instagram", "tiktok", "linkedin"])
  return false unless platform_validator.valid?(@platform)
  status_option_validator = EnumAttributeValidator.new('String', ["ACTIVE", "PAUSED", "INHERITED_FROM_SOURCE"])
  return false unless status_option_validator.valid?(@status_option)
  rename_strategy_validator = EnumAttributeValidator.new('String', ["DEEP_RENAME", "ONLY_TOP_LEVEL_RENAME", "NO_RENAME"])
  return false unless rename_strategy_validator.valid?(@rename_strategy)
  true
end