Class: UltracartClient::AffiliateClick

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/affiliate_click.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AffiliateClick

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 107

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#affiliate_click_oid ⇒ Object

Unique object identifier for this click



19
20
21
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 19

def affiliate_click_oid
  @affiliate_click_oid
end

#affiliate_link_oid ⇒ Object

Unique object identifier for for the link that this click is associated with



22
23
24
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 22

def affiliate_link_oid
  @affiliate_link_oid
end

#affiliate_oid ⇒ Object

Affiliate object ID associated with this click



25
26
27
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 25

def affiliate_oid
  @affiliate_oid
end

#click_dts ⇒ Object

Date/time that the click was made



28
29
30
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 28

def click_dts
  @click_dts
end

#ip_address ⇒ Object

IP address that generated the click



31
32
33
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 31

def ip_address
  @ip_address
end

#landing_page ⇒ Object

URL of the landing page the customer was sent to.



34
35
36
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 34

def landing_page
  @landing_page
end

#landing_page_query_string ⇒ Object

Query string on the landing page URL the customer was sent to.



37
38
39
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 37

def landing_page_query_string
  @landing_page_query_string
end

#link ⇒ Object

Returns the value of attribute link.



39
40
41
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 39

def link
  @link
end

#referrer ⇒ Object

URL that referred the click (Browser Header Referer)



42
43
44
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 42

def referrer
  @referrer
end

#referrer_query_string ⇒ Object

Query string that was on the referrer URL.



45
46
47
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 45

def referrer_query_string
  @referrer_query_string
end

#screen_recording_uuid ⇒ Object

Screen recording UUID



48
49
50
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 48

def screen_recording_uuid
  @screen_recording_uuid
end

#sub_id ⇒ Object

Sub ID value passed on the click



51
52
53
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 51

def sub_id
  @sub_id
end

#ucacid ⇒ Object

UC Analytics Identifier



54
55
56
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 54

def ucacid
  @ucacid
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 57

def self.attribute_map
  {
    :'affiliate_click_oid' => :'affiliate_click_oid',
    :'affiliate_link_oid' => :'affiliate_link_oid',
    :'affiliate_oid' => :'affiliate_oid',
    :'click_dts' => :'click_dts',
    :'ip_address' => :'ip_address',
    :'landing_page' => :'landing_page',
    :'landing_page_query_string' => :'landing_page_query_string',
    :'link' => :'link',
    :'referrer' => :'referrer',
    :'referrer_query_string' => :'referrer_query_string',
    :'screen_recording_uuid' => :'screen_recording_uuid',
    :'sub_id' => :'sub_id',
    :'ucacid' => :'ucacid'
  }
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



221
222
223
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 221

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 81

def self.openapi_types
  {
    :'affiliate_click_oid' => :'Integer',
    :'affiliate_link_oid' => :'Integer',
    :'affiliate_oid' => :'Integer',
    :'click_dts' => :'String',
    :'ip_address' => :'String',
    :'landing_page' => :'String',
    :'landing_page_query_string' => :'String',
    :'link' => :'AffiliateLink',
    :'referrer' => :'String',
    :'referrer_query_string' => :'String',
    :'screen_recording_uuid' => :'String',
    :'sub_id' => :'String',
    :'ucacid' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 188

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      affiliate_click_oid == o.affiliate_click_oid &&
      affiliate_link_oid == o.affiliate_link_oid &&
      affiliate_oid == o.affiliate_oid &&
      click_dts == o.click_dts &&
      ip_address == o.ip_address &&
      landing_page == o.landing_page &&
      landing_page_query_string == o.landing_page_query_string &&
      link == o.link &&
      referrer == o.referrer &&
      referrer_query_string == o.referrer_query_string &&
      screen_recording_uuid == o.screen_recording_uuid &&
      sub_id == o.sub_id &&
      ucacid == o.ucacid
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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 252

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 323

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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 228

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


208
209
210
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 208

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



214
215
216
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 214

def hash
  [affiliate_click_oid, affiliate_link_oid, affiliate_oid, click_dts, ip_address, landing_page, landing_page_query_string, link, referrer, referrer_query_string, screen_recording_uuid, sub_id, ucacid].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



175
176
177
178
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 175

def list_invalid_properties
  invalid_properties = Array.new
  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



299
300
301
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 299

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



305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 305

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



293
294
295
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 293

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



182
183
184
 
# File 'lib/ultracart_api/models/affiliate_click.rb', line 182

def valid?
  true
end