Class: TalonOne::CampaignVersions

Inherits:
ApiModelBase show all
Defined in:
lib/talon_one_sdk/models/campaign_versions.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 = {}) ⇒ CampaignVersions

Initializes the object

Parameters:

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

    Model attributes in the form of hash



105
106
107
108
109
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
 
# File 'lib/talon_one_sdk/models/campaign_versions.rb', line 105

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

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

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

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

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

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

  if attributes.key?(:'stage_revision')
    self.stage_revision = attributes[:'stage_revision']
  else
    self.stage_revision = false
  end
end

Instance Attribute Details

#active_revision_id ⇒ Object

ID of the revision that was last activated on this campaign.



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

def active_revision_id
  @active_revision_id
end

#active_revision_version_id ⇒ Object

ID of the revision version that is active on the campaign.



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

def active_revision_version_id
  @active_revision_version_id
end

#current_revision_id ⇒ Object

ID of the revision currently being modified for the campaign.



31
32
33
 
# File 'lib/talon_one_sdk/models/campaign_versions.rb', line 31

def current_revision_id
  @current_revision_id
end

#current_revision_version_id ⇒ Object

ID of the latest version applied on the current revision.



34
35
36
 
# File 'lib/talon_one_sdk/models/campaign_versions.rb', line 34

def current_revision_version_id
  @current_revision_version_id
end

#revision_frontend_state ⇒ Object

The campaign revision state displayed in the Campaign Manager.



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

def revision_frontend_state
  @revision_frontend_state
end

#stage_revision ⇒ Object

Flag for determining whether we use current revision when sending requests with staging API key.



37
38
39
 
# File 'lib/talon_one_sdk/models/campaign_versions.rb', line 37

def stage_revision
  @stage_revision
end

#version ⇒ Object

Incrementing number representing how many revisions have been activated on this campaign, starts from 0 for a new campaign.



28
29
30
 
# File 'lib/talon_one_sdk/models/campaign_versions.rb', line 28

def version
  @version
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



75
76
77
 
# File 'lib/talon_one_sdk/models/campaign_versions.rb', line 75

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/talon_one_sdk/models/campaign_versions.rb', line 80

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/talon_one_sdk/models/campaign_versions.rb', line 62

def self.attribute_map
  {
    :'revision_frontend_state' => :'revisionFrontendState',
    :'active_revision_id' => :'activeRevisionId',
    :'active_revision_version_id' => :'activeRevisionVersionId',
    :'version' => :'version',
    :'current_revision_id' => :'currentRevisionId',
    :'current_revision_version_id' => :'currentRevisionVersionId',
    :'stage_revision' => :'stageRevision'
  }
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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/talon_one_sdk/models/campaign_versions.rb', line 206

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



98
99
100
101
 
# File 'lib/talon_one_sdk/models/campaign_versions.rb', line 98

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

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/talon_one_sdk/models/campaign_versions.rb', line 85

def self.openapi_types
  {
    :'revision_frontend_state' => :'String',
    :'active_revision_id' => :'Integer',
    :'active_revision_version_id' => :'Integer',
    :'version' => :'Integer',
    :'current_revision_id' => :'Integer',
    :'current_revision_version_id' => :'Integer',
    :'stage_revision' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/talon_one_sdk/models/campaign_versions.rb', line 179

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      revision_frontend_state == o.revision_frontend_state &&
      active_revision_id == o.active_revision_id &&
      active_revision_version_id == o.active_revision_version_id &&
      version == o.version &&
      current_revision_id == o.current_revision_id &&
      current_revision_version_id == o.current_revision_version_id &&
      stage_revision == o.stage_revision
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


193
194
195
 
# File 'lib/talon_one_sdk/models/campaign_versions.rb', line 193

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



199
200
201
 
# File 'lib/talon_one_sdk/models/campaign_versions.rb', line 199

def hash
  [revision_frontend_state, active_revision_id, active_revision_version_id, version, current_revision_id, current_revision_version_id, stage_revision].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



152
153
154
155
156
 
# File 'lib/talon_one_sdk/models/campaign_versions.rb', line 152

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/talon_one_sdk/models/campaign_versions.rb', line 228

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



160
161
162
163
164
165
 
# File 'lib/talon_one_sdk/models/campaign_versions.rb', line 160

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  revision_frontend_state_validator = EnumAttributeValidator.new('String', ["revised", "pending"])
  return false unless revision_frontend_state_validator.valid?(@revision_frontend_state)
  true
end