Module: Files

Defined in:
lib/files.com.rb,
lib/files.com/api.rb,
lib/files.com/uri.rb,
lib/files.com/list.rb,
lib/files.com/util.rb,
lib/files.com/errors.rb,
lib/files.com/version.rb,
lib/files.com/response.rb,
lib/files.com/path_util.rb,
lib/files.com/api_client.rb,
lib/files.com/models/app.rb,
lib/files.com/models/dir.rb,
lib/files.com/sizable_io.rb,
lib/files.com/models/auto.rb,
lib/files.com/models/file.rb,
lib/files.com/models/lock.rb,
lib/files.com/models/site.rb,
lib/files.com/models/sync.rb,
lib/files.com/models/user.rb,
lib/files.com/models/group.rb,
lib/files.com/models/image.rb,
lib/files.com/models/style.rb,
lib/files.com/models/action.rb,
lib/files.com/models/bundle.rb,
lib/files.com/models/errors.rb,
lib/files.com/models/folder.rb,
lib/files.com/models/secret.rb,
lib/files.com/models/status.rb,
lib/files.com/models/ai_task.rb,
lib/files.com/models/api_key.rb,
lib/files.com/models/gpg_key.rb,
lib/files.com/models/history.rb,
lib/files.com/models/invoice.rb,
lib/files.com/models/message.rb,
lib/files.com/models/partner.rb,
lib/files.com/models/payment.rb,
lib/files.com/models/preview.rb,
lib/files.com/models/project.rb,
lib/files.com/models/request.rb,
lib/files.com/models/restore.rb,
lib/files.com/models/session.rb,
lib/files.com/models/behavior.rb,
lib/files.com/models/scim_log.rb,
lib/files.com/models/snapshot.rb,
lib/files.com/models/sync_log.rb,
lib/files.com/models/sync_run.rb,
lib/files.com/system_profiler.rb,
lib/files.com/models/clickwrap.rb,
lib/files.com/models/email_log.rb,
lib/files.com/models/sso_event.rb,
lib/files.com/models/workspace.rb,
lib/files.com/models/action_log.rb,
lib/files.com/models/automation.rb,
lib/files.com/models/dns_record.rb,
lib/files.com/models/file_utils.rb,
lib/files.com/models/form_field.rb,
lib/files.com/models/group_user.rb,
lib/files.com/models/ip_address.rb,
lib/files.com/models/permission.rb,
lib/files.com/models/public_key.rb,
lib/files.com/models/as2_partner.rb,
lib/files.com/models/as2_station.rb,
lib/files.com/models/bundle_path.rb,
lib/files.com/models/expectation.rb,
lib/files.com/models/file_action.rb,
lib/files.com/models/share_group.rb,
lib/files.com/models/chat_message.rb,
lib/files.com/models/chat_session.rb,
lib/files.com/models/event_record.rb,
lib/files.com/models/event_target.rb,
lib/files.com/models/file_comment.rb,
lib/files.com/models/inbox_upload.rb,
lib/files.com/models/notification.rb,
lib/files.com/models/partner_site.rb,
lib/files.com/models/sso_strategy.rb,
lib/files.com/models/user_request.rb,
lib/files.com/models/webhook_test.rb,
lib/files.com/models/bundle_action.rb,
lib/files.com/models/custom_domain.rb,
lib/files.com/models/event_channel.rb,
lib/files.com/models/remote_server.rb,
lib/files.com/models/sftp_host_key.rb,
lib/files.com/models/automation_log.rb,
lib/files.com/models/automation_run.rb,
lib/files.com/models/external_event.rb,
lib/files.com/models/file_migration.rb,
lib/files.com/models/form_field_set.rb,
lib/files.com/models/ftp_action_log.rb,
lib/files.com/models/history_export.rb,
lib/files.com/models/holiday_region.rb,
lib/files.com/models/inbound_s3_log.rb,
lib/files.com/models/usage_snapshot.rb,
lib/files.com/models/zip_list_entry.rb,
lib/files.com/models/api_request_log.rb,
lib/files.com/models/bundle_download.rb,
lib/files.com/models/inbox_recipient.rb,
lib/files.com/models/message_comment.rb,
lib/files.com/models/partner_channel.rb,
lib/files.com/models/settings_change.rb,
lib/files.com/models/sftp_action_log.rb,
lib/files.com/models/user_cipher_use.rb,
lib/files.com/models/bundle_recipient.rb,
lib/files.com/models/file_upload_part.rb,
lib/files.com/models/message_reaction.rb,
lib/files.com/models/scheduled_export.rb,
lib/files.com/models/account_line_item.rb,
lib/files.com/models/agent_push_update.rb,
lib/files.com/models/invoice_line_item.rb,
lib/files.com/models/metadata_category.rb,
lib/files.com/models/payment_line_item.rb,
lib/files.com/models/public_ip_address.rb,
lib/files.com/models/bandwidth_snapshot.rb,
lib/files.com/models/event_subscription.rb,
lib/files.com/models/file_migration_log.rb,
lib/files.com/models/inbox_registration.rb,
lib/files.com/models/key_lifecycle_rule.rb,
lib/files.com/models/pending_work_event.rb,
lib/files.com/models/share_group_member.rb,
lib/files.com/models/web_dav_action_log.rb,
lib/files.com/models/bundle_notification.rb,
lib/files.com/models/bundle_registration.rb,
lib/files.com/models/user_lifecycle_rule.rb,
lib/files.com/models/user_security_event.rb,
lib/files.com/models/as2_incoming_message.rb,
lib/files.com/models/as2_outgoing_message.rb,
lib/files.com/models/expectation_incident.rb,
lib/files.com/models/partner_site_request.rb,
lib/files.com/models/remote_mount_backend.rb,
lib/files.com/models/usage_daily_snapshot.rb,
lib/files.com/models/user_sftp_client_use.rb,
lib/files.com/models/file_comment_reaction.rb,
lib/files.com/models/history_export_result.rb,
lib/files.com/models/siem_http_destination.rb,
lib/files.com/models/email_incoming_message.rb,
lib/files.com/models/event_delivery_attempt.rb,
lib/files.com/models/expectation_evaluation.rb,
lib/files.com/models/sync_run_live_transfer.rb,
lib/files.com/models/usage_by_top_level_dir.rb,
lib/files.com/models/outbound_connection_log.rb,
lib/files.com/models/site_subdomain_redirect.rb,
lib/files.com/models/ai_assistant_personality.rb,
lib/files.com/models/exavault_api_request_log.rb,
lib/files.com/models/message_comment_reaction.rb,
lib/files.com/models/partner_channel_template.rb,
lib/files.com/models/remote_server_credential.rb,
lib/files.com/models/remote_bandwidth_snapshot.rb,
lib/files.com/models/action_notification_export.rb,
lib/files.com/models/public_hosting_request_log.rb,
lib/files.com/models/automation_authoring_schema.rb,
lib/files.com/models/integration_centric_profile.rb,
lib/files.com/models/siem_http_destination_event.rb,
lib/files.com/models/child_site_management_policy.rb,
lib/files.com/models/desktop_configuration_profile.rb,
lib/files.com/models/remote_server_configuration_file.rb,
lib/files.com/models/action_notification_export_result.rb

