files.com 1.0.77 → 1.0.78

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9a51f85cdfb6f53328a7ba37b464c4c1e92f741707e0598b4ed4b70a608b5dc
-  data.tar.gz: 5e3d7b201f518ff1f65c0ddc1943dee7f549693141935f950786b0293396c368
+  metadata.gz: 0a980877cfd1d13cd77d84319021702c5caa7bf8f74505756bf56bafce53aaad
+  data.tar.gz: 35bd639b7ccfa518f7f82ac6d78e602469b912d3410ac0eaea9a9eec7b412453
 SHA512:
-  metadata.gz: 28568c4de2bcf15925978fa9c645be7c4614bd276287103226bcafb949e001de1d07946274d82239c80b87ad1153bc9d1c8c194f64d5f75b1a0635265f97bb0b
-  data.tar.gz: 0e1a26eba12d2567865ef7d0555d088dce57710064eac501db9a6a9b870dfe7749800a7c9633bb75dbb03b036c1879063e499fd0b88dd7e29e3e5b4bc95d2610
+  metadata.gz: 13e0d73c07f2664595c085a427ef1f6f29b86aec412d7229f07b4d2db91db5e750372c14a4e4e00f9dfd64e0d6478ca5903c2f45f859072bf08c40bed791be9a
+  data.tar.gz: a367d3a24b1d1c9edccd8e30dfffc65fd786edf9e5a799ec97456b1d503ec908bb44c8e87d23ef3119e213b101ca05dcaeba08146d0102d0087b8bf3307482a4

data/_VERSION

@@ -1 +1 @@
-1.0.77
+1.0.78

data/docs/api_key.md

@@ -24,7 +24,7 @@
 * `key` (string): API Key actual key string
 * `last_use_at` (date-time): API Key last used - note this value is only updated once per 3 hour period, so the 'actual' time of last use may be up to 3 hours later than this timestamp.
 * `name` (string): Internal name for the API Key.  For your use.
-* `permission_set` (string): Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations.)  We hope to offer additional permission sets in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+* `permission_set` (string): Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
 * `platform` (string): If this API key represents a Desktop app, what platform was it created on?
 * `user_id` (int64): User ID for the owner of this API Key.  May be blank for Site-wide API Keys.
 
@@ -78,18 +78,18 @@ Files::ApiKey.find(id)
 ```
 Files::ApiKey.create(
   user_id: 1, 
-  name: "My Key", 
-  permission_set: "full", 
-  expires_at: "2000-01-01T01:00:00Z"
+  name: "My Main API Key", 
+  expires_at: "2000-01-01T01:00:00Z", 
+  permission_set: "full"
 )
 ```
 
 ### Parameters
 
 * `user_id` (int64): User ID.  Provide a value of `0` to operate the current session's user.
-* `name` (string): Internal name for key.  For your reference only.
-* `permission_set` (string): Leave blank, or set to 'desktop_app' to restrict the key to only desktop app functions.
-* `expires_at` (string): Have the key expire at this date/time.
+* `name` (string): Internal name for the API Key.  For your use.
+* `expires_at` (string): API Key expiration date
+* `permission_set` (string): Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
 
 
 ---
