Class: ConnectWise::EmailToken

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailToken

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 86

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#address_flag ⇒ Object

Returns the value of attribute address_flag.



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

def address_flag
  @address_flag
end

#agreement_flag ⇒ Object

Returns the value of attribute agreement_flag.



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

def agreement_flag
  @agreement_flag
end

#company_flag ⇒ Object

Returns the value of attribute company_flag.



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

def company_flag
  @company_flag
end

#config_flag ⇒ Object

Returns the value of attribute config_flag.



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

def config_flag
  @config_flag
end

#contact_flag ⇒ Object

Returns the value of attribute contact_flag.



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

def contact_flag
  @contact_flag
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#invoice_flag ⇒ Object

Returns the value of attribute invoice_flag.



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

def invoice_flag
  @invoice_flag
end

#purchase_order_flag ⇒ Object

Returns the value of attribute purchase_order_flag.



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

def purchase_order_flag
  @purchase_order_flag
end

#purchase_order_status_flag ⇒ Object

Returns the value of attribute purchase_order_status_flag.



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

def purchase_order_status_flag
  @purchase_order_status_flag
end

#rma_flag ⇒ Object

Returns the value of attribute rma_flag.



29
30
31
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 29

def rma_flag
  @rma_flag
end

#sales_flag ⇒ Object

Returns the value of attribute sales_flag.



31
32
33
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 31

def sales_flag
  @sales_flag
end

#service_flag ⇒ Object

Returns the value of attribute service_flag.



33
34
35
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 33

def service_flag
  @service_flag
end

#token ⇒ Object

Returns the value of attribute token.



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

def token
  @token
end

#tracks_flag ⇒ Object

Returns the value of attribute tracks_flag.



35
36
37
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 35

def tracks_flag
  @tracks_flag
end

#workflow_flag ⇒ Object

Returns the value of attribute workflow_flag.



37
38
39
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 37

def workflow_flag
  @workflow_flag
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 41

def self.attribute_map
  {
    :'id' => :'id',
    :'token' => :'token',
    :'description' => :'description',
    :'address_flag' => :'addressFlag',
    :'agreement_flag' => :'agreementFlag',
    :'company_flag' => :'companyFlag',
    :'config_flag' => :'configFlag',
    :'contact_flag' => :'contactFlag',
    :'invoice_flag' => :'invoiceFlag',
    :'purchase_order_flag' => :'purchaseOrderFlag',
    :'purchase_order_status_flag' => :'purchaseOrderStatusFlag',
    :'rma_flag' => :'rmaFlag',
    :'sales_flag' => :'salesFlag',
    :'service_flag' => :'serviceFlag',
    :'tracks_flag' => :'tracksFlag',
    :'workflow_flag' => :'workflowFlag'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 63

def self.swagger_types
  {
    :'id' => :'Integer',
    :'token' => :'String',
    :'description' => :'String',
    :'address_flag' => :'BOOLEAN',
    :'agreement_flag' => :'BOOLEAN',
    :'company_flag' => :'BOOLEAN',
    :'config_flag' => :'BOOLEAN',
    :'contact_flag' => :'BOOLEAN',
    :'invoice_flag' => :'BOOLEAN',
    :'purchase_order_flag' => :'BOOLEAN',
    :'purchase_order_status_flag' => :'BOOLEAN',
    :'rma_flag' => :'BOOLEAN',
    :'sales_flag' => :'BOOLEAN',
    :'service_flag' => :'BOOLEAN',
    :'tracks_flag' => :'BOOLEAN',
    :'workflow_flag' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 173

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      token == o.token &&
      description == o.description &&
      address_flag == o.address_flag &&
      agreement_flag == o.agreement_flag &&
      company_flag == o.company_flag &&
      config_flag == o.config_flag &&
      contact_flag == o.contact_flag &&
      invoice_flag == o.invoice_flag &&
      purchase_order_flag == o.purchase_order_flag &&
      purchase_order_status_flag == o.purchase_order_status_flag &&
      rma_flag == o.rma_flag &&
      sales_flag == o.sales_flag &&
      service_flag == o.service_flag &&
      tracks_flag == o.tracks_flag &&
      workflow_flag == o.workflow_flag
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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 230

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



296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 296

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 209

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


196
197
198
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 196

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



202
203
204
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 202

def hash
  [id, token, description, address_flag, agreement_flag, company_flag, config_flag, contact_flag, invoice_flag, purchase_order_flag, purchase_order_status_flag, rma_flag, sales_flag, service_flag, tracks_flag, workflow_flag].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



160
161
162
163
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 160

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



276
277
278
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 276

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



282
283
284
285
286
287
288
289
290
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 282

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



270
271
272
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 270

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



167
168
169
 
# File 'lib/connectwise-ruby-sdk/models/email_token.rb', line 167

def valid?
  return true
end