files.com 1.1.735 → 1.1.737

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c5e657a8cede65f1b30b34a5532aa8533b70251cfac4e473bd47533b1e35876
-  data.tar.gz: 8a8eb050476c8355e42fbe2a86c22f18ad0d0fe2ab1c19b198d26bdd1d2a9b83
+  metadata.gz: b2a3fb76a20d379b83e7151a07b4e5d6ca409c8ece689a9a29d227a726bf19fe
+  data.tar.gz: f4974b99eb2432f9537d1482a9a22842548dae5c1e0fee494a0fed32d727b4ce
 SHA512:
-  metadata.gz: e388c37dd8980d2e00099cca5b45eb56c5640143f87deee41104a8368600d82d2bcb360d25fda3975bdb07940e9844e5da1e047f8afc86a4c8b88ff4139ecc23
-  data.tar.gz: 5943b844f36c2c4b6212d9e0fd893dc74f78bb049f6055a326fc55d598e8e4480a6a99b79aa7fdc9616f1a8c9c499cf5174d3bdd28520ef70ab0086e155198cb
+  metadata.gz: 1e99ed43ddd384c5a6cafcdebbed1540e9b940139fbcb0a18deb95479714ed8eeb5754977ca295d055facf2910de66483c04741ed8b3a55390c7bfab92431f5b
+  data.tar.gz: c611152987f1f551e62681e707e4e282fe4e0750cb261cfda7e0d1e6bab8b3761931bf7e7eb859ec7ad372731eb648770b59407108b8d105fa024c9834be1788

data/README.md

@@ -559,6 +559,7 @@ Files::FolderAdminPermissionRequiredError -> Files::NotAuthorizedError -> Files:
 |`ApiKeyIsDisabledError`|  `NotAuthorizedError` |
 |`ApiKeyIsPathRestrictedError`|  `NotAuthorizedError` |
 |`ApiKeyOnlyForDesktopAppError`|  `NotAuthorizedError` |
+|`ApiKeyOnlyForFileOperationsError`|  `NotAuthorizedError` |
 |`ApiKeyOnlyForMobileAppError`|  `NotAuthorizedError` |
 |`ApiKeyOnlyForOfficeIntegrationError`|  `NotAuthorizedError` |
 |`BillingInformationHiddenError`|  `NotAuthorizedError` |

data/_VERSION

@@ -1 +1 @@
-1.1.735
+1.1.737

data/docs/api_key.md

@@ -36,14 +36,14 @@
 * `aws_secret_key` (string): AWS Secret Key to use with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
 * `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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
+* `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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. They cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user, and every other endpoint denies them with `not-authorized/api-key-only-for-file-operations`.
 * `platform` (string): If this API key represents a Desktop app, what platform was it created on?
 * `site_id` (int64): Site ID
 * `site_name` (string): Site Name
 * `url` (string): URL for API host.
 * `user_id` (int64): User ID for the owner of this API Key.  May be blank for Site-wide API Keys.
 * `workspace_id` (int64): Workspace ID for this API Key. `0` means the default workspace.
-* `path` (string): Restricts this API key to the specified folder and its descendants. Applies to every permission set and all paths accessed by a request, including copy and move destinations. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
+* `path` (string): Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. Other endpoints do not apply the path restriction; use the `files_only` permission set to confine a key to the endpoints that do. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
 
 
 ---
@@ -115,8 +115,8 @@ Files::ApiKey.create(
 * `expires_at` (string): API Key expiration date
 * `name` (string): Required - Internal name for the API Key.  For your use.
 * `aws_style_credentials` (boolean): If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
-* `path` (string): Restricts this API key to the specified folder and its descendants. Applies to every permission set and all paths accessed by a request, including copy and move destinations. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
-* `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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
+* `path` (string): Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. Other endpoints do not apply the path restriction; use the `files_only` permission set to confine a key to the endpoints that do. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
+* `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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. They cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user, and every other endpoint denies them with `not-authorized/api-key-only-for-file-operations`.
 * `workspace_id` (int64): Workspace ID for this API Key. `0` means the default workspace.
 
 
@@ -136,7 +136,7 @@ Files::ApiKey.update_current(
 
 * `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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
+* `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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. They cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user, and every other endpoint denies them with `not-authorized/api-key-only-for-file-operations`.
 
 
 ---

data/docs/partner.md

@@ -48,7 +48,7 @@
 * `notes` (string): Notes about this Partner.
 * `partner_admin_ids` (array(int64)): Array of User IDs that are Partner Admins for this Partner.
 * `partner_channel_template_id` (int64): ID of the Partner Channel Template assigned to this Partner.
-* `partnership_role` (string): This site's role in Partner Site relationships for this Partner. Can be `host`, `guest`, `host_and_guest`, or null.
+* `partnership_role` (string): This site's role for this Partner in Connected Sites relationships. `host` is a Partner this site configured. `guest` is a Partner created by approving another site's connection request; it has no root folder and cannot hold users, permissions, or Partner Channels, or host a connection. `host_and_guest` is a configured Partner that is also the guest side of a connection. Promote a `guest` Partner by setting this to `host_and_guest` together with a `root_folder`.
 * `responsible_group_id` (int64): ID of the Group responsible for this Partner.
 * `responsible_user_id` (int64): ID of the User responsible for this Partner.
 * `root_folder` (string): The root folder path for this Partner.
@@ -151,6 +151,7 @@ Files::Partner.update(id,
   show_partner_channel_home_page: false, 
   tags: "example", 
   name: "Acme Corp", 
+  partnership_role: "host", 
   root_folder: "/AcmeCorp"
 )
 ```
@@ -172,6 +173,7 @@ Files::Partner.update(id,
 * `show_partner_channel_home_page` (boolean): Show Partner users a simplified home page built from this Partner's Channels.
 * `tags` (string): Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
 * `name` (string): The name of the Partner.
+* `partnership_role` (string): This site's role for this Partner in Connected Sites relationships. `host` is a Partner this site configured. `guest` is a Partner created by approving another site's connection request; it has no root folder and cannot hold users, permissions, or Partner Channels, or host a connection. `host_and_guest` is a configured Partner that is also the guest side of a connection. Promote a `guest` Partner by setting this to `host_and_guest` together with a `root_folder`.
 * `root_folder` (string): The root folder path for this Partner.
 
 
@@ -210,6 +212,7 @@ partner.update(
   show_partner_channel_home_page: false,
   tags: "example",
   name: "Acme Corp",
+  partnership_role: "host",
   root_folder: "/AcmeCorp"
 )
 ```
@@ -231,6 +234,7 @@ partner.update(
 * `show_partner_channel_home_page` (boolean): Show Partner users a simplified home page built from this Partner's Channels.
 * `tags` (string): Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
 * `name` (string): The name of the Partner.
+* `partnership_role` (string): This site's role for this Partner in Connected Sites relationships. `host` is a Partner this site configured. `guest` is a Partner created by approving another site's connection request; it has no root folder and cannot hold users, permissions, or Partner Channels, or host a connection. `host_and_guest` is a configured Partner that is also the guest side of a connection. Promote a `guest` Partner by setting this to `host_and_guest` together with a `root_folder`.
 * `root_folder` (string): The root folder path for this Partner.
 
 

data/docs/partner_site_request.md

@@ -94,13 +94,15 @@ Files::PartnerSiteRequest.reject(
 
 ```
 Files::PartnerSiteRequest.approve(
-  pairing_key: "pairing_key"
+  pairing_key: "pairing_key", 
+  partner_id: 1
 )
 ```
 
 ### Parameters
 
 * `pairing_key` (string): Required - Pairing key for the partner site request
+* `partner_id` (int64): ID of an existing Partner on this site, with the host role, that represents the requesting organization. The connection binds to that Partner and makes it host_and_guest. When omitted, a guest Partner named after the host site is created.
 
 
 ---

data/lib/files.com/errors.rb

@@ -119,6 +119,7 @@ module Files
   class ApiKeyIsDisabledError < NotAuthorizedError; end
   class ApiKeyIsPathRestrictedError < NotAuthorizedError; end
   class ApiKeyOnlyForDesktopAppError < NotAuthorizedError; end
+  class ApiKeyOnlyForFileOperationsError < NotAuthorizedError; end
   class ApiKeyOnlyForMobileAppError < NotAuthorizedError; end
   class ApiKeyOnlyForOfficeIntegrationError < NotAuthorizedError; end
   class BillingInformationHiddenError < NotAuthorizedError; end

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

@@ -104,7 +104,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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
+    # 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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. They cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user, and every other endpoint denies them with `not-authorized/api-key-only-for-file-operations`.
     def permission_set
       @attributes[:permission_set]
     end
@@ -167,7 +167,7 @@ module Files
       @attributes[:workspace_id] = value
     end
 
-    # string - Restricts this API key to the specified folder and its descendants. Applies to every permission set and all paths accessed by a request, including copy and move destinations. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
+    # string - Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. Other endpoints do not apply the path restriction; use the `files_only` permission set to confine a key to the endpoints that do. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
     def path
       @attributes[:path]
     end
@@ -276,8 +276,8 @@ module Files
     #   expires_at - string - API Key expiration date
     #   name (required) - string - Internal name for the API Key.  For your use.
     #   aws_style_credentials - boolean - If `true`, this API key will be usable with AWS-compatible endpoints, such as our Inbound S3-compatible endpoint.
-    #   path - string - Restricts this API key to the specified folder and its descendants. Applies to every permission set and all paths accessed by a request, including copy and move destinations. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
-    #   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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
+    #   path - string - Restricts the file and folder operations made with this key, meaning the files, folders, and file_actions endpoints, to the specified folder and its descendants, including copy and move destinations. Other endpoints do not apply the path restriction; use the `files_only` permission set to confine a key to the endpoints that do. Does not grant access beyond the owning user's permissions. Optional except for `office_integration` keys, which require a path the owning user can read.
+    #   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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. They cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user, and every other endpoint denies them with `not-authorized/api-key-only-for-file-operations`.
     #   workspace_id - int64 - Workspace ID for this API Key. `0` means the default workspace.
     def self.create(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: user_id must be an Integer") if params[:user_id] and !params[:user_id].is_a?(Integer)
@@ -296,7 +296,7 @@ module Files
     # Parameters:
     #   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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can perform file operations as a full-access file user in the key's workspace scope, but cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user.
+    #   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). Keys with the `office_integration` permission set are auto generated, and automatically expire, to allow users to interact with office integration platforms. Keys with the `files_only` permission set can use only the files, folders, and file_actions endpoints, where they perform file operations as a full-access file user in the key's workspace scope, along with `GET /file_migrations/{id}` and `GET /api_key`. They cannot use site admin, workspace admin, folder admin, group admin, partner admin, or billing privileges from the owning user, and every other endpoint denies them with `not-authorized/api-key-only-for-file-operations`.
     def self.update_current(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: expires_at must be an String") if params[:expires_at] and !params[:expires_at].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)

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

@@ -126,7 +126,7 @@ module Files
       @attributes[:partner_channel_template_id] = value
     end
 
-    # string - This site's role in Partner Site relationships for this Partner. Can be `host`, `guest`, `host_and_guest`, or null.
+    # string - This site's role for this Partner in Connected Sites relationships. `host` is a Partner this site configured. `guest` is a Partner created by approving another site's connection request; it has no root folder and cannot hold users, permissions, or Partner Channels, or host a connection. `host_and_guest` is a configured Partner that is also the guest side of a connection. Promote a `guest` Partner by setting this to `host_and_guest` together with a `root_folder`.
     def partnership_role
       @attributes[:partnership_role]
     end
@@ -204,6 +204,7 @@ module Files
     #   show_partner_channel_home_page - boolean - Show Partner users a simplified home page built from this Partner's Channels.
     #   tags - string - Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
     #   name - string - The name of the Partner.
+    #   partnership_role - string - This site's role for this Partner in Connected Sites relationships. `host` is a Partner this site configured. `guest` is a Partner created by approving another site's connection request; it has no root folder and cannot hold users, permissions, or Partner Channels, or host a connection. `host_and_guest` is a configured Partner that is also the guest side of a connection. Promote a `guest` Partner by setting this to `host_and_guest` together with a `root_folder`.
     #   root_folder - string - The root folder path for this Partner.
     def update(params = {})
       params ||= {}
@@ -218,6 +219,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: responsible_user_id must be an Integer") if params[:responsible_user_id] and !params[:responsible_user_id].is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: tags must be an String") if params[:tags] and !params[:tags].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: partnership_role must be an String") if params[:partnership_role] and !params[:partnership_role].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: root_folder must be an String") if params[:root_folder] and !params[:root_folder].is_a?(String)
       raise MissingParameterError.new("Parameter missing: id") unless params[:id]
 
@@ -336,6 +338,7 @@ module Files
     #   show_partner_channel_home_page - boolean - Show Partner users a simplified home page built from this Partner's Channels.
     #   tags - string - Comma-separated list of Tags for this Partner. Tags are used for other features, such as UserLifecycleRules, which can target specific tags.  Tags must only contain lowercase letters, numbers, and hyphens.
     #   name - string - The name of the Partner.
+    #   partnership_role - string - This site's role for this Partner in Connected Sites relationships. `host` is a Partner this site configured. `guest` is a Partner created by approving another site's connection request; it has no root folder and cannot hold users, permissions, or Partner Channels, or host a connection. `host_and_guest` is a configured Partner that is also the guest side of a connection. Promote a `guest` Partner by setting this to `host_and_guest` together with a `root_folder`.
     #   root_folder - string - The root folder path for this Partner.
     def self.update(id, params = {}, options = {})
       params ||= {}
@@ -349,6 +352,7 @@ module Files
       raise InvalidParameterError.new("Bad parameter: responsible_user_id must be an Integer") if params[:responsible_user_id] and !params[:responsible_user_id].is_a?(Integer)
       raise InvalidParameterError.new("Bad parameter: tags must be an String") if params[:tags] and !params[:tags].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: name must be an String") if params[:name] and !params[:name].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: partnership_role must be an String") if params[:partnership_role] and !params[:partnership_role].is_a?(String)
       raise InvalidParameterError.new("Bad parameter: root_folder must be an String") if params[:root_folder] and !params[:root_folder].is_a?(String)
       raise MissingParameterError.new("Parameter missing: id") unless params[:id]
 

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

@@ -154,8 +154,10 @@ module Files
 
     # Parameters:
     #   pairing_key (required) - string - Pairing key for the partner site request
+    #   partner_id - int64 - ID of an existing Partner on this site, with the host role, that represents the requesting organization. The connection binds to that Partner and makes it host_and_guest. When omitted, a guest Partner named after the host site is created.
     def self.approve(params = {}, options = {})
       raise InvalidParameterError.new("Bad parameter: pairing_key must be an String") if params[:pairing_key] and !params[:pairing_key].is_a?(String)
+      raise InvalidParameterError.new("Bad parameter: partner_id must be an Integer") if params[:partner_id] and !params[:partner_id].is_a?(Integer)
       raise MissingParameterError.new("Parameter missing: pairing_key") unless params[:pairing_key]
 
       Api.send_request("/partner_site_requests/approve", :post, params, options)

data/lib/files.com/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: files.com
 version: !ruby/object:Gem::Version
-  version: 1.1.735
+  version: 1.1.737
 platform: ruby
 authors:
 - files.com