@@ -98,17 +98,17 @@ Files::ApiKey.create(
 
 ```
 Files::ApiKey.update_current(
-  name: "My Key", 
-  permission_set: "full", 
-  expires_at: "2000-01-01T01:00:00Z"
+  expires_at: "2000-01-01T01:00:00Z", 
+  name: "My Main API Key", 
+  permission_set: "full"
 )
 ```
 
 ### Parameters
 
-* `name` (string): Internal name for key.  For your reference only.
-* `permission_set` (string): Leave blank, or set to `desktop_app` to restrict the key to only desktop app functions.
-* `expires_at` (string): Have the key expire at this date/time.
+* `expires_at` (string): API Key expiration date
+* `name` (string): Internal name for the API Key.  For your use.
+* `permission_set` (string): Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
 
 
 ---
@@ -117,18 +117,18 @@ Files::ApiKey.update_current(
 
 ```
 Files::ApiKey.update(id, 
-  name: "My Key", 
-  permission_set: "full", 
-  expires_at: "2000-01-01T01:00:00Z"
+  name: "My Main API Key", 
+  expires_at: "2000-01-01T01:00:00Z", 
+  permission_set: "full"
 )
 ```
 
 ### Parameters
 
 * `id` (int64): Required - Api Key ID.
-* `name` (string): Internal name for key.  For your reference only.
-* `permission_set` (string): Leave blank, or set to 'desktop_app' to restrict the key to only desktop app functions.
-* `expires_at` (string): Have the key expire at this date/time.
+* `name` (string): Internal name for the API Key.  For your use.
+* `expires_at` (string): API Key expiration date
+* `permission_set` (string): Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
 
 
 ---
@@ -161,18 +161,18 @@ Files::ApiKey.delete(id)
 api_key = Files::ApiKey.list_for(path).first
 
 api_key.update(
-  name: "My Key",
-  permission_set: "full",
-  expires_at: "2000-01-01T01:00:00Z"
+  name: "My Main API Key",
+  expires_at: "2000-01-01T01:00:00Z",
+  permission_set: "full"
 )
 ```
 
 ### Parameters
 
 * `id` (int64): Required - Api Key ID.
-* `name` (string): Internal name for key.  For your reference only.
-* `permission_set` (string): Leave blank, or set to 'desktop_app' to restrict the key to only desktop app functions.
-* `expires_at` (string): Have the key expire at this date/time.
+* `name` (string): Internal name for the API Key.  For your use.
+* `expires_at` (string): API Key expiration date
+* `permission_set` (string): Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
 
 
 ---

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

@@ -68,7 +68,7 @@ module Files
       @attributes[:name] = value
     end
 
-    # string - Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations.)  We hope to offer additional permission sets in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
+    # string - Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
     def permission_set
       @attributes[:permission_set]
     end
@@ -96,17 +96,17 @@ module Files
     end
 
     # Parameters:
-    #   name - string - Internal name for key.  For your reference only.
-    #   permission_set - string - Leave blank, or set to 'desktop_app' to restrict the key to only desktop app functions.
-    #   expires_at - string - Have the key expire at this date/time.
+    #   name - string - Internal name for the API Key.  For your use.
+    #   expires_at - string - API Key expiration date
+    #   permission_set - string - Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
     def update(params = {})
       params ||= {}
       params[:id] = @attributes[:id]
       raise MissingParameterError.new("Current object doesn't have a id") unless @attributes[:id]
       raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params.dig(:permission_set) and !params.dig(:permission_set).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params.dig(:permission_set) and !params.dig(:permission_set).is_a?(String)
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
 
       Api.send_request("/api_keys/#{@attributes[:id]}", :patch, params, @options)
@@ -179,43 +179,43 @@ module Files
 
     # Parameters:
     #   user_id - int64 - User ID.  Provide a value of `0` to operate the current session's user.
-    #   name - string - Internal name for key.  For your reference only.
-    #   permission_set - string - Leave blank, or set to 'desktop_app' to restrict the key to only desktop app functions.
-    #   expires_at - string - Have the key expire at this date/time.
+    #   name - string - Internal name for the API Key.  For your use.
+    #   expires_at - string - API Key expiration date
+    #   permission_set - string - Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params.dig(:user_id) and !params.dig(:user_id).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params.dig(:permission_set) and !params.dig(:permission_set).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params.dig(:permission_set) and !params.dig(:permission_set).is_a?(String)
 
       response, options = Api.send_request("/api_keys", :post, params, options)
       ApiKey.new(response.data, options)
     end
 
     # Parameters:
-    #   name - string - Internal name for key.  For your reference only.
-    #   permission_set - string - Leave blank, or set to `desktop_app` to restrict the key to only desktop app functions.
-    #   expires_at - string - Have the key expire at this date/time.
+    #   expires_at - string - API Key expiration date
+    #   name - string - Internal name for the API Key.  For your use.
+    #   permission_set - string - Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
     def self.update_current(params = {}, options = {})
+      raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params.dig(:permission_set) and !params.dig(:permission_set).is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
 
       response, options = Api.send_request("/api_key", :patch, params, options)
       ApiKey.new(response.data, options)
     end
 
     # Parameters:
-    #   name - string - Internal name for key.  For your reference only.
-    #   permission_set - string - Leave blank, or set to 'desktop_app' to restrict the key to only desktop app functions.
-    #   expires_at - string - Have the key expire at this date/time.
+    #   name - string - Internal name for the API Key.  For your use.
+    #   expires_at - string - API Key expiration date
+    #   permission_set - string - Permissions for this API Key.  Keys with the `desktop_app` permission set only have the ability to do the functions provided in our Desktop App (File and Share Link operations).  Additional permission sets may become available in the future, such as for a Site Admin to give a key with no administrator privileges.  If you have ideas for permission sets, please let us know.
     def self.update(id, params = {}, options = {})
       params ||= {}
       params[:id] = id
       raise InvalidParameterError.new("Bad parameter: id must be an Integer") if params.dig(:id) and !params.dig(:id).is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params.dig(:name) and !params.dig(:name).is_a?(String)
-      raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params.dig(:permission_set) and !params.dig(:permission_set).is_a?(String)
       raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params.dig(:expires_at) and !params.dig(:expires_at).is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: permission_set must be an String") if params.dig(:permission_set) and !params.dig(:permission_set).is_a?(String)
       raise MissingParameterError.new("Parameter missing: id") unless params.dig(:id)
 
       response, options = Api.send_request("/api_keys/#{params[:id]}", :patch, params, options)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.0.77
+  version: 1.0.78
 platform: ruby
 authors:
 - files.com
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-30 00:00:00.000000000 Z
+date: 2020-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable