buildium-ruby 2.0.1 → 3.0.0

data/docs/GeneralLedgerEntryMessage.md

@@ -0,0 +1,30 @@
+# Buildium::GeneralLedgerEntryMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The unique identifier of the transaction associated with the entry. | [optional] |
+| **date** | **Date** | Date of the transaction. | [optional] |
+| **description** | **String** | Transaction description. | [optional] |
+| **amount** | **Float** | Entry amount. | [optional] |
+| **balance** | **Float** | The general ledger account balance after this entry was recorded. | [optional] |
+| **transaction_type** | **String** | Indicates the type of transaction that occurred. | [optional] |
+| **accounting_entity** | [**AccountingEntityMessage**](AccountingEntityMessage.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::GeneralLedgerEntryMessage.new(
+  id: null,
+  date: null,
+  description: null,
+  amount: null,
+  balance: null,
+  transaction_type: null,
+  accounting_entity: null
+)
+```
+

data/docs/GeneralLedgerMessage.md

@@ -0,0 +1,26 @@
+# Buildium::GeneralLedgerMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **gl_account_id** | **Integer** | Unique identifier of the general ledger account associated with the entries. | [optional] |
+| **gl_account_name** | **String** | Name of the general ledger account associated with the entries. | [optional] |
+| **beginning_balance** | **Float** | The general ledger account balance based on the date range requested. | [optional] |
+| **total_amount** | **Float** | The sum of the entry amounts that were recorded under this general ledger account within the date range requested. | [optional] |
+| **entries** | [**Array<GeneralLedgerEntryMessage>**](GeneralLedgerEntryMessage.md) | Entries applied to the general ledger account. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::GeneralLedgerMessage.new(
+  gl_account_id: null,
+  gl_account_name: null,
+  beginning_balance: null,
+  total_amount: null,
+  entries: null
+)
+```
+

data/docs/GeneralLedgerSearchMessage.md

@@ -0,0 +1,28 @@
+# Buildium::GeneralLedgerSearchMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accounting_basis** | **String** | The methodology in which revenues and expenses are recognized when calculating the balances. Specifying `Cash` calculates balances based on when money changes hands. Specifying `Accrual` calculates balances based on the period in which the transaction originally happened. |  |
+| **entity_type** | **String** | Specifies the type of entity that `EntityId` field refers to. | [optional] |
+| **entity_id** | **Integer** | Filters results to any general ledger entry containing line items associated with the specified entity identifier. This filter is used in conjunction with the `EntityType` field which must be set to the type of entity this identifier references. | [optional] |
+| **gl_account_ids** | **Array<Integer>** | Filters results to entries whose general ledger account belongs to the specified set of general ledger account ids. |  |
+| **start_date** | **Date** | Filters results to any entries whose start date is greater than or equal to the specified value. |  |
+| **end_date** | **Date** | Filters results to any entries whose end date is less than or equal to the specified value. |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::GeneralLedgerSearchMessage.new(
+  accounting_basis: null,
+  entity_type: null,
+  entity_id: null,
+  gl_account_ids: null,
+  start_date: null,
+  end_date: null
+)
+```
+

data/docs/ImageReorderRequestPutMessage.md

@@ -0,0 +1,18 @@
+# Buildium::ImageReorderRequestPutMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ids** | **Array<Integer>** | Unique identifiers for the images. The request must contain the ids of all images. |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::ImageReorderRequestPutMessage.new(
+  ids: null
+)
+```
+

data/docs/InsuredTenantMessage.md

@@ -0,0 +1,24 @@
+# Buildium::InsuredTenantMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Tenant unique identifier. | [optional] |
+| **first_name** | **String** | First name of the tenant. | [optional] |
+| **last_name** | **String** | Last name of the tenant. | [optional] |
+| **is_primary_insured** | **Boolean** | Indicates whether this tenant is the primary insured person on the policy. This only applies to policies with a `CarrierType` of `MSI`. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::InsuredTenantMessage.new(
+  id: null,
+  first_name: null,
+  last_name: null,
+  is_primary_insured: null
+)
+```
+

data/docs/JournalLineMessage.md

@@ -10,6 +10,7 @@
 | **reference_number** | **String** | Reference number for the line item. | [optional] |
 | **memo** | **String** | Memo for the line item. | [optional] |
 | **property_id** | **Integer** | PropertyId associated with the line item. | [optional] |
+| **unit_id** | **Integer** | UnitId associated with the line item. | [optional] |
 
 ## Example
 
@@ -22,7 +23,8 @@ instance = Buildium::JournalLineMessage.new(
   is_cash_posting: null,
   reference_number: null,
   memo: null,
-  property_id: null
+  property_id: null,
+  unit_id: null
 )
 ```
 

data/docs/JsonPatchOperation.md

@@ -0,0 +1,24 @@
+# Buildium::JsonPatchOperation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **op** | **String** |  |  |
+| **path** | **String** |  |  |
+| **value** | **Object** |  | [optional] |
+| **from** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::JsonPatchOperation.new(
+  op: null,
+  path: null,
+  value: null,
+  from: null
+)
+```
+

data/docs/LeaseAutoAllocatedPaymentPostMessage.md

@@ -0,0 +1,30 @@
+# Buildium::LeaseAutoAllocatedPaymentPostMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** | The date of the transaction. The date must be formatted as YYYY-MM-DD. |  |
+| **payment_method** | **String** | The payment method used for the transaction. |  |
+| **payee_user_id** | **Integer** | The payee's user unique identifier. | [optional] |
+| **memo** | **String** | A brief note describing the reason for the payment. The value cannot exceed 65 characters. | [optional] |
+| **reference_number** | **String** | The reference Number of the transaction. The value cannot exceed 30 characters. | [optional] |
+| **send_email_receipt** | **Boolean** | An indicator for whether or not to send an email receipt to the payee. If the payee does not have an email address set, no email will be sent. |  |
+| **total_amount** | **Float** | The total amount of the payment being created. |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::LeaseAutoAllocatedPaymentPostMessage.new(
+  date: null,
+  payment_method: null,
+  payee_user_id: null,
+  memo: null,
+  reference_number: null,
+  send_email_receipt: null,
+  total_amount: null
+)
+```
+

data/docs/LeaseLedgerPaymentPutMessage.md

@@ -0,0 +1,28 @@
+# Buildium::LeaseLedgerPaymentPutMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date** | **Date** | The date of the transaction. The date must be formatted as YYYY-MM-DD. |  |
+| **payment_method** | **String** | The payment method used for the transaction. |  |
+| **payee_user_id** | **Integer** | The payee's user unique identifier. | [optional] |
+| **memo** | **String** | A brief note describing the reason for the payment. The value cannot exceed 65 characters. | [optional] |
+| **reference_number** | **String** | The reference Number of the transaction. The value cannot exceed 30 characters. | [optional] |
+| **lines** | [**Array<LeaseLedgerPaymentLineSaveMessage>**](LeaseLedgerPaymentLineSaveMessage.md) | A collection of line items included in the payment. At least one line item is required. |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::LeaseLedgerPaymentPutMessage.new(
+  date: null,
+  payment_method: null,
+  payee_user_id: null,
+  memo: null,
+  reference_number: null,
+  lines: null
+)
+```
+

data/docs/LeasePostMessage.md

@@ -9,7 +9,9 @@
 | **lease_from_date** | **Date** | Start date of the lease. |  |
 | **lease_to_date** | **Date** | End date of the lease. | [optional] |
 | **send_welcome_email** | **Boolean** | Indicates whether to send a welcome email to all tenants on the lease inviting them to the resident center website. |  |
-| **tenants** | [**Array<RentalTenantPutMessage>**](RentalTenantPutMessage.md) | List of the tenants on the lease. |  |
+| **tenants** | [**Array<RentalTenantPutMessage>**](RentalTenantPutMessage.md) | List of new tenants to add to the lease. The list cannot exceed five tenants. | [optional] |
+| **tenant_ids** | **Array<Integer>** | List of identifiers for existing tenants to add to the lease. The list cannot exceed five tenants. | [optional] |
+| **applicant_ids** | **Array<Integer>** | List of identifiers for applicants to become tenants on the lease. Identifiers must refer to applicants with a Status of `Approved`. The list cannot exceed five applicants. | [optional] |
 | **cosigners** | [**Array<LeaseCosignerPostMessage>**](LeaseCosignerPostMessage.md) | List of the cosigners on the lease. | [optional] |
 | **rent** | [**LeaseRentPostMessage**](LeaseRentPostMessage.md) |  | [optional] |
 | **security_deposit** | [**LeaseSecurityDepositPostMessage**](LeaseSecurityDepositPostMessage.md) |  | [optional] |
@@ -28,6 +30,8 @@ instance = Buildium::LeasePostMessage.new(
   lease_to_date: null,
   send_welcome_email: null,
   tenants: null,
+  tenant_ids: null,
+  applicant_ids: null,
   cosigners: null,
   rent: null,
   security_deposit: null,

data/docs/LeaseRenewalSearchMessage.md

@@ -0,0 +1,22 @@
+# Buildium::LeaseRenewalSearchMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **property_ids** | **Array<Integer>** | Filters results to only include leases whose unit belongs to the specified set of property ids. | [optional] |
+| **rental_owner_ids** | **Array<Integer>** | Filters results to any lease whose unit belongs to a property with rental owner in the specified set of rental owner ids. | [optional] |
+| **e_signature_statuses** | **Array<String>** | Filters result to any lease renewal with an esignature status that matches the given statuses. |  |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::LeaseRenewalSearchMessage.new(
+  property_ids: null,
+  rental_owner_ids: null,
+  e_signature_statuses: null
+)
+```
+

data/docs/LeaseRentMessage.md

@@ -9,7 +9,7 @@
 | **end_date** | **Date** | End date of the rent. | [optional] |
 | **total_amount** | **Float** | Total amount of the rent. | [optional] |
 | **rent_cycle** | **String** | Determines the frequency at which rent is charged. | [optional] |
-| **backdate_charges** | **Boolean** | Indicates whether the rent has backdated charges. | [optional] |
+| **backdate_charges** | **Boolean** | Indicates whether backdated charges should be created when creating or editing rents. This field will always return false, even if backdated charges exist. | [optional] |
 | **created_date_time** | **Time** | The date and time the rent was created. | [optional] |
 | **created_by_user_id** | **Integer** | Unique identifier of user that created the rent. | [optional] |
 | **charges** | [**Array<LeaseRentChargeMessage>**](LeaseRentChargeMessage.md) | A collection of charges associated with the rent. | [optional] |

data/docs/LeaseTenantMessage.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **Integer** | Tenant unique identifier. | [optional] |
 | **status** | **String** | Indicates the tenant's current status in relation to the lease. | [optional] |
+| **move_in_date** | **Date** | Indicates the tenant's move-in date. | [optional] |
 
 ## Example
 
@@ -14,7 +15,8 @@ require 'buildium-ruby'
 
 instance = Buildium::LeaseTenantMessage.new(
   id: null,
-  status: null
+  status: null,
+  move_in_date: null
 )
 ```
 

data/docs/LeaseTransactionMessage.md

@@ -6,7 +6,8 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **Integer** | Transaction unique identifier. | [optional] |
 | **date** | **Date** | Date of the transaction. | [optional] |
-| **transaction_type** | **String** | Type of transaction that occurred | [optional] |
+| **transaction_type** | **String** | Type of transaction that occurred. | [optional] |
+| **transaction_type_enum** | **String** | The type of transaction that occurred. | [optional] |
 | **total_amount** | **Float** | Sum of all `Journal.Lines.Amount` entries in the transaction. | [optional] |
 | **check_number** | **String** | Check number associated with the transaction, if applicable. | [optional] |
 | **lease_id** | **Integer** | Lease unique identifier associated with the transaction, if applicable. Null if value is not set. | [optional] |
@@ -23,6 +24,7 @@ instance = Buildium::LeaseTransactionMessage.new(
   id: null,
   date: null,
   transaction_type: null,
+  transaction_type_enum: null,
   total_amount: null,
   check_number: null,
   lease_id: null,