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/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/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/status.rb,
lib/files.com/models/api_key.rb,
lib/files.com/models/as2_key.rb,
lib/files.com/models/history.rb,
lib/files.com/models/invoice.rb,
lib/files.com/models/message.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/session.rb,
lib/files.com/models/behavior.rb,
lib/files.com/system_profiler.rb,
lib/files.com/models/clickwrap.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/file_action.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/sso_strategy.rb,
lib/files.com/models/user_request.rb,
lib/files.com/models/webhook_test.rb,
lib/files.com/models/remote_server.rb,
lib/files.com/models/external_event.rb,
lib/files.com/models/form_field_set.rb,
lib/files.com/models/history_export.rb,
lib/files.com/models/usage_snapshot.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/settings_change.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/account_line_item.rb,
lib/files.com/models/invoice_line_item.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/inbox_registration.rb,
lib/files.com/models/bundle_registration.rb,
lib/files.com/models/usage_daily_snapshot.rb,
lib/files.com/models/file_comment_reaction.rb,
lib/files.com/models/history_export_result.rb,
lib/files.com/models/message_comment_reaction.rb

Defined Under Namespace

Modules: URI, Util Classes: APIConnectionError, APIError, AccountAlreadyExistsError, AccountLineItem, AccountOverdueError, Action, Api, ApiClient, ApiKey, ApiKeyIsDisabledError, ApiKeyIsPathRestrictedError, ApiKeyNotFoundError, ApiKeyOnlyForDesktopAppError, ApiKeyOnlyForOfficeIntegrationError, App, As2Key, AttachmentTooLargeError, AuthenticationError, AuthenticationRequiredError, Auto, Automation, BadRequestError, BandwidthSnapshot, Behavior, BillingPermissionRequiredError, Bundle, BundleDownload, BundleMaximumUsesReachedError, BundlePathNotFoundError, BundleRecipient, BundleRegistration, BundleRegistrationCodeFailedError, CannotDownloadDirectoryError, CannotLoginWhileUsingKeyError, CantActForOtherUserError, CantMoveWithMultipleLocationsError, Clickwrap, CodeNotFoundError, ContactAdminForPasswordChangeHelpError, DatetimeParseError, DestinationExistsError, DestinationFolderLimitedError, DestinationParentConflictError, DestinationParentDoesNotExistError, DestinationSameError, DnsRecord, Error, Errors, ExpiredPublicKeyError, ExternalEvent, FailedToChangePasswordError, File, FileAction, FileComment, FileCommentReaction, FileLockedError, FileNotFoundError, FileNotUploadedError, FilePendingProcessingError, FileUploadNotFoundError, FileUploadPart, FileUploadedToWrongRegionError, FileUtils, Folder, FolderAdminOrBillingPermissionRequiredError, FolderAdminPermissionRequiredError, FolderLockedError, FolderMustNotBeAFileError, FolderNotEmptyError, FolderNotFoundError, FormField, FormFieldSet, Group, GroupNotFoundError, GroupUser, History, HistoryExport, HistoryExportFailureError, HistoryExportNonAdminsMustQueryByFolderOrPathError, HistoryExportNotReadyError, HistoryExportResult, HistoryPermissionRequiredError, HistoryUnavailableError, Image, InboxNotFoundError, InboxRecipient, InboxRegistration, InboxRegistrationCodeFailedError, InboxUpload, InsufficientPermissionForParamsError, InvalidBodyError, InvalidBundleCodeError, InvalidCredentialsError, InvalidCursorError, InvalidEtagsError, InvalidFileTypeError, InvalidFilenameError, InvalidFilterCombinationError, InvalidFilterFieldError, InvalidInputEncodingError, InvalidInterfaceError, InvalidOauthError, InvalidOauthProviderError, InvalidOrExpiredCodeError, InvalidParameterError, InvalidRangeError, InvalidReturnToUrlError, InvalidUploadOffsetError, InvalidUploadPartGapError, InvalidUploadPartSizeError, InvalidUsernameOrPasswordError, Invoice, InvoiceLineItem, IpAddress, List, Lock, LockedOutError, LockoutRegionMismatchError, Message, MessageComment, MessageCommentReaction, MessageReaction, MethodNotAllowedError, MissingParameterError, ModelSaveErrorError, MultipartUploadsRequiredForRemotesError, MultipleProcessingErrorsError, MustAuthenticateWithApiKeyError, NeedAdminPermissionForInboxError, NestedNotFoundError, NoAccountForSiteError, NoValidInputParamsError, NotAllowedToCreateBundleError, NotAuthenticatedError, NotAuthorizedError, NotFoundError, NotImplementedError, Notification, OneTimePasswordIncorrectError, OperationOnNonScimResourceError, PartNumberTooLargeError, PasswordChangeNotRequiredError, PasswordChangeRequiredError, Payment, PaymentLineItem, Permission, PlanNotFoundError, Preview, ProcessingFailureError, Project, PublicIpAddress, PublicKey, RateLimitedError, ReadOnlySessionError, ReadPermissionRequiredError, ReauthenticationFailedError, ReauthenticationFailedFinalError, ReauthenticationNeededActionError, ReauthenticationNeededFieldsError, ReauthenticationRateLimitedError, RemoteServer, RemoteServerErrorError, Request, RequestParamPathCannotHaveTrailingWhitespaceError, RequestParamsContainInvalidCharacterError, RequestParamsInvalidError, RequestParamsRequiredError, ResourceLockedError, Response, SelfManagedRequiredError, Session, SettingsChange, Site, SiteAdminRequiredError, SiteConfigurationError, SiteNotFoundError, SiteWasRemovedError, SizableIO, SsoStrategy, Status, Style, SubfolderLockedError, SystemProfiler, TooManyLoginAttemptsError, TooManyRequestsError, TrialExpiredError, TrialLockedError, TwoFactorAuthenticationCodeAlreadySentError, TwoFactorAuthenticationErrorError, TwoFactorAuthenticationRequiredError, TwoFactorAuthenticationSetupExpiredError, UnsupportedCurrencyError, UnsupportedHttpResponseFormatError, UnsupportedMediaTypeError, UpdatesNotAllowedForRemotesError, UsageDailySnapshot, UsageSnapshot, User, UserCipherUse, UserIdInvalidError, UserIdOnUserEndpointError, UserIdWithoutSiteAdminError, UserNotFoundError, UserRequest, UserRequestsEnabledRequiredError, UserRequiredError, WebhookTest, WritePermissionRequiredError, ZipDownloadIpMismatchError

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.0"
Dir = 
Folder

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.api_key ⇒ Object

