propertyware 1.2.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. checksums.yaml +4 -4
  2. data/.openapi-generator/FILES +6 -3
  3. data/.tool-versions +2 -0
  4. data/DOCS.md +7 -5
  5. data/Gemfile.lock +4 -2
  6. data/bin/config.yml +1 -1
  7. data/bin/fix_json.rb +0 -1
  8. data/bin/propertyware.json +218 -178
  9. data/docs/Adjustment.md +40 -0
  10. data/docs/BankDeposit.md +1 -1
  11. data/docs/ChargeTx.md +1 -5
  12. data/docs/ContactCategory.md +20 -0
  13. data/docs/ContactsApi.md +79 -0
  14. data/docs/DocumentsApi.md +4 -4
  15. data/docs/Inspection.md +8 -0
  16. data/docs/LeasesApi.md +19 -19
  17. data/docs/OwnerContribution.md +5 -5
  18. data/docs/OwnerDraw.md +1 -1
  19. data/docs/Portfolio.md +2 -0
  20. data/docs/Refund.md +5 -5
  21. data/docs/SaveAdjustment.md +2 -2
  22. data/docs/SaveBankDeposit.md +1 -1
  23. data/docs/SaveContact.md +2 -0
  24. data/docs/SaveDiscount.md +1 -1
  25. data/docs/SaveOwnerContribution.md +5 -5
  26. data/docs/SaveOwnerDraw.md +5 -5
  27. data/docs/SavePayment.md +6 -6
  28. data/docs/SavePortfolio.md +6 -0
  29. data/docs/SaveRefund.md +6 -6
  30. data/lib/propertyware/api/contacts_api.rb +57 -0
  31. data/lib/propertyware/api/documents_api.rb +4 -4
  32. data/lib/propertyware/api/leases_api.rb +14 -14
  33. data/lib/propertyware/models/account.rb +1 -1
  34. data/lib/propertyware/models/{transaction.rb → adjustment.rb} +24 -118
  35. data/lib/propertyware/models/auto_journal_entry.rb +2 -2
  36. data/lib/propertyware/models/bank_deposit.rb +1 -1
  37. data/lib/propertyware/models/charge.rb +2 -2
  38. data/lib/propertyware/models/charge_tx.rb +4 -24
  39. data/lib/propertyware/models/contact_category.rb +229 -0
  40. data/lib/propertyware/models/inspection.rb +41 -1
  41. data/lib/propertyware/models/owner_contribution.rb +0 -25
  42. data/lib/propertyware/models/owner_draw.rb +0 -5
  43. data/lib/propertyware/models/portfolio.rb +11 -1
  44. data/lib/propertyware/models/refund.rb +2 -27
  45. data/lib/propertyware/models/save_adjustment.rb +2 -2
  46. data/lib/propertyware/models/save_bank_deposit.rb +1 -1
  47. data/lib/propertyware/models/save_contact.rb +11 -1
  48. data/lib/propertyware/models/save_discount.rb +1 -1
  49. data/lib/propertyware/models/save_owner_contribution.rb +5 -5
  50. data/lib/propertyware/models/save_owner_draw.rb +5 -5
  51. data/lib/propertyware/models/save_payment.rb +6 -6
  52. data/lib/propertyware/models/save_portfolio.rb +31 -1
  53. data/lib/propertyware/models/save_refund.rb +7 -17
  54. data/lib/propertyware/version.rb +1 -1
  55. data/lib/propertyware.rb +2 -1
  56. data/spec/api/contacts_api_spec.rb +11 -0
  57. data/spec/api/documents_api_spec.rb +2 -2
  58. data/spec/api/leases_api_spec.rb +5 -5
  59. data/spec/models/{transaction_spec.rb → adjustment_spec.rb} +6 -52
  60. data/spec/models/auto_journal_entry_spec.rb +1 -1
  61. data/spec/models/charge_spec.rb +1 -1
  62. data/spec/models/charge_tx_spec.rb +0 -12
  63. data/spec/models/contact_category_spec.rb +40 -0
  64. data/spec/models/inspection_spec.rb +24 -0
  65. data/spec/models/portfolio_spec.rb +6 -0
  66. data/spec/models/save_contact_spec.rb +6 -0
  67. data/spec/models/save_portfolio_spec.rb +18 -0
  68. metadata +11 -6
  69. data/docs/Transaction.md +0 -54
data/docs/SaveRefund.md CHANGED
@@ -7,12 +7,12 @@
7
7
  | **amount** | **Float** | Amount. | |
8
8
  | **comments** | **String** | Comments. | [optional] |
