Class: ConnectWise::AgreementType

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AgreementType

Initializes the object

Parameters:

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

    Model attributes in the form of hash



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 296

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#_infoObject

Metadata of the entity



132
133
134
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 132

def _info
  @_info
end

#add_all_work_role_exclusionsObject

Returns the value of attribute add_all_work_role_exclusions.



115
116
117
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 115

def add_all_work_role_exclusions
  @add_all_work_role_exclusions
end

#add_all_work_type_exclusionsObject

Returns the value of attribute add_all_work_type_exclusions.



121
122
123
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 121

def add_all_work_type_exclusions
  @add_all_work_type_exclusions
end

#allow_overruns_flagObject

Returns the value of attribute allow_overruns_flag.



51
52
53
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 51

def allow_overruns_flag
  @allow_overruns_flag
end

#application_cycleObject

Returns the value of attribute application_cycle.



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

def application_cycle
  @application_cycle
end

#application_limitObject

Returns the value of attribute application_limit.



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

def application_limit
  @application_limit
end

#application_unitsObject

Returns the value of attribute application_units.



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

def application_units
  @application_units
end

#application_unlimited_flagObject

Returns the value of attribute application_unlimited_flag.



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

def application_unlimited_flag
  @application_unlimited_flag
end

#bill_amountObject

Returns the value of attribute bill_amount.



77
78
79
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 77

def bill_amount
  @bill_amount
end

#bill_expensesObject

Returns the value of attribute bill_expenses.



99
100
101
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 99

def bill_expenses
  @bill_expenses
end

#bill_one_time_flagObject

Returns the value of attribute bill_one_time_flag.



71
72
73
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 71

def bill_one_time_flag
  @bill_one_time_flag
end

#bill_productsObject

Returns the value of attribute bill_products.



101
102
103
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 101

def bill_products
  @bill_products
end

#bill_timeObject

Returns the value of attribute bill_time.



97
98
99
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 97

def bill_time
  @bill_time
end

#billable_expense_invoice_flagObject

Returns the value of attribute billable_expense_invoice_flag.



105
106
107
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 105

def billable_expense_invoice_flag
  @billable_expense_invoice_flag
end

#billable_product_invoice_flagObject

Returns the value of attribute billable_product_invoice_flag.



107
108
109
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 107

def billable_product_invoice_flag
  @billable_product_invoice_flag
end

#billable_time_invoice_flagObject

Returns the value of attribute billable_time_invoice_flag.



103
104
105
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 103

def billable_time_invoice_flag
  @billable_time_invoice_flag
end

#billing_cycleObject

Returns the value of attribute billing_cycle.



69
70
71
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 69

def billing_cycle
  @billing_cycle
end

#billing_termsObject

Returns the value of attribute billing_terms.



73
74
75
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 73

def billing_terms
  @billing_terms
end

#bottom_comment_flagObject

Returns the value of attribute bottom_comment_flag.



87
88
89
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 87

def bottom_comment_flag
  @bottom_comment_flag
end

#carry_over_unused_flagObject

Returns the value of attribute carry_over_unused_flag.



49
50
51
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 49

def carry_over_unused_flag
  @carry_over_unused_flag
end

#charge_to_firm_flagObject

Returns the value of attribute charge_to_firm_flag.



59
60
61
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 59

def charge_to_firm_flag
  @charge_to_firm_flag
end

#comp_hourly_rateObject

Returns the value of attribute comp_hourly_rate.



65
66
67
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 65

def comp_hourly_rate
  @comp_hourly_rate
end

#comp_limit_amountObject

Returns the value of attribute comp_limit_amount.



67
68
69
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 67

def comp_limit_amount
  @comp_limit_amount
end

#copy_work_roles_flagObject

Returns the value of attribute copy_work_roles_flag.



109
110
111
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 109

def copy_work_roles_flag
  @copy_work_roles_flag
end

#copy_work_types_flagObject

Returns the value of attribute copy_work_types_flag.



111
112
113
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 111

def copy_work_types_flag
  @copy_work_types_flag
end

#cover_agreement_expense_flagObject

Returns the value of attribute cover_agreement_expense_flag.



45
46
47
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 45

def cover_agreement_expense_flag
  @cover_agreement_expense_flag
end

#cover_agreement_product_flagObject

