google-apis-chromewebstore_v2 0.1.0

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

@@ -0,0 +1,246 @@
+# 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 ChromewebstoreV2
+      # Chrome Web Store API
+      #
+      # The Chrome Web Store API provides access to data about apps and extensions, as
+      #  well as developer tools for managing them.
+      #
+      # @example
+      #    require 'google/apis/chromewebstore_v2'
+      #
+      #    Chromewebstore = Google::Apis::ChromewebstoreV2 # Alias the module
+      #    service = Chromewebstore::ChromewebstoreService.new
+      #
+      # @see https://developer.chrome.com/docs/webstore/api
+      class ChromewebstoreService < Google::Apis::Core::BaseService
+        DEFAULT_ENDPOINT_TEMPLATE = "https://chromewebstore.$UNIVERSE_DOMAIN$/"
+
+        # @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(DEFAULT_ENDPOINT_TEMPLATE, '',
+                client_name: 'google-apis-chromewebstore_v2',
+                client_version: Google::Apis::ChromewebstoreV2::GEM_VERSION)
+          @batch_path = 'batch'
+        end
+        
+        # Upload a new package to an existing item.
+        # @param [String] name
+        #   Required. Name of the item to upload the new package to in the form `
+        #   publishers/`publisherId`/items/`itemId``
+        # @param [Google::Apis::ChromewebstoreV2::UploadItemPackageRequest] upload_item_package_request_object
+        # @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 [IO, String] upload_source
+        #   IO stream or filename containing content to upload
+        # @param [String] content_type
+        #   Content type of the uploaded content.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::ChromewebstoreV2::UploadItemPackageResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::ChromewebstoreV2::UploadItemPackageResponse]
+        #
+        # @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 upload_medium_item_package(name, upload_item_package_request_object = nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
+          if upload_source.nil?
+            command = make_simple_command(:post, 'v2/{+name}:upload', options)
+          else
+            command = make_upload_command(:post, 'v2/{+name}:upload', options)
+            command.upload_source = upload_source
+            command.upload_content_type = content_type
+          end
+          command.request_representation = Google::Apis::ChromewebstoreV2::UploadItemPackageRequest::Representation
+          command.request_object = upload_item_package_request_object
+          command.response_representation = Google::Apis::ChromewebstoreV2::UploadItemPackageResponse::Representation
+          command.response_class = Google::Apis::ChromewebstoreV2::UploadItemPackageResponse
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Cancel the current active submission of an item if present. This can be used
+        # to cancel the review of a pending submission.
+        # @param [String] name
+        #   Required. Name of the item to cancel the submission of in the form `publishers/
+        #   `publisherId`/items/`itemId``
+        # @param [Google::Apis::ChromewebstoreV2::CancelSubmissionRequest] cancel_submission_request_object
+        # @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::ChromewebstoreV2::CancelSubmissionResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::ChromewebstoreV2::CancelSubmissionResponse]
+        #
+        # @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 cancel_item_submission(name, cancel_submission_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2/{+name}:cancelSubmission', options)
+          command.request_representation = Google::Apis::ChromewebstoreV2::CancelSubmissionRequest::Representation
+          command.request_object = cancel_submission_request_object
+          command.response_representation = Google::Apis::ChromewebstoreV2::CancelSubmissionResponse::Representation
+          command.response_class = Google::Apis::ChromewebstoreV2::CancelSubmissionResponse
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Fetch the status of an item.
+        # @param [String] name
+        #   Required. Name of the item to retrieve the status of in the form `publishers/`
+        #   publisherId`/items/`itemId``
+        # @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::ChromewebstoreV2::FetchItemStatusResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::ChromewebstoreV2::FetchItemStatusResponse]
+        #
+        # @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 fetch_publisher_item_status(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2/{+name}:fetchStatus', options)
+          command.response_representation = Google::Apis::ChromewebstoreV2::FetchItemStatusResponse::Representation
+          command.response_class = Google::Apis::ChromewebstoreV2::FetchItemStatusResponse
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Submit the item to be published in the store. The item will be submitted for
+        # review unless `skip_review` is set to true, or the item is staged from a
+        # previous submission with `publish_type` set to `STAGED_PUBLISH`.
+        # @param [String] name
+        #   Required. Name of the item in the form `publishers/`publisherId`/items/`itemId`
+        #   `
+        # @param [Google::Apis::ChromewebstoreV2::PublishItemRequest] publish_item_request_object
+        # @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::ChromewebstoreV2::PublishItemResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::ChromewebstoreV2::PublishItemResponse]
+        #
+        # @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 publish_item(name, publish_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2/{+name}:publish', options)
+          command.request_representation = Google::Apis::ChromewebstoreV2::PublishItemRequest::Representation
+          command.request_object = publish_item_request_object
+          command.response_representation = Google::Apis::ChromewebstoreV2::PublishItemResponse::Representation
+          command.response_class = Google::Apis::ChromewebstoreV2::PublishItemResponse
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Set a higher target deploy percentage for the item's published revision. This
+        # will be updated without the item being submitted for review. This is only
+        # available to items with over 10,000 seven-day active users.
+        # @param [String] name
+        #   Required. Name of the item to update the published revision of in the form `
+        #   publishers/`publisherId`/items/`itemId``
+        # @param [Google::Apis::ChromewebstoreV2::SetPublishedDeployPercentageRequest] set_published_deploy_percentage_request_object
+        # @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::ChromewebstoreV2::SetPublishedDeployPercentageResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::ChromewebstoreV2::SetPublishedDeployPercentageResponse]
+        #
+        # @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 set_item_published_deploy_percentage(name, set_published_deploy_percentage_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2/{+name}:setPublishedDeployPercentage', options)
+          command.request_representation = Google::Apis::ChromewebstoreV2::SetPublishedDeployPercentageRequest::Representation
+          command.request_object = set_published_deploy_percentage_request_object
+          command.response_representation = Google::Apis::ChromewebstoreV2::SetPublishedDeployPercentageResponse::Representation
+          command.response_class = Google::Apis::ChromewebstoreV2::SetPublishedDeployPercentageResponse
+          command.params['name'] = name unless name.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/chromewebstore_v2.rb

@@ -0,0 +1,40 @@
+# 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/chromewebstore_v2/service.rb'
+require 'google/apis/chromewebstore_v2/classes.rb'
+require 'google/apis/chromewebstore_v2/representations.rb'
+require 'google/apis/chromewebstore_v2/gem_version.rb'
+
+module Google
+  module Apis
+    # Chrome Web Store API
+    #
+    # The Chrome Web Store API provides access to data about apps and extensions, as
+    # well as developer tools for managing them.
+    #
+    # @see https://developer.chrome.com/docs/webstore/api
+    module ChromewebstoreV2
+      # Version of the Chrome Web Store API this client connects to.
+      # This is NOT the gem version.
+      VERSION = 'V2'
+
+      # See, edit, update, or publish your Chrome Web Store extensions, themes, apps, and licences you have access to
+      AUTH_CHROMEWEBSTORE = 'https://www.googleapis.com/auth/chromewebstore'
+
+      # See and download your Chrome Web Store extensions and apps, and see licenses you have access to
+      AUTH_CHROMEWEBSTORE_READONLY = 'https://www.googleapis.com/auth/chromewebstore.readonly'
+    end
+  end
+end

data/lib/google-apis-chromewebstore_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/chromewebstore_v2"

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: google-apis-chromewebstore_v2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Google LLC
+bindir: bin
+cert_chain: []
+date: 1980-01-02 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.15.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+description: This is the simple REST client for Chrome Web Store 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 Chrome Web Store 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-chromewebstore_v2.rb
+- lib/google/apis/chromewebstore_v2.rb
+- lib/google/apis/chromewebstore_v2/classes.rb
+- lib/google/apis/chromewebstore_v2/gem_version.rb
+- lib/google/apis/chromewebstore_v2/representations.rb
+- lib/google/apis/chromewebstore_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-chromewebstore_v2/CHANGELOG.md
+  documentation_uri: https://googleapis.dev/ruby/google-apis-chromewebstore_v2/v0.1.0
+  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-chromewebstore_v2
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Simple REST client for Chrome Web Store API V2
+test_files: []