Defined Under Namespace

Modules: PathUtil, URI, Util Classes: APIConnectionError, APIError, AccountAlreadyExistsError, AccountLineItem, AccountOverdueError, Action, ActionLog, ActionNotificationExport, ActionNotificationExportResult, AdditionalAuthenticationRequiredError, AgentPushUpdate, AgentUnavailableError, AgentUpgradeRequiredError, AiAssistantPersonality, AiTask, AiTaskCannotBeRunManuallyError, AlreadyCompletedError, Api, ApiClient, ApiKey, ApiKeyIsDisabledError, ApiKeyIsPathRestrictedError, ApiKeyNotFoundError, ApiKeyOnlyForDesktopAppError, ApiKeyOnlyForMobileAppError, ApiKeyOnlyForOfficeIntegrationError, ApiKeySessionsNotSupportedError, ApiRequestLog, App, As2IncomingMessage, As2OutgoingMessage, As2Partner, As2Station, AttachmentTooLargeError, AuthenticationError, AuthenticationRequiredError, Auto, Automation, AutomationAuthoringSchema, AutomationCannotBeRunManuallyError, AutomationLog, AutomationRun, AutomationsUnavailableError, BadRequestError, BandwidthSnapshot, Behavior, BehaviorNotAllowedOnRemoteServerError, BillingInformationHiddenError, BillingPermissionRequiredError, BufferedUploadDisabledForThisDestinationError, Bundle, BundleAction, BundleDownload, BundleMaximumUsesReachedError, BundleNotification, BundleOnlyAllowsPreviewsError, BundleOperationRequiresSubfolderError, BundlePath, BundlePathNotFoundError, BundlePermissionRequiredError, BundleRecipient, BundleRegistration, BundleRegistrationCodeFailedError, BundleRegistrationNotFoundError, CannotDownloadDirectoryError, CannotLoginWhileUsingKeyError, CantActForOtherUserError, CantMoveWithMultipleLocationsError, ChatMessage, ChatSession, ChildSiteManagementPolicy, Clickwrap, CodeNotFoundError, ConfigurationLockedPathError, ContactAdminForPasswordChangeHelpError, CouldNotCreateParentError, CustomDomain, DatetimeParseError, DesktopConfigurationProfile, DestinationExistsError, DestinationFolderLimitedError, DestinationParentConflictError, DestinationParentDoesNotExistError, DestinationSameError, DestinationSiteMismatchError, DnsRecord, DoesNotSupportSortingError, DuplicateShareRecipientError, EmailIncomingMessage, EmailLog, Error, Errors, EventChannel, EventDeliveryAttempt, EventRecord, EventSubscription, EventTarget, ExavaultApiRequestLog, ExceededRuntimeLimitError, Expectation, ExpectationAlreadyHasOpenWindowError, ExpectationEvaluation, ExpectationIncident, ExpectationNotManualTriggerError, ExpiredPrivateKeyError, ExpiredPublicKeyError, ExportFailureError, ExportNotReadyError, ExternalEvent, FailedToChangePasswordError, File, FileAction, FileComment, FileCommentReaction, FileLockedError, FileMigration, FileMigrationLog, FileNotFoundError, FileNotUploadedError, FilePendingProcessingError, FileProcessingErrorError, FileTooBigToDecryptError, FileTooBigToEncryptError, FileUploadNotFoundError, FileUploadPart, FileUploadedToWrongRegionError, FileUtils, FilenameTooLongError, FilesAgentFailedAuthorizationError, FilesAgentTokenFailedError, Folder, FolderAdminOrBillingPermissionRequiredError, FolderAdminPermissionRequiredError, FolderLockedError, FolderMustNotBeAFileError, FolderNotEmptyError, FoldersNotAllowedError, FormField, FormFieldSet, FtpActionLog, FullPermissionRequiredError, GpgKey, Group, GroupNotFoundError, GroupUser, History, HistoryExport, HistoryExportResult, HistoryPermissionRequiredError, HistoryUnavailableError, HolidayRegion, Image, InAppAiAssistantUnavailableError, InboundS3Log, InboxNotFoundError, InboxRecipient, InboxRegistration, InboxRegistrationCodeFailedError, InboxUpload, InsufficientPermissionForParamsError, InsufficientPermissionForSiteError, IntegrationCentricProfile, InternalGeneralErrorError, InvalidBodyError, InvalidBundleCodeError, InvalidCredentialsError, InvalidCursorError, InvalidCursorTypeForSortError, InvalidEtagsError, InvalidFileTypeError, InvalidFilenameError, InvalidFilterAliasCombinationError, InvalidFilterFieldError, InvalidFilterParamError, InvalidFilterParamFormatError, InvalidFilterParamValueError, InvalidInputEncodingError, InvalidInterfaceError, InvalidOauthError, InvalidOauthProviderError, InvalidOrExpiredCodeError, InvalidParameterError, InvalidPathError, InvalidPriorityColorError, InvalidRangeError, InvalidReturnToUrlError, InvalidSearchQueryError, InvalidSessionError, InvalidSiteError, InvalidSortFieldError, InvalidSortFilterCombinationError, InvalidUploadOffsetError, InvalidUploadPartGapError, InvalidUploadPartSizeError, InvalidUsernameOrPasswordError, InvalidWorkspaceIdHeaderError, InvalidZipFileError, Invoice, InvoiceLineItem, IpAddress, KeyLifecycleRule, List, Lock, LockedOutError, LockoutRegionMismatchError, Message, MessageComment, MessageCommentReaction, MessageReaction, MetadataCategory, MetadataNotSupportedOnRemotesError, MethodNotAllowedError, MigrationInProgressError, MissingParameterError, ModelSaveErrorError, MoverAccessDeniedError, MoverPackageRequiredError, MultipleProcessingErrorsError, MultipleSortParamsNotAllowedError, MustAuthenticateWithApiKeyError, NeedAdminPermissionForInboxError, NestedNotFoundError, NoAccountForSiteError, NoValidInputParamsError, NonAdminsMustQueryByFolderOrPathError, NotAllowedToCreateBundleError, NotAuthenticatedError, NotAuthorizedError, NotEnqueuableSyncError, NotFoundError, NotImplementedError, Notification, OneTimePasswordIncorrectError, OutboundConnectionLog, PartNumberTooLargeError, Partner, PartnerChannel, PartnerChannelTemplate, PartnerSite, PartnerSiteRequest, PasswordChangeNotRequiredError, PasswordChangeRequiredError, PathCannotHaveTrailingWhitespaceError, PathTooLongError, Payment, PaymentLineItem, PaymentMethodErrorError, PendingWorkEvent, Permission, PlanNotFoundError, Preview, PreviewOnlyPermissionCannotDownloadError, ProcessingFailureError, Project, PublicHostingRequestLog, PublicIpAddress, PublicKey, RateLimitedError, ReadOnlySessionError, ReadPermissionRequiredError, ReauthenticationFailedError, ReauthenticationFailedFinalError, ReauthenticationNeededActionError, ReauthenticationNeededFieldsError, ReauthenticationRateLimitedError, RecaptchaFailedError, RecipientAlreadySharedError, RemoteBandwidthSnapshot, RemoteDesktopDebugLoggingDisabledError, RemoteMountBackend, RemoteServer, RemoteServerConfigurationFile, RemoteServerCredential, RemoteServerErrorError, Request, RequestBodyTooLargeError, RequestParamsContainInvalidCharacterError, RequestParamsInvalidError, RequestParamsRequiredError, ResourceBelongsToParentSiteError, ResourceLockedError, Response, Restore, ScheduledExport, ScimLog, SearchAllOnChildPathError, Secret, SelfManagedRequiredError, ServiceUnavailableError, Session, SettingsChange, SftpActionLog, SftpHostKey, ShareGroup, ShareGroupMember, SiemHttpDestination, SiemHttpDestinationEvent, Site, SiteAdminOrPartnerAdminPermissionRequiredError, SiteAdminOrWorkspaceAdminOrFolderAdminPermissionRequiredError, SiteAdminOrWorkspaceAdminOrPartnerAdminOrFolderAdminPermissionRequiredError, SiteAdminOrWorkspaceAdminOrPartnerAdminPermissionRequiredError, SiteAdminOrWorkspaceAdminPermissionRequiredError, SiteAdminRequiredError, SiteConfigurationError, SiteDisabledError, SiteFilesAreImmutableError, SiteNotFoundError, SiteSubdomainRedirect, SiteWasRemovedError, SizableIO, Snapshot, SsoEvent, SsoStrategy, Status, Style, SubfolderLockedError, Sync, SyncInProgressError, SyncLog, SyncRun, SyncRunLiveTransfer, SystemProfiler, TooManyConcurrentLoginsError, TooManyConcurrentRequestsError, TooManyLoginAttemptsError, TooManyRequestsError, TooManySharesError, TrialExpiredError, TrialLockedError, TwoFactorAuthenticationCodeAlreadySentError, TwoFactorAuthenticationCountryBlacklistedError, TwoFactorAuthenticationErrorError, TwoFactorAuthenticationGeneralErrorError, TwoFactorAuthenticationMethodUnsupportedErrorError, TwoFactorAuthenticationRequiredError, TwoFactorAuthenticationSetupExpiredError, TwoFactorAuthenticationUnsubscribedRecipientError, UnrecognizedSortIndexError, UnsupportedCurrencyError, UnsupportedHttpResponseFormatError, UnsupportedMediaTypeError, UpdatesNotAllowedForRemotesError, UploadsUnavailableError, UsageByTopLevelDir, UsageDailySnapshot, UsageSnapshot, User, UserCipherUse, UserIdInvalidError, UserIdOnUserEndpointError, UserIdWithoutSiteAdminError, UserLifecycleRule, UserNotFoundError, UserRequest, UserRequestsEnabledRequiredError, UserRequiredError, UserSecurityEvent, UserSftpClientUse, WebDavActionLog, WebhookTest, Workspace, WriteAndBundlePermissionRequiredError, WritePermissionRequiredError, ZipListEntry

