Class: ConnectWise::LinkClicked

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/models/link_clicked.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LinkClicked

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/connect_wise/models/link_clicked.rb', line 60

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `ConnectWise::LinkClicked` initialize method' unless attributes.is_a?(Hash)

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) do |(k, v), h|
    raise ArgumentError, "`#{k}` is not a valid attribute in `ConnectWise::LinkClicked`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect unless self.class.attribute_map.key?(k.to_sym)

    h[k.to_sym] = v
  end

  self.contact_id = attributes[:contact_id] if attributes.key?(:contact_id)

  self.url = attributes[:url] if attributes.key?(:url)

  self.id = attributes[:id] if attributes.key?(:id)

  self.campaign_id = attributes[:campaign_id] if attributes.key?(:campaign_id)

  self.date_clicked = attributes[:date_clicked] if attributes.key?(:date_clicked)

  return unless attributes.key?(:query_string)

  self.query_string = attributes[:query_string]
end

Instance Attribute Details

#campaign_id ⇒ Object

Returns the value of attribute campaign_id.



16
17
18
 
# File 'lib/connect_wise/models/link_clicked.rb', line 16

def campaign_id
  @campaign_id
end

#contact_id ⇒ Object

Returns the value of attribute contact_id.



16
17
18
 
# File 'lib/connect_wise/models/link_clicked.rb', line 16

def contact_id
  @contact_id
end

#date_clicked ⇒ Object

Returns the value of attribute date_clicked.



16
17
18
 
# File 'lib/connect_wise/models/link_clicked.rb', line 16

def date_clicked
  @date_clicked
end

#id ⇒ Object

Returns the value of attribute id.



16
17
18
 
# File 'lib/connect_wise/models/link_clicked.rb', line 16

def id
  @id
end

#query_string ⇒ Object

Returns the value of attribute query_string.



16
17
18
 
# File 'lib/connect_wise/models/link_clicked.rb', line 16

def query_string
  @query_string
end

#url ⇒ Object

Max length: 2083;



19
20
21
 
# File 'lib/connect_wise/models/link_clicked.rb', line 19

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



34
35
36
 
# File 'lib/connect_wise/models/link_clicked.rb', line 34

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/connect_wise/models/link_clicked.rb', line 22

def self.attribute_map
  {
    contact_id: :contactId,
    url: :url,
    id: :id,
    campaign_id: :campaignId,
    date_clicked: :dateClicked,
    query_string: :queryString
  }
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



131
132
133
 
# File 'lib/connect_wise/models/link_clicked.rb', line 131

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



51
52
53
54
55
56
 
# File 'lib/connect_wise/models/link_clicked.rb', line 51

def self.openapi_nullable
  Set.new(%i[
            contact_id
            campaign_id
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/connect_wise/models/link_clicked.rb', line 39

def self.openapi_types
  {
    contact_id: :Integer,
    url: :String,
    id: :Integer,
    campaign_id: :Integer,
    date_clicked: :Time,
    query_string: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/connect_wise/models/link_clicked.rb', line 104

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    contact_id == other.contact_id &&
    url == other.url &&
    id == other.id &&
    campaign_id == other.campaign_id &&
    date_clicked == other.date_clicked &&
    query_string == other.query_string
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



161
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
 
# File 'lib/connect_wise/models/link_clicked.rb', line 161

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 = ConnectWise.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



232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/connect_wise/models/link_clicked.rb', line 232

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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/connect_wise/models/link_clicked.rb', line 138

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)
      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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


118
119
120
 
# File 'lib/connect_wise/models/link_clicked.rb', line 118

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



124
125
126
 
# File 'lib/connect_wise/models/link_clicked.rb', line 124

def hash
  [contact_id, url, id, campaign_id, date_clicked, query_string].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



87
88
89
90
91
92
 
# File 'lib/connect_wise/models/link_clicked.rb', line 87

def list_invalid_properties
  invalid_properties = []
  invalid_properties.push('invalid value for "url", url cannot be nil.') if @url.nil?

  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



208
209
210
 
# File 'lib/connect_wise/models/link_clicked.rb', line 208

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



214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/connect_wise/models/link_clicked.rb', line 214

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



202
203
204
 
# File 'lib/connect_wise/models/link_clicked.rb', line 202

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



96
97
98
99
100
 
# File 'lib/connect_wise/models/link_clicked.rb', line 96

def valid?
  return false if @url.nil?

  true
end