files.com 1.1.207 → 1.1.209

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e320daf55d9a2f7129ec3243103cc2a5b35e398702314a49a769775cdbaad49c
-  data.tar.gz: 1b21167c8d91faaf452e34db8a2d92caf4a6c55d5e56bc44829258b3a929b99b
+  metadata.gz: 68178822d907592200032431d45cb642e14fb43c69a90581dd5ba57f736a98ee
+  data.tar.gz: 4ef6c6c634a31505d20134df1cd55663efd6e205834686dbced284d5d1933468
 SHA512:
-  metadata.gz: cae91452fcfbcce6427eeb36b8ac5d5e5b651a8fa769e4dab4ab7f834cd7b342da779ef62759e4aa39d5855eb10851d76d6c03036652f003f66ef777c7bc309a
-  data.tar.gz: 2857c2d365ac114c36a9e7eb6a2d92724e45ff6c230af2846b2e9074e7c2b3615af182b4473430259f8a9ab72995d98a0248914f1d74c84565f8765015def4c3
+  metadata.gz: b7b1227eaf4f216a59850eac06d26f94e0b22d57bd006e37a8523b74633abf9b9375044a7de2bceef5f7d6a6a70b31051c36074488631c0b8af06659fa6ec008
+  data.tar.gz: 789287b933acc3a43c4390fd47dc1e915d37f055fcdd8fcea2cec05d6f89db412247f7fe7d03b32ca80ece12840835c478b7804cb76679007a0304acd511167c

data/README.md

@@ -69,8 +69,14 @@ that user can access, and no access will be granted to site administration funct
 ```ruby title="Example Request"
 Files.api_key = 'YOUR_API_KEY'
 
-## Alternatively, you can specify the API key on a per-request basis in the final parameter to any method or initializer.
-Files::User.new(params, api_key: 'YOUR_API_KEY')
+begin
+  # Alternatively, you can specify the API key on a per-request basis in the final parameter to any method or initializer.
+  Files::User.new(params, api_key: 'YOUR_API_KEY')
+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
 ```
 
 Don't forget to replace the placeholder, `YOUR_API_KEY`, with your actual API key.
@@ -95,7 +101,13 @@ password.
 This returns a session object that can be used to authenticate SDK method calls.
 
 ```ruby title="Example Request"
-session = Files::Session.create(username: "username", password: "password")
+begin
+  session = Files::Session.create(username: "username", password: "password")
+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
 ```
 
 #### Using a Session
@@ -104,14 +116,19 @@ Once a session has been created, you can store the session globally, use the ses
 
 ```ruby title="Example Requests"
 ## You may set the returned session to be used by default for subsequent requests.
-Files.session = Files::Session.create(username: "username", password: "password")
+Files.session = session
 
-## Alternatively, you can specify the session ID on a per-object basis in the second parameter to a model constructor.
-user = Files::User.new(params, session_id: session.id)
-
-## You may also specify the session ID on a per-request basis in the final parameter to static methods.
-Files::Group.list({}, session_id: session.id)
+begin
+  # Alternatively, you can specify the session ID on a per-object basis in the second parameter to a model constructor.
+  user = Files::User.new(params, session_id: session.id)
 
+  # You may also specify the session ID on a per-request basis in the final parameter to static methods.
+  Files::Group.list({}, session_id: session.id)
+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
 ```
 
 #### Logging Out
@@ -119,7 +136,13 @@ Files::Group.list({}, session_id: session.id)
 User sessions can be ended calling the `destroy` method on the `session` object.
 
 ```ruby title="Example Request"
-session.destroy()
+begin
+  session.destroy()
+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
 ```
 
 ## Configuration
@@ -216,10 +239,16 @@ The argument value is a Ruby hash that has a key of the resource field name to s
 of either ```"asc"``` or ```"desc"``` to specify the sort order.
 
 ```ruby title="Sort Example"
-## users sorted by username
-Files::User.list(
-  sort_by: { "username": "asc"}
-)
+begin
+  # users sorted by username
+  Files::User.list(
+    sort_by: { "username": "asc" }
+  )
+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
 ```
 
 ### Filtering