Constant Summary collapse

LEVEL_DEBUG =

map to the same values as the standard library's logger

Logger::DEBUG
LEVEL_ERROR = 
Logger::ERROR
LEVEL_INFO = 
Logger::INFO
VERSION = 
"1.1.682"
Dir = 
Folder

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_key ⇒ Object

Returns the value of attribute api_key.



200
201
202
 
# File 'lib/files.com.rb', line 200

def api_key
  @api_key
end

.base_url ⇒ Object

Returns the value of attribute base_url.



200
201
202
 
# File 'lib/files.com.rb', line 200

def base_url
  @base_url
end

.default_headers ⇒ Object

Returns the value of attribute default_headers.



200
201
202
 
# File 'lib/files.com.rb', line 200

def default_headers
  @default_headers
end

.initial_network_retry_delay ⇒ Object

Returns the value of attribute initial_network_retry_delay.



200
201
202
 
# File 'lib/files.com.rb', line 200

def initial_network_retry_delay
  @initial_network_retry_delay
end

.language ⇒ Object

Returns the value of attribute language.



200
201
202
 
# File 'lib/files.com.rb', line 200

def language
  @language
end

.max_network_retry_delay ⇒ Object

Returns the value of attribute max_network_retry_delay.



200
201
202
 
# File 'lib/files.com.rb', line 200