Returns the value of attribute cover_agreement_product_flag.



43
44
45
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 43

def cover_agreement_product_flag
  @cover_agreement_product_flag
end

#cover_agreement_time_flagObject

Returns the value of attribute cover_agreement_time_flag.



41
42
43
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 41

def cover_agreement_time_flag
  @cover_agreement_time_flag
end

#cover_sales_tax_flagObject

Returns the value of attribute cover_sales_tax_flag.



47
48
49
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 47

def cover_sales_tax_flag
  @cover_sales_tax_flag
end

#default_flagObject

Returns the value of attribute default_flag.



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

def default_flag
  @default_flag
end

#departmentObject

Returns the value of attribute department.



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

def department
  @department
end

#email_templateObject

Returns the value of attribute email_template.



129
130
131
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 129

def email_template
  @email_template
end

#employee_comp_not_exceedObject

Returns the value of attribute employee_comp_not_exceed.



63
64
65
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 63

def employee_comp_not_exceed
  @employee_comp_not_exceed
end

#employee_comp_rateObject

Returns the value of attribute employee_comp_rate.



61
62
63
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 61

def employee_comp_rate
  @employee_comp_rate
end

#exclusion_work_role_idsObject

Returns the value of attribute exclusion_work_role_ids.



113
114
115
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 113

def exclusion_work_role_ids
  @exclusion_work_role_ids
end

#exclusion_work_type_idsObject

Returns the value of attribute exclusion_work_type_ids.



119
120
121
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 119

def exclusion_work_type_ids
  @exclusion_work_type_ids
end

#expire_when_zeroObject

Returns the value of attribute expire_when_zero.



57
58
59
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 57

def expire_when_zero
  @expire_when_zero
end

#expired_daysObject

Returns the value of attribute expired_days.



53
54
55
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 53

def expired_days
  @expired_days
end

#idObject

Returns the value of attribute id.



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

def id
  @id
end

#inactive_flagObject

Returns the value of attribute inactive_flag.



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

def inactive_flag
  @inactive_flag
end

#integration_x_refObject

Returns the value of attribute integration_x_ref.



125
126
127
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 125

def integration_x_ref
  @integration_x_ref
end

#invoice_descriptionObject

Returns the value of attribute invoice_description.



83
84
85
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 83

def invoice_description
  @invoice_description
end

#invoice_pre_suffixObject

Returns the value of attribute invoice_pre_suffix.



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

def invoice_pre_suffix
  @invoice_pre_suffix
end

#invoice_templateObject

Returns the value of attribute invoice_template.



95
96
97
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 95

def invoice_template
  @invoice_template
end

#invoicing_cycleObject

Returns the value of attribute invoicing_cycle.



75
76
77
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 75

def invoicing_cycle
  @invoicing_cycle
end

#limitObject

Returns the value of attribute limit.



55
56
57
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 55

def limit
  @limit
end

#locationObject

Returns the value of attribute location.



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

def location
  @location
end

#nameObject

Returns the value of attribute name.



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

def name
  @name
end

#one_time_flagObject

Returns the value of attribute one_time_flag.



39
40
41
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 39

def one_time_flag
  @one_time_flag
end

#pre_payment_flagObject

Returns the value of attribute pre_payment_flag.



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

def pre_payment_flag
  @pre_payment_flag
end

#prefix_suffix_optionObject

Returns the value of attribute prefix_suffix_option.



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

def prefix_suffix_option
  @prefix_suffix_option
end

#project_typeObject

Returns the value of attribute project_type.



93
94
95
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 93

def project_type
  @project_type
end

#prorate_flagObject

Returns the value of attribute prorate_flag.



127
128
129
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 127

def prorate_flag
  @prorate_flag
end

#remove_all_work_role_exclusionsObject

Returns the value of attribute remove_all_work_role_exclusions.



117
118
119
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 117

def remove_all_work_role_exclusions
  @remove_all_work_role_exclusions
end

#remove_all_work_type_exclusionsObject

Returns the value of attribute remove_all_work_type_exclusions.



123
124
125
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 123

def remove_all_work_type_exclusions
  @remove_all_work_type_exclusions
end

#restrict_department_flagObject

Returns the value of attribute restrict_department_flag.



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

def restrict_department_flag
  @restrict_department_flag
end

#restrict_down_payment_flagObject

Returns the value of attribute restrict_down_payment_flag.



81
82
83
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 81

def restrict_down_payment_flag
  @restrict_down_payment_flag
end

#restrict_location_flagObject

Returns the value of attribute restrict_location_flag.



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

def restrict_location_flag
  @restrict_location_flag
end

#slaObject

Returns the value of attribute sla.



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

def sla
  @sla
end

#taxable_flagObject

Returns the value of attribute taxable_flag.



79
80
81
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 79

def taxable_flag
  @taxable_flag
end

#top_comment_flagObject

Returns the value of attribute top_comment_flag.



85
86
87
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 85

def top_comment_flag
  @top_comment_flag
end

#work_roleObject

Returns the value of attribute work_role.



89
90
91
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 89

def work_role
  @work_role
end

#work_typeObject

Returns the value of attribute work_type.



91
92
93
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 91

def work_type
  @work_type
end

Class Method Details

.attribute_mapObject

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



157
158
159
160
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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 157

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'prefix_suffix_option' => :'prefixSuffixOption',
    :'default_flag' => :'defaultFlag',
    :'inactive_flag' => :'inactiveFlag',
    :'pre_payment_flag' => :'prePaymentFlag',
    :'invoice_pre_suffix' => :'invoicePreSuffix',
    :'location' => :'location',
    :'department' => :'department',
    :'restrict_location_flag' => :'restrictLocationFlag',
    :'restrict_department_flag' => :'restrictDepartmentFlag',
    :'sla' => :'sla',
    :'application_units' => :'applicationUnits',
    :'application_limit' => :'applicationLimit',
    :'application_cycle' => :'applicationCycle',
    :'application_unlimited_flag' => :'applicationUnlimitedFlag',
    :'one_time_flag' => :'oneTimeFlag',
    :'cover_agreement_time_flag' => :'coverAgreementTimeFlag',
    :'cover_agreement_product_flag' => :'coverAgreementProductFlag',
    :'cover_agreement_expense_flag' => :'coverAgreementExpenseFlag',
    :'cover_sales_tax_flag' => :'coverSalesTaxFlag',
    :'carry_over_unused_flag' => :'carryOverUnusedFlag',
    :'allow_overruns_flag' => :'allowOverrunsFlag',
    :'expired_days' => :'expiredDays',
    :'limit' => :'limit',
    :'expire_when_zero' => :'expireWhenZero',
    :'charge_to_firm_flag' => :'chargeToFirmFlag',
    :'employee_comp_rate' => :'employeeCompRate',
    :'employee_comp_not_exceed' => :'employeeCompNotExceed',
    :'comp_hourly_rate' => :'compHourlyRate',
    :'comp_limit_amount' => :'compLimitAmount',
    :'billing_cycle' => :'billingCycle',
    :'bill_one_time_flag' => :'billOneTimeFlag',
    :'billing_terms' => :'billingTerms',
    :'invoicing_cycle' => :'invoicingCycle',
    :'bill_amount' => :'billAmount',
    :'taxable_flag' => :'taxableFlag',
    :'restrict_down_payment_flag' => :'restrictDownPaymentFlag',
    :'invoice_description' => :'invoiceDescription',
    :'top_comment_flag' => :'topCommentFlag',
    :'bottom_comment_flag' => :'bottomCommentFlag',
    :'work_role' => :'workRole',
    :'work_type' => :'workType',
    :'project_type' => :'projectType',
    :'invoice_template' => :'invoiceTemplate',
    :'bill_time' => :'billTime',
    :'bill_expenses' => :'billExpenses',
    :'bill_products' => :'billProducts',
    :'billable_time_invoice_flag' => :'billableTimeInvoiceFlag',
    :'billable_expense_invoice_flag' => :'billableExpenseInvoiceFlag',
    :'billable_product_invoice_flag' => :'billableProductInvoiceFlag',
    :'copy_work_roles_flag' => :'copyWorkRolesFlag',
    :'copy_work_types_flag' => :'copyWorkTypesFlag',
    :'exclusion_work_role_ids' => :'exclusionWorkRoleIds',
    :'add_all_work_role_exclusions' => :'addAllWorkRoleExclusions',
    :'remove_all_work_role_exclusions' => :'removeAllWorkRoleExclusions',
    :'exclusion_work_type_ids' => :'exclusionWorkTypeIds',
    :'add_all_work_type_exclusions' => :'addAllWorkTypeExclusions',
    :'remove_all_work_type_exclusions' => :'removeAllWorkTypeExclusions',
    :'integration_x_ref' => :'integrationXRef',
    :'prorate_flag' => :'prorateFlag',
    :'email_template' => :'emailTemplate',
    :'_info' => :'_info'
  }
