Class: ConnectWise::OpportunityToAgreementConversion

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/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

Raises:

  • (ArgumentError) 


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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/connect_wise/models/opportunity_to_agreement_conversion.rb', line 83

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `ConnectWise::OpportunityToAgreementConversion` 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::OpportunityToAgreementConversion`. 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.agreement_id = attributes[:agreement_id] if attributes.key?(:agreement_id)

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:include_note_ids) && (value = attributes[:include_note_ids]).is_a?(Array)
    self.include_note_ids = value
  end

  if attributes.key?(:include_document_ids) && (value = attributes[:include_document_ids]).is_a?(Array)
    self.include_document_ids = value
  end

  return unless attributes.key?(:include_product_ids)
  return unless (value = attributes[:include_product_ids]).is_a?(Array)

  self.include_product_ids = value
end

Instance Attribute Details

#agreement_id ⇒ Object

Returns the value of attribute agreement_id.



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

def agreement_id
  @agreement_id
end

#bill_cycle_id ⇒ Object

Returns the value of attribute bill_cycle_id.



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

def bill_cycle_id
  @bill_cycle_id
end

#bill_one_time_flag ⇒ Object

Returns the value of attribute bill_one_time_flag.



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

def bill_one_time_flag
  @bill_one_time_flag
end

#business_unit_id ⇒ Object

Returns the value of attribute business_unit_id.



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

def business_unit_id
  @business_unit_id
end

#end_date ⇒ Object

Returns the value of attribute end_date.



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

def end_date
  @end_date
end

#include_all_documents_flag ⇒ Object

Returns the value of attribute include_all_documents_flag.



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

def include_all_documents_flag
  @include_all_documents_flag
end

#include_all_notes_flag ⇒ Object

Returns the value of attribute include_all_notes_flag.



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

def include_all_notes_flag
  @include_all_notes_flag
end

#include_all_products_flag ⇒ Object

Returns the value of attribute include_all_products_flag.



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

def include_all_products_flag
  @include_all_products_flag
end

#include_document_ids ⇒ Object

Returns the value of attribute include_document_ids.



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

def include_document_ids
  @include_document_ids
end

#include_note_ids ⇒ Object

Returns the value of attribute include_note_ids.



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

def include_note_ids
  @include_note_ids
end

#include_product_ids ⇒ Object

Returns the value of attribute include_product_ids.



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

def include_product_ids
  @include_product_ids
end

#location_id ⇒ Object

Returns the value of attribute location_id.



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

def location_id
  @location_id
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#no_ending_date_flag ⇒ Object

Returns the value of attribute no_ending_date_flag.



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

def no_ending_date_flag
  @no_ending_date_flag
end

#start_date ⇒ Object

Returns the value of attribute start_date.



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

def start_date
  @start_date
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



41
42
43
 
# File 'lib/connect_wise/models/opportunity_to_agreement_conversion.rb', line 41

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/connect_wise/models/opportunity_to_agreement_conversion.rb', line 19

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

.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



184
185
186
 
# File 'lib/connect_wise/models/opportunity_to_agreement_conversion.rb', line 184

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/connect_wise/models/opportunity_to_agreement_conversion.rb', line 68

def self.openapi_nullable
  Set.new(i[
            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
          ])
end

.openapi_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/connect_wise/models/opportunity_to_agreement_conversion.rb', line 46

def self.openapi_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

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/connect_wise/models/opportunity_to_agreement_conversion.rb', line 147

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

  self.class == other.class &&
    agreement_id == other.agreement_id &&
    name == other.name &&
    type == other.type &&
    start_date == other.start_date &&
    end_date == other.end_date &&
    no_ending_date_flag == other.no_ending_date_flag &&
    bill_cycle_id == other.bill_cycle_id &&
    bill_one_time_flag == other.bill_one_time_flag &&
    location_id == other.location_id &&
    business_unit_id == other.business_unit_id &&
    include_all_notes_flag == other.include_all_notes_flag &&
    include_all_documents_flag == other.include_all_documents_flag &&
    include_all_products_flag == other.include_all_products_flag &&
    include_note_ids == other.include_note_ids &&
    include_document_ids == other.include_document_ids &&
    include_product_ids == other.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



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
251
 
# File 'lib/connect_wise/models/opportunity_to_agreement_conversion.rb', line 214

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



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/connect_wise/models/opportunity_to_agreement_conversion.rb', line 285

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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/connect_wise/models/opportunity_to_agreement_conversion.rb', line 191

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


171
172
173
 
# File 'lib/connect_wise/models/opportunity_to_agreement_conversion.rb', line 171

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



177
178
179
 
# File 'lib/connect_wise/models/opportunity_to_agreement_conversion.rb', line 177

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 properties with the reasons



135
136
137
 
# File 'lib/connect_wise/models/opportunity_to_agreement_conversion.rb', line 135

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



261
262
263
 
# File 'lib/connect_wise/models/opportunity_to_agreement_conversion.rb', line 261

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



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/connect_wise/models/opportunity_to_agreement_conversion.rb', line 267

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



255
256
257
 
# File 'lib/connect_wise/models/opportunity_to_agreement_conversion.rb', line 255

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



141
142
143
 
# File 'lib/connect_wise/models/opportunity_to_agreement_conversion.rb', line 141

def valid?
  true
end