Class: UltracartClient::AffiliateLink

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AffiliateLink

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 123

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

  if attributes.has_key?(:'affiliate_managed_link_oid')
    self.affiliate_managed_link_oid = attributes[:'affiliate_managed_link_oid']
  end

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

  if attributes.has_key?(:'affiliate_program_item_oid')
    self.affiliate_program_item_oid = attributes[:'affiliate_program_item_oid']
  end

  if attributes.has_key?(:'code')
    self.code = attributes[:'code']
  end

  if attributes.has_key?(:'creative_oid')
    self.creative_oid = attributes[:'creative_oid']
  end

  if attributes.has_key?(:'custom_html')
    self.custom_html = attributes[:'custom_html']
  end

  if attributes.has_key?(:'custom_html_approval_status')
    self.custom_html_approval_status = attributes[:'custom_html_approval_status']
  end

  if attributes.has_key?(:'custom_landing_url')
    self.custom_landing_url = attributes[:'custom_landing_url']
  end

  if attributes.has_key?(:'deleted')
    self.deleted = attributes[:'deleted']
  end

  if attributes.has_key?(:'invisible_link_approval_status')
    self.invisible_link_approval_status = attributes[:'invisible_link_approval_status']
  end

  if attributes.has_key?(:'invisible_link_url_prefix')
    self.invisible_link_url_prefix = attributes[:'invisible_link_url_prefix']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end
end

Instance Attribute Details

Unique object identifier associated with this link



18
19
20
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 18

def affiliate_link_oid
  @affiliate_link_oid
end

#affiliate_managed_link_oid ⇒ Object

Managed link OID that this link object was generated from



21
22
23
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 21

def affiliate_managed_link_oid
  @affiliate_managed_link_oid
end

#affiliate_oid ⇒ Object

Affiliate object ID associated with this link



24
25
26
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 24

def affiliate_oid
  @affiliate_oid
end

#affiliate_program_item_oid ⇒ Object

The affiliate program item this managed link is associated with



27
28
29
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 27

def affiliate_program_item_oid
  @affiliate_program_item_oid
end

#code ⇒ Object

Code associated with the link



30
31
32
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 30

def code
  @code
end

#creative_oid ⇒ Object

Creative (image or text) associated with this link



33
34
35
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 33

def creative_oid
  @creative_oid
end

#custom_html ⇒ Object

Custom HTML associated with this link



36
37
38
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 36

def custom_html
  @custom_html
end

#custom_html_approval_status ⇒ Object

Approved status of the custom html



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

def custom_html_approval_status
  @custom_html_approval_status
end

#custom_landing_url ⇒ Object

Custom landing page URL if configured



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

def custom_landing_url
  @custom_landing_url
end

#deleted ⇒ Object

True if the link has been deleted



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

def deleted
  @deleted
end

#invisible_link_approval_status ⇒ Object

Invisible link approval status



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

def invisible_link_approval_status
  @invisible_link_approval_status
end

#invisible_link_url_prefix ⇒ Object

Invisible link URL prefix



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

def invisible_link_url_prefix
  @invisible_link_url_prefix
end

#name ⇒ Object

Name of the link



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

def name
  @name
end

#type ⇒ Object

Type of link



57
58
59
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 57

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'affiliate_link_oid' => :'affiliate_link_oid',
    :'affiliate_managed_link_oid' => :'affiliate_managed_link_oid',
    :'affiliate_oid' => :'affiliate_oid',
    :'affiliate_program_item_oid' => :'affiliate_program_item_oid',
    :'code' => :'code',
    :'creative_oid' => :'creative_oid',
    :'custom_html' => :'custom_html',
    :'custom_html_approval_status' => :'custom_html_approval_status',
    :'custom_landing_url' => :'custom_landing_url',
    :'deleted' => :'deleted',
    :'invisible_link_approval_status' => :'invisible_link_approval_status',
    :'invisible_link_url_prefix' => :'invisible_link_url_prefix',
    :'name' => :'name',
    :'type' => :'type'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 102

def self.swagger_types
  {
    :'affiliate_link_oid' => :'Integer',
    :'affiliate_managed_link_oid' => :'Integer',
    :'affiliate_oid' => :'Integer',
    :'affiliate_program_item_oid' => :'Integer',
    :'code' => :'String',
    :'creative_oid' => :'Integer',
    :'custom_html' => :'String',
    :'custom_html_approval_status' => :'String',
    :'custom_landing_url' => :'String',
    :'deleted' => :'BOOLEAN',
    :'invisible_link_approval_status' => :'String',
    :'invisible_link_url_prefix' => :'String',
    :'name' => :'String',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 237

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      affiliate_link_oid == o.affiliate_link_oid &&
      affiliate_managed_link_oid == o.affiliate_managed_link_oid &&
      affiliate_oid == o.affiliate_oid &&
      affiliate_program_item_oid == o.affiliate_program_item_oid &&
      code == o.code &&
      creative_oid == o.creative_oid &&
      custom_html == o.custom_html &&
      custom_html_approval_status == o.custom_html_approval_status &&
      custom_landing_url == o.custom_landing_url &&
      deleted == o.deleted &&
      invisible_link_approval_status == o.invisible_link_approval_status &&
      invisible_link_url_prefix == o.invisible_link_url_prefix &&
      name == o.name &&
      type == o.type
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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 292

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = UltracartClient.const_get(type).new
    temp_model.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



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 358

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



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 271

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


258
259
260
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 258

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



264
265
266
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 264

def hash
  [affiliate_link_oid, affiliate_managed_link_oid, affiliate_oid, affiliate_program_item_oid, code, creative_oid, custom_html, custom_html_approval_status, custom_landing_url, deleted, invisible_link_approval_status, invisible_link_url_prefix, name, type].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



188
189
190
191
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 188

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



338
339
340
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 338

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



344
345
346
347
348
349
350
351
352
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 344

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



332
333
334
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 332

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



195
196
197
198
199
200
201
202
203
 
# File 'lib/ultracart_api/models/affiliate_link.rb', line 195

def valid?
  custom_html_approval_status_validator = EnumAttributeValidator.new('String', ['Pending', 'Approved', 'Rejected'])
  return false unless custom_html_approval_status_validator.valid?(@custom_html_approval_status)
  invisible_link_approval_status_validator = EnumAttributeValidator.new('String', ['Pending', 'Approved', 'Rejected'])
  return false unless invisible_link_approval_status_validator.valid?(@invisible_link_approval_status)
  type_validator = EnumAttributeValidator.new('String', ['image', 'text', 'invisible', 'direct'])
  return false unless type_validator.valid?(@type)
  true
end