end

.swagger_typesObject

Attribute type mapping.



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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 226

def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'prefix_suffix_option' => :'String',
    :'default_flag' => :'BOOLEAN',
    :'inactive_flag' => :'BOOLEAN',
    :'pre_payment_flag' => :'BOOLEAN',
    :'invoice_pre_suffix' => :'String',
    :'location' => :'SystemLocationReference',
    :'department' => :'SystemDepartmentReference',
    :'restrict_location_flag' => :'BOOLEAN',
    :'restrict_department_flag' => :'BOOLEAN',
    :'sla' => :'SLAReference',
    :'application_units' => :'String',
    :'application_limit' => :'Float',
    :'application_cycle' => :'String',
    :'application_unlimited_flag' => :'BOOLEAN',
    :'one_time_flag' => :'BOOLEAN',
    :'cover_agreement_time_flag' => :'BOOLEAN',
    :'cover_agreement_product_flag' => :'BOOLEAN',
    :'cover_agreement_expense_flag' => :'BOOLEAN',
    :'cover_sales_tax_flag' => :'BOOLEAN',
    :'carry_over_unused_flag' => :'BOOLEAN',
    :'allow_overruns_flag' => :'BOOLEAN',
    :'expired_days' => :'Integer',
    :'limit' => :'Integer',
    :'expire_when_zero' => :'BOOLEAN',
    :'charge_to_firm_flag' => :'BOOLEAN',
    :'employee_comp_rate' => :'String',
    :'employee_comp_not_exceed' => :'String',
    :'comp_hourly_rate' => :'Float',
    :'comp_limit_amount' => :'Float',
    :'billing_cycle' => :'BillingCycleReference',
    :'bill_one_time_flag' => :'BOOLEAN',
    :'billing_terms' => :'BillingTermsReference',
    :'invoicing_cycle' => :'String',
    :'bill_amount' => :'Float',
    :'taxable_flag' => :'BOOLEAN',
    :'restrict_down_payment_flag' => :'BOOLEAN',
    :'invoice_description' => :'String',
    :'top_comment_flag' => :'BOOLEAN',
    :'bottom_comment_flag' => :'BOOLEAN',
    :'work_role' => :'WorkRoleReference',
    :'work_type' => :'WorkTypeReference',
    :'project_type' => :'ProjectTypeReference',
    :'invoice_template' => :'InvoiceTemplateReference',
    :'bill_time' => :'String',
    :'bill_expenses' => :'String',
    :'bill_products' => :'String',
    :'billable_time_invoice_flag' => :'BOOLEAN',
    :'billable_expense_invoice_flag' => :'BOOLEAN',
    :'billable_product_invoice_flag' => :'BOOLEAN',
    :'copy_work_roles_flag' => :'BOOLEAN',
    :'copy_work_types_flag' => :'BOOLEAN',
    :'exclusion_work_role_ids' => :'Array<Integer>',
    :'add_all_work_role_exclusions' => :'BOOLEAN',
    :'remove_all_work_role_exclusions' => :'BOOLEAN',
    :'exclusion_work_type_ids' => :'Array<Integer>',
    :'add_all_work_type_exclusions' => :'BOOLEAN',
    :'remove_all_work_type_exclusions' => :'BOOLEAN',
    :'integration_x_ref' => :'String',
    :'prorate_flag' => :'BOOLEAN',
    :'email_template' => :'EmailTemplateReference',
    :'_info' => :'Metadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 835

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      prefix_suffix_option == o.prefix_suffix_option &&
      default_flag == o.default_flag &&
      inactive_flag == o.inactive_flag &&
      pre_payment_flag == o.pre_payment_flag &&
      invoice_pre_suffix == o.invoice_pre_suffix &&
      location == o.location &&
      department == o.department &&
      restrict_location_flag == o.restrict_location_flag &&
      restrict_department_flag == o.restrict_department_flag &&
      sla == o.sla &&
      application_units == o.application_units &&
      application_limit == o.application_limit &&
      application_cycle == o.application_cycle &&
      application_unlimited_flag == o.application_unlimited_flag &&
      one_time_flag == o.one_time_flag &&
      cover_agreement_time_flag == o.cover_agreement_time_flag &&
      cover_agreement_product_flag == o.cover_agreement_product_flag &&
      cover_agreement_expense_flag == o.cover_agreement_expense_flag &&
      cover_sales_tax_flag == o.cover_sales_tax_flag &&
      carry_over_unused_flag == o.carry_over_unused_flag &&
      allow_overruns_flag == o.allow_overruns_flag &&
      expired_days == o.expired_days &&
      limit == o.limit &&
      expire_when_zero == o.expire_when_zero &&
      charge_to_firm_flag == o.charge_to_firm_flag &&
      employee_comp_rate == o.employee_comp_rate &&
      employee_comp_not_exceed == o.employee_comp_not_exceed &&
      comp_hourly_rate == o.comp_hourly_rate &&
      comp_limit_amount == o.comp_limit_amount &&
      billing_cycle == o.billing_cycle &&
      bill_one_time_flag == o.bill_one_time_flag &&
      billing_terms == o.billing_terms &&
      invoicing_cycle == o.invoicing_cycle &&
      bill_amount == o.bill_amount &&
      taxable_flag == o.taxable_flag &&
      restrict_down_payment_flag == o.restrict_down_payment_flag &&
      invoice_description == o.invoice_description &&
      top_comment_flag == o.top_comment_flag &&
      bottom_comment_flag == o.bottom_comment_flag &&
      work_role == o.work_role &&
      work_type == o.work_type &&
      project_type == o.project_type &&
      invoice_template == o.invoice_template &&
      bill_time == o.bill_time &&
      bill_expenses == o.bill_expenses &&
      bill_products == o.bill_products &&
      billable_time_invoice_flag == o.billable_time_invoice_flag &&
      billable_expense_invoice_flag == o.billable_expense_invoice_flag &&
      billable_product_invoice_flag == o.billable_product_invoice_flag &&
      copy_work_roles_flag == o.copy_work_roles_flag &&
      copy_work_types_flag == o.copy_work_types_flag &&
      exclusion_work_role_ids == o.exclusion_work_role_ids &&
      add_all_work_role_exclusions == o.add_all_work_role_exclusions &&
      remove_all_work_role_exclusions == o.remove_all_work_role_exclusions &&
      exclusion_work_type_ids == o.exclusion_work_type_ids &&
      add_all_work_type_exclusions == o.add_all_work_type_exclusions &&
      remove_all_work_type_exclusions == o.remove_all_work_type_exclusions &&
      integration_x_ref == o.integration_x_ref &&
      prorate_flag == o.prorate_flag &&
      email_template == o.email_template &&
      _info == o._info
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