9
9
  | **date** | **Date** | Post Date. | |
10
- | **destination_account_id** | **Integer** | Bank GL Account to pay from. | |
11
- | **gl_account_id** | **Integer** | Refund GL Account. | |
12
- | **lease_id** | **Integer** | Lease id to apply payment. | |
13
- | **ref_no** | **String** | Payment Ref No. | [optional] |
14
- | **to_be_printed** | **Boolean** | Bank GL Account to pay from. | |
15
- | **to_primary_tenant** | **Boolean** | Bank GL Account to pay from. | |
10
+ | **destination_account_id** | **Integer** | Id of the bank account to send the refund from. | |
11
+ | **gl_account_id** | **Integer** | Id of the general ledger account associated with the refund. | |
12
+ | **lease_id** | **Integer** | Id of the lease associated with the refund. | |
13
+ | **ref_no** | **String** | Reference number. | [optional] |
14
+ | **to_be_printed** | **Boolean** | Indicates if the check is to be printed. | [optional] |
15
+ | **to_primary_tenant** | **Boolean** | Indicates if refund is for primary contact only | [optional] |
16
16
 
17
17
  ## Example
18
18
 
@@ -353,6 +353,63 @@ module Propertyware
353
353
  return data, status_code, headers
354
354
  end
355
355
 
356
+ # Retrieve all contact categories
357
+ # Retrieves a list of contact categories.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">CONTACTS</span> - <code>Read</code>
358
+ # @param [Hash] opts the optional parameters
359
+ # @return [Array<ContactCategory>]
360
+ def get_contact_categories(opts = {})
361
+ data, _status_code, _headers = get_contact_categories_with_http_info(opts)
362
+ data
363
+ end
364
+
365
+ # Retrieve all contact categories
366
+ # Retrieves a list of contact categories.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;CONTACTS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt;
367
+ # @param [Hash] opts the optional parameters
368
+ # @return [Array<(Array<ContactCategory>, Integer, Hash)>] Array<ContactCategory> data, response status code and response headers
369
+ def get_contact_categories_with_http_info(opts = {})
370
+ if @api_client.config.debugging
371
+ @api_client.config.logger.debug 'Calling API: ContactsApi.get_contact_categories ...'
372
+ end
373
+ # resource path
374
+ local_var_path = '/contacts/categories'
375
+
376
+ # query parameters
377
+ query_params = opts[:query_params] || {}
378
+
379
+ # header parameters
380
+ header_params = opts[:header_params] || {}
381
+ # HTTP header 'Accept' (if needed)
382
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
383
+
384
+ # form parameters
385
+ form_params = opts[:form_params] || {}
386
+
387
+ # http body (model)
388
+ post_body = opts[:debug_body]
389
+
390
+ # return_type
391
+ return_type = opts[:debug_return_type] || 'Array<ContactCategory>'
392
+
393
+ # auth_names
394
+ auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
395
+
396
+ new_options = opts.merge(
397
+ :operation => :"ContactsApi.get_contact_categories",
398
+ :header_params => header_params,
399
+ :query_params => query_params,
400
+ :form_params => form_params,
401
+ :body => post_body,
402
+ :auth_names => auth_names,
403
+ :return_type => return_type
404
+ )
405
+
406
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
407
+ if @api_client.config.debugging
408
+ @api_client.config.logger.debug "API called: ContactsApi#get_contact_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
409
+ end
410
+ return data, status_code, headers
411
+ end
412
+
356
413
  # Retrieve a contact conversation
357
414
  # Retrieves a specific contact conversation.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">CONTACTS</span> - <code>Read</code>
358
415
  # @param contact_id [Integer] Contact ID
@@ -154,7 +154,7 @@ module Propertyware
154
154
  # @option opts [Time] :last_modified_date_time_start Filters results to any item modified on or after the date time specified.
155
155
  # @option opts [Time] :last_modified_date_time_end Filters results to any item modified on or prior to the date time specified.
156
156
  # @option opts [String] :orderby Indicates the field(s) and direction to sort the results in the response.
157
- # @option opts [Integer] :entity_id Filters results to documents associated with a specific entity id. entity ID is not required for “DESKTOP†and “OTHER†. Remaining entities need “entity ID†.
157
+ # @option opts [Integer] :entity_id Filters results to documents associated with a specific entity id. entity ID is not required for DESKTOP and OTHER. Remaining entities need entity ID.
158
158
  # @return [Array<Document>]
159
159
  def retrieve_all_documents(entity_type, opts = {})
160
160
  data, _status_code, _headers = retrieve_all_documents_with_http_info(entity_type, opts)
