Errors

The Files.com Ruby SDK will return errors by raising exceptions. There are many exception classes defined in the Files SDK that correspond to specific errors.

The raised exceptions come from two categories:

SDK Exceptions - errors that originate within the SDK
API Exceptions - errors that occur due to the response from the Files.com API. These errors are grouped into common error types.

There are several types of exceptions within each category. Exception classes indicate different types of errors and are named in a fashion that describe the general premise of the originating error. More details can be found in the message attribute of the capture exception object.

Use standard Ruby exception handling to detect and deal with errors. It is generally recommended to rescue for specific errors first, then rescue for general Files::Error as a catch-all.

Example Error Handling

begin
  session = Files::Session.create(username: "USERNAME", password: "BADPASSWORD")
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Error Types

SDK Errors

SDK errors are general errors that occur within the SDK code. Each exception class inherits from a standard Error base class.

Example SDK Exception Class Inheritance Structure

Files::APIConnectionError -> Files::Error -> StandardError

SDK Exception Classes

Error Class Name	Description
`APIConnectionError`	The Files.com API cannot be reached
`AuthenticationError`	Not enough authentication information has been provided
`InvalidParameterError`	A passed in parameter is invalid
`MissingParameterError`	A method parameter is missing
`NotImplementedError`	The called method has not be implemented by the SDK

API Errors

API errors are errors returned by the Files.com API. Each exception class inherits from an error group base class. The error group base class indicates a particular type of error.

Example API Exception Class Inheritance Structure

Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files::Error -> StandardError

API Exception Classes

