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
data/docs/TasksApi.md
CHANGED
@@ -4,197 +4,29 @@ All URIs are relative to *https://api.buildium.com*
|
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**create_contact_request_task**](TasksApi.md#create_contact_request_task) | **POST** /v1/tasks/contactrequests | Create a contact request |
|
8
|
-
| [**create_rental_owner_request_task**](TasksApi.md#create_rental_owner_request_task) | **POST** /v1/tasks/rentalownerrequests | Create a rental owner request |
|
9
|
-
| [**create_resource**](TasksApi.md#create_resource) | **POST** /v1/tasks/residentrequests | Create a resident request |
|
10
7
|
| [**create_task_category**](TasksApi.md#create_task_category) | **POST** /v1/tasks/categories | Create a task category |
|
11
|
-
| [**create_to_do_task**](TasksApi.md#create_to_do_task) | **POST** /v1/tasks/todorequests | Create a to do task |
|
12
8
|
| [**delete_task_history_file**](TasksApi.md#delete_task_history_file) | **DELETE** /v1/tasks/{taskId}/history/{taskHistoryId}/files/{fileId} | Delete task history file |
|
13
|
-
| [**get_all_rental_owner_request_tasks**](TasksApi.md#get_all_rental_owner_request_tasks) | **GET** /v1/tasks/rentalownerrequests | Retrieve all rental owner requests |
|
14
9
|
| [**get_all_task_categories**](TasksApi.md#get_all_task_categories) | **GET** /v1/tasks/categories | Retrieve all task categories |
|
15
10
|
| [**get_all_task_history_files**](TasksApi.md#get_all_task_history_files) | **GET** /v1/tasks/{taskId}/history/{taskHistoryId}/files | Retrieve all task history files |
|
16
11
|
| [**get_all_tasks**](TasksApi.md#get_all_tasks) | **GET** /v1/tasks | Retrieve all tasks |
|
17
|
-
| [**get_contact_request_task_by_id**](TasksApi.md#get_contact_request_task_by_id) | **GET** /v1/tasks/contactrequests/{contactRequestTaskId} | Retrieve a contact request |
|
18
|
-
| [**get_contact_request_tasks**](TasksApi.md#get_contact_request_tasks) | **GET** /v1/tasks/contactrequests | Retrieve all contact requests |
|
19
12
|
| [**get_file_download_request**](TasksApi.md#get_file_download_request) | **POST** /v1/tasks/{taskId}/history/{taskHistoryId}/files/{fileId}/downloadrequest | Download a task history file |
|
20
|
-
| [**get_rental_owner_request_task_by_id**](TasksApi.md#get_rental_owner_request_task_by_id) | **GET** /v1/tasks/rentalownerrequests/{rentalOwnerRequestTaskId} | Retrieve a rental owner request |
|
21
|
-
| [**get_resident_request_task**](TasksApi.md#get_resident_request_task) | **GET** /v1/tasks/residentrequests/{residentRequestTaskId} | Retrieve a resident request |
|
22
|
-
| [**get_resident_request_tasks**](TasksApi.md#get_resident_request_tasks) | **GET** /v1/tasks/residentrequests | Retrieve all resident requests |
|
23
13
|
| [**get_task_by_id**](TasksApi.md#get_task_by_id) | **GET** /v1/tasks/{taskId} | Retrieve a task |
|
24
14
|
| [**get_task_category_by_id**](TasksApi.md#get_task_category_by_id) | **GET** /v1/tasks/categories/{taskCategoryId} | Retrieve a task category |
|
25
15
|
| [**get_task_histories**](TasksApi.md#get_task_histories) | **GET** /v1/tasks/{taskId}/history | Retrieve all task history |
|
26
16
|
| [**get_task_history_by_id**](TasksApi.md#get_task_history_by_id) | **GET** /v1/tasks/{taskId}/history/{taskHistoryId} | Retrieve a task history |
|
27
17
|
| [**get_task_history_file_by_id**](TasksApi.md#get_task_history_file_by_id) | **GET** /v1/tasks/{taskId}/history/{taskHistoryId}/files/{fileId} | Retrieve a task history file |
|
28
|
-
| [**get_to_do_task_by_id**](TasksApi.md#get_to_do_task_by_id) | **GET** /v1/tasks/todorequests/{toDoTaskId} | Retrieve a to do task |
|
29
|
-
| [**get_to_do_tasks**](TasksApi.md#get_to_do_tasks) | **GET** /v1/tasks/todorequests | Retrieve all to do tasks |
|
30
|
-
| [**update_contact_request_task**](TasksApi.md#update_contact_request_task) | **PUT** /v1/tasks/contactrequests/{contactRequestTaskId} | Update a contact request |
|
31
|
-
| [**update_rental_owner_request_task**](TasksApi.md#update_rental_owner_request_task) | **PUT** /v1/tasks/rentalownerrequests/{rentalOwnerRequestTaskId} | Update a rental owner request |
|
32
|
-
| [**update_resource**](TasksApi.md#update_resource) | **PUT** /v1/tasks/residentrequests/{residentRequestTaskId} | Update a resident request |
|
33
18
|
| [**update_task_category**](TasksApi.md#update_task_category) | **PUT** /v1/tasks/categories/{taskCategoryId} | Update a task category |
|
34
19
|
| [**update_task_history**](TasksApi.md#update_task_history) | **PUT** /v1/tasks/{taskId}/history/{taskHistoryId} | Update a task history |
|
35
|
-
| [**update_to_do_task**](TasksApi.md#update_to_do_task) | **PUT** /v1/tasks/todorequests/{toDoTaskId} | Update a to do task |
|
36
20
|
| [**upload_task_history_file_request_async**](TasksApi.md#upload_task_history_file_request_async) | **POST** /v1/tasks/{taskId}/history/{taskHistoryId}/files/uploadrequests | Upload a task history file |
|
37
21
|
|
38
22
|
|
39
|
-
##
|
40
|
-
|
41
|
-
> <ContactRequestTaskMessage> create_contact_request_task(contact_request_task_post_message)
|
42
|
-
|
43
|
-
Create a contact request
|
44
|
-
|
45
|
-
Creates a contact request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
46
|
-
|
47
|
-
### Examples
|
48
|
-
|
49
|
-
```ruby
|
50
|
-
require 'time'
|
51
|
-
require 'buildium-ruby'
|
52
|
-
# setup authorization
|
53
|
-
Buildium.configure do |config|
|
54
|
-
# Configure API key authorization: clientId
|
55
|
-
config.api_key['clientId'] = 'YOUR API KEY'
|
56
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
57
|
-
# config.api_key_prefix['clientId'] = 'Bearer'
|
58
|
-
|
59
|
-
# Configure API key authorization: clientSecret
|
60
|
-
config.api_key['clientSecret'] = 'YOUR API KEY'
|
61
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
62
|
-
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
63
|
-
end
|
64
|
-
|
65
|
-
api_instance = Buildium::TasksApi.new
|
66
|
-
contact_request_task_post_message = Buildium::ContactRequestTaskPostMessage.new({title: 'title_example', assigned_to_user_id: 37, task_status: 'New', priority: 'Low', contact_detail: Buildium::ContactDetailSaveMessage.new({first_name: 'first_name_example'})}) # ContactRequestTaskPostMessage |
|
67
|
-
|
68
|
-
begin
|
69
|
-
# Create a contact request
|
70
|
-
result = api_instance.create_contact_request_task(contact_request_task_post_message)
|
71
|
-
p result
|
72
|
-
rescue Buildium::ApiError => e
|
73
|
-
puts "Error when calling TasksApi->create_contact_request_task: #{e}"
|
74
|
-
end
|
75
|
-
```
|
76
|
-
|
77
|
-
#### Using the create_contact_request_task_with_http_info variant
|
78
|
-
|
79
|
-
This returns an Array which contains the response data, status code and headers.
|
80
|
-
|
81
|
-
> <Array(<ContactRequestTaskMessage>, Integer, Hash)> create_contact_request_task_with_http_info(contact_request_task_post_message)
|
82
|
-
|
83
|
-
```ruby
|
84
|
-
begin
|
85
|
-
# Create a contact request
|
86
|
-
data, status_code, headers = api_instance.create_contact_request_task_with_http_info(contact_request_task_post_message)
|
87
|
-
p status_code # => 2xx
|
88
|
-
p headers # => { ... }
|
89
|
-
p data # => <ContactRequestTaskMessage>
|
90
|
-
rescue Buildium::ApiError => e
|
91
|
-
puts "Error when calling TasksApi->create_contact_request_task_with_http_info: #{e}"
|
92
|
-
end
|
93
|
-
```
|
94
|
-
|
95
|
-
### Parameters
|
96
|
-
|
97
|
-
| Name | Type | Description | Notes |
|
98
|
-
| ---- | ---- | ----------- | ----- |
|
99
|
-
| **contact_request_task_post_message** | [**ContactRequestTaskPostMessage**](ContactRequestTaskPostMessage.md) | | |
|
100
|
-
|
101
|
-
### Return type
|
102
|
-
|
103
|
-
[**ContactRequestTaskMessage**](ContactRequestTaskMessage.md)
|
104
|
-
|
105
|
-
### Authorization
|
106
|
-
|
107
|
-
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
108
|
-
|
109
|
-
### HTTP request headers
|
110
|
-
|
111
|
-
- **Content-Type**: application/json
|
112
|
-
- **Accept**: application/json
|
113
|
-
|
114
|
-
|
115
|
-
## create_rental_owner_request_task
|
116
|
-
|
117
|
-
> <RentalOwnerRequestTaskMessage> create_rental_owner_request_task(rental_owner_request_task_post_message)
|
118
|
-
|
119
|
-
Create a rental owner request
|
120
|
-
|
121
|
-
Creates a rental owner request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
122
|
-
|
123
|
-
### Examples
|
124
|
-
|
125
|
-
```ruby
|
126
|
-
require 'time'
|
127
|
-
require 'buildium-ruby'
|
128
|
-
# setup authorization
|
129
|
-
Buildium.configure do |config|
|
130
|
-
# Configure API key authorization: clientId
|
131
|
-
config.api_key['clientId'] = 'YOUR API KEY'
|
132
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
133
|
-
# config.api_key_prefix['clientId'] = 'Bearer'
|
134
|
-
|
135
|
-
# Configure API key authorization: clientSecret
|
136
|
-
config.api_key['clientSecret'] = 'YOUR API KEY'
|
137
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
138
|
-
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
139
|
-
end
|
140
|
-
|
141
|
-
api_instance = Buildium::TasksApi.new
|
142
|
-
rental_owner_request_task_post_message = Buildium::RentalOwnerRequestTaskPostMessage.new({title: 'title_example', task_status: 'New', priority: 'Low', requested_by_rental_owner_id: 37}) # RentalOwnerRequestTaskPostMessage |
|
143
|
-
|
144
|
-
begin
|
145
|
-
# Create a rental owner request
|
146
|
-
result = api_instance.create_rental_owner_request_task(rental_owner_request_task_post_message)
|
147
|
-
p result
|
148
|
-
rescue Buildium::ApiError => e
|
149
|
-
puts "Error when calling TasksApi->create_rental_owner_request_task: #{e}"
|
150
|
-
end
|
151
|
-
```
|
152
|
-
|
153
|
-
#### Using the create_rental_owner_request_task_with_http_info variant
|
154
|
-
|
155
|
-
This returns an Array which contains the response data, status code and headers.
|
156
|
-
|
157
|
-
> <Array(<RentalOwnerRequestTaskMessage>, Integer, Hash)> create_rental_owner_request_task_with_http_info(rental_owner_request_task_post_message)
|
158
|
-
|
159
|
-
```ruby
|
160
|
-
begin
|
161
|
-
# Create a rental owner request
|
162
|
-
data, status_code, headers = api_instance.create_rental_owner_request_task_with_http_info(rental_owner_request_task_post_message)
|
163
|
-
p status_code # => 2xx
|
164
|
-
p headers # => { ... }
|
165
|
-
p data # => <RentalOwnerRequestTaskMessage>
|
166
|
-
rescue Buildium::ApiError => e
|
167
|
-
puts "Error when calling TasksApi->create_rental_owner_request_task_with_http_info: #{e}"
|
168
|
-
end
|
169
|
-
```
|
170
|
-
|
171
|
-
### Parameters
|
172
|
-
|
173
|
-
| Name | Type | Description | Notes |
|
174
|
-
| ---- | ---- | ----------- | ----- |
|
175
|
-
| **rental_owner_request_task_post_message** | [**RentalOwnerRequestTaskPostMessage**](RentalOwnerRequestTaskPostMessage.md) | | |
|
176
|
-
|
177
|
-
### Return type
|
178
|
-
|
179
|
-
[**RentalOwnerRequestTaskMessage**](RentalOwnerRequestTaskMessage.md)
|
180
|
-
|
181
|
-
### Authorization
|
182
|
-
|
183
|
-
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
184
|
-
|
185
|
-
### HTTP request headers
|
186
|
-
|
187
|
-
- **Content-Type**: application/json
|
188
|
-
- **Accept**: application/json
|
189
|
-
|
190
|
-
|
191
|
-
## create_resource
|
23
|
+
## create_task_category
|
192
24
|
|
193
|
-
> <
|
25
|
+
> <TaskCategoryMessage> create_task_category(task_category_save_message)
|
194
26
|
|
195
|
-
Create a
|
27
|
+
Create a task category
|
196
28
|
|
197
|
-
|
29
|
+
Create a task category. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
198
30
|
|
199
31
|
### Examples
|
200
32
|
|
@@ -215,32 +47,32 @@ Buildium.configure do |config|
|
|
215
47
|
end
|
216
48
|
|
217
49
|
api_instance = Buildium::TasksApi.new
|
218
|
-
|
50
|
+
task_category_save_message = Buildium::TaskCategorySaveMessage.new({name: 'name_example'}) # TaskCategorySaveMessage |
|
219
51
|
|
220
52
|
begin
|
221
|
-
# Create a
|
222
|
-
result = api_instance.
|
53
|
+
# Create a task category
|
54
|
+
result = api_instance.create_task_category(task_category_save_message)
|
223
55
|
p result
|
224
56
|
rescue Buildium::ApiError => e
|
225
|
-
puts "Error when calling TasksApi->
|
57
|
+
puts "Error when calling TasksApi->create_task_category: #{e}"
|
226
58
|
end
|
227
59
|
```
|
228
60
|
|
229
|
-
#### Using the
|
61
|
+
#### Using the create_task_category_with_http_info variant
|
230
62
|
|
231
63
|
This returns an Array which contains the response data, status code and headers.
|
232
64
|
|
233
|
-
> <Array(<
|
65
|
+
> <Array(<TaskCategoryMessage>, Integer, Hash)> create_task_category_with_http_info(task_category_save_message)
|
234
66
|
|
235
67
|
```ruby
|
236
68
|
begin
|
237
|
-
# Create a
|
238
|
-
data, status_code, headers = api_instance.
|
69
|
+
# Create a task category
|
70
|
+
data, status_code, headers = api_instance.create_task_category_with_http_info(task_category_save_message)
|
239
71
|
p status_code # => 2xx
|
240
72
|
p headers # => { ... }
|
241
|
-
p data # => <
|
73
|
+
p data # => <TaskCategoryMessage>
|
242
74
|
rescue Buildium::ApiError => e
|
243
|
-
puts "Error when calling TasksApi->
|
75
|
+
puts "Error when calling TasksApi->create_task_category_with_http_info: #{e}"
|
244
76
|
end
|
245
77
|
```
|
246
78
|
|
@@ -248,11 +80,11 @@ end
|
|
248
80
|
|
249
81
|
| Name | Type | Description | Notes |
|
250
82
|
| ---- | ---- | ----------- | ----- |
|
251
|
-
| **
|
83
|
+
| **task_category_save_message** | [**TaskCategorySaveMessage**](TaskCategorySaveMessage.md) | | |
|
252
84
|
|
253
85
|
### Return type
|
254
86
|
|
255
|
-
[**
|
87
|
+
[**TaskCategoryMessage**](TaskCategoryMessage.md)
|
256
88
|
|
257
89
|
### Authorization
|
258
90
|
|
@@ -264,13 +96,13 @@ end
|
|
264
96
|
- **Accept**: application/json
|
265
97
|
|
266
98
|
|
267
|
-
##
|
99
|
+
## delete_task_history_file
|
268
100
|
|
269
|
-
>
|
101
|
+
> delete_task_history_file(task_id, task_history_id, file_id)
|
270
102
|
|
271
|
-
|
103
|
+
Delete task history file
|
272
104
|
|
273
|
-
|
105
|
+
Deletes a specific file from a task history record. The file will be permanently deleted from the Buildium platform an can not be recovered. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit` `Delete`
|
274
106
|
|
275
107
|
### Examples
|
276
108
|
|
@@ -291,32 +123,33 @@ Buildium.configure do |config|
|
|
291
123
|
end
|
292
124
|
|
293
125
|
api_instance = Buildium::TasksApi.new
|
294
|
-
|
126
|
+
task_id = 56 # Integer |
|
127
|
+
task_history_id = 56 # Integer |
|
128
|
+
file_id = 56 # Integer |
|
295
129
|
|
296
130
|
begin
|
297
|
-
#
|
298
|
-
|
299
|
-
p result
|
131
|
+
# Delete task history file
|
132
|
+
api_instance.delete_task_history_file(task_id, task_history_id, file_id)
|
300
133
|
rescue Buildium::ApiError => e
|
301
|
-
puts "Error when calling TasksApi->
|
134
|
+
puts "Error when calling TasksApi->delete_task_history_file: #{e}"
|
302
135
|
end
|
303
136
|
```
|
304
137
|
|
305
|
-
#### Using the
|
138
|
+
#### Using the delete_task_history_file_with_http_info variant
|
306
139
|
|
307
|
-
This returns an Array which contains the response data, status code and headers.
|
140
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
308
141
|
|
309
|
-
> <Array(
|
142
|
+
> <Array(nil, Integer, Hash)> delete_task_history_file_with_http_info(task_id, task_history_id, file_id)
|
310
143
|
|
311
144
|
```ruby
|
312
145
|
begin
|
313
|
-
#
|
314
|
-
data, status_code, headers = api_instance.
|
146
|
+
# Delete task history file
|
147
|
+
data, status_code, headers = api_instance.delete_task_history_file_with_http_info(task_id, task_history_id, file_id)
|
315
148
|
p status_code # => 2xx
|
316
149
|
p headers # => { ... }
|
317
|
-
p data # =>
|
150
|
+
p data # => nil
|
318
151
|
rescue Buildium::ApiError => e
|
319
|
-
puts "Error when calling TasksApi->
|
152
|
+
puts "Error when calling TasksApi->delete_task_history_file_with_http_info: #{e}"
|
320
153
|
end
|
321
154
|
```
|
322
155
|
|
@@ -324,11 +157,13 @@ end
|
|
324
157
|
|
325
158
|
| Name | Type | Description | Notes |
|
326
159
|
| ---- | ---- | ----------- | ----- |
|
327
|
-
| **
|
160
|
+
| **task_id** | **Integer** | | |
|
161
|
+
| **task_history_id** | **Integer** | | |
|
162
|
+
| **file_id** | **Integer** | | |
|
328
163
|
|
329
164
|
### Return type
|
330
165
|
|
331
|
-
|
166
|
+
nil (empty response body)
|
332
167
|
|
333
168
|
### Authorization
|
334
169
|
|
@@ -336,17 +171,17 @@ end
|
|
336
171
|
|
337
172
|
### HTTP request headers
|
338
173
|
|
339
|
-
- **Content-Type**:
|
174
|
+
- **Content-Type**: Not defined
|
340
175
|
- **Accept**: application/json
|
341
176
|
|
342
177
|
|
343
|
-
##
|
178
|
+
## get_all_task_categories
|
344
179
|
|
345
|
-
> <
|
180
|
+
> <Array<TaskCategoryMessage>> get_all_task_categories(opts)
|
346
181
|
|
347
|
-
|
182
|
+
Retrieve all task categories
|
348
183
|
|
349
|
-
|
184
|
+
Retrieves a list of task categories. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
350
185
|
|
351
186
|
### Examples
|
352
187
|
|
@@ -367,32 +202,36 @@ Buildium.configure do |config|
|
|
367
202
|
end
|
368
203
|
|
369
204
|
api_instance = Buildium::TasksApi.new
|
370
|
-
|
205
|
+
opts = {
|
206
|
+
orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
|
207
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
208
|
+
limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
|
209
|
+
}
|
371
210
|
|
372
211
|
begin
|
373
|
-
#
|
374
|
-
result = api_instance.
|
212
|
+
# Retrieve all task categories
|
213
|
+
result = api_instance.get_all_task_categories(opts)
|
375
214
|
p result
|
376
215
|
rescue Buildium::ApiError => e
|
377
|
-
puts "Error when calling TasksApi->
|
216
|
+
puts "Error when calling TasksApi->get_all_task_categories: #{e}"
|
378
217
|
end
|
379
218
|
```
|
380
219
|
|
381
|
-
#### Using the
|
220
|
+
#### Using the get_all_task_categories_with_http_info variant
|
382
221
|
|
383
222
|
This returns an Array which contains the response data, status code and headers.
|
384
223
|
|
385
|
-
> <Array(<
|
224
|
+
> <Array(<Array<TaskCategoryMessage>>, Integer, Hash)> get_all_task_categories_with_http_info(opts)
|
386
225
|
|
387
226
|
```ruby
|
388
227
|
begin
|
389
|
-
#
|
390
|
-
data, status_code, headers = api_instance.
|
228
|
+
# Retrieve all task categories
|
229
|
+
data, status_code, headers = api_instance.get_all_task_categories_with_http_info(opts)
|
391
230
|
p status_code # => 2xx
|
392
231
|
p headers # => { ... }
|
393
|
-
p data # => <
|
232
|
+
p data # => <Array<TaskCategoryMessage>>
|
394
233
|
rescue Buildium::ApiError => e
|
395
|
-
puts "Error when calling TasksApi->
|
234
|
+
puts "Error when calling TasksApi->get_all_task_categories_with_http_info: #{e}"
|
396
235
|
end
|
397
236
|
```
|
398
237
|
|
@@ -400,11 +239,13 @@ end
|
|
400
239
|
|
401
240
|
| Name | Type | Description | Notes |
|
402
241
|
| ---- | ---- | ----------- | ----- |
|
403
|
-
| **
|
242
|
+
| **orderby** | **String** | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. | [optional] |
|
243
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
244
|
+
| **limit** | **Integer** | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. | [optional] |
|
404
245
|
|
405
246
|
### Return type
|
406
247
|
|
407
|
-
[**
|
248
|
+
[**Array<TaskCategoryMessage>**](TaskCategoryMessage.md)
|
408
249
|
|
409
250
|
### Authorization
|
410
251
|
|
@@ -412,17 +253,17 @@ end
|
|
412
253
|
|
413
254
|
### HTTP request headers
|
414
255
|
|
415
|
-
- **Content-Type**:
|
256
|
+
- **Content-Type**: Not defined
|
416
257
|
- **Accept**: application/json
|
417
258
|
|
418
259
|
|
419
|
-
##
|
260
|
+
## get_all_task_history_files
|
420
261
|
|
421
|
-
>
|
262
|
+
> <Array<TaskHistoryFileMessage>> get_all_task_history_files(task_id, task_history_id, opts)
|
422
263
|
|
423
|
-
|
264
|
+
Retrieve all task history files
|
424
265
|
|
425
|
-
|
266
|
+
Retrieves the metadata for all files associated with a task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
426
267
|
|
427
268
|
### Examples
|
428
269
|
|
@@ -445,31 +286,36 @@ end
|
|
445
286
|
api_instance = Buildium::TasksApi.new
|
446
287
|
task_id = 56 # Integer |
|
447
288
|
task_history_id = 56 # Integer |
|
448
|
-
|
289
|
+
opts = {
|
290
|
+
orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
|
291
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
292
|
+
limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
|
293
|
+
}
|
449
294
|
|
450
295
|
begin
|
451
|
-
#
|
452
|
-
api_instance.
|
296
|
+
# Retrieve all task history files
|
297
|
+
result = api_instance.get_all_task_history_files(task_id, task_history_id, opts)
|
298
|
+
p result
|
453
299
|
rescue Buildium::ApiError => e
|
454
|
-
puts "Error when calling TasksApi->
|
300
|
+
puts "Error when calling TasksApi->get_all_task_history_files: #{e}"
|
455
301
|
end
|
456
302
|
```
|
457
303
|
|
458
|
-
#### Using the
|
304
|
+
#### Using the get_all_task_history_files_with_http_info variant
|
459
305
|
|
460
|
-
This returns an Array which contains the response data
|
306
|
+
This returns an Array which contains the response data, status code and headers.
|
461
307
|
|
462
|
-
> <Array(
|
308
|
+
> <Array(<Array<TaskHistoryFileMessage>>, Integer, Hash)> get_all_task_history_files_with_http_info(task_id, task_history_id, opts)
|
463
309
|
|
464
310
|
```ruby
|
465
311
|
begin
|
466
|
-
#
|
467
|
-
data, status_code, headers = api_instance.
|
312
|
+
# Retrieve all task history files
|
313
|
+
data, status_code, headers = api_instance.get_all_task_history_files_with_http_info(task_id, task_history_id, opts)
|
468
314
|
p status_code # => 2xx
|
469
315
|
p headers # => { ... }
|
470
|
-
p data # =>
|
316
|
+
p data # => <Array<TaskHistoryFileMessage>>
|
471
317
|
rescue Buildium::ApiError => e
|
472
|
-
puts "Error when calling TasksApi->
|
318
|
+
puts "Error when calling TasksApi->get_all_task_history_files_with_http_info: #{e}"
|
473
319
|
end
|
474
320
|
```
|
475
321
|
|
@@ -479,11 +325,13 @@ end
|
|
479
325
|
| ---- | ---- | ----------- | ----- |
|
480
326
|
| **task_id** | **Integer** | | |
|
481
327
|
| **task_history_id** | **Integer** | | |
|
482
|
-
| **
|
328
|
+
| **orderby** | **String** | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. | [optional] |
|
329
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
330
|
+
| **limit** | **Integer** | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. | [optional] |
|
483
331
|
|
484
332
|
### Return type
|
485
333
|
|
486
|
-
|
334
|
+
[**Array<TaskHistoryFileMessage>**](TaskHistoryFileMessage.md)
|
487
335
|
|
488
336
|
### Authorization
|
489
337
|
|
@@ -495,13 +343,13 @@ nil (empty response body)
|
|
495
343
|
- **Accept**: application/json
|
496
344
|
|
497
345
|
|
498
|
-
##
|
346
|
+
## get_all_tasks
|
499
347
|
|
500
|
-
> <Array<
|
348
|
+
> <Array<AllTasksMessage>> get_all_tasks(opts)
|
501
349
|
|
502
|
-
Retrieve all
|
350
|
+
Retrieve all tasks
|
503
351
|
|
504
|
-
Retrieves all
|
352
|
+
Retrieves a list of all task/request types (Contact, Owner, Resident and To Do). Note, the response payload only contains fields common across all of the request types. To retrieve the full details of the task query the retrieve endpoint specific to the task type. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
505
353
|
|
506
354
|
### Examples
|
507
355
|
|
@@ -526,7 +374,9 @@ opts = {
|
|
526
374
|
entitytype: 'Rental', # String | Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated.
|
527
375
|
entityid: 56, # Integer | Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field.
|
528
376
|
statuses: ['New'], # Array<String> | Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
|
377
|
+
type: 'ContactRequest', # String | Filters results to any task associated with the task type specified.
|
529
378
|
unitid: 56, # Integer | Filters results to any task associated with the unit identifier.
|
379
|
+
unitagreementid: 56, # Integer | Filters results to any task associated with the unit agreement identifier specified.
|
530
380
|
lastupdatedfrom: Date.parse('2013-10-20'), # Date | Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
531
381
|
lastupdatedto: Date.parse('2013-10-20'), # Date | Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
532
382
|
duedatefrom: Date.parse('2013-10-20'), # Date | Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
@@ -541,1156 +391,29 @@ opts = {
|
|
541
391
|
}
|
542
392
|
|
543
393
|
begin
|
544
|
-
# Retrieve all
|
545
|
-
result = api_instance.
|
546
|
-
p result
|
547
|
-
rescue Buildium::ApiError => e
|
548
|
-
puts "Error when calling TasksApi->get_all_rental_owner_request_tasks: #{e}"
|
549
|
-
end
|
550
|
-
```
|
551
|
-
|
552
|
-
#### Using the get_all_rental_owner_request_tasks_with_http_info variant
|
553
|
-
|
554
|
-
This returns an Array which contains the response data, status code and headers.
|
555
|
-
|
556
|
-
> <Array(<Array<RentalOwnerRequestTaskMessage>>, Integer, Hash)> get_all_rental_owner_request_tasks_with_http_info(opts)
|
557
|
-
|
558
|
-
```ruby
|
559
|
-
begin
|
560
|
-
# Retrieve all rental owner requests
|
561
|
-
data, status_code, headers = api_instance.get_all_rental_owner_request_tasks_with_http_info(opts)
|
562
|
-
p status_code # => 2xx
|
563
|
-
p headers # => { ... }
|
564
|
-
p data # => <Array<RentalOwnerRequestTaskMessage>>
|
565
|
-
rescue Buildium::ApiError => e
|
566
|
-
puts "Error when calling TasksApi->get_all_rental_owner_request_tasks_with_http_info: #{e}"
|
567
|
-
end
|
568
|
-
```
|
569
|
-
|
570
|
-
### Parameters
|
571
|
-
|
572
|
-
| Name | Type | Description | Notes |
|
573
|
-
| ---- | ---- | ----------- | ----- |
|
574
|
-
| **entitytype** | **String** | Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated. | [optional] |
|
575
|
-
| **entityid** | **Integer** | Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field. | [optional] |
|
576
|
-
| **statuses** | [**Array<String>**](String.md) | Filters results by the status of the task. If no status is specified, tasks with any status will be returned. | [optional] |
|
577
|
-
| **unitid** | **Integer** | Filters results to any task associated with the unit identifier. | [optional] |
|
578
|
-
| **lastupdatedfrom** | **Date** | Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
579
|
-
| **lastupdatedto** | **Date** | Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
580
|
-
| **duedatefrom** | **Date** | Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
581
|
-
| **duedateto** | **Date** | Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
582
|
-
| **taskcategoryid** | **Integer** | Filters results to any tasks with the specified category identifier. | [optional] |
|
583
|
-
| **priorities** | [**Array<String>**](String.md) | Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned. | [optional] |
|
584
|
-
| **assignedtoid** | **Integer** | Filters results to any tasks that have been assigned to the specified staff user identifier. | [optional] |
|
585
|
-
| **tasktitle** | **String** | Filters results to any task whose title *contains* the specified value. | [optional] |
|
586
|
-
| **orderby** | **String** | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. | [optional] |
|
587
|
-
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
588
|
-
| **limit** | **Integer** | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. | [optional] |
|
589
|
-
|
590
|
-
### Return type
|
591
|
-
|
592
|
-
[**Array<RentalOwnerRequestTaskMessage>**](RentalOwnerRequestTaskMessage.md)
|
593
|
-
|
594
|
-
### Authorization
|
595
|
-
|
596
|
-
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
597
|
-
|
598
|
-
### HTTP request headers
|
599
|
-
|
600
|
-
- **Content-Type**: Not defined
|
601
|
-
- **Accept**: application/json
|
602
|
-
|
603
|
-
|
604
|
-
## get_all_task_categories
|
605
|
-
|
606
|
-
> <Array<TaskCategoryMessage>> get_all_task_categories(opts)
|
607
|
-
|
608
|
-
Retrieve all task categories
|
609
|
-
|
610
|
-
Retrieves a list of task categories. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
611
|
-
|
612
|
-
### Examples
|
613
|
-
|
614
|
-
```ruby
|
615
|
-
require 'time'
|
616
|
-
require 'buildium-ruby'
|
617
|
-
# setup authorization
|
618
|
-
Buildium.configure do |config|
|
619
|
-
# Configure API key authorization: clientId
|
620
|
-
config.api_key['clientId'] = 'YOUR API KEY'
|
621
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
622
|
-
# config.api_key_prefix['clientId'] = 'Bearer'
|
623
|
-
|
624
|
-
# Configure API key authorization: clientSecret
|
625
|
-
config.api_key['clientSecret'] = 'YOUR API KEY'
|
626
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
627
|
-
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
628
|
-
end
|
629
|
-
|
630
|
-
api_instance = Buildium::TasksApi.new
|
631
|
-
opts = {
|
632
|
-
orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
|
633
|
-
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
634
|
-
limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
|
635
|
-
}
|
636
|
-
|
637
|
-
begin
|
638
|
-
# Retrieve all task categories
|
639
|
-
result = api_instance.get_all_task_categories(opts)
|
640
|
-
p result
|
641
|
-
rescue Buildium::ApiError => e
|
642
|
-
puts "Error when calling TasksApi->get_all_task_categories: #{e}"
|
643
|
-
end
|
644
|
-
```
|
645
|
-
|
646
|
-
#### Using the get_all_task_categories_with_http_info variant
|
647
|
-
|
648
|
-
This returns an Array which contains the response data, status code and headers.
|
649
|
-
|
650
|
-
> <Array(<Array<TaskCategoryMessage>>, Integer, Hash)> get_all_task_categories_with_http_info(opts)
|
651
|
-
|
652
|
-
```ruby
|
653
|
-
begin
|
654
|
-
# Retrieve all task categories
|
655
|
-
data, status_code, headers = api_instance.get_all_task_categories_with_http_info(opts)
|
656
|
-
p status_code # => 2xx
|
657
|
-
p headers # => { ... }
|
658
|
-
p data # => <Array<TaskCategoryMessage>>
|
659
|
-
rescue Buildium::ApiError => e
|
660
|
-
puts "Error when calling TasksApi->get_all_task_categories_with_http_info: #{e}"
|
661
|
-
end
|
662
|
-
```
|
663
|
-
|
664
|
-
### Parameters
|
665
|
-
|
666
|
-
| Name | Type | Description | Notes |
|
667
|
-
| ---- | ---- | ----------- | ----- |
|
668
|
-
| **orderby** | **String** | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. | [optional] |
|
669
|
-
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
670
|
-
| **limit** | **Integer** | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. | [optional] |
|
671
|
-
|
672
|
-
### Return type
|
673
|
-
|
674
|
-
[**Array<TaskCategoryMessage>**](TaskCategoryMessage.md)
|
675
|
-
|
676
|
-
### Authorization
|
677
|
-
|
678
|
-
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
679
|
-
|
680
|
-
### HTTP request headers
|
681
|
-
|
682
|
-
- **Content-Type**: Not defined
|
683
|
-
- **Accept**: application/json
|
684
|
-
|
685
|
-
|
686
|
-
## get_all_task_history_files
|
687
|
-
|
688
|
-
> <Array<TaskHistoryFileMessage>> get_all_task_history_files(task_id, task_history_id, opts)
|
689
|
-
|
690
|
-
Retrieve all task history files
|
691
|
-
|
692
|
-
Retrieves the metadata for all files associated with a task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
693
|
-
|
694
|
-
### Examples
|
695
|
-
|
696
|
-
```ruby
|
697
|
-
require 'time'
|
698
|
-
require 'buildium-ruby'
|
699
|
-
# setup authorization
|
700
|
-
Buildium.configure do |config|
|
701
|
-
# Configure API key authorization: clientId
|
702
|
-
config.api_key['clientId'] = 'YOUR API KEY'
|
703
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
704
|
-
# config.api_key_prefix['clientId'] = 'Bearer'
|
705
|
-
|
706
|
-
# Configure API key authorization: clientSecret
|
707
|
-
config.api_key['clientSecret'] = 'YOUR API KEY'
|
708
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
709
|
-
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
710
|
-
end
|
711
|
-
|
712
|
-
api_instance = Buildium::TasksApi.new
|
713
|
-
task_id = 56 # Integer |
|
714
|
-
task_history_id = 56 # Integer |
|
715
|
-
opts = {
|
716
|
-
orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
|
717
|
-
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
718
|
-
limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
|
719
|
-
}
|
720
|
-
|
721
|
-
begin
|
722
|
-
# Retrieve all task history files
|
723
|
-
result = api_instance.get_all_task_history_files(task_id, task_history_id, opts)
|
724
|
-
p result
|
725
|
-
rescue Buildium::ApiError => e
|
726
|
-
puts "Error when calling TasksApi->get_all_task_history_files: #{e}"
|
727
|
-
end
|
728
|
-
```
|
729
|
-
|
730
|
-
#### Using the get_all_task_history_files_with_http_info variant
|
731
|
-
|
732
|
-
This returns an Array which contains the response data, status code and headers.
|
733
|
-
|
734
|
-
> <Array(<Array<TaskHistoryFileMessage>>, Integer, Hash)> get_all_task_history_files_with_http_info(task_id, task_history_id, opts)
|
735
|
-
|
736
|
-
```ruby
|
737
|
-
begin
|
738
|
-
# Retrieve all task history files
|
739
|
-
data, status_code, headers = api_instance.get_all_task_history_files_with_http_info(task_id, task_history_id, opts)
|
740
|
-
p status_code # => 2xx
|
741
|
-
p headers # => { ... }
|
742
|
-
p data # => <Array<TaskHistoryFileMessage>>
|
743
|
-
rescue Buildium::ApiError => e
|
744
|
-
puts "Error when calling TasksApi->get_all_task_history_files_with_http_info: #{e}"
|
745
|
-
end
|
746
|
-
```
|
747
|
-
|
748
|
-
### Parameters
|
749
|
-
|
750
|
-
| Name | Type | Description | Notes |
|
751
|
-
| ---- | ---- | ----------- | ----- |
|
752
|
-
| **task_id** | **Integer** | | |
|
753
|
-
| **task_history_id** | **Integer** | | |
|
754
|
-
| **orderby** | **String** | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. | [optional] |
|
755
|
-
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
756
|
-
| **limit** | **Integer** | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. | [optional] |
|
757
|
-
|
758
|
-
### Return type
|
759
|
-
|
760
|
-
[**Array<TaskHistoryFileMessage>**](TaskHistoryFileMessage.md)
|
761
|
-
|
762
|
-
### Authorization
|
763
|
-
|
764
|
-
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
765
|
-
|
766
|
-
### HTTP request headers
|
767
|
-
|
768
|
-
- **Content-Type**: Not defined
|
769
|
-
- **Accept**: application/json
|
770
|
-
|
771
|
-
|
772
|
-
## get_all_tasks
|
773
|
-
|
774
|
-
> <Array<AllTasksMessage>> get_all_tasks(opts)
|
775
|
-
|
776
|
-
Retrieve all tasks
|
777
|
-
|
778
|
-
Retrieves a list of tasks. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
779
|
-
|
780
|
-
### Examples
|
781
|
-
|
782
|
-
```ruby
|
783
|
-
require 'time'
|
784
|
-
require 'buildium-ruby'
|
785
|
-
# setup authorization
|
786
|
-
Buildium.configure do |config|
|
787
|
-
# Configure API key authorization: clientId
|
788
|
-
config.api_key['clientId'] = 'YOUR API KEY'
|
789
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
790
|
-
# config.api_key_prefix['clientId'] = 'Bearer'
|
791
|
-
|
792
|
-
# Configure API key authorization: clientSecret
|
793
|
-
config.api_key['clientSecret'] = 'YOUR API KEY'
|
794
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
795
|
-
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
796
|
-
end
|
797
|
-
|
798
|
-
api_instance = Buildium::TasksApi.new
|
799
|
-
opts = {
|
800
|
-
entitytype: 'Rental', # String | Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated.
|
801
|
-
entityid: 56, # Integer | Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field.
|
802
|
-
statuses: ['New'], # Array<String> | Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
|
803
|
-
type: 'ContactRequest', # String | Filters results to any task associated with the task type specified.
|
804
|
-
unitid: 56, # Integer | Filters results to any task associated with the unit identifier.
|
805
|
-
unitagreementid: 56, # Integer | Filters results to any task associated with the unit agreement identifier specified.
|
806
|
-
lastupdatedfrom: Date.parse('2013-10-20'), # Date | Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
807
|
-
lastupdatedto: Date.parse('2013-10-20'), # Date | Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
808
|
-
duedatefrom: Date.parse('2013-10-20'), # Date | Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
809
|
-
duedateto: Date.parse('2013-10-20'), # Date | Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
810
|
-
taskcategoryid: 56, # Integer | Filters results to any tasks with the specified category identifier.
|
811
|
-
priorities: ['Low'], # Array<String> | Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
|
812
|
-
assignedtoid: 56, # Integer | Filters results to any tasks that have been assigned to the specified staff user identifier.
|
813
|
-
tasktitle: 'tasktitle_example', # String | Filters results to any task whose title *contains* the specified value.
|
814
|
-
orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
|
815
|
-
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
816
|
-
limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
|
817
|
-
}
|
818
|
-
|
819
|
-
begin
|
820
|
-
# Retrieve all tasks
|
821
|
-
result = api_instance.get_all_tasks(opts)
|
822
|
-
p result
|
823
|
-
rescue Buildium::ApiError => e
|
824
|
-
puts "Error when calling TasksApi->get_all_tasks: #{e}"
|
825
|
-
end
|
826
|
-
```
|
827
|
-
|
828
|
-
#### Using the get_all_tasks_with_http_info variant
|
829
|
-
|
830
|
-
This returns an Array which contains the response data, status code and headers.
|
831
|
-
|
832
|
-
> <Array(<Array<AllTasksMessage>>, Integer, Hash)> get_all_tasks_with_http_info(opts)
|
833
|
-
|
834
|
-
```ruby
|
835
|
-
begin
|
836
|
-
# Retrieve all tasks
|
837
|
-
data, status_code, headers = api_instance.get_all_tasks_with_http_info(opts)
|
838
|
-
p status_code # => 2xx
|
839
|
-
p headers # => { ... }
|
840
|
-
p data # => <Array<AllTasksMessage>>
|
841
|
-
rescue Buildium::ApiError => e
|
842
|
-
puts "Error when calling TasksApi->get_all_tasks_with_http_info: #{e}"
|
843
|
-
end
|
844
|
-
```
|
845
|
-
|
846
|
-
### Parameters
|
847
|
-
|
848
|
-
| Name | Type | Description | Notes |
|
849
|
-
| ---- | ---- | ----------- | ----- |
|
850
|
-
| **entitytype** | **String** | Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated. | [optional] |
|
851
|
-
| **entityid** | **Integer** | Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field. | [optional] |
|
852
|
-
| **statuses** | [**Array<String>**](String.md) | Filters results by the status of the task. If no status is specified, tasks with any status will be returned. | [optional] |
|
853
|
-
| **type** | **String** | Filters results to any task associated with the task type specified. | [optional] |
|
854
|
-
| **unitid** | **Integer** | Filters results to any task associated with the unit identifier. | [optional] |
|
855
|
-
| **unitagreementid** | **Integer** | Filters results to any task associated with the unit agreement identifier specified. | [optional] |
|
856
|
-
| **lastupdatedfrom** | **Date** | Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
857
|
-
| **lastupdatedto** | **Date** | Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
858
|
-
| **duedatefrom** | **Date** | Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
859
|
-
| **duedateto** | **Date** | Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
860
|
-
| **taskcategoryid** | **Integer** | Filters results to any tasks with the specified category identifier. | [optional] |
|
861
|
-
| **priorities** | [**Array<String>**](String.md) | Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned. | [optional] |
|
862
|
-
| **assignedtoid** | **Integer** | Filters results to any tasks that have been assigned to the specified staff user identifier. | [optional] |
|
863
|
-
| **tasktitle** | **String** | Filters results to any task whose title *contains* the specified value. | [optional] |
|
864
|
-
| **orderby** | **String** | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. | [optional] |
|
865
|
-
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
866
|
-
| **limit** | **Integer** | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. | [optional] |
|
867
|
-
|
868
|
-
### Return type
|
869
|
-
|
870
|
-
[**Array<AllTasksMessage>**](AllTasksMessage.md)
|
871
|
-
|
872
|
-
### Authorization
|
873
|
-
|
874
|
-
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
875
|
-
|
876
|
-
### HTTP request headers
|
877
|
-
|
878
|
-
- **Content-Type**: Not defined
|
879
|
-
- **Accept**: application/json
|
880
|
-
|
881
|
-
|
882
|
-
## get_contact_request_task_by_id
|
883
|
-
|
884
|
-
> <ContactRequestTaskMessage> get_contact_request_task_by_id(contact_request_task_id)
|
885
|
-
|
886
|
-
Retrieve a contact request
|
887
|
-
|
888
|
-
Retrieves a contact request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
889
|
-
|
890
|
-
### Examples
|
891
|
-
|
892
|
-
```ruby
|
893
|
-
require 'time'
|
894
|
-
require 'buildium-ruby'
|
895
|
-
# setup authorization
|
896
|
-
Buildium.configure do |config|
|
897
|
-
# Configure API key authorization: clientId
|
898
|
-
config.api_key['clientId'] = 'YOUR API KEY'
|
899
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
900
|
-
# config.api_key_prefix['clientId'] = 'Bearer'
|
901
|
-
|
902
|
-
# Configure API key authorization: clientSecret
|
903
|
-
config.api_key['clientSecret'] = 'YOUR API KEY'
|
904
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
905
|
-
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
906
|
-
end
|
907
|
-
|
908
|
-
api_instance = Buildium::TasksApi.new
|
909
|
-
contact_request_task_id = 56 # Integer | The contact request identifier.
|
910
|
-
|
911
|
-
begin
|
912
|
-
# Retrieve a contact request
|
913
|
-
result = api_instance.get_contact_request_task_by_id(contact_request_task_id)
|
914
|
-
p result
|
915
|
-
rescue Buildium::ApiError => e
|
916
|
-
puts "Error when calling TasksApi->get_contact_request_task_by_id: #{e}"
|
917
|
-
end
|
918
|
-
```
|
919
|
-
|
920
|
-
#### Using the get_contact_request_task_by_id_with_http_info variant
|
921
|
-
|
922
|
-
This returns an Array which contains the response data, status code and headers.
|
923
|
-
|
924
|
-
> <Array(<ContactRequestTaskMessage>, Integer, Hash)> get_contact_request_task_by_id_with_http_info(contact_request_task_id)
|
925
|
-
|
926
|
-
```ruby
|
927
|
-
begin
|
928
|
-
# Retrieve a contact request
|
929
|
-
data, status_code, headers = api_instance.get_contact_request_task_by_id_with_http_info(contact_request_task_id)
|
930
|
-
p status_code # => 2xx
|
931
|
-
p headers # => { ... }
|
932
|
-
p data # => <ContactRequestTaskMessage>
|
933
|
-
rescue Buildium::ApiError => e
|
934
|
-
puts "Error when calling TasksApi->get_contact_request_task_by_id_with_http_info: #{e}"
|
935
|
-
end
|
936
|
-
```
|
937
|
-
|
938
|
-
### Parameters
|
939
|
-
|
940
|
-
| Name | Type | Description | Notes |
|
941
|
-
| ---- | ---- | ----------- | ----- |
|
942
|
-
| **contact_request_task_id** | **Integer** | The contact request identifier. | |
|
943
|
-
|
944
|
-
### Return type
|
945
|
-
|
946
|
-
[**ContactRequestTaskMessage**](ContactRequestTaskMessage.md)
|
947
|
-
|
948
|
-
### Authorization
|
949
|
-
|
950
|
-
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
951
|
-
|
952
|
-
### HTTP request headers
|
953
|
-
|
954
|
-
- **Content-Type**: Not defined
|
955
|
-
- **Accept**: application/json
|
956
|
-
|
957
|
-
|
958
|
-
## get_contact_request_tasks
|
959
|
-
|
960
|
-
> <Array<ContactRequestTaskMessage>> get_contact_request_tasks(opts)
|
961
|
-
|
962
|
-
Retrieve all contact requests
|
963
|
-
|
964
|
-
Retrieves a list of contact requests. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
965
|
-
|
966
|
-
### Examples
|
967
|
-
|
968
|
-
```ruby
|
969
|
-
require 'time'
|
970
|
-
require 'buildium-ruby'
|
971
|
-
# setup authorization
|
972
|
-
Buildium.configure do |config|
|
973
|
-
# Configure API key authorization: clientId
|
974
|
-
config.api_key['clientId'] = 'YOUR API KEY'
|
975
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
976
|
-
# config.api_key_prefix['clientId'] = 'Bearer'
|
977
|
-
|
978
|
-
# Configure API key authorization: clientSecret
|
979
|
-
config.api_key['clientSecret'] = 'YOUR API KEY'
|
980
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
981
|
-
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
982
|
-
end
|
983
|
-
|
984
|
-
api_instance = Buildium::TasksApi.new
|
985
|
-
opts = {
|
986
|
-
entitytype: 'Rental', # String | Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated.
|
987
|
-
entityid: 56, # Integer | Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field.
|
988
|
-
statuses: ['New'], # Array<String> | Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
|
989
|
-
unitid: 56, # Integer | Filters results to any task associated with the unit identifier.
|
990
|
-
lastupdatedfrom: Date.parse('2013-10-20'), # Date | Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
991
|
-
lastupdatedto: Date.parse('2013-10-20'), # Date | Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
992
|
-
duedatefrom: Date.parse('2013-10-20'), # Date | Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
993
|
-
duedateto: Date.parse('2013-10-20'), # Date | Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
994
|
-
taskcategoryid: 56, # Integer | Filters results to any tasks with the specified category identifier.
|
995
|
-
priorities: ['Low'], # Array<String> | Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
|
996
|
-
assignedtoid: 56, # Integer | Filters results to any tasks that have been assigned to the specified staff user identifier.
|
997
|
-
tasktitle: 'tasktitle_example', # String | Filters results to any task whose title *contains* the specified value.
|
998
|
-
orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
|
999
|
-
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
1000
|
-
limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
|
1001
|
-
}
|
1002
|
-
|
1003
|
-
begin
|
1004
|
-
# Retrieve all contact requests
|
1005
|
-
result = api_instance.get_contact_request_tasks(opts)
|
1006
|
-
p result
|
1007
|
-
rescue Buildium::ApiError => e
|
1008
|
-
puts "Error when calling TasksApi->get_contact_request_tasks: #{e}"
|
1009
|
-
end
|
1010
|
-
```
|
1011
|
-
|
1012
|
-
#### Using the get_contact_request_tasks_with_http_info variant
|
1013
|
-
|
1014
|
-
This returns an Array which contains the response data, status code and headers.
|
1015
|
-
|
1016
|
-
> <Array(<Array<ContactRequestTaskMessage>>, Integer, Hash)> get_contact_request_tasks_with_http_info(opts)
|
1017
|
-
|
1018
|
-
```ruby
|
1019
|
-
begin
|
1020
|
-
# Retrieve all contact requests
|
1021
|
-
data, status_code, headers = api_instance.get_contact_request_tasks_with_http_info(opts)
|
1022
|
-
p status_code # => 2xx
|
1023
|
-
p headers # => { ... }
|
1024
|
-
p data # => <Array<ContactRequestTaskMessage>>
|
1025
|
-
rescue Buildium::ApiError => e
|
1026
|
-
puts "Error when calling TasksApi->get_contact_request_tasks_with_http_info: #{e}"
|
1027
|
-
end
|
1028
|
-
```
|
1029
|
-
|
1030
|
-
### Parameters
|
1031
|
-
|
1032
|
-
| Name | Type | Description | Notes |
|
1033
|
-
| ---- | ---- | ----------- | ----- |
|
1034
|
-
| **entitytype** | **String** | Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated. | [optional] |
|
1035
|
-
| **entityid** | **Integer** | Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field. | [optional] |
|
1036
|
-
| **statuses** | [**Array<String>**](String.md) | Filters results by the status of the task. If no status is specified, tasks with any status will be returned. | [optional] |
|
1037
|
-
| **unitid** | **Integer** | Filters results to any task associated with the unit identifier. | [optional] |
|
1038
|
-
| **lastupdatedfrom** | **Date** | Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
1039
|
-
| **lastupdatedto** | **Date** | Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
1040
|
-
| **duedatefrom** | **Date** | Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
1041
|
-
| **duedateto** | **Date** | Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
1042
|
-
| **taskcategoryid** | **Integer** | Filters results to any tasks with the specified category identifier. | [optional] |
|
1043
|
-
| **priorities** | [**Array<String>**](String.md) | Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned. | [optional] |
|
1044
|
-
| **assignedtoid** | **Integer** | Filters results to any tasks that have been assigned to the specified staff user identifier. | [optional] |
|
1045
|
-
| **tasktitle** | **String** | Filters results to any task whose title *contains* the specified value. | [optional] |
|
1046
|
-
| **orderby** | **String** | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. | [optional] |
|
1047
|
-
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
1048
|
-
| **limit** | **Integer** | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. | [optional] |
|
1049
|
-
|
1050
|
-
### Return type
|
1051
|
-
|
1052
|
-
[**Array<ContactRequestTaskMessage>**](ContactRequestTaskMessage.md)
|
1053
|
-
|
1054
|
-
### Authorization
|
1055
|
-
|
1056
|
-
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1057
|
-
|
1058
|
-
### HTTP request headers
|
1059
|
-
|
1060
|
-
- **Content-Type**: Not defined
|
1061
|
-
- **Accept**: application/json
|
1062
|
-
|
1063
|
-
|
1064
|
-
## get_file_download_request
|
1065
|
-
|
1066
|
-
> <FileDownloadMessage> get_file_download_request(task_id, task_history_id, file_id)
|
1067
|
-
|
1068
|
-
Download a task history file
|
1069
|
-
|
1070
|
-
Downloads a specific file associated to the task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
1071
|
-
|
1072
|
-
### Examples
|
1073
|
-
|
1074
|
-
```ruby
|
1075
|
-
require 'time'
|
1076
|
-
require 'buildium-ruby'
|
1077
|
-
# setup authorization
|
1078
|
-
Buildium.configure do |config|
|
1079
|
-
# Configure API key authorization: clientId
|
1080
|
-
config.api_key['clientId'] = 'YOUR API KEY'
|
1081
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1082
|
-
# config.api_key_prefix['clientId'] = 'Bearer'
|
1083
|
-
|
1084
|
-
# Configure API key authorization: clientSecret
|
1085
|
-
config.api_key['clientSecret'] = 'YOUR API KEY'
|
1086
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1087
|
-
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
1088
|
-
end
|
1089
|
-
|
1090
|
-
api_instance = Buildium::TasksApi.new
|
1091
|
-
task_id = 56 # Integer |
|
1092
|
-
task_history_id = 56 # Integer |
|
1093
|
-
file_id = 56 # Integer |
|
1094
|
-
|
1095
|
-
begin
|
1096
|
-
# Download a task history file
|
1097
|
-
result = api_instance.get_file_download_request(task_id, task_history_id, file_id)
|
1098
|
-
p result
|
1099
|
-
rescue Buildium::ApiError => e
|
1100
|
-
puts "Error when calling TasksApi->get_file_download_request: #{e}"
|
1101
|
-
end
|
1102
|
-
```
|
1103
|
-
|
1104
|
-
#### Using the get_file_download_request_with_http_info variant
|
1105
|
-
|
1106
|
-
This returns an Array which contains the response data, status code and headers.
|
1107
|
-
|
1108
|
-
> <Array(<FileDownloadMessage>, Integer, Hash)> get_file_download_request_with_http_info(task_id, task_history_id, file_id)
|
1109
|
-
|
1110
|
-
```ruby
|
1111
|
-
begin
|
1112
|
-
# Download a task history file
|
1113
|
-
data, status_code, headers = api_instance.get_file_download_request_with_http_info(task_id, task_history_id, file_id)
|
1114
|
-
p status_code # => 2xx
|
1115
|
-
p headers # => { ... }
|
1116
|
-
p data # => <FileDownloadMessage>
|
1117
|
-
rescue Buildium::ApiError => e
|
1118
|
-
puts "Error when calling TasksApi->get_file_download_request_with_http_info: #{e}"
|
1119
|
-
end
|
1120
|
-
```
|
1121
|
-
|
1122
|
-
### Parameters
|
1123
|
-
|
1124
|
-
| Name | Type | Description | Notes |
|
1125
|
-
| ---- | ---- | ----------- | ----- |
|
1126
|
-
| **task_id** | **Integer** | | |
|
1127
|
-
| **task_history_id** | **Integer** | | |
|
1128
|
-
| **file_id** | **Integer** | | |
|
1129
|
-
|
1130
|
-
### Return type
|
1131
|
-
|
1132
|
-
[**FileDownloadMessage**](FileDownloadMessage.md)
|
1133
|
-
|
1134
|
-
### Authorization
|
1135
|
-
|
1136
|
-
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1137
|
-
|
1138
|
-
### HTTP request headers
|
1139
|
-
|
1140
|
-
- **Content-Type**: Not defined
|
1141
|
-
- **Accept**: application/json
|
1142
|
-
|
1143
|
-
|
1144
|
-
## get_rental_owner_request_task_by_id
|
1145
|
-
|
1146
|
-
> <RentalOwnerRequestTaskMessage> get_rental_owner_request_task_by_id(rental_owner_request_task_id)
|
1147
|
-
|
1148
|
-
Retrieve a rental owner request
|
1149
|
-
|
1150
|
-
Retrieves a specific rental owner request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
1151
|
-
|
1152
|
-
### Examples
|
1153
|
-
|
1154
|
-
```ruby
|
1155
|
-
require 'time'
|
1156
|
-
require 'buildium-ruby'
|
1157
|
-
# setup authorization
|
1158
|
-
Buildium.configure do |config|
|
1159
|
-
# Configure API key authorization: clientId
|
1160
|
-
config.api_key['clientId'] = 'YOUR API KEY'
|
1161
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1162
|
-
# config.api_key_prefix['clientId'] = 'Bearer'
|
1163
|
-
|
1164
|
-
# Configure API key authorization: clientSecret
|
1165
|
-
config.api_key['clientSecret'] = 'YOUR API KEY'
|
1166
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1167
|
-
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
1168
|
-
end
|
1169
|
-
|
1170
|
-
api_instance = Buildium::TasksApi.new
|
1171
|
-
rental_owner_request_task_id = 56 # Integer | The rental owner request identifier.
|
1172
|
-
|
1173
|
-
begin
|
1174
|
-
# Retrieve a rental owner request
|
1175
|
-
result = api_instance.get_rental_owner_request_task_by_id(rental_owner_request_task_id)
|
1176
|
-
p result
|
1177
|
-
rescue Buildium::ApiError => e
|
1178
|
-
puts "Error when calling TasksApi->get_rental_owner_request_task_by_id: #{e}"
|
1179
|
-
end
|
1180
|
-
```
|
1181
|
-
|
1182
|
-
#### Using the get_rental_owner_request_task_by_id_with_http_info variant
|
1183
|
-
|
1184
|
-
This returns an Array which contains the response data, status code and headers.
|
1185
|
-
|
1186
|
-
> <Array(<RentalOwnerRequestTaskMessage>, Integer, Hash)> get_rental_owner_request_task_by_id_with_http_info(rental_owner_request_task_id)
|
1187
|
-
|
1188
|
-
```ruby
|
1189
|
-
begin
|
1190
|
-
# Retrieve a rental owner request
|
1191
|
-
data, status_code, headers = api_instance.get_rental_owner_request_task_by_id_with_http_info(rental_owner_request_task_id)
|
1192
|
-
p status_code # => 2xx
|
1193
|
-
p headers # => { ... }
|
1194
|
-
p data # => <RentalOwnerRequestTaskMessage>
|
1195
|
-
rescue Buildium::ApiError => e
|
1196
|
-
puts "Error when calling TasksApi->get_rental_owner_request_task_by_id_with_http_info: #{e}"
|
1197
|
-
end
|
1198
|
-
```
|
1199
|
-
|
1200
|
-
### Parameters
|
1201
|
-
|
1202
|
-
| Name | Type | Description | Notes |
|
1203
|
-
| ---- | ---- | ----------- | ----- |
|
1204
|
-
| **rental_owner_request_task_id** | **Integer** | The rental owner request identifier. | |
|
1205
|
-
|
1206
|
-
### Return type
|
1207
|
-
|
1208
|
-
[**RentalOwnerRequestTaskMessage**](RentalOwnerRequestTaskMessage.md)
|
1209
|
-
|
1210
|
-
### Authorization
|
1211
|
-
|
1212
|
-
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1213
|
-
|
1214
|
-
### HTTP request headers
|
1215
|
-
|
1216
|
-
- **Content-Type**: Not defined
|
1217
|
-
- **Accept**: application/json
|
1218
|
-
|
1219
|
-
|
1220
|
-
## get_resident_request_task
|
1221
|
-
|
1222
|
-
> <ResidentRequestTaskMessage> get_resident_request_task(resident_request_task_id)
|
1223
|
-
|
1224
|
-
Retrieve a resident request
|
1225
|
-
|
1226
|
-
Retrieves a specific resident request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
1227
|
-
|
1228
|
-
### Examples
|
1229
|
-
|
1230
|
-
```ruby
|
1231
|
-
require 'time'
|
1232
|
-
require 'buildium-ruby'
|
1233
|
-
# setup authorization
|
1234
|
-
Buildium.configure do |config|
|
1235
|
-
# Configure API key authorization: clientId
|
1236
|
-
config.api_key['clientId'] = 'YOUR API KEY'
|
1237
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1238
|
-
# config.api_key_prefix['clientId'] = 'Bearer'
|
1239
|
-
|
1240
|
-
# Configure API key authorization: clientSecret
|
1241
|
-
config.api_key['clientSecret'] = 'YOUR API KEY'
|
1242
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1243
|
-
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
1244
|
-
end
|
1245
|
-
|
1246
|
-
api_instance = Buildium::TasksApi.new
|
1247
|
-
resident_request_task_id = 56 # Integer | The resident request identifier.
|
1248
|
-
|
1249
|
-
begin
|
1250
|
-
# Retrieve a resident request
|
1251
|
-
result = api_instance.get_resident_request_task(resident_request_task_id)
|
1252
|
-
p result
|
1253
|
-
rescue Buildium::ApiError => e
|
1254
|
-
puts "Error when calling TasksApi->get_resident_request_task: #{e}"
|
1255
|
-
end
|
1256
|
-
```
|
1257
|
-
|
1258
|
-
#### Using the get_resident_request_task_with_http_info variant
|
1259
|
-
|
1260
|
-
This returns an Array which contains the response data, status code and headers.
|
1261
|
-
|
1262
|
-
> <Array(<ResidentRequestTaskMessage>, Integer, Hash)> get_resident_request_task_with_http_info(resident_request_task_id)
|
1263
|
-
|
1264
|
-
```ruby
|
1265
|
-
begin
|
1266
|
-
# Retrieve a resident request
|
1267
|
-
data, status_code, headers = api_instance.get_resident_request_task_with_http_info(resident_request_task_id)
|
1268
|
-
p status_code # => 2xx
|
1269
|
-
p headers # => { ... }
|
1270
|
-
p data # => <ResidentRequestTaskMessage>
|
1271
|
-
rescue Buildium::ApiError => e
|
1272
|
-
puts "Error when calling TasksApi->get_resident_request_task_with_http_info: #{e}"
|
1273
|
-
end
|
1274
|
-
```
|
1275
|
-
|
1276
|
-
### Parameters
|
1277
|
-
|
1278
|
-
| Name | Type | Description | Notes |
|
1279
|
-
| ---- | ---- | ----------- | ----- |
|
1280
|
-
| **resident_request_task_id** | **Integer** | The resident request identifier. | |
|
1281
|
-
|
1282
|
-
### Return type
|
1283
|
-
|
1284
|
-
[**ResidentRequestTaskMessage**](ResidentRequestTaskMessage.md)
|
1285
|
-
|
1286
|
-
### Authorization
|
1287
|
-
|
1288
|
-
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1289
|
-
|
1290
|
-
### HTTP request headers
|
1291
|
-
|
1292
|
-
- **Content-Type**: Not defined
|
1293
|
-
- **Accept**: application/json
|
1294
|
-
|
1295
|
-
|
1296
|
-
## get_resident_request_tasks
|
1297
|
-
|
1298
|
-
> <Array<ResidentRequestTaskMessage>> get_resident_request_tasks(opts)
|
1299
|
-
|
1300
|
-
Retrieve all resident requests
|
1301
|
-
|
1302
|
-
Retrieves a list of resident requests. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
1303
|
-
|
1304
|
-
### Examples
|
1305
|
-
|
1306
|
-
```ruby
|
1307
|
-
require 'time'
|
1308
|
-
require 'buildium-ruby'
|
1309
|
-
# setup authorization
|
1310
|
-
Buildium.configure do |config|
|
1311
|
-
# Configure API key authorization: clientId
|
1312
|
-
config.api_key['clientId'] = 'YOUR API KEY'
|
1313
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1314
|
-
# config.api_key_prefix['clientId'] = 'Bearer'
|
1315
|
-
|
1316
|
-
# Configure API key authorization: clientSecret
|
1317
|
-
config.api_key['clientSecret'] = 'YOUR API KEY'
|
1318
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1319
|
-
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
1320
|
-
end
|
1321
|
-
|
1322
|
-
api_instance = Buildium::TasksApi.new
|
1323
|
-
opts = {
|
1324
|
-
entitytype: 'Rental', # String | Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated.
|
1325
|
-
entityid: 56, # Integer | Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field.
|
1326
|
-
statuses: ['New'], # Array<String> | Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
|
1327
|
-
unitid: 56, # Integer | Filters results to any task associated with the unit identifier.
|
1328
|
-
unitagreementid: 56, # Integer | Filters results to any task associated with the unit agreement identifier specified.
|
1329
|
-
lastupdatedfrom: Date.parse('2013-10-20'), # Date | Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
1330
|
-
lastupdatedto: Date.parse('2013-10-20'), # Date | Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
1331
|
-
duedatefrom: Date.parse('2013-10-20'), # Date | Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
1332
|
-
duedateto: Date.parse('2013-10-20'), # Date | Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
1333
|
-
taskcategoryid: 56, # Integer | Filters results to any tasks with the specified category identifier.
|
1334
|
-
priorities: ['Low'], # Array<String> | Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
|
1335
|
-
assignedtoid: 56, # Integer | Filters results to any tasks that have been assigned to the specified staff user identifier.
|
1336
|
-
tasktitle: 'tasktitle_example', # String | Filters results to any task whose title *contains* the specified value.
|
1337
|
-
orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
|
1338
|
-
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
1339
|
-
limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
|
1340
|
-
}
|
1341
|
-
|
1342
|
-
begin
|
1343
|
-
# Retrieve all resident requests
|
1344
|
-
result = api_instance.get_resident_request_tasks(opts)
|
1345
|
-
p result
|
1346
|
-
rescue Buildium::ApiError => e
|
1347
|
-
puts "Error when calling TasksApi->get_resident_request_tasks: #{e}"
|
1348
|
-
end
|
1349
|
-
```
|
1350
|
-
|
1351
|
-
#### Using the get_resident_request_tasks_with_http_info variant
|
1352
|
-
|
1353
|
-
This returns an Array which contains the response data, status code and headers.
|
1354
|
-
|
1355
|
-
> <Array(<Array<ResidentRequestTaskMessage>>, Integer, Hash)> get_resident_request_tasks_with_http_info(opts)
|
1356
|
-
|
1357
|
-
```ruby
|
1358
|
-
begin
|
1359
|
-
# Retrieve all resident requests
|
1360
|
-
data, status_code, headers = api_instance.get_resident_request_tasks_with_http_info(opts)
|
1361
|
-
p status_code # => 2xx
|
1362
|
-
p headers # => { ... }
|
1363
|
-
p data # => <Array<ResidentRequestTaskMessage>>
|
1364
|
-
rescue Buildium::ApiError => e
|
1365
|
-
puts "Error when calling TasksApi->get_resident_request_tasks_with_http_info: #{e}"
|
1366
|
-
end
|
1367
|
-
```
|
1368
|
-
|
1369
|
-
### Parameters
|
1370
|
-
|
1371
|
-
| Name | Type | Description | Notes |
|
1372
|
-
| ---- | ---- | ----------- | ----- |
|
1373
|
-
| **entitytype** | **String** | Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated. | [optional] |
|
1374
|
-
| **entityid** | **Integer** | Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field. | [optional] |
|
1375
|
-
| **statuses** | [**Array<String>**](String.md) | Filters results by the status of the task. If no status is specified, tasks with any status will be returned. | [optional] |
|
1376
|
-
| **unitid** | **Integer** | Filters results to any task associated with the unit identifier. | [optional] |
|
1377
|
-
| **unitagreementid** | **Integer** | Filters results to any task associated with the unit agreement identifier specified. | [optional] |
|
1378
|
-
| **lastupdatedfrom** | **Date** | Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
1379
|
-
| **lastupdatedto** | **Date** | Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
1380
|
-
| **duedatefrom** | **Date** | Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
1381
|
-
| **duedateto** | **Date** | Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
1382
|
-
| **taskcategoryid** | **Integer** | Filters results to any tasks with the specified category identifier. | [optional] |
|
1383
|
-
| **priorities** | [**Array<String>**](String.md) | Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned. | [optional] |
|
1384
|
-
| **assignedtoid** | **Integer** | Filters results to any tasks that have been assigned to the specified staff user identifier. | [optional] |
|
1385
|
-
| **tasktitle** | **String** | Filters results to any task whose title *contains* the specified value. | [optional] |
|
1386
|
-
| **orderby** | **String** | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. | [optional] |
|
1387
|
-
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
1388
|
-
| **limit** | **Integer** | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. | [optional] |
|
1389
|
-
|
1390
|
-
### Return type
|
1391
|
-
|
1392
|
-
[**Array<ResidentRequestTaskMessage>**](ResidentRequestTaskMessage.md)
|
1393
|
-
|
1394
|
-
### Authorization
|
1395
|
-
|
1396
|
-
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1397
|
-
|
1398
|
-
### HTTP request headers
|
1399
|
-
|
1400
|
-
- **Content-Type**: Not defined
|
1401
|
-
- **Accept**: application/json
|
1402
|
-
|
1403
|
-
|
1404
|
-
## get_task_by_id
|
1405
|
-
|
1406
|
-
> <AllTasksMessage> get_task_by_id(task_id)
|
1407
|
-
|
1408
|
-
Retrieve a task
|
1409
|
-
|
1410
|
-
Retrieves a specific task. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
1411
|
-
|
1412
|
-
### Examples
|
1413
|
-
|
1414
|
-
```ruby
|
1415
|
-
require 'time'
|
1416
|
-
require 'buildium-ruby'
|
1417
|
-
# setup authorization
|
1418
|
-
Buildium.configure do |config|
|
1419
|
-
# Configure API key authorization: clientId
|
1420
|
-
config.api_key['clientId'] = 'YOUR API KEY'
|
1421
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1422
|
-
# config.api_key_prefix['clientId'] = 'Bearer'
|
1423
|
-
|
1424
|
-
# Configure API key authorization: clientSecret
|
1425
|
-
config.api_key['clientSecret'] = 'YOUR API KEY'
|
1426
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1427
|
-
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
1428
|
-
end
|
1429
|
-
|
1430
|
-
api_instance = Buildium::TasksApi.new
|
1431
|
-
task_id = 56 # Integer | The task identifier
|
1432
|
-
|
1433
|
-
begin
|
1434
|
-
# Retrieve a task
|
1435
|
-
result = api_instance.get_task_by_id(task_id)
|
1436
|
-
p result
|
1437
|
-
rescue Buildium::ApiError => e
|
1438
|
-
puts "Error when calling TasksApi->get_task_by_id: #{e}"
|
1439
|
-
end
|
1440
|
-
```
|
1441
|
-
|
1442
|
-
#### Using the get_task_by_id_with_http_info variant
|
1443
|
-
|
1444
|
-
This returns an Array which contains the response data, status code and headers.
|
1445
|
-
|
1446
|
-
> <Array(<AllTasksMessage>, Integer, Hash)> get_task_by_id_with_http_info(task_id)
|
1447
|
-
|
1448
|
-
```ruby
|
1449
|
-
begin
|
1450
|
-
# Retrieve a task
|
1451
|
-
data, status_code, headers = api_instance.get_task_by_id_with_http_info(task_id)
|
1452
|
-
p status_code # => 2xx
|
1453
|
-
p headers # => { ... }
|
1454
|
-
p data # => <AllTasksMessage>
|
1455
|
-
rescue Buildium::ApiError => e
|
1456
|
-
puts "Error when calling TasksApi->get_task_by_id_with_http_info: #{e}"
|
1457
|
-
end
|
1458
|
-
```
|
1459
|
-
|
1460
|
-
### Parameters
|
1461
|
-
|
1462
|
-
| Name | Type | Description | Notes |
|
1463
|
-
| ---- | ---- | ----------- | ----- |
|
1464
|
-
| **task_id** | **Integer** | The task identifier | |
|
1465
|
-
|
1466
|
-
### Return type
|
1467
|
-
|
1468
|
-
[**AllTasksMessage**](AllTasksMessage.md)
|
1469
|
-
|
1470
|
-
### Authorization
|
1471
|
-
|
1472
|
-
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1473
|
-
|
1474
|
-
### HTTP request headers
|
1475
|
-
|
1476
|
-
- **Content-Type**: Not defined
|
1477
|
-
- **Accept**: application/json
|
1478
|
-
|
1479
|
-
|
1480
|
-
## get_task_category_by_id
|
1481
|
-
|
1482
|
-
> <TaskCategoryMessage> get_task_category_by_id(task_category_id)
|
1483
|
-
|
1484
|
-
Retrieve a task category
|
1485
|
-
|
1486
|
-
Retrieves a specific task category. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
1487
|
-
|
1488
|
-
### Examples
|
1489
|
-
|
1490
|
-
```ruby
|
1491
|
-
require 'time'
|
1492
|
-
require 'buildium-ruby'
|
1493
|
-
# setup authorization
|
1494
|
-
Buildium.configure do |config|
|
1495
|
-
# Configure API key authorization: clientId
|
1496
|
-
config.api_key['clientId'] = 'YOUR API KEY'
|
1497
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1498
|
-
# config.api_key_prefix['clientId'] = 'Bearer'
|
1499
|
-
|
1500
|
-
# Configure API key authorization: clientSecret
|
1501
|
-
config.api_key['clientSecret'] = 'YOUR API KEY'
|
1502
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1503
|
-
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
1504
|
-
end
|
1505
|
-
|
1506
|
-
api_instance = Buildium::TasksApi.new
|
1507
|
-
task_category_id = 56 # Integer | The task category identifier.
|
1508
|
-
|
1509
|
-
begin
|
1510
|
-
# Retrieve a task category
|
1511
|
-
result = api_instance.get_task_category_by_id(task_category_id)
|
1512
|
-
p result
|
1513
|
-
rescue Buildium::ApiError => e
|
1514
|
-
puts "Error when calling TasksApi->get_task_category_by_id: #{e}"
|
1515
|
-
end
|
1516
|
-
```
|
1517
|
-
|
1518
|
-
#### Using the get_task_category_by_id_with_http_info variant
|
1519
|
-
|
1520
|
-
This returns an Array which contains the response data, status code and headers.
|
1521
|
-
|
1522
|
-
> <Array(<TaskCategoryMessage>, Integer, Hash)> get_task_category_by_id_with_http_info(task_category_id)
|
1523
|
-
|
1524
|
-
```ruby
|
1525
|
-
begin
|
1526
|
-
# Retrieve a task category
|
1527
|
-
data, status_code, headers = api_instance.get_task_category_by_id_with_http_info(task_category_id)
|
1528
|
-
p status_code # => 2xx
|
1529
|
-
p headers # => { ... }
|
1530
|
-
p data # => <TaskCategoryMessage>
|
1531
|
-
rescue Buildium::ApiError => e
|
1532
|
-
puts "Error when calling TasksApi->get_task_category_by_id_with_http_info: #{e}"
|
1533
|
-
end
|
1534
|
-
```
|
1535
|
-
|
1536
|
-
### Parameters
|
1537
|
-
|
1538
|
-
| Name | Type | Description | Notes |
|
1539
|
-
| ---- | ---- | ----------- | ----- |
|
1540
|
-
| **task_category_id** | **Integer** | The task category identifier. | |
|
1541
|
-
|
1542
|
-
### Return type
|
1543
|
-
|
1544
|
-
[**TaskCategoryMessage**](TaskCategoryMessage.md)
|
1545
|
-
|
1546
|
-
### Authorization
|
1547
|
-
|
1548
|
-
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1549
|
-
|
1550
|
-
### HTTP request headers
|
1551
|
-
|
1552
|
-
- **Content-Type**: Not defined
|
1553
|
-
- **Accept**: application/json
|
1554
|
-
|
1555
|
-
|
1556
|
-
## get_task_histories
|
1557
|
-
|
1558
|
-
> <Array<TaskHistoryMessage>> get_task_histories(task_id, opts)
|
1559
|
-
|
1560
|
-
Retrieve all task history
|
1561
|
-
|
1562
|
-
Retrieves all task history records for a specific task. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
1563
|
-
|
1564
|
-
### Examples
|
1565
|
-
|
1566
|
-
```ruby
|
1567
|
-
require 'time'
|
1568
|
-
require 'buildium-ruby'
|
1569
|
-
# setup authorization
|
1570
|
-
Buildium.configure do |config|
|
1571
|
-
# Configure API key authorization: clientId
|
1572
|
-
config.api_key['clientId'] = 'YOUR API KEY'
|
1573
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1574
|
-
# config.api_key_prefix['clientId'] = 'Bearer'
|
1575
|
-
|
1576
|
-
# Configure API key authorization: clientSecret
|
1577
|
-
config.api_key['clientSecret'] = 'YOUR API KEY'
|
1578
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1579
|
-
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
1580
|
-
end
|
1581
|
-
|
1582
|
-
api_instance = Buildium::TasksApi.new
|
1583
|
-
task_id = 56 # Integer |
|
1584
|
-
opts = {
|
1585
|
-
orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
|
1586
|
-
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
1587
|
-
limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
|
1588
|
-
}
|
1589
|
-
|
1590
|
-
begin
|
1591
|
-
# Retrieve all task history
|
1592
|
-
result = api_instance.get_task_histories(task_id, opts)
|
1593
|
-
p result
|
1594
|
-
rescue Buildium::ApiError => e
|
1595
|
-
puts "Error when calling TasksApi->get_task_histories: #{e}"
|
1596
|
-
end
|
1597
|
-
```
|
1598
|
-
|
1599
|
-
#### Using the get_task_histories_with_http_info variant
|
1600
|
-
|
1601
|
-
This returns an Array which contains the response data, status code and headers.
|
1602
|
-
|
1603
|
-
> <Array(<Array<TaskHistoryMessage>>, Integer, Hash)> get_task_histories_with_http_info(task_id, opts)
|
1604
|
-
|
1605
|
-
```ruby
|
1606
|
-
begin
|
1607
|
-
# Retrieve all task history
|
1608
|
-
data, status_code, headers = api_instance.get_task_histories_with_http_info(task_id, opts)
|
1609
|
-
p status_code # => 2xx
|
1610
|
-
p headers # => { ... }
|
1611
|
-
p data # => <Array<TaskHistoryMessage>>
|
1612
|
-
rescue Buildium::ApiError => e
|
1613
|
-
puts "Error when calling TasksApi->get_task_histories_with_http_info: #{e}"
|
1614
|
-
end
|
1615
|
-
```
|
1616
|
-
|
1617
|
-
### Parameters
|
1618
|
-
|
1619
|
-
| Name | Type | Description | Notes |
|
1620
|
-
| ---- | ---- | ----------- | ----- |
|
1621
|
-
| **task_id** | **Integer** | | |
|
1622
|
-
| **orderby** | **String** | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. | [optional] |
|
1623
|
-
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
1624
|
-
| **limit** | **Integer** | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. | [optional] |
|
1625
|
-
|
1626
|
-
### Return type
|
1627
|
-
|
1628
|
-
[**Array<TaskHistoryMessage>**](TaskHistoryMessage.md)
|
1629
|
-
|
1630
|
-
### Authorization
|
1631
|
-
|
1632
|
-
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1633
|
-
|
1634
|
-
### HTTP request headers
|
1635
|
-
|
1636
|
-
- **Content-Type**: Not defined
|
1637
|
-
- **Accept**: application/json
|
1638
|
-
|
1639
|
-
|
1640
|
-
## get_task_history_by_id
|
1641
|
-
|
1642
|
-
> <TaskHistoryMessage> get_task_history_by_id(task_id, task_history_id)
|
1643
|
-
|
1644
|
-
Retrieve a task history
|
1645
|
-
|
1646
|
-
Retrieves a specific task history record for a task. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
1647
|
-
|
1648
|
-
### Examples
|
1649
|
-
|
1650
|
-
```ruby
|
1651
|
-
require 'time'
|
1652
|
-
require 'buildium-ruby'
|
1653
|
-
# setup authorization
|
1654
|
-
Buildium.configure do |config|
|
1655
|
-
# Configure API key authorization: clientId
|
1656
|
-
config.api_key['clientId'] = 'YOUR API KEY'
|
1657
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1658
|
-
# config.api_key_prefix['clientId'] = 'Bearer'
|
1659
|
-
|
1660
|
-
# Configure API key authorization: clientSecret
|
1661
|
-
config.api_key['clientSecret'] = 'YOUR API KEY'
|
1662
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1663
|
-
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
1664
|
-
end
|
1665
|
-
|
1666
|
-
api_instance = Buildium::TasksApi.new
|
1667
|
-
task_id = 56 # Integer |
|
1668
|
-
task_history_id = 56 # Integer |
|
1669
|
-
|
1670
|
-
begin
|
1671
|
-
# Retrieve a task history
|
1672
|
-
result = api_instance.get_task_history_by_id(task_id, task_history_id)
|
394
|
+
# Retrieve all tasks
|
395
|
+
result = api_instance.get_all_tasks(opts)
|
1673
396
|
p result
|
1674
397
|
rescue Buildium::ApiError => e
|
1675
|
-
puts "Error when calling TasksApi->
|
398
|
+
puts "Error when calling TasksApi->get_all_tasks: #{e}"
|
1676
399
|
end
|
1677
400
|
```
|
1678
401
|
|
1679
|
-
#### Using the
|
402
|
+
#### Using the get_all_tasks_with_http_info variant
|
1680
403
|
|
1681
404
|
This returns an Array which contains the response data, status code and headers.
|
1682
405
|
|
1683
|
-
> <Array(<
|
406
|
+
> <Array(<Array<AllTasksMessage>>, Integer, Hash)> get_all_tasks_with_http_info(opts)
|
1684
407
|
|
1685
408
|
```ruby
|
1686
409
|
begin
|
1687
|
-
# Retrieve
|
1688
|
-
data, status_code, headers = api_instance.
|
410
|
+
# Retrieve all tasks
|
411
|
+
data, status_code, headers = api_instance.get_all_tasks_with_http_info(opts)
|
1689
412
|
p status_code # => 2xx
|
1690
413
|
p headers # => { ... }
|
1691
|
-
p data # => <
|
414
|
+
p data # => <Array<AllTasksMessage>>
|
1692
415
|
rescue Buildium::ApiError => e
|
1693
|
-
puts "Error when calling TasksApi->
|
416
|
+
puts "Error when calling TasksApi->get_all_tasks_with_http_info: #{e}"
|
1694
417
|
end
|
1695
418
|
```
|
1696
419
|
|
@@ -1698,12 +421,27 @@ end
|
|
1698
421
|
|
1699
422
|
| Name | Type | Description | Notes |
|
1700
423
|
| ---- | ---- | ----------- | ----- |
|
1701
|
-
| **
|
1702
|
-
| **
|
424
|
+
| **entitytype** | **String** | Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated. | [optional] |
|
425
|
+
| **entityid** | **Integer** | Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field. | [optional] |
|
426
|
+
| **statuses** | [**Array<String>**](String.md) | Filters results by the status of the task. If no status is specified, tasks with any status will be returned. | [optional] |
|
427
|
+
| **type** | **String** | Filters results to any task associated with the task type specified. | [optional] |
|
428
|
+
| **unitid** | **Integer** | Filters results to any task associated with the unit identifier. | [optional] |
|
429
|
+
| **unitagreementid** | **Integer** | Filters results to any task associated with the unit agreement identifier specified. | [optional] |
|
430
|
+
| **lastupdatedfrom** | **Date** | Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
431
|
+
| **lastupdatedto** | **Date** | Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
432
|
+
| **duedatefrom** | **Date** | Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
433
|
+
| **duedateto** | **Date** | Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
434
|
+
| **taskcategoryid** | **Integer** | Filters results to any tasks with the specified category identifier. | [optional] |
|
435
|
+
| **priorities** | [**Array<String>**](String.md) | Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned. | [optional] |
|
436
|
+
| **assignedtoid** | **Integer** | Filters results to any tasks that have been assigned to the specified staff user identifier. | [optional] |
|
437
|
+
| **tasktitle** | **String** | Filters results to any task whose title *contains* the specified value. | [optional] |
|
438
|
+
| **orderby** | **String** | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. | [optional] |
|
439
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
440
|
+
| **limit** | **Integer** | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. | [optional] |
|
1703
441
|
|
1704
442
|
### Return type
|
1705
443
|
|
1706
|
-
[**
|
444
|
+
[**Array<AllTasksMessage>**](AllTasksMessage.md)
|
1707
445
|
|
1708
446
|
### Authorization
|
1709
447
|
|
@@ -1715,13 +453,13 @@ end
|
|
1715
453
|
- **Accept**: application/json
|
1716
454
|
|
1717
455
|
|
1718
|
-
##
|
456
|
+
## get_file_download_request
|
1719
457
|
|
1720
|
-
> <
|
458
|
+
> <FileDownloadMessage> get_file_download_request(task_id, task_history_id, file_id)
|
1721
459
|
|
1722
|
-
|
460
|
+
Download a task history file
|
1723
461
|
|
1724
|
-
|
462
|
+
Downloads a specific file associated to the task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
1725
463
|
|
1726
464
|
### Examples
|
1727
465
|
|
@@ -1747,29 +485,29 @@ task_history_id = 56 # Integer |
|
|
1747
485
|
file_id = 56 # Integer |
|
1748
486
|
|
1749
487
|
begin
|
1750
|
-
#
|
1751
|
-
result = api_instance.
|
488
|
+
# Download a task history file
|
489
|
+
result = api_instance.get_file_download_request(task_id, task_history_id, file_id)
|
1752
490
|
p result
|
1753
491
|
rescue Buildium::ApiError => e
|
1754
|
-
puts "Error when calling TasksApi->
|
492
|
+
puts "Error when calling TasksApi->get_file_download_request: #{e}"
|
1755
493
|
end
|
1756
494
|
```
|
1757
495
|
|
1758
|
-
#### Using the
|
496
|
+
#### Using the get_file_download_request_with_http_info variant
|
1759
497
|
|
1760
498
|
This returns an Array which contains the response data, status code and headers.
|
1761
499
|
|
1762
|
-
> <Array(<
|
500
|
+
> <Array(<FileDownloadMessage>, Integer, Hash)> get_file_download_request_with_http_info(task_id, task_history_id, file_id)
|
1763
501
|
|
1764
502
|
```ruby
|
1765
503
|
begin
|
1766
|
-
#
|
1767
|
-
data, status_code, headers = api_instance.
|
504
|
+
# Download a task history file
|
505
|
+
data, status_code, headers = api_instance.get_file_download_request_with_http_info(task_id, task_history_id, file_id)
|
1768
506
|
p status_code # => 2xx
|
1769
507
|
p headers # => { ... }
|
1770
|
-
p data # => <
|
508
|
+
p data # => <FileDownloadMessage>
|
1771
509
|
rescue Buildium::ApiError => e
|
1772
|
-
puts "Error when calling TasksApi->
|
510
|
+
puts "Error when calling TasksApi->get_file_download_request_with_http_info: #{e}"
|
1773
511
|
end
|
1774
512
|
```
|
1775
513
|
|
@@ -1783,7 +521,7 @@ end
|
|
1783
521
|
|
1784
522
|
### Return type
|
1785
523
|
|
1786
|
-
[**
|
524
|
+
[**FileDownloadMessage**](FileDownloadMessage.md)
|
1787
525
|
|
1788
526
|
### Authorization
|
1789
527
|
|
@@ -1795,13 +533,13 @@ end
|
|
1795
533
|
- **Accept**: application/json
|
1796
534
|
|
1797
535
|
|
1798
|
-
##
|
536
|
+
## get_task_by_id
|
1799
537
|
|
1800
|
-
> <
|
538
|
+
> <AllTasksMessage> get_task_by_id(task_id)
|
1801
539
|
|
1802
|
-
Retrieve a
|
540
|
+
Retrieve a task
|
1803
541
|
|
1804
|
-
Retrieves a to do task. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
542
|
+
Retrieves a specific task. This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. Note, the response payload only contains fields common across all of the request types. To retrieve the full details of the task query the retrieve endpoint specific to the task type. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
1805
543
|
|
1806
544
|
### Examples
|
1807
545
|
|
@@ -1822,32 +560,32 @@ Buildium.configure do |config|
|
|
1822
560
|
end
|
1823
561
|
|
1824
562
|
api_instance = Buildium::TasksApi.new
|
1825
|
-
|
563
|
+
task_id = 56 # Integer | The task identifier
|
1826
564
|
|
1827
565
|
begin
|
1828
|
-
# Retrieve a
|
1829
|
-
result = api_instance.
|
566
|
+
# Retrieve a task
|
567
|
+
result = api_instance.get_task_by_id(task_id)
|
1830
568
|
p result
|
1831
569
|
rescue Buildium::ApiError => e
|
1832
|
-
puts "Error when calling TasksApi->
|
570
|
+
puts "Error when calling TasksApi->get_task_by_id: #{e}"
|
1833
571
|
end
|
1834
572
|
```
|
1835
573
|
|
1836
|
-
#### Using the
|
574
|
+
#### Using the get_task_by_id_with_http_info variant
|
1837
575
|
|
1838
576
|
This returns an Array which contains the response data, status code and headers.
|
1839
577
|
|
1840
|
-
> <Array(<
|
578
|
+
> <Array(<AllTasksMessage>, Integer, Hash)> get_task_by_id_with_http_info(task_id)
|
1841
579
|
|
1842
580
|
```ruby
|
1843
581
|
begin
|
1844
|
-
# Retrieve a
|
1845
|
-
data, status_code, headers = api_instance.
|
582
|
+
# Retrieve a task
|
583
|
+
data, status_code, headers = api_instance.get_task_by_id_with_http_info(task_id)
|
1846
584
|
p status_code # => 2xx
|
1847
585
|
p headers # => { ... }
|
1848
|
-
p data # => <
|
586
|
+
p data # => <AllTasksMessage>
|
1849
587
|
rescue Buildium::ApiError => e
|
1850
|
-
puts "Error when calling TasksApi->
|
588
|
+
puts "Error when calling TasksApi->get_task_by_id_with_http_info: #{e}"
|
1851
589
|
end
|
1852
590
|
```
|
1853
591
|
|
@@ -1855,11 +593,11 @@ end
|
|
1855
593
|
|
1856
594
|
| Name | Type | Description | Notes |
|
1857
595
|
| ---- | ---- | ----------- | ----- |
|
1858
|
-
| **
|
596
|
+
| **task_id** | **Integer** | The task identifier | |
|
1859
597
|
|
1860
598
|
### Return type
|
1861
599
|
|
1862
|
-
[**
|
600
|
+
[**AllTasksMessage**](AllTasksMessage.md)
|
1863
601
|
|
1864
602
|
### Authorization
|
1865
603
|
|
@@ -1871,13 +609,13 @@ end
|
|
1871
609
|
- **Accept**: application/json
|
1872
610
|
|
1873
611
|
|
1874
|
-
##
|
612
|
+
## get_task_category_by_id
|
1875
613
|
|
1876
|
-
> <
|
614
|
+
> <TaskCategoryMessage> get_task_category_by_id(task_category_id)
|
1877
615
|
|
1878
|
-
Retrieve
|
616
|
+
Retrieve a task category
|
1879
617
|
|
1880
|
-
Retrieves a
|
618
|
+
Retrieves a specific task category. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
1881
619
|
|
1882
620
|
### Examples
|
1883
621
|
|
@@ -1898,48 +636,32 @@ Buildium.configure do |config|
|
|
1898
636
|
end
|
1899
637
|
|
1900
638
|
api_instance = Buildium::TasksApi.new
|
1901
|
-
|
1902
|
-
entitytype: 'Rental', # String | Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated.
|
1903
|
-
entityid: 56, # Integer | Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field.
|
1904
|
-
statuses: ['New'], # Array<String> | Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
|
1905
|
-
unitid: 56, # Integer | Filters results to any task associated with the unit identifier.
|
1906
|
-
lastupdatedfrom: Date.parse('2013-10-20'), # Date | Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
1907
|
-
lastupdatedto: Date.parse('2013-10-20'), # Date | Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
1908
|
-
duedatefrom: Date.parse('2013-10-20'), # Date | Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
1909
|
-
duedateto: Date.parse('2013-10-20'), # Date | Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
1910
|
-
taskcategoryid: 56, # Integer | Filters results to any tasks with the specified category identifier.
|
1911
|
-
priorities: ['Low'], # Array<String> | Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
|
1912
|
-
assignedtoid: 56, # Integer | Filters results to any tasks that have been assigned to the specified staff user identifier.
|
1913
|
-
tasktitle: 'tasktitle_example', # String | Filters results to any task whose title *contains* the specified value.
|
1914
|
-
orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
|
1915
|
-
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
1916
|
-
limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
|
1917
|
-
}
|
639
|
+
task_category_id = 56 # Integer | The task category identifier.
|
1918
640
|
|
1919
641
|
begin
|
1920
|
-
# Retrieve
|
1921
|
-
result = api_instance.
|
642
|
+
# Retrieve a task category
|
643
|
+
result = api_instance.get_task_category_by_id(task_category_id)
|
1922
644
|
p result
|
1923
645
|
rescue Buildium::ApiError => e
|
1924
|
-
puts "Error when calling TasksApi->
|
646
|
+
puts "Error when calling TasksApi->get_task_category_by_id: #{e}"
|
1925
647
|
end
|
1926
648
|
```
|
1927
649
|
|
1928
|
-
#### Using the
|
650
|
+
#### Using the get_task_category_by_id_with_http_info variant
|
1929
651
|
|
1930
652
|
This returns an Array which contains the response data, status code and headers.
|
1931
653
|
|
1932
|
-
> <Array(<
|
654
|
+
> <Array(<TaskCategoryMessage>, Integer, Hash)> get_task_category_by_id_with_http_info(task_category_id)
|
1933
655
|
|
1934
656
|
```ruby
|
1935
657
|
begin
|
1936
|
-
# Retrieve
|
1937
|
-
data, status_code, headers = api_instance.
|
658
|
+
# Retrieve a task category
|
659
|
+
data, status_code, headers = api_instance.get_task_category_by_id_with_http_info(task_category_id)
|
1938
660
|
p status_code # => 2xx
|
1939
661
|
p headers # => { ... }
|
1940
|
-
p data # => <
|
662
|
+
p data # => <TaskCategoryMessage>
|
1941
663
|
rescue Buildium::ApiError => e
|
1942
|
-
puts "Error when calling TasksApi->
|
664
|
+
puts "Error when calling TasksApi->get_task_category_by_id_with_http_info: #{e}"
|
1943
665
|
end
|
1944
666
|
```
|
1945
667
|
|
@@ -1947,25 +669,11 @@ end
|
|
1947
669
|
|
1948
670
|
| Name | Type | Description | Notes |
|
1949
671
|
| ---- | ---- | ----------- | ----- |
|
1950
|
-
| **
|
1951
|
-
| **entityid** | **Integer** | Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field. | [optional] |
|
1952
|
-
| **statuses** | [**Array<String>**](String.md) | Filters results by the status of the task. If no status is specified, tasks with any status will be returned. | [optional] |
|
1953
|
-
| **unitid** | **Integer** | Filters results to any task associated with the unit identifier. | [optional] |
|
1954
|
-
| **lastupdatedfrom** | **Date** | Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
1955
|
-
| **lastupdatedto** | **Date** | Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
1956
|
-
| **duedatefrom** | **Date** | Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
1957
|
-
| **duedateto** | **Date** | Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD. | [optional] |
|
1958
|
-
| **taskcategoryid** | **Integer** | Filters results to any tasks with the specified category identifier. | [optional] |
|
1959
|
-
| **priorities** | [**Array<String>**](String.md) | Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned. | [optional] |
|
1960
|
-
| **assignedtoid** | **Integer** | Filters results to any tasks that have been assigned to the specified staff user identifier. | [optional] |
|
1961
|
-
| **tasktitle** | **String** | Filters results to any task whose title *contains* the specified value. | [optional] |
|
1962
|
-
| **orderby** | **String** | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. | [optional] |
|
1963
|
-
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
1964
|
-
| **limit** | **Integer** | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. | [optional] |
|
672
|
+
| **task_category_id** | **Integer** | The task category identifier. | |
|
1965
673
|
|
1966
674
|
### Return type
|
1967
675
|
|
1968
|
-
[**
|
676
|
+
[**TaskCategoryMessage**](TaskCategoryMessage.md)
|
1969
677
|
|
1970
678
|
### Authorization
|
1971
679
|
|
@@ -1977,13 +685,13 @@ end
|
|
1977
685
|
- **Accept**: application/json
|
1978
686
|
|
1979
687
|
|
1980
|
-
##
|
688
|
+
## get_task_histories
|
1981
689
|
|
1982
|
-
> <
|
690
|
+
> <Array<TaskHistoryMessage>> get_task_histories(task_id, opts)
|
1983
691
|
|
1984
|
-
|
692
|
+
Retrieve all task history
|
1985
693
|
|
1986
|
-
|
694
|
+
Retrieves all task history records for a specific task. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
1987
695
|
|
1988
696
|
### Examples
|
1989
697
|
|
@@ -2004,33 +712,37 @@ Buildium.configure do |config|
|
|
2004
712
|
end
|
2005
713
|
|
2006
714
|
api_instance = Buildium::TasksApi.new
|
2007
|
-
|
2008
|
-
|
715
|
+
task_id = 56 # Integer |
|
716
|
+
opts = {
|
717
|
+
orderby: 'orderby_example', # String | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information.
|
718
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
719
|
+
limit: 56 # Integer | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50.
|
720
|
+
}
|
2009
721
|
|
2010
722
|
begin
|
2011
|
-
#
|
2012
|
-
result = api_instance.
|
723
|
+
# Retrieve all task history
|
724
|
+
result = api_instance.get_task_histories(task_id, opts)
|
2013
725
|
p result
|
2014
726
|
rescue Buildium::ApiError => e
|
2015
|
-
puts "Error when calling TasksApi->
|
727
|
+
puts "Error when calling TasksApi->get_task_histories: #{e}"
|
2016
728
|
end
|
2017
729
|
```
|
2018
730
|
|
2019
|
-
#### Using the
|
731
|
+
#### Using the get_task_histories_with_http_info variant
|
2020
732
|
|
2021
733
|
This returns an Array which contains the response data, status code and headers.
|
2022
734
|
|
2023
|
-
> <Array(<
|
735
|
+
> <Array(<Array<TaskHistoryMessage>>, Integer, Hash)> get_task_histories_with_http_info(task_id, opts)
|
2024
736
|
|
2025
737
|
```ruby
|
2026
738
|
begin
|
2027
|
-
#
|
2028
|
-
data, status_code, headers = api_instance.
|
739
|
+
# Retrieve all task history
|
740
|
+
data, status_code, headers = api_instance.get_task_histories_with_http_info(task_id, opts)
|
2029
741
|
p status_code # => 2xx
|
2030
742
|
p headers # => { ... }
|
2031
|
-
p data # => <
|
743
|
+
p data # => <Array<TaskHistoryMessage>>
|
2032
744
|
rescue Buildium::ApiError => e
|
2033
|
-
puts "Error when calling TasksApi->
|
745
|
+
puts "Error when calling TasksApi->get_task_histories_with_http_info: #{e}"
|
2034
746
|
end
|
2035
747
|
```
|
2036
748
|
|
@@ -2038,12 +750,14 @@ end
|
|
2038
750
|
|
2039
751
|
| Name | Type | Description | Notes |
|
2040
752
|
| ---- | ---- | ----------- | ----- |
|
2041
|
-
| **
|
2042
|
-
| **
|
753
|
+
| **task_id** | **Integer** | | |
|
754
|
+
| **orderby** | **String** | `orderby` indicates the field(s) and direction to sort the results in the response. See <a href=\"#section/API-Overview/Bulk-Request-Options\">Bulk Request Options</a> for more information. | [optional] |
|
755
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
756
|
+
| **limit** | **Integer** | `limit` indicates the maximum number of results to be returned in the response. `limit` can range between 1 and 1000 and the default is 50. | [optional] |
|
2043
757
|
|
2044
758
|
### Return type
|
2045
759
|
|
2046
|
-
[**
|
760
|
+
[**Array<TaskHistoryMessage>**](TaskHistoryMessage.md)
|
2047
761
|
|
2048
762
|
### Authorization
|
2049
763
|
|
@@ -2051,17 +765,17 @@ end
|
|
2051
765
|
|
2052
766
|
### HTTP request headers
|
2053
767
|
|
2054
|
-
- **Content-Type**:
|
768
|
+
- **Content-Type**: Not defined
|
2055
769
|
- **Accept**: application/json
|
2056
770
|
|
2057
771
|
|
2058
|
-
##
|
772
|
+
## get_task_history_by_id
|
2059
773
|
|
2060
|
-
> <
|
774
|
+
> <TaskHistoryMessage> get_task_history_by_id(task_id, task_history_id)
|
2061
775
|
|
2062
|
-
|
776
|
+
Retrieve a task history
|
2063
777
|
|
2064
|
-
|
778
|
+
Retrieves a specific task history record for a task. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
2065
779
|
|
2066
780
|
### Examples
|
2067
781
|
|
@@ -2082,33 +796,33 @@ Buildium.configure do |config|
|
|
2082
796
|
end
|
2083
797
|
|
2084
798
|
api_instance = Buildium::TasksApi.new
|
2085
|
-
|
2086
|
-
|
799
|
+
task_id = 56 # Integer |
|
800
|
+
task_history_id = 56 # Integer |
|
2087
801
|
|
2088
802
|
begin
|
2089
|
-
#
|
2090
|
-
result = api_instance.
|
803
|
+
# Retrieve a task history
|
804
|
+
result = api_instance.get_task_history_by_id(task_id, task_history_id)
|
2091
805
|
p result
|
2092
806
|
rescue Buildium::ApiError => e
|
2093
|
-
puts "Error when calling TasksApi->
|
807
|
+
puts "Error when calling TasksApi->get_task_history_by_id: #{e}"
|
2094
808
|
end
|
2095
809
|
```
|
2096
810
|
|
2097
|
-
#### Using the
|
811
|
+
#### Using the get_task_history_by_id_with_http_info variant
|
2098
812
|
|
2099
813
|
This returns an Array which contains the response data, status code and headers.
|
2100
814
|
|
2101
|
-
> <Array(<
|
815
|
+
> <Array(<TaskHistoryMessage>, Integer, Hash)> get_task_history_by_id_with_http_info(task_id, task_history_id)
|
2102
816
|
|
2103
817
|
```ruby
|
2104
818
|
begin
|
2105
|
-
#
|
2106
|
-
data, status_code, headers = api_instance.
|
819
|
+
# Retrieve a task history
|
820
|
+
data, status_code, headers = api_instance.get_task_history_by_id_with_http_info(task_id, task_history_id)
|
2107
821
|
p status_code # => 2xx
|
2108
822
|
p headers # => { ... }
|
2109
|
-
p data # => <
|
823
|
+
p data # => <TaskHistoryMessage>
|
2110
824
|
rescue Buildium::ApiError => e
|
2111
|
-
puts "Error when calling TasksApi->
|
825
|
+
puts "Error when calling TasksApi->get_task_history_by_id_with_http_info: #{e}"
|
2112
826
|
end
|
2113
827
|
```
|
2114
828
|
|
@@ -2116,12 +830,12 @@ end
|
|
2116
830
|
|
2117
831
|
| Name | Type | Description | Notes |
|
2118
832
|
| ---- | ---- | ----------- | ----- |
|
2119
|
-
| **
|
2120
|
-
| **
|
833
|
+
| **task_id** | **Integer** | | |
|
834
|
+
| **task_history_id** | **Integer** | | |
|
2121
835
|
|
2122
836
|
### Return type
|
2123
837
|
|
2124
|
-
[**
|
838
|
+
[**TaskHistoryMessage**](TaskHistoryMessage.md)
|
2125
839
|
|
2126
840
|
### Authorization
|
2127
841
|
|
@@ -2129,17 +843,17 @@ end
|
|
2129
843
|
|
2130
844
|
### HTTP request headers
|
2131
845
|
|
2132
|
-
- **Content-Type**:
|
846
|
+
- **Content-Type**: Not defined
|
2133
847
|
- **Accept**: application/json
|
2134
848
|
|
2135
849
|
|
2136
|
-
##
|
850
|
+
## get_task_history_file_by_id
|
2137
851
|
|
2138
|
-
> <
|
852
|
+
> <TaskHistoryFileMessage> get_task_history_file_by_id(task_id, task_history_id, file_id)
|
2139
853
|
|
2140
|
-
|
854
|
+
Retrieve a task history file
|
2141
855
|
|
2142
|
-
|
856
|
+
Retrieves the metadata for a specific file associated with a task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
2143
857
|
|
2144
858
|
### Examples
|
2145
859
|
|
@@ -2160,33 +874,34 @@ Buildium.configure do |config|
|
|
2160
874
|
end
|
2161
875
|
|
2162
876
|
api_instance = Buildium::TasksApi.new
|
2163
|
-
|
2164
|
-
|
877
|
+
task_id = 56 # Integer |
|
878
|
+
task_history_id = 56 # Integer |
|
879
|
+
file_id = 56 # Integer |
|
2165
880
|
|
2166
881
|
begin
|
2167
|
-
#
|
2168
|
-
result = api_instance.
|
882
|
+
# Retrieve a task history file
|
883
|
+
result = api_instance.get_task_history_file_by_id(task_id, task_history_id, file_id)
|
2169
884
|
p result
|
2170
885
|
rescue Buildium::ApiError => e
|
2171
|
-
puts "Error when calling TasksApi->
|
886
|
+
puts "Error when calling TasksApi->get_task_history_file_by_id: #{e}"
|
2172
887
|
end
|
2173
888
|
```
|
2174
889
|
|
2175
|
-
#### Using the
|
890
|
+
#### Using the get_task_history_file_by_id_with_http_info variant
|
2176
891
|
|
2177
892
|
This returns an Array which contains the response data, status code and headers.
|
2178
893
|
|
2179
|
-
> <Array(<
|
894
|
+
> <Array(<TaskHistoryFileMessage>, Integer, Hash)> get_task_history_file_by_id_with_http_info(task_id, task_history_id, file_id)
|
2180
895
|
|
2181
896
|
```ruby
|
2182
897
|
begin
|
2183
|
-
#
|
2184
|
-
data, status_code, headers = api_instance.
|
898
|
+
# Retrieve a task history file
|
899
|
+
data, status_code, headers = api_instance.get_task_history_file_by_id_with_http_info(task_id, task_history_id, file_id)
|
2185
900
|
p status_code # => 2xx
|
2186
901
|
p headers # => { ... }
|
2187
|
-
p data # => <
|
902
|
+
p data # => <TaskHistoryFileMessage>
|
2188
903
|
rescue Buildium::ApiError => e
|
2189
|
-
puts "Error when calling TasksApi->
|
904
|
+
puts "Error when calling TasksApi->get_task_history_file_by_id_with_http_info: #{e}"
|
2190
905
|
end
|
2191
906
|
```
|
2192
907
|
|
@@ -2194,12 +909,13 @@ end
|
|
2194
909
|
|
2195
910
|
| Name | Type | Description | Notes |
|
2196
911
|
| ---- | ---- | ----------- | ----- |
|
2197
|
-
| **
|
2198
|
-
| **
|
912
|
+
| **task_id** | **Integer** | | |
|
913
|
+
| **task_history_id** | **Integer** | | |
|
914
|
+
| **file_id** | **Integer** | | |
|
2199
915
|
|
2200
916
|
### Return type
|
2201
917
|
|
2202
|
-
[**
|
918
|
+
[**TaskHistoryFileMessage**](TaskHistoryFileMessage.md)
|
2203
919
|
|
2204
920
|
### Authorization
|
2205
921
|
|
@@ -2207,7 +923,7 @@ end
|
|
2207
923
|
|
2208
924
|
### HTTP request headers
|
2209
925
|
|
2210
|
-
- **Content-Type**:
|
926
|
+
- **Content-Type**: Not defined
|
2211
927
|
- **Accept**: application/json
|
2212
928
|
|
2213
929
|
|
@@ -2369,91 +1085,13 @@ end
|
|
2369
1085
|
- **Accept**: application/json
|
2370
1086
|
|
2371
1087
|
|
2372
|
-
## update_to_do_task
|
2373
|
-
|
2374
|
-
> <ToDoTaskMessage> update_to_do_task(to_do_task_id, to_do_task_put_message)
|
2375
|
-
|
2376
|
-
Update a to do task
|
2377
|
-
|
2378
|
-
Updates a to do task <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
2379
|
-
|
2380
|
-
### Examples
|
2381
|
-
|
2382
|
-
```ruby
|
2383
|
-
require 'time'
|
2384
|
-
require 'buildium-ruby'
|
2385
|
-
# setup authorization
|
2386
|
-
Buildium.configure do |config|
|
2387
|
-
# Configure API key authorization: clientId
|
2388
|
-
config.api_key['clientId'] = 'YOUR API KEY'
|
2389
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2390
|
-
# config.api_key_prefix['clientId'] = 'Bearer'
|
2391
|
-
|
2392
|
-
# Configure API key authorization: clientSecret
|
2393
|
-
config.api_key['clientSecret'] = 'YOUR API KEY'
|
2394
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2395
|
-
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
2396
|
-
end
|
2397
|
-
|
2398
|
-
api_instance = Buildium::TasksApi.new
|
2399
|
-
to_do_task_id = 56 # Integer | The to do task identifier.
|
2400
|
-
to_do_task_put_message = Buildium::ToDoTaskPutMessage.new({title: 'title_example', assigned_to_user_id: 37, task_status: 'New', priority: 'Low'}) # ToDoTaskPutMessage |
|
2401
|
-
|
2402
|
-
begin
|
2403
|
-
# Update a to do task
|
2404
|
-
result = api_instance.update_to_do_task(to_do_task_id, to_do_task_put_message)
|
2405
|
-
p result
|
2406
|
-
rescue Buildium::ApiError => e
|
2407
|
-
puts "Error when calling TasksApi->update_to_do_task: #{e}"
|
2408
|
-
end
|
2409
|
-
```
|
2410
|
-
|
2411
|
-
#### Using the update_to_do_task_with_http_info variant
|
2412
|
-
|
2413
|
-
This returns an Array which contains the response data, status code and headers.
|
2414
|
-
|
2415
|
-
> <Array(<ToDoTaskMessage>, Integer, Hash)> update_to_do_task_with_http_info(to_do_task_id, to_do_task_put_message)
|
2416
|
-
|
2417
|
-
```ruby
|
2418
|
-
begin
|
2419
|
-
# Update a to do task
|
2420
|
-
data, status_code, headers = api_instance.update_to_do_task_with_http_info(to_do_task_id, to_do_task_put_message)
|
2421
|
-
p status_code # => 2xx
|
2422
|
-
p headers # => { ... }
|
2423
|
-
p data # => <ToDoTaskMessage>
|
2424
|
-
rescue Buildium::ApiError => e
|
2425
|
-
puts "Error when calling TasksApi->update_to_do_task_with_http_info: #{e}"
|
2426
|
-
end
|
2427
|
-
```
|
2428
|
-
|
2429
|
-
### Parameters
|
2430
|
-
|
2431
|
-
| Name | Type | Description | Notes |
|
2432
|
-
| ---- | ---- | ----------- | ----- |
|
2433
|
-
| **to_do_task_id** | **Integer** | The to do task identifier. | |
|
2434
|
-
| **to_do_task_put_message** | [**ToDoTaskPutMessage**](ToDoTaskPutMessage.md) | | |
|
2435
|
-
|
2436
|
-
### Return type
|
2437
|
-
|
2438
|
-
[**ToDoTaskMessage**](ToDoTaskMessage.md)
|
2439
|
-
|
2440
|
-
### Authorization
|
2441
|
-
|
2442
|
-
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
2443
|
-
|
2444
|
-
### HTTP request headers
|
2445
|
-
|
2446
|
-
- **Content-Type**: application/json
|
2447
|
-
- **Accept**: application/json
|
2448
|
-
|
2449
|
-
|
2450
1088
|
## upload_task_history_file_request_async
|
2451
1089
|
|
2452
1090
|
> <FileUploadTicketMessage> upload_task_history_file_request_async(task_id, task_history_id, task_history_file_upload_post_message)
|
2453
1091
|
|
2454
1092
|
Upload a task history file
|
2455
1093
|
|
2456
|
-
Uploads a file and associates it to the specified task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br />Uploading a file requires making two API requests. Each step is outlined below. <br /><br /><strong>Step 1 - Save file metadata</strong><br /> The first step in the file upload process is to submit the file metadata to `/v1/tasks/{taskId}/history/{taskHistoryId}/uploadrequests`. The response of this call will contain a URL and a collection of form data that will be used in step 2 to generate the request for the file binary upload. <br /><br /><strong>NOTE:</strong> The response data will expire after 5 minutes. The file metadata will not be saved in the Buildium system if step 2 of this process is not completed successfully. <br /><br /><strong>Step 2 - Upload the file binary</strong><br /> Uploading the file binary will require using the response from step 1 to form a POST request to the Buildium file provider. Follow these steps to create the request: <br /> 1. Form a POST request using the value of the `BucketUrl` property as the URL. <br /><br /> 2. Set the `Content-Type` header to `multipart/form-data`. <br /><br /> 3. Copy the fields from the `FormData` property to this request as form-data key/value pairs. <br /><strong>NOTE:</strong> These values must added to the request form-data in the order they were received in the response. <br /><br /> 4. Lastly create a form-data key named `file` and set the value to the file binary. <br /><strong>NOTE:</strong> This must be the last field in the form-data list. <br /><br />This image shows what the POST request should look like if you're using Postman: <img src=\"file-upload-example.png\" /><br /><br /> 5. Send the POST request! A successful request will return with a `204 - NO CONTENT` HTTP response code. For any failure responses, please refer to <a target=\"_blank\" href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses\">AWS documentation</a> on REST error responses. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
1094
|
+
Uploads a file and associates it to the specified task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br />Uploading a file requires making two API requests. Each step is outlined below. <br /><br /><strong>Step 1 - Save file metadata</strong><br /> The first step in the file upload process is to submit the file metadata to `/v1/tasks/{taskId}/history/{taskHistoryId}/files/uploadrequests`. The response of this call will contain a URL and a collection of form data that will be used in step 2 to generate the request for the file binary upload. <br /><br /><strong>NOTE:</strong> The response data will expire after 5 minutes. The file metadata will not be saved in the Buildium system if step 2 of this process is not completed successfully. <br /><br /><strong>Step 2 - Upload the file binary</strong><br /> Uploading the file binary will require using the response from step 1 to form a POST request to the Buildium file provider. Follow these steps to create the request: <br /> 1. Form a POST request using the value of the `BucketUrl` property as the URL. <br /><br /> 2. Set the `Content-Type` header to `multipart/form-data`. <br /><br /> 3. Copy the fields from the `FormData` property to this request as form-data key/value pairs. <br /><strong>NOTE:</strong> These values must added to the request form-data in the order they were received in the response. <br /><br /> 4. Lastly create a form-data key named `file` and set the value to the file binary. <br /><strong>NOTE:</strong> This must be the last field in the form-data list. <br /><br />This image shows what the POST request should look like if you're using Postman: <img src=\"file-upload-example.png\" /><br /><br /> 5. Send the POST request! A successful request will return with a `204 - NO CONTENT` HTTP response code. For any failure responses, please refer to <a target=\"_blank\" href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses\">AWS documentation</a> on REST error responses. <br /><br /><strong>NOTE:</strong> The file identifier is not generated in this response. To retrieve the file identifier, call `/v1/files` and pass the `PhysicalFileName` value received from the response of this endpoint into the `physicalfilenames` query parameter. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
2457
1095
|
|
2458
1096
|
### Examples
|
2459
1097
|
|