@@ -170,7 +170,7 @@ module Propertyware
170
170
  # @option opts [Time] :last_modified_date_time_start Filters results to any item modified on or after the date time specified.
171
171
  # @option opts [Time] :last_modified_date_time_end Filters results to any item modified on or prior to the date time specified.
172
172
  # @option opts [String] :orderby Indicates the field(s) and direction to sort the results in the response.
173
- # @option opts [Integer] :entity_id Filters results to documents associated with a specific entity id. entity ID is not required for “DESKTOP†and “OTHER†. Remaining entities need “entity ID†.
173
+ # @option opts [Integer] :entity_id Filters results to documents associated with a specific entity id. entity ID is not required for DESKTOP and OTHER. Remaining entities need entity ID.
174
174
  # @return [Array<(Array<Document>, Integer, Hash)>] Array<Document> data, response status code and response headers
175
175
  def retrieve_all_documents_with_http_info(entity_type, opts = {})
176
176
  if @api_client.config.debugging
@@ -372,7 +372,7 @@ module Propertyware
372
372
  # Upload a document (BETA)
373
373
  # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Upload a document<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">DOCUMENTS</span> - <code>Write</code>
374
374
  # @param entity_id [Integer] Unique identifier of an entity document is attached to.
375
- # @param entity_type [String] Entity type Document is attached to (Bill, Building, Desktop, Inspection, Lease, Portfolio, Prospect, Unit, Vendor, Work Order, Tenant, Owner, Bank Deposit, Asset)
375
+ # @param entity_type [String] Entity type Document is attached to (Asset, Bill, Bank Deposit, Building, Desktop, Lease, Owner, Portfolio, Prospect, Prospect Contact, Tenant, Unit, Vendor, Check, Credit, Service Agreement, Journal Entry, Work Order)
376
376
  # @param body [File]
377
377
  # @param [Hash] opts the optional parameters
378
378
  # @option opts [Boolean] :publish_to_tenant_portal Indicates if the document is published to the tenant portal.
@@ -386,7 +386,7 @@ module Propertyware
386
386
  # Upload a document (BETA)
387
387
  # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Upload a document&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;DOCUMENTS&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;
388
388
  # @param entity_id [Integer] Unique identifier of an entity document is attached to.
389
- # @param entity_type [String] Entity type Document is attached to (Bill, Building, Desktop, Inspection, Lease, Portfolio, Prospect, Unit, Vendor, Work Order, Tenant, Owner, Bank Deposit, Asset)
389
+ # @param entity_type [String] Entity type Document is attached to (Asset, Bill, Bank Deposit, Building, Desktop, Lease, Owner, Portfolio, Prospect, Prospect Contact, Tenant, Unit, Vendor, Check, Credit, Service Agreement, Journal Entry, Work Order)
390
390
  # @param body [File]
391
391
  # @param [Hash] opts the optional parameters
392
392
  # @option opts [Boolean] :publish_to_tenant_portal Indicates if the document is published to the tenant portal.
@@ -239,7 +239,7 @@ module Propertyware
239
239
  # <p class=\"betaError\"><b>Note: </b>Write access is only available to customers who have opted in to our beta program. Please reach out to support if you'd like to be included.</p> Creates a lease adjustment.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Write</code>
240
240
  # @param save_adjustment [SaveAdjustment] saveAdjustment
241
241
  # @param [Hash] opts the optional parameters
242
- # @return [ChargeTx]
242
+ # @return [Adjustment]
243
243
  def create_lease_adjustment(save_adjustment, opts = {})
244
244
  data, _status_code, _headers = create_lease_adjustment_with_http_info(save_adjustment, opts)
245
245
  data
@@ -249,7 +249,7 @@ module Propertyware
249
249
  # &lt;p class&#x3D;\&quot;betaError\&quot;&gt;&lt;b&gt;Note: &lt;/b&gt;Write access is only available to customers who have opted in to our beta program. Please reach out to support if you&#39;d like to be included.&lt;/p&gt; Creates a lease adjustment.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Write&lt;/code&gt;
250
250
  # @param save_adjustment [SaveAdjustment] saveAdjustment
251
251
  # @param [Hash] opts the optional parameters
252
- # @return [Array<(ChargeTx, Integer, Hash)>] ChargeTx data, response status code and response headers
252
+ # @return [Array<(Adjustment, Integer, Hash)>] Adjustment data, response status code and response headers
253
253
  def create_lease_adjustment_with_http_info(save_adjustment, opts = {})
254
254
  if @api_client.config.debugging
255
255
  @api_client.config.logger.debug 'Calling API: LeasesApi.create_lease_adjustment ...'
