buildium-ruby 2.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.github/workflows/ci.yml +27 -0
- data/.github/workflows/publish.yml +48 -0
- data/.gitignore +39 -0
- data/.openapi-generator/FILES +1215 -0
- data/.openapi-generator/VERSION +1 -0
- data/.openapi-generator/templates/ruby-client/gemspec.mustache +37 -0
- data/.openapi-generator/templates/ruby-client/partial_model_generic.mustache +371 -0
- data/.openapi-generator/templates/ruby-client/rubocop.mustache +124 -0
- data/.openapi-generator-ignore +26 -0
- data/.rspec +2 -0
- data/.rubocop.yml +124 -0
- data/CUSTOMIZATIONS.md +11 -0
- data/DOCS.md +811 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +75 -0
- data/README.md +118 -0
- data/Rakefile +10 -0
- data/bin/CUSTOMIZATIONS.md +11 -0
- data/bin/README.md +118 -0
- data/bin/config.yml +9 -0
- data/bin/rebuild.sh +49 -0
- data/bin/swagger.json +52218 -0
- data/buildium-ruby.gemspec +39 -0
- data/docs/AccountInfoMessage.md +26 -0
- data/docs/AccountingApi.md +2041 -0
- data/docs/AccountingEntityMessage.md +22 -0
- data/docs/AccountingEntitySaveMessage.md +20 -0
- data/docs/AccountingLockPeriodMessage.md +22 -0
- data/docs/AccountingSettingsMessage.md +28 -0
- data/docs/AddressMessage.md +30 -0
- data/docs/AdministrationApi.md +485 -0
- data/docs/AllTasksMessage.md +46 -0
- data/docs/AnnouncementMessage.md +30 -0
- data/docs/AnnouncementPostMessage.md +28 -0
- data/docs/AnnouncementSearchMessage.md +26 -0
- data/docs/AnnouncementSenderMessage.md +22 -0
- data/docs/ApiError.md +20 -0
- data/docs/ApiErrorResponse.md +22 -0
- data/docs/ApplianceMessage.md +26 -0
- data/docs/ApplicantApplicationMessage.md +24 -0
- data/docs/ApplicantGroupMessage.md +26 -0
- data/docs/ApplicantGroupPostMessage.md +20 -0
- data/docs/ApplicantGroupPutMessage.md +22 -0
- data/docs/ApplicantGroupSearchMessage.md +26 -0
- data/docs/ApplicantMessage.md +36 -0
- data/docs/ApplicantPostMessage.md +28 -0
- data/docs/ApplicantPutMessage.md +26 -0
- data/docs/ApplicantSearchMessage.md +32 -0
- data/docs/ApplicantsApi.md +1489 -0
- data/docs/ApplicationMessage.md +26 -0
- data/docs/ApplicationPutMessage.md +18 -0
- data/docs/ApplicationResponseFieldMessage.md +24 -0
- data/docs/ApplicationResponseMessage.md +22 -0
- data/docs/ApplicationSectionResponseMessage.md +18 -0
- data/docs/AssociationApplianceMessage.md +32 -0
- data/docs/AssociationAppliancePostMessage.md +32 -0
- data/docs/AssociationAppliancePutMessage.md +28 -0
- data/docs/AssociationApplianceSearchMessage.md +20 -0
- data/docs/AssociationApplianceServiceHistoryMessage.md +24 -0
- data/docs/AssociationApplianceServiceHistoryPostMessage.md +22 -0
- data/docs/AssociationAppliancesApi.md +646 -0
- data/docs/AssociationBoardMemberMessage.md +36 -0
- data/docs/AssociationBoardMemberPostMessage.md +24 -0
- data/docs/AssociationBoardMemberPutMessage.md +22 -0
- data/docs/AssociationBoardMemberSearchMessage.md +24 -0
- data/docs/AssociationMessage.md +40 -0
- data/docs/AssociationOwnerBoardTermMessage.md +28 -0
- data/docs/AssociationOwnerBoardTermPostMessage.md +22 -0
- data/docs/AssociationOwnerMessage.md +52 -0
- data/docs/AssociationOwnerPostMessage.md +44 -0
- data/docs/AssociationOwnerPutMessage.md +38 -0
- data/docs/AssociationOwnerToExistingOwnershipAccountPostMessage.md +48 -0
- data/docs/AssociationOwnerUnitOccupancyPutMessage.md +18 -0
- data/docs/AssociationOwnerUnitOccupancyStatusMessage.md +20 -0
- data/docs/AssociationOwnersApi.md +916 -0
- data/docs/AssociationOwnershipAccountMessage.md +34 -0
- data/docs/AssociationOwnershipAccountPostMessage.md +32 -0
- data/docs/AssociationOwnershipAccountPutMessage.md +18 -0
- data/docs/AssociationOwnershipAccountSearchMessage.md +28 -0
- data/docs/AssociationOwnershipAccountsApi.md +2042 -0
- data/docs/AssociationPostMessage.md +32 -0
- data/docs/AssociationPreferredVendorMessage.md +34 -0
- data/docs/AssociationPreferredVendorPutMessage.md +18 -0
- data/docs/AssociationPutMessage.md +34 -0
- data/docs/AssociationSearchMessage.md +24 -0
- data/docs/AssociationTenantMessage.md +44 -0
- data/docs/AssociationTenantPostMessage.md +42 -0
- data/docs/AssociationTenantPutMessage.md +38 -0
- data/docs/AssociationTenantsApi.md +671 -0
- data/docs/AssociationUnitMessage.md +32 -0
- data/docs/AssociationUnitPutMessage.md +26 -0
- data/docs/AssociationUnitSearchMessage.md +22 -0
- data/docs/AssociationUnitsApi.md +659 -0
- data/docs/AssociationUnitsPostMessage.md +28 -0
- data/docs/AssociationUserSearchMessage.md +34 -0
- data/docs/AssociationsApi.md +1235 -0
- data/docs/BankAccountCheckAccountingEntitySaveMessage.md +20 -0
- data/docs/BankAccountCheckLineMessage.md +28 -0
- data/docs/BankAccountCheckLineSaveMessage.md +26 -0
- data/docs/BankAccountCheckMessage.md +30 -0
- data/docs/BankAccountCheckPayeeMessage.md +22 -0
- data/docs/BankAccountCheckPayeeSaveMessage.md +20 -0
- data/docs/BankAccountCheckPostMessage.md +26 -0
- data/docs/BankAccountCheckPutMessage.md +26 -0
- data/docs/BankAccountCheckSearchMessage.md +20 -0
- data/docs/BankAccountDepositLineMessage.md +28 -0
- data/docs/BankAccountDepositLineSaveMessage.md +26 -0
- data/docs/BankAccountDepositMessage.md +28 -0
- data/docs/BankAccountDepositPostMessage.md +24 -0
- data/docs/BankAccountDepositPutMessage.md +22 -0
- data/docs/BankAccountDepositSearchMessage.md +20 -0
- data/docs/BankAccountMessage.md +40 -0
- data/docs/BankAccountPostMessage.md +30 -0
- data/docs/BankAccountPutMessage.md +30 -0
- data/docs/BankAccountQuickDepositMessage.md +28 -0
- data/docs/BankAccountQuickDepositSaveMessage.md +26 -0
- data/docs/BankAccountQuickDepositSearchMessage.md +20 -0
- data/docs/BankAccountSearchMessage.md +20 -0
- data/docs/BankAccountTransactionMessage.md +36 -0
- data/docs/BankAccountTransactionSearchMessage.md +24 -0
- data/docs/BankAccountTransferAccountingEntitySaveMessage.md +20 -0
- data/docs/BankAccountTransferMessage.md +28 -0
- data/docs/BankAccountTransferSaveMessage.md +26 -0
- data/docs/BankAccountTransferSearchMessage.md +20 -0
- data/docs/BankAccountWithdrawalMessage.md +28 -0
- data/docs/BankAccountWithdrawalSaveMessage.md +26 -0
- data/docs/BankAccountWithdrawalSearchMessage.md +20 -0
- data/docs/BankAccountsApi.md +2224 -0
- data/docs/BillFileMessage.md +28 -0
- data/docs/BillLineMessage.md +28 -0
- data/docs/BillLinePostMessage.md +26 -0
- data/docs/BillLinePutMessage.md +28 -0
- data/docs/BillMarkupMessage.md +20 -0
- data/docs/BillMarkupSaveMessage.md +20 -0
- data/docs/BillMessage.md +36 -0
- data/docs/BillPaymentAccountingEntityMessage.md +20 -0
- data/docs/BillPaymentLineMessage.md +22 -0
- data/docs/BillPaymentLinePostMessage.md +20 -0
- data/docs/BillPaymentMessage.md +28 -0
- data/docs/BillPaymentPostMessage.md +26 -0
- data/docs/BillPostMessage.md +30 -0
- data/docs/BillPutMessage.md +28 -0
- data/docs/BillSearchMessage.md +32 -0
- data/docs/BudgetDetailsMessage.md +24 -0
- data/docs/BudgetDetailsSaveMessage.md +20 -0
- data/docs/BudgetMessage.md +28 -0
- data/docs/BudgetMonthlyAmountsMessage.md +40 -0
- data/docs/BudgetMonthlyAmountsSaveMessage.md +40 -0
- data/docs/BudgetPostMessage.md +26 -0
- data/docs/BudgetPutMessage.md +20 -0
- data/docs/BudgetSearchMessage.md +22 -0
- data/docs/ChargeRecurringTransactionPostMessage.md +32 -0
- data/docs/ChargeRecurringTransactionPutMessage.md +34 -0
- data/docs/CheckPrintingInfoMessage.md +46 -0
- data/docs/CheckPrintingInfoPostMessage.md +46 -0
- data/docs/CheckPrintingInfoPutMessage.md +46 -0
- data/docs/ClientLeadCreditRequestMessage.md +24 -0
- data/docs/ClientLeadMessage.md +38 -0
- data/docs/ClientLeadSearchMessage.md +26 -0
- data/docs/ClientLeadsApi.md +177 -0
- data/docs/CommunicationsApi.md +1238 -0
- data/docs/ContactDetailMessage.md +24 -0
- data/docs/ContactDetailPhoneMessage.md +22 -0
- data/docs/ContactDetailSaveMessage.md +24 -0
- data/docs/ContactDetailSavePhoneMessage.md +22 -0
- data/docs/ContactInfoMessage.md +24 -0
- data/docs/ContactRequestTaskMessage.md +42 -0
- data/docs/ContactRequestTaskPostMessage.md +38 -0
- data/docs/ContactRequestTaskPutMessage.md +38 -0
- data/docs/ContactRequestTaskSearchMessage.md +40 -0
- data/docs/CosignerMessage.md +36 -0
- data/docs/CreatedByUserMessage.md +24 -0
- data/docs/CreditRecurringTransactionPostMessage.md +36 -0
- data/docs/DepositDetailMessage.md +20 -0
- data/docs/ElectronicPaymentsMessage.md +32 -0
- data/docs/EmailMessage.md +24 -0
- data/docs/EmailPostMessage.md +30 -0
- data/docs/EmailRecipientMessage.md +26 -0
- data/docs/EmailSearchMessage.md +26 -0
- data/docs/EmailSenderMessage.md +24 -0
- data/docs/EmergencyContactMessage.md +24 -0
- data/docs/FileCategoryMessage.md +22 -0
- data/docs/FileCategoryPostMessage.md +18 -0
- data/docs/FileCategoryPutMessage.md +18 -0
- data/docs/FileDownloadMessage.md +18 -0
- data/docs/FileEntityMessage.md +22 -0
- data/docs/FileMessage.md +34 -0
- data/docs/FileNamePostMessage.md +18 -0
- data/docs/FilePutMessage.md +22 -0
- data/docs/FileSearchMessage.md +30 -0
- data/docs/FileUploadPostMessage.md +28 -0
- data/docs/FileUploadTicketMessage.md +22 -0
- data/docs/FilesApi.md +730 -0
- data/docs/GLAccountBalanceItemMessage.md +20 -0
- data/docs/GLAccountBalanceMessage.md +22 -0
- data/docs/GLAccountBalanceSearchMessage.md +26 -0
- data/docs/GLAccountMessage.md +46 -0
- data/docs/GLAccountPostMessage.md +32 -0
- data/docs/GLAccountPutMessage.md +32 -0
- data/docs/GLAccountsSearchMessage.md +18 -0
- data/docs/GLTransactionMessageV1.md +26 -0
- data/docs/GeneralJournalEntryLineSaveMessage.md +24 -0
- data/docs/GeneralJournalEntryPostMessage.md +24 -0
- data/docs/GeneralJournalEntryPutMessage.md +24 -0
- data/docs/GeneralLedgerJournalLineMessage.md +28 -0
- data/docs/GeneralLedgerJournalMessage.md +20 -0
- data/docs/GeneralLedgerTransactionMessage.md +38 -0
- data/docs/GeneralLedgerTransactionSearchMessage.md +26 -0
- data/docs/InternalTransactionStatusMessage.md +22 -0
- data/docs/JournalLineMessage.md +28 -0
- data/docs/JournalMessage.md +20 -0
- data/docs/LastUpdatedByUserMessage.md +26 -0
- data/docs/LeaseAccountDetailMessage.md +20 -0
- data/docs/LeaseChargeLineSaveMessage.md +22 -0
- data/docs/LeaseChargePostMessage.md +22 -0
- data/docs/LeaseChargePutMessage.md +22 -0
- data/docs/LeaseChargeRecurringTransactionMessage.md +40 -0
- data/docs/LeaseCosignerPostMessage.md +32 -0
- data/docs/LeaseLedgerCreditLinePostMessage.md +20 -0
- data/docs/LeaseLedgerCreditPostMessage.md +26 -0
- data/docs/LeaseLedgerDepositWithholdingLinePostMessage.md +20 -0
- data/docs/LeaseLedgerDepositWithholdingPostMessage.md +24 -0
- data/docs/LeaseLedgerPaymentLineSaveMessage.md +20 -0
- data/docs/LeaseLedgerPaymentPostMessage.md +30 -0
- data/docs/LeaseLedgerRefundLineMessage.md +20 -0
- data/docs/LeaseLedgerRefundLinePostMessage.md +20 -0
- data/docs/LeaseLedgerRefundMessage.md +34 -0
- data/docs/LeaseLedgerRefundPostMessage.md +30 -0
- data/docs/LeaseLedgerReversePaymentNSFChargePostMessage.md +20 -0
- data/docs/LeaseLedgerReversePaymentOtherBankChargePostMessage.md +20 -0
- data/docs/LeaseLedgerReversePaymentPostMessage.md +24 -0
- data/docs/LeaseMessage.md +58 -0
- data/docs/LeaseMoveOutDataMessage.md +22 -0
- data/docs/LeaseMoveOutDataPostMessage.md +22 -0
- data/docs/LeaseOutstandingBalanceMessage.md +40 -0
- data/docs/LeaseOutstandingBalanceSearchMessage.md +30 -0
- data/docs/LeasePostMessage.md +38 -0
- data/docs/LeasePutMessage.md +28 -0
- data/docs/LeaseRecurringCreditMessage.md +44 -0
- data/docs/LeaseRecurringPaymentMessage.md +42 -0
- data/docs/LeaseRenewalMessage.md +32 -0
- data/docs/LeaseRenewalPostMessage.md +38 -0
- data/docs/LeaseRentChargeMessage.md +30 -0
- data/docs/LeaseRentChargePostMessage.md +24 -0
- data/docs/LeaseRentMessage.md +34 -0
- data/docs/LeaseRentPostMessage.md +20 -0
- data/docs/LeaseSearchMessage.md +40 -0
- data/docs/LeaseSecurityDepositPostMessage.md +20 -0
- data/docs/LeaseTenantMessage.md +20 -0
- data/docs/LeaseTransactionMessage.md +34 -0
- data/docs/LeaseTransactionSearchMessage.md +22 -0
- data/docs/LeasesApi.md +2865 -0
- data/docs/ListingContactMessage.md +26 -0
- data/docs/ListingContactSaveMessage.md +24 -0
- data/docs/ListingFileMessage.md +22 -0
- data/docs/ListingMessage.md +36 -0
- data/docs/ListingPropertyMessage.md +34 -0
- data/docs/ListingPutMessage.md +28 -0
- data/docs/ListingSearchMessage.md +20 -0
- data/docs/ListingUnitMessage.md +36 -0
- data/docs/ListingsApi.md +642 -0
- data/docs/LockPeriodSettingsGlobalMessage.md +18 -0
- data/docs/LockPeriodSettingsOverridesMessage.md +20 -0
- data/docs/LoggedByStaffUserMessage.md +24 -0
- data/docs/LookupMessage.md +20 -0
- data/docs/MailingTemplateMessage.md +24 -0
- data/docs/NoteMessage.md +22 -0
- data/docs/NotePostMessage.md +18 -0
- data/docs/NotePutMessage.md +18 -0
- data/docs/NoteSearchMessage.md +22 -0
- data/docs/OutstandingBalancesLineMessage.md +20 -0
- data/docs/OwnershipAccountChargeRecurringTransactionMessage.md +40 -0
- data/docs/OwnershipAccountCreditLinePostMessage.md +20 -0
- data/docs/OwnershipAccountCreditPostMessage.md +26 -0
- data/docs/OwnershipAccountDepositWithholdingLinePostMessage.md +20 -0
- data/docs/OwnershipAccountDepositWithholdingPostMessage.md +24 -0
- data/docs/OwnershipAccountLedgerChargeLinesPutMessage.md +22 -0
- data/docs/OwnershipAccountLedgerChargeLinesSaveMessage.md +20 -0
- data/docs/OwnershipAccountLedgerChargePostMessage.md +22 -0
- data/docs/OwnershipAccountLedgerChargePutMessage.md +22 -0
- data/docs/OwnershipAccountLedgerPaymentLineSaveMessage.md +20 -0
- data/docs/OwnershipAccountLedgerPaymentPostMessage.md +30 -0
- data/docs/OwnershipAccountOutstandingBalanceMessage.md +36 -0
- data/docs/OwnershipAccountOutstandingBalanceSearchMessage.md +26 -0
- data/docs/OwnershipAccountRecurringCreditMessage.md +44 -0
- data/docs/OwnershipAccountRecurringPaymentMessage.md +42 -0
- data/docs/OwnershipAccountRefundLineMessage.md +20 -0
- data/docs/OwnershipAccountRefundLinesPostMessage.md +20 -0
- data/docs/OwnershipAccountRefundMessage.md +34 -0
- data/docs/OwnershipAccountRefundPostMessage.md +30 -0
- data/docs/OwnershipAccountTransactionMessage.md +34 -0
- data/docs/PaidByMessage.md +20 -0
- data/docs/ParticipantMessage.md +22 -0
- data/docs/ParticipantResourceMessage.md +20 -0
- data/docs/PayeeMessage.md +24 -0
- data/docs/PaymentDetailMessage.md +24 -0
- data/docs/PaymentRecurringTransactionPostMessage.md +34 -0
- data/docs/PaymentTransactionsMessage.md +22 -0
- data/docs/PhoneLogMessage.md +28 -0
- data/docs/PhoneLogParticipantPostMessage.md +22 -0
- data/docs/PhoneLogParticipantUnitAgreementPostMessage.md +20 -0
- data/docs/PhoneLogPostMessage.md +24 -0
- data/docs/PhoneLogPutMessage.md +22 -0
- data/docs/PhoneLogSearchMessage.md +32 -0
- data/docs/PhoneNumberMessage.md +20 -0
- data/docs/PhoneNumbersMessage.md +24 -0
- data/docs/PropertyGroupMessage.md +26 -0
- data/docs/PropertyGroupPostMessage.md +22 -0
- data/docs/PropertyGroupPutMessage.md +22 -0
- data/docs/PropertyGroupSearchMessage.md +20 -0
- data/docs/PropertyGroupsApi.md +327 -0
- data/docs/PropertyManagerMessage.md +32 -0
- data/docs/PropertyMessage.md +22 -0
- data/docs/RecurringTransactionLineMessage.md +20 -0
- data/docs/RecurringTransactionLinePostMessage.md +20 -0
- data/docs/RecurringTransactionMessage.md +40 -0
- data/docs/RentalApplianceMessage.md +32 -0
- data/docs/RentalAppliancePostMessage.md +32 -0
- data/docs/RentalAppliancePutMessage.md +28 -0
- data/docs/RentalApplianceSearchMessage.md +20 -0
- data/docs/RentalApplianceServiceHistoryMessage.md +24 -0
- data/docs/RentalApplianceServiceHistoryPostMessage.md +22 -0
- data/docs/RentalAppliancesApi.md +646 -0
- data/docs/RentalFeaturesMessage.md +20 -0
- data/docs/RentalFeaturesPutMessage.md +20 -0
- data/docs/RentalMessage.md +40 -0
- data/docs/RentalOwnerMessage.md +46 -0
- data/docs/RentalOwnerPostMessage.md +44 -0
- data/docs/RentalOwnerPutMessage.md +42 -0
- data/docs/RentalOwnerRequestTaskMessage.md +42 -0
- data/docs/RentalOwnerRequestTaskPostMessage.md +38 -0
- data/docs/RentalOwnerRequestTaskPutMessage.md +36 -0
- data/docs/RentalOwnerRequestTaskSearchMessage.md +40 -0
- data/docs/RentalOwnerTaxInformationMessage.md +28 -0
- data/docs/RentalOwnersApi.md +667 -0
- data/docs/RentalOwnersSearchMessage.md +30 -0
- data/docs/RentalPreferredVendorMessage.md +34 -0
- data/docs/RentalPreferredVendorPutMessage.md +18 -0
- data/docs/RentalPropertiesApi.md +989 -0
- data/docs/RentalPropertyPostMessage.md +36 -0
- data/docs/RentalPropertyPutMessage.md +32 -0
- data/docs/RentalPropertyUnitPostMessage.md +30 -0
- data/docs/RentalSearchMessage.md +32 -0
- data/docs/RentalTenantPostMessage.md +42 -0
- data/docs/RentalTenantPutMessage.md +40 -0
- data/docs/RentalTenantRenewalPostMessage.md +40 -0
- data/docs/RentalTenantsApi.md +673 -0
- data/docs/RentalUnitFeaturesMessage.md +18 -0
- data/docs/RentalUnitFeaturesPutMessage.md +18 -0
- data/docs/RentalUnitMessage.md +40 -0
- data/docs/RentalUnitPutMessage.md +30 -0
- data/docs/RentalUnitSearchMessage.md +22 -0
- data/docs/RentalUnitsApi.md +815 -0
- data/docs/RentalUnitsPostMessage.md +32 -0
- data/docs/RequestedByUserEntityMessage.md +28 -0
- data/docs/ResidentCenterApi.md +100 -0
- data/docs/ResidentCenterUserMessage.md +24 -0
- data/docs/ResidentCenterUserReferenceMessage.md +26 -0
- data/docs/ResidentCenterUserSearchMessage.md +26 -0
- data/docs/ResidentRequestTaskMessage.md +52 -0
- data/docs/ResidentRequestTaskPostMessage.md +42 -0
- data/docs/ResidentRequestTaskPutMessage.md +32 -0
- data/docs/ResidentRequestTaskSearchMessage.md +42 -0
- data/docs/SaveAddressMessage.md +30 -0
- data/docs/SaveEmergencyContactMessage.md +24 -0
- data/docs/TaskCategoryMessage.md +24 -0
- data/docs/TaskCategoryPutMessage.md +18 -0
- data/docs/TaskCategoryResponseMessage.md +24 -0
- data/docs/TaskCategorySaveMessage.md +18 -0
- data/docs/TaskHistoryFileMessage.md +28 -0
- data/docs/TaskHistoryFileUploadPostMessage.md +18 -0
- data/docs/TaskHistoryMessage.md +40 -0
- data/docs/TaskHistoryPutMessage.md +18 -0
- data/docs/TaskHistoryUserMessage.md +24 -0
- data/docs/TaskSearchMessage.md +44 -0
- data/docs/TaskSubCategoryMessage.md +20 -0
- data/docs/TasksApi.md +2528 -0
- data/docs/TaxInformationPostMessage.md +26 -0
- data/docs/TaxInformationSaveMessage.md +28 -0
- data/docs/TenantMessage.md +48 -0
- data/docs/TenantSearchMessage.md +36 -0
- data/docs/ToDoTaskMessage.md +40 -0
- data/docs/ToDoTaskPostMessage.md +36 -0
- data/docs/ToDoTaskPutMessage.md +36 -0
- data/docs/ToDoTaskSearchMessage.md +40 -0
- data/docs/UndepositedFundsMessage.md +18 -0
- data/docs/UnitAgreementMessage.md +22 -0
- data/docs/UserMessage.md +40 -0
- data/docs/UserRoleMessage.md +24 -0
- data/docs/UserSearchMessage.md +26 -0
- data/docs/VehicleMessage.md +24 -0
- data/docs/VendorCategoryMessage.md +22 -0
- data/docs/VendorCategorySaveMessage.md +18 -0
- data/docs/VendorCreditLineItemMessage.md +26 -0
- data/docs/VendorCreditLineItemPostMessage.md +24 -0
- data/docs/VendorCreditMessage.md +26 -0
- data/docs/VendorCreditPostMessage.md +24 -0
- data/docs/VendorInsuranceMessage.md +22 -0
- data/docs/VendorInsuranceSaveMessage.md +22 -0
- data/docs/VendorMessage.md +50 -0
- data/docs/VendorPostMessage.md +46 -0
- data/docs/VendorPutMessage.md +46 -0
- data/docs/VendorRefundLineMessage.md +26 -0
- data/docs/VendorRefundLinePostMessage.md +24 -0
- data/docs/VendorRefundMessage.md +30 -0
- data/docs/VendorRefundPostMessage.md +28 -0
- data/docs/VendorSearchMessage.md +32 -0
- data/docs/VendorTaxInformationMessage.md +28 -0
- data/docs/VendorTransactionMessage.md +28 -0
- data/docs/VendorTransactionSearchMessage.md +26 -0
- data/docs/VendorsApi.md +1396 -0
- data/docs/WorkOrderEntryContactMessage.md +20 -0
- data/docs/WorkOrderEntryContactResourceMessage.md +20 -0
- data/docs/WorkOrderLineItemMessage.md +24 -0
- data/docs/WorkOrderLineItemSaveMessage.md +24 -0
- data/docs/WorkOrderMessage.md +42 -0
- data/docs/WorkOrderPostMessage.md +38 -0
- data/docs/WorkOrderPutMessage.md +34 -0
- data/docs/WorkOrderSearchMessage.md +54 -0
- data/docs/WorkOrderTaskMessage.md +32 -0
- data/docs/WorkOrderTaskPostMessage.md +30 -0
- data/docs/WorkOrdersApi.md +361 -0
- data/lib/buildium-ruby/api/accounting_api.rb +1855 -0
- data/lib/buildium-ruby/api/administration_api.rb +417 -0
- data/lib/buildium-ruby/api/applicants_api.rb +1368 -0
- data/lib/buildium-ruby/api/association_appliances_api.rb +577 -0
- data/lib/buildium-ruby/api/association_owners_api.rb +849 -0
- data/lib/buildium-ruby/api/association_ownership_accounts_api.rb +1890 -0
- data/lib/buildium-ruby/api/association_tenants_api.rb +628 -0
- data/lib/buildium-ruby/api/association_units_api.rb +606 -0
- data/lib/buildium-ruby/api/associations_api.rb +1143 -0
- data/lib/buildium-ruby/api/bank_accounts_api.rb +2085 -0
- data/lib/buildium-ruby/api/client_leads_api.rb +174 -0
- data/lib/buildium-ruby/api/communications_api.rb +1097 -0
- data/lib/buildium-ruby/api/files_api.rb +652 -0
- data/lib/buildium-ruby/api/leases_api.rb +2636 -0
- data/lib/buildium-ruby/api/listings_api.rb +569 -0
- data/lib/buildium-ruby/api/property_groups_api.rb +299 -0
- data/lib/buildium-ruby/api/rental_appliances_api.rb +577 -0
- data/lib/buildium-ruby/api/rental_owners_api.rb +622 -0
- data/lib/buildium-ruby/api/rental_properties_api.rb +916 -0
- data/lib/buildium-ruby/api/rental_tenants_api.rb +635 -0
- data/lib/buildium-ruby/api/rental_units_api.rb +743 -0
- data/lib/buildium-ruby/api/resident_center_api.rb +111 -0
- data/lib/buildium-ruby/api/tasks_api.rb +2363 -0
- data/lib/buildium-ruby/api/vendors_api.rb +1285 -0
- data/lib/buildium-ruby/api/work_orders_api.rb +366 -0
- data/lib/buildium-ruby/api_client.rb +426 -0
- data/lib/buildium-ruby/api_error.rb +57 -0
- data/lib/buildium-ruby/configuration.rb +319 -0
- data/lib/buildium-ruby/models/account_info_message.rb +257 -0
- data/lib/buildium-ruby/models/accounting_entity_message.rb +273 -0
- data/lib/buildium-ruby/models/accounting_entity_save_message.rb +273 -0
- data/lib/buildium-ruby/models/accounting_lock_period_message.rb +242 -0
- data/lib/buildium-ruby/models/accounting_settings_message.rb +314 -0
- data/lib/buildium-ruby/models/address_message.rb +313 -0
- data/lib/buildium-ruby/models/all_tasks_message.rb +413 -0
- data/lib/buildium-ruby/models/announcement_message.rb +301 -0
- data/lib/buildium-ruby/models/announcement_post_message.rb +295 -0
- data/lib/buildium-ruby/models/announcement_search_message.rb +292 -0
- data/lib/buildium-ruby/models/announcement_sender_message.rb +239 -0
- data/lib/buildium-ruby/models/api_error_response.rb +237 -0
- data/lib/buildium-ruby/models/appliance_message.rb +259 -0
- data/lib/buildium-ruby/models/applicant_application_message.rb +282 -0
- data/lib/buildium-ruby/models/applicant_group_message.rb +294 -0
- data/lib/buildium-ruby/models/applicant_group_post_message.rb +235 -0
- data/lib/buildium-ruby/models/applicant_group_put_message.rb +284 -0
- data/lib/buildium-ruby/models/applicant_group_search_message.rb +296 -0
- data/lib/buildium-ruby/models/applicant_message.rb +312 -0
- data/lib/buildium-ruby/models/applicant_post_message.rb +283 -0
- data/lib/buildium-ruby/models/applicant_put_message.rb +267 -0
- data/lib/buildium-ruby/models/applicant_search_message.rb +326 -0
- data/lib/buildium-ruby/models/application_message.rb +294 -0
- data/lib/buildium-ruby/models/application_put_message.rb +257 -0
- data/lib/buildium-ruby/models/application_response_field_message.rb +294 -0
- data/lib/buildium-ruby/models/application_response_message.rb +274 -0
- data/lib/buildium-ruby/models/application_section_response_message.rb +219 -0
- data/lib/buildium-ruby/models/association_appliance_message.rb +288 -0
- data/lib/buildium-ruby/models/association_appliance_post_message.rb +298 -0
- data/lib/buildium-ruby/models/association_appliance_put_message.rb +273 -0
- data/lib/buildium-ruby/models/association_appliance_search_message.rb +232 -0
- data/lib/buildium-ruby/models/association_appliance_service_history_message.rb +282 -0
- data/lib/buildium-ruby/models/association_appliance_service_history_post_message.rb +282 -0
- data/lib/buildium-ruby/models/association_board_member_message.rb +344 -0
- data/lib/buildium-ruby/models/association_board_member_post_message.rb +293 -0
- data/lib/buildium-ruby/models/association_board_member_put_message.rb +278 -0
- data/lib/buildium-ruby/models/association_board_member_search_message.rb +274 -0
- data/lib/buildium-ruby/models/association_message.rb +327 -0
- data/lib/buildium-ruby/models/association_owner_board_term_message.rb +303 -0
- data/lib/buildium-ruby/models/association_owner_board_term_post_message.rb +278 -0
- data/lib/buildium-ruby/models/association_owner_message.rb +440 -0
- data/lib/buildium-ruby/models/association_owner_post_message.rb +398 -0
- data/lib/buildium-ruby/models/association_owner_put_message.rb +363 -0
- data/lib/buildium-ruby/models/association_owner_to_existing_ownership_account_post_message.rb +428 -0
- data/lib/buildium-ruby/models/association_owner_unit_occupancy_put_message.rb +223 -0
- data/lib/buildium-ruby/models/association_owner_unit_occupancy_status_message.rb +228 -0
- data/lib/buildium-ruby/models/association_ownership_account_message.rb +347 -0
- data/lib/buildium-ruby/models/association_ownership_account_post_message.rb +346 -0
- data/lib/buildium-ruby/models/association_ownership_account_put_message.rb +223 -0
- data/lib/buildium-ruby/models/association_ownership_account_search_message.rb +296 -0
- data/lib/buildium-ruby/models/association_post_message.rb +302 -0
- data/lib/buildium-ruby/models/association_preferred_vendor_message.rb +300 -0
- data/lib/buildium-ruby/models/association_preferred_vendor_put_message.rb +225 -0
- data/lib/buildium-ruby/models/association_put_message.rb +322 -0
- data/lib/buildium-ruby/models/association_search_message.rb +283 -0
- data/lib/buildium-ruby/models/association_tenant_message.rb +350 -0
- data/lib/buildium-ruby/models/association_tenant_post_message.rb +354 -0
- data/lib/buildium-ruby/models/association_tenant_put_message.rb +329 -0
- data/lib/buildium-ruby/models/association_unit_message.rb +334 -0
- data/lib/buildium-ruby/models/association_unit_put_message.rb +313 -0
- data/lib/buildium-ruby/models/association_unit_search_message.rb +241 -0
- data/lib/buildium-ruby/models/association_units_post_message.rb +328 -0
- data/lib/buildium-ruby/models/association_user_search_message.rb +324 -0
- data/lib/buildium-ruby/models/bank_account_check_accounting_entity_save_message.rb +272 -0
- data/lib/buildium-ruby/models/bank_account_check_line_message.rb +267 -0
- data/lib/buildium-ruby/models/bank_account_check_line_save_message.rb +272 -0
- data/lib/buildium-ruby/models/bank_account_check_message.rb +279 -0
- data/lib/buildium-ruby/models/bank_account_check_payee_message.rb +272 -0
- data/lib/buildium-ruby/models/bank_account_check_payee_save_message.rb +272 -0
- data/lib/buildium-ruby/models/bank_account_check_post_message.rb +274 -0
- data/lib/buildium-ruby/models/bank_account_check_put_message.rb +274 -0
- data/lib/buildium-ruby/models/bank_account_check_search_message.rb +238 -0
- data/lib/buildium-ruby/models/bank_account_deposit_line_message.rb +267 -0
- data/lib/buildium-ruby/models/bank_account_deposit_line_save_message.rb +257 -0
- data/lib/buildium-ruby/models/bank_account_deposit_message.rb +272 -0
- data/lib/buildium-ruby/models/bank_account_deposit_post_message.rb +257 -0
- data/lib/buildium-ruby/models/bank_account_deposit_put_message.rb +250 -0
- data/lib/buildium-ruby/models/bank_account_deposit_search_message.rb +238 -0
- data/lib/buildium-ruby/models/bank_account_message.rb +360 -0
- data/lib/buildium-ruby/models/bank_account_post_message.rb +338 -0
- data/lib/buildium-ruby/models/bank_account_put_message.rb +343 -0
- data/lib/buildium-ruby/models/bank_account_quick_deposit_message.rb +267 -0
- data/lib/buildium-ruby/models/bank_account_quick_deposit_save_message.rb +277 -0
- data/lib/buildium-ruby/models/bank_account_quick_deposit_search_message.rb +238 -0
- data/lib/buildium-ruby/models/bank_account_search_message.rb +263 -0
- data/lib/buildium-ruby/models/bank_account_transaction_message.rb +359 -0
- data/lib/buildium-ruby/models/bank_account_transaction_search_message.rb +292 -0
- data/lib/buildium-ruby/models/bank_account_transfer_accounting_entity_save_message.rb +272 -0
- data/lib/buildium-ruby/models/bank_account_transfer_message.rb +267 -0
- data/lib/buildium-ruby/models/bank_account_transfer_save_message.rb +277 -0
- data/lib/buildium-ruby/models/bank_account_transfer_search_message.rb +238 -0
- data/lib/buildium-ruby/models/bank_account_withdrawal_message.rb +267 -0
- data/lib/buildium-ruby/models/bank_account_withdrawal_save_message.rb +277 -0
- data/lib/buildium-ruby/models/bank_account_withdrawal_search_message.rb +238 -0
- data/lib/buildium-ruby/models/bill_file_message.rb +268 -0
- data/lib/buildium-ruby/models/bill_line_message.rb +266 -0
- data/lib/buildium-ruby/models/bill_line_post_message.rb +272 -0
- data/lib/buildium-ruby/models/bill_line_put_message.rb +282 -0
- data/lib/buildium-ruby/models/bill_markup_message.rb +263 -0
- data/lib/buildium-ruby/models/bill_markup_save_message.rb +273 -0
- data/lib/buildium-ruby/models/bill_message.rb +344 -0
- data/lib/buildium-ruby/models/bill_payment_accounting_entity_message.rb +263 -0
- data/lib/buildium-ruby/models/bill_payment_line_message.rb +238 -0
- data/lib/buildium-ruby/models/bill_payment_line_post_message.rb +238 -0
- data/lib/buildium-ruby/models/bill_payment_message.rb +270 -0
- data/lib/buildium-ruby/models/bill_payment_post_message.rb +275 -0
- data/lib/buildium-ruby/models/bill_post_message.rb +301 -0
- data/lib/buildium-ruby/models/bill_put_message.rb +286 -0
- data/lib/buildium-ruby/models/bill_search_message.rb +336 -0
- data/lib/buildium-ruby/models/budget_details_message.rb +281 -0
- data/lib/buildium-ruby/models/budget_details_save_message.rb +237 -0
- data/lib/buildium-ruby/models/budget_message.rb +269 -0
- data/lib/buildium-ruby/models/budget_monthly_amounts_message.rb +328 -0
- data/lib/buildium-ruby/models/budget_monthly_amounts_save_message.rb +388 -0
- data/lib/buildium-ruby/models/budget_post_message.rb +319 -0
- data/lib/buildium-ruby/models/budget_put_message.rb +240 -0
- data/lib/buildium-ruby/models/budget_search_message.rb +240 -0
- data/lib/buildium-ruby/models/charge_recurring_transaction_post_message.rb +359 -0
- data/lib/buildium-ruby/models/charge_recurring_transaction_put_message.rb +374 -0
- data/lib/buildium-ruby/models/check_printing_info_message.rb +392 -0
- data/lib/buildium-ruby/models/check_printing_info_post_message.rb +392 -0
- data/lib/buildium-ruby/models/check_printing_info_put_message.rb +407 -0
- data/lib/buildium-ruby/models/client_lead_credit_request_message.rb +295 -0
- data/lib/buildium-ruby/models/client_lead_message.rb +363 -0
- data/lib/buildium-ruby/models/client_lead_search_message.rb +285 -0
- data/lib/buildium-ruby/models/contact_detail_message.rb +248 -0
- data/lib/buildium-ruby/models/contact_detail_phone_message.rb +239 -0
- data/lib/buildium-ruby/models/contact_detail_save_message.rb +253 -0
- data/lib/buildium-ruby/models/contact_detail_save_phone_message.rb +239 -0
- data/lib/buildium-ruby/models/contact_info_message.rb +248 -0
- data/lib/buildium-ruby/models/contact_request_task_message.rb +381 -0
- data/lib/buildium-ruby/models/contact_request_task_post_message.rb +388 -0
- data/lib/buildium-ruby/models/contact_request_task_put_message.rb +388 -0
- data/lib/buildium-ruby/models/contact_request_task_search_message.rb +366 -0
- data/lib/buildium-ruby/models/cosigner_message.rb +343 -0
- data/lib/buildium-ruby/models/created_by_user_message.rb +248 -0
- data/lib/buildium-ruby/models/credit_recurring_transaction_post_message.rb +388 -0
- data/lib/buildium-ruby/models/deposit_detail_message.rb +231 -0
- data/lib/buildium-ruby/models/electronic_payments_message.rb +288 -0
- data/lib/buildium-ruby/models/email_message.rb +247 -0
- data/lib/buildium-ruby/models/email_post_message.rb +307 -0
- data/lib/buildium-ruby/models/email_recipient_message.rb +292 -0
- data/lib/buildium-ruby/models/email_search_message.rb +268 -0
- data/lib/buildium-ruby/models/email_sender_message.rb +248 -0
- data/lib/buildium-ruby/models/emergency_contact_message.rb +249 -0
- data/lib/buildium-ruby/models/file_category_message.rb +239 -0
- data/lib/buildium-ruby/models/file_category_post_message.rb +224 -0
- data/lib/buildium-ruby/models/file_category_put_message.rb +224 -0
- data/lib/buildium-ruby/models/file_download_message.rb +218 -0
- data/lib/buildium-ruby/models/file_entity_message.rb +273 -0
- data/lib/buildium-ruby/models/file_message.rb +297 -0
- data/lib/buildium-ruby/models/file_name_post_message.rb +223 -0
- data/lib/buildium-ruby/models/file_put_message.rb +248 -0
- data/lib/buildium-ruby/models/file_search_message.rb +315 -0
- data/lib/buildium-ruby/models/file_upload_post_message.rb +322 -0
- data/lib/buildium-ruby/models/file_upload_ticket_message.rb +240 -0
- data/lib/buildium-ruby/models/general_journal_entry_line_save_message.rb +297 -0
- data/lib/buildium-ruby/models/general_journal_entry_post_message.rb +264 -0
- data/lib/buildium-ruby/models/general_journal_entry_put_message.rb +264 -0
- data/lib/buildium-ruby/models/general_ledger_journal_line_message.rb +267 -0
- data/lib/buildium-ruby/models/general_ledger_journal_message.rb +230 -0
- data/lib/buildium-ruby/models/general_ledger_transaction_message.rb +349 -0
- data/lib/buildium-ruby/models/general_ledger_transaction_search_message.rb +310 -0
- data/lib/buildium-ruby/models/gl_account_balance_item_message.rb +228 -0
- data/lib/buildium-ruby/models/gl_account_balance_message.rb +240 -0
- data/lib/buildium-ruby/models/gl_account_balance_search_message.rb +317 -0
- data/lib/buildium-ruby/models/gl_account_message.rb +419 -0
- data/lib/buildium-ruby/models/gl_account_post_message.rb +349 -0
- data/lib/buildium-ruby/models/gl_account_put_message.rb +344 -0
- data/lib/buildium-ruby/models/gl_accounts_search_message.rb +243 -0
- data/lib/buildium-ruby/models/gl_transaction_message_v1.rb +258 -0
- data/lib/buildium-ruby/models/internal_transaction_status_message.rb +239 -0
- data/lib/buildium-ruby/models/journal_line_message.rb +268 -0
- data/lib/buildium-ruby/models/journal_message.rb +230 -0
- data/lib/buildium-ruby/models/last_updated_by_user_message.rb +259 -0
- data/lib/buildium-ruby/models/lease_account_detail_message.rb +229 -0
- data/lib/buildium-ruby/models/lease_charge_line_save_message.rb +249 -0
- data/lib/buildium-ruby/models/lease_charge_post_message.rb +241 -0
- data/lib/buildium-ruby/models/lease_charge_put_message.rb +250 -0
- data/lib/buildium-ruby/models/lease_charge_recurring_transaction_message.rb +374 -0
- data/lib/buildium-ruby/models/lease_cosigner_post_message.rb +330 -0
- data/lib/buildium-ruby/models/lease_ledger_credit_line_post_message.rb +239 -0
- data/lib/buildium-ruby/models/lease_ledger_credit_post_message.rb +309 -0
- data/lib/buildium-ruby/models/lease_ledger_deposit_withholding_line_post_message.rb +238 -0
- data/lib/buildium-ruby/models/lease_ledger_deposit_withholding_post_message.rb +260 -0
- data/lib/buildium-ruby/models/lease_ledger_payment_line_save_message.rb +239 -0
- data/lib/buildium-ruby/models/lease_ledger_payment_post_message.rb +335 -0
- data/lib/buildium-ruby/models/lease_ledger_refund_line_message.rb +228 -0
- data/lib/buildium-ruby/models/lease_ledger_refund_line_post_message.rb +238 -0
- data/lib/buildium-ruby/models/lease_ledger_refund_message.rb +301 -0
- data/lib/buildium-ruby/models/lease_ledger_refund_post_message.rb +306 -0
- data/lib/buildium-ruby/models/lease_ledger_reverse_payment_nsf_charge_post_message.rb +239 -0
- data/lib/buildium-ruby/models/lease_ledger_reverse_payment_other_bank_charge_post_message.rb +239 -0
- data/lib/buildium-ruby/models/lease_ledger_reverse_payment_post_message.rb +256 -0
- data/lib/buildium-ruby/models/lease_message.rb +496 -0
- data/lib/buildium-ruby/models/lease_move_out_data_message.rb +238 -0
- data/lib/buildium-ruby/models/lease_move_out_data_post_message.rb +248 -0
- data/lib/buildium-ruby/models/lease_outstanding_balance_message.rb +330 -0
- data/lib/buildium-ruby/models/lease_outstanding_balance_search_message.rb +345 -0
- data/lib/buildium-ruby/models/lease_post_message.rb +379 -0
- data/lib/buildium-ruby/models/lease_put_message.rb +322 -0
- data/lib/buildium-ruby/models/lease_recurring_credit_message.rb +408 -0
- data/lib/buildium-ruby/models/lease_recurring_payment_message.rb +397 -0
- data/lib/buildium-ruby/models/lease_renewal_message.rb +336 -0
- data/lib/buildium-ruby/models/lease_renewal_post_message.rb +378 -0
- data/lib/buildium-ruby/models/lease_rent_charge_message.rb +278 -0
- data/lib/buildium-ruby/models/lease_rent_charge_post_message.rb +263 -0
- data/lib/buildium-ruby/models/lease_rent_message.rb +334 -0
- data/lib/buildium-ruby/models/lease_rent_post_message.rb +275 -0
- data/lib/buildium-ruby/models/lease_search_message.rb +359 -0
- data/lib/buildium-ruby/models/lease_security_deposit_post_message.rb +239 -0
- data/lib/buildium-ruby/models/lease_tenant_message.rb +262 -0
- data/lib/buildium-ruby/models/lease_transaction_message.rb +298 -0
- data/lib/buildium-ruby/models/lease_transaction_search_message.rb +263 -0
- data/lib/buildium-ruby/models/listing_contact_message.rb +259 -0
- data/lib/buildium-ruby/models/listing_contact_save_message.rb +253 -0
- data/lib/buildium-ruby/models/listing_file_message.rb +272 -0
- data/lib/buildium-ruby/models/listing_message.rb +305 -0
- data/lib/buildium-ruby/models/listing_property_message.rb +326 -0
- data/lib/buildium-ruby/models/listing_put_message.rb +283 -0
- data/lib/buildium-ruby/models/listing_search_message.rb +262 -0
- data/lib/buildium-ruby/models/listing_unit_message.rb +358 -0
- data/lib/buildium-ruby/models/lock_period_settings_global_message.rb +218 -0
- data/lib/buildium-ruby/models/lock_period_settings_overrides_message.rb +227 -0
- data/lib/buildium-ruby/models/logged_by_staff_user_message.rb +249 -0
- data/lib/buildium-ruby/models/lookup_message.rb +226 -0
- data/lib/buildium-ruby/models/mailing_template_message.rb +282 -0
- data/lib/buildium-ruby/models/note_message.rb +237 -0
- data/lib/buildium-ruby/models/note_post_message.rb +223 -0
- data/lib/buildium-ruby/models/note_put_message.rb +223 -0
- data/lib/buildium-ruby/models/note_search_message.rb +238 -0
- data/lib/buildium-ruby/models/outstanding_balances_line_message.rb +228 -0
- data/lib/buildium-ruby/models/ownership_account_charge_recurring_transaction_message.rb +374 -0
- data/lib/buildium-ruby/models/ownership_account_credit_line_post_message.rb +238 -0
- data/lib/buildium-ruby/models/ownership_account_credit_post_message.rb +309 -0
- data/lib/buildium-ruby/models/ownership_account_deposit_withholding_line_post_message.rb +238 -0
- data/lib/buildium-ruby/models/ownership_account_deposit_withholding_post_message.rb +260 -0
- data/lib/buildium-ruby/models/ownership_account_ledger_charge_lines_put_message.rb +248 -0
- data/lib/buildium-ruby/models/ownership_account_ledger_charge_lines_save_message.rb +238 -0
- data/lib/buildium-ruby/models/ownership_account_ledger_charge_post_message.rb +250 -0
- data/lib/buildium-ruby/models/ownership_account_ledger_charge_put_message.rb +250 -0
- data/lib/buildium-ruby/models/ownership_account_ledger_payment_line_save_message.rb +239 -0
- data/lib/buildium-ruby/models/ownership_account_ledger_payment_post_message.rb +335 -0
- data/lib/buildium-ruby/models/ownership_account_outstanding_balance_message.rb +310 -0
- data/lib/buildium-ruby/models/ownership_account_outstanding_balance_search_message.rb +308 -0
- data/lib/buildium-ruby/models/ownership_account_recurring_credit_message.rb +408 -0
- data/lib/buildium-ruby/models/ownership_account_recurring_payment_message.rb +397 -0
- data/lib/buildium-ruby/models/ownership_account_refund_line_message.rb +228 -0
- data/lib/buildium-ruby/models/ownership_account_refund_lines_post_message.rb +238 -0
- data/lib/buildium-ruby/models/ownership_account_refund_message.rb +301 -0
- data/lib/buildium-ruby/models/ownership_account_refund_post_message.rb +306 -0
- data/lib/buildium-ruby/models/ownership_account_transaction_message.rb +298 -0
- data/lib/buildium-ruby/models/paid_by_message.rb +228 -0
- data/lib/buildium-ruby/models/participant_message.rb +240 -0
- data/lib/buildium-ruby/models/participant_resource_message.rb +263 -0
- data/lib/buildium-ruby/models/payee_message.rb +283 -0
- data/lib/buildium-ruby/models/payment_detail_message.rb +281 -0
- data/lib/buildium-ruby/models/payment_recurring_transaction_post_message.rb +378 -0
- data/lib/buildium-ruby/models/payment_transactions_message.rb +237 -0
- data/lib/buildium-ruby/models/phone_log_message.rb +266 -0
- data/lib/buildium-ruby/models/phone_log_participant_post_message.rb +282 -0
- data/lib/buildium-ruby/models/phone_log_participant_unit_agreement_post_message.rb +263 -0
- data/lib/buildium-ruby/models/phone_log_post_message.rb +267 -0
- data/lib/buildium-ruby/models/phone_log_put_message.rb +253 -0
- data/lib/buildium-ruby/models/phone_log_search_message.rb +336 -0
- data/lib/buildium-ruby/models/phone_number_message.rb +263 -0
- data/lib/buildium-ruby/models/phone_numbers_message.rb +249 -0
- data/lib/buildium-ruby/models/property_group_message.rb +259 -0
- data/lib/buildium-ruby/models/property_group_post_message.rb +250 -0
- data/lib/buildium-ruby/models/property_group_put_message.rb +250 -0
- data/lib/buildium-ruby/models/property_group_search_message.rb +230 -0
- data/lib/buildium-ruby/models/property_manager_message.rb +291 -0
- data/lib/buildium-ruby/models/property_message.rb +273 -0
- data/lib/buildium-ruby/models/recurring_transaction_line_message.rb +228 -0
- data/lib/buildium-ruby/models/recurring_transaction_line_post_message.rb +238 -0
- data/lib/buildium-ruby/models/recurring_transaction_message.rb +388 -0
- data/lib/buildium-ruby/models/rental_appliance_message.rb +288 -0
- data/lib/buildium-ruby/models/rental_appliance_post_message.rb +298 -0
- data/lib/buildium-ruby/models/rental_appliance_put_message.rb +273 -0
- data/lib/buildium-ruby/models/rental_appliance_search_message.rb +232 -0
- data/lib/buildium-ruby/models/rental_appliance_service_history_message.rb +282 -0
- data/lib/buildium-ruby/models/rental_appliance_service_history_post_message.rb +282 -0
- data/lib/buildium-ruby/models/rental_features_message.rb +255 -0
- data/lib/buildium-ruby/models/rental_features_put_message.rb +254 -0
- data/lib/buildium-ruby/models/rental_message.rb +373 -0
- data/lib/buildium-ruby/models/rental_owner_message.rb +361 -0
- data/lib/buildium-ruby/models/rental_owner_post_message.rb +363 -0
- data/lib/buildium-ruby/models/rental_owner_put_message.rb +354 -0
- data/lib/buildium-ruby/models/rental_owner_request_task_message.rb +381 -0
- data/lib/buildium-ruby/models/rental_owner_request_task_post_message.rb +384 -0
- data/lib/buildium-ruby/models/rental_owner_request_task_put_message.rb +369 -0
- data/lib/buildium-ruby/models/rental_owner_request_task_search_message.rb +366 -0
- data/lib/buildium-ruby/models/rental_owner_tax_information_message.rb +302 -0
- data/lib/buildium-ruby/models/rental_owners_search_message.rb +314 -0
- data/lib/buildium-ruby/models/rental_preferred_vendor_message.rb +300 -0
- data/lib/buildium-ruby/models/rental_preferred_vendor_put_message.rb +225 -0
- data/lib/buildium-ruby/models/rental_property_post_message.rb +365 -0
- data/lib/buildium-ruby/models/rental_property_put_message.rb +341 -0
- data/lib/buildium-ruby/models/rental_property_unit_post_message.rb +333 -0
- data/lib/buildium-ruby/models/rental_search_message.rb +330 -0
- data/lib/buildium-ruby/models/rental_tenant_post_message.rb +388 -0
- data/lib/buildium-ruby/models/rental_tenant_put_message.rb +373 -0
- data/lib/buildium-ruby/models/rental_tenant_renewal_post_message.rb +373 -0
- data/lib/buildium-ruby/models/rental_unit_features_message.rb +243 -0
- data/lib/buildium-ruby/models/rental_unit_features_put_message.rb +242 -0
- data/lib/buildium-ruby/models/rental_unit_message.rb +374 -0
- data/lib/buildium-ruby/models/rental_unit_put_message.rb +333 -0
- data/lib/buildium-ruby/models/rental_unit_search_message.rb +240 -0
- data/lib/buildium-ruby/models/rental_units_post_message.rb +348 -0
- data/lib/buildium-ruby/models/requested_by_user_entity_message.rb +303 -0
- data/lib/buildium-ruby/models/resident_center_user_message.rb +280 -0
- data/lib/buildium-ruby/models/resident_center_user_reference_message.rb +292 -0
- data/lib/buildium-ruby/models/resident_center_user_search_message.rb +288 -0
- data/lib/buildium-ruby/models/resident_request_task_message.rb +429 -0
- data/lib/buildium-ruby/models/resident_request_task_post_message.rb +409 -0
- data/lib/buildium-ruby/models/resident_request_task_put_message.rb +349 -0
- data/lib/buildium-ruby/models/resident_request_task_search_message.rb +376 -0
- data/lib/buildium-ruby/models/save_address_message.rb +323 -0
- data/lib/buildium-ruby/models/save_emergency_contact_message.rb +248 -0
- data/lib/buildium-ruby/models/task_category_message.rb +251 -0
- data/lib/buildium-ruby/models/task_category_put_message.rb +224 -0
- data/lib/buildium-ruby/models/task_category_response_message.rb +248 -0
- data/lib/buildium-ruby/models/task_category_save_message.rb +224 -0
- data/lib/buildium-ruby/models/task_history_file_message.rb +268 -0
- data/lib/buildium-ruby/models/task_history_file_upload_post_message.rb +223 -0
- data/lib/buildium-ruby/models/task_history_message.rb +376 -0
- data/lib/buildium-ruby/models/task_history_put_message.rb +223 -0
- data/lib/buildium-ruby/models/task_history_user_message.rb +249 -0
- data/lib/buildium-ruby/models/task_search_message.rb +398 -0
- data/lib/buildium-ruby/models/task_sub_category_message.rb +229 -0
- data/lib/buildium-ruby/models/tax_information_post_message.rb +292 -0
- data/lib/buildium-ruby/models/tax_information_save_message.rb +307 -0
- data/lib/buildium-ruby/models/tenant_message.rb +404 -0
- data/lib/buildium-ruby/models/tenant_search_message.rb +339 -0
- data/lib/buildium-ruby/models/to_do_task_message.rb +372 -0
- data/lib/buildium-ruby/models/to_do_task_post_message.rb +374 -0
- data/lib/buildium-ruby/models/to_do_task_put_message.rb +374 -0
- data/lib/buildium-ruby/models/to_do_task_search_message.rb +366 -0
- data/lib/buildium-ruby/models/undeposited_funds_message.rb +217 -0
- data/lib/buildium-ruby/models/unit_agreement_message.rb +273 -0
- data/lib/buildium-ruby/models/user_message.rb +354 -0
- data/lib/buildium-ruby/models/user_role_message.rb +249 -0
- data/lib/buildium-ruby/models/user_search_message.rb +297 -0
- data/lib/buildium-ruby/models/vehicle_message.rb +249 -0
- data/lib/buildium-ruby/models/vendor_category_message.rb +239 -0
- data/lib/buildium-ruby/models/vendor_category_save_message.rb +223 -0
- data/lib/buildium-ruby/models/vendor_credit_line_item_message.rb +257 -0
- data/lib/buildium-ruby/models/vendor_credit_line_item_post_message.rb +262 -0
- data/lib/buildium-ruby/models/vendor_credit_message.rb +260 -0
- data/lib/buildium-ruby/models/vendor_credit_post_message.rb +260 -0
- data/lib/buildium-ruby/models/vendor_insurance_message.rb +239 -0
- data/lib/buildium-ruby/models/vendor_insurance_save_message.rb +239 -0
- data/lib/buildium-ruby/models/vendor_message.rb +377 -0
- data/lib/buildium-ruby/models/vendor_post_message.rb +364 -0
- data/lib/buildium-ruby/models/vendor_put_message.rb +364 -0
- data/lib/buildium-ruby/models/vendor_refund_line_message.rb +257 -0
- data/lib/buildium-ruby/models/vendor_refund_line_post_message.rb +262 -0
- data/lib/buildium-ruby/models/vendor_refund_message.rb +314 -0
- data/lib/buildium-ruby/models/vendor_refund_post_message.rb +324 -0
- data/lib/buildium-ruby/models/vendor_search_message.rb +334 -0
- data/lib/buildium-ruby/models/vendor_tax_information_message.rb +302 -0
- data/lib/buildium-ruby/models/vendor_transaction_message.rb +302 -0
- data/lib/buildium-ruby/models/vendor_transaction_search_message.rb +292 -0
- data/lib/buildium-ruby/models/work_order_entry_contact_message.rb +231 -0
- data/lib/buildium-ruby/models/work_order_entry_contact_resource_message.rb +263 -0
- data/lib/buildium-ruby/models/work_order_line_item_message.rb +249 -0
- data/lib/buildium-ruby/models/work_order_line_item_save_message.rb +258 -0
- data/lib/buildium-ruby/models/work_order_message.rb +372 -0
- data/lib/buildium-ruby/models/work_order_post_message.rb +363 -0
- data/lib/buildium-ruby/models/work_order_put_message.rb +344 -0
- data/lib/buildium-ruby/models/work_order_search_message.rb +452 -0
- data/lib/buildium-ruby/models/work_order_task_message.rb +346 -0
- data/lib/buildium-ruby/models/work_order_task_post_message.rb +345 -0
- data/lib/buildium-ruby/version.rb +15 -0
- data/lib/buildium-ruby.rb +438 -0
- data/openapitools.json +7 -0
- data/spec/api/accounting_api_spec.rb +383 -0
- data/spec/api/administration_api_spec.rb +114 -0
- data/spec/api/applicants_api_spec.rb +294 -0
- data/spec/api/association_appliances_api_spec.rb +141 -0
- data/spec/api/association_owners_api_spec.rb +195 -0
- data/spec/api/association_ownership_accounts_api_spec.rb +385 -0
- data/spec/api/association_tenants_api_spec.rb +153 -0
- data/spec/api/association_units_api_spec.rb +147 -0
- data/spec/api/associations_api_spec.rb +248 -0
- data/spec/api/bank_accounts_api_spec.rb +420 -0
- data/spec/api/client_leads_api_spec.rb +66 -0
- data/spec/api/communications_api_spec.rb +248 -0
- data/spec/api/files_api_spec.rb +156 -0
- data/spec/api/leases_api_spec.rb +529 -0
- data/spec/api/listings_api_spec.rb +139 -0
- data/spec/api/property_groups_api_spec.rb +88 -0
- data/spec/api/rental_appliances_api_spec.rb +141 -0
- data/spec/api/rental_owners_api_spec.rb +151 -0
- data/spec/api/rental_properties_api_spec.rb +205 -0
- data/spec/api/rental_tenants_api_spec.rb +154 -0
- data/spec/api/rental_units_api_spec.rb +172 -0
- data/spec/api/resident_center_api_spec.rb +54 -0
- data/spec/api/tasks_api_spec.rb +493 -0
- data/spec/api/vendors_api_spec.rb +275 -0
- data/spec/api/work_orders_api_spec.rb +105 -0
- data/spec/api_client_spec.rb +188 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/account_info_message_spec.rb +58 -0
- data/spec/models/accounting_entity_message_spec.rb +50 -0
- data/spec/models/accounting_entity_save_message_spec.rb +44 -0
- data/spec/models/accounting_lock_period_message_spec.rb +46 -0
- data/spec/models/accounting_settings_message_spec.rb +72 -0
- data/spec/models/address_message_spec.rb +74 -0
- data/spec/models/all_tasks_message_spec.rb +130 -0
- data/spec/models/announcement_message_spec.rb +74 -0
- data/spec/models/announcement_post_message_spec.rb +64 -0
- data/spec/models/announcement_search_message_spec.rb +62 -0
- data/spec/models/announcement_sender_message_spec.rb +46 -0
- data/spec/models/api_error_response_spec.rb +46 -0
- data/spec/models/appliance_message_spec.rb +58 -0
- data/spec/models/applicant_application_message_spec.rb +56 -0
- data/spec/models/applicant_group_message_spec.rb +62 -0
- data/spec/models/applicant_group_post_message_spec.rb +40 -0
- data/spec/models/applicant_group_put_message_spec.rb +50 -0
- data/spec/models/applicant_group_search_message_spec.rb +66 -0
- data/spec/models/applicant_message_spec.rb +88 -0
- data/spec/models/applicant_post_message_spec.rb +64 -0
- data/spec/models/applicant_put_message_spec.rb +58 -0
- data/spec/models/applicant_search_message_spec.rb +84 -0
- data/spec/models/application_message_spec.rb +62 -0
- data/spec/models/application_put_message_spec.rb +38 -0
- data/spec/models/application_response_field_message_spec.rb +60 -0
- data/spec/models/application_response_message_spec.rb +50 -0
- data/spec/models/application_section_response_message_spec.rb +34 -0
- data/spec/models/association_appliance_message_spec.rb +76 -0
- data/spec/models/association_appliance_post_message_spec.rb +76 -0
- data/spec/models/association_appliance_put_message_spec.rb +64 -0
- data/spec/models/association_appliance_search_message_spec.rb +40 -0
- data/spec/models/association_appliance_service_history_message_spec.rb +56 -0
- data/spec/models/association_appliance_service_history_post_message_spec.rb +50 -0
- data/spec/models/association_board_member_message_spec.rb +92 -0
- data/spec/models/association_board_member_post_message_spec.rb +56 -0
- data/spec/models/association_board_member_put_message_spec.rb +50 -0
- data/spec/models/association_board_member_search_message_spec.rb +60 -0
- data/spec/models/association_message_spec.rb +100 -0
- data/spec/models/association_owner_board_term_message_spec.rb +68 -0
- data/spec/models/association_owner_board_term_post_message_spec.rb +50 -0
- data/spec/models/association_owner_message_spec.rb +144 -0
- data/spec/models/association_owner_post_message_spec.rb +116 -0
- data/spec/models/association_owner_put_message_spec.rb +98 -0
- data/spec/models/association_owner_to_existing_ownership_account_post_message_spec.rb +128 -0
- data/spec/models/association_owner_unit_occupancy_put_message_spec.rb +34 -0
- data/spec/models/association_owner_unit_occupancy_status_message_spec.rb +40 -0
- data/spec/models/association_ownership_account_message_spec.rb +90 -0
- data/spec/models/association_ownership_account_post_message_spec.rb +80 -0
- data/spec/models/association_ownership_account_put_message_spec.rb +34 -0
- data/spec/models/association_ownership_account_search_message_spec.rb +72 -0
- data/spec/models/association_post_message_spec.rb +76 -0
- data/spec/models/association_preferred_vendor_message_spec.rb +82 -0
- data/spec/models/association_preferred_vendor_put_message_spec.rb +34 -0
- data/spec/models/association_put_message_spec.rb +82 -0
- data/spec/models/association_search_message_spec.rb +56 -0
- data/spec/models/association_tenant_message_spec.rb +112 -0
- data/spec/models/association_tenant_post_message_spec.rb +106 -0
- data/spec/models/association_tenant_put_message_spec.rb +94 -0
- data/spec/models/association_unit_message_spec.rb +84 -0
- data/spec/models/association_unit_put_message_spec.rb +66 -0
- data/spec/models/association_unit_search_message_spec.rb +46 -0
- data/spec/models/association_units_post_message_spec.rb +72 -0
- data/spec/models/association_user_search_message_spec.rb +86 -0
- data/spec/models/bank_account_check_accounting_entity_save_message_spec.rb +44 -0
- data/spec/models/bank_account_check_line_message_spec.rb +64 -0
- data/spec/models/bank_account_check_line_save_message_spec.rb +58 -0
- data/spec/models/bank_account_check_message_spec.rb +70 -0
- data/spec/models/bank_account_check_payee_message_spec.rb +50 -0
- data/spec/models/bank_account_check_payee_save_message_spec.rb +44 -0
- data/spec/models/bank_account_check_post_message_spec.rb +58 -0
- data/spec/models/bank_account_check_put_message_spec.rb +58 -0
- data/spec/models/bank_account_check_search_message_spec.rb +40 -0
- data/spec/models/bank_account_deposit_line_message_spec.rb +64 -0
- data/spec/models/bank_account_deposit_line_save_message_spec.rb +58 -0
- data/spec/models/bank_account_deposit_message_spec.rb +64 -0
- data/spec/models/bank_account_deposit_post_message_spec.rb +52 -0
- data/spec/models/bank_account_deposit_put_message_spec.rb +46 -0
- data/spec/models/bank_account_deposit_search_message_spec.rb +40 -0
- data/spec/models/bank_account_message_spec.rb +104 -0
- data/spec/models/bank_account_post_message_spec.rb +78 -0
- data/spec/models/bank_account_put_message_spec.rb +78 -0
- data/spec/models/bank_account_quick_deposit_message_spec.rb +64 -0
- data/spec/models/bank_account_quick_deposit_save_message_spec.rb +58 -0
- data/spec/models/bank_account_quick_deposit_search_message_spec.rb +40 -0
- data/spec/models/bank_account_search_message_spec.rb +44 -0
- data/spec/models/bank_account_transaction_message_spec.rb +96 -0
- data/spec/models/bank_account_transaction_search_message_spec.rb +56 -0
- data/spec/models/bank_account_transfer_accounting_entity_save_message_spec.rb +44 -0
- data/spec/models/bank_account_transfer_message_spec.rb +64 -0
- data/spec/models/bank_account_transfer_save_message_spec.rb +58 -0
- data/spec/models/bank_account_transfer_search_message_spec.rb +40 -0
- data/spec/models/bank_account_withdrawal_message_spec.rb +64 -0
- data/spec/models/bank_account_withdrawal_save_message_spec.rb +58 -0
- data/spec/models/bank_account_withdrawal_search_message_spec.rb +40 -0
- data/spec/models/bill_file_message_spec.rb +64 -0
- data/spec/models/bill_line_message_spec.rb +64 -0
- data/spec/models/bill_line_post_message_spec.rb +58 -0
- data/spec/models/bill_line_put_message_spec.rb +64 -0
- data/spec/models/bill_markup_message_spec.rb +44 -0
- data/spec/models/bill_markup_save_message_spec.rb +44 -0
- data/spec/models/bill_message_spec.rb +92 -0
- data/spec/models/bill_payment_accounting_entity_message_spec.rb +44 -0
- data/spec/models/bill_payment_line_message_spec.rb +46 -0
- data/spec/models/bill_payment_line_post_message_spec.rb +40 -0
- data/spec/models/bill_payment_message_spec.rb +64 -0
- data/spec/models/bill_payment_post_message_spec.rb +58 -0
- data/spec/models/bill_post_message_spec.rb +70 -0
- data/spec/models/bill_put_message_spec.rb +64 -0
- data/spec/models/bill_search_message_spec.rb +88 -0
- data/spec/models/budget_details_message_spec.rb +56 -0
- data/spec/models/budget_details_save_message_spec.rb +40 -0
- data/spec/models/budget_message_spec.rb +64 -0
- data/spec/models/budget_monthly_amounts_message_spec.rb +100 -0
- data/spec/models/budget_monthly_amounts_save_message_spec.rb +100 -0
- data/spec/models/budget_post_message_spec.rb +62 -0
- data/spec/models/budget_put_message_spec.rb +40 -0
- data/spec/models/budget_search_message_spec.rb +46 -0
- data/spec/models/charge_recurring_transaction_post_message_spec.rb +84 -0
- data/spec/models/charge_recurring_transaction_put_message_spec.rb +90 -0
- data/spec/models/check_printing_info_message_spec.rb +122 -0
- data/spec/models/check_printing_info_post_message_spec.rb +122 -0
- data/spec/models/check_printing_info_put_message_spec.rb +122 -0
- data/spec/models/client_lead_credit_request_message_spec.rb +60 -0
- data/spec/models/client_lead_message_spec.rb +102 -0
- data/spec/models/client_lead_search_message_spec.rb +66 -0
- data/spec/models/contact_detail_message_spec.rb +52 -0
- data/spec/models/contact_detail_phone_message_spec.rb +46 -0
- data/spec/models/contact_detail_save_message_spec.rb +52 -0
- data/spec/models/contact_detail_save_phone_message_spec.rb +46 -0
- data/spec/models/contact_info_message_spec.rb +52 -0
- data/spec/models/contact_request_task_message_spec.rb +114 -0
- data/spec/models/contact_request_task_post_message_spec.rb +102 -0
- data/spec/models/contact_request_task_put_message_spec.rb +102 -0
- data/spec/models/contact_request_task_search_message_spec.rb +112 -0
- data/spec/models/cosigner_message_spec.rb +92 -0
- data/spec/models/created_by_user_message_spec.rb +52 -0
- data/spec/models/credit_recurring_transaction_post_message_spec.rb +100 -0
- data/spec/models/deposit_detail_message_spec.rb +40 -0
- data/spec/models/electronic_payments_message_spec.rb +76 -0
- data/spec/models/email_message_spec.rb +52 -0
- data/spec/models/email_post_message_spec.rb +70 -0
- data/spec/models/email_recipient_message_spec.rb +62 -0
- data/spec/models/email_search_message_spec.rb +58 -0
- data/spec/models/email_sender_message_spec.rb +52 -0
- data/spec/models/emergency_contact_message_spec.rb +52 -0
- data/spec/models/file_category_message_spec.rb +46 -0
- data/spec/models/file_category_post_message_spec.rb +34 -0
- data/spec/models/file_category_put_message_spec.rb +34 -0
- data/spec/models/file_download_message_spec.rb +34 -0
- data/spec/models/file_entity_message_spec.rb +50 -0
- data/spec/models/file_message_spec.rb +82 -0
- data/spec/models/file_name_post_message_spec.rb +34 -0
- data/spec/models/file_put_message_spec.rb +46 -0
- data/spec/models/file_search_message_spec.rb +74 -0
- data/spec/models/file_upload_post_message_spec.rb +68 -0
- data/spec/models/file_upload_ticket_message_spec.rb +46 -0
- data/spec/models/general_journal_entry_line_save_message_spec.rb +56 -0
- data/spec/models/general_journal_entry_post_message_spec.rb +52 -0
- data/spec/models/general_journal_entry_put_message_spec.rb +52 -0
- data/spec/models/general_ledger_journal_line_message_spec.rb +64 -0
- data/spec/models/general_ledger_journal_message_spec.rb +40 -0
- data/spec/models/general_ledger_transaction_message_spec.rb +98 -0
- data/spec/models/general_ledger_transaction_search_message_spec.rb +62 -0
- data/spec/models/gl_account_balance_item_message_spec.rb +40 -0
- data/spec/models/gl_account_balance_message_spec.rb +46 -0
- data/spec/models/gl_account_balance_search_message_spec.rb +66 -0
- data/spec/models/gl_account_message_spec.rb +130 -0
- data/spec/models/gl_account_post_message_spec.rb +84 -0
- data/spec/models/gl_account_put_message_spec.rb +84 -0
- data/spec/models/gl_accounts_search_message_spec.rb +38 -0
- data/spec/models/gl_transaction_message_v1_spec.rb +58 -0
- data/spec/models/internal_transaction_status_message_spec.rb +46 -0
- data/spec/models/journal_line_message_spec.rb +64 -0
- data/spec/models/journal_message_spec.rb +40 -0
- data/spec/models/last_updated_by_user_message_spec.rb +58 -0
- data/spec/models/lease_account_detail_message_spec.rb +40 -0
- data/spec/models/lease_charge_line_save_message_spec.rb +46 -0
- data/spec/models/lease_charge_post_message_spec.rb +46 -0
- data/spec/models/lease_charge_put_message_spec.rb +46 -0
- data/spec/models/lease_charge_recurring_transaction_message_spec.rb +108 -0
- data/spec/models/lease_cosigner_post_message_spec.rb +80 -0
- data/spec/models/lease_ledger_credit_line_post_message_spec.rb +40 -0
- data/spec/models/lease_ledger_credit_post_message_spec.rb +62 -0
- data/spec/models/lease_ledger_deposit_withholding_line_post_message_spec.rb +40 -0
- data/spec/models/lease_ledger_deposit_withholding_post_message_spec.rb +52 -0
- data/spec/models/lease_ledger_payment_line_save_message_spec.rb +40 -0
- data/spec/models/lease_ledger_payment_post_message_spec.rb +74 -0
- data/spec/models/lease_ledger_refund_line_message_spec.rb +40 -0
- data/spec/models/lease_ledger_refund_line_post_message_spec.rb +40 -0
- data/spec/models/lease_ledger_refund_message_spec.rb +82 -0
- data/spec/models/lease_ledger_refund_post_message_spec.rb +70 -0
- data/spec/models/lease_ledger_reverse_payment_nsf_charge_post_message_spec.rb +40 -0
- data/spec/models/lease_ledger_reverse_payment_other_bank_charge_post_message_spec.rb +40 -0
- data/spec/models/lease_ledger_reverse_payment_post_message_spec.rb +52 -0
- data/spec/models/lease_message_spec.rb +170 -0
- data/spec/models/lease_move_out_data_message_spec.rb +46 -0
- data/spec/models/lease_move_out_data_post_message_spec.rb +46 -0
- data/spec/models/lease_outstanding_balance_message_spec.rb +100 -0
- data/spec/models/lease_outstanding_balance_search_message_spec.rb +90 -0
- data/spec/models/lease_post_message_spec.rb +98 -0
- data/spec/models/lease_put_message_spec.rb +68 -0
- data/spec/models/lease_recurring_credit_message_spec.rb +124 -0
- data/spec/models/lease_recurring_payment_message_spec.rb +118 -0
- data/spec/models/lease_renewal_message_spec.rb +84 -0
- data/spec/models/lease_renewal_post_message_spec.rb +98 -0
- data/spec/models/lease_rent_charge_message_spec.rb +70 -0
- data/spec/models/lease_rent_charge_post_message_spec.rb +52 -0
- data/spec/models/lease_rent_message_spec.rb +86 -0
- data/spec/models/lease_rent_post_message_spec.rb +44 -0
- data/spec/models/lease_search_message_spec.rb +108 -0
- data/spec/models/lease_security_deposit_post_message_spec.rb +40 -0
- data/spec/models/lease_tenant_message_spec.rb +44 -0
- data/spec/models/lease_transaction_message_spec.rb +82 -0
- data/spec/models/lease_transaction_search_message_spec.rb +50 -0
- data/spec/models/listing_contact_message_spec.rb +58 -0
- data/spec/models/listing_contact_save_message_spec.rb +52 -0
- data/spec/models/listing_file_message_spec.rb +50 -0
- data/spec/models/listing_message_spec.rb +88 -0
- data/spec/models/listing_property_message_spec.rb +90 -0
- data/spec/models/listing_put_message_spec.rb +64 -0
- data/spec/models/listing_search_message_spec.rb +44 -0
- data/spec/models/listing_unit_message_spec.rb +100 -0
- data/spec/models/lock_period_settings_global_message_spec.rb +34 -0
- data/spec/models/lock_period_settings_overrides_message_spec.rb +40 -0
- data/spec/models/logged_by_staff_user_message_spec.rb +52 -0
- data/spec/models/lookup_message_spec.rb +40 -0
- data/spec/models/mailing_template_message_spec.rb +56 -0
- data/spec/models/note_message_spec.rb +46 -0
- data/spec/models/note_post_message_spec.rb +34 -0
- data/spec/models/note_put_message_spec.rb +34 -0
- data/spec/models/note_search_message_spec.rb +46 -0
- data/spec/models/outstanding_balances_line_message_spec.rb +40 -0
- data/spec/models/ownership_account_charge_recurring_transaction_message_spec.rb +108 -0
- data/spec/models/ownership_account_credit_line_post_message_spec.rb +40 -0
- data/spec/models/ownership_account_credit_post_message_spec.rb +62 -0
- data/spec/models/ownership_account_deposit_withholding_line_post_message_spec.rb +40 -0
- data/spec/models/ownership_account_deposit_withholding_post_message_spec.rb +52 -0
- data/spec/models/ownership_account_ledger_charge_lines_put_message_spec.rb +46 -0
- data/spec/models/ownership_account_ledger_charge_lines_save_message_spec.rb +40 -0
- data/spec/models/ownership_account_ledger_charge_post_message_spec.rb +46 -0
- data/spec/models/ownership_account_ledger_charge_put_message_spec.rb +46 -0
- data/spec/models/ownership_account_ledger_payment_line_save_message_spec.rb +40 -0
- data/spec/models/ownership_account_ledger_payment_post_message_spec.rb +74 -0
- data/spec/models/ownership_account_outstanding_balance_message_spec.rb +88 -0
- data/spec/models/ownership_account_outstanding_balance_search_message_spec.rb +70 -0
- data/spec/models/ownership_account_recurring_credit_message_spec.rb +124 -0
- data/spec/models/ownership_account_recurring_payment_message_spec.rb +118 -0
- data/spec/models/ownership_account_refund_line_message_spec.rb +40 -0
- data/spec/models/ownership_account_refund_lines_post_message_spec.rb +40 -0
- data/spec/models/ownership_account_refund_message_spec.rb +82 -0
- data/spec/models/ownership_account_refund_post_message_spec.rb +70 -0
- data/spec/models/ownership_account_transaction_message_spec.rb +82 -0
- data/spec/models/paid_by_message_spec.rb +40 -0
- data/spec/models/participant_message_spec.rb +46 -0
- data/spec/models/participant_resource_message_spec.rb +44 -0
- data/spec/models/payee_message_spec.rb +56 -0
- data/spec/models/payment_detail_message_spec.rb +56 -0
- data/spec/models/payment_recurring_transaction_post_message_spec.rb +94 -0
- data/spec/models/payment_transactions_message_spec.rb +46 -0
- data/spec/models/phone_log_message_spec.rb +64 -0
- data/spec/models/phone_log_participant_post_message_spec.rb +50 -0
- data/spec/models/phone_log_participant_unit_agreement_post_message_spec.rb +44 -0
- data/spec/models/phone_log_post_message_spec.rb +52 -0
- data/spec/models/phone_log_put_message_spec.rb +46 -0
- data/spec/models/phone_log_search_message_spec.rb +84 -0
- data/spec/models/phone_number_message_spec.rb +44 -0
- data/spec/models/phone_numbers_message_spec.rb +52 -0
- data/spec/models/property_group_message_spec.rb +58 -0
- data/spec/models/property_group_post_message_spec.rb +46 -0
- data/spec/models/property_group_put_message_spec.rb +46 -0
- data/spec/models/property_group_search_message_spec.rb +40 -0
- data/spec/models/property_manager_message_spec.rb +76 -0
- data/spec/models/property_message_spec.rb +50 -0
- data/spec/models/recurring_transaction_line_message_spec.rb +40 -0
- data/spec/models/recurring_transaction_line_post_message_spec.rb +40 -0
- data/spec/models/recurring_transaction_message_spec.rb +112 -0
- data/spec/models/rental_appliance_message_spec.rb +76 -0
- data/spec/models/rental_appliance_post_message_spec.rb +76 -0
- data/spec/models/rental_appliance_put_message_spec.rb +64 -0
- data/spec/models/rental_appliance_search_message_spec.rb +40 -0
- data/spec/models/rental_appliance_service_history_message_spec.rb +56 -0
- data/spec/models/rental_appliance_service_history_post_message_spec.rb +50 -0
- data/spec/models/rental_features_message_spec.rb +48 -0
- data/spec/models/rental_features_put_message_spec.rb +48 -0
- data/spec/models/rental_message_spec.rb +108 -0
- data/spec/models/rental_owner_message_spec.rb +118 -0
- data/spec/models/rental_owner_post_message_spec.rb +112 -0
- data/spec/models/rental_owner_put_message_spec.rb +106 -0
- data/spec/models/rental_owner_request_task_message_spec.rb +114 -0
- data/spec/models/rental_owner_request_task_post_message_spec.rb +102 -0
- data/spec/models/rental_owner_request_task_put_message_spec.rb +96 -0
- data/spec/models/rental_owner_request_task_search_message_spec.rb +112 -0
- data/spec/models/rental_owner_tax_information_message_spec.rb +68 -0
- data/spec/models/rental_owners_search_message_spec.rb +74 -0
- data/spec/models/rental_preferred_vendor_message_spec.rb +82 -0
- data/spec/models/rental_preferred_vendor_put_message_spec.rb +34 -0
- data/spec/models/rental_property_post_message_spec.rb +92 -0
- data/spec/models/rental_property_put_message_spec.rb +80 -0
- data/spec/models/rental_property_unit_post_message_spec.rb +78 -0
- data/spec/models/rental_search_message_spec.rb +88 -0
- data/spec/models/rental_tenant_post_message_spec.rb +110 -0
- data/spec/models/rental_tenant_put_message_spec.rb +104 -0
- data/spec/models/rental_tenant_renewal_post_message_spec.rb +104 -0
- data/spec/models/rental_unit_features_message_spec.rb +38 -0
- data/spec/models/rental_unit_features_put_message_spec.rb +38 -0
- data/spec/models/rental_unit_message_spec.rb +108 -0
- data/spec/models/rental_unit_put_message_spec.rb +78 -0
- data/spec/models/rental_unit_search_message_spec.rb +46 -0
- data/spec/models/rental_units_post_message_spec.rb +84 -0
- data/spec/models/requested_by_user_entity_message_spec.rb +68 -0
- data/spec/models/resident_center_user_message_spec.rb +56 -0
- data/spec/models/resident_center_user_reference_message_spec.rb +62 -0
- data/spec/models/resident_center_user_search_message_spec.rb +66 -0
- data/spec/models/resident_request_task_message_spec.rb +144 -0
- data/spec/models/resident_request_task_post_message_spec.rb +114 -0
- data/spec/models/resident_request_task_put_message_spec.rb +84 -0
- data/spec/models/resident_request_task_search_message_spec.rb +118 -0
- data/spec/models/save_address_message_spec.rb +74 -0
- data/spec/models/save_emergency_contact_message_spec.rb +52 -0
- data/spec/models/task_category_message_spec.rb +52 -0
- data/spec/models/task_category_put_message_spec.rb +34 -0
- data/spec/models/task_category_response_message_spec.rb +52 -0
- data/spec/models/task_category_save_message_spec.rb +34 -0
- data/spec/models/task_history_file_message_spec.rb +64 -0
- data/spec/models/task_history_file_upload_post_message_spec.rb +34 -0
- data/spec/models/task_history_message_spec.rb +112 -0
- data/spec/models/task_history_put_message_spec.rb +34 -0
- data/spec/models/task_history_user_message_spec.rb +52 -0
- data/spec/models/task_search_message_spec.rb +128 -0
- data/spec/models/task_sub_category_message_spec.rb +40 -0
- data/spec/models/tax_information_post_message_spec.rb +62 -0
- data/spec/models/tax_information_save_message_spec.rb +68 -0
- data/spec/models/tenant_message_spec.rb +128 -0
- data/spec/models/tenant_search_message_spec.rb +96 -0
- data/spec/models/to_do_task_message_spec.rb +108 -0
- data/spec/models/to_do_task_post_message_spec.rb +96 -0
- data/spec/models/to_do_task_put_message_spec.rb +96 -0
- data/spec/models/to_do_task_search_message_spec.rb +112 -0
- data/spec/models/undeposited_funds_message_spec.rb +34 -0
- data/spec/models/unit_agreement_message_spec.rb +50 -0
- data/spec/models/user_message_spec.rb +104 -0
- data/spec/models/user_role_message_spec.rb +52 -0
- data/spec/models/user_search_message_spec.rb +66 -0
- data/spec/models/vehicle_message_spec.rb +52 -0
- data/spec/models/vendor_category_message_spec.rb +46 -0
- data/spec/models/vendor_category_save_message_spec.rb +34 -0
- data/spec/models/vendor_credit_line_item_message_spec.rb +58 -0
- data/spec/models/vendor_credit_line_item_post_message_spec.rb +52 -0
- data/spec/models/vendor_credit_message_spec.rb +58 -0
- data/spec/models/vendor_credit_post_message_spec.rb +52 -0
- data/spec/models/vendor_insurance_message_spec.rb +46 -0
- data/spec/models/vendor_insurance_save_message_spec.rb +46 -0
- data/spec/models/vendor_message_spec.rb +130 -0
- data/spec/models/vendor_post_message_spec.rb +118 -0
- data/spec/models/vendor_put_message_spec.rb +118 -0
- data/spec/models/vendor_refund_line_message_spec.rb +58 -0
- data/spec/models/vendor_refund_line_post_message_spec.rb +52 -0
- data/spec/models/vendor_refund_message_spec.rb +74 -0
- data/spec/models/vendor_refund_post_message_spec.rb +68 -0
- data/spec/models/vendor_search_message_spec.rb +84 -0
- data/spec/models/vendor_tax_information_message_spec.rb +68 -0
- data/spec/models/vendor_transaction_message_spec.rb +68 -0
- data/spec/models/vendor_transaction_search_message_spec.rb +62 -0
- data/spec/models/work_order_entry_contact_message_spec.rb +40 -0
- data/spec/models/work_order_entry_contact_resource_message_spec.rb +44 -0
- data/spec/models/work_order_line_item_message_spec.rb +52 -0
- data/spec/models/work_order_line_item_save_message_spec.rb +52 -0
- data/spec/models/work_order_message_spec.rb +110 -0
- data/spec/models/work_order_post_message_spec.rb +98 -0
- data/spec/models/work_order_put_message_spec.rb +86 -0
- data/spec/models/work_order_search_message_spec.rb +158 -0
- data/spec/models/work_order_task_message_spec.rb +88 -0
- data/spec/models/work_order_task_post_message_spec.rb +78 -0
- data/spec/spec_helper.rb +111 -0
- metadata +1725 -0
data/docs/TasksApi.md
ADDED
@@ -0,0 +1,2528 @@
|
|
1
|
+
# Buildium::TasksApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.buildium.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
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
|
+
| [**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
|
+
| [**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
|
+
| [**get_all_task_categories**](TasksApi.md#get_all_task_categories) | **GET** /v1/tasks/categories | Retrieve all task categories |
|
15
|
+
| [**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
|
+
| [**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
|
+
| [**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
|
+
| [**get_task_by_id**](TasksApi.md#get_task_by_id) | **GET** /v1/tasks/{taskId} | Retrieve a task |
|
24
|
+
| [**get_task_category_by_id**](TasksApi.md#get_task_category_by_id) | **GET** /v1/tasks/categories/{taskCategoryId} | Retrieve a task category |
|
25
|
+
| [**get_task_histories**](TasksApi.md#get_task_histories) | **GET** /v1/tasks/{taskId}/history | Retrieve all task history |
|
26
|
+
| [**get_task_history_by_id**](TasksApi.md#get_task_history_by_id) | **GET** /v1/tasks/{taskId}/history/{taskHistoryId} | Retrieve a task history |
|
27
|
+
| [**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
|
+
| [**update_task_category**](TasksApi.md#update_task_category) | **PUT** /v1/tasks/categories/{taskCategoryId} | Update a task category |
|
34
|
+
| [**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
|
+
| [**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
|
+
|
38
|
+
|
39
|
+
## create_contact_request_task
|
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
|
192
|
+
|
193
|
+
> <ResidentRequestTaskMessage> create_resource(resident_request_task_post_message)
|
194
|
+
|
195
|
+
Create a resident request
|
196
|
+
|
197
|
+
Creates a resident request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
198
|
+
|
199
|
+
### Examples
|
200
|
+
|
201
|
+
```ruby
|
202
|
+
require 'time'
|
203
|
+
require 'buildium-ruby'
|
204
|
+
# setup authorization
|
205
|
+
Buildium.configure do |config|
|
206
|
+
# Configure API key authorization: clientId
|
207
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
208
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
209
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
210
|
+
|
211
|
+
# Configure API key authorization: clientSecret
|
212
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
213
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
214
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
215
|
+
end
|
216
|
+
|
217
|
+
api_instance = Buildium::TasksApi.new
|
218
|
+
resident_request_task_post_message = Buildium::ResidentRequestTaskPostMessage.new({title: 'title_example', unit_agreement_id: 37, requested_by_entity_id: 37, task_status: 'New', priority: 'Low'}) # ResidentRequestTaskPostMessage |
|
219
|
+
|
220
|
+
begin
|
221
|
+
# Create a resident request
|
222
|
+
result = api_instance.create_resource(resident_request_task_post_message)
|
223
|
+
p result
|
224
|
+
rescue Buildium::ApiError => e
|
225
|
+
puts "Error when calling TasksApi->create_resource: #{e}"
|
226
|
+
end
|
227
|
+
```
|
228
|
+
|
229
|
+
#### Using the create_resource_with_http_info variant
|
230
|
+
|
231
|
+
This returns an Array which contains the response data, status code and headers.
|
232
|
+
|
233
|
+
> <Array(<ResidentRequestTaskMessage>, Integer, Hash)> create_resource_with_http_info(resident_request_task_post_message)
|
234
|
+
|
235
|
+
```ruby
|
236
|
+
begin
|
237
|
+
# Create a resident request
|
238
|
+
data, status_code, headers = api_instance.create_resource_with_http_info(resident_request_task_post_message)
|
239
|
+
p status_code # => 2xx
|
240
|
+
p headers # => { ... }
|
241
|
+
p data # => <ResidentRequestTaskMessage>
|
242
|
+
rescue Buildium::ApiError => e
|
243
|
+
puts "Error when calling TasksApi->create_resource_with_http_info: #{e}"
|
244
|
+
end
|
245
|
+
```
|
246
|
+
|
247
|
+
### Parameters
|
248
|
+
|
249
|
+
| Name | Type | Description | Notes |
|
250
|
+
| ---- | ---- | ----------- | ----- |
|
251
|
+
| **resident_request_task_post_message** | [**ResidentRequestTaskPostMessage**](ResidentRequestTaskPostMessage.md) | | |
|
252
|
+
|
253
|
+
### Return type
|
254
|
+
|
255
|
+
[**ResidentRequestTaskMessage**](ResidentRequestTaskMessage.md)
|
256
|
+
|
257
|
+
### Authorization
|
258
|
+
|
259
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
260
|
+
|
261
|
+
### HTTP request headers
|
262
|
+
|
263
|
+
- **Content-Type**: application/json
|
264
|
+
- **Accept**: application/json
|
265
|
+
|
266
|
+
|
267
|
+
## create_task_category
|
268
|
+
|
269
|
+
> <TaskCategoryMessage> create_task_category(task_category_save_message)
|
270
|
+
|
271
|
+
Create a task category
|
272
|
+
|
273
|
+
Create a task category. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
274
|
+
|
275
|
+
### Examples
|
276
|
+
|
277
|
+
```ruby
|
278
|
+
require 'time'
|
279
|
+
require 'buildium-ruby'
|
280
|
+
# setup authorization
|
281
|
+
Buildium.configure do |config|
|
282
|
+
# Configure API key authorization: clientId
|
283
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
284
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
285
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
286
|
+
|
287
|
+
# Configure API key authorization: clientSecret
|
288
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
289
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
290
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
291
|
+
end
|
292
|
+
|
293
|
+
api_instance = Buildium::TasksApi.new
|
294
|
+
task_category_save_message = Buildium::TaskCategorySaveMessage.new({name: 'name_example'}) # TaskCategorySaveMessage |
|
295
|
+
|
296
|
+
begin
|
297
|
+
# Create a task category
|
298
|
+
result = api_instance.create_task_category(task_category_save_message)
|
299
|
+
p result
|
300
|
+
rescue Buildium::ApiError => e
|
301
|
+
puts "Error when calling TasksApi->create_task_category: #{e}"
|
302
|
+
end
|
303
|
+
```
|
304
|
+
|
305
|
+
#### Using the create_task_category_with_http_info variant
|
306
|
+
|
307
|
+
This returns an Array which contains the response data, status code and headers.
|
308
|
+
|
309
|
+
> <Array(<TaskCategoryMessage>, Integer, Hash)> create_task_category_with_http_info(task_category_save_message)
|
310
|
+
|
311
|
+
```ruby
|
312
|
+
begin
|
313
|
+
# Create a task category
|
314
|
+
data, status_code, headers = api_instance.create_task_category_with_http_info(task_category_save_message)
|
315
|
+
p status_code # => 2xx
|
316
|
+
p headers # => { ... }
|
317
|
+
p data # => <TaskCategoryMessage>
|
318
|
+
rescue Buildium::ApiError => e
|
319
|
+
puts "Error when calling TasksApi->create_task_category_with_http_info: #{e}"
|
320
|
+
end
|
321
|
+
```
|
322
|
+
|
323
|
+
### Parameters
|
324
|
+
|
325
|
+
| Name | Type | Description | Notes |
|
326
|
+
| ---- | ---- | ----------- | ----- |
|
327
|
+
| **task_category_save_message** | [**TaskCategorySaveMessage**](TaskCategorySaveMessage.md) | | |
|
328
|
+
|
329
|
+
### Return type
|
330
|
+
|
331
|
+
[**TaskCategoryMessage**](TaskCategoryMessage.md)
|
332
|
+
|
333
|
+
### Authorization
|
334
|
+
|
335
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
336
|
+
|
337
|
+
### HTTP request headers
|
338
|
+
|
339
|
+
- **Content-Type**: application/json
|
340
|
+
- **Accept**: application/json
|
341
|
+
|
342
|
+
|
343
|
+
## create_to_do_task
|
344
|
+
|
345
|
+
> <ToDoTaskMessage> create_to_do_task(to_do_task_post_message)
|
346
|
+
|
347
|
+
Create a to do task
|
348
|
+
|
349
|
+
Creates a to do task. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
350
|
+
|
351
|
+
### Examples
|
352
|
+
|
353
|
+
```ruby
|
354
|
+
require 'time'
|
355
|
+
require 'buildium-ruby'
|
356
|
+
# setup authorization
|
357
|
+
Buildium.configure do |config|
|
358
|
+
# Configure API key authorization: clientId
|
359
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
360
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
361
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
362
|
+
|
363
|
+
# Configure API key authorization: clientSecret
|
364
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
365
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
366
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
367
|
+
end
|
368
|
+
|
369
|
+
api_instance = Buildium::TasksApi.new
|
370
|
+
to_do_task_post_message = Buildium::ToDoTaskPostMessage.new({title: 'title_example', assigned_to_user_id: 37, task_status: 'New', priority: 'Low'}) # ToDoTaskPostMessage |
|
371
|
+
|
372
|
+
begin
|
373
|
+
# Create a to do task
|
374
|
+
result = api_instance.create_to_do_task(to_do_task_post_message)
|
375
|
+
p result
|
376
|
+
rescue Buildium::ApiError => e
|
377
|
+
puts "Error when calling TasksApi->create_to_do_task: #{e}"
|
378
|
+
end
|
379
|
+
```
|
380
|
+
|
381
|
+
#### Using the create_to_do_task_with_http_info variant
|
382
|
+
|
383
|
+
This returns an Array which contains the response data, status code and headers.
|
384
|
+
|
385
|
+
> <Array(<ToDoTaskMessage>, Integer, Hash)> create_to_do_task_with_http_info(to_do_task_post_message)
|
386
|
+
|
387
|
+
```ruby
|
388
|
+
begin
|
389
|
+
# Create a to do task
|
390
|
+
data, status_code, headers = api_instance.create_to_do_task_with_http_info(to_do_task_post_message)
|
391
|
+
p status_code # => 2xx
|
392
|
+
p headers # => { ... }
|
393
|
+
p data # => <ToDoTaskMessage>
|
394
|
+
rescue Buildium::ApiError => e
|
395
|
+
puts "Error when calling TasksApi->create_to_do_task_with_http_info: #{e}"
|
396
|
+
end
|
397
|
+
```
|
398
|
+
|
399
|
+
### Parameters
|
400
|
+
|
401
|
+
| Name | Type | Description | Notes |
|
402
|
+
| ---- | ---- | ----------- | ----- |
|
403
|
+
| **to_do_task_post_message** | [**ToDoTaskPostMessage**](ToDoTaskPostMessage.md) | | |
|
404
|
+
|
405
|
+
### Return type
|
406
|
+
|
407
|
+
[**ToDoTaskMessage**](ToDoTaskMessage.md)
|
408
|
+
|
409
|
+
### Authorization
|
410
|
+
|
411
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
412
|
+
|
413
|
+
### HTTP request headers
|
414
|
+
|
415
|
+
- **Content-Type**: application/json
|
416
|
+
- **Accept**: application/json
|
417
|
+
|
418
|
+
|
419
|
+
## delete_task_history_file
|
420
|
+
|
421
|
+
> delete_task_history_file(task_id, task_history_id, file_id)
|
422
|
+
|
423
|
+
Delete task history file
|
424
|
+
|
425
|
+
Deletes a specific file from a task history record. The file will be permanently deleted from the Buildium platform an can not be recovered. 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` `Edit` `Delete`
|
426
|
+
|
427
|
+
### Examples
|
428
|
+
|
429
|
+
```ruby
|
430
|
+
require 'time'
|
431
|
+
require 'buildium-ruby'
|
432
|
+
# setup authorization
|
433
|
+
Buildium.configure do |config|
|
434
|
+
# Configure API key authorization: clientId
|
435
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
436
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
437
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
438
|
+
|
439
|
+
# Configure API key authorization: clientSecret
|
440
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
441
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
442
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
443
|
+
end
|
444
|
+
|
445
|
+
api_instance = Buildium::TasksApi.new
|
446
|
+
task_id = 56 # Integer |
|
447
|
+
task_history_id = 56 # Integer |
|
448
|
+
file_id = 56 # Integer |
|
449
|
+
|
450
|
+
begin
|
451
|
+
# Delete task history file
|
452
|
+
api_instance.delete_task_history_file(task_id, task_history_id, file_id)
|
453
|
+
rescue Buildium::ApiError => e
|
454
|
+
puts "Error when calling TasksApi->delete_task_history_file: #{e}"
|
455
|
+
end
|
456
|
+
```
|
457
|
+
|
458
|
+
#### Using the delete_task_history_file_with_http_info variant
|
459
|
+
|
460
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
461
|
+
|
462
|
+
> <Array(nil, Integer, Hash)> delete_task_history_file_with_http_info(task_id, task_history_id, file_id)
|
463
|
+
|
464
|
+
```ruby
|
465
|
+
begin
|
466
|
+
# Delete task history file
|
467
|
+
data, status_code, headers = api_instance.delete_task_history_file_with_http_info(task_id, task_history_id, file_id)
|
468
|
+
p status_code # => 2xx
|
469
|
+
p headers # => { ... }
|
470
|
+
p data # => nil
|
471
|
+
rescue Buildium::ApiError => e
|
472
|
+
puts "Error when calling TasksApi->delete_task_history_file_with_http_info: #{e}"
|
473
|
+
end
|
474
|
+
```
|
475
|
+
|
476
|
+
### Parameters
|
477
|
+
|
478
|
+
| Name | Type | Description | Notes |
|
479
|
+
| ---- | ---- | ----------- | ----- |
|
480
|
+
| **task_id** | **Integer** | | |
|
481
|
+
| **task_history_id** | **Integer** | | |
|
482
|
+
| **file_id** | **Integer** | | |
|
483
|
+
|
484
|
+
### Return type
|
485
|
+
|
486
|
+
nil (empty response body)
|
487
|
+
|
488
|
+
### Authorization
|
489
|
+
|
490
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
491
|
+
|
492
|
+
### HTTP request headers
|
493
|
+
|
494
|
+
- **Content-Type**: Not defined
|
495
|
+
- **Accept**: application/json
|
496
|
+
|
497
|
+
|
498
|
+
## get_all_rental_owner_request_tasks
|
499
|
+
|
500
|
+
> <Array<RentalOwnerRequestTaskMessage>> get_all_rental_owner_request_tasks(opts)
|
501
|
+
|
502
|
+
Retrieve all rental owner requests
|
503
|
+
|
504
|
+
Retrieves all rental owner requests. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
505
|
+
|
506
|
+
### Examples
|
507
|
+
|
508
|
+
```ruby
|
509
|
+
require 'time'
|
510
|
+
require 'buildium-ruby'
|
511
|
+
# setup authorization
|
512
|
+
Buildium.configure do |config|
|
513
|
+
# Configure API key authorization: clientId
|
514
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
515
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
516
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
517
|
+
|
518
|
+
# Configure API key authorization: clientSecret
|
519
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
520
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
521
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
522
|
+
end
|
523
|
+
|
524
|
+
api_instance = Buildium::TasksApi.new
|
525
|
+
opts = {
|
526
|
+
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
|
+
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
|
+
statuses: ['New'], # Array<String> | Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
|
529
|
+
unitid: 56, # Integer | Filters results to any task associated with the unit identifier.
|
530
|
+
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
|
+
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
|
+
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.
|
533
|
+
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.
|
534
|
+
taskcategoryid: 56, # Integer | Filters results to any tasks with the specified category identifier.
|
535
|
+
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.
|
536
|
+
assignedtoid: 56, # Integer | Filters results to any tasks that have been assigned to the specified staff user identifier.
|
537
|
+
tasktitle: 'tasktitle_example', # String | Filters results to any task whose title *contains* the specified value.
|
538
|
+
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.
|
539
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
540
|
+
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.
|
541
|
+
}
|
542
|
+
|
543
|
+
begin
|
544
|
+
# Retrieve all rental owner requests
|
545
|
+
result = api_instance.get_all_rental_owner_request_tasks(opts)
|
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)
|
1673
|
+
p result
|
1674
|
+
rescue Buildium::ApiError => e
|
1675
|
+
puts "Error when calling TasksApi->get_task_history_by_id: #{e}"
|
1676
|
+
end
|
1677
|
+
```
|
1678
|
+
|
1679
|
+
#### Using the get_task_history_by_id_with_http_info variant
|
1680
|
+
|
1681
|
+
This returns an Array which contains the response data, status code and headers.
|
1682
|
+
|
1683
|
+
> <Array(<TaskHistoryMessage>, Integer, Hash)> get_task_history_by_id_with_http_info(task_id, task_history_id)
|
1684
|
+
|
1685
|
+
```ruby
|
1686
|
+
begin
|
1687
|
+
# Retrieve a task history
|
1688
|
+
data, status_code, headers = api_instance.get_task_history_by_id_with_http_info(task_id, task_history_id)
|
1689
|
+
p status_code # => 2xx
|
1690
|
+
p headers # => { ... }
|
1691
|
+
p data # => <TaskHistoryMessage>
|
1692
|
+
rescue Buildium::ApiError => e
|
1693
|
+
puts "Error when calling TasksApi->get_task_history_by_id_with_http_info: #{e}"
|
1694
|
+
end
|
1695
|
+
```
|
1696
|
+
|
1697
|
+
### Parameters
|
1698
|
+
|
1699
|
+
| Name | Type | Description | Notes |
|
1700
|
+
| ---- | ---- | ----------- | ----- |
|
1701
|
+
| **task_id** | **Integer** | | |
|
1702
|
+
| **task_history_id** | **Integer** | | |
|
1703
|
+
|
1704
|
+
### Return type
|
1705
|
+
|
1706
|
+
[**TaskHistoryMessage**](TaskHistoryMessage.md)
|
1707
|
+
|
1708
|
+
### Authorization
|
1709
|
+
|
1710
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1711
|
+
|
1712
|
+
### HTTP request headers
|
1713
|
+
|
1714
|
+
- **Content-Type**: Not defined
|
1715
|
+
- **Accept**: application/json
|
1716
|
+
|
1717
|
+
|
1718
|
+
## get_task_history_file_by_id
|
1719
|
+
|
1720
|
+
> <TaskHistoryFileMessage> get_task_history_file_by_id(task_id, task_history_id, file_id)
|
1721
|
+
|
1722
|
+
Retrieve a task history file
|
1723
|
+
|
1724
|
+
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`
|
1725
|
+
|
1726
|
+
### Examples
|
1727
|
+
|
1728
|
+
```ruby
|
1729
|
+
require 'time'
|
1730
|
+
require 'buildium-ruby'
|
1731
|
+
# setup authorization
|
1732
|
+
Buildium.configure do |config|
|
1733
|
+
# Configure API key authorization: clientId
|
1734
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
1735
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1736
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
1737
|
+
|
1738
|
+
# Configure API key authorization: clientSecret
|
1739
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
1740
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1741
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
1742
|
+
end
|
1743
|
+
|
1744
|
+
api_instance = Buildium::TasksApi.new
|
1745
|
+
task_id = 56 # Integer |
|
1746
|
+
task_history_id = 56 # Integer |
|
1747
|
+
file_id = 56 # Integer |
|
1748
|
+
|
1749
|
+
begin
|
1750
|
+
# Retrieve a task history file
|
1751
|
+
result = api_instance.get_task_history_file_by_id(task_id, task_history_id, file_id)
|
1752
|
+
p result
|
1753
|
+
rescue Buildium::ApiError => e
|
1754
|
+
puts "Error when calling TasksApi->get_task_history_file_by_id: #{e}"
|
1755
|
+
end
|
1756
|
+
```
|
1757
|
+
|
1758
|
+
#### Using the get_task_history_file_by_id_with_http_info variant
|
1759
|
+
|
1760
|
+
This returns an Array which contains the response data, status code and headers.
|
1761
|
+
|
1762
|
+
> <Array(<TaskHistoryFileMessage>, Integer, Hash)> get_task_history_file_by_id_with_http_info(task_id, task_history_id, file_id)
|
1763
|
+
|
1764
|
+
```ruby
|
1765
|
+
begin
|
1766
|
+
# Retrieve a task history file
|
1767
|
+
data, status_code, headers = api_instance.get_task_history_file_by_id_with_http_info(task_id, task_history_id, file_id)
|
1768
|
+
p status_code # => 2xx
|
1769
|
+
p headers # => { ... }
|
1770
|
+
p data # => <TaskHistoryFileMessage>
|
1771
|
+
rescue Buildium::ApiError => e
|
1772
|
+
puts "Error when calling TasksApi->get_task_history_file_by_id_with_http_info: #{e}"
|
1773
|
+
end
|
1774
|
+
```
|
1775
|
+
|
1776
|
+
### Parameters
|
1777
|
+
|
1778
|
+
| Name | Type | Description | Notes |
|
1779
|
+
| ---- | ---- | ----------- | ----- |
|
1780
|
+
| **task_id** | **Integer** | | |
|
1781
|
+
| **task_history_id** | **Integer** | | |
|
1782
|
+
| **file_id** | **Integer** | | |
|
1783
|
+
|
1784
|
+
### Return type
|
1785
|
+
|
1786
|
+
[**TaskHistoryFileMessage**](TaskHistoryFileMessage.md)
|
1787
|
+
|
1788
|
+
### Authorization
|
1789
|
+
|
1790
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1791
|
+
|
1792
|
+
### HTTP request headers
|
1793
|
+
|
1794
|
+
- **Content-Type**: Not defined
|
1795
|
+
- **Accept**: application/json
|
1796
|
+
|
1797
|
+
|
1798
|
+
## get_to_do_task_by_id
|
1799
|
+
|
1800
|
+
> <ToDoTaskMessage> get_to_do_task_by_id(to_do_task_id)
|
1801
|
+
|
1802
|
+
Retrieve a to do task
|
1803
|
+
|
1804
|
+
Retrieves a to do task. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
1805
|
+
|
1806
|
+
### Examples
|
1807
|
+
|
1808
|
+
```ruby
|
1809
|
+
require 'time'
|
1810
|
+
require 'buildium-ruby'
|
1811
|
+
# setup authorization
|
1812
|
+
Buildium.configure do |config|
|
1813
|
+
# Configure API key authorization: clientId
|
1814
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
1815
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1816
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
1817
|
+
|
1818
|
+
# Configure API key authorization: clientSecret
|
1819
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
1820
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1821
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
1822
|
+
end
|
1823
|
+
|
1824
|
+
api_instance = Buildium::TasksApi.new
|
1825
|
+
to_do_task_id = 56 # Integer | The to do task identifier
|
1826
|
+
|
1827
|
+
begin
|
1828
|
+
# Retrieve a to do task
|
1829
|
+
result = api_instance.get_to_do_task_by_id(to_do_task_id)
|
1830
|
+
p result
|
1831
|
+
rescue Buildium::ApiError => e
|
1832
|
+
puts "Error when calling TasksApi->get_to_do_task_by_id: #{e}"
|
1833
|
+
end
|
1834
|
+
```
|
1835
|
+
|
1836
|
+
#### Using the get_to_do_task_by_id_with_http_info variant
|
1837
|
+
|
1838
|
+
This returns an Array which contains the response data, status code and headers.
|
1839
|
+
|
1840
|
+
> <Array(<ToDoTaskMessage>, Integer, Hash)> get_to_do_task_by_id_with_http_info(to_do_task_id)
|
1841
|
+
|
1842
|
+
```ruby
|
1843
|
+
begin
|
1844
|
+
# Retrieve a to do task
|
1845
|
+
data, status_code, headers = api_instance.get_to_do_task_by_id_with_http_info(to_do_task_id)
|
1846
|
+
p status_code # => 2xx
|
1847
|
+
p headers # => { ... }
|
1848
|
+
p data # => <ToDoTaskMessage>
|
1849
|
+
rescue Buildium::ApiError => e
|
1850
|
+
puts "Error when calling TasksApi->get_to_do_task_by_id_with_http_info: #{e}"
|
1851
|
+
end
|
1852
|
+
```
|
1853
|
+
|
1854
|
+
### Parameters
|
1855
|
+
|
1856
|
+
| Name | Type | Description | Notes |
|
1857
|
+
| ---- | ---- | ----------- | ----- |
|
1858
|
+
| **to_do_task_id** | **Integer** | The to do task identifier | |
|
1859
|
+
|
1860
|
+
### Return type
|
1861
|
+
|
1862
|
+
[**ToDoTaskMessage**](ToDoTaskMessage.md)
|
1863
|
+
|
1864
|
+
### Authorization
|
1865
|
+
|
1866
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1867
|
+
|
1868
|
+
### HTTP request headers
|
1869
|
+
|
1870
|
+
- **Content-Type**: Not defined
|
1871
|
+
- **Accept**: application/json
|
1872
|
+
|
1873
|
+
|
1874
|
+
## get_to_do_tasks
|
1875
|
+
|
1876
|
+
> <Array<ToDoTaskMessage>> get_to_do_tasks(opts)
|
1877
|
+
|
1878
|
+
Retrieve all to do tasks
|
1879
|
+
|
1880
|
+
Retrieves a list of to do tasks. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
1881
|
+
|
1882
|
+
### Examples
|
1883
|
+
|
1884
|
+
```ruby
|
1885
|
+
require 'time'
|
1886
|
+
require 'buildium-ruby'
|
1887
|
+
# setup authorization
|
1888
|
+
Buildium.configure do |config|
|
1889
|
+
# Configure API key authorization: clientId
|
1890
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
1891
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1892
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
1893
|
+
|
1894
|
+
# Configure API key authorization: clientSecret
|
1895
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
1896
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1897
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
1898
|
+
end
|
1899
|
+
|
1900
|
+
api_instance = Buildium::TasksApi.new
|
1901
|
+
opts = {
|
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
|
+
}
|
1918
|
+
|
1919
|
+
begin
|
1920
|
+
# Retrieve all to do tasks
|
1921
|
+
result = api_instance.get_to_do_tasks(opts)
|
1922
|
+
p result
|
1923
|
+
rescue Buildium::ApiError => e
|
1924
|
+
puts "Error when calling TasksApi->get_to_do_tasks: #{e}"
|
1925
|
+
end
|
1926
|
+
```
|
1927
|
+
|
1928
|
+
#### Using the get_to_do_tasks_with_http_info variant
|
1929
|
+
|
1930
|
+
This returns an Array which contains the response data, status code and headers.
|
1931
|
+
|
1932
|
+
> <Array(<Array<ToDoTaskMessage>>, Integer, Hash)> get_to_do_tasks_with_http_info(opts)
|
1933
|
+
|
1934
|
+
```ruby
|
1935
|
+
begin
|
1936
|
+
# Retrieve all to do tasks
|
1937
|
+
data, status_code, headers = api_instance.get_to_do_tasks_with_http_info(opts)
|
1938
|
+
p status_code # => 2xx
|
1939
|
+
p headers # => { ... }
|
1940
|
+
p data # => <Array<ToDoTaskMessage>>
|
1941
|
+
rescue Buildium::ApiError => e
|
1942
|
+
puts "Error when calling TasksApi->get_to_do_tasks_with_http_info: #{e}"
|
1943
|
+
end
|
1944
|
+
```
|
1945
|
+
|
1946
|
+
### Parameters
|
1947
|
+
|
1948
|
+
| Name | Type | Description | Notes |
|
1949
|
+
| ---- | ---- | ----------- | ----- |
|
1950
|
+
| **entitytype** | **String** | Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated. | [optional] |
|
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] |
|
1965
|
+
|
1966
|
+
### Return type
|
1967
|
+
|
1968
|
+
[**Array<ToDoTaskMessage>**](ToDoTaskMessage.md)
|
1969
|
+
|
1970
|
+
### Authorization
|
1971
|
+
|
1972
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
1973
|
+
|
1974
|
+
### HTTP request headers
|
1975
|
+
|
1976
|
+
- **Content-Type**: Not defined
|
1977
|
+
- **Accept**: application/json
|
1978
|
+
|
1979
|
+
|
1980
|
+
## update_contact_request_task
|
1981
|
+
|
1982
|
+
> <ContactRequestTaskMessage> update_contact_request_task(contact_request_task_id, contact_request_task_put_message)
|
1983
|
+
|
1984
|
+
Update a contact request
|
1985
|
+
|
1986
|
+
Updates a contact request. <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`
|
1987
|
+
|
1988
|
+
### Examples
|
1989
|
+
|
1990
|
+
```ruby
|
1991
|
+
require 'time'
|
1992
|
+
require 'buildium-ruby'
|
1993
|
+
# setup authorization
|
1994
|
+
Buildium.configure do |config|
|
1995
|
+
# Configure API key authorization: clientId
|
1996
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
1997
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1998
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
1999
|
+
|
2000
|
+
# Configure API key authorization: clientSecret
|
2001
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
2002
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2003
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
2004
|
+
end
|
2005
|
+
|
2006
|
+
api_instance = Buildium::TasksApi.new
|
2007
|
+
contact_request_task_id = 56 # Integer | The contact request identifier.
|
2008
|
+
contact_request_task_put_message = Buildium::ContactRequestTaskPutMessage.new({title: 'title_example', assigned_to_user_id: 37, task_status: 'New', priority: 'Low', contact_detail: Buildium::ContactDetailSaveMessage.new({first_name: 'first_name_example'})}) # ContactRequestTaskPutMessage |
|
2009
|
+
|
2010
|
+
begin
|
2011
|
+
# Update a contact request
|
2012
|
+
result = api_instance.update_contact_request_task(contact_request_task_id, contact_request_task_put_message)
|
2013
|
+
p result
|
2014
|
+
rescue Buildium::ApiError => e
|
2015
|
+
puts "Error when calling TasksApi->update_contact_request_task: #{e}"
|
2016
|
+
end
|
2017
|
+
```
|
2018
|
+
|
2019
|
+
#### Using the update_contact_request_task_with_http_info variant
|
2020
|
+
|
2021
|
+
This returns an Array which contains the response data, status code and headers.
|
2022
|
+
|
2023
|
+
> <Array(<ContactRequestTaskMessage>, Integer, Hash)> update_contact_request_task_with_http_info(contact_request_task_id, contact_request_task_put_message)
|
2024
|
+
|
2025
|
+
```ruby
|
2026
|
+
begin
|
2027
|
+
# Update a contact request
|
2028
|
+
data, status_code, headers = api_instance.update_contact_request_task_with_http_info(contact_request_task_id, contact_request_task_put_message)
|
2029
|
+
p status_code # => 2xx
|
2030
|
+
p headers # => { ... }
|
2031
|
+
p data # => <ContactRequestTaskMessage>
|
2032
|
+
rescue Buildium::ApiError => e
|
2033
|
+
puts "Error when calling TasksApi->update_contact_request_task_with_http_info: #{e}"
|
2034
|
+
end
|
2035
|
+
```
|
2036
|
+
|
2037
|
+
### Parameters
|
2038
|
+
|
2039
|
+
| Name | Type | Description | Notes |
|
2040
|
+
| ---- | ---- | ----------- | ----- |
|
2041
|
+
| **contact_request_task_id** | **Integer** | The contact request identifier. | |
|
2042
|
+
| **contact_request_task_put_message** | [**ContactRequestTaskPutMessage**](ContactRequestTaskPutMessage.md) | | |
|
2043
|
+
|
2044
|
+
### Return type
|
2045
|
+
|
2046
|
+
[**ContactRequestTaskMessage**](ContactRequestTaskMessage.md)
|
2047
|
+
|
2048
|
+
### Authorization
|
2049
|
+
|
2050
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
2051
|
+
|
2052
|
+
### HTTP request headers
|
2053
|
+
|
2054
|
+
- **Content-Type**: application/json
|
2055
|
+
- **Accept**: application/json
|
2056
|
+
|
2057
|
+
|
2058
|
+
## update_rental_owner_request_task
|
2059
|
+
|
2060
|
+
> <RentalOwnerRequestTaskMessage> update_rental_owner_request_task(rental_owner_request_task_id, rental_owner_request_task_put_message)
|
2061
|
+
|
2062
|
+
Update a rental owner request
|
2063
|
+
|
2064
|
+
Updates a rental owner request. <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`
|
2065
|
+
|
2066
|
+
### Examples
|
2067
|
+
|
2068
|
+
```ruby
|
2069
|
+
require 'time'
|
2070
|
+
require 'buildium-ruby'
|
2071
|
+
# setup authorization
|
2072
|
+
Buildium.configure do |config|
|
2073
|
+
# Configure API key authorization: clientId
|
2074
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
2075
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2076
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
2077
|
+
|
2078
|
+
# Configure API key authorization: clientSecret
|
2079
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
2080
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2081
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
2082
|
+
end
|
2083
|
+
|
2084
|
+
api_instance = Buildium::TasksApi.new
|
2085
|
+
rental_owner_request_task_id = 56 # Integer | The rental owner request identifier.
|
2086
|
+
rental_owner_request_task_put_message = Buildium::RentalOwnerRequestTaskPutMessage.new({title: 'title_example', task_status: 'New', priority: 'Low'}) # RentalOwnerRequestTaskPutMessage |
|
2087
|
+
|
2088
|
+
begin
|
2089
|
+
# Update a rental owner request
|
2090
|
+
result = api_instance.update_rental_owner_request_task(rental_owner_request_task_id, rental_owner_request_task_put_message)
|
2091
|
+
p result
|
2092
|
+
rescue Buildium::ApiError => e
|
2093
|
+
puts "Error when calling TasksApi->update_rental_owner_request_task: #{e}"
|
2094
|
+
end
|
2095
|
+
```
|
2096
|
+
|
2097
|
+
#### Using the update_rental_owner_request_task_with_http_info variant
|
2098
|
+
|
2099
|
+
This returns an Array which contains the response data, status code and headers.
|
2100
|
+
|
2101
|
+
> <Array(<RentalOwnerRequestTaskMessage>, Integer, Hash)> update_rental_owner_request_task_with_http_info(rental_owner_request_task_id, rental_owner_request_task_put_message)
|
2102
|
+
|
2103
|
+
```ruby
|
2104
|
+
begin
|
2105
|
+
# Update a rental owner request
|
2106
|
+
data, status_code, headers = api_instance.update_rental_owner_request_task_with_http_info(rental_owner_request_task_id, rental_owner_request_task_put_message)
|
2107
|
+
p status_code # => 2xx
|
2108
|
+
p headers # => { ... }
|
2109
|
+
p data # => <RentalOwnerRequestTaskMessage>
|
2110
|
+
rescue Buildium::ApiError => e
|
2111
|
+
puts "Error when calling TasksApi->update_rental_owner_request_task_with_http_info: #{e}"
|
2112
|
+
end
|
2113
|
+
```
|
2114
|
+
|
2115
|
+
### Parameters
|
2116
|
+
|
2117
|
+
| Name | Type | Description | Notes |
|
2118
|
+
| ---- | ---- | ----------- | ----- |
|
2119
|
+
| **rental_owner_request_task_id** | **Integer** | The rental owner request identifier. | |
|
2120
|
+
| **rental_owner_request_task_put_message** | [**RentalOwnerRequestTaskPutMessage**](RentalOwnerRequestTaskPutMessage.md) | | |
|
2121
|
+
|
2122
|
+
### Return type
|
2123
|
+
|
2124
|
+
[**RentalOwnerRequestTaskMessage**](RentalOwnerRequestTaskMessage.md)
|
2125
|
+
|
2126
|
+
### Authorization
|
2127
|
+
|
2128
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
2129
|
+
|
2130
|
+
### HTTP request headers
|
2131
|
+
|
2132
|
+
- **Content-Type**: application/json
|
2133
|
+
- **Accept**: application/json
|
2134
|
+
|
2135
|
+
|
2136
|
+
## update_resource
|
2137
|
+
|
2138
|
+
> <ResidentRequestTaskMessage> update_resource(resident_request_task_id, resident_request_task_put_message)
|
2139
|
+
|
2140
|
+
Update a resident request
|
2141
|
+
|
2142
|
+
Update a resident request. <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`
|
2143
|
+
|
2144
|
+
### Examples
|
2145
|
+
|
2146
|
+
```ruby
|
2147
|
+
require 'time'
|
2148
|
+
require 'buildium-ruby'
|
2149
|
+
# setup authorization
|
2150
|
+
Buildium.configure do |config|
|
2151
|
+
# Configure API key authorization: clientId
|
2152
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
2153
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2154
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
2155
|
+
|
2156
|
+
# Configure API key authorization: clientSecret
|
2157
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
2158
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2159
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
2160
|
+
end
|
2161
|
+
|
2162
|
+
api_instance = Buildium::TasksApi.new
|
2163
|
+
resident_request_task_id = 56 # Integer | The resident request identifier.
|
2164
|
+
resident_request_task_put_message = Buildium::ResidentRequestTaskPutMessage.new({title: 'title_example', task_status: 'New', priority: 'Low'}) # ResidentRequestTaskPutMessage |
|
2165
|
+
|
2166
|
+
begin
|
2167
|
+
# Update a resident request
|
2168
|
+
result = api_instance.update_resource(resident_request_task_id, resident_request_task_put_message)
|
2169
|
+
p result
|
2170
|
+
rescue Buildium::ApiError => e
|
2171
|
+
puts "Error when calling TasksApi->update_resource: #{e}"
|
2172
|
+
end
|
2173
|
+
```
|
2174
|
+
|
2175
|
+
#### Using the update_resource_with_http_info variant
|
2176
|
+
|
2177
|
+
This returns an Array which contains the response data, status code and headers.
|
2178
|
+
|
2179
|
+
> <Array(<ResidentRequestTaskMessage>, Integer, Hash)> update_resource_with_http_info(resident_request_task_id, resident_request_task_put_message)
|
2180
|
+
|
2181
|
+
```ruby
|
2182
|
+
begin
|
2183
|
+
# Update a resident request
|
2184
|
+
data, status_code, headers = api_instance.update_resource_with_http_info(resident_request_task_id, resident_request_task_put_message)
|
2185
|
+
p status_code # => 2xx
|
2186
|
+
p headers # => { ... }
|
2187
|
+
p data # => <ResidentRequestTaskMessage>
|
2188
|
+
rescue Buildium::ApiError => e
|
2189
|
+
puts "Error when calling TasksApi->update_resource_with_http_info: #{e}"
|
2190
|
+
end
|
2191
|
+
```
|
2192
|
+
|
2193
|
+
### Parameters
|
2194
|
+
|
2195
|
+
| Name | Type | Description | Notes |
|
2196
|
+
| ---- | ---- | ----------- | ----- |
|
2197
|
+
| **resident_request_task_id** | **Integer** | The resident request identifier. | |
|
2198
|
+
| **resident_request_task_put_message** | [**ResidentRequestTaskPutMessage**](ResidentRequestTaskPutMessage.md) | | |
|
2199
|
+
|
2200
|
+
### Return type
|
2201
|
+
|
2202
|
+
[**ResidentRequestTaskMessage**](ResidentRequestTaskMessage.md)
|
2203
|
+
|
2204
|
+
### Authorization
|
2205
|
+
|
2206
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
2207
|
+
|
2208
|
+
### HTTP request headers
|
2209
|
+
|
2210
|
+
- **Content-Type**: application/json
|
2211
|
+
- **Accept**: application/json
|
2212
|
+
|
2213
|
+
|
2214
|
+
## update_task_category
|
2215
|
+
|
2216
|
+
> <TaskCategoryMessage> update_task_category(task_category_id, task_category_put_message)
|
2217
|
+
|
2218
|
+
Update a task category
|
2219
|
+
|
2220
|
+
Updates a task category. <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`
|
2221
|
+
|
2222
|
+
### Examples
|
2223
|
+
|
2224
|
+
```ruby
|
2225
|
+
require 'time'
|
2226
|
+
require 'buildium-ruby'
|
2227
|
+
# setup authorization
|
2228
|
+
Buildium.configure do |config|
|
2229
|
+
# Configure API key authorization: clientId
|
2230
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
2231
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2232
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
2233
|
+
|
2234
|
+
# Configure API key authorization: clientSecret
|
2235
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
2236
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2237
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
2238
|
+
end
|
2239
|
+
|
2240
|
+
api_instance = Buildium::TasksApi.new
|
2241
|
+
task_category_id = 56 # Integer | The task category identifier.
|
2242
|
+
task_category_put_message = Buildium::TaskCategoryPutMessage.new({name: 'name_example'}) # TaskCategoryPutMessage |
|
2243
|
+
|
2244
|
+
begin
|
2245
|
+
# Update a task category
|
2246
|
+
result = api_instance.update_task_category(task_category_id, task_category_put_message)
|
2247
|
+
p result
|
2248
|
+
rescue Buildium::ApiError => e
|
2249
|
+
puts "Error when calling TasksApi->update_task_category: #{e}"
|
2250
|
+
end
|
2251
|
+
```
|
2252
|
+
|
2253
|
+
#### Using the update_task_category_with_http_info variant
|
2254
|
+
|
2255
|
+
This returns an Array which contains the response data, status code and headers.
|
2256
|
+
|
2257
|
+
> <Array(<TaskCategoryMessage>, Integer, Hash)> update_task_category_with_http_info(task_category_id, task_category_put_message)
|
2258
|
+
|
2259
|
+
```ruby
|
2260
|
+
begin
|
2261
|
+
# Update a task category
|
2262
|
+
data, status_code, headers = api_instance.update_task_category_with_http_info(task_category_id, task_category_put_message)
|
2263
|
+
p status_code # => 2xx
|
2264
|
+
p headers # => { ... }
|
2265
|
+
p data # => <TaskCategoryMessage>
|
2266
|
+
rescue Buildium::ApiError => e
|
2267
|
+
puts "Error when calling TasksApi->update_task_category_with_http_info: #{e}"
|
2268
|
+
end
|
2269
|
+
```
|
2270
|
+
|
2271
|
+
### Parameters
|
2272
|
+
|
2273
|
+
| Name | Type | Description | Notes |
|
2274
|
+
| ---- | ---- | ----------- | ----- |
|
2275
|
+
| **task_category_id** | **Integer** | The task category identifier. | |
|
2276
|
+
| **task_category_put_message** | [**TaskCategoryPutMessage**](TaskCategoryPutMessage.md) | | |
|
2277
|
+
|
2278
|
+
### Return type
|
2279
|
+
|
2280
|
+
[**TaskCategoryMessage**](TaskCategoryMessage.md)
|
2281
|
+
|
2282
|
+
### Authorization
|
2283
|
+
|
2284
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
2285
|
+
|
2286
|
+
### HTTP request headers
|
2287
|
+
|
2288
|
+
- **Content-Type**: application/json
|
2289
|
+
- **Accept**: application/json
|
2290
|
+
|
2291
|
+
|
2292
|
+
## update_task_history
|
2293
|
+
|
2294
|
+
> <TaskHistoryMessage> update_task_history(task_id, task_history_id, task_history_put_message)
|
2295
|
+
|
2296
|
+
Update a task history
|
2297
|
+
|
2298
|
+
Updates 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` `Edit`
|
2299
|
+
|
2300
|
+
### Examples
|
2301
|
+
|
2302
|
+
```ruby
|
2303
|
+
require 'time'
|
2304
|
+
require 'buildium-ruby'
|
2305
|
+
# setup authorization
|
2306
|
+
Buildium.configure do |config|
|
2307
|
+
# Configure API key authorization: clientId
|
2308
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
2309
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2310
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
2311
|
+
|
2312
|
+
# Configure API key authorization: clientSecret
|
2313
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
2314
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2315
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
2316
|
+
end
|
2317
|
+
|
2318
|
+
api_instance = Buildium::TasksApi.new
|
2319
|
+
task_id = 56 # Integer |
|
2320
|
+
task_history_id = 56 # Integer |
|
2321
|
+
task_history_put_message = Buildium::TaskHistoryPutMessage.new({message: 'message_example'}) # TaskHistoryPutMessage |
|
2322
|
+
|
2323
|
+
begin
|
2324
|
+
# Update a task history
|
2325
|
+
result = api_instance.update_task_history(task_id, task_history_id, task_history_put_message)
|
2326
|
+
p result
|
2327
|
+
rescue Buildium::ApiError => e
|
2328
|
+
puts "Error when calling TasksApi->update_task_history: #{e}"
|
2329
|
+
end
|
2330
|
+
```
|
2331
|
+
|
2332
|
+
#### Using the update_task_history_with_http_info variant
|
2333
|
+
|
2334
|
+
This returns an Array which contains the response data, status code and headers.
|
2335
|
+
|
2336
|
+
> <Array(<TaskHistoryMessage>, Integer, Hash)> update_task_history_with_http_info(task_id, task_history_id, task_history_put_message)
|
2337
|
+
|
2338
|
+
```ruby
|
2339
|
+
begin
|
2340
|
+
# Update a task history
|
2341
|
+
data, status_code, headers = api_instance.update_task_history_with_http_info(task_id, task_history_id, task_history_put_message)
|
2342
|
+
p status_code # => 2xx
|
2343
|
+
p headers # => { ... }
|
2344
|
+
p data # => <TaskHistoryMessage>
|
2345
|
+
rescue Buildium::ApiError => e
|
2346
|
+
puts "Error when calling TasksApi->update_task_history_with_http_info: #{e}"
|
2347
|
+
end
|
2348
|
+
```
|
2349
|
+
|
2350
|
+
### Parameters
|
2351
|
+
|
2352
|
+
| Name | Type | Description | Notes |
|
2353
|
+
| ---- | ---- | ----------- | ----- |
|
2354
|
+
| **task_id** | **Integer** | | |
|
2355
|
+
| **task_history_id** | **Integer** | | |
|
2356
|
+
| **task_history_put_message** | [**TaskHistoryPutMessage**](TaskHistoryPutMessage.md) | | |
|
2357
|
+
|
2358
|
+
### Return type
|
2359
|
+
|
2360
|
+
[**TaskHistoryMessage**](TaskHistoryMessage.md)
|
2361
|
+
|
2362
|
+
### Authorization
|
2363
|
+
|
2364
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
2365
|
+
|
2366
|
+
### HTTP request headers
|
2367
|
+
|
2368
|
+
- **Content-Type**: application/json
|
2369
|
+
- **Accept**: application/json
|
2370
|
+
|
2371
|
+
|
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
|
+
## upload_task_history_file_request_async
|
2451
|
+
|
2452
|
+
> <FileUploadTicketMessage> upload_task_history_file_request_async(task_id, task_history_id, task_history_file_upload_post_message)
|
2453
|
+
|
2454
|
+
Upload a task history file
|
2455
|
+
|
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`
|
2457
|
+
|
2458
|
+
### Examples
|
2459
|
+
|
2460
|
+
```ruby
|
2461
|
+
require 'time'
|
2462
|
+
require 'buildium-ruby'
|
2463
|
+
# setup authorization
|
2464
|
+
Buildium.configure do |config|
|
2465
|
+
# Configure API key authorization: clientId
|
2466
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
2467
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2468
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
2469
|
+
|
2470
|
+
# Configure API key authorization: clientSecret
|
2471
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
2472
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
2473
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
2474
|
+
end
|
2475
|
+
|
2476
|
+
api_instance = Buildium::TasksApi.new
|
2477
|
+
task_id = 56 # Integer |
|
2478
|
+
task_history_id = 56 # Integer |
|
2479
|
+
task_history_file_upload_post_message = Buildium::TaskHistoryFileUploadPostMessage.new({file_name: 'file_name_example'}) # TaskHistoryFileUploadPostMessage |
|
2480
|
+
|
2481
|
+
begin
|
2482
|
+
# Upload a task history file
|
2483
|
+
result = api_instance.upload_task_history_file_request_async(task_id, task_history_id, task_history_file_upload_post_message)
|
2484
|
+
p result
|
2485
|
+
rescue Buildium::ApiError => e
|
2486
|
+
puts "Error when calling TasksApi->upload_task_history_file_request_async: #{e}"
|
2487
|
+
end
|
2488
|
+
```
|
2489
|
+
|
2490
|
+
#### Using the upload_task_history_file_request_async_with_http_info variant
|
2491
|
+
|
2492
|
+
This returns an Array which contains the response data, status code and headers.
|
2493
|
+
|
2494
|
+
> <Array(<FileUploadTicketMessage>, Integer, Hash)> upload_task_history_file_request_async_with_http_info(task_id, task_history_id, task_history_file_upload_post_message)
|
2495
|
+
|
2496
|
+
```ruby
|
2497
|
+
begin
|
2498
|
+
# Upload a task history file
|
2499
|
+
data, status_code, headers = api_instance.upload_task_history_file_request_async_with_http_info(task_id, task_history_id, task_history_file_upload_post_message)
|
2500
|
+
p status_code # => 2xx
|
2501
|
+
p headers # => { ... }
|
2502
|
+
p data # => <FileUploadTicketMessage>
|
2503
|
+
rescue Buildium::ApiError => e
|
2504
|
+
puts "Error when calling TasksApi->upload_task_history_file_request_async_with_http_info: #{e}"
|
2505
|
+
end
|
2506
|
+
```
|
2507
|
+
|
2508
|
+
### Parameters
|
2509
|
+
|
2510
|
+
| Name | Type | Description | Notes |
|
2511
|
+
| ---- | ---- | ----------- | ----- |
|
2512
|
+
| **task_id** | **Integer** | | |
|
2513
|
+
| **task_history_id** | **Integer** | | |
|
2514
|
+
| **task_history_file_upload_post_message** | [**TaskHistoryFileUploadPostMessage**](TaskHistoryFileUploadPostMessage.md) | | |
|
2515
|
+
|
2516
|
+
### Return type
|
2517
|
+
|
2518
|
+
[**FileUploadTicketMessage**](FileUploadTicketMessage.md)
|
2519
|
+
|
2520
|
+
### Authorization
|
2521
|
+
|
2522
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
2523
|
+
|
2524
|
+
### HTTP request headers
|
2525
|
+
|
2526
|
+
- **Content-Type**: application/json
|
2527
|
+
- **Accept**: application/json
|
2528
|
+
|