buildium-ruby 2.1.0 → 3.1.0

data/buildium-ruby.gemspec

@@ -25,13 +25,11 @@ Gem::Specification.new do |s|
   s.summary     = "Open API, powered by Buildium Ruby Gem"
   s.description = "API client library for Buildium"
   s.license     = "Unlicense"
-  s.required_ruby_version = "> 2.6.0"
+  s.required_ruby_version = "> 3.0.0"
 
   s.add_runtime_dependency 'faraday', '>= 1.0.1', '< 3.0'
   s.add_runtime_dependency 'faraday-multipart'
 
-  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
-
   s.files         = `git ls-files`.split("\n").uniq.sort.select { |f| !f.empty? }
   s.test_files    = `git ls-files spec/*`.split("\n")
   s.executables   = []

data/docker-compose.yml

@@ -0,0 +1,19 @@
+# To run the container and rebuild the gem:
+# docker-compose run --rm app bash
+# > bin/rebuild.sh
+services:
+  app:
+    build: .
+    volumes:
+      - .:/app
+      - bundle_cache:/usr/local/bundle
+    command: /bin/bash
+    stdin_open: true
+    tty: true
+    environment:
+      - BUNDLE_PATH=/usr/local/bundle
+      - BUNDLE_APP_CONFIG=/usr/local/bundle
+    network_mode: bridge
+
+volumes:
+  bundle_cache:  # Persists installed gems between container runs

data/docs/AccountInfoMessage.md

@@ -7,8 +7,8 @@
 | **id** | **Integer** | Account unique identifier. | [optional] |
 | **company_name** | **String** | Account company name. | [optional] |
 | **url** | **String** | Url for this account. | [optional] |
-| **contact** | [**ContactInfoMessage**](ContactInfoMessage.md) |  | [optional] |
-| **accounting_settings** | [**AccountingSettingsMessage**](AccountingSettingsMessage.md) |  | [optional] |
+| **contact** | [**AccountInfoMessageContact**](AccountInfoMessageContact.md) |  | [optional] |
+| **accounting_settings** | [**AccountInfoMessageAccountingSettings**](AccountInfoMessageAccountingSettings.md) |  | [optional] |
 
 ## Example
 

data/docs/AccountInfoMessageAccountingSettings.md

@@ -0,0 +1,28 @@
+# Buildium::AccountInfoMessageAccountingSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accounting_book_id** | **Integer** | The accounting book entity unique identifier. | [optional] |
+| **default_bank_account_id** | **Integer** | The default bank account unique identifier. | [optional] |
+| **default_accounting_basis** | **String** | The default accounting basis. | [optional] |
+| **trust_account_warning** | **String** | Indicates the type of trust account warnings are enable within the account, if any. | [optional] |
+| **fiscal_year_end_month** | **Integer** | The month the fiscal year ends. | [optional] |
+| **fiscal_year_end_day** | **Integer** | The day the fiscal year ends. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::AccountInfoMessageAccountingSettings.new(
+  accounting_book_id: null,
+  default_bank_account_id: null,
+  default_accounting_basis: null,
+  trust_account_warning: null,
+  fiscal_year_end_month: null,
+  fiscal_year_end_day: null
+)
+```
+

data/docs/AccountInfoMessageContact.md

@@ -0,0 +1,24 @@
+# Buildium::AccountInfoMessageContact
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** | Contact first name. | [optional] |
+| **last_name** | **String** | Contact last name. | [optional] |
+| **address** | [**ContactInfoMessageAddress**](ContactInfoMessageAddress.md) |  | [optional] |
+| **phone_number** | **String** | Contact phone number. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::AccountInfoMessageContact.new(
+  first_name: null,
+  last_name: null,
+  address: null,
+  phone_number: null
+)
+```
+

data/docs/AccountingEntityMessage.md

@@ -7,7 +7,7 @@
 | **id** | **Integer** | The accounting entity unique identifier. | [optional] |
 | **accounting_entity_type** | **String** | The type of accounting entity. | [optional] |
 | **href** | **String** | A link to the accounting entity resource. | [optional] |
-| **unit** | [**UnitEntityMessage**](UnitEntityMessage.md) |  | [optional] |
+| **unit** | [**AccountingEntityMessageUnit**](AccountingEntityMessageUnit.md) |  | [optional] |
 
 ## Example
 

data/docs/AccountingEntityMessageUnit.md

@@ -0,0 +1,20 @@
+# Buildium::AccountingEntityMessageUnit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The unit unique identifier | [optional] |
+| **href** | **String** | A link to the unit resource. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::AccountingEntityMessageUnit.new(
+  id: null,
+  href: null
+)
+```
+

data/docs/AccountingEntityPatchMessage.md

@@ -0,0 +1,22 @@
+# Buildium::AccountingEntityPatchMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The unique identifier of the accounting entity | [optional] |
+| **accounting_entity_type** | **String** | The type of the accounting entity | [optional] |
+| **unit_id** | **Integer** | The unit unique identifier for the accounting entity. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::AccountingEntityPatchMessage.new(
+  id: null,
+  accounting_entity_type: null,
+  unit_id: null
+)
+```
+