939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 939

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



1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 1005

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



918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 918

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


905
906
907
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 905

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



911
912
913
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 911

def hash
  [id, name, prefix_suffix_option, default_flag, inactive_flag, pre_payment_flag, invoice_pre_suffix, location, department, restrict_location_flag, restrict_department_flag, sla, application_units, application_limit, application_cycle, application_unlimited_flag, one_time_flag, cover_agreement_time_flag, cover_agreement_product_flag, cover_agreement_expense_flag, cover_sales_tax_flag, carry_over_unused_flag, allow_overruns_flag, expired_days, limit, expire_when_zero, charge_to_firm_flag, employee_comp_rate, employee_comp_not_exceed, comp_hourly_rate, comp_limit_amount, billing_cycle, bill_one_time_flag, billing_terms, invoicing_cycle, bill_amount, taxable_flag, restrict_down_payment_flag, invoice_description, top_comment_flag, bottom_comment_flag, work_role, work_type, project_type, invoice_template, bill_time, bill_expenses, bill_products, billable_time_invoice_flag, billable_expense_invoice_flag, billable_product_invoice_flag, copy_work_roles_flag, copy_work_types_flag, exclusion_work_role_ids, add_all_work_role_exclusions, remove_all_work_role_exclusions, exclusion_work_type_ids, add_all_work_type_exclusions, remove_all_work_type_exclusions, integration_x_ref, prorate_flag, email_template, _info].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properies with the reasons



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 562

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

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

  if !@invoice_pre_suffix.nil? && @invoice_pre_suffix.to_s.length > 5
    invalid_properties.push("invalid value for 'invoice_pre_suffix', the character length must be smaller than or equal to 5.")
  end

  if !@expired_days.nil? && @expired_days > 99999
    invalid_properties.push("invalid value for 'expired_days', must be smaller than or equal to 99999.")
  end

  if !@expired_days.nil? && @expired_days < -9999
    invalid_properties.push("invalid value for 'expired_days', must be greater than or equal to -9999.")
  end

  if !@limit.nil? && @limit > 99999
    invalid_properties.push("invalid value for 'limit', must be smaller than or equal to 99999.")
  end

  if !@limit.nil? && @limit < -9999
    invalid_properties.push("invalid value for 'limit', must be greater than or equal to -9999.")
  end

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

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

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

  if !@invoice_description.nil? && @invoice_description.to_s.length > 4000
    invalid_properties.push("invalid value for 'invoice_description', the character length must be smaller than or equal to 4000.")
  end

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

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

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

  if !@integration_x_ref.nil? && @integration_x_ref.to_s.length > 50
    invalid_properties.push("invalid value for 'integration_x_ref', the character length must be smaller than or equal to 50.")
  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



