aws-sdk-workdocs 1.39.0 → 1.41.0

data/lib/aws-sdk-workdocs/plugins/endpoints.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+
+module Aws::WorkDocs
+  module Plugins
+    class Endpoints < Seahorse::Client::Plugin
+      option(
+        :endpoint_provider,
+        doc_type: 'Aws::WorkDocs::EndpointProvider',
+        docstring: 'The endpoint provider used to resolve endpoints. Any '\
+                   'object that responds to `#resolve_endpoint(parameters)` '\
+                   'where `parameters` is a Struct similar to '\
+                   '`Aws::WorkDocs::EndpointParameters`'
+      ) do |cfg|
+        Aws::WorkDocs::EndpointProvider.new
+      end
+
+      # @api private
+      class Handler < Seahorse::Client::Handler
+        def call(context)
+          # If endpoint was discovered, do not resolve or apply the endpoint.
+          unless context[:discovered_endpoint]
+            params = parameters_for_operation(context)
+            endpoint = context.config.endpoint_provider.resolve_endpoint(params)
+
+            context.http_request.endpoint = endpoint.url
+            apply_endpoint_headers(context, endpoint.headers)
+          end
+
+          context[:endpoint_params] = params
+          context[:auth_scheme] =
+            Aws::Endpoints.resolve_auth_scheme(context, endpoint)
+
+          @handler.call(context)
+        end
+
+        private
+
+        def apply_endpoint_headers(context, headers)
+          headers.each do |key, values|
+            value = values
+              .compact
+              .map { |s| Seahorse::Util.escape_header_list_string(s.to_s) }
+              .join(',')
+
+            context.http_request.headers[key] = value
+          end
+        end
+
+        def parameters_for_operation(context)
+          case context.operation_name
+          when :abort_document_version_upload
+            Aws::WorkDocs::Endpoints::AbortDocumentVersionUpload.build(context)
+          when :activate_user
+            Aws::WorkDocs::Endpoints::ActivateUser.build(context)
+          when :add_resource_permissions
+            Aws::WorkDocs::Endpoints::AddResourcePermissions.build(context)
+          when :create_comment
+            Aws::WorkDocs::Endpoints::CreateComment.build(context)
+          when :create_custom_metadata
+            Aws::WorkDocs::Endpoints::CreateCustomMetadata.build(context)
+          when :create_folder
+            Aws::WorkDocs::Endpoints::CreateFolder.build(context)
+          when :create_labels
+            Aws::WorkDocs::Endpoints::CreateLabels.build(context)
+          when :create_notification_subscription
+            Aws::WorkDocs::Endpoints::CreateNotificationSubscription.build(context)
+          when :create_user
+            Aws::WorkDocs::Endpoints::CreateUser.build(context)
+          when :deactivate_user
+            Aws::WorkDocs::Endpoints::DeactivateUser.build(context)
+          when :delete_comment
+            Aws::WorkDocs::Endpoints::DeleteComment.build(context)
+          when :delete_custom_metadata
+            Aws::WorkDocs::Endpoints::DeleteCustomMetadata.build(context)
+          when :delete_document
+            Aws::WorkDocs::Endpoints::DeleteDocument.build(context)
+          when :delete_document_version
+            Aws::WorkDocs::Endpoints::DeleteDocumentVersion.build(context)
+          when :delete_folder
+            Aws::WorkDocs::Endpoints::DeleteFolder.build(context)
+          when :delete_folder_contents
+            Aws::WorkDocs::Endpoints::DeleteFolderContents.build(context)
+          when :delete_labels
+            Aws::WorkDocs::Endpoints::DeleteLabels.build(context)
+          when :delete_notification_subscription
+            Aws::WorkDocs::Endpoints::DeleteNotificationSubscription.build(context)
+          when :delete_user
+            Aws::WorkDocs::Endpoints::DeleteUser.build(context)
+          when :describe_activities
+            Aws::WorkDocs::Endpoints::DescribeActivities.build(context)
+          when :describe_comments
+            Aws::WorkDocs::Endpoints::DescribeComments.build(context)
+          when :describe_document_versions
+            Aws::WorkDocs::Endpoints::DescribeDocumentVersions.build(context)
+          when :describe_folder_contents
+            Aws::WorkDocs::Endpoints::DescribeFolderContents.build(context)
+          when :describe_groups
+            Aws::WorkDocs::Endpoints::DescribeGroups.build(context)
+          when :describe_notification_subscriptions
+            Aws::WorkDocs::Endpoints::DescribeNotificationSubscriptions.build(context)
+          when :describe_resource_permissions
+            Aws::WorkDocs::Endpoints::DescribeResourcePermissions.build(context)
+          when :describe_root_folders
+            Aws::WorkDocs::Endpoints::DescribeRootFolders.build(context)
+          when :describe_users
+            Aws::WorkDocs::Endpoints::DescribeUsers.build(context)
+          when :get_current_user
+            Aws::WorkDocs::Endpoints::GetCurrentUser.build(context)
+          when :get_document
+            Aws::WorkDocs::Endpoints::GetDocument.build(context)
+          when :get_document_path
+            Aws::WorkDocs::Endpoints::GetDocumentPath.build(context)
+          when :get_document_version
+            Aws::WorkDocs::Endpoints::GetDocumentVersion.build(context)
+          when :get_folder
+            Aws::WorkDocs::Endpoints::GetFolder.build(context)
+          when :get_folder_path
+            Aws::WorkDocs::Endpoints::GetFolderPath.build(context)
+          when :get_resources
+            Aws::WorkDocs::Endpoints::GetResources.build(context)
+          when :initiate_document_version_upload
+            Aws::WorkDocs::Endpoints::InitiateDocumentVersionUpload.build(context)
+          when :remove_all_resource_permissions
+            Aws::WorkDocs::Endpoints::RemoveAllResourcePermissions.build(context)
+          when :remove_resource_permission
+            Aws::WorkDocs::Endpoints::RemoveResourcePermission.build(context)
+          when :restore_document_versions
+            Aws::WorkDocs::Endpoints::RestoreDocumentVersions.build(context)
+          when :update_document
+            Aws::WorkDocs::Endpoints::UpdateDocument.build(context)
+          when :update_document_version
+            Aws::WorkDocs::Endpoints::UpdateDocumentVersion.build(context)
+          when :update_folder
+            Aws::WorkDocs::Endpoints::UpdateFolder.build(context)
+          when :update_user
+            Aws::WorkDocs::Endpoints::UpdateUser.build(context)
+          end
+        end
+      end
+
+      def add_handlers(handlers, _config)
+        handlers.add(Handler, step: :build, priority: 75)
+      end
+    end
+  end
+end

