buildium-ruby 2.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.github/workflows/ci.yml +27 -0
- data/.github/workflows/publish.yml +48 -0
- data/.gitignore +39 -0
- data/.openapi-generator/FILES +1215 -0
- data/.openapi-generator/VERSION +1 -0
- data/.openapi-generator/templates/ruby-client/gemspec.mustache +37 -0
- data/.openapi-generator/templates/ruby-client/partial_model_generic.mustache +371 -0
- data/.openapi-generator/templates/ruby-client/rubocop.mustache +124 -0
- data/.openapi-generator-ignore +26 -0
- data/.rspec +2 -0
- data/.rubocop.yml +124 -0
- data/CUSTOMIZATIONS.md +11 -0
- data/DOCS.md +811 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +75 -0
- data/README.md +118 -0
- data/Rakefile +10 -0
- data/bin/CUSTOMIZATIONS.md +11 -0
- data/bin/README.md +118 -0
- data/bin/config.yml +9 -0
- data/bin/rebuild.sh +49 -0
- data/bin/swagger.json +52218 -0
- data/buildium-ruby.gemspec +39 -0
- data/docs/AccountInfoMessage.md +26 -0
- data/docs/AccountingApi.md +2041 -0
- data/docs/AccountingEntityMessage.md +22 -0
- data/docs/AccountingEntitySaveMessage.md +20 -0
- data/docs/AccountingLockPeriodMessage.md +22 -0
- data/docs/AccountingSettingsMessage.md +28 -0
- data/docs/AddressMessage.md +30 -0
- data/docs/AdministrationApi.md +485 -0
- data/docs/AllTasksMessage.md +46 -0
- data/docs/AnnouncementMessage.md +30 -0
- data/docs/AnnouncementPostMessage.md +28 -0
- data/docs/AnnouncementSearchMessage.md +26 -0
- data/docs/AnnouncementSenderMessage.md +22 -0
- data/docs/ApiError.md +20 -0
- data/docs/ApiErrorResponse.md +22 -0
- data/docs/ApplianceMessage.md +26 -0
- data/docs/ApplicantApplicationMessage.md +24 -0
- data/docs/ApplicantGroupMessage.md +26 -0
- data/docs/ApplicantGroupPostMessage.md +20 -0
- data/docs/ApplicantGroupPutMessage.md +22 -0
- data/docs/ApplicantGroupSearchMessage.md +26 -0
- data/docs/ApplicantMessage.md +36 -0
- data/docs/ApplicantPostMessage.md +28 -0
- data/docs/ApplicantPutMessage.md +26 -0
- data/docs/ApplicantSearchMessage.md +32 -0
- data/docs/ApplicantsApi.md +1489 -0
- data/docs/ApplicationMessage.md +26 -0
- data/docs/ApplicationPutMessage.md +18 -0
- data/docs/ApplicationResponseFieldMessage.md +24 -0
- data/docs/ApplicationResponseMessage.md +22 -0
- data/docs/ApplicationSectionResponseMessage.md +18 -0
- data/docs/AssociationApplianceMessage.md +32 -0
- data/docs/AssociationAppliancePostMessage.md +32 -0
- data/docs/AssociationAppliancePutMessage.md +28 -0
- data/docs/AssociationApplianceSearchMessage.md +20 -0
- data/docs/AssociationApplianceServiceHistoryMessage.md +24 -0
- data/docs/AssociationApplianceServiceHistoryPostMessage.md +22 -0
- data/docs/AssociationAppliancesApi.md +646 -0
- data/docs/AssociationBoardMemberMessage.md +36 -0
- data/docs/AssociationBoardMemberPostMessage.md +24 -0
- data/docs/AssociationBoardMemberPutMessage.md +22 -0
- data/docs/AssociationBoardMemberSearchMessage.md +24 -0
- data/docs/AssociationMessage.md +40 -0
- data/docs/AssociationOwnerBoardTermMessage.md +28 -0
- data/docs/AssociationOwnerBoardTermPostMessage.md +22 -0
- data/docs/AssociationOwnerMessage.md +52 -0
- data/docs/AssociationOwnerPostMessage.md +44 -0
- data/docs/AssociationOwnerPutMessage.md +38 -0
- data/docs/AssociationOwnerToExistingOwnershipAccountPostMessage.md +48 -0
- data/docs/AssociationOwnerUnitOccupancyPutMessage.md +18 -0
- data/docs/AssociationOwnerUnitOccupancyStatusMessage.md +20 -0
- data/docs/AssociationOwnersApi.md +916 -0
- data/docs/AssociationOwnershipAccountMessage.md +34 -0
- data/docs/AssociationOwnershipAccountPostMessage.md +32 -0
- data/docs/AssociationOwnershipAccountPutMessage.md +18 -0
- data/docs/AssociationOwnershipAccountSearchMessage.md +28 -0
- data/docs/AssociationOwnershipAccountsApi.md +2042 -0
- data/docs/AssociationPostMessage.md +32 -0
- data/docs/AssociationPreferredVendorMessage.md +34 -0
- data/docs/AssociationPreferredVendorPutMessage.md +18 -0
- data/docs/AssociationPutMessage.md +34 -0
- data/docs/AssociationSearchMessage.md +24 -0
- data/docs/AssociationTenantMessage.md +44 -0
- data/docs/AssociationTenantPostMessage.md +42 -0
- data/docs/AssociationTenantPutMessage.md +38 -0
- data/docs/AssociationTenantsApi.md +671 -0
- data/docs/AssociationUnitMessage.md +32 -0
- data/docs/AssociationUnitPutMessage.md +26 -0
- data/docs/AssociationUnitSearchMessage.md +22 -0
- data/docs/AssociationUnitsApi.md +659 -0
- data/docs/AssociationUnitsPostMessage.md +28 -0
- data/docs/AssociationUserSearchMessage.md +34 -0
- data/docs/AssociationsApi.md +1235 -0
- data/docs/BankAccountCheckAccountingEntitySaveMessage.md +20 -0
- data/docs/BankAccountCheckLineMessage.md +28 -0
- data/docs/BankAccountCheckLineSaveMessage.md +26 -0
- data/docs/BankAccountCheckMessage.md +30 -0
- data/docs/BankAccountCheckPayeeMessage.md +22 -0
- data/docs/BankAccountCheckPayeeSaveMessage.md +20 -0
- data/docs/BankAccountCheckPostMessage.md +26 -0
- data/docs/BankAccountCheckPutMessage.md +26 -0
- data/docs/BankAccountCheckSearchMessage.md +20 -0
- data/docs/BankAccountDepositLineMessage.md +28 -0
- data/docs/BankAccountDepositLineSaveMessage.md +26 -0
- data/docs/BankAccountDepositMessage.md +28 -0
- data/docs/BankAccountDepositPostMessage.md +24 -0
- data/docs/BankAccountDepositPutMessage.md +22 -0
- data/docs/BankAccountDepositSearchMessage.md +20 -0
- data/docs/BankAccountMessage.md +40 -0
- data/docs/BankAccountPostMessage.md +30 -0
- data/docs/BankAccountPutMessage.md +30 -0
- data/docs/BankAccountQuickDepositMessage.md +28 -0
- data/docs/BankAccountQuickDepositSaveMessage.md +26 -0
- data/docs/BankAccountQuickDepositSearchMessage.md +20 -0
- data/docs/BankAccountSearchMessage.md +20 -0
- data/docs/BankAccountTransactionMessage.md +36 -0
- data/docs/BankAccountTransactionSearchMessage.md +24 -0
- data/docs/BankAccountTransferAccountingEntitySaveMessage.md +20 -0
- data/docs/BankAccountTransferMessage.md +28 -0
- data/docs/BankAccountTransferSaveMessage.md +26 -0
- data/docs/BankAccountTransferSearchMessage.md +20 -0
- data/docs/BankAccountWithdrawalMessage.md +28 -0
- data/docs/BankAccountWithdrawalSaveMessage.md +26 -0
- data/docs/BankAccountWithdrawalSearchMessage.md +20 -0
- data/docs/BankAccountsApi.md +2224 -0
- data/docs/BillFileMessage.md +28 -0
- data/docs/BillLineMessage.md +28 -0
- data/docs/BillLinePostMessage.md +26 -0
- data/docs/BillLinePutMessage.md +28 -0
- data/docs/BillMarkupMessage.md +20 -0
- data/docs/BillMarkupSaveMessage.md +20 -0
- data/docs/BillMessage.md +36 -0
- data/docs/BillPaymentAccountingEntityMessage.md +20 -0
- data/docs/BillPaymentLineMessage.md +22 -0
- data/docs/BillPaymentLinePostMessage.md +20 -0
- data/docs/BillPaymentMessage.md +28 -0
- data/docs/BillPaymentPostMessage.md +26 -0
- data/docs/BillPostMessage.md +30 -0
- data/docs/BillPutMessage.md +28 -0
- data/docs/BillSearchMessage.md +32 -0
- data/docs/BudgetDetailsMessage.md +24 -0
- data/docs/BudgetDetailsSaveMessage.md +20 -0
- data/docs/BudgetMessage.md +28 -0
- data/docs/BudgetMonthlyAmountsMessage.md +40 -0
- data/docs/BudgetMonthlyAmountsSaveMessage.md +40 -0
- data/docs/BudgetPostMessage.md +26 -0
- data/docs/BudgetPutMessage.md +20 -0
- data/docs/BudgetSearchMessage.md +22 -0
- data/docs/ChargeRecurringTransactionPostMessage.md +32 -0
- data/docs/ChargeRecurringTransactionPutMessage.md +34 -0
- data/docs/CheckPrintingInfoMessage.md +46 -0
- data/docs/CheckPrintingInfoPostMessage.md +46 -0
- data/docs/CheckPrintingInfoPutMessage.md +46 -0
- data/docs/ClientLeadCreditRequestMessage.md +24 -0
- data/docs/ClientLeadMessage.md +38 -0
- data/docs/ClientLeadSearchMessage.md +26 -0
- data/docs/ClientLeadsApi.md +177 -0
- data/docs/CommunicationsApi.md +1238 -0
- data/docs/ContactDetailMessage.md +24 -0
- data/docs/ContactDetailPhoneMessage.md +22 -0
- data/docs/ContactDetailSaveMessage.md +24 -0
- data/docs/ContactDetailSavePhoneMessage.md +22 -0
- data/docs/ContactInfoMessage.md +24 -0
- data/docs/ContactRequestTaskMessage.md +42 -0
- data/docs/ContactRequestTaskPostMessage.md +38 -0
- data/docs/ContactRequestTaskPutMessage.md +38 -0
- data/docs/ContactRequestTaskSearchMessage.md +40 -0
- data/docs/CosignerMessage.md +36 -0
- data/docs/CreatedByUserMessage.md +24 -0
- data/docs/CreditRecurringTransactionPostMessage.md +36 -0
- data/docs/DepositDetailMessage.md +20 -0
- data/docs/ElectronicPaymentsMessage.md +32 -0
- data/docs/EmailMessage.md +24 -0
- data/docs/EmailPostMessage.md +30 -0
- data/docs/EmailRecipientMessage.md +26 -0
- data/docs/EmailSearchMessage.md +26 -0
- data/docs/EmailSenderMessage.md +24 -0
- data/docs/EmergencyContactMessage.md +24 -0
- data/docs/FileCategoryMessage.md +22 -0
- data/docs/FileCategoryPostMessage.md +18 -0
- data/docs/FileCategoryPutMessage.md +18 -0
- data/docs/FileDownloadMessage.md +18 -0
- data/docs/FileEntityMessage.md +22 -0
- data/docs/FileMessage.md +34 -0
- data/docs/FileNamePostMessage.md +18 -0
- data/docs/FilePutMessage.md +22 -0
- data/docs/FileSearchMessage.md +30 -0
- data/docs/FileUploadPostMessage.md +28 -0
- data/docs/FileUploadTicketMessage.md +22 -0
- data/docs/FilesApi.md +730 -0
- data/docs/GLAccountBalanceItemMessage.md +20 -0
- data/docs/GLAccountBalanceMessage.md +22 -0
- data/docs/GLAccountBalanceSearchMessage.md +26 -0
- data/docs/GLAccountMessage.md +46 -0
- data/docs/GLAccountPostMessage.md +32 -0
- data/docs/GLAccountPutMessage.md +32 -0
- data/docs/GLAccountsSearchMessage.md +18 -0
- data/docs/GLTransactionMessageV1.md +26 -0
- data/docs/GeneralJournalEntryLineSaveMessage.md +24 -0
- data/docs/GeneralJournalEntryPostMessage.md +24 -0
- data/docs/GeneralJournalEntryPutMessage.md +24 -0
- data/docs/GeneralLedgerJournalLineMessage.md +28 -0
- data/docs/GeneralLedgerJournalMessage.md +20 -0
- data/docs/GeneralLedgerTransactionMessage.md +38 -0
- data/docs/GeneralLedgerTransactionSearchMessage.md +26 -0
- data/docs/InternalTransactionStatusMessage.md +22 -0
- data/docs/JournalLineMessage.md +28 -0
- data/docs/JournalMessage.md +20 -0
- data/docs/LastUpdatedByUserMessage.md +26 -0
- data/docs/LeaseAccountDetailMessage.md +20 -0
- data/docs/LeaseChargeLineSaveMessage.md +22 -0
- data/docs/LeaseChargePostMessage.md +22 -0
- data/docs/LeaseChargePutMessage.md +22 -0
- data/docs/LeaseChargeRecurringTransactionMessage.md +40 -0
- data/docs/LeaseCosignerPostMessage.md +32 -0
- data/docs/LeaseLedgerCreditLinePostMessage.md +20 -0
- data/docs/LeaseLedgerCreditPostMessage.md +26 -0
- data/docs/LeaseLedgerDepositWithholdingLinePostMessage.md +20 -0
- data/docs/LeaseLedgerDepositWithholdingPostMessage.md +24 -0
- data/docs/LeaseLedgerPaymentLineSaveMessage.md +20 -0
- data/docs/LeaseLedgerPaymentPostMessage.md +30 -0
- data/docs/LeaseLedgerRefundLineMessage.md +20 -0
- data/docs/LeaseLedgerRefundLinePostMessage.md +20 -0
- data/docs/LeaseLedgerRefundMessage.md +34 -0
- data/docs/LeaseLedgerRefundPostMessage.md +30 -0
- data/docs/LeaseLedgerReversePaymentNSFChargePostMessage.md +20 -0
- data/docs/LeaseLedgerReversePaymentOtherBankChargePostMessage.md +20 -0
- data/docs/LeaseLedgerReversePaymentPostMessage.md +24 -0
- data/docs/LeaseMessage.md +58 -0
- data/docs/LeaseMoveOutDataMessage.md +22 -0
- data/docs/LeaseMoveOutDataPostMessage.md +22 -0
- data/docs/LeaseOutstandingBalanceMessage.md +40 -0
- data/docs/LeaseOutstandingBalanceSearchMessage.md +30 -0
- data/docs/LeasePostMessage.md +38 -0
- data/docs/LeasePutMessage.md +28 -0
- data/docs/LeaseRecurringCreditMessage.md +44 -0
- data/docs/LeaseRecurringPaymentMessage.md +42 -0
- data/docs/LeaseRenewalMessage.md +32 -0
- data/docs/LeaseRenewalPostMessage.md +38 -0
- data/docs/LeaseRentChargeMessage.md +30 -0
- data/docs/LeaseRentChargePostMessage.md +24 -0
- data/docs/LeaseRentMessage.md +34 -0
- data/docs/LeaseRentPostMessage.md +20 -0
- data/docs/LeaseSearchMessage.md +40 -0
- data/docs/LeaseSecurityDepositPostMessage.md +20 -0
- data/docs/LeaseTenantMessage.md +20 -0
- data/docs/LeaseTransactionMessage.md +34 -0
- data/docs/LeaseTransactionSearchMessage.md +22 -0
- data/docs/LeasesApi.md +2865 -0
- data/docs/ListingContactMessage.md +26 -0
- data/docs/ListingContactSaveMessage.md +24 -0
- data/docs/ListingFileMessage.md +22 -0
- data/docs/ListingMessage.md +36 -0
- data/docs/ListingPropertyMessage.md +34 -0
- data/docs/ListingPutMessage.md +28 -0
- data/docs/ListingSearchMessage.md +20 -0
- data/docs/ListingUnitMessage.md +36 -0
- data/docs/ListingsApi.md +642 -0
- data/docs/LockPeriodSettingsGlobalMessage.md +18 -0
- data/docs/LockPeriodSettingsOverridesMessage.md +20 -0
- data/docs/LoggedByStaffUserMessage.md +24 -0
- data/docs/LookupMessage.md +20 -0
- data/docs/MailingTemplateMessage.md +24 -0
- data/docs/NoteMessage.md +22 -0
- data/docs/NotePostMessage.md +18 -0
- data/docs/NotePutMessage.md +18 -0
- data/docs/NoteSearchMessage.md +22 -0
- data/docs/OutstandingBalancesLineMessage.md +20 -0
- data/docs/OwnershipAccountChargeRecurringTransactionMessage.md +40 -0
- data/docs/OwnershipAccountCreditLinePostMessage.md +20 -0
- data/docs/OwnershipAccountCreditPostMessage.md +26 -0
- data/docs/OwnershipAccountDepositWithholdingLinePostMessage.md +20 -0
- data/docs/OwnershipAccountDepositWithholdingPostMessage.md +24 -0
- data/docs/OwnershipAccountLedgerChargeLinesPutMessage.md +22 -0
- data/docs/OwnershipAccountLedgerChargeLinesSaveMessage.md +20 -0
- data/docs/OwnershipAccountLedgerChargePostMessage.md +22 -0
- data/docs/OwnershipAccountLedgerChargePutMessage.md +22 -0
- data/docs/OwnershipAccountLedgerPaymentLineSaveMessage.md +20 -0
- data/docs/OwnershipAccountLedgerPaymentPostMessage.md +30 -0
- data/docs/OwnershipAccountOutstandingBalanceMessage.md +36 -0
- data/docs/OwnershipAccountOutstandingBalanceSearchMessage.md +26 -0
- data/docs/OwnershipAccountRecurringCreditMessage.md +44 -0
- data/docs/OwnershipAccountRecurringPaymentMessage.md +42 -0
- data/docs/OwnershipAccountRefundLineMessage.md +20 -0
- data/docs/OwnershipAccountRefundLinesPostMessage.md +20 -0
- data/docs/OwnershipAccountRefundMessage.md +34 -0
- data/docs/OwnershipAccountRefundPostMessage.md +30 -0
- data/docs/OwnershipAccountTransactionMessage.md +34 -0
- data/docs/PaidByMessage.md +20 -0
- data/docs/ParticipantMessage.md +22 -0
- data/docs/ParticipantResourceMessage.md +20 -0
- data/docs/PayeeMessage.md +24 -0
- data/docs/PaymentDetailMessage.md +24 -0
- data/docs/PaymentRecurringTransactionPostMessage.md +34 -0
- data/docs/PaymentTransactionsMessage.md +22 -0
- data/docs/PhoneLogMessage.md +28 -0
- data/docs/PhoneLogParticipantPostMessage.md +22 -0
- data/docs/PhoneLogParticipantUnitAgreementPostMessage.md +20 -0
- data/docs/PhoneLogPostMessage.md +24 -0
- data/docs/PhoneLogPutMessage.md +22 -0
- data/docs/PhoneLogSearchMessage.md +32 -0
- data/docs/PhoneNumberMessage.md +20 -0
- data/docs/PhoneNumbersMessage.md +24 -0
- data/docs/PropertyGroupMessage.md +26 -0
- data/docs/PropertyGroupPostMessage.md +22 -0
- data/docs/PropertyGroupPutMessage.md +22 -0
- data/docs/PropertyGroupSearchMessage.md +20 -0
- data/docs/PropertyGroupsApi.md +327 -0
- data/docs/PropertyManagerMessage.md +32 -0
- data/docs/PropertyMessage.md +22 -0
- data/docs/RecurringTransactionLineMessage.md +20 -0
- data/docs/RecurringTransactionLinePostMessage.md +20 -0
- data/docs/RecurringTransactionMessage.md +40 -0
- data/docs/RentalApplianceMessage.md +32 -0
- data/docs/RentalAppliancePostMessage.md +32 -0
- data/docs/RentalAppliancePutMessage.md +28 -0
- data/docs/RentalApplianceSearchMessage.md +20 -0
- data/docs/RentalApplianceServiceHistoryMessage.md +24 -0
- data/docs/RentalApplianceServiceHistoryPostMessage.md +22 -0
- data/docs/RentalAppliancesApi.md +646 -0
- data/docs/RentalFeaturesMessage.md +20 -0
- data/docs/RentalFeaturesPutMessage.md +20 -0
- data/docs/RentalMessage.md +40 -0
- data/docs/RentalOwnerMessage.md +46 -0
- data/docs/RentalOwnerPostMessage.md +44 -0
- data/docs/RentalOwnerPutMessage.md +42 -0
- data/docs/RentalOwnerRequestTaskMessage.md +42 -0
- data/docs/RentalOwnerRequestTaskPostMessage.md +38 -0
- data/docs/RentalOwnerRequestTaskPutMessage.md +36 -0
- data/docs/RentalOwnerRequestTaskSearchMessage.md +40 -0
- data/docs/RentalOwnerTaxInformationMessage.md +28 -0
- data/docs/RentalOwnersApi.md +667 -0
- data/docs/RentalOwnersSearchMessage.md +30 -0
- data/docs/RentalPreferredVendorMessage.md +34 -0
- data/docs/RentalPreferredVendorPutMessage.md +18 -0
- data/docs/RentalPropertiesApi.md +989 -0
- data/docs/RentalPropertyPostMessage.md +36 -0
- data/docs/RentalPropertyPutMessage.md +32 -0
- data/docs/RentalPropertyUnitPostMessage.md +30 -0
- data/docs/RentalSearchMessage.md +32 -0
- data/docs/RentalTenantPostMessage.md +42 -0
- data/docs/RentalTenantPutMessage.md +40 -0
- data/docs/RentalTenantRenewalPostMessage.md +40 -0
- data/docs/RentalTenantsApi.md +673 -0
- data/docs/RentalUnitFeaturesMessage.md +18 -0
- data/docs/RentalUnitFeaturesPutMessage.md +18 -0
- data/docs/RentalUnitMessage.md +40 -0
- data/docs/RentalUnitPutMessage.md +30 -0
- data/docs/RentalUnitSearchMessage.md +22 -0
- data/docs/RentalUnitsApi.md +815 -0
- data/docs/RentalUnitsPostMessage.md +32 -0
- data/docs/RequestedByUserEntityMessage.md +28 -0
- data/docs/ResidentCenterApi.md +100 -0
- data/docs/ResidentCenterUserMessage.md +24 -0
- data/docs/ResidentCenterUserReferenceMessage.md +26 -0
- data/docs/ResidentCenterUserSearchMessage.md +26 -0
- data/docs/ResidentRequestTaskMessage.md +52 -0
- data/docs/ResidentRequestTaskPostMessage.md +42 -0
- data/docs/ResidentRequestTaskPutMessage.md +32 -0
- data/docs/ResidentRequestTaskSearchMessage.md +42 -0
- data/docs/SaveAddressMessage.md +30 -0
- data/docs/SaveEmergencyContactMessage.md +24 -0
- data/docs/TaskCategoryMessage.md +24 -0
- data/docs/TaskCategoryPutMessage.md +18 -0
- data/docs/TaskCategoryResponseMessage.md +24 -0
- data/docs/TaskCategorySaveMessage.md +18 -0
- data/docs/TaskHistoryFileMessage.md +28 -0
- data/docs/TaskHistoryFileUploadPostMessage.md +18 -0
- data/docs/TaskHistoryMessage.md +40 -0
- data/docs/TaskHistoryPutMessage.md +18 -0
- data/docs/TaskHistoryUserMessage.md +24 -0
- data/docs/TaskSearchMessage.md +44 -0
- data/docs/TaskSubCategoryMessage.md +20 -0
- data/docs/TasksApi.md +2528 -0
- data/docs/TaxInformationPostMessage.md +26 -0
- data/docs/TaxInformationSaveMessage.md +28 -0
- data/docs/TenantMessage.md +48 -0
- data/docs/TenantSearchMessage.md +36 -0
- data/docs/ToDoTaskMessage.md +40 -0
- data/docs/ToDoTaskPostMessage.md +36 -0
- data/docs/ToDoTaskPutMessage.md +36 -0
- data/docs/ToDoTaskSearchMessage.md +40 -0
- data/docs/UndepositedFundsMessage.md +18 -0
- data/docs/UnitAgreementMessage.md +22 -0
- data/docs/UserMessage.md +40 -0
- data/docs/UserRoleMessage.md +24 -0
- data/docs/UserSearchMessage.md +26 -0
- data/docs/VehicleMessage.md +24 -0
- data/docs/VendorCategoryMessage.md +22 -0
- data/docs/VendorCategorySaveMessage.md +18 -0
- data/docs/VendorCreditLineItemMessage.md +26 -0
- data/docs/VendorCreditLineItemPostMessage.md +24 -0
- data/docs/VendorCreditMessage.md +26 -0
- data/docs/VendorCreditPostMessage.md +24 -0
- data/docs/VendorInsuranceMessage.md +22 -0
- data/docs/VendorInsuranceSaveMessage.md +22 -0
- data/docs/VendorMessage.md +50 -0
- data/docs/VendorPostMessage.md +46 -0
- data/docs/VendorPutMessage.md +46 -0
- data/docs/VendorRefundLineMessage.md +26 -0
- data/docs/VendorRefundLinePostMessage.md +24 -0
- data/docs/VendorRefundMessage.md +30 -0
- data/docs/VendorRefundPostMessage.md +28 -0
- data/docs/VendorSearchMessage.md +32 -0
- data/docs/VendorTaxInformationMessage.md +28 -0
- data/docs/VendorTransactionMessage.md +28 -0
- data/docs/VendorTransactionSearchMessage.md +26 -0
- data/docs/VendorsApi.md +1396 -0
- data/docs/WorkOrderEntryContactMessage.md +20 -0
- data/docs/WorkOrderEntryContactResourceMessage.md +20 -0
- data/docs/WorkOrderLineItemMessage.md +24 -0
- data/docs/WorkOrderLineItemSaveMessage.md +24 -0
- data/docs/WorkOrderMessage.md +42 -0
- data/docs/WorkOrderPostMessage.md +38 -0
- data/docs/WorkOrderPutMessage.md +34 -0
- data/docs/WorkOrderSearchMessage.md +54 -0
- data/docs/WorkOrderTaskMessage.md +32 -0
- data/docs/WorkOrderTaskPostMessage.md +30 -0
- data/docs/WorkOrdersApi.md +361 -0
- data/lib/buildium-ruby/api/accounting_api.rb +1855 -0
- data/lib/buildium-ruby/api/administration_api.rb +417 -0
- data/lib/buildium-ruby/api/applicants_api.rb +1368 -0
- data/lib/buildium-ruby/api/association_appliances_api.rb +577 -0
- data/lib/buildium-ruby/api/association_owners_api.rb +849 -0
- data/lib/buildium-ruby/api/association_ownership_accounts_api.rb +1890 -0
- data/lib/buildium-ruby/api/association_tenants_api.rb +628 -0
- data/lib/buildium-ruby/api/association_units_api.rb +606 -0
- data/lib/buildium-ruby/api/associations_api.rb +1143 -0
- data/lib/buildium-ruby/api/bank_accounts_api.rb +2085 -0
- data/lib/buildium-ruby/api/client_leads_api.rb +174 -0
- data/lib/buildium-ruby/api/communications_api.rb +1097 -0
- data/lib/buildium-ruby/api/files_api.rb +652 -0
- data/lib/buildium-ruby/api/leases_api.rb +2636 -0
- data/lib/buildium-ruby/api/listings_api.rb +569 -0
- data/lib/buildium-ruby/api/property_groups_api.rb +299 -0
- data/lib/buildium-ruby/api/rental_appliances_api.rb +577 -0
- data/lib/buildium-ruby/api/rental_owners_api.rb +622 -0
- data/lib/buildium-ruby/api/rental_properties_api.rb +916 -0
- data/lib/buildium-ruby/api/rental_tenants_api.rb +635 -0
- data/lib/buildium-ruby/api/rental_units_api.rb +743 -0
- data/lib/buildium-ruby/api/resident_center_api.rb +111 -0
- data/lib/buildium-ruby/api/tasks_api.rb +2363 -0
- data/lib/buildium-ruby/api/vendors_api.rb +1285 -0
- data/lib/buildium-ruby/api/work_orders_api.rb +366 -0
- data/lib/buildium-ruby/api_client.rb +426 -0
- data/lib/buildium-ruby/api_error.rb +57 -0
- data/lib/buildium-ruby/configuration.rb +319 -0
- data/lib/buildium-ruby/models/account_info_message.rb +257 -0
- data/lib/buildium-ruby/models/accounting_entity_message.rb +273 -0
- data/lib/buildium-ruby/models/accounting_entity_save_message.rb +273 -0
- data/lib/buildium-ruby/models/accounting_lock_period_message.rb +242 -0
- data/lib/buildium-ruby/models/accounting_settings_message.rb +314 -0
- data/lib/buildium-ruby/models/address_message.rb +313 -0
- data/lib/buildium-ruby/models/all_tasks_message.rb +413 -0
- data/lib/buildium-ruby/models/announcement_message.rb +301 -0
- data/lib/buildium-ruby/models/announcement_post_message.rb +295 -0
- data/lib/buildium-ruby/models/announcement_search_message.rb +292 -0
- data/lib/buildium-ruby/models/announcement_sender_message.rb +239 -0
- data/lib/buildium-ruby/models/api_error_response.rb +237 -0
- data/lib/buildium-ruby/models/appliance_message.rb +259 -0
- data/lib/buildium-ruby/models/applicant_application_message.rb +282 -0
- data/lib/buildium-ruby/models/applicant_group_message.rb +294 -0
- data/lib/buildium-ruby/models/applicant_group_post_message.rb +235 -0
- data/lib/buildium-ruby/models/applicant_group_put_message.rb +284 -0
- data/lib/buildium-ruby/models/applicant_group_search_message.rb +296 -0
- data/lib/buildium-ruby/models/applicant_message.rb +312 -0
- data/lib/buildium-ruby/models/applicant_post_message.rb +283 -0
- data/lib/buildium-ruby/models/applicant_put_message.rb +267 -0
- data/lib/buildium-ruby/models/applicant_search_message.rb +326 -0
- data/lib/buildium-ruby/models/application_message.rb +294 -0
- data/lib/buildium-ruby/models/application_put_message.rb +257 -0
- data/lib/buildium-ruby/models/application_response_field_message.rb +294 -0
- data/lib/buildium-ruby/models/application_response_message.rb +274 -0
- data/lib/buildium-ruby/models/application_section_response_message.rb +219 -0
- data/lib/buildium-ruby/models/association_appliance_message.rb +288 -0
- data/lib/buildium-ruby/models/association_appliance_post_message.rb +298 -0
- data/lib/buildium-ruby/models/association_appliance_put_message.rb +273 -0
- data/lib/buildium-ruby/models/association_appliance_search_message.rb +232 -0
- data/lib/buildium-ruby/models/association_appliance_service_history_message.rb +282 -0
- data/lib/buildium-ruby/models/association_appliance_service_history_post_message.rb +282 -0
- data/lib/buildium-ruby/models/association_board_member_message.rb +344 -0
- data/lib/buildium-ruby/models/association_board_member_post_message.rb +293 -0
- data/lib/buildium-ruby/models/association_board_member_put_message.rb +278 -0
- data/lib/buildium-ruby/models/association_board_member_search_message.rb +274 -0
- data/lib/buildium-ruby/models/association_message.rb +327 -0
- data/lib/buildium-ruby/models/association_owner_board_term_message.rb +303 -0
- data/lib/buildium-ruby/models/association_owner_board_term_post_message.rb +278 -0
- data/lib/buildium-ruby/models/association_owner_message.rb +440 -0
- data/lib/buildium-ruby/models/association_owner_post_message.rb +398 -0
- data/lib/buildium-ruby/models/association_owner_put_message.rb +363 -0
- data/lib/buildium-ruby/models/association_owner_to_existing_ownership_account_post_message.rb +428 -0
- data/lib/buildium-ruby/models/association_owner_unit_occupancy_put_message.rb +223 -0
- data/lib/buildium-ruby/models/association_owner_unit_occupancy_status_message.rb +228 -0
- data/lib/buildium-ruby/models/association_ownership_account_message.rb +347 -0
- data/lib/buildium-ruby/models/association_ownership_account_post_message.rb +346 -0
- data/lib/buildium-ruby/models/association_ownership_account_put_message.rb +223 -0
- data/lib/buildium-ruby/models/association_ownership_account_search_message.rb +296 -0
- data/lib/buildium-ruby/models/association_post_message.rb +302 -0
- data/lib/buildium-ruby/models/association_preferred_vendor_message.rb +300 -0
- data/lib/buildium-ruby/models/association_preferred_vendor_put_message.rb +225 -0
- data/lib/buildium-ruby/models/association_put_message.rb +322 -0
- data/lib/buildium-ruby/models/association_search_message.rb +283 -0
- data/lib/buildium-ruby/models/association_tenant_message.rb +350 -0
- data/lib/buildium-ruby/models/association_tenant_post_message.rb +354 -0
- data/lib/buildium-ruby/models/association_tenant_put_message.rb +329 -0
- data/lib/buildium-ruby/models/association_unit_message.rb +334 -0
- data/lib/buildium-ruby/models/association_unit_put_message.rb +313 -0
- data/lib/buildium-ruby/models/association_unit_search_message.rb +241 -0
- data/lib/buildium-ruby/models/association_units_post_message.rb +328 -0
- data/lib/buildium-ruby/models/association_user_search_message.rb +324 -0
- data/lib/buildium-ruby/models/bank_account_check_accounting_entity_save_message.rb +272 -0
- data/lib/buildium-ruby/models/bank_account_check_line_message.rb +267 -0
- data/lib/buildium-ruby/models/bank_account_check_line_save_message.rb +272 -0
- data/lib/buildium-ruby/models/bank_account_check_message.rb +279 -0
- data/lib/buildium-ruby/models/bank_account_check_payee_message.rb +272 -0
- data/lib/buildium-ruby/models/bank_account_check_payee_save_message.rb +272 -0
- data/lib/buildium-ruby/models/bank_account_check_post_message.rb +274 -0
- data/lib/buildium-ruby/models/bank_account_check_put_message.rb +274 -0
- data/lib/buildium-ruby/models/bank_account_check_search_message.rb +238 -0
- data/lib/buildium-ruby/models/bank_account_deposit_line_message.rb +267 -0
- data/lib/buildium-ruby/models/bank_account_deposit_line_save_message.rb +257 -0
- data/lib/buildium-ruby/models/bank_account_deposit_message.rb +272 -0
- data/lib/buildium-ruby/models/bank_account_deposit_post_message.rb +257 -0
- data/lib/buildium-ruby/models/bank_account_deposit_put_message.rb +250 -0
- data/lib/buildium-ruby/models/bank_account_deposit_search_message.rb +238 -0
- data/lib/buildium-ruby/models/bank_account_message.rb +360 -0
- data/lib/buildium-ruby/models/bank_account_post_message.rb +338 -0
- data/lib/buildium-ruby/models/bank_account_put_message.rb +343 -0
- data/lib/buildium-ruby/models/bank_account_quick_deposit_message.rb +267 -0
- data/lib/buildium-ruby/models/bank_account_quick_deposit_save_message.rb +277 -0
- data/lib/buildium-ruby/models/bank_account_quick_deposit_search_message.rb +238 -0
- data/lib/buildium-ruby/models/bank_account_search_message.rb +263 -0
- data/lib/buildium-ruby/models/bank_account_transaction_message.rb +359 -0
- data/lib/buildium-ruby/models/bank_account_transaction_search_message.rb +292 -0
- data/lib/buildium-ruby/models/bank_account_transfer_accounting_entity_save_message.rb +272 -0
- data/lib/buildium-ruby/models/bank_account_transfer_message.rb +267 -0
- data/lib/buildium-ruby/models/bank_account_transfer_save_message.rb +277 -0
- data/lib/buildium-ruby/models/bank_account_transfer_search_message.rb +238 -0
- data/lib/buildium-ruby/models/bank_account_withdrawal_message.rb +267 -0
- data/lib/buildium-ruby/models/bank_account_withdrawal_save_message.rb +277 -0
- data/lib/buildium-ruby/models/bank_account_withdrawal_search_message.rb +238 -0
- data/lib/buildium-ruby/models/bill_file_message.rb +268 -0
- data/lib/buildium-ruby/models/bill_line_message.rb +266 -0
- data/lib/buildium-ruby/models/bill_line_post_message.rb +272 -0
- data/lib/buildium-ruby/models/bill_line_put_message.rb +282 -0
- data/lib/buildium-ruby/models/bill_markup_message.rb +263 -0
- data/lib/buildium-ruby/models/bill_markup_save_message.rb +273 -0
- data/lib/buildium-ruby/models/bill_message.rb +344 -0
- data/lib/buildium-ruby/models/bill_payment_accounting_entity_message.rb +263 -0
- data/lib/buildium-ruby/models/bill_payment_line_message.rb +238 -0
- data/lib/buildium-ruby/models/bill_payment_line_post_message.rb +238 -0
- data/lib/buildium-ruby/models/bill_payment_message.rb +270 -0
- data/lib/buildium-ruby/models/bill_payment_post_message.rb +275 -0
- data/lib/buildium-ruby/models/bill_post_message.rb +301 -0
- data/lib/buildium-ruby/models/bill_put_message.rb +286 -0
- data/lib/buildium-ruby/models/bill_search_message.rb +336 -0
- data/lib/buildium-ruby/models/budget_details_message.rb +281 -0
- data/lib/buildium-ruby/models/budget_details_save_message.rb +237 -0
- data/lib/buildium-ruby/models/budget_message.rb +269 -0
- data/lib/buildium-ruby/models/budget_monthly_amounts_message.rb +328 -0
- data/lib/buildium-ruby/models/budget_monthly_amounts_save_message.rb +388 -0
- data/lib/buildium-ruby/models/budget_post_message.rb +319 -0
- data/lib/buildium-ruby/models/budget_put_message.rb +240 -0
- data/lib/buildium-ruby/models/budget_search_message.rb +240 -0
- data/lib/buildium-ruby/models/charge_recurring_transaction_post_message.rb +359 -0
- data/lib/buildium-ruby/models/charge_recurring_transaction_put_message.rb +374 -0
- data/lib/buildium-ruby/models/check_printing_info_message.rb +392 -0
- data/lib/buildium-ruby/models/check_printing_info_post_message.rb +392 -0
- data/lib/buildium-ruby/models/check_printing_info_put_message.rb +407 -0
- data/lib/buildium-ruby/models/client_lead_credit_request_message.rb +295 -0
- data/lib/buildium-ruby/models/client_lead_message.rb +363 -0
- data/lib/buildium-ruby/models/client_lead_search_message.rb +285 -0
- data/lib/buildium-ruby/models/contact_detail_message.rb +248 -0
- data/lib/buildium-ruby/models/contact_detail_phone_message.rb +239 -0
- data/lib/buildium-ruby/models/contact_detail_save_message.rb +253 -0
- data/lib/buildium-ruby/models/contact_detail_save_phone_message.rb +239 -0
- data/lib/buildium-ruby/models/contact_info_message.rb +248 -0
- data/lib/buildium-ruby/models/contact_request_task_message.rb +381 -0
- data/lib/buildium-ruby/models/contact_request_task_post_message.rb +388 -0
- data/lib/buildium-ruby/models/contact_request_task_put_message.rb +388 -0
- data/lib/buildium-ruby/models/contact_request_task_search_message.rb +366 -0
- data/lib/buildium-ruby/models/cosigner_message.rb +343 -0
- data/lib/buildium-ruby/models/created_by_user_message.rb +248 -0
- data/lib/buildium-ruby/models/credit_recurring_transaction_post_message.rb +388 -0
- data/lib/buildium-ruby/models/deposit_detail_message.rb +231 -0
- data/lib/buildium-ruby/models/electronic_payments_message.rb +288 -0
- data/lib/buildium-ruby/models/email_message.rb +247 -0
- data/lib/buildium-ruby/models/email_post_message.rb +307 -0
- data/lib/buildium-ruby/models/email_recipient_message.rb +292 -0
- data/lib/buildium-ruby/models/email_search_message.rb +268 -0
- data/lib/buildium-ruby/models/email_sender_message.rb +248 -0
- data/lib/buildium-ruby/models/emergency_contact_message.rb +249 -0
- data/lib/buildium-ruby/models/file_category_message.rb +239 -0
- data/lib/buildium-ruby/models/file_category_post_message.rb +224 -0
- data/lib/buildium-ruby/models/file_category_put_message.rb +224 -0
- data/lib/buildium-ruby/models/file_download_message.rb +218 -0
- data/lib/buildium-ruby/models/file_entity_message.rb +273 -0
- data/lib/buildium-ruby/models/file_message.rb +297 -0
- data/lib/buildium-ruby/models/file_name_post_message.rb +223 -0
- data/lib/buildium-ruby/models/file_put_message.rb +248 -0
- data/lib/buildium-ruby/models/file_search_message.rb +315 -0
- data/lib/buildium-ruby/models/file_upload_post_message.rb +322 -0
- data/lib/buildium-ruby/models/file_upload_ticket_message.rb +240 -0
- data/lib/buildium-ruby/models/general_journal_entry_line_save_message.rb +297 -0
- data/lib/buildium-ruby/models/general_journal_entry_post_message.rb +264 -0
- data/lib/buildium-ruby/models/general_journal_entry_put_message.rb +264 -0
- data/lib/buildium-ruby/models/general_ledger_journal_line_message.rb +267 -0
- data/lib/buildium-ruby/models/general_ledger_journal_message.rb +230 -0
- data/lib/buildium-ruby/models/general_ledger_transaction_message.rb +349 -0
- data/lib/buildium-ruby/models/general_ledger_transaction_search_message.rb +310 -0
- data/lib/buildium-ruby/models/gl_account_balance_item_message.rb +228 -0
- data/lib/buildium-ruby/models/gl_account_balance_message.rb +240 -0
- data/lib/buildium-ruby/models/gl_account_balance_search_message.rb +317 -0
- data/lib/buildium-ruby/models/gl_account_message.rb +419 -0
- data/lib/buildium-ruby/models/gl_account_post_message.rb +349 -0
- data/lib/buildium-ruby/models/gl_account_put_message.rb +344 -0
- data/lib/buildium-ruby/models/gl_accounts_search_message.rb +243 -0
- data/lib/buildium-ruby/models/gl_transaction_message_v1.rb +258 -0
- data/lib/buildium-ruby/models/internal_transaction_status_message.rb +239 -0
- data/lib/buildium-ruby/models/journal_line_message.rb +268 -0
- data/lib/buildium-ruby/models/journal_message.rb +230 -0
- data/lib/buildium-ruby/models/last_updated_by_user_message.rb +259 -0
- data/lib/buildium-ruby/models/lease_account_detail_message.rb +229 -0
- data/lib/buildium-ruby/models/lease_charge_line_save_message.rb +249 -0
- data/lib/buildium-ruby/models/lease_charge_post_message.rb +241 -0
- data/lib/buildium-ruby/models/lease_charge_put_message.rb +250 -0
- data/lib/buildium-ruby/models/lease_charge_recurring_transaction_message.rb +374 -0
- data/lib/buildium-ruby/models/lease_cosigner_post_message.rb +330 -0
- data/lib/buildium-ruby/models/lease_ledger_credit_line_post_message.rb +239 -0
- data/lib/buildium-ruby/models/lease_ledger_credit_post_message.rb +309 -0
- data/lib/buildium-ruby/models/lease_ledger_deposit_withholding_line_post_message.rb +238 -0
- data/lib/buildium-ruby/models/lease_ledger_deposit_withholding_post_message.rb +260 -0
- data/lib/buildium-ruby/models/lease_ledger_payment_line_save_message.rb +239 -0
- data/lib/buildium-ruby/models/lease_ledger_payment_post_message.rb +335 -0
- data/lib/buildium-ruby/models/lease_ledger_refund_line_message.rb +228 -0
- data/lib/buildium-ruby/models/lease_ledger_refund_line_post_message.rb +238 -0
- data/lib/buildium-ruby/models/lease_ledger_refund_message.rb +301 -0
- data/lib/buildium-ruby/models/lease_ledger_refund_post_message.rb +306 -0
- data/lib/buildium-ruby/models/lease_ledger_reverse_payment_nsf_charge_post_message.rb +239 -0
- data/lib/buildium-ruby/models/lease_ledger_reverse_payment_other_bank_charge_post_message.rb +239 -0
- data/lib/buildium-ruby/models/lease_ledger_reverse_payment_post_message.rb +256 -0
- data/lib/buildium-ruby/models/lease_message.rb +496 -0
- data/lib/buildium-ruby/models/lease_move_out_data_message.rb +238 -0
- data/lib/buildium-ruby/models/lease_move_out_data_post_message.rb +248 -0
- data/lib/buildium-ruby/models/lease_outstanding_balance_message.rb +330 -0
- data/lib/buildium-ruby/models/lease_outstanding_balance_search_message.rb +345 -0
- data/lib/buildium-ruby/models/lease_post_message.rb +379 -0
- data/lib/buildium-ruby/models/lease_put_message.rb +322 -0
- data/lib/buildium-ruby/models/lease_recurring_credit_message.rb +408 -0
- data/lib/buildium-ruby/models/lease_recurring_payment_message.rb +397 -0
- data/lib/buildium-ruby/models/lease_renewal_message.rb +336 -0
- data/lib/buildium-ruby/models/lease_renewal_post_message.rb +378 -0
- data/lib/buildium-ruby/models/lease_rent_charge_message.rb +278 -0
- data/lib/buildium-ruby/models/lease_rent_charge_post_message.rb +263 -0
- data/lib/buildium-ruby/models/lease_rent_message.rb +334 -0
- data/lib/buildium-ruby/models/lease_rent_post_message.rb +275 -0
- data/lib/buildium-ruby/models/lease_search_message.rb +359 -0
- data/lib/buildium-ruby/models/lease_security_deposit_post_message.rb +239 -0
- data/lib/buildium-ruby/models/lease_tenant_message.rb +262 -0
- data/lib/buildium-ruby/models/lease_transaction_message.rb +298 -0
- data/lib/buildium-ruby/models/lease_transaction_search_message.rb +263 -0
- data/lib/buildium-ruby/models/listing_contact_message.rb +259 -0
- data/lib/buildium-ruby/models/listing_contact_save_message.rb +253 -0
- data/lib/buildium-ruby/models/listing_file_message.rb +272 -0
- data/lib/buildium-ruby/models/listing_message.rb +305 -0
- data/lib/buildium-ruby/models/listing_property_message.rb +326 -0
- data/lib/buildium-ruby/models/listing_put_message.rb +283 -0
- data/lib/buildium-ruby/models/listing_search_message.rb +262 -0
- data/lib/buildium-ruby/models/listing_unit_message.rb +358 -0
- data/lib/buildium-ruby/models/lock_period_settings_global_message.rb +218 -0
- data/lib/buildium-ruby/models/lock_period_settings_overrides_message.rb +227 -0
- data/lib/buildium-ruby/models/logged_by_staff_user_message.rb +249 -0
- data/lib/buildium-ruby/models/lookup_message.rb +226 -0
- data/lib/buildium-ruby/models/mailing_template_message.rb +282 -0
- data/lib/buildium-ruby/models/note_message.rb +237 -0
- data/lib/buildium-ruby/models/note_post_message.rb +223 -0
- data/lib/buildium-ruby/models/note_put_message.rb +223 -0
- data/lib/buildium-ruby/models/note_search_message.rb +238 -0
- data/lib/buildium-ruby/models/outstanding_balances_line_message.rb +228 -0
- data/lib/buildium-ruby/models/ownership_account_charge_recurring_transaction_message.rb +374 -0
- data/lib/buildium-ruby/models/ownership_account_credit_line_post_message.rb +238 -0
- data/lib/buildium-ruby/models/ownership_account_credit_post_message.rb +309 -0
- data/lib/buildium-ruby/models/ownership_account_deposit_withholding_line_post_message.rb +238 -0
- data/lib/buildium-ruby/models/ownership_account_deposit_withholding_post_message.rb +260 -0
- data/lib/buildium-ruby/models/ownership_account_ledger_charge_lines_put_message.rb +248 -0
- data/lib/buildium-ruby/models/ownership_account_ledger_charge_lines_save_message.rb +238 -0
- data/lib/buildium-ruby/models/ownership_account_ledger_charge_post_message.rb +250 -0
- data/lib/buildium-ruby/models/ownership_account_ledger_charge_put_message.rb +250 -0
- data/lib/buildium-ruby/models/ownership_account_ledger_payment_line_save_message.rb +239 -0
- data/lib/buildium-ruby/models/ownership_account_ledger_payment_post_message.rb +335 -0
- data/lib/buildium-ruby/models/ownership_account_outstanding_balance_message.rb +310 -0
- data/lib/buildium-ruby/models/ownership_account_outstanding_balance_search_message.rb +308 -0
- data/lib/buildium-ruby/models/ownership_account_recurring_credit_message.rb +408 -0
- data/lib/buildium-ruby/models/ownership_account_recurring_payment_message.rb +397 -0
- data/lib/buildium-ruby/models/ownership_account_refund_line_message.rb +228 -0
- data/lib/buildium-ruby/models/ownership_account_refund_lines_post_message.rb +238 -0
- data/lib/buildium-ruby/models/ownership_account_refund_message.rb +301 -0
- data/lib/buildium-ruby/models/ownership_account_refund_post_message.rb +306 -0
- data/lib/buildium-ruby/models/ownership_account_transaction_message.rb +298 -0
- data/lib/buildium-ruby/models/paid_by_message.rb +228 -0
- data/lib/buildium-ruby/models/participant_message.rb +240 -0
- data/lib/buildium-ruby/models/participant_resource_message.rb +263 -0
- data/lib/buildium-ruby/models/payee_message.rb +283 -0
- data/lib/buildium-ruby/models/payment_detail_message.rb +281 -0
- data/lib/buildium-ruby/models/payment_recurring_transaction_post_message.rb +378 -0
- data/lib/buildium-ruby/models/payment_transactions_message.rb +237 -0
- data/lib/buildium-ruby/models/phone_log_message.rb +266 -0
- data/lib/buildium-ruby/models/phone_log_participant_post_message.rb +282 -0
- data/lib/buildium-ruby/models/phone_log_participant_unit_agreement_post_message.rb +263 -0
- data/lib/buildium-ruby/models/phone_log_post_message.rb +267 -0
- data/lib/buildium-ruby/models/phone_log_put_message.rb +253 -0
- data/lib/buildium-ruby/models/phone_log_search_message.rb +336 -0
- data/lib/buildium-ruby/models/phone_number_message.rb +263 -0
- data/lib/buildium-ruby/models/phone_numbers_message.rb +249 -0
- data/lib/buildium-ruby/models/property_group_message.rb +259 -0
- data/lib/buildium-ruby/models/property_group_post_message.rb +250 -0
- data/lib/buildium-ruby/models/property_group_put_message.rb +250 -0
- data/lib/buildium-ruby/models/property_group_search_message.rb +230 -0
- data/lib/buildium-ruby/models/property_manager_message.rb +291 -0
- data/lib/buildium-ruby/models/property_message.rb +273 -0
- data/lib/buildium-ruby/models/recurring_transaction_line_message.rb +228 -0
- data/lib/buildium-ruby/models/recurring_transaction_line_post_message.rb +238 -0
- data/lib/buildium-ruby/models/recurring_transaction_message.rb +388 -0
- data/lib/buildium-ruby/models/rental_appliance_message.rb +288 -0
- data/lib/buildium-ruby/models/rental_appliance_post_message.rb +298 -0
- data/lib/buildium-ruby/models/rental_appliance_put_message.rb +273 -0
- data/lib/buildium-ruby/models/rental_appliance_search_message.rb +232 -0
- data/lib/buildium-ruby/models/rental_appliance_service_history_message.rb +282 -0
- data/lib/buildium-ruby/models/rental_appliance_service_history_post_message.rb +282 -0
- data/lib/buildium-ruby/models/rental_features_message.rb +255 -0
- data/lib/buildium-ruby/models/rental_features_put_message.rb +254 -0
- data/lib/buildium-ruby/models/rental_message.rb +373 -0
- data/lib/buildium-ruby/models/rental_owner_message.rb +361 -0
- data/lib/buildium-ruby/models/rental_owner_post_message.rb +363 -0
- data/lib/buildium-ruby/models/rental_owner_put_message.rb +354 -0
- data/lib/buildium-ruby/models/rental_owner_request_task_message.rb +381 -0
- data/lib/buildium-ruby/models/rental_owner_request_task_post_message.rb +384 -0
- data/lib/buildium-ruby/models/rental_owner_request_task_put_message.rb +369 -0
- data/lib/buildium-ruby/models/rental_owner_request_task_search_message.rb +366 -0
- data/lib/buildium-ruby/models/rental_owner_tax_information_message.rb +302 -0
- data/lib/buildium-ruby/models/rental_owners_search_message.rb +314 -0
- data/lib/buildium-ruby/models/rental_preferred_vendor_message.rb +300 -0
- data/lib/buildium-ruby/models/rental_preferred_vendor_put_message.rb +225 -0
- data/lib/buildium-ruby/models/rental_property_post_message.rb +365 -0
- data/lib/buildium-ruby/models/rental_property_put_message.rb +341 -0
- data/lib/buildium-ruby/models/rental_property_unit_post_message.rb +333 -0
- data/lib/buildium-ruby/models/rental_search_message.rb +330 -0
- data/lib/buildium-ruby/models/rental_tenant_post_message.rb +388 -0
- data/lib/buildium-ruby/models/rental_tenant_put_message.rb +373 -0
- data/lib/buildium-ruby/models/rental_tenant_renewal_post_message.rb +373 -0
- data/lib/buildium-ruby/models/rental_unit_features_message.rb +243 -0
- data/lib/buildium-ruby/models/rental_unit_features_put_message.rb +242 -0
- data/lib/buildium-ruby/models/rental_unit_message.rb +374 -0
- data/lib/buildium-ruby/models/rental_unit_put_message.rb +333 -0
- data/lib/buildium-ruby/models/rental_unit_search_message.rb +240 -0
- data/lib/buildium-ruby/models/rental_units_post_message.rb +348 -0
- data/lib/buildium-ruby/models/requested_by_user_entity_message.rb +303 -0
- data/lib/buildium-ruby/models/resident_center_user_message.rb +280 -0
- data/lib/buildium-ruby/models/resident_center_user_reference_message.rb +292 -0
- data/lib/buildium-ruby/models/resident_center_user_search_message.rb +288 -0
- data/lib/buildium-ruby/models/resident_request_task_message.rb +429 -0
- data/lib/buildium-ruby/models/resident_request_task_post_message.rb +409 -0
- data/lib/buildium-ruby/models/resident_request_task_put_message.rb +349 -0
- data/lib/buildium-ruby/models/resident_request_task_search_message.rb +376 -0
- data/lib/buildium-ruby/models/save_address_message.rb +323 -0
- data/lib/buildium-ruby/models/save_emergency_contact_message.rb +248 -0
- data/lib/buildium-ruby/models/task_category_message.rb +251 -0
- data/lib/buildium-ruby/models/task_category_put_message.rb +224 -0
- data/lib/buildium-ruby/models/task_category_response_message.rb +248 -0
- data/lib/buildium-ruby/models/task_category_save_message.rb +224 -0
- data/lib/buildium-ruby/models/task_history_file_message.rb +268 -0
- data/lib/buildium-ruby/models/task_history_file_upload_post_message.rb +223 -0
- data/lib/buildium-ruby/models/task_history_message.rb +376 -0
- data/lib/buildium-ruby/models/task_history_put_message.rb +223 -0
- data/lib/buildium-ruby/models/task_history_user_message.rb +249 -0
- data/lib/buildium-ruby/models/task_search_message.rb +398 -0
- data/lib/buildium-ruby/models/task_sub_category_message.rb +229 -0
- data/lib/buildium-ruby/models/tax_information_post_message.rb +292 -0
- data/lib/buildium-ruby/models/tax_information_save_message.rb +307 -0
- data/lib/buildium-ruby/models/tenant_message.rb +404 -0
- data/lib/buildium-ruby/models/tenant_search_message.rb +339 -0
- data/lib/buildium-ruby/models/to_do_task_message.rb +372 -0
- data/lib/buildium-ruby/models/to_do_task_post_message.rb +374 -0
- data/lib/buildium-ruby/models/to_do_task_put_message.rb +374 -0
- data/lib/buildium-ruby/models/to_do_task_search_message.rb +366 -0
- data/lib/buildium-ruby/models/undeposited_funds_message.rb +217 -0
- data/lib/buildium-ruby/models/unit_agreement_message.rb +273 -0
- data/lib/buildium-ruby/models/user_message.rb +354 -0
- data/lib/buildium-ruby/models/user_role_message.rb +249 -0
- data/lib/buildium-ruby/models/user_search_message.rb +297 -0
- data/lib/buildium-ruby/models/vehicle_message.rb +249 -0
- data/lib/buildium-ruby/models/vendor_category_message.rb +239 -0
- data/lib/buildium-ruby/models/vendor_category_save_message.rb +223 -0
- data/lib/buildium-ruby/models/vendor_credit_line_item_message.rb +257 -0
- data/lib/buildium-ruby/models/vendor_credit_line_item_post_message.rb +262 -0
- data/lib/buildium-ruby/models/vendor_credit_message.rb +260 -0
- data/lib/buildium-ruby/models/vendor_credit_post_message.rb +260 -0
- data/lib/buildium-ruby/models/vendor_insurance_message.rb +239 -0
- data/lib/buildium-ruby/models/vendor_insurance_save_message.rb +239 -0
- data/lib/buildium-ruby/models/vendor_message.rb +377 -0
- data/lib/buildium-ruby/models/vendor_post_message.rb +364 -0
- data/lib/buildium-ruby/models/vendor_put_message.rb +364 -0
- data/lib/buildium-ruby/models/vendor_refund_line_message.rb +257 -0
- data/lib/buildium-ruby/models/vendor_refund_line_post_message.rb +262 -0
- data/lib/buildium-ruby/models/vendor_refund_message.rb +314 -0
- data/lib/buildium-ruby/models/vendor_refund_post_message.rb +324 -0
- data/lib/buildium-ruby/models/vendor_search_message.rb +334 -0
- data/lib/buildium-ruby/models/vendor_tax_information_message.rb +302 -0
- data/lib/buildium-ruby/models/vendor_transaction_message.rb +302 -0
- data/lib/buildium-ruby/models/vendor_transaction_search_message.rb +292 -0
- data/lib/buildium-ruby/models/work_order_entry_contact_message.rb +231 -0
- data/lib/buildium-ruby/models/work_order_entry_contact_resource_message.rb +263 -0
- data/lib/buildium-ruby/models/work_order_line_item_message.rb +249 -0
- data/lib/buildium-ruby/models/work_order_line_item_save_message.rb +258 -0
- data/lib/buildium-ruby/models/work_order_message.rb +372 -0
- data/lib/buildium-ruby/models/work_order_post_message.rb +363 -0
- data/lib/buildium-ruby/models/work_order_put_message.rb +344 -0
- data/lib/buildium-ruby/models/work_order_search_message.rb +452 -0
- data/lib/buildium-ruby/models/work_order_task_message.rb +346 -0
- data/lib/buildium-ruby/models/work_order_task_post_message.rb +345 -0
- data/lib/buildium-ruby/version.rb +15 -0
- data/lib/buildium-ruby.rb +438 -0
- data/openapitools.json +7 -0
- data/spec/api/accounting_api_spec.rb +383 -0
- data/spec/api/administration_api_spec.rb +114 -0
- data/spec/api/applicants_api_spec.rb +294 -0
- data/spec/api/association_appliances_api_spec.rb +141 -0
- data/spec/api/association_owners_api_spec.rb +195 -0
- data/spec/api/association_ownership_accounts_api_spec.rb +385 -0
- data/spec/api/association_tenants_api_spec.rb +153 -0
- data/spec/api/association_units_api_spec.rb +147 -0
- data/spec/api/associations_api_spec.rb +248 -0
- data/spec/api/bank_accounts_api_spec.rb +420 -0
- data/spec/api/client_leads_api_spec.rb +66 -0
- data/spec/api/communications_api_spec.rb +248 -0
- data/spec/api/files_api_spec.rb +156 -0
- data/spec/api/leases_api_spec.rb +529 -0
- data/spec/api/listings_api_spec.rb +139 -0
- data/spec/api/property_groups_api_spec.rb +88 -0
- data/spec/api/rental_appliances_api_spec.rb +141 -0
- data/spec/api/rental_owners_api_spec.rb +151 -0
- data/spec/api/rental_properties_api_spec.rb +205 -0
- data/spec/api/rental_tenants_api_spec.rb +154 -0
- data/spec/api/rental_units_api_spec.rb +172 -0
- data/spec/api/resident_center_api_spec.rb +54 -0
- data/spec/api/tasks_api_spec.rb +493 -0
- data/spec/api/vendors_api_spec.rb +275 -0
- data/spec/api/work_orders_api_spec.rb +105 -0
- data/spec/api_client_spec.rb +188 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/account_info_message_spec.rb +58 -0
- data/spec/models/accounting_entity_message_spec.rb +50 -0
- data/spec/models/accounting_entity_save_message_spec.rb +44 -0
- data/spec/models/accounting_lock_period_message_spec.rb +46 -0
- data/spec/models/accounting_settings_message_spec.rb +72 -0
- data/spec/models/address_message_spec.rb +74 -0
- data/spec/models/all_tasks_message_spec.rb +130 -0
- data/spec/models/announcement_message_spec.rb +74 -0
- data/spec/models/announcement_post_message_spec.rb +64 -0
- data/spec/models/announcement_search_message_spec.rb +62 -0
- data/spec/models/announcement_sender_message_spec.rb +46 -0
- data/spec/models/api_error_response_spec.rb +46 -0
- data/spec/models/appliance_message_spec.rb +58 -0
- data/spec/models/applicant_application_message_spec.rb +56 -0
- data/spec/models/applicant_group_message_spec.rb +62 -0
- data/spec/models/applicant_group_post_message_spec.rb +40 -0
- data/spec/models/applicant_group_put_message_spec.rb +50 -0
- data/spec/models/applicant_group_search_message_spec.rb +66 -0
- data/spec/models/applicant_message_spec.rb +88 -0
- data/spec/models/applicant_post_message_spec.rb +64 -0
- data/spec/models/applicant_put_message_spec.rb +58 -0
- data/spec/models/applicant_search_message_spec.rb +84 -0
- data/spec/models/application_message_spec.rb +62 -0
- data/spec/models/application_put_message_spec.rb +38 -0
- data/spec/models/application_response_field_message_spec.rb +60 -0
- data/spec/models/application_response_message_spec.rb +50 -0
- data/spec/models/application_section_response_message_spec.rb +34 -0
- data/spec/models/association_appliance_message_spec.rb +76 -0
- data/spec/models/association_appliance_post_message_spec.rb +76 -0
- data/spec/models/association_appliance_put_message_spec.rb +64 -0
- data/spec/models/association_appliance_search_message_spec.rb +40 -0
- data/spec/models/association_appliance_service_history_message_spec.rb +56 -0
- data/spec/models/association_appliance_service_history_post_message_spec.rb +50 -0
- data/spec/models/association_board_member_message_spec.rb +92 -0
- data/spec/models/association_board_member_post_message_spec.rb +56 -0
- data/spec/models/association_board_member_put_message_spec.rb +50 -0
- data/spec/models/association_board_member_search_message_spec.rb +60 -0
- data/spec/models/association_message_spec.rb +100 -0
- data/spec/models/association_owner_board_term_message_spec.rb +68 -0
- data/spec/models/association_owner_board_term_post_message_spec.rb +50 -0
- data/spec/models/association_owner_message_spec.rb +144 -0
- data/spec/models/association_owner_post_message_spec.rb +116 -0
- data/spec/models/association_owner_put_message_spec.rb +98 -0
- data/spec/models/association_owner_to_existing_ownership_account_post_message_spec.rb +128 -0
- data/spec/models/association_owner_unit_occupancy_put_message_spec.rb +34 -0
- data/spec/models/association_owner_unit_occupancy_status_message_spec.rb +40 -0
- data/spec/models/association_ownership_account_message_spec.rb +90 -0
- data/spec/models/association_ownership_account_post_message_spec.rb +80 -0
- data/spec/models/association_ownership_account_put_message_spec.rb +34 -0
- data/spec/models/association_ownership_account_search_message_spec.rb +72 -0
- data/spec/models/association_post_message_spec.rb +76 -0
- data/spec/models/association_preferred_vendor_message_spec.rb +82 -0
- data/spec/models/association_preferred_vendor_put_message_spec.rb +34 -0
- data/spec/models/association_put_message_spec.rb +82 -0
- data/spec/models/association_search_message_spec.rb +56 -0
- data/spec/models/association_tenant_message_spec.rb +112 -0
- data/spec/models/association_tenant_post_message_spec.rb +106 -0
- data/spec/models/association_tenant_put_message_spec.rb +94 -0
- data/spec/models/association_unit_message_spec.rb +84 -0
- data/spec/models/association_unit_put_message_spec.rb +66 -0
- data/spec/models/association_unit_search_message_spec.rb +46 -0
- data/spec/models/association_units_post_message_spec.rb +72 -0
- data/spec/models/association_user_search_message_spec.rb +86 -0
- data/spec/models/bank_account_check_accounting_entity_save_message_spec.rb +44 -0
- data/spec/models/bank_account_check_line_message_spec.rb +64 -0
- data/spec/models/bank_account_check_line_save_message_spec.rb +58 -0
- data/spec/models/bank_account_check_message_spec.rb +70 -0
- data/spec/models/bank_account_check_payee_message_spec.rb +50 -0
- data/spec/models/bank_account_check_payee_save_message_spec.rb +44 -0
- data/spec/models/bank_account_check_post_message_spec.rb +58 -0
- data/spec/models/bank_account_check_put_message_spec.rb +58 -0
- data/spec/models/bank_account_check_search_message_spec.rb +40 -0
- data/spec/models/bank_account_deposit_line_message_spec.rb +64 -0
- data/spec/models/bank_account_deposit_line_save_message_spec.rb +58 -0
- data/spec/models/bank_account_deposit_message_spec.rb +64 -0
- data/spec/models/bank_account_deposit_post_message_spec.rb +52 -0
- data/spec/models/bank_account_deposit_put_message_spec.rb +46 -0
- data/spec/models/bank_account_deposit_search_message_spec.rb +40 -0
- data/spec/models/bank_account_message_spec.rb +104 -0
- data/spec/models/bank_account_post_message_spec.rb +78 -0
- data/spec/models/bank_account_put_message_spec.rb +78 -0
- data/spec/models/bank_account_quick_deposit_message_spec.rb +64 -0
- data/spec/models/bank_account_quick_deposit_save_message_spec.rb +58 -0
- data/spec/models/bank_account_quick_deposit_search_message_spec.rb +40 -0
- data/spec/models/bank_account_search_message_spec.rb +44 -0
- data/spec/models/bank_account_transaction_message_spec.rb +96 -0
- data/spec/models/bank_account_transaction_search_message_spec.rb +56 -0
- data/spec/models/bank_account_transfer_accounting_entity_save_message_spec.rb +44 -0
- data/spec/models/bank_account_transfer_message_spec.rb +64 -0
- data/spec/models/bank_account_transfer_save_message_spec.rb +58 -0
- data/spec/models/bank_account_transfer_search_message_spec.rb +40 -0
- data/spec/models/bank_account_withdrawal_message_spec.rb +64 -0
- data/spec/models/bank_account_withdrawal_save_message_spec.rb +58 -0
- data/spec/models/bank_account_withdrawal_search_message_spec.rb +40 -0
- data/spec/models/bill_file_message_spec.rb +64 -0
- data/spec/models/bill_line_message_spec.rb +64 -0
- data/spec/models/bill_line_post_message_spec.rb +58 -0
- data/spec/models/bill_line_put_message_spec.rb +64 -0
- data/spec/models/bill_markup_message_spec.rb +44 -0
- data/spec/models/bill_markup_save_message_spec.rb +44 -0
- data/spec/models/bill_message_spec.rb +92 -0
- data/spec/models/bill_payment_accounting_entity_message_spec.rb +44 -0
- data/spec/models/bill_payment_line_message_spec.rb +46 -0
- data/spec/models/bill_payment_line_post_message_spec.rb +40 -0
- data/spec/models/bill_payment_message_spec.rb +64 -0
- data/spec/models/bill_payment_post_message_spec.rb +58 -0
- data/spec/models/bill_post_message_spec.rb +70 -0
- data/spec/models/bill_put_message_spec.rb +64 -0
- data/spec/models/bill_search_message_spec.rb +88 -0
- data/spec/models/budget_details_message_spec.rb +56 -0
- data/spec/models/budget_details_save_message_spec.rb +40 -0
- data/spec/models/budget_message_spec.rb +64 -0
- data/spec/models/budget_monthly_amounts_message_spec.rb +100 -0
- data/spec/models/budget_monthly_amounts_save_message_spec.rb +100 -0
- data/spec/models/budget_post_message_spec.rb +62 -0
- data/spec/models/budget_put_message_spec.rb +40 -0
- data/spec/models/budget_search_message_spec.rb +46 -0
- data/spec/models/charge_recurring_transaction_post_message_spec.rb +84 -0
- data/spec/models/charge_recurring_transaction_put_message_spec.rb +90 -0
- data/spec/models/check_printing_info_message_spec.rb +122 -0
- data/spec/models/check_printing_info_post_message_spec.rb +122 -0
- data/spec/models/check_printing_info_put_message_spec.rb +122 -0
- data/spec/models/client_lead_credit_request_message_spec.rb +60 -0
- data/spec/models/client_lead_message_spec.rb +102 -0
- data/spec/models/client_lead_search_message_spec.rb +66 -0
- data/spec/models/contact_detail_message_spec.rb +52 -0
- data/spec/models/contact_detail_phone_message_spec.rb +46 -0
- data/spec/models/contact_detail_save_message_spec.rb +52 -0
- data/spec/models/contact_detail_save_phone_message_spec.rb +46 -0
- data/spec/models/contact_info_message_spec.rb +52 -0
- data/spec/models/contact_request_task_message_spec.rb +114 -0
- data/spec/models/contact_request_task_post_message_spec.rb +102 -0
- data/spec/models/contact_request_task_put_message_spec.rb +102 -0
- data/spec/models/contact_request_task_search_message_spec.rb +112 -0
- data/spec/models/cosigner_message_spec.rb +92 -0
- data/spec/models/created_by_user_message_spec.rb +52 -0
- data/spec/models/credit_recurring_transaction_post_message_spec.rb +100 -0
- data/spec/models/deposit_detail_message_spec.rb +40 -0
- data/spec/models/electronic_payments_message_spec.rb +76 -0
- data/spec/models/email_message_spec.rb +52 -0
- data/spec/models/email_post_message_spec.rb +70 -0
- data/spec/models/email_recipient_message_spec.rb +62 -0
- data/spec/models/email_search_message_spec.rb +58 -0
- data/spec/models/email_sender_message_spec.rb +52 -0
- data/spec/models/emergency_contact_message_spec.rb +52 -0
- data/spec/models/file_category_message_spec.rb +46 -0
- data/spec/models/file_category_post_message_spec.rb +34 -0
- data/spec/models/file_category_put_message_spec.rb +34 -0
- data/spec/models/file_download_message_spec.rb +34 -0
- data/spec/models/file_entity_message_spec.rb +50 -0
- data/spec/models/file_message_spec.rb +82 -0
- data/spec/models/file_name_post_message_spec.rb +34 -0
- data/spec/models/file_put_message_spec.rb +46 -0
- data/spec/models/file_search_message_spec.rb +74 -0
- data/spec/models/file_upload_post_message_spec.rb +68 -0
- data/spec/models/file_upload_ticket_message_spec.rb +46 -0
- data/spec/models/general_journal_entry_line_save_message_spec.rb +56 -0
- data/spec/models/general_journal_entry_post_message_spec.rb +52 -0
- data/spec/models/general_journal_entry_put_message_spec.rb +52 -0
- data/spec/models/general_ledger_journal_line_message_spec.rb +64 -0
- data/spec/models/general_ledger_journal_message_spec.rb +40 -0
- data/spec/models/general_ledger_transaction_message_spec.rb +98 -0
- data/spec/models/general_ledger_transaction_search_message_spec.rb +62 -0
- data/spec/models/gl_account_balance_item_message_spec.rb +40 -0
- data/spec/models/gl_account_balance_message_spec.rb +46 -0
- data/spec/models/gl_account_balance_search_message_spec.rb +66 -0
- data/spec/models/gl_account_message_spec.rb +130 -0
- data/spec/models/gl_account_post_message_spec.rb +84 -0
- data/spec/models/gl_account_put_message_spec.rb +84 -0
- data/spec/models/gl_accounts_search_message_spec.rb +38 -0
- data/spec/models/gl_transaction_message_v1_spec.rb +58 -0
- data/spec/models/internal_transaction_status_message_spec.rb +46 -0
- data/spec/models/journal_line_message_spec.rb +64 -0
- data/spec/models/journal_message_spec.rb +40 -0
- data/spec/models/last_updated_by_user_message_spec.rb +58 -0
- data/spec/models/lease_account_detail_message_spec.rb +40 -0
- data/spec/models/lease_charge_line_save_message_spec.rb +46 -0
- data/spec/models/lease_charge_post_message_spec.rb +46 -0
- data/spec/models/lease_charge_put_message_spec.rb +46 -0
- data/spec/models/lease_charge_recurring_transaction_message_spec.rb +108 -0
- data/spec/models/lease_cosigner_post_message_spec.rb +80 -0
- data/spec/models/lease_ledger_credit_line_post_message_spec.rb +40 -0
- data/spec/models/lease_ledger_credit_post_message_spec.rb +62 -0
- data/spec/models/lease_ledger_deposit_withholding_line_post_message_spec.rb +40 -0
- data/spec/models/lease_ledger_deposit_withholding_post_message_spec.rb +52 -0
- data/spec/models/lease_ledger_payment_line_save_message_spec.rb +40 -0
- data/spec/models/lease_ledger_payment_post_message_spec.rb +74 -0
- data/spec/models/lease_ledger_refund_line_message_spec.rb +40 -0
- data/spec/models/lease_ledger_refund_line_post_message_spec.rb +40 -0
- data/spec/models/lease_ledger_refund_message_spec.rb +82 -0
- data/spec/models/lease_ledger_refund_post_message_spec.rb +70 -0
- data/spec/models/lease_ledger_reverse_payment_nsf_charge_post_message_spec.rb +40 -0
- data/spec/models/lease_ledger_reverse_payment_other_bank_charge_post_message_spec.rb +40 -0
- data/spec/models/lease_ledger_reverse_payment_post_message_spec.rb +52 -0
- data/spec/models/lease_message_spec.rb +170 -0
- data/spec/models/lease_move_out_data_message_spec.rb +46 -0
- data/spec/models/lease_move_out_data_post_message_spec.rb +46 -0
- data/spec/models/lease_outstanding_balance_message_spec.rb +100 -0
- data/spec/models/lease_outstanding_balance_search_message_spec.rb +90 -0
- data/spec/models/lease_post_message_spec.rb +98 -0
- data/spec/models/lease_put_message_spec.rb +68 -0
- data/spec/models/lease_recurring_credit_message_spec.rb +124 -0
- data/spec/models/lease_recurring_payment_message_spec.rb +118 -0
- data/spec/models/lease_renewal_message_spec.rb +84 -0
- data/spec/models/lease_renewal_post_message_spec.rb +98 -0
- data/spec/models/lease_rent_charge_message_spec.rb +70 -0
- data/spec/models/lease_rent_charge_post_message_spec.rb +52 -0
- data/spec/models/lease_rent_message_spec.rb +86 -0
- data/spec/models/lease_rent_post_message_spec.rb +44 -0
- data/spec/models/lease_search_message_spec.rb +108 -0
- data/spec/models/lease_security_deposit_post_message_spec.rb +40 -0
- data/spec/models/lease_tenant_message_spec.rb +44 -0
- data/spec/models/lease_transaction_message_spec.rb +82 -0
- data/spec/models/lease_transaction_search_message_spec.rb +50 -0
- data/spec/models/listing_contact_message_spec.rb +58 -0
- data/spec/models/listing_contact_save_message_spec.rb +52 -0
- data/spec/models/listing_file_message_spec.rb +50 -0
- data/spec/models/listing_message_spec.rb +88 -0
- data/spec/models/listing_property_message_spec.rb +90 -0
- data/spec/models/listing_put_message_spec.rb +64 -0
- data/spec/models/listing_search_message_spec.rb +44 -0
- data/spec/models/listing_unit_message_spec.rb +100 -0
- data/spec/models/lock_period_settings_global_message_spec.rb +34 -0
- data/spec/models/lock_period_settings_overrides_message_spec.rb +40 -0
- data/spec/models/logged_by_staff_user_message_spec.rb +52 -0
- data/spec/models/lookup_message_spec.rb +40 -0
- data/spec/models/mailing_template_message_spec.rb +56 -0
- data/spec/models/note_message_spec.rb +46 -0
- data/spec/models/note_post_message_spec.rb +34 -0
- data/spec/models/note_put_message_spec.rb +34 -0
- data/spec/models/note_search_message_spec.rb +46 -0
- data/spec/models/outstanding_balances_line_message_spec.rb +40 -0
- data/spec/models/ownership_account_charge_recurring_transaction_message_spec.rb +108 -0
- data/spec/models/ownership_account_credit_line_post_message_spec.rb +40 -0
- data/spec/models/ownership_account_credit_post_message_spec.rb +62 -0
- data/spec/models/ownership_account_deposit_withholding_line_post_message_spec.rb +40 -0
- data/spec/models/ownership_account_deposit_withholding_post_message_spec.rb +52 -0
- data/spec/models/ownership_account_ledger_charge_lines_put_message_spec.rb +46 -0
- data/spec/models/ownership_account_ledger_charge_lines_save_message_spec.rb +40 -0
- data/spec/models/ownership_account_ledger_charge_post_message_spec.rb +46 -0
- data/spec/models/ownership_account_ledger_charge_put_message_spec.rb +46 -0
- data/spec/models/ownership_account_ledger_payment_line_save_message_spec.rb +40 -0
- data/spec/models/ownership_account_ledger_payment_post_message_spec.rb +74 -0
- data/spec/models/ownership_account_outstanding_balance_message_spec.rb +88 -0
- data/spec/models/ownership_account_outstanding_balance_search_message_spec.rb +70 -0
- data/spec/models/ownership_account_recurring_credit_message_spec.rb +124 -0
- data/spec/models/ownership_account_recurring_payment_message_spec.rb +118 -0
- data/spec/models/ownership_account_refund_line_message_spec.rb +40 -0
- data/spec/models/ownership_account_refund_lines_post_message_spec.rb +40 -0
- data/spec/models/ownership_account_refund_message_spec.rb +82 -0
- data/spec/models/ownership_account_refund_post_message_spec.rb +70 -0
- data/spec/models/ownership_account_transaction_message_spec.rb +82 -0
- data/spec/models/paid_by_message_spec.rb +40 -0
- data/spec/models/participant_message_spec.rb +46 -0
- data/spec/models/participant_resource_message_spec.rb +44 -0
- data/spec/models/payee_message_spec.rb +56 -0
- data/spec/models/payment_detail_message_spec.rb +56 -0
- data/spec/models/payment_recurring_transaction_post_message_spec.rb +94 -0
- data/spec/models/payment_transactions_message_spec.rb +46 -0
- data/spec/models/phone_log_message_spec.rb +64 -0
- data/spec/models/phone_log_participant_post_message_spec.rb +50 -0
- data/spec/models/phone_log_participant_unit_agreement_post_message_spec.rb +44 -0
- data/spec/models/phone_log_post_message_spec.rb +52 -0
- data/spec/models/phone_log_put_message_spec.rb +46 -0
- data/spec/models/phone_log_search_message_spec.rb +84 -0
- data/spec/models/phone_number_message_spec.rb +44 -0
- data/spec/models/phone_numbers_message_spec.rb +52 -0
- data/spec/models/property_group_message_spec.rb +58 -0
- data/spec/models/property_group_post_message_spec.rb +46 -0
- data/spec/models/property_group_put_message_spec.rb +46 -0
- data/spec/models/property_group_search_message_spec.rb +40 -0
- data/spec/models/property_manager_message_spec.rb +76 -0
- data/spec/models/property_message_spec.rb +50 -0
- data/spec/models/recurring_transaction_line_message_spec.rb +40 -0
- data/spec/models/recurring_transaction_line_post_message_spec.rb +40 -0
- data/spec/models/recurring_transaction_message_spec.rb +112 -0
- data/spec/models/rental_appliance_message_spec.rb +76 -0
- data/spec/models/rental_appliance_post_message_spec.rb +76 -0
- data/spec/models/rental_appliance_put_message_spec.rb +64 -0
- data/spec/models/rental_appliance_search_message_spec.rb +40 -0
- data/spec/models/rental_appliance_service_history_message_spec.rb +56 -0
- data/spec/models/rental_appliance_service_history_post_message_spec.rb +50 -0
- data/spec/models/rental_features_message_spec.rb +48 -0
- data/spec/models/rental_features_put_message_spec.rb +48 -0
- data/spec/models/rental_message_spec.rb +108 -0
- data/spec/models/rental_owner_message_spec.rb +118 -0
- data/spec/models/rental_owner_post_message_spec.rb +112 -0
- data/spec/models/rental_owner_put_message_spec.rb +106 -0
- data/spec/models/rental_owner_request_task_message_spec.rb +114 -0
- data/spec/models/rental_owner_request_task_post_message_spec.rb +102 -0
- data/spec/models/rental_owner_request_task_put_message_spec.rb +96 -0
- data/spec/models/rental_owner_request_task_search_message_spec.rb +112 -0
- data/spec/models/rental_owner_tax_information_message_spec.rb +68 -0
- data/spec/models/rental_owners_search_message_spec.rb +74 -0
- data/spec/models/rental_preferred_vendor_message_spec.rb +82 -0
- data/spec/models/rental_preferred_vendor_put_message_spec.rb +34 -0
- data/spec/models/rental_property_post_message_spec.rb +92 -0
- data/spec/models/rental_property_put_message_spec.rb +80 -0
- data/spec/models/rental_property_unit_post_message_spec.rb +78 -0
- data/spec/models/rental_search_message_spec.rb +88 -0
- data/spec/models/rental_tenant_post_message_spec.rb +110 -0
- data/spec/models/rental_tenant_put_message_spec.rb +104 -0
- data/spec/models/rental_tenant_renewal_post_message_spec.rb +104 -0
- data/spec/models/rental_unit_features_message_spec.rb +38 -0
- data/spec/models/rental_unit_features_put_message_spec.rb +38 -0
- data/spec/models/rental_unit_message_spec.rb +108 -0
- data/spec/models/rental_unit_put_message_spec.rb +78 -0
- data/spec/models/rental_unit_search_message_spec.rb +46 -0
- data/spec/models/rental_units_post_message_spec.rb +84 -0
- data/spec/models/requested_by_user_entity_message_spec.rb +68 -0
- data/spec/models/resident_center_user_message_spec.rb +56 -0
- data/spec/models/resident_center_user_reference_message_spec.rb +62 -0
- data/spec/models/resident_center_user_search_message_spec.rb +66 -0
- data/spec/models/resident_request_task_message_spec.rb +144 -0
- data/spec/models/resident_request_task_post_message_spec.rb +114 -0
- data/spec/models/resident_request_task_put_message_spec.rb +84 -0
- data/spec/models/resident_request_task_search_message_spec.rb +118 -0
- data/spec/models/save_address_message_spec.rb +74 -0
- data/spec/models/save_emergency_contact_message_spec.rb +52 -0
- data/spec/models/task_category_message_spec.rb +52 -0
- data/spec/models/task_category_put_message_spec.rb +34 -0
- data/spec/models/task_category_response_message_spec.rb +52 -0
- data/spec/models/task_category_save_message_spec.rb +34 -0
- data/spec/models/task_history_file_message_spec.rb +64 -0
- data/spec/models/task_history_file_upload_post_message_spec.rb +34 -0
- data/spec/models/task_history_message_spec.rb +112 -0
- data/spec/models/task_history_put_message_spec.rb +34 -0
- data/spec/models/task_history_user_message_spec.rb +52 -0
- data/spec/models/task_search_message_spec.rb +128 -0
- data/spec/models/task_sub_category_message_spec.rb +40 -0
- data/spec/models/tax_information_post_message_spec.rb +62 -0
- data/spec/models/tax_information_save_message_spec.rb +68 -0
- data/spec/models/tenant_message_spec.rb +128 -0
- data/spec/models/tenant_search_message_spec.rb +96 -0
- data/spec/models/to_do_task_message_spec.rb +108 -0
- data/spec/models/to_do_task_post_message_spec.rb +96 -0
- data/spec/models/to_do_task_put_message_spec.rb +96 -0
- data/spec/models/to_do_task_search_message_spec.rb +112 -0
- data/spec/models/undeposited_funds_message_spec.rb +34 -0
- data/spec/models/unit_agreement_message_spec.rb +50 -0
- data/spec/models/user_message_spec.rb +104 -0
- data/spec/models/user_role_message_spec.rb +52 -0
- data/spec/models/user_search_message_spec.rb +66 -0
- data/spec/models/vehicle_message_spec.rb +52 -0
- data/spec/models/vendor_category_message_spec.rb +46 -0
- data/spec/models/vendor_category_save_message_spec.rb +34 -0
- data/spec/models/vendor_credit_line_item_message_spec.rb +58 -0
- data/spec/models/vendor_credit_line_item_post_message_spec.rb +52 -0
- data/spec/models/vendor_credit_message_spec.rb +58 -0
- data/spec/models/vendor_credit_post_message_spec.rb +52 -0
- data/spec/models/vendor_insurance_message_spec.rb +46 -0
- data/spec/models/vendor_insurance_save_message_spec.rb +46 -0
- data/spec/models/vendor_message_spec.rb +130 -0
- data/spec/models/vendor_post_message_spec.rb +118 -0
- data/spec/models/vendor_put_message_spec.rb +118 -0
- data/spec/models/vendor_refund_line_message_spec.rb +58 -0
- data/spec/models/vendor_refund_line_post_message_spec.rb +52 -0
- data/spec/models/vendor_refund_message_spec.rb +74 -0
- data/spec/models/vendor_refund_post_message_spec.rb +68 -0
- data/spec/models/vendor_search_message_spec.rb +84 -0
- data/spec/models/vendor_tax_information_message_spec.rb +68 -0
- data/spec/models/vendor_transaction_message_spec.rb +68 -0
- data/spec/models/vendor_transaction_search_message_spec.rb +62 -0
- data/spec/models/work_order_entry_contact_message_spec.rb +40 -0
- data/spec/models/work_order_entry_contact_resource_message_spec.rb +44 -0
- data/spec/models/work_order_line_item_message_spec.rb +52 -0
- data/spec/models/work_order_line_item_save_message_spec.rb +52 -0
- data/spec/models/work_order_message_spec.rb +110 -0
- data/spec/models/work_order_post_message_spec.rb +98 -0
- data/spec/models/work_order_put_message_spec.rb +86 -0
- data/spec/models/work_order_search_message_spec.rb +158 -0
- data/spec/models/work_order_task_message_spec.rb +88 -0
- data/spec/models/work_order_task_post_message_spec.rb +78 -0
- data/spec/spec_helper.rb +111 -0
- metadata +1725 -0
@@ -0,0 +1,1097 @@
|
|
1
|
+
=begin
|
2
|
+
#Open API, powered by Buildium
|
3
|
+
|
4
|
+
#GetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account. * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: v1
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 6.0.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'cgi'
|
14
|
+
|
15
|
+
module Buildium
|
16
|
+
class CommunicationsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Create an announcement
|
23
|
+
# Creates and publishes an announcement. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications > Announcements</span> - `View` `Edit`
|
24
|
+
# @param announcement_post_message [AnnouncementPostMessage]
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [AnnouncementMessage]
|
27
|
+
def create_announcement(announcement_post_message, opts = {})
|
28
|
+
data, _status_code, _headers = create_announcement_with_http_info(announcement_post_message, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Create an announcement
|
33
|
+
# Creates and publishes an announcement. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Announcements</span> - `View` `Edit`
|
34
|
+
# @param announcement_post_message [AnnouncementPostMessage]
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(AnnouncementMessage, Integer, Hash)>] AnnouncementMessage data, response status code and response headers
|
37
|
+
def create_announcement_with_http_info(announcement_post_message, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: CommunicationsApi.create_announcement ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'announcement_post_message' is set
|
42
|
+
if @api_client.config.client_side_validation && announcement_post_message.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'announcement_post_message' when calling CommunicationsApi.create_announcement"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/v1/communications/announcements'
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = opts[:query_params] || {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = opts[:header_params] || {}
|
53
|
+
# HTTP header 'Accept' (if needed)
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
55
|
+
# HTTP header 'Content-Type'
|
56
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
57
|
+
if !content_type.nil?
|
58
|
+
header_params['Content-Type'] = content_type
|
59
|
+
end
|
60
|
+
|
61
|
+
# form parameters
|
62
|
+
form_params = opts[:form_params] || {}
|
63
|
+
|
64
|
+
# http body (model)
|
65
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(announcement_post_message)
|
66
|
+
|
67
|
+
# return_type
|
68
|
+
return_type = opts[:debug_return_type] || 'AnnouncementMessage'
|
69
|
+
|
70
|
+
# auth_names
|
71
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
72
|
+
|
73
|
+
new_options = opts.merge(
|
74
|
+
:operation => :"CommunicationsApi.create_announcement",
|
75
|
+
:header_params => header_params,
|
76
|
+
:query_params => query_params,
|
77
|
+
:form_params => form_params,
|
78
|
+
:body => post_body,
|
79
|
+
:auth_names => auth_names,
|
80
|
+
:return_type => return_type
|
81
|
+
)
|
82
|
+
|
83
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
84
|
+
if @api_client.config.debugging
|
85
|
+
@api_client.config.logger.debug "API called: CommunicationsApi#create_announcement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
86
|
+
end
|
87
|
+
return data, status_code, headers
|
88
|
+
end
|
89
|
+
|
90
|
+
# Create a phone log
|
91
|
+
# Creates a phone log. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications > Timelines (Phone Logs)</span> - `View` `Edit`
|
92
|
+
# @param phone_log_post_message [PhoneLogPostMessage]
|
93
|
+
# @param [Hash] opts the optional parameters
|
94
|
+
# @return [PhoneLogMessage]
|
95
|
+
def create_phone_log(phone_log_post_message, opts = {})
|
96
|
+
data, _status_code, _headers = create_phone_log_with_http_info(phone_log_post_message, opts)
|
97
|
+
data
|
98
|
+
end
|
99
|
+
|
100
|
+
# Create a phone log
|
101
|
+
# Creates a phone log. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Timelines (Phone Logs)</span> - `View` `Edit`
|
102
|
+
# @param phone_log_post_message [PhoneLogPostMessage]
|
103
|
+
# @param [Hash] opts the optional parameters
|
104
|
+
# @return [Array<(PhoneLogMessage, Integer, Hash)>] PhoneLogMessage data, response status code and response headers
|
105
|
+
def create_phone_log_with_http_info(phone_log_post_message, opts = {})
|
106
|
+
if @api_client.config.debugging
|
107
|
+
@api_client.config.logger.debug 'Calling API: CommunicationsApi.create_phone_log ...'
|
108
|
+
end
|
109
|
+
# verify the required parameter 'phone_log_post_message' is set
|
110
|
+
if @api_client.config.client_side_validation && phone_log_post_message.nil?
|
111
|
+
fail ArgumentError, "Missing the required parameter 'phone_log_post_message' when calling CommunicationsApi.create_phone_log"
|
112
|
+
end
|
113
|
+
# resource path
|
114
|
+
local_var_path = '/v1/communications/phonelogs'
|
115
|
+
|
116
|
+
# query parameters
|
117
|
+
query_params = opts[:query_params] || {}
|
118
|
+
|
119
|
+
# header parameters
|
120
|
+
header_params = opts[:header_params] || {}
|
121
|
+
# HTTP header 'Accept' (if needed)
|
122
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
123
|
+
# HTTP header 'Content-Type'
|
124
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
125
|
+
if !content_type.nil?
|
126
|
+
header_params['Content-Type'] = content_type
|
127
|
+
end
|
128
|
+
|
129
|
+
# form parameters
|
130
|
+
form_params = opts[:form_params] || {}
|
131
|
+
|
132
|
+
# http body (model)
|
133
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(phone_log_post_message)
|
134
|
+
|
135
|
+
# return_type
|
136
|
+
return_type = opts[:debug_return_type] || 'PhoneLogMessage'
|
137
|
+
|
138
|
+
# auth_names
|
139
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
140
|
+
|
141
|
+
new_options = opts.merge(
|
142
|
+
:operation => :"CommunicationsApi.create_phone_log",
|
143
|
+
:header_params => header_params,
|
144
|
+
:query_params => query_params,
|
145
|
+
:form_params => form_params,
|
146
|
+
:body => post_body,
|
147
|
+
:auth_names => auth_names,
|
148
|
+
:return_type => return_type
|
149
|
+
)
|
150
|
+
|
151
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
152
|
+
if @api_client.config.debugging
|
153
|
+
@api_client.config.logger.debug "API called: CommunicationsApi#create_phone_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
154
|
+
end
|
155
|
+
return data, status_code, headers
|
156
|
+
end
|
157
|
+
|
158
|
+
# Create an email.
|
159
|
+
# Creates an email <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communication > Emails</span> - `View` `Edit`
|
160
|
+
# @param email_post_message [EmailPostMessage]
|
161
|
+
# @param [Hash] opts the optional parameters
|
162
|
+
# @return [nil]
|
163
|
+
def emails_external_api_write_create_email(email_post_message, opts = {})
|
164
|
+
emails_external_api_write_create_email_with_http_info(email_post_message, opts)
|
165
|
+
nil
|
166
|
+
end
|
167
|
+
|
168
|
+
# Create an email.
|
169
|
+
# Creates an email <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communication &gt; Emails</span> - `View` `Edit`
|
170
|
+
# @param email_post_message [EmailPostMessage]
|
171
|
+
# @param [Hash] opts the optional parameters
|
172
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
173
|
+
def emails_external_api_write_create_email_with_http_info(email_post_message, opts = {})
|
174
|
+
if @api_client.config.debugging
|
175
|
+
@api_client.config.logger.debug 'Calling API: CommunicationsApi.emails_external_api_write_create_email ...'
|
176
|
+
end
|
177
|
+
# verify the required parameter 'email_post_message' is set
|
178
|
+
if @api_client.config.client_side_validation && email_post_message.nil?
|
179
|
+
fail ArgumentError, "Missing the required parameter 'email_post_message' when calling CommunicationsApi.emails_external_api_write_create_email"
|
180
|
+
end
|
181
|
+
# resource path
|
182
|
+
local_var_path = '/v1/communications/emails'
|
183
|
+
|
184
|
+
# query parameters
|
185
|
+
query_params = opts[:query_params] || {}
|
186
|
+
|
187
|
+
# header parameters
|
188
|
+
header_params = opts[:header_params] || {}
|
189
|
+
# HTTP header 'Accept' (if needed)
|
190
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
191
|
+
# HTTP header 'Content-Type'
|
192
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
193
|
+
if !content_type.nil?
|
194
|
+
header_params['Content-Type'] = content_type
|
195
|
+
end
|
196
|
+
|
197
|
+
# form parameters
|
198
|
+
form_params = opts[:form_params] || {}
|
199
|
+
|
200
|
+
# http body (model)
|
201
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(email_post_message)
|
202
|
+
|
203
|
+
# return_type
|
204
|
+
return_type = opts[:debug_return_type]
|
205
|
+
|
206
|
+
# auth_names
|
207
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
208
|
+
|
209
|
+
new_options = opts.merge(
|
210
|
+
:operation => :"CommunicationsApi.emails_external_api_write_create_email",
|
211
|
+
:header_params => header_params,
|
212
|
+
:query_params => query_params,
|
213
|
+
:form_params => form_params,
|
214
|
+
:body => post_body,
|
215
|
+
:auth_names => auth_names,
|
216
|
+
:return_type => return_type
|
217
|
+
)
|
218
|
+
|
219
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
220
|
+
if @api_client.config.debugging
|
221
|
+
@api_client.config.logger.debug "API called: CommunicationsApi#emails_external_api_write_create_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
222
|
+
end
|
223
|
+
return data, status_code, headers
|
224
|
+
end
|
225
|
+
|
226
|
+
# Expire an announcement
|
227
|
+
# Removes the announcement from the Resident Center immediately. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications > Announcements</span> - `View` `Edit`
|
228
|
+
# @param announcement_id [Integer]
|
229
|
+
# @param [Hash] opts the optional parameters
|
230
|
+
# @return [nil]
|
231
|
+
def expire_announcement(announcement_id, opts = {})
|
232
|
+
expire_announcement_with_http_info(announcement_id, opts)
|
233
|
+
nil
|
234
|
+
end
|
235
|
+
|
236
|
+
# Expire an announcement
|
237
|
+
# Removes the announcement from the Resident Center immediately. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Announcements</span> - `View` `Edit`
|
238
|
+
# @param announcement_id [Integer]
|
239
|
+
# @param [Hash] opts the optional parameters
|
240
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
241
|
+
def expire_announcement_with_http_info(announcement_id, opts = {})
|
242
|
+
if @api_client.config.debugging
|
243
|
+
@api_client.config.logger.debug 'Calling API: CommunicationsApi.expire_announcement ...'
|
244
|
+
end
|
245
|
+
# verify the required parameter 'announcement_id' is set
|
246
|
+
if @api_client.config.client_side_validation && announcement_id.nil?
|
247
|
+
fail ArgumentError, "Missing the required parameter 'announcement_id' when calling CommunicationsApi.expire_announcement"
|
248
|
+
end
|
249
|
+
# resource path
|
250
|
+
local_var_path = '/v1/communications/announcements/{announcementId}/expirationrequest'.sub('{' + 'announcementId' + '}', CGI.escape(announcement_id.to_s))
|
251
|
+
|
252
|
+
# query parameters
|
253
|
+
query_params = opts[:query_params] || {}
|
254
|
+
|
255
|
+
# header parameters
|
256
|
+
header_params = opts[:header_params] || {}
|
257
|
+
# HTTP header 'Accept' (if needed)
|
258
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
259
|
+
|
260
|
+
# form parameters
|
261
|
+
form_params = opts[:form_params] || {}
|
262
|
+
|
263
|
+
# http body (model)
|
264
|
+
post_body = opts[:debug_body]
|
265
|
+
|
266
|
+
# return_type
|
267
|
+
return_type = opts[:debug_return_type]
|
268
|
+
|
269
|
+
# auth_names
|
270
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
271
|
+
|
272
|
+
new_options = opts.merge(
|
273
|
+
:operation => :"CommunicationsApi.expire_announcement",
|
274
|
+
:header_params => header_params,
|
275
|
+
:query_params => query_params,
|
276
|
+
:form_params => form_params,
|
277
|
+
:body => post_body,
|
278
|
+
:auth_names => auth_names,
|
279
|
+
:return_type => return_type
|
280
|
+
)
|
281
|
+
|
282
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
283
|
+
if @api_client.config.debugging
|
284
|
+
@api_client.config.logger.debug "API called: CommunicationsApi#expire_announcement\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
285
|
+
end
|
286
|
+
return data, status_code, headers
|
287
|
+
end
|
288
|
+
|
289
|
+
# Retrieve all announcements
|
290
|
+
# Retrieves all announcements. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications > Announcements</span> - `View`
|
291
|
+
# @param [Hash] opts the optional parameters
|
292
|
+
# @option opts [Date] :announcementdatefrom Filters results to any announcements created on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
293
|
+
# @option opts [Date] :announcementdateto Filters results to any announcements created on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
294
|
+
# @option opts [Integer] :entityid Filters results to any announcement associated with the specified entity id value. The value must be of the type specified in the `EntityType` field.
|
295
|
+
# @option opts [String] :entitytype Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is provided.
|
296
|
+
# @option opts [Integer] :senderid Unique identifier of the user that published the announcement.
|
297
|
+
# @option opts [String] :orderby `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.
|
298
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
299
|
+
# @option opts [Integer] :limit `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.
|
300
|
+
# @return [Array<AnnouncementMessage>]
|
301
|
+
def get_all_announcements(opts = {})
|
302
|
+
data, _status_code, _headers = get_all_announcements_with_http_info(opts)
|
303
|
+
data
|
304
|
+
end
|
305
|
+
|
306
|
+
# Retrieve all announcements
|
307
|
+
# Retrieves all announcements. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Announcements</span> - `View`
|
308
|
+
# @param [Hash] opts the optional parameters
|
309
|
+
# @option opts [Date] :announcementdatefrom Filters results to any announcements created on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
310
|
+
# @option opts [Date] :announcementdateto Filters results to any announcements created on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
311
|
+
# @option opts [Integer] :entityid Filters results to any announcement associated with the specified entity id value. The value must be of the type specified in the `EntityType` field.
|
312
|
+
# @option opts [String] :entitytype Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is provided.
|
313
|
+
# @option opts [Integer] :senderid Unique identifier of the user that published the announcement.
|
314
|
+
# @option opts [String] :orderby `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.
|
315
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
316
|
+
# @option opts [Integer] :limit `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.
|
317
|
+
# @return [Array<(Array<AnnouncementMessage>, Integer, Hash)>] Array<AnnouncementMessage> data, response status code and response headers
|
318
|
+
def get_all_announcements_with_http_info(opts = {})
|
319
|
+
if @api_client.config.debugging
|
320
|
+
@api_client.config.logger.debug 'Calling API: CommunicationsApi.get_all_announcements ...'
|
321
|
+
end
|
322
|
+
allowable_values = ["Rental", "RentalOwner", "Association"]
|
323
|
+
if @api_client.config.client_side_validation && opts[:'entitytype'] && !allowable_values.include?(opts[:'entitytype'])
|
324
|
+
fail ArgumentError, "invalid value for \"entitytype\", must be one of #{allowable_values}"
|
325
|
+
end
|
326
|
+
# resource path
|
327
|
+
local_var_path = '/v1/communications/announcements'
|
328
|
+
|
329
|
+
# query parameters
|
330
|
+
query_params = opts[:query_params] || {}
|
331
|
+
query_params[:'announcementdatefrom'] = opts[:'announcementdatefrom'] if !opts[:'announcementdatefrom'].nil?
|
332
|
+
query_params[:'announcementdateto'] = opts[:'announcementdateto'] if !opts[:'announcementdateto'].nil?
|
333
|
+
query_params[:'entityid'] = opts[:'entityid'] if !opts[:'entityid'].nil?
|
334
|
+
query_params[:'entitytype'] = opts[:'entitytype'] if !opts[:'entitytype'].nil?
|
335
|
+
query_params[:'senderid'] = opts[:'senderid'] if !opts[:'senderid'].nil?
|
336
|
+
query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
|
337
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
338
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
339
|
+
|
340
|
+
# header parameters
|
341
|
+
header_params = opts[:header_params] || {}
|
342
|
+
# HTTP header 'Accept' (if needed)
|
343
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
344
|
+
|
345
|
+
# form parameters
|
346
|
+
form_params = opts[:form_params] || {}
|
347
|
+
|
348
|
+
# http body (model)
|
349
|
+
post_body = opts[:debug_body]
|
350
|
+
|
351
|
+
# return_type
|
352
|
+
return_type = opts[:debug_return_type] || 'Array<AnnouncementMessage>'
|
353
|
+
|
354
|
+
# auth_names
|
355
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
356
|
+
|
357
|
+
new_options = opts.merge(
|
358
|
+
:operation => :"CommunicationsApi.get_all_announcements",
|
359
|
+
:header_params => header_params,
|
360
|
+
:query_params => query_params,
|
361
|
+
:form_params => form_params,
|
362
|
+
:body => post_body,
|
363
|
+
:auth_names => auth_names,
|
364
|
+
:return_type => return_type
|
365
|
+
)
|
366
|
+
|
367
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
368
|
+
if @api_client.config.debugging
|
369
|
+
@api_client.config.logger.debug "API called: CommunicationsApi#get_all_announcements\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
370
|
+
end
|
371
|
+
return data, status_code, headers
|
372
|
+
end
|
373
|
+
|
374
|
+
# Retrieve an announcement
|
375
|
+
# Retrieves an announcement. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications > Announcements</span> - `View`
|
376
|
+
# @param announcement_id [Integer]
|
377
|
+
# @param [Hash] opts the optional parameters
|
378
|
+
# @return [AnnouncementMessage]
|
379
|
+
def get_announcement_by_id(announcement_id, opts = {})
|
380
|
+
data, _status_code, _headers = get_announcement_by_id_with_http_info(announcement_id, opts)
|
381
|
+
data
|
382
|
+
end
|
383
|
+
|
384
|
+
# Retrieve an announcement
|
385
|
+
# Retrieves an announcement. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Announcements</span> - `View`
|
386
|
+
# @param announcement_id [Integer]
|
387
|
+
# @param [Hash] opts the optional parameters
|
388
|
+
# @return [Array<(AnnouncementMessage, Integer, Hash)>] AnnouncementMessage data, response status code and response headers
|
389
|
+
def get_announcement_by_id_with_http_info(announcement_id, opts = {})
|
390
|
+
if @api_client.config.debugging
|
391
|
+
@api_client.config.logger.debug 'Calling API: CommunicationsApi.get_announcement_by_id ...'
|
392
|
+
end
|
393
|
+
# verify the required parameter 'announcement_id' is set
|
394
|
+
if @api_client.config.client_side_validation && announcement_id.nil?
|
395
|
+
fail ArgumentError, "Missing the required parameter 'announcement_id' when calling CommunicationsApi.get_announcement_by_id"
|
396
|
+
end
|
397
|
+
# resource path
|
398
|
+
local_var_path = '/v1/communications/announcements/{announcementId}'.sub('{' + 'announcementId' + '}', CGI.escape(announcement_id.to_s))
|
399
|
+
|
400
|
+
# query parameters
|
401
|
+
query_params = opts[:query_params] || {}
|
402
|
+
|
403
|
+
# header parameters
|
404
|
+
header_params = opts[:header_params] || {}
|
405
|
+
# HTTP header 'Accept' (if needed)
|
406
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
407
|
+
|
408
|
+
# form parameters
|
409
|
+
form_params = opts[:form_params] || {}
|
410
|
+
|
411
|
+
# http body (model)
|
412
|
+
post_body = opts[:debug_body]
|
413
|
+
|
414
|
+
# return_type
|
415
|
+
return_type = opts[:debug_return_type] || 'AnnouncementMessage'
|
416
|
+
|
417
|
+
# auth_names
|
418
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
419
|
+
|
420
|
+
new_options = opts.merge(
|
421
|
+
:operation => :"CommunicationsApi.get_announcement_by_id",
|
422
|
+
:header_params => header_params,
|
423
|
+
:query_params => query_params,
|
424
|
+
:form_params => form_params,
|
425
|
+
:body => post_body,
|
426
|
+
:auth_names => auth_names,
|
427
|
+
:return_type => return_type
|
428
|
+
)
|
429
|
+
|
430
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
431
|
+
if @api_client.config.debugging
|
432
|
+
@api_client.config.logger.debug "API called: CommunicationsApi#get_announcement_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
433
|
+
end
|
434
|
+
return data, status_code, headers
|
435
|
+
end
|
436
|
+
|
437
|
+
# Retrieve all announcement properties
|
438
|
+
# Retrieves a list of association and/or rental properties whose residents received the announcement. An empty response collection indicates that the announcement was sent to all properties at the time of its creation. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications > Announcements</span> - `View`
|
439
|
+
# @param announcement_id [Integer]
|
440
|
+
# @param [Hash] opts the optional parameters
|
441
|
+
# @option opts [String] :orderby `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.
|
442
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
443
|
+
# @option opts [Integer] :limit `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.
|
444
|
+
# @return [Array<PropertyMessage>]
|
445
|
+
def get_announcement_properties(announcement_id, opts = {})
|
446
|
+
data, _status_code, _headers = get_announcement_properties_with_http_info(announcement_id, opts)
|
447
|
+
data
|
448
|
+
end
|
449
|
+
|
450
|
+
# Retrieve all announcement properties
|
451
|
+
# Retrieves a list of association and/or rental properties whose residents received the announcement. An empty response collection indicates that the announcement was sent to all properties at the time of its creation. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Announcements</span> - `View`
|
452
|
+
# @param announcement_id [Integer]
|
453
|
+
# @param [Hash] opts the optional parameters
|
454
|
+
# @option opts [String] :orderby `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.
|
455
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
456
|
+
# @option opts [Integer] :limit `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.
|
457
|
+
# @return [Array<(Array<PropertyMessage>, Integer, Hash)>] Array<PropertyMessage> data, response status code and response headers
|
458
|
+
def get_announcement_properties_with_http_info(announcement_id, opts = {})
|
459
|
+
if @api_client.config.debugging
|
460
|
+
@api_client.config.logger.debug 'Calling API: CommunicationsApi.get_announcement_properties ...'
|
461
|
+
end
|
462
|
+
# verify the required parameter 'announcement_id' is set
|
463
|
+
if @api_client.config.client_side_validation && announcement_id.nil?
|
464
|
+
fail ArgumentError, "Missing the required parameter 'announcement_id' when calling CommunicationsApi.get_announcement_properties"
|
465
|
+
end
|
466
|
+
# resource path
|
467
|
+
local_var_path = '/v1/communications/announcements/{announcementId}/properties'.sub('{' + 'announcementId' + '}', CGI.escape(announcement_id.to_s))
|
468
|
+
|
469
|
+
# query parameters
|
470
|
+
query_params = opts[:query_params] || {}
|
471
|
+
query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
|
472
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
473
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
474
|
+
|
475
|
+
# header parameters
|
476
|
+
header_params = opts[:header_params] || {}
|
477
|
+
# HTTP header 'Accept' (if needed)
|
478
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
479
|
+
|
480
|
+
# form parameters
|
481
|
+
form_params = opts[:form_params] || {}
|
482
|
+
|
483
|
+
# http body (model)
|
484
|
+
post_body = opts[:debug_body]
|
485
|
+
|
486
|
+
# return_type
|
487
|
+
return_type = opts[:debug_return_type] || 'Array<PropertyMessage>'
|
488
|
+
|
489
|
+
# auth_names
|
490
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
491
|
+
|
492
|
+
new_options = opts.merge(
|
493
|
+
:operation => :"CommunicationsApi.get_announcement_properties",
|
494
|
+
:header_params => header_params,
|
495
|
+
:query_params => query_params,
|
496
|
+
:form_params => form_params,
|
497
|
+
:body => post_body,
|
498
|
+
:auth_names => auth_names,
|
499
|
+
:return_type => return_type
|
500
|
+
)
|
501
|
+
|
502
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
503
|
+
if @api_client.config.debugging
|
504
|
+
@api_client.config.logger.debug "API called: CommunicationsApi#get_announcement_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
505
|
+
end
|
506
|
+
return data, status_code, headers
|
507
|
+
end
|
508
|
+
|
509
|
+
# Retrieve an email
|
510
|
+
# Retrieves an email. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications > Emails</span> - `View`
|
511
|
+
# @param email_id [Integer]
|
512
|
+
# @param [Hash] opts the optional parameters
|
513
|
+
# @return [EmailMessage]
|
514
|
+
def get_email_by_id(email_id, opts = {})
|
515
|
+
data, _status_code, _headers = get_email_by_id_with_http_info(email_id, opts)
|
516
|
+
data
|
517
|
+
end
|
518
|
+
|
519
|
+
# Retrieve an email
|
520
|
+
# Retrieves an email. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Emails</span> - `View`
|
521
|
+
# @param email_id [Integer]
|
522
|
+
# @param [Hash] opts the optional parameters
|
523
|
+
# @return [Array<(EmailMessage, Integer, Hash)>] EmailMessage data, response status code and response headers
|
524
|
+
def get_email_by_id_with_http_info(email_id, opts = {})
|
525
|
+
if @api_client.config.debugging
|
526
|
+
@api_client.config.logger.debug 'Calling API: CommunicationsApi.get_email_by_id ...'
|
527
|
+
end
|
528
|
+
# verify the required parameter 'email_id' is set
|
529
|
+
if @api_client.config.client_side_validation && email_id.nil?
|
530
|
+
fail ArgumentError, "Missing the required parameter 'email_id' when calling CommunicationsApi.get_email_by_id"
|
531
|
+
end
|
532
|
+
# resource path
|
533
|
+
local_var_path = '/v1/communications/emails/{emailId}'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
|
534
|
+
|
535
|
+
# query parameters
|
536
|
+
query_params = opts[:query_params] || {}
|
537
|
+
|
538
|
+
# header parameters
|
539
|
+
header_params = opts[:header_params] || {}
|
540
|
+
# HTTP header 'Accept' (if needed)
|
541
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
542
|
+
|
543
|
+
# form parameters
|
544
|
+
form_params = opts[:form_params] || {}
|
545
|
+
|
546
|
+
# http body (model)
|
547
|
+
post_body = opts[:debug_body]
|
548
|
+
|
549
|
+
# return_type
|
550
|
+
return_type = opts[:debug_return_type] || 'EmailMessage'
|
551
|
+
|
552
|
+
# auth_names
|
553
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
554
|
+
|
555
|
+
new_options = opts.merge(
|
556
|
+
:operation => :"CommunicationsApi.get_email_by_id",
|
557
|
+
:header_params => header_params,
|
558
|
+
:query_params => query_params,
|
559
|
+
:form_params => form_params,
|
560
|
+
:body => post_body,
|
561
|
+
:auth_names => auth_names,
|
562
|
+
:return_type => return_type
|
563
|
+
)
|
564
|
+
|
565
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
566
|
+
if @api_client.config.debugging
|
567
|
+
@api_client.config.logger.debug "API called: CommunicationsApi#get_email_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
568
|
+
end
|
569
|
+
return data, status_code, headers
|
570
|
+
end
|
571
|
+
|
572
|
+
# Retrieve all email recipients
|
573
|
+
# Retrieves all email recipients. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications > Email</span> - `View` <br /><h4>Optional Permissions:</h4><br /> The following permissions are optional, but results with a missing permission will be filtered out. <span class=\"permissionBlock\">Maintenance > Vendors</span> - `View` In order to retrieve recipients that are Vendors, you must have this permission. <span class=\"permissionBlock\">Administration > Users</span> - `View` In order to see recipients that are Staff, you must have this permission.
|
574
|
+
# @param email_id [Integer]
|
575
|
+
# @param [Hash] opts the optional parameters
|
576
|
+
# @option opts [String] :orderby `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.
|
577
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
578
|
+
# @option opts [Integer] :limit `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.
|
579
|
+
# @return [Array<EmailRecipientMessage>]
|
580
|
+
def get_email_recipients(email_id, opts = {})
|
581
|
+
data, _status_code, _headers = get_email_recipients_with_http_info(email_id, opts)
|
582
|
+
data
|
583
|
+
end
|
584
|
+
|
585
|
+
# Retrieve all email recipients
|
586
|
+
# Retrieves all email recipients. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Email</span> - `View` <br /><h4>Optional Permissions:</h4><br /> The following permissions are optional, but results with a missing permission will be filtered out. <span class=\"permissionBlock\">Maintenance &gt; Vendors</span> - `View` In order to retrieve recipients that are Vendors, you must have this permission. <span class=\"permissionBlock\">Administration &gt; Users</span> - `View` In order to see recipients that are Staff, you must have this permission.
|
587
|
+
# @param email_id [Integer]
|
588
|
+
# @param [Hash] opts the optional parameters
|
589
|
+
# @option opts [String] :orderby `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.
|
590
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
591
|
+
# @option opts [Integer] :limit `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.
|
592
|
+
# @return [Array<(Array<EmailRecipientMessage>, Integer, Hash)>] Array<EmailRecipientMessage> data, response status code and response headers
|
593
|
+
def get_email_recipients_with_http_info(email_id, opts = {})
|
594
|
+
if @api_client.config.debugging
|
595
|
+
@api_client.config.logger.debug 'Calling API: CommunicationsApi.get_email_recipients ...'
|
596
|
+
end
|
597
|
+
# verify the required parameter 'email_id' is set
|
598
|
+
if @api_client.config.client_side_validation && email_id.nil?
|
599
|
+
fail ArgumentError, "Missing the required parameter 'email_id' when calling CommunicationsApi.get_email_recipients"
|
600
|
+
end
|
601
|
+
# resource path
|
602
|
+
local_var_path = '/v1/communications/emails/{emailId}/recipients'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
|
603
|
+
|
604
|
+
# query parameters
|
605
|
+
query_params = opts[:query_params] || {}
|
606
|
+
query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
|
607
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
608
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
609
|
+
|
610
|
+
# header parameters
|
611
|
+
header_params = opts[:header_params] || {}
|
612
|
+
# HTTP header 'Accept' (if needed)
|
613
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
614
|
+
|
615
|
+
# form parameters
|
616
|
+
form_params = opts[:form_params] || {}
|
617
|
+
|
618
|
+
# http body (model)
|
619
|
+
post_body = opts[:debug_body]
|
620
|
+
|
621
|
+
# return_type
|
622
|
+
return_type = opts[:debug_return_type] || 'Array<EmailRecipientMessage>'
|
623
|
+
|
624
|
+
# auth_names
|
625
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
626
|
+
|
627
|
+
new_options = opts.merge(
|
628
|
+
:operation => :"CommunicationsApi.get_email_recipients",
|
629
|
+
:header_params => header_params,
|
630
|
+
:query_params => query_params,
|
631
|
+
:form_params => form_params,
|
632
|
+
:body => post_body,
|
633
|
+
:auth_names => auth_names,
|
634
|
+
:return_type => return_type
|
635
|
+
)
|
636
|
+
|
637
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
638
|
+
if @api_client.config.debugging
|
639
|
+
@api_client.config.logger.debug "API called: CommunicationsApi#get_email_recipients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
640
|
+
end
|
641
|
+
return data, status_code, headers
|
642
|
+
end
|
643
|
+
|
644
|
+
# Retrieve all emails
|
645
|
+
# Retrieves all emails. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communication > Emails</span> - `View`
|
646
|
+
# @param sentdatetimefrom [Time] Filters results to any emails whose sent date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DDTHH:MM:SSZ. The maximum date range is 90 days.
|
647
|
+
# @param sentdatetimeto [Time] Filters results to any emails whose sent date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DDTHH:MM:SSZ. The maximum date range is 90 days.
|
648
|
+
# @param [Hash] opts the optional parameters
|
649
|
+
# @option opts [String] :subject Filters results to any email whose subject *contains* the specified value.
|
650
|
+
# @option opts [String] :recipientnameoremail Filters results to any email with a recipient whose name or email address *contains* the specified value.
|
651
|
+
# @option opts [Integer] :senderuserid Filters results to only emails that were sent by the specified user identifier.
|
652
|
+
# @option opts [String] :orderby `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.
|
653
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
654
|
+
# @option opts [Integer] :limit `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.
|
655
|
+
# @return [Array<EmailMessage>]
|
656
|
+
def get_emails(sentdatetimefrom, sentdatetimeto, opts = {})
|
657
|
+
data, _status_code, _headers = get_emails_with_http_info(sentdatetimefrom, sentdatetimeto, opts)
|
658
|
+
data
|
659
|
+
end
|
660
|
+
|
661
|
+
# Retrieve all emails
|
662
|
+
# Retrieves all emails. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communication &gt; Emails</span> - `View`
|
663
|
+
# @param sentdatetimefrom [Time] Filters results to any emails whose sent date and time are greater than or equal to the specified value. The value must be formatted as YYYY-MM-DDTHH:MM:SSZ. The maximum date range is 90 days.
|
664
|
+
# @param sentdatetimeto [Time] Filters results to any emails whose sent date and time are less than or equal to the specified value. The value must be formatted as YYYY-MM-DDTHH:MM:SSZ. The maximum date range is 90 days.
|
665
|
+
# @param [Hash] opts the optional parameters
|
666
|
+
# @option opts [String] :subject Filters results to any email whose subject *contains* the specified value.
|
667
|
+
# @option opts [String] :recipientnameoremail Filters results to any email with a recipient whose name or email address *contains* the specified value.
|
668
|
+
# @option opts [Integer] :senderuserid Filters results to only emails that were sent by the specified user identifier.
|
669
|
+
# @option opts [String] :orderby `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.
|
670
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
671
|
+
# @option opts [Integer] :limit `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.
|
672
|
+
# @return [Array<(Array<EmailMessage>, Integer, Hash)>] Array<EmailMessage> data, response status code and response headers
|
673
|
+
def get_emails_with_http_info(sentdatetimefrom, sentdatetimeto, opts = {})
|
674
|
+
if @api_client.config.debugging
|
675
|
+
@api_client.config.logger.debug 'Calling API: CommunicationsApi.get_emails ...'
|
676
|
+
end
|
677
|
+
# verify the required parameter 'sentdatetimefrom' is set
|
678
|
+
if @api_client.config.client_side_validation && sentdatetimefrom.nil?
|
679
|
+
fail ArgumentError, "Missing the required parameter 'sentdatetimefrom' when calling CommunicationsApi.get_emails"
|
680
|
+
end
|
681
|
+
# verify the required parameter 'sentdatetimeto' is set
|
682
|
+
if @api_client.config.client_side_validation && sentdatetimeto.nil?
|
683
|
+
fail ArgumentError, "Missing the required parameter 'sentdatetimeto' when calling CommunicationsApi.get_emails"
|
684
|
+
end
|
685
|
+
# resource path
|
686
|
+
local_var_path = '/v1/communications/emails'
|
687
|
+
|
688
|
+
# query parameters
|
689
|
+
query_params = opts[:query_params] || {}
|
690
|
+
query_params[:'sentdatetimefrom'] = sentdatetimefrom
|
691
|
+
query_params[:'sentdatetimeto'] = sentdatetimeto
|
692
|
+
query_params[:'subject'] = opts[:'subject'] if !opts[:'subject'].nil?
|
693
|
+
query_params[:'recipientnameoremail'] = opts[:'recipientnameoremail'] if !opts[:'recipientnameoremail'].nil?
|
694
|
+
query_params[:'senderuserid'] = opts[:'senderuserid'] if !opts[:'senderuserid'].nil?
|
695
|
+
query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
|
696
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
697
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
698
|
+
|
699
|
+
# header parameters
|
700
|
+
header_params = opts[:header_params] || {}
|
701
|
+
# HTTP header 'Accept' (if needed)
|
702
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
703
|
+
|
704
|
+
# form parameters
|
705
|
+
form_params = opts[:form_params] || {}
|
706
|
+
|
707
|
+
# http body (model)
|
708
|
+
post_body = opts[:debug_body]
|
709
|
+
|
710
|
+
# return_type
|
711
|
+
return_type = opts[:debug_return_type] || 'Array<EmailMessage>'
|
712
|
+
|
713
|
+
# auth_names
|
714
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
715
|
+
|
716
|
+
new_options = opts.merge(
|
717
|
+
:operation => :"CommunicationsApi.get_emails",
|
718
|
+
:header_params => header_params,
|
719
|
+
:query_params => query_params,
|
720
|
+
:form_params => form_params,
|
721
|
+
:body => post_body,
|
722
|
+
:auth_names => auth_names,
|
723
|
+
:return_type => return_type
|
724
|
+
)
|
725
|
+
|
726
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
727
|
+
if @api_client.config.debugging
|
728
|
+
@api_client.config.logger.debug "API called: CommunicationsApi#get_emails\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
729
|
+
end
|
730
|
+
return data, status_code, headers
|
731
|
+
end
|
732
|
+
|
733
|
+
# Retrieve all communication templates
|
734
|
+
# Retrieves all mailing and email templates. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications > Mailing Templates</span> - `View` <br /><h4>Optional Permissions:</h4><span class=\"permissionBlock\">Rentals > Tenants</span> - `View` <br /><span class=\"permissionBlock\">Rentals > Property Rental owners</span> - `View` <br /><span class=\"permissionBlock\">Associations > Association owners and tenants</span> - `View` <br /><span class=\"permissionBlock\">Maintenance > Vendors</span> - `View` <br /><span class=\"permissionBlock\">Rentals > Applicants</span> - `View`
|
735
|
+
# @param [Hash] opts the optional parameters
|
736
|
+
# @option opts [String] :orderby `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.
|
737
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
738
|
+
# @option opts [Integer] :limit `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.
|
739
|
+
# @return [Array<MailingTemplateMessage>]
|
740
|
+
def get_mailing_templates(opts = {})
|
741
|
+
data, _status_code, _headers = get_mailing_templates_with_http_info(opts)
|
742
|
+
data
|
743
|
+
end
|
744
|
+
|
745
|
+
# Retrieve all communication templates
|
746
|
+
# Retrieves all mailing and email templates. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Mailing Templates</span> - `View` <br /><h4>Optional Permissions:</h4><span class=\"permissionBlock\">Rentals &gt; Tenants</span> - `View` <br /><span class=\"permissionBlock\">Rentals &gt; Property Rental owners</span> - `View` <br /><span class=\"permissionBlock\">Associations &gt; Association owners and tenants</span> - `View` <br /><span class=\"permissionBlock\">Maintenance &gt; Vendors</span> - `View` <br /><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View`
|
747
|
+
# @param [Hash] opts the optional parameters
|
748
|
+
# @option opts [String] :orderby `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.
|
749
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
750
|
+
# @option opts [Integer] :limit `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.
|
751
|
+
# @return [Array<(Array<MailingTemplateMessage>, Integer, Hash)>] Array<MailingTemplateMessage> data, response status code and response headers
|
752
|
+
def get_mailing_templates_with_http_info(opts = {})
|
753
|
+
if @api_client.config.debugging
|
754
|
+
@api_client.config.logger.debug 'Calling API: CommunicationsApi.get_mailing_templates ...'
|
755
|
+
end
|
756
|
+
# resource path
|
757
|
+
local_var_path = '/v1/communications/templates'
|
758
|
+
|
759
|
+
# query parameters
|
760
|
+
query_params = opts[:query_params] || {}
|
761
|
+
query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
|
762
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
763
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
764
|
+
|
765
|
+
# header parameters
|
766
|
+
header_params = opts[:header_params] || {}
|
767
|
+
# HTTP header 'Accept' (if needed)
|
768
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
769
|
+
|
770
|
+
# form parameters
|
771
|
+
form_params = opts[:form_params] || {}
|
772
|
+
|
773
|
+
# http body (model)
|
774
|
+
post_body = opts[:debug_body]
|
775
|
+
|
776
|
+
# return_type
|
777
|
+
return_type = opts[:debug_return_type] || 'Array<MailingTemplateMessage>'
|
778
|
+
|
779
|
+
# auth_names
|
780
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
781
|
+
|
782
|
+
new_options = opts.merge(
|
783
|
+
:operation => :"CommunicationsApi.get_mailing_templates",
|
784
|
+
:header_params => header_params,
|
785
|
+
:query_params => query_params,
|
786
|
+
:form_params => form_params,
|
787
|
+
:body => post_body,
|
788
|
+
:auth_names => auth_names,
|
789
|
+
:return_type => return_type
|
790
|
+
)
|
791
|
+
|
792
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
793
|
+
if @api_client.config.debugging
|
794
|
+
@api_client.config.logger.debug "API called: CommunicationsApi#get_mailing_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
795
|
+
end
|
796
|
+
return data, status_code, headers
|
797
|
+
end
|
798
|
+
|
799
|
+
# Retrieve a communication template
|
800
|
+
# Retrieves a communication template. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications > Mailing Templates</span> - `View` <br /><h4>Optional Permissions:</h4><span class=\"permissionBlock\">Rentals > Tenants</span> - `View` <br /><span class=\"permissionBlock\">Rentals > Property Rental owners</span> - `View` <br /><span class=\"permissionBlock\">Associations > Association owners and tenants</span> - `View` <br /><span class=\"permissionBlock\">Maintenance > Vendors</span> - `View` <br /><span class=\"permissionBlock\">Rentals > Applicants</span> - `View`
|
801
|
+
# @param template_id [Integer]
|
802
|
+
# @param [Hash] opts the optional parameters
|
803
|
+
# @return [MailingTemplateMessage]
|
804
|
+
def get_mailing_templates_by_id(template_id, opts = {})
|
805
|
+
data, _status_code, _headers = get_mailing_templates_by_id_with_http_info(template_id, opts)
|
806
|
+
data
|
807
|
+
end
|
808
|
+
|
809
|
+
# Retrieve a communication template
|
810
|
+
# Retrieves a communication template. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Mailing Templates</span> - `View` <br /><h4>Optional Permissions:</h4><span class=\"permissionBlock\">Rentals &gt; Tenants</span> - `View` <br /><span class=\"permissionBlock\">Rentals &gt; Property Rental owners</span> - `View` <br /><span class=\"permissionBlock\">Associations &gt; Association owners and tenants</span> - `View` <br /><span class=\"permissionBlock\">Maintenance &gt; Vendors</span> - `View` <br /><span class=\"permissionBlock\">Rentals &gt; Applicants</span> - `View`
|
811
|
+
# @param template_id [Integer]
|
812
|
+
# @param [Hash] opts the optional parameters
|
813
|
+
# @return [Array<(MailingTemplateMessage, Integer, Hash)>] MailingTemplateMessage data, response status code and response headers
|
814
|
+
def get_mailing_templates_by_id_with_http_info(template_id, opts = {})
|
815
|
+
if @api_client.config.debugging
|
816
|
+
@api_client.config.logger.debug 'Calling API: CommunicationsApi.get_mailing_templates_by_id ...'
|
817
|
+
end
|
818
|
+
# verify the required parameter 'template_id' is set
|
819
|
+
if @api_client.config.client_side_validation && template_id.nil?
|
820
|
+
fail ArgumentError, "Missing the required parameter 'template_id' when calling CommunicationsApi.get_mailing_templates_by_id"
|
821
|
+
end
|
822
|
+
# resource path
|
823
|
+
local_var_path = '/v1/communications/templates/{templateId}'.sub('{' + 'templateId' + '}', CGI.escape(template_id.to_s))
|
824
|
+
|
825
|
+
# query parameters
|
826
|
+
query_params = opts[:query_params] || {}
|
827
|
+
|
828
|
+
# header parameters
|
829
|
+
header_params = opts[:header_params] || {}
|
830
|
+
# HTTP header 'Accept' (if needed)
|
831
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
832
|
+
|
833
|
+
# form parameters
|
834
|
+
form_params = opts[:form_params] || {}
|
835
|
+
|
836
|
+
# http body (model)
|
837
|
+
post_body = opts[:debug_body]
|
838
|
+
|
839
|
+
# return_type
|
840
|
+
return_type = opts[:debug_return_type] || 'MailingTemplateMessage'
|
841
|
+
|
842
|
+
# auth_names
|
843
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
844
|
+
|
845
|
+
new_options = opts.merge(
|
846
|
+
:operation => :"CommunicationsApi.get_mailing_templates_by_id",
|
847
|
+
:header_params => header_params,
|
848
|
+
:query_params => query_params,
|
849
|
+
:form_params => form_params,
|
850
|
+
:body => post_body,
|
851
|
+
:auth_names => auth_names,
|
852
|
+
:return_type => return_type
|
853
|
+
)
|
854
|
+
|
855
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
856
|
+
if @api_client.config.debugging
|
857
|
+
@api_client.config.logger.debug "API called: CommunicationsApi#get_mailing_templates_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
858
|
+
end
|
859
|
+
return data, status_code, headers
|
860
|
+
end
|
861
|
+
|
862
|
+
# Retrieve a phone log
|
863
|
+
# Retrieves a specific phone log. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications > Timelines (Phone Logs)</span> - `View`
|
864
|
+
# @param phone_log_id [Integer] The phone log identifier
|
865
|
+
# @param [Hash] opts the optional parameters
|
866
|
+
# @return [PhoneLogMessage]
|
867
|
+
def get_phone_log_by_id(phone_log_id, opts = {})
|
868
|
+
data, _status_code, _headers = get_phone_log_by_id_with_http_info(phone_log_id, opts)
|
869
|
+
data
|
870
|
+
end
|
871
|
+
|
872
|
+
# Retrieve a phone log
|
873
|
+
# Retrieves a specific phone log. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Timelines (Phone Logs)</span> - `View`
|
874
|
+
# @param phone_log_id [Integer] The phone log identifier
|
875
|
+
# @param [Hash] opts the optional parameters
|
876
|
+
# @return [Array<(PhoneLogMessage, Integer, Hash)>] PhoneLogMessage data, response status code and response headers
|
877
|
+
def get_phone_log_by_id_with_http_info(phone_log_id, opts = {})
|
878
|
+
if @api_client.config.debugging
|
879
|
+
@api_client.config.logger.debug 'Calling API: CommunicationsApi.get_phone_log_by_id ...'
|
880
|
+
end
|
881
|
+
# verify the required parameter 'phone_log_id' is set
|
882
|
+
if @api_client.config.client_side_validation && phone_log_id.nil?
|
883
|
+
fail ArgumentError, "Missing the required parameter 'phone_log_id' when calling CommunicationsApi.get_phone_log_by_id"
|
884
|
+
end
|
885
|
+
# resource path
|
886
|
+
local_var_path = '/v1/communications/phonelogs/{phoneLogId}'.sub('{' + 'phoneLogId' + '}', CGI.escape(phone_log_id.to_s))
|
887
|
+
|
888
|
+
# query parameters
|
889
|
+
query_params = opts[:query_params] || {}
|
890
|
+
|
891
|
+
# header parameters
|
892
|
+
header_params = opts[:header_params] || {}
|
893
|
+
# HTTP header 'Accept' (if needed)
|
894
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
895
|
+
|
896
|
+
# form parameters
|
897
|
+
form_params = opts[:form_params] || {}
|
898
|
+
|
899
|
+
# http body (model)
|
900
|
+
post_body = opts[:debug_body]
|
901
|
+
|
902
|
+
# return_type
|
903
|
+
return_type = opts[:debug_return_type] || 'PhoneLogMessage'
|
904
|
+
|
905
|
+
# auth_names
|
906
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
907
|
+
|
908
|
+
new_options = opts.merge(
|
909
|
+
:operation => :"CommunicationsApi.get_phone_log_by_id",
|
910
|
+
:header_params => header_params,
|
911
|
+
:query_params => query_params,
|
912
|
+
:form_params => form_params,
|
913
|
+
:body => post_body,
|
914
|
+
:auth_names => auth_names,
|
915
|
+
:return_type => return_type
|
916
|
+
)
|
917
|
+
|
918
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
919
|
+
if @api_client.config.debugging
|
920
|
+
@api_client.config.logger.debug "API called: CommunicationsApi#get_phone_log_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
921
|
+
end
|
922
|
+
return data, status_code, headers
|
923
|
+
end
|
924
|
+
|
925
|
+
# Retrieve all phone logs
|
926
|
+
# Retrieves all phone logs. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications > Timelines (Phone Logs)</span> - `View`
|
927
|
+
# @param [Hash] opts the optional parameters
|
928
|
+
# @option opts [Date] :fromdate Filters results to any phone log whose call date is greater than or equal to the specified value.
|
929
|
+
# @option opts [Date] :todate Filters results to any phone log whose call date is less than or equal to the specified value.
|
930
|
+
# @option opts [Array<Integer>] :loggedbystaffuserids Filters results to any phone log that was logged by staff user(s).
|
931
|
+
# @option opts [String] :subject Filters results to any phone log whose subject *contains* the specified value.
|
932
|
+
# @option opts [Integer] :participantentityid Filters results to any phone logs that match the participant identifier. Note, if a value is provided in this field the `ParticipantEntityType` must also be provided.
|
933
|
+
# @option opts [String] :participantentitytype Filters results to any phone log with the specified participant type. This field is required if a value is provided for the `ParticipantEntityId` field.
|
934
|
+
# @option opts [Integer] :unitagreementid Filters results to any phone log with the specified unit agreement identifier. Note, if a value is provided in this field the `UnitAgreementType` must also be provided.
|
935
|
+
# @option opts [String] :unitagreementtype Filters results to any phone log with the specified unit agreement type. This field is required if a value is provided for the `UnitAgreementId` field.
|
936
|
+
# @option opts [String] :orderby `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.
|
937
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
938
|
+
# @option opts [Integer] :limit `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.
|
939
|
+
# @return [Array<PhoneLogMessage>]
|
940
|
+
def get_phone_logs(opts = {})
|
941
|
+
data, _status_code, _headers = get_phone_logs_with_http_info(opts)
|
942
|
+
data
|
943
|
+
end
|
944
|
+
|
945
|
+
# Retrieve all phone logs
|
946
|
+
# Retrieves all phone logs. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Communications &gt; Timelines (Phone Logs)</span> - `View`
|
947
|
+
# @param [Hash] opts the optional parameters
|
948
|
+
# @option opts [Date] :fromdate Filters results to any phone log whose call date is greater than or equal to the specified value.
|
949
|
+
# @option opts [Date] :todate Filters results to any phone log whose call date is less than or equal to the specified value.
|
950
|
+
# @option opts [Array<Integer>] :loggedbystaffuserids Filters results to any phone log that was logged by staff user(s).
|
951
|
+
# @option opts [String] :subject Filters results to any phone log whose subject *contains* the specified value.
|
952
|
+
# @option opts [Integer] :participantentityid Filters results to any phone logs that match the participant identifier. Note, if a value is provided in this field the `ParticipantEntityType` must also be provided.
|
953
|
+
# @option opts [String] :participantentitytype Filters results to any phone log with the specified participant type. This field is required if a value is provided for the `ParticipantEntityId` field.
|
954
|
+
# @option opts [Integer] :unitagreementid Filters results to any phone log with the specified unit agreement identifier. Note, if a value is provided in this field the `UnitAgreementType` must also be provided.
|
955
|
+
# @option opts [String] :unitagreementtype Filters results to any phone log with the specified unit agreement type. This field is required if a value is provided for the `UnitAgreementId` field.
|
956
|
+
# @option opts [String] :orderby `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.
|
957
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
958
|
+
# @option opts [Integer] :limit `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.
|
959
|
+
# @return [Array<(Array<PhoneLogMessage>, Integer, Hash)>] Array<PhoneLogMessage> data, response status code and response headers
|
960
|
+
def get_phone_logs_with_http_info(opts = {})
|
961
|
+
if @api_client.config.debugging
|
962
|
+
@api_client.config.logger.debug 'Calling API: CommunicationsApi.get_phone_logs ...'
|
963
|
+
end
|
964
|
+
allowable_values = ["Vendor", "RentalOwner", "RentalTenant", "AssociationOwner"]
|
965
|
+
if @api_client.config.client_side_validation && opts[:'participantentitytype'] && !allowable_values.include?(opts[:'participantentitytype'])
|
966
|
+
fail ArgumentError, "invalid value for \"participantentitytype\", must be one of #{allowable_values}"
|
967
|
+
end
|
968
|
+
allowable_values = ["Lease", "OwnershipAccount"]
|
969
|
+
if @api_client.config.client_side_validation && opts[:'unitagreementtype'] && !allowable_values.include?(opts[:'unitagreementtype'])
|
970
|
+
fail ArgumentError, "invalid value for \"unitagreementtype\", must be one of #{allowable_values}"
|
971
|
+
end
|
972
|
+
# resource path
|
973
|
+
local_var_path = '/v1/communications/phonelogs'
|
974
|
+
|
975
|
+
# query parameters
|
976
|
+
query_params = opts[:query_params] || {}
|
977
|
+
query_params[:'fromdate'] = opts[:'fromdate'] if !opts[:'fromdate'].nil?
|
978
|
+
query_params[:'todate'] = opts[:'todate'] if !opts[:'todate'].nil?
|
979
|
+
query_params[:'loggedbystaffuserids'] = @api_client.build_collection_param(opts[:'loggedbystaffuserids'], :multi) if !opts[:'loggedbystaffuserids'].nil?
|
980
|
+
query_params[:'subject'] = opts[:'subject'] if !opts[:'subject'].nil?
|
981
|
+
query_params[:'participantentityid'] = opts[:'participantentityid'] if !opts[:'participantentityid'].nil?
|
982
|
+
query_params[:'participantentitytype'] = opts[:'participantentitytype'] if !opts[:'participantentitytype'].nil?
|
983
|
+
query_params[:'unitagreementid'] = opts[:'unitagreementid'] if !opts[:'unitagreementid'].nil?
|
984
|
+
query_params[:'unitagreementtype'] = opts[:'unitagreementtype'] if !opts[:'unitagreementtype'].nil?
|
985
|
+
query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
|
986
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
987
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
988
|
+
|
989
|
+
# header parameters
|
990
|
+
header_params = opts[:header_params] || {}
|
991
|
+
# HTTP header 'Accept' (if needed)
|
992
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
993
|
+
|
994
|
+
# form parameters
|
995
|
+
form_params = opts[:form_params] || {}
|
996
|
+
|
997
|
+
# http body (model)
|
998
|
+
post_body = opts[:debug_body]
|
999
|
+
|
1000
|
+
# return_type
|
1001
|
+
return_type = opts[:debug_return_type] || 'Array<PhoneLogMessage>'
|
1002
|
+
|
1003
|
+
# auth_names
|
1004
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
1005
|
+
|
1006
|
+
new_options = opts.merge(
|
1007
|
+
:operation => :"CommunicationsApi.get_phone_logs",
|
1008
|
+
:header_params => header_params,
|
1009
|
+
:query_params => query_params,
|
1010
|
+
:form_params => form_params,
|
1011
|
+
:body => post_body,
|
1012
|
+
:auth_names => auth_names,
|
1013
|
+
:return_type => return_type
|
1014
|
+
)
|
1015
|
+
|
1016
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1017
|
+
if @api_client.config.debugging
|
1018
|
+
@api_client.config.logger.debug "API called: CommunicationsApi#get_phone_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1019
|
+
end
|
1020
|
+
return data, status_code, headers
|
1021
|
+
end
|
1022
|
+
|
1023
|
+
# Update a phone log
|
1024
|
+
# Update a phone log <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\">Communications > Timelines (Phone Logs)</span> - `View` `Edit`
|
1025
|
+
# @param phone_log_id [Integer] The phone log identifier.
|
1026
|
+
# @param phone_log_put_message [PhoneLogPutMessage]
|
1027
|
+
# @param [Hash] opts the optional parameters
|
1028
|
+
# @return [PhoneLogMessage]
|
1029
|
+
def update_phone_log(phone_log_id, phone_log_put_message, opts = {})
|
1030
|
+
data, _status_code, _headers = update_phone_log_with_http_info(phone_log_id, phone_log_put_message, opts)
|
1031
|
+
data
|
1032
|
+
end
|
1033
|
+
|
1034
|
+
# Update a phone log
|
1035
|
+
# Update a phone log <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\">Communications &gt; Timelines (Phone Logs)</span> - `View` `Edit`
|
1036
|
+
# @param phone_log_id [Integer] The phone log identifier.
|
1037
|
+
# @param phone_log_put_message [PhoneLogPutMessage]
|
1038
|
+
# @param [Hash] opts the optional parameters
|
1039
|
+
# @return [Array<(PhoneLogMessage, Integer, Hash)>] PhoneLogMessage data, response status code and response headers
|
1040
|
+
def update_phone_log_with_http_info(phone_log_id, phone_log_put_message, opts = {})
|
1041
|
+
if @api_client.config.debugging
|
1042
|
+
@api_client.config.logger.debug 'Calling API: CommunicationsApi.update_phone_log ...'
|
1043
|
+
end
|
1044
|
+
# verify the required parameter 'phone_log_id' is set
|
1045
|
+
if @api_client.config.client_side_validation && phone_log_id.nil?
|
1046
|
+
fail ArgumentError, "Missing the required parameter 'phone_log_id' when calling CommunicationsApi.update_phone_log"
|
1047
|
+
end
|
1048
|
+
# verify the required parameter 'phone_log_put_message' is set
|
1049
|
+
if @api_client.config.client_side_validation && phone_log_put_message.nil?
|
1050
|
+
fail ArgumentError, "Missing the required parameter 'phone_log_put_message' when calling CommunicationsApi.update_phone_log"
|
1051
|
+
end
|
1052
|
+
# resource path
|
1053
|
+
local_var_path = '/v1/communications/phonelogs/{phoneLogId}'.sub('{' + 'phoneLogId' + '}', CGI.escape(phone_log_id.to_s))
|
1054
|
+
|
1055
|
+
# query parameters
|
1056
|
+
query_params = opts[:query_params] || {}
|
1057
|
+
|
1058
|
+
# header parameters
|
1059
|
+
header_params = opts[:header_params] || {}
|
1060
|
+
# HTTP header 'Accept' (if needed)
|
1061
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1062
|
+
# HTTP header 'Content-Type'
|
1063
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
1064
|
+
if !content_type.nil?
|
1065
|
+
header_params['Content-Type'] = content_type
|
1066
|
+
end
|
1067
|
+
|
1068
|
+
# form parameters
|
1069
|
+
form_params = opts[:form_params] || {}
|
1070
|
+
|
1071
|
+
# http body (model)
|
1072
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(phone_log_put_message)
|
1073
|
+
|
1074
|
+
# return_type
|
1075
|
+
return_type = opts[:debug_return_type] || 'PhoneLogMessage'
|
1076
|
+
|
1077
|
+
# auth_names
|
1078
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
1079
|
+
|
1080
|
+
new_options = opts.merge(
|
1081
|
+
:operation => :"CommunicationsApi.update_phone_log",
|
1082
|
+
:header_params => header_params,
|
1083
|
+
:query_params => query_params,
|
1084
|
+
:form_params => form_params,
|
1085
|
+
:body => post_body,
|
1086
|
+
:auth_names => auth_names,
|
1087
|
+
:return_type => return_type
|
1088
|
+
)
|
1089
|
+
|
1090
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
1091
|
+
if @api_client.config.debugging
|
1092
|
+
@api_client.config.logger.debug "API called: CommunicationsApi#update_phone_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1093
|
+
end
|
1094
|
+
return data, status_code, headers
|
1095
|
+
end
|
1096
|
+
end
|
1097
|
+
end
|