Class: ConnectWise::FormSubmitted

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/models/form_submitted.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FormSubmitted

Initializes the object

Parameters:

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

    Model attributes in the form of hash



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 66

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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#campaign_idObject

Returns the value of attribute campaign_id.



9
10
11
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 9

def campaign_id
  @campaign_id
end

#contact_idObject

Returns the value of attribute contact_id.



11
12
13
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 11

def contact_id
  @contact_id
end

#date_submittedObject

Returns the value of attribute date_submitted.



13
14
15
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 13

def 
  @date_submitted
end

#idObject

Returns the value of attribute id.



7
8
9
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 7

def id
  @id
end

#page_sub_typeObject

Returns the value of attribute page_sub_type.



21
22
23
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 21

def page_sub_type
  @page_sub_type
end

#page_typeObject

Returns the value of attribute page_type.



19
20
21
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 19

def page_type
  @page_type
end

#query_stringObject

Returns the value of attribute query_string.



17
18
19
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 17

def query_string
  @query_string
end

#statusObject

Returns the value of attribute status.



27
28
29
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 27

def status
  @status
end

#topicObject

Returns the value of attribute topic.



23
24
25
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 23

def topic
  @topic
end

#urlObject

Returns the value of attribute url.



15
16
17
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 15

def url
  @url
end

#versionObject

Returns the value of attribute version.



25
26
27
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 25

def version
  @version
end

Class Method Details

.attribute_mapObject

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



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 31

def self.attribute_map
  {
    :'id' => :'id',
    :'campaign_id' => :'campaignId',
    :'contact_id' => :'contactId',
    :'date_submitted' => :'dateSubmitted',
    :'url' => :'url',
    :'query_string' => :'queryString',
    :'page_type' => :'pageType',
    :'page_sub_type' => :'pageSubType',
    :'topic' => :'topic',
    :'version' => :'version',
    :'status' => :'status'
  }
end

.swagger_typesObject

Attribute type mapping.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 48

def self.swagger_types
  {
    :'id' => :'Integer',
    :'campaign_id' => :'Integer',
    :'contact_id' => :'Integer',
    :'date_submitted' => :'DateTime',
    :'url' => :'String',
    :'query_string' => :'String',
    :'page_type' => :'String',
    :'page_sub_type' => :'String',
    :'topic' => :'String',
    :'version' => :'String',
    :'status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 162

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      campaign_id == o.campaign_id &&
      contact_id == o.contact_id &&
       == o. &&
      url == o.url &&
      query_string == o.query_string &&
      page_type == o.page_type &&
      page_sub_type == o.page_sub_type &&
      topic == o.topic &&
      version == o.version &&
      status == o.status
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



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
246
247
248
249
250
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 214

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



280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 280

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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 193

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 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


180
181
182
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 180

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



186
187
188
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 186

def hash
  [id, campaign_id, contact_id, , url, query_string, page_type, page_sub_type, topic, version, status].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 120

def list_invalid_properties
  invalid_properties = Array.new
  if @contact_id.nil?
    invalid_properties.push("invalid value for 'contact_id', contact_id cannot be nil.")
  end

  if @url.nil?
    invalid_properties.push("invalid value for 'url', url cannot be nil.")
  end

  if @url.to_s.length > 2083
    invalid_properties.push("invalid value for 'url', the character length must be smaller than or equal to 2083.")
  end

  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



260
261
262
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 260

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



266
267
268
269
270
271
272
273
274
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 266

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



254
255
256
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 254

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



139
140
141
142
143
144
# File 'lib/connectwise-ruby-sdk/models/form_submitted.rb', line 139

def valid?
  return false if @contact_id.nil?
  return false if @url.nil?
  return false if @url.to_s.length > 2083
  return true
end