def max_network_retry_delay
  @max_network_retry_delay
end

.open_timeout ⇒ Object

Returns the value of attribute open_timeout.



200
201
202
 
# File 'lib/files.com.rb', line 200

def open_timeout
  @open_timeout
end

.proxy ⇒ Object

Returns the value of attribute proxy.



200
201
202
 
# File 'lib/files.com.rb', line 200

def proxy
  @proxy
end

.read_timeout ⇒ Object

Returns the value of attribute read_timeout.



200
201
202
 
# File 'lib/files.com.rb', line 200

def read_timeout
  @read_timeout
end

.session_id ⇒ Object

Returns the value of attribute session_id.



200
201
202
 
# File 'lib/files.com.rb', line 200

def session_id
  @session_id
end

.workspace_id ⇒ Object

Returns the value of attribute workspace_id.



200
201
202
 
# File 'lib/files.com.rb', line 200

def workspace_id
  @workspace_id
end

Class Method Details

.app_info ⇒ Object 



276
277
278
 
# File 'lib/files.com.rb', line 276

def self.app_info
  @app_info
end

.app_info=(info) ⇒ Object 



280
281
282
 
# File 'lib/files.com.rb', line 280

def self.app_info=(info)
  @app_info = info
end

.log_level ⇒ Object

When set prompts the library to log some extra information to $stdout and $stderr about what it's doing. For example, it'll produce information about requests, responses, and errors that are received. Valid log levels are debug and info, with debug being a little more verbose in places.