985
986
987
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 985

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



991
992
993
994
995
996
997
998
999
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 991

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



979
980
981
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 979

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



629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
# File 'lib/connectwise-ruby-sdk/models/agreement_type.rb', line 629

def valid?
  return false if @name.nil?
  return false if @name.to_s.length > 50
  prefix_suffix_option_validator = EnumAttributeValidator.new('String', ["Prefix", "Suffix"])
  return false unless prefix_suffix_option_validator.valid?(@prefix_suffix_option)
  return false if !@invoice_pre_suffix.nil? && @invoice_pre_suffix.to_s.length > 5
  application_units_validator = EnumAttributeValidator.new('String', ["Amount", "Hours", "Incidents"])
  return false unless application_units_validator.valid?(@application_units)
  application_cycle_validator = EnumAttributeValidator.new('String', ["Contract2Weeks", "Contract4Weeks", "ContractYear", "CalendarMonth", "CalendarQuarter", "CalendarWeek", "ContractQuarter", "CalendarYear"])
  return false unless application_cycle_validator.valid?(@application_cycle)
  return false if !@expired_days.nil? && @expired_days > 99999
  return false if !@expired_days.nil? && @expired_days < -9999
  return false if !@limit.nil? && @limit > 99999
  return false if !@limit.nil? && @limit < -9999
  return false if @employee_comp_rate.nil?
  employee_comp_rate_validator = EnumAttributeValidator.new('String', ["Actual", "Hourly"])
  return false unless employee_comp_rate_validator.valid?(@employee_comp_rate)
  return false if @employee_comp_not_exceed.nil?
  employee_comp_not_exceed_validator = EnumAttributeValidator.new('String', ["Billing", "Percent", "Amount"])
  return false unless employee_comp_not_exceed_validator.valid?(@employee_comp_not_exceed)
  return false if @invoicing_cycle.nil?
  invoicing_cycle_validator = EnumAttributeValidator.new('String', ["CalendarYear", "ContractYear"])
  return false unless invoicing_cycle_validator.valid?(@invoicing_cycle)
  return false if !@invoice_description.nil? && @invoice_description.to_s.length > 4000
  return false if @bill_time.nil?
  bill_time_validator = EnumAttributeValidator.new('String', ["Billable", "DoNotBill", "NoCharge", "NoDefault"])
  return false unless bill_time_validator.valid?(@bill_time)
  return false if @bill_expenses.nil?
  bill_expenses_validator = EnumAttributeValidator.new('String', ["Billable", "DoNotBill", "NoCharge", "NoDefault"])
  return false unless bill_expenses_validator.valid?(@bill_expenses)
  return false if @bill_products.nil?
  bill_products_validator = EnumAttributeValidator.new('String', ["Billable", "DoNotBill", "NoCharge", "NoDefault"])
  return false unless bill_products_validator.valid?(@bill_products)
  return false if !@integration_x_ref.nil? && @integration_x_ref.to_s.length > 50
  return true
end