data/lib/aws-sdk-workdocs/types.rb

@@ -530,7 +530,7 @@ module Aws::WorkDocs
     #       {
     #         organization_id: "IdType", # required
     #         endpoint: "SubscriptionEndPointType", # required
-    #         protocol: "HTTPS", # required, accepts HTTPS
+    #         protocol: "HTTPS", # required, accepts HTTPS, SQS
     #         subscription_type: "ALL", # required, accepts ALL
     #       }
     #
@@ -642,7 +642,7 @@ module Aws::WorkDocs
       :time_zone_id,
       :storage_rule,
       :authentication_token)
-      SENSITIVE = [:password, :authentication_token]
+      SENSITIVE = [:email_address, :password, :authentication_token]
       include Aws::Structure
     end
 
@@ -818,6 +818,45 @@ module Aws::WorkDocs
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DeleteDocumentVersionRequest
+    #   data as a hash:
+    #
+    #       {
+    #         authentication_token: "AuthenticationHeaderType",
+    #         document_id: "ResourceIdType", # required
+    #         version_id: "DocumentVersionIdType", # required
+    #         delete_prior_versions: false, # required
+    #       }
+    #
+    # @!attribute [rw] authentication_token
+    #   Amazon WorkDocs authentication token. Not required when using AWS
+    #   administrator credentials to access the API.
+    #   @return [String]
+    #
+    # @!attribute [rw] document_id
+    #   The ID of a document.
+    #   @return [String]
+    #
+    # @!attribute [rw] version_id
+    #   The version ID of a document.
+    #   @return [String]
+    #
+    # @!attribute [rw] delete_prior_versions
+    #   When set to `TRUE`, deletes the specified version and *all prior
+    #   versions* of a document.
+    #   @return [Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DeleteDocumentVersionRequest AWS API Documentation
+    #
+    class DeleteDocumentVersionRequest < Struct.new(
+      :authentication_token,
+      :document_id,
+      :version_id,
+      :delete_prior_versions)
+      SENSITIVE = [:authentication_token]
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass DeleteFolderContentsRequest
     #   data as a hash:
     #
@@ -977,7 +1016,7 @@ module Aws::WorkDocs
     #         user_id: "IdType",
     #         include_indirect_activities: false,
     #         limit: 1,
-    #         marker: "MarkerType",
+    #         marker: "SearchMarkerType",
     #       }
     #
     # @!attribute [rw] authentication_token
@@ -1542,7 +1581,28 @@ module Aws::WorkDocs
     #   @return [String]
     #
     # @!attribute [rw] query