@@ -281,7 +281,7 @@ module Propertyware
281
281
  post_body = opts[:debug_body] || @api_client.object_to_http_body(save_adjustment)
282
282
 
283
283
  # return_type
284
- return_type = opts[:debug_return_type] || 'ChargeTx'
284
+ return_type = opts[:debug_return_type] || 'Adjustment'
285
285
 
286
286
  # auth_names
287
287
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
@@ -973,7 +973,7 @@ module Propertyware
973
973
  end
974
974
 
975
975
  # Retrieve all the adjustments
976
- # Retrieves a list of adjustments.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">GL ACCOUNTS</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>leaseid</code>, <code>postdate</code>, <code>id</code>
976
+ # Retrieves a list of adjustments.<br/><br/><b>Required permission:</b><br/><span class=\"permissionBlock\">LEASES</span> - <code>Read</code> <br/><br/><b>Sortable by:</b> <code>leaseid</code>, <code>postdate</code>, <code>id</code>
977
977
  # @param [Hash] opts the optional parameters
978
978
  # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0.
979
979
  # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. (default to 100)
@@ -985,14 +985,14 @@ module Propertyware
985
985
  # @option opts [Integer] :portfolio_id Filters results associated with a specific portfolio.
986
986
  # @option opts [Integer] :lease_id Filters results with Lease ID.
987
987
  # @option opts [String] :status Filters results to with Lease Status.
988
- # @return [Array<Transaction>]
988
+ # @return [Array<Adjustment>]
989
989
  def get_lease_adjustments(opts = {})
990
990
  data, _status_code, _headers = get_lease_adjustments_with_http_info(opts)
991
991
  data
992
992
  end
993
993
 
994
994
  # Retrieve all the adjustments
995
- # Retrieves a list of adjustments.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;GL ACCOUNTS&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;leaseid&lt;/code&gt;, &lt;code&gt;postdate&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;
995
+ # Retrieves a list of adjustments.&lt;br/&gt;&lt;br/&gt;&lt;b&gt;Required permission:&lt;/b&gt;&lt;br/&gt;&lt;span class&#x3D;\&quot;permissionBlock\&quot;&gt;LEASES&lt;/span&gt; - &lt;code&gt;Read&lt;/code&gt; &lt;br/&gt;&lt;br/&gt;&lt;b&gt;Sortable by:&lt;/b&gt; &lt;code&gt;leaseid&lt;/code&gt;, &lt;code&gt;postdate&lt;/code&gt;, &lt;code&gt;id&lt;/code&gt;
996
996
  # @param [Hash] opts the optional parameters
997
997
  # @option opts [Integer] :offset &#x60;offset&#x60; indicates the position of the first record to return. The offset is zero-based and the default is 0.
998
998
  # @option opts [Integer] :limit &#x60;limit&#x60; indicates the maximum number of results to be returned in the response. &#x60;limit&#x60; can range between 1 and 500 and the default is 100. (default to 100)
@@ -1004,7 +1004,7 @@ module Propertyware
1004
1004
  # @option opts [Integer] :portfolio_id Filters results associated with a specific portfolio.
1005
1005
  # @option opts [Integer] :lease_id Filters results with Lease ID.
1006
1006
  # @option opts [String] :status Filters results to with Lease Status.
1007
- # @return [Array<(Array<Transaction>, Integer, Hash)>] Array<Transaction> data, response status code and response headers
1007
+ # @return [Array<(Array<Adjustment>, Integer, Hash)>] Array<Adjustment> data, response status code and response headers
1008
1008
  def get_lease_adjustments_with_http_info(opts = {})
1009
1009
  if @api_client.config.debugging
1010
1010
  @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_adjustments ...'
@@ -1037,7 +1037,7 @@ module Propertyware
1037
1037
  post_body = opts[:debug_body]
1038
1038
 
1039
1039
  # return_type
1040
- return_type = opts[:debug_return_type] || 'Array<Transaction>'
1040
+ return_type = opts[:debug_return_type] || 'Array<Adjustment>'
1041
1041
 
1042
1042
  # auth_names
1043
1043
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
@@ -1716,7 +1716,7 @@ module Propertyware
1716
1716
  # @option opts [Integer] :lease_id Filters results to any LeaseID.
1717
1717
  # @option opts [Date] :post_date_start Filters results to any discount with a start date on or after the date specified.
1718
1718
  # @option opts [Date] :post_date_end Filters results to any discount with a start date on or prior to the date specified.
1719
- # @return [Array<Transaction>]
1719
+ # @return [Array<Discount>]
1720
1720
  def get_lease_discounts(opts = {})
