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,2042 @@
|
|
|
1
|
+
# Buildium::AssociationOwnershipAccountsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.buildium.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_association_ownership_account**](AssociationOwnershipAccountsApi.md#create_association_ownership_account) | **POST** /v1/associations/ownershipaccounts | Create an ownership account |
|
|
8
|
+
| [**create_association_ownership_account_note**](AssociationOwnershipAccountsApi.md#create_association_ownership_account_note) | **POST** /v1/associations/ownershipaccounts/{ownershipAccountId}/notes | Create a note |
|
|
9
|
+
| [**create_ownership_account_credit**](AssociationOwnershipAccountsApi.md#create_ownership_account_credit) | **POST** /v1/associations/ownershipaccounts/{ownershipAccountId}/credits | Create a ledger credit |
|
|
10
|
+
| [**create_ownership_account_credit_recurring_transaction**](AssociationOwnershipAccountsApi.md#create_ownership_account_credit_recurring_transaction) | **POST** /v1/associations/ownershipaccounts/{ownershipAccountId}/recurringcredits | Create a recurring credit |
|
|
11
|
+
| [**create_ownership_account_deposit_withholding**](AssociationOwnershipAccountsApi.md#create_ownership_account_deposit_withholding) | **POST** /v1/associations/ownershipaccounts/{ownershipAccountId}/applieddeposits | Create a deposit withholding |
|
|
12
|
+
| [**create_ownership_account_ledger_charge**](AssociationOwnershipAccountsApi.md#create_ownership_account_ledger_charge) | **POST** /v1/associations/ownershipaccounts/{ownershipAccountId}/charges | Create a ledger charge |
|
|
13
|
+
| [**create_ownership_account_ledger_payment**](AssociationOwnershipAccountsApi.md#create_ownership_account_ledger_payment) | **POST** /v1/associations/ownershipaccounts/{ownershipAccountId}/payments | Create a ledger payment |
|
|
14
|
+
| [**create_ownership_account_recurring_payment**](AssociationOwnershipAccountsApi.md#create_ownership_account_recurring_payment) | **POST** /v1/associations/ownershipaccounts/{ownershipAccountId}/recurringpayments | Create a recurring payment |
|
|
15
|
+
| [**create_ownership_account_refund**](AssociationOwnershipAccountsApi.md#create_ownership_account_refund) | **POST** /v1/associations/ownershipaccounts/{ownershipAccountId}/refunds | Create a refund |
|
|
16
|
+
| [**create_ownership_accounts_charge_recurring_transaction**](AssociationOwnershipAccountsApi.md#create_ownership_accounts_charge_recurring_transaction) | **POST** /v1/associations/ownershipaccounts/{ownershipAccountId}/recurringcharges | Create a recurring charge |
|
|
17
|
+
| [**get_all_ownership_accounts**](AssociationOwnershipAccountsApi.md#get_all_ownership_accounts) | **GET** /v1/associations/ownershipaccounts | Retrieve all ownership accounts |
|
|
18
|
+
| [**get_association_ownership_account_note_by_note_id**](AssociationOwnershipAccountsApi.md#get_association_ownership_account_note_by_note_id) | **GET** /v1/associations/ownershipaccounts/{ownershipAccountId}/notes/{noteId} | Retrieve a note |
|
|
19
|
+
| [**get_association_ownership_account_notes**](AssociationOwnershipAccountsApi.md#get_association_ownership_account_notes) | **GET** /v1/associations/ownershipaccounts/{ownershipAccountId}/notes | Retrieve all notes |
|
|
20
|
+
| [**get_association_recurring_transaction**](AssociationOwnershipAccountsApi.md#get_association_recurring_transaction) | **GET** /v1/associations/ownershipaccounts/{ownershipAccountId}/recurringtransactions | Retrieve all recurring transactions |
|
|
21
|
+
| [**get_ownership_account_by_id**](AssociationOwnershipAccountsApi.md#get_ownership_account_by_id) | **GET** /v1/associations/ownershipaccounts/{ownershipAccountId} | Retrieve an ownership account |
|
|
22
|
+
| [**get_ownership_account_ledger**](AssociationOwnershipAccountsApi.md#get_ownership_account_ledger) | **GET** /v1/associations/ownershipaccounts/{ownershipAccountId}/transactions | Retrieve ownership account transactions |
|
|
23
|
+
| [**get_ownership_account_outstanding_balances**](AssociationOwnershipAccountsApi.md#get_ownership_account_outstanding_balances) | **GET** /v1/associations/ownershipaccounts/outstandingbalances | Retrieve all outstanding balances |
|
|
24
|
+
| [**get_ownership_account_recurring_credit_by_id**](AssociationOwnershipAccountsApi.md#get_ownership_account_recurring_credit_by_id) | **GET** /v1/associations/ownershipaccounts/{ownershipAccountId}/recurringcredits/{transactionId} | Retrieve a recurring credit |
|
|
25
|
+
| [**get_ownership_account_refund_by_id**](AssociationOwnershipAccountsApi.md#get_ownership_account_refund_by_id) | **GET** /v1/associations/ownershipaccounts/{ownershipAccountId}/refunds/{refundId} | Retrieve a refund |
|
|
26
|
+
| [**get_ownership_account_transaction_by_id**](AssociationOwnershipAccountsApi.md#get_ownership_account_transaction_by_id) | **GET** /v1/associations/ownershipaccounts/{ownershipAccountId}/transactions/{transactionId} | Retrieve an ownership account transaction |
|
|
27
|
+
| [**get_ownership_accounts_charge_recurring_transaction_by_id**](AssociationOwnershipAccountsApi.md#get_ownership_accounts_charge_recurring_transaction_by_id) | **GET** /v1/associations/ownershipaccounts/{ownershipAccountId}/recurringcharges/{transactionId} | Retrieve a recurring charge |
|
|
28
|
+
| [**get_recurring_ownership_account_payments_by_id**](AssociationOwnershipAccountsApi.md#get_recurring_ownership_account_payments_by_id) | **GET** /v1/associations/ownershipaccounts/{ownershipAccountId}/recurringpayments/{paymentId} | Retrieve a recurring payment |
|
|
29
|
+
| [**update_association_ownership_account**](AssociationOwnershipAccountsApi.md#update_association_ownership_account) | **PUT** /v1/associations/ownershipaccounts/{ownershipAccountId} | Update an ownership account |
|
|
30
|
+
| [**update_association_ownership_account_note**](AssociationOwnershipAccountsApi.md#update_association_ownership_account_note) | **PUT** /v1/associations/ownershipaccounts/{ownershipAccountId}/notes/{noteId} | Update a note |
|
|
31
|
+
| [**update_ownership_account_charge**](AssociationOwnershipAccountsApi.md#update_ownership_account_charge) | **PUT** /v1/associations/ownershipaccounts/{ownershipAccountId}/charges/{chargeId} | Update a charge |
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
## create_association_ownership_account
|
|
35
|
+
|
|
36
|
+
> <AssociationOwnershipAccountMessage> create_association_ownership_account(association_ownership_account_post_message)
|
|
37
|
+
|
|
38
|
+
Create an ownership account
|
|
39
|
+
|
|
40
|
+
Creates an ownership account. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership accounts</span> - `View` `Edit` <br /><span class=\"permissionBlock\">Associations > Owners</span> - `View` `Edit`
|
|
41
|
+
|
|
42
|
+
### Examples
|
|
43
|
+
|
|
44
|
+
```ruby
|
|
45
|
+
require 'time'
|
|
46
|
+
require 'buildium-ruby'
|
|
47
|
+
# setup authorization
|
|
48
|
+
Buildium.configure do |config|
|
|
49
|
+
# Configure API key authorization: clientId
|
|
50
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
51
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
52
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
53
|
+
|
|
54
|
+
# Configure API key authorization: clientSecret
|
|
55
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
56
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
57
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
61
|
+
association_ownership_account_post_message = Buildium::AssociationOwnershipAccountPostMessage.new({unit_id: 37, date_of_purchase: Date.today, send_welcome_email: false, replace_existing_ownership_account: false}) # AssociationOwnershipAccountPostMessage |
|
|
62
|
+
|
|
63
|
+
begin
|
|
64
|
+
# Create an ownership account
|
|
65
|
+
result = api_instance.create_association_ownership_account(association_ownership_account_post_message)
|
|
66
|
+
p result
|
|
67
|
+
rescue Buildium::ApiError => e
|
|
68
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_association_ownership_account: #{e}"
|
|
69
|
+
end
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
#### Using the create_association_ownership_account_with_http_info variant
|
|
73
|
+
|
|
74
|
+
This returns an Array which contains the response data, status code and headers.
|
|
75
|
+
|
|
76
|
+
> <Array(<AssociationOwnershipAccountMessage>, Integer, Hash)> create_association_ownership_account_with_http_info(association_ownership_account_post_message)
|
|
77
|
+
|
|
78
|
+
```ruby
|
|
79
|
+
begin
|
|
80
|
+
# Create an ownership account
|
|
81
|
+
data, status_code, headers = api_instance.create_association_ownership_account_with_http_info(association_ownership_account_post_message)
|
|
82
|
+
p status_code # => 2xx
|
|
83
|
+
p headers # => { ... }
|
|
84
|
+
p data # => <AssociationOwnershipAccountMessage>
|
|
85
|
+
rescue Buildium::ApiError => e
|
|
86
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_association_ownership_account_with_http_info: #{e}"
|
|
87
|
+
end
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### Parameters
|
|
91
|
+
|
|
92
|
+
| Name | Type | Description | Notes |
|
|
93
|
+
| ---- | ---- | ----------- | ----- |
|
|
94
|
+
| **association_ownership_account_post_message** | [**AssociationOwnershipAccountPostMessage**](AssociationOwnershipAccountPostMessage.md) | | |
|
|
95
|
+
|
|
96
|
+
### Return type
|
|
97
|
+
|
|
98
|
+
[**AssociationOwnershipAccountMessage**](AssociationOwnershipAccountMessage.md)
|
|
99
|
+
|
|
100
|
+
### Authorization
|
|
101
|
+
|
|
102
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
103
|
+
|
|
104
|
+
### HTTP request headers
|
|
105
|
+
|
|
106
|
+
- **Content-Type**: application/json
|
|
107
|
+
- **Accept**: application/json
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
## create_association_ownership_account_note
|
|
111
|
+
|
|
112
|
+
> <NoteMessage> create_association_ownership_account_note(ownership_account_id, note_post_message)
|
|
113
|
+
|
|
114
|
+
Create a note
|
|
115
|
+
|
|
116
|
+
Creates a new ownership account note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership accounts</span> - `View` `Edit`
|
|
117
|
+
|
|
118
|
+
### Examples
|
|
119
|
+
|
|
120
|
+
```ruby
|
|
121
|
+
require 'time'
|
|
122
|
+
require 'buildium-ruby'
|
|
123
|
+
# setup authorization
|
|
124
|
+
Buildium.configure do |config|
|
|
125
|
+
# Configure API key authorization: clientId
|
|
126
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
127
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
128
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
129
|
+
|
|
130
|
+
# Configure API key authorization: clientSecret
|
|
131
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
132
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
133
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
137
|
+
ownership_account_id = 56 # Integer |
|
|
138
|
+
note_post_message = Buildium::NotePostMessage.new({note: 'note_example'}) # NotePostMessage |
|
|
139
|
+
|
|
140
|
+
begin
|
|
141
|
+
# Create a note
|
|
142
|
+
result = api_instance.create_association_ownership_account_note(ownership_account_id, note_post_message)
|
|
143
|
+
p result
|
|
144
|
+
rescue Buildium::ApiError => e
|
|
145
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_association_ownership_account_note: #{e}"
|
|
146
|
+
end
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
#### Using the create_association_ownership_account_note_with_http_info variant
|
|
150
|
+
|
|
151
|
+
This returns an Array which contains the response data, status code and headers.
|
|
152
|
+
|
|
153
|
+
> <Array(<NoteMessage>, Integer, Hash)> create_association_ownership_account_note_with_http_info(ownership_account_id, note_post_message)
|
|
154
|
+
|
|
155
|
+
```ruby
|
|
156
|
+
begin
|
|
157
|
+
# Create a note
|
|
158
|
+
data, status_code, headers = api_instance.create_association_ownership_account_note_with_http_info(ownership_account_id, note_post_message)
|
|
159
|
+
p status_code # => 2xx
|
|
160
|
+
p headers # => { ... }
|
|
161
|
+
p data # => <NoteMessage>
|
|
162
|
+
rescue Buildium::ApiError => e
|
|
163
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_association_ownership_account_note_with_http_info: #{e}"
|
|
164
|
+
end
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
### Parameters
|
|
168
|
+
|
|
169
|
+
| Name | Type | Description | Notes |
|
|
170
|
+
| ---- | ---- | ----------- | ----- |
|
|
171
|
+
| **ownership_account_id** | **Integer** | | |
|
|
172
|
+
| **note_post_message** | [**NotePostMessage**](NotePostMessage.md) | | |
|
|
173
|
+
|
|
174
|
+
### Return type
|
|
175
|
+
|
|
176
|
+
[**NoteMessage**](NoteMessage.md)
|
|
177
|
+
|
|
178
|
+
### Authorization
|
|
179
|
+
|
|
180
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
181
|
+
|
|
182
|
+
### HTTP request headers
|
|
183
|
+
|
|
184
|
+
- **Content-Type**: application/json
|
|
185
|
+
- **Accept**: application/json
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
## create_ownership_account_credit
|
|
189
|
+
|
|
190
|
+
> <OwnershipAccountTransactionMessage> create_ownership_account_credit(ownership_account_id, ownership_account_credit_post_message)
|
|
191
|
+
|
|
192
|
+
Create a ledger credit
|
|
193
|
+
|
|
194
|
+
Creates a ledger credit. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit`
|
|
195
|
+
|
|
196
|
+
### Examples
|
|
197
|
+
|
|
198
|
+
```ruby
|
|
199
|
+
require 'time'
|
|
200
|
+
require 'buildium-ruby'
|
|
201
|
+
# setup authorization
|
|
202
|
+
Buildium.configure do |config|
|
|
203
|
+
# Configure API key authorization: clientId
|
|
204
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
205
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
206
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
207
|
+
|
|
208
|
+
# Configure API key authorization: clientSecret
|
|
209
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
210
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
211
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
212
|
+
end
|
|
213
|
+
|
|
214
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
215
|
+
ownership_account_id = 56 # Integer |
|
|
216
|
+
ownership_account_credit_post_message = Buildium::OwnershipAccountCreditPostMessage.new({date: Date.today, credit_type: 'WaiveUnpaid', lines: [Buildium::OwnershipAccountCreditLinePostMessage.new({amount: 3.56, gl_account_id: 37})]}) # OwnershipAccountCreditPostMessage |
|
|
217
|
+
|
|
218
|
+
begin
|
|
219
|
+
# Create a ledger credit
|
|
220
|
+
result = api_instance.create_ownership_account_credit(ownership_account_id, ownership_account_credit_post_message)
|
|
221
|
+
p result
|
|
222
|
+
rescue Buildium::ApiError => e
|
|
223
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_ownership_account_credit: #{e}"
|
|
224
|
+
end
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
#### Using the create_ownership_account_credit_with_http_info variant
|
|
228
|
+
|
|
229
|
+
This returns an Array which contains the response data, status code and headers.
|
|
230
|
+
|
|
231
|
+
> <Array(<OwnershipAccountTransactionMessage>, Integer, Hash)> create_ownership_account_credit_with_http_info(ownership_account_id, ownership_account_credit_post_message)
|
|
232
|
+
|
|
233
|
+
```ruby
|
|
234
|
+
begin
|
|
235
|
+
# Create a ledger credit
|
|
236
|
+
data, status_code, headers = api_instance.create_ownership_account_credit_with_http_info(ownership_account_id, ownership_account_credit_post_message)
|
|
237
|
+
p status_code # => 2xx
|
|
238
|
+
p headers # => { ... }
|
|
239
|
+
p data # => <OwnershipAccountTransactionMessage>
|
|
240
|
+
rescue Buildium::ApiError => e
|
|
241
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_ownership_account_credit_with_http_info: #{e}"
|
|
242
|
+
end
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
### Parameters
|
|
246
|
+
|
|
247
|
+
| Name | Type | Description | Notes |
|
|
248
|
+
| ---- | ---- | ----------- | ----- |
|
|
249
|
+
| **ownership_account_id** | **Integer** | | |
|
|
250
|
+
| **ownership_account_credit_post_message** | [**OwnershipAccountCreditPostMessage**](OwnershipAccountCreditPostMessage.md) | | |
|
|
251
|
+
|
|
252
|
+
### Return type
|
|
253
|
+
|
|
254
|
+
[**OwnershipAccountTransactionMessage**](OwnershipAccountTransactionMessage.md)
|
|
255
|
+
|
|
256
|
+
### Authorization
|
|
257
|
+
|
|
258
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
259
|
+
|
|
260
|
+
### HTTP request headers
|
|
261
|
+
|
|
262
|
+
- **Content-Type**: application/json
|
|
263
|
+
- **Accept**: application/json
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
## create_ownership_account_credit_recurring_transaction
|
|
267
|
+
|
|
268
|
+
> <OwnershipAccountRecurringCreditMessage> create_ownership_account_credit_recurring_transaction(ownership_account_id, credit_recurring_transaction_post_message)
|
|
269
|
+
|
|
270
|
+
Create a recurring credit
|
|
271
|
+
|
|
272
|
+
Creates a recurring credit transaction that will post automatically on the specified ownership account ledger. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit`
|
|
273
|
+
|
|
274
|
+
### Examples
|
|
275
|
+
|
|
276
|
+
```ruby
|
|
277
|
+
require 'time'
|
|
278
|
+
require 'buildium-ruby'
|
|
279
|
+
# setup authorization
|
|
280
|
+
Buildium.configure do |config|
|
|
281
|
+
# Configure API key authorization: clientId
|
|
282
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
283
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
284
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
285
|
+
|
|
286
|
+
# Configure API key authorization: clientSecret
|
|
287
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
288
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
289
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
290
|
+
end
|
|
291
|
+
|
|
292
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
293
|
+
ownership_account_id = 56 # Integer |
|
|
294
|
+
credit_recurring_transaction_post_message = Buildium::CreditRecurringTransactionPostMessage.new({credit_type: 'WaiveUnpaid', post_days_in_advance: 37, frequency: 'Monthly', first_occurrence_date: Date.today}) # CreditRecurringTransactionPostMessage |
|
|
295
|
+
|
|
296
|
+
begin
|
|
297
|
+
# Create a recurring credit
|
|
298
|
+
result = api_instance.create_ownership_account_credit_recurring_transaction(ownership_account_id, credit_recurring_transaction_post_message)
|
|
299
|
+
p result
|
|
300
|
+
rescue Buildium::ApiError => e
|
|
301
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_ownership_account_credit_recurring_transaction: #{e}"
|
|
302
|
+
end
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
#### Using the create_ownership_account_credit_recurring_transaction_with_http_info variant
|
|
306
|
+
|
|
307
|
+
This returns an Array which contains the response data, status code and headers.
|
|
308
|
+
|
|
309
|
+
> <Array(<OwnershipAccountRecurringCreditMessage>, Integer, Hash)> create_ownership_account_credit_recurring_transaction_with_http_info(ownership_account_id, credit_recurring_transaction_post_message)
|
|
310
|
+
|
|
311
|
+
```ruby
|
|
312
|
+
begin
|
|
313
|
+
# Create a recurring credit
|
|
314
|
+
data, status_code, headers = api_instance.create_ownership_account_credit_recurring_transaction_with_http_info(ownership_account_id, credit_recurring_transaction_post_message)
|
|
315
|
+
p status_code # => 2xx
|
|
316
|
+
p headers # => { ... }
|
|
317
|
+
p data # => <OwnershipAccountRecurringCreditMessage>
|
|
318
|
+
rescue Buildium::ApiError => e
|
|
319
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_ownership_account_credit_recurring_transaction_with_http_info: #{e}"
|
|
320
|
+
end
|
|
321
|
+
```
|
|
322
|
+
|
|
323
|
+
### Parameters
|
|
324
|
+
|
|
325
|
+
| Name | Type | Description | Notes |
|
|
326
|
+
| ---- | ---- | ----------- | ----- |
|
|
327
|
+
| **ownership_account_id** | **Integer** | | |
|
|
328
|
+
| **credit_recurring_transaction_post_message** | [**CreditRecurringTransactionPostMessage**](CreditRecurringTransactionPostMessage.md) | | |
|
|
329
|
+
|
|
330
|
+
### Return type
|
|
331
|
+
|
|
332
|
+
[**OwnershipAccountRecurringCreditMessage**](OwnershipAccountRecurringCreditMessage.md)
|
|
333
|
+
|
|
334
|
+
### Authorization
|
|
335
|
+
|
|
336
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
337
|
+
|
|
338
|
+
### HTTP request headers
|
|
339
|
+
|
|
340
|
+
- **Content-Type**: application/json
|
|
341
|
+
- **Accept**: application/json
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
## create_ownership_account_deposit_withholding
|
|
345
|
+
|
|
346
|
+
> <OwnershipAccountTransactionMessage> create_ownership_account_deposit_withholding(ownership_account_id, ownership_account_deposit_withholding_post_message)
|
|
347
|
+
|
|
348
|
+
Create a deposit withholding
|
|
349
|
+
|
|
350
|
+
Withholds an association owner deposit by reallocating the funds from a liability account to an income account to cover an expense(s). <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit` <span class=\"permissionBlock\">Accounting > General Ledger Accounts</span> - `View`
|
|
351
|
+
|
|
352
|
+
### Examples
|
|
353
|
+
|
|
354
|
+
```ruby
|
|
355
|
+
require 'time'
|
|
356
|
+
require 'buildium-ruby'
|
|
357
|
+
# setup authorization
|
|
358
|
+
Buildium.configure do |config|
|
|
359
|
+
# Configure API key authorization: clientId
|
|
360
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
361
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
362
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
363
|
+
|
|
364
|
+
# Configure API key authorization: clientSecret
|
|
365
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
366
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
367
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
368
|
+
end
|
|
369
|
+
|
|
370
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
371
|
+
ownership_account_id = 56 # Integer |
|
|
372
|
+
ownership_account_deposit_withholding_post_message = Buildium::OwnershipAccountDepositWithholdingPostMessage.new({entry_date: Date.today, deposit_liability_gl_account_id: 37}) # OwnershipAccountDepositWithholdingPostMessage |
|
|
373
|
+
|
|
374
|
+
begin
|
|
375
|
+
# Create a deposit withholding
|
|
376
|
+
result = api_instance.create_ownership_account_deposit_withholding(ownership_account_id, ownership_account_deposit_withholding_post_message)
|
|
377
|
+
p result
|
|
378
|
+
rescue Buildium::ApiError => e
|
|
379
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_ownership_account_deposit_withholding: #{e}"
|
|
380
|
+
end
|
|
381
|
+
```
|
|
382
|
+
|
|
383
|
+
#### Using the create_ownership_account_deposit_withholding_with_http_info variant
|
|
384
|
+
|
|
385
|
+
This returns an Array which contains the response data, status code and headers.
|
|
386
|
+
|
|
387
|
+
> <Array(<OwnershipAccountTransactionMessage>, Integer, Hash)> create_ownership_account_deposit_withholding_with_http_info(ownership_account_id, ownership_account_deposit_withholding_post_message)
|
|
388
|
+
|
|
389
|
+
```ruby
|
|
390
|
+
begin
|
|
391
|
+
# Create a deposit withholding
|
|
392
|
+
data, status_code, headers = api_instance.create_ownership_account_deposit_withholding_with_http_info(ownership_account_id, ownership_account_deposit_withholding_post_message)
|
|
393
|
+
p status_code # => 2xx
|
|
394
|
+
p headers # => { ... }
|
|
395
|
+
p data # => <OwnershipAccountTransactionMessage>
|
|
396
|
+
rescue Buildium::ApiError => e
|
|
397
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_ownership_account_deposit_withholding_with_http_info: #{e}"
|
|
398
|
+
end
|
|
399
|
+
```
|
|
400
|
+
|
|
401
|
+
### Parameters
|
|
402
|
+
|
|
403
|
+
| Name | Type | Description | Notes |
|
|
404
|
+
| ---- | ---- | ----------- | ----- |
|
|
405
|
+
| **ownership_account_id** | **Integer** | | |
|
|
406
|
+
| **ownership_account_deposit_withholding_post_message** | [**OwnershipAccountDepositWithholdingPostMessage**](OwnershipAccountDepositWithholdingPostMessage.md) | | |
|
|
407
|
+
|
|
408
|
+
### Return type
|
|
409
|
+
|
|
410
|
+
[**OwnershipAccountTransactionMessage**](OwnershipAccountTransactionMessage.md)
|
|
411
|
+
|
|
412
|
+
### Authorization
|
|
413
|
+
|
|
414
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
415
|
+
|
|
416
|
+
### HTTP request headers
|
|
417
|
+
|
|
418
|
+
- **Content-Type**: application/json
|
|
419
|
+
- **Accept**: application/json
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
## create_ownership_account_ledger_charge
|
|
423
|
+
|
|
424
|
+
> <OwnershipAccountTransactionMessage> create_ownership_account_ledger_charge(ownership_account_id, ownership_account_ledger_charge_post_message)
|
|
425
|
+
|
|
426
|
+
Create a ledger charge
|
|
427
|
+
|
|
428
|
+
Creates a ledger charge. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit` <br />
|
|
429
|
+
|
|
430
|
+
### Examples
|
|
431
|
+
|
|
432
|
+
```ruby
|
|
433
|
+
require 'time'
|
|
434
|
+
require 'buildium-ruby'
|
|
435
|
+
# setup authorization
|
|
436
|
+
Buildium.configure do |config|
|
|
437
|
+
# Configure API key authorization: clientId
|
|
438
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
439
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
440
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
441
|
+
|
|
442
|
+
# Configure API key authorization: clientSecret
|
|
443
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
444
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
445
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
446
|
+
end
|
|
447
|
+
|
|
448
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
449
|
+
ownership_account_id = 56 # Integer | The ownership account identifier.
|
|
450
|
+
ownership_account_ledger_charge_post_message = Buildium::OwnershipAccountLedgerChargePostMessage.new({date: Date.today, lines: [Buildium::OwnershipAccountLedgerChargeLinesSaveMessage.new({amount: 3.56, gl_account_id: 37})]}) # OwnershipAccountLedgerChargePostMessage |
|
|
451
|
+
|
|
452
|
+
begin
|
|
453
|
+
# Create a ledger charge
|
|
454
|
+
result = api_instance.create_ownership_account_ledger_charge(ownership_account_id, ownership_account_ledger_charge_post_message)
|
|
455
|
+
p result
|
|
456
|
+
rescue Buildium::ApiError => e
|
|
457
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_ownership_account_ledger_charge: #{e}"
|
|
458
|
+
end
|
|
459
|
+
```
|
|
460
|
+
|
|
461
|
+
#### Using the create_ownership_account_ledger_charge_with_http_info variant
|
|
462
|
+
|
|
463
|
+
This returns an Array which contains the response data, status code and headers.
|
|
464
|
+
|
|
465
|
+
> <Array(<OwnershipAccountTransactionMessage>, Integer, Hash)> create_ownership_account_ledger_charge_with_http_info(ownership_account_id, ownership_account_ledger_charge_post_message)
|
|
466
|
+
|
|
467
|
+
```ruby
|
|
468
|
+
begin
|
|
469
|
+
# Create a ledger charge
|
|
470
|
+
data, status_code, headers = api_instance.create_ownership_account_ledger_charge_with_http_info(ownership_account_id, ownership_account_ledger_charge_post_message)
|
|
471
|
+
p status_code # => 2xx
|
|
472
|
+
p headers # => { ... }
|
|
473
|
+
p data # => <OwnershipAccountTransactionMessage>
|
|
474
|
+
rescue Buildium::ApiError => e
|
|
475
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_ownership_account_ledger_charge_with_http_info: #{e}"
|
|
476
|
+
end
|
|
477
|
+
```
|
|
478
|
+
|
|
479
|
+
### Parameters
|
|
480
|
+
|
|
481
|
+
| Name | Type | Description | Notes |
|
|
482
|
+
| ---- | ---- | ----------- | ----- |
|
|
483
|
+
| **ownership_account_id** | **Integer** | The ownership account identifier. | |
|
|
484
|
+
| **ownership_account_ledger_charge_post_message** | [**OwnershipAccountLedgerChargePostMessage**](OwnershipAccountLedgerChargePostMessage.md) | | |
|
|
485
|
+
|
|
486
|
+
### Return type
|
|
487
|
+
|
|
488
|
+
[**OwnershipAccountTransactionMessage**](OwnershipAccountTransactionMessage.md)
|
|
489
|
+
|
|
490
|
+
### Authorization
|
|
491
|
+
|
|
492
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
493
|
+
|
|
494
|
+
### HTTP request headers
|
|
495
|
+
|
|
496
|
+
- **Content-Type**: application/json
|
|
497
|
+
- **Accept**: application/json
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
## create_ownership_account_ledger_payment
|
|
501
|
+
|
|
502
|
+
> <OwnershipAccountTransactionMessage> create_ownership_account_ledger_payment(ownership_account_id, ownership_account_ledger_payment_post_message)
|
|
503
|
+
|
|
504
|
+
Create a ledger payment
|
|
505
|
+
|
|
506
|
+
Creates a ledger payment. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit`
|
|
507
|
+
|
|
508
|
+
### Examples
|
|
509
|
+
|
|
510
|
+
```ruby
|
|
511
|
+
require 'time'
|
|
512
|
+
require 'buildium-ruby'
|
|
513
|
+
# setup authorization
|
|
514
|
+
Buildium.configure do |config|
|
|
515
|
+
# Configure API key authorization: clientId
|
|
516
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
517
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
518
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
519
|
+
|
|
520
|
+
# Configure API key authorization: clientSecret
|
|
521
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
522
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
523
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
524
|
+
end
|
|
525
|
+
|
|
526
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
527
|
+
ownership_account_id = 56 # Integer |
|
|
528
|
+
ownership_account_ledger_payment_post_message = Buildium::OwnershipAccountLedgerPaymentPostMessage.new({date: Date.today, payment_method: 'Check', send_email_receipt: false, lines: [Buildium::OwnershipAccountLedgerPaymentLineSaveMessage.new({amount: 3.56, gl_account_id: 37})]}) # OwnershipAccountLedgerPaymentPostMessage |
|
|
529
|
+
|
|
530
|
+
begin
|
|
531
|
+
# Create a ledger payment
|
|
532
|
+
result = api_instance.create_ownership_account_ledger_payment(ownership_account_id, ownership_account_ledger_payment_post_message)
|
|
533
|
+
p result
|
|
534
|
+
rescue Buildium::ApiError => e
|
|
535
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_ownership_account_ledger_payment: #{e}"
|
|
536
|
+
end
|
|
537
|
+
```
|
|
538
|
+
|
|
539
|
+
#### Using the create_ownership_account_ledger_payment_with_http_info variant
|
|
540
|
+
|
|
541
|
+
This returns an Array which contains the response data, status code and headers.
|
|
542
|
+
|
|
543
|
+
> <Array(<OwnershipAccountTransactionMessage>, Integer, Hash)> create_ownership_account_ledger_payment_with_http_info(ownership_account_id, ownership_account_ledger_payment_post_message)
|
|
544
|
+
|
|
545
|
+
```ruby
|
|
546
|
+
begin
|
|
547
|
+
# Create a ledger payment
|
|
548
|
+
data, status_code, headers = api_instance.create_ownership_account_ledger_payment_with_http_info(ownership_account_id, ownership_account_ledger_payment_post_message)
|
|
549
|
+
p status_code # => 2xx
|
|
550
|
+
p headers # => { ... }
|
|
551
|
+
p data # => <OwnershipAccountTransactionMessage>
|
|
552
|
+
rescue Buildium::ApiError => e
|
|
553
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_ownership_account_ledger_payment_with_http_info: #{e}"
|
|
554
|
+
end
|
|
555
|
+
```
|
|
556
|
+
|
|
557
|
+
### Parameters
|
|
558
|
+
|
|
559
|
+
| Name | Type | Description | Notes |
|
|
560
|
+
| ---- | ---- | ----------- | ----- |
|
|
561
|
+
| **ownership_account_id** | **Integer** | | |
|
|
562
|
+
| **ownership_account_ledger_payment_post_message** | [**OwnershipAccountLedgerPaymentPostMessage**](OwnershipAccountLedgerPaymentPostMessage.md) | | |
|
|
563
|
+
|
|
564
|
+
### Return type
|
|
565
|
+
|
|
566
|
+
[**OwnershipAccountTransactionMessage**](OwnershipAccountTransactionMessage.md)
|
|
567
|
+
|
|
568
|
+
### Authorization
|
|
569
|
+
|
|
570
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
571
|
+
|
|
572
|
+
### HTTP request headers
|
|
573
|
+
|
|
574
|
+
- **Content-Type**: application/json
|
|
575
|
+
- **Accept**: application/json
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
## create_ownership_account_recurring_payment
|
|
579
|
+
|
|
580
|
+
> <OwnershipAccountRecurringPaymentMessage> create_ownership_account_recurring_payment(ownership_account_id, payment_recurring_transaction_post_message)
|
|
581
|
+
|
|
582
|
+
Create a recurring payment
|
|
583
|
+
|
|
584
|
+
Creates a recurring payment that will post automatically on the specified ownership account ledger. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit`
|
|
585
|
+
|
|
586
|
+
### Examples
|
|
587
|
+
|
|
588
|
+
```ruby
|
|
589
|
+
require 'time'
|
|
590
|
+
require 'buildium-ruby'
|
|
591
|
+
# setup authorization
|
|
592
|
+
Buildium.configure do |config|
|
|
593
|
+
# Configure API key authorization: clientId
|
|
594
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
595
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
596
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
597
|
+
|
|
598
|
+
# Configure API key authorization: clientSecret
|
|
599
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
600
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
601
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
602
|
+
end
|
|
603
|
+
|
|
604
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
605
|
+
ownership_account_id = 56 # Integer |
|
|
606
|
+
payment_recurring_transaction_post_message = Buildium::PaymentRecurringTransactionPostMessage.new({payment_method: 'Check', first_occurrence_date: Date.today, post_days_in_advance: 37, frequency: 'Monthly'}) # PaymentRecurringTransactionPostMessage |
|
|
607
|
+
|
|
608
|
+
begin
|
|
609
|
+
# Create a recurring payment
|
|
610
|
+
result = api_instance.create_ownership_account_recurring_payment(ownership_account_id, payment_recurring_transaction_post_message)
|
|
611
|
+
p result
|
|
612
|
+
rescue Buildium::ApiError => e
|
|
613
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_ownership_account_recurring_payment: #{e}"
|
|
614
|
+
end
|
|
615
|
+
```
|
|
616
|
+
|
|
617
|
+
#### Using the create_ownership_account_recurring_payment_with_http_info variant
|
|
618
|
+
|
|
619
|
+
This returns an Array which contains the response data, status code and headers.
|
|
620
|
+
|
|
621
|
+
> <Array(<OwnershipAccountRecurringPaymentMessage>, Integer, Hash)> create_ownership_account_recurring_payment_with_http_info(ownership_account_id, payment_recurring_transaction_post_message)
|
|
622
|
+
|
|
623
|
+
```ruby
|
|
624
|
+
begin
|
|
625
|
+
# Create a recurring payment
|
|
626
|
+
data, status_code, headers = api_instance.create_ownership_account_recurring_payment_with_http_info(ownership_account_id, payment_recurring_transaction_post_message)
|
|
627
|
+
p status_code # => 2xx
|
|
628
|
+
p headers # => { ... }
|
|
629
|
+
p data # => <OwnershipAccountRecurringPaymentMessage>
|
|
630
|
+
rescue Buildium::ApiError => e
|
|
631
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_ownership_account_recurring_payment_with_http_info: #{e}"
|
|
632
|
+
end
|
|
633
|
+
```
|
|
634
|
+
|
|
635
|
+
### Parameters
|
|
636
|
+
|
|
637
|
+
| Name | Type | Description | Notes |
|
|
638
|
+
| ---- | ---- | ----------- | ----- |
|
|
639
|
+
| **ownership_account_id** | **Integer** | | |
|
|
640
|
+
| **payment_recurring_transaction_post_message** | [**PaymentRecurringTransactionPostMessage**](PaymentRecurringTransactionPostMessage.md) | | |
|
|
641
|
+
|
|
642
|
+
### Return type
|
|
643
|
+
|
|
644
|
+
[**OwnershipAccountRecurringPaymentMessage**](OwnershipAccountRecurringPaymentMessage.md)
|
|
645
|
+
|
|
646
|
+
### Authorization
|
|
647
|
+
|
|
648
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
649
|
+
|
|
650
|
+
### HTTP request headers
|
|
651
|
+
|
|
652
|
+
- **Content-Type**: application/json
|
|
653
|
+
- **Accept**: application/json
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
## create_ownership_account_refund
|
|
657
|
+
|
|
658
|
+
> <OwnershipAccountRefundMessage> create_ownership_account_refund(ownership_account_id, ownership_account_refund_post_message)
|
|
659
|
+
|
|
660
|
+
Create a refund
|
|
661
|
+
|
|
662
|
+
Creates a refund. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting > Bank Accounts</span> - `View` `Edit`
|
|
663
|
+
|
|
664
|
+
### Examples
|
|
665
|
+
|
|
666
|
+
```ruby
|
|
667
|
+
require 'time'
|
|
668
|
+
require 'buildium-ruby'
|
|
669
|
+
# setup authorization
|
|
670
|
+
Buildium.configure do |config|
|
|
671
|
+
# Configure API key authorization: clientId
|
|
672
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
673
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
674
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
675
|
+
|
|
676
|
+
# Configure API key authorization: clientSecret
|
|
677
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
678
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
679
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
680
|
+
end
|
|
681
|
+
|
|
682
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
683
|
+
ownership_account_id = 56 # Integer |
|
|
684
|
+
ownership_account_refund_post_message = Buildium::OwnershipAccountRefundPostMessage.new({date: Date.today, payee_user_ids: [37], bank_account_id: 37, address: Buildium::SaveAddressMessage.new({address_line1: 'address_line1_example', country: 'UnitedStates'}), lines: [Buildium::OwnershipAccountRefundLinesPostMessage.new({amount: 3.56, gl_account_id: 37})]}) # OwnershipAccountRefundPostMessage |
|
|
685
|
+
|
|
686
|
+
begin
|
|
687
|
+
# Create a refund
|
|
688
|
+
result = api_instance.create_ownership_account_refund(ownership_account_id, ownership_account_refund_post_message)
|
|
689
|
+
p result
|
|
690
|
+
rescue Buildium::ApiError => e
|
|
691
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_ownership_account_refund: #{e}"
|
|
692
|
+
end
|
|
693
|
+
```
|
|
694
|
+
|
|
695
|
+
#### Using the create_ownership_account_refund_with_http_info variant
|
|
696
|
+
|
|
697
|
+
This returns an Array which contains the response data, status code and headers.
|
|
698
|
+
|
|
699
|
+
> <Array(<OwnershipAccountRefundMessage>, Integer, Hash)> create_ownership_account_refund_with_http_info(ownership_account_id, ownership_account_refund_post_message)
|
|
700
|
+
|
|
701
|
+
```ruby
|
|
702
|
+
begin
|
|
703
|
+
# Create a refund
|
|
704
|
+
data, status_code, headers = api_instance.create_ownership_account_refund_with_http_info(ownership_account_id, ownership_account_refund_post_message)
|
|
705
|
+
p status_code # => 2xx
|
|
706
|
+
p headers # => { ... }
|
|
707
|
+
p data # => <OwnershipAccountRefundMessage>
|
|
708
|
+
rescue Buildium::ApiError => e
|
|
709
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_ownership_account_refund_with_http_info: #{e}"
|
|
710
|
+
end
|
|
711
|
+
```
|
|
712
|
+
|
|
713
|
+
### Parameters
|
|
714
|
+
|
|
715
|
+
| Name | Type | Description | Notes |
|
|
716
|
+
| ---- | ---- | ----------- | ----- |
|
|
717
|
+
| **ownership_account_id** | **Integer** | | |
|
|
718
|
+
| **ownership_account_refund_post_message** | [**OwnershipAccountRefundPostMessage**](OwnershipAccountRefundPostMessage.md) | | |
|
|
719
|
+
|
|
720
|
+
### Return type
|
|
721
|
+
|
|
722
|
+
[**OwnershipAccountRefundMessage**](OwnershipAccountRefundMessage.md)
|
|
723
|
+
|
|
724
|
+
### Authorization
|
|
725
|
+
|
|
726
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
727
|
+
|
|
728
|
+
### HTTP request headers
|
|
729
|
+
|
|
730
|
+
- **Content-Type**: application/json
|
|
731
|
+
- **Accept**: application/json
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
## create_ownership_accounts_charge_recurring_transaction
|
|
735
|
+
|
|
736
|
+
> <OwnershipAccountChargeRecurringTransactionMessage> create_ownership_accounts_charge_recurring_transaction(ownership_account_id, charge_recurring_transaction_post_message)
|
|
737
|
+
|
|
738
|
+
Create a recurring charge
|
|
739
|
+
|
|
740
|
+
Creates a recurring charge transaction that will post automatically on the specified ownership account ledger. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit`
|
|
741
|
+
|
|
742
|
+
### Examples
|
|
743
|
+
|
|
744
|
+
```ruby
|
|
745
|
+
require 'time'
|
|
746
|
+
require 'buildium-ruby'
|
|
747
|
+
# setup authorization
|
|
748
|
+
Buildium.configure do |config|
|
|
749
|
+
# Configure API key authorization: clientId
|
|
750
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
751
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
752
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
753
|
+
|
|
754
|
+
# Configure API key authorization: clientSecret
|
|
755
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
756
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
757
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
758
|
+
end
|
|
759
|
+
|
|
760
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
761
|
+
ownership_account_id = 56 # Integer |
|
|
762
|
+
charge_recurring_transaction_post_message = Buildium::ChargeRecurringTransactionPostMessage.new({gl_account_id: 37, amount: 3.56, first_occurrence_date: Date.today, post_days_in_advance: 37, frequency: 'Monthly'}) # ChargeRecurringTransactionPostMessage |
|
|
763
|
+
|
|
764
|
+
begin
|
|
765
|
+
# Create a recurring charge
|
|
766
|
+
result = api_instance.create_ownership_accounts_charge_recurring_transaction(ownership_account_id, charge_recurring_transaction_post_message)
|
|
767
|
+
p result
|
|
768
|
+
rescue Buildium::ApiError => e
|
|
769
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_ownership_accounts_charge_recurring_transaction: #{e}"
|
|
770
|
+
end
|
|
771
|
+
```
|
|
772
|
+
|
|
773
|
+
#### Using the create_ownership_accounts_charge_recurring_transaction_with_http_info variant
|
|
774
|
+
|
|
775
|
+
This returns an Array which contains the response data, status code and headers.
|
|
776
|
+
|
|
777
|
+
> <Array(<OwnershipAccountChargeRecurringTransactionMessage>, Integer, Hash)> create_ownership_accounts_charge_recurring_transaction_with_http_info(ownership_account_id, charge_recurring_transaction_post_message)
|
|
778
|
+
|
|
779
|
+
```ruby
|
|
780
|
+
begin
|
|
781
|
+
# Create a recurring charge
|
|
782
|
+
data, status_code, headers = api_instance.create_ownership_accounts_charge_recurring_transaction_with_http_info(ownership_account_id, charge_recurring_transaction_post_message)
|
|
783
|
+
p status_code # => 2xx
|
|
784
|
+
p headers # => { ... }
|
|
785
|
+
p data # => <OwnershipAccountChargeRecurringTransactionMessage>
|
|
786
|
+
rescue Buildium::ApiError => e
|
|
787
|
+
puts "Error when calling AssociationOwnershipAccountsApi->create_ownership_accounts_charge_recurring_transaction_with_http_info: #{e}"
|
|
788
|
+
end
|
|
789
|
+
```
|
|
790
|
+
|
|
791
|
+
### Parameters
|
|
792
|
+
|
|
793
|
+
| Name | Type | Description | Notes |
|
|
794
|
+
| ---- | ---- | ----------- | ----- |
|
|
795
|
+
| **ownership_account_id** | **Integer** | | |
|
|
796
|
+
| **charge_recurring_transaction_post_message** | [**ChargeRecurringTransactionPostMessage**](ChargeRecurringTransactionPostMessage.md) | | |
|
|
797
|
+
|
|
798
|
+
### Return type
|
|
799
|
+
|
|
800
|
+
[**OwnershipAccountChargeRecurringTransactionMessage**](OwnershipAccountChargeRecurringTransactionMessage.md)
|
|
801
|
+
|
|
802
|
+
### Authorization
|
|
803
|
+
|
|
804
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
805
|
+
|
|
806
|
+
### HTTP request headers
|
|
807
|
+
|
|
808
|
+
- **Content-Type**: application/json
|
|
809
|
+
- **Accept**: application/json
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
## get_all_ownership_accounts
|
|
813
|
+
|
|
814
|
+
> <Array<AssociationOwnershipAccountMessage>> get_all_ownership_accounts(opts)
|
|
815
|
+
|
|
816
|
+
Retrieve all ownership accounts
|
|
817
|
+
|
|
818
|
+
Retrieves a list of ownership accounts. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership accounts</span> - `View`
|
|
819
|
+
|
|
820
|
+
### Examples
|
|
821
|
+
|
|
822
|
+
```ruby
|
|
823
|
+
require 'time'
|
|
824
|
+
require 'buildium-ruby'
|
|
825
|
+
# setup authorization
|
|
826
|
+
Buildium.configure do |config|
|
|
827
|
+
# Configure API key authorization: clientId
|
|
828
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
829
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
830
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
831
|
+
|
|
832
|
+
# Configure API key authorization: clientSecret
|
|
833
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
834
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
835
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
836
|
+
end
|
|
837
|
+
|
|
838
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
839
|
+
opts = {
|
|
840
|
+
associationids: [37], # Array<Integer> | Filters results to any ownership accounts who belong to the specified set of association ids.
|
|
841
|
+
unitorowner: 'unitorowner_example', # String | Filters results to any association whose unit or owner *contains* the specified value.
|
|
842
|
+
datefrom: Date.parse('2013-10-20'), # Date | Filters results to any ownership account whose start date is greater than or equal to the specified value.
|
|
843
|
+
dateto: Date.parse('2013-10-20'), # Date | Filters results to any ownership account whose start date is less than or equal to the specified value.
|
|
844
|
+
status: ['Active'], # Array<String> | Filters results by the status of the association. If no status is specified, `active`, `past` and `future` associations will be returned.
|
|
845
|
+
delinquencystatuses: ['NoDelinquency'], # Array<String> | Filters results by the delinquency status of the ownership account. If no status is specified, ownership accounts of any delinquency status will be returned.
|
|
846
|
+
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.
|
|
847
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
848
|
+
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.
|
|
849
|
+
}
|
|
850
|
+
|
|
851
|
+
begin
|
|
852
|
+
# Retrieve all ownership accounts
|
|
853
|
+
result = api_instance.get_all_ownership_accounts(opts)
|
|
854
|
+
p result
|
|
855
|
+
rescue Buildium::ApiError => e
|
|
856
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_all_ownership_accounts: #{e}"
|
|
857
|
+
end
|
|
858
|
+
```
|
|
859
|
+
|
|
860
|
+
#### Using the get_all_ownership_accounts_with_http_info variant
|
|
861
|
+
|
|
862
|
+
This returns an Array which contains the response data, status code and headers.
|
|
863
|
+
|
|
864
|
+
> <Array(<Array<AssociationOwnershipAccountMessage>>, Integer, Hash)> get_all_ownership_accounts_with_http_info(opts)
|
|
865
|
+
|
|
866
|
+
```ruby
|
|
867
|
+
begin
|
|
868
|
+
# Retrieve all ownership accounts
|
|
869
|
+
data, status_code, headers = api_instance.get_all_ownership_accounts_with_http_info(opts)
|
|
870
|
+
p status_code # => 2xx
|
|
871
|
+
p headers # => { ... }
|
|
872
|
+
p data # => <Array<AssociationOwnershipAccountMessage>>
|
|
873
|
+
rescue Buildium::ApiError => e
|
|
874
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_all_ownership_accounts_with_http_info: #{e}"
|
|
875
|
+
end
|
|
876
|
+
```
|
|
877
|
+
|
|
878
|
+
### Parameters
|
|
879
|
+
|
|
880
|
+
| Name | Type | Description | Notes |
|
|
881
|
+
| ---- | ---- | ----------- | ----- |
|
|
882
|
+
| **associationids** | [**Array<Integer>**](Integer.md) | Filters results to any ownership accounts who belong to the specified set of association ids. | [optional] |
|
|
883
|
+
| **unitorowner** | **String** | Filters results to any association whose unit or owner *contains* the specified value. | [optional] |
|
|
884
|
+
| **datefrom** | **Date** | Filters results to any ownership account whose start date is greater than or equal to the specified value. | [optional] |
|
|
885
|
+
| **dateto** | **Date** | Filters results to any ownership account whose start date is less than or equal to the specified value. | [optional] |
|
|
886
|
+
| **status** | [**Array<String>**](String.md) | Filters results by the status of the association. If no status is specified, `active`, `past` and `future` associations will be returned. | [optional] |
|
|
887
|
+
| **delinquencystatuses** | [**Array<String>**](String.md) | Filters results by the delinquency status of the ownership account. If no status is specified, ownership accounts of any delinquency status will be returned. | [optional] |
|
|
888
|
+
| **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] |
|
|
889
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
|
890
|
+
| **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] |
|
|
891
|
+
|
|
892
|
+
### Return type
|
|
893
|
+
|
|
894
|
+
[**Array<AssociationOwnershipAccountMessage>**](AssociationOwnershipAccountMessage.md)
|
|
895
|
+
|
|
896
|
+
### Authorization
|
|
897
|
+
|
|
898
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
899
|
+
|
|
900
|
+
### HTTP request headers
|
|
901
|
+
|
|
902
|
+
- **Content-Type**: Not defined
|
|
903
|
+
- **Accept**: application/json
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
## get_association_ownership_account_note_by_note_id
|
|
907
|
+
|
|
908
|
+
> <NoteMessage> get_association_ownership_account_note_by_note_id(ownership_account_id, note_id)
|
|
909
|
+
|
|
910
|
+
Retrieve a note
|
|
911
|
+
|
|
912
|
+
Retrieves an ownership account note. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > OwnershipAccounts</span> - `View`
|
|
913
|
+
|
|
914
|
+
### Examples
|
|
915
|
+
|
|
916
|
+
```ruby
|
|
917
|
+
require 'time'
|
|
918
|
+
require 'buildium-ruby'
|
|
919
|
+
# setup authorization
|
|
920
|
+
Buildium.configure do |config|
|
|
921
|
+
# Configure API key authorization: clientId
|
|
922
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
923
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
924
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
925
|
+
|
|
926
|
+
# Configure API key authorization: clientSecret
|
|
927
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
928
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
929
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
930
|
+
end
|
|
931
|
+
|
|
932
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
933
|
+
ownership_account_id = 56 # Integer |
|
|
934
|
+
note_id = 56 # Integer |
|
|
935
|
+
|
|
936
|
+
begin
|
|
937
|
+
# Retrieve a note
|
|
938
|
+
result = api_instance.get_association_ownership_account_note_by_note_id(ownership_account_id, note_id)
|
|
939
|
+
p result
|
|
940
|
+
rescue Buildium::ApiError => e
|
|
941
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_association_ownership_account_note_by_note_id: #{e}"
|
|
942
|
+
end
|
|
943
|
+
```
|
|
944
|
+
|
|
945
|
+
#### Using the get_association_ownership_account_note_by_note_id_with_http_info variant
|
|
946
|
+
|
|
947
|
+
This returns an Array which contains the response data, status code and headers.
|
|
948
|
+
|
|
949
|
+
> <Array(<NoteMessage>, Integer, Hash)> get_association_ownership_account_note_by_note_id_with_http_info(ownership_account_id, note_id)
|
|
950
|
+
|
|
951
|
+
```ruby
|
|
952
|
+
begin
|
|
953
|
+
# Retrieve a note
|
|
954
|
+
data, status_code, headers = api_instance.get_association_ownership_account_note_by_note_id_with_http_info(ownership_account_id, note_id)
|
|
955
|
+
p status_code # => 2xx
|
|
956
|
+
p headers # => { ... }
|
|
957
|
+
p data # => <NoteMessage>
|
|
958
|
+
rescue Buildium::ApiError => e
|
|
959
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_association_ownership_account_note_by_note_id_with_http_info: #{e}"
|
|
960
|
+
end
|
|
961
|
+
```
|
|
962
|
+
|
|
963
|
+
### Parameters
|
|
964
|
+
|
|
965
|
+
| Name | Type | Description | Notes |
|
|
966
|
+
| ---- | ---- | ----------- | ----- |
|
|
967
|
+
| **ownership_account_id** | **Integer** | | |
|
|
968
|
+
| **note_id** | **Integer** | | |
|
|
969
|
+
|
|
970
|
+
### Return type
|
|
971
|
+
|
|
972
|
+
[**NoteMessage**](NoteMessage.md)
|
|
973
|
+
|
|
974
|
+
### Authorization
|
|
975
|
+
|
|
976
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
977
|
+
|
|
978
|
+
### HTTP request headers
|
|
979
|
+
|
|
980
|
+
- **Content-Type**: Not defined
|
|
981
|
+
- **Accept**: application/json
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
## get_association_ownership_account_notes
|
|
985
|
+
|
|
986
|
+
> <Array<NoteMessage>> get_association_ownership_account_notes(ownership_account_id, opts)
|
|
987
|
+
|
|
988
|
+
Retrieve all notes
|
|
989
|
+
|
|
990
|
+
Retrieves notes for an ownership account. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > OwnershipAccounts</span> - `View`
|
|
991
|
+
|
|
992
|
+
### Examples
|
|
993
|
+
|
|
994
|
+
```ruby
|
|
995
|
+
require 'time'
|
|
996
|
+
require 'buildium-ruby'
|
|
997
|
+
# setup authorization
|
|
998
|
+
Buildium.configure do |config|
|
|
999
|
+
# Configure API key authorization: clientId
|
|
1000
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
1001
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1002
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
1003
|
+
|
|
1004
|
+
# Configure API key authorization: clientSecret
|
|
1005
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
1006
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1007
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
1008
|
+
end
|
|
1009
|
+
|
|
1010
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
1011
|
+
ownership_account_id = 56 # Integer |
|
|
1012
|
+
opts = {
|
|
1013
|
+
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.
|
|
1014
|
+
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.
|
|
1015
|
+
lastupdatedbyuserid: 56, # Integer | Filters results to only notes that were last updated by the specified user identifier.
|
|
1016
|
+
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.
|
|
1017
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
1018
|
+
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.
|
|
1019
|
+
}
|
|
1020
|
+
|
|
1021
|
+
begin
|
|
1022
|
+
# Retrieve all notes
|
|
1023
|
+
result = api_instance.get_association_ownership_account_notes(ownership_account_id, opts)
|
|
1024
|
+
p result
|
|
1025
|
+
rescue Buildium::ApiError => e
|
|
1026
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_association_ownership_account_notes: #{e}"
|
|
1027
|
+
end
|
|
1028
|
+
```
|
|
1029
|
+
|
|
1030
|
+
#### Using the get_association_ownership_account_notes_with_http_info variant
|
|
1031
|
+
|
|
1032
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1033
|
+
|
|
1034
|
+
> <Array(<Array<NoteMessage>>, Integer, Hash)> get_association_ownership_account_notes_with_http_info(ownership_account_id, opts)
|
|
1035
|
+
|
|
1036
|
+
```ruby
|
|
1037
|
+
begin
|
|
1038
|
+
# Retrieve all notes
|
|
1039
|
+
data, status_code, headers = api_instance.get_association_ownership_account_notes_with_http_info(ownership_account_id, opts)
|
|
1040
|
+
p status_code # => 2xx
|
|
1041
|
+
p headers # => { ... }
|
|
1042
|
+
p data # => <Array<NoteMessage>>
|
|
1043
|
+
rescue Buildium::ApiError => e
|
|
1044
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_association_ownership_account_notes_with_http_info: #{e}"
|
|
1045
|
+
end
|
|
1046
|
+
```
|
|
1047
|
+
|
|
1048
|
+
### Parameters
|
|
1049
|
+
|
|
1050
|
+
| Name | Type | Description | Notes |
|
|
1051
|
+
| ---- | ---- | ----------- | ----- |
|
|
1052
|
+
| **ownership_account_id** | **Integer** | | |
|
|
1053
|
+
| **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] |
|
|
1054
|
+
| **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] |
|
|
1055
|
+
| **lastupdatedbyuserid** | **Integer** | Filters results to only notes that were last updated by the specified user identifier. | [optional] |
|
|
1056
|
+
| **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] |
|
|
1057
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
|
1058
|
+
| **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] |
|
|
1059
|
+
|
|
1060
|
+
### Return type
|
|
1061
|
+
|
|
1062
|
+
[**Array<NoteMessage>**](NoteMessage.md)
|
|
1063
|
+
|
|
1064
|
+
### Authorization
|
|
1065
|
+
|
|
1066
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
1067
|
+
|
|
1068
|
+
### HTTP request headers
|
|
1069
|
+
|
|
1070
|
+
- **Content-Type**: Not defined
|
|
1071
|
+
- **Accept**: application/json
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
## get_association_recurring_transaction
|
|
1075
|
+
|
|
1076
|
+
> <Array<RecurringTransactionMessage>> get_association_recurring_transaction(ownership_account_id, opts)
|
|
1077
|
+
|
|
1078
|
+
Retrieve all recurring transactions
|
|
1079
|
+
|
|
1080
|
+
Retrieves all recurring transactions for an ownership account. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View`
|
|
1081
|
+
|
|
1082
|
+
### Examples
|
|
1083
|
+
|
|
1084
|
+
```ruby
|
|
1085
|
+
require 'time'
|
|
1086
|
+
require 'buildium-ruby'
|
|
1087
|
+
# setup authorization
|
|
1088
|
+
Buildium.configure do |config|
|
|
1089
|
+
# Configure API key authorization: clientId
|
|
1090
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
1091
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1092
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
1093
|
+
|
|
1094
|
+
# Configure API key authorization: clientSecret
|
|
1095
|
+
config.api_key['clientSecret'] = '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['clientSecret'] = 'Bearer'
|
|
1098
|
+
end
|
|
1099
|
+
|
|
1100
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
1101
|
+
ownership_account_id = 56 # Integer |
|
|
1102
|
+
opts = {
|
|
1103
|
+
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.
|
|
1104
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
1105
|
+
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.
|
|
1106
|
+
}
|
|
1107
|
+
|
|
1108
|
+
begin
|
|
1109
|
+
# Retrieve all recurring transactions
|
|
1110
|
+
result = api_instance.get_association_recurring_transaction(ownership_account_id, opts)
|
|
1111
|
+
p result
|
|
1112
|
+
rescue Buildium::ApiError => e
|
|
1113
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_association_recurring_transaction: #{e}"
|
|
1114
|
+
end
|
|
1115
|
+
```
|
|
1116
|
+
|
|
1117
|
+
#### Using the get_association_recurring_transaction_with_http_info variant
|
|
1118
|
+
|
|
1119
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1120
|
+
|
|
1121
|
+
> <Array(<Array<RecurringTransactionMessage>>, Integer, Hash)> get_association_recurring_transaction_with_http_info(ownership_account_id, opts)
|
|
1122
|
+
|
|
1123
|
+
```ruby
|
|
1124
|
+
begin
|
|
1125
|
+
# Retrieve all recurring transactions
|
|
1126
|
+
data, status_code, headers = api_instance.get_association_recurring_transaction_with_http_info(ownership_account_id, opts)
|
|
1127
|
+
p status_code # => 2xx
|
|
1128
|
+
p headers # => { ... }
|
|
1129
|
+
p data # => <Array<RecurringTransactionMessage>>
|
|
1130
|
+
rescue Buildium::ApiError => e
|
|
1131
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_association_recurring_transaction_with_http_info: #{e}"
|
|
1132
|
+
end
|
|
1133
|
+
```
|
|
1134
|
+
|
|
1135
|
+
### Parameters
|
|
1136
|
+
|
|
1137
|
+
| Name | Type | Description | Notes |
|
|
1138
|
+
| ---- | ---- | ----------- | ----- |
|
|
1139
|
+
| **ownership_account_id** | **Integer** | | |
|
|
1140
|
+
| **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] |
|
|
1141
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
|
1142
|
+
| **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] |
|
|
1143
|
+
|
|
1144
|
+
### Return type
|
|
1145
|
+
|
|
1146
|
+
[**Array<RecurringTransactionMessage>**](RecurringTransactionMessage.md)
|
|
1147
|
+
|
|
1148
|
+
### Authorization
|
|
1149
|
+
|
|
1150
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
1151
|
+
|
|
1152
|
+
### HTTP request headers
|
|
1153
|
+
|
|
1154
|
+
- **Content-Type**: Not defined
|
|
1155
|
+
- **Accept**: application/json
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
## get_ownership_account_by_id
|
|
1159
|
+
|
|
1160
|
+
> <AssociationOwnershipAccountMessage> get_ownership_account_by_id(ownership_account_id)
|
|
1161
|
+
|
|
1162
|
+
Retrieve an ownership account
|
|
1163
|
+
|
|
1164
|
+
Retrieves a specific ownership account. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership accounts</span> - `View`
|
|
1165
|
+
|
|
1166
|
+
### Examples
|
|
1167
|
+
|
|
1168
|
+
```ruby
|
|
1169
|
+
require 'time'
|
|
1170
|
+
require 'buildium-ruby'
|
|
1171
|
+
# setup authorization
|
|
1172
|
+
Buildium.configure do |config|
|
|
1173
|
+
# Configure API key authorization: clientId
|
|
1174
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
1175
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1176
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
1177
|
+
|
|
1178
|
+
# Configure API key authorization: clientSecret
|
|
1179
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
1180
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1181
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
1182
|
+
end
|
|
1183
|
+
|
|
1184
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
1185
|
+
ownership_account_id = 56 # Integer | The ownership account identifier.
|
|
1186
|
+
|
|
1187
|
+
begin
|
|
1188
|
+
# Retrieve an ownership account
|
|
1189
|
+
result = api_instance.get_ownership_account_by_id(ownership_account_id)
|
|
1190
|
+
p result
|
|
1191
|
+
rescue Buildium::ApiError => e
|
|
1192
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_ownership_account_by_id: #{e}"
|
|
1193
|
+
end
|
|
1194
|
+
```
|
|
1195
|
+
|
|
1196
|
+
#### Using the get_ownership_account_by_id_with_http_info variant
|
|
1197
|
+
|
|
1198
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1199
|
+
|
|
1200
|
+
> <Array(<AssociationOwnershipAccountMessage>, Integer, Hash)> get_ownership_account_by_id_with_http_info(ownership_account_id)
|
|
1201
|
+
|
|
1202
|
+
```ruby
|
|
1203
|
+
begin
|
|
1204
|
+
# Retrieve an ownership account
|
|
1205
|
+
data, status_code, headers = api_instance.get_ownership_account_by_id_with_http_info(ownership_account_id)
|
|
1206
|
+
p status_code # => 2xx
|
|
1207
|
+
p headers # => { ... }
|
|
1208
|
+
p data # => <AssociationOwnershipAccountMessage>
|
|
1209
|
+
rescue Buildium::ApiError => e
|
|
1210
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_ownership_account_by_id_with_http_info: #{e}"
|
|
1211
|
+
end
|
|
1212
|
+
```
|
|
1213
|
+
|
|
1214
|
+
### Parameters
|
|
1215
|
+
|
|
1216
|
+
| Name | Type | Description | Notes |
|
|
1217
|
+
| ---- | ---- | ----------- | ----- |
|
|
1218
|
+
| **ownership_account_id** | **Integer** | The ownership account identifier. | |
|
|
1219
|
+
|
|
1220
|
+
### Return type
|
|
1221
|
+
|
|
1222
|
+
[**AssociationOwnershipAccountMessage**](AssociationOwnershipAccountMessage.md)
|
|
1223
|
+
|
|
1224
|
+
### Authorization
|
|
1225
|
+
|
|
1226
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
1227
|
+
|
|
1228
|
+
### HTTP request headers
|
|
1229
|
+
|
|
1230
|
+
- **Content-Type**: Not defined
|
|
1231
|
+
- **Accept**: application/json
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
## get_ownership_account_ledger
|
|
1235
|
+
|
|
1236
|
+
> <Array<OwnershipAccountTransactionMessage>> get_ownership_account_ledger(ownership_account_id, opts)
|
|
1237
|
+
|
|
1238
|
+
Retrieve ownership account transactions
|
|
1239
|
+
|
|
1240
|
+
Retrieves all transactions for a specific ownership account. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View`
|
|
1241
|
+
|
|
1242
|
+
### Examples
|
|
1243
|
+
|
|
1244
|
+
```ruby
|
|
1245
|
+
require 'time'
|
|
1246
|
+
require 'buildium-ruby'
|
|
1247
|
+
# setup authorization
|
|
1248
|
+
Buildium.configure do |config|
|
|
1249
|
+
# Configure API key authorization: clientId
|
|
1250
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
1251
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1252
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
1253
|
+
|
|
1254
|
+
# Configure API key authorization: clientSecret
|
|
1255
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
1256
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1257
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
1258
|
+
end
|
|
1259
|
+
|
|
1260
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
1261
|
+
ownership_account_id = 56 # Integer | The ownership account identifier.
|
|
1262
|
+
opts = {
|
|
1263
|
+
transactiondatefrom: Date.parse('2013-10-20'), # Date | Filters results to any lease transaction whose start date is greater than or equal to the specified value.
|
|
1264
|
+
transactiondateto: Date.parse('2013-10-20'), # Date | Filters results to any lease transaction whose end date is less than or equal to the specified value.
|
|
1265
|
+
transactiontypes: ['Bill'], # Array<String> | Filters results to any lease transaction whose lease transaction type matches the specified status. If no type is specified, lease transactions with any type will be returned.
|
|
1266
|
+
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.
|
|
1267
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
1268
|
+
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.
|
|
1269
|
+
}
|
|
1270
|
+
|
|
1271
|
+
begin
|
|
1272
|
+
# Retrieve ownership account transactions
|
|
1273
|
+
result = api_instance.get_ownership_account_ledger(ownership_account_id, opts)
|
|
1274
|
+
p result
|
|
1275
|
+
rescue Buildium::ApiError => e
|
|
1276
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_ownership_account_ledger: #{e}"
|
|
1277
|
+
end
|
|
1278
|
+
```
|
|
1279
|
+
|
|
1280
|
+
#### Using the get_ownership_account_ledger_with_http_info variant
|
|
1281
|
+
|
|
1282
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1283
|
+
|
|
1284
|
+
> <Array(<Array<OwnershipAccountTransactionMessage>>, Integer, Hash)> get_ownership_account_ledger_with_http_info(ownership_account_id, opts)
|
|
1285
|
+
|
|
1286
|
+
```ruby
|
|
1287
|
+
begin
|
|
1288
|
+
# Retrieve ownership account transactions
|
|
1289
|
+
data, status_code, headers = api_instance.get_ownership_account_ledger_with_http_info(ownership_account_id, opts)
|
|
1290
|
+
p status_code # => 2xx
|
|
1291
|
+
p headers # => { ... }
|
|
1292
|
+
p data # => <Array<OwnershipAccountTransactionMessage>>
|
|
1293
|
+
rescue Buildium::ApiError => e
|
|
1294
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_ownership_account_ledger_with_http_info: #{e}"
|
|
1295
|
+
end
|
|
1296
|
+
```
|
|
1297
|
+
|
|
1298
|
+
### Parameters
|
|
1299
|
+
|
|
1300
|
+
| Name | Type | Description | Notes |
|
|
1301
|
+
| ---- | ---- | ----------- | ----- |
|
|
1302
|
+
| **ownership_account_id** | **Integer** | The ownership account identifier. | |
|
|
1303
|
+
| **transactiondatefrom** | **Date** | Filters results to any lease transaction whose start date is greater than or equal to the specified value. | [optional] |
|
|
1304
|
+
| **transactiondateto** | **Date** | Filters results to any lease transaction whose end date is less than or equal to the specified value. | [optional] |
|
|
1305
|
+
| **transactiontypes** | [**Array<String>**](String.md) | Filters results to any lease transaction whose lease transaction type matches the specified status. If no type is specified, lease transactions with any type will be returned. | [optional] |
|
|
1306
|
+
| **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] |
|
|
1307
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
|
1308
|
+
| **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] |
|
|
1309
|
+
|
|
1310
|
+
### Return type
|
|
1311
|
+
|
|
1312
|
+
[**Array<OwnershipAccountTransactionMessage>**](OwnershipAccountTransactionMessage.md)
|
|
1313
|
+
|
|
1314
|
+
### Authorization
|
|
1315
|
+
|
|
1316
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
1317
|
+
|
|
1318
|
+
### HTTP request headers
|
|
1319
|
+
|
|
1320
|
+
- **Content-Type**: Not defined
|
|
1321
|
+
- **Accept**: application/json
|
|
1322
|
+
|
|
1323
|
+
|
|
1324
|
+
## get_ownership_account_outstanding_balances
|
|
1325
|
+
|
|
1326
|
+
> <Array<OwnershipAccountOutstandingBalanceMessage>> get_ownership_account_outstanding_balances(opts)
|
|
1327
|
+
|
|
1328
|
+
Retrieve all outstanding balances
|
|
1329
|
+
|
|
1330
|
+
Retrieves a list of ownership account outstanding balances. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Outstanding Balances</span> - `View`
|
|
1331
|
+
|
|
1332
|
+
### Examples
|
|
1333
|
+
|
|
1334
|
+
```ruby
|
|
1335
|
+
require 'time'
|
|
1336
|
+
require 'buildium-ruby'
|
|
1337
|
+
# setup authorization
|
|
1338
|
+
Buildium.configure do |config|
|
|
1339
|
+
# Configure API key authorization: clientId
|
|
1340
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
1341
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1342
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
1343
|
+
|
|
1344
|
+
# Configure API key authorization: clientSecret
|
|
1345
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
1346
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1347
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
1348
|
+
end
|
|
1349
|
+
|
|
1350
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
1351
|
+
opts = {
|
|
1352
|
+
associationid: 56, # Integer | Association unique identifier
|
|
1353
|
+
ownershipaccountstatuses: ['Active'], # Array<String> | List of ownership account statuses
|
|
1354
|
+
ownershipaccountids: [37], # Array<Integer> | List of ownership account ids
|
|
1355
|
+
pastdueemail: 'NoEmailAddress', # String | Status of notification of outstanding balances
|
|
1356
|
+
balanceduration: 'TotalBalance', # String | Duration of outstanding balances
|
|
1357
|
+
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.
|
|
1358
|
+
offset: 56, # Integer | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
1359
|
+
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.
|
|
1360
|
+
}
|
|
1361
|
+
|
|
1362
|
+
begin
|
|
1363
|
+
# Retrieve all outstanding balances
|
|
1364
|
+
result = api_instance.get_ownership_account_outstanding_balances(opts)
|
|
1365
|
+
p result
|
|
1366
|
+
rescue Buildium::ApiError => e
|
|
1367
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_ownership_account_outstanding_balances: #{e}"
|
|
1368
|
+
end
|
|
1369
|
+
```
|
|
1370
|
+
|
|
1371
|
+
#### Using the get_ownership_account_outstanding_balances_with_http_info variant
|
|
1372
|
+
|
|
1373
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1374
|
+
|
|
1375
|
+
> <Array(<Array<OwnershipAccountOutstandingBalanceMessage>>, Integer, Hash)> get_ownership_account_outstanding_balances_with_http_info(opts)
|
|
1376
|
+
|
|
1377
|
+
```ruby
|
|
1378
|
+
begin
|
|
1379
|
+
# Retrieve all outstanding balances
|
|
1380
|
+
data, status_code, headers = api_instance.get_ownership_account_outstanding_balances_with_http_info(opts)
|
|
1381
|
+
p status_code # => 2xx
|
|
1382
|
+
p headers # => { ... }
|
|
1383
|
+
p data # => <Array<OwnershipAccountOutstandingBalanceMessage>>
|
|
1384
|
+
rescue Buildium::ApiError => e
|
|
1385
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_ownership_account_outstanding_balances_with_http_info: #{e}"
|
|
1386
|
+
end
|
|
1387
|
+
```
|
|
1388
|
+
|
|
1389
|
+
### Parameters
|
|
1390
|
+
|
|
1391
|
+
| Name | Type | Description | Notes |
|
|
1392
|
+
| ---- | ---- | ----------- | ----- |
|
|
1393
|
+
| **associationid** | **Integer** | Association unique identifier | [optional] |
|
|
1394
|
+
| **ownershipaccountstatuses** | [**Array<String>**](String.md) | List of ownership account statuses | [optional] |
|
|
1395
|
+
| **ownershipaccountids** | [**Array<Integer>**](Integer.md) | List of ownership account ids | [optional] |
|
|
1396
|
+
| **pastdueemail** | **String** | Status of notification of outstanding balances | [optional] |
|
|
1397
|
+
| **balanceduration** | **String** | Duration of outstanding balances | [optional] |
|
|
1398
|
+
| **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] |
|
|
1399
|
+
| **offset** | **Integer** | `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0. | [optional] |
|
|
1400
|
+
| **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] |
|
|
1401
|
+
|
|
1402
|
+
### Return type
|
|
1403
|
+
|
|
1404
|
+
[**Array<OwnershipAccountOutstandingBalanceMessage>**](OwnershipAccountOutstandingBalanceMessage.md)
|
|
1405
|
+
|
|
1406
|
+
### Authorization
|
|
1407
|
+
|
|
1408
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
1409
|
+
|
|
1410
|
+
### HTTP request headers
|
|
1411
|
+
|
|
1412
|
+
- **Content-Type**: Not defined
|
|
1413
|
+
- **Accept**: application/json
|
|
1414
|
+
|
|
1415
|
+
|
|
1416
|
+
## get_ownership_account_recurring_credit_by_id
|
|
1417
|
+
|
|
1418
|
+
> <OwnershipAccountRecurringCreditMessage> get_ownership_account_recurring_credit_by_id(ownership_account_id, transaction_id)
|
|
1419
|
+
|
|
1420
|
+
Retrieve a recurring credit
|
|
1421
|
+
|
|
1422
|
+
Retrieves a recurring credit. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View`
|
|
1423
|
+
|
|
1424
|
+
### Examples
|
|
1425
|
+
|
|
1426
|
+
```ruby
|
|
1427
|
+
require 'time'
|
|
1428
|
+
require 'buildium-ruby'
|
|
1429
|
+
# setup authorization
|
|
1430
|
+
Buildium.configure do |config|
|
|
1431
|
+
# Configure API key authorization: clientId
|
|
1432
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
1433
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1434
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
1435
|
+
|
|
1436
|
+
# Configure API key authorization: clientSecret
|
|
1437
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
1438
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1439
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
1440
|
+
end
|
|
1441
|
+
|
|
1442
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
1443
|
+
ownership_account_id = 56 # Integer |
|
|
1444
|
+
transaction_id = 56 # Integer |
|
|
1445
|
+
|
|
1446
|
+
begin
|
|
1447
|
+
# Retrieve a recurring credit
|
|
1448
|
+
result = api_instance.get_ownership_account_recurring_credit_by_id(ownership_account_id, transaction_id)
|
|
1449
|
+
p result
|
|
1450
|
+
rescue Buildium::ApiError => e
|
|
1451
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_ownership_account_recurring_credit_by_id: #{e}"
|
|
1452
|
+
end
|
|
1453
|
+
```
|
|
1454
|
+
|
|
1455
|
+
#### Using the get_ownership_account_recurring_credit_by_id_with_http_info variant
|
|
1456
|
+
|
|
1457
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1458
|
+
|
|
1459
|
+
> <Array(<OwnershipAccountRecurringCreditMessage>, Integer, Hash)> get_ownership_account_recurring_credit_by_id_with_http_info(ownership_account_id, transaction_id)
|
|
1460
|
+
|
|
1461
|
+
```ruby
|
|
1462
|
+
begin
|
|
1463
|
+
# Retrieve a recurring credit
|
|
1464
|
+
data, status_code, headers = api_instance.get_ownership_account_recurring_credit_by_id_with_http_info(ownership_account_id, transaction_id)
|
|
1465
|
+
p status_code # => 2xx
|
|
1466
|
+
p headers # => { ... }
|
|
1467
|
+
p data # => <OwnershipAccountRecurringCreditMessage>
|
|
1468
|
+
rescue Buildium::ApiError => e
|
|
1469
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_ownership_account_recurring_credit_by_id_with_http_info: #{e}"
|
|
1470
|
+
end
|
|
1471
|
+
```
|
|
1472
|
+
|
|
1473
|
+
### Parameters
|
|
1474
|
+
|
|
1475
|
+
| Name | Type | Description | Notes |
|
|
1476
|
+
| ---- | ---- | ----------- | ----- |
|
|
1477
|
+
| **ownership_account_id** | **Integer** | | |
|
|
1478
|
+
| **transaction_id** | **Integer** | | |
|
|
1479
|
+
|
|
1480
|
+
### Return type
|
|
1481
|
+
|
|
1482
|
+
[**OwnershipAccountRecurringCreditMessage**](OwnershipAccountRecurringCreditMessage.md)
|
|
1483
|
+
|
|
1484
|
+
### Authorization
|
|
1485
|
+
|
|
1486
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
1487
|
+
|
|
1488
|
+
### HTTP request headers
|
|
1489
|
+
|
|
1490
|
+
- **Content-Type**: Not defined
|
|
1491
|
+
- **Accept**: application/json
|
|
1492
|
+
|
|
1493
|
+
|
|
1494
|
+
## get_ownership_account_refund_by_id
|
|
1495
|
+
|
|
1496
|
+
> <OwnershipAccountRefundMessage> get_ownership_account_refund_by_id(ownership_account_id, refund_id)
|
|
1497
|
+
|
|
1498
|
+
Retrieve a refund
|
|
1499
|
+
|
|
1500
|
+
Retrieves a refund. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Accounting > Bank Accounts</span> - `View`
|
|
1501
|
+
|
|
1502
|
+
### Examples
|
|
1503
|
+
|
|
1504
|
+
```ruby
|
|
1505
|
+
require 'time'
|
|
1506
|
+
require 'buildium-ruby'
|
|
1507
|
+
# setup authorization
|
|
1508
|
+
Buildium.configure do |config|
|
|
1509
|
+
# Configure API key authorization: clientId
|
|
1510
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
1511
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1512
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
1513
|
+
|
|
1514
|
+
# Configure API key authorization: clientSecret
|
|
1515
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
1516
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1517
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
1518
|
+
end
|
|
1519
|
+
|
|
1520
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
1521
|
+
ownership_account_id = 56 # Integer |
|
|
1522
|
+
refund_id = 56 # Integer |
|
|
1523
|
+
|
|
1524
|
+
begin
|
|
1525
|
+
# Retrieve a refund
|
|
1526
|
+
result = api_instance.get_ownership_account_refund_by_id(ownership_account_id, refund_id)
|
|
1527
|
+
p result
|
|
1528
|
+
rescue Buildium::ApiError => e
|
|
1529
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_ownership_account_refund_by_id: #{e}"
|
|
1530
|
+
end
|
|
1531
|
+
```
|
|
1532
|
+
|
|
1533
|
+
#### Using the get_ownership_account_refund_by_id_with_http_info variant
|
|
1534
|
+
|
|
1535
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1536
|
+
|
|
1537
|
+
> <Array(<OwnershipAccountRefundMessage>, Integer, Hash)> get_ownership_account_refund_by_id_with_http_info(ownership_account_id, refund_id)
|
|
1538
|
+
|
|
1539
|
+
```ruby
|
|
1540
|
+
begin
|
|
1541
|
+
# Retrieve a refund
|
|
1542
|
+
data, status_code, headers = api_instance.get_ownership_account_refund_by_id_with_http_info(ownership_account_id, refund_id)
|
|
1543
|
+
p status_code # => 2xx
|
|
1544
|
+
p headers # => { ... }
|
|
1545
|
+
p data # => <OwnershipAccountRefundMessage>
|
|
1546
|
+
rescue Buildium::ApiError => e
|
|
1547
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_ownership_account_refund_by_id_with_http_info: #{e}"
|
|
1548
|
+
end
|
|
1549
|
+
```
|
|
1550
|
+
|
|
1551
|
+
### Parameters
|
|
1552
|
+
|
|
1553
|
+
| Name | Type | Description | Notes |
|
|
1554
|
+
| ---- | ---- | ----------- | ----- |
|
|
1555
|
+
| **ownership_account_id** | **Integer** | | |
|
|
1556
|
+
| **refund_id** | **Integer** | | |
|
|
1557
|
+
|
|
1558
|
+
### Return type
|
|
1559
|
+
|
|
1560
|
+
[**OwnershipAccountRefundMessage**](OwnershipAccountRefundMessage.md)
|
|
1561
|
+
|
|
1562
|
+
### Authorization
|
|
1563
|
+
|
|
1564
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
1565
|
+
|
|
1566
|
+
### HTTP request headers
|
|
1567
|
+
|
|
1568
|
+
- **Content-Type**: Not defined
|
|
1569
|
+
- **Accept**: application/json
|
|
1570
|
+
|
|
1571
|
+
|
|
1572
|
+
## get_ownership_account_transaction_by_id
|
|
1573
|
+
|
|
1574
|
+
> <OwnershipAccountTransactionMessage> get_ownership_account_transaction_by_id(ownership_account_id, transaction_id)
|
|
1575
|
+
|
|
1576
|
+
Retrieve an ownership account transaction
|
|
1577
|
+
|
|
1578
|
+
Retrieves a single ownership account transaction. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View`
|
|
1579
|
+
|
|
1580
|
+
### Examples
|
|
1581
|
+
|
|
1582
|
+
```ruby
|
|
1583
|
+
require 'time'
|
|
1584
|
+
require 'buildium-ruby'
|
|
1585
|
+
# setup authorization
|
|
1586
|
+
Buildium.configure do |config|
|
|
1587
|
+
# Configure API key authorization: clientId
|
|
1588
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
1589
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1590
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
1591
|
+
|
|
1592
|
+
# Configure API key authorization: clientSecret
|
|
1593
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
1594
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1595
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
1596
|
+
end
|
|
1597
|
+
|
|
1598
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
1599
|
+
ownership_account_id = 56 # Integer | The ownership account identifier.
|
|
1600
|
+
transaction_id = 56 # Integer | The transaction identifier.
|
|
1601
|
+
|
|
1602
|
+
begin
|
|
1603
|
+
# Retrieve an ownership account transaction
|
|
1604
|
+
result = api_instance.get_ownership_account_transaction_by_id(ownership_account_id, transaction_id)
|
|
1605
|
+
p result
|
|
1606
|
+
rescue Buildium::ApiError => e
|
|
1607
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_ownership_account_transaction_by_id: #{e}"
|
|
1608
|
+
end
|
|
1609
|
+
```
|
|
1610
|
+
|
|
1611
|
+
#### Using the get_ownership_account_transaction_by_id_with_http_info variant
|
|
1612
|
+
|
|
1613
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1614
|
+
|
|
1615
|
+
> <Array(<OwnershipAccountTransactionMessage>, Integer, Hash)> get_ownership_account_transaction_by_id_with_http_info(ownership_account_id, transaction_id)
|
|
1616
|
+
|
|
1617
|
+
```ruby
|
|
1618
|
+
begin
|
|
1619
|
+
# Retrieve an ownership account transaction
|
|
1620
|
+
data, status_code, headers = api_instance.get_ownership_account_transaction_by_id_with_http_info(ownership_account_id, transaction_id)
|
|
1621
|
+
p status_code # => 2xx
|
|
1622
|
+
p headers # => { ... }
|
|
1623
|
+
p data # => <OwnershipAccountTransactionMessage>
|
|
1624
|
+
rescue Buildium::ApiError => e
|
|
1625
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_ownership_account_transaction_by_id_with_http_info: #{e}"
|
|
1626
|
+
end
|
|
1627
|
+
```
|
|
1628
|
+
|
|
1629
|
+
### Parameters
|
|
1630
|
+
|
|
1631
|
+
| Name | Type | Description | Notes |
|
|
1632
|
+
| ---- | ---- | ----------- | ----- |
|
|
1633
|
+
| **ownership_account_id** | **Integer** | The ownership account identifier. | |
|
|
1634
|
+
| **transaction_id** | **Integer** | The transaction identifier. | |
|
|
1635
|
+
|
|
1636
|
+
### Return type
|
|
1637
|
+
|
|
1638
|
+
[**OwnershipAccountTransactionMessage**](OwnershipAccountTransactionMessage.md)
|
|
1639
|
+
|
|
1640
|
+
### Authorization
|
|
1641
|
+
|
|
1642
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
1643
|
+
|
|
1644
|
+
### HTTP request headers
|
|
1645
|
+
|
|
1646
|
+
- **Content-Type**: Not defined
|
|
1647
|
+
- **Accept**: application/json
|
|
1648
|
+
|
|
1649
|
+
|
|
1650
|
+
## get_ownership_accounts_charge_recurring_transaction_by_id
|
|
1651
|
+
|
|
1652
|
+
> <OwnershipAccountChargeRecurringTransactionMessage> get_ownership_accounts_charge_recurring_transaction_by_id(ownership_account_id, transaction_id)
|
|
1653
|
+
|
|
1654
|
+
Retrieve a recurring charge
|
|
1655
|
+
|
|
1656
|
+
Retrieves a recurring charge. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View`
|
|
1657
|
+
|
|
1658
|
+
### Examples
|
|
1659
|
+
|
|
1660
|
+
```ruby
|
|
1661
|
+
require 'time'
|
|
1662
|
+
require 'buildium-ruby'
|
|
1663
|
+
# setup authorization
|
|
1664
|
+
Buildium.configure do |config|
|
|
1665
|
+
# Configure API key authorization: clientId
|
|
1666
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
1667
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1668
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
1669
|
+
|
|
1670
|
+
# Configure API key authorization: clientSecret
|
|
1671
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
1672
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1673
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
1674
|
+
end
|
|
1675
|
+
|
|
1676
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
1677
|
+
ownership_account_id = 56 # Integer |
|
|
1678
|
+
transaction_id = 56 # Integer |
|
|
1679
|
+
|
|
1680
|
+
begin
|
|
1681
|
+
# Retrieve a recurring charge
|
|
1682
|
+
result = api_instance.get_ownership_accounts_charge_recurring_transaction_by_id(ownership_account_id, transaction_id)
|
|
1683
|
+
p result
|
|
1684
|
+
rescue Buildium::ApiError => e
|
|
1685
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_ownership_accounts_charge_recurring_transaction_by_id: #{e}"
|
|
1686
|
+
end
|
|
1687
|
+
```
|
|
1688
|
+
|
|
1689
|
+
#### Using the get_ownership_accounts_charge_recurring_transaction_by_id_with_http_info variant
|
|
1690
|
+
|
|
1691
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1692
|
+
|
|
1693
|
+
> <Array(<OwnershipAccountChargeRecurringTransactionMessage>, Integer, Hash)> get_ownership_accounts_charge_recurring_transaction_by_id_with_http_info(ownership_account_id, transaction_id)
|
|
1694
|
+
|
|
1695
|
+
```ruby
|
|
1696
|
+
begin
|
|
1697
|
+
# Retrieve a recurring charge
|
|
1698
|
+
data, status_code, headers = api_instance.get_ownership_accounts_charge_recurring_transaction_by_id_with_http_info(ownership_account_id, transaction_id)
|
|
1699
|
+
p status_code # => 2xx
|
|
1700
|
+
p headers # => { ... }
|
|
1701
|
+
p data # => <OwnershipAccountChargeRecurringTransactionMessage>
|
|
1702
|
+
rescue Buildium::ApiError => e
|
|
1703
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_ownership_accounts_charge_recurring_transaction_by_id_with_http_info: #{e}"
|
|
1704
|
+
end
|
|
1705
|
+
```
|
|
1706
|
+
|
|
1707
|
+
### Parameters
|
|
1708
|
+
|
|
1709
|
+
| Name | Type | Description | Notes |
|
|
1710
|
+
| ---- | ---- | ----------- | ----- |
|
|
1711
|
+
| **ownership_account_id** | **Integer** | | |
|
|
1712
|
+
| **transaction_id** | **Integer** | | |
|
|
1713
|
+
|
|
1714
|
+
### Return type
|
|
1715
|
+
|
|
1716
|
+
[**OwnershipAccountChargeRecurringTransactionMessage**](OwnershipAccountChargeRecurringTransactionMessage.md)
|
|
1717
|
+
|
|
1718
|
+
### Authorization
|
|
1719
|
+
|
|
1720
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
1721
|
+
|
|
1722
|
+
### HTTP request headers
|
|
1723
|
+
|
|
1724
|
+
- **Content-Type**: Not defined
|
|
1725
|
+
- **Accept**: application/json
|
|
1726
|
+
|
|
1727
|
+
|
|
1728
|
+
## get_recurring_ownership_account_payments_by_id
|
|
1729
|
+
|
|
1730
|
+
> <OwnershipAccountRecurringPaymentMessage> get_recurring_ownership_account_payments_by_id(ownership_account_id, payment_id)
|
|
1731
|
+
|
|
1732
|
+
Retrieve a recurring payment
|
|
1733
|
+
|
|
1734
|
+
Retrieves a recurring payment. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View`
|
|
1735
|
+
|
|
1736
|
+
### Examples
|
|
1737
|
+
|
|
1738
|
+
```ruby
|
|
1739
|
+
require 'time'
|
|
1740
|
+
require 'buildium-ruby'
|
|
1741
|
+
# setup authorization
|
|
1742
|
+
Buildium.configure do |config|
|
|
1743
|
+
# Configure API key authorization: clientId
|
|
1744
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
1745
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1746
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
1747
|
+
|
|
1748
|
+
# Configure API key authorization: clientSecret
|
|
1749
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
1750
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1751
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
1752
|
+
end
|
|
1753
|
+
|
|
1754
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
1755
|
+
ownership_account_id = 56 # Integer |
|
|
1756
|
+
payment_id = 56 # Integer |
|
|
1757
|
+
|
|
1758
|
+
begin
|
|
1759
|
+
# Retrieve a recurring payment
|
|
1760
|
+
result = api_instance.get_recurring_ownership_account_payments_by_id(ownership_account_id, payment_id)
|
|
1761
|
+
p result
|
|
1762
|
+
rescue Buildium::ApiError => e
|
|
1763
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_recurring_ownership_account_payments_by_id: #{e}"
|
|
1764
|
+
end
|
|
1765
|
+
```
|
|
1766
|
+
|
|
1767
|
+
#### Using the get_recurring_ownership_account_payments_by_id_with_http_info variant
|
|
1768
|
+
|
|
1769
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1770
|
+
|
|
1771
|
+
> <Array(<OwnershipAccountRecurringPaymentMessage>, Integer, Hash)> get_recurring_ownership_account_payments_by_id_with_http_info(ownership_account_id, payment_id)
|
|
1772
|
+
|
|
1773
|
+
```ruby
|
|
1774
|
+
begin
|
|
1775
|
+
# Retrieve a recurring payment
|
|
1776
|
+
data, status_code, headers = api_instance.get_recurring_ownership_account_payments_by_id_with_http_info(ownership_account_id, payment_id)
|
|
1777
|
+
p status_code # => 2xx
|
|
1778
|
+
p headers # => { ... }
|
|
1779
|
+
p data # => <OwnershipAccountRecurringPaymentMessage>
|
|
1780
|
+
rescue Buildium::ApiError => e
|
|
1781
|
+
puts "Error when calling AssociationOwnershipAccountsApi->get_recurring_ownership_account_payments_by_id_with_http_info: #{e}"
|
|
1782
|
+
end
|
|
1783
|
+
```
|
|
1784
|
+
|
|
1785
|
+
### Parameters
|
|
1786
|
+
|
|
1787
|
+
| Name | Type | Description | Notes |
|
|
1788
|
+
| ---- | ---- | ----------- | ----- |
|
|
1789
|
+
| **ownership_account_id** | **Integer** | | |
|
|
1790
|
+
| **payment_id** | **Integer** | | |
|
|
1791
|
+
|
|
1792
|
+
### Return type
|
|
1793
|
+
|
|
1794
|
+
[**OwnershipAccountRecurringPaymentMessage**](OwnershipAccountRecurringPaymentMessage.md)
|
|
1795
|
+
|
|
1796
|
+
### Authorization
|
|
1797
|
+
|
|
1798
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
1799
|
+
|
|
1800
|
+
### HTTP request headers
|
|
1801
|
+
|
|
1802
|
+
- **Content-Type**: Not defined
|
|
1803
|
+
- **Accept**: application/json
|
|
1804
|
+
|
|
1805
|
+
|
|
1806
|
+
## update_association_ownership_account
|
|
1807
|
+
|
|
1808
|
+
> <AssociationOwnershipAccountMessage> update_association_ownership_account(ownership_account_id, association_ownership_account_put_message)
|
|
1809
|
+
|
|
1810
|
+
Update an ownership account
|
|
1811
|
+
|
|
1812
|
+
Updates an ownership account. <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 > Ownership accounts</span> - `View` `Edit`
|
|
1813
|
+
|
|
1814
|
+
### Examples
|
|
1815
|
+
|
|
1816
|
+
```ruby
|
|
1817
|
+
require 'time'
|
|
1818
|
+
require 'buildium-ruby'
|
|
1819
|
+
# setup authorization
|
|
1820
|
+
Buildium.configure do |config|
|
|
1821
|
+
# Configure API key authorization: clientId
|
|
1822
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
1823
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1824
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
1825
|
+
|
|
1826
|
+
# Configure API key authorization: clientSecret
|
|
1827
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
1828
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1829
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
1830
|
+
end
|
|
1831
|
+
|
|
1832
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
1833
|
+
ownership_account_id = 56 # Integer |
|
|
1834
|
+
association_ownership_account_put_message = Buildium::AssociationOwnershipAccountPutMessage.new({date_of_purchase: Date.today}) # AssociationOwnershipAccountPutMessage |
|
|
1835
|
+
|
|
1836
|
+
begin
|
|
1837
|
+
# Update an ownership account
|
|
1838
|
+
result = api_instance.update_association_ownership_account(ownership_account_id, association_ownership_account_put_message)
|
|
1839
|
+
p result
|
|
1840
|
+
rescue Buildium::ApiError => e
|
|
1841
|
+
puts "Error when calling AssociationOwnershipAccountsApi->update_association_ownership_account: #{e}"
|
|
1842
|
+
end
|
|
1843
|
+
```
|
|
1844
|
+
|
|
1845
|
+
#### Using the update_association_ownership_account_with_http_info variant
|
|
1846
|
+
|
|
1847
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1848
|
+
|
|
1849
|
+
> <Array(<AssociationOwnershipAccountMessage>, Integer, Hash)> update_association_ownership_account_with_http_info(ownership_account_id, association_ownership_account_put_message)
|
|
1850
|
+
|
|
1851
|
+
```ruby
|
|
1852
|
+
begin
|
|
1853
|
+
# Update an ownership account
|
|
1854
|
+
data, status_code, headers = api_instance.update_association_ownership_account_with_http_info(ownership_account_id, association_ownership_account_put_message)
|
|
1855
|
+
p status_code # => 2xx
|
|
1856
|
+
p headers # => { ... }
|
|
1857
|
+
p data # => <AssociationOwnershipAccountMessage>
|
|
1858
|
+
rescue Buildium::ApiError => e
|
|
1859
|
+
puts "Error when calling AssociationOwnershipAccountsApi->update_association_ownership_account_with_http_info: #{e}"
|
|
1860
|
+
end
|
|
1861
|
+
```
|
|
1862
|
+
|
|
1863
|
+
### Parameters
|
|
1864
|
+
|
|
1865
|
+
| Name | Type | Description | Notes |
|
|
1866
|
+
| ---- | ---- | ----------- | ----- |
|
|
1867
|
+
| **ownership_account_id** | **Integer** | | |
|
|
1868
|
+
| **association_ownership_account_put_message** | [**AssociationOwnershipAccountPutMessage**](AssociationOwnershipAccountPutMessage.md) | | |
|
|
1869
|
+
|
|
1870
|
+
### Return type
|
|
1871
|
+
|
|
1872
|
+
[**AssociationOwnershipAccountMessage**](AssociationOwnershipAccountMessage.md)
|
|
1873
|
+
|
|
1874
|
+
### Authorization
|
|
1875
|
+
|
|
1876
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
1877
|
+
|
|
1878
|
+
### HTTP request headers
|
|
1879
|
+
|
|
1880
|
+
- **Content-Type**: application/json
|
|
1881
|
+
- **Accept**: application/json
|
|
1882
|
+
|
|
1883
|
+
|
|
1884
|
+
## update_association_ownership_account_note
|
|
1885
|
+
|
|
1886
|
+
> <NoteMessage> update_association_ownership_account_note(ownership_account_id, note_id, note_put_message)
|
|
1887
|
+
|
|
1888
|
+
Update a note
|
|
1889
|
+
|
|
1890
|
+
Updates an association ownership account 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 > Ownership Accounts</span> - `View` `Edit`
|
|
1891
|
+
|
|
1892
|
+
### Examples
|
|
1893
|
+
|
|
1894
|
+
```ruby
|
|
1895
|
+
require 'time'
|
|
1896
|
+
require 'buildium-ruby'
|
|
1897
|
+
# setup authorization
|
|
1898
|
+
Buildium.configure do |config|
|
|
1899
|
+
# Configure API key authorization: clientId
|
|
1900
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
1901
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1902
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
1903
|
+
|
|
1904
|
+
# Configure API key authorization: clientSecret
|
|
1905
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
1906
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1907
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
1908
|
+
end
|
|
1909
|
+
|
|
1910
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
1911
|
+
ownership_account_id = 56 # Integer |
|
|
1912
|
+
note_id = 56 # Integer |
|
|
1913
|
+
note_put_message = Buildium::NotePutMessage.new({note: 'note_example'}) # NotePutMessage |
|
|
1914
|
+
|
|
1915
|
+
begin
|
|
1916
|
+
# Update a note
|
|
1917
|
+
result = api_instance.update_association_ownership_account_note(ownership_account_id, note_id, note_put_message)
|
|
1918
|
+
p result
|
|
1919
|
+
rescue Buildium::ApiError => e
|
|
1920
|
+
puts "Error when calling AssociationOwnershipAccountsApi->update_association_ownership_account_note: #{e}"
|
|
1921
|
+
end
|
|
1922
|
+
```
|
|
1923
|
+
|
|
1924
|
+
#### Using the update_association_ownership_account_note_with_http_info variant
|
|
1925
|
+
|
|
1926
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1927
|
+
|
|
1928
|
+
> <Array(<NoteMessage>, Integer, Hash)> update_association_ownership_account_note_with_http_info(ownership_account_id, note_id, note_put_message)
|
|
1929
|
+
|
|
1930
|
+
```ruby
|
|
1931
|
+
begin
|
|
1932
|
+
# Update a note
|
|
1933
|
+
data, status_code, headers = api_instance.update_association_ownership_account_note_with_http_info(ownership_account_id, note_id, note_put_message)
|
|
1934
|
+
p status_code # => 2xx
|
|
1935
|
+
p headers # => { ... }
|
|
1936
|
+
p data # => <NoteMessage>
|
|
1937
|
+
rescue Buildium::ApiError => e
|
|
1938
|
+
puts "Error when calling AssociationOwnershipAccountsApi->update_association_ownership_account_note_with_http_info: #{e}"
|
|
1939
|
+
end
|
|
1940
|
+
```
|
|
1941
|
+
|
|
1942
|
+
### Parameters
|
|
1943
|
+
|
|
1944
|
+
| Name | Type | Description | Notes |
|
|
1945
|
+
| ---- | ---- | ----------- | ----- |
|
|
1946
|
+
| **ownership_account_id** | **Integer** | | |
|
|
1947
|
+
| **note_id** | **Integer** | | |
|
|
1948
|
+
| **note_put_message** | [**NotePutMessage**](NotePutMessage.md) | | |
|
|
1949
|
+
|
|
1950
|
+
### Return type
|
|
1951
|
+
|
|
1952
|
+
[**NoteMessage**](NoteMessage.md)
|
|
1953
|
+
|
|
1954
|
+
### Authorization
|
|
1955
|
+
|
|
1956
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
1957
|
+
|
|
1958
|
+
### HTTP request headers
|
|
1959
|
+
|
|
1960
|
+
- **Content-Type**: application/json
|
|
1961
|
+
- **Accept**: application/json
|
|
1962
|
+
|
|
1963
|
+
|
|
1964
|
+
## update_ownership_account_charge
|
|
1965
|
+
|
|
1966
|
+
> <OwnershipAccountTransactionMessage> update_ownership_account_charge(ownership_account_id, charge_id, ownership_account_ledger_charge_put_message)
|
|
1967
|
+
|
|
1968
|
+
Update a charge
|
|
1969
|
+
|
|
1970
|
+
Updates a charge. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Associations > Ownership account transactions</span> - `View` `Edit` <br />
|
|
1971
|
+
|
|
1972
|
+
### Examples
|
|
1973
|
+
|
|
1974
|
+
```ruby
|
|
1975
|
+
require 'time'
|
|
1976
|
+
require 'buildium-ruby'
|
|
1977
|
+
# setup authorization
|
|
1978
|
+
Buildium.configure do |config|
|
|
1979
|
+
# Configure API key authorization: clientId
|
|
1980
|
+
config.api_key['clientId'] = 'YOUR API KEY'
|
|
1981
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1982
|
+
# config.api_key_prefix['clientId'] = 'Bearer'
|
|
1983
|
+
|
|
1984
|
+
# Configure API key authorization: clientSecret
|
|
1985
|
+
config.api_key['clientSecret'] = 'YOUR API KEY'
|
|
1986
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1987
|
+
# config.api_key_prefix['clientSecret'] = 'Bearer'
|
|
1988
|
+
end
|
|
1989
|
+
|
|
1990
|
+
api_instance = Buildium::AssociationOwnershipAccountsApi.new
|
|
1991
|
+
ownership_account_id = 56 # Integer | The ownership account identifier.
|
|
1992
|
+
charge_id = 56 # Integer | The charge identifier.
|
|
1993
|
+
ownership_account_ledger_charge_put_message = Buildium::OwnershipAccountLedgerChargePutMessage.new({date: Date.today, lines: [Buildium::OwnershipAccountLedgerChargeLinesPutMessage.new({amount: 3.56, gl_account_id: 37})]}) # OwnershipAccountLedgerChargePutMessage |
|
|
1994
|
+
|
|
1995
|
+
begin
|
|
1996
|
+
# Update a charge
|
|
1997
|
+
result = api_instance.update_ownership_account_charge(ownership_account_id, charge_id, ownership_account_ledger_charge_put_message)
|
|
1998
|
+
p result
|
|
1999
|
+
rescue Buildium::ApiError => e
|
|
2000
|
+
puts "Error when calling AssociationOwnershipAccountsApi->update_ownership_account_charge: #{e}"
|
|
2001
|
+
end
|
|
2002
|
+
```
|
|
2003
|
+
|
|
2004
|
+
#### Using the update_ownership_account_charge_with_http_info variant
|
|
2005
|
+
|
|
2006
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2007
|
+
|
|
2008
|
+
> <Array(<OwnershipAccountTransactionMessage>, Integer, Hash)> update_ownership_account_charge_with_http_info(ownership_account_id, charge_id, ownership_account_ledger_charge_put_message)
|
|
2009
|
+
|
|
2010
|
+
```ruby
|
|
2011
|
+
begin
|
|
2012
|
+
# Update a charge
|
|
2013
|
+
data, status_code, headers = api_instance.update_ownership_account_charge_with_http_info(ownership_account_id, charge_id, ownership_account_ledger_charge_put_message)
|
|
2014
|
+
p status_code # => 2xx
|
|
2015
|
+
p headers # => { ... }
|
|
2016
|
+
p data # => <OwnershipAccountTransactionMessage>
|
|
2017
|
+
rescue Buildium::ApiError => e
|
|
2018
|
+
puts "Error when calling AssociationOwnershipAccountsApi->update_ownership_account_charge_with_http_info: #{e}"
|
|
2019
|
+
end
|
|
2020
|
+
```
|
|
2021
|
+
|
|
2022
|
+
### Parameters
|
|
2023
|
+
|
|
2024
|
+
| Name | Type | Description | Notes |
|
|
2025
|
+
| ---- | ---- | ----------- | ----- |
|
|
2026
|
+
| **ownership_account_id** | **Integer** | The ownership account identifier. | |
|
|
2027
|
+
| **charge_id** | **Integer** | The charge identifier. | |
|
|
2028
|
+
| **ownership_account_ledger_charge_put_message** | [**OwnershipAccountLedgerChargePutMessage**](OwnershipAccountLedgerChargePutMessage.md) | | |
|
|
2029
|
+
|
|
2030
|
+
### Return type
|
|
2031
|
+
|
|
2032
|
+
[**OwnershipAccountTransactionMessage**](OwnershipAccountTransactionMessage.md)
|
|
2033
|
+
|
|
2034
|
+
### Authorization
|
|
2035
|
+
|
|
2036
|
+
[clientId](../README.md#clientId), [clientSecret](../README.md#clientSecret)
|
|
2037
|
+
|
|
2038
|
+
### HTTP request headers
|
|
2039
|
+
|
|
2040
|
+
- **Content-Type**: application/json
|
|
2041
|
+
- **Accept**: application/json
|
|
2042
|
+
|