-    #   A query to filter users by user name.
+    #   A query to filter users by user name. Remember the following about
+    #   the `Userids` and `Query` parameters:
+    #
+    #   * If you don't use either parameter, the API returns a paginated
+    #     list of all users on the site.
+    #
+    #   * If you use both parameters, the API ignores the `Query` parameter.
+    #
+    #   * The `Userid` parameter only returns user names that match a
+    #     corresponding user ID.
+    #
+    #   * The `Query` parameter runs a "prefix" search for users by the
+    #     `GivenName`, `SurName`, or `UserName` fields included in a
+    #     [CreateUser][1] API call. For example, querying on `Ma` returns
+    #     Márcia Oliveira, María García, and Mateo Jackson. If you use
+    #     multiple characters, the API only returns data that matches all
+    #     characters. For example, querying on `Ma J` only returns Mateo
+    #     Jackson.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/workdocs/latest/APIReference/API_CreateUser.html
     #   @return [String]
     #
     # @!attribute [rw] include
@@ -1783,6 +1843,7 @@ module Aws::WorkDocs
     #   @return [String]
     #
     # @!attribute [rw] entity_ids
+    #   The IDs of the non-existent resources.
     #   @return [Array<String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/EntityNotExistsException AWS API Documentation
@@ -2291,7 +2352,7 @@ module Aws::WorkDocs
     #         content_modified_timestamp: Time.now,
     #         content_type: "DocumentContentType",
     #         document_size_in_bytes: 1,
-    #         parent_folder_id: "ResourceIdType", # required
+    #         parent_folder_id: "ResourceIdType",
     #       }
     #
     # @!attribute [rw] authentication_token
@@ -2413,8 +2474,8 @@ module Aws::WorkDocs
       include Aws::Structure
     end
 
-    # The maximum of 100,000 folders under the parent folder has been
-    # exceeded.
+    # The maximum of 100,000 files and folders under the parent folder has
+    # been exceeded.
     #
     # @!attribute [rw] message
     #   @return [String]
@@ -2699,6 +2760,32 @@ module Aws::WorkDocs
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass RestoreDocumentVersionsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         authentication_token: "AuthenticationHeaderType",
+    #         document_id: "ResourceIdType", # required
+    #       }
+    #
+    # @!attribute [rw] authentication_token
+    #   Amazon WorkDocs authentication token. Not required when using AWS
+    #   administrator credentials to access the API.
+    #   @return [String]
+    #
+    # @!attribute [rw] document_id
+    #   The ID of the document.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/RestoreDocumentVersionsRequest AWS API Documentation
+    #
+    class RestoreDocumentVersionsRequest < Struct.new(
+      :authentication_token,
+      :document_id)
+      SENSITIVE = [:authentication_token]
+      include Aws::Structure
+    end
+
     # One or more of the dependencies is unavailable.
     #
     # @!attribute [rw] message
@@ -3219,7 +3306,7 @@ module Aws::WorkDocs
       :time_zone_id,
       :locale,
       :storage)
-      SENSITIVE = []
+      SENSITIVE = [:email_address]
       include Aws::Structure
     end
 
@@ -3253,7 +3340,7 @@ module Aws::WorkDocs
       :given_name,
       :surname,
       :email_address)
-      SENSITIVE = []
+      SENSITIVE = [:email_address]
       include Aws::Structure
     end
 

data/lib/aws-sdk-workdocs.rb

@@ -13,9 +13,13 @@ require 'aws-sigv4'
 
 require_relative 'aws-sdk-workdocs/types'
 require_relative 'aws-sdk-workdocs/client_api'
+require_relative 'aws-sdk-workdocs/plugins/endpoints.rb'
 require_relative 'aws-sdk-workdocs/client'
 require_relative 'aws-sdk-workdocs/errors'
 require_relative 'aws-sdk-workdocs/resource'
+require_relative 'aws-sdk-workdocs/endpoint_parameters'
+require_relative 'aws-sdk-workdocs/endpoint_provider'
+require_relative 'aws-sdk-workdocs/endpoints'
 require_relative 'aws-sdk-workdocs/customizations'
 
 # This module provides support for Amazon WorkDocs. This module is available in the
@@ -48,6 +52,6 @@ require_relative 'aws-sdk-workdocs/customizations'
 # @!group service
 module Aws::WorkDocs
 
-  GEM_VERSION = '1.39.0'
+  GEM_VERSION = '1.41.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-workdocs
 version: !ruby/object:Gem::Version
-  version: 1.39.0
+  version: 1.41.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.127.0
+        version: 3.165.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.127.0
+        version: 3.165.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +59,11 @@ files:
 - lib/aws-sdk-workdocs/client.rb
 - lib/aws-sdk-workdocs/client_api.rb
 - lib/aws-sdk-workdocs/customizations.rb
+- lib/aws-sdk-workdocs/endpoint_parameters.rb
+- lib/aws-sdk-workdocs/endpoint_provider.rb
+- lib/aws-sdk-workdocs/endpoints.rb
 - lib/aws-sdk-workdocs/errors.rb
+- lib/aws-sdk-workdocs/plugins/endpoints.rb
 - lib/aws-sdk-workdocs/resource.rb
 - lib/aws-sdk-workdocs/types.rb
 homepage: https://github.com/aws/aws-sdk-ruby