Use of this configuration is only useful when .logger is not set. When it is, the decision what levels to print is entirely deferred to the logger.



215
216
217
 
# File 'lib/files.com.rb', line 215

def self.log_level
  @log_level
end

.log_level=(val) ⇒ Object 



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/files.com.rb', line 219

def self.log_level=(val)
  # Backwards compatibility for values that we briefly allowed
  case val
  when "debug"
    val = LEVEL_DEBUG
  when "info"
    val = LEVEL_INFO
  end

  if !val.nil? && ![ LEVEL_DEBUG, LEVEL_ERROR, LEVEL_INFO ].include?(val)
    raise ArgumentError,
          "log_level should only be set to `nil`, `debug` or `info`"
  end
  @log_level = val
end

.logger ⇒ Object

Sets a logger to which logging output will be sent. The logger should support the same interface as the Logger class that's part of Ruby's standard library (hint, anything in Rails.logger will likely be suitable).

If .logger is set, the value of .log_level is ignored. The decision on what levels to print is entirely deferred to the logger.



242
243
244
 
# File 'lib/files.com.rb', line 242

def self.logger
  @logger
end

.logger=(val) ⇒ Object 



246
247
248
 
# File 'lib/files.com.rb', line 246

def self.logger=(val)
  @logger = val
end

.max_network_retries ⇒ Object 



250
251
252
 
# File 'lib/files.com.rb', line 250

def self.max_network_retries
  @max_network_retries
end

.max_network_retries=(val) ⇒ Object 



254
255
256
 
# File 'lib/files.com.rb', line 254

def self.max_network_retries=(val)
  @max_network_retries = val.to_i
end

.session=(session) ⇒ Object 



258
259
260
261
 
# File 'lib/files.com.rb', line 258

def self.session=(session)
  session.save unless session.id
  self.session_id = session.id
end

.set_app_info(name, partner_id: nil, url: nil, version: nil) ⇒ Object

Sets some basic information about the running application that's sent along with API requests.

Takes a name and optional partner program ID, plugin URL, and version.



267
268
269
270
271
272
273
274
 
# File 'lib/files.com.rb', line 267

def self.set_app_info(name, partner_id: nil, url: nil, version: nil)
  @app_info = {
    name: name,
    partner_id: partner_id,
    url: url,
    version: version,
  }
end