google-cloud-channel-v1 0.15.0 → 0.17.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/client.rb +14 -18
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/operations.rb +14 -16
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/rest/client.rb +583 -0
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/rest/operations.rb +793 -0
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/rest/service_stub.rb +227 -0
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service/rest.rb +56 -0
- data/lib/google/cloud/channel/v1/cloud_channel_reports_service.rb +7 -1
- data/lib/google/cloud/channel/v1/cloud_channel_service/client.rb +232 -119
- data/lib/google/cloud/channel/v1/cloud_channel_service/operations.rb +14 -16
- data/lib/google/cloud/channel/v1/cloud_channel_service/rest/client.rb +4894 -0
- data/lib/google/cloud/channel/v1/cloud_channel_service/rest/operations.rb +793 -0
- data/lib/google/cloud/channel/v1/cloud_channel_service/rest/service_stub.rb +2830 -0
- data/lib/google/cloud/channel/v1/cloud_channel_service/rest.rb +72 -0
- data/lib/google/cloud/channel/v1/cloud_channel_service.rb +7 -1
- data/lib/google/cloud/channel/v1/customers_pb.rb +1 -0
- data/lib/google/cloud/channel/v1/entitlement_changes_pb.rb +81 -0
- data/lib/google/cloud/channel/v1/reports_service_pb.rb +1 -0
- data/lib/google/cloud/channel/v1/rest.rb +38 -0
- data/lib/google/cloud/channel/v1/service_pb.rb +15 -0
- data/lib/google/cloud/channel/v1/service_services_pb.rb +17 -0
- data/lib/google/cloud/channel/v1/version.rb +1 -1
- data/lib/google/cloud/channel/v1.rb +7 -2
- data/proto_docs/google/cloud/channel/v1/customers.rb +4 -0
- data/proto_docs/google/cloud/channel/v1/entitlement_changes.rb +182 -0
- data/proto_docs/google/cloud/channel/v1/entitlements.rb +12 -3
- data/proto_docs/google/cloud/channel/v1/service.rb +52 -0
- metadata +21 -8
@@ -0,0 +1,72 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
require "gapic/rest"
|
20
|
+
require "gapic/config"
|
21
|
+
require "gapic/config/method"
|
22
|
+
|
23
|
+
require "google/cloud/channel/v1/version"
|
24
|
+
|
25
|
+
require "google/cloud/channel/v1/cloud_channel_service/credentials"
|
26
|
+
require "google/cloud/channel/v1/cloud_channel_service/paths"
|
27
|
+
require "google/cloud/channel/v1/cloud_channel_service/rest/operations"
|
28
|
+
require "google/cloud/channel/v1/cloud_channel_service/rest/client"
|
29
|
+
|
30
|
+
module Google
|
31
|
+
module Cloud
|
32
|
+
module Channel
|
33
|
+
module V1
|
34
|
+
##
|
35
|
+
# CloudChannelService lets Google cloud resellers and distributors manage
|
36
|
+
# their customers, channel partners, entitlements, and reports.
|
37
|
+
#
|
38
|
+
# Using this service:
|
39
|
+
# 1. Resellers and distributors can manage a customer entity.
|
40
|
+
# 2. Distributors can register an authorized reseller in their channel and
|
41
|
+
# provide them with delegated admin access.
|
42
|
+
# 3. Resellers and distributors can manage customer entitlements.
|
43
|
+
#
|
44
|
+
# CloudChannelService exposes the following resources:
|
45
|
+
# - {::Google::Cloud::Channel::V1::Customer Customer}s: An entity-usually an
|
46
|
+
# enterprise-managed by a reseller or distributor.
|
47
|
+
#
|
48
|
+
# - {::Google::Cloud::Channel::V1::Entitlement Entitlement}s: An entity that
|
49
|
+
# provides a customer with the means to use a service. Entitlements are created
|
50
|
+
# or updated as a result of a successful fulfillment.
|
51
|
+
#
|
52
|
+
# - {::Google::Cloud::Channel::V1::ChannelPartnerLink ChannelPartnerLink}s: An
|
53
|
+
# entity that identifies links between distributors and their indirect
|
54
|
+
# resellers in a channel.
|
55
|
+
#
|
56
|
+
# To load this service and instantiate a REST client:
|
57
|
+
#
|
58
|
+
# require "google/cloud/channel/v1/cloud_channel_service/rest"
|
59
|
+
# client = ::Google::Cloud::Channel::V1::CloudChannelService::Rest::Client.new
|
60
|
+
#
|
61
|
+
module CloudChannelService
|
62
|
+
# Client for the REST transport
|
63
|
+
module Rest
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
67
|
+
end
|
68
|
+
end
|
69
|
+
end
|
70
|
+
|
71
|
+
helper_path = ::File.join __dir__, "rest", "helpers.rb"
|
72
|
+
require "google/cloud/channel/v1/cloud_channel_service/rest/helpers" if ::File.file? helper_path
|
@@ -26,6 +26,7 @@ require "google/cloud/channel/v1/cloud_channel_service/credentials"
|
|
26
26
|
require "google/cloud/channel/v1/cloud_channel_service/paths"
|
27
27
|
require "google/cloud/channel/v1/cloud_channel_service/operations"
|
28
28
|
require "google/cloud/channel/v1/cloud_channel_service/client"
|
29
|
+
require "google/cloud/channel/v1/cloud_channel_service/rest"
|
29
30
|
|
30
31
|
module Google
|
31
32
|
module Cloud
|
@@ -53,11 +54,16 @@ module Google
|
|
53
54
|
# entity that identifies links between distributors and their indirect
|
54
55
|
# resellers in a channel.
|
55
56
|
#
|
56
|
-
#
|
57
|
+
# @example Load this service and instantiate a gRPC client
|
57
58
|
#
|
58
59
|
# require "google/cloud/channel/v1/cloud_channel_service"
|
59
60
|
# client = ::Google::Cloud::Channel::V1::CloudChannelService::Client.new
|
60
61
|
#
|
62
|
+
# @example Load this service and instantiate a REST client
|
63
|
+
#
|
64
|
+
# require "google/cloud/channel/v1/cloud_channel_service/rest"
|
65
|
+
# client = ::Google::Cloud::Channel::V1::CloudChannelService::Rest::Client.new
|
66
|
+
#
|
61
67
|
module CloudChannelService
|
62
68
|
end
|
63
69
|
end
|
@@ -24,6 +24,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
24
24
|
optional :language_code, :string, 10
|
25
25
|
optional :cloud_identity_info, :message, 12, "google.cloud.channel.v1.CloudIdentityInfo"
|
26
26
|
optional :channel_partner_id, :string, 13
|
27
|
+
optional :correlation_id, :string, 14
|
27
28
|
end
|
28
29
|
add_message "google.cloud.channel.v1.ContactInfo" do
|
29
30
|
optional :first_name, :string, 1
|
@@ -0,0 +1,81 @@
|
|
1
|
+
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
|
+
# source: google/cloud/channel/v1/entitlement_changes.proto
|
3
|
+
|
4
|
+
require 'google/protobuf'
|
5
|
+
|
6
|
+
require 'google/api/field_behavior_pb'
|
7
|
+
require 'google/api/resource_pb'
|
8
|
+
require 'google/cloud/channel/v1/entitlements_pb'
|
9
|
+
require 'google/protobuf/timestamp_pb'
|
10
|
+
|
11
|
+
Google::Protobuf::DescriptorPool.generated_pool.build do
|
12
|
+
add_file("google/cloud/channel/v1/entitlement_changes.proto", :syntax => :proto3) do
|
13
|
+
add_message "google.cloud.channel.v1.EntitlementChange" do
|
14
|
+
optional :entitlement, :string, 1
|
15
|
+
optional :offer, :string, 2
|
16
|
+
optional :provisioned_service, :message, 3, "google.cloud.channel.v1.ProvisionedService"
|
17
|
+
optional :change_type, :enum, 4, "google.cloud.channel.v1.EntitlementChange.ChangeType"
|
18
|
+
optional :create_time, :message, 5, "google.protobuf.Timestamp"
|
19
|
+
optional :operator_type, :enum, 6, "google.cloud.channel.v1.EntitlementChange.OperatorType"
|
20
|
+
repeated :parameters, :message, 8, "google.cloud.channel.v1.Parameter"
|
21
|
+
optional :operator, :string, 12
|
22
|
+
oneof :change_reason do
|
23
|
+
optional :suspension_reason, :enum, 9, "google.cloud.channel.v1.Entitlement.SuspensionReason"
|
24
|
+
optional :cancellation_reason, :enum, 10, "google.cloud.channel.v1.EntitlementChange.CancellationReason"
|
25
|
+
optional :activation_reason, :enum, 11, "google.cloud.channel.v1.EntitlementChange.ActivationReason"
|
26
|
+
optional :other_change_reason, :string, 100
|
27
|
+
end
|
28
|
+
end
|
29
|
+
add_enum "google.cloud.channel.v1.EntitlementChange.ChangeType" do
|
30
|
+
value :CHANGE_TYPE_UNSPECIFIED, 0
|
31
|
+
value :CREATED, 1
|
32
|
+
value :PRICE_PLAN_SWITCHED, 3
|
33
|
+
value :COMMITMENT_CHANGED, 4
|
34
|
+
value :RENEWED, 5
|
35
|
+
value :SUSPENDED, 6
|
36
|
+
value :ACTIVATED, 7
|
37
|
+
value :CANCELLED, 8
|
38
|
+
value :SKU_CHANGED, 9
|
39
|
+
value :RENEWAL_SETTING_CHANGED, 10
|
40
|
+
value :PAID_SUBSCRIPTION_STARTED, 11
|
41
|
+
value :LICENSE_CAP_CHANGED, 12
|
42
|
+
value :SUSPENSION_DETAILS_CHANGED, 13
|
43
|
+
value :TRIAL_END_DATE_EXTENDED, 14
|
44
|
+
value :TRIAL_STARTED, 15
|
45
|
+
end
|
46
|
+
add_enum "google.cloud.channel.v1.EntitlementChange.OperatorType" do
|
47
|
+
value :OPERATOR_TYPE_UNSPECIFIED, 0
|
48
|
+
value :CUSTOMER_SERVICE_REPRESENTATIVE, 1
|
49
|
+
value :SYSTEM, 2
|
50
|
+
value :CUSTOMER, 3
|
51
|
+
value :RESELLER, 4
|
52
|
+
end
|
53
|
+
add_enum "google.cloud.channel.v1.EntitlementChange.CancellationReason" do
|
54
|
+
value :CANCELLATION_REASON_UNSPECIFIED, 0
|
55
|
+
value :SERVICE_TERMINATED, 1
|
56
|
+
value :RELATIONSHIP_ENDED, 2
|
57
|
+
value :PARTIAL_TRANSFER, 3
|
58
|
+
end
|
59
|
+
add_enum "google.cloud.channel.v1.EntitlementChange.ActivationReason" do
|
60
|
+
value :ACTIVATION_REASON_UNSPECIFIED, 0
|
61
|
+
value :RESELLER_REVOKED_SUSPENSION, 1
|
62
|
+
value :CUSTOMER_ACCEPTED_PENDING_TOS, 2
|
63
|
+
value :RENEWAL_SETTINGS_CHANGED, 3
|
64
|
+
value :OTHER_ACTIVATION_REASON, 100
|
65
|
+
end
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
69
|
+
module Google
|
70
|
+
module Cloud
|
71
|
+
module Channel
|
72
|
+
module V1
|
73
|
+
EntitlementChange = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.EntitlementChange").msgclass
|
74
|
+
EntitlementChange::ChangeType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.EntitlementChange.ChangeType").enummodule
|
75
|
+
EntitlementChange::OperatorType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.EntitlementChange.OperatorType").enummodule
|
76
|
+
EntitlementChange::CancellationReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.EntitlementChange.CancellationReason").enummodule
|
77
|
+
EntitlementChange::ActivationReason = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.EntitlementChange.ActivationReason").enummodule
|
78
|
+
end
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|
@@ -7,6 +7,7 @@ require 'google/api/annotations_pb'
|
|
7
7
|
require 'google/api/client_pb'
|
8
8
|
require 'google/api/field_behavior_pb'
|
9
9
|
require 'google/api/resource_pb'
|
10
|
+
require 'google/cloud/channel/v1/operations_pb'
|
10
11
|
require 'google/longrunning/operations_pb'
|
11
12
|
require 'google/protobuf/timestamp_pb'
|
12
13
|
require 'google/type/date_pb'
|
@@ -0,0 +1,38 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
require "google/cloud/channel/v1/cloud_channel_reports_service/rest"
|
20
|
+
require "google/cloud/channel/v1/cloud_channel_service/rest"
|
21
|
+
require "google/cloud/channel/v1/version"
|
22
|
+
|
23
|
+
module Google
|
24
|
+
module Cloud
|
25
|
+
module Channel
|
26
|
+
##
|
27
|
+
# To load just the REST part of this package, including all its services, and instantiate a REST client:
|
28
|
+
#
|
29
|
+
# @example
|
30
|
+
#
|
31
|
+
# require "google/cloud/channel/v1/rest"
|
32
|
+
# client = ::Google::Cloud::Channel::V1::CloudChannelReportsService::Rest::Client.new
|
33
|
+
#
|
34
|
+
module V1
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
@@ -10,8 +10,10 @@ require 'google/api/resource_pb'
|
|
10
10
|
require 'google/cloud/channel/v1/channel_partner_links_pb'
|
11
11
|
require 'google/cloud/channel/v1/common_pb'
|
12
12
|
require 'google/cloud/channel/v1/customers_pb'
|
13
|
+
require 'google/cloud/channel/v1/entitlement_changes_pb'
|
13
14
|
require 'google/cloud/channel/v1/entitlements_pb'
|
14
15
|
require 'google/cloud/channel/v1/offers_pb'
|
16
|
+
require 'google/cloud/channel/v1/operations_pb'
|
15
17
|
require 'google/cloud/channel/v1/products_pb'
|
16
18
|
require 'google/cloud/channel/v1/repricing_pb'
|
17
19
|
require 'google/longrunning/operations_pb'
|
@@ -271,6 +273,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
271
273
|
optional :page_token, :string, 3
|
272
274
|
optional :filter, :string, 4
|
273
275
|
optional :language_code, :string, 5
|
276
|
+
optional :show_future_offers, :bool, 7
|
274
277
|
end
|
275
278
|
add_message "google.cloud.channel.v1.ListOffersResponse" do
|
276
279
|
repeated :offers, :message, 1, "google.cloud.channel.v1.Offer"
|
@@ -353,6 +356,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
353
356
|
repeated :service_accounts, :string, 2
|
354
357
|
optional :next_page_token, :string, 3
|
355
358
|
end
|
359
|
+
add_message "google.cloud.channel.v1.ListEntitlementChangesRequest" do
|
360
|
+
optional :parent, :string, 1
|
361
|
+
optional :page_size, :int32, 2
|
362
|
+
optional :page_token, :string, 3
|
363
|
+
optional :filter, :string, 4
|
364
|
+
end
|
365
|
+
add_message "google.cloud.channel.v1.ListEntitlementChangesResponse" do
|
366
|
+
repeated :entitlement_changes, :message, 1, "google.cloud.channel.v1.EntitlementChange"
|
367
|
+
optional :next_page_token, :string, 2
|
368
|
+
end
|
356
369
|
end
|
357
370
|
end
|
358
371
|
|
@@ -431,6 +444,8 @@ module Google
|
|
431
444
|
UnregisterSubscriberResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.UnregisterSubscriberResponse").msgclass
|
432
445
|
ListSubscribersRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListSubscribersRequest").msgclass
|
433
446
|
ListSubscribersResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListSubscribersResponse").msgclass
|
447
|
+
ListEntitlementChangesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListEntitlementChangesRequest").msgclass
|
448
|
+
ListEntitlementChangesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.channel.v1.ListEntitlementChangesResponse").msgclass
|
434
449
|
end
|
435
450
|
end
|
436
451
|
end
|
@@ -967,6 +967,23 @@ module Google
|
|
967
967
|
# Return value:
|
968
968
|
# A list of service email addresses.
|
969
969
|
rpc :ListSubscribers, ::Google::Cloud::Channel::V1::ListSubscribersRequest, ::Google::Cloud::Channel::V1::ListSubscribersResponse
|
970
|
+
# List entitlement history.
|
971
|
+
#
|
972
|
+
# Possible error codes:
|
973
|
+
#
|
974
|
+
# * PERMISSION_DENIED: The reseller account making the request and the
|
975
|
+
# provided reseller account are different.
|
976
|
+
# * INVALID_ARGUMENT: Missing or invalid required fields in the request.
|
977
|
+
# * NOT_FOUND: The parent resource doesn't exist. Usually the result of an
|
978
|
+
# invalid name parameter.
|
979
|
+
# * INTERNAL: Any non-user error related to a technical issue in the backend.
|
980
|
+
# In this case, contact CloudChannel support.
|
981
|
+
# * UNKNOWN: Any non-user error related to a technical issue in the backend.
|
982
|
+
# In this case, contact Cloud Channel support.
|
983
|
+
#
|
984
|
+
# Return value:
|
985
|
+
# List of [EntitlementChange][google.cloud.channel.v1.EntitlementChange]s.
|
986
|
+
rpc :ListEntitlementChanges, ::Google::Cloud::Channel::V1::ListEntitlementChangesRequest, ::Google::Cloud::Channel::V1::ListEntitlementChangesResponse
|
970
987
|
end
|
971
988
|
|
972
989
|
Stub = Service.rpc_stub_class
|
@@ -24,13 +24,18 @@ module Google
|
|
24
24
|
module Cloud
|
25
25
|
module Channel
|
26
26
|
##
|
27
|
-
#
|
27
|
+
# API client module.
|
28
28
|
#
|
29
|
-
# @example
|
29
|
+
# @example Load this package, including all its services, and instantiate a gRPC client
|
30
30
|
#
|
31
31
|
# require "google/cloud/channel/v1"
|
32
32
|
# client = ::Google::Cloud::Channel::V1::CloudChannelReportsService::Client.new
|
33
33
|
#
|
34
|
+
# @example Load this package, including all its services, and instantiate a REST client
|
35
|
+
#
|
36
|
+
# require "google/cloud/channel/v1"
|
37
|
+
# client = ::Google::Cloud::Channel::V1::CloudChannelReportsService::Rest::Client.new
|
38
|
+
#
|
34
39
|
module V1
|
35
40
|
end
|
36
41
|
end
|
@@ -72,6 +72,10 @@ module Google
|
|
72
72
|
# @return [::String]
|
73
73
|
# Cloud Identity ID of the customer's channel partner.
|
74
74
|
# Populated only if a channel partner exists for this customer.
|
75
|
+
# @!attribute [rw] correlation_id
|
76
|
+
# @return [::String]
|
77
|
+
# Optional. External CRM ID for the customer.
|
78
|
+
# Populated only if a CRM ID exists for this customer.
|
75
79
|
class Customer
|
76
80
|
include ::Google::Protobuf::MessageExts
|
77
81
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -0,0 +1,182 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2023 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Channel
|
23
|
+
module V1
|
24
|
+
# Change event entry for Entitlement order history
|
25
|
+
# @!attribute [rw] suspension_reason
|
26
|
+
# @return [::Google::Cloud::Channel::V1::Entitlement::SuspensionReason]
|
27
|
+
# Suspension reason for the Entitlement.
|
28
|
+
# @!attribute [rw] cancellation_reason
|
29
|
+
# @return [::Google::Cloud::Channel::V1::EntitlementChange::CancellationReason]
|
30
|
+
# Cancellation reason for the Entitlement.
|
31
|
+
# @!attribute [rw] activation_reason
|
32
|
+
# @return [::Google::Cloud::Channel::V1::EntitlementChange::ActivationReason]
|
33
|
+
# The Entitlement's activation reason
|
34
|
+
# @!attribute [rw] other_change_reason
|
35
|
+
# @return [::String]
|
36
|
+
# e.g. purchase_number change reason, entered by CRS.
|
37
|
+
# @!attribute [rw] entitlement
|
38
|
+
# @return [::String]
|
39
|
+
# Required. Resource name of an entitlement in the form:
|
40
|
+
# accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
41
|
+
# @!attribute [rw] offer
|
42
|
+
# @return [::String]
|
43
|
+
# Required. Resource name of the Offer at the time of change.
|
44
|
+
# Takes the form: accounts/\\{account_id}/offers/\\{offer_id}.
|
45
|
+
# @!attribute [rw] provisioned_service
|
46
|
+
# @return [::Google::Cloud::Channel::V1::ProvisionedService]
|
47
|
+
# Service provisioned for an Entitlement.
|
48
|
+
# @!attribute [rw] change_type
|
49
|
+
# @return [::Google::Cloud::Channel::V1::EntitlementChange::ChangeType]
|
50
|
+
# The change action type.
|
51
|
+
# @!attribute [rw] create_time
|
52
|
+
# @return [::Google::Protobuf::Timestamp]
|
53
|
+
# The submitted time of the change.
|
54
|
+
# @!attribute [rw] operator_type
|
55
|
+
# @return [::Google::Cloud::Channel::V1::EntitlementChange::OperatorType]
|
56
|
+
# Operator type responsible for the change.
|
57
|
+
# @!attribute [rw] parameters
|
58
|
+
# @return [::Array<::Google::Cloud::Channel::V1::Parameter>]
|
59
|
+
# Extended parameters, such as:
|
60
|
+
# purchase_order_number, gcp_details;
|
61
|
+
# internal_correlation_id, long_running_operation_id, order_id;
|
62
|
+
# etc.
|
63
|
+
# @!attribute [rw] operator
|
64
|
+
# @return [::String]
|
65
|
+
# Human-readable identifier that shows what operator made a change.
|
66
|
+
# When the operator_type is RESELLER, this is the user's email address.
|
67
|
+
# For all other operator types, this is empty.
|
68
|
+
class EntitlementChange
|
69
|
+
include ::Google::Protobuf::MessageExts
|
70
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
71
|
+
|
72
|
+
# Specifies the type of change action
|
73
|
+
module ChangeType
|
74
|
+
# Not used.
|
75
|
+
CHANGE_TYPE_UNSPECIFIED = 0
|
76
|
+
|
77
|
+
# New Entitlement was created.
|
78
|
+
CREATED = 1
|
79
|
+
|
80
|
+
# Price plan associated with an Entitlement was changed.
|
81
|
+
PRICE_PLAN_SWITCHED = 3
|
82
|
+
|
83
|
+
# Number of seats committed for a commitment Entitlement was changed.
|
84
|
+
COMMITMENT_CHANGED = 4
|
85
|
+
|
86
|
+
# An annual Entitlement was renewed.
|
87
|
+
RENEWED = 5
|
88
|
+
|
89
|
+
# Entitlement was suspended.
|
90
|
+
SUSPENDED = 6
|
91
|
+
|
92
|
+
# Entitlement was activated.
|
93
|
+
ACTIVATED = 7
|
94
|
+
|
95
|
+
# Entitlement was cancelled.
|
96
|
+
CANCELLED = 8
|
97
|
+
|
98
|
+
# Entitlement was upgraded or downgraded for ex. from Google Workspace
|
99
|
+
# Business Standard to Google Workspace Business Plus.
|
100
|
+
SKU_CHANGED = 9
|
101
|
+
|
102
|
+
# The settings for renewal of an Entitlement have changed.
|
103
|
+
RENEWAL_SETTING_CHANGED = 10
|
104
|
+
|
105
|
+
# Use for Google Workspace subscription.
|
106
|
+
# Either a trial was converted to a paid subscription or a new subscription
|
107
|
+
# with no trial is created.
|
108
|
+
PAID_SUBSCRIPTION_STARTED = 11
|
109
|
+
|
110
|
+
# License cap was changed for the entitlement.
|
111
|
+
LICENSE_CAP_CHANGED = 12
|
112
|
+
|
113
|
+
# The suspension details have changed (but it is still suspended).
|
114
|
+
SUSPENSION_DETAILS_CHANGED = 13
|
115
|
+
|
116
|
+
# The trial end date was extended.
|
117
|
+
TRIAL_END_DATE_EXTENDED = 14
|
118
|
+
|
119
|
+
# Entitlement started trial.
|
120
|
+
TRIAL_STARTED = 15
|
121
|
+
end
|
122
|
+
|
123
|
+
# Specifies the type of operator responsible for the change
|
124
|
+
module OperatorType
|
125
|
+
# Not used.
|
126
|
+
OPERATOR_TYPE_UNSPECIFIED = 0
|
127
|
+
|
128
|
+
# Customer service representative.
|
129
|
+
CUSTOMER_SERVICE_REPRESENTATIVE = 1
|
130
|
+
|
131
|
+
# System auto job.
|
132
|
+
SYSTEM = 2
|
133
|
+
|
134
|
+
# Customer user.
|
135
|
+
CUSTOMER = 3
|
136
|
+
|
137
|
+
# Reseller user.
|
138
|
+
RESELLER = 4
|
139
|
+
end
|
140
|
+
|
141
|
+
# Cancellation reason for the entitlement
|
142
|
+
module CancellationReason
|
143
|
+
# Not used.
|
144
|
+
CANCELLATION_REASON_UNSPECIFIED = 0
|
145
|
+
|
146
|
+
# Reseller triggered a cancellation of the service.
|
147
|
+
SERVICE_TERMINATED = 1
|
148
|
+
|
149
|
+
# Relationship between the reseller and customer has ended due to a
|
150
|
+
# transfer.
|
151
|
+
RELATIONSHIP_ENDED = 2
|
152
|
+
|
153
|
+
# Entitlement transferred away from reseller while still keeping other
|
154
|
+
# entitlement(s) with the reseller.
|
155
|
+
PARTIAL_TRANSFER = 3
|
156
|
+
end
|
157
|
+
|
158
|
+
# The Entitlement's activation reason
|
159
|
+
module ActivationReason
|
160
|
+
# Not used.
|
161
|
+
ACTIVATION_REASON_UNSPECIFIED = 0
|
162
|
+
|
163
|
+
# Reseller reactivated a suspended Entitlement.
|
164
|
+
RESELLER_REVOKED_SUSPENSION = 1
|
165
|
+
|
166
|
+
# Customer accepted pending terms of service.
|
167
|
+
CUSTOMER_ACCEPTED_PENDING_TOS = 2
|
168
|
+
|
169
|
+
# Reseller updated the renewal settings on an entitlement that was
|
170
|
+
# suspended due to cancellation, and this update reactivated the
|
171
|
+
# entitlement.
|
172
|
+
RENEWAL_SETTINGS_CHANGED = 3
|
173
|
+
|
174
|
+
# Other reasons (Activated temporarily for cancellation, added a payment
|
175
|
+
# plan to a trial entitlement, etc.)
|
176
|
+
OTHER_ACTIVATION_REASON = 100
|
177
|
+
end
|
178
|
+
end
|
179
|
+
end
|
180
|
+
end
|
181
|
+
end
|
182
|
+
end
|
@@ -69,13 +69,22 @@ module Google
|
|
69
69
|
# parameter names and values are defined in the
|
70
70
|
# {::Google::Cloud::Channel::V1::Offer#parameter_definitions Offer.parameter_definitions}.
|
71
71
|
#
|
72
|
-
#
|
72
|
+
# For Google Workspace, the following Parameters may be accepted as input:
|
73
|
+
#
|
74
|
+
# - max_units: The maximum assignable units for a flexible offer
|
75
|
+
#
|
76
|
+
# OR
|
77
|
+
#
|
78
|
+
# - num_units: The total commitment for commitment-based offers
|
79
|
+
#
|
80
|
+
# The response may additionally include the following output-only Parameters:
|
73
81
|
#
|
74
82
|
# - assigned_units: The number of licenses assigned to users.
|
75
83
|
#
|
76
|
-
#
|
84
|
+
# For GCP billing subaccounts, the following Parameter may be accepted as
|
85
|
+
# input:
|
77
86
|
#
|
78
|
-
# -
|
87
|
+
# - display_name: The display name of the billing subaccount.
|
79
88
|
class Entitlement
|
80
89
|
include ::Google::Protobuf::MessageExts
|
81
90
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1125,6 +1125,12 @@ module Google
|
|
1125
1125
|
# Optional. The BCP-47 language code. For example, "en-US". The
|
1126
1126
|
# response will localize in the corresponding language code, if specified.
|
1127
1127
|
# The default value is "en-US".
|
1128
|
+
# @!attribute [rw] show_future_offers
|
1129
|
+
# @return [::Boolean]
|
1130
|
+
# Optional. A boolean flag that determines if a response returns future
|
1131
|
+
# offers 30 days from now. If the show_future_offers is true, the response
|
1132
|
+
# will only contain offers that are scheduled to be available 30 days from
|
1133
|
+
# now.
|
1128
1134
|
class ListOffersRequest
|
1129
1135
|
include ::Google::Protobuf::MessageExts
|
1130
1136
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -1391,6 +1397,52 @@ module Google
|
|
1391
1397
|
include ::Google::Protobuf::MessageExts
|
1392
1398
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1393
1399
|
end
|
1400
|
+
|
1401
|
+
# Request message for
|
1402
|
+
# {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlement_changes CloudChannelService.ListEntitlementChanges}
|
1403
|
+
# @!attribute [rw] parent
|
1404
|
+
# @return [::String]
|
1405
|
+
# Required. The resource name of the entitlement for which to list
|
1406
|
+
# entitlement changes. The `-` wildcard may be used to match entitlements
|
1407
|
+
# across a customer. Formats:
|
1408
|
+
#
|
1409
|
+
# * accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
|
1410
|
+
# * accounts/\\{account_id}/customers/\\{customer_id}/entitlements/-
|
1411
|
+
# @!attribute [rw] page_size
|
1412
|
+
# @return [::Integer]
|
1413
|
+
# Optional. The maximum number of entitlement changes to return. The service
|
1414
|
+
# may return fewer than this value. If unspecified, returns at most 10
|
1415
|
+
# entitlement changes. The maximum value is 50; the server will coerce values
|
1416
|
+
# above 50.
|
1417
|
+
# @!attribute [rw] page_token
|
1418
|
+
# @return [::String]
|
1419
|
+
# Optional. A page token, received from a previous
|
1420
|
+
# {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlement_changes CloudChannelService.ListEntitlementChanges}
|
1421
|
+
# call. Provide this to retrieve the subsequent page.
|
1422
|
+
#
|
1423
|
+
# When paginating, all other parameters provided to
|
1424
|
+
# {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlement_changes CloudChannelService.ListEntitlementChanges}
|
1425
|
+
# must match the call that provided the page token.
|
1426
|
+
# @!attribute [rw] filter
|
1427
|
+
# @return [::String]
|
1428
|
+
# Optional. Filters applied to the list results.
|
1429
|
+
class ListEntitlementChangesRequest
|
1430
|
+
include ::Google::Protobuf::MessageExts
|
1431
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1432
|
+
end
|
1433
|
+
|
1434
|
+
# Response message for
|
1435
|
+
# {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlement_changes CloudChannelService.ListEntitlementChanges}
|
1436
|
+
# @!attribute [rw] entitlement_changes
|
1437
|
+
# @return [::Array<::Google::Cloud::Channel::V1::EntitlementChange>]
|
1438
|
+
# The list of entitlement changes.
|
1439
|
+
# @!attribute [rw] next_page_token
|
1440
|
+
# @return [::String]
|
1441
|
+
# A token to list the next page of results.
|
1442
|
+
class ListEntitlementChangesResponse
|
1443
|
+
include ::Google::Protobuf::MessageExts
|
1444
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
1445
|
+
end
|
1394
1446
|
end
|
1395
1447
|
end
|
1396
1448
|
end
|