data/docs/AccountingLockPeriodMessage.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **global** | [**LockPeriodSettingsGlobalMessage**](LockPeriodSettingsGlobalMessage.md) |  | [optional] |
+| **global** | [**AccountingLockPeriodMessageGlobal**](AccountingLockPeriodMessageGlobal.md) |  | [optional] |
 | **overrides** | [**Array<LockPeriodSettingsOverridesMessage>**](LockPeriodSettingsOverridesMessage.md) | Settings overrides for specific properties. | [optional] |
 | **financial_administrator_user_ids** | **Array<Integer>** | A collection of identifiers for users that have been designated financial administrators. These users will have permission to add, edit, and delete transactions during a locked period. This won't conflict with any property-level permissions for this account. By default, account administrators have permission to add, edit, and delete transactions within a locked period. | [optional] |
 

data/docs/AccountingLockPeriodMessageGlobal.md

@@ -0,0 +1,18 @@
+# Buildium::AccountingLockPeriodMessageGlobal
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **lock_date** | **Date** | Financial transactions on or prior to this date will be locked. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::AccountingLockPeriodMessageGlobal.new(
+  lock_date: null
+)
+```
+

data/docs/AdministrationApi.md

@@ -8,8 +8,10 @@ All URIs are relative to *https://api.buildium.com*
 | [**get_accounting_lock_period_settings**](AdministrationApi.md#get_accounting_lock_period_settings) | **GET** /v1/administration/accountinglockperiod | Retrieve accounting lock periods |
 | [**get_all_user_roles**](AdministrationApi.md#get_all_user_roles) | **GET** /v1/userroles | Retrieve all user roles |
 | [**get_all_users**](AdministrationApi.md#get_all_users) | **GET** /v1/users | Retrieve all users |
+| [**get_global_partial_payment_settings**](AdministrationApi.md#get_global_partial_payment_settings) | **GET** /v1/administration/residentsettings/partialpaymentsettings | Retrieve the partial payment settings for residents |
 | [**get_user_by_id**](AdministrationApi.md#get_user_by_id) | **GET** /v1/users/{userId} | Retrieve a user |
 | [**get_user_role_by_id**](AdministrationApi.md#get_user_role_by_id) | **GET** /v1/userroles/{userRoleId} | Retrieve a user role |
+| [**patch_global_partial_payment_settings**](AdministrationApi.md#patch_global_partial_payment_settings) | **PATCH** /v1/administration/residentsettings/partialpaymentsettings | Update the partial payment settings for residents |
 
 
 ## get_account_info
@@ -18,7 +20,7 @@ All URIs are relative to *https://api.buildium.com*
 
 Retrieve account info
 
-Retrieves information related to the Buildium account.   <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Administration &gt; Account Information</span> - `View`
+Retrieves information related to the Buildium account.   <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Administration > Account Information</span> - `View`
 
 ### Examples
 
@@ -91,7 +93,7 @@ This endpoint does not need any parameter.
 
 Retrieve accounting lock periods
 
-Retrieves accounting lock periods.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Administration &gt; Application Settings</span> - `View`
+Retrieves accounting lock periods.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Administration > Application Settings</span> - `View`
 
 ### Examples
 
@@ -164,7 +166,7 @@ This endpoint does not need any parameter.
 
 Retrieve all user roles
 
-Retrieves a list of user roles.  <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Administration &gt; User Roles</span> - `View`
+Retrieves a list of user roles.  <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Administration > User Roles</span> - `View`
 
 ### Examples
 
@@ -246,7 +248,7 @@ end
 
 Retrieve all users
 
-Retrieves a list of users.  <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Administration &gt; Users</span> - `View`
+Retrieves a list of users.  <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Administration > Users</span> - `View`
 
 ### Examples
 
@@ -332,13 +334,86 @@ end
 - **Accept**: application/json
 
 
+## get_global_partial_payment_settings
+
+> <PartialPaymentSettingsMessage> get_global_partial_payment_settings
+
+Retrieve the partial payment settings for residents
+
+Retrieves the partial payment settings for residents.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Administration > Application Settings</span> - `View`
+
+### Examples
+
+```ruby
+require 'time'
+require 'buildium-ruby'
+# setup authorization
+Buildium.configure do |config|
+  # Configure API key authorization: clientId
+  config.api_key['clientId'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['clientId'] = 'Bearer'
+
+  # Configure API key authorization: clientSecret
+  config.api_key['clientSecret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['clientSecret'] = 'Bearer'
+end
+
+api_instance = Buildium::AdministrationApi.new
+
+begin
+  # Retrieve the partial payment settings for residents
+  result = api_instance.get_global_partial_payment_settings
+  p result
+rescue Buildium::ApiError => e
+  puts "Error when calling AdministrationApi->get_global_partial_payment_settings: #{e}"
+end
+```
+
+#### Using the get_global_partial_payment_settings_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PartialPaymentSettingsMessage>, Integer, Hash)> get_global_partial_payment_settings_with_http_info
+
+```ruby
+begin
+  # Retrieve the partial payment settings for residents
+  data, status_code, headers = api_instance.get_global_partial_payment_settings_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PartialPaymentSettingsMessage>
+rescue Buildium::ApiError => e
+  puts "Error when calling AdministrationApi->get_global_partial_payment_settings_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**PartialPaymentSettingsMessage**](PartialPaymentSettingsMessage.md)
+
+### Authorization
+
+[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_user_by_id
 
 > <UserMessage> get_user_by_id(user_id)
 
 Retrieve a user
 
-Retrieve a specific user.  <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Administration &gt; Users</span> - `View`
+Retrieve a specific user.  <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Administration > Users</span> - `View`
 
 ### Examples
 
@@ -414,7 +489,7 @@ end
 
 Retrieve a user role
 
-Retrieve a specific user role.  <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Administration &gt; User Roles</span> - `View`
+Retrieve a specific user role.  <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Administration > User Roles</span> - `View`
 
 ### Examples
 
@@ -483,3 +558,79 @@ end
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## patch_global_partial_payment_settings
+
+> <PartialPaymentSettingsMessage> patch_global_partial_payment_settings(patch_global_partial_payment_settings_request)
+
+Update the partial payment settings for residents
+
+Updates the partial payment settings for residents.              <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Administration > Application Settings</span> - `View` `Edit`
+
+### Examples
+
+```ruby
+require 'time'
+require 'buildium-ruby'
+# setup authorization
+Buildium.configure do |config|
+  # Configure API key authorization: clientId
+  config.api_key['clientId'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['clientId'] = 'Bearer'
+
+  # Configure API key authorization: clientSecret
+  config.api_key['clientSecret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['clientSecret'] = 'Bearer'
+end
+
+api_instance = Buildium::AdministrationApi.new
+patch_global_partial_payment_settings_request = Buildium::PatchGlobalPartialPaymentSettingsRequest.new # PatchGlobalPartialPaymentSettingsRequest | <span>Represents the structure of the data that can be provided to a <a target=\"_blank\" href=\"https://datatracker.ietf.org/doc/html/rfc6902\">JSON patch document</a> as path values via <a target=\"_blank\" href=\"https://datatracker.ietf.org/doc/html/rfc6901/\">JSON pointer</a> syntax.</span>
+
+begin
+  # Update the partial payment settings for residents
+  result = api_instance.patch_global_partial_payment_settings(patch_global_partial_payment_settings_request)
+  p result
+rescue Buildium::ApiError => e
+  puts "Error when calling AdministrationApi->patch_global_partial_payment_settings: #{e}"
+end
+```
+
+#### Using the patch_global_partial_payment_settings_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PartialPaymentSettingsMessage>, Integer, Hash)> patch_global_partial_payment_settings_with_http_info(patch_global_partial_payment_settings_request)
+
+```ruby
+begin
+  # Update the partial payment settings for residents
+  data, status_code, headers = api_instance.patch_global_partial_payment_settings_with_http_info(patch_global_partial_payment_settings_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PartialPaymentSettingsMessage>
+rescue Buildium::ApiError => e
+  puts "Error when calling AdministrationApi->patch_global_partial_payment_settings_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **patch_global_partial_payment_settings_request** | [**PatchGlobalPartialPaymentSettingsRequest**](PatchGlobalPartialPaymentSettingsRequest.md) | &lt;span&gt;Represents the structure of the data that can be provided to a &lt;a target&#x3D;\&quot;_blank\&quot; href&#x3D;\&quot;https://datatracker.ietf.org/doc/html/rfc6902\&quot;&gt;JSON patch document&lt;/a&gt; as path values via &lt;a target&#x3D;\&quot;_blank\&quot; href&#x3D;\&quot;https://datatracker.ietf.org/doc/html/rfc6901/\&quot;&gt;JSON pointer&lt;/a&gt; syntax.&lt;/span&gt; |  |
+
+### Return type
+
+[**PartialPaymentSettingsMessage**](PartialPaymentSettingsMessage.md)
+
+### Authorization
+
+[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/json-patch+json
+- **Accept**: application/json
+

data/docs/AllTasksMessage.md

@@ -6,13 +6,13 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **Integer** | Task unique identifier. | [optional] |
 | **task_type** | **String** | The task type. | [optional] |
-| **category** | [**TaskCategoryResponseMessage**](TaskCategoryResponseMessage.md) |  | [optional] |
+| **category** | [**AllTasksMessageCategory**](AllTasksMessageCategory.md) |  | [optional] |
 | **title** | **String** | Task title. | [optional] |
 | **description** | **String** | Task description. | [optional] |
-| **property** | [**PropertyMessage**](PropertyMessage.md) |  | [optional] |
+| **property** | [**AllTasksMessageProperty**](AllTasksMessageProperty.md) |  | [optional] |
 | **unit_id** | **Integer** | The unit unique identifier associated with the task. | [optional] |
-| **unit_agreement** | [**UnitAgreementMessage**](UnitAgreementMessage.md) |  | [optional] |
-| **requested_by_user_entity** | [**RequestedByUserEntityMessage**](RequestedByUserEntityMessage.md) |  | [optional] |
+| **unit_agreement** | [**AllTasksMessageUnitAgreement**](AllTasksMessageUnitAgreement.md) |  | [optional] |
+| **requested_by_user_entity** | [**AllTasksMessageRequestedByUserEntity**](AllTasksMessageRequestedByUserEntity.md) |  | [optional] |
 | **assigned_to_user_id** | **Integer** | The unique identifier of the staff user assigned to the task. | [optional] |
 | **task_status** | **String** | Task status. | [optional] |
 | **priority** | **String** | Task priority. | [optional] |

data/docs/AllTasksMessageCategory.md

@@ -0,0 +1,24 @@
+# Buildium::AllTasksMessageCategory
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Task category unique identifier. | [optional] |
+| **name** | **String** | Name of the task category. | [optional] |
+| **href** | **String** | A link to the task category resource. | [optional] |
+| **sub_category** | [**TaskCategoryResponseMessageSubCategory**](TaskCategoryResponseMessageSubCategory.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::AllTasksMessageCategory.new(
+  id: null,
+  name: null,
+  href: null,
+  sub_category: null
+)
+```
+

data/docs/AllTasksMessageProperty.md

@@ -0,0 +1,22 @@
+# Buildium::AllTasksMessageProperty
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The property unique identifier. | [optional] |
+| **type** | **String** | The property type. | [optional] |
+| **href** | **String** | A link to the property entity resource. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::AllTasksMessageProperty.new(
+  id: null,
+  type: null,
+  href: null
+)
+```
+

data/docs/AllTasksMessageRequestedByUserEntity.md

@@ -0,0 +1,28 @@
+# Buildium::AllTasksMessageRequestedByUserEntity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | Entity type. | [optional] |
+| **id** | **Integer** | Entity identifier. | [optional] |
+| **first_name** | **String** | First name. | [optional] |
+| **last_name** | **String** | Last name. | [optional] |
+| **is_company** | **Boolean** | Indicates whether entity is a company. | [optional] |
+| **href** | **String** | A link to the entity resource. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::AllTasksMessageRequestedByUserEntity.new(
+  type: null,
+  id: null,
+  first_name: null,
+  last_name: null,
+  is_company: null,
+  href: null
+)
+```
+

data/docs/AllTasksMessageUnitAgreement.md

@@ -0,0 +1,22 @@
+# Buildium::AllTasksMessageUnitAgreement
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Unit agreement unique identifier. | [optional] |
+| **type** | **String** | The type of unit agreement. | [optional] |
+| **href** | **String** | A link to the unit agreement resource. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::AllTasksMessageUnitAgreement.new(
+  id: null,
+  type: null,
+  href: null
+)
+```
+

data/docs/AnnouncementMessage.md

@@ -10,7 +10,7 @@
 | **announcement_date** | **Date** | Date the announcement was published. | [optional] |
 | **expiration_date** | **Date** | Indicates the date on which the announcement will be removed from the Resident Center. | [optional] |
 | **channels** | **Array<String>** | List of the distribution channels the announcement was sent through. | [optional] |
-| **sender** | [**AnnouncementSenderMessage**](AnnouncementSenderMessage.md) |  | [optional] |
+| **sender** | [**AnnouncementMessageSender**](AnnouncementMessageSender.md) |  | [optional] |
 
 ## Example
 

data/docs/AnnouncementMessageSender.md

@@ -0,0 +1,22 @@
+# Buildium::AnnouncementMessageSender
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | Unique identifier of the user who sent the announcement. | [optional] |
+| **display_name** | **String** | Display name of the user who sent the announcement. | [optional] |
+| **href** | **String** | A link to the user resource. | [optional] |
+
+## Example
+
+```ruby
+require 'buildium-ruby'
+
+instance = Buildium::AnnouncementMessageSender.new(
+  id: null,
+  display_name: null,
+  href: null
+)
+```
+