buildium-ruby 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.github/workflows/ci.yml +27 -0
- data/.github/workflows/publish.yml +48 -0
- data/.gitignore +39 -0
- data/.openapi-generator/FILES +1215 -0
- data/.openapi-generator/VERSION +1 -0
- data/.openapi-generator/templates/ruby-client/gemspec.mustache +37 -0
- data/.openapi-generator/templates/ruby-client/partial_model_generic.mustache +371 -0
- data/.openapi-generator/templates/ruby-client/rubocop.mustache +124 -0
- data/.openapi-generator-ignore +26 -0
- data/.rspec +2 -0
- data/.rubocop.yml +124 -0
- data/CUSTOMIZATIONS.md +11 -0
- data/DOCS.md +811 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +75 -0
- data/README.md +118 -0
- data/Rakefile +10 -0
- data/bin/CUSTOMIZATIONS.md +11 -0
- data/bin/README.md +118 -0
- data/bin/config.yml +9 -0
- data/bin/rebuild.sh +49 -0
- data/bin/swagger.json +52218 -0
- data/buildium-ruby.gemspec +39 -0
- data/docs/AccountInfoMessage.md +26 -0
- data/docs/AccountingApi.md +2041 -0
- data/docs/AccountingEntityMessage.md +22 -0
- data/docs/AccountingEntitySaveMessage.md +20 -0
- data/docs/AccountingLockPeriodMessage.md +22 -0
- data/docs/AccountingSettingsMessage.md +28 -0
- data/docs/AddressMessage.md +30 -0
- data/docs/AdministrationApi.md +485 -0
- data/docs/AllTasksMessage.md +46 -0
- data/docs/AnnouncementMessage.md +30 -0
- data/docs/AnnouncementPostMessage.md +28 -0
- data/docs/AnnouncementSearchMessage.md +26 -0
- data/docs/AnnouncementSenderMessage.md +22 -0
- data/docs/ApiError.md +20 -0
- data/docs/ApiErrorResponse.md +22 -0
- data/docs/ApplianceMessage.md +26 -0
- data/docs/ApplicantApplicationMessage.md +24 -0
- data/docs/ApplicantGroupMessage.md +26 -0
- data/docs/ApplicantGroupPostMessage.md +20 -0
- data/docs/ApplicantGroupPutMessage.md +22 -0
- data/docs/ApplicantGroupSearchMessage.md +26 -0
- data/docs/ApplicantMessage.md +36 -0
- data/docs/ApplicantPostMessage.md +28 -0
- data/docs/ApplicantPutMessage.md +26 -0
- data/docs/ApplicantSearchMessage.md +32 -0
- data/docs/ApplicantsApi.md +1489 -0
- data/docs/ApplicationMessage.md +26 -0
- data/docs/ApplicationPutMessage.md +18 -0
- data/docs/ApplicationResponseFieldMessage.md +24 -0
- data/docs/ApplicationResponseMessage.md +22 -0
- data/docs/ApplicationSectionResponseMessage.md +18 -0
- data/docs/AssociationApplianceMessage.md +32 -0
- data/docs/AssociationAppliancePostMessage.md +32 -0
- data/docs/AssociationAppliancePutMessage.md +28 -0
- data/docs/AssociationApplianceSearchMessage.md +20 -0
- data/docs/AssociationApplianceServiceHistoryMessage.md +24 -0
- data/docs/AssociationApplianceServiceHistoryPostMessage.md +22 -0
- data/docs/AssociationAppliancesApi.md +646 -0
- data/docs/AssociationBoardMemberMessage.md +36 -0
- data/docs/AssociationBoardMemberPostMessage.md +24 -0
- data/docs/AssociationBoardMemberPutMessage.md +22 -0
- data/docs/AssociationBoardMemberSearchMessage.md +24 -0
- data/docs/AssociationMessage.md +40 -0
- data/docs/AssociationOwnerBoardTermMessage.md +28 -0
- data/docs/AssociationOwnerBoardTermPostMessage.md +22 -0
- data/docs/AssociationOwnerMessage.md +52 -0
- data/docs/AssociationOwnerPostMessage.md +44 -0
- data/docs/AssociationOwnerPutMessage.md +38 -0
- data/docs/AssociationOwnerToExistingOwnershipAccountPostMessage.md +48 -0
- data/docs/AssociationOwnerUnitOccupancyPutMessage.md +18 -0
- data/docs/AssociationOwnerUnitOccupancyStatusMessage.md +20 -0
- data/docs/AssociationOwnersApi.md +916 -0
- data/docs/AssociationOwnershipAccountMessage.md +34 -0
- data/docs/AssociationOwnershipAccountPostMessage.md +32 -0
- data/docs/AssociationOwnershipAccountPutMessage.md +18 -0
- data/docs/AssociationOwnershipAccountSearchMessage.md +28 -0
- data/docs/AssociationOwnershipAccountsApi.md +2042 -0
- data/docs/AssociationPostMessage.md +32 -0
- data/docs/AssociationPreferredVendorMessage.md +34 -0
- data/docs/AssociationPreferredVendorPutMessage.md +18 -0
- data/docs/AssociationPutMessage.md +34 -0
- data/docs/AssociationSearchMessage.md +24 -0
- data/docs/AssociationTenantMessage.md +44 -0
- data/docs/AssociationTenantPostMessage.md +42 -0
- data/docs/AssociationTenantPutMessage.md +38 -0
- data/docs/AssociationTenantsApi.md +671 -0
- data/docs/AssociationUnitMessage.md +32 -0
- data/docs/AssociationUnitPutMessage.md +26 -0
- data/docs/AssociationUnitSearchMessage.md +22 -0
- data/docs/AssociationUnitsApi.md +659 -0
- data/docs/AssociationUnitsPostMessage.md +28 -0
- data/docs/AssociationUserSearchMessage.md +34 -0
- data/docs/AssociationsApi.md +1235 -0
- data/docs/BankAccountCheckAccountingEntitySaveMessage.md +20 -0
- data/docs/BankAccountCheckLineMessage.md +28 -0
- data/docs/BankAccountCheckLineSaveMessage.md +26 -0
- data/docs/BankAccountCheckMessage.md +30 -0
- data/docs/BankAccountCheckPayeeMessage.md +22 -0
- data/docs/BankAccountCheckPayeeSaveMessage.md +20 -0
- data/docs/BankAccountCheckPostMessage.md +26 -0
- data/docs/BankAccountCheckPutMessage.md +26 -0
- data/docs/BankAccountCheckSearchMessage.md +20 -0
- data/docs/BankAccountDepositLineMessage.md +28 -0
- data/docs/BankAccountDepositLineSaveMessage.md +26 -0
- data/docs/BankAccountDepositMessage.md +28 -0
- data/docs/BankAccountDepositPostMessage.md +24 -0
- data/docs/BankAccountDepositPutMessage.md +22 -0
- data/docs/BankAccountDepositSearchMessage.md +20 -0
- data/docs/BankAccountMessage.md +40 -0
- data/docs/BankAccountPostMessage.md +30 -0
- data/docs/BankAccountPutMessage.md +30 -0
- data/docs/BankAccountQuickDepositMessage.md +28 -0
- data/docs/BankAccountQuickDepositSaveMessage.md +26 -0
- data/docs/BankAccountQuickDepositSearchMessage.md +20 -0
- data/docs/BankAccountSearchMessage.md +20 -0
- data/docs/BankAccountTransactionMessage.md +36 -0
- data/docs/BankAccountTransactionSearchMessage.md +24 -0
- data/docs/BankAccountTransferAccountingEntitySaveMessage.md +20 -0
- data/docs/BankAccountTransferMessage.md +28 -0
- data/docs/BankAccountTransferSaveMessage.md +26 -0
- data/docs/BankAccountTransferSearchMessage.md +20 -0
- data/docs/BankAccountWithdrawalMessage.md +28 -0
- data/docs/BankAccountWithdrawalSaveMessage.md +26 -0
- data/docs/BankAccountWithdrawalSearchMessage.md +20 -0
- data/docs/BankAccountsApi.md +2224 -0
- data/docs/BillFileMessage.md +28 -0
- data/docs/BillLineMessage.md +28 -0
- data/docs/BillLinePostMessage.md +26 -0
- data/docs/BillLinePutMessage.md +28 -0
- data/docs/BillMarkupMessage.md +20 -0
- data/docs/BillMarkupSaveMessage.md +20 -0
- data/docs/BillMessage.md +36 -0
- data/docs/BillPaymentAccountingEntityMessage.md +20 -0
- data/docs/BillPaymentLineMessage.md +22 -0
- data/docs/BillPaymentLinePostMessage.md +20 -0
- data/docs/BillPaymentMessage.md +28 -0
- data/docs/BillPaymentPostMessage.md +26 -0
- data/docs/BillPostMessage.md +30 -0
- data/docs/BillPutMessage.md +28 -0
- data/docs/BillSearchMessage.md +32 -0
- data/docs/BudgetDetailsMessage.md +24 -0
- data/docs/BudgetDetailsSaveMessage.md +20 -0
- data/docs/BudgetMessage.md +28 -0
- data/docs/BudgetMonthlyAmountsMessage.md +40 -0
- data/docs/BudgetMonthlyAmountsSaveMessage.md +40 -0
- data/docs/BudgetPostMessage.md +26 -0
- data/docs/BudgetPutMessage.md +20 -0
- data/docs/BudgetSearchMessage.md +22 -0
- data/docs/ChargeRecurringTransactionPostMessage.md +32 -0
- data/docs/ChargeRecurringTransactionPutMessage.md +34 -0
- data/docs/CheckPrintingInfoMessage.md +46 -0
- data/docs/CheckPrintingInfoPostMessage.md +46 -0
- data/docs/CheckPrintingInfoPutMessage.md +46 -0
- data/docs/ClientLeadCreditRequestMessage.md +24 -0
- data/docs/ClientLeadMessage.md +38 -0
- data/docs/ClientLeadSearchMessage.md +26 -0
- data/docs/ClientLeadsApi.md +177 -0
- data/docs/CommunicationsApi.md +1238 -0
- data/docs/ContactDetailMessage.md +24 -0
- data/docs/ContactDetailPhoneMessage.md +22 -0
- data/docs/ContactDetailSaveMessage.md +24 -0
- data/docs/ContactDetailSavePhoneMessage.md +22 -0
- data/docs/ContactInfoMessage.md +24 -0
- data/docs/ContactRequestTaskMessage.md +42 -0
- data/docs/ContactRequestTaskPostMessage.md +38 -0
- data/docs/ContactRequestTaskPutMessage.md +38 -0
- data/docs/ContactRequestTaskSearchMessage.md +40 -0
- data/docs/CosignerMessage.md +36 -0
- data/docs/CreatedByUserMessage.md +24 -0
- data/docs/CreditRecurringTransactionPostMessage.md +36 -0
- data/docs/DepositDetailMessage.md +20 -0
- data/docs/ElectronicPaymentsMessage.md +32 -0
- data/docs/EmailMessage.md +24 -0
- data/docs/EmailPostMessage.md +30 -0
- data/docs/EmailRecipientMessage.md +26 -0
- data/docs/EmailSearchMessage.md +26 -0
- data/docs/EmailSenderMessage.md +24 -0
- data/docs/EmergencyContactMessage.md +24 -0
- data/docs/FileCategoryMessage.md +22 -0
- data/docs/FileCategoryPostMessage.md +18 -0
- data/docs/FileCategoryPutMessage.md +18 -0
- data/docs/FileDownloadMessage.md +18 -0
- data/docs/FileEntityMessage.md +22 -0
- data/docs/FileMessage.md +34 -0
- data/docs/FileNamePostMessage.md +18 -0
- data/docs/FilePutMessage.md +22 -0
- data/docs/FileSearchMessage.md +30 -0
- data/docs/FileUploadPostMessage.md +28 -0
- data/docs/FileUploadTicketMessage.md +22 -0
- data/docs/FilesApi.md +730 -0
- data/docs/GLAccountBalanceItemMessage.md +20 -0
- data/docs/GLAccountBalanceMessage.md +22 -0
- data/docs/GLAccountBalanceSearchMessage.md +26 -0
- data/docs/GLAccountMessage.md +46 -0
- data/docs/GLAccountPostMessage.md +32 -0
- data/docs/GLAccountPutMessage.md +32 -0
- data/docs/GLAccountsSearchMessage.md +18 -0
- data/docs/GLTransactionMessageV1.md +26 -0
- data/docs/GeneralJournalEntryLineSaveMessage.md +24 -0
- data/docs/GeneralJournalEntryPostMessage.md +24 -0
- data/docs/GeneralJournalEntryPutMessage.md +24 -0
- data/docs/GeneralLedgerJournalLineMessage.md +28 -0
- data/docs/GeneralLedgerJournalMessage.md +20 -0
- data/docs/GeneralLedgerTransactionMessage.md +38 -0
- data/docs/GeneralLedgerTransactionSearchMessage.md +26 -0
- data/docs/InternalTransactionStatusMessage.md +22 -0
- data/docs/JournalLineMessage.md +28 -0
- data/docs/JournalMessage.md +20 -0
- data/docs/LastUpdatedByUserMessage.md +26 -0
- data/docs/LeaseAccountDetailMessage.md +20 -0
- data/docs/LeaseChargeLineSaveMessage.md +22 -0
- data/docs/LeaseChargePostMessage.md +22 -0
- data/docs/LeaseChargePutMessage.md +22 -0
- data/docs/LeaseChargeRecurringTransactionMessage.md +40 -0
- data/docs/LeaseCosignerPostMessage.md +32 -0
- data/docs/LeaseLedgerCreditLinePostMessage.md +20 -0
- data/docs/LeaseLedgerCreditPostMessage.md +26 -0
- data/docs/LeaseLedgerDepositWithholdingLinePostMessage.md +20 -0
- data/docs/LeaseLedgerDepositWithholdingPostMessage.md +24 -0
- data/docs/LeaseLedgerPaymentLineSaveMessage.md +20 -0
- data/docs/LeaseLedgerPaymentPostMessage.md +30 -0
- data/docs/LeaseLedgerRefundLineMessage.md +20 -0
- data/docs/LeaseLedgerRefundLinePostMessage.md +20 -0
- data/docs/LeaseLedgerRefundMessage.md +34 -0
- data/docs/LeaseLedgerRefundPostMessage.md +30 -0
- data/docs/LeaseLedgerReversePaymentNSFChargePostMessage.md +20 -0
- data/docs/LeaseLedgerReversePaymentOtherBankChargePostMessage.md +20 -0
- data/docs/LeaseLedgerReversePaymentPostMessage.md +24 -0
- data/docs/LeaseMessage.md +58 -0
- data/docs/LeaseMoveOutDataMessage.md +22 -0
- data/docs/LeaseMoveOutDataPostMessage.md +22 -0
- data/docs/LeaseOutstandingBalanceMessage.md +40 -0
- data/docs/LeaseOutstandingBalanceSearchMessage.md +30 -0
- data/docs/LeasePostMessage.md +38 -0
- data/docs/LeasePutMessage.md +28 -0
- data/docs/LeaseRecurringCreditMessage.md +44 -0
- data/docs/LeaseRecurringPaymentMessage.md +42 -0
- data/docs/LeaseRenewalMessage.md +32 -0
- data/docs/LeaseRenewalPostMessage.md +38 -0
- data/docs/LeaseRentChargeMessage.md +30 -0
- data/docs/LeaseRentChargePostMessage.md +24 -0
- data/docs/LeaseRentMessage.md +34 -0
- data/docs/LeaseRentPostMessage.md +20 -0
- data/docs/LeaseSearchMessage.md +40 -0
- data/docs/LeaseSecurityDepositPostMessage.md +20 -0
- data/docs/LeaseTenantMessage.md +20 -0
- data/docs/LeaseTransactionMessage.md +34 -0
- data/docs/LeaseTransactionSearchMessage.md +22 -0
- data/docs/LeasesApi.md +2865 -0
- data/docs/ListingContactMessage.md +26 -0
- data/docs/ListingContactSaveMessage.md +24 -0
- data/docs/ListingFileMessage.md +22 -0
- data/docs/ListingMessage.md +36 -0
- data/docs/ListingPropertyMessage.md +34 -0
- data/docs/ListingPutMessage.md +28 -0
- data/docs/ListingSearchMessage.md +20 -0
- data/docs/ListingUnitMessage.md +36 -0
- data/docs/ListingsApi.md +642 -0
- data/docs/LockPeriodSettingsGlobalMessage.md +18 -0
- data/docs/LockPeriodSettingsOverridesMessage.md +20 -0
- data/docs/LoggedByStaffUserMessage.md +24 -0
- data/docs/LookupMessage.md +20 -0
- data/docs/MailingTemplateMessage.md +24 -0
- data/docs/NoteMessage.md +22 -0
- data/docs/NotePostMessage.md +18 -0
- data/docs/NotePutMessage.md +18 -0
- data/docs/NoteSearchMessage.md +22 -0
- data/docs/OutstandingBalancesLineMessage.md +20 -0
- data/docs/OwnershipAccountChargeRecurringTransactionMessage.md +40 -0
- data/docs/OwnershipAccountCreditLinePostMessage.md +20 -0
- data/docs/OwnershipAccountCreditPostMessage.md +26 -0
- data/docs/OwnershipAccountDepositWithholdingLinePostMessage.md +20 -0
- data/docs/OwnershipAccountDepositWithholdingPostMessage.md +24 -0
- data/docs/OwnershipAccountLedgerChargeLinesPutMessage.md +22 -0
- data/docs/OwnershipAccountLedgerChargeLinesSaveMessage.md +20 -0
- data/docs/OwnershipAccountLedgerChargePostMessage.md +22 -0
- data/docs/OwnershipAccountLedgerChargePutMessage.md +22 -0
- data/docs/OwnershipAccountLedgerPaymentLineSaveMessage.md +20 -0
- data/docs/OwnershipAccountLedgerPaymentPostMessage.md +30 -0
- data/docs/OwnershipAccountOutstandingBalanceMessage.md +36 -0
- data/docs/OwnershipAccountOutstandingBalanceSearchMessage.md +26 -0
- data/docs/OwnershipAccountRecurringCreditMessage.md +44 -0
- data/docs/OwnershipAccountRecurringPaymentMessage.md +42 -0
- data/docs/OwnershipAccountRefundLineMessage.md +20 -0
- data/docs/OwnershipAccountRefundLinesPostMessage.md +20 -0
- data/docs/OwnershipAccountRefundMessage.md +34 -0
- data/docs/OwnershipAccountRefundPostMessage.md +30 -0
- data/docs/OwnershipAccountTransactionMessage.md +34 -0
- data/docs/PaidByMessage.md +20 -0
- data/docs/ParticipantMessage.md +22 -0
- data/docs/ParticipantResourceMessage.md +20 -0
- data/docs/PayeeMessage.md +24 -0
- data/docs/PaymentDetailMessage.md +24 -0
- data/docs/PaymentRecurringTransactionPostMessage.md +34 -0
- data/docs/PaymentTransactionsMessage.md +22 -0
- data/docs/PhoneLogMessage.md +28 -0
- data/docs/PhoneLogParticipantPostMessage.md +22 -0
- data/docs/PhoneLogParticipantUnitAgreementPostMessage.md +20 -0
- data/docs/PhoneLogPostMessage.md +24 -0
- data/docs/PhoneLogPutMessage.md +22 -0
- data/docs/PhoneLogSearchMessage.md +32 -0
- data/docs/PhoneNumberMessage.md +20 -0
- data/docs/PhoneNumbersMessage.md +24 -0
- data/docs/PropertyGroupMessage.md +26 -0
- data/docs/PropertyGroupPostMessage.md +22 -0
- data/docs/PropertyGroupPutMessage.md +22 -0
- data/docs/PropertyGroupSearchMessage.md +20 -0
- data/docs/PropertyGroupsApi.md +327 -0
- data/docs/PropertyManagerMessage.md +32 -0
- data/docs/PropertyMessage.md +22 -0
- data/docs/RecurringTransactionLineMessage.md +20 -0
- data/docs/RecurringTransactionLinePostMessage.md +20 -0
- data/docs/RecurringTransactionMessage.md +40 -0
- data/docs/RentalApplianceMessage.md +32 -0
- data/docs/RentalAppliancePostMessage.md +32 -0
- data/docs/RentalAppliancePutMessage.md +28 -0
- data/docs/RentalApplianceSearchMessage.md +20 -0
- data/docs/RentalApplianceServiceHistoryMessage.md +24 -0
- data/docs/RentalApplianceServiceHistoryPostMessage.md +22 -0
- data/docs/RentalAppliancesApi.md +646 -0
- data/docs/RentalFeaturesMessage.md +20 -0
- data/docs/RentalFeaturesPutMessage.md +20 -0
- data/docs/RentalMessage.md +40 -0
- data/docs/RentalOwnerMessage.md +46 -0
- data/docs/RentalOwnerPostMessage.md +44 -0
- data/docs/RentalOwnerPutMessage.md +42 -0
- data/docs/RentalOwnerRequestTaskMessage.md +42 -0
- data/docs/RentalOwnerRequestTaskPostMessage.md +38 -0
- data/docs/RentalOwnerRequestTaskPutMessage.md +36 -0
- data/docs/RentalOwnerRequestTaskSearchMessage.md +40 -0
- data/docs/RentalOwnerTaxInformationMessage.md +28 -0
- data/docs/RentalOwnersApi.md +667 -0
- data/docs/RentalOwnersSearchMessage.md +30 -0
- data/docs/RentalPreferredVendorMessage.md +34 -0
- data/docs/RentalPreferredVendorPutMessage.md +18 -0
- data/docs/RentalPropertiesApi.md +989 -0
- data/docs/RentalPropertyPostMessage.md +36 -0
- data/docs/RentalPropertyPutMessage.md +32 -0
- data/docs/RentalPropertyUnitPostMessage.md +30 -0
- data/docs/RentalSearchMessage.md +32 -0
- data/docs/RentalTenantPostMessage.md +42 -0
- data/docs/RentalTenantPutMessage.md +40 -0
- data/docs/RentalTenantRenewalPostMessage.md +40 -0
- data/docs/RentalTenantsApi.md +673 -0
- data/docs/RentalUnitFeaturesMessage.md +18 -0
- data/docs/RentalUnitFeaturesPutMessage.md +18 -0
- data/docs/RentalUnitMessage.md +40 -0
- data/docs/RentalUnitPutMessage.md +30 -0
- data/docs/RentalUnitSearchMessage.md +22 -0
- data/docs/RentalUnitsApi.md +815 -0
- data/docs/RentalUnitsPostMessage.md +32 -0
- data/docs/RequestedByUserEntityMessage.md +28 -0
- data/docs/ResidentCenterApi.md +100 -0
- data/docs/ResidentCenterUserMessage.md +24 -0
- data/docs/ResidentCenterUserReferenceMessage.md +26 -0
- data/docs/ResidentCenterUserSearchMessage.md +26 -0
- data/docs/ResidentRequestTaskMessage.md +52 -0
- data/docs/ResidentRequestTaskPostMessage.md +42 -0
- data/docs/ResidentRequestTaskPutMessage.md +32 -0
- data/docs/ResidentRequestTaskSearchMessage.md +42 -0
- data/docs/SaveAddressMessage.md +30 -0
- data/docs/SaveEmergencyContactMessage.md +24 -0
- data/docs/TaskCategoryMessage.md +24 -0
- data/docs/TaskCategoryPutMessage.md +18 -0
- data/docs/TaskCategoryResponseMessage.md +24 -0
- data/docs/TaskCategorySaveMessage.md +18 -0
- data/docs/TaskHistoryFileMessage.md +28 -0
- data/docs/TaskHistoryFileUploadPostMessage.md +18 -0
- data/docs/TaskHistoryMessage.md +40 -0
- data/docs/TaskHistoryPutMessage.md +18 -0
- data/docs/TaskHistoryUserMessage.md +24 -0
- data/docs/TaskSearchMessage.md +44 -0
- data/docs/TaskSubCategoryMessage.md +20 -0
- data/docs/TasksApi.md +2528 -0
- data/docs/TaxInformationPostMessage.md +26 -0
- data/docs/TaxInformationSaveMessage.md +28 -0
- data/docs/TenantMessage.md +48 -0
- data/docs/TenantSearchMessage.md +36 -0
- data/docs/ToDoTaskMessage.md +40 -0
- data/docs/ToDoTaskPostMessage.md +36 -0
- data/docs/ToDoTaskPutMessage.md +36 -0
- data/docs/ToDoTaskSearchMessage.md +40 -0
- data/docs/UndepositedFundsMessage.md +18 -0
- data/docs/UnitAgreementMessage.md +22 -0
- data/docs/UserMessage.md +40 -0
- data/docs/UserRoleMessage.md +24 -0
- data/docs/UserSearchMessage.md +26 -0
- data/docs/VehicleMessage.md +24 -0
- data/docs/VendorCategoryMessage.md +22 -0
- data/docs/VendorCategorySaveMessage.md +18 -0
- data/docs/VendorCreditLineItemMessage.md +26 -0
- data/docs/VendorCreditLineItemPostMessage.md +24 -0
- data/docs/VendorCreditMessage.md +26 -0
- data/docs/VendorCreditPostMessage.md +24 -0
- data/docs/VendorInsuranceMessage.md +22 -0
- data/docs/VendorInsuranceSaveMessage.md +22 -0
- data/docs/VendorMessage.md +50 -0
- data/docs/VendorPostMessage.md +46 -0
- data/docs/VendorPutMessage.md +46 -0
- data/docs/VendorRefundLineMessage.md +26 -0
- data/docs/VendorRefundLinePostMessage.md +24 -0
- data/docs/VendorRefundMessage.md +30 -0
- data/docs/VendorRefundPostMessage.md +28 -0
- data/docs/VendorSearchMessage.md +32 -0
- data/docs/VendorTaxInformationMessage.md +28 -0
- data/docs/VendorTransactionMessage.md +28 -0
- data/docs/VendorTransactionSearchMessage.md +26 -0
- data/docs/VendorsApi.md +1396 -0
- data/docs/WorkOrderEntryContactMessage.md +20 -0
- data/docs/WorkOrderEntryContactResourceMessage.md +20 -0
- data/docs/WorkOrderLineItemMessage.md +24 -0
- data/docs/WorkOrderLineItemSaveMessage.md +24 -0
- data/docs/WorkOrderMessage.md +42 -0
- data/docs/WorkOrderPostMessage.md +38 -0
- data/docs/WorkOrderPutMessage.md +34 -0
- data/docs/WorkOrderSearchMessage.md +54 -0
- data/docs/WorkOrderTaskMessage.md +32 -0
- data/docs/WorkOrderTaskPostMessage.md +30 -0
- data/docs/WorkOrdersApi.md +361 -0
- data/lib/buildium-ruby/api/accounting_api.rb +1855 -0
- data/lib/buildium-ruby/api/administration_api.rb +417 -0
- data/lib/buildium-ruby/api/applicants_api.rb +1368 -0
- data/lib/buildium-ruby/api/association_appliances_api.rb +577 -0
- data/lib/buildium-ruby/api/association_owners_api.rb +849 -0
- data/lib/buildium-ruby/api/association_ownership_accounts_api.rb +1890 -0
- data/lib/buildium-ruby/api/association_tenants_api.rb +628 -0
- data/lib/buildium-ruby/api/association_units_api.rb +606 -0
- data/lib/buildium-ruby/api/associations_api.rb +1143 -0
- data/lib/buildium-ruby/api/bank_accounts_api.rb +2085 -0
- data/lib/buildium-ruby/api/client_leads_api.rb +174 -0
- data/lib/buildium-ruby/api/communications_api.rb +1097 -0
- data/lib/buildium-ruby/api/files_api.rb +652 -0
- data/lib/buildium-ruby/api/leases_api.rb +2636 -0
- data/lib/buildium-ruby/api/listings_api.rb +569 -0
- data/lib/buildium-ruby/api/property_groups_api.rb +299 -0
- data/lib/buildium-ruby/api/rental_appliances_api.rb +577 -0
- data/lib/buildium-ruby/api/rental_owners_api.rb +622 -0
- data/lib/buildium-ruby/api/rental_properties_api.rb +916 -0
- data/lib/buildium-ruby/api/rental_tenants_api.rb +635 -0
- data/lib/buildium-ruby/api/rental_units_api.rb +743 -0
- data/lib/buildium-ruby/api/resident_center_api.rb +111 -0
- data/lib/buildium-ruby/api/tasks_api.rb +2363 -0
- data/lib/buildium-ruby/api/vendors_api.rb +1285 -0
- data/lib/buildium-ruby/api/work_orders_api.rb +366 -0
- data/lib/buildium-ruby/api_client.rb +426 -0
- data/lib/buildium-ruby/api_error.rb +57 -0
- data/lib/buildium-ruby/configuration.rb +319 -0
- data/lib/buildium-ruby/models/account_info_message.rb +257 -0
- data/lib/buildium-ruby/models/accounting_entity_message.rb +273 -0
- data/lib/buildium-ruby/models/accounting_entity_save_message.rb +273 -0
- data/lib/buildium-ruby/models/accounting_lock_period_message.rb +242 -0
- data/lib/buildium-ruby/models/accounting_settings_message.rb +314 -0
- data/lib/buildium-ruby/models/address_message.rb +313 -0
- data/lib/buildium-ruby/models/all_tasks_message.rb +413 -0
- data/lib/buildium-ruby/models/announcement_message.rb +301 -0
- data/lib/buildium-ruby/models/announcement_post_message.rb +295 -0
- data/lib/buildium-ruby/models/announcement_search_message.rb +292 -0
- data/lib/buildium-ruby/models/announcement_sender_message.rb +239 -0
- data/lib/buildium-ruby/models/api_error_response.rb +237 -0
- data/lib/buildium-ruby/models/appliance_message.rb +259 -0
- data/lib/buildium-ruby/models/applicant_application_message.rb +282 -0
- data/lib/buildium-ruby/models/applicant_group_message.rb +294 -0
- data/lib/buildium-ruby/models/applicant_group_post_message.rb +235 -0
- data/lib/buildium-ruby/models/applicant_group_put_message.rb +284 -0
- data/lib/buildium-ruby/models/applicant_group_search_message.rb +296 -0
- data/lib/buildium-ruby/models/applicant_message.rb +312 -0
- data/lib/buildium-ruby/models/applicant_post_message.rb +283 -0
- data/lib/buildium-ruby/models/applicant_put_message.rb +267 -0
- data/lib/buildium-ruby/models/applicant_search_message.rb +326 -0
- data/lib/buildium-ruby/models/application_message.rb +294 -0
- data/lib/buildium-ruby/models/application_put_message.rb +257 -0
- data/lib/buildium-ruby/models/application_response_field_message.rb +294 -0
- data/lib/buildium-ruby/models/application_response_message.rb +274 -0
- data/lib/buildium-ruby/models/application_section_response_message.rb +219 -0
- data/lib/buildium-ruby/models/association_appliance_message.rb +288 -0
- data/lib/buildium-ruby/models/association_appliance_post_message.rb +298 -0
- data/lib/buildium-ruby/models/association_appliance_put_message.rb +273 -0
- data/lib/buildium-ruby/models/association_appliance_search_message.rb +232 -0
- data/lib/buildium-ruby/models/association_appliance_service_history_message.rb +282 -0
- data/lib/buildium-ruby/models/association_appliance_service_history_post_message.rb +282 -0
- data/lib/buildium-ruby/models/association_board_member_message.rb +344 -0
- data/lib/buildium-ruby/models/association_board_member_post_message.rb +293 -0
- data/lib/buildium-ruby/models/association_board_member_put_message.rb +278 -0
- data/lib/buildium-ruby/models/association_board_member_search_message.rb +274 -0
- data/lib/buildium-ruby/models/association_message.rb +327 -0
- data/lib/buildium-ruby/models/association_owner_board_term_message.rb +303 -0
- data/lib/buildium-ruby/models/association_owner_board_term_post_message.rb +278 -0
- data/lib/buildium-ruby/models/association_owner_message.rb +440 -0
- data/lib/buildium-ruby/models/association_owner_post_message.rb +398 -0
- data/lib/buildium-ruby/models/association_owner_put_message.rb +363 -0
- data/lib/buildium-ruby/models/association_owner_to_existing_ownership_account_post_message.rb +428 -0
- data/lib/buildium-ruby/models/association_owner_unit_occupancy_put_message.rb +223 -0
- data/lib/buildium-ruby/models/association_owner_unit_occupancy_status_message.rb +228 -0
- data/lib/buildium-ruby/models/association_ownership_account_message.rb +347 -0
- data/lib/buildium-ruby/models/association_ownership_account_post_message.rb +346 -0
- data/lib/buildium-ruby/models/association_ownership_account_put_message.rb +223 -0
- data/lib/buildium-ruby/models/association_ownership_account_search_message.rb +296 -0
- data/lib/buildium-ruby/models/association_post_message.rb +302 -0
- data/lib/buildium-ruby/models/association_preferred_vendor_message.rb +300 -0
- data/lib/buildium-ruby/models/association_preferred_vendor_put_message.rb +225 -0
- data/lib/buildium-ruby/models/association_put_message.rb +322 -0
- data/lib/buildium-ruby/models/association_search_message.rb +283 -0
- data/lib/buildium-ruby/models/association_tenant_message.rb +350 -0
- data/lib/buildium-ruby/models/association_tenant_post_message.rb +354 -0
- data/lib/buildium-ruby/models/association_tenant_put_message.rb +329 -0
- data/lib/buildium-ruby/models/association_unit_message.rb +334 -0
- data/lib/buildium-ruby/models/association_unit_put_message.rb +313 -0
- data/lib/buildium-ruby/models/association_unit_search_message.rb +241 -0
- data/lib/buildium-ruby/models/association_units_post_message.rb +328 -0
- data/lib/buildium-ruby/models/association_user_search_message.rb +324 -0
- data/lib/buildium-ruby/models/bank_account_check_accounting_entity_save_message.rb +272 -0
- data/lib/buildium-ruby/models/bank_account_check_line_message.rb +267 -0
- data/lib/buildium-ruby/models/bank_account_check_line_save_message.rb +272 -0
- data/lib/buildium-ruby/models/bank_account_check_message.rb +279 -0
- data/lib/buildium-ruby/models/bank_account_check_payee_message.rb +272 -0
- data/lib/buildium-ruby/models/bank_account_check_payee_save_message.rb +272 -0
- data/lib/buildium-ruby/models/bank_account_check_post_message.rb +274 -0
- data/lib/buildium-ruby/models/bank_account_check_put_message.rb +274 -0
- data/lib/buildium-ruby/models/bank_account_check_search_message.rb +238 -0
- data/lib/buildium-ruby/models/bank_account_deposit_line_message.rb +267 -0
- data/lib/buildium-ruby/models/bank_account_deposit_line_save_message.rb +257 -0
- data/lib/buildium-ruby/models/bank_account_deposit_message.rb +272 -0
- data/lib/buildium-ruby/models/bank_account_deposit_post_message.rb +257 -0
- data/lib/buildium-ruby/models/bank_account_deposit_put_message.rb +250 -0
- data/lib/buildium-ruby/models/bank_account_deposit_search_message.rb +238 -0
- data/lib/buildium-ruby/models/bank_account_message.rb +360 -0
- data/lib/buildium-ruby/models/bank_account_post_message.rb +338 -0
- data/lib/buildium-ruby/models/bank_account_put_message.rb +343 -0
- data/lib/buildium-ruby/models/bank_account_quick_deposit_message.rb +267 -0
- data/lib/buildium-ruby/models/bank_account_quick_deposit_save_message.rb +277 -0
- data/lib/buildium-ruby/models/bank_account_quick_deposit_search_message.rb +238 -0
- data/lib/buildium-ruby/models/bank_account_search_message.rb +263 -0
- data/lib/buildium-ruby/models/bank_account_transaction_message.rb +359 -0
- data/lib/buildium-ruby/models/bank_account_transaction_search_message.rb +292 -0
- data/lib/buildium-ruby/models/bank_account_transfer_accounting_entity_save_message.rb +272 -0
- data/lib/buildium-ruby/models/bank_account_transfer_message.rb +267 -0
- data/lib/buildium-ruby/models/bank_account_transfer_save_message.rb +277 -0
- data/lib/buildium-ruby/models/bank_account_transfer_search_message.rb +238 -0
- data/lib/buildium-ruby/models/bank_account_withdrawal_message.rb +267 -0
- data/lib/buildium-ruby/models/bank_account_withdrawal_save_message.rb +277 -0
- data/lib/buildium-ruby/models/bank_account_withdrawal_search_message.rb +238 -0
- data/lib/buildium-ruby/models/bill_file_message.rb +268 -0
- data/lib/buildium-ruby/models/bill_line_message.rb +266 -0
- data/lib/buildium-ruby/models/bill_line_post_message.rb +272 -0
- data/lib/buildium-ruby/models/bill_line_put_message.rb +282 -0
- data/lib/buildium-ruby/models/bill_markup_message.rb +263 -0
- data/lib/buildium-ruby/models/bill_markup_save_message.rb +273 -0
- data/lib/buildium-ruby/models/bill_message.rb +344 -0
- data/lib/buildium-ruby/models/bill_payment_accounting_entity_message.rb +263 -0
- data/lib/buildium-ruby/models/bill_payment_line_message.rb +238 -0
- data/lib/buildium-ruby/models/bill_payment_line_post_message.rb +238 -0
- data/lib/buildium-ruby/models/bill_payment_message.rb +270 -0
- data/lib/buildium-ruby/models/bill_payment_post_message.rb +275 -0
- data/lib/buildium-ruby/models/bill_post_message.rb +301 -0
- data/lib/buildium-ruby/models/bill_put_message.rb +286 -0
- data/lib/buildium-ruby/models/bill_search_message.rb +336 -0
- data/lib/buildium-ruby/models/budget_details_message.rb +281 -0
- data/lib/buildium-ruby/models/budget_details_save_message.rb +237 -0
- data/lib/buildium-ruby/models/budget_message.rb +269 -0
- data/lib/buildium-ruby/models/budget_monthly_amounts_message.rb +328 -0
- data/lib/buildium-ruby/models/budget_monthly_amounts_save_message.rb +388 -0
- data/lib/buildium-ruby/models/budget_post_message.rb +319 -0
- data/lib/buildium-ruby/models/budget_put_message.rb +240 -0
- data/lib/buildium-ruby/models/budget_search_message.rb +240 -0
- data/lib/buildium-ruby/models/charge_recurring_transaction_post_message.rb +359 -0
- data/lib/buildium-ruby/models/charge_recurring_transaction_put_message.rb +374 -0
- data/lib/buildium-ruby/models/check_printing_info_message.rb +392 -0
- data/lib/buildium-ruby/models/check_printing_info_post_message.rb +392 -0
- data/lib/buildium-ruby/models/check_printing_info_put_message.rb +407 -0
- data/lib/buildium-ruby/models/client_lead_credit_request_message.rb +295 -0
- data/lib/buildium-ruby/models/client_lead_message.rb +363 -0
- data/lib/buildium-ruby/models/client_lead_search_message.rb +285 -0
- data/lib/buildium-ruby/models/contact_detail_message.rb +248 -0
- data/lib/buildium-ruby/models/contact_detail_phone_message.rb +239 -0
- data/lib/buildium-ruby/models/contact_detail_save_message.rb +253 -0
- data/lib/buildium-ruby/models/contact_detail_save_phone_message.rb +239 -0
- data/lib/buildium-ruby/models/contact_info_message.rb +248 -0
- data/lib/buildium-ruby/models/contact_request_task_message.rb +381 -0
- data/lib/buildium-ruby/models/contact_request_task_post_message.rb +388 -0
- data/lib/buildium-ruby/models/contact_request_task_put_message.rb +388 -0
- data/lib/buildium-ruby/models/contact_request_task_search_message.rb +366 -0
- data/lib/buildium-ruby/models/cosigner_message.rb +343 -0
- data/lib/buildium-ruby/models/created_by_user_message.rb +248 -0
- data/lib/buildium-ruby/models/credit_recurring_transaction_post_message.rb +388 -0
- data/lib/buildium-ruby/models/deposit_detail_message.rb +231 -0
- data/lib/buildium-ruby/models/electronic_payments_message.rb +288 -0
- data/lib/buildium-ruby/models/email_message.rb +247 -0
- data/lib/buildium-ruby/models/email_post_message.rb +307 -0
- data/lib/buildium-ruby/models/email_recipient_message.rb +292 -0
- data/lib/buildium-ruby/models/email_search_message.rb +268 -0
- data/lib/buildium-ruby/models/email_sender_message.rb +248 -0
- data/lib/buildium-ruby/models/emergency_contact_message.rb +249 -0
- data/lib/buildium-ruby/models/file_category_message.rb +239 -0
- data/lib/buildium-ruby/models/file_category_post_message.rb +224 -0
- data/lib/buildium-ruby/models/file_category_put_message.rb +224 -0
- data/lib/buildium-ruby/models/file_download_message.rb +218 -0
- data/lib/buildium-ruby/models/file_entity_message.rb +273 -0
- data/lib/buildium-ruby/models/file_message.rb +297 -0
- data/lib/buildium-ruby/models/file_name_post_message.rb +223 -0
- data/lib/buildium-ruby/models/file_put_message.rb +248 -0
- data/lib/buildium-ruby/models/file_search_message.rb +315 -0
- data/lib/buildium-ruby/models/file_upload_post_message.rb +322 -0
- data/lib/buildium-ruby/models/file_upload_ticket_message.rb +240 -0
- data/lib/buildium-ruby/models/general_journal_entry_line_save_message.rb +297 -0
- data/lib/buildium-ruby/models/general_journal_entry_post_message.rb +264 -0
- data/lib/buildium-ruby/models/general_journal_entry_put_message.rb +264 -0
- data/lib/buildium-ruby/models/general_ledger_journal_line_message.rb +267 -0
- data/lib/buildium-ruby/models/general_ledger_journal_message.rb +230 -0
- data/lib/buildium-ruby/models/general_ledger_transaction_message.rb +349 -0
- data/lib/buildium-ruby/models/general_ledger_transaction_search_message.rb +310 -0
- data/lib/buildium-ruby/models/gl_account_balance_item_message.rb +228 -0
- data/lib/buildium-ruby/models/gl_account_balance_message.rb +240 -0
- data/lib/buildium-ruby/models/gl_account_balance_search_message.rb +317 -0
- data/lib/buildium-ruby/models/gl_account_message.rb +419 -0
- data/lib/buildium-ruby/models/gl_account_post_message.rb +349 -0
- data/lib/buildium-ruby/models/gl_account_put_message.rb +344 -0
- data/lib/buildium-ruby/models/gl_accounts_search_message.rb +243 -0
- data/lib/buildium-ruby/models/gl_transaction_message_v1.rb +258 -0
- data/lib/buildium-ruby/models/internal_transaction_status_message.rb +239 -0
- data/lib/buildium-ruby/models/journal_line_message.rb +268 -0
- data/lib/buildium-ruby/models/journal_message.rb +230 -0
- data/lib/buildium-ruby/models/last_updated_by_user_message.rb +259 -0
- data/lib/buildium-ruby/models/lease_account_detail_message.rb +229 -0
- data/lib/buildium-ruby/models/lease_charge_line_save_message.rb +249 -0
- data/lib/buildium-ruby/models/lease_charge_post_message.rb +241 -0
- data/lib/buildium-ruby/models/lease_charge_put_message.rb +250 -0
- data/lib/buildium-ruby/models/lease_charge_recurring_transaction_message.rb +374 -0
- data/lib/buildium-ruby/models/lease_cosigner_post_message.rb +330 -0
- data/lib/buildium-ruby/models/lease_ledger_credit_line_post_message.rb +239 -0
- data/lib/buildium-ruby/models/lease_ledger_credit_post_message.rb +309 -0
- data/lib/buildium-ruby/models/lease_ledger_deposit_withholding_line_post_message.rb +238 -0
- data/lib/buildium-ruby/models/lease_ledger_deposit_withholding_post_message.rb +260 -0
- data/lib/buildium-ruby/models/lease_ledger_payment_line_save_message.rb +239 -0
- data/lib/buildium-ruby/models/lease_ledger_payment_post_message.rb +335 -0
- data/lib/buildium-ruby/models/lease_ledger_refund_line_message.rb +228 -0
- data/lib/buildium-ruby/models/lease_ledger_refund_line_post_message.rb +238 -0
- data/lib/buildium-ruby/models/lease_ledger_refund_message.rb +301 -0
- data/lib/buildium-ruby/models/lease_ledger_refund_post_message.rb +306 -0
- data/lib/buildium-ruby/models/lease_ledger_reverse_payment_nsf_charge_post_message.rb +239 -0
- data/lib/buildium-ruby/models/lease_ledger_reverse_payment_other_bank_charge_post_message.rb +239 -0
- data/lib/buildium-ruby/models/lease_ledger_reverse_payment_post_message.rb +256 -0
- data/lib/buildium-ruby/models/lease_message.rb +496 -0
- data/lib/buildium-ruby/models/lease_move_out_data_message.rb +238 -0
- data/lib/buildium-ruby/models/lease_move_out_data_post_message.rb +248 -0
- data/lib/buildium-ruby/models/lease_outstanding_balance_message.rb +330 -0
- data/lib/buildium-ruby/models/lease_outstanding_balance_search_message.rb +345 -0
- data/lib/buildium-ruby/models/lease_post_message.rb +379 -0
- data/lib/buildium-ruby/models/lease_put_message.rb +322 -0
- data/lib/buildium-ruby/models/lease_recurring_credit_message.rb +408 -0
- data/lib/buildium-ruby/models/lease_recurring_payment_message.rb +397 -0
- data/lib/buildium-ruby/models/lease_renewal_message.rb +336 -0
- data/lib/buildium-ruby/models/lease_renewal_post_message.rb +378 -0
- data/lib/buildium-ruby/models/lease_rent_charge_message.rb +278 -0
- data/lib/buildium-ruby/models/lease_rent_charge_post_message.rb +263 -0
- data/lib/buildium-ruby/models/lease_rent_message.rb +334 -0
- data/lib/buildium-ruby/models/lease_rent_post_message.rb +275 -0
- data/lib/buildium-ruby/models/lease_search_message.rb +359 -0
- data/lib/buildium-ruby/models/lease_security_deposit_post_message.rb +239 -0
- data/lib/buildium-ruby/models/lease_tenant_message.rb +262 -0
- data/lib/buildium-ruby/models/lease_transaction_message.rb +298 -0
- data/lib/buildium-ruby/models/lease_transaction_search_message.rb +263 -0
- data/lib/buildium-ruby/models/listing_contact_message.rb +259 -0
- data/lib/buildium-ruby/models/listing_contact_save_message.rb +253 -0
- data/lib/buildium-ruby/models/listing_file_message.rb +272 -0
- data/lib/buildium-ruby/models/listing_message.rb +305 -0
- data/lib/buildium-ruby/models/listing_property_message.rb +326 -0
- data/lib/buildium-ruby/models/listing_put_message.rb +283 -0
- data/lib/buildium-ruby/models/listing_search_message.rb +262 -0
- data/lib/buildium-ruby/models/listing_unit_message.rb +358 -0
- data/lib/buildium-ruby/models/lock_period_settings_global_message.rb +218 -0
- data/lib/buildium-ruby/models/lock_period_settings_overrides_message.rb +227 -0
- data/lib/buildium-ruby/models/logged_by_staff_user_message.rb +249 -0
- data/lib/buildium-ruby/models/lookup_message.rb +226 -0
- data/lib/buildium-ruby/models/mailing_template_message.rb +282 -0
- data/lib/buildium-ruby/models/note_message.rb +237 -0
- data/lib/buildium-ruby/models/note_post_message.rb +223 -0
- data/lib/buildium-ruby/models/note_put_message.rb +223 -0
- data/lib/buildium-ruby/models/note_search_message.rb +238 -0
- data/lib/buildium-ruby/models/outstanding_balances_line_message.rb +228 -0
- data/lib/buildium-ruby/models/ownership_account_charge_recurring_transaction_message.rb +374 -0
- data/lib/buildium-ruby/models/ownership_account_credit_line_post_message.rb +238 -0
- data/lib/buildium-ruby/models/ownership_account_credit_post_message.rb +309 -0
- data/lib/buildium-ruby/models/ownership_account_deposit_withholding_line_post_message.rb +238 -0
- data/lib/buildium-ruby/models/ownership_account_deposit_withholding_post_message.rb +260 -0
- data/lib/buildium-ruby/models/ownership_account_ledger_charge_lines_put_message.rb +248 -0
- data/lib/buildium-ruby/models/ownership_account_ledger_charge_lines_save_message.rb +238 -0
- data/lib/buildium-ruby/models/ownership_account_ledger_charge_post_message.rb +250 -0
- data/lib/buildium-ruby/models/ownership_account_ledger_charge_put_message.rb +250 -0
- data/lib/buildium-ruby/models/ownership_account_ledger_payment_line_save_message.rb +239 -0
- data/lib/buildium-ruby/models/ownership_account_ledger_payment_post_message.rb +335 -0
- data/lib/buildium-ruby/models/ownership_account_outstanding_balance_message.rb +310 -0
- data/lib/buildium-ruby/models/ownership_account_outstanding_balance_search_message.rb +308 -0
- data/lib/buildium-ruby/models/ownership_account_recurring_credit_message.rb +408 -0
- data/lib/buildium-ruby/models/ownership_account_recurring_payment_message.rb +397 -0
- data/lib/buildium-ruby/models/ownership_account_refund_line_message.rb +228 -0
- data/lib/buildium-ruby/models/ownership_account_refund_lines_post_message.rb +238 -0
- data/lib/buildium-ruby/models/ownership_account_refund_message.rb +301 -0
- data/lib/buildium-ruby/models/ownership_account_refund_post_message.rb +306 -0
- data/lib/buildium-ruby/models/ownership_account_transaction_message.rb +298 -0
- data/lib/buildium-ruby/models/paid_by_message.rb +228 -0
- data/lib/buildium-ruby/models/participant_message.rb +240 -0
- data/lib/buildium-ruby/models/participant_resource_message.rb +263 -0
- data/lib/buildium-ruby/models/payee_message.rb +283 -0
- data/lib/buildium-ruby/models/payment_detail_message.rb +281 -0
- data/lib/buildium-ruby/models/payment_recurring_transaction_post_message.rb +378 -0
- data/lib/buildium-ruby/models/payment_transactions_message.rb +237 -0
- data/lib/buildium-ruby/models/phone_log_message.rb +266 -0
- data/lib/buildium-ruby/models/phone_log_participant_post_message.rb +282 -0
- data/lib/buildium-ruby/models/phone_log_participant_unit_agreement_post_message.rb +263 -0
- data/lib/buildium-ruby/models/phone_log_post_message.rb +267 -0
- data/lib/buildium-ruby/models/phone_log_put_message.rb +253 -0
- data/lib/buildium-ruby/models/phone_log_search_message.rb +336 -0
- data/lib/buildium-ruby/models/phone_number_message.rb +263 -0
- data/lib/buildium-ruby/models/phone_numbers_message.rb +249 -0
- data/lib/buildium-ruby/models/property_group_message.rb +259 -0
- data/lib/buildium-ruby/models/property_group_post_message.rb +250 -0
- data/lib/buildium-ruby/models/property_group_put_message.rb +250 -0
- data/lib/buildium-ruby/models/property_group_search_message.rb +230 -0
- data/lib/buildium-ruby/models/property_manager_message.rb +291 -0
- data/lib/buildium-ruby/models/property_message.rb +273 -0
- data/lib/buildium-ruby/models/recurring_transaction_line_message.rb +228 -0
- data/lib/buildium-ruby/models/recurring_transaction_line_post_message.rb +238 -0
- data/lib/buildium-ruby/models/recurring_transaction_message.rb +388 -0
- data/lib/buildium-ruby/models/rental_appliance_message.rb +288 -0
- data/lib/buildium-ruby/models/rental_appliance_post_message.rb +298 -0
- data/lib/buildium-ruby/models/rental_appliance_put_message.rb +273 -0
- data/lib/buildium-ruby/models/rental_appliance_search_message.rb +232 -0
- data/lib/buildium-ruby/models/rental_appliance_service_history_message.rb +282 -0
- data/lib/buildium-ruby/models/rental_appliance_service_history_post_message.rb +282 -0
- data/lib/buildium-ruby/models/rental_features_message.rb +255 -0
- data/lib/buildium-ruby/models/rental_features_put_message.rb +254 -0
- data/lib/buildium-ruby/models/rental_message.rb +373 -0
- data/lib/buildium-ruby/models/rental_owner_message.rb +361 -0
- data/lib/buildium-ruby/models/rental_owner_post_message.rb +363 -0
- data/lib/buildium-ruby/models/rental_owner_put_message.rb +354 -0
- data/lib/buildium-ruby/models/rental_owner_request_task_message.rb +381 -0
- data/lib/buildium-ruby/models/rental_owner_request_task_post_message.rb +384 -0
- data/lib/buildium-ruby/models/rental_owner_request_task_put_message.rb +369 -0
- data/lib/buildium-ruby/models/rental_owner_request_task_search_message.rb +366 -0
- data/lib/buildium-ruby/models/rental_owner_tax_information_message.rb +302 -0
- data/lib/buildium-ruby/models/rental_owners_search_message.rb +314 -0
- data/lib/buildium-ruby/models/rental_preferred_vendor_message.rb +300 -0
- data/lib/buildium-ruby/models/rental_preferred_vendor_put_message.rb +225 -0
- data/lib/buildium-ruby/models/rental_property_post_message.rb +365 -0
- data/lib/buildium-ruby/models/rental_property_put_message.rb +341 -0
- data/lib/buildium-ruby/models/rental_property_unit_post_message.rb +333 -0
- data/lib/buildium-ruby/models/rental_search_message.rb +330 -0
- data/lib/buildium-ruby/models/rental_tenant_post_message.rb +388 -0
- data/lib/buildium-ruby/models/rental_tenant_put_message.rb +373 -0
- data/lib/buildium-ruby/models/rental_tenant_renewal_post_message.rb +373 -0
- data/lib/buildium-ruby/models/rental_unit_features_message.rb +243 -0
- data/lib/buildium-ruby/models/rental_unit_features_put_message.rb +242 -0
- data/lib/buildium-ruby/models/rental_unit_message.rb +374 -0
- data/lib/buildium-ruby/models/rental_unit_put_message.rb +333 -0
- data/lib/buildium-ruby/models/rental_unit_search_message.rb +240 -0
- data/lib/buildium-ruby/models/rental_units_post_message.rb +348 -0
- data/lib/buildium-ruby/models/requested_by_user_entity_message.rb +303 -0
- data/lib/buildium-ruby/models/resident_center_user_message.rb +280 -0
- data/lib/buildium-ruby/models/resident_center_user_reference_message.rb +292 -0
- data/lib/buildium-ruby/models/resident_center_user_search_message.rb +288 -0
- data/lib/buildium-ruby/models/resident_request_task_message.rb +429 -0
- data/lib/buildium-ruby/models/resident_request_task_post_message.rb +409 -0
- data/lib/buildium-ruby/models/resident_request_task_put_message.rb +349 -0
- data/lib/buildium-ruby/models/resident_request_task_search_message.rb +376 -0
- data/lib/buildium-ruby/models/save_address_message.rb +323 -0
- data/lib/buildium-ruby/models/save_emergency_contact_message.rb +248 -0
- data/lib/buildium-ruby/models/task_category_message.rb +251 -0
- data/lib/buildium-ruby/models/task_category_put_message.rb +224 -0
- data/lib/buildium-ruby/models/task_category_response_message.rb +248 -0
- data/lib/buildium-ruby/models/task_category_save_message.rb +224 -0
- data/lib/buildium-ruby/models/task_history_file_message.rb +268 -0
- data/lib/buildium-ruby/models/task_history_file_upload_post_message.rb +223 -0
- data/lib/buildium-ruby/models/task_history_message.rb +376 -0
- data/lib/buildium-ruby/models/task_history_put_message.rb +223 -0
- data/lib/buildium-ruby/models/task_history_user_message.rb +249 -0
- data/lib/buildium-ruby/models/task_search_message.rb +398 -0
- data/lib/buildium-ruby/models/task_sub_category_message.rb +229 -0
- data/lib/buildium-ruby/models/tax_information_post_message.rb +292 -0
- data/lib/buildium-ruby/models/tax_information_save_message.rb +307 -0
- data/lib/buildium-ruby/models/tenant_message.rb +404 -0
- data/lib/buildium-ruby/models/tenant_search_message.rb +339 -0
- data/lib/buildium-ruby/models/to_do_task_message.rb +372 -0
- data/lib/buildium-ruby/models/to_do_task_post_message.rb +374 -0
- data/lib/buildium-ruby/models/to_do_task_put_message.rb +374 -0
- data/lib/buildium-ruby/models/to_do_task_search_message.rb +366 -0
- data/lib/buildium-ruby/models/undeposited_funds_message.rb +217 -0
- data/lib/buildium-ruby/models/unit_agreement_message.rb +273 -0
- data/lib/buildium-ruby/models/user_message.rb +354 -0
- data/lib/buildium-ruby/models/user_role_message.rb +249 -0
- data/lib/buildium-ruby/models/user_search_message.rb +297 -0
- data/lib/buildium-ruby/models/vehicle_message.rb +249 -0
- data/lib/buildium-ruby/models/vendor_category_message.rb +239 -0
- data/lib/buildium-ruby/models/vendor_category_save_message.rb +223 -0
- data/lib/buildium-ruby/models/vendor_credit_line_item_message.rb +257 -0
- data/lib/buildium-ruby/models/vendor_credit_line_item_post_message.rb +262 -0
- data/lib/buildium-ruby/models/vendor_credit_message.rb +260 -0
- data/lib/buildium-ruby/models/vendor_credit_post_message.rb +260 -0
- data/lib/buildium-ruby/models/vendor_insurance_message.rb +239 -0
- data/lib/buildium-ruby/models/vendor_insurance_save_message.rb +239 -0
- data/lib/buildium-ruby/models/vendor_message.rb +377 -0
- data/lib/buildium-ruby/models/vendor_post_message.rb +364 -0
- data/lib/buildium-ruby/models/vendor_put_message.rb +364 -0
- data/lib/buildium-ruby/models/vendor_refund_line_message.rb +257 -0
- data/lib/buildium-ruby/models/vendor_refund_line_post_message.rb +262 -0
- data/lib/buildium-ruby/models/vendor_refund_message.rb +314 -0
- data/lib/buildium-ruby/models/vendor_refund_post_message.rb +324 -0
- data/lib/buildium-ruby/models/vendor_search_message.rb +334 -0
- data/lib/buildium-ruby/models/vendor_tax_information_message.rb +302 -0
- data/lib/buildium-ruby/models/vendor_transaction_message.rb +302 -0
- data/lib/buildium-ruby/models/vendor_transaction_search_message.rb +292 -0
- data/lib/buildium-ruby/models/work_order_entry_contact_message.rb +231 -0
- data/lib/buildium-ruby/models/work_order_entry_contact_resource_message.rb +263 -0
- data/lib/buildium-ruby/models/work_order_line_item_message.rb +249 -0
- data/lib/buildium-ruby/models/work_order_line_item_save_message.rb +258 -0
- data/lib/buildium-ruby/models/work_order_message.rb +372 -0
- data/lib/buildium-ruby/models/work_order_post_message.rb +363 -0
- data/lib/buildium-ruby/models/work_order_put_message.rb +344 -0
- data/lib/buildium-ruby/models/work_order_search_message.rb +452 -0
- data/lib/buildium-ruby/models/work_order_task_message.rb +346 -0
- data/lib/buildium-ruby/models/work_order_task_post_message.rb +345 -0
- data/lib/buildium-ruby/version.rb +15 -0
- data/lib/buildium-ruby.rb +438 -0
- data/openapitools.json +7 -0
- data/spec/api/accounting_api_spec.rb +383 -0
- data/spec/api/administration_api_spec.rb +114 -0
- data/spec/api/applicants_api_spec.rb +294 -0
- data/spec/api/association_appliances_api_spec.rb +141 -0
- data/spec/api/association_owners_api_spec.rb +195 -0
- data/spec/api/association_ownership_accounts_api_spec.rb +385 -0
- data/spec/api/association_tenants_api_spec.rb +153 -0
- data/spec/api/association_units_api_spec.rb +147 -0
- data/spec/api/associations_api_spec.rb +248 -0
- data/spec/api/bank_accounts_api_spec.rb +420 -0
- data/spec/api/client_leads_api_spec.rb +66 -0
- data/spec/api/communications_api_spec.rb +248 -0
- data/spec/api/files_api_spec.rb +156 -0
- data/spec/api/leases_api_spec.rb +529 -0
- data/spec/api/listings_api_spec.rb +139 -0
- data/spec/api/property_groups_api_spec.rb +88 -0
- data/spec/api/rental_appliances_api_spec.rb +141 -0
- data/spec/api/rental_owners_api_spec.rb +151 -0
- data/spec/api/rental_properties_api_spec.rb +205 -0
- data/spec/api/rental_tenants_api_spec.rb +154 -0
- data/spec/api/rental_units_api_spec.rb +172 -0
- data/spec/api/resident_center_api_spec.rb +54 -0
- data/spec/api/tasks_api_spec.rb +493 -0
- data/spec/api/vendors_api_spec.rb +275 -0
- data/spec/api/work_orders_api_spec.rb +105 -0
- data/spec/api_client_spec.rb +188 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/account_info_message_spec.rb +58 -0
- data/spec/models/accounting_entity_message_spec.rb +50 -0
- data/spec/models/accounting_entity_save_message_spec.rb +44 -0
- data/spec/models/accounting_lock_period_message_spec.rb +46 -0
- data/spec/models/accounting_settings_message_spec.rb +72 -0
- data/spec/models/address_message_spec.rb +74 -0
- data/spec/models/all_tasks_message_spec.rb +130 -0
- data/spec/models/announcement_message_spec.rb +74 -0
- data/spec/models/announcement_post_message_spec.rb +64 -0
- data/spec/models/announcement_search_message_spec.rb +62 -0
- data/spec/models/announcement_sender_message_spec.rb +46 -0
- data/spec/models/api_error_response_spec.rb +46 -0
- data/spec/models/appliance_message_spec.rb +58 -0
- data/spec/models/applicant_application_message_spec.rb +56 -0
- data/spec/models/applicant_group_message_spec.rb +62 -0
- data/spec/models/applicant_group_post_message_spec.rb +40 -0
- data/spec/models/applicant_group_put_message_spec.rb +50 -0
- data/spec/models/applicant_group_search_message_spec.rb +66 -0
- data/spec/models/applicant_message_spec.rb +88 -0
- data/spec/models/applicant_post_message_spec.rb +64 -0
- data/spec/models/applicant_put_message_spec.rb +58 -0
- data/spec/models/applicant_search_message_spec.rb +84 -0
- data/spec/models/application_message_spec.rb +62 -0
- data/spec/models/application_put_message_spec.rb +38 -0
- data/spec/models/application_response_field_message_spec.rb +60 -0
- data/spec/models/application_response_message_spec.rb +50 -0
- data/spec/models/application_section_response_message_spec.rb +34 -0
- data/spec/models/association_appliance_message_spec.rb +76 -0
- data/spec/models/association_appliance_post_message_spec.rb +76 -0
- data/spec/models/association_appliance_put_message_spec.rb +64 -0
- data/spec/models/association_appliance_search_message_spec.rb +40 -0
- data/spec/models/association_appliance_service_history_message_spec.rb +56 -0
- data/spec/models/association_appliance_service_history_post_message_spec.rb +50 -0
- data/spec/models/association_board_member_message_spec.rb +92 -0
- data/spec/models/association_board_member_post_message_spec.rb +56 -0
- data/spec/models/association_board_member_put_message_spec.rb +50 -0
- data/spec/models/association_board_member_search_message_spec.rb +60 -0
- data/spec/models/association_message_spec.rb +100 -0
- data/spec/models/association_owner_board_term_message_spec.rb +68 -0
- data/spec/models/association_owner_board_term_post_message_spec.rb +50 -0
- data/spec/models/association_owner_message_spec.rb +144 -0
- data/spec/models/association_owner_post_message_spec.rb +116 -0
- data/spec/models/association_owner_put_message_spec.rb +98 -0
- data/spec/models/association_owner_to_existing_ownership_account_post_message_spec.rb +128 -0
- data/spec/models/association_owner_unit_occupancy_put_message_spec.rb +34 -0
- data/spec/models/association_owner_unit_occupancy_status_message_spec.rb +40 -0
- data/spec/models/association_ownership_account_message_spec.rb +90 -0
- data/spec/models/association_ownership_account_post_message_spec.rb +80 -0
- data/spec/models/association_ownership_account_put_message_spec.rb +34 -0
- data/spec/models/association_ownership_account_search_message_spec.rb +72 -0
- data/spec/models/association_post_message_spec.rb +76 -0
- data/spec/models/association_preferred_vendor_message_spec.rb +82 -0
- data/spec/models/association_preferred_vendor_put_message_spec.rb +34 -0
- data/spec/models/association_put_message_spec.rb +82 -0
- data/spec/models/association_search_message_spec.rb +56 -0
- data/spec/models/association_tenant_message_spec.rb +112 -0
- data/spec/models/association_tenant_post_message_spec.rb +106 -0
- data/spec/models/association_tenant_put_message_spec.rb +94 -0
- data/spec/models/association_unit_message_spec.rb +84 -0
- data/spec/models/association_unit_put_message_spec.rb +66 -0
- data/spec/models/association_unit_search_message_spec.rb +46 -0
- data/spec/models/association_units_post_message_spec.rb +72 -0
- data/spec/models/association_user_search_message_spec.rb +86 -0
- data/spec/models/bank_account_check_accounting_entity_save_message_spec.rb +44 -0
- data/spec/models/bank_account_check_line_message_spec.rb +64 -0
- data/spec/models/bank_account_check_line_save_message_spec.rb +58 -0
- data/spec/models/bank_account_check_message_spec.rb +70 -0
- data/spec/models/bank_account_check_payee_message_spec.rb +50 -0
- data/spec/models/bank_account_check_payee_save_message_spec.rb +44 -0
- data/spec/models/bank_account_check_post_message_spec.rb +58 -0
- data/spec/models/bank_account_check_put_message_spec.rb +58 -0
- data/spec/models/bank_account_check_search_message_spec.rb +40 -0
- data/spec/models/bank_account_deposit_line_message_spec.rb +64 -0
- data/spec/models/bank_account_deposit_line_save_message_spec.rb +58 -0
- data/spec/models/bank_account_deposit_message_spec.rb +64 -0
- data/spec/models/bank_account_deposit_post_message_spec.rb +52 -0
- data/spec/models/bank_account_deposit_put_message_spec.rb +46 -0
- data/spec/models/bank_account_deposit_search_message_spec.rb +40 -0
- data/spec/models/bank_account_message_spec.rb +104 -0
- data/spec/models/bank_account_post_message_spec.rb +78 -0
- data/spec/models/bank_account_put_message_spec.rb +78 -0
- data/spec/models/bank_account_quick_deposit_message_spec.rb +64 -0
- data/spec/models/bank_account_quick_deposit_save_message_spec.rb +58 -0
- data/spec/models/bank_account_quick_deposit_search_message_spec.rb +40 -0
- data/spec/models/bank_account_search_message_spec.rb +44 -0
- data/spec/models/bank_account_transaction_message_spec.rb +96 -0
- data/spec/models/bank_account_transaction_search_message_spec.rb +56 -0
- data/spec/models/bank_account_transfer_accounting_entity_save_message_spec.rb +44 -0
- data/spec/models/bank_account_transfer_message_spec.rb +64 -0
- data/spec/models/bank_account_transfer_save_message_spec.rb +58 -0
- data/spec/models/bank_account_transfer_search_message_spec.rb +40 -0
- data/spec/models/bank_account_withdrawal_message_spec.rb +64 -0
- data/spec/models/bank_account_withdrawal_save_message_spec.rb +58 -0
- data/spec/models/bank_account_withdrawal_search_message_spec.rb +40 -0
- data/spec/models/bill_file_message_spec.rb +64 -0
- data/spec/models/bill_line_message_spec.rb +64 -0
- data/spec/models/bill_line_post_message_spec.rb +58 -0
- data/spec/models/bill_line_put_message_spec.rb +64 -0
- data/spec/models/bill_markup_message_spec.rb +44 -0
- data/spec/models/bill_markup_save_message_spec.rb +44 -0
- data/spec/models/bill_message_spec.rb +92 -0
- data/spec/models/bill_payment_accounting_entity_message_spec.rb +44 -0
- data/spec/models/bill_payment_line_message_spec.rb +46 -0
- data/spec/models/bill_payment_line_post_message_spec.rb +40 -0
- data/spec/models/bill_payment_message_spec.rb +64 -0
- data/spec/models/bill_payment_post_message_spec.rb +58 -0
- data/spec/models/bill_post_message_spec.rb +70 -0
- data/spec/models/bill_put_message_spec.rb +64 -0
- data/spec/models/bill_search_message_spec.rb +88 -0
- data/spec/models/budget_details_message_spec.rb +56 -0
- data/spec/models/budget_details_save_message_spec.rb +40 -0
- data/spec/models/budget_message_spec.rb +64 -0
- data/spec/models/budget_monthly_amounts_message_spec.rb +100 -0
- data/spec/models/budget_monthly_amounts_save_message_spec.rb +100 -0
- data/spec/models/budget_post_message_spec.rb +62 -0
- data/spec/models/budget_put_message_spec.rb +40 -0
- data/spec/models/budget_search_message_spec.rb +46 -0
- data/spec/models/charge_recurring_transaction_post_message_spec.rb +84 -0
- data/spec/models/charge_recurring_transaction_put_message_spec.rb +90 -0
- data/spec/models/check_printing_info_message_spec.rb +122 -0
- data/spec/models/check_printing_info_post_message_spec.rb +122 -0
- data/spec/models/check_printing_info_put_message_spec.rb +122 -0
- data/spec/models/client_lead_credit_request_message_spec.rb +60 -0
- data/spec/models/client_lead_message_spec.rb +102 -0
- data/spec/models/client_lead_search_message_spec.rb +66 -0
- data/spec/models/contact_detail_message_spec.rb +52 -0
- data/spec/models/contact_detail_phone_message_spec.rb +46 -0
- data/spec/models/contact_detail_save_message_spec.rb +52 -0
- data/spec/models/contact_detail_save_phone_message_spec.rb +46 -0
- data/spec/models/contact_info_message_spec.rb +52 -0
- data/spec/models/contact_request_task_message_spec.rb +114 -0
- data/spec/models/contact_request_task_post_message_spec.rb +102 -0
- data/spec/models/contact_request_task_put_message_spec.rb +102 -0
- data/spec/models/contact_request_task_search_message_spec.rb +112 -0
- data/spec/models/cosigner_message_spec.rb +92 -0
- data/spec/models/created_by_user_message_spec.rb +52 -0
- data/spec/models/credit_recurring_transaction_post_message_spec.rb +100 -0
- data/spec/models/deposit_detail_message_spec.rb +40 -0
- data/spec/models/electronic_payments_message_spec.rb +76 -0
- data/spec/models/email_message_spec.rb +52 -0
- data/spec/models/email_post_message_spec.rb +70 -0
- data/spec/models/email_recipient_message_spec.rb +62 -0
- data/spec/models/email_search_message_spec.rb +58 -0
- data/spec/models/email_sender_message_spec.rb +52 -0
- data/spec/models/emergency_contact_message_spec.rb +52 -0
- data/spec/models/file_category_message_spec.rb +46 -0
- data/spec/models/file_category_post_message_spec.rb +34 -0
- data/spec/models/file_category_put_message_spec.rb +34 -0
- data/spec/models/file_download_message_spec.rb +34 -0
- data/spec/models/file_entity_message_spec.rb +50 -0
- data/spec/models/file_message_spec.rb +82 -0
- data/spec/models/file_name_post_message_spec.rb +34 -0
- data/spec/models/file_put_message_spec.rb +46 -0
- data/spec/models/file_search_message_spec.rb +74 -0
- data/spec/models/file_upload_post_message_spec.rb +68 -0
- data/spec/models/file_upload_ticket_message_spec.rb +46 -0
- data/spec/models/general_journal_entry_line_save_message_spec.rb +56 -0
- data/spec/models/general_journal_entry_post_message_spec.rb +52 -0
- data/spec/models/general_journal_entry_put_message_spec.rb +52 -0
- data/spec/models/general_ledger_journal_line_message_spec.rb +64 -0
- data/spec/models/general_ledger_journal_message_spec.rb +40 -0
- data/spec/models/general_ledger_transaction_message_spec.rb +98 -0
- data/spec/models/general_ledger_transaction_search_message_spec.rb +62 -0
- data/spec/models/gl_account_balance_item_message_spec.rb +40 -0
- data/spec/models/gl_account_balance_message_spec.rb +46 -0
- data/spec/models/gl_account_balance_search_message_spec.rb +66 -0
- data/spec/models/gl_account_message_spec.rb +130 -0
- data/spec/models/gl_account_post_message_spec.rb +84 -0
- data/spec/models/gl_account_put_message_spec.rb +84 -0
- data/spec/models/gl_accounts_search_message_spec.rb +38 -0
- data/spec/models/gl_transaction_message_v1_spec.rb +58 -0
- data/spec/models/internal_transaction_status_message_spec.rb +46 -0
- data/spec/models/journal_line_message_spec.rb +64 -0
- data/spec/models/journal_message_spec.rb +40 -0
- data/spec/models/last_updated_by_user_message_spec.rb +58 -0
- data/spec/models/lease_account_detail_message_spec.rb +40 -0
- data/spec/models/lease_charge_line_save_message_spec.rb +46 -0
- data/spec/models/lease_charge_post_message_spec.rb +46 -0
- data/spec/models/lease_charge_put_message_spec.rb +46 -0
- data/spec/models/lease_charge_recurring_transaction_message_spec.rb +108 -0
- data/spec/models/lease_cosigner_post_message_spec.rb +80 -0
- data/spec/models/lease_ledger_credit_line_post_message_spec.rb +40 -0
- data/spec/models/lease_ledger_credit_post_message_spec.rb +62 -0
- data/spec/models/lease_ledger_deposit_withholding_line_post_message_spec.rb +40 -0
- data/spec/models/lease_ledger_deposit_withholding_post_message_spec.rb +52 -0
- data/spec/models/lease_ledger_payment_line_save_message_spec.rb +40 -0
- data/spec/models/lease_ledger_payment_post_message_spec.rb +74 -0
- data/spec/models/lease_ledger_refund_line_message_spec.rb +40 -0
- data/spec/models/lease_ledger_refund_line_post_message_spec.rb +40 -0
- data/spec/models/lease_ledger_refund_message_spec.rb +82 -0
- data/spec/models/lease_ledger_refund_post_message_spec.rb +70 -0
- data/spec/models/lease_ledger_reverse_payment_nsf_charge_post_message_spec.rb +40 -0
- data/spec/models/lease_ledger_reverse_payment_other_bank_charge_post_message_spec.rb +40 -0
- data/spec/models/lease_ledger_reverse_payment_post_message_spec.rb +52 -0
- data/spec/models/lease_message_spec.rb +170 -0
- data/spec/models/lease_move_out_data_message_spec.rb +46 -0
- data/spec/models/lease_move_out_data_post_message_spec.rb +46 -0
- data/spec/models/lease_outstanding_balance_message_spec.rb +100 -0
- data/spec/models/lease_outstanding_balance_search_message_spec.rb +90 -0
- data/spec/models/lease_post_message_spec.rb +98 -0
- data/spec/models/lease_put_message_spec.rb +68 -0
- data/spec/models/lease_recurring_credit_message_spec.rb +124 -0
- data/spec/models/lease_recurring_payment_message_spec.rb +118 -0
- data/spec/models/lease_renewal_message_spec.rb +84 -0
- data/spec/models/lease_renewal_post_message_spec.rb +98 -0
- data/spec/models/lease_rent_charge_message_spec.rb +70 -0
- data/spec/models/lease_rent_charge_post_message_spec.rb +52 -0
- data/spec/models/lease_rent_message_spec.rb +86 -0
- data/spec/models/lease_rent_post_message_spec.rb +44 -0
- data/spec/models/lease_search_message_spec.rb +108 -0
- data/spec/models/lease_security_deposit_post_message_spec.rb +40 -0
- data/spec/models/lease_tenant_message_spec.rb +44 -0
- data/spec/models/lease_transaction_message_spec.rb +82 -0
- data/spec/models/lease_transaction_search_message_spec.rb +50 -0
- data/spec/models/listing_contact_message_spec.rb +58 -0
- data/spec/models/listing_contact_save_message_spec.rb +52 -0
- data/spec/models/listing_file_message_spec.rb +50 -0
- data/spec/models/listing_message_spec.rb +88 -0
- data/spec/models/listing_property_message_spec.rb +90 -0
- data/spec/models/listing_put_message_spec.rb +64 -0
- data/spec/models/listing_search_message_spec.rb +44 -0
- data/spec/models/listing_unit_message_spec.rb +100 -0
- data/spec/models/lock_period_settings_global_message_spec.rb +34 -0
- data/spec/models/lock_period_settings_overrides_message_spec.rb +40 -0
- data/spec/models/logged_by_staff_user_message_spec.rb +52 -0
- data/spec/models/lookup_message_spec.rb +40 -0
- data/spec/models/mailing_template_message_spec.rb +56 -0
- data/spec/models/note_message_spec.rb +46 -0
- data/spec/models/note_post_message_spec.rb +34 -0
- data/spec/models/note_put_message_spec.rb +34 -0
- data/spec/models/note_search_message_spec.rb +46 -0
- data/spec/models/outstanding_balances_line_message_spec.rb +40 -0
- data/spec/models/ownership_account_charge_recurring_transaction_message_spec.rb +108 -0
- data/spec/models/ownership_account_credit_line_post_message_spec.rb +40 -0
- data/spec/models/ownership_account_credit_post_message_spec.rb +62 -0
- data/spec/models/ownership_account_deposit_withholding_line_post_message_spec.rb +40 -0
- data/spec/models/ownership_account_deposit_withholding_post_message_spec.rb +52 -0
- data/spec/models/ownership_account_ledger_charge_lines_put_message_spec.rb +46 -0
- data/spec/models/ownership_account_ledger_charge_lines_save_message_spec.rb +40 -0
- data/spec/models/ownership_account_ledger_charge_post_message_spec.rb +46 -0
- data/spec/models/ownership_account_ledger_charge_put_message_spec.rb +46 -0
- data/spec/models/ownership_account_ledger_payment_line_save_message_spec.rb +40 -0
- data/spec/models/ownership_account_ledger_payment_post_message_spec.rb +74 -0
- data/spec/models/ownership_account_outstanding_balance_message_spec.rb +88 -0
- data/spec/models/ownership_account_outstanding_balance_search_message_spec.rb +70 -0
- data/spec/models/ownership_account_recurring_credit_message_spec.rb +124 -0
- data/spec/models/ownership_account_recurring_payment_message_spec.rb +118 -0
- data/spec/models/ownership_account_refund_line_message_spec.rb +40 -0
- data/spec/models/ownership_account_refund_lines_post_message_spec.rb +40 -0
- data/spec/models/ownership_account_refund_message_spec.rb +82 -0
- data/spec/models/ownership_account_refund_post_message_spec.rb +70 -0
- data/spec/models/ownership_account_transaction_message_spec.rb +82 -0
- data/spec/models/paid_by_message_spec.rb +40 -0
- data/spec/models/participant_message_spec.rb +46 -0
- data/spec/models/participant_resource_message_spec.rb +44 -0
- data/spec/models/payee_message_spec.rb +56 -0
- data/spec/models/payment_detail_message_spec.rb +56 -0
- data/spec/models/payment_recurring_transaction_post_message_spec.rb +94 -0
- data/spec/models/payment_transactions_message_spec.rb +46 -0
- data/spec/models/phone_log_message_spec.rb +64 -0
- data/spec/models/phone_log_participant_post_message_spec.rb +50 -0
- data/spec/models/phone_log_participant_unit_agreement_post_message_spec.rb +44 -0
- data/spec/models/phone_log_post_message_spec.rb +52 -0
- data/spec/models/phone_log_put_message_spec.rb +46 -0
- data/spec/models/phone_log_search_message_spec.rb +84 -0
- data/spec/models/phone_number_message_spec.rb +44 -0
- data/spec/models/phone_numbers_message_spec.rb +52 -0
- data/spec/models/property_group_message_spec.rb +58 -0
- data/spec/models/property_group_post_message_spec.rb +46 -0
- data/spec/models/property_group_put_message_spec.rb +46 -0
- data/spec/models/property_group_search_message_spec.rb +40 -0
- data/spec/models/property_manager_message_spec.rb +76 -0
- data/spec/models/property_message_spec.rb +50 -0
- data/spec/models/recurring_transaction_line_message_spec.rb +40 -0
- data/spec/models/recurring_transaction_line_post_message_spec.rb +40 -0
- data/spec/models/recurring_transaction_message_spec.rb +112 -0
- data/spec/models/rental_appliance_message_spec.rb +76 -0
- data/spec/models/rental_appliance_post_message_spec.rb +76 -0
- data/spec/models/rental_appliance_put_message_spec.rb +64 -0
- data/spec/models/rental_appliance_search_message_spec.rb +40 -0
- data/spec/models/rental_appliance_service_history_message_spec.rb +56 -0
- data/spec/models/rental_appliance_service_history_post_message_spec.rb +50 -0
- data/spec/models/rental_features_message_spec.rb +48 -0
- data/spec/models/rental_features_put_message_spec.rb +48 -0
- data/spec/models/rental_message_spec.rb +108 -0
- data/spec/models/rental_owner_message_spec.rb +118 -0
- data/spec/models/rental_owner_post_message_spec.rb +112 -0
- data/spec/models/rental_owner_put_message_spec.rb +106 -0
- data/spec/models/rental_owner_request_task_message_spec.rb +114 -0
- data/spec/models/rental_owner_request_task_post_message_spec.rb +102 -0
- data/spec/models/rental_owner_request_task_put_message_spec.rb +96 -0
- data/spec/models/rental_owner_request_task_search_message_spec.rb +112 -0
- data/spec/models/rental_owner_tax_information_message_spec.rb +68 -0
- data/spec/models/rental_owners_search_message_spec.rb +74 -0
- data/spec/models/rental_preferred_vendor_message_spec.rb +82 -0
- data/spec/models/rental_preferred_vendor_put_message_spec.rb +34 -0
- data/spec/models/rental_property_post_message_spec.rb +92 -0
- data/spec/models/rental_property_put_message_spec.rb +80 -0
- data/spec/models/rental_property_unit_post_message_spec.rb +78 -0
- data/spec/models/rental_search_message_spec.rb +88 -0
- data/spec/models/rental_tenant_post_message_spec.rb +110 -0
- data/spec/models/rental_tenant_put_message_spec.rb +104 -0
- data/spec/models/rental_tenant_renewal_post_message_spec.rb +104 -0
- data/spec/models/rental_unit_features_message_spec.rb +38 -0
- data/spec/models/rental_unit_features_put_message_spec.rb +38 -0
- data/spec/models/rental_unit_message_spec.rb +108 -0
- data/spec/models/rental_unit_put_message_spec.rb +78 -0
- data/spec/models/rental_unit_search_message_spec.rb +46 -0
- data/spec/models/rental_units_post_message_spec.rb +84 -0
- data/spec/models/requested_by_user_entity_message_spec.rb +68 -0
- data/spec/models/resident_center_user_message_spec.rb +56 -0
- data/spec/models/resident_center_user_reference_message_spec.rb +62 -0
- data/spec/models/resident_center_user_search_message_spec.rb +66 -0
- data/spec/models/resident_request_task_message_spec.rb +144 -0
- data/spec/models/resident_request_task_post_message_spec.rb +114 -0
- data/spec/models/resident_request_task_put_message_spec.rb +84 -0
- data/spec/models/resident_request_task_search_message_spec.rb +118 -0
- data/spec/models/save_address_message_spec.rb +74 -0
- data/spec/models/save_emergency_contact_message_spec.rb +52 -0
- data/spec/models/task_category_message_spec.rb +52 -0
- data/spec/models/task_category_put_message_spec.rb +34 -0
- data/spec/models/task_category_response_message_spec.rb +52 -0
- data/spec/models/task_category_save_message_spec.rb +34 -0
- data/spec/models/task_history_file_message_spec.rb +64 -0
- data/spec/models/task_history_file_upload_post_message_spec.rb +34 -0
- data/spec/models/task_history_message_spec.rb +112 -0
- data/spec/models/task_history_put_message_spec.rb +34 -0
- data/spec/models/task_history_user_message_spec.rb +52 -0
- data/spec/models/task_search_message_spec.rb +128 -0
- data/spec/models/task_sub_category_message_spec.rb +40 -0
- data/spec/models/tax_information_post_message_spec.rb +62 -0
- data/spec/models/tax_information_save_message_spec.rb +68 -0
- data/spec/models/tenant_message_spec.rb +128 -0
- data/spec/models/tenant_search_message_spec.rb +96 -0
- data/spec/models/to_do_task_message_spec.rb +108 -0
- data/spec/models/to_do_task_post_message_spec.rb +96 -0
- data/spec/models/to_do_task_put_message_spec.rb +96 -0
- data/spec/models/to_do_task_search_message_spec.rb +112 -0
- data/spec/models/undeposited_funds_message_spec.rb +34 -0
- data/spec/models/unit_agreement_message_spec.rb +50 -0
- data/spec/models/user_message_spec.rb +104 -0
- data/spec/models/user_role_message_spec.rb +52 -0
- data/spec/models/user_search_message_spec.rb +66 -0
- data/spec/models/vehicle_message_spec.rb +52 -0
- data/spec/models/vendor_category_message_spec.rb +46 -0
- data/spec/models/vendor_category_save_message_spec.rb +34 -0
- data/spec/models/vendor_credit_line_item_message_spec.rb +58 -0
- data/spec/models/vendor_credit_line_item_post_message_spec.rb +52 -0
- data/spec/models/vendor_credit_message_spec.rb +58 -0
- data/spec/models/vendor_credit_post_message_spec.rb +52 -0
- data/spec/models/vendor_insurance_message_spec.rb +46 -0
- data/spec/models/vendor_insurance_save_message_spec.rb +46 -0
- data/spec/models/vendor_message_spec.rb +130 -0
- data/spec/models/vendor_post_message_spec.rb +118 -0
- data/spec/models/vendor_put_message_spec.rb +118 -0
- data/spec/models/vendor_refund_line_message_spec.rb +58 -0
- data/spec/models/vendor_refund_line_post_message_spec.rb +52 -0
- data/spec/models/vendor_refund_message_spec.rb +74 -0
- data/spec/models/vendor_refund_post_message_spec.rb +68 -0
- data/spec/models/vendor_search_message_spec.rb +84 -0
- data/spec/models/vendor_tax_information_message_spec.rb +68 -0
- data/spec/models/vendor_transaction_message_spec.rb +68 -0
- data/spec/models/vendor_transaction_search_message_spec.rb +62 -0
- data/spec/models/work_order_entry_contact_message_spec.rb +40 -0
- data/spec/models/work_order_entry_contact_resource_message_spec.rb +44 -0
- data/spec/models/work_order_line_item_message_spec.rb +52 -0
- data/spec/models/work_order_line_item_save_message_spec.rb +52 -0
- data/spec/models/work_order_message_spec.rb +110 -0
- data/spec/models/work_order_post_message_spec.rb +98 -0
- data/spec/models/work_order_put_message_spec.rb +86 -0
- data/spec/models/work_order_search_message_spec.rb +158 -0
- data/spec/models/work_order_task_message_spec.rb +88 -0
- data/spec/models/work_order_task_post_message_spec.rb +78 -0
- data/spec/spec_helper.rb +111 -0
- metadata +1725 -0
|
@@ -0,0 +1,2363 @@
|
|
|
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 TasksApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Create a contact request
|
|
23
|
+
# Creates a contact request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
|
24
|
+
# @param contact_request_task_post_message [ContactRequestTaskPostMessage]
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @return [ContactRequestTaskMessage]
|
|
27
|
+
def create_contact_request_task(contact_request_task_post_message, opts = {})
|
|
28
|
+
data, _status_code, _headers = create_contact_request_task_with_http_info(contact_request_task_post_message, opts)
|
|
29
|
+
data
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# Create a contact request
|
|
33
|
+
# Creates a contact request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
|
|
34
|
+
# @param contact_request_task_post_message [ContactRequestTaskPostMessage]
|
|
35
|
+
# @param [Hash] opts the optional parameters
|
|
36
|
+
# @return [Array<(ContactRequestTaskMessage, Integer, Hash)>] ContactRequestTaskMessage data, response status code and response headers
|
|
37
|
+
def create_contact_request_task_with_http_info(contact_request_task_post_message, opts = {})
|
|
38
|
+
if @api_client.config.debugging
|
|
39
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.create_contact_request_task ...'
|
|
40
|
+
end
|
|
41
|
+
# verify the required parameter 'contact_request_task_post_message' is set
|
|
42
|
+
if @api_client.config.client_side_validation && contact_request_task_post_message.nil?
|
|
43
|
+
fail ArgumentError, "Missing the required parameter 'contact_request_task_post_message' when calling TasksApi.create_contact_request_task"
|
|
44
|
+
end
|
|
45
|
+
# resource path
|
|
46
|
+
local_var_path = '/v1/tasks/contactrequests'
|
|
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(contact_request_task_post_message)
|
|
66
|
+
|
|
67
|
+
# return_type
|
|
68
|
+
return_type = opts[:debug_return_type] || 'ContactRequestTaskMessage'
|
|
69
|
+
|
|
70
|
+
# auth_names
|
|
71
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
72
|
+
|
|
73
|
+
new_options = opts.merge(
|
|
74
|
+
:operation => :"TasksApi.create_contact_request_task",
|
|
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: TasksApi#create_contact_request_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
86
|
+
end
|
|
87
|
+
return data, status_code, headers
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
# Create a rental owner request
|
|
91
|
+
# Creates a rental owner request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
|
92
|
+
# @param rental_owner_request_task_post_message [RentalOwnerRequestTaskPostMessage]
|
|
93
|
+
# @param [Hash] opts the optional parameters
|
|
94
|
+
# @return [RentalOwnerRequestTaskMessage]
|
|
95
|
+
def create_rental_owner_request_task(rental_owner_request_task_post_message, opts = {})
|
|
96
|
+
data, _status_code, _headers = create_rental_owner_request_task_with_http_info(rental_owner_request_task_post_message, opts)
|
|
97
|
+
data
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
# Create a rental owner request
|
|
101
|
+
# Creates a rental owner request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
|
|
102
|
+
# @param rental_owner_request_task_post_message [RentalOwnerRequestTaskPostMessage]
|
|
103
|
+
# @param [Hash] opts the optional parameters
|
|
104
|
+
# @return [Array<(RentalOwnerRequestTaskMessage, Integer, Hash)>] RentalOwnerRequestTaskMessage data, response status code and response headers
|
|
105
|
+
def create_rental_owner_request_task_with_http_info(rental_owner_request_task_post_message, opts = {})
|
|
106
|
+
if @api_client.config.debugging
|
|
107
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.create_rental_owner_request_task ...'
|
|
108
|
+
end
|
|
109
|
+
# verify the required parameter 'rental_owner_request_task_post_message' is set
|
|
110
|
+
if @api_client.config.client_side_validation && rental_owner_request_task_post_message.nil?
|
|
111
|
+
fail ArgumentError, "Missing the required parameter 'rental_owner_request_task_post_message' when calling TasksApi.create_rental_owner_request_task"
|
|
112
|
+
end
|
|
113
|
+
# resource path
|
|
114
|
+
local_var_path = '/v1/tasks/rentalownerrequests'
|
|
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(rental_owner_request_task_post_message)
|
|
134
|
+
|
|
135
|
+
# return_type
|
|
136
|
+
return_type = opts[:debug_return_type] || 'RentalOwnerRequestTaskMessage'
|
|
137
|
+
|
|
138
|
+
# auth_names
|
|
139
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
140
|
+
|
|
141
|
+
new_options = opts.merge(
|
|
142
|
+
:operation => :"TasksApi.create_rental_owner_request_task",
|
|
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: TasksApi#create_rental_owner_request_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
154
|
+
end
|
|
155
|
+
return data, status_code, headers
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# Create a resident request
|
|
159
|
+
# Creates a resident request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
|
160
|
+
# @param resident_request_task_post_message [ResidentRequestTaskPostMessage]
|
|
161
|
+
# @param [Hash] opts the optional parameters
|
|
162
|
+
# @return [ResidentRequestTaskMessage]
|
|
163
|
+
def create_resource(resident_request_task_post_message, opts = {})
|
|
164
|
+
data, _status_code, _headers = create_resource_with_http_info(resident_request_task_post_message, opts)
|
|
165
|
+
data
|
|
166
|
+
end
|
|
167
|
+
|
|
168
|
+
# Create a resident request
|
|
169
|
+
# Creates a resident request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
|
|
170
|
+
# @param resident_request_task_post_message [ResidentRequestTaskPostMessage]
|
|
171
|
+
# @param [Hash] opts the optional parameters
|
|
172
|
+
# @return [Array<(ResidentRequestTaskMessage, Integer, Hash)>] ResidentRequestTaskMessage data, response status code and response headers
|
|
173
|
+
def create_resource_with_http_info(resident_request_task_post_message, opts = {})
|
|
174
|
+
if @api_client.config.debugging
|
|
175
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.create_resource ...'
|
|
176
|
+
end
|
|
177
|
+
# verify the required parameter 'resident_request_task_post_message' is set
|
|
178
|
+
if @api_client.config.client_side_validation && resident_request_task_post_message.nil?
|
|
179
|
+
fail ArgumentError, "Missing the required parameter 'resident_request_task_post_message' when calling TasksApi.create_resource"
|
|
180
|
+
end
|
|
181
|
+
# resource path
|
|
182
|
+
local_var_path = '/v1/tasks/residentrequests'
|
|
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(resident_request_task_post_message)
|
|
202
|
+
|
|
203
|
+
# return_type
|
|
204
|
+
return_type = opts[:debug_return_type] || 'ResidentRequestTaskMessage'
|
|
205
|
+
|
|
206
|
+
# auth_names
|
|
207
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
208
|
+
|
|
209
|
+
new_options = opts.merge(
|
|
210
|
+
:operation => :"TasksApi.create_resource",
|
|
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: TasksApi#create_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
222
|
+
end
|
|
223
|
+
return data, status_code, headers
|
|
224
|
+
end
|
|
225
|
+
|
|
226
|
+
# Create a task category
|
|
227
|
+
# Create a task category. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
|
228
|
+
# @param task_category_save_message [TaskCategorySaveMessage]
|
|
229
|
+
# @param [Hash] opts the optional parameters
|
|
230
|
+
# @return [TaskCategoryMessage]
|
|
231
|
+
def create_task_category(task_category_save_message, opts = {})
|
|
232
|
+
data, _status_code, _headers = create_task_category_with_http_info(task_category_save_message, opts)
|
|
233
|
+
data
|
|
234
|
+
end
|
|
235
|
+
|
|
236
|
+
# Create a task category
|
|
237
|
+
# Create a task category. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
|
|
238
|
+
# @param task_category_save_message [TaskCategorySaveMessage]
|
|
239
|
+
# @param [Hash] opts the optional parameters
|
|
240
|
+
# @return [Array<(TaskCategoryMessage, Integer, Hash)>] TaskCategoryMessage data, response status code and response headers
|
|
241
|
+
def create_task_category_with_http_info(task_category_save_message, opts = {})
|
|
242
|
+
if @api_client.config.debugging
|
|
243
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.create_task_category ...'
|
|
244
|
+
end
|
|
245
|
+
# verify the required parameter 'task_category_save_message' is set
|
|
246
|
+
if @api_client.config.client_side_validation && task_category_save_message.nil?
|
|
247
|
+
fail ArgumentError, "Missing the required parameter 'task_category_save_message' when calling TasksApi.create_task_category"
|
|
248
|
+
end
|
|
249
|
+
# resource path
|
|
250
|
+
local_var_path = '/v1/tasks/categories'
|
|
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
|
+
# HTTP header 'Content-Type'
|
|
260
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
261
|
+
if !content_type.nil?
|
|
262
|
+
header_params['Content-Type'] = content_type
|
|
263
|
+
end
|
|
264
|
+
|
|
265
|
+
# form parameters
|
|
266
|
+
form_params = opts[:form_params] || {}
|
|
267
|
+
|
|
268
|
+
# http body (model)
|
|
269
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(task_category_save_message)
|
|
270
|
+
|
|
271
|
+
# return_type
|
|
272
|
+
return_type = opts[:debug_return_type] || 'TaskCategoryMessage'
|
|
273
|
+
|
|
274
|
+
# auth_names
|
|
275
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
276
|
+
|
|
277
|
+
new_options = opts.merge(
|
|
278
|
+
:operation => :"TasksApi.create_task_category",
|
|
279
|
+
:header_params => header_params,
|
|
280
|
+
:query_params => query_params,
|
|
281
|
+
:form_params => form_params,
|
|
282
|
+
:body => post_body,
|
|
283
|
+
:auth_names => auth_names,
|
|
284
|
+
:return_type => return_type
|
|
285
|
+
)
|
|
286
|
+
|
|
287
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
288
|
+
if @api_client.config.debugging
|
|
289
|
+
@api_client.config.logger.debug "API called: TasksApi#create_task_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
290
|
+
end
|
|
291
|
+
return data, status_code, headers
|
|
292
|
+
end
|
|
293
|
+
|
|
294
|
+
# Create a to do task
|
|
295
|
+
# Creates a to do task. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
|
296
|
+
# @param to_do_task_post_message [ToDoTaskPostMessage]
|
|
297
|
+
# @param [Hash] opts the optional parameters
|
|
298
|
+
# @return [ToDoTaskMessage]
|
|
299
|
+
def create_to_do_task(to_do_task_post_message, opts = {})
|
|
300
|
+
data, _status_code, _headers = create_to_do_task_with_http_info(to_do_task_post_message, opts)
|
|
301
|
+
data
|
|
302
|
+
end
|
|
303
|
+
|
|
304
|
+
# Create a to do task
|
|
305
|
+
# Creates a to do task. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
|
|
306
|
+
# @param to_do_task_post_message [ToDoTaskPostMessage]
|
|
307
|
+
# @param [Hash] opts the optional parameters
|
|
308
|
+
# @return [Array<(ToDoTaskMessage, Integer, Hash)>] ToDoTaskMessage data, response status code and response headers
|
|
309
|
+
def create_to_do_task_with_http_info(to_do_task_post_message, opts = {})
|
|
310
|
+
if @api_client.config.debugging
|
|
311
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.create_to_do_task ...'
|
|
312
|
+
end
|
|
313
|
+
# verify the required parameter 'to_do_task_post_message' is set
|
|
314
|
+
if @api_client.config.client_side_validation && to_do_task_post_message.nil?
|
|
315
|
+
fail ArgumentError, "Missing the required parameter 'to_do_task_post_message' when calling TasksApi.create_to_do_task"
|
|
316
|
+
end
|
|
317
|
+
# resource path
|
|
318
|
+
local_var_path = '/v1/tasks/todorequests'
|
|
319
|
+
|
|
320
|
+
# query parameters
|
|
321
|
+
query_params = opts[:query_params] || {}
|
|
322
|
+
|
|
323
|
+
# header parameters
|
|
324
|
+
header_params = opts[:header_params] || {}
|
|
325
|
+
# HTTP header 'Accept' (if needed)
|
|
326
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
327
|
+
# HTTP header 'Content-Type'
|
|
328
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
329
|
+
if !content_type.nil?
|
|
330
|
+
header_params['Content-Type'] = content_type
|
|
331
|
+
end
|
|
332
|
+
|
|
333
|
+
# form parameters
|
|
334
|
+
form_params = opts[:form_params] || {}
|
|
335
|
+
|
|
336
|
+
# http body (model)
|
|
337
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(to_do_task_post_message)
|
|
338
|
+
|
|
339
|
+
# return_type
|
|
340
|
+
return_type = opts[:debug_return_type] || 'ToDoTaskMessage'
|
|
341
|
+
|
|
342
|
+
# auth_names
|
|
343
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
344
|
+
|
|
345
|
+
new_options = opts.merge(
|
|
346
|
+
:operation => :"TasksApi.create_to_do_task",
|
|
347
|
+
:header_params => header_params,
|
|
348
|
+
:query_params => query_params,
|
|
349
|
+
:form_params => form_params,
|
|
350
|
+
:body => post_body,
|
|
351
|
+
:auth_names => auth_names,
|
|
352
|
+
:return_type => return_type
|
|
353
|
+
)
|
|
354
|
+
|
|
355
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
356
|
+
if @api_client.config.debugging
|
|
357
|
+
@api_client.config.logger.debug "API called: TasksApi#create_to_do_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
358
|
+
end
|
|
359
|
+
return data, status_code, headers
|
|
360
|
+
end
|
|
361
|
+
|
|
362
|
+
# Delete task history file
|
|
363
|
+
# Deletes a specific file from a task history record. The file will be permanently deleted from the Buildium platform an can not be recovered. associated with a task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit` `Delete`
|
|
364
|
+
# @param task_id [Integer]
|
|
365
|
+
# @param task_history_id [Integer]
|
|
366
|
+
# @param file_id [Integer]
|
|
367
|
+
# @param [Hash] opts the optional parameters
|
|
368
|
+
# @return [nil]
|
|
369
|
+
def delete_task_history_file(task_id, task_history_id, file_id, opts = {})
|
|
370
|
+
delete_task_history_file_with_http_info(task_id, task_history_id, file_id, opts)
|
|
371
|
+
nil
|
|
372
|
+
end
|
|
373
|
+
|
|
374
|
+
# Delete task history file
|
|
375
|
+
# Deletes a specific file from a task history record. The file will be permanently deleted from the Buildium platform an can not be recovered. associated with a task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit` `Delete`
|
|
376
|
+
# @param task_id [Integer]
|
|
377
|
+
# @param task_history_id [Integer]
|
|
378
|
+
# @param file_id [Integer]
|
|
379
|
+
# @param [Hash] opts the optional parameters
|
|
380
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
381
|
+
def delete_task_history_file_with_http_info(task_id, task_history_id, file_id, opts = {})
|
|
382
|
+
if @api_client.config.debugging
|
|
383
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.delete_task_history_file ...'
|
|
384
|
+
end
|
|
385
|
+
# verify the required parameter 'task_id' is set
|
|
386
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
|
387
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.delete_task_history_file"
|
|
388
|
+
end
|
|
389
|
+
# verify the required parameter 'task_history_id' is set
|
|
390
|
+
if @api_client.config.client_side_validation && task_history_id.nil?
|
|
391
|
+
fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.delete_task_history_file"
|
|
392
|
+
end
|
|
393
|
+
# verify the required parameter 'file_id' is set
|
|
394
|
+
if @api_client.config.client_side_validation && file_id.nil?
|
|
395
|
+
fail ArgumentError, "Missing the required parameter 'file_id' when calling TasksApi.delete_task_history_file"
|
|
396
|
+
end
|
|
397
|
+
# resource path
|
|
398
|
+
local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}/files/{fileId}'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s)).sub('{' + 'fileId' + '}', CGI.escape(file_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]
|
|
416
|
+
|
|
417
|
+
# auth_names
|
|
418
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
419
|
+
|
|
420
|
+
new_options = opts.merge(
|
|
421
|
+
:operation => :"TasksApi.delete_task_history_file",
|
|
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(:DELETE, local_var_path, new_options)
|
|
431
|
+
if @api_client.config.debugging
|
|
432
|
+
@api_client.config.logger.debug "API called: TasksApi#delete_task_history_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
433
|
+
end
|
|
434
|
+
return data, status_code, headers
|
|
435
|
+
end
|
|
436
|
+
|
|
437
|
+
# Retrieve all rental owner requests
|
|
438
|
+
# Retrieves all rental owner requests. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
|
439
|
+
# @param [Hash] opts the optional parameters
|
|
440
|
+
# @option opts [String] :entitytype Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated.
|
|
441
|
+
# @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field.
|
|
442
|
+
# @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
|
|
443
|
+
# @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
|
|
444
|
+
# @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
445
|
+
# @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
446
|
+
# @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
447
|
+
# @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
448
|
+
# @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
|
|
449
|
+
# @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
|
|
450
|
+
# @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
|
|
451
|
+
# @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
|
|
452
|
+
# @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.
|
|
453
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
454
|
+
# @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.
|
|
455
|
+
# @return [Array<RentalOwnerRequestTaskMessage>]
|
|
456
|
+
def get_all_rental_owner_request_tasks(opts = {})
|
|
457
|
+
data, _status_code, _headers = get_all_rental_owner_request_tasks_with_http_info(opts)
|
|
458
|
+
data
|
|
459
|
+
end
|
|
460
|
+
|
|
461
|
+
# Retrieve all rental owner requests
|
|
462
|
+
# Retrieves all rental owner requests. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
|
|
463
|
+
# @param [Hash] opts the optional parameters
|
|
464
|
+
# @option opts [String] :entitytype Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated.
|
|
465
|
+
# @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field.
|
|
466
|
+
# @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
|
|
467
|
+
# @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
|
|
468
|
+
# @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
469
|
+
# @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
470
|
+
# @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
471
|
+
# @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
472
|
+
# @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
|
|
473
|
+
# @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
|
|
474
|
+
# @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
|
|
475
|
+
# @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
|
|
476
|
+
# @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.
|
|
477
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
478
|
+
# @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.
|
|
479
|
+
# @return [Array<(Array<RentalOwnerRequestTaskMessage>, Integer, Hash)>] Array<RentalOwnerRequestTaskMessage> data, response status code and response headers
|
|
480
|
+
def get_all_rental_owner_request_tasks_with_http_info(opts = {})
|
|
481
|
+
if @api_client.config.debugging
|
|
482
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.get_all_rental_owner_request_tasks ...'
|
|
483
|
+
end
|
|
484
|
+
allowable_values = ["Rental", "RentalOwner", "Association"]
|
|
485
|
+
if @api_client.config.client_side_validation && opts[:'entitytype'] && !allowable_values.include?(opts[:'entitytype'])
|
|
486
|
+
fail ArgumentError, "invalid value for \"entitytype\", must be one of #{allowable_values}"
|
|
487
|
+
end
|
|
488
|
+
allowable_values = ["New", "InProgress", "Completed", "Deferred", "Closed"]
|
|
489
|
+
if @api_client.config.client_side_validation && opts[:'statuses'] && !opts[:'statuses'].all? { |item| allowable_values.include?(item) }
|
|
490
|
+
fail ArgumentError, "invalid value for \"statuses\", must include one of #{allowable_values}"
|
|
491
|
+
end
|
|
492
|
+
allowable_values = ["Low", "Normal", "High"]
|
|
493
|
+
if @api_client.config.client_side_validation && opts[:'priorities'] && !opts[:'priorities'].all? { |item| allowable_values.include?(item) }
|
|
494
|
+
fail ArgumentError, "invalid value for \"priorities\", must include one of #{allowable_values}"
|
|
495
|
+
end
|
|
496
|
+
# resource path
|
|
497
|
+
local_var_path = '/v1/tasks/rentalownerrequests'
|
|
498
|
+
|
|
499
|
+
# query parameters
|
|
500
|
+
query_params = opts[:query_params] || {}
|
|
501
|
+
query_params[:'entitytype'] = opts[:'entitytype'] if !opts[:'entitytype'].nil?
|
|
502
|
+
query_params[:'entityid'] = opts[:'entityid'] if !opts[:'entityid'].nil?
|
|
503
|
+
query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?
|
|
504
|
+
query_params[:'unitid'] = opts[:'unitid'] if !opts[:'unitid'].nil?
|
|
505
|
+
query_params[:'lastupdatedfrom'] = opts[:'lastupdatedfrom'] if !opts[:'lastupdatedfrom'].nil?
|
|
506
|
+
query_params[:'lastupdatedto'] = opts[:'lastupdatedto'] if !opts[:'lastupdatedto'].nil?
|
|
507
|
+
query_params[:'duedatefrom'] = opts[:'duedatefrom'] if !opts[:'duedatefrom'].nil?
|
|
508
|
+
query_params[:'duedateto'] = opts[:'duedateto'] if !opts[:'duedateto'].nil?
|
|
509
|
+
query_params[:'taskcategoryid'] = opts[:'taskcategoryid'] if !opts[:'taskcategoryid'].nil?
|
|
510
|
+
query_params[:'priorities'] = @api_client.build_collection_param(opts[:'priorities'], :multi) if !opts[:'priorities'].nil?
|
|
511
|
+
query_params[:'assignedtoid'] = opts[:'assignedtoid'] if !opts[:'assignedtoid'].nil?
|
|
512
|
+
query_params[:'tasktitle'] = opts[:'tasktitle'] if !opts[:'tasktitle'].nil?
|
|
513
|
+
query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
|
|
514
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
515
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
516
|
+
|
|
517
|
+
# header parameters
|
|
518
|
+
header_params = opts[:header_params] || {}
|
|
519
|
+
# HTTP header 'Accept' (if needed)
|
|
520
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
521
|
+
|
|
522
|
+
# form parameters
|
|
523
|
+
form_params = opts[:form_params] || {}
|
|
524
|
+
|
|
525
|
+
# http body (model)
|
|
526
|
+
post_body = opts[:debug_body]
|
|
527
|
+
|
|
528
|
+
# return_type
|
|
529
|
+
return_type = opts[:debug_return_type] || 'Array<RentalOwnerRequestTaskMessage>'
|
|
530
|
+
|
|
531
|
+
# auth_names
|
|
532
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
533
|
+
|
|
534
|
+
new_options = opts.merge(
|
|
535
|
+
:operation => :"TasksApi.get_all_rental_owner_request_tasks",
|
|
536
|
+
:header_params => header_params,
|
|
537
|
+
:query_params => query_params,
|
|
538
|
+
:form_params => form_params,
|
|
539
|
+
:body => post_body,
|
|
540
|
+
:auth_names => auth_names,
|
|
541
|
+
:return_type => return_type
|
|
542
|
+
)
|
|
543
|
+
|
|
544
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
545
|
+
if @api_client.config.debugging
|
|
546
|
+
@api_client.config.logger.debug "API called: TasksApi#get_all_rental_owner_request_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
547
|
+
end
|
|
548
|
+
return data, status_code, headers
|
|
549
|
+
end
|
|
550
|
+
|
|
551
|
+
# Retrieve all task categories
|
|
552
|
+
# Retrieves a list of task categories. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
|
553
|
+
# @param [Hash] opts the optional parameters
|
|
554
|
+
# @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.
|
|
555
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
556
|
+
# @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.
|
|
557
|
+
# @return [Array<TaskCategoryMessage>]
|
|
558
|
+
def get_all_task_categories(opts = {})
|
|
559
|
+
data, _status_code, _headers = get_all_task_categories_with_http_info(opts)
|
|
560
|
+
data
|
|
561
|
+
end
|
|
562
|
+
|
|
563
|
+
# Retrieve all task categories
|
|
564
|
+
# Retrieves a list of task categories. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
|
|
565
|
+
# @param [Hash] opts the optional parameters
|
|
566
|
+
# @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.
|
|
567
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
568
|
+
# @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.
|
|
569
|
+
# @return [Array<(Array<TaskCategoryMessage>, Integer, Hash)>] Array<TaskCategoryMessage> data, response status code and response headers
|
|
570
|
+
def get_all_task_categories_with_http_info(opts = {})
|
|
571
|
+
if @api_client.config.debugging
|
|
572
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.get_all_task_categories ...'
|
|
573
|
+
end
|
|
574
|
+
# resource path
|
|
575
|
+
local_var_path = '/v1/tasks/categories'
|
|
576
|
+
|
|
577
|
+
# query parameters
|
|
578
|
+
query_params = opts[:query_params] || {}
|
|
579
|
+
query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
|
|
580
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
581
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
582
|
+
|
|
583
|
+
# header parameters
|
|
584
|
+
header_params = opts[:header_params] || {}
|
|
585
|
+
# HTTP header 'Accept' (if needed)
|
|
586
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
587
|
+
|
|
588
|
+
# form parameters
|
|
589
|
+
form_params = opts[:form_params] || {}
|
|
590
|
+
|
|
591
|
+
# http body (model)
|
|
592
|
+
post_body = opts[:debug_body]
|
|
593
|
+
|
|
594
|
+
# return_type
|
|
595
|
+
return_type = opts[:debug_return_type] || 'Array<TaskCategoryMessage>'
|
|
596
|
+
|
|
597
|
+
# auth_names
|
|
598
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
599
|
+
|
|
600
|
+
new_options = opts.merge(
|
|
601
|
+
:operation => :"TasksApi.get_all_task_categories",
|
|
602
|
+
:header_params => header_params,
|
|
603
|
+
:query_params => query_params,
|
|
604
|
+
:form_params => form_params,
|
|
605
|
+
:body => post_body,
|
|
606
|
+
:auth_names => auth_names,
|
|
607
|
+
:return_type => return_type
|
|
608
|
+
)
|
|
609
|
+
|
|
610
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
611
|
+
if @api_client.config.debugging
|
|
612
|
+
@api_client.config.logger.debug "API called: TasksApi#get_all_task_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
613
|
+
end
|
|
614
|
+
return data, status_code, headers
|
|
615
|
+
end
|
|
616
|
+
|
|
617
|
+
# Retrieve all task history files
|
|
618
|
+
# Retrieves the metadata for all files associated with a task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
|
619
|
+
# @param task_id [Integer]
|
|
620
|
+
# @param task_history_id [Integer]
|
|
621
|
+
# @param [Hash] opts the optional parameters
|
|
622
|
+
# @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.
|
|
623
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
624
|
+
# @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.
|
|
625
|
+
# @return [Array<TaskHistoryFileMessage>]
|
|
626
|
+
def get_all_task_history_files(task_id, task_history_id, opts = {})
|
|
627
|
+
data, _status_code, _headers = get_all_task_history_files_with_http_info(task_id, task_history_id, opts)
|
|
628
|
+
data
|
|
629
|
+
end
|
|
630
|
+
|
|
631
|
+
# Retrieve all task history files
|
|
632
|
+
# Retrieves the metadata for all files associated with a task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
|
|
633
|
+
# @param task_id [Integer]
|
|
634
|
+
# @param task_history_id [Integer]
|
|
635
|
+
# @param [Hash] opts the optional parameters
|
|
636
|
+
# @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.
|
|
637
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
638
|
+
# @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.
|
|
639
|
+
# @return [Array<(Array<TaskHistoryFileMessage>, Integer, Hash)>] Array<TaskHistoryFileMessage> data, response status code and response headers
|
|
640
|
+
def get_all_task_history_files_with_http_info(task_id, task_history_id, opts = {})
|
|
641
|
+
if @api_client.config.debugging
|
|
642
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.get_all_task_history_files ...'
|
|
643
|
+
end
|
|
644
|
+
# verify the required parameter 'task_id' is set
|
|
645
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
|
646
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_all_task_history_files"
|
|
647
|
+
end
|
|
648
|
+
# verify the required parameter 'task_history_id' is set
|
|
649
|
+
if @api_client.config.client_side_validation && task_history_id.nil?
|
|
650
|
+
fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.get_all_task_history_files"
|
|
651
|
+
end
|
|
652
|
+
# resource path
|
|
653
|
+
local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}/files'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s))
|
|
654
|
+
|
|
655
|
+
# query parameters
|
|
656
|
+
query_params = opts[:query_params] || {}
|
|
657
|
+
query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
|
|
658
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
659
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
660
|
+
|
|
661
|
+
# header parameters
|
|
662
|
+
header_params = opts[:header_params] || {}
|
|
663
|
+
# HTTP header 'Accept' (if needed)
|
|
664
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
665
|
+
|
|
666
|
+
# form parameters
|
|
667
|
+
form_params = opts[:form_params] || {}
|
|
668
|
+
|
|
669
|
+
# http body (model)
|
|
670
|
+
post_body = opts[:debug_body]
|
|
671
|
+
|
|
672
|
+
# return_type
|
|
673
|
+
return_type = opts[:debug_return_type] || 'Array<TaskHistoryFileMessage>'
|
|
674
|
+
|
|
675
|
+
# auth_names
|
|
676
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
677
|
+
|
|
678
|
+
new_options = opts.merge(
|
|
679
|
+
:operation => :"TasksApi.get_all_task_history_files",
|
|
680
|
+
:header_params => header_params,
|
|
681
|
+
:query_params => query_params,
|
|
682
|
+
:form_params => form_params,
|
|
683
|
+
:body => post_body,
|
|
684
|
+
:auth_names => auth_names,
|
|
685
|
+
:return_type => return_type
|
|
686
|
+
)
|
|
687
|
+
|
|
688
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
689
|
+
if @api_client.config.debugging
|
|
690
|
+
@api_client.config.logger.debug "API called: TasksApi#get_all_task_history_files\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
691
|
+
end
|
|
692
|
+
return data, status_code, headers
|
|
693
|
+
end
|
|
694
|
+
|
|
695
|
+
# Retrieve all tasks
|
|
696
|
+
# Retrieves a list of tasks. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
|
697
|
+
# @param [Hash] opts the optional parameters
|
|
698
|
+
# @option opts [String] :entitytype Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated.
|
|
699
|
+
# @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field.
|
|
700
|
+
# @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
|
|
701
|
+
# @option opts [String] :type Filters results to any task associated with the task type specified.
|
|
702
|
+
# @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
|
|
703
|
+
# @option opts [Integer] :unitagreementid Filters results to any task associated with the unit agreement identifier specified.
|
|
704
|
+
# @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
705
|
+
# @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
706
|
+
# @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
707
|
+
# @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
708
|
+
# @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
|
|
709
|
+
# @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
|
|
710
|
+
# @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
|
|
711
|
+
# @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
|
|
712
|
+
# @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.
|
|
713
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
714
|
+
# @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.
|
|
715
|
+
# @return [Array<AllTasksMessage>]
|
|
716
|
+
def get_all_tasks(opts = {})
|
|
717
|
+
data, _status_code, _headers = get_all_tasks_with_http_info(opts)
|
|
718
|
+
data
|
|
719
|
+
end
|
|
720
|
+
|
|
721
|
+
# Retrieve all tasks
|
|
722
|
+
# Retrieves a list of tasks. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
|
|
723
|
+
# @param [Hash] opts the optional parameters
|
|
724
|
+
# @option opts [String] :entitytype Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated.
|
|
725
|
+
# @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field.
|
|
726
|
+
# @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
|
|
727
|
+
# @option opts [String] :type Filters results to any task associated with the task type specified.
|
|
728
|
+
# @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
|
|
729
|
+
# @option opts [Integer] :unitagreementid Filters results to any task associated with the unit agreement identifier specified.
|
|
730
|
+
# @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
731
|
+
# @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
732
|
+
# @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
733
|
+
# @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
734
|
+
# @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
|
|
735
|
+
# @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
|
|
736
|
+
# @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
|
|
737
|
+
# @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
|
|
738
|
+
# @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.
|
|
739
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
740
|
+
# @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.
|
|
741
|
+
# @return [Array<(Array<AllTasksMessage>, Integer, Hash)>] Array<AllTasksMessage> data, response status code and response headers
|
|
742
|
+
def get_all_tasks_with_http_info(opts = {})
|
|
743
|
+
if @api_client.config.debugging
|
|
744
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.get_all_tasks ...'
|
|
745
|
+
end
|
|
746
|
+
allowable_values = ["Rental", "RentalOwner", "Association"]
|
|
747
|
+
if @api_client.config.client_side_validation && opts[:'entitytype'] && !allowable_values.include?(opts[:'entitytype'])
|
|
748
|
+
fail ArgumentError, "invalid value for \"entitytype\", must be one of #{allowable_values}"
|
|
749
|
+
end
|
|
750
|
+
allowable_values = ["New", "InProgress", "Completed", "Deferred", "Closed"]
|
|
751
|
+
if @api_client.config.client_side_validation && opts[:'statuses'] && !opts[:'statuses'].all? { |item| allowable_values.include?(item) }
|
|
752
|
+
fail ArgumentError, "invalid value for \"statuses\", must include one of #{allowable_values}"
|
|
753
|
+
end
|
|
754
|
+
allowable_values = ["ContactRequest", "ResidentRequest", "Todo", "RentalOwnerRequest"]
|
|
755
|
+
if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
|
|
756
|
+
fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
|
|
757
|
+
end
|
|
758
|
+
allowable_values = ["Low", "Normal", "High"]
|
|
759
|
+
if @api_client.config.client_side_validation && opts[:'priorities'] && !opts[:'priorities'].all? { |item| allowable_values.include?(item) }
|
|
760
|
+
fail ArgumentError, "invalid value for \"priorities\", must include one of #{allowable_values}"
|
|
761
|
+
end
|
|
762
|
+
# resource path
|
|
763
|
+
local_var_path = '/v1/tasks'
|
|
764
|
+
|
|
765
|
+
# query parameters
|
|
766
|
+
query_params = opts[:query_params] || {}
|
|
767
|
+
query_params[:'entitytype'] = opts[:'entitytype'] if !opts[:'entitytype'].nil?
|
|
768
|
+
query_params[:'entityid'] = opts[:'entityid'] if !opts[:'entityid'].nil?
|
|
769
|
+
query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?
|
|
770
|
+
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
|
771
|
+
query_params[:'unitid'] = opts[:'unitid'] if !opts[:'unitid'].nil?
|
|
772
|
+
query_params[:'unitagreementid'] = opts[:'unitagreementid'] if !opts[:'unitagreementid'].nil?
|
|
773
|
+
query_params[:'lastupdatedfrom'] = opts[:'lastupdatedfrom'] if !opts[:'lastupdatedfrom'].nil?
|
|
774
|
+
query_params[:'lastupdatedto'] = opts[:'lastupdatedto'] if !opts[:'lastupdatedto'].nil?
|
|
775
|
+
query_params[:'duedatefrom'] = opts[:'duedatefrom'] if !opts[:'duedatefrom'].nil?
|
|
776
|
+
query_params[:'duedateto'] = opts[:'duedateto'] if !opts[:'duedateto'].nil?
|
|
777
|
+
query_params[:'taskcategoryid'] = opts[:'taskcategoryid'] if !opts[:'taskcategoryid'].nil?
|
|
778
|
+
query_params[:'priorities'] = @api_client.build_collection_param(opts[:'priorities'], :multi) if !opts[:'priorities'].nil?
|
|
779
|
+
query_params[:'assignedtoid'] = opts[:'assignedtoid'] if !opts[:'assignedtoid'].nil?
|
|
780
|
+
query_params[:'tasktitle'] = opts[:'tasktitle'] if !opts[:'tasktitle'].nil?
|
|
781
|
+
query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
|
|
782
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
783
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
784
|
+
|
|
785
|
+
# header parameters
|
|
786
|
+
header_params = opts[:header_params] || {}
|
|
787
|
+
# HTTP header 'Accept' (if needed)
|
|
788
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
789
|
+
|
|
790
|
+
# form parameters
|
|
791
|
+
form_params = opts[:form_params] || {}
|
|
792
|
+
|
|
793
|
+
# http body (model)
|
|
794
|
+
post_body = opts[:debug_body]
|
|
795
|
+
|
|
796
|
+
# return_type
|
|
797
|
+
return_type = opts[:debug_return_type] || 'Array<AllTasksMessage>'
|
|
798
|
+
|
|
799
|
+
# auth_names
|
|
800
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
801
|
+
|
|
802
|
+
new_options = opts.merge(
|
|
803
|
+
:operation => :"TasksApi.get_all_tasks",
|
|
804
|
+
:header_params => header_params,
|
|
805
|
+
:query_params => query_params,
|
|
806
|
+
:form_params => form_params,
|
|
807
|
+
:body => post_body,
|
|
808
|
+
:auth_names => auth_names,
|
|
809
|
+
:return_type => return_type
|
|
810
|
+
)
|
|
811
|
+
|
|
812
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
813
|
+
if @api_client.config.debugging
|
|
814
|
+
@api_client.config.logger.debug "API called: TasksApi#get_all_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
815
|
+
end
|
|
816
|
+
return data, status_code, headers
|
|
817
|
+
end
|
|
818
|
+
|
|
819
|
+
# Retrieve a contact request
|
|
820
|
+
# Retrieves a contact request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
|
821
|
+
# @param contact_request_task_id [Integer] The contact request identifier.
|
|
822
|
+
# @param [Hash] opts the optional parameters
|
|
823
|
+
# @return [ContactRequestTaskMessage]
|
|
824
|
+
def get_contact_request_task_by_id(contact_request_task_id, opts = {})
|
|
825
|
+
data, _status_code, _headers = get_contact_request_task_by_id_with_http_info(contact_request_task_id, opts)
|
|
826
|
+
data
|
|
827
|
+
end
|
|
828
|
+
|
|
829
|
+
# Retrieve a contact request
|
|
830
|
+
# Retrieves a contact request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
|
|
831
|
+
# @param contact_request_task_id [Integer] The contact request identifier.
|
|
832
|
+
# @param [Hash] opts the optional parameters
|
|
833
|
+
# @return [Array<(ContactRequestTaskMessage, Integer, Hash)>] ContactRequestTaskMessage data, response status code and response headers
|
|
834
|
+
def get_contact_request_task_by_id_with_http_info(contact_request_task_id, opts = {})
|
|
835
|
+
if @api_client.config.debugging
|
|
836
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.get_contact_request_task_by_id ...'
|
|
837
|
+
end
|
|
838
|
+
# verify the required parameter 'contact_request_task_id' is set
|
|
839
|
+
if @api_client.config.client_side_validation && contact_request_task_id.nil?
|
|
840
|
+
fail ArgumentError, "Missing the required parameter 'contact_request_task_id' when calling TasksApi.get_contact_request_task_by_id"
|
|
841
|
+
end
|
|
842
|
+
# resource path
|
|
843
|
+
local_var_path = '/v1/tasks/contactrequests/{contactRequestTaskId}'.sub('{' + 'contactRequestTaskId' + '}', CGI.escape(contact_request_task_id.to_s))
|
|
844
|
+
|
|
845
|
+
# query parameters
|
|
846
|
+
query_params = opts[:query_params] || {}
|
|
847
|
+
|
|
848
|
+
# header parameters
|
|
849
|
+
header_params = opts[:header_params] || {}
|
|
850
|
+
# HTTP header 'Accept' (if needed)
|
|
851
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
852
|
+
|
|
853
|
+
# form parameters
|
|
854
|
+
form_params = opts[:form_params] || {}
|
|
855
|
+
|
|
856
|
+
# http body (model)
|
|
857
|
+
post_body = opts[:debug_body]
|
|
858
|
+
|
|
859
|
+
# return_type
|
|
860
|
+
return_type = opts[:debug_return_type] || 'ContactRequestTaskMessage'
|
|
861
|
+
|
|
862
|
+
# auth_names
|
|
863
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
864
|
+
|
|
865
|
+
new_options = opts.merge(
|
|
866
|
+
:operation => :"TasksApi.get_contact_request_task_by_id",
|
|
867
|
+
:header_params => header_params,
|
|
868
|
+
:query_params => query_params,
|
|
869
|
+
:form_params => form_params,
|
|
870
|
+
:body => post_body,
|
|
871
|
+
:auth_names => auth_names,
|
|
872
|
+
:return_type => return_type
|
|
873
|
+
)
|
|
874
|
+
|
|
875
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
876
|
+
if @api_client.config.debugging
|
|
877
|
+
@api_client.config.logger.debug "API called: TasksApi#get_contact_request_task_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
878
|
+
end
|
|
879
|
+
return data, status_code, headers
|
|
880
|
+
end
|
|
881
|
+
|
|
882
|
+
# Retrieve all contact requests
|
|
883
|
+
# Retrieves a list of contact requests. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
|
884
|
+
# @param [Hash] opts the optional parameters
|
|
885
|
+
# @option opts [String] :entitytype Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated.
|
|
886
|
+
# @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field.
|
|
887
|
+
# @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
|
|
888
|
+
# @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
|
|
889
|
+
# @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
890
|
+
# @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
891
|
+
# @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
892
|
+
# @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
893
|
+
# @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
|
|
894
|
+
# @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
|
|
895
|
+
# @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
|
|
896
|
+
# @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
|
|
897
|
+
# @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.
|
|
898
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
899
|
+
# @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.
|
|
900
|
+
# @return [Array<ContactRequestTaskMessage>]
|
|
901
|
+
def get_contact_request_tasks(opts = {})
|
|
902
|
+
data, _status_code, _headers = get_contact_request_tasks_with_http_info(opts)
|
|
903
|
+
data
|
|
904
|
+
end
|
|
905
|
+
|
|
906
|
+
# Retrieve all contact requests
|
|
907
|
+
# Retrieves a list of contact requests. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
|
|
908
|
+
# @param [Hash] opts the optional parameters
|
|
909
|
+
# @option opts [String] :entitytype Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated.
|
|
910
|
+
# @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field.
|
|
911
|
+
# @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
|
|
912
|
+
# @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
|
|
913
|
+
# @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
914
|
+
# @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
915
|
+
# @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
916
|
+
# @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
917
|
+
# @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
|
|
918
|
+
# @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
|
|
919
|
+
# @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
|
|
920
|
+
# @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
|
|
921
|
+
# @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.
|
|
922
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
923
|
+
# @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.
|
|
924
|
+
# @return [Array<(Array<ContactRequestTaskMessage>, Integer, Hash)>] Array<ContactRequestTaskMessage> data, response status code and response headers
|
|
925
|
+
def get_contact_request_tasks_with_http_info(opts = {})
|
|
926
|
+
if @api_client.config.debugging
|
|
927
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.get_contact_request_tasks ...'
|
|
928
|
+
end
|
|
929
|
+
allowable_values = ["Rental", "RentalOwner", "Association"]
|
|
930
|
+
if @api_client.config.client_side_validation && opts[:'entitytype'] && !allowable_values.include?(opts[:'entitytype'])
|
|
931
|
+
fail ArgumentError, "invalid value for \"entitytype\", must be one of #{allowable_values}"
|
|
932
|
+
end
|
|
933
|
+
allowable_values = ["New", "InProgress", "Completed", "Deferred", "Closed"]
|
|
934
|
+
if @api_client.config.client_side_validation && opts[:'statuses'] && !opts[:'statuses'].all? { |item| allowable_values.include?(item) }
|
|
935
|
+
fail ArgumentError, "invalid value for \"statuses\", must include one of #{allowable_values}"
|
|
936
|
+
end
|
|
937
|
+
allowable_values = ["Low", "Normal", "High"]
|
|
938
|
+
if @api_client.config.client_side_validation && opts[:'priorities'] && !opts[:'priorities'].all? { |item| allowable_values.include?(item) }
|
|
939
|
+
fail ArgumentError, "invalid value for \"priorities\", must include one of #{allowable_values}"
|
|
940
|
+
end
|
|
941
|
+
# resource path
|
|
942
|
+
local_var_path = '/v1/tasks/contactrequests'
|
|
943
|
+
|
|
944
|
+
# query parameters
|
|
945
|
+
query_params = opts[:query_params] || {}
|
|
946
|
+
query_params[:'entitytype'] = opts[:'entitytype'] if !opts[:'entitytype'].nil?
|
|
947
|
+
query_params[:'entityid'] = opts[:'entityid'] if !opts[:'entityid'].nil?
|
|
948
|
+
query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?
|
|
949
|
+
query_params[:'unitid'] = opts[:'unitid'] if !opts[:'unitid'].nil?
|
|
950
|
+
query_params[:'lastupdatedfrom'] = opts[:'lastupdatedfrom'] if !opts[:'lastupdatedfrom'].nil?
|
|
951
|
+
query_params[:'lastupdatedto'] = opts[:'lastupdatedto'] if !opts[:'lastupdatedto'].nil?
|
|
952
|
+
query_params[:'duedatefrom'] = opts[:'duedatefrom'] if !opts[:'duedatefrom'].nil?
|
|
953
|
+
query_params[:'duedateto'] = opts[:'duedateto'] if !opts[:'duedateto'].nil?
|
|
954
|
+
query_params[:'taskcategoryid'] = opts[:'taskcategoryid'] if !opts[:'taskcategoryid'].nil?
|
|
955
|
+
query_params[:'priorities'] = @api_client.build_collection_param(opts[:'priorities'], :multi) if !opts[:'priorities'].nil?
|
|
956
|
+
query_params[:'assignedtoid'] = opts[:'assignedtoid'] if !opts[:'assignedtoid'].nil?
|
|
957
|
+
query_params[:'tasktitle'] = opts[:'tasktitle'] if !opts[:'tasktitle'].nil?
|
|
958
|
+
query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
|
|
959
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
960
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
961
|
+
|
|
962
|
+
# header parameters
|
|
963
|
+
header_params = opts[:header_params] || {}
|
|
964
|
+
# HTTP header 'Accept' (if needed)
|
|
965
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
966
|
+
|
|
967
|
+
# form parameters
|
|
968
|
+
form_params = opts[:form_params] || {}
|
|
969
|
+
|
|
970
|
+
# http body (model)
|
|
971
|
+
post_body = opts[:debug_body]
|
|
972
|
+
|
|
973
|
+
# return_type
|
|
974
|
+
return_type = opts[:debug_return_type] || 'Array<ContactRequestTaskMessage>'
|
|
975
|
+
|
|
976
|
+
# auth_names
|
|
977
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
978
|
+
|
|
979
|
+
new_options = opts.merge(
|
|
980
|
+
:operation => :"TasksApi.get_contact_request_tasks",
|
|
981
|
+
:header_params => header_params,
|
|
982
|
+
:query_params => query_params,
|
|
983
|
+
:form_params => form_params,
|
|
984
|
+
:body => post_body,
|
|
985
|
+
:auth_names => auth_names,
|
|
986
|
+
:return_type => return_type
|
|
987
|
+
)
|
|
988
|
+
|
|
989
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
990
|
+
if @api_client.config.debugging
|
|
991
|
+
@api_client.config.logger.debug "API called: TasksApi#get_contact_request_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
992
|
+
end
|
|
993
|
+
return data, status_code, headers
|
|
994
|
+
end
|
|
995
|
+
|
|
996
|
+
# Download a task history file
|
|
997
|
+
# Downloads a specific file associated to the task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
|
998
|
+
# @param task_id [Integer]
|
|
999
|
+
# @param task_history_id [Integer]
|
|
1000
|
+
# @param file_id [Integer]
|
|
1001
|
+
# @param [Hash] opts the optional parameters
|
|
1002
|
+
# @return [FileDownloadMessage]
|
|
1003
|
+
def get_file_download_request(task_id, task_history_id, file_id, opts = {})
|
|
1004
|
+
data, _status_code, _headers = get_file_download_request_with_http_info(task_id, task_history_id, file_id, opts)
|
|
1005
|
+
data
|
|
1006
|
+
end
|
|
1007
|
+
|
|
1008
|
+
# Download a task history file
|
|
1009
|
+
# Downloads a specific file associated to the task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
|
|
1010
|
+
# @param task_id [Integer]
|
|
1011
|
+
# @param task_history_id [Integer]
|
|
1012
|
+
# @param file_id [Integer]
|
|
1013
|
+
# @param [Hash] opts the optional parameters
|
|
1014
|
+
# @return [Array<(FileDownloadMessage, Integer, Hash)>] FileDownloadMessage data, response status code and response headers
|
|
1015
|
+
def get_file_download_request_with_http_info(task_id, task_history_id, file_id, opts = {})
|
|
1016
|
+
if @api_client.config.debugging
|
|
1017
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.get_file_download_request ...'
|
|
1018
|
+
end
|
|
1019
|
+
# verify the required parameter 'task_id' is set
|
|
1020
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
|
1021
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_file_download_request"
|
|
1022
|
+
end
|
|
1023
|
+
# verify the required parameter 'task_history_id' is set
|
|
1024
|
+
if @api_client.config.client_side_validation && task_history_id.nil?
|
|
1025
|
+
fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.get_file_download_request"
|
|
1026
|
+
end
|
|
1027
|
+
# verify the required parameter 'file_id' is set
|
|
1028
|
+
if @api_client.config.client_side_validation && file_id.nil?
|
|
1029
|
+
fail ArgumentError, "Missing the required parameter 'file_id' when calling TasksApi.get_file_download_request"
|
|
1030
|
+
end
|
|
1031
|
+
# resource path
|
|
1032
|
+
local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}/files/{fileId}/downloadrequest'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s)).sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s))
|
|
1033
|
+
|
|
1034
|
+
# query parameters
|
|
1035
|
+
query_params = opts[:query_params] || {}
|
|
1036
|
+
|
|
1037
|
+
# header parameters
|
|
1038
|
+
header_params = opts[:header_params] || {}
|
|
1039
|
+
# HTTP header 'Accept' (if needed)
|
|
1040
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1041
|
+
|
|
1042
|
+
# form parameters
|
|
1043
|
+
form_params = opts[:form_params] || {}
|
|
1044
|
+
|
|
1045
|
+
# http body (model)
|
|
1046
|
+
post_body = opts[:debug_body]
|
|
1047
|
+
|
|
1048
|
+
# return_type
|
|
1049
|
+
return_type = opts[:debug_return_type] || 'FileDownloadMessage'
|
|
1050
|
+
|
|
1051
|
+
# auth_names
|
|
1052
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
1053
|
+
|
|
1054
|
+
new_options = opts.merge(
|
|
1055
|
+
:operation => :"TasksApi.get_file_download_request",
|
|
1056
|
+
:header_params => header_params,
|
|
1057
|
+
:query_params => query_params,
|
|
1058
|
+
:form_params => form_params,
|
|
1059
|
+
:body => post_body,
|
|
1060
|
+
:auth_names => auth_names,
|
|
1061
|
+
:return_type => return_type
|
|
1062
|
+
)
|
|
1063
|
+
|
|
1064
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1065
|
+
if @api_client.config.debugging
|
|
1066
|
+
@api_client.config.logger.debug "API called: TasksApi#get_file_download_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1067
|
+
end
|
|
1068
|
+
return data, status_code, headers
|
|
1069
|
+
end
|
|
1070
|
+
|
|
1071
|
+
# Retrieve a rental owner request
|
|
1072
|
+
# Retrieves a specific rental owner request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
|
1073
|
+
# @param rental_owner_request_task_id [Integer] The rental owner request identifier.
|
|
1074
|
+
# @param [Hash] opts the optional parameters
|
|
1075
|
+
# @return [RentalOwnerRequestTaskMessage]
|
|
1076
|
+
def get_rental_owner_request_task_by_id(rental_owner_request_task_id, opts = {})
|
|
1077
|
+
data, _status_code, _headers = get_rental_owner_request_task_by_id_with_http_info(rental_owner_request_task_id, opts)
|
|
1078
|
+
data
|
|
1079
|
+
end
|
|
1080
|
+
|
|
1081
|
+
# Retrieve a rental owner request
|
|
1082
|
+
# Retrieves a specific rental owner request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
|
|
1083
|
+
# @param rental_owner_request_task_id [Integer] The rental owner request identifier.
|
|
1084
|
+
# @param [Hash] opts the optional parameters
|
|
1085
|
+
# @return [Array<(RentalOwnerRequestTaskMessage, Integer, Hash)>] RentalOwnerRequestTaskMessage data, response status code and response headers
|
|
1086
|
+
def get_rental_owner_request_task_by_id_with_http_info(rental_owner_request_task_id, opts = {})
|
|
1087
|
+
if @api_client.config.debugging
|
|
1088
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.get_rental_owner_request_task_by_id ...'
|
|
1089
|
+
end
|
|
1090
|
+
# verify the required parameter 'rental_owner_request_task_id' is set
|
|
1091
|
+
if @api_client.config.client_side_validation && rental_owner_request_task_id.nil?
|
|
1092
|
+
fail ArgumentError, "Missing the required parameter 'rental_owner_request_task_id' when calling TasksApi.get_rental_owner_request_task_by_id"
|
|
1093
|
+
end
|
|
1094
|
+
# resource path
|
|
1095
|
+
local_var_path = '/v1/tasks/rentalownerrequests/{rentalOwnerRequestTaskId}'.sub('{' + 'rentalOwnerRequestTaskId' + '}', CGI.escape(rental_owner_request_task_id.to_s))
|
|
1096
|
+
|
|
1097
|
+
# query parameters
|
|
1098
|
+
query_params = opts[:query_params] || {}
|
|
1099
|
+
|
|
1100
|
+
# header parameters
|
|
1101
|
+
header_params = opts[:header_params] || {}
|
|
1102
|
+
# HTTP header 'Accept' (if needed)
|
|
1103
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1104
|
+
|
|
1105
|
+
# form parameters
|
|
1106
|
+
form_params = opts[:form_params] || {}
|
|
1107
|
+
|
|
1108
|
+
# http body (model)
|
|
1109
|
+
post_body = opts[:debug_body]
|
|
1110
|
+
|
|
1111
|
+
# return_type
|
|
1112
|
+
return_type = opts[:debug_return_type] || 'RentalOwnerRequestTaskMessage'
|
|
1113
|
+
|
|
1114
|
+
# auth_names
|
|
1115
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
1116
|
+
|
|
1117
|
+
new_options = opts.merge(
|
|
1118
|
+
:operation => :"TasksApi.get_rental_owner_request_task_by_id",
|
|
1119
|
+
:header_params => header_params,
|
|
1120
|
+
:query_params => query_params,
|
|
1121
|
+
:form_params => form_params,
|
|
1122
|
+
:body => post_body,
|
|
1123
|
+
:auth_names => auth_names,
|
|
1124
|
+
:return_type => return_type
|
|
1125
|
+
)
|
|
1126
|
+
|
|
1127
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1128
|
+
if @api_client.config.debugging
|
|
1129
|
+
@api_client.config.logger.debug "API called: TasksApi#get_rental_owner_request_task_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1130
|
+
end
|
|
1131
|
+
return data, status_code, headers
|
|
1132
|
+
end
|
|
1133
|
+
|
|
1134
|
+
# Retrieve a resident request
|
|
1135
|
+
# Retrieves a specific resident request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
|
1136
|
+
# @param resident_request_task_id [Integer] The resident request identifier.
|
|
1137
|
+
# @param [Hash] opts the optional parameters
|
|
1138
|
+
# @return [ResidentRequestTaskMessage]
|
|
1139
|
+
def get_resident_request_task(resident_request_task_id, opts = {})
|
|
1140
|
+
data, _status_code, _headers = get_resident_request_task_with_http_info(resident_request_task_id, opts)
|
|
1141
|
+
data
|
|
1142
|
+
end
|
|
1143
|
+
|
|
1144
|
+
# Retrieve a resident request
|
|
1145
|
+
# Retrieves a specific resident request. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
|
|
1146
|
+
# @param resident_request_task_id [Integer] The resident request identifier.
|
|
1147
|
+
# @param [Hash] opts the optional parameters
|
|
1148
|
+
# @return [Array<(ResidentRequestTaskMessage, Integer, Hash)>] ResidentRequestTaskMessage data, response status code and response headers
|
|
1149
|
+
def get_resident_request_task_with_http_info(resident_request_task_id, opts = {})
|
|
1150
|
+
if @api_client.config.debugging
|
|
1151
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.get_resident_request_task ...'
|
|
1152
|
+
end
|
|
1153
|
+
# verify the required parameter 'resident_request_task_id' is set
|
|
1154
|
+
if @api_client.config.client_side_validation && resident_request_task_id.nil?
|
|
1155
|
+
fail ArgumentError, "Missing the required parameter 'resident_request_task_id' when calling TasksApi.get_resident_request_task"
|
|
1156
|
+
end
|
|
1157
|
+
# resource path
|
|
1158
|
+
local_var_path = '/v1/tasks/residentrequests/{residentRequestTaskId}'.sub('{' + 'residentRequestTaskId' + '}', CGI.escape(resident_request_task_id.to_s))
|
|
1159
|
+
|
|
1160
|
+
# query parameters
|
|
1161
|
+
query_params = opts[:query_params] || {}
|
|
1162
|
+
|
|
1163
|
+
# header parameters
|
|
1164
|
+
header_params = opts[:header_params] || {}
|
|
1165
|
+
# HTTP header 'Accept' (if needed)
|
|
1166
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1167
|
+
|
|
1168
|
+
# form parameters
|
|
1169
|
+
form_params = opts[:form_params] || {}
|
|
1170
|
+
|
|
1171
|
+
# http body (model)
|
|
1172
|
+
post_body = opts[:debug_body]
|
|
1173
|
+
|
|
1174
|
+
# return_type
|
|
1175
|
+
return_type = opts[:debug_return_type] || 'ResidentRequestTaskMessage'
|
|
1176
|
+
|
|
1177
|
+
# auth_names
|
|
1178
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
1179
|
+
|
|
1180
|
+
new_options = opts.merge(
|
|
1181
|
+
:operation => :"TasksApi.get_resident_request_task",
|
|
1182
|
+
:header_params => header_params,
|
|
1183
|
+
:query_params => query_params,
|
|
1184
|
+
:form_params => form_params,
|
|
1185
|
+
:body => post_body,
|
|
1186
|
+
:auth_names => auth_names,
|
|
1187
|
+
:return_type => return_type
|
|
1188
|
+
)
|
|
1189
|
+
|
|
1190
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1191
|
+
if @api_client.config.debugging
|
|
1192
|
+
@api_client.config.logger.debug "API called: TasksApi#get_resident_request_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1193
|
+
end
|
|
1194
|
+
return data, status_code, headers
|
|
1195
|
+
end
|
|
1196
|
+
|
|
1197
|
+
# Retrieve all resident requests
|
|
1198
|
+
# Retrieves a list of resident requests. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
|
1199
|
+
# @param [Hash] opts the optional parameters
|
|
1200
|
+
# @option opts [String] :entitytype Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated.
|
|
1201
|
+
# @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field.
|
|
1202
|
+
# @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
|
|
1203
|
+
# @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
|
|
1204
|
+
# @option opts [Integer] :unitagreementid Filters results to any task associated with the unit agreement identifier specified.
|
|
1205
|
+
# @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
1206
|
+
# @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
1207
|
+
# @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
1208
|
+
# @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
1209
|
+
# @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
|
|
1210
|
+
# @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
|
|
1211
|
+
# @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
|
|
1212
|
+
# @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
|
|
1213
|
+
# @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.
|
|
1214
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
1215
|
+
# @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.
|
|
1216
|
+
# @return [Array<ResidentRequestTaskMessage>]
|
|
1217
|
+
def get_resident_request_tasks(opts = {})
|
|
1218
|
+
data, _status_code, _headers = get_resident_request_tasks_with_http_info(opts)
|
|
1219
|
+
data
|
|
1220
|
+
end
|
|
1221
|
+
|
|
1222
|
+
# Retrieve all resident requests
|
|
1223
|
+
# Retrieves a list of resident requests. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
|
|
1224
|
+
# @param [Hash] opts the optional parameters
|
|
1225
|
+
# @option opts [String] :entitytype Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated.
|
|
1226
|
+
# @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field.
|
|
1227
|
+
# @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
|
|
1228
|
+
# @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
|
|
1229
|
+
# @option opts [Integer] :unitagreementid Filters results to any task associated with the unit agreement identifier specified.
|
|
1230
|
+
# @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
1231
|
+
# @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
1232
|
+
# @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
1233
|
+
# @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
1234
|
+
# @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
|
|
1235
|
+
# @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
|
|
1236
|
+
# @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
|
|
1237
|
+
# @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
|
|
1238
|
+
# @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.
|
|
1239
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
1240
|
+
# @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.
|
|
1241
|
+
# @return [Array<(Array<ResidentRequestTaskMessage>, Integer, Hash)>] Array<ResidentRequestTaskMessage> data, response status code and response headers
|
|
1242
|
+
def get_resident_request_tasks_with_http_info(opts = {})
|
|
1243
|
+
if @api_client.config.debugging
|
|
1244
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.get_resident_request_tasks ...'
|
|
1245
|
+
end
|
|
1246
|
+
allowable_values = ["Rental", "RentalOwner", "Association"]
|
|
1247
|
+
if @api_client.config.client_side_validation && opts[:'entitytype'] && !allowable_values.include?(opts[:'entitytype'])
|
|
1248
|
+
fail ArgumentError, "invalid value for \"entitytype\", must be one of #{allowable_values}"
|
|
1249
|
+
end
|
|
1250
|
+
allowable_values = ["New", "InProgress", "Completed", "Deferred", "Closed"]
|
|
1251
|
+
if @api_client.config.client_side_validation && opts[:'statuses'] && !opts[:'statuses'].all? { |item| allowable_values.include?(item) }
|
|
1252
|
+
fail ArgumentError, "invalid value for \"statuses\", must include one of #{allowable_values}"
|
|
1253
|
+
end
|
|
1254
|
+
allowable_values = ["Low", "Normal", "High"]
|
|
1255
|
+
if @api_client.config.client_side_validation && opts[:'priorities'] && !opts[:'priorities'].all? { |item| allowable_values.include?(item) }
|
|
1256
|
+
fail ArgumentError, "invalid value for \"priorities\", must include one of #{allowable_values}"
|
|
1257
|
+
end
|
|
1258
|
+
# resource path
|
|
1259
|
+
local_var_path = '/v1/tasks/residentrequests'
|
|
1260
|
+
|
|
1261
|
+
# query parameters
|
|
1262
|
+
query_params = opts[:query_params] || {}
|
|
1263
|
+
query_params[:'entitytype'] = opts[:'entitytype'] if !opts[:'entitytype'].nil?
|
|
1264
|
+
query_params[:'entityid'] = opts[:'entityid'] if !opts[:'entityid'].nil?
|
|
1265
|
+
query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?
|
|
1266
|
+
query_params[:'unitid'] = opts[:'unitid'] if !opts[:'unitid'].nil?
|
|
1267
|
+
query_params[:'unitagreementid'] = opts[:'unitagreementid'] if !opts[:'unitagreementid'].nil?
|
|
1268
|
+
query_params[:'lastupdatedfrom'] = opts[:'lastupdatedfrom'] if !opts[:'lastupdatedfrom'].nil?
|
|
1269
|
+
query_params[:'lastupdatedto'] = opts[:'lastupdatedto'] if !opts[:'lastupdatedto'].nil?
|
|
1270
|
+
query_params[:'duedatefrom'] = opts[:'duedatefrom'] if !opts[:'duedatefrom'].nil?
|
|
1271
|
+
query_params[:'duedateto'] = opts[:'duedateto'] if !opts[:'duedateto'].nil?
|
|
1272
|
+
query_params[:'taskcategoryid'] = opts[:'taskcategoryid'] if !opts[:'taskcategoryid'].nil?
|
|
1273
|
+
query_params[:'priorities'] = @api_client.build_collection_param(opts[:'priorities'], :multi) if !opts[:'priorities'].nil?
|
|
1274
|
+
query_params[:'assignedtoid'] = opts[:'assignedtoid'] if !opts[:'assignedtoid'].nil?
|
|
1275
|
+
query_params[:'tasktitle'] = opts[:'tasktitle'] if !opts[:'tasktitle'].nil?
|
|
1276
|
+
query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
|
|
1277
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
1278
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
1279
|
+
|
|
1280
|
+
# header parameters
|
|
1281
|
+
header_params = opts[:header_params] || {}
|
|
1282
|
+
# HTTP header 'Accept' (if needed)
|
|
1283
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1284
|
+
|
|
1285
|
+
# form parameters
|
|
1286
|
+
form_params = opts[:form_params] || {}
|
|
1287
|
+
|
|
1288
|
+
# http body (model)
|
|
1289
|
+
post_body = opts[:debug_body]
|
|
1290
|
+
|
|
1291
|
+
# return_type
|
|
1292
|
+
return_type = opts[:debug_return_type] || 'Array<ResidentRequestTaskMessage>'
|
|
1293
|
+
|
|
1294
|
+
# auth_names
|
|
1295
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
1296
|
+
|
|
1297
|
+
new_options = opts.merge(
|
|
1298
|
+
:operation => :"TasksApi.get_resident_request_tasks",
|
|
1299
|
+
:header_params => header_params,
|
|
1300
|
+
:query_params => query_params,
|
|
1301
|
+
:form_params => form_params,
|
|
1302
|
+
:body => post_body,
|
|
1303
|
+
:auth_names => auth_names,
|
|
1304
|
+
:return_type => return_type
|
|
1305
|
+
)
|
|
1306
|
+
|
|
1307
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1308
|
+
if @api_client.config.debugging
|
|
1309
|
+
@api_client.config.logger.debug "API called: TasksApi#get_resident_request_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1310
|
+
end
|
|
1311
|
+
return data, status_code, headers
|
|
1312
|
+
end
|
|
1313
|
+
|
|
1314
|
+
# Retrieve a task
|
|
1315
|
+
# Retrieves a specific task. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
|
1316
|
+
# @param task_id [Integer] The task identifier
|
|
1317
|
+
# @param [Hash] opts the optional parameters
|
|
1318
|
+
# @return [AllTasksMessage]
|
|
1319
|
+
def get_task_by_id(task_id, opts = {})
|
|
1320
|
+
data, _status_code, _headers = get_task_by_id_with_http_info(task_id, opts)
|
|
1321
|
+
data
|
|
1322
|
+
end
|
|
1323
|
+
|
|
1324
|
+
# Retrieve a task
|
|
1325
|
+
# Retrieves a specific task. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
|
|
1326
|
+
# @param task_id [Integer] The task identifier
|
|
1327
|
+
# @param [Hash] opts the optional parameters
|
|
1328
|
+
# @return [Array<(AllTasksMessage, Integer, Hash)>] AllTasksMessage data, response status code and response headers
|
|
1329
|
+
def get_task_by_id_with_http_info(task_id, opts = {})
|
|
1330
|
+
if @api_client.config.debugging
|
|
1331
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.get_task_by_id ...'
|
|
1332
|
+
end
|
|
1333
|
+
# verify the required parameter 'task_id' is set
|
|
1334
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
|
1335
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_task_by_id"
|
|
1336
|
+
end
|
|
1337
|
+
# resource path
|
|
1338
|
+
local_var_path = '/v1/tasks/{taskId}'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s))
|
|
1339
|
+
|
|
1340
|
+
# query parameters
|
|
1341
|
+
query_params = opts[:query_params] || {}
|
|
1342
|
+
|
|
1343
|
+
# header parameters
|
|
1344
|
+
header_params = opts[:header_params] || {}
|
|
1345
|
+
# HTTP header 'Accept' (if needed)
|
|
1346
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1347
|
+
|
|
1348
|
+
# form parameters
|
|
1349
|
+
form_params = opts[:form_params] || {}
|
|
1350
|
+
|
|
1351
|
+
# http body (model)
|
|
1352
|
+
post_body = opts[:debug_body]
|
|
1353
|
+
|
|
1354
|
+
# return_type
|
|
1355
|
+
return_type = opts[:debug_return_type] || 'AllTasksMessage'
|
|
1356
|
+
|
|
1357
|
+
# auth_names
|
|
1358
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
1359
|
+
|
|
1360
|
+
new_options = opts.merge(
|
|
1361
|
+
:operation => :"TasksApi.get_task_by_id",
|
|
1362
|
+
:header_params => header_params,
|
|
1363
|
+
:query_params => query_params,
|
|
1364
|
+
:form_params => form_params,
|
|
1365
|
+
:body => post_body,
|
|
1366
|
+
:auth_names => auth_names,
|
|
1367
|
+
:return_type => return_type
|
|
1368
|
+
)
|
|
1369
|
+
|
|
1370
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1371
|
+
if @api_client.config.debugging
|
|
1372
|
+
@api_client.config.logger.debug "API called: TasksApi#get_task_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1373
|
+
end
|
|
1374
|
+
return data, status_code, headers
|
|
1375
|
+
end
|
|
1376
|
+
|
|
1377
|
+
# Retrieve a task category
|
|
1378
|
+
# Retrieves a specific task category. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
|
1379
|
+
# @param task_category_id [Integer] The task category identifier.
|
|
1380
|
+
# @param [Hash] opts the optional parameters
|
|
1381
|
+
# @return [TaskCategoryMessage]
|
|
1382
|
+
def get_task_category_by_id(task_category_id, opts = {})
|
|
1383
|
+
data, _status_code, _headers = get_task_category_by_id_with_http_info(task_category_id, opts)
|
|
1384
|
+
data
|
|
1385
|
+
end
|
|
1386
|
+
|
|
1387
|
+
# Retrieve a task category
|
|
1388
|
+
# Retrieves a specific task category. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
|
|
1389
|
+
# @param task_category_id [Integer] The task category identifier.
|
|
1390
|
+
# @param [Hash] opts the optional parameters
|
|
1391
|
+
# @return [Array<(TaskCategoryMessage, Integer, Hash)>] TaskCategoryMessage data, response status code and response headers
|
|
1392
|
+
def get_task_category_by_id_with_http_info(task_category_id, opts = {})
|
|
1393
|
+
if @api_client.config.debugging
|
|
1394
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.get_task_category_by_id ...'
|
|
1395
|
+
end
|
|
1396
|
+
# verify the required parameter 'task_category_id' is set
|
|
1397
|
+
if @api_client.config.client_side_validation && task_category_id.nil?
|
|
1398
|
+
fail ArgumentError, "Missing the required parameter 'task_category_id' when calling TasksApi.get_task_category_by_id"
|
|
1399
|
+
end
|
|
1400
|
+
# resource path
|
|
1401
|
+
local_var_path = '/v1/tasks/categories/{taskCategoryId}'.sub('{' + 'taskCategoryId' + '}', CGI.escape(task_category_id.to_s))
|
|
1402
|
+
|
|
1403
|
+
# query parameters
|
|
1404
|
+
query_params = opts[:query_params] || {}
|
|
1405
|
+
|
|
1406
|
+
# header parameters
|
|
1407
|
+
header_params = opts[:header_params] || {}
|
|
1408
|
+
# HTTP header 'Accept' (if needed)
|
|
1409
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1410
|
+
|
|
1411
|
+
# form parameters
|
|
1412
|
+
form_params = opts[:form_params] || {}
|
|
1413
|
+
|
|
1414
|
+
# http body (model)
|
|
1415
|
+
post_body = opts[:debug_body]
|
|
1416
|
+
|
|
1417
|
+
# return_type
|
|
1418
|
+
return_type = opts[:debug_return_type] || 'TaskCategoryMessage'
|
|
1419
|
+
|
|
1420
|
+
# auth_names
|
|
1421
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
1422
|
+
|
|
1423
|
+
new_options = opts.merge(
|
|
1424
|
+
:operation => :"TasksApi.get_task_category_by_id",
|
|
1425
|
+
:header_params => header_params,
|
|
1426
|
+
:query_params => query_params,
|
|
1427
|
+
:form_params => form_params,
|
|
1428
|
+
:body => post_body,
|
|
1429
|
+
:auth_names => auth_names,
|
|
1430
|
+
:return_type => return_type
|
|
1431
|
+
)
|
|
1432
|
+
|
|
1433
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1434
|
+
if @api_client.config.debugging
|
|
1435
|
+
@api_client.config.logger.debug "API called: TasksApi#get_task_category_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1436
|
+
end
|
|
1437
|
+
return data, status_code, headers
|
|
1438
|
+
end
|
|
1439
|
+
|
|
1440
|
+
# Retrieve all task history
|
|
1441
|
+
# Retrieves all task history records for a specific task. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
|
1442
|
+
# @param task_id [Integer]
|
|
1443
|
+
# @param [Hash] opts the optional parameters
|
|
1444
|
+
# @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.
|
|
1445
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
1446
|
+
# @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.
|
|
1447
|
+
# @return [Array<TaskHistoryMessage>]
|
|
1448
|
+
def get_task_histories(task_id, opts = {})
|
|
1449
|
+
data, _status_code, _headers = get_task_histories_with_http_info(task_id, opts)
|
|
1450
|
+
data
|
|
1451
|
+
end
|
|
1452
|
+
|
|
1453
|
+
# Retrieve all task history
|
|
1454
|
+
# Retrieves all task history records for a specific task. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
|
|
1455
|
+
# @param task_id [Integer]
|
|
1456
|
+
# @param [Hash] opts the optional parameters
|
|
1457
|
+
# @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.
|
|
1458
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
1459
|
+
# @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.
|
|
1460
|
+
# @return [Array<(Array<TaskHistoryMessage>, Integer, Hash)>] Array<TaskHistoryMessage> data, response status code and response headers
|
|
1461
|
+
def get_task_histories_with_http_info(task_id, opts = {})
|
|
1462
|
+
if @api_client.config.debugging
|
|
1463
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.get_task_histories ...'
|
|
1464
|
+
end
|
|
1465
|
+
# verify the required parameter 'task_id' is set
|
|
1466
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
|
1467
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_task_histories"
|
|
1468
|
+
end
|
|
1469
|
+
# resource path
|
|
1470
|
+
local_var_path = '/v1/tasks/{taskId}/history'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s))
|
|
1471
|
+
|
|
1472
|
+
# query parameters
|
|
1473
|
+
query_params = opts[:query_params] || {}
|
|
1474
|
+
query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
|
|
1475
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
1476
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
1477
|
+
|
|
1478
|
+
# header parameters
|
|
1479
|
+
header_params = opts[:header_params] || {}
|
|
1480
|
+
# HTTP header 'Accept' (if needed)
|
|
1481
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1482
|
+
|
|
1483
|
+
# form parameters
|
|
1484
|
+
form_params = opts[:form_params] || {}
|
|
1485
|
+
|
|
1486
|
+
# http body (model)
|
|
1487
|
+
post_body = opts[:debug_body]
|
|
1488
|
+
|
|
1489
|
+
# return_type
|
|
1490
|
+
return_type = opts[:debug_return_type] || 'Array<TaskHistoryMessage>'
|
|
1491
|
+
|
|
1492
|
+
# auth_names
|
|
1493
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
1494
|
+
|
|
1495
|
+
new_options = opts.merge(
|
|
1496
|
+
:operation => :"TasksApi.get_task_histories",
|
|
1497
|
+
:header_params => header_params,
|
|
1498
|
+
:query_params => query_params,
|
|
1499
|
+
:form_params => form_params,
|
|
1500
|
+
:body => post_body,
|
|
1501
|
+
:auth_names => auth_names,
|
|
1502
|
+
:return_type => return_type
|
|
1503
|
+
)
|
|
1504
|
+
|
|
1505
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1506
|
+
if @api_client.config.debugging
|
|
1507
|
+
@api_client.config.logger.debug "API called: TasksApi#get_task_histories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1508
|
+
end
|
|
1509
|
+
return data, status_code, headers
|
|
1510
|
+
end
|
|
1511
|
+
|
|
1512
|
+
# Retrieve a task history
|
|
1513
|
+
# Retrieves a specific task history record for a task. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
|
1514
|
+
# @param task_id [Integer]
|
|
1515
|
+
# @param task_history_id [Integer]
|
|
1516
|
+
# @param [Hash] opts the optional parameters
|
|
1517
|
+
# @return [TaskHistoryMessage]
|
|
1518
|
+
def get_task_history_by_id(task_id, task_history_id, opts = {})
|
|
1519
|
+
data, _status_code, _headers = get_task_history_by_id_with_http_info(task_id, task_history_id, opts)
|
|
1520
|
+
data
|
|
1521
|
+
end
|
|
1522
|
+
|
|
1523
|
+
# Retrieve a task history
|
|
1524
|
+
# Retrieves a specific task history record for a task. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
|
|
1525
|
+
# @param task_id [Integer]
|
|
1526
|
+
# @param task_history_id [Integer]
|
|
1527
|
+
# @param [Hash] opts the optional parameters
|
|
1528
|
+
# @return [Array<(TaskHistoryMessage, Integer, Hash)>] TaskHistoryMessage data, response status code and response headers
|
|
1529
|
+
def get_task_history_by_id_with_http_info(task_id, task_history_id, opts = {})
|
|
1530
|
+
if @api_client.config.debugging
|
|
1531
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.get_task_history_by_id ...'
|
|
1532
|
+
end
|
|
1533
|
+
# verify the required parameter 'task_id' is set
|
|
1534
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
|
1535
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_task_history_by_id"
|
|
1536
|
+
end
|
|
1537
|
+
# verify the required parameter 'task_history_id' is set
|
|
1538
|
+
if @api_client.config.client_side_validation && task_history_id.nil?
|
|
1539
|
+
fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.get_task_history_by_id"
|
|
1540
|
+
end
|
|
1541
|
+
# resource path
|
|
1542
|
+
local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s))
|
|
1543
|
+
|
|
1544
|
+
# query parameters
|
|
1545
|
+
query_params = opts[:query_params] || {}
|
|
1546
|
+
|
|
1547
|
+
# header parameters
|
|
1548
|
+
header_params = opts[:header_params] || {}
|
|
1549
|
+
# HTTP header 'Accept' (if needed)
|
|
1550
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1551
|
+
|
|
1552
|
+
# form parameters
|
|
1553
|
+
form_params = opts[:form_params] || {}
|
|
1554
|
+
|
|
1555
|
+
# http body (model)
|
|
1556
|
+
post_body = opts[:debug_body]
|
|
1557
|
+
|
|
1558
|
+
# return_type
|
|
1559
|
+
return_type = opts[:debug_return_type] || 'TaskHistoryMessage'
|
|
1560
|
+
|
|
1561
|
+
# auth_names
|
|
1562
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
1563
|
+
|
|
1564
|
+
new_options = opts.merge(
|
|
1565
|
+
:operation => :"TasksApi.get_task_history_by_id",
|
|
1566
|
+
:header_params => header_params,
|
|
1567
|
+
:query_params => query_params,
|
|
1568
|
+
:form_params => form_params,
|
|
1569
|
+
:body => post_body,
|
|
1570
|
+
:auth_names => auth_names,
|
|
1571
|
+
:return_type => return_type
|
|
1572
|
+
)
|
|
1573
|
+
|
|
1574
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1575
|
+
if @api_client.config.debugging
|
|
1576
|
+
@api_client.config.logger.debug "API called: TasksApi#get_task_history_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1577
|
+
end
|
|
1578
|
+
return data, status_code, headers
|
|
1579
|
+
end
|
|
1580
|
+
|
|
1581
|
+
# Retrieve a task history file
|
|
1582
|
+
# Retrieves the metadata for a specific file associated with a task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
|
1583
|
+
# @param task_id [Integer]
|
|
1584
|
+
# @param task_history_id [Integer]
|
|
1585
|
+
# @param file_id [Integer]
|
|
1586
|
+
# @param [Hash] opts the optional parameters
|
|
1587
|
+
# @return [TaskHistoryFileMessage]
|
|
1588
|
+
def get_task_history_file_by_id(task_id, task_history_id, file_id, opts = {})
|
|
1589
|
+
data, _status_code, _headers = get_task_history_file_by_id_with_http_info(task_id, task_history_id, file_id, opts)
|
|
1590
|
+
data
|
|
1591
|
+
end
|
|
1592
|
+
|
|
1593
|
+
# Retrieve a task history file
|
|
1594
|
+
# Retrieves the metadata for a specific file associated with a task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
|
|
1595
|
+
# @param task_id [Integer]
|
|
1596
|
+
# @param task_history_id [Integer]
|
|
1597
|
+
# @param file_id [Integer]
|
|
1598
|
+
# @param [Hash] opts the optional parameters
|
|
1599
|
+
# @return [Array<(TaskHistoryFileMessage, Integer, Hash)>] TaskHistoryFileMessage data, response status code and response headers
|
|
1600
|
+
def get_task_history_file_by_id_with_http_info(task_id, task_history_id, file_id, opts = {})
|
|
1601
|
+
if @api_client.config.debugging
|
|
1602
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.get_task_history_file_by_id ...'
|
|
1603
|
+
end
|
|
1604
|
+
# verify the required parameter 'task_id' is set
|
|
1605
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
|
1606
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.get_task_history_file_by_id"
|
|
1607
|
+
end
|
|
1608
|
+
# verify the required parameter 'task_history_id' is set
|
|
1609
|
+
if @api_client.config.client_side_validation && task_history_id.nil?
|
|
1610
|
+
fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.get_task_history_file_by_id"
|
|
1611
|
+
end
|
|
1612
|
+
# verify the required parameter 'file_id' is set
|
|
1613
|
+
if @api_client.config.client_side_validation && file_id.nil?
|
|
1614
|
+
fail ArgumentError, "Missing the required parameter 'file_id' when calling TasksApi.get_task_history_file_by_id"
|
|
1615
|
+
end
|
|
1616
|
+
# resource path
|
|
1617
|
+
local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}/files/{fileId}'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s)).sub('{' + 'fileId' + '}', CGI.escape(file_id.to_s))
|
|
1618
|
+
|
|
1619
|
+
# query parameters
|
|
1620
|
+
query_params = opts[:query_params] || {}
|
|
1621
|
+
|
|
1622
|
+
# header parameters
|
|
1623
|
+
header_params = opts[:header_params] || {}
|
|
1624
|
+
# HTTP header 'Accept' (if needed)
|
|
1625
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1626
|
+
|
|
1627
|
+
# form parameters
|
|
1628
|
+
form_params = opts[:form_params] || {}
|
|
1629
|
+
|
|
1630
|
+
# http body (model)
|
|
1631
|
+
post_body = opts[:debug_body]
|
|
1632
|
+
|
|
1633
|
+
# return_type
|
|
1634
|
+
return_type = opts[:debug_return_type] || 'TaskHistoryFileMessage'
|
|
1635
|
+
|
|
1636
|
+
# auth_names
|
|
1637
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
1638
|
+
|
|
1639
|
+
new_options = opts.merge(
|
|
1640
|
+
:operation => :"TasksApi.get_task_history_file_by_id",
|
|
1641
|
+
:header_params => header_params,
|
|
1642
|
+
:query_params => query_params,
|
|
1643
|
+
:form_params => form_params,
|
|
1644
|
+
:body => post_body,
|
|
1645
|
+
:auth_names => auth_names,
|
|
1646
|
+
:return_type => return_type
|
|
1647
|
+
)
|
|
1648
|
+
|
|
1649
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1650
|
+
if @api_client.config.debugging
|
|
1651
|
+
@api_client.config.logger.debug "API called: TasksApi#get_task_history_file_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1652
|
+
end
|
|
1653
|
+
return data, status_code, headers
|
|
1654
|
+
end
|
|
1655
|
+
|
|
1656
|
+
# Retrieve a to do task
|
|
1657
|
+
# Retrieves a to do task. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
|
1658
|
+
# @param to_do_task_id [Integer] The to do task identifier
|
|
1659
|
+
# @param [Hash] opts the optional parameters
|
|
1660
|
+
# @return [ToDoTaskMessage]
|
|
1661
|
+
def get_to_do_task_by_id(to_do_task_id, opts = {})
|
|
1662
|
+
data, _status_code, _headers = get_to_do_task_by_id_with_http_info(to_do_task_id, opts)
|
|
1663
|
+
data
|
|
1664
|
+
end
|
|
1665
|
+
|
|
1666
|
+
# Retrieve a to do task
|
|
1667
|
+
# Retrieves a to do task. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
|
|
1668
|
+
# @param to_do_task_id [Integer] The to do task identifier
|
|
1669
|
+
# @param [Hash] opts the optional parameters
|
|
1670
|
+
# @return [Array<(ToDoTaskMessage, Integer, Hash)>] ToDoTaskMessage data, response status code and response headers
|
|
1671
|
+
def get_to_do_task_by_id_with_http_info(to_do_task_id, opts = {})
|
|
1672
|
+
if @api_client.config.debugging
|
|
1673
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.get_to_do_task_by_id ...'
|
|
1674
|
+
end
|
|
1675
|
+
# verify the required parameter 'to_do_task_id' is set
|
|
1676
|
+
if @api_client.config.client_side_validation && to_do_task_id.nil?
|
|
1677
|
+
fail ArgumentError, "Missing the required parameter 'to_do_task_id' when calling TasksApi.get_to_do_task_by_id"
|
|
1678
|
+
end
|
|
1679
|
+
# resource path
|
|
1680
|
+
local_var_path = '/v1/tasks/todorequests/{toDoTaskId}'.sub('{' + 'toDoTaskId' + '}', CGI.escape(to_do_task_id.to_s))
|
|
1681
|
+
|
|
1682
|
+
# query parameters
|
|
1683
|
+
query_params = opts[:query_params] || {}
|
|
1684
|
+
|
|
1685
|
+
# header parameters
|
|
1686
|
+
header_params = opts[:header_params] || {}
|
|
1687
|
+
# HTTP header 'Accept' (if needed)
|
|
1688
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1689
|
+
|
|
1690
|
+
# form parameters
|
|
1691
|
+
form_params = opts[:form_params] || {}
|
|
1692
|
+
|
|
1693
|
+
# http body (model)
|
|
1694
|
+
post_body = opts[:debug_body]
|
|
1695
|
+
|
|
1696
|
+
# return_type
|
|
1697
|
+
return_type = opts[:debug_return_type] || 'ToDoTaskMessage'
|
|
1698
|
+
|
|
1699
|
+
# auth_names
|
|
1700
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
1701
|
+
|
|
1702
|
+
new_options = opts.merge(
|
|
1703
|
+
:operation => :"TasksApi.get_to_do_task_by_id",
|
|
1704
|
+
:header_params => header_params,
|
|
1705
|
+
:query_params => query_params,
|
|
1706
|
+
:form_params => form_params,
|
|
1707
|
+
:body => post_body,
|
|
1708
|
+
:auth_names => auth_names,
|
|
1709
|
+
:return_type => return_type
|
|
1710
|
+
)
|
|
1711
|
+
|
|
1712
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1713
|
+
if @api_client.config.debugging
|
|
1714
|
+
@api_client.config.logger.debug "API called: TasksApi#get_to_do_task_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1715
|
+
end
|
|
1716
|
+
return data, status_code, headers
|
|
1717
|
+
end
|
|
1718
|
+
|
|
1719
|
+
# Retrieve all to do tasks
|
|
1720
|
+
# Retrieves a list of to do tasks. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View`
|
|
1721
|
+
# @param [Hash] opts the optional parameters
|
|
1722
|
+
# @option opts [String] :entitytype Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated.
|
|
1723
|
+
# @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field.
|
|
1724
|
+
# @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
|
|
1725
|
+
# @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
|
|
1726
|
+
# @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
1727
|
+
# @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
1728
|
+
# @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
1729
|
+
# @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
1730
|
+
# @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
|
|
1731
|
+
# @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
|
|
1732
|
+
# @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
|
|
1733
|
+
# @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
|
|
1734
|
+
# @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.
|
|
1735
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
1736
|
+
# @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.
|
|
1737
|
+
# @return [Array<ToDoTaskMessage>]
|
|
1738
|
+
def get_to_do_tasks(opts = {})
|
|
1739
|
+
data, _status_code, _headers = get_to_do_tasks_with_http_info(opts)
|
|
1740
|
+
data
|
|
1741
|
+
end
|
|
1742
|
+
|
|
1743
|
+
# Retrieve all to do tasks
|
|
1744
|
+
# Retrieves a list of to do tasks. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View`
|
|
1745
|
+
# @param [Hash] opts the optional parameters
|
|
1746
|
+
# @option opts [String] :entitytype Specifies the type of entity that the `EntityId` field refers to. This field is required if the `EntityId` field is populated.
|
|
1747
|
+
# @option opts [Integer] :entityid Filters results to any task associated with the specified entity id value. The value must be of the type specified in the `EntityType` field.
|
|
1748
|
+
# @option opts [Array<String>] :statuses Filters results by the status of the task. If no status is specified, tasks with any status will be returned.
|
|
1749
|
+
# @option opts [Integer] :unitid Filters results to any task associated with the unit identifier.
|
|
1750
|
+
# @option opts [Date] :lastupdatedfrom Filters results to any tasks were updated on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
1751
|
+
# @option opts [Date] :lastupdatedto Filters results to any tasks were updated on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
1752
|
+
# @option opts [Date] :duedatefrom Filters results to any tasks with a due date on or after the specified date. The value must be formatted as YYYY-MM-DD.
|
|
1753
|
+
# @option opts [Date] :duedateto Filters results to any tasks with a due date on or before the specified date. The value must be formatted as YYYY-MM-DD.
|
|
1754
|
+
# @option opts [Integer] :taskcategoryid Filters results to any tasks with the specified category identifier.
|
|
1755
|
+
# @option opts [Array<String>] :priorities Filters results to any tasks whose priority matches the specified values. If no priority is specified, tasks with any priority will be returned.
|
|
1756
|
+
# @option opts [Integer] :assignedtoid Filters results to any tasks that have been assigned to the specified staff user identifier.
|
|
1757
|
+
# @option opts [String] :tasktitle Filters results to any task whose title *contains* the specified value.
|
|
1758
|
+
# @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.
|
|
1759
|
+
# @option opts [Integer] :offset `offset` indicates the position of the first record to return. The `offset` is zero-based and the default is 0.
|
|
1760
|
+
# @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.
|
|
1761
|
+
# @return [Array<(Array<ToDoTaskMessage>, Integer, Hash)>] Array<ToDoTaskMessage> data, response status code and response headers
|
|
1762
|
+
def get_to_do_tasks_with_http_info(opts = {})
|
|
1763
|
+
if @api_client.config.debugging
|
|
1764
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.get_to_do_tasks ...'
|
|
1765
|
+
end
|
|
1766
|
+
allowable_values = ["Rental", "RentalOwner", "Association"]
|
|
1767
|
+
if @api_client.config.client_side_validation && opts[:'entitytype'] && !allowable_values.include?(opts[:'entitytype'])
|
|
1768
|
+
fail ArgumentError, "invalid value for \"entitytype\", must be one of #{allowable_values}"
|
|
1769
|
+
end
|
|
1770
|
+
allowable_values = ["New", "InProgress", "Completed", "Deferred", "Closed"]
|
|
1771
|
+
if @api_client.config.client_side_validation && opts[:'statuses'] && !opts[:'statuses'].all? { |item| allowable_values.include?(item) }
|
|
1772
|
+
fail ArgumentError, "invalid value for \"statuses\", must include one of #{allowable_values}"
|
|
1773
|
+
end
|
|
1774
|
+
allowable_values = ["Low", "Normal", "High"]
|
|
1775
|
+
if @api_client.config.client_side_validation && opts[:'priorities'] && !opts[:'priorities'].all? { |item| allowable_values.include?(item) }
|
|
1776
|
+
fail ArgumentError, "invalid value for \"priorities\", must include one of #{allowable_values}"
|
|
1777
|
+
end
|
|
1778
|
+
# resource path
|
|
1779
|
+
local_var_path = '/v1/tasks/todorequests'
|
|
1780
|
+
|
|
1781
|
+
# query parameters
|
|
1782
|
+
query_params = opts[:query_params] || {}
|
|
1783
|
+
query_params[:'entitytype'] = opts[:'entitytype'] if !opts[:'entitytype'].nil?
|
|
1784
|
+
query_params[:'entityid'] = opts[:'entityid'] if !opts[:'entityid'].nil?
|
|
1785
|
+
query_params[:'statuses'] = @api_client.build_collection_param(opts[:'statuses'], :multi) if !opts[:'statuses'].nil?
|
|
1786
|
+
query_params[:'unitid'] = opts[:'unitid'] if !opts[:'unitid'].nil?
|
|
1787
|
+
query_params[:'lastupdatedfrom'] = opts[:'lastupdatedfrom'] if !opts[:'lastupdatedfrom'].nil?
|
|
1788
|
+
query_params[:'lastupdatedto'] = opts[:'lastupdatedto'] if !opts[:'lastupdatedto'].nil?
|
|
1789
|
+
query_params[:'duedatefrom'] = opts[:'duedatefrom'] if !opts[:'duedatefrom'].nil?
|
|
1790
|
+
query_params[:'duedateto'] = opts[:'duedateto'] if !opts[:'duedateto'].nil?
|
|
1791
|
+
query_params[:'taskcategoryid'] = opts[:'taskcategoryid'] if !opts[:'taskcategoryid'].nil?
|
|
1792
|
+
query_params[:'priorities'] = @api_client.build_collection_param(opts[:'priorities'], :multi) if !opts[:'priorities'].nil?
|
|
1793
|
+
query_params[:'assignedtoid'] = opts[:'assignedtoid'] if !opts[:'assignedtoid'].nil?
|
|
1794
|
+
query_params[:'tasktitle'] = opts[:'tasktitle'] if !opts[:'tasktitle'].nil?
|
|
1795
|
+
query_params[:'orderby'] = opts[:'orderby'] if !opts[:'orderby'].nil?
|
|
1796
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
1797
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
1798
|
+
|
|
1799
|
+
# header parameters
|
|
1800
|
+
header_params = opts[:header_params] || {}
|
|
1801
|
+
# HTTP header 'Accept' (if needed)
|
|
1802
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1803
|
+
|
|
1804
|
+
# form parameters
|
|
1805
|
+
form_params = opts[:form_params] || {}
|
|
1806
|
+
|
|
1807
|
+
# http body (model)
|
|
1808
|
+
post_body = opts[:debug_body]
|
|
1809
|
+
|
|
1810
|
+
# return_type
|
|
1811
|
+
return_type = opts[:debug_return_type] || 'Array<ToDoTaskMessage>'
|
|
1812
|
+
|
|
1813
|
+
# auth_names
|
|
1814
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
1815
|
+
|
|
1816
|
+
new_options = opts.merge(
|
|
1817
|
+
:operation => :"TasksApi.get_to_do_tasks",
|
|
1818
|
+
:header_params => header_params,
|
|
1819
|
+
:query_params => query_params,
|
|
1820
|
+
:form_params => form_params,
|
|
1821
|
+
:body => post_body,
|
|
1822
|
+
:auth_names => auth_names,
|
|
1823
|
+
:return_type => return_type
|
|
1824
|
+
)
|
|
1825
|
+
|
|
1826
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1827
|
+
if @api_client.config.debugging
|
|
1828
|
+
@api_client.config.logger.debug "API called: TasksApi#get_to_do_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1829
|
+
end
|
|
1830
|
+
return data, status_code, headers
|
|
1831
|
+
end
|
|
1832
|
+
|
|
1833
|
+
# Update a contact request
|
|
1834
|
+
# Updates a contact request. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
|
1835
|
+
# @param contact_request_task_id [Integer] The contact request identifier.
|
|
1836
|
+
# @param contact_request_task_put_message [ContactRequestTaskPutMessage]
|
|
1837
|
+
# @param [Hash] opts the optional parameters
|
|
1838
|
+
# @return [ContactRequestTaskMessage]
|
|
1839
|
+
def update_contact_request_task(contact_request_task_id, contact_request_task_put_message, opts = {})
|
|
1840
|
+
data, _status_code, _headers = update_contact_request_task_with_http_info(contact_request_task_id, contact_request_task_put_message, opts)
|
|
1841
|
+
data
|
|
1842
|
+
end
|
|
1843
|
+
|
|
1844
|
+
# Update a contact request
|
|
1845
|
+
# Updates a contact request. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
|
|
1846
|
+
# @param contact_request_task_id [Integer] The contact request identifier.
|
|
1847
|
+
# @param contact_request_task_put_message [ContactRequestTaskPutMessage]
|
|
1848
|
+
# @param [Hash] opts the optional parameters
|
|
1849
|
+
# @return [Array<(ContactRequestTaskMessage, Integer, Hash)>] ContactRequestTaskMessage data, response status code and response headers
|
|
1850
|
+
def update_contact_request_task_with_http_info(contact_request_task_id, contact_request_task_put_message, opts = {})
|
|
1851
|
+
if @api_client.config.debugging
|
|
1852
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.update_contact_request_task ...'
|
|
1853
|
+
end
|
|
1854
|
+
# verify the required parameter 'contact_request_task_id' is set
|
|
1855
|
+
if @api_client.config.client_side_validation && contact_request_task_id.nil?
|
|
1856
|
+
fail ArgumentError, "Missing the required parameter 'contact_request_task_id' when calling TasksApi.update_contact_request_task"
|
|
1857
|
+
end
|
|
1858
|
+
# verify the required parameter 'contact_request_task_put_message' is set
|
|
1859
|
+
if @api_client.config.client_side_validation && contact_request_task_put_message.nil?
|
|
1860
|
+
fail ArgumentError, "Missing the required parameter 'contact_request_task_put_message' when calling TasksApi.update_contact_request_task"
|
|
1861
|
+
end
|
|
1862
|
+
# resource path
|
|
1863
|
+
local_var_path = '/v1/tasks/contactrequests/{contactRequestTaskId}'.sub('{' + 'contactRequestTaskId' + '}', CGI.escape(contact_request_task_id.to_s))
|
|
1864
|
+
|
|
1865
|
+
# query parameters
|
|
1866
|
+
query_params = opts[:query_params] || {}
|
|
1867
|
+
|
|
1868
|
+
# header parameters
|
|
1869
|
+
header_params = opts[:header_params] || {}
|
|
1870
|
+
# HTTP header 'Accept' (if needed)
|
|
1871
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1872
|
+
# HTTP header 'Content-Type'
|
|
1873
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1874
|
+
if !content_type.nil?
|
|
1875
|
+
header_params['Content-Type'] = content_type
|
|
1876
|
+
end
|
|
1877
|
+
|
|
1878
|
+
# form parameters
|
|
1879
|
+
form_params = opts[:form_params] || {}
|
|
1880
|
+
|
|
1881
|
+
# http body (model)
|
|
1882
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(contact_request_task_put_message)
|
|
1883
|
+
|
|
1884
|
+
# return_type
|
|
1885
|
+
return_type = opts[:debug_return_type] || 'ContactRequestTaskMessage'
|
|
1886
|
+
|
|
1887
|
+
# auth_names
|
|
1888
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
1889
|
+
|
|
1890
|
+
new_options = opts.merge(
|
|
1891
|
+
:operation => :"TasksApi.update_contact_request_task",
|
|
1892
|
+
:header_params => header_params,
|
|
1893
|
+
:query_params => query_params,
|
|
1894
|
+
:form_params => form_params,
|
|
1895
|
+
:body => post_body,
|
|
1896
|
+
:auth_names => auth_names,
|
|
1897
|
+
:return_type => return_type
|
|
1898
|
+
)
|
|
1899
|
+
|
|
1900
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1901
|
+
if @api_client.config.debugging
|
|
1902
|
+
@api_client.config.logger.debug "API called: TasksApi#update_contact_request_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1903
|
+
end
|
|
1904
|
+
return data, status_code, headers
|
|
1905
|
+
end
|
|
1906
|
+
|
|
1907
|
+
# Update a rental owner request
|
|
1908
|
+
# Updates a rental owner request. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
|
1909
|
+
# @param rental_owner_request_task_id [Integer] The rental owner request identifier.
|
|
1910
|
+
# @param rental_owner_request_task_put_message [RentalOwnerRequestTaskPutMessage]
|
|
1911
|
+
# @param [Hash] opts the optional parameters
|
|
1912
|
+
# @return [RentalOwnerRequestTaskMessage]
|
|
1913
|
+
def update_rental_owner_request_task(rental_owner_request_task_id, rental_owner_request_task_put_message, opts = {})
|
|
1914
|
+
data, _status_code, _headers = update_rental_owner_request_task_with_http_info(rental_owner_request_task_id, rental_owner_request_task_put_message, opts)
|
|
1915
|
+
data
|
|
1916
|
+
end
|
|
1917
|
+
|
|
1918
|
+
# Update a rental owner request
|
|
1919
|
+
# Updates a rental owner request. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
|
|
1920
|
+
# @param rental_owner_request_task_id [Integer] The rental owner request identifier.
|
|
1921
|
+
# @param rental_owner_request_task_put_message [RentalOwnerRequestTaskPutMessage]
|
|
1922
|
+
# @param [Hash] opts the optional parameters
|
|
1923
|
+
# @return [Array<(RentalOwnerRequestTaskMessage, Integer, Hash)>] RentalOwnerRequestTaskMessage data, response status code and response headers
|
|
1924
|
+
def update_rental_owner_request_task_with_http_info(rental_owner_request_task_id, rental_owner_request_task_put_message, opts = {})
|
|
1925
|
+
if @api_client.config.debugging
|
|
1926
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.update_rental_owner_request_task ...'
|
|
1927
|
+
end
|
|
1928
|
+
# verify the required parameter 'rental_owner_request_task_id' is set
|
|
1929
|
+
if @api_client.config.client_side_validation && rental_owner_request_task_id.nil?
|
|
1930
|
+
fail ArgumentError, "Missing the required parameter 'rental_owner_request_task_id' when calling TasksApi.update_rental_owner_request_task"
|
|
1931
|
+
end
|
|
1932
|
+
# verify the required parameter 'rental_owner_request_task_put_message' is set
|
|
1933
|
+
if @api_client.config.client_side_validation && rental_owner_request_task_put_message.nil?
|
|
1934
|
+
fail ArgumentError, "Missing the required parameter 'rental_owner_request_task_put_message' when calling TasksApi.update_rental_owner_request_task"
|
|
1935
|
+
end
|
|
1936
|
+
# resource path
|
|
1937
|
+
local_var_path = '/v1/tasks/rentalownerrequests/{rentalOwnerRequestTaskId}'.sub('{' + 'rentalOwnerRequestTaskId' + '}', CGI.escape(rental_owner_request_task_id.to_s))
|
|
1938
|
+
|
|
1939
|
+
# query parameters
|
|
1940
|
+
query_params = opts[:query_params] || {}
|
|
1941
|
+
|
|
1942
|
+
# header parameters
|
|
1943
|
+
header_params = opts[:header_params] || {}
|
|
1944
|
+
# HTTP header 'Accept' (if needed)
|
|
1945
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1946
|
+
# HTTP header 'Content-Type'
|
|
1947
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1948
|
+
if !content_type.nil?
|
|
1949
|
+
header_params['Content-Type'] = content_type
|
|
1950
|
+
end
|
|
1951
|
+
|
|
1952
|
+
# form parameters
|
|
1953
|
+
form_params = opts[:form_params] || {}
|
|
1954
|
+
|
|
1955
|
+
# http body (model)
|
|
1956
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(rental_owner_request_task_put_message)
|
|
1957
|
+
|
|
1958
|
+
# return_type
|
|
1959
|
+
return_type = opts[:debug_return_type] || 'RentalOwnerRequestTaskMessage'
|
|
1960
|
+
|
|
1961
|
+
# auth_names
|
|
1962
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
1963
|
+
|
|
1964
|
+
new_options = opts.merge(
|
|
1965
|
+
:operation => :"TasksApi.update_rental_owner_request_task",
|
|
1966
|
+
:header_params => header_params,
|
|
1967
|
+
:query_params => query_params,
|
|
1968
|
+
:form_params => form_params,
|
|
1969
|
+
:body => post_body,
|
|
1970
|
+
:auth_names => auth_names,
|
|
1971
|
+
:return_type => return_type
|
|
1972
|
+
)
|
|
1973
|
+
|
|
1974
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1975
|
+
if @api_client.config.debugging
|
|
1976
|
+
@api_client.config.logger.debug "API called: TasksApi#update_rental_owner_request_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1977
|
+
end
|
|
1978
|
+
return data, status_code, headers
|
|
1979
|
+
end
|
|
1980
|
+
|
|
1981
|
+
# Update a resident request
|
|
1982
|
+
# Update a resident request. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
|
1983
|
+
# @param resident_request_task_id [Integer] The resident request identifier.
|
|
1984
|
+
# @param resident_request_task_put_message [ResidentRequestTaskPutMessage]
|
|
1985
|
+
# @param [Hash] opts the optional parameters
|
|
1986
|
+
# @return [ResidentRequestTaskMessage]
|
|
1987
|
+
def update_resource(resident_request_task_id, resident_request_task_put_message, opts = {})
|
|
1988
|
+
data, _status_code, _headers = update_resource_with_http_info(resident_request_task_id, resident_request_task_put_message, opts)
|
|
1989
|
+
data
|
|
1990
|
+
end
|
|
1991
|
+
|
|
1992
|
+
# Update a resident request
|
|
1993
|
+
# Update a resident request. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
|
|
1994
|
+
# @param resident_request_task_id [Integer] The resident request identifier.
|
|
1995
|
+
# @param resident_request_task_put_message [ResidentRequestTaskPutMessage]
|
|
1996
|
+
# @param [Hash] opts the optional parameters
|
|
1997
|
+
# @return [Array<(ResidentRequestTaskMessage, Integer, Hash)>] ResidentRequestTaskMessage data, response status code and response headers
|
|
1998
|
+
def update_resource_with_http_info(resident_request_task_id, resident_request_task_put_message, opts = {})
|
|
1999
|
+
if @api_client.config.debugging
|
|
2000
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.update_resource ...'
|
|
2001
|
+
end
|
|
2002
|
+
# verify the required parameter 'resident_request_task_id' is set
|
|
2003
|
+
if @api_client.config.client_side_validation && resident_request_task_id.nil?
|
|
2004
|
+
fail ArgumentError, "Missing the required parameter 'resident_request_task_id' when calling TasksApi.update_resource"
|
|
2005
|
+
end
|
|
2006
|
+
# verify the required parameter 'resident_request_task_put_message' is set
|
|
2007
|
+
if @api_client.config.client_side_validation && resident_request_task_put_message.nil?
|
|
2008
|
+
fail ArgumentError, "Missing the required parameter 'resident_request_task_put_message' when calling TasksApi.update_resource"
|
|
2009
|
+
end
|
|
2010
|
+
# resource path
|
|
2011
|
+
local_var_path = '/v1/tasks/residentrequests/{residentRequestTaskId}'.sub('{' + 'residentRequestTaskId' + '}', CGI.escape(resident_request_task_id.to_s))
|
|
2012
|
+
|
|
2013
|
+
# query parameters
|
|
2014
|
+
query_params = opts[:query_params] || {}
|
|
2015
|
+
|
|
2016
|
+
# header parameters
|
|
2017
|
+
header_params = opts[:header_params] || {}
|
|
2018
|
+
# HTTP header 'Accept' (if needed)
|
|
2019
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2020
|
+
# HTTP header 'Content-Type'
|
|
2021
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2022
|
+
if !content_type.nil?
|
|
2023
|
+
header_params['Content-Type'] = content_type
|
|
2024
|
+
end
|
|
2025
|
+
|
|
2026
|
+
# form parameters
|
|
2027
|
+
form_params = opts[:form_params] || {}
|
|
2028
|
+
|
|
2029
|
+
# http body (model)
|
|
2030
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(resident_request_task_put_message)
|
|
2031
|
+
|
|
2032
|
+
# return_type
|
|
2033
|
+
return_type = opts[:debug_return_type] || 'ResidentRequestTaskMessage'
|
|
2034
|
+
|
|
2035
|
+
# auth_names
|
|
2036
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
2037
|
+
|
|
2038
|
+
new_options = opts.merge(
|
|
2039
|
+
:operation => :"TasksApi.update_resource",
|
|
2040
|
+
:header_params => header_params,
|
|
2041
|
+
:query_params => query_params,
|
|
2042
|
+
:form_params => form_params,
|
|
2043
|
+
:body => post_body,
|
|
2044
|
+
:auth_names => auth_names,
|
|
2045
|
+
:return_type => return_type
|
|
2046
|
+
)
|
|
2047
|
+
|
|
2048
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
2049
|
+
if @api_client.config.debugging
|
|
2050
|
+
@api_client.config.logger.debug "API called: TasksApi#update_resource\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2051
|
+
end
|
|
2052
|
+
return data, status_code, headers
|
|
2053
|
+
end
|
|
2054
|
+
|
|
2055
|
+
# Update a task category
|
|
2056
|
+
# Updates a task category. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
|
2057
|
+
# @param task_category_id [Integer] The task category identifier.
|
|
2058
|
+
# @param task_category_put_message [TaskCategoryPutMessage]
|
|
2059
|
+
# @param [Hash] opts the optional parameters
|
|
2060
|
+
# @return [TaskCategoryMessage]
|
|
2061
|
+
def update_task_category(task_category_id, task_category_put_message, opts = {})
|
|
2062
|
+
data, _status_code, _headers = update_task_category_with_http_info(task_category_id, task_category_put_message, opts)
|
|
2063
|
+
data
|
|
2064
|
+
end
|
|
2065
|
+
|
|
2066
|
+
# Update a task category
|
|
2067
|
+
# Updates a task category. <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
|
|
2068
|
+
# @param task_category_id [Integer] The task category identifier.
|
|
2069
|
+
# @param task_category_put_message [TaskCategoryPutMessage]
|
|
2070
|
+
# @param [Hash] opts the optional parameters
|
|
2071
|
+
# @return [Array<(TaskCategoryMessage, Integer, Hash)>] TaskCategoryMessage data, response status code and response headers
|
|
2072
|
+
def update_task_category_with_http_info(task_category_id, task_category_put_message, opts = {})
|
|
2073
|
+
if @api_client.config.debugging
|
|
2074
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.update_task_category ...'
|
|
2075
|
+
end
|
|
2076
|
+
# verify the required parameter 'task_category_id' is set
|
|
2077
|
+
if @api_client.config.client_side_validation && task_category_id.nil?
|
|
2078
|
+
fail ArgumentError, "Missing the required parameter 'task_category_id' when calling TasksApi.update_task_category"
|
|
2079
|
+
end
|
|
2080
|
+
# verify the required parameter 'task_category_put_message' is set
|
|
2081
|
+
if @api_client.config.client_side_validation && task_category_put_message.nil?
|
|
2082
|
+
fail ArgumentError, "Missing the required parameter 'task_category_put_message' when calling TasksApi.update_task_category"
|
|
2083
|
+
end
|
|
2084
|
+
# resource path
|
|
2085
|
+
local_var_path = '/v1/tasks/categories/{taskCategoryId}'.sub('{' + 'taskCategoryId' + '}', CGI.escape(task_category_id.to_s))
|
|
2086
|
+
|
|
2087
|
+
# query parameters
|
|
2088
|
+
query_params = opts[:query_params] || {}
|
|
2089
|
+
|
|
2090
|
+
# header parameters
|
|
2091
|
+
header_params = opts[:header_params] || {}
|
|
2092
|
+
# HTTP header 'Accept' (if needed)
|
|
2093
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2094
|
+
# HTTP header 'Content-Type'
|
|
2095
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2096
|
+
if !content_type.nil?
|
|
2097
|
+
header_params['Content-Type'] = content_type
|
|
2098
|
+
end
|
|
2099
|
+
|
|
2100
|
+
# form parameters
|
|
2101
|
+
form_params = opts[:form_params] || {}
|
|
2102
|
+
|
|
2103
|
+
# http body (model)
|
|
2104
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(task_category_put_message)
|
|
2105
|
+
|
|
2106
|
+
# return_type
|
|
2107
|
+
return_type = opts[:debug_return_type] || 'TaskCategoryMessage'
|
|
2108
|
+
|
|
2109
|
+
# auth_names
|
|
2110
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
2111
|
+
|
|
2112
|
+
new_options = opts.merge(
|
|
2113
|
+
:operation => :"TasksApi.update_task_category",
|
|
2114
|
+
:header_params => header_params,
|
|
2115
|
+
:query_params => query_params,
|
|
2116
|
+
:form_params => form_params,
|
|
2117
|
+
:body => post_body,
|
|
2118
|
+
:auth_names => auth_names,
|
|
2119
|
+
:return_type => return_type
|
|
2120
|
+
)
|
|
2121
|
+
|
|
2122
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
2123
|
+
if @api_client.config.debugging
|
|
2124
|
+
@api_client.config.logger.debug "API called: TasksApi#update_task_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2125
|
+
end
|
|
2126
|
+
return data, status_code, headers
|
|
2127
|
+
end
|
|
2128
|
+
|
|
2129
|
+
# Update a task history
|
|
2130
|
+
# Updates a specific task history record for a task. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
|
2131
|
+
# @param task_id [Integer]
|
|
2132
|
+
# @param task_history_id [Integer]
|
|
2133
|
+
# @param task_history_put_message [TaskHistoryPutMessage]
|
|
2134
|
+
# @param [Hash] opts the optional parameters
|
|
2135
|
+
# @return [TaskHistoryMessage]
|
|
2136
|
+
def update_task_history(task_id, task_history_id, task_history_put_message, opts = {})
|
|
2137
|
+
data, _status_code, _headers = update_task_history_with_http_info(task_id, task_history_id, task_history_put_message, opts)
|
|
2138
|
+
data
|
|
2139
|
+
end
|
|
2140
|
+
|
|
2141
|
+
# Update a task history
|
|
2142
|
+
# Updates a specific task history record for a task. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
|
|
2143
|
+
# @param task_id [Integer]
|
|
2144
|
+
# @param task_history_id [Integer]
|
|
2145
|
+
# @param task_history_put_message [TaskHistoryPutMessage]
|
|
2146
|
+
# @param [Hash] opts the optional parameters
|
|
2147
|
+
# @return [Array<(TaskHistoryMessage, Integer, Hash)>] TaskHistoryMessage data, response status code and response headers
|
|
2148
|
+
def update_task_history_with_http_info(task_id, task_history_id, task_history_put_message, opts = {})
|
|
2149
|
+
if @api_client.config.debugging
|
|
2150
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.update_task_history ...'
|
|
2151
|
+
end
|
|
2152
|
+
# verify the required parameter 'task_id' is set
|
|
2153
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
|
2154
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.update_task_history"
|
|
2155
|
+
end
|
|
2156
|
+
# verify the required parameter 'task_history_id' is set
|
|
2157
|
+
if @api_client.config.client_side_validation && task_history_id.nil?
|
|
2158
|
+
fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.update_task_history"
|
|
2159
|
+
end
|
|
2160
|
+
# verify the required parameter 'task_history_put_message' is set
|
|
2161
|
+
if @api_client.config.client_side_validation && task_history_put_message.nil?
|
|
2162
|
+
fail ArgumentError, "Missing the required parameter 'task_history_put_message' when calling TasksApi.update_task_history"
|
|
2163
|
+
end
|
|
2164
|
+
# resource path
|
|
2165
|
+
local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s))
|
|
2166
|
+
|
|
2167
|
+
# query parameters
|
|
2168
|
+
query_params = opts[:query_params] || {}
|
|
2169
|
+
|
|
2170
|
+
# header parameters
|
|
2171
|
+
header_params = opts[:header_params] || {}
|
|
2172
|
+
# HTTP header 'Accept' (if needed)
|
|
2173
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2174
|
+
# HTTP header 'Content-Type'
|
|
2175
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2176
|
+
if !content_type.nil?
|
|
2177
|
+
header_params['Content-Type'] = content_type
|
|
2178
|
+
end
|
|
2179
|
+
|
|
2180
|
+
# form parameters
|
|
2181
|
+
form_params = opts[:form_params] || {}
|
|
2182
|
+
|
|
2183
|
+
# http body (model)
|
|
2184
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(task_history_put_message)
|
|
2185
|
+
|
|
2186
|
+
# return_type
|
|
2187
|
+
return_type = opts[:debug_return_type] || 'TaskHistoryMessage'
|
|
2188
|
+
|
|
2189
|
+
# auth_names
|
|
2190
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
2191
|
+
|
|
2192
|
+
new_options = opts.merge(
|
|
2193
|
+
:operation => :"TasksApi.update_task_history",
|
|
2194
|
+
:header_params => header_params,
|
|
2195
|
+
:query_params => query_params,
|
|
2196
|
+
:form_params => form_params,
|
|
2197
|
+
:body => post_body,
|
|
2198
|
+
:auth_names => auth_names,
|
|
2199
|
+
:return_type => return_type
|
|
2200
|
+
)
|
|
2201
|
+
|
|
2202
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
2203
|
+
if @api_client.config.debugging
|
|
2204
|
+
@api_client.config.logger.debug "API called: TasksApi#update_task_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2205
|
+
end
|
|
2206
|
+
return data, status_code, headers
|
|
2207
|
+
end
|
|
2208
|
+
|
|
2209
|
+
# Update a to do task
|
|
2210
|
+
# Updates a to do task <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
|
2211
|
+
# @param to_do_task_id [Integer] The to do task identifier.
|
|
2212
|
+
# @param to_do_task_put_message [ToDoTaskPutMessage]
|
|
2213
|
+
# @param [Hash] opts the optional parameters
|
|
2214
|
+
# @return [ToDoTaskMessage]
|
|
2215
|
+
def update_to_do_task(to_do_task_id, to_do_task_put_message, opts = {})
|
|
2216
|
+
data, _status_code, _headers = update_to_do_task_with_http_info(to_do_task_id, to_do_task_put_message, opts)
|
|
2217
|
+
data
|
|
2218
|
+
end
|
|
2219
|
+
|
|
2220
|
+
# Update a to do task
|
|
2221
|
+
# Updates a to do task <br /><br /><strong>NOTE:</strong> Any field not included in the update request will be set to either an empty string or `null` in the database depending on the field definition. <br />The recommended workflow to ensure no data is inadvertently overwritten is to execute a `GET` request for the resource you're about to update and then use this response to fill any of the fields that are not being updated. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
|
|
2222
|
+
# @param to_do_task_id [Integer] The to do task identifier.
|
|
2223
|
+
# @param to_do_task_put_message [ToDoTaskPutMessage]
|
|
2224
|
+
# @param [Hash] opts the optional parameters
|
|
2225
|
+
# @return [Array<(ToDoTaskMessage, Integer, Hash)>] ToDoTaskMessage data, response status code and response headers
|
|
2226
|
+
def update_to_do_task_with_http_info(to_do_task_id, to_do_task_put_message, opts = {})
|
|
2227
|
+
if @api_client.config.debugging
|
|
2228
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.update_to_do_task ...'
|
|
2229
|
+
end
|
|
2230
|
+
# verify the required parameter 'to_do_task_id' is set
|
|
2231
|
+
if @api_client.config.client_side_validation && to_do_task_id.nil?
|
|
2232
|
+
fail ArgumentError, "Missing the required parameter 'to_do_task_id' when calling TasksApi.update_to_do_task"
|
|
2233
|
+
end
|
|
2234
|
+
# verify the required parameter 'to_do_task_put_message' is set
|
|
2235
|
+
if @api_client.config.client_side_validation && to_do_task_put_message.nil?
|
|
2236
|
+
fail ArgumentError, "Missing the required parameter 'to_do_task_put_message' when calling TasksApi.update_to_do_task"
|
|
2237
|
+
end
|
|
2238
|
+
# resource path
|
|
2239
|
+
local_var_path = '/v1/tasks/todorequests/{toDoTaskId}'.sub('{' + 'toDoTaskId' + '}', CGI.escape(to_do_task_id.to_s))
|
|
2240
|
+
|
|
2241
|
+
# query parameters
|
|
2242
|
+
query_params = opts[:query_params] || {}
|
|
2243
|
+
|
|
2244
|
+
# header parameters
|
|
2245
|
+
header_params = opts[:header_params] || {}
|
|
2246
|
+
# HTTP header 'Accept' (if needed)
|
|
2247
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2248
|
+
# HTTP header 'Content-Type'
|
|
2249
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2250
|
+
if !content_type.nil?
|
|
2251
|
+
header_params['Content-Type'] = content_type
|
|
2252
|
+
end
|
|
2253
|
+
|
|
2254
|
+
# form parameters
|
|
2255
|
+
form_params = opts[:form_params] || {}
|
|
2256
|
+
|
|
2257
|
+
# http body (model)
|
|
2258
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(to_do_task_put_message)
|
|
2259
|
+
|
|
2260
|
+
# return_type
|
|
2261
|
+
return_type = opts[:debug_return_type] || 'ToDoTaskMessage'
|
|
2262
|
+
|
|
2263
|
+
# auth_names
|
|
2264
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
2265
|
+
|
|
2266
|
+
new_options = opts.merge(
|
|
2267
|
+
:operation => :"TasksApi.update_to_do_task",
|
|
2268
|
+
:header_params => header_params,
|
|
2269
|
+
:query_params => query_params,
|
|
2270
|
+
:form_params => form_params,
|
|
2271
|
+
:body => post_body,
|
|
2272
|
+
:auth_names => auth_names,
|
|
2273
|
+
:return_type => return_type
|
|
2274
|
+
)
|
|
2275
|
+
|
|
2276
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
2277
|
+
if @api_client.config.debugging
|
|
2278
|
+
@api_client.config.logger.debug "API called: TasksApi#update_to_do_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2279
|
+
end
|
|
2280
|
+
return data, status_code, headers
|
|
2281
|
+
end
|
|
2282
|
+
|
|
2283
|
+
# Upload a task history file
|
|
2284
|
+
# Uploads a file and associates it to the specified task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br />Uploading a file requires making two API requests. Each step is outlined below. <br /><br /><strong>Step 1 - Save file metadata</strong><br /> The first step in the file upload process is to submit the file metadata to `/v1/tasks/{taskId}/history/{taskHistoryId}/uploadrequests`. The response of this call will contain a URL and a collection of form data that will be used in step 2 to generate the request for the file binary upload. <br /><br /><strong>NOTE:</strong> The response data will expire after 5 minutes. The file metadata will not be saved in the Buildium system if step 2 of this process is not completed successfully. <br /><br /><strong>Step 2 - Upload the file binary</strong><br /> Uploading the file binary will require using the response from step 1 to form a POST request to the Buildium file provider. Follow these steps to create the request: <br /> 1. Form a POST request using the value of the `BucketUrl` property as the URL. <br /><br /> 2. Set the `Content-Type` header to `multipart/form-data`. <br /><br /> 3. Copy the fields from the `FormData` property to this request as form-data key/value pairs. <br /><strong>NOTE:</strong> These values must added to the request form-data in the order they were received in the response. <br /><br /> 4. Lastly create a form-data key named `file` and set the value to the file binary. <br /><strong>NOTE:</strong> This must be the last field in the form-data list. <br /><br />This image shows what the POST request should look like if you're using Postman: <img src=\"file-upload-example.png\" /><br /><br /> 5. Send the POST request! A successful request will return with a `204 - NO CONTENT` HTTP response code. For any failure responses, please refer to <a target=\"_blank\" href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses\">AWS documentation</a> on REST error responses. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks > Tasks</span> - `View` `Edit`
|
|
2285
|
+
# @param task_id [Integer]
|
|
2286
|
+
# @param task_history_id [Integer]
|
|
2287
|
+
# @param task_history_file_upload_post_message [TaskHistoryFileUploadPostMessage]
|
|
2288
|
+
# @param [Hash] opts the optional parameters
|
|
2289
|
+
# @return [FileUploadTicketMessage]
|
|
2290
|
+
def upload_task_history_file_request_async(task_id, task_history_id, task_history_file_upload_post_message, opts = {})
|
|
2291
|
+
data, _status_code, _headers = upload_task_history_file_request_async_with_http_info(task_id, task_history_id, task_history_file_upload_post_message, opts)
|
|
2292
|
+
data
|
|
2293
|
+
end
|
|
2294
|
+
|
|
2295
|
+
# Upload a task history file
|
|
2296
|
+
# Uploads a file and associates it to the specified task history record. <br /><br />This endpoint can be used for any task type - contact requests, rental owner requests, resident requests or to do's. <br /><br />Uploading a file requires making two API requests. Each step is outlined below. <br /><br /><strong>Step 1 - Save file metadata</strong><br /> The first step in the file upload process is to submit the file metadata to `/v1/tasks/{taskId}/history/{taskHistoryId}/uploadrequests`. The response of this call will contain a URL and a collection of form data that will be used in step 2 to generate the request for the file binary upload. <br /><br /><strong>NOTE:</strong> The response data will expire after 5 minutes. The file metadata will not be saved in the Buildium system if step 2 of this process is not completed successfully. <br /><br /><strong>Step 2 - Upload the file binary</strong><br /> Uploading the file binary will require using the response from step 1 to form a POST request to the Buildium file provider. Follow these steps to create the request: <br /> 1. Form a POST request using the value of the `BucketUrl` property as the URL. <br /><br /> 2. Set the `Content-Type` header to `multipart/form-data`. <br /><br /> 3. Copy the fields from the `FormData` property to this request as form-data key/value pairs. <br /><strong>NOTE:</strong> These values must added to the request form-data in the order they were received in the response. <br /><br /> 4. Lastly create a form-data key named `file` and set the value to the file binary. <br /><strong>NOTE:</strong> This must be the last field in the form-data list. <br /><br />This image shows what the POST request should look like if you're using Postman: <img src=\"file-upload-example.png\" /><br /><br /> 5. Send the POST request! A successful request will return with a `204 - NO CONTENT` HTTP response code. For any failure responses, please refer to <a target=\"_blank\" href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#RESTErrorResponses\">AWS documentation</a> on REST error responses. <br /><br /><h4>Required permission(s):</h4><span class=\"permissionBlock\">Tasks &gt; Tasks</span> - `View` `Edit`
|
|
2297
|
+
# @param task_id [Integer]
|
|
2298
|
+
# @param task_history_id [Integer]
|
|
2299
|
+
# @param task_history_file_upload_post_message [TaskHistoryFileUploadPostMessage]
|
|
2300
|
+
# @param [Hash] opts the optional parameters
|
|
2301
|
+
# @return [Array<(FileUploadTicketMessage, Integer, Hash)>] FileUploadTicketMessage data, response status code and response headers
|
|
2302
|
+
def upload_task_history_file_request_async_with_http_info(task_id, task_history_id, task_history_file_upload_post_message, opts = {})
|
|
2303
|
+
if @api_client.config.debugging
|
|
2304
|
+
@api_client.config.logger.debug 'Calling API: TasksApi.upload_task_history_file_request_async ...'
|
|
2305
|
+
end
|
|
2306
|
+
# verify the required parameter 'task_id' is set
|
|
2307
|
+
if @api_client.config.client_side_validation && task_id.nil?
|
|
2308
|
+
fail ArgumentError, "Missing the required parameter 'task_id' when calling TasksApi.upload_task_history_file_request_async"
|
|
2309
|
+
end
|
|
2310
|
+
# verify the required parameter 'task_history_id' is set
|
|
2311
|
+
if @api_client.config.client_side_validation && task_history_id.nil?
|
|
2312
|
+
fail ArgumentError, "Missing the required parameter 'task_history_id' when calling TasksApi.upload_task_history_file_request_async"
|
|
2313
|
+
end
|
|
2314
|
+
# verify the required parameter 'task_history_file_upload_post_message' is set
|
|
2315
|
+
if @api_client.config.client_side_validation && task_history_file_upload_post_message.nil?
|
|
2316
|
+
fail ArgumentError, "Missing the required parameter 'task_history_file_upload_post_message' when calling TasksApi.upload_task_history_file_request_async"
|
|
2317
|
+
end
|
|
2318
|
+
# resource path
|
|
2319
|
+
local_var_path = '/v1/tasks/{taskId}/history/{taskHistoryId}/files/uploadrequests'.sub('{' + 'taskId' + '}', CGI.escape(task_id.to_s)).sub('{' + 'taskHistoryId' + '}', CGI.escape(task_history_id.to_s))
|
|
2320
|
+
|
|
2321
|
+
# query parameters
|
|
2322
|
+
query_params = opts[:query_params] || {}
|
|
2323
|
+
|
|
2324
|
+
# header parameters
|
|
2325
|
+
header_params = opts[:header_params] || {}
|
|
2326
|
+
# HTTP header 'Accept' (if needed)
|
|
2327
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
2328
|
+
# HTTP header 'Content-Type'
|
|
2329
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2330
|
+
if !content_type.nil?
|
|
2331
|
+
header_params['Content-Type'] = content_type
|
|
2332
|
+
end
|
|
2333
|
+
|
|
2334
|
+
# form parameters
|
|
2335
|
+
form_params = opts[:form_params] || {}
|
|
2336
|
+
|
|
2337
|
+
# http body (model)
|
|
2338
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(task_history_file_upload_post_message)
|
|
2339
|
+
|
|
2340
|
+
# return_type
|
|
2341
|
+
return_type = opts[:debug_return_type] || 'FileUploadTicketMessage'
|
|
2342
|
+
|
|
2343
|
+
# auth_names
|
|
2344
|
+
auth_names = opts[:debug_auth_names] || ['clientId', 'clientSecret']
|
|
2345
|
+
|
|
2346
|
+
new_options = opts.merge(
|
|
2347
|
+
:operation => :"TasksApi.upload_task_history_file_request_async",
|
|
2348
|
+
:header_params => header_params,
|
|
2349
|
+
:query_params => query_params,
|
|
2350
|
+
:form_params => form_params,
|
|
2351
|
+
:body => post_body,
|
|
2352
|
+
:auth_names => auth_names,
|
|
2353
|
+
:return_type => return_type
|
|
2354
|
+
)
|
|
2355
|
+
|
|
2356
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
2357
|
+
if @api_client.config.debugging
|
|
2358
|
+
@api_client.config.logger.debug "API called: TasksApi#upload_task_history_file_request_async\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2359
|
+
end
|
|
2360
|
+
return data, status_code, headers
|
|
2361
|
+
end
|
|
2362
|
+
end
|
|
2363
|
+
end
|