buildium-ruby 2.0.1 → 3.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/ci.yml +1 -3
- data/.github/workflows/publish.yml +2 -2
- data/.openapi-generator/FILES +200 -405
- data/.openapi-generator/templates/ruby-client/Gemfile.mustache +3 -0
- data/.openapi-generator/templates/ruby-client/gemspec.mustache +1 -3
- data/.openapi-generator/templates/ruby-client/rubocop.mustache +1 -1
- data/.rubocop.yml +1 -1
- data/.tool-versions +1 -0
- data/CUSTOMIZATIONS.md +4 -0
- data/DOCS.md +404 -112
- data/Gemfile +1 -7
- data/Gemfile.lock +9 -54
- data/README.md +2 -2
- data/bin/CUSTOMIZATIONS.md +4 -0
- data/bin/README.md +2 -2
- data/bin/config.yml +5 -2
- data/bin/rebuild.sh +15 -9
- data/bin/swagger.json +17251 -8723
- data/buildium-ruby.gemspec +2 -4
- data/docs/AccountingEntityMessage.md +3 -1
- data/docs/AccountingEntitySaveMessage.md +3 -1
- data/docs/{AssociationAppliancesApi.md → AppliancesApi.md} +41 -41
- data/docs/ApplicantMessage.md +2 -0
- data/docs/AppliedVendorCreditMessage.md +20 -0
- data/docs/AssociationMessage.md +3 -1
- data/docs/AssociationMeterReadingsApi.md +344 -0
- data/docs/AssociationOwnershipAccountSearchMessage.md +2 -0
- data/docs/AssociationPostMessage.md +3 -1
- data/docs/AssociationSearchMessage.md +5 -1
- data/docs/AssociationTaxInformationMessage.md +26 -0
- data/docs/AssociationsApi.md +204 -217
- data/docs/BankAccountCheckAccountingEntitySaveMessage.md +3 -1
- data/docs/BankAccountCheckFileMessage.md +28 -0
- data/docs/BankAccountDepositPostMessage.md +1 -1
- data/docs/BankAccountMessage.md +3 -1
- data/docs/BankAccountSearchMessage.md +3 -1
- data/docs/BankAccountTransferAccountingEntitySaveMessage.md +3 -1
- data/docs/BankAccountsApi.md +412 -0
- data/docs/BankLockboxDataAssociationMessage.md +22 -0
- data/docs/BankLockboxDataAssociationOwnerMessage.md +30 -0
- data/docs/BankLockboxDataMessage.md +20 -0
- data/docs/BankLockboxDataOwnershipAccountMessage.md +26 -0
- data/docs/BankLockboxDataSearchMessage.md +18 -0
- data/docs/BillPaymentAccountingEntityMessage.md +3 -1
- data/docs/BillPaymentMessage.md +4 -0
- data/docs/BillsApi.md +1059 -0
- data/docs/BoardMembersApi.md +417 -0
- data/docs/BudgetsApi.md +329 -0
- data/docs/CCPaymentsMessage.md +18 -0
- data/docs/CCPaymentsPutMessage.md +18 -0
- data/docs/CancellationToken.md +22 -0
- data/docs/CommunicationsApi.md +39 -39
- data/docs/ContactRequestsApi.md +347 -0
- data/docs/EFTPaymentsMessage.md +18 -0
- data/docs/EFTPaymentsPutMessage.md +18 -0
- data/docs/EPaySettingsMessage.md +22 -0
- data/docs/EPaySettingsPutMessage.md +22 -0
- data/docs/FileSharingAccountMessage.md +26 -0
- data/docs/FileSharingAccountPutMessage.md +26 -0
- data/docs/FileSharingAssociationMessage.md +20 -0
- data/docs/FileSharingAssociationOwnerMessage.md +18 -0
- data/docs/FileSharingAssociationOwnerPutMessage.md +18 -0
- data/docs/FileSharingAssociationPutMessage.md +20 -0
- data/docs/FileSharingAssociationUnitMessage.md +20 -0
- data/docs/FileSharingAssociationUnitPutMessage.md +20 -0
- data/docs/FileSharingCommitteeMessage.md +22 -0
- data/docs/FileSharingCommitteePutMessage.md +22 -0
- data/docs/FileSharingLeaseMessage.md +20 -0
- data/docs/FileSharingLeasePutMessage.md +20 -0
- data/docs/FileSharingMessage.md +40 -0
- data/docs/FileSharingOwnershipAccountMessage.md +20 -0
- data/docs/FileSharingOwnershipAccountPutMessage.md +20 -0
- data/docs/FileSharingPutMessage.md +40 -0
- data/docs/FileSharingRentalMessage.md +20 -0
- data/docs/FileSharingRentalOwnerMessage.md +18 -0
- data/docs/FileSharingRentalOwnerPutMessage.md +18 -0
- data/docs/FileSharingRentalPutMessage.md +20 -0
- data/docs/FileSharingRentalUnitMesage.md +20 -0
- data/docs/FileSharingRentalUnitPutMesage.md +20 -0
- data/docs/FileSharingTenantMessage.md +20 -0
- data/docs/FileSharingTenantPutMessage.md +20 -0
- data/docs/FileSharingVendorMessage.md +18 -0
- data/docs/FileSharingVendorPutMessage.md +18 -0
- data/docs/FilesApi.md +159 -3
- data/docs/GeneralJournalEntryLineSaveMessage.md +1 -1
- data/docs/GeneralLedgerApi.md +839 -0
- data/docs/GeneralLedgerEntryMessage.md +30 -0
- data/docs/GeneralLedgerMessage.md +26 -0
- data/docs/GeneralLedgerSearchMessage.md +28 -0
- data/docs/ImageReorderRequestPutMessage.md +18 -0
- data/docs/InsuredTenantMessage.md +24 -0
- data/docs/JournalLineMessage.md +3 -1
- data/docs/JsonPatchOperation.md +24 -0
- data/docs/LeaseAutoAllocatedPaymentPostMessage.md +30 -0
- data/docs/LeaseLedgerPaymentPutMessage.md +28 -0
- data/docs/LeasePostMessage.md +5 -1
- data/docs/LeaseRenewalSearchMessage.md +22 -0
- data/docs/LeaseRentMessage.md +1 -1
- data/docs/LeaseTenantMessage.md +3 -1
- data/docs/LeaseTransactionMessage.md +3 -1
- data/docs/LeaseTransactionsApi.md +1627 -0
- data/docs/LeasesApi.md +302 -1353
- data/docs/ListingEntityFilePostMessage.md +22 -0
- data/docs/ListingsApi.md +5 -5
- data/docs/MeterReadingDetailMessage.md +28 -0
- data/docs/MeterReadingDetailPutMessage.md +24 -0
- data/docs/MeterReadingDetailsDeleteSearchMessage.md +20 -0
- data/docs/MeterReadingDetailsMessage.md +22 -0
- data/docs/MeterReadingDetailsPutMessage.md +22 -0
- data/docs/MeterReadingDetailsPutSearchMessage.md +20 -0
- data/docs/MeterReadingDetailsSearchMessage.md +20 -0
- data/docs/MeterReadingMessage.md +26 -0
- data/docs/MeterReadingSearchMessage.md +22 -0
- data/docs/MultipleBillPaymentsPostMessage.md +26 -0
- data/docs/OfflinePaymentsMessage.md +22 -0
- data/docs/OfflinePaymentsPutMessage.md +22 -0
- data/docs/OwnershipAccountAutoAllocatedPaymentPostMessage.md +30 -0
- data/docs/OwnershipAccountLedgerPaymentPutMessage.md +28 -0
- data/docs/OwnershipAccountTransactionMessage.md +2 -0
- data/docs/{AssociationOwnershipAccountsApi.md → OwnershipAccountTransactionsApi.md} +146 -644
- data/docs/OwnershipAccountsApi.md +667 -0
- data/docs/PropertyGroupsApi.md +1 -1
- data/docs/RentalImageMessage.md +26 -0
- data/docs/RentalImagePutMessage.md +20 -0
- data/docs/RentalMeterReadingsApi.md +344 -0
- data/docs/RentalOwnerContributionDataMessage.md +20 -0
- data/docs/RentalOwnerContributionDataPutMessage.md +20 -0
- data/docs/RentalOwnerContributionMessage.md +20 -0
- data/docs/RentalOwnerContributionPutMessage.md +20 -0
- data/docs/RentalOwnerContributionReminderMessage.md +20 -0
- data/docs/RentalOwnerContributionReminderPutMessage.md +20 -0
- data/docs/RentalOwnerRequestsApi.md +503 -0
- data/docs/RentalPropertiesApi.md +1123 -176
- data/docs/RentalPropertyPostMessage.md +1 -1
- data/docs/RentalUnitImageMessage.md +26 -0
- data/docs/RentalUnitImagePutMessage.md +20 -0
- data/docs/RentalUnitMessage.md +2 -2
- data/docs/RentalUnitsApi.md +639 -0
- data/docs/RentersInsurancePolicyMessage.md +32 -0
- data/docs/ResidentCenterApi.md +255 -0
- data/docs/ResidentRequestTaskPostMessage.md +5 -1
- data/docs/ResidentRequestsApi.md +349 -0
- data/docs/RetailCashPropertyMessage.md +24 -0
- data/docs/RetailCashUnitMessage.md +22 -0
- data/docs/RetailCashUserDataMessage.md +30 -0
- data/docs/RetailCashUserMessage.md +30 -0
- data/docs/RetailCashUserPutMessage.md +18 -0
- data/docs/RetailCashUsersSearchMessage.md +28 -0
- data/docs/SafeWaitHandle.md +20 -0
- data/docs/TasksApi.md +230 -1592
- data/docs/ToDoRequestsApi.md +347 -0
- data/docs/UnitEntityMessage.md +20 -0
- data/docs/VendorsApi.md +1 -1
- data/docs/VideoLinkRequestPostMessage.md +20 -0
- data/docs/WaitHandle.md +20 -0
- data/lib/buildium-ruby/api/administration_api.rb +1 -1
- data/lib/buildium-ruby/api/{association_appliances_api.rb → appliances_api.rb} +52 -52
- data/lib/buildium-ruby/api/applicants_api.rb +1 -1
- data/lib/buildium-ruby/api/association_meter_readings_api.rb +363 -0
- data/lib/buildium-ruby/api/association_owners_api.rb +1 -1
- data/lib/buildium-ruby/api/association_tenants_api.rb +1 -1
- data/lib/buildium-ruby/api/association_units_api.rb +1 -1
- data/lib/buildium-ruby/api/associations_api.rb +238 -284
- data/lib/buildium-ruby/api/bank_accounts_api.rb +387 -1
- data/lib/buildium-ruby/api/bills_api.rb +965 -0
- data/lib/buildium-ruby/api/board_members_api.rb +406 -0
- data/lib/buildium-ruby/api/budgets_api.rb +302 -0
- data/lib/buildium-ruby/api/client_leads_api.rb +1 -1
- data/lib/buildium-ruby/api/communications_api.rb +49 -49
- data/lib/buildium-ruby/api/contact_requests_api.rb +341 -0
- data/lib/buildium-ruby/api/files_api.rb +144 -7
- data/lib/buildium-ruby/api/general_ledger_api.rb +809 -0
- data/lib/buildium-ruby/api/lease_transactions_api.rb +1531 -0
- data/lib/buildium-ruby/api/leases_api.rb +193 -1191
- data/lib/buildium-ruby/api/listings_api.rb +5 -5
- data/lib/buildium-ruby/api/{association_ownership_accounts_api.rb → ownership_account_transactions_api.rb} +166 -613
- data/lib/buildium-ruby/api/ownership_accounts_api.rb +626 -0
- data/lib/buildium-ruby/api/property_groups_api.rb +3 -3
- data/lib/buildium-ruby/api/rental_appliances_api.rb +1 -1
- data/lib/buildium-ruby/api/rental_meter_readings_api.rb +363 -0
- data/lib/buildium-ruby/api/rental_owner_requests_api.rb +478 -0
- data/lib/buildium-ruby/api/rental_owners_api.rb +1 -1
- data/lib/buildium-ruby/api/rental_properties_api.rb +898 -54
- data/lib/buildium-ruby/api/rental_tenants_api.rb +1 -1
- data/lib/buildium-ruby/api/rental_units_api.rb +582 -1
- data/lib/buildium-ruby/api/resident_center_api.rb +242 -1
- data/lib/buildium-ruby/api/resident_requests_api.rb +344 -0
- data/lib/buildium-ruby/api/tasks_api.rb +345 -1624
- data/lib/buildium-ruby/api/to_do_requests_api.rb +341 -0
- data/lib/buildium-ruby/api/vendors_api.rb +3 -3
- data/lib/buildium-ruby/api/work_orders_api.rb +1 -1
- data/lib/buildium-ruby/api_client.rb +1 -1
- data/lib/buildium-ruby/api_error.rb +1 -1
- data/lib/buildium-ruby/configuration.rb +1 -1
- data/lib/buildium-ruby/models/account_info_message.rb +1 -1
- data/lib/buildium-ruby/models/accounting_entity_message.rb +14 -5
- data/lib/buildium-ruby/models/accounting_entity_save_message.rb +15 -5
- data/lib/buildium-ruby/models/accounting_lock_period_message.rb +1 -1
- data/lib/buildium-ruby/models/accounting_settings_message.rb +1 -1
- data/lib/buildium-ruby/models/address_message.rb +1 -1
- data/lib/buildium-ruby/models/all_tasks_message.rb +1 -1
- data/lib/buildium-ruby/models/announcement_message.rb +1 -1
- data/lib/buildium-ruby/models/announcement_post_message.rb +1 -1
- data/lib/buildium-ruby/models/announcement_search_message.rb +1 -1
- data/lib/buildium-ruby/models/announcement_sender_message.rb +1 -1
- data/lib/buildium-ruby/models/api_error_response.rb +1 -1
- data/lib/buildium-ruby/models/appliance_message.rb +1 -1
- data/lib/buildium-ruby/models/applicant_application_message.rb +1 -1
- data/lib/buildium-ruby/models/applicant_group_message.rb +1 -1
- data/lib/buildium-ruby/models/applicant_group_post_message.rb +1 -1
- data/lib/buildium-ruby/models/applicant_group_put_message.rb +1 -1
- data/lib/buildium-ruby/models/applicant_group_search_message.rb +1 -1
- data/lib/buildium-ruby/models/applicant_message.rb +46 -2
- data/lib/buildium-ruby/models/applicant_post_message.rb +1 -1
- data/lib/buildium-ruby/models/applicant_put_message.rb +1 -1
- data/lib/buildium-ruby/models/applicant_search_message.rb +1 -1
- data/lib/buildium-ruby/models/application_message.rb +1 -1
- data/lib/buildium-ruby/models/application_put_message.rb +1 -1
- data/lib/buildium-ruby/models/application_response_field_message.rb +3 -3
- data/lib/buildium-ruby/models/application_response_message.rb +3 -3
- data/lib/buildium-ruby/models/application_section_response_message.rb +1 -1
- data/lib/buildium-ruby/models/applied_vendor_credit_message.rb +228 -0
- data/lib/buildium-ruby/models/association_appliance_message.rb +1 -1
- data/lib/buildium-ruby/models/association_appliance_post_message.rb +1 -1
- data/lib/buildium-ruby/models/association_appliance_put_message.rb +1 -1
- data/lib/buildium-ruby/models/association_appliance_search_message.rb +1 -1
- data/lib/buildium-ruby/models/association_appliance_service_history_message.rb +1 -1
- data/lib/buildium-ruby/models/association_appliance_service_history_post_message.rb +1 -1
- data/lib/buildium-ruby/models/association_board_member_message.rb +1 -1
- data/lib/buildium-ruby/models/association_board_member_post_message.rb +1 -1
- data/lib/buildium-ruby/models/association_board_member_put_message.rb +1 -1
- data/lib/buildium-ruby/models/association_board_member_search_message.rb +1 -1
- data/lib/buildium-ruby/models/association_message.rb +14 -5
- data/lib/buildium-ruby/models/association_owner_board_term_message.rb +1 -1
- data/lib/buildium-ruby/models/association_owner_board_term_post_message.rb +1 -1
- data/lib/buildium-ruby/models/association_owner_message.rb +1 -1
- data/lib/buildium-ruby/models/association_owner_post_message.rb +1 -1
- data/lib/buildium-ruby/models/association_owner_put_message.rb +1 -1
- data/lib/buildium-ruby/models/association_owner_to_existing_ownership_account_post_message.rb +1 -1
- data/lib/buildium-ruby/models/association_owner_unit_occupancy_put_message.rb +1 -1
- data/lib/buildium-ruby/models/association_owner_unit_occupancy_status_message.rb +1 -1
- data/lib/buildium-ruby/models/association_ownership_account_message.rb +1 -1
- data/lib/buildium-ruby/models/association_ownership_account_post_message.rb +1 -1
- data/lib/buildium-ruby/models/association_ownership_account_put_message.rb +1 -1
- data/lib/buildium-ruby/models/association_ownership_account_search_message.rb +14 -2
- data/lib/buildium-ruby/models/association_post_message.rb +14 -5
- data/lib/buildium-ruby/models/association_preferred_vendor_message.rb +1 -1
- data/lib/buildium-ruby/models/association_preferred_vendor_put_message.rb +1 -1
- data/lib/buildium-ruby/models/association_put_message.rb +1 -1
- data/lib/buildium-ruby/models/association_search_message.rb +29 -5
- data/lib/buildium-ruby/models/association_tax_information_message.rb +292 -0
- data/lib/buildium-ruby/models/association_tenant_message.rb +1 -1
- data/lib/buildium-ruby/models/association_tenant_post_message.rb +1 -1
- data/lib/buildium-ruby/models/association_tenant_put_message.rb +1 -1
- data/lib/buildium-ruby/models/association_unit_message.rb +1 -1
- data/lib/buildium-ruby/models/association_unit_put_message.rb +1 -1
- data/lib/buildium-ruby/models/association_unit_search_message.rb +1 -1
- data/lib/buildium-ruby/models/association_units_post_message.rb +1 -1
- data/lib/buildium-ruby/models/association_user_search_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_check_accounting_entity_save_message.rb +15 -5
- data/lib/buildium-ruby/models/bank_account_check_file_message.rb +268 -0
- data/lib/buildium-ruby/models/bank_account_check_line_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_check_line_save_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_check_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_check_payee_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_check_payee_save_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_check_post_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_check_put_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_check_search_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_deposit_line_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_deposit_line_save_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_deposit_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_deposit_post_message.rb +2 -2
- data/lib/buildium-ruby/models/bank_account_deposit_put_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_deposit_search_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_message.rb +15 -5
- data/lib/buildium-ruby/models/bank_account_post_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_put_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_quick_deposit_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_quick_deposit_save_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_quick_deposit_search_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_search_message.rb +17 -5
- data/lib/buildium-ruby/models/bank_account_transaction_message.rb +3 -3
- data/lib/buildium-ruby/models/bank_account_transaction_search_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_transfer_accounting_entity_save_message.rb +15 -5
- data/lib/buildium-ruby/models/bank_account_transfer_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_transfer_save_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_transfer_search_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_withdrawal_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_withdrawal_save_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_account_withdrawal_search_message.rb +1 -1
- data/lib/buildium-ruby/models/bank_lockbox_data_association_message.rb +238 -0
- data/lib/buildium-ruby/models/bank_lockbox_data_association_owner_message.rb +314 -0
- data/lib/buildium-ruby/models/bank_lockbox_data_message.rb +229 -0
- data/lib/buildium-ruby/models/bank_lockbox_data_ownership_account_message.rb +293 -0
- data/lib/buildium-ruby/models/bank_lockbox_data_search_message.rb +220 -0
- data/lib/buildium-ruby/models/bill_file_message.rb +1 -1
- data/lib/buildium-ruby/models/bill_line_message.rb +1 -1
- data/lib/buildium-ruby/models/bill_line_post_message.rb +1 -1
- data/lib/buildium-ruby/models/bill_line_put_message.rb +1 -1
- data/lib/buildium-ruby/models/bill_markup_message.rb +1 -1
- data/lib/buildium-ruby/models/bill_markup_save_message.rb +1 -1
- data/lib/buildium-ruby/models/bill_message.rb +1 -1
- data/lib/buildium-ruby/models/bill_payment_accounting_entity_message.rb +15 -5
- data/lib/buildium-ruby/models/bill_payment_line_message.rb +1 -1
- data/lib/buildium-ruby/models/bill_payment_line_post_message.rb +1 -1
- data/lib/buildium-ruby/models/bill_payment_message.rb +26 -2
- data/lib/buildium-ruby/models/bill_payment_post_message.rb +1 -1
- data/lib/buildium-ruby/models/bill_post_message.rb +1 -1
- data/lib/buildium-ruby/models/bill_put_message.rb +1 -1
- data/lib/buildium-ruby/models/bill_search_message.rb +1 -1
- data/lib/buildium-ruby/models/budget_details_message.rb +1 -1
- data/lib/buildium-ruby/models/budget_details_save_message.rb +1 -1
- data/lib/buildium-ruby/models/budget_message.rb +1 -1
- data/lib/buildium-ruby/models/budget_monthly_amounts_message.rb +1 -1
- data/lib/buildium-ruby/models/budget_monthly_amounts_save_message.rb +1 -1
- data/lib/buildium-ruby/models/budget_post_message.rb +1 -1
- data/lib/buildium-ruby/models/budget_put_message.rb +1 -1
- data/lib/buildium-ruby/models/budget_search_message.rb +1 -1
- data/lib/buildium-ruby/models/cancellation_token.rb +235 -0
- data/lib/buildium-ruby/models/cc_payments_message.rb +219 -0
- data/lib/buildium-ruby/models/cc_payments_put_message.rb +224 -0
- data/lib/buildium-ruby/models/charge_recurring_transaction_post_message.rb +1 -1
- data/lib/buildium-ruby/models/charge_recurring_transaction_put_message.rb +1 -1
- data/lib/buildium-ruby/models/check_printing_info_message.rb +1 -1
- data/lib/buildium-ruby/models/check_printing_info_post_message.rb +1 -1
- data/lib/buildium-ruby/models/check_printing_info_put_message.rb +1 -1
- data/lib/buildium-ruby/models/client_lead_credit_request_message.rb +1 -1
- data/lib/buildium-ruby/models/client_lead_message.rb +1 -1
- data/lib/buildium-ruby/models/client_lead_search_message.rb +1 -1
- data/lib/buildium-ruby/models/contact_detail_message.rb +1 -1
- data/lib/buildium-ruby/models/contact_detail_phone_message.rb +1 -1
- data/lib/buildium-ruby/models/contact_detail_save_message.rb +1 -1
- data/lib/buildium-ruby/models/contact_detail_save_phone_message.rb +1 -1
- data/lib/buildium-ruby/models/contact_info_message.rb +1 -1
- data/lib/buildium-ruby/models/contact_request_task_message.rb +1 -1
- data/lib/buildium-ruby/models/contact_request_task_post_message.rb +1 -1
- data/lib/buildium-ruby/models/contact_request_task_put_message.rb +1 -1
- data/lib/buildium-ruby/models/contact_request_task_search_message.rb +1 -1
- data/lib/buildium-ruby/models/cosigner_message.rb +1 -1
- data/lib/buildium-ruby/models/created_by_user_message.rb +1 -1
- data/lib/buildium-ruby/models/credit_recurring_transaction_post_message.rb +1 -1
- data/lib/buildium-ruby/models/deposit_detail_message.rb +1 -1
- data/lib/buildium-ruby/models/e_pay_settings_message.rb +235 -0
- data/lib/buildium-ruby/models/e_pay_settings_put_message.rb +250 -0
- data/lib/buildium-ruby/models/eft_payments_message.rb +219 -0
- data/lib/buildium-ruby/models/eft_payments_put_message.rb +224 -0
- data/lib/buildium-ruby/models/electronic_payments_message.rb +1 -1
- data/lib/buildium-ruby/models/email_message.rb +1 -1
- data/lib/buildium-ruby/models/email_post_message.rb +1 -1
- data/lib/buildium-ruby/models/email_recipient_message.rb +1 -1
- data/lib/buildium-ruby/models/email_search_message.rb +1 -1
- data/lib/buildium-ruby/models/email_sender_message.rb +1 -1
- data/lib/buildium-ruby/models/emergency_contact_message.rb +1 -1
- data/lib/buildium-ruby/models/file_category_message.rb +1 -1
- data/lib/buildium-ruby/models/file_category_post_message.rb +1 -1
- data/lib/buildium-ruby/models/file_category_put_message.rb +1 -1
- data/lib/buildium-ruby/models/file_download_message.rb +1 -1
- data/lib/buildium-ruby/models/file_entity_message.rb +1 -1
- data/lib/buildium-ruby/models/file_message.rb +1 -1
- data/lib/buildium-ruby/models/file_name_post_message.rb +1 -1
- data/lib/buildium-ruby/models/file_put_message.rb +1 -1
- data/lib/buildium-ruby/models/file_search_message.rb +1 -1
- data/lib/buildium-ruby/models/file_sharing_account_message.rb +263 -0
- data/lib/buildium-ruby/models/file_sharing_account_put_message.rb +263 -0
- data/lib/buildium-ruby/models/file_sharing_association_message.rb +229 -0
- data/lib/buildium-ruby/models/file_sharing_association_owner_message.rb +219 -0
- data/lib/buildium-ruby/models/file_sharing_association_owner_put_message.rb +219 -0
- data/lib/buildium-ruby/models/file_sharing_association_put_message.rb +229 -0
- data/lib/buildium-ruby/models/file_sharing_association_unit_message.rb +229 -0
- data/lib/buildium-ruby/models/file_sharing_association_unit_put_message.rb +229 -0
- data/lib/buildium-ruby/models/file_sharing_committee_message.rb +239 -0
- data/lib/buildium-ruby/models/file_sharing_committee_put_message.rb +239 -0
- data/lib/buildium-ruby/models/file_sharing_lease_message.rb +229 -0
- data/lib/buildium-ruby/models/file_sharing_lease_put_message.rb +229 -0
- data/lib/buildium-ruby/models/file_sharing_message.rb +316 -0
- data/lib/buildium-ruby/models/file_sharing_ownership_account_message.rb +229 -0
- data/lib/buildium-ruby/models/file_sharing_ownership_account_put_message.rb +229 -0
- data/lib/buildium-ruby/models/file_sharing_put_message.rb +316 -0
- data/lib/buildium-ruby/models/file_sharing_rental_message.rb +229 -0
- data/lib/buildium-ruby/models/file_sharing_rental_owner_message.rb +219 -0
- data/lib/buildium-ruby/models/file_sharing_rental_owner_put_message.rb +219 -0
- data/lib/buildium-ruby/models/file_sharing_rental_put_message.rb +229 -0
- data/lib/buildium-ruby/models/file_sharing_rental_unit_mesage.rb +229 -0
- data/lib/buildium-ruby/models/file_sharing_rental_unit_put_mesage.rb +229 -0
- data/lib/buildium-ruby/models/file_sharing_tenant_message.rb +229 -0
- data/lib/buildium-ruby/models/file_sharing_tenant_put_message.rb +229 -0
- data/lib/buildium-ruby/models/file_sharing_vendor_message.rb +219 -0
- data/lib/buildium-ruby/models/file_sharing_vendor_put_message.rb +219 -0
- data/lib/buildium-ruby/models/file_upload_post_message.rb +1 -1
- data/lib/buildium-ruby/models/file_upload_ticket_message.rb +1 -1
- data/lib/buildium-ruby/models/general_journal_entry_line_save_message.rb +2 -2
- data/lib/buildium-ruby/models/general_journal_entry_post_message.rb +1 -1
- data/lib/buildium-ruby/models/general_journal_entry_put_message.rb +1 -1
- data/lib/buildium-ruby/models/general_ledger_entry_message.rb +311 -0
- data/lib/buildium-ruby/models/general_ledger_journal_line_message.rb +1 -1
- data/lib/buildium-ruby/models/general_ledger_journal_message.rb +1 -1
- data/lib/buildium-ruby/models/general_ledger_message.rb +260 -0
- data/lib/buildium-ruby/models/general_ledger_search_message.rb +336 -0
- data/lib/buildium-ruby/models/general_ledger_transaction_message.rb +1 -1
- data/lib/buildium-ruby/models/general_ledger_transaction_search_message.rb +1 -1
- data/lib/buildium-ruby/models/gl_account_balance_item_message.rb +1 -1
- data/lib/buildium-ruby/models/gl_account_balance_message.rb +1 -1
- data/lib/buildium-ruby/models/gl_account_balance_search_message.rb +1 -1
- data/lib/buildium-ruby/models/gl_account_message.rb +1 -1
- data/lib/buildium-ruby/models/gl_account_post_message.rb +1 -1
- data/lib/buildium-ruby/models/gl_account_put_message.rb +1 -1
- data/lib/buildium-ruby/models/gl_accounts_search_message.rb +1 -1
- data/lib/buildium-ruby/models/gl_transaction_message_v1.rb +1 -1
- data/lib/buildium-ruby/models/image_reorder_request_put_message.rb +225 -0
- data/lib/buildium-ruby/models/insured_tenant_message.rb +248 -0
- data/lib/buildium-ruby/models/internal_transaction_status_message.rb +1 -1
- data/lib/buildium-ruby/models/journal_line_message.rb +15 -5
- data/lib/buildium-ruby/models/journal_message.rb +1 -1
- data/lib/buildium-ruby/models/json_patch_operation.rb +254 -0
- data/lib/buildium-ruby/models/last_updated_by_user_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_account_detail_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_auto_allocated_payment_post_message.rb +332 -0
- data/lib/buildium-ruby/models/lease_charge_line_save_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_charge_post_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_charge_put_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_charge_recurring_transaction_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_cosigner_post_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_ledger_credit_line_post_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_ledger_credit_post_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_ledger_deposit_withholding_line_post_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_ledger_deposit_withholding_post_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_ledger_payment_line_save_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_ledger_payment_post_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_ledger_payment_put_message.rb +319 -0
- data/lib/buildium-ruby/models/lease_ledger_refund_line_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_ledger_refund_line_post_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_ledger_refund_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_ledger_refund_post_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_ledger_reverse_payment_nsf_charge_post_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_ledger_reverse_payment_other_bank_charge_post_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_ledger_reverse_payment_post_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_move_out_data_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_move_out_data_post_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_outstanding_balance_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_outstanding_balance_search_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_post_message.rb +27 -8
- data/lib/buildium-ruby/models/lease_put_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_recurring_credit_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_recurring_payment_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_renewal_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_renewal_post_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_renewal_search_message.rb +272 -0
- data/lib/buildium-ruby/models/lease_rent_charge_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_rent_charge_post_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_rent_message.rb +2 -2
- data/lib/buildium-ruby/models/lease_rent_post_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_search_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_security_deposit_post_message.rb +1 -1
- data/lib/buildium-ruby/models/lease_tenant_message.rb +15 -5
- data/lib/buildium-ruby/models/lease_transaction_message.rb +47 -3
- data/lib/buildium-ruby/models/lease_transaction_search_message.rb +1 -1
- data/lib/buildium-ruby/models/listing_contact_message.rb +1 -1
- data/lib/buildium-ruby/models/listing_contact_save_message.rb +1 -1
- data/lib/buildium-ruby/models/listing_entity_file_post_message.rb +248 -0
- data/lib/buildium-ruby/models/listing_file_message.rb +1 -1
- data/lib/buildium-ruby/models/listing_message.rb +1 -1
- data/lib/buildium-ruby/models/listing_property_message.rb +1 -1
- data/lib/buildium-ruby/models/listing_put_message.rb +1 -1
- data/lib/buildium-ruby/models/listing_search_message.rb +1 -1
- data/lib/buildium-ruby/models/listing_unit_message.rb +1 -1
- data/lib/buildium-ruby/models/lock_period_settings_global_message.rb +1 -1
- data/lib/buildium-ruby/models/lock_period_settings_overrides_message.rb +1 -1
- data/lib/buildium-ruby/models/logged_by_staff_user_message.rb +1 -1
- data/lib/buildium-ruby/models/lookup_message.rb +1 -1
- data/lib/buildium-ruby/models/mailing_template_message.rb +1 -1
- data/lib/buildium-ruby/models/meter_reading_detail_message.rb +268 -0
- data/lib/buildium-ruby/models/meter_reading_detail_put_message.rb +263 -0
- data/lib/buildium-ruby/models/meter_reading_details_delete_search_message.rb +272 -0
- data/lib/buildium-ruby/models/meter_reading_details_message.rb +274 -0
- data/lib/buildium-ruby/models/meter_reading_details_put_message.rb +289 -0
- data/lib/buildium-ruby/models/meter_reading_details_put_search_message.rb +262 -0
- data/lib/buildium-ruby/models/meter_reading_details_search_message.rb +272 -0
- data/lib/buildium-ruby/models/meter_reading_message.rb +292 -0
- data/lib/buildium-ruby/models/meter_reading_search_message.rb +272 -0
- data/lib/buildium-ruby/models/multiple_bill_payments_post_message.rb +277 -0
- data/lib/buildium-ruby/models/note_message.rb +1 -1
- data/lib/buildium-ruby/models/note_post_message.rb +1 -1
- data/lib/buildium-ruby/models/note_put_message.rb +1 -1
- data/lib/buildium-ruby/models/note_search_message.rb +1 -1
- data/lib/buildium-ruby/models/offline_payments_message.rb +239 -0
- data/lib/buildium-ruby/models/offline_payments_put_message.rb +249 -0
- data/lib/buildium-ruby/models/outstanding_balances_line_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_auto_allocated_payment_post_message.rb +332 -0
- data/lib/buildium-ruby/models/ownership_account_charge_recurring_transaction_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_credit_line_post_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_credit_post_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_deposit_withholding_line_post_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_deposit_withholding_post_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_ledger_charge_lines_put_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_ledger_charge_lines_save_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_ledger_charge_post_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_ledger_charge_put_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_ledger_payment_line_save_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_ledger_payment_post_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_ledger_payment_put_message.rb +320 -0
- data/lib/buildium-ruby/models/ownership_account_outstanding_balance_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_outstanding_balance_search_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_recurring_credit_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_recurring_payment_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_refund_line_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_refund_lines_post_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_refund_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_refund_post_message.rb +1 -1
- data/lib/buildium-ruby/models/ownership_account_transaction_message.rb +46 -2
- data/lib/buildium-ruby/models/paid_by_message.rb +1 -1
- data/lib/buildium-ruby/models/participant_message.rb +1 -1
- data/lib/buildium-ruby/models/participant_resource_message.rb +1 -1
- data/lib/buildium-ruby/models/payee_message.rb +1 -1
- data/lib/buildium-ruby/models/payment_detail_message.rb +1 -1
- data/lib/buildium-ruby/models/payment_recurring_transaction_post_message.rb +1 -1
- data/lib/buildium-ruby/models/payment_transactions_message.rb +1 -1
- data/lib/buildium-ruby/models/phone_log_message.rb +1 -1
- data/lib/buildium-ruby/models/phone_log_participant_post_message.rb +1 -1
- data/lib/buildium-ruby/models/phone_log_participant_unit_agreement_post_message.rb +1 -1
- data/lib/buildium-ruby/models/phone_log_post_message.rb +1 -1
- data/lib/buildium-ruby/models/phone_log_put_message.rb +1 -1
- data/lib/buildium-ruby/models/phone_log_search_message.rb +1 -1
- data/lib/buildium-ruby/models/phone_number_message.rb +1 -1
- data/lib/buildium-ruby/models/phone_numbers_message.rb +1 -1
- data/lib/buildium-ruby/models/property_group_message.rb +1 -1
- data/lib/buildium-ruby/models/property_group_post_message.rb +1 -1
- data/lib/buildium-ruby/models/property_group_put_message.rb +1 -1
- data/lib/buildium-ruby/models/property_group_search_message.rb +1 -1
- data/lib/buildium-ruby/models/property_manager_message.rb +1 -1
- data/lib/buildium-ruby/models/property_message.rb +1 -1
- data/lib/buildium-ruby/models/recurring_transaction_line_message.rb +1 -1
- data/lib/buildium-ruby/models/recurring_transaction_line_post_message.rb +1 -1
- data/lib/buildium-ruby/models/recurring_transaction_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_appliance_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_appliance_post_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_appliance_put_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_appliance_search_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_appliance_service_history_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_appliance_service_history_post_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_features_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_features_put_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_image_message.rb +292 -0
- data/lib/buildium-ruby/models/rental_image_put_message.rb +233 -0
- data/lib/buildium-ruby/models/rental_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_owner_contribution_data_message.rb +229 -0
- data/lib/buildium-ruby/models/rental_owner_contribution_data_put_message.rb +229 -0
- data/lib/buildium-ruby/models/rental_owner_contribution_message.rb +229 -0
- data/lib/buildium-ruby/models/rental_owner_contribution_put_message.rb +229 -0
- data/lib/buildium-ruby/models/rental_owner_contribution_reminder_message.rb +229 -0
- data/lib/buildium-ruby/models/rental_owner_contribution_reminder_put_message.rb +229 -0
- data/lib/buildium-ruby/models/rental_owner_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_owner_post_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_owner_put_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_owner_request_task_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_owner_request_task_post_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_owner_request_task_put_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_owner_request_task_search_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_owner_tax_information_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_owners_search_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_preferred_vendor_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_preferred_vendor_put_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_property_post_message.rb +2 -2
- data/lib/buildium-ruby/models/rental_property_put_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_property_unit_post_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_search_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_tenant_post_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_tenant_put_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_tenant_renewal_post_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_unit_features_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_unit_features_put_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_unit_image_message.rb +292 -0
- data/lib/buildium-ruby/models/rental_unit_image_put_message.rb +233 -0
- data/lib/buildium-ruby/models/rental_unit_message.rb +3 -3
- data/lib/buildium-ruby/models/rental_unit_put_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_unit_search_message.rb +1 -1
- data/lib/buildium-ruby/models/rental_units_post_message.rb +1 -1
- data/lib/buildium-ruby/models/renters_insurance_policy_message.rb +324 -0
- data/lib/buildium-ruby/models/requested_by_user_entity_message.rb +1 -1
- data/lib/buildium-ruby/models/resident_center_user_message.rb +1 -1
- data/lib/buildium-ruby/models/resident_center_user_reference_message.rb +1 -1
- data/lib/buildium-ruby/models/resident_center_user_search_message.rb +1 -1
- data/lib/buildium-ruby/models/resident_request_task_message.rb +1 -1
- data/lib/buildium-ruby/models/resident_request_task_post_message.rb +25 -5
- data/lib/buildium-ruby/models/resident_request_task_put_message.rb +1 -1
- data/lib/buildium-ruby/models/resident_request_task_search_message.rb +1 -1
- data/lib/buildium-ruby/models/retail_cash_property_message.rb +282 -0
- data/lib/buildium-ruby/models/retail_cash_unit_message.rb +238 -0
- data/lib/buildium-ruby/models/retail_cash_user_data_message.rb +312 -0
- data/lib/buildium-ruby/models/retail_cash_user_message.rb +274 -0
- data/lib/buildium-ruby/models/retail_cash_user_put_message.rb +223 -0
- data/lib/buildium-ruby/models/retail_cash_users_search_message.rb +304 -0
- data/lib/buildium-ruby/models/safe_wait_handle.rb +226 -0
- data/lib/buildium-ruby/models/save_address_message.rb +1 -1
- data/lib/buildium-ruby/models/save_emergency_contact_message.rb +1 -1
- data/lib/buildium-ruby/models/task_category_message.rb +1 -1
- data/lib/buildium-ruby/models/task_category_put_message.rb +1 -1
- data/lib/buildium-ruby/models/task_category_response_message.rb +1 -1
- data/lib/buildium-ruby/models/task_category_save_message.rb +1 -1
- data/lib/buildium-ruby/models/task_history_file_message.rb +1 -1
- data/lib/buildium-ruby/models/task_history_file_upload_post_message.rb +1 -1
- data/lib/buildium-ruby/models/task_history_message.rb +1 -1
- data/lib/buildium-ruby/models/task_history_put_message.rb +1 -1
- data/lib/buildium-ruby/models/task_history_user_message.rb +1 -1
- data/lib/buildium-ruby/models/task_search_message.rb +1 -1
- data/lib/buildium-ruby/models/task_sub_category_message.rb +1 -1
- data/lib/buildium-ruby/models/tax_information_post_message.rb +1 -1
- data/lib/buildium-ruby/models/tax_information_save_message.rb +1 -1
- data/lib/buildium-ruby/models/tenant_message.rb +1 -1
- data/lib/buildium-ruby/models/tenant_search_message.rb +1 -1
- data/lib/buildium-ruby/models/to_do_task_message.rb +1 -1
- data/lib/buildium-ruby/models/to_do_task_post_message.rb +1 -1
- data/lib/buildium-ruby/models/to_do_task_put_message.rb +1 -1
- data/lib/buildium-ruby/models/to_do_task_search_message.rb +1 -1
- data/lib/buildium-ruby/models/undeposited_funds_message.rb +1 -1
- data/lib/buildium-ruby/models/unit_agreement_message.rb +1 -1
- data/lib/buildium-ruby/models/unit_entity_message.rb +229 -0
- data/lib/buildium-ruby/models/user_message.rb +1 -1
- data/lib/buildium-ruby/models/user_role_message.rb +1 -1
- data/lib/buildium-ruby/models/user_search_message.rb +1 -1
- data/lib/buildium-ruby/models/vehicle_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_category_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_category_save_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_credit_line_item_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_credit_line_item_post_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_credit_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_credit_post_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_insurance_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_insurance_save_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_post_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_put_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_refund_line_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_refund_line_post_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_refund_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_refund_post_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_search_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_tax_information_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_transaction_message.rb +1 -1
- data/lib/buildium-ruby/models/vendor_transaction_search_message.rb +1 -1
- data/lib/buildium-ruby/models/video_link_request_post_message.rb +238 -0
- data/lib/buildium-ruby/models/wait_handle.rb +226 -0
- data/lib/buildium-ruby/models/work_order_entry_contact_message.rb +1 -1
- data/lib/buildium-ruby/models/work_order_entry_contact_resource_message.rb +1 -1
- data/lib/buildium-ruby/models/work_order_line_item_message.rb +1 -1
- data/lib/buildium-ruby/models/work_order_line_item_save_message.rb +1 -1
- data/lib/buildium-ruby/models/work_order_message.rb +1 -1
- data/lib/buildium-ruby/models/work_order_post_message.rb +1 -1
- data/lib/buildium-ruby/models/work_order_put_message.rb +1 -1
- data/lib/buildium-ruby/models/work_order_search_message.rb +1 -1
- data/lib/buildium-ruby/models/work_order_task_message.rb +1 -1
- data/lib/buildium-ruby/models/work_order_task_post_message.rb +1 -1
- data/lib/buildium-ruby/version.rb +2 -2
- data/lib/buildium-ruby.rb +101 -4
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +206 -826
- data/docs/AccountingApi.md +0 -2041
- data/lib/buildium-ruby/api/accounting_api.rb +0 -1855
- data/spec/api/accounting_api_spec.rb +0 -383
- data/spec/api/administration_api_spec.rb +0 -114
- data/spec/api/applicants_api_spec.rb +0 -294
- data/spec/api/association_appliances_api_spec.rb +0 -141
- data/spec/api/association_owners_api_spec.rb +0 -195
- data/spec/api/association_ownership_accounts_api_spec.rb +0 -385
- data/spec/api/association_tenants_api_spec.rb +0 -153
- data/spec/api/association_units_api_spec.rb +0 -147
- data/spec/api/associations_api_spec.rb +0 -248
- data/spec/api/bank_accounts_api_spec.rb +0 -420
- data/spec/api/client_leads_api_spec.rb +0 -66
- data/spec/api/communications_api_spec.rb +0 -248
- data/spec/api/files_api_spec.rb +0 -156
- data/spec/api/leases_api_spec.rb +0 -529
- data/spec/api/listings_api_spec.rb +0 -139
- data/spec/api/property_groups_api_spec.rb +0 -88
- data/spec/api/rental_appliances_api_spec.rb +0 -141
- data/spec/api/rental_owners_api_spec.rb +0 -151
- data/spec/api/rental_properties_api_spec.rb +0 -205
- data/spec/api/rental_tenants_api_spec.rb +0 -154
- data/spec/api/rental_units_api_spec.rb +0 -172
- data/spec/api/resident_center_api_spec.rb +0 -54
- data/spec/api/tasks_api_spec.rb +0 -493
- data/spec/api/vendors_api_spec.rb +0 -275
- data/spec/api/work_orders_api_spec.rb +0 -105
- data/spec/models/account_info_message_spec.rb +0 -58
- data/spec/models/accounting_entity_message_spec.rb +0 -50
- data/spec/models/accounting_entity_save_message_spec.rb +0 -44
- data/spec/models/accounting_lock_period_message_spec.rb +0 -46
- data/spec/models/accounting_settings_message_spec.rb +0 -72
- data/spec/models/address_message_spec.rb +0 -74
- data/spec/models/all_tasks_message_spec.rb +0 -130
- data/spec/models/announcement_message_spec.rb +0 -74
- data/spec/models/announcement_post_message_spec.rb +0 -64
- data/spec/models/announcement_search_message_spec.rb +0 -62
- data/spec/models/announcement_sender_message_spec.rb +0 -46
- data/spec/models/api_error_response_spec.rb +0 -46
- data/spec/models/appliance_message_spec.rb +0 -58
- data/spec/models/applicant_application_message_spec.rb +0 -56
- data/spec/models/applicant_group_message_spec.rb +0 -62
- data/spec/models/applicant_group_post_message_spec.rb +0 -40
- data/spec/models/applicant_group_put_message_spec.rb +0 -50
- data/spec/models/applicant_group_search_message_spec.rb +0 -66
- data/spec/models/applicant_message_spec.rb +0 -88
- data/spec/models/applicant_post_message_spec.rb +0 -64
- data/spec/models/applicant_put_message_spec.rb +0 -58
- data/spec/models/applicant_search_message_spec.rb +0 -84
- data/spec/models/application_message_spec.rb +0 -62
- data/spec/models/application_put_message_spec.rb +0 -38
- data/spec/models/application_response_field_message_spec.rb +0 -60
- data/spec/models/application_response_message_spec.rb +0 -50
- data/spec/models/application_section_response_message_spec.rb +0 -34
- data/spec/models/association_appliance_message_spec.rb +0 -76
- data/spec/models/association_appliance_post_message_spec.rb +0 -76
- data/spec/models/association_appliance_put_message_spec.rb +0 -64
- data/spec/models/association_appliance_search_message_spec.rb +0 -40
- data/spec/models/association_appliance_service_history_message_spec.rb +0 -56
- data/spec/models/association_appliance_service_history_post_message_spec.rb +0 -50
- data/spec/models/association_board_member_message_spec.rb +0 -92
- data/spec/models/association_board_member_post_message_spec.rb +0 -56
- data/spec/models/association_board_member_put_message_spec.rb +0 -50
- data/spec/models/association_board_member_search_message_spec.rb +0 -60
- data/spec/models/association_message_spec.rb +0 -100
- data/spec/models/association_owner_board_term_message_spec.rb +0 -68
- data/spec/models/association_owner_board_term_post_message_spec.rb +0 -50
- data/spec/models/association_owner_message_spec.rb +0 -144
- data/spec/models/association_owner_post_message_spec.rb +0 -116
- data/spec/models/association_owner_put_message_spec.rb +0 -98
- data/spec/models/association_owner_to_existing_ownership_account_post_message_spec.rb +0 -128
- data/spec/models/association_owner_unit_occupancy_put_message_spec.rb +0 -34
- data/spec/models/association_owner_unit_occupancy_status_message_spec.rb +0 -40
- data/spec/models/association_ownership_account_message_spec.rb +0 -90
- data/spec/models/association_ownership_account_post_message_spec.rb +0 -80
- data/spec/models/association_ownership_account_put_message_spec.rb +0 -34
- data/spec/models/association_ownership_account_search_message_spec.rb +0 -72
- data/spec/models/association_post_message_spec.rb +0 -76
- data/spec/models/association_preferred_vendor_message_spec.rb +0 -82
- data/spec/models/association_preferred_vendor_put_message_spec.rb +0 -34
- data/spec/models/association_put_message_spec.rb +0 -82
- data/spec/models/association_search_message_spec.rb +0 -56
- data/spec/models/association_tenant_message_spec.rb +0 -112
- data/spec/models/association_tenant_post_message_spec.rb +0 -106
- data/spec/models/association_tenant_put_message_spec.rb +0 -94
- data/spec/models/association_unit_message_spec.rb +0 -84
- data/spec/models/association_unit_put_message_spec.rb +0 -66
- data/spec/models/association_unit_search_message_spec.rb +0 -46
- data/spec/models/association_units_post_message_spec.rb +0 -72
- data/spec/models/association_user_search_message_spec.rb +0 -86
- data/spec/models/bank_account_check_accounting_entity_save_message_spec.rb +0 -44
- data/spec/models/bank_account_check_line_message_spec.rb +0 -64
- data/spec/models/bank_account_check_line_save_message_spec.rb +0 -58
- data/spec/models/bank_account_check_message_spec.rb +0 -70
- data/spec/models/bank_account_check_payee_message_spec.rb +0 -50
- data/spec/models/bank_account_check_payee_save_message_spec.rb +0 -44
- data/spec/models/bank_account_check_post_message_spec.rb +0 -58
- data/spec/models/bank_account_check_put_message_spec.rb +0 -58
- data/spec/models/bank_account_check_search_message_spec.rb +0 -40
- data/spec/models/bank_account_deposit_line_message_spec.rb +0 -64
- data/spec/models/bank_account_deposit_line_save_message_spec.rb +0 -58
- data/spec/models/bank_account_deposit_message_spec.rb +0 -64
- data/spec/models/bank_account_deposit_post_message_spec.rb +0 -52
- data/spec/models/bank_account_deposit_put_message_spec.rb +0 -46
- data/spec/models/bank_account_deposit_search_message_spec.rb +0 -40
- data/spec/models/bank_account_message_spec.rb +0 -104
- data/spec/models/bank_account_post_message_spec.rb +0 -78
- data/spec/models/bank_account_put_message_spec.rb +0 -78
- data/spec/models/bank_account_quick_deposit_message_spec.rb +0 -64
- data/spec/models/bank_account_quick_deposit_save_message_spec.rb +0 -58
- data/spec/models/bank_account_quick_deposit_search_message_spec.rb +0 -40
- data/spec/models/bank_account_search_message_spec.rb +0 -44
- data/spec/models/bank_account_transaction_message_spec.rb +0 -96
- data/spec/models/bank_account_transaction_search_message_spec.rb +0 -56
- data/spec/models/bank_account_transfer_accounting_entity_save_message_spec.rb +0 -44
- data/spec/models/bank_account_transfer_message_spec.rb +0 -64
- data/spec/models/bank_account_transfer_save_message_spec.rb +0 -58
- data/spec/models/bank_account_transfer_search_message_spec.rb +0 -40
- data/spec/models/bank_account_withdrawal_message_spec.rb +0 -64
- data/spec/models/bank_account_withdrawal_save_message_spec.rb +0 -58
- data/spec/models/bank_account_withdrawal_search_message_spec.rb +0 -40
- data/spec/models/bill_file_message_spec.rb +0 -64
- data/spec/models/bill_line_message_spec.rb +0 -64
- data/spec/models/bill_line_post_message_spec.rb +0 -58
- data/spec/models/bill_line_put_message_spec.rb +0 -64
- data/spec/models/bill_markup_message_spec.rb +0 -44
- data/spec/models/bill_markup_save_message_spec.rb +0 -44
- data/spec/models/bill_message_spec.rb +0 -92
- data/spec/models/bill_payment_accounting_entity_message_spec.rb +0 -44
- data/spec/models/bill_payment_line_message_spec.rb +0 -46
- data/spec/models/bill_payment_line_post_message_spec.rb +0 -40
- data/spec/models/bill_payment_message_spec.rb +0 -64
- data/spec/models/bill_payment_post_message_spec.rb +0 -58
- data/spec/models/bill_post_message_spec.rb +0 -70
- data/spec/models/bill_put_message_spec.rb +0 -64
- data/spec/models/bill_search_message_spec.rb +0 -88
- data/spec/models/budget_details_message_spec.rb +0 -56
- data/spec/models/budget_details_save_message_spec.rb +0 -40
- data/spec/models/budget_message_spec.rb +0 -64
- data/spec/models/budget_monthly_amounts_message_spec.rb +0 -100
- data/spec/models/budget_monthly_amounts_save_message_spec.rb +0 -100
- data/spec/models/budget_post_message_spec.rb +0 -62
- data/spec/models/budget_put_message_spec.rb +0 -40
- data/spec/models/budget_search_message_spec.rb +0 -46
- data/spec/models/charge_recurring_transaction_post_message_spec.rb +0 -84
- data/spec/models/charge_recurring_transaction_put_message_spec.rb +0 -90
- data/spec/models/check_printing_info_message_spec.rb +0 -122
- data/spec/models/check_printing_info_post_message_spec.rb +0 -122
- data/spec/models/check_printing_info_put_message_spec.rb +0 -122
- data/spec/models/client_lead_credit_request_message_spec.rb +0 -60
- data/spec/models/client_lead_message_spec.rb +0 -102
- data/spec/models/client_lead_search_message_spec.rb +0 -66
- data/spec/models/contact_detail_message_spec.rb +0 -52
- data/spec/models/contact_detail_phone_message_spec.rb +0 -46
- data/spec/models/contact_detail_save_message_spec.rb +0 -52
- data/spec/models/contact_detail_save_phone_message_spec.rb +0 -46
- data/spec/models/contact_info_message_spec.rb +0 -52
- data/spec/models/contact_request_task_message_spec.rb +0 -114
- data/spec/models/contact_request_task_post_message_spec.rb +0 -102
- data/spec/models/contact_request_task_put_message_spec.rb +0 -102
- data/spec/models/contact_request_task_search_message_spec.rb +0 -112
- data/spec/models/cosigner_message_spec.rb +0 -92
- data/spec/models/created_by_user_message_spec.rb +0 -52
- data/spec/models/credit_recurring_transaction_post_message_spec.rb +0 -100
- data/spec/models/deposit_detail_message_spec.rb +0 -40
- data/spec/models/electronic_payments_message_spec.rb +0 -76
- data/spec/models/email_message_spec.rb +0 -52
- data/spec/models/email_post_message_spec.rb +0 -70
- data/spec/models/email_recipient_message_spec.rb +0 -62
- data/spec/models/email_search_message_spec.rb +0 -58
- data/spec/models/email_sender_message_spec.rb +0 -52
- data/spec/models/emergency_contact_message_spec.rb +0 -52
- data/spec/models/file_category_message_spec.rb +0 -46
- data/spec/models/file_category_post_message_spec.rb +0 -34
- data/spec/models/file_category_put_message_spec.rb +0 -34
- data/spec/models/file_download_message_spec.rb +0 -34
- data/spec/models/file_entity_message_spec.rb +0 -50
- data/spec/models/file_message_spec.rb +0 -82
- data/spec/models/file_name_post_message_spec.rb +0 -34
- data/spec/models/file_put_message_spec.rb +0 -46
- data/spec/models/file_search_message_spec.rb +0 -74
- data/spec/models/file_upload_post_message_spec.rb +0 -68
- data/spec/models/file_upload_ticket_message_spec.rb +0 -46
- data/spec/models/general_journal_entry_line_save_message_spec.rb +0 -56
- data/spec/models/general_journal_entry_post_message_spec.rb +0 -52
- data/spec/models/general_journal_entry_put_message_spec.rb +0 -52
- data/spec/models/general_ledger_journal_line_message_spec.rb +0 -64
- data/spec/models/general_ledger_journal_message_spec.rb +0 -40
- data/spec/models/general_ledger_transaction_message_spec.rb +0 -98
- data/spec/models/general_ledger_transaction_search_message_spec.rb +0 -62
- data/spec/models/gl_account_balance_item_message_spec.rb +0 -40
- data/spec/models/gl_account_balance_message_spec.rb +0 -46
- data/spec/models/gl_account_balance_search_message_spec.rb +0 -66
- data/spec/models/gl_account_message_spec.rb +0 -130
- data/spec/models/gl_account_post_message_spec.rb +0 -84
- data/spec/models/gl_account_put_message_spec.rb +0 -84
- data/spec/models/gl_accounts_search_message_spec.rb +0 -38
- data/spec/models/gl_transaction_message_v1_spec.rb +0 -58
- data/spec/models/internal_transaction_status_message_spec.rb +0 -46
- data/spec/models/journal_line_message_spec.rb +0 -64
- data/spec/models/journal_message_spec.rb +0 -40
- data/spec/models/last_updated_by_user_message_spec.rb +0 -58
- data/spec/models/lease_account_detail_message_spec.rb +0 -40
- data/spec/models/lease_charge_line_save_message_spec.rb +0 -46
- data/spec/models/lease_charge_post_message_spec.rb +0 -46
- data/spec/models/lease_charge_put_message_spec.rb +0 -46
- data/spec/models/lease_charge_recurring_transaction_message_spec.rb +0 -108
- data/spec/models/lease_cosigner_post_message_spec.rb +0 -80
- data/spec/models/lease_ledger_credit_line_post_message_spec.rb +0 -40
- data/spec/models/lease_ledger_credit_post_message_spec.rb +0 -62
- data/spec/models/lease_ledger_deposit_withholding_line_post_message_spec.rb +0 -40
- data/spec/models/lease_ledger_deposit_withholding_post_message_spec.rb +0 -52
- data/spec/models/lease_ledger_payment_line_save_message_spec.rb +0 -40
- data/spec/models/lease_ledger_payment_post_message_spec.rb +0 -74
- data/spec/models/lease_ledger_refund_line_message_spec.rb +0 -40
- data/spec/models/lease_ledger_refund_line_post_message_spec.rb +0 -40
- data/spec/models/lease_ledger_refund_message_spec.rb +0 -82
- data/spec/models/lease_ledger_refund_post_message_spec.rb +0 -70
- data/spec/models/lease_ledger_reverse_payment_nsf_charge_post_message_spec.rb +0 -40
- data/spec/models/lease_ledger_reverse_payment_other_bank_charge_post_message_spec.rb +0 -40
- data/spec/models/lease_ledger_reverse_payment_post_message_spec.rb +0 -52
- data/spec/models/lease_message_spec.rb +0 -170
- data/spec/models/lease_move_out_data_message_spec.rb +0 -46
- data/spec/models/lease_move_out_data_post_message_spec.rb +0 -46
- data/spec/models/lease_outstanding_balance_message_spec.rb +0 -100
- data/spec/models/lease_outstanding_balance_search_message_spec.rb +0 -90
- data/spec/models/lease_post_message_spec.rb +0 -98
- data/spec/models/lease_put_message_spec.rb +0 -68
- data/spec/models/lease_recurring_credit_message_spec.rb +0 -124
- data/spec/models/lease_recurring_payment_message_spec.rb +0 -118
- data/spec/models/lease_renewal_message_spec.rb +0 -84
- data/spec/models/lease_renewal_post_message_spec.rb +0 -98
- data/spec/models/lease_rent_charge_message_spec.rb +0 -70
- data/spec/models/lease_rent_charge_post_message_spec.rb +0 -52
- data/spec/models/lease_rent_message_spec.rb +0 -86
- data/spec/models/lease_rent_post_message_spec.rb +0 -44
- data/spec/models/lease_search_message_spec.rb +0 -108
- data/spec/models/lease_security_deposit_post_message_spec.rb +0 -40
- data/spec/models/lease_tenant_message_spec.rb +0 -44
- data/spec/models/lease_transaction_message_spec.rb +0 -82
- data/spec/models/lease_transaction_search_message_spec.rb +0 -50
- data/spec/models/listing_contact_message_spec.rb +0 -58
- data/spec/models/listing_contact_save_message_spec.rb +0 -52
- data/spec/models/listing_file_message_spec.rb +0 -50
- data/spec/models/listing_message_spec.rb +0 -88
- data/spec/models/listing_property_message_spec.rb +0 -90
- data/spec/models/listing_put_message_spec.rb +0 -64
- data/spec/models/listing_search_message_spec.rb +0 -44
- data/spec/models/listing_unit_message_spec.rb +0 -100
- data/spec/models/lock_period_settings_global_message_spec.rb +0 -34
- data/spec/models/lock_period_settings_overrides_message_spec.rb +0 -40
- data/spec/models/logged_by_staff_user_message_spec.rb +0 -52
- data/spec/models/lookup_message_spec.rb +0 -40
- data/spec/models/mailing_template_message_spec.rb +0 -56
- data/spec/models/note_message_spec.rb +0 -46
- data/spec/models/note_post_message_spec.rb +0 -34
- data/spec/models/note_put_message_spec.rb +0 -34
- data/spec/models/note_search_message_spec.rb +0 -46
- data/spec/models/outstanding_balances_line_message_spec.rb +0 -40
- data/spec/models/ownership_account_charge_recurring_transaction_message_spec.rb +0 -108
- data/spec/models/ownership_account_credit_line_post_message_spec.rb +0 -40
- data/spec/models/ownership_account_credit_post_message_spec.rb +0 -62
- data/spec/models/ownership_account_deposit_withholding_line_post_message_spec.rb +0 -40
- data/spec/models/ownership_account_deposit_withholding_post_message_spec.rb +0 -52
- data/spec/models/ownership_account_ledger_charge_lines_put_message_spec.rb +0 -46
- data/spec/models/ownership_account_ledger_charge_lines_save_message_spec.rb +0 -40
- data/spec/models/ownership_account_ledger_charge_post_message_spec.rb +0 -46
- data/spec/models/ownership_account_ledger_charge_put_message_spec.rb +0 -46
- data/spec/models/ownership_account_ledger_payment_line_save_message_spec.rb +0 -40
- data/spec/models/ownership_account_ledger_payment_post_message_spec.rb +0 -74
- data/spec/models/ownership_account_outstanding_balance_message_spec.rb +0 -88
- data/spec/models/ownership_account_outstanding_balance_search_message_spec.rb +0 -70
- data/spec/models/ownership_account_recurring_credit_message_spec.rb +0 -124
- data/spec/models/ownership_account_recurring_payment_message_spec.rb +0 -118
- data/spec/models/ownership_account_refund_line_message_spec.rb +0 -40
- data/spec/models/ownership_account_refund_lines_post_message_spec.rb +0 -40
- data/spec/models/ownership_account_refund_message_spec.rb +0 -82
- data/spec/models/ownership_account_refund_post_message_spec.rb +0 -70
- data/spec/models/ownership_account_transaction_message_spec.rb +0 -82
- data/spec/models/paid_by_message_spec.rb +0 -40
- data/spec/models/participant_message_spec.rb +0 -46
- data/spec/models/participant_resource_message_spec.rb +0 -44
- data/spec/models/payee_message_spec.rb +0 -56
- data/spec/models/payment_detail_message_spec.rb +0 -56
- data/spec/models/payment_recurring_transaction_post_message_spec.rb +0 -94
- data/spec/models/payment_transactions_message_spec.rb +0 -46
- data/spec/models/phone_log_message_spec.rb +0 -64
- data/spec/models/phone_log_participant_post_message_spec.rb +0 -50
- data/spec/models/phone_log_participant_unit_agreement_post_message_spec.rb +0 -44
- data/spec/models/phone_log_post_message_spec.rb +0 -52
- data/spec/models/phone_log_put_message_spec.rb +0 -46
- data/spec/models/phone_log_search_message_spec.rb +0 -84
- data/spec/models/phone_number_message_spec.rb +0 -44
- data/spec/models/phone_numbers_message_spec.rb +0 -52
- data/spec/models/property_group_message_spec.rb +0 -58
- data/spec/models/property_group_post_message_spec.rb +0 -46
- data/spec/models/property_group_put_message_spec.rb +0 -46
- data/spec/models/property_group_search_message_spec.rb +0 -40
- data/spec/models/property_manager_message_spec.rb +0 -76
- data/spec/models/property_message_spec.rb +0 -50
- data/spec/models/recurring_transaction_line_message_spec.rb +0 -40
- data/spec/models/recurring_transaction_line_post_message_spec.rb +0 -40
- data/spec/models/recurring_transaction_message_spec.rb +0 -112
- data/spec/models/rental_appliance_message_spec.rb +0 -76
- data/spec/models/rental_appliance_post_message_spec.rb +0 -76
- data/spec/models/rental_appliance_put_message_spec.rb +0 -64
- data/spec/models/rental_appliance_search_message_spec.rb +0 -40
- data/spec/models/rental_appliance_service_history_message_spec.rb +0 -56
- data/spec/models/rental_appliance_service_history_post_message_spec.rb +0 -50
- data/spec/models/rental_features_message_spec.rb +0 -48
- data/spec/models/rental_features_put_message_spec.rb +0 -48
- data/spec/models/rental_message_spec.rb +0 -108
- data/spec/models/rental_owner_message_spec.rb +0 -118
- data/spec/models/rental_owner_post_message_spec.rb +0 -112
- data/spec/models/rental_owner_put_message_spec.rb +0 -106
- data/spec/models/rental_owner_request_task_message_spec.rb +0 -114
- data/spec/models/rental_owner_request_task_post_message_spec.rb +0 -102
- data/spec/models/rental_owner_request_task_put_message_spec.rb +0 -96
- data/spec/models/rental_owner_request_task_search_message_spec.rb +0 -112
- data/spec/models/rental_owner_tax_information_message_spec.rb +0 -68
- data/spec/models/rental_owners_search_message_spec.rb +0 -74
- data/spec/models/rental_preferred_vendor_message_spec.rb +0 -82
- data/spec/models/rental_preferred_vendor_put_message_spec.rb +0 -34
- data/spec/models/rental_property_post_message_spec.rb +0 -92
- data/spec/models/rental_property_put_message_spec.rb +0 -80
- data/spec/models/rental_property_unit_post_message_spec.rb +0 -78
- data/spec/models/rental_search_message_spec.rb +0 -88
- data/spec/models/rental_tenant_post_message_spec.rb +0 -110
- data/spec/models/rental_tenant_put_message_spec.rb +0 -104
- data/spec/models/rental_tenant_renewal_post_message_spec.rb +0 -104
- data/spec/models/rental_unit_features_message_spec.rb +0 -38
- data/spec/models/rental_unit_features_put_message_spec.rb +0 -38
- data/spec/models/rental_unit_message_spec.rb +0 -108
- data/spec/models/rental_unit_put_message_spec.rb +0 -78
- data/spec/models/rental_unit_search_message_spec.rb +0 -46
- data/spec/models/rental_units_post_message_spec.rb +0 -84
- data/spec/models/requested_by_user_entity_message_spec.rb +0 -68
- data/spec/models/resident_center_user_message_spec.rb +0 -56
- data/spec/models/resident_center_user_reference_message_spec.rb +0 -62
- data/spec/models/resident_center_user_search_message_spec.rb +0 -66
- data/spec/models/resident_request_task_message_spec.rb +0 -144
- data/spec/models/resident_request_task_post_message_spec.rb +0 -114
- data/spec/models/resident_request_task_put_message_spec.rb +0 -84
- data/spec/models/resident_request_task_search_message_spec.rb +0 -118
- data/spec/models/save_address_message_spec.rb +0 -74
- data/spec/models/save_emergency_contact_message_spec.rb +0 -52
- data/spec/models/task_category_message_spec.rb +0 -52
- data/spec/models/task_category_put_message_spec.rb +0 -34
- data/spec/models/task_category_response_message_spec.rb +0 -52
- data/spec/models/task_category_save_message_spec.rb +0 -34
- data/spec/models/task_history_file_message_spec.rb +0 -64
- data/spec/models/task_history_file_upload_post_message_spec.rb +0 -34
- data/spec/models/task_history_message_spec.rb +0 -112
- data/spec/models/task_history_put_message_spec.rb +0 -34
- data/spec/models/task_history_user_message_spec.rb +0 -52
- data/spec/models/task_search_message_spec.rb +0 -128
- data/spec/models/task_sub_category_message_spec.rb +0 -40
- data/spec/models/tax_information_post_message_spec.rb +0 -62
- data/spec/models/tax_information_save_message_spec.rb +0 -68
- data/spec/models/tenant_message_spec.rb +0 -128
- data/spec/models/tenant_search_message_spec.rb +0 -96
- data/spec/models/to_do_task_message_spec.rb +0 -108
- data/spec/models/to_do_task_post_message_spec.rb +0 -96
- data/spec/models/to_do_task_put_message_spec.rb +0 -96
- data/spec/models/to_do_task_search_message_spec.rb +0 -112
- data/spec/models/undeposited_funds_message_spec.rb +0 -34
- data/spec/models/unit_agreement_message_spec.rb +0 -50
- data/spec/models/user_message_spec.rb +0 -104
- data/spec/models/user_role_message_spec.rb +0 -52
- data/spec/models/user_search_message_spec.rb +0 -66
- data/spec/models/vehicle_message_spec.rb +0 -52
- data/spec/models/vendor_category_message_spec.rb +0 -46
- data/spec/models/vendor_category_save_message_spec.rb +0 -34
- data/spec/models/vendor_credit_line_item_message_spec.rb +0 -58
- data/spec/models/vendor_credit_line_item_post_message_spec.rb +0 -52
- data/spec/models/vendor_credit_message_spec.rb +0 -58
- data/spec/models/vendor_credit_post_message_spec.rb +0 -52
- data/spec/models/vendor_insurance_message_spec.rb +0 -46
- data/spec/models/vendor_insurance_save_message_spec.rb +0 -46
- data/spec/models/vendor_message_spec.rb +0 -130
- data/spec/models/vendor_post_message_spec.rb +0 -118
- data/spec/models/vendor_put_message_spec.rb +0 -118
- data/spec/models/vendor_refund_line_message_spec.rb +0 -58
- data/spec/models/vendor_refund_line_post_message_spec.rb +0 -52
- data/spec/models/vendor_refund_message_spec.rb +0 -74
- data/spec/models/vendor_refund_post_message_spec.rb +0 -68
- data/spec/models/vendor_search_message_spec.rb +0 -84
- data/spec/models/vendor_tax_information_message_spec.rb +0 -68
- data/spec/models/vendor_transaction_message_spec.rb +0 -68
- data/spec/models/vendor_transaction_search_message_spec.rb +0 -62
- data/spec/models/work_order_entry_contact_message_spec.rb +0 -40
- data/spec/models/work_order_entry_contact_resource_message_spec.rb +0 -44
- data/spec/models/work_order_line_item_message_spec.rb +0 -52
- data/spec/models/work_order_line_item_save_message_spec.rb +0 -52
- data/spec/models/work_order_message_spec.rb +0 -110
- data/spec/models/work_order_post_message_spec.rb +0 -98
- data/spec/models/work_order_put_message_spec.rb +0 -86
- data/spec/models/work_order_search_message_spec.rb +0 -158
- data/spec/models/work_order_task_message_spec.rb +0 -88
- data/spec/models/work_order_task_post_message_spec.rb +0 -78
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Open API, powered by Buildium
|
3
3
|
|
4
|
-
#
|
4
|
+
# # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes <br /> # Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a <a target=\"_blank\" href=\"https://www.buildium.com/pricing/\">**Premium Subscription**</a>. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Application settings*** to set things up properly. <br /> **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. <video width=\"100%\" autoplay loop muted> <source src=\"enable_open_api.mp4\" type=\"video/mp4\" /> </video> Congratulations! Your account's enabled. Now, you’re ready to start managing API keys. <br /> <br /> If you are having issues enabling the API within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Buildium account and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there! > **Tip:** You’ll need an administrator user role to complete this step, too. <br /> **How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. <br /> <video width=\"100%\" autoplay loop muted> <source src=\"generate_open_api_key.mp4\" type=\"video/mp4\" /> </video> <br /> You have now successfully created an API key and have everything you need to send requests to the Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Buildium account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. <br /> ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: v1
|
7
7
|
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Open API, powered by Buildium
|
3
3
|
|
4
|
-
#
|
4
|
+
# # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes <br /> # Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a <a target=\"_blank\" href=\"https://www.buildium.com/pricing/\">**Premium Subscription**</a>. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Application settings*** to set things up properly. <br /> **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. <video width=\"100%\" autoplay loop muted> <source src=\"enable_open_api.mp4\" type=\"video/mp4\" /> </video> Congratulations! Your account's enabled. Now, you’re ready to start managing API keys. <br /> <br /> If you are having issues enabling the API within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Buildium account and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there! > **Tip:** You’ll need an administrator user role to complete this step, too. <br /> **How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. <br /> <video width=\"100%\" autoplay loop muted> <source src=\"generate_open_api_key.mp4\" type=\"video/mp4\" /> </video> <br /> You have now successfully created an API key and have everything you need to send requests to the Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Buildium account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. <br /> ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: v1
|
7
7
|
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Open API, powered by Buildium
|
3
3
|
|
4
|
-
#
|
4
|
+
# # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes <br /> # Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a <a target=\"_blank\" href=\"https://www.buildium.com/pricing/\">**Premium Subscription**</a>. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Application settings*** to set things up properly. <br /> **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. <video width=\"100%\" autoplay loop muted> <source src=\"enable_open_api.mp4\" type=\"video/mp4\" /> </video> Congratulations! Your account's enabled. Now, you’re ready to start managing API keys. <br /> <br /> If you are having issues enabling the API within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Buildium account and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there! > **Tip:** You’ll need an administrator user role to complete this step, too. <br /> **How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. <br /> <video width=\"100%\" autoplay loop muted> <source src=\"generate_open_api_key.mp4\" type=\"video/mp4\" /> </video> <br /> You have now successfully created an API key and have everything you need to send requests to the Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Buildium account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. <br /> ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: v1
|
7
7
|
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Open API, powered by Buildium
|
3
3
|
|
4
|
-
#
|
4
|
+
# # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes <br /> # Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a <a target=\"_blank\" href=\"https://www.buildium.com/pricing/\">**Premium Subscription**</a>. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Application settings*** to set things up properly. <br /> **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. <video width=\"100%\" autoplay loop muted> <source src=\"enable_open_api.mp4\" type=\"video/mp4\" /> </video> Congratulations! Your account's enabled. Now, you’re ready to start managing API keys. <br /> <br /> If you are having issues enabling the API within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Buildium account and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there! > **Tip:** You’ll need an administrator user role to complete this step, too. <br /> **How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. <br /> <video width=\"100%\" autoplay loop muted> <source src=\"generate_open_api_key.mp4\" type=\"video/mp4\" /> </video> <br /> You have now successfully created an API key and have everything you need to send requests to the Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Buildium account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. <br /> ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: v1
|
7
7
|
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Open API, powered by Buildium
|
3
3
|
|
4
|
-
#
|
4
|
+
# # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes <br /> # Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a <a target=\"_blank\" href=\"https://www.buildium.com/pricing/\">**Premium Subscription**</a>. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Application settings*** to set things up properly. <br /> **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. <video width=\"100%\" autoplay loop muted> <source src=\"enable_open_api.mp4\" type=\"video/mp4\" /> </video> Congratulations! Your account's enabled. Now, you’re ready to start managing API keys. <br /> <br /> If you are having issues enabling the API within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Buildium account and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there! > **Tip:** You’ll need an administrator user role to complete this step, too. <br /> **How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. <br /> <video width=\"100%\" autoplay loop muted> <source src=\"generate_open_api_key.mp4\" type=\"video/mp4\" /> </video> <br /> You have now successfully created an API key and have everything you need to send requests to the Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Buildium account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. <br /> ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: v1
|
7
7
|
|
@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1
|
|
11
11
|
=end
|
12
12
|
|
13
13
|
module Buildium
|
14
|
-
VERSION = '
|
14
|
+
VERSION = '3.0.0'
|
15
15
|
end
|
data/lib/buildium-ruby.rb
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Open API, powered by Buildium
|
3
3
|
|
4
|
-
#
|
4
|
+
# # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes <br /> # Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a <a target=\"_blank\" href=\"https://www.buildium.com/pricing/\">**Premium Subscription**</a>. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Application settings*** to set things up properly. <br /> **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. <video width=\"100%\" autoplay loop muted> <source src=\"enable_open_api.mp4\" type=\"video/mp4\" /> </video> Congratulations! Your account's enabled. Now, you’re ready to start managing API keys. <br /> <br /> If you are having issues enabling the API within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Buildium account and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there! > **Tip:** You’ll need an administrator user role to complete this step, too. <br /> **How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. <br /> <video width=\"100%\" autoplay loop muted> <source src=\"generate_open_api_key.mp4\" type=\"video/mp4\" /> </video> <br /> You have now successfully created an API key and have everything you need to send requests to the Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Buildium account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. <br /> ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: v1
|
7
7
|
|
@@ -45,6 +45,7 @@ require 'buildium-ruby/models/application_put_message'
|
|
45
45
|
require 'buildium-ruby/models/application_response_field_message'
|
46
46
|
require 'buildium-ruby/models/application_response_message'
|
47
47
|
require 'buildium-ruby/models/application_section_response_message'
|
48
|
+
require 'buildium-ruby/models/applied_vendor_credit_message'
|
48
49
|
require 'buildium-ruby/models/association_appliance_message'
|
49
50
|
require 'buildium-ruby/models/association_appliance_post_message'
|
50
51
|
require 'buildium-ruby/models/association_appliance_put_message'
|
@@ -73,6 +74,7 @@ require 'buildium-ruby/models/association_preferred_vendor_message'
|
|
73
74
|
require 'buildium-ruby/models/association_preferred_vendor_put_message'
|
74
75
|
require 'buildium-ruby/models/association_put_message'
|
75
76
|
require 'buildium-ruby/models/association_search_message'
|
77
|
+
require 'buildium-ruby/models/association_tax_information_message'
|
76
78
|
require 'buildium-ruby/models/association_tenant_message'
|
77
79
|
require 'buildium-ruby/models/association_tenant_post_message'
|
78
80
|
require 'buildium-ruby/models/association_tenant_put_message'
|
@@ -82,6 +84,7 @@ require 'buildium-ruby/models/association_unit_search_message'
|
|
82
84
|
require 'buildium-ruby/models/association_units_post_message'
|
83
85
|
require 'buildium-ruby/models/association_user_search_message'
|
84
86
|
require 'buildium-ruby/models/bank_account_check_accounting_entity_save_message'
|
87
|
+
require 'buildium-ruby/models/bank_account_check_file_message'
|
85
88
|
require 'buildium-ruby/models/bank_account_check_line_message'
|
86
89
|
require 'buildium-ruby/models/bank_account_check_line_save_message'
|
87
90
|
require 'buildium-ruby/models/bank_account_check_message'
|
@@ -112,6 +115,11 @@ require 'buildium-ruby/models/bank_account_transfer_search_message'
|
|
112
115
|
require 'buildium-ruby/models/bank_account_withdrawal_message'
|
113
116
|
require 'buildium-ruby/models/bank_account_withdrawal_save_message'
|
114
117
|
require 'buildium-ruby/models/bank_account_withdrawal_search_message'
|
118
|
+
require 'buildium-ruby/models/bank_lockbox_data_association_message'
|
119
|
+
require 'buildium-ruby/models/bank_lockbox_data_association_owner_message'
|
120
|
+
require 'buildium-ruby/models/bank_lockbox_data_message'
|
121
|
+
require 'buildium-ruby/models/bank_lockbox_data_ownership_account_message'
|
122
|
+
require 'buildium-ruby/models/bank_lockbox_data_search_message'
|
115
123
|
require 'buildium-ruby/models/bill_file_message'
|
116
124
|
require 'buildium-ruby/models/bill_line_message'
|
117
125
|
require 'buildium-ruby/models/bill_line_post_message'
|
@@ -135,6 +143,9 @@ require 'buildium-ruby/models/budget_monthly_amounts_save_message'
|
|
135
143
|
require 'buildium-ruby/models/budget_post_message'
|
136
144
|
require 'buildium-ruby/models/budget_put_message'
|
137
145
|
require 'buildium-ruby/models/budget_search_message'
|
146
|
+
require 'buildium-ruby/models/cc_payments_message'
|
147
|
+
require 'buildium-ruby/models/cc_payments_put_message'
|
148
|
+
require 'buildium-ruby/models/cancellation_token'
|
138
149
|
require 'buildium-ruby/models/charge_recurring_transaction_post_message'
|
139
150
|
require 'buildium-ruby/models/charge_recurring_transaction_put_message'
|
140
151
|
require 'buildium-ruby/models/check_printing_info_message'
|
@@ -156,6 +167,10 @@ require 'buildium-ruby/models/cosigner_message'
|
|
156
167
|
require 'buildium-ruby/models/created_by_user_message'
|
157
168
|
require 'buildium-ruby/models/credit_recurring_transaction_post_message'
|
158
169
|
require 'buildium-ruby/models/deposit_detail_message'
|
170
|
+
require 'buildium-ruby/models/eft_payments_message'
|
171
|
+
require 'buildium-ruby/models/eft_payments_put_message'
|
172
|
+
require 'buildium-ruby/models/e_pay_settings_message'
|
173
|
+
require 'buildium-ruby/models/e_pay_settings_put_message'
|
159
174
|
require 'buildium-ruby/models/electronic_payments_message'
|
160
175
|
require 'buildium-ruby/models/email_message'
|
161
176
|
require 'buildium-ruby/models/email_post_message'
|
@@ -172,6 +187,32 @@ require 'buildium-ruby/models/file_message'
|
|
172
187
|
require 'buildium-ruby/models/file_name_post_message'
|
173
188
|
require 'buildium-ruby/models/file_put_message'
|
174
189
|
require 'buildium-ruby/models/file_search_message'
|
190
|
+
require 'buildium-ruby/models/file_sharing_account_message'
|
191
|
+
require 'buildium-ruby/models/file_sharing_account_put_message'
|
192
|
+
require 'buildium-ruby/models/file_sharing_association_message'
|
193
|
+
require 'buildium-ruby/models/file_sharing_association_owner_message'
|
194
|
+
require 'buildium-ruby/models/file_sharing_association_owner_put_message'
|
195
|
+
require 'buildium-ruby/models/file_sharing_association_put_message'
|
196
|
+
require 'buildium-ruby/models/file_sharing_association_unit_message'
|
197
|
+
require 'buildium-ruby/models/file_sharing_association_unit_put_message'
|
198
|
+
require 'buildium-ruby/models/file_sharing_committee_message'
|
199
|
+
require 'buildium-ruby/models/file_sharing_committee_put_message'
|
200
|
+
require 'buildium-ruby/models/file_sharing_lease_message'
|
201
|
+
require 'buildium-ruby/models/file_sharing_lease_put_message'
|
202
|
+
require 'buildium-ruby/models/file_sharing_message'
|
203
|
+
require 'buildium-ruby/models/file_sharing_ownership_account_message'
|
204
|
+
require 'buildium-ruby/models/file_sharing_ownership_account_put_message'
|
205
|
+
require 'buildium-ruby/models/file_sharing_put_message'
|
206
|
+
require 'buildium-ruby/models/file_sharing_rental_message'
|
207
|
+
require 'buildium-ruby/models/file_sharing_rental_owner_message'
|
208
|
+
require 'buildium-ruby/models/file_sharing_rental_owner_put_message'
|
209
|
+
require 'buildium-ruby/models/file_sharing_rental_put_message'
|
210
|
+
require 'buildium-ruby/models/file_sharing_rental_unit_mesage'
|
211
|
+
require 'buildium-ruby/models/file_sharing_rental_unit_put_mesage'
|
212
|
+
require 'buildium-ruby/models/file_sharing_tenant_message'
|
213
|
+
require 'buildium-ruby/models/file_sharing_tenant_put_message'
|
214
|
+
require 'buildium-ruby/models/file_sharing_vendor_message'
|
215
|
+
require 'buildium-ruby/models/file_sharing_vendor_put_message'
|
175
216
|
require 'buildium-ruby/models/file_upload_post_message'
|
176
217
|
require 'buildium-ruby/models/file_upload_ticket_message'
|
177
218
|
require 'buildium-ruby/models/gl_account_balance_item_message'
|
@@ -185,15 +226,22 @@ require 'buildium-ruby/models/gl_transaction_message_v1'
|
|
185
226
|
require 'buildium-ruby/models/general_journal_entry_line_save_message'
|
186
227
|
require 'buildium-ruby/models/general_journal_entry_post_message'
|
187
228
|
require 'buildium-ruby/models/general_journal_entry_put_message'
|
229
|
+
require 'buildium-ruby/models/general_ledger_entry_message'
|
188
230
|
require 'buildium-ruby/models/general_ledger_journal_line_message'
|
189
231
|
require 'buildium-ruby/models/general_ledger_journal_message'
|
232
|
+
require 'buildium-ruby/models/general_ledger_message'
|
233
|
+
require 'buildium-ruby/models/general_ledger_search_message'
|
190
234
|
require 'buildium-ruby/models/general_ledger_transaction_message'
|
191
235
|
require 'buildium-ruby/models/general_ledger_transaction_search_message'
|
236
|
+
require 'buildium-ruby/models/image_reorder_request_put_message'
|
237
|
+
require 'buildium-ruby/models/insured_tenant_message'
|
192
238
|
require 'buildium-ruby/models/internal_transaction_status_message'
|
193
239
|
require 'buildium-ruby/models/journal_line_message'
|
194
240
|
require 'buildium-ruby/models/journal_message'
|
241
|
+
require 'buildium-ruby/models/json_patch_operation'
|
195
242
|
require 'buildium-ruby/models/last_updated_by_user_message'
|
196
243
|
require 'buildium-ruby/models/lease_account_detail_message'
|
244
|
+
require 'buildium-ruby/models/lease_auto_allocated_payment_post_message'
|
197
245
|
require 'buildium-ruby/models/lease_charge_line_save_message'
|
198
246
|
require 'buildium-ruby/models/lease_charge_post_message'
|
199
247
|
require 'buildium-ruby/models/lease_charge_put_message'
|
@@ -205,6 +253,7 @@ require 'buildium-ruby/models/lease_ledger_deposit_withholding_line_post_message
|
|
205
253
|
require 'buildium-ruby/models/lease_ledger_deposit_withholding_post_message'
|
206
254
|
require 'buildium-ruby/models/lease_ledger_payment_line_save_message'
|
207
255
|
require 'buildium-ruby/models/lease_ledger_payment_post_message'
|
256
|
+
require 'buildium-ruby/models/lease_ledger_payment_put_message'
|
208
257
|
require 'buildium-ruby/models/lease_ledger_refund_line_message'
|
209
258
|
require 'buildium-ruby/models/lease_ledger_refund_line_post_message'
|
210
259
|
require 'buildium-ruby/models/lease_ledger_refund_message'
|
@@ -223,6 +272,7 @@ require 'buildium-ruby/models/lease_recurring_credit_message'
|
|
223
272
|
require 'buildium-ruby/models/lease_recurring_payment_message'
|
224
273
|
require 'buildium-ruby/models/lease_renewal_message'
|
225
274
|
require 'buildium-ruby/models/lease_renewal_post_message'
|
275
|
+
require 'buildium-ruby/models/lease_renewal_search_message'
|
226
276
|
require 'buildium-ruby/models/lease_rent_charge_message'
|
227
277
|
require 'buildium-ruby/models/lease_rent_charge_post_message'
|
228
278
|
require 'buildium-ruby/models/lease_rent_message'
|
@@ -234,6 +284,7 @@ require 'buildium-ruby/models/lease_transaction_message'
|
|
234
284
|
require 'buildium-ruby/models/lease_transaction_search_message'
|
235
285
|
require 'buildium-ruby/models/listing_contact_message'
|
236
286
|
require 'buildium-ruby/models/listing_contact_save_message'
|
287
|
+
require 'buildium-ruby/models/listing_entity_file_post_message'
|
237
288
|
require 'buildium-ruby/models/listing_file_message'
|
238
289
|
require 'buildium-ruby/models/listing_message'
|
239
290
|
require 'buildium-ruby/models/listing_property_message'
|
@@ -245,11 +296,24 @@ require 'buildium-ruby/models/lock_period_settings_overrides_message'
|
|
245
296
|
require 'buildium-ruby/models/logged_by_staff_user_message'
|
246
297
|
require 'buildium-ruby/models/lookup_message'
|
247
298
|
require 'buildium-ruby/models/mailing_template_message'
|
299
|
+
require 'buildium-ruby/models/meter_reading_detail_message'
|
300
|
+
require 'buildium-ruby/models/meter_reading_detail_put_message'
|
301
|
+
require 'buildium-ruby/models/meter_reading_details_delete_search_message'
|
302
|
+
require 'buildium-ruby/models/meter_reading_details_message'
|
303
|
+
require 'buildium-ruby/models/meter_reading_details_put_message'
|
304
|
+
require 'buildium-ruby/models/meter_reading_details_put_search_message'
|
305
|
+
require 'buildium-ruby/models/meter_reading_details_search_message'
|
306
|
+
require 'buildium-ruby/models/meter_reading_message'
|
307
|
+
require 'buildium-ruby/models/meter_reading_search_message'
|
308
|
+
require 'buildium-ruby/models/multiple_bill_payments_post_message'
|
248
309
|
require 'buildium-ruby/models/note_message'
|
249
310
|
require 'buildium-ruby/models/note_post_message'
|
250
311
|
require 'buildium-ruby/models/note_put_message'
|
251
312
|
require 'buildium-ruby/models/note_search_message'
|
313
|
+
require 'buildium-ruby/models/offline_payments_message'
|
314
|
+
require 'buildium-ruby/models/offline_payments_put_message'
|
252
315
|
require 'buildium-ruby/models/outstanding_balances_line_message'
|
316
|
+
require 'buildium-ruby/models/ownership_account_auto_allocated_payment_post_message'
|
253
317
|
require 'buildium-ruby/models/ownership_account_charge_recurring_transaction_message'
|
254
318
|
require 'buildium-ruby/models/ownership_account_credit_line_post_message'
|
255
319
|
require 'buildium-ruby/models/ownership_account_credit_post_message'
|
@@ -261,6 +325,7 @@ require 'buildium-ruby/models/ownership_account_ledger_charge_post_message'
|
|
261
325
|
require 'buildium-ruby/models/ownership_account_ledger_charge_put_message'
|
262
326
|
require 'buildium-ruby/models/ownership_account_ledger_payment_line_save_message'
|
263
327
|
require 'buildium-ruby/models/ownership_account_ledger_payment_post_message'
|
328
|
+
require 'buildium-ruby/models/ownership_account_ledger_payment_put_message'
|
264
329
|
require 'buildium-ruby/models/ownership_account_outstanding_balance_message'
|
265
330
|
require 'buildium-ruby/models/ownership_account_outstanding_balance_search_message'
|
266
331
|
require 'buildium-ruby/models/ownership_account_recurring_credit_message'
|
@@ -302,7 +367,15 @@ require 'buildium-ruby/models/rental_appliance_service_history_message'
|
|
302
367
|
require 'buildium-ruby/models/rental_appliance_service_history_post_message'
|
303
368
|
require 'buildium-ruby/models/rental_features_message'
|
304
369
|
require 'buildium-ruby/models/rental_features_put_message'
|
370
|
+
require 'buildium-ruby/models/rental_image_message'
|
371
|
+
require 'buildium-ruby/models/rental_image_put_message'
|
305
372
|
require 'buildium-ruby/models/rental_message'
|
373
|
+
require 'buildium-ruby/models/rental_owner_contribution_data_message'
|
374
|
+
require 'buildium-ruby/models/rental_owner_contribution_data_put_message'
|
375
|
+
require 'buildium-ruby/models/rental_owner_contribution_message'
|
376
|
+
require 'buildium-ruby/models/rental_owner_contribution_put_message'
|
377
|
+
require 'buildium-ruby/models/rental_owner_contribution_reminder_message'
|
378
|
+
require 'buildium-ruby/models/rental_owner_contribution_reminder_put_message'
|
306
379
|
require 'buildium-ruby/models/rental_owner_message'
|
307
380
|
require 'buildium-ruby/models/rental_owner_post_message'
|
308
381
|
require 'buildium-ruby/models/rental_owner_put_message'
|
@@ -323,10 +396,13 @@ require 'buildium-ruby/models/rental_tenant_put_message'
|
|
323
396
|
require 'buildium-ruby/models/rental_tenant_renewal_post_message'
|
324
397
|
require 'buildium-ruby/models/rental_unit_features_message'
|
325
398
|
require 'buildium-ruby/models/rental_unit_features_put_message'
|
399
|
+
require 'buildium-ruby/models/rental_unit_image_message'
|
400
|
+
require 'buildium-ruby/models/rental_unit_image_put_message'
|
326
401
|
require 'buildium-ruby/models/rental_unit_message'
|
327
402
|
require 'buildium-ruby/models/rental_unit_put_message'
|
328
403
|
require 'buildium-ruby/models/rental_unit_search_message'
|
329
404
|
require 'buildium-ruby/models/rental_units_post_message'
|
405
|
+
require 'buildium-ruby/models/renters_insurance_policy_message'
|
330
406
|
require 'buildium-ruby/models/requested_by_user_entity_message'
|
331
407
|
require 'buildium-ruby/models/resident_center_user_message'
|
332
408
|
require 'buildium-ruby/models/resident_center_user_reference_message'
|
@@ -335,6 +411,13 @@ require 'buildium-ruby/models/resident_request_task_message'
|
|
335
411
|
require 'buildium-ruby/models/resident_request_task_post_message'
|
336
412
|
require 'buildium-ruby/models/resident_request_task_put_message'
|
337
413
|
require 'buildium-ruby/models/resident_request_task_search_message'
|
414
|
+
require 'buildium-ruby/models/retail_cash_property_message'
|
415
|
+
require 'buildium-ruby/models/retail_cash_unit_message'
|
416
|
+
require 'buildium-ruby/models/retail_cash_user_data_message'
|
417
|
+
require 'buildium-ruby/models/retail_cash_user_message'
|
418
|
+
require 'buildium-ruby/models/retail_cash_user_put_message'
|
419
|
+
require 'buildium-ruby/models/retail_cash_users_search_message'
|
420
|
+
require 'buildium-ruby/models/safe_wait_handle'
|
338
421
|
require 'buildium-ruby/models/save_address_message'
|
339
422
|
require 'buildium-ruby/models/save_emergency_contact_message'
|
340
423
|
require 'buildium-ruby/models/task_category_message'
|
@@ -358,6 +441,7 @@ require 'buildium-ruby/models/to_do_task_put_message'
|
|
358
441
|
require 'buildium-ruby/models/to_do_task_search_message'
|
359
442
|
require 'buildium-ruby/models/undeposited_funds_message'
|
360
443
|
require 'buildium-ruby/models/unit_agreement_message'
|
444
|
+
require 'buildium-ruby/models/unit_entity_message'
|
361
445
|
require 'buildium-ruby/models/user_message'
|
362
446
|
require 'buildium-ruby/models/user_role_message'
|
363
447
|
require 'buildium-ruby/models/user_search_message'
|
@@ -381,6 +465,8 @@ require 'buildium-ruby/models/vendor_search_message'
|
|
381
465
|
require 'buildium-ruby/models/vendor_tax_information_message'
|
382
466
|
require 'buildium-ruby/models/vendor_transaction_message'
|
383
467
|
require 'buildium-ruby/models/vendor_transaction_search_message'
|
468
|
+
require 'buildium-ruby/models/video_link_request_post_message'
|
469
|
+
require 'buildium-ruby/models/wait_handle'
|
384
470
|
require 'buildium-ruby/models/work_order_entry_contact_message'
|
385
471
|
require 'buildium-ruby/models/work_order_entry_contact_resource_message'
|
386
472
|
require 'buildium-ruby/models/work_order_line_item_message'
|
@@ -393,29 +479,40 @@ require 'buildium-ruby/models/work_order_task_message'
|
|
393
479
|
require 'buildium-ruby/models/work_order_task_post_message'
|
394
480
|
|
395
481
|
# APIs
|
396
|
-
require 'buildium-ruby/api/accounting_api'
|
397
482
|
require 'buildium-ruby/api/administration_api'
|
483
|
+
require 'buildium-ruby/api/appliances_api'
|
398
484
|
require 'buildium-ruby/api/applicants_api'
|
399
|
-
require 'buildium-ruby/api/
|
485
|
+
require 'buildium-ruby/api/association_meter_readings_api'
|
400
486
|
require 'buildium-ruby/api/association_owners_api'
|
401
|
-
require 'buildium-ruby/api/association_ownership_accounts_api'
|
402
487
|
require 'buildium-ruby/api/association_tenants_api'
|
403
488
|
require 'buildium-ruby/api/association_units_api'
|
404
489
|
require 'buildium-ruby/api/associations_api'
|
405
490
|
require 'buildium-ruby/api/bank_accounts_api'
|
491
|
+
require 'buildium-ruby/api/bills_api'
|
492
|
+
require 'buildium-ruby/api/board_members_api'
|
493
|
+
require 'buildium-ruby/api/budgets_api'
|
406
494
|
require 'buildium-ruby/api/client_leads_api'
|
407
495
|
require 'buildium-ruby/api/communications_api'
|
496
|
+
require 'buildium-ruby/api/contact_requests_api'
|
408
497
|
require 'buildium-ruby/api/files_api'
|
498
|
+
require 'buildium-ruby/api/general_ledger_api'
|
499
|
+
require 'buildium-ruby/api/lease_transactions_api'
|
409
500
|
require 'buildium-ruby/api/leases_api'
|
410
501
|
require 'buildium-ruby/api/listings_api'
|
502
|
+
require 'buildium-ruby/api/ownership_account_transactions_api'
|
503
|
+
require 'buildium-ruby/api/ownership_accounts_api'
|
411
504
|
require 'buildium-ruby/api/property_groups_api'
|
412
505
|
require 'buildium-ruby/api/rental_appliances_api'
|
506
|
+
require 'buildium-ruby/api/rental_meter_readings_api'
|
507
|
+
require 'buildium-ruby/api/rental_owner_requests_api'
|
413
508
|
require 'buildium-ruby/api/rental_owners_api'
|
414
509
|
require 'buildium-ruby/api/rental_properties_api'
|
415
510
|
require 'buildium-ruby/api/rental_tenants_api'
|
416
511
|
require 'buildium-ruby/api/rental_units_api'
|
417
512
|
require 'buildium-ruby/api/resident_center_api'
|
513
|
+
require 'buildium-ruby/api/resident_requests_api'
|
418
514
|
require 'buildium-ruby/api/tasks_api'
|
515
|
+
require 'buildium-ruby/api/to_do_requests_api'
|
419
516
|
require 'buildium-ruby/api/vendors_api'
|
420
517
|
require 'buildium-ruby/api/work_orders_api'
|
421
518
|
|
data/spec/api_client_spec.rb
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Open API, powered by Buildium
|
3
3
|
|
4
|
-
#
|
4
|
+
# # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes <br /> # Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a <a target=\"_blank\" href=\"https://www.buildium.com/pricing/\">**Premium Subscription**</a>. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Application settings*** to set things up properly. <br /> **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. <video width=\"100%\" autoplay loop muted> <source src=\"enable_open_api.mp4\" type=\"video/mp4\" /> </video> Congratulations! Your account's enabled. Now, you’re ready to start managing API keys. <br /> <br /> If you are having issues enabling the API within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Buildium account and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there! > **Tip:** You’ll need an administrator user role to complete this step, too. <br /> **How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. <br /> <video width=\"100%\" autoplay loop muted> <source src=\"generate_open_api_key.mp4\" type=\"video/mp4\" /> </video> <br /> You have now successfully created an API key and have everything you need to send requests to the Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Buildium account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. <br /> ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: v1
|
7
7
|
|
data/spec/configuration_spec.rb
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Open API, powered by Buildium
|
3
3
|
|
4
|
-
#
|
4
|
+
# # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes <br /> # Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a <a target=\"_blank\" href=\"https://www.buildium.com/pricing/\">**Premium Subscription**</a>. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Application settings*** to set things up properly. <br /> **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. <video width=\"100%\" autoplay loop muted> <source src=\"enable_open_api.mp4\" type=\"video/mp4\" /> </video> Congratulations! Your account's enabled. Now, you’re ready to start managing API keys. <br /> <br /> If you are having issues enabling the API within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Buildium account and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there! > **Tip:** You’ll need an administrator user role to complete this step, too. <br /> **How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. <br /> <video width=\"100%\" autoplay loop muted> <source src=\"generate_open_api_key.mp4\" type=\"video/mp4\" /> </video> <br /> You have now successfully created an API key and have everything you need to send requests to the Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Buildium account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. <br /> ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: v1
|
7
7
|
|
data/spec/spec_helper.rb
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Open API, powered by Buildium
|
3
3
|
|
4
|
-
#
|
4
|
+
# # Introduction ### Welcome! Welcome to Buildium’s API—a powerful, RESTful programming interface that lets you leverage valuable Buildium data. Using HTTP requests, you can create integrations with applications that specialize in accounting, lead tracking, and more. Enjoy greater flexibility, transparency, and control over your business! ### What's in this Guide? This guide is full of simple, easy-to-follow instructions that’ll help you use Buildium’s API like a pro. Topics include: * choosing the right resources for your use case * making HTTP requests to any resource * understanding data and response codes <br /> # Getting Started Excited to get going? We’ll walk you through the setup process. > **Note:** To take advantage of the Buildium Open API you must have a <a target=\"_blank\" href=\"https://www.buildium.com/pricing/\">**Premium Subscription**</a>. ## Account Configuration Before you can use Buildium’s API, you’ll need to make some tweaks to your account settings. <br /> ### Enabling the API In order to start creating your keys and making requests, you’ll need to enable the API. > **Tip:** You’ll need an administrator user role with access to ***Application settings*** to set things up properly. <br /> **Let's Begin!** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Application settings***. 3. Under ***System preferences***, click ***Api settings***. A modal will appear. 4. Click the ***Open API*** toggle to turn it on. Then click ***Save***. <video width=\"100%\" autoplay loop muted> <source src=\"enable_open_api.mp4\" type=\"video/mp4\" /> </video> Congratulations! Your account's enabled. Now, you’re ready to start managing API keys. <br /> <br /> If you are having issues enabling the API within your account you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## API Keys Account-level API keys authenticate every request and keep things secure. API keys have two components: a “client ID” and a “secret”. * **Client IDs** are similar to usernames. They’re used to identify your Buildium account and are safe to share. * **Secrets** are similar to passwords. They must be kept confidential. Whenever you make a request, you’ll need the API key’s client ID and secret. If you forget it, make a mistake, or try to use information that’s linked to a deleted key, the API will return a `401` response code. > **Tip:** We compiled a list of best practices that detail how securely store API keys. [Give it a read](#section/Getting-Started/Keeping-API-Keys-Safe)! ## Creating API Keys Now that the Open APi is enabled, you’ll be able to create API keys. You’re almost there! > **Tip:** You’ll need an administrator user role to complete this step, too. <br /> **How to create an API key** 1. Sign in to your [Buildium](https://signin.managebuilding.com/manager/public/authentication/login?ReturnUrl=%2Fmanager%2F) account from your browser. 2. Open the ***Settings*** menu and click ***Developer Tools***. The page will open automatically. 3. Click the ***Create API Key*** button. A modal will appear. 4. Enter a clear, memorable name and description for your API key. It’ll make it easier to locate the right key when you make a request. Once finished, click **Next**. 5. Now, choose which pieces of Buildium data you want this API key to have access to by marking the corresponding checkboxes. Once finished, click **Next**. 6. You successfully created an API key! > **Important:** This is your only chance to record the secret. Make sure it’s stored somewhere secure! If it’s forgotten, you’ll need to delete this key and start from scratch. <br /> <video width=\"100%\" autoplay loop muted> <source src=\"generate_open_api_key.mp4\" type=\"video/mp4\" /> </video> <br /> You have now successfully created an API key and have everything you need to send requests to the Buildium API! Before moving on to [making your first request](#section/Getting-Started/How-to-Make-a-Request) please review [Keeping your Keys Safe](#section/Getting-Started/Keeping-your-Keys-Safe) for an overview on securely storing your API keys. <br /> If you are having issues creating API keys you can submit a [Support](#section/API-Overview/Support) request for assistance. <br /> ## Keeping API Keys Safe Based on their permissions, API keys could have full access to your account’s Buildium data. It’s important that you only grant access to trusted applications, securely record secrets, and consider a password manager to stay organized. ### Recommended Practices - Avoid hard-coding client IDs and secrets inside source files. - Avoid storing client IDs and secrets in any files that may be committed to source control, particularly cloud-based source control platforms. - Apply restrictions to client IDs and secrets shared with your staff. You can restrict a key to particular Buildium entities or to read-only access (GET resources only). - Avoid sharing client IDs and secrets across public, insecure platforms. - Establish a process to regularly recreate your client IDs and secrets from your Buildium account. <br /> <br /> ## How to Make a Request You’ve done a great job setting up your account, Now, we’ll walk you through how to access your data. It’s very straightforward and should only take a few minutes! > **Tip:** Looking for the right HTTP client? If you’re just getting started, we recommend Postman. <br /> ### Let's Get Started! #### Step 1: Get Your API Key If you haven't yet done so, obtain your API key client ID and secret from your Buildium account. Your API key is how the Buildium API authenticates requests and ensures only you can access your data. See [Getting Started](#section/Getting-Started) for a deeper dive into enabling the API and creating keys. #### Step 2: Install a HTTP client The Buildium API supports any standard HTTP client. If you're looking for a user-friendly HTTP client application, we recommend [Postman](https://www.postman.com/product/api-client) – it allows you to access the Buildium API without writing code. We’ll use Postman for our example below to demonstrate sending an API request. #### Step 3: Make a Sample Request Let's dive in and make a simple request to get all the [Rental Properties](#operation/RentalsGetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: v1
|
7
7
|
|