Error Class Name	Error Group
`AgentUpgradeRequiredError`	`BadRequestError`
`AttachmentTooLargeError`	`BadRequestError`
`CannotDownloadDirectoryError`	`BadRequestError`
`CantMoveWithMultipleLocationsError`	`BadRequestError`
`DatetimeParseError`	`BadRequestError`
`DestinationSameError`	`BadRequestError`
`DestinationSiteMismatchError`	`BadRequestError`
`DoesNotSupportSortingError`	`BadRequestError`
`FolderMustNotBeAFileError`	`BadRequestError`
`FoldersNotAllowedError`	`BadRequestError`
`InternalGeneralErrorError`	`BadRequestError`
`InvalidBodyError`	`BadRequestError`
`InvalidCursorError`	`BadRequestError`
`InvalidCursorTypeForSortError`	`BadRequestError`
`InvalidEtagsError`	`BadRequestError`
`InvalidFilterAliasCombinationError`	`BadRequestError`
`InvalidFilterFieldError`	`BadRequestError`
`InvalidFilterParamError`	`BadRequestError`
`InvalidFilterParamFormatError`	`BadRequestError`
`InvalidFilterParamValueError`	`BadRequestError`
`InvalidInputEncodingError`	`BadRequestError`
`InvalidInterfaceError`	`BadRequestError`
`InvalidOauthProviderError`	`BadRequestError`
`InvalidPathError`	`BadRequestError`
`InvalidReturnToUrlError`	`BadRequestError`
`InvalidSearchQueryError`	`BadRequestError`
`InvalidSortFieldError`	`BadRequestError`
`InvalidSortFilterCombinationError`	`BadRequestError`
`InvalidUploadOffsetError`	`BadRequestError`
`InvalidUploadPartGapError`	`BadRequestError`
`InvalidUploadPartSizeError`	`BadRequestError`
`InvalidWorkspaceIdHeaderError`	`BadRequestError`
`MethodNotAllowedError`	`BadRequestError`
`MultipleSortParamsNotAllowedError`	`BadRequestError`
`NoValidInputParamsError`	`BadRequestError`
`OffsetUploadNotAllowedWithMalwareScanningError`	`BadRequestError`
`PartNumberTooLargeError`	`BadRequestError`
`PathCannotHaveTrailingWhitespaceError`	`BadRequestError`
`ReauthenticationNeededFieldsError`	`BadRequestError`
`RequestBodyTooLargeError`	`BadRequestError`
`RequestParamsContainInvalidCharacterError`	`BadRequestError`
`RequestParamsInvalidError`	`BadRequestError`
`RequestParamsRequiredError`	`BadRequestError`
`SearchAllOnChildPathError`	`BadRequestError`
`UnrecognizedSortIndexError`	`BadRequestError`
`UnsupportedCurrencyError`	`BadRequestError`
`UnsupportedHttpResponseFormatError`	`BadRequestError`
`UnsupportedMediaTypeError`	`BadRequestError`
`UserIdInvalidError`	`BadRequestError`
`UserIdOnUserEndpointError`	`BadRequestError`
`UserRequiredError`	`BadRequestError`
`AdditionalAuthenticationRequiredError`	`NotAuthenticatedError`
`ApiKeySessionsNotSupportedError`	`NotAuthenticatedError`
`AuthenticationRequiredError`	`NotAuthenticatedError`
`BundleRegistrationCodeFailedError`	`NotAuthenticatedError`
`FilesAgentTokenFailedError`	`NotAuthenticatedError`
`InboxRegistrationCodeFailedError`	`NotAuthenticatedError`
`InvalidCredentialsError`	`NotAuthenticatedError`
`InvalidOauthError`	`NotAuthenticatedError`
`InvalidOrExpiredCodeError`	`NotAuthenticatedError`
`InvalidSessionError`	`NotAuthenticatedError`
`InvalidUsernameOrPasswordError`	`NotAuthenticatedError`
`LockedOutError`	`NotAuthenticatedError`
`LockoutRegionMismatchError`	`NotAuthenticatedError`
`OneTimePasswordIncorrectError`	`NotAuthenticatedError`
`TwoFactorAuthenticationErrorError`	`NotAuthenticatedError`
`TwoFactorAuthenticationSetupExpiredError`	`NotAuthenticatedError`
`ApiKeyIsDisabledError`	`NotAuthorizedError`
`ApiKeyIsPathRestrictedError`	`NotAuthorizedError`
`ApiKeyOnlyForDesktopAppError`	`NotAuthorizedError`
`ApiKeyOnlyForMobileAppError`	`NotAuthorizedError`
`ApiKeyOnlyForOfficeIntegrationError`	`NotAuthorizedError`
`BillingInformationHiddenError`	`NotAuthorizedError`
`BillingPermissionRequiredError`	`NotAuthorizedError`
`BundleMaximumUsesReachedError`	`NotAuthorizedError`
`BundlePermissionRequiredError`	`NotAuthorizedError`
`CannotLoginWhileUsingKeyError`	`NotAuthorizedError`
`CantActForOtherUserError`	`NotAuthorizedError`
`ContactAdminForPasswordChangeHelpError`	`NotAuthorizedError`
`FilesAgentFailedAuthorizationError`	`NotAuthorizedError`
`FolderAdminOrBillingPermissionRequiredError`	`NotAuthorizedError`
`FolderAdminPermissionRequiredError`	`NotAuthorizedError`
`FullPermissionRequiredError`	`NotAuthorizedError`
`HistoryPermissionRequiredError`	`NotAuthorizedError`
`InAppAiAssistantUnavailableError`	`NotAuthorizedError`
`InsufficientPermissionForParamsError`	`NotAuthorizedError`
`InsufficientPermissionForSiteError`	`NotAuthorizedError`
`MoverAccessDeniedError`	`NotAuthorizedError`
`MoverPackageRequiredError`	`NotAuthorizedError`
`MustAuthenticateWithApiKeyError`	`NotAuthorizedError`
`NeedAdminPermissionForInboxError`	`NotAuthorizedError`
`NonAdminsMustQueryByFolderOrPathError`	`NotAuthorizedError`
`NotAllowedToCreateBundleError`	`NotAuthorizedError`
`NotEnqueuableSyncError`	`NotAuthorizedError`
`PasswordChangeNotRequiredError`	`NotAuthorizedError`
`PasswordChangeRequiredError`	`NotAuthorizedError`
`PaymentMethodErrorError`	`NotAuthorizedError`
`PreviewOnlyPermissionCannotDownloadError`	`NotAuthorizedError`
`ReadOnlySessionError`	`NotAuthorizedError`
`ReadPermissionRequiredError`	`NotAuthorizedError`
`ReauthenticationFailedError`	`NotAuthorizedError`
`ReauthenticationFailedFinalError`	`NotAuthorizedError`
`ReauthenticationNeededActionError`	`NotAuthorizedError`
`RecaptchaFailedError`	`NotAuthorizedError`
`RemoteDesktopDebugLoggingDisabledError`	`NotAuthorizedError`
`RootFolderBehaviorSiteAdminRequiredError`	`NotAuthorizedError`
`RootFolderBehaviorSkipSiteAdminRequiredError`	`NotAuthorizedError`
`SelfManagedRequiredError`	`NotAuthorizedError`
`SiteAdminOrPartnerAdminPermissionRequiredError`	`NotAuthorizedError`
`SiteAdminOrWorkspaceAdminOrFolderAdminPermissionRequiredError`	`NotAuthorizedError`
`SiteAdminOrWorkspaceAdminOrPartnerAdminOrFolderAdminPermissionRequiredError`	`NotAuthorizedError`
`SiteAdminOrWorkspaceAdminOrPartnerAdminPermissionRequiredError`	`NotAuthorizedError`
`SiteAdminOrWorkspaceAdminPermissionRequiredError`	`NotAuthorizedError`
`SiteAdminRequiredError`	`NotAuthorizedError`
`SiteFilesAreImmutableError`	`NotAuthorizedError`
`TwoFactorAuthenticationRequiredError`	`NotAuthorizedError`
`UserIdWithoutSiteAdminError`	`NotAuthorizedError`
`WriteAndBundlePermissionRequiredError`	`NotAuthorizedError`
`WritePermissionRequiredError`	`NotAuthorizedError`
`ApiKeyNotFoundError`	`NotFoundError`
`BundlePathNotFoundError`	`NotFoundError`
`BundleRegistrationNotFoundError`	`NotFoundError`
`CodeNotFoundError`	`NotFoundError`
`FileNotFoundError`	`NotFoundError`
`FileUploadNotFoundError`	`NotFoundError`
`GroupNotFoundError`	`NotFoundError`
`InboxNotFoundError`	`NotFoundError`
`NestedNotFoundError`	`NotFoundError`
`PlanNotFoundError`	`NotFoundError`
`SiteNotFoundError`	`NotFoundError`
`UserNotFoundError`	`NotFoundError`
`AgentPushUpdateBlockedError`	`ProcessingFailureError`
`AgentUnavailableError`	`ProcessingFailureError`
`AiTaskCannotBeRunManuallyError`	`ProcessingFailureError`
`AlreadyCompletedError`	`ProcessingFailureError`
`AutomationCannotBeRunManuallyError`	`ProcessingFailureError`
`BehaviorNotAllowedOnRemoteServerError`	`ProcessingFailureError`
`BufferedUploadDisabledForThisDestinationError`	`ProcessingFailureError`
`BundleOnlyAllowsPreviewsError`	`ProcessingFailureError`
`BundleOperationRequiresSubfolderError`	`ProcessingFailureError`
`ConfigurationLockedPathError`	`ProcessingFailureError`
`CouldNotCreateParentError`	`ProcessingFailureError`
`DestinationExistsError`	`ProcessingFailureError`
`DestinationFolderLimitedError`	`ProcessingFailureError`
`DestinationParentConflictError`	`ProcessingFailureError`
`DestinationParentDoesNotExistError`	`ProcessingFailureError`
`ExceededRuntimeLimitError`	`ProcessingFailureError`
`ExpectationAlreadyHasOpenWindowError`	`ProcessingFailureError`
`ExpectationNotManualTriggerError`	`ProcessingFailureError`
`ExpiredPrivateKeyError`	`ProcessingFailureError`
`ExpiredPublicKeyError`	`ProcessingFailureError`
`ExportFailureError`	`ProcessingFailureError`
`ExportNotReadyError`	`ProcessingFailureError`
`FailedToChangePasswordError`	`ProcessingFailureError`
`FileLockedError`	`ProcessingFailureError`
`FileNotUploadedError`	`ProcessingFailureError`
`FilePendingProcessingError`	`ProcessingFailureError`
`FileProcessingErrorError`	`ProcessingFailureError`
`FileTooBigToDecryptError`	`ProcessingFailureError`
`FileTooBigToEncryptError`	`ProcessingFailureError`
`FileUploadedToWrongRegionError`	`ProcessingFailureError`
`FilenameTooLongError`	`ProcessingFailureError`
`FolderLockedError`	`ProcessingFailureError`
`FolderNotEmptyError`	`ProcessingFailureError`
`HistoryUnavailableError`	`ProcessingFailureError`
`InvalidBundleCodeError`	`ProcessingFailureError`
`InvalidFileTypeError`	`ProcessingFailureError`
`InvalidFilenameError`	`ProcessingFailureError`
`InvalidPriorityColorError`	`ProcessingFailureError`
`InvalidRangeError`	`ProcessingFailureError`
`InvalidSiteError`	`ProcessingFailureError`
`InvalidZipFileError`	`ProcessingFailureError`
`MetadataNotSupportedOnRemotesError`	`ProcessingFailureError`
`ModelSaveErrorError`	`ProcessingFailureError`
`MultipleProcessingErrorsError`	`ProcessingFailureError`
`PathTooLongError`	`ProcessingFailureError`
`RecipientAlreadySharedError`	`ProcessingFailureError`
`RemoteServerErrorError`	`ProcessingFailureError`
`ResourceBelongsToParentSiteError`	`ProcessingFailureError`
`ResourceLockedError`	`ProcessingFailureError`
`SubfolderLockedError`	`ProcessingFailureError`
`SyncInProgressError`	`ProcessingFailureError`
`TwoFactorAuthenticationCodeAlreadySentError`	`ProcessingFailureError`
`TwoFactorAuthenticationCountryBlacklistedError`	`ProcessingFailureError`
`TwoFactorAuthenticationGeneralErrorError`	`ProcessingFailureError`
`TwoFactorAuthenticationMethodUnsupportedErrorError`	`ProcessingFailureError`
`TwoFactorAuthenticationUnsubscribedRecipientError`	`ProcessingFailureError`
`UpdatesNotAllowedForRemotesError`	`ProcessingFailureError`
`DuplicateShareRecipientError`	`RateLimitedError`
`ReauthenticationRateLimitedError`	`RateLimitedError`
`TooManyConcurrentLoginsError`	`RateLimitedError`
`TooManyConcurrentRequestsError`	`RateLimitedError`
`TooManyLoginAttemptsError`	`RateLimitedError`
`TooManyRequestsError`	`RateLimitedError`
`TooManySharesError`	`RateLimitedError`
`AutomationsUnavailableError`	`ServiceUnavailableError`
`MigrationInProgressError`	`ServiceUnavailableError`
`SiteDisabledError`	`ServiceUnavailableError`
`UploadsUnavailableError`	`ServiceUnavailableError`
`AccountAlreadyExistsError`	`SiteConfigurationError`
`AccountOverdueError`	`SiteConfigurationError`
`NoAccountForSiteError`	`SiteConfigurationError`
`SiteWasRemovedError`	`SiteConfigurationError`
`TrialExpiredError`	`SiteConfigurationError`
`TrialLockedError`	`SiteConfigurationError`
`UserRequestsEnabledRequiredError`	`SiteConfigurationError`