buildium-ruby 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
|
@@ -0,0 +1,1235 @@
|
|
|
1
|
+
# Buildium::AssociationsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.buildium.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_association**](AssociationsApi.md#create_association) | **POST** /v1/associations | Create an association |
|
|
8
|
+
| [**create_association_note**](AssociationsApi.md#create_association_note) | **POST** /v1/associations/{associationId}/notes | Create a note |
|
|
9
|
+
| [**create_board_member**](AssociationsApi.md#create_board_member) | **POST** /v1/associations/{associationId}/boardmembers | Create a board member |
|
|
10
|
+
| [**delete_board_member**](AssociationsApi.md#delete_board_member) | **DELETE** /v1/associations/{associationId}/boardmembers/{boardMemberId} | Delete a board member |
|
|
11
|
+
| [**get_all_association_board_members**](AssociationsApi.md#get_all_association_board_members) | **GET** /v1/associations/{associationId}/boardmembers | Retrieve all board members |
|
|
12
|
+
| [**get_association_board_member_by_id**](AssociationsApi.md#get_association_board_member_by_id) | **GET** /v1/associations/{associationId}/boardmembers/{boardMemberId} | Retrieve a board member |
|
|
13
|
+
| [**get_association_by_id**](AssociationsApi.md#get_association_by_id) | **GET** /v1/associations/{associationId} | Retrieve an association |
|
|
14
|
+
| [**get_association_note_by_note_id**](AssociationsApi.md#get_association_note_by_note_id) | **GET** /v1/associations/{associationId}/notes/{noteId} | Retrieve a note |
|
|
15
|
+
| [**get_association_notes**](AssociationsApi.md#get_association_notes) | **GET** /v1/associations/{associationId}/notes | Retrieve all notes |
|
|
16
|
+
| [**get_association_preferred_vendors**](AssociationsApi.md#get_association_preferred_vendors) | **GET** /v1/associations/{associationId}/vendors | Retrieve all preferred vendors |
|
|
17
|
+
| [**get_associations**](AssociationsApi.md#get_associations) | **GET** /v1/associations | Retrieve all associations |
|
|
18
|
+
| [**update_association**](AssociationsApi.md#update_association) | **PUT** /v1/associations/{associationId} | Update an association |
|
|
19
|
+
| [**update_association_note**](AssociationsApi.md#update_association_note) | **PUT** /v1/associations/{associationId}/notes/{noteId} | Update a note |
|
|
20
|
+
| [**update_association_preferred_vendors**](AssociationsApi.md#update_association_preferred_vendors) | **PUT** /v1/associations/{associationId}/vendors | Update preferred vendors |
|
|
21
|
+
| [**update_board_member**](AssociationsApi.md#update_board_member) | **PUT** /v1/associations/{associationId}/boardmembers/{boardMemberId} | Update a board member |
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
## create_association
|
|
25
|
+
|
|
26
|
+
> <AssociationMessage> create_association(association_post_message)
|
|
27
|
+
|
|
28
|
+
Create an association
|
|
29
|
+
|
|
30
|
+
Creates an association. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Associations and units</span> - `View` `Edit`
|
|
31
|
+
|
|
32
|
+
### Examples
|
|
33
|
+
|
|
34
|
+
```ruby
|
|
35
|
+
require 'time'
|
|
36
|
+
require 'buildium-ruby'
|
|
37
|
+
# setup authorization
|
|
38
|
+
Buildium.configure do |config|
|
|
39
|
+
# Configure API key authorization: clientId
|
|
40
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
41
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
42
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
43
|
+
|
|
44
|
+
# Configure API key authorization: clientSecret
|
|
45
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
46
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
47
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
api_instance = Buildium::AssociationsApi.new
|
|
51
|
+
association_post_message = Buildium::AssociationPostMessage.new({name: 'name_example', operating_bank_account_id: 37, address: Buildium::SaveAddressMessage.new({address_line1: 'address_line1_example', country: 'UnitedStates'})}) # AssociationPostMessage |
|
|
52
|
+
|
|
53
|
+
begin
|
|
54
|
+
# Create an association
|
|
55
|
+
result = api_instance.create_association(association_post_message)
|
|
56
|
+
p result
|
|
57
|
+
rescue Buildium::ApiError => e
|
|
58
|
+
puts "Error when calling AssociationsApi->create_association: #{e}"
|
|
59
|
+
end
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
#### Using the create_association_with_http_info variant
|
|
63
|
+
|
|
64
|
+
This returns an Array which contains the response data, status code and headers.
|
|
65
|
+
|
|
66
|
+
> <Array(<AssociationMessage>, Integer, Hash)> create_association_with_http_info(association_post_message)
|
|
67
|
+
|
|
68
|
+
```ruby
|
|
69
|
+
begin
|
|
70
|
+
# Create an association
|
|
71
|
+
data, status_code, headers = api_instance.create_association_with_http_info(association_post_message)
|
|
72
|
+
p status_code # => 2xx
|
|
73
|
+
p headers # => { ... }
|
|
74
|
+
p data # => <AssociationMessage>
|
|
75
|
+
rescue Buildium::ApiError => e
|
|
76
|
+
puts "Error when calling AssociationsApi->create_association_with_http_info: #{e}"
|
|
77
|
+
end
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Parameters
|
|
81
|
+
|
|
82
|
+
| Name | Type | Description | Notes |
|
|
83
|
+
| ---- | ---- | ----------- | ----- |
|
|
84
|
+
| **association_post_message** | [**AssociationPostMessage**](AssociationPostMessage.md) | | |
|
|
85
|
+
|
|
86
|
+
### Return type
|
|
87
|
+
|
|
88
|
+
[**AssociationMessage**](AssociationMessage.md)
|
|
89
|
+
|
|
90
|
+
### Authorization
|
|
91
|
+
|
|
92
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
93
|
+
|
|
94
|
+
### HTTP request headers
|
|
95
|
+
|
|
96
|
+
- **Content-Type**: application/json
|
|
97
|
+
- **Accept**: application/json
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
## create_association_note
|
|
101
|
+
|
|
102
|
+
> <NoteMessage> create_association_note(association_id, note_post_message)
|
|
103
|
+
|
|
104
|
+
Create a note
|
|
105
|
+
|
|
106
|
+
Creates a note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Associations and units</span> - `View` `Edit`
|
|
107
|
+
|
|
108
|
+
### Examples
|
|
109
|
+
|
|
110
|
+
```ruby
|
|
111
|
+
require 'time'
|
|
112
|
+
require 'buildium-ruby'
|
|
113
|
+
# setup authorization
|
|
114
|
+
Buildium.configure do |config|
|
|
115
|
+
# Configure API key authorization: clientId
|
|
116
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
117
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
118
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
119
|
+
|
|
120
|
+
# Configure API key authorization: clientSecret
|
|
121
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
122
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
123
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
api_instance = Buildium::AssociationsApi.new
|
|
127
|
+
association_id = 56 # Integer |
|
|
128
|
+
note_post_message = Buildium::NotePostMessage.new({note: 'note_example'}) # NotePostMessage |
|
|
129
|
+
|
|
130
|
+
begin
|
|
131
|
+
# Create a note
|
|
132
|
+
result = api_instance.create_association_note(association_id, note_post_message)
|
|
133
|
+
p result
|
|
134
|
+
rescue Buildium::ApiError => e
|
|
135
|
+
puts "Error when calling AssociationsApi->create_association_note: #{e}"
|
|
136
|
+
end
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
#### Using the create_association_note_with_http_info variant
|
|
140
|
+
|
|
141
|
+
This returns an Array which contains the response data, status code and headers.
|
|
142
|
+
|
|
143
|
+
> <Array(<NoteMessage>, Integer, Hash)> create_association_note_with_http_info(association_id, note_post_message)
|
|
144
|
+
|
|
145
|
+
```ruby
|
|
146
|
+
begin
|
|
147
|
+
# Create a note
|
|
148
|
+
data, status_code, headers = api_instance.create_association_note_with_http_info(association_id, note_post_message)
|
|
149
|
+
p status_code # => 2xx
|
|
150
|
+
p headers # => { ... }
|
|
151
|
+
p data # => <NoteMessage>
|
|
152
|
+
rescue Buildium::ApiError => e
|
|
153
|
+
puts "Error when calling AssociationsApi->create_association_note_with_http_info: #{e}"
|
|
154
|
+
end
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### Parameters
|
|
158
|
+
|
|
159
|
+
| Name | Type | Description | Notes |
|
|
160
|
+
| ---- | ---- | ----------- | ----- |
|
|
161
|
+
| **association_id** | **Integer** | | |
|
|
162
|
+
| **note_post_message** | [**NotePostMessage**](NotePostMessage.md) | | |
|
|
163
|
+
|
|
164
|
+
### Return type
|
|
165
|
+
|
|
166
|
+
[**NoteMessage**](NoteMessage.md)
|
|
167
|
+
|
|
168
|
+
### Authorization
|
|
169
|
+
|
|
170
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
171
|
+
|
|
172
|
+
### HTTP request headers
|
|
173
|
+
|
|
174
|
+
- **Content-Type**: application/json
|
|
175
|
+
- **Accept**: application/json
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
## create_board_member
|
|
179
|
+
|
|
180
|
+
> <AssociationBoardMemberMessage> create_board_member(association_id, association_board_member_post_message)
|
|
181
|
+
|
|
182
|
+
Create a board member
|
|
183
|
+
|
|
184
|
+
Creates a board member for a given association. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Association owners and tenants</span> - `View` `Edit`
|
|
185
|
+
|
|
186
|
+
### Examples
|
|
187
|
+
|
|
188
|
+
```ruby
|
|
189
|
+
require 'time'
|
|
190
|
+
require 'buildium-ruby'
|
|
191
|
+
# setup authorization
|
|
192
|
+
Buildium.configure do |config|
|
|
193
|
+
# Configure API key authorization: clientId
|
|
194
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
195
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
196
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
197
|
+
|
|
198
|
+
# Configure API key authorization: clientSecret
|
|
199
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
200
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
201
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
202
|
+
end
|
|
203
|
+
|
|
204
|
+
api_instance = Buildium::AssociationsApi.new
|
|
205
|
+
association_id = 56 # Integer |
|
|
206
|
+
association_board_member_post_message = Buildium::AssociationBoardMemberPostMessage.new({association_owner_id: 37, board_position_type: 'President'}) # AssociationBoardMemberPostMessage |
|
|
207
|
+
|
|
208
|
+
begin
|
|
209
|
+
# Create a board member
|
|
210
|
+
result = api_instance.create_board_member(association_id, association_board_member_post_message)
|
|
211
|
+
p result
|
|
212
|
+
rescue Buildium::ApiError => e
|
|
213
|
+
puts "Error when calling AssociationsApi->create_board_member: #{e}"
|
|
214
|
+
end
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
#### Using the create_board_member_with_http_info variant
|
|
218
|
+
|
|
219
|
+
This returns an Array which contains the response data, status code and headers.
|
|
220
|
+
|
|
221
|
+
> <Array(<AssociationBoardMemberMessage>, Integer, Hash)> create_board_member_with_http_info(association_id, association_board_member_post_message)
|
|
222
|
+
|
|
223
|
+
```ruby
|
|
224
|
+
begin
|
|
225
|
+
# Create a board member
|
|
226
|
+
data, status_code, headers = api_instance.create_board_member_with_http_info(association_id, association_board_member_post_message)
|
|
227
|
+
p status_code # => 2xx
|
|
228
|
+
p headers # => { ... }
|
|
229
|
+
p data # => <AssociationBoardMemberMessage>
|
|
230
|
+
rescue Buildium::ApiError => e
|
|
231
|
+
puts "Error when calling AssociationsApi->create_board_member_with_http_info: #{e}"
|
|
232
|
+
end
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
### Parameters
|
|
236
|
+
|
|
237
|
+
| Name | Type | Description | Notes |
|
|
238
|
+
| ---- | ---- | ----------- | ----- |
|
|
239
|
+
| **association_id** | **Integer** | | |
|
|
240
|
+
| **association_board_member_post_message** | [**AssociationBoardMemberPostMessage**](AssociationBoardMemberPostMessage.md) | | |
|
|
241
|
+
|
|
242
|
+
### Return type
|
|
243
|
+
|
|
244
|
+
[**AssociationBoardMemberMessage**](AssociationBoardMemberMessage.md)
|
|
245
|
+
|
|
246
|
+
### Authorization
|
|
247
|
+
|
|
248
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
249
|
+
|
|
250
|
+
### HTTP request headers
|
|
251
|
+
|
|
252
|
+
- **Content-Type**: application/json
|
|
253
|
+
- **Accept**: application/json
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
## delete_board_member
|
|
257
|
+
|
|
258
|
+
> delete_board_member(association_id, board_member_id)
|
|
259
|
+
|
|
260
|
+
Delete a board member
|
|
261
|
+
|
|
262
|
+
Deletes a board member. Note, this is a hard delete from the database and data can not be restored. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Association owners and tenants</span> - `View` `Edit` `Delete`
|
|
263
|
+
|
|
264
|
+
### Examples
|
|
265
|
+
|
|
266
|
+
```ruby
|
|
267
|
+
require 'time'
|
|
268
|
+
require 'buildium-ruby'
|
|
269
|
+
# setup authorization
|
|
270
|
+
Buildium.configure do |config|
|
|
271
|
+
# Configure API key authorization: clientId
|
|
272
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
273
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
274
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
275
|
+
|
|
276
|
+
# Configure API key authorization: clientSecret
|
|
277
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
278
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
279
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
280
|
+
end
|
|
281
|
+
|
|
282
|
+
api_instance = Buildium::AssociationsApi.new
|
|
283
|
+
association_id = 56 # Integer |
|
|
284
|
+
board_member_id = 56 # Integer |
|
|
285
|
+
|
|
286
|
+
begin
|
|
287
|
+
# Delete a board member
|
|
288
|
+
api_instance.delete_board_member(association_id, board_member_id)
|
|
289
|
+
rescue Buildium::ApiError => e
|
|
290
|
+
puts "Error when calling AssociationsApi->delete_board_member: #{e}"
|
|
291
|
+
end
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
#### Using the delete_board_member_with_http_info variant
|
|
295
|
+
|
|
296
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
297
|
+
|
|
298
|
+
> <Array(nil, Integer, Hash)> delete_board_member_with_http_info(association_id, board_member_id)
|
|
299
|
+
|
|
300
|
+
```ruby
|
|
301
|
+
begin
|
|
302
|
+
# Delete a board member
|
|
303
|
+
data, status_code, headers = api_instance.delete_board_member_with_http_info(association_id, board_member_id)
|
|
304
|
+
p status_code # => 2xx
|
|
305
|
+
p headers # => { ... }
|
|
306
|
+
p data # => nil
|
|
307
|
+
rescue Buildium::ApiError => e
|
|
308
|
+
puts "Error when calling AssociationsApi->delete_board_member_with_http_info: #{e}"
|
|
309
|
+
end
|
|
310
|
+
```
|
|
311
|
+
|
|
312
|
+
### Parameters
|
|
313
|
+
|
|
314
|
+
| Name | Type | Description | Notes |
|
|
315
|
+
| ---- | ---- | ----------- | ----- |
|
|
316
|
+
| **association_id** | **Integer** | | |
|
|
317
|
+
| **board_member_id** | **Integer** | | |
|
|
318
|
+
|
|
319
|
+
### Return type
|
|
320
|
+
|
|
321
|
+
nil (empty response body)
|
|
322
|
+
|
|
323
|
+
### Authorization
|
|
324
|
+
|
|
325
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
326
|
+
|
|
327
|
+
### HTTP request headers
|
|
328
|
+
|
|
329
|
+
- **Content-Type**: Not defined
|
|
330
|
+
- **Accept**: application/json
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
## get_all_association_board_members
|
|
334
|
+
|
|
335
|
+
> <Array<AssociationBoardMemberMessage>> get_all_association_board_members(association_id, opts)
|
|
336
|
+
|
|
337
|
+
Retrieve all board members
|
|
338
|
+
|
|
339
|
+
Retrieves all association board members. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Association owners and tenants</span> - `View`
|
|
340
|
+
|
|
341
|
+
### Examples
|
|
342
|
+
|
|
343
|
+
```ruby
|
|
344
|
+
require 'time'
|
|
345
|
+
require 'buildium-ruby'
|
|
346
|
+
# setup authorization
|
|
347
|
+
Buildium.configure do |config|
|
|
348
|
+
# Configure API key authorization: clientId
|
|
349
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
350
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
351
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
352
|
+
|
|
353
|
+
# Configure API key authorization: clientSecret
|
|
354
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
355
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
356
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
357
|
+
end
|
|
358
|
+
|
|
359
|
+
api_instance = Buildium::AssociationsApi.new
|
|
360
|
+
association_id = 56 # Integer |
|
|
361
|
+
opts = {
|
|
362
|
+
statuses: ['Current'], # Array<String> | Filters results to only records whose status is equal to the specified values.
|
|
363
|
+
boardpositiontypes: ['President'], # Array<String> | Filters results to only records whose board position type is equal to the specified values.
|
|
364
|
+
createddatetimeto: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to only records that were created before this date. Must be formatted as `YYYY-MM-DD`.
|
|
365
|
+
createddatetimefrom: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to only records that were created after this date. Must be formatted as `YYYY-MM-DD`.
|
|
366
|
+
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.
|
|
367
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
368
|
+
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.
|
|
369
|
+
}
|
|
370
|
+
|
|
371
|
+
begin
|
|
372
|
+
# Retrieve all board members
|
|
373
|
+
result = api_instance.get_all_association_board_members(association_id, opts)
|
|
374
|
+
p result
|
|
375
|
+
rescue Buildium::ApiError => e
|
|
376
|
+
puts "Error when calling AssociationsApi->get_all_association_board_members: #{e}"
|
|
377
|
+
end
|
|
378
|
+
```
|
|
379
|
+
|
|
380
|
+
#### Using the get_all_association_board_members_with_http_info variant
|
|
381
|
+
|
|
382
|
+
This returns an Array which contains the response data, status code and headers.
|
|
383
|
+
|
|
384
|
+
> <Array(<Array<AssociationBoardMemberMessage>>, Integer, Hash)> get_all_association_board_members_with_http_info(association_id, opts)
|
|
385
|
+
|
|
386
|
+
```ruby
|
|
387
|
+
begin
|
|
388
|
+
# Retrieve all board members
|
|
389
|
+
data, status_code, headers = api_instance.get_all_association_board_members_with_http_info(association_id, opts)
|
|
390
|
+
p status_code # => 2xx
|
|
391
|
+
p headers # => { ... }
|
|
392
|
+
p data # => <Array<AssociationBoardMemberMessage>>
|
|
393
|
+
rescue Buildium::ApiError => e
|
|
394
|
+
puts "Error when calling AssociationsApi->get_all_association_board_members_with_http_info: #{e}"
|
|
395
|
+
end
|
|
396
|
+
```
|
|
397
|
+
|
|
398
|
+
### Parameters
|
|
399
|
+
|
|
400
|
+
| Name | Type | Description | Notes |
|
|
401
|
+
| ---- | ---- | ----------- | ----- |
|
|
402
|
+
| **association_id** | **Integer** | | |
|
|
403
|
+
| **statuses** | [**Array<String>**](String.md) | Filters results to only records whose status is equal to the specified values. | [optional] |
|
|
404
|
+
| **boardpositiontypes** | [**Array<String>**](String.md) | Filters results to only records whose board position type is equal to the specified values. | [optional] |
|
|
405
|
+
| **createddatetimeto** | **Time** | Filters results to only records that were created before this date. Must be formatted as `YYYY-MM-DD`. | [optional] |
|
|
406
|
+
| **createddatetimefrom** | **Time** | Filters results to only records that were created after this date. Must be formatted as `YYYY-MM-DD`. | [optional] |
|
|
407
|
+
| **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] |
|
|
408
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
|
409
|
+
| **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] |
|
|
410
|
+
|
|
411
|
+
### Return type
|
|
412
|
+
|
|
413
|
+
[**Array<AssociationBoardMemberMessage>**](AssociationBoardMemberMessage.md)
|
|
414
|
+
|
|
415
|
+
### Authorization
|
|
416
|
+
|
|
417
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
418
|
+
|
|
419
|
+
### HTTP request headers
|
|
420
|
+
|
|
421
|
+
- **Content-Type**: Not defined
|
|
422
|
+
- **Accept**: application/json
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
## get_association_board_member_by_id
|
|
426
|
+
|
|
427
|
+
> <AssociationBoardMemberMessage> get_association_board_member_by_id(association_id, board_member_id)
|
|
428
|
+
|
|
429
|
+
Retrieve a board member
|
|
430
|
+
|
|
431
|
+
Retrieves an association board member. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Association owners and tenants</span> - `View`
|
|
432
|
+
|
|
433
|
+
### Examples
|
|
434
|
+
|
|
435
|
+
```ruby
|
|
436
|
+
require 'time'
|
|
437
|
+
require 'buildium-ruby'
|
|
438
|
+
# setup authorization
|
|
439
|
+
Buildium.configure do |config|
|
|
440
|
+
# Configure API key authorization: clientId
|
|
441
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
442
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
443
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
444
|
+
|
|
445
|
+
# Configure API key authorization: clientSecret
|
|
446
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
447
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
448
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
449
|
+
end
|
|
450
|
+
|
|
451
|
+
api_instance = Buildium::AssociationsApi.new
|
|
452
|
+
association_id = 56 # Integer |
|
|
453
|
+
board_member_id = 56 # Integer |
|
|
454
|
+
|
|
455
|
+
begin
|
|
456
|
+
# Retrieve a board member
|
|
457
|
+
result = api_instance.get_association_board_member_by_id(association_id, board_member_id)
|
|
458
|
+
p result
|
|
459
|
+
rescue Buildium::ApiError => e
|
|
460
|
+
puts "Error when calling AssociationsApi->get_association_board_member_by_id: #{e}"
|
|
461
|
+
end
|
|
462
|
+
```
|
|
463
|
+
|
|
464
|
+
#### Using the get_association_board_member_by_id_with_http_info variant
|
|
465
|
+
|
|
466
|
+
This returns an Array which contains the response data, status code and headers.
|
|
467
|
+
|
|
468
|
+
> <Array(<AssociationBoardMemberMessage>, Integer, Hash)> get_association_board_member_by_id_with_http_info(association_id, board_member_id)
|
|
469
|
+
|
|
470
|
+
```ruby
|
|
471
|
+
begin
|
|
472
|
+
# Retrieve a board member
|
|
473
|
+
data, status_code, headers = api_instance.get_association_board_member_by_id_with_http_info(association_id, board_member_id)
|
|
474
|
+
p status_code # => 2xx
|
|
475
|
+
p headers # => { ... }
|
|
476
|
+
p data # => <AssociationBoardMemberMessage>
|
|
477
|
+
rescue Buildium::ApiError => e
|
|
478
|
+
puts "Error when calling AssociationsApi->get_association_board_member_by_id_with_http_info: #{e}"
|
|
479
|
+
end
|
|
480
|
+
```
|
|
481
|
+
|
|
482
|
+
### Parameters
|
|
483
|
+
|
|
484
|
+
| Name | Type | Description | Notes |
|
|
485
|
+
| ---- | ---- | ----------- | ----- |
|
|
486
|
+
| **association_id** | **Integer** | | |
|
|
487
|
+
| **board_member_id** | **Integer** | | |
|
|
488
|
+
|
|
489
|
+
### Return type
|
|
490
|
+
|
|
491
|
+
[**AssociationBoardMemberMessage**](AssociationBoardMemberMessage.md)
|
|
492
|
+
|
|
493
|
+
### Authorization
|
|
494
|
+
|
|
495
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
496
|
+
|
|
497
|
+
### HTTP request headers
|
|
498
|
+
|
|
499
|
+
- **Content-Type**: Not defined
|
|
500
|
+
- **Accept**: application/json
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
## get_association_by_id
|
|
504
|
+
|
|
505
|
+
> <AssociationMessage> get_association_by_id(association_id)
|
|
506
|
+
|
|
507
|
+
Retrieve an association
|
|
508
|
+
|
|
509
|
+
Retrieve a specific association. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Associations and units</span> - `View`
|
|
510
|
+
|
|
511
|
+
### Examples
|
|
512
|
+
|
|
513
|
+
```ruby
|
|
514
|
+
require 'time'
|
|
515
|
+
require 'buildium-ruby'
|
|
516
|
+
# setup authorization
|
|
517
|
+
Buildium.configure do |config|
|
|
518
|
+
# Configure API key authorization: clientId
|
|
519
|
+
config.api_key['clientId'] = '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['clientId'] = 'Bearer'
|
|
522
|
+
|
|
523
|
+
# Configure API key authorization: clientSecret
|
|
524
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
525
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
526
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
527
|
+
end
|
|
528
|
+
|
|
529
|
+
api_instance = Buildium::AssociationsApi.new
|
|
530
|
+
association_id = 56 # Integer | The association identifier.
|
|
531
|
+
|
|
532
|
+
begin
|
|
533
|
+
# Retrieve an association
|
|
534
|
+
result = api_instance.get_association_by_id(association_id)
|
|
535
|
+
p result
|
|
536
|
+
rescue Buildium::ApiError => e
|
|
537
|
+
puts "Error when calling AssociationsApi->get_association_by_id: #{e}"
|
|
538
|
+
end
|
|
539
|
+
```
|
|
540
|
+
|
|
541
|
+
#### Using the get_association_by_id_with_http_info variant
|
|
542
|
+
|
|
543
|
+
This returns an Array which contains the response data, status code and headers.
|
|
544
|
+
|
|
545
|
+
> <Array(<AssociationMessage>, Integer, Hash)> get_association_by_id_with_http_info(association_id)
|
|
546
|
+
|
|
547
|
+
```ruby
|
|
548
|
+
begin
|
|
549
|
+
# Retrieve an association
|
|
550
|
+
data, status_code, headers = api_instance.get_association_by_id_with_http_info(association_id)
|
|
551
|
+
p status_code # => 2xx
|
|
552
|
+
p headers # => { ... }
|
|
553
|
+
p data # => <AssociationMessage>
|
|
554
|
+
rescue Buildium::ApiError => e
|
|
555
|
+
puts "Error when calling AssociationsApi->get_association_by_id_with_http_info: #{e}"
|
|
556
|
+
end
|
|
557
|
+
```
|
|
558
|
+
|
|
559
|
+
### Parameters
|
|
560
|
+
|
|
561
|
+
| Name | Type | Description | Notes |
|
|
562
|
+
| ---- | ---- | ----------- | ----- |
|
|
563
|
+
| **association_id** | **Integer** | The association identifier. | |
|
|
564
|
+
|
|
565
|
+
### Return type
|
|
566
|
+
|
|
567
|
+
[**AssociationMessage**](AssociationMessage.md)
|
|
568
|
+
|
|
569
|
+
### Authorization
|
|
570
|
+
|
|
571
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
572
|
+
|
|
573
|
+
### HTTP request headers
|
|
574
|
+
|
|
575
|
+
- **Content-Type**: Not defined
|
|
576
|
+
- **Accept**: application/json
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
## get_association_note_by_note_id
|
|
580
|
+
|
|
581
|
+
> <NoteMessage> get_association_note_by_note_id(association_id, note_id)
|
|
582
|
+
|
|
583
|
+
Retrieve a note
|
|
584
|
+
|
|
585
|
+
Retrieves a note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Associations and units</span> - `View`
|
|
586
|
+
|
|
587
|
+
### Examples
|
|
588
|
+
|
|
589
|
+
```ruby
|
|
590
|
+
require 'time'
|
|
591
|
+
require 'buildium-ruby'
|
|
592
|
+
# setup authorization
|
|
593
|
+
Buildium.configure do |config|
|
|
594
|
+
# Configure API key authorization: clientId
|
|
595
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
596
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
597
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
598
|
+
|
|
599
|
+
# Configure API key authorization: clientSecret
|
|
600
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
601
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
602
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
603
|
+
end
|
|
604
|
+
|
|
605
|
+
api_instance = Buildium::AssociationsApi.new
|
|
606
|
+
association_id = 56 # Integer |
|
|
607
|
+
note_id = 56 # Integer |
|
|
608
|
+
|
|
609
|
+
begin
|
|
610
|
+
# Retrieve a note
|
|
611
|
+
result = api_instance.get_association_note_by_note_id(association_id, note_id)
|
|
612
|
+
p result
|
|
613
|
+
rescue Buildium::ApiError => e
|
|
614
|
+
puts "Error when calling AssociationsApi->get_association_note_by_note_id: #{e}"
|
|
615
|
+
end
|
|
616
|
+
```
|
|
617
|
+
|
|
618
|
+
#### Using the get_association_note_by_note_id_with_http_info variant
|
|
619
|
+
|
|
620
|
+
This returns an Array which contains the response data, status code and headers.
|
|
621
|
+
|
|
622
|
+
> <Array(<NoteMessage>, Integer, Hash)> get_association_note_by_note_id_with_http_info(association_id, note_id)
|
|
623
|
+
|
|
624
|
+
```ruby
|
|
625
|
+
begin
|
|
626
|
+
# Retrieve a note
|
|
627
|
+
data, status_code, headers = api_instance.get_association_note_by_note_id_with_http_info(association_id, note_id)
|
|
628
|
+
p status_code # => 2xx
|
|
629
|
+
p headers # => { ... }
|
|
630
|
+
p data # => <NoteMessage>
|
|
631
|
+
rescue Buildium::ApiError => e
|
|
632
|
+
puts "Error when calling AssociationsApi->get_association_note_by_note_id_with_http_info: #{e}"
|
|
633
|
+
end
|
|
634
|
+
```
|
|
635
|
+
|
|
636
|
+
### Parameters
|
|
637
|
+
|
|
638
|
+
| Name | Type | Description | Notes |
|
|
639
|
+
| ---- | ---- | ----------- | ----- |
|
|
640
|
+
| **association_id** | **Integer** | | |
|
|
641
|
+
| **note_id** | **Integer** | | |
|
|
642
|
+
|
|
643
|
+
### Return type
|
|
644
|
+
|
|
645
|
+
[**NoteMessage**](NoteMessage.md)
|
|
646
|
+
|
|
647
|
+
### Authorization
|
|
648
|
+
|
|
649
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
650
|
+
|
|
651
|
+
### HTTP request headers
|
|
652
|
+
|
|
653
|
+
- **Content-Type**: Not defined
|
|
654
|
+
- **Accept**: application/json
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
## get_association_notes
|
|
658
|
+
|
|
659
|
+
> <Array<NoteMessage>> get_association_notes(association_id, opts)
|
|
660
|
+
|
|
661
|
+
Retrieve all notes
|
|
662
|
+
|
|
663
|
+
Retrieves all notes. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Associations and units</span> - `View`
|
|
664
|
+
|
|
665
|
+
### Examples
|
|
666
|
+
|
|
667
|
+
```ruby
|
|
668
|
+
require 'time'
|
|
669
|
+
require 'buildium-ruby'
|
|
670
|
+
# setup authorization
|
|
671
|
+
Buildium.configure do |config|
|
|
672
|
+
# Configure API key authorization: clientId
|
|
673
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
674
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
675
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
676
|
+
|
|
677
|
+
# Configure API key authorization: clientSecret
|
|
678
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
679
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
680
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
681
|
+
end
|
|
682
|
+
|
|
683
|
+
api_instance = Buildium::AssociationsApi.new
|
|
684
|
+
association_id = 56 # Integer |
|
|
685
|
+
opts = {
|
|
686
|
+
updateddatetimefrom: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.
|
|
687
|
+
updateddatetimeto: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS.
|
|
688
|
+
lastupdatedbyuserid: 56, # Integer | Filters results to only notes that were last updated by the specified user identifier.
|
|
689
|
+
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.
|
|
690
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
691
|
+
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.
|
|
692
|
+
}
|
|
693
|
+
|
|
694
|
+
begin
|
|
695
|
+
# Retrieve all notes
|
|
696
|
+
result = api_instance.get_association_notes(association_id, opts)
|
|
697
|
+
p result
|
|
698
|
+
rescue Buildium::ApiError => e
|
|
699
|
+
puts "Error when calling AssociationsApi->get_association_notes: #{e}"
|
|
700
|
+
end
|
|
701
|
+
```
|
|
702
|
+
|
|
703
|
+
#### Using the get_association_notes_with_http_info variant
|
|
704
|
+
|
|
705
|
+
This returns an Array which contains the response data, status code and headers.
|
|
706
|
+
|
|
707
|
+
> <Array(<Array<NoteMessage>>, Integer, Hash)> get_association_notes_with_http_info(association_id, opts)
|
|
708
|
+
|
|
709
|
+
```ruby
|
|
710
|
+
begin
|
|
711
|
+
# Retrieve all notes
|
|
712
|
+
data, status_code, headers = api_instance.get_association_notes_with_http_info(association_id, opts)
|
|
713
|
+
p status_code # => 2xx
|
|
714
|
+
p headers # => { ... }
|
|
715
|
+
p data # => <Array<NoteMessage>>
|
|
716
|
+
rescue Buildium::ApiError => e
|
|
717
|
+
puts "Error when calling AssociationsApi->get_association_notes_with_http_info: #{e}"
|
|
718
|
+
end
|
|
719
|
+
```
|
|
720
|
+
|
|
721
|
+
### Parameters
|
|
722
|
+
|
|
723
|
+
| Name | Type | Description | Notes |
|
|
724
|
+
| ---- | ---- | ----------- | ----- |
|
|
725
|
+
| **association_id** | **Integer** | | |
|
|
726
|
+
| **updateddatetimefrom** | **Time** | Filters results to any note whose updated date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. | [optional] |
|
|
727
|
+
| **updateddatetimeto** | **Time** | Filters results to any note whose updated date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DD HH:MM:SS. | [optional] |
|
|
728
|
+
| **lastupdatedbyuserid** | **Integer** | Filters results to only notes that were last updated by the specified user identifier. | [optional] |
|
|
729
|
+
| **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] |
|
|
730
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
|
731
|
+
| **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] |
|
|
732
|
+
|
|
733
|
+
### Return type
|
|
734
|
+
|
|
735
|
+
[**Array<NoteMessage>**](NoteMessage.md)
|
|
736
|
+
|
|
737
|
+
### Authorization
|
|
738
|
+
|
|
739
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
740
|
+
|
|
741
|
+
### HTTP request headers
|
|
742
|
+
|
|
743
|
+
- **Content-Type**: Not defined
|
|
744
|
+
- **Accept**: application/json
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
## get_association_preferred_vendors
|
|
748
|
+
|
|
749
|
+
> <Array<AssociationPreferredVendorMessage>> get_association_preferred_vendors(association_id, opts)
|
|
750
|
+
|
|
751
|
+
Retrieve all preferred vendors
|
|
752
|
+
|
|
753
|
+
Retrieves all preferred vendors. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Associations and units</span> - `View` <br /><span class=\"permissionBlock\">Maintenance > Vendors</span> - `View`
|
|
754
|
+
|
|
755
|
+
### Examples
|
|
756
|
+
|
|
757
|
+
```ruby
|
|
758
|
+
require 'time'
|
|
759
|
+
require 'buildium-ruby'
|
|
760
|
+
# setup authorization
|
|
761
|
+
Buildium.configure do |config|
|
|
762
|
+
# Configure API key authorization: clientId
|
|
763
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
764
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
765
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
766
|
+
|
|
767
|
+
# Configure API key authorization: clientSecret
|
|
768
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
769
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
770
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
771
|
+
end
|
|
772
|
+
|
|
773
|
+
api_instance = Buildium::AssociationsApi.new
|
|
774
|
+
association_id = 56 # Integer |
|
|
775
|
+
opts = {
|
|
776
|
+
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.
|
|
777
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
778
|
+
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.
|
|
779
|
+
}
|
|
780
|
+
|
|
781
|
+
begin
|
|
782
|
+
# Retrieve all preferred vendors
|
|
783
|
+
result = api_instance.get_association_preferred_vendors(association_id, opts)
|
|
784
|
+
p result
|
|
785
|
+
rescue Buildium::ApiError => e
|
|
786
|
+
puts "Error when calling AssociationsApi->get_association_preferred_vendors: #{e}"
|
|
787
|
+
end
|
|
788
|
+
```
|
|
789
|
+
|
|
790
|
+
#### Using the get_association_preferred_vendors_with_http_info variant
|
|
791
|
+
|
|
792
|
+
This returns an Array which contains the response data, status code and headers.
|
|
793
|
+
|
|
794
|
+
> <Array(<Array<AssociationPreferredVendorMessage>>, Integer, Hash)> get_association_preferred_vendors_with_http_info(association_id, opts)
|
|
795
|
+
|
|
796
|
+
```ruby
|
|
797
|
+
begin
|
|
798
|
+
# Retrieve all preferred vendors
|
|
799
|
+
data, status_code, headers = api_instance.get_association_preferred_vendors_with_http_info(association_id, opts)
|
|
800
|
+
p status_code # => 2xx
|
|
801
|
+
p headers # => { ... }
|
|
802
|
+
p data # => <Array<AssociationPreferredVendorMessage>>
|
|
803
|
+
rescue Buildium::ApiError => e
|
|
804
|
+
puts "Error when calling AssociationsApi->get_association_preferred_vendors_with_http_info: #{e}"
|
|
805
|
+
end
|
|
806
|
+
```
|
|
807
|
+
|
|
808
|
+
### Parameters
|
|
809
|
+
|
|
810
|
+
| Name | Type | Description | Notes |
|
|
811
|
+
| ---- | ---- | ----------- | ----- |
|
|
812
|
+
| **association_id** | **Integer** | | |
|
|
813
|
+
| **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] |
|
|
814
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
|
815
|
+
| **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] |
|
|
816
|
+
|
|
817
|
+
### Return type
|
|
818
|
+
|
|
819
|
+
[**Array<AssociationPreferredVendorMessage>**](AssociationPreferredVendorMessage.md)
|
|
820
|
+
|
|
821
|
+
### Authorization
|
|
822
|
+
|
|
823
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
824
|
+
|
|
825
|
+
### HTTP request headers
|
|
826
|
+
|
|
827
|
+
- **Content-Type**: Not defined
|
|
828
|
+
- **Accept**: application/json
|
|
829
|
+
|
|
830
|
+
|
|
831
|
+
## get_associations
|
|
832
|
+
|
|
833
|
+
> <Array<AssociationMessage>> get_associations(opts)
|
|
834
|
+
|
|
835
|
+
Retrieve all associations
|
|
836
|
+
|
|
837
|
+
Retrieves a list of associations. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Associations and units</span> - `View`
|
|
838
|
+
|
|
839
|
+
### Examples
|
|
840
|
+
|
|
841
|
+
```ruby
|
|
842
|
+
require 'time'
|
|
843
|
+
require 'buildium-ruby'
|
|
844
|
+
# setup authorization
|
|
845
|
+
Buildium.configure do |config|
|
|
846
|
+
# Configure API key authorization: clientId
|
|
847
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
848
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
849
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
850
|
+
|
|
851
|
+
# Configure API key authorization: clientSecret
|
|
852
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
853
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
854
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
855
|
+
end
|
|
856
|
+
|
|
857
|
+
api_instance = Buildium::AssociationsApi.new
|
|
858
|
+
opts = {
|
|
859
|
+
location: 'location_example', # String | Filters results to any association whose city or state *contains* the specified value.
|
|
860
|
+
status: 'Active', # String | Filters results by the status of the association. If no status is specified both `active` and `inactive` associations will be returned.
|
|
861
|
+
lastupdatedfrom: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any associations that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.
|
|
862
|
+
lastupdatedto: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filters results to any associations that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ.
|
|
863
|
+
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.
|
|
864
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
865
|
+
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.
|
|
866
|
+
}
|
|
867
|
+
|
|
868
|
+
begin
|
|
869
|
+
# Retrieve all associations
|
|
870
|
+
result = api_instance.get_associations(opts)
|
|
871
|
+
p result
|
|
872
|
+
rescue Buildium::ApiError => e
|
|
873
|
+
puts "Error when calling AssociationsApi->get_associations: #{e}"
|
|
874
|
+
end
|
|
875
|
+
```
|
|
876
|
+
|
|
877
|
+
#### Using the get_associations_with_http_info variant
|
|
878
|
+
|
|
879
|
+
This returns an Array which contains the response data, status code and headers.
|
|
880
|
+
|
|
881
|
+
> <Array(<Array<AssociationMessage>>, Integer, Hash)> get_associations_with_http_info(opts)
|
|
882
|
+
|
|
883
|
+
```ruby
|
|
884
|
+
begin
|
|
885
|
+
# Retrieve all associations
|
|
886
|
+
data, status_code, headers = api_instance.get_associations_with_http_info(opts)
|
|
887
|
+
p status_code # => 2xx
|
|
888
|
+
p headers # => { ... }
|
|
889
|
+
p data # => <Array<AssociationMessage>>
|
|
890
|
+
rescue Buildium::ApiError => e
|
|
891
|
+
puts "Error when calling AssociationsApi->get_associations_with_http_info: #{e}"
|
|
892
|
+
end
|
|
893
|
+
```
|
|
894
|
+
|
|
895
|
+
### Parameters
|
|
896
|
+
|
|
897
|
+
| Name | Type | Description | Notes |
|
|
898
|
+
| ---- | ---- | ----------- | ----- |
|
|
899
|
+
| **location** | **String** | Filters results to any association whose city or state *contains* the specified value. | [optional] |
|
|
900
|
+
| **status** | **String** | Filters results by the status of the association. If no status is specified both `active` and `inactive` associations will be returned. | [optional] |
|
|
901
|
+
| **lastupdatedfrom** | **Time** | Filters results to any associations that were updated on or after the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ. | [optional] |
|
|
902
|
+
| **lastupdatedto** | **Time** | Filters results to any associations that were updated on or before the specified date. The value must be in UTC and formatted as YYYY-MM-DDTHH:MM:SSZ. | [optional] |
|
|
903
|
+
| **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] |
|
|
904
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
|
905
|
+
| **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] |
|
|
906
|
+
|
|
907
|
+
### Return type
|
|
908
|
+
|
|
909
|
+
[**Array<AssociationMessage>**](AssociationMessage.md)
|
|
910
|
+
|
|
911
|
+
### Authorization
|
|
912
|
+
|
|
913
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
914
|
+
|
|
915
|
+
### HTTP request headers
|
|
916
|
+
|
|
917
|
+
- **Content-Type**: Not defined
|
|
918
|
+
- **Accept**: application/json
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
## update_association
|
|
922
|
+
|
|
923
|
+
> <AssociationMessage> update_association(association_id, association_put_message)
|
|
924
|
+
|
|
925
|
+
Update an association
|
|
926
|
+
|
|
927
|
+
Updates an association. <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\">Associations > Associations and units</span> - `View` `Edit`
|
|
928
|
+
|
|
929
|
+
### Examples
|
|
930
|
+
|
|
931
|
+
```ruby
|
|
932
|
+
require 'time'
|
|
933
|
+
require 'buildium-ruby'
|
|
934
|
+
# setup authorization
|
|
935
|
+
Buildium.configure do |config|
|
|
936
|
+
# Configure API key authorization: clientId
|
|
937
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
938
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
939
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
940
|
+
|
|
941
|
+
# Configure API key authorization: clientSecret
|
|
942
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
943
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
944
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
945
|
+
end
|
|
946
|
+
|
|
947
|
+
api_instance = Buildium::AssociationsApi.new
|
|
948
|
+
association_id = 56 # Integer |
|
|
949
|
+
association_put_message = Buildium::AssociationPutMessage.new({name: 'name_example', operating_bank_account_id: 37, address: Buildium::SaveAddressMessage.new({address_line1: 'address_line1_example', country: 'UnitedStates'}), fiscal_year_end_day: 37, fiscal_year_end_month: 37}) # AssociationPutMessage |
|
|
950
|
+
|
|
951
|
+
begin
|
|
952
|
+
# Update an association
|
|
953
|
+
result = api_instance.update_association(association_id, association_put_message)
|
|
954
|
+
p result
|
|
955
|
+
rescue Buildium::ApiError => e
|
|
956
|
+
puts "Error when calling AssociationsApi->update_association: #{e}"
|
|
957
|
+
end
|
|
958
|
+
```
|
|
959
|
+
|
|
960
|
+
#### Using the update_association_with_http_info variant
|
|
961
|
+
|
|
962
|
+
This returns an Array which contains the response data, status code and headers.
|
|
963
|
+
|
|
964
|
+
> <Array(<AssociationMessage>, Integer, Hash)> update_association_with_http_info(association_id, association_put_message)
|
|
965
|
+
|
|
966
|
+
```ruby
|
|
967
|
+
begin
|
|
968
|
+
# Update an association
|
|
969
|
+
data, status_code, headers = api_instance.update_association_with_http_info(association_id, association_put_message)
|
|
970
|
+
p status_code # => 2xx
|
|
971
|
+
p headers # => { ... }
|
|
972
|
+
p data # => <AssociationMessage>
|
|
973
|
+
rescue Buildium::ApiError => e
|
|
974
|
+
puts "Error when calling AssociationsApi->update_association_with_http_info: #{e}"
|
|
975
|
+
end
|
|
976
|
+
```
|
|
977
|
+
|
|
978
|
+
### Parameters
|
|
979
|
+
|
|
980
|
+
| Name | Type | Description | Notes |
|
|
981
|
+
| ---- | ---- | ----------- | ----- |
|
|
982
|
+
| **association_id** | **Integer** | | |
|
|
983
|
+
| **association_put_message** | [**AssociationPutMessage**](AssociationPutMessage.md) | | |
|
|
984
|
+
|
|
985
|
+
### Return type
|
|
986
|
+
|
|
987
|
+
[**AssociationMessage**](AssociationMessage.md)
|
|
988
|
+
|
|
989
|
+
### Authorization
|
|
990
|
+
|
|
991
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
992
|
+
|
|
993
|
+
### HTTP request headers
|
|
994
|
+
|
|
995
|
+
- **Content-Type**: application/json
|
|
996
|
+
- **Accept**: application/json
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
## update_association_note
|
|
1000
|
+
|
|
1001
|
+
> <NoteMessage> update_association_note(association_id, note_id, note_put_message)
|
|
1002
|
+
|
|
1003
|
+
Update a note
|
|
1004
|
+
|
|
1005
|
+
Updates a note. <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\">Associations > Associations and units</span> - `View` `Edit`
|
|
1006
|
+
|
|
1007
|
+
### Examples
|
|
1008
|
+
|
|
1009
|
+
```ruby
|
|
1010
|
+
require 'time'
|
|
1011
|
+
require 'buildium-ruby'
|
|
1012
|
+
# setup authorization
|
|
1013
|
+
Buildium.configure do |config|
|
|
1014
|
+
# Configure API key authorization: clientId
|
|
1015
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
1016
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1017
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
1018
|
+
|
|
1019
|
+
# Configure API key authorization: clientSecret
|
|
1020
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
1021
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1022
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
1023
|
+
end
|
|
1024
|
+
|
|
1025
|
+
api_instance = Buildium::AssociationsApi.new
|
|
1026
|
+
association_id = 56 # Integer |
|
|
1027
|
+
note_id = 56 # Integer |
|
|
1028
|
+
note_put_message = Buildium::NotePutMessage.new({note: 'note_example'}) # NotePutMessage |
|
|
1029
|
+
|
|
1030
|
+
begin
|
|
1031
|
+
# Update a note
|
|
1032
|
+
result = api_instance.update_association_note(association_id, note_id, note_put_message)
|
|
1033
|
+
p result
|
|
1034
|
+
rescue Buildium::ApiError => e
|
|
1035
|
+
puts "Error when calling AssociationsApi->update_association_note: #{e}"
|
|
1036
|
+
end
|
|
1037
|
+
```
|
|
1038
|
+
|
|
1039
|
+
#### Using the update_association_note_with_http_info variant
|
|
1040
|
+
|
|
1041
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1042
|
+
|
|
1043
|
+
> <Array(<NoteMessage>, Integer, Hash)> update_association_note_with_http_info(association_id, note_id, note_put_message)
|
|
1044
|
+
|
|
1045
|
+
```ruby
|
|
1046
|
+
begin
|
|
1047
|
+
# Update a note
|
|
1048
|
+
data, status_code, headers = api_instance.update_association_note_with_http_info(association_id, note_id, note_put_message)
|
|
1049
|
+
p status_code # => 2xx
|
|
1050
|
+
p headers # => { ... }
|
|
1051
|
+
p data # => <NoteMessage>
|
|
1052
|
+
rescue Buildium::ApiError => e
|
|
1053
|
+
puts "Error when calling AssociationsApi->update_association_note_with_http_info: #{e}"
|
|
1054
|
+
end
|
|
1055
|
+
```
|
|
1056
|
+
|
|
1057
|
+
### Parameters
|
|
1058
|
+
|
|
1059
|
+
| Name | Type | Description | Notes |
|
|
1060
|
+
| ---- | ---- | ----------- | ----- |
|
|
1061
|
+
| **association_id** | **Integer** | | |
|
|
1062
|
+
| **note_id** | **Integer** | | |
|
|
1063
|
+
| **note_put_message** | [**NotePutMessage**](NotePutMessage.md) | | |
|
|
1064
|
+
|
|
1065
|
+
### Return type
|
|
1066
|
+
|
|
1067
|
+
[**NoteMessage**](NoteMessage.md)
|
|
1068
|
+
|
|
1069
|
+
### Authorization
|
|
1070
|
+
|
|
1071
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
1072
|
+
|
|
1073
|
+
### HTTP request headers
|
|
1074
|
+
|
|
1075
|
+
- **Content-Type**: application/json
|
|
1076
|
+
- **Accept**: application/json
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
## update_association_preferred_vendors
|
|
1080
|
+
|
|
1081
|
+
> <Array<AssociationPreferredVendorMessage>> update_association_preferred_vendors(association_id, association_preferred_vendor_put_message)
|
|
1082
|
+
|
|
1083
|
+
Update preferred vendors
|
|
1084
|
+
|
|
1085
|
+
Updates preferred vendors. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Associations and units</span> - `View` `Edit` <br /><span class=\"permissionBlock\">Maintenance > Vendors</span> - `View` `Edit`
|
|
1086
|
+
|
|
1087
|
+
### Examples
|
|
1088
|
+
|
|
1089
|
+
```ruby
|
|
1090
|
+
require 'time'
|
|
1091
|
+
require 'buildium-ruby'
|
|
1092
|
+
# setup authorization
|
|
1093
|
+
Buildium.configure do |config|
|
|
1094
|
+
# Configure API key authorization: clientId
|
|
1095
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
1096
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1097
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
1098
|
+
|
|
1099
|
+
# Configure API key authorization: clientSecret
|
|
1100
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
1101
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1102
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
1103
|
+
end
|
|
1104
|
+
|
|
1105
|
+
api_instance = Buildium::AssociationsApi.new
|
|
1106
|
+
association_id = 56 # Integer |
|
|
1107
|
+
association_preferred_vendor_put_message = Buildium::AssociationPreferredVendorPutMessage.new({vendor_ids: [37]}) # AssociationPreferredVendorPutMessage |
|
|
1108
|
+
|
|
1109
|
+
begin
|
|
1110
|
+
# Update preferred vendors
|
|
1111
|
+
result = api_instance.update_association_preferred_vendors(association_id, association_preferred_vendor_put_message)
|
|
1112
|
+
p result
|
|
1113
|
+
rescue Buildium::ApiError => e
|
|
1114
|
+
puts "Error when calling AssociationsApi->update_association_preferred_vendors: #{e}"
|
|
1115
|
+
end
|
|
1116
|
+
```
|
|
1117
|
+
|
|
1118
|
+
#### Using the update_association_preferred_vendors_with_http_info variant
|
|
1119
|
+
|
|
1120
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1121
|
+
|
|
1122
|
+
> <Array(<Array<AssociationPreferredVendorMessage>>, Integer, Hash)> update_association_preferred_vendors_with_http_info(association_id, association_preferred_vendor_put_message)
|
|
1123
|
+
|
|
1124
|
+
```ruby
|
|
1125
|
+
begin
|
|
1126
|
+
# Update preferred vendors
|
|
1127
|
+
data, status_code, headers = api_instance.update_association_preferred_vendors_with_http_info(association_id, association_preferred_vendor_put_message)
|
|
1128
|
+
p status_code # => 2xx
|
|
1129
|
+
p headers # => { ... }
|
|
1130
|
+
p data # => <Array<AssociationPreferredVendorMessage>>
|
|
1131
|
+
rescue Buildium::ApiError => e
|
|
1132
|
+
puts "Error when calling AssociationsApi->update_association_preferred_vendors_with_http_info: #{e}"
|
|
1133
|
+
end
|
|
1134
|
+
```
|
|
1135
|
+
|
|
1136
|
+
### Parameters
|
|
1137
|
+
|
|
1138
|
+
| Name | Type | Description | Notes |
|
|
1139
|
+
| ---- | ---- | ----------- | ----- |
|
|
1140
|
+
| **association_id** | **Integer** | | |
|
|
1141
|
+
| **association_preferred_vendor_put_message** | [**AssociationPreferredVendorPutMessage**](AssociationPreferredVendorPutMessage.md) | | |
|
|
1142
|
+
|
|
1143
|
+
### Return type
|
|
1144
|
+
|
|
1145
|
+
[**Array<AssociationPreferredVendorMessage>**](AssociationPreferredVendorMessage.md)
|
|
1146
|
+
|
|
1147
|
+
### Authorization
|
|
1148
|
+
|
|
1149
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
1150
|
+
|
|
1151
|
+
### HTTP request headers
|
|
1152
|
+
|
|
1153
|
+
- **Content-Type**: application/json
|
|
1154
|
+
- **Accept**: application/json
|
|
1155
|
+
|
|
1156
|
+
|
|
1157
|
+
## update_board_member
|
|
1158
|
+
|
|
1159
|
+
> <AssociationBoardMemberMessage> update_board_member(association_id, board_member_id, association_board_member_put_message)
|
|
1160
|
+
|
|
1161
|
+
Update a board member
|
|
1162
|
+
|
|
1163
|
+
Updates a board member for a given association. <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\">Associations > Association owners and tenants</span> - `View` `Edit`
|
|
1164
|
+
|
|
1165
|
+
### Examples
|
|
1166
|
+
|
|
1167
|
+
```ruby
|
|
1168
|
+
require 'time'
|
|
1169
|
+
require 'buildium-ruby'
|
|
1170
|
+
# setup authorization
|
|
1171
|
+
Buildium.configure do |config|
|
|
1172
|
+
# Configure API key authorization: clientId
|
|
1173
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
1174
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1175
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
1176
|
+
|
|
1177
|
+
# Configure API key authorization: clientSecret
|
|
1178
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
1179
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1180
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
1181
|
+
end
|
|
1182
|
+
|
|
1183
|
+
api_instance = Buildium::AssociationsApi.new
|
|
1184
|
+
association_id = 56 # Integer |
|
|
1185
|
+
board_member_id = 56 # Integer |
|
|
1186
|
+
association_board_member_put_message = Buildium::AssociationBoardMemberPutMessage.new({board_position_type: 'President'}) # AssociationBoardMemberPutMessage |
|
|
1187
|
+
|
|
1188
|
+
begin
|
|
1189
|
+
# Update a board member
|
|
1190
|
+
result = api_instance.update_board_member(association_id, board_member_id, association_board_member_put_message)
|
|
1191
|
+
p result
|
|
1192
|
+
rescue Buildium::ApiError => e
|
|
1193
|
+
puts "Error when calling AssociationsApi->update_board_member: #{e}"
|
|
1194
|
+
end
|
|
1195
|
+
```
|
|
1196
|
+
|
|
1197
|
+
#### Using the update_board_member_with_http_info variant
|
|
1198
|
+
|
|
1199
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1200
|
+
|
|
1201
|
+
> <Array(<AssociationBoardMemberMessage>, Integer, Hash)> update_board_member_with_http_info(association_id, board_member_id, association_board_member_put_message)
|
|
1202
|
+
|
|
1203
|
+
```ruby
|
|
1204
|
+
begin
|
|
1205
|
+
# Update a board member
|
|
1206
|
+
data, status_code, headers = api_instance.update_board_member_with_http_info(association_id, board_member_id, association_board_member_put_message)
|
|
1207
|
+
p status_code # => 2xx
|
|
1208
|
+
p headers # => { ... }
|
|
1209
|
+
p data # => <AssociationBoardMemberMessage>
|
|
1210
|
+
rescue Buildium::ApiError => e
|
|
1211
|
+
puts "Error when calling AssociationsApi->update_board_member_with_http_info: #{e}"
|
|
1212
|
+
end
|
|
1213
|
+
```
|
|
1214
|
+
|
|
1215
|
+
### Parameters
|
|
1216
|
+
|
|
1217
|
+
| Name | Type | Description | Notes |
|
|
1218
|
+
| ---- | ---- | ----------- | ----- |
|
|
1219
|
+
| **association_id** | **Integer** | | |
|
|
1220
|
+
| **board_member_id** | **Integer** | | |
|
|
1221
|
+
| **association_board_member_put_message** | [**AssociationBoardMemberPutMessage**](AssociationBoardMemberPutMessage.md) | | |
|
|
1222
|
+
|
|
1223
|
+
### Return type
|
|
1224
|
+
|
|
1225
|
+
[**AssociationBoardMemberMessage**](AssociationBoardMemberMessage.md)
|
|
1226
|
+
|
|
1227
|
+
### Authorization
|
|
1228
|
+
|
|
1229
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
1230
|
+
|
|
1231
|
+
### HTTP request headers
|
|
1232
|
+
|
|
1233
|
+
- **Content-Type**: application/json
|
|
1234
|
+
- **Accept**: application/json
|
|
1235
|
+
|