files.com 1.1.808 → 1.1.810
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 +4 -4
- data/_VERSION +1 -1
- data/doc/Files/APIConnectionError.html +1 -1
- data/doc/Files/APIError.html +1 -1
- data/doc/Files/AccountAlreadyExistsError.html +1 -1
- data/doc/Files/AccountLineItem.html +1 -1
- data/doc/Files/AccountOverdueError.html +1 -1
- data/doc/Files/Action.html +1 -1
- data/doc/Files/ActionLog.html +1 -1
- data/doc/Files/ActionNotificationExport.html +1 -1
- data/doc/Files/ActionNotificationExportResult.html +1 -1
- data/doc/Files/AdditionalAuthenticationRequiredError.html +1 -1
- data/doc/Files/AgentNode.html +1 -1
- data/doc/Files/AgentNodeConnection.html +1 -1
- data/doc/Files/AgentNodeInstance.html +1 -1
- data/doc/Files/AgentPushUpdate.html +1 -1
- data/doc/Files/AgentPushUpdateBlockedError.html +1 -1
- data/doc/Files/AgentUnavailableError.html +1 -1
- data/doc/Files/AgentUpgradeRequiredError.html +1 -1
- data/doc/Files/AiAssistantPersonality.html +1 -1
- data/doc/Files/AiTask.html +1 -1
- data/doc/Files/AiTaskCannotBeRunManuallyError.html +1 -1
- data/doc/Files/AlreadyCompletedError.html +1 -1
- data/doc/Files/Api.html +1 -1
- data/doc/Files/ApiClient/RequestLogContext.html +1 -1
- data/doc/Files/ApiClient.html +1 -1
- data/doc/Files/ApiKey.html +1 -1
- data/doc/Files/ApiKeyIsDisabledError.html +1 -1
- data/doc/Files/ApiKeyIsPathRestrictedError.html +1 -1
- data/doc/Files/ApiKeyNotFoundError.html +1 -1
- data/doc/Files/ApiKeyOnlyForDesktopAppError.html +1 -1
- data/doc/Files/ApiKeyOnlyForFileOperationsError.html +1 -1
- data/doc/Files/ApiKeyOnlyForMobileAppError.html +1 -1
- data/doc/Files/ApiKeyOnlyForOfficeIntegrationError.html +1 -1
- data/doc/Files/ApiKeySessionsNotSupportedError.html +1 -1
- data/doc/Files/ApiRequestLog.html +1 -1
- data/doc/Files/App.html +1 -1
- data/doc/Files/As2IncomingMessage.html +1 -1
- data/doc/Files/As2OutgoingMessage.html +1 -1
- data/doc/Files/As2Partner.html +1 -1
- data/doc/Files/As2Station.html +1 -1
- data/doc/Files/AttachmentTooLargeError.html +1 -1
- data/doc/Files/AuthenticationError.html +1 -1
- data/doc/Files/AuthenticationRequiredError.html +1 -1
- data/doc/Files/Auto.html +1 -1
- data/doc/Files/Automation.html +1 -1
- data/doc/Files/AutomationAuthoringSchema.html +1 -1
- data/doc/Files/AutomationCannotBeRunManuallyError.html +1 -1
- data/doc/Files/AutomationExecutionNode.html +1 -1
- data/doc/Files/AutomationLog.html +1 -1
- data/doc/Files/AutomationRun.html +1 -1
- data/doc/Files/AutomationsUnavailableError.html +1 -1
- data/doc/Files/BadRequestError.html +1 -1
- data/doc/Files/BandwidthSnapshot.html +1 -1
- data/doc/Files/Behavior.html +1 -1
- data/doc/Files/BehaviorNotAllowedOnRemoteServerError.html +1 -1
- data/doc/Files/BillingInformationHiddenError.html +1 -1
- data/doc/Files/BillingPermissionRequiredError.html +1 -1
- data/doc/Files/BufferedUploadDisabledForThisDestinationError.html +1 -1
- data/doc/Files/Bundle.html +1 -1
- data/doc/Files/BundleAction.html +1 -1
- data/doc/Files/BundleDownload.html +1 -1
- data/doc/Files/BundleMaximumUsesReachedError.html +1 -1
- data/doc/Files/BundleNotification.html +1 -1
- data/doc/Files/BundleOnlyAllowsPreviewsError.html +1 -1
- data/doc/Files/BundleOperationRequiresSubfolderError.html +1 -1
- data/doc/Files/BundlePath.html +1 -1
- data/doc/Files/BundlePathNotFoundError.html +1 -1
- data/doc/Files/BundlePermissionRequiredError.html +1 -1
- data/doc/Files/BundleRecipient.html +1 -1
- data/doc/Files/BundleRegistration.html +1 -1
- data/doc/Files/BundleRegistrationCodeFailedError.html +1 -1
- data/doc/Files/BundleRegistrationNotFoundError.html +1 -1
- data/doc/Files/CannotAdministerHigherLevelUserError.html +1 -1
- data/doc/Files/CannotDownloadDirectoryError.html +1 -1
- data/doc/Files/CannotLoginWhileUsingKeyError.html +1 -1
- data/doc/Files/CantActForOtherUserError.html +1 -1
- data/doc/Files/CantMoveWithMultipleLocationsError.html +1 -1
- data/doc/Files/ChatMessage.html +1 -1
- data/doc/Files/ChatSession.html +1 -1
- data/doc/Files/ChildSiteManagementPolicy.html +1 -1
- data/doc/Files/Clickwrap.html +1 -1
- data/doc/Files/CodeNotFoundError.html +1 -1
- data/doc/Files/ConfigurationLockedPathError.html +1 -1
- data/doc/Files/ContactAdminForPasswordChangeHelpError.html +1 -1
- data/doc/Files/CouldNotCreateParentError.html +1 -1
- data/doc/Files/CustomDomain.html +1 -1
- data/doc/Files/DatetimeParseError.html +1 -1
- data/doc/Files/DesktopConfigurationProfile.html +1 -1
- data/doc/Files/DestinationExistsError.html +1 -1
- data/doc/Files/DestinationFolderLimitedError.html +1 -1
- data/doc/Files/DestinationParentConflictError.html +1 -1
- data/doc/Files/DestinationParentDoesNotExistError.html +1 -1
- data/doc/Files/DestinationSameError.html +1 -1
- data/doc/Files/DestinationSiteMismatchError.html +1 -1
- data/doc/Files/DirectConnectionInfo.html +1 -1
- data/doc/Files/DnsRecord.html +1 -1
- data/doc/Files/DoesNotSupportSortingError.html +1 -1
- data/doc/Files/DuplicateShareRecipientError.html +1 -1
- data/doc/Files/EmailIncomingMessage.html +1 -1
- data/doc/Files/EmailLog.html +1 -1
- data/doc/Files/Error.html +1 -1
- data/doc/Files/Errors.html +1 -1
- data/doc/Files/EventChannel.html +1 -1
- data/doc/Files/EventDeliveryAttempt.html +1 -1
- data/doc/Files/EventRecord.html +2 -2
- data/doc/Files/EventSubscription.html +5 -5
- data/doc/Files/EventTarget.html +1 -1
- data/doc/Files/ExavaultApiRequestLog.html +1 -1
- data/doc/Files/ExceededRuntimeLimitError.html +1 -1
- data/doc/Files/Expectation.html +1 -1
- data/doc/Files/ExpectationAlreadyHasOpenWindowError.html +1 -1
- data/doc/Files/ExpectationEvaluation.html +1 -1
- data/doc/Files/ExpectationIncident.html +1 -1
- data/doc/Files/ExpectationNotManualTriggerError.html +1 -1
- data/doc/Files/ExpiredPrivateKeyError.html +1 -1
- data/doc/Files/ExpiredPublicKeyError.html +1 -1
- data/doc/Files/ExportFailureError.html +1 -1
- data/doc/Files/ExportNotReadyError.html +1 -1
- data/doc/Files/ExternalEvent.html +268 -96
- data/doc/Files/FailedToChangePasswordError.html +1 -1
- data/doc/Files/File.html +1 -1
- data/doc/Files/FileAction.html +1 -1
- data/doc/Files/FileActionError.html +1 -1
- data/doc/Files/FileComment.html +1 -1
- data/doc/Files/FileCommentReaction.html +1 -1
- data/doc/Files/FileLockedError.html +1 -1
- data/doc/Files/FileMigration.html +1 -1
- data/doc/Files/FileMigrationLog.html +1 -1
- data/doc/Files/FileNotFoundError.html +1 -1
- data/doc/Files/FileNotUploadedError.html +1 -1
- data/doc/Files/FilePendingProcessingError.html +1 -1
- data/doc/Files/FileProcessingErrorError.html +1 -1
- data/doc/Files/FileTooBigToDecryptError.html +1 -1
- data/doc/Files/FileTooBigToEncryptError.html +1 -1
- data/doc/Files/FileUploadNotFoundError.html +1 -1
- data/doc/Files/FileUploadPart.html +1 -1
- data/doc/Files/FileUploadedToWrongRegionError.html +1 -1
- data/doc/Files/FileUtils.html +1 -1
- data/doc/Files/FilenameTooLongError.html +1 -1
- data/doc/Files/FilesAgentFailedAuthorizationError.html +1 -1
- data/doc/Files/Folder.html +1 -1
- data/doc/Files/FolderAdminOrBillingPermissionRequiredError.html +1 -1
- data/doc/Files/FolderAdminPermissionRequiredError.html +1 -1
- data/doc/Files/FolderLockedError.html +1 -1
- data/doc/Files/FolderMustNotBeAFileError.html +1 -1
- data/doc/Files/FolderNotEmptyError.html +1 -1
- data/doc/Files/FoldersNotAllowedError.html +1 -1
- data/doc/Files/FormField.html +1 -1
- data/doc/Files/FormFieldSet.html +1 -1
- data/doc/Files/FtpActionLog.html +1 -1
- data/doc/Files/FullPermissionRequiredError.html +1 -1
- data/doc/Files/GpgKey.html +1 -1
- data/doc/Files/Group.html +1 -1
- data/doc/Files/GroupNotFoundError.html +1 -1
- data/doc/Files/GroupUser.html +1 -1
- data/doc/Files/History.html +1 -1
- data/doc/Files/HistoryExport.html +1 -1
- data/doc/Files/HistoryExportResult.html +1 -1
- data/doc/Files/HistoryPermissionRequiredError.html +1 -1
- data/doc/Files/HistoryUnavailableError.html +1 -1
- data/doc/Files/HolidayCalendar.html +1 -1
- data/doc/Files/HolidayRegion.html +1 -1
- data/doc/Files/Image.html +1 -1
- data/doc/Files/InAppAiAssistantUnavailableError.html +1 -1
- data/doc/Files/InboundS3Log.html +1 -1
- data/doc/Files/InboxNotFoundError.html +1 -1
- data/doc/Files/InboxRecipient.html +1 -1
- data/doc/Files/InboxRegistration.html +1 -1
- data/doc/Files/InboxRegistrationCodeFailedError.html +1 -1
- data/doc/Files/InboxUpload.html +1 -1
- data/doc/Files/InsufficientPermissionForParamsError.html +1 -1
- data/doc/Files/InsufficientPermissionForSiteError.html +1 -1
- data/doc/Files/IntegrationCentricProfile.html +1 -1
- data/doc/Files/InternalGeneralErrorError.html +1 -1
- data/doc/Files/InvalidBodyError.html +1 -1
- data/doc/Files/InvalidBundleCodeError.html +1 -1
- data/doc/Files/InvalidCredentialsError.html +1 -1
- data/doc/Files/InvalidCursorError.html +1 -1
- data/doc/Files/InvalidCursorTypeForSortError.html +1 -1
- data/doc/Files/InvalidEtagsError.html +1 -1
- data/doc/Files/InvalidFileTypeError.html +1 -1
- data/doc/Files/InvalidFilenameError.html +1 -1
- data/doc/Files/InvalidFilterAliasCombinationError.html +1 -1
- data/doc/Files/InvalidFilterFieldError.html +1 -1
- data/doc/Files/InvalidFilterParamError.html +1 -1
- data/doc/Files/InvalidFilterParamFormatError.html +1 -1
- data/doc/Files/InvalidFilterParamValueError.html +1 -1
- data/doc/Files/InvalidInputEncodingError.html +1 -1
- data/doc/Files/InvalidInterfaceError.html +1 -1
- data/doc/Files/InvalidOauthError.html +1 -1
- data/doc/Files/InvalidOauthProviderError.html +1 -1
- data/doc/Files/InvalidOrExpiredCodeError.html +1 -1
- data/doc/Files/InvalidParameterError.html +1 -1
- data/doc/Files/InvalidPathError.html +1 -1
- data/doc/Files/InvalidPriorityColorError.html +1 -1
- data/doc/Files/InvalidRangeError.html +1 -1
- data/doc/Files/InvalidReturnToUrlError.html +1 -1
- data/doc/Files/InvalidSearchQueryError.html +1 -1
- data/doc/Files/InvalidSessionError.html +1 -1
- data/doc/Files/InvalidSiteError.html +1 -1
- data/doc/Files/InvalidSortFieldError.html +1 -1
- data/doc/Files/InvalidSortFilterCombinationError.html +1 -1
- data/doc/Files/InvalidUploadOffsetError.html +1 -1
- data/doc/Files/InvalidUploadPartGapError.html +1 -1
- data/doc/Files/InvalidUploadPartSizeError.html +1 -1
- data/doc/Files/InvalidUsernameOrPasswordError.html +1 -1
- data/doc/Files/InvalidWorkspaceIdHeaderError.html +1 -1
- data/doc/Files/InvalidZipFileError.html +1 -1
- data/doc/Files/Invoice.html +1 -1
- data/doc/Files/InvoiceLineItem.html +1 -1
- data/doc/Files/IpAddress.html +1 -1
- data/doc/Files/KeyLifecycleRule.html +1 -1
- data/doc/Files/List.html +1 -1
- data/doc/Files/Lock.html +1 -1
- data/doc/Files/LockOperationBusyError.html +1 -1
- data/doc/Files/LockedOutError.html +1 -1
- data/doc/Files/LockoutRegionMismatchError.html +1 -1
- data/doc/Files/MetadataCategory.html +1 -1
- data/doc/Files/MetadataNotSupportedOnRemotesError.html +1 -1
- data/doc/Files/MethodNotAllowedError.html +1 -1
- data/doc/Files/MigrationInProgressError.html +1 -1
- data/doc/Files/MissingParameterError.html +1 -1
- data/doc/Files/ModelSaveErrorError.html +1 -1
- data/doc/Files/MoverAccessDeniedError.html +1 -1
- data/doc/Files/MoverPackageRequiredError.html +1 -1
- data/doc/Files/MultipleProcessingErrorsError.html +1 -1
- data/doc/Files/MultipleSortParamsNotAllowedError.html +1 -1
- data/doc/Files/MustAuthenticateWithApiKeyError.html +1 -1
- data/doc/Files/NeedAdminPermissionForInboxError.html +1 -1
- data/doc/Files/NestedNotFoundError.html +1 -1
- data/doc/Files/NoAccountForSiteError.html +1 -1
- data/doc/Files/NoValidInputParamsError.html +1 -1
- data/doc/Files/NonAdminsMustQueryByFolderOrPathError.html +1 -1
- data/doc/Files/NotAllowedToCreateBundleError.html +1 -1
- data/doc/Files/NotAuthenticatedError.html +1 -1
- data/doc/Files/NotAuthorizedError.html +1 -1
- data/doc/Files/NotEnqueuableSyncError.html +1 -1
- data/doc/Files/NotFoundError.html +1 -1
- data/doc/Files/NotImplementedError.html +1 -1
- data/doc/Files/Notification.html +1 -1
- data/doc/Files/OffsetUploadNotAllowedWithMalwareScanningError.html +1 -1
- data/doc/Files/OneTimePasswordIncorrectError.html +1 -1
- data/doc/Files/OutboundConnectionLog.html +1 -1
- data/doc/Files/PartNumberTooLargeError.html +1 -1
- data/doc/Files/Partner.html +1 -1
- data/doc/Files/PartnerChannel.html +1 -1
- data/doc/Files/PartnerChannelTemplate.html +1 -1
- data/doc/Files/PartnerConnection.html +1 -1
- data/doc/Files/PartnerSite.html +1 -1
- data/doc/Files/PartnerSiteRequest.html +1 -1
- data/doc/Files/PasswordChangeNotRequiredError.html +1 -1
- data/doc/Files/PasswordChangeRequiredError.html +1 -1
- data/doc/Files/PathCannotHaveTrailingWhitespaceError.html +1 -1
- data/doc/Files/PathTooLongError.html +1 -1
- data/doc/Files/PathUtil.html +1 -1
- data/doc/Files/Payment.html +1 -1
- data/doc/Files/PaymentLineItem.html +1 -1
- data/doc/Files/PaymentMethodErrorError.html +1 -1
- data/doc/Files/PendingWorkEvent.html +1 -1
- data/doc/Files/Permission.html +1 -1
- data/doc/Files/PlanNotFoundError.html +1 -1
- data/doc/Files/Preview.html +1 -1
- data/doc/Files/PreviewOnlyPermissionCannotDownloadError.html +1 -1
- data/doc/Files/ProcessingFailureError.html +1 -1
- data/doc/Files/PublicHostingRequestLog.html +1 -1
- data/doc/Files/PublicIpAddress.html +1 -1
- data/doc/Files/PublicKey.html +1 -1
- data/doc/Files/RateLimitedError.html +1 -1
- data/doc/Files/ReadOnlySessionError.html +1 -1
- data/doc/Files/ReadPermissionRequiredError.html +1 -1
- data/doc/Files/ReauthenticationFailedError.html +1 -1
- data/doc/Files/ReauthenticationFailedFinalError.html +1 -1
- data/doc/Files/ReauthenticationNeededActionError.html +1 -1
- data/doc/Files/ReauthenticationNeededFieldsError.html +1 -1
- data/doc/Files/ReauthenticationRateLimitedError.html +1 -1
- data/doc/Files/RecaptchaFailedError.html +1 -1
- data/doc/Files/RecipientAlreadySharedError.html +1 -1
- data/doc/Files/RemoteBandwidthSnapshot.html +1 -1
- data/doc/Files/RemoteDesktopDebugLoggingDisabledError.html +1 -1
- data/doc/Files/RemoteEntryReadOnlyError.html +1 -1
- data/doc/Files/RemoteMountBackend.html +1 -1
- data/doc/Files/RemoteServer.html +1312 -929
- data/doc/Files/RemoteServerConfigurationFile.html +1 -1
- data/doc/Files/RemoteServerCredential.html +1 -1
- data/doc/Files/RemoteServerErrorError.html +1 -1
- data/doc/Files/Request.html +1 -1
- data/doc/Files/RequestBodyTooLargeError.html +1 -1
- data/doc/Files/RequestParamsContainInvalidCharacterError.html +1 -1
- data/doc/Files/RequestParamsInvalidError.html +1 -1
- data/doc/Files/RequestParamsRequiredError.html +1 -1
- data/doc/Files/ResourceBelongsToParentSiteError.html +1 -1
- data/doc/Files/ResourceLockedError.html +1 -1
- data/doc/Files/Response.html +1 -1
- data/doc/Files/Restore.html +1 -1
- data/doc/Files/RootFolderBehaviorSiteAdminRequiredError.html +1 -1
- data/doc/Files/RootFolderBehaviorSkipSiteAdminRequiredError.html +1 -1
- data/doc/Files/Schedule.html +1 -1
- data/doc/Files/ScheduledExport.html +1 -1
- data/doc/Files/ScimLog.html +1 -1
- data/doc/Files/SearchAllOnChildPathError.html +1 -1
- data/doc/Files/SearchUnavailableError.html +1 -1
- data/doc/Files/Secret.html +1 -1
- data/doc/Files/SelfManagedRequiredError.html +1 -1
- data/doc/Files/ServiceUnavailableError.html +1 -1
- data/doc/Files/Session.html +1 -1
- data/doc/Files/SettingsChange.html +1 -1
- data/doc/Files/SftpActionLog.html +1 -1
- data/doc/Files/SftpHostKey.html +1 -1
- data/doc/Files/ShareGroup.html +1 -1
- data/doc/Files/ShareGroupMember.html +1 -1
- data/doc/Files/SiemHttpDestination.html +1 -1
- data/doc/Files/SiemHttpDestinationEvent.html +1 -1
- data/doc/Files/Site.html +2480 -3779
- data/doc/Files/SiteAdminOrPartnerAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminOrWorkspaceAdminOrFolderAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminOrWorkspaceAdminOrPartnerAdminOrFolderAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminOrWorkspaceAdminOrPartnerAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminOrWorkspaceAdminPermissionRequiredError.html +1 -1
- data/doc/Files/SiteAdminRequiredError.html +1 -1
- data/doc/Files/SiteConfigurationError.html +1 -1
- data/doc/Files/SiteDisabledError.html +1 -1
- data/doc/Files/SiteFilesAreImmutableError.html +1 -1
- data/doc/Files/SiteNotFoundError.html +1 -1
- data/doc/Files/SiteSubdomainRedirect.html +1 -1
- data/doc/Files/SiteWasRemovedError.html +1 -1
- data/doc/Files/SizableIO.html +1 -1
- data/doc/Files/Snapshot.html +1 -1
- data/doc/Files/SsoEvent.html +1 -1
- data/doc/Files/SsoStrategy.html +1 -1
- data/doc/Files/Status.html +1 -1
- data/doc/Files/Style.html +1 -1
- data/doc/Files/SubfolderLockedError.html +1 -1
- data/doc/Files/Sync.html +1 -1
- data/doc/Files/SyncInProgressError.html +1 -1
- data/doc/Files/SyncLog.html +1 -1
- data/doc/Files/SyncRun.html +1 -1
- data/doc/Files/SyncRunLiveTransfer.html +1 -1
- data/doc/Files/SystemProfiler.html +1 -1
- data/doc/Files/TooManyConcurrentLoginsError.html +1 -1
- data/doc/Files/TooManyConcurrentRequestsError.html +1 -1
- data/doc/Files/TooManyLoginAttemptsError.html +1 -1
- data/doc/Files/TooManyRequestsError.html +1 -1
- data/doc/Files/TooManySharesError.html +1 -1
- data/doc/Files/TrialExpiredError.html +1 -1
- data/doc/Files/TrialLockedError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationCodeAlreadySentError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationCountryBlacklistedError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationErrorError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationGeneralErrorError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationMethodUnsupportedErrorError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationRequiredError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationSetupExpiredError.html +1 -1
- data/doc/Files/TwoFactorAuthenticationUnsubscribedRecipientError.html +1 -1
- data/doc/Files/URI.html +1 -1
- data/doc/Files/UnrecognizedSortIndexError.html +1 -1
- data/doc/Files/UnsupportedCurrencyError.html +1 -1
- data/doc/Files/UnsupportedHttpResponseFormatError.html +1 -1
- data/doc/Files/UnsupportedMediaTypeError.html +1 -1
- data/doc/Files/UpdatesNotAllowedForRemotesError.html +1 -1
- data/doc/Files/UploadsUnavailableError.html +1 -1
- data/doc/Files/UsageByTopLevelDir.html +1 -1
- data/doc/Files/UsageDailySnapshot.html +1 -1
- data/doc/Files/UsageSnapshot.html +1 -1
- data/doc/Files/User.html +1 -1
- data/doc/Files/UserAdditionalEmailRecipient.html +1 -1
- data/doc/Files/UserCipherUse.html +1 -1
- data/doc/Files/UserIdInvalidError.html +1 -1
- data/doc/Files/UserIdOnUserEndpointError.html +1 -1
- data/doc/Files/UserIdWithoutSiteAdminError.html +1 -1
- data/doc/Files/UserLifecycleRule.html +1 -1
- data/doc/Files/UserNotFoundError.html +1 -1
- data/doc/Files/UserRequest.html +1 -1
- data/doc/Files/UserRequestsEnabledRequiredError.html +1 -1
- data/doc/Files/UserRequiredError.html +1 -1
- data/doc/Files/UserSecurityEvent.html +1 -1
- data/doc/Files/UserSftpClientUse.html +1 -1
- data/doc/Files/Util/LogSettings.html +1 -1
- data/doc/Files/Util.html +1 -1
- data/doc/Files/WebDavActionLog.html +1 -1
- data/doc/Files/WebhookTest.html +1 -1
- data/doc/Files/Workspace.html +1 -1
- data/doc/Files/WriteAndBundlePermissionRequiredError.html +1 -1
- data/doc/Files/WritePermissionRequiredError.html +1 -1
- data/doc/Files/ZipListEntry.html +1 -1
- data/doc/Files.html +1 -1
- data/doc/_index.html +1 -1
- data/doc/file.README.html +1 -1
- data/doc/index.html +1 -1
- data/doc/method_list.html +244 -308
- data/doc/top-level-namespace.html +1 -1
- data/docs/event_record.md +1 -1
- data/docs/event_subscription.md +4 -4
- data/docs/external_event.md +4 -2
- data/docs/remote_server.md +12 -1
- data/docs/site.md +10 -70
- data/lib/files.com/models/event_record.rb +1 -1
- data/lib/files.com/models/event_subscription.rb +4 -4
- data/lib/files.com/models/external_event.rb +15 -2
- data/lib/files.com/models/remote_server.rb +45 -13
- data/lib/files.com/models/site.rb +22 -140
- metadata +1 -1
|
@@ -102,7 +102,7 @@
|
|
|
102
102
|
</div>
|
|
103
103
|
|
|
104
104
|
<div id="footer">
|
|
105
|
-
Generated on
|
|
105
|
+
Generated on Sun Nov 1 19:03:12 2026 by
|
|
106
106
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
107
107
|
0.9.45 (ruby-4.0.9).
|
|
108
108
|
</div>
|
data/docs/event_record.md
CHANGED
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
* `id` (int64): Event Record ID
|
|
30
30
|
* `workspace_id` (int64): Workspace ID. 0 means the default workspace or site-wide.
|
|
31
31
|
* `event_uuid` (string): Stable event UUID.
|
|
32
|
-
* `event_type` (string): Versioned event type string. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
32
|
+
* `event_type` (string): Versioned event type string. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `malware_scan_log.quarantined.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
33
33
|
* `severity` (string): Event severity.
|
|
34
34
|
* `source_type` (string): Source record type.
|
|
35
35
|
* `source_id` (int64): Source record ID.
|
data/docs/event_subscription.md
CHANGED
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
* `message` (string): Custom message to include in notification emails.
|
|
49
49
|
* `message_only` (boolean): If true, notification email bodies contain only the custom message, omitting event details and the review button. Requires a custom message, defaults to false, and does not affect non-email targets.
|
|
50
50
|
* `enabled` (boolean): Whether this Event Subscription can dispatch events.
|
|
51
|
-
* `event_types` (array(string)): Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
51
|
+
* `event_types` (array(string)): Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `malware_scan_log.quarantined.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
52
52
|
* `filter` (object): Conditions on event fields that an event must meet to be delivered, keyed by dot-notation field path. All conditions must match.
|
|
53
53
|
* `delivery_policy` (object): Event Subscription delivery policy. Overrides retry settings from each Event Target's delivery policy.
|
|
54
54
|
* `event_target_ids` (array(int64)): Event Target IDs this subscription sends to.
|
|
@@ -116,7 +116,7 @@ Files::EventSubscription.create(
|
|
|
116
116
|
* `message` (string): Custom message to include in notification emails.
|
|
117
117
|
* `message_only` (boolean): If true, notification email bodies contain only the custom message, omitting event details and the review button. Requires a custom message, defaults to false, and does not affect non-email targets.
|
|
118
118
|
* `enabled` (boolean): Whether this Event Subscription can dispatch events.
|
|
119
|
-
* `event_types` (array(string)): Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
119
|
+
* `event_types` (array(string)): Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `malware_scan_log.quarantined.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
120
120
|
* `filter` (object): Conditions on event fields that an event must meet to be delivered, keyed by dot-notation field path. All conditions must match.
|
|
121
121
|
* `delivery_policy` (object): Event Subscription delivery policy. Overrides retry settings from each Event Target's delivery policy.
|
|
122
122
|
* `event_target_ids` (array(int64)): Event Target IDs this subscription sends to.
|
|
@@ -154,7 +154,7 @@ Files::EventSubscription.update(id,
|
|
|
154
154
|
* `message` (string): Custom message to include in notification emails.
|
|
155
155
|
* `message_only` (boolean): If true, notification email bodies contain only the custom message, omitting event details and the review button. Requires a custom message, defaults to false, and does not affect non-email targets.
|
|
156
156
|
* `enabled` (boolean): Whether this Event Subscription can dispatch events.
|
|
157
|
-
* `event_types` (array(string)): Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
157
|
+
* `event_types` (array(string)): Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `malware_scan_log.quarantined.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
158
158
|
* `filter` (object): Conditions on event fields that an event must meet to be delivered, keyed by dot-notation field path. All conditions must match.
|
|
159
159
|
* `delivery_policy` (object): Event Subscription delivery policy. Overrides retry settings from each Event Target's delivery policy.
|
|
160
160
|
* `event_target_ids` (array(int64)): Event Target IDs this subscription sends to.
|
|
@@ -207,7 +207,7 @@ event_subscription.update(
|
|
|
207
207
|
* `message` (string): Custom message to include in notification emails.
|
|
208
208
|
* `message_only` (boolean): If true, notification email bodies contain only the custom message, omitting event details and the review button. Requires a custom message, defaults to false, and does not affect non-email targets.
|
|
209
209
|
* `enabled` (boolean): Whether this Event Subscription can dispatch events.
|
|
210
|
-
* `event_types` (array(string)): Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
210
|
+
* `event_types` (array(string)): Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `malware_scan_log.quarantined.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
211
211
|
* `filter` (object): Conditions on event fields that an event must meet to be delivered, keyed by dot-notation field path. All conditions must match.
|
|
212
212
|
* `delivery_policy` (object): Event Subscription delivery policy. Overrides retry settings from each Event Target's delivery policy.
|
|
213
213
|
* `event_target_ids` (array(int64)): Event Target IDs this subscription sends to.
|
data/docs/external_event.md
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
```
|
|
6
6
|
{
|
|
7
7
|
"id": 1,
|
|
8
|
+
"workspace_id": 1,
|
|
8
9
|
"event_type": "example",
|
|
9
10
|
"status": "example",
|
|
10
11
|
"body": "example",
|
|
@@ -14,6 +15,7 @@
|
|
|
14
15
|
```
|
|
15
16
|
|
|
16
17
|
* `id` (int64): Event ID
|
|
18
|
+
* `workspace_id` (int64): Workspace ID
|
|
17
19
|
* `event_type` (string): Type of event being recorded.
|
|
18
20
|
* `status` (string): Status of event.
|
|
19
21
|
* `body` (string): Event body
|
|
@@ -33,8 +35,8 @@ Files::ExternalEvent.list
|
|
|
33
35
|
|
|
34
36
|
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
35
37
|
* `per_page` (int64): Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
36
|
-
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `status` or `
|
|
37
|
-
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`
|
|
38
|
+
* `sort_by` (object): If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `status`, `event_type` or `workspace_id`.
|
|
39
|
+
* `filter` (object): If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `status` or `workspace_id`. Valid field combinations are `[ status, created_at ]`.
|
|
38
40
|
* `filter_gt` (object): If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
39
41
|
* `filter_gteq` (object): If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
40
42
|
* `filter_lt` (object): If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
data/docs/remote_server.md
CHANGED
|
@@ -29,6 +29,9 @@
|
|
|
29
29
|
"server_certificate": "require_match",
|
|
30
30
|
"server_host_key": "[public key]",
|
|
31
31
|
"server_type": "s3",
|
|
32
|
+
"site_admin_access": true,
|
|
33
|
+
"effective_site_admin_access": true,
|
|
34
|
+
"user_id": 1,
|
|
32
35
|
"workspace_id": 1,
|
|
33
36
|
"ssl": "if_available",
|
|
34
37
|
"username": "user",
|
|
@@ -115,6 +118,9 @@
|
|
|
115
118
|
* `server_certificate` (string): Remote server certificate
|
|
116
119
|
* `server_host_key` (string): Pinned SSH host key or OpenSSH host certificate for SFTP. If omitted, Files.com detects and stores a host key, preferring plain keys over certificates. With `server_certificate=require_match` (the default), the server must present the exact pinned key or certificate and prove it holds the matching private key. A pinned certificate is compared in full, so renewal can require updating `server_host_key` even when its underlying key is unchanged. Files.com does not check certificate CA signatures, principals, or validity periods. Certificate expiration alone does not end the pin. Update `server_host_key` to replace the pin.
|
|
117
120
|
* `server_type` (string): Remote server type.
|
|
121
|
+
* `site_admin_access` (boolean): Owner's preference for administrator access to this user-owned Remote Server. Null uses the Site policy's default. Only the owner may change it when the Site policy allows user choice.
|
|
122
|
+
* `effective_site_admin_access` (boolean): Whether Site and Workspace Administrators can access this Remote Server under the current Site policy.
|
|
123
|
+
* `user_id` (int64): ID of the user who owns this Remote Server, if any.
|
|
118
124
|
* `workspace_id` (int64): Workspace ID (0 for default workspace)
|
|
119
125
|
* `ssl` (string): Should we require SSL?
|
|
120
126
|
* `username` (string): Remote server username.
|
|
@@ -170,7 +176,6 @@
|
|
|
170
176
|
* `linode_access_key` (string): Linode: Access Key
|
|
171
177
|
* `linode_region` (string): Linode: region
|
|
172
178
|
* `supports_versioning` (boolean): If true, this remote server supports file versioning. This value is determined automatically by Files.com.
|
|
173
|
-
* `user_id` (int64): User ID. Provide a value of `0` to operate the current session's user.
|
|
174
179
|
* `password` (string): Password, if needed.
|
|
175
180
|
* `private_key` (string): Private key, if needed.
|
|
176
181
|
* `private_key_passphrase` (string): Passphrase for private key if needed.
|
|
@@ -316,6 +321,7 @@ Files::RemoteServer.create(
|
|
|
316
321
|
server_certificate: "require_match",
|
|
317
322
|
server_host_key: "[public key]",
|
|
318
323
|
server_type: "s3",
|
|
324
|
+
site_admin_access: true,
|
|
319
325
|
sharepoint_client_id: "00000000-0000-0000-0000-000000000000",
|
|
320
326
|
sharepoint_site_url: "https://example.sharepoint.com/sites/accounting",
|
|
321
327
|
sharepoint_tenant_id: "00000000-0000-0000-0000-000000000000",
|
|
@@ -407,6 +413,7 @@ Files::RemoteServer.create(
|
|
|
407
413
|
* `server_certificate` (string): Remote server certificate
|
|
408
414
|
* `server_host_key` (string): Pinned SSH host key or OpenSSH host certificate for SFTP. If omitted, Files.com detects and stores a host key, preferring plain keys over certificates. With `server_certificate=require_match` (the default), the server must present the exact pinned key or certificate and prove it holds the matching private key. A pinned certificate is compared in full, so renewal can require updating `server_host_key` even when its underlying key is unchanged. Files.com does not check certificate CA signatures, principals, or validity periods. Certificate expiration alone does not end the pin. Update `server_host_key` to replace the pin.
|
|
409
415
|
* `server_type` (string): Remote server type.
|
|
416
|
+
* `site_admin_access` (boolean): Owner's preference for administrator access to this user-owned Remote Server. Null uses the Site policy's default. Only the owner may change it when the Site policy allows user choice.
|
|
410
417
|
* `sharepoint_client_id` (string): SharePoint: Microsoft Entra application client ID for app-only authentication.
|
|
411
418
|
* `sharepoint_site_url` (string): SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
|
|
412
419
|
* `sharepoint_tenant_id` (string): SharePoint: Microsoft Entra tenant ID for app-only authentication.
|
|
@@ -492,6 +499,7 @@ Files::RemoteServer.update(id,
|
|
|
492
499
|
server_certificate: "require_match",
|
|
493
500
|
server_host_key: "[public key]",
|
|
494
501
|
server_type: "s3",
|
|
502
|
+
site_admin_access: true,
|
|
495
503
|
sharepoint_client_id: "00000000-0000-0000-0000-000000000000",
|
|
496
504
|
sharepoint_site_url: "https://example.sharepoint.com/sites/accounting",
|
|
497
505
|
sharepoint_tenant_id: "00000000-0000-0000-0000-000000000000",
|
|
@@ -582,6 +590,7 @@ Files::RemoteServer.update(id,
|
|
|
582
590
|
* `server_certificate` (string): Remote server certificate
|
|
583
591
|
* `server_host_key` (string): Pinned SSH host key or OpenSSH host certificate for SFTP. If omitted, Files.com detects and stores a host key, preferring plain keys over certificates. With `server_certificate=require_match` (the default), the server must present the exact pinned key or certificate and prove it holds the matching private key. A pinned certificate is compared in full, so renewal can require updating `server_host_key` even when its underlying key is unchanged. Files.com does not check certificate CA signatures, principals, or validity periods. Certificate expiration alone does not end the pin. Update `server_host_key` to replace the pin.
|
|
584
592
|
* `server_type` (string): Remote server type.
|
|
593
|
+
* `site_admin_access` (boolean): Owner's preference for administrator access to this user-owned Remote Server. Null uses the Site policy's default. Only the owner may change it when the Site policy allows user choice.
|
|
585
594
|
* `sharepoint_client_id` (string): SharePoint: Microsoft Entra application client ID for app-only authentication.
|
|
586
595
|
* `sharepoint_site_url` (string): SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
|
|
587
596
|
* `sharepoint_tenant_id` (string): SharePoint: Microsoft Entra tenant ID for app-only authentication.
|
|
@@ -698,6 +707,7 @@ remote_server.update(
|
|
|
698
707
|
server_certificate: "require_match",
|
|
699
708
|
server_host_key: "[public key]",
|
|
700
709
|
server_type: "s3",
|
|
710
|
+
site_admin_access: true,
|
|
701
711
|
sharepoint_client_id: "00000000-0000-0000-0000-000000000000",
|
|
702
712
|
sharepoint_site_url: "https://example.sharepoint.com/sites/accounting",
|
|
703
713
|
sharepoint_tenant_id: "00000000-0000-0000-0000-000000000000",
|
|
@@ -788,6 +798,7 @@ remote_server.update(
|
|
|
788
798
|
* `server_certificate` (string): Remote server certificate
|
|
789
799
|
* `server_host_key` (string): Pinned SSH host key or OpenSSH host certificate for SFTP. If omitted, Files.com detects and stores a host key, preferring plain keys over certificates. With `server_certificate=require_match` (the default), the server must present the exact pinned key or certificate and prove it holds the matching private key. A pinned certificate is compared in full, so renewal can require updating `server_host_key` even when its underlying key is unchanged. Files.com does not check certificate CA signatures, principals, or validity periods. Certificate expiration alone does not end the pin. Update `server_host_key` to replace the pin.
|
|
790
800
|
* `server_type` (string): Remote server type.
|
|
801
|
+
* `site_admin_access` (boolean): Owner's preference for administrator access to this user-owned Remote Server. Null uses the Site policy's default. Only the owner may change it when the Site policy allows user choice.
|
|
791
802
|
* `sharepoint_client_id` (string): SharePoint: Microsoft Entra application client ID for app-only authentication.
|
|
792
803
|
* `sharepoint_site_url` (string): SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
|
|
793
804
|
* `sharepoint_tenant_id` (string): SharePoint: Microsoft Entra tenant ID for app-only authentication.
|
data/docs/site.md
CHANGED
|
@@ -87,6 +87,8 @@
|
|
|
87
87
|
"desktop_app_session_ip_pinning": true,
|
|
88
88
|
"desktop_app_session_lifetime": 1,
|
|
89
89
|
"legacy_checksums_mode": true,
|
|
90
|
+
"legacy_pairing_enabled": true,
|
|
91
|
+
"last_pairing_at": "2000-01-01T01:00:00Z",
|
|
90
92
|
"migrate_remote_server_sync_to_sync": true,
|
|
91
93
|
"mcp_dcr_enabled": true,
|
|
92
94
|
"mobile_app": true,
|
|
@@ -135,25 +137,9 @@
|
|
|
135
137
|
"uri": "https://mysite.files.com/.../my_image.png"
|
|
136
138
|
},
|
|
137
139
|
"immutable_files_set_at": "2000-01-01T01:00:00Z",
|
|
140
|
+
"integration_centric_remote_server_admin_access": "example",
|
|
138
141
|
"include_password_in_welcome_email": true,
|
|
139
142
|
"language": "en",
|
|
140
|
-
"ldap_base_dn": "example",
|
|
141
|
-
"ldap_domain": "mysite.com",
|
|
142
|
-
"ldap_enabled": true,
|
|
143
|
-
"ldap_group_action": "disabled",
|
|
144
|
-
"ldap_group_exclusion": "example",
|
|
145
|
-
"ldap_group_inclusion": "example",
|
|
146
|
-
"ldap_host": "ldap.site.com",
|
|
147
|
-
"ldap_host_2": "ldap2.site.com",
|
|
148
|
-
"ldap_host_3": "ldap3.site.com",
|
|
149
|
-
"ldap_port": 1,
|
|
150
|
-
"ldap_secure": true,
|
|
151
|
-
"ldap_server_certificate": "require_match",
|
|
152
|
-
"ldap_type": "open_ldap",
|
|
153
|
-
"ldap_user_action": "disabled",
|
|
154
|
-
"ldap_user_include_groups": "example",
|
|
155
|
-
"ldap_username": "[ldap username]",
|
|
156
|
-
"ldap_username_field": "sAMAccountName",
|
|
157
143
|
"login_help_text": "Login page help text.",
|
|
158
144
|
"logo": {
|
|
159
145
|
"name": "My logo",
|
|
@@ -440,6 +426,8 @@
|
|
|
440
426
|
* `desktop_app_session_ip_pinning` (boolean): Is desktop app session IP pinning enabled?
|
|
441
427
|
* `desktop_app_session_lifetime` (int64): Desktop app session lifetime (in hours)
|
|
442
428
|
* `legacy_checksums_mode` (boolean): Use legacy checksums mode?
|
|
429
|
+
* `legacy_pairing_enabled` (boolean): Allow legacy app pairing in all workspaces? Disabled for new sites; existing sites remain enabled until changed. Disabling blocks new pairing exchanges without revoking existing app credentials or affecting OAuth sign-in. Site administrators can re-enable it.
|
|
430
|
+
* `last_pairing_at` (date-time): Time of the last completed legacy app pairing across all workspaces. Failed or incomplete attempts do not count. Read-only; empty until a pairing completes after tracking begins.
|
|
443
431
|
* `migrate_remote_server_sync_to_sync` (boolean): If true, we will migrate all remote server syncs to the new Sync model.
|
|
444
432
|
* `mcp_dcr_enabled` (boolean): Is OAuth DCR (dynamic client registration) for MCP enabled?
|
|
445
433
|
* `mobile_app` (boolean): Is the mobile app enabled?
|
|
@@ -476,25 +464,9 @@
|
|
|
476
464
|
* `icon32` (Image): Branded icon 32x32
|
|
477
465
|
* `icon48` (Image): Branded icon 48x48
|
|
478
466
|
* `immutable_files_set_at` (date-time): Can files be modified?
|
|
467
|
+
* `integration_centric_remote_server_admin_access` (string): Administrator access to user-owned Remote Servers in every Workspace: always_visible (default), never_visible, user_choice_default_visible, or user_choice_default_personal. Forced modes override owner preferences; choice modes use the preference or their default.
|
|
479
468
|
* `include_password_in_welcome_email` (boolean): Include password in emails to new users?
|
|
480
469
|
* `language` (string): Site default language
|
|
481
|
-
* `ldap_base_dn` (string): Base DN for looking up users in LDAP server
|
|
482
|
-
* `ldap_domain` (string): Domain name that will be appended to usernames
|
|
483
|
-
* `ldap_enabled` (boolean): Main LDAP setting: is LDAP enabled?
|
|
484
|
-
* `ldap_group_action` (string): Should we sync groups from LDAP server?
|
|
485
|
-
* `ldap_group_exclusion` (string): Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
|
|
486
|
-
* `ldap_group_inclusion` (string): Comma or newline separated list of group names (with optional wildcards) to include when syncing.
|
|
487
|
-
* `ldap_host` (string): LDAP host
|
|
488
|
-
* `ldap_host_2` (string): LDAP backup host
|
|
489
|
-
* `ldap_host_3` (string): LDAP backup host
|
|
490
|
-
* `ldap_port` (int64): LDAP port
|
|
491
|
-
* `ldap_secure` (boolean): Use secure LDAP?
|
|
492
|
-
* `ldap_server_certificate` (string): How to validate the LDAP server certificate. `require_match` validates the certificate chain and hostname; `allow_any` disables certificate validation.
|
|
493
|
-
* `ldap_type` (string): LDAP type
|
|
494
|
-
* `ldap_user_action` (string): Should we sync users from LDAP server?
|
|
495
|
-
* `ldap_user_include_groups` (string): Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced.
|
|
496
|
-
* `ldap_username` (string): Username for signing in to LDAP server.
|
|
497
|
-
* `ldap_username_field` (string): LDAP username field
|
|
498
470
|
* `login_help_text` (string): Login help text
|
|
499
471
|
* `logo` (Image): Branded logo
|
|
500
472
|
* `login_page_background_image` (Image): Branded login page background
|
|
@@ -655,7 +627,9 @@ Files::Site.update(
|
|
|
655
627
|
as2_message_retention_days: 1,
|
|
656
628
|
file_activity_events_enabled: false,
|
|
657
629
|
username_display: "username_only",
|
|
630
|
+
integration_centric_remote_server_admin_access: "example",
|
|
658
631
|
session_expiry_minutes: 1,
|
|
632
|
+
legacy_pairing_enabled: false,
|
|
659
633
|
ssl_required: false,
|
|
660
634
|
sftp_insecure_ciphers: false,
|
|
661
635
|
sftp_insecure_diffie_hellman: false,
|
|
@@ -764,23 +738,6 @@ Files::Site.update(
|
|
|
764
738
|
smtp_username: "mail",
|
|
765
739
|
smtp_port: 1,
|
|
766
740
|
smtp_ssl: "require",
|
|
767
|
-
ldap_enabled: false,
|
|
768
|
-
ldap_type: "open_ldap",
|
|
769
|
-
ldap_host: "ldap.site.com",
|
|
770
|
-
ldap_host_2: "ldap2.site.com",
|
|
771
|
-
ldap_host_3: "ldap3.site.com",
|
|
772
|
-
ldap_port: 1,
|
|
773
|
-
ldap_secure: false,
|
|
774
|
-
ldap_server_certificate: "require_match",
|
|
775
|
-
ldap_username: "[ldap username]",
|
|
776
|
-
ldap_username_field: "sAMAccountName",
|
|
777
|
-
ldap_domain: "mysite.com",
|
|
778
|
-
ldap_user_action: "disabled",
|
|
779
|
-
ldap_group_action: "disabled",
|
|
780
|
-
ldap_user_include_groups: "example",
|
|
781
|
-
ldap_group_exclusion: "example",
|
|
782
|
-
ldap_group_inclusion: "example",
|
|
783
|
-
ldap_base_dn: "example",
|
|
784
741
|
uploads_via_email_authentication: false,
|
|
785
742
|
bundle_watermark_value: {"gravity":"SouthWest","max_height_or_width":20,"transparency":25},
|
|
786
743
|
icon16_delete: false,
|
|
@@ -847,7 +804,9 @@ Files::Site.update(
|
|
|
847
804
|
* `as2_message_retention_days` (int64): Number of days to retain AS2 messages (incoming and outgoing).
|
|
848
805
|
* `file_activity_events_enabled` (boolean): If true, file operations produce file_action.activity.v1 EventChannel events in all workspaces. Defaults to false; subscription filters and workspace access still control delivery.
|
|
849
806
|
* `username_display` (string): How usernames are displayed in the web UI. Can be `username_only`, `full_name_only`, `full_name_username`, `full_name_company`, or `full_name_username_company`.
|
|
807
|
+
* `integration_centric_remote_server_admin_access` (string): Administrator access to user-owned Remote Servers in every Workspace: always_visible (default), never_visible, user_choice_default_visible, or user_choice_default_personal. Forced modes override owner preferences; choice modes use the preference or their default.
|
|
850
808
|
* `session_expiry_minutes` (int64): Session expiry in minutes
|
|
809
|
+
* `legacy_pairing_enabled` (boolean): Allow legacy app pairing in all workspaces? Disabled for new sites; existing sites remain enabled until changed. Disabling blocks new pairing exchanges without revoking existing app credentials or affecting OAuth sign-in. Site administrators can re-enable it.
|
|
851
810
|
* `ssl_required` (boolean): Is SSL required? Disabling this is insecure.
|
|
852
811
|
* `sftp_insecure_ciphers` (boolean): If true, we will allow weak and known insecure ciphers to be used for SFTP connections. Enabling this setting severely weakens the security of your site and it is not recommend, except as a last resort for compatibility.
|
|
853
812
|
* `sftp_insecure_diffie_hellman` (boolean): If true, we will allow weak Diffie Hellman parameters to be used within ciphers for SFTP that are otherwise on our secure list. This has the effect of making the cipher weaker than our normal threshold for security, but is required to support certain legacy or broken SSH and MFT clients. Enabling this weakens security, but not nearly as much as enabling the full `sftp_insecure_ciphers` option.
|
|
@@ -956,23 +915,6 @@ Files::Site.update(
|
|
|
956
915
|
* `smtp_username` (string): SMTP server username
|
|
957
916
|
* `smtp_port` (int64): SMTP server port
|
|
958
917
|
* `smtp_ssl` (string): Custom SMTP encryption mode: if_available (default) uses STARTTLS when offered and otherwise sends credentials and messages unencrypted. A certificate-verified STARTTLS connection automatically changes if_available to require unless smtp_ssl is managed by a parent policy. require requires STARTTLS before authentication; require_implicit uses TLS from connection start; never disables TLS. TLS verifies the server certificate against smtp_address. Encryption is never automatically downgraded.
|
|
959
|
-
* `ldap_enabled` (boolean): Main LDAP setting: is LDAP enabled?
|
|
960
|
-
* `ldap_type` (string): LDAP type
|
|
961
|
-
* `ldap_host` (string): LDAP host
|
|
962
|
-
* `ldap_host_2` (string): LDAP backup host
|
|
963
|
-
* `ldap_host_3` (string): LDAP backup host
|
|
964
|
-
* `ldap_port` (int64): LDAP port
|
|
965
|
-
* `ldap_secure` (boolean): Use secure LDAP?
|
|
966
|
-
* `ldap_server_certificate` (string): How to validate the LDAP server certificate. `require_match` validates the certificate chain and hostname; `allow_any` disables certificate validation.
|
|
967
|
-
* `ldap_username` (string): Username for signing in to LDAP server.
|
|
968
|
-
* `ldap_username_field` (string): LDAP username field
|
|
969
|
-
* `ldap_domain` (string): Domain name that will be appended to usernames
|
|
970
|
-
* `ldap_user_action` (string): Should we sync users from LDAP server?
|
|
971
|
-
* `ldap_group_action` (string): Should we sync groups from LDAP server?
|
|
972
|
-
* `ldap_user_include_groups` (string): Comma or newline separated list of group names (with optional wildcards) - if provided, only users in these groups will be added or synced.
|
|
973
|
-
* `ldap_group_exclusion` (string): Comma or newline separated list of group names (with optional wildcards) to exclude when syncing.
|
|
974
|
-
* `ldap_group_inclusion` (string): Comma or newline separated list of group names (with optional wildcards) to include when syncing.
|
|
975
|
-
* `ldap_base_dn` (string): Base DN for looking up users in LDAP server
|
|
976
918
|
* `uploads_via_email_authentication` (boolean): Require email authentication, virus, and spam checks for incoming emails to Inboxes and Incoming Email Automations in every Workspace on this site?
|
|
977
919
|
* `bundle_watermark_value` (object): Preview watermark settings applied to all bundle items. Uses the same keys as Behavior.value
|
|
978
920
|
* `icon16_file` (file):
|
|
@@ -990,7 +932,5 @@ Files::Site.update(
|
|
|
990
932
|
* `login_page_background_image_file` (file):
|
|
991
933
|
* `login_page_background_image_delete` (boolean): If true, will delete the file stored in login_page_background_image
|
|
992
934
|
* `disable_2fa_with_delay` (boolean): If set to true, we will begin the process of disabling 2FA on this site.
|
|
993
|
-
* `ldap_password_change` (string): New LDAP password.
|
|
994
|
-
* `ldap_password_change_confirmation` (string): Confirm new LDAP password.
|
|
995
935
|
* `redirect_old_subdomain` (boolean): If true, and if changing the site subdomain, then create a redirect from the previous Files.com subdomain to the new Files.com subdomain.
|
|
996
936
|
* `smtp_password` (string): Password for SMTP server.
|
|
@@ -35,7 +35,7 @@ module Files
|
|
|
35
35
|
@attributes[:event_uuid]
|
|
36
36
|
end
|
|
37
37
|
|
|
38
|
-
# Versioned event type string. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
38
|
+
# Versioned event type string. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `malware_scan_log.quarantined.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
39
39
|
# @return [String, nil] the field value, or nil when absent.
|
|
40
40
|
def event_type
|
|
41
41
|
@attributes[:event_type]
|
|
@@ -134,7 +134,7 @@ module Files
|
|
|
134
134
|
@attributes[:enabled] = value
|
|
135
135
|
end
|
|
136
136
|
|
|
137
|
-
# Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
137
|
+
# Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `malware_scan_log.quarantined.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
138
138
|
# @return [Array<String>, nil] the field value, or nil when absent.
|
|
139
139
|
def event_types
|
|
140
140
|
@attributes[:event_types]
|
|
@@ -209,7 +209,7 @@ module Files
|
|
|
209
209
|
# @option params [String] message Custom message to include in notification emails.
|
|
210
210
|
# @option params [Boolean] message_only If true, notification email bodies contain only the custom message, omitting event details and the review button. Requires a custom message, defaults to false, and does not affect non-email targets.
|
|
211
211
|
# @option params [Boolean] enabled Whether this Event Subscription can dispatch events.
|
|
212
|
-
# @option params [Array<String>] event_types Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
212
|
+
# @option params [Array<String>] event_types Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `malware_scan_log.quarantined.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
213
213
|
# @option params [Hash] filter Conditions on event fields that an event must meet to be delivered, keyed by dot-notation field path. All conditions must match.
|
|
214
214
|
# @option params [Hash] delivery_policy Event Subscription delivery policy. Overrides retry settings from each Event Target's delivery policy.
|
|
215
215
|
# @option params [Array<Integer>] event_target_ids Event Target IDs this subscription sends to.
|
|
@@ -352,7 +352,7 @@ module Files
|
|
|
352
352
|
# @option params [String] message Custom message to include in notification emails.
|
|
353
353
|
# @option params [Boolean] message_only If true, notification email bodies contain only the custom message, omitting event details and the review button. Requires a custom message, defaults to false, and does not affect non-email targets.
|
|
354
354
|
# @option params [Boolean] enabled Whether this Event Subscription can dispatch events.
|
|
355
|
-
# @option params [Array<String>] event_types Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
355
|
+
# @option params [Array<String>] event_types Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `malware_scan_log.quarantined.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
356
356
|
# @option params [Hash] filter Conditions on event fields that an event must meet to be delivered, keyed by dot-notation field path. All conditions must match.
|
|
357
357
|
# @option params [Hash] delivery_policy Event Subscription delivery policy. Overrides retry settings from each Event Target's delivery policy.
|
|
358
358
|
# @option params [Array<Integer>] event_target_ids Event Target IDs this subscription sends to.
|
|
@@ -392,7 +392,7 @@ module Files
|
|
|
392
392
|
# @option params [String] message Custom message to include in notification emails.
|
|
393
393
|
# @option params [Boolean] message_only If true, notification email bodies contain only the custom message, omitting event details and the review button. Requires a custom message, defaults to false, and does not affect non-email targets.
|
|
394
394
|
# @option params [Boolean] enabled Whether this Event Subscription can dispatch events.
|
|
395
|
-
# @option params [Array<String>] event_types Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
395
|
+
# @option params [Array<String>] event_types Event type strings matched by this subscription. Blank means all event types. Valid values: `automation_run.canceled.v1`, `automation_run.failure.v1`, `automation_run.failure_will_retry.v1`, `automation_run.partial_failure.v1`, `automation_run.partial_failure_will_retry.v1`, `automation_run.skipped.v1`, `automation_run.success.v1`, `expectation_evaluation.invalid.v1`, `expectation_evaluation.late.v1`, `expectation_evaluation.missing.v1`, `expectation_evaluation.success.v1`, `expectation_incident.acknowledged.v1`, `expectation_incident.open.v1`, `expectation_incident.resolved.v1`, `expectation_incident.snoozed.v1`, `external_event.client_log.failure.v1`, `external_event.client_log.partial_failure.v1`, `external_event.client_log.skipped.v1`, `external_event.client_log.success.v1`, `malware_scan_log.quarantined.v1`, `pending_work_event.failure.v1`, `pending_work_event.partial_failure.v1`, `pending_work_event.skipped.v1`, `pending_work_event.success.v1`, `siem_http_destination_event.failure.v1`, `siem_http_destination_event.partial_failure.v1`, `siem_http_destination_event.skipped.v1`, `siem_http_destination_event.success.v1`, `sso_event.ldap_login.failure.v1`, `sso_event.ldap_login.partial_failure.v1`, `sso_event.ldap_login.skipped.v1`, `sso_event.ldap_login.success.v1`, `sso_event.ldap_sync.failure.v1`, `sso_event.ldap_sync.partial_failure.v1`, `sso_event.ldap_sync.skipped.v1`, `sso_event.ldap_sync.success.v1`, `sso_event.saml_login.failure.v1`, `sso_event.saml_login.partial_failure.v1`, `sso_event.saml_login.skipped.v1`, `sso_event.saml_login.success.v1`, `sync_run.failure.v1`, `sync_run.partial_failure.v1`, `sync_run.skipped.v1`, `sync_run.success.v1`, `user_security_event.lockout.v1`
|
|
396
396
|
# @option params [Hash] filter Conditions on event fields that an event must meet to be delivered, keyed by dot-notation field path. All conditions must match.
|
|
397
397
|
# @option params [Hash] delivery_policy Event Subscription delivery policy. Overrides retry settings from each Event Target's delivery policy.
|
|
398
398
|
# @option params [Array<Integer>] event_target_ids Event Target IDs this subscription sends to.
|
|
@@ -30,6 +30,19 @@ module Files
|
|
|
30
30
|
@attributes[:id] = value
|
|
31
31
|
end
|
|
32
32
|
|
|
33
|
+
# Workspace ID
|
|
34
|
+
# @return [Integer, nil] the field value, or nil when absent.
|
|
35
|
+
def workspace_id
|
|
36
|
+
@attributes[:workspace_id]
|
|
37
|
+
end
|
|
38
|
+
|
|
39
|
+
# Changes the local field value. Call {#save} to persist changes.
|
|
40
|
+
# @param value [Integer, nil] the new field value.
|
|
41
|
+
# @return [Integer, nil] the assigned value.
|
|
42
|
+
def workspace_id=(value)
|
|
43
|
+
@attributes[:workspace_id] = value
|
|
44
|
+
end
|
|
45
|
+
|
|
33
46
|
# Type of event being recorded.
|
|
34
47
|
# @return [String, nil] the field value, or nil when absent.
|
|
35
48
|
def event_type
|
|
@@ -109,8 +122,8 @@ module Files
|
|
|
109
122
|
# @param params [Hash] API parameters, keyed by Symbol.
|
|
110
123
|
# @option params [String] cursor Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
|
|
111
124
|
# @option params [Integer] per_page Number of records to show per page. (Max: 10000, 1,000 or less is recommended).
|
|
112
|
-
# @option params [Hash] sort_by If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `status` or `
|
|
113
|
-
# @option params [Hash] filter If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`
|
|
125
|
+
# @option params [Hash] sort_by If set, sort records by the specified field in either `asc` or `desc` direction. Valid fields are `created_at`, `status`, `event_type` or `workspace_id`.
|
|
126
|
+
# @option params [Hash] filter If set, return records where the specified field is equal to the supplied value. Valid fields are `created_at`, `status` or `workspace_id`. Valid field combinations are `[ status, created_at ]`.
|
|
114
127
|
# @option params [Hash] filter_gt If set, return records where the specified field is greater than the supplied value. Valid fields are `created_at`.
|
|
115
128
|
# @option params [Hash] filter_gteq If set, return records where the specified field is greater than or equal the supplied value. Valid fields are `created_at`.
|
|
116
129
|
# @option params [Hash] filter_lt If set, return records where the specified field is less than the supplied value. Valid fields are `created_at`.
|
|
@@ -342,6 +342,45 @@ module Files
|
|
|
342
342
|
@attributes[:server_type] = value
|
|
343
343
|
end
|
|
344
344
|
|
|
345
|
+
# Owner's preference for administrator access to this user-owned Remote Server. Null uses the Site policy's default. Only the owner may change it when the Site policy allows user choice.
|
|
346
|
+
# @return [Boolean, nil] the field value, or nil when absent.
|
|
347
|
+
def site_admin_access
|
|
348
|
+
@attributes[:site_admin_access]
|
|
349
|
+
end
|
|
350
|
+
|
|
351
|
+
# Changes the local field value. Call {#save} to persist changes.
|
|
352
|
+
# @param value [Boolean, nil] the new field value.
|
|
353
|
+
# @return [Boolean, nil] the assigned value.
|
|
354
|
+
def site_admin_access=(value)
|
|
355
|
+
@attributes[:site_admin_access] = value
|
|
356
|
+
end
|
|
357
|
+
|
|
358
|
+
# Whether Site and Workspace Administrators can access this Remote Server under the current Site policy.
|
|
359
|
+
# @return [Boolean, nil] the field value, or nil when absent.
|
|
360
|
+
def effective_site_admin_access
|
|
361
|
+
@attributes[:effective_site_admin_access]
|
|
362
|
+
end
|
|
363
|
+
|
|
364
|
+
# Changes the local field value. Call {#save} to persist changes.
|
|
365
|
+
# @param value [Boolean, nil] the new field value.
|
|
366
|
+
# @return [Boolean, nil] the assigned value.
|
|
367
|
+
def effective_site_admin_access=(value)
|
|
368
|
+
@attributes[:effective_site_admin_access] = value
|
|
369
|
+
end
|
|
370
|
+
|
|
371
|
+
# ID of the user who owns this Remote Server, if any.
|
|
372
|
+
# @return [Integer, nil] the field value, or nil when absent.
|
|
373
|
+
def user_id
|
|
374
|
+
@attributes[:user_id]
|
|
375
|
+
end
|
|
376
|
+
|
|
377
|
+
# Changes the local field value. Call {#save} to persist changes.
|
|
378
|
+
# @param value [Integer, nil] the new field value.
|
|
379
|
+
# @return [Integer, nil] the assigned value.
|
|
380
|
+
def user_id=(value)
|
|
381
|
+
@attributes[:user_id] = value
|
|
382
|
+
end
|
|
383
|
+
|
|
345
384
|
# Workspace ID (0 for default workspace)
|
|
346
385
|
# @return [Integer, nil] the field value, or nil when absent.
|
|
347
386
|
def workspace_id
|
|
@@ -1057,19 +1096,6 @@ module Files
|
|
|
1057
1096
|
@attributes[:supports_versioning] = value
|
|
1058
1097
|
end
|
|
1059
1098
|
|
|
1060
|
-
# User ID. Provide a value of `0` to operate the current session's user.
|
|
1061
|
-
# @return [Integer, nil] the field value, or nil when absent.
|
|
1062
|
-
def user_id
|
|
1063
|
-
@attributes[:user_id]
|
|
1064
|
-
end
|
|
1065
|
-
|
|
1066
|
-
# Changes the local field value. Call {#save} to persist changes.
|
|
1067
|
-
# @param value [Integer, nil] the new field value.
|
|
1068
|
-
# @return [Integer, nil] the assigned value.
|
|
1069
|
-
def user_id=(value)
|
|
1070
|
-
@attributes[:user_id] = value
|
|
1071
|
-
end
|
|
1072
|
-
|
|
1073
1099
|
# Password, if needed.
|
|
1074
1100
|
# @return [String, nil] the field value, or nil when absent.
|
|
1075
1101
|
def password
|
|
@@ -1473,6 +1499,7 @@ module Files
|
|
|
1473
1499
|
# @option params [String] server_certificate Remote server certificate
|
|
1474
1500
|
# @option params [String] server_host_key Pinned SSH host key or OpenSSH host certificate for SFTP. If omitted, Files.com detects and stores a host key, preferring plain keys over certificates. With `server_certificate=require_match` (the default), the server must present the exact pinned key or certificate and prove it holds the matching private key. A pinned certificate is compared in full, so renewal can require updating `server_host_key` even when its underlying key is unchanged. Files.com does not check certificate CA signatures, principals, or validity periods. Certificate expiration alone does not end the pin. Update `server_host_key` to replace the pin.
|
|
1475
1501
|
# @option params [String] server_type Remote server type.
|
|
1502
|
+
# @option params [Boolean] site_admin_access Owner's preference for administrator access to this user-owned Remote Server. Null uses the Site policy's default. Only the owner may change it when the Site policy allows user choice.
|
|
1476
1503
|
# @option params [String] sharepoint_client_id SharePoint: Microsoft Entra application client ID for app-only authentication.
|
|
1477
1504
|
# @option params [String] sharepoint_site_url SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
|
|
1478
1505
|
# @option params [String] sharepoint_tenant_id SharePoint: Microsoft Entra tenant ID for app-only authentication.
|
|
@@ -1566,6 +1593,7 @@ module Files
|
|
|
1566
1593
|
raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if !params[:server_certificate].nil? and !params[:server_certificate].is_a?(String)
|
|
1567
1594
|
raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if !params[:server_host_key].nil? and !params[:server_host_key].is_a?(String)
|
|
1568
1595
|
raise InvalidParameterError.new("Bad parameter: server_type must be an String") if !params[:server_type].nil? and !params[:server_type].is_a?(String)
|
|
1596
|
+
raise InvalidParameterError.new("Bad parameter: site_admin_access must be a single value, not #{params[:site_admin_access].class}") if [ Array, Hash ].any? { |klass| params[:site_admin_access].is_a?(klass) }
|
|
1569
1597
|
raise InvalidParameterError.new("Bad parameter: sharepoint_client_id must be an String") if !params[:sharepoint_client_id].nil? and !params[:sharepoint_client_id].is_a?(String)
|
|
1570
1598
|
raise InvalidParameterError.new("Bad parameter: sharepoint_site_url must be an String") if !params[:sharepoint_site_url].nil? and !params[:sharepoint_site_url].is_a?(String)
|
|
1571
1599
|
raise InvalidParameterError.new("Bad parameter: sharepoint_tenant_id must be an String") if !params[:sharepoint_tenant_id].nil? and !params[:sharepoint_tenant_id].is_a?(String)
|
|
@@ -1803,6 +1831,7 @@ module Files
|
|
|
1803
1831
|
# @option params [String] server_certificate Remote server certificate
|
|
1804
1832
|
# @option params [String] server_host_key Pinned SSH host key or OpenSSH host certificate for SFTP. If omitted, Files.com detects and stores a host key, preferring plain keys over certificates. With `server_certificate=require_match` (the default), the server must present the exact pinned key or certificate and prove it holds the matching private key. A pinned certificate is compared in full, so renewal can require updating `server_host_key` even when its underlying key is unchanged. Files.com does not check certificate CA signatures, principals, or validity periods. Certificate expiration alone does not end the pin. Update `server_host_key` to replace the pin.
|
|
1805
1833
|
# @option params [String] server_type Remote server type.
|
|
1834
|
+
# @option params [Boolean] site_admin_access Owner's preference for administrator access to this user-owned Remote Server. Null uses the Site policy's default. Only the owner may change it when the Site policy allows user choice.
|
|
1806
1835
|
# @option params [String] sharepoint_client_id SharePoint: Microsoft Entra application client ID for app-only authentication.
|
|
1807
1836
|
# @option params [String] sharepoint_site_url SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
|
|
1808
1837
|
# @option params [String] sharepoint_tenant_id SharePoint: Microsoft Entra tenant ID for app-only authentication.
|
|
@@ -1895,6 +1924,7 @@ module Files
|
|
|
1895
1924
|
raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if !params[:server_certificate].nil? and !params[:server_certificate].is_a?(String)
|
|
1896
1925
|
raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if !params[:server_host_key].nil? and !params[:server_host_key].is_a?(String)
|
|
1897
1926
|
raise InvalidParameterError.new("Bad parameter: server_type must be an String") if !params[:server_type].nil? and !params[:server_type].is_a?(String)
|
|
1927
|
+
raise InvalidParameterError.new("Bad parameter: site_admin_access must be a single value, not #{params[:site_admin_access].class}") if [ Array, Hash ].any? { |klass| params[:site_admin_access].is_a?(klass) }
|
|
1898
1928
|
raise InvalidParameterError.new("Bad parameter: sharepoint_client_id must be an String") if !params[:sharepoint_client_id].nil? and !params[:sharepoint_client_id].is_a?(String)
|
|
1899
1929
|
raise InvalidParameterError.new("Bad parameter: sharepoint_site_url must be an String") if !params[:sharepoint_site_url].nil? and !params[:sharepoint_site_url].is_a?(String)
|
|
1900
1930
|
raise InvalidParameterError.new("Bad parameter: sharepoint_tenant_id must be an String") if !params[:sharepoint_tenant_id].nil? and !params[:sharepoint_tenant_id].is_a?(String)
|
|
@@ -2008,6 +2038,7 @@ module Files
|
|
|
2008
2038
|
# @option params [String] server_certificate Remote server certificate
|
|
2009
2039
|
# @option params [String] server_host_key Pinned SSH host key or OpenSSH host certificate for SFTP. If omitted, Files.com detects and stores a host key, preferring plain keys over certificates. With `server_certificate=require_match` (the default), the server must present the exact pinned key or certificate and prove it holds the matching private key. A pinned certificate is compared in full, so renewal can require updating `server_host_key` even when its underlying key is unchanged. Files.com does not check certificate CA signatures, principals, or validity periods. Certificate expiration alone does not end the pin. Update `server_host_key` to replace the pin.
|
|
2010
2040
|
# @option params [String] server_type Remote server type.
|
|
2041
|
+
# @option params [Boolean] site_admin_access Owner's preference for administrator access to this user-owned Remote Server. Null uses the Site policy's default. Only the owner may change it when the Site policy allows user choice.
|
|
2011
2042
|
# @option params [String] sharepoint_client_id SharePoint: Microsoft Entra application client ID for app-only authentication.
|
|
2012
2043
|
# @option params [String] sharepoint_site_url SharePoint: Site URL to scope app-only authentication to a single site. Leave blank to browse all sites.
|
|
2013
2044
|
# @option params [String] sharepoint_tenant_id SharePoint: Microsoft Entra tenant ID for app-only authentication.
|
|
@@ -2101,6 +2132,7 @@ module Files
|
|
|
2101
2132
|
raise InvalidParameterError.new("Bad parameter: server_certificate must be an String") if !params[:server_certificate].nil? and !params[:server_certificate].is_a?(String)
|
|
2102
2133
|
raise InvalidParameterError.new("Bad parameter: server_host_key must be an String") if !params[:server_host_key].nil? and !params[:server_host_key].is_a?(String)
|
|
2103
2134
|
raise InvalidParameterError.new("Bad parameter: server_type must be an String") if !params[:server_type].nil? and !params[:server_type].is_a?(String)
|
|
2135
|
+
raise InvalidParameterError.new("Bad parameter: site_admin_access must be a single value, not #{params[:site_admin_access].class}") if [ Array, Hash ].any? { |klass| params[:site_admin_access].is_a?(klass) }
|
|
2104
2136
|
raise InvalidParameterError.new("Bad parameter: sharepoint_client_id must be an String") if !params[:sharepoint_client_id].nil? and !params[:sharepoint_client_id].is_a?(String)
|
|
2105
2137
|
raise InvalidParameterError.new("Bad parameter: sharepoint_site_url must be an String") if !params[:sharepoint_site_url].nil? and !params[:sharepoint_site_url].is_a?(String)
|
|
2106
2138
|
raise InvalidParameterError.new("Bad parameter: sharepoint_tenant_id must be an String") if !params[:sharepoint_tenant_id].nil? and !params[:sharepoint_tenant_id].is_a?(String)
|