@@ -246,33 +275,57 @@ and a passed in value to use in the filter comparison.
 | `filter_lteq` | Range | Find resources that have a field value that is less than or equal to the passed in value.  (i.e., FIELD_VALUE \<= PASS_IN_VALUE). |
 
 ```ruby title="Exact Filter Example"
-## non admin users
-Files::User.list(
-  filter: { not_site_admin: true }
-)
+begin
+  # non admin users
+  Files::User.list(
+    filter: { not_site_admin: true }
+  )
+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
 ```
 
 ```ruby title="Range Filter Example"
-## users who haven't logged in since 2024-01-01
-Files::User.list(
-  filter_gteq: { "last_login_at": "2024-01-01" }
-)
+begin
+  # users who haven't logged in since 2024-01-01
+  Files::User.list(
+    filter_gteq: { "last_login_at": "2024-01-01" }
+  )
+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
 ```
 
 ```ruby title="Pattern Filter Example"
-## users whose usernames start with 'test'
-Files::User.list(
-  filter_pre: { username: "test" }
-)
+begin
+  # users whose usernames start with 'test'
+  Files::User.list(
+    filter_pre: { username: "test" }
+  )
+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
 ```
 
 ```ruby title="Combination Filter with Sort Example"
-## users whose usernames start with 'test' and are not admins
-Files::User.list(
-  filter_prefix: { username: "test" },
-  filter: { not_site_admin: true },
-  sort_by: { "username": "asc"}
-)
+begin
+  # users whose usernames start with 'test' and are not admins
+  Files::User.list(
+    filter_prefix: { username: "test" },
+    filter: { not_site_admin: true },
+    sort_by: { "username": "asc" }
+  )
+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
 ```
 
 ## Errors
@@ -296,9 +349,9 @@ rescue for general `Files::Error` as a catch-all.
 begin
   session = Files::Session.create(username: "USERNAME", password: "BADPASSWORD")
 rescue Files::NotAuthenticatedError => e
-  puts "An Authentication Error has occurred (#{e.class.to_s}): " + e.message
+  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
 rescue Files::Error => e
-  puts "An Unknown Error has occurred (#{e.class.to_s}): " + e.message
+  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
 end
 ```
 

data/_VERSION

@@ -1 +1 @@
-1.1.207
+1.1.209

data/docs/folder.md

@@ -113,7 +113,7 @@ Files::Folder.list_for(path,
 * `path` (string): Required - Path to operate on.
 * `preview_size` (string): Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
 * `sort_by` (object): Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`.  Valid directions are `asc` and `desc`.  Defaults to `{"path":"asc"}`.
-* `search` (string): If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  Results may be trunacted if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
+* `search` (string): If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  Results may be truncated if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
 * `search_all` (boolean): Search entire site?  If set, we will ignore the folder path provided and search the entire site.  This is the same API used by the search bar in the web UI when running 'Search All Files'.  Search results are a best effort, not real time, and not guaranteed to match every file.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
 * `with_previews` (boolean): Include file previews?
 * `with_priority_color` (boolean): Include file priority color information?

data/lib/files.com/models/folder.rb

@@ -482,7 +482,7 @@ module Files
     #   path (required) - string - Path to operate on.
     #   preview_size - string - Request a preview size.  Can be `small` (default), `large`, `xlarge`, or `pdf`.
     #   sort_by - object - Search by field and direction. Valid fields are `path`, `size`, `modified_at_datetime`, `provided_modified_at`.  Valid directions are `asc` and `desc`.  Defaults to `{"path":"asc"}`.
-    #   search - string - If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  Results may be trunacted if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
+    #   search - string - If specified, will search the folders/files list by name. Ignores text before last `/`. This is the same API used by the search bar in the web UI when running 'Search This Folder'.  Search results are a best effort, not real time, and not guaranteed to perfectly match the latest folder listing.  Results may be truncated if more than 1,000 possible matches exist.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
     #   search_all - boolean - Search entire site?  If set, we will ignore the folder path provided and search the entire site.  This is the same API used by the search bar in the web UI when running 'Search All Files'.  Search results are a best effort, not real time, and not guaranteed to match every file.  This field should only be used for ad-hoc (human) searching, and not as part of an automated process.
     #   with_previews - boolean - Include file previews?
     #   with_priority_color - boolean - Include file priority color information?

data/lib/files.com/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Files
-  VERSION = "1.1.207"
+  VERSION = "1.1.209"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.207
+  version: 1.1.209
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-08 00:00:00.000000000 Z
+date: 2025-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable