google-cloud-channel-v1 0.12.0 → 0.13.0

data/lib/google/cloud/channel/v1/cloud_channel_reports_service/paths.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Channel
+      module V1
+        module CloudChannelReportsService
+          # Path helper methods for the CloudChannelReportsService API.
+          module Paths
+            ##
+            # Create a fully-qualified Report resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `accounts/{account}/reports/{report}`
+            #
+            # @param account [String]
+            # @param report [String]
+            #
+            # @return [::String]
+            def report_path account:, report:
+              raise ::ArgumentError, "account cannot contain /" if account.to_s.include? "/"
+
+              "accounts/#{account}/reports/#{report}"
+            end
+
+            ##
+            # Create a fully-qualified ReportJob resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `accounts/{account}/reportJobs/{report_job}`
+            #
+            # @param account [String]
+            # @param report_job [String]
+            #
+            # @return [::String]
+            def report_job_path account:, report_job:
+              raise ::ArgumentError, "account cannot contain /" if account.to_s.include? "/"
+
+              "accounts/#{account}/reportJobs/#{report_job}"
+            end
+
+            extend self
+          end
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/channel/v1/cloud_channel_reports_service.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/channel/v1/version"
+
+require "google/cloud/channel/v1/cloud_channel_reports_service/credentials"
+require "google/cloud/channel/v1/cloud_channel_reports_service/paths"
+require "google/cloud/channel/v1/cloud_channel_reports_service/operations"
+require "google/cloud/channel/v1/cloud_channel_reports_service/client"
+
+module Google
+  module Cloud
+    module Channel
+      module V1
+        ##
+        # CloudChannelReportsService lets Google Cloud resellers and
+        # distributors retrieve and combine a variety of data in Cloud Channel for
+        # multiple products (Google Cloud Platform (GCP), Google Voice, and
+        # Google Workspace.)
+        #
+        # To load this service and instantiate a client:
+        #
+        #     require "google/cloud/channel/v1/cloud_channel_reports_service"
+        #     client = ::Google::Cloud::Channel::V1::CloudChannelReportsService::Client.new
+        #
+        module CloudChannelReportsService
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "cloud_channel_reports_service", "helpers.rb"
+require "google/cloud/channel/v1/cloud_channel_reports_service/helpers" if ::File.file? helper_path

data/lib/google/cloud/channel/v1/cloud_channel_service/client.rb

@@ -1221,7 +1221,7 @@ module Google
             #     {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_transferable_skus CloudChannelService.ListTransferableSkus} call.
             #     Optional.
             #   @param auth_token [::String]
-            #     The super admin of the resold customer generates this token to
+            #     Optional. The super admin of the resold customer generates this token to
             #     authorize a reseller to access their Cloud Identity and purchase
             #     entitlements on their behalf. You can omit this token after authorization.
             #     See https://support.google.com/a/answer/7643790 for more details.
@@ -1314,7 +1314,8 @@ module Google
             #
             # * PERMISSION_DENIED:
             #     * The customer doesn't belong to the reseller and has no auth token.
-            #     * The supplied auth token is invalid.
+            #     * The customer provided incorrect reseller information when generating
+            #     auth token.
             #     * The reseller account making the request is different
             #     from the reseller account in the query.
             # * INVALID_ARGUMENT: Required request parameters are missing or invalid.
@@ -1356,7 +1357,7 @@ module Google
             #   @param sku [::String]
             #     Required. The SKU to look up Offers for.
             #   @param language_code [::String]
-            #     The BCP-47 language code. For example, "en-US". The
+            #     Optional. The BCP-47 language code. For example, "en-US". The
             #     response will localize in the corresponding language code, if specified.
             #     The default value is "en-US".
             #

data/lib/google/cloud/channel/v1/reports_service_pb.rb

@@ -0,0 +1,136 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/channel/v1/reports_service.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/longrunning/operations_pb'
+require 'google/protobuf/timestamp_pb'
+require 'google/type/date_pb'
+require 'google/type/datetime_pb'
+require 'google/type/decimal_pb'
+require 'google/type/money_pb'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/channel/v1/reports_service.proto", :syntax => :proto3) do
+    add_message "google.cloud.channel.v1.RunReportJobRequest" do
+      optional :name, :string, 1
+      optional :date_range, :message, 2, "google.cloud.channel.v1.DateRange"
+      optional :filter, :string, 3
+      optional :language_code, :string, 4
+    end
+    add_message "google.cloud.channel.v1.RunReportJobResponse" do
+      optional :report_job, :message, 1, "google.cloud.channel.v1.ReportJob"
+      optional :report_metadata, :message, 2, "google.cloud.channel.v1.ReportResultsMetadata"
+    end
+    add_message "google.cloud.channel.v1.FetchReportResultsRequest" do
+      optional :report_job, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+    end
+    add_message "google.cloud.channel.v1.FetchReportResultsResponse" do
+      optional :report_metadata, :message, 1, "google.cloud.channel.v1.ReportResultsMetadata"
+      repeated :rows, :message, 2, "google.cloud.channel.v1.Row"
+      optional :next_page_token, :string, 3
+    end
+    add_message "google.cloud.channel.v1.ListReportsRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+      optional :language_code, :string, 4
+    end
+    add_message "google.cloud.channel.v1.ListReportsResponse" do
+      repeated :reports, :message, 1, "google.cloud.channel.v1.Report"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.cloud.channel.v1.ReportJob" do
+      optional :name, :string, 1
+      optional :report_status, :message, 2, "google.cloud.channel.v1.ReportStatus"
+    end
+    add_message "google.cloud.channel.v1.ReportResultsMetadata" do
+      optional :report, :message, 1, "google.cloud.channel.v1.Report"
+      optional :row_count, :int64, 2
+      optional :date_range, :message, 3, "google.cloud.channel.v1.DateRange"
+      optional :preceding_date_range, :message, 4, "google.cloud.channel.v1.DateRange"
+    end
+    add_message "google.cloud.channel.v1.Column" do
+      optional :column_id, :string, 1
+      optional :display_name, :string, 2
+      optional :data_type, :enum, 3, "google.cloud.channel.v1.Column.DataType"
+    end
+    add_enum "google.cloud.channel.v1.Column.DataType" do
+      value :DATA_TYPE_UNSPECIFIED, 0
+      value :STRING, 1
+      value :INT, 2
+      value :DECIMAL, 3
+      value :MONEY, 4
+      value :DATE, 5
+      value :DATE_TIME, 6
+    end
+    add_message "google.cloud.channel.v1.DateRange" do
+      optional :usage_start_date_time, :message, 1, "google.type.DateTime"
+      optional :usage_end_date_time, :message, 2, "google.type.DateTime"
+      optional :invoice_start_date, :message, 3, "google.type.Date"
+      optional :invoice_end_date, :message, 4, "google.type.Date"
+    end
+    add_message "google.cloud.channel.v1.Row" do
+      repeated :values, :message, 1, "google.cloud.channel.v1.ReportValue"
+    end
+    add_message "google.cloud.channel.v1.ReportValue" do
+      oneof :value do
+        optional :string_value, :string, 1
+        optional :int_value, :int64, 2
+        optional :decimal_value, :message, 3, "google.type.Decimal"
+        optional :money_value, :message, 4, "google.type.Money"
+        optional :date_value, :message, 5, "google.type.Date"
+        optional :date_time_value, :message, 6, "google.type.DateTime"
+      end
+    end
+    add_message "google.cloud.channel.v1.ReportStatus" do
+      optional :state, :enum, 1, "google.cloud.channel.v1.ReportStatus.State"
+      optional :start_time, :message, 2, "google.protobuf.Timestamp"
+      optional :end_time, :message, 3, "google.protobuf.Timestamp"
+    end
+    add_enum "google.cloud.channel.v1.ReportStatus.State" do
+      value :STATE_UNSPECIFIED, 0
+      value :STARTED, 1
+      value :WRITING, 2
+      value :AVAILABLE, 3
+      value :FAILED, 4
+    end
+    add_message "google.cloud.channel.v1.Report" do
+      optional :name, :string, 1
+      optional :display_name, :string, 2
+      repeated :columns, :message, 3, "google.cloud.channel.v1.Column"
+      optional :description, :string, 4
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Channel
+      module V1
+        RunReportJobRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.RunReportJobRequest").msgclass
+        RunReportJobResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.RunReportJobResponse").msgclass
+        FetchReportResultsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.FetchReportResultsRequest").msgclass
+        FetchReportResultsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.FetchReportResultsResponse").msgclass
+        ListReportsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListReportsRequest").msgclass
+        ListReportsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListReportsResponse").msgclass
+        ReportJob = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ReportJob").msgclass
+        ReportResultsMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ReportResultsMetadata").msgclass
+        Column = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.Column").msgclass
+        Column::DataType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.Column.DataType").enummodule
+        DateRange = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.DateRange").msgclass
+        Row = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.Row").msgclass
+        ReportValue = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ReportValue").msgclass
+        ReportStatus = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ReportStatus").msgclass
+        ReportStatus::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ReportStatus.State").enummodule
+        Report = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.Report").msgclass
+      end
+    end
+  end
+end

data/lib/google/cloud/channel/v1/reports_service_services_pb.rb

@@ -0,0 +1,76 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/channel/v1/reports_service.proto for package 'google.cloud.channel.v1'
+# Original file comments:
+# Copyright 2022 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 'grpc'
+require 'google/cloud/channel/v1/reports_service_pb'
+
+module Google
+  module Cloud
+    module Channel
+      module V1
+        module CloudChannelReportsService
+          # CloudChannelReportsService lets Google Cloud resellers and
+          # distributors retrieve and combine a variety of data in Cloud Channel for
+          # multiple products (Google Cloud Platform (GCP), Google Voice, and
+          # Google Workspace.)
+          class Service
+
+            include ::GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.channel.v1.CloudChannelReportsService'
+
+            # Begins generation of data for a given report. The report
+            # identifier is a UID (for example, `613bf59q`).
+            #
+            # Possible error codes:
+            #
+            # * PERMISSION_DENIED: The user doesn't have access to this report.
+            # * INVALID_ARGUMENT: Required request parameters are missing
+            #   or invalid.
+            # * NOT_FOUND: The report identifier was not found.
+            # * INTERNAL: Any non-user error related to a technical issue
+            #   in the backend. Contact Cloud Channel support.
+            # * UNKNOWN: Any non-user error related to a technical issue
+            #   in the backend. Contact Cloud Channel support.
+            #
+            # Return value:
+            # The ID of a long-running operation.
+            #
+            # To get the results of the operation, call the GetOperation method of
+            # CloudChannelOperationsService. The Operation metadata contains an
+            # instance of [OperationMetadata][google.cloud.channel.v1.OperationMetadata].
+            #
+            # To get the results of report generation, call
+            # [CloudChannelReportsService.FetchReportResults][google.cloud.channel.v1.CloudChannelReportsService.FetchReportResults] with the
+            # [RunReportJobResponse.report_job][google.cloud.channel.v1.RunReportJobResponse.report_job].
+            rpc :RunReportJob, ::Google::Cloud::Channel::V1::RunReportJobRequest, ::Google::Longrunning::Operation
+            # Retrieves data generated by [CloudChannelReportsService.RunReportJob][google.cloud.channel.v1.CloudChannelReportsService.RunReportJob].
+            rpc :FetchReportResults, ::Google::Cloud::Channel::V1::FetchReportResultsRequest, ::Google::Cloud::Channel::V1::FetchReportResultsResponse
+            # Lists the reports that RunReportJob can run. These reports include an ID,
+            # a description, and the list of columns that will be in the result.
+            rpc :ListReports, ::Google::Cloud::Channel::V1::ListReportsRequest, ::Google::Cloud::Channel::V1::ListReportsResponse
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/channel/v1/service_services_pb.rb

@@ -209,7 +209,8 @@ module Google
             #
             # * PERMISSION_DENIED:
             #     * The customer doesn't belong to the reseller and has no auth token.
-            #     * The supplied auth token is invalid.
+            #     * The customer provided incorrect reseller information when generating
+            #     auth token.
             #     * The reseller account making the request is different
             #     from the reseller account in the query.
             # * INVALID_ARGUMENT: Required request parameters are missing or invalid.

data/lib/google/cloud/channel/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Channel
       module V1
-        VERSION = "0.12.0"
+        VERSION = "0.13.0"
       end
     end
   end

data/lib/google/cloud/channel/v1.rb

@@ -16,6 +16,7 @@
 
 # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
 
+require "google/cloud/channel/v1/cloud_channel_reports_service"
 require "google/cloud/channel/v1/cloud_channel_service"
 require "google/cloud/channel/v1/version"
 
@@ -28,7 +29,7 @@ module Google
       # @example
       #
       #     require "google/cloud/channel/v1"
-      #     client = ::Google::Cloud::Channel::V1::CloudChannelService::Client.new
+      #     client = ::Google::Cloud::Channel::V1::CloudChannelReportsService::Client.new
       #
       module V1
       end