google-apis-drivelabels_v2 0.1.0

data/lib/google/apis/drivelabels_v2/service.rb

@@ -0,0 +1,168 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module DrivelabelsV2
+      # Drive Labels API
+      #
+      # An API for managing Drive Labels
+      #
+      # @example
+      #    require 'google/apis/drivelabels_v2'
+      #
+      #    Drivelabels = Google::Apis::DrivelabelsV2 # Alias the module
+      #    service = Drivelabels::DriveLabelsService.new
+      #
+      # @see https://developers.google.com/drive/labels
+      class DriveLabelsService < Google::Apis::Core::BaseService
+        # @return [String]
+        #  API key. Your API key identifies your project and provides you with API access,
+        #  quota, and reports. Required unless you provide an OAuth 2.0 token.
+        attr_accessor :key
+
+        # @return [String]
+        #  Available to use for quota purposes for server-side applications. Can be any
+        #  arbitrary string assigned to a user, but should not exceed 40 characters.
+        attr_accessor :quota_user
+
+        def initialize
+          super('https://drivelabels.googleapis.com/', '',
+                client_name: 'google-apis-drivelabels_v2',
+                client_version: Google::Apis::DrivelabelsV2::GEM_VERSION)
+          @batch_path = 'batch'
+        end
+        
+        # Get a Label by its resource name. Resource name may be any of: * `labels/`id``
+        # - See to `labels/`id`@latest` * `labels/`id`@latest` - Gets the latest
+        # revision of the Label. * `labels/`id`@published` - Gets the current published
+        # revision of the Label. * `labels/`id`@`revision_id`` - Gets the Label at the
+        # specified revision ID.
+        # @param [String] name
+        #   Required. Label resource name. May be any of: * `labels/`id`` (equivalent to
+        #   labels/`id`@latest) * `labels/`id`@latest` * `labels/`id`@published` * `labels/
+        #   `id`@`revision_id``
+        # @param [String] language_code
+        #   The BCP-47 language code to use for evaluating localized Field labels. When
+        #   not specified, values in the default configured language will be used.
+        # @param [Boolean] use_admin_access
+        #   Set to `true` in order to use the user's admin credentials. The server will
+        #   verify the user is an admin for the Label before allowing access.
+        # @param [String] view
+        #   When specified, only certain Fields belonging to the indicated view will be
+        #   returned.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2Label] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2Label]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def get_label(name, language_code: nil, use_admin_access: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2/{+name}', options)
+          command.response_representation = Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2Label::Representation
+          command.response_class = Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2Label
+          command.params['name'] = name unless name.nil?
+          command.query['languageCode'] = language_code unless language_code.nil?
+          command.query['useAdminAccess'] = use_admin_access unless use_admin_access.nil?
+          command.query['view'] = view unless view.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # -------------------------------------------------------------------------- ##
+        # Label APIs ---------------------------------------------------------------
+        # List Labels.
+        # @param [String] language_code
+        #   The BCP-47 language code to use for evaluating localized field labels. When
+        #   not specified, values in the default configured language will be used.
+        # @param [String] minimum_role
+        #   Specifies the level of access the user must have on the returned Labels. The
+        #   minimum role a user must have on a label. Defaults to `READER`.
+        # @param [Fixnum] page_size
+        #   Maximum number of Labels to return per page. Default: 50. Max: 200.
+        # @param [String] page_token
+        #   The token of the page to return.
+        # @param [Boolean] published_only
+        #   Whether to include only published labels in the results. * When `true`, only
+        #   the current published label revisions will be returned. Disabled labels will
+        #   be included. Returned Label resource names will reference the published
+        #   revision (`labels/`id`/`revision_id``). * When `false`, the current label
+        #   revisions will be returned, which may not by published. Returned Label
+        #   resource names will not reference a specific revision (`labels/`id``).
+        # @param [Boolean] use_admin_access
+        #   Set to `true` in order to use the user's admin credentials. This will return
+        #   all Labels within the customer.
+        # @param [String] view
+        #   When specified, only certain fields belonging to the indicated view will be
+        #   returned.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2ListLabelsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2ListLabelsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_labels(language_code: nil, minimum_role: nil, page_size: nil, page_token: nil, published_only: nil, use_admin_access: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2/labels', options)
+          command.response_representation = Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2ListLabelsResponse::Representation
+          command.response_class = Google::Apis::DrivelabelsV2::GoogleAppsDriveLabelsV2ListLabelsResponse
+          command.query['languageCode'] = language_code unless language_code.nil?
+          command.query['minimumRole'] = minimum_role unless minimum_role.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['publishedOnly'] = published_only unless published_only.nil?
+          command.query['useAdminAccess'] = use_admin_access unless use_admin_access.nil?
+          command.query['view'] = view unless view.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+
+        protected
+
+        def apply_command_defaults(command)
+          command.query['key'] = key unless key.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+        end
+      end
+    end
+  end
+end

data/lib/google/apis/drivelabels_v2.rb

@@ -0,0 +1,33 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'google/apis/drivelabels_v2/service.rb'
+require 'google/apis/drivelabels_v2/classes.rb'
+require 'google/apis/drivelabels_v2/representations.rb'
+require 'google/apis/drivelabels_v2/gem_version.rb'
+
+module Google
+  module Apis
+    # Drive Labels API
+    #
+    # An API for managing Drive Labels
+    #
+    # @see https://developers.google.com/drive/labels
+    module DrivelabelsV2
+      # Version of the Drive Labels API this client connects to.
+      # This is NOT the gem version.
+      VERSION = 'V2'
+    end
+  end
+end

data/lib/google-apis-drivelabels_v2.rb

@@ -0,0 +1,15 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require "google/apis/drivelabels_v2"

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: google-apis-drivelabels_v2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Google LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-07-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: google-apis-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+description: This is the simple REST client for Drive Labels API V2. Simple REST clients
+  are Ruby client libraries that provide access to Google services via their HTTP
+  REST API endpoints. These libraries are generated and updated automatically based
+  on the discovery documents published by the service, and they handle most concerns
+  such as authentication, pagination, retry, timeouts, and logging. You can use this
+  client to access the Drive Labels API, but note that some services may provide a
+  separate modern client that is easier to use.
+email: googleapis-packages@google.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE.md
+- OVERVIEW.md
+- lib/google-apis-drivelabels_v2.rb
+- lib/google/apis/drivelabels_v2.rb
+- lib/google/apis/drivelabels_v2/classes.rb
+- lib/google/apis/drivelabels_v2/gem_version.rb
+- lib/google/apis/drivelabels_v2/representations.rb
+- lib/google/apis/drivelabels_v2/service.rb
+homepage: https://github.com/google/google-api-ruby-client
+licenses:
+- Apache-2.0
+metadata:
+  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
+  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-drivelabels_v2/CHANGELOG.md
+  documentation_uri: https://googleapis.dev/ruby/google-apis-drivelabels_v2/v0.1.0
+  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-drivelabels_v2
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.14
+signing_key: 
+specification_version: 4
+summary: Simple REST client for Drive Labels API V2
+test_files: []