Returns the value of attribute api_key.



115
116
117
 
# File 'lib/files.com.rb', line 115

def api_key
  @api_key
end

.base_url ⇒ Object

Returns the value of attribute base_url.



115
116
117
 
# File 'lib/files.com.rb', line 115

def base_url
  @base_url
end

.initial_network_retry_delay ⇒ Object

Returns the value of attribute initial_network_retry_delay.



115
116
117
 
# File 'lib/files.com.rb', line 115

def initial_network_retry_delay
  @initial_network_retry_delay
end

.max_network_retry_delay ⇒ Object

Returns the value of attribute max_network_retry_delay.



115
116
117
 
# File 'lib/files.com.rb', line 115

def max_network_retry_delay
  @max_network_retry_delay
end

.open_timeout ⇒ Object

Returns the value of attribute open_timeout.



115
116
117
 
# File 'lib/files.com.rb', line 115

def open_timeout
  @open_timeout
end

.proxy ⇒ Object

Returns the value of attribute proxy.



115
116
117
 
# File 'lib/files.com.rb', line 115

def proxy
  @proxy
end

.read_timeout ⇒ Object

Returns the value of attribute read_timeout.



115
116
117
 
# File 'lib/files.com.rb', line 115

def read_timeout
  @read_timeout
end

.session_id ⇒ Object

Returns the value of attribute session_id.



115
116
117
 
# File 'lib/files.com.rb', line 115

def session_id
  @session_id
end

Class Method Details

.app_info ⇒ Object 



190
191
192
 
# File 'lib/files.com.rb', line 190

def self.app_info
  @app_info
end

.app_info=(info) ⇒ Object 



194
195
196
 
# File 'lib/files.com.rb', line 194

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.



130
131
132
 
# File 'lib/files.com.rb', line 130

def self.log_level
  @log_level
end

.log_level=(val) ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/files.com.rb', line 134

def self.log_level=(val)
  # Backwards compatibility for values that we briefly allowed
  if val == "debug"
    val = LEVEL_DEBUG
  elsif val == "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.



156
157
158
 
# File 'lib/files.com.rb', line 156

def self.logger
  @logger
end

.logger=(val) ⇒ Object 



160
161
162
 
# File 'lib/files.com.rb', line 160

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

.max_network_retries ⇒ Object 



164
165
166
 
# File 'lib/files.com.rb', line 164

def self.max_network_retries
  @max_network_retries
end

.max_network_retries=(val) ⇒ Object 



168
169
170
 
# File 'lib/files.com.rb', line 168

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

.session=(session) ⇒ Object 



172
173
174
175
 
# File 'lib/files.com.rb', line 172

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.



181
182
183
184
185
186
187
188
 
# File 'lib/files.com.rb', line 181

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