Class: ConnectWise::OpportunityToAgreementConversion

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OpportunityToAgreementConversion

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
157
158
159
160
161
162
 
# File 'lib/connectwise-ruby-sdk/models/opportunity_to_agreement_conversion.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?(:'agreementId')
    self.agreement_id = attributes[:'agreementId']
  end

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'includeNoteIds')
    if (value = attributes[:'includeNoteIds']).is_a?(Array)
      self.include_note_ids = value
    end
  end

  if attributes.has_key?(:'includeDocumentIds')
    if (value = attributes[:'includeDocumentIds']).is_a?(Array)
      self.include_document_ids = value
    end
  end

  if attributes.has_key?(:'includeProductIds')
    if (value = attributes[:'includeProductIds']).is_a?(Array)
      self.include_product_ids = value
    end
  end

end

Instance Attribute Details

#agreement_id ⇒ Object

Returns the value of attribute agreement_id.



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

def agreement_id
  @agreement_id
end

#bill_cycle_id ⇒ Object

Returns the value of attribute bill_cycle_id.



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

def bill_cycle_id
  @bill_cycle_id
end

#bill_one_time_flag ⇒ Object

Returns the value of attribute bill_one_time_flag.



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

def bill_one_time_flag
  @bill_one_time_flag
end

#business_unit_id ⇒ Object

Returns the value of attribute business_unit_id.



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

def business_unit_id
  @business_unit_id
end

#end_date ⇒ Object

Returns the value of attribute end_date.



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

def end_date
  @end_date
end

#include_all_documents_flag ⇒ Object

Returns the value of attribute include_all_documents_flag.



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

def include_all_documents_flag
  @include_all_documents_flag
end

#include_all_notes_flag ⇒ Object

Returns the value of attribute include_all_notes_flag.



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

def include_all_notes_flag
  @include_all_notes_flag
end

#include_all_products_flag ⇒ Object

Returns the value of attribute include_all_products_flag.



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

def include_all_products_flag
  @include_all_products_flag
end

#include_document_ids ⇒ Object

Returns the value of attribute include_document_ids.



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

def include_document_ids
  @include_document_ids
end

#include_note_ids ⇒ Object

Returns the value of attribute include_note_ids.



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

def include_note_ids
  @include_note_ids
end

#include_product_ids ⇒ Object

Returns the value of attribute include_product_ids.



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

def include_product_ids
  @include_product_ids
end

#location_id ⇒ Object

Returns the value of attribute location_id.



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

def location_id
  @location_id
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#no_ending_date_flag ⇒ Object

Returns the value of attribute no_ending_date_flag.



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

def no_ending_date_flag
  @no_ending_date_flag
end

#start_date ⇒ Object

Returns the value of attribute start_date.



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

def start_date
  @start_date
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
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/opportunity_to_agreement_conversion.rb', line 41

def self.attribute_map
  {
    :'agreement_id' => :'agreementId',
    :'name' => :'name',
    :'type' => :'type',
    :'start_date' => :'startDate',
    :'end_date' => :'endDate',
    :'no_ending_date_flag' => :'noEndingDateFlag',
    :'bill_cycle_id' => :'billCycleId',
    :'bill_one_time_flag' => :'billOneTimeFlag',
    :'location_id' => :'locationId',
    :'business_unit_id' => :'businessUnitId',
    :'include_all_notes_flag' => :'includeAllNotesFlag',
    :'include_all_documents_flag' => :'includeAllDocumentsFlag',
    :'include_all_products_flag' => :'includeAllProductsFlag',
    :'include_note_ids' => :'includeNoteIds',
    :'include_document_ids' => :'includeDocumentIds',
    :'include_product_ids' => :'includeProductIds'
  }
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/opportunity_to_agreement_conversion.rb', line 63

def self.swagger_types
  {
    :'agreement_id' => :'Integer',
    :'name' => :'String',
    :'type' => :'AgreementTypeReference',
    :'start_date' => :'String',
    :'end_date' => :'String',
    :'no_ending_date_flag' => :'BOOLEAN',
    :'bill_cycle_id' => :'Integer',
    :'bill_one_time_flag' => :'BOOLEAN',
    :'location_id' => :'Integer',
    :'business_unit_id' => :'Integer',
    :'include_all_notes_flag' => :'BOOLEAN',
    :'include_all_documents_flag' => :'BOOLEAN',
    :'include_all_products_flag' => :'BOOLEAN',
    :'include_note_ids' => :'Array<Integer>',
    :'include_document_ids' => :'Array<Integer>',
    :'include_product_ids' => :'Array<Integer>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/connectwise-ruby-sdk/models/opportunity_to_agreement_conversion.rb', line 179

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      agreement_id == o.agreement_id &&
      name == o.name &&
      type == o.type &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      no_ending_date_flag == o.no_ending_date_flag &&
      bill_cycle_id == o.bill_cycle_id &&
      bill_one_time_flag == o.bill_one_time_flag &&
      location_id == o.location_id &&
      business_unit_id == o.business_unit_id &&
      include_all_notes_flag == o.include_all_notes_flag &&
      include_all_documents_flag == o.include_all_documents_flag &&
      include_all_products_flag == o.include_all_products_flag &&
      include_note_ids == o.include_note_ids &&
      include_document_ids == o.include_document_ids &&
      include_product_ids == o.include_product_ids
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



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
267
268
269
270
271
272
 
# File 'lib/connectwise-ruby-sdk/models/opportunity_to_agreement_conversion.rb', line 236

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



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/connectwise-ruby-sdk/models/opportunity_to_agreement_conversion.rb', line 302

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/connectwise-ruby-sdk/models/opportunity_to_agreement_conversion.rb', line 215

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



208
209
210
 
# File 'lib/connectwise-ruby-sdk/models/opportunity_to_agreement_conversion.rb', line 208

def hash
  [agreement_id, name, type, start_date, end_date, no_ending_date_flag, bill_cycle_id, bill_one_time_flag, location_id, business_unit_id, include_all_notes_flag, include_all_documents_flag, include_all_products_flag, include_note_ids, include_document_ids, include_product_ids].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



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

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



282
283
284
 
# File 'lib/connectwise-ruby-sdk/models/opportunity_to_agreement_conversion.rb', line 282

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



288
289
290
291
292
293
294
295
296
 
# File 'lib/connectwise-ruby-sdk/models/opportunity_to_agreement_conversion.rb', line 288

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



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

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



173
174
175
 
# File 'lib/connectwise-ruby-sdk/models/opportunity_to_agreement_conversion.rb', line 173

def valid?
  return true
end