1721
1721
  data, _status_code, _headers = get_lease_discounts_with_http_info(opts)
1722
1722
  data
@@ -1733,7 +1733,7 @@ module Propertyware
1733
1733
  # @option opts [Integer] :lease_id Filters results to any LeaseID.
1734
1734
  # @option opts [Date] :post_date_start Filters results to any discount with a start date on or after the date specified.
1735
1735
  # @option opts [Date] :post_date_end Filters results to any discount with a start date on or prior to the date specified.
1736
- # @return [Array<(Array<Transaction>, Integer, Hash)>] Array<Transaction> data, response status code and response headers
1736
+ # @return [Array<(Array<Discount>, Integer, Hash)>] Array<Discount> data, response status code and response headers
1737
1737
  def get_lease_discounts_with_http_info(opts = {})
1738
1738
  if @api_client.config.debugging
1739
1739
  @api_client.config.logger.debug 'Calling API: LeasesApi.get_lease_discounts ...'
@@ -1764,7 +1764,7 @@ module Propertyware
1764
1764
  post_body = opts[:debug_body]
1765
1765
 
1766
1766
  # return_type
1767
- return_type = opts[:debug_return_type] || 'Array<Transaction>'
1767
+ return_type = opts[:debug_return_type] || 'Array<Discount>'
1768
1768
 
1769
1769
  # auth_names
1770
1770
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
@@ -2489,7 +2489,7 @@ module Propertyware
2489
2489
  # @param adjustment_id [Integer] Adjustment ID
2490
2490
  # @param save_adjustment [SaveAdjustment] saveAdjustment
2491
2491
  # @param [Hash] opts the optional parameters
2492
- # @return [ChargeTx]
2492
+ # @return [Adjustment]
2493
2493
  def update_lease_adjustment(adjustment_id, save_adjustment, opts = {})
2494
2494
  data, _status_code, _headers = update_lease_adjustment_with_http_info(adjustment_id, save_adjustment, opts)
2495
2495
  data
@@ -2500,7 +2500,7 @@ module Propertyware
2500
2500
  # @param adjustment_id [Integer] Adjustment ID
2501
2501
  # @param save_adjustment [SaveAdjustment] saveAdjustment
2502
2502
  # @param [Hash] opts the optional parameters
2503
- # @return [Array<(ChargeTx, Integer, Hash)>] ChargeTx data, response status code and response headers
2503
+ # @return [Array<(Adjustment, Integer, Hash)>] Adjustment data, response status code and response headers
2504
2504
  def update_lease_adjustment_with_http_info(adjustment_id, save_adjustment, opts = {})
2505
2505
  if @api_client.config.debugging
2506
2506
  @api_client.config.logger.debug 'Calling API: LeasesApi.update_lease_adjustment ...'
@@ -2536,7 +2536,7 @@ module Propertyware
2536
2536
  post_body = opts[:debug_body] || @api_client.object_to_http_body(save_adjustment)
2537
2537
 
2538
2538
  # return_type
2539
- return_type = opts[:debug_return_type] || 'ChargeTx'
2539
+ return_type = opts[:debug_return_type] || 'Adjustment'
2540
2540
 
2541
2541
  # auth_names
2542
2542
  auth_names = opts[:debug_auth_names] || ['organizationId', 'clientId', 'clientSecret']
@@ -14,7 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module Propertyware
17
- # Account
17
+ # General Ledger Account
18
18
  class Account
19
19
  # Account code.
20
20
  attr_accessor :account_code
@@ -14,33 +14,24 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module Propertyware
17
- # Transaction
18
- class Transaction
19
- # Transaction amount.
17
+ # Adjustment
18
+ class Adjustment
19
+ # Amount.
20
20
  attr_accessor :amount
21
21
 
22
22
  # Comments.
23
23
  attr_accessor :comments
24
24
 
25
- # Id of the contact associated with this transaction.
26
- attr_accessor :contact_id
27
-
28
25
  # User who created the record.
29
26
  attr_accessor :created_by
30
27
 
31
28
  # Date and time the record was created. (Timezone: UTC)
32
29
  attr_accessor :created_date_time
33
30
 
34
- # Transaction date.
31
+ # Post date.
35
32
  attr_accessor :date
36
33
 
37
- # Transaction deposit date.
38
- attr_accessor :deposit_date
39
-
40
- # Id of the bank account associated with this transaction.
41
- attr_accessor :destination_account_id
42
-
43
- # Id of the general ledger account associated with this transaction.
34
+ # Id of the general ledger account associated with this charge.
44
35
  attr_accessor :gl_account_id
