Class: Zernio::InstallTrackingTagOnStore200ResponseInstall

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
238
239
240
241
242
243
244
245
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 162

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created ⇒ Object

WordPress only: false when an existing Zernio widget was updated.



63
64
65
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 63

def created
  @created
end

#homepage_check ⇒ Object

WordPress only: whether the pixel appeared in the homepage HTML. not_found can be a stale page cache.



66
67
68
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 66

def homepage_check
  @homepage_check
end

#installed ⇒ Object

Shopify: this tag is the one the store fires for its platform. WordPress: the Zernio widget for this tag is in an active widget area with its script intact.



30
31
32
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 30

def installed
  @installed
end

#installed_tag_id ⇒ Object

Shopify only: the tag of the same platform the store fires now (may be a different tag), or null.



36
37
38
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 36

def installed_tag_id
  @installed_tag_id
end

#method ⇒ Object

WordPress only.



48
49
50
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 48

def method
  @method
end

#platform ⇒ Object

The store platform.



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

def platform
  @platform
end

#replaced_tag_id ⇒ Object

Shopify only: the pixel this install replaced on the store, if any.



57
58
59
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 57

def replaced_tag_id
  @replaced_tag_id
end

#shop_domain ⇒ Object

Shopify only.



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

def shop_domain
  @shop_domain
end

#sidebar_id ⇒ Object

WordPress only: widget area holding the widget.



54
55
56
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 54

def sidebar_id
  @sidebar_id
end

#sidebar_name ⇒ Object

WordPress only: name of the widget area used.



60
61
62
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 60

def sidebar_name
  @sidebar_name
end

#site_tag_id ⇒ Object

The id the tag carries on the site (see TrackingTag.siteTagId).



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

def site_tag_id
  @site_tag_id
end

#site_url ⇒ Object

WordPress only.



45
46
47
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 45

def site_url
  @site_url
end

#store_account_id ⇒ Object

Returns the value of attribute store_account_id.



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

def 
  @store_account_id
end

#tag_platform ⇒ Object

Platform of the tag this install is about (e.g. metaads).



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

def tag_platform
  @tag_platform
end

#tags ⇒ Object

GET only on WordPress, always on Shopify: every Zernio tag on the store, all platforms.



39
40
41
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 39

def tags
  @tags
end

#web_pixel_id ⇒ Object

Shopify only: web pixel id, or null when nothing is installed.



42
43
44
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 42

def web_pixel_id
  @web_pixel_id
end

#widget_id ⇒ Object

WordPress only: widget id, e.g. custom_html-3.



51
52
53
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 51

def widget_id
  @widget_id
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



114
115
116
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 114

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



119
120
121
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 119

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 91

def self.attribute_map
  {
    :'store_account_id' => :'storeAccountId',
    :'platform' => :'platform',
    :'tag_platform' => :'tagPlatform',
    :'site_tag_id' => :'siteTagId',
    :'installed' => :'installed',
    :'shop_domain' => :'shopDomain',
    :'installed_tag_id' => :'installedTagId',
    :'tags' => :'tags',
    :'web_pixel_id' => :'webPixelId',
    :'site_url' => :'siteUrl',
    :'method' => :'method',
    :'widget_id' => :'widgetId',
    :'sidebar_id' => :'sidebarId',
    :'replaced_tag_id' => :'replacedTagId',
    :'sidebar_name' => :'sidebarName',
    :'created' => :'created',
    :'homepage_check' => :'homepageCheck'
  }
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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 337

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



154
155
156
157
158
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 154

def self.openapi_all_of
  [
  :'StorePixelInstall'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



147
148
149
150
151
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 147

def self.openapi_nullable
  Set.new([
    :'replaced_tag_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 124

def self.openapi_types
  {
    :'store_account_id' => :'String',
    :'platform' => :'String',
    :'tag_platform' => :'String',
    :'site_tag_id' => :'String',
    :'installed' => :'Boolean',
    :'shop_domain' => :'String',
    :'installed_tag_id' => :'String',
    :'tags' => :'Array<StorePixelInstallTagsInner>',
    :'web_pixel_id' => :'String',
    :'site_url' => :'String',
    :'method' => :'String',
    :'widget_id' => :'String',
    :'sidebar_id' => :'String',
    :'replaced_tag_id' => :'String',
    :'sidebar_name' => :'String',
    :'created' => :'Boolean',
    :'homepage_check' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 300

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      platform == o.platform &&
      tag_platform == o.tag_platform &&
      site_tag_id == o.site_tag_id &&
      installed == o.installed &&
      shop_domain == o.shop_domain &&
      installed_tag_id == o.installed_tag_id &&
      tags == o.tags &&
      web_pixel_id == o.web_pixel_id &&
      site_url == o.site_url &&
      method == o.method &&
      widget_id == o.widget_id &&
      sidebar_id == o.sidebar_id &&
      replaced_tag_id == o.replaced_tag_id &&
      sidebar_name == o.sidebar_name &&
      created == o.created &&
      homepage_check == o.homepage_check
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


324
325
326
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 324

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



330
331
332
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 330

def hash
  [, platform, tag_platform, site_tag_id, installed, shop_domain, installed_tag_id, tags, web_pixel_id, site_url, method, widget_id, sidebar_id, replaced_tag_id, sidebar_name, created, homepage_check].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



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

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



359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 359

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



257
258
259
260
261
262
263
264
265
266
 
# File 'lib/zernio-sdk/models/install_tracking_tag_on_store200_response_install.rb', line 257

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  platform_validator = EnumAttributeValidator.new('String', ["shopify", "wordpress"])
  return false unless platform_validator.valid?(@platform)
  method_validator = EnumAttributeValidator.new('String', ["wordpress_widget"])
  return false unless method_validator.valid?(@method)
  homepage_check_validator = EnumAttributeValidator.new('String', ["found", "not_found", "unreachable", "skipped"])
  return false unless homepage_check_validator.valid?(@homepage_check)
  true
end