45
36
 
46
37
  # Unique identifier.
@@ -52,71 +43,30 @@ module Propertyware
52
43
  # Date and time the record was last modified. (Timezone: UTC)
53
44
  attr_accessor :last_modified_date_time
54
45
 
55
- # Id of the lease associated with this transaction.
46
+ # Id of the lease associated with this charge.
56
47
  attr_accessor :lease_id
57
48
 
58
- # Name of the payee or payer.
59
- attr_accessor :payee_payer
60
-
61
- # Payment method.
62
- attr_accessor :payment_method
63
-
64
- # Payment type.
65
- attr_accessor :payment_type
66
-
67
- # Id of the portfolio associated with this transaction.
49
+ # Id of the portfolio associated with this charge.
68
50
  attr_accessor :portfolio_id
69
51
 
70
- # Transaction reference number.
52
+ # Reference number.
71
53
  attr_accessor :ref_no
72
54
 
73
- # Indicates if a check should be printed for this transaction.
74
- attr_accessor :to_be_printed
75
-
76
- class EnumAttributeValidator
77
- attr_reader :datatype
78
- attr_reader :allowable_values
79
-
80
- def initialize(datatype, allowable_values)
81
- @allowable_values = allowable_values.map do |value|
82
- case datatype.to_s
83
- when /Integer/i
84
- value.to_i
85
- when /Float/i
86
- value.to_f
87
- else
88
- value
89
- end
90
- end
91
- end
92
-
93
- def valid?(value)
94
- !value || allowable_values.include?(value)
95
- end
96
- end
97
-
98
55
  # Attribute mapping from ruby-style variable name to JSON key.
99
56
  def self.attribute_map
100
57
  {
101
58
  :'amount' => :'amount',
102
59
  :'comments' => :'comments',
103
- :'contact_id' => :'contactID',
104
60
  :'created_by' => :'createdBy',
105
61
  :'created_date_time' => :'createdDateTime',
106
62
  :'date' => :'date',
107
- :'deposit_date' => :'depositDate',
108
- :'destination_account_id' => :'destinationAccountID',
109
63
  :'gl_account_id' => :'glAccountID',
110
64
  :'id' => :'id',
111
65
  :'last_modified_by' => :'lastModifiedBy',
112
66
  :'last_modified_date_time' => :'lastModifiedDateTime',
113
67
  :'lease_id' => :'leaseID',
114
- :'payee_payer' => :'payeePayer',
115
- :'payment_method' => :'paymentMethod',
116
- :'payment_type' => :'paymentType',
117
68
  :'portfolio_id' => :'portfolioID',
118
- :'ref_no' => :'refNo',
119
- :'to_be_printed' => :'toBePrinted'
69
+ :'ref_no' => :'refNo'
120
70
  }
121
71
  end
122
72
 
@@ -130,23 +80,16 @@ module Propertyware
130
80
  {
131
81
  :'amount' => :'Float',
132
82
  :'comments' => :'String',
133
- :'contact_id' => :'Integer',
134
83
  :'created_by' => :'String',
135
84
  :'created_date_time' => :'Time',
136
85
  :'date' => :'Date',
137
- :'deposit_date' => :'Date',
138
- :'destination_account_id' => :'Integer',
139
86
  :'gl_account_id' => :'Integer',
140
87
  :'id' => :'Integer',
141
88
  :'last_modified_by' => :'String',
142
89
  :'last_modified_date_time' => :'Time',
143
90
  :'lease_id' => :'Integer',
144
- :'payee_payer' => :'String',
145
- :'payment_method' => :'String',
146
- :'payment_type' => :'String',
147
91
  :'portfolio_id' => :'Integer',
148
- :'ref_no' => :'String',
149
- :'to_be_printed' => :'Boolean'
92
+ :'ref_no' => :'String'
150
93
  }
151
94
  end
152
95
 
@@ -160,13 +103,13 @@ module Propertyware
160
103
  # @param [Hash] attributes Model attributes in the form of hash
161
104
  def initialize(attributes = {})
162
105
  if (!attributes.is_a?(Hash))
163
- fail ArgumentError, "The input argument (attributes) must be a hash in `Propertyware::Transaction` initialize method"
106
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Propertyware::Adjustment` initialize method"
164
107
  end
165
108
 
166
109
  # check to see if the attribute exists and convert string to symbol for hash key
167
110
  attributes = attributes.each_with_object({}) { |(k, v), h|
168
111
  if (!self.class.attribute_map.key?(k.to_sym))
169
- fail ArgumentError, "`#{k}` is not a valid attribute in `Propertyware::Transaction`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
112
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Propertyware::Adjustment`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
170
113
  end
171
114
  h[k.to_sym] = v
172
115
  }
@@ -179,10 +122,6 @@ module Propertyware
179
122
  self.comments = attributes[:'comments']
180
123
  end
181
124
 
182
- if attributes.key?(:'contact_id')
183
- self.contact_id = attributes[:'contact_id']
184
- end
185
-
186
125
  if attributes.key?(:'created_by')
187
126
  self.created_by = attributes[:'created_by']
188
127
  end
@@ -195,14 +134,6 @@ module Propertyware
195
134
  self.date = attributes[:'date']
196
135
  end
197
136
 
198
- if attributes.key?(:'deposit_date')
199
- self.deposit_date = attributes[:'deposit_date']
200
- end
201
-
202
- if attributes.key?(:'destination_account_id')
203
- self.destination_account_id = attributes[:'destination_account_id']
204
- end
205
-
206
137
  if attributes.key?(:'gl_account_id')
207
138
  self.gl_account_id = attributes[:'gl_account_id']
208
139
  end
@@ -223,18 +154,6 @@ module Propertyware
223
154
  self.lease_id = attributes[:'lease_id']
224
155
  end
225
156
 
226
- if attributes.key?(:'payee_payer')
227
- self.payee_payer = attributes[:'payee_payer']
228
- end
229
-
230
- if attributes.key?(:'payment_method')
231
- self.payment_method = attributes[:'payment_method']
232
- end
233
-
234
- if attributes.key?(:'payment_type')
235
- self.payment_type = attributes[:'payment_type']
236
- end
237
-
238
157
  if attributes.key?(:'portfolio_id')
239
158
  self.portfolio_id = attributes[:'portfolio_id']
240
159
  end
@@ -242,37 +161,31 @@ module Propertyware
242
161
  if attributes.key?(:'ref_no')
243
162
  self.ref_no = attributes[:'ref_no']
244
163
  end
245
-
246
- if attributes.key?(:'to_be_printed')
247
- self.to_be_printed = attributes[:'to_be_printed']
248
- end
249
164
  end
250
165
 
251
166
  # Show invalid properties with the reasons. Usually used together with valid?
252
167
  # @return Array for valid properties with the reasons
253
168
  def list_invalid_properties
254
169
  invalid_properties = Array.new
170
+ if @amount.nil?
171
+ invalid_properties.push('invalid value for "amount", amount cannot be nil.')
172
+ end
173
+
174
+ if @date.nil?
175
+ invalid_properties.push('invalid value for "date", date cannot be nil.')
176
+ end
177
+
255
178
  invalid_properties
256
179
  end
257
180
 
258
181
  # Check to see if the all the properties in the model are valid
259
182
  # @return true if the model is valid
260
183
  def valid?
261
- payment_type_validator = EnumAttributeValidator.new('String', ["CHECK", "CHECK21", "CASHIERS_CHECK", "CREDIT_CARD", "CASH", "MONEY_ORDER", "OTHER", "CLICKPAY", "SECTION8", "EPAY", "ECHECK", "NACHA", "RENTMONEY", "PUBLIC_ASSISTANCE"])
262
- return false unless payment_type_validator.valid?(@payment_type)
184
+ return false if @amount.nil?
185
+ return false if @date.nil?
263
186
  true
264
187
  end
265
188
 
266
- # Custom attribute writer method checking allowed values (enum).
267
- # @param [Object] payment_type Object to be assigned
268
- def payment_type=(payment_type)
269
- validator = EnumAttributeValidator.new('String', ["CHECK", "CHECK21", "CASHIERS_CHECK", "CREDIT_CARD", "CASH", "MONEY_ORDER", "OTHER", "CLICKPAY", "SECTION8", "EPAY", "ECHECK", "NACHA", "RENTMONEY", "PUBLIC_ASSISTANCE"])
270
- unless validator.valid?(payment_type)
271
- fail ArgumentError, "invalid value #{ payment_type.inspect } for \"payment_type\", must be one of #{validator.allowable_values}."
272
- end
273
- @payment_type = payment_type
274
- end
275
-
276
189
  # Checks equality by comparing each attribute.
277
190
  # @param [Object] Object to be compared
278
191
  def ==(o)
@@ -280,23 +193,16 @@ module Propertyware
280
193
  self.class == o.class &&
281
194
  amount == o.amount &&
282
195
  comments == o.comments &&
283
- contact_id == o.contact_id &&
284
196
  created_by == o.created_by &&
285
197
  created_date_time == o.created_date_time &&
286
198
  date == o.date &&
287
- deposit_date == o.deposit_date &&
288
- destination_account_id == o.destination_account_id &&
289
199
  gl_account_id == o.gl_account_id &&
290
200
  id == o.id &&
291
201
  last_modified_by == o.last_modified_by &&
292
202
  last_modified_date_time == o.last_modified_date_time &&
293
203
  lease_id == o.lease_id &&
294
- payee_payer == o.payee_payer &&
295
- payment_method == o.payment_method &&
296
- payment_type == o.payment_type &&
297
204
  portfolio_id == o.portfolio_id &&
298
- ref_no == o.ref_no &&
299
- to_be_printed == o.to_be_printed
205
+ ref_no == o.ref_no
300
206
  end
301
207
 
302
208
  # @see the `==` method
@@ -308,7 +214,7 @@ module Propertyware
308
214
  # Calculates hash code according to all attributes.
309
215
  # @return [Integer] Hash code
310
216
  def hash
311
- [amount, comments, contact_id, created_by, created_date_time, date, deposit_date, destination_account_id, gl_account_id, id, last_modified_by, last_modified_date_time, lease_id, payee_payer, payment_method, payment_type, portfolio_id, ref_no, to_be_printed].hash
217
+ [amount, comments, created_by, created_date_time, date, gl_account_id, id, last_modified_by, last_modified_date_time, lease_id, portfolio_id, ref_no].hash
312
218
  end
313
219
 
314
220
  # Builds the object from hash
@@ -221,7 +221,7 @@ module Propertyware
221
221
  # Check to see if the all the properties in the model are valid
222
222
  # @return true if the model is valid
223
223
  def valid?
224
- frequency_validator = EnumAttributeValidator.new('String', ["WEEKLY", "MONTHLY", "QUARTERLY", "SEMIANNUAL", "YEARLY"])
224
+ frequency_validator = EnumAttributeValidator.new('String', ["WEEKLY", "MONTHLY", "YEARLY", "MANUALLY"])
225
225
  return false unless frequency_validator.valid?(@frequency)
226
226
  true
227
227
  end
@@ -229,7 +229,7 @@ module Propertyware
229
229
  # Custom attribute writer method checking allowed values (enum).
230
230
  # @param [Object] frequency Object to be assigned
231
231
  def frequency=(frequency)
232
- validator = EnumAttributeValidator.new('String', ["WEEKLY", "MONTHLY", "QUARTERLY", "SEMIANNUAL", "YEARLY"])
232
+ validator = EnumAttributeValidator.new('String', ["WEEKLY", "MONTHLY", "YEARLY", "MANUALLY"])
233
233
  unless validator.valid?(frequency)
234
234
  fail ArgumentError, "invalid value #{ frequency.inspect } for \"frequency\", must be one of #{validator.allowable_values}."
235
235
  end
@@ -34,7 +34,7 @@ module Propertyware
34
34
  # Date and time the record was last modified. (Timezone: UTC)
35
35
  attr_accessor :last_modified_date_time
36
36
 
37
- # Name.
37
+ # Bank deposit name.
38
38
  attr_accessor :name
39
39
 
40
40
  # Status.
@@ -194,7 +194,7 @@ module Propertyware
194
194
  # @return true if the model is valid
195
195
  def valid?
196
196
  return false if @frequency.nil?
197
- frequency_validator = EnumAttributeValidator.new('String', ["WEEKLY", "MONTHLY", "QUARTERLY", "SEMIANNUAL", "YEARLY"])
197
+ frequency_validator = EnumAttributeValidator.new('String', ["WEEKLY", "MONTHLY", "QUARTERLY", "SEMIANUUAL", "ANUUAL", "ANUUAL_ACCRUAL"])
198
198
  return false unless frequency_validator.valid?(@frequency)
199
199
  return false if @start_date.nil?
200
200
  true
@@ -203,7 +203,7 @@ module Propertyware
203
203
  # Custom attribute writer method checking allowed values (enum).
204
204
  # @param [Object] frequency Object to be assigned
205
205
  def frequency=(frequency)
206
- validator = EnumAttributeValidator.new('String', ["WEEKLY", "MONTHLY", "QUARTERLY", "SEMIANNUAL", "YEARLY"])
206
+ validator = EnumAttributeValidator.new('String', ["WEEKLY", "MONTHLY", "QUARTERLY", "SEMIANUUAL", "ANUUAL", "ANUUAL_ACCRUAL"])
207
207
  unless validator.valid?(frequency)
208
208
  fail ArgumentError, "invalid value #{ frequency.inspect } for \"frequency\", must be one of #{validator.allowable_values}."
209
209
  end