google-cloud-channel-v1 0.16.0 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cdf3c3ad2fbdba2747db533d2b1799aa193890699bee88076ad04fd752169561
4
- data.tar.gz: 6c491505cced7628a330142bdafaa10486aafe6400c0cba132c4ba42090f4704
3
+ metadata.gz: 60136f93039bfca45387f078d5b69fb88bbd6a81ad3211ecdf13ee0e364db505
4
+ data.tar.gz: 47063e16eab671bdea343a5986d4d67162289387ef278f22e5009cf24e9539ba
5
5
  SHA512:
6
- metadata.gz: 6225e99f7fed79535a4d1c24ce37d447cb539602a29c704c70624ec0ca6cc85239d15003cd3c1e7e9d57cd3f0482fa916823d420e1131de8a0d581f5e3932195
7
- data.tar.gz: 431ea70d5f3b5eaeaa79be21bea9623f804372d5c923f66d0eb7828561d9fb5fff83dc757b72ba3f175926fa0b6323c63539357a4718699a46ae6cf17bf13f67
6
+ metadata.gz: 7e10b8cee62bbad634847afd61625dc927ada9b70c3572e214e8681a8f5e15b84e3415cb567303b6ed17fc75a615bd998e01dfa980bdf1fe0e710a9188f4f78c
7
+ data.tar.gz: 809ebef155747869e0af83361f67e5a49324c3240521d13e9d9a8ee16e5f0e5eb7ddc120711fc55877132f6a00acd26c176758dbdfb403bb8c5c06e89f0b0ae5
data/README.md CHANGED
@@ -47,7 +47,7 @@ for general usage information.
47
47
 
48
48
  To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
49
49
  The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
50
- or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
50
+ or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
51
51
  that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
52
52
  and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
53
53
 
@@ -553,9 +553,9 @@ module Google
553
553
  # * (`String`) The path to a service account key file in JSON format
554
554
  # * (`Hash`) A service account key as a Hash
555
555
  # * (`Google::Auth::Credentials`) A googleauth credentials object
556
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
556
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
557
557
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
558
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
558
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
559
559
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
560
560
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
561
561
  # * (`nil`) indicating no credentials
@@ -620,9 +620,9 @@ module Google
620
620
  # * (`String`) The path to a service account key file in JSON format
621
621
  # * (`Hash`) A service account key as a Hash
622
622
  # * (`Google::Auth::Credentials`) A googleauth credentials object
623
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
623
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
624
624
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
625
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
625
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
626
626
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
627
627
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
628
628
  # * (`nil`) indicating no credentials
@@ -460,9 +460,9 @@ module Google
460
460
  # * (`String`) The path to a service account key file in JSON format
461
461
  # * (`Hash`) A service account key as a Hash
462
462
  # * (`Google::Auth::Credentials`) A googleauth credentials object
463
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
463
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
464
464
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
465
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
465
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
466
466
  # * (`nil`) indicating no credentials
467
467
  # @return [::Object]
468
468
  # @!attribute [rw] scope
@@ -411,9 +411,9 @@ module Google
411
411
  # * (`String`) The path to a service account key file in JSON format
412
412
  # * (`Hash`) A service account key as a Hash
413
413
  # * (`Google::Auth::Credentials`) A googleauth credentials object
414
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
414
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
415
415
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
416
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
416
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
417
417
  # * (`nil`) indicating no credentials
418
418
  # @return [::Object]
419
419
  # @!attribute [rw] scope
@@ -4844,7 +4844,7 @@ module Google
4844
4844
  # @param options [::Gapic::CallOptions, ::Hash]
4845
4845
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
4846
4846
  #
4847
- # @overload list_offers(parent: nil, page_size: nil, page_token: nil, filter: nil, language_code: nil)
4847
+ # @overload list_offers(parent: nil, page_size: nil, page_token: nil, filter: nil, language_code: nil, show_future_offers: nil)
4848
4848
  # Pass arguments to `list_offers` via keyword arguments. Note that at
4849
4849
  # least one keyword argument is required. To specify no parameters, or to keep all
4850
4850
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -4868,6 +4868,11 @@ module Google
4868
4868
  # Optional. The BCP-47 language code. For example, "en-US". The
4869
4869
  # response will localize in the corresponding language code, if specified.
4870
4870
  # The default value is "en-US".
4871
+ # @param show_future_offers [::Boolean]
4872
+ # Optional. A boolean flag that determines if a response returns future
4873
+ # offers 30 days from now. If the show_future_offers is true, the response
4874
+ # will only contain offers that are scheduled to be available 30 days from
4875
+ # now.
4871
4876
  #
4872
4877
  # @yield [response, operation] Access the result along with the RPC operation
4873
4878
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Offer>]
@@ -5489,6 +5494,131 @@ module Google
5489
5494
  raise ::Google::Cloud::Error.from_error(e)
5490
5495
  end
5491
5496
 
5497
+ ##
5498
+ # List entitlement history.
5499
+ #
5500
+ # Possible error codes:
5501
+ #
5502
+ # * PERMISSION_DENIED: The reseller account making the request and the
5503
+ # provided reseller account are different.
5504
+ # * INVALID_ARGUMENT: Missing or invalid required fields in the request.
5505
+ # * NOT_FOUND: The parent resource doesn't exist. Usually the result of an
5506
+ # invalid name parameter.
5507
+ # * INTERNAL: Any non-user error related to a technical issue in the backend.
5508
+ # In this case, contact CloudChannel support.
5509
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
5510
+ # In this case, contact Cloud Channel support.
5511
+ #
5512
+ # Return value:
5513
+ # List of {::Google::Cloud::Channel::V1::EntitlementChange EntitlementChange}s.
5514
+ #
5515
+ # @overload list_entitlement_changes(request, options = nil)
5516
+ # Pass arguments to `list_entitlement_changes` via a request object, either of type
5517
+ # {::Google::Cloud::Channel::V1::ListEntitlementChangesRequest} or an equivalent Hash.
5518
+ #
5519
+ # @param request [::Google::Cloud::Channel::V1::ListEntitlementChangesRequest, ::Hash]
5520
+ # A request object representing the call parameters. Required. To specify no
5521
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5522
+ # @param options [::Gapic::CallOptions, ::Hash]
5523
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5524
+ #
5525
+ # @overload list_entitlement_changes(parent: nil, page_size: nil, page_token: nil, filter: nil)
5526
+ # Pass arguments to `list_entitlement_changes` via keyword arguments. Note that at
5527
+ # least one keyword argument is required. To specify no parameters, or to keep all
5528
+ # the default parameter values, pass an empty Hash as a request object (see above).
5529
+ #
5530
+ # @param parent [::String]
5531
+ # Required. The resource name of the entitlement for which to list
5532
+ # entitlement changes. The `-` wildcard may be used to match entitlements
5533
+ # across a customer. Formats:
5534
+ #
5535
+ # * accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
5536
+ # * accounts/\\{account_id}/customers/\\{customer_id}/entitlements/-
5537
+ # @param page_size [::Integer]
5538
+ # Optional. The maximum number of entitlement changes to return. The service
5539
+ # may return fewer than this value. If unspecified, returns at most 10
5540
+ # entitlement changes. The maximum value is 50; the server will coerce values
5541
+ # above 50.
5542
+ # @param page_token [::String]
5543
+ # Optional. A page token, received from a previous
5544
+ # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlement_changes CloudChannelService.ListEntitlementChanges}
5545
+ # call. Provide this to retrieve the subsequent page.
5546
+ #
5547
+ # When paginating, all other parameters provided to
5548
+ # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlement_changes CloudChannelService.ListEntitlementChanges}
5549
+ # must match the call that provided the page token.
5550
+ # @param filter [::String]
5551
+ # Optional. Filters applied to the list results.
5552
+ #
5553
+ # @yield [response, operation] Access the result along with the RPC operation
5554
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::EntitlementChange>]
5555
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5556
+ #
5557
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::EntitlementChange>]
5558
+ #
5559
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5560
+ #
5561
+ # @example Basic example
5562
+ # require "google/cloud/channel/v1"
5563
+ #
5564
+ # # Create a client object. The client can be reused for multiple calls.
5565
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
5566
+ #
5567
+ # # Create a request. To set request fields, pass in keyword arguments.
5568
+ # request = Google::Cloud::Channel::V1::ListEntitlementChangesRequest.new
5569
+ #
5570
+ # # Call the list_entitlement_changes method.
5571
+ # result = client.list_entitlement_changes request
5572
+ #
5573
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
5574
+ # # over elements, and API calls will be issued to fetch pages as needed.
5575
+ # result.each do |item|
5576
+ # # Each element is of type ::Google::Cloud::Channel::V1::EntitlementChange.
5577
+ # p item
5578
+ # end
5579
+ #
5580
+ def list_entitlement_changes request, options = nil
5581
+ raise ::ArgumentError, "request must be provided" if request.nil?
5582
+
5583
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Channel::V1::ListEntitlementChangesRequest
5584
+
5585
+ # Converts hash and nil to an options object
5586
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5587
+
5588
+ # Customize the options with defaults
5589
+ metadata = @config.rpcs.list_entitlement_changes.metadata.to_h
5590
+
5591
+ # Set x-goog-api-client and x-goog-user-project headers
5592
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5593
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5594
+ gapic_version: ::Google::Cloud::Channel::V1::VERSION
5595
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5596
+
5597
+ header_params = {}
5598
+ if request.parent
5599
+ header_params["parent"] = request.parent
5600
+ end
5601
+
5602
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5603
+ metadata[:"x-goog-request-params"] ||= request_params_header
5604
+
5605
+ options.apply_defaults timeout: @config.rpcs.list_entitlement_changes.timeout,
5606
+ metadata: metadata,
5607
+ retry_policy: @config.rpcs.list_entitlement_changes.retry_policy
5608
+
5609
+ options.apply_defaults timeout: @config.timeout,
5610
+ metadata: @config.metadata,
5611
+ retry_policy: @config.retry_policy
5612
+
5613
+ @cloud_channel_service_stub.call_rpc :list_entitlement_changes, request, options: options do |response, operation|
5614
+ response = ::Gapic::PagedEnumerable.new @cloud_channel_service_stub, :list_entitlement_changes, request, response, operation, options
5615
+ yield response, operation if block_given?
5616
+ return response
5617
+ end
5618
+ rescue ::GRPC::BadStatus => e
5619
+ raise ::Google::Cloud::Error.from_error(e)
5620
+ end
5621
+
5492
5622
  ##
5493
5623
  # Configuration class for the CloudChannelService API.
5494
5624
  #
@@ -5527,9 +5657,9 @@ module Google
5527
5657
  # * (`String`) The path to a service account key file in JSON format
5528
5658
  # * (`Hash`) A service account key as a Hash
5529
5659
  # * (`Google::Auth::Credentials`) A googleauth credentials object
5530
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
5660
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
5531
5661
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
5532
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
5662
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
5533
5663
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
5534
5664
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
5535
5665
  # * (`nil`) indicating no credentials
@@ -5849,6 +5979,11 @@ module Google
5849
5979
  # @return [::Gapic::Config::Method]
5850
5980
  #
5851
5981
  attr_reader :list_subscribers
5982
+ ##
5983
+ # RPC-specific configuration for `list_entitlement_changes`
5984
+ # @return [::Gapic::Config::Method]
5985
+ #
5986
+ attr_reader :list_entitlement_changes
5852
5987
 
5853
5988
  # @private
5854
5989
  def initialize parent_rpcs = nil
@@ -5942,6 +6077,8 @@ module Google
5942
6077
  @unregister_subscriber = ::Gapic::Config::Method.new unregister_subscriber_config
5943
6078
  list_subscribers_config = parent_rpcs.list_subscribers if parent_rpcs.respond_to? :list_subscribers
5944
6079
  @list_subscribers = ::Gapic::Config::Method.new list_subscribers_config
6080
+ list_entitlement_changes_config = parent_rpcs.list_entitlement_changes if parent_rpcs.respond_to? :list_entitlement_changes
6081
+ @list_entitlement_changes = ::Gapic::Config::Method.new list_entitlement_changes_config
5945
6082
 
5946
6083
  yield self if block_given?
5947
6084
  end
@@ -620,9 +620,9 @@ module Google
620
620
  # * (`String`) The path to a service account key file in JSON format
621
621
  # * (`Hash`) A service account key as a Hash
622
622
  # * (`Google::Auth::Credentials`) A googleauth credentials object
623
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
623
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
624
624
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
625
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
625
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
626
626
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
627
627
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
628
628
  # * (`nil`) indicating no credentials
@@ -3833,7 +3833,7 @@ module Google
3833
3833
  # @param options [::Gapic::CallOptions, ::Hash]
3834
3834
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
3835
3835
  #
3836
- # @overload list_offers(parent: nil, page_size: nil, page_token: nil, filter: nil, language_code: nil)
3836
+ # @overload list_offers(parent: nil, page_size: nil, page_token: nil, filter: nil, language_code: nil, show_future_offers: nil)
3837
3837
  # Pass arguments to `list_offers` via keyword arguments. Note that at
3838
3838
  # least one keyword argument is required. To specify no parameters, or to keep all
3839
3839
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -3857,6 +3857,11 @@ module Google
3857
3857
  # Optional. The BCP-47 language code. For example, "en-US". The
3858
3858
  # response will localize in the corresponding language code, if specified.
3859
3859
  # The default value is "en-US".
3860
+ # @param show_future_offers [::Boolean]
3861
+ # Optional. A boolean flag that determines if a response returns future
3862
+ # offers 30 days from now. If the show_future_offers is true, the response
3863
+ # will only contain offers that are scheduled to be available 30 days from
3864
+ # now.
3860
3865
  # @yield [result, operation] Access the result along with the TransportOperation object
3861
3866
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Channel::V1::Offer>]
3862
3867
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -4329,6 +4334,104 @@ module Google
4329
4334
  raise ::Google::Cloud::Error.from_error(e)
4330
4335
  end
4331
4336
 
4337
+ ##
4338
+ # List entitlement history.
4339
+ #
4340
+ # Possible error codes:
4341
+ #
4342
+ # * PERMISSION_DENIED: The reseller account making the request and the
4343
+ # provided reseller account are different.
4344
+ # * INVALID_ARGUMENT: Missing or invalid required fields in the request.
4345
+ # * NOT_FOUND: The parent resource doesn't exist. Usually the result of an
4346
+ # invalid name parameter.
4347
+ # * INTERNAL: Any non-user error related to a technical issue in the backend.
4348
+ # In this case, contact CloudChannel support.
4349
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
4350
+ # In this case, contact Cloud Channel support.
4351
+ #
4352
+ # Return value:
4353
+ # List of {::Google::Cloud::Channel::V1::EntitlementChange EntitlementChange}s.
4354
+ #
4355
+ # @overload list_entitlement_changes(request, options = nil)
4356
+ # Pass arguments to `list_entitlement_changes` via a request object, either of type
4357
+ # {::Google::Cloud::Channel::V1::ListEntitlementChangesRequest} or an equivalent Hash.
4358
+ #
4359
+ # @param request [::Google::Cloud::Channel::V1::ListEntitlementChangesRequest, ::Hash]
4360
+ # A request object representing the call parameters. Required. To specify no
4361
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
4362
+ # @param options [::Gapic::CallOptions, ::Hash]
4363
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
4364
+ #
4365
+ # @overload list_entitlement_changes(parent: nil, page_size: nil, page_token: nil, filter: nil)
4366
+ # Pass arguments to `list_entitlement_changes` via keyword arguments. Note that at
4367
+ # least one keyword argument is required. To specify no parameters, or to keep all
4368
+ # the default parameter values, pass an empty Hash as a request object (see above).
4369
+ #
4370
+ # @param parent [::String]
4371
+ # Required. The resource name of the entitlement for which to list
4372
+ # entitlement changes. The `-` wildcard may be used to match entitlements
4373
+ # across a customer. Formats:
4374
+ #
4375
+ # * accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
4376
+ # * accounts/\\{account_id}/customers/\\{customer_id}/entitlements/-
4377
+ # @param page_size [::Integer]
4378
+ # Optional. The maximum number of entitlement changes to return. The service
4379
+ # may return fewer than this value. If unspecified, returns at most 10
4380
+ # entitlement changes. The maximum value is 50; the server will coerce values
4381
+ # above 50.
4382
+ # @param page_token [::String]
4383
+ # Optional. A page token, received from a previous
4384
+ # {::Google::Cloud::Channel::V1::CloudChannelService::Rest::Client#list_entitlement_changes CloudChannelService.ListEntitlementChanges}
4385
+ # call. Provide this to retrieve the subsequent page.
4386
+ #
4387
+ # When paginating, all other parameters provided to
4388
+ # {::Google::Cloud::Channel::V1::CloudChannelService::Rest::Client#list_entitlement_changes CloudChannelService.ListEntitlementChanges}
4389
+ # must match the call that provided the page token.
4390
+ # @param filter [::String]
4391
+ # Optional. Filters applied to the list results.
4392
+ # @yield [result, operation] Access the result along with the TransportOperation object
4393
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Channel::V1::EntitlementChange>]
4394
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
4395
+ #
4396
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Channel::V1::EntitlementChange>]
4397
+ #
4398
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
4399
+ def list_entitlement_changes request, options = nil
4400
+ raise ::ArgumentError, "request must be provided" if request.nil?
4401
+
4402
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Channel::V1::ListEntitlementChangesRequest
4403
+
4404
+ # Converts hash and nil to an options object
4405
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
4406
+
4407
+ # Customize the options with defaults
4408
+ call_metadata = @config.rpcs.list_entitlement_changes.metadata.to_h
4409
+
4410
+ # Set x-goog-api-client and x-goog-user-project headers
4411
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
4412
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
4413
+ gapic_version: ::Google::Cloud::Channel::V1::VERSION,
4414
+ transports_version_send: [:rest]
4415
+
4416
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
4417
+
4418
+ options.apply_defaults timeout: @config.rpcs.list_entitlement_changes.timeout,
4419
+ metadata: call_metadata,
4420
+ retry_policy: @config.rpcs.list_entitlement_changes.retry_policy
4421
+
4422
+ options.apply_defaults timeout: @config.timeout,
4423
+ metadata: @config.metadata,
4424
+ retry_policy: @config.retry_policy
4425
+
4426
+ @cloud_channel_service_stub.list_entitlement_changes request, options do |result, operation|
4427
+ result = ::Gapic::Rest::PagedEnumerable.new @cloud_channel_service_stub, :list_entitlement_changes, "entitlement_changes", request, result, options
4428
+ yield result, operation if block_given?
4429
+ return result
4430
+ end
4431
+ rescue ::Gapic::Rest::Error => e
4432
+ raise ::Google::Cloud::Error.from_error(e)
4433
+ end
4434
+
4332
4435
  ##
4333
4436
  # Configuration class for the CloudChannelService REST API.
4334
4437
  #
@@ -4367,9 +4470,9 @@ module Google
4367
4470
  # * (`String`) The path to a service account key file in JSON format
4368
4471
  # * (`Hash`) A service account key as a Hash
4369
4472
  # * (`Google::Auth::Credentials`) A googleauth credentials object
4370
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
4473
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
4371
4474
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
4372
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
4475
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
4373
4476
  # * (`nil`) indicating no credentials
4374
4477
  # @return [::Object]
4375
4478
  # @!attribute [rw] scope
@@ -4677,6 +4780,11 @@ module Google
4677
4780
  # @return [::Gapic::Config::Method]
4678
4781
  #
4679
4782
  attr_reader :list_subscribers
4783
+ ##
4784
+ # RPC-specific configuration for `list_entitlement_changes`
4785
+ # @return [::Gapic::Config::Method]
4786
+ #
4787
+ attr_reader :list_entitlement_changes
4680
4788
 
4681
4789
  # @private
4682
4790
  def initialize parent_rpcs = nil
@@ -4770,6 +4878,8 @@ module Google
4770
4878
  @unregister_subscriber = ::Gapic::Config::Method.new unregister_subscriber_config
4771
4879
  list_subscribers_config = parent_rpcs.list_subscribers if parent_rpcs.respond_to? :list_subscribers
4772
4880
  @list_subscribers = ::Gapic::Config::Method.new list_subscribers_config
4881
+ list_entitlement_changes_config = parent_rpcs.list_entitlement_changes if parent_rpcs.respond_to? :list_entitlement_changes
4882
+ @list_entitlement_changes = ::Gapic::Config::Method.new list_entitlement_changes_config
4773
4883
 
4774
4884
  yield self if block_given?
4775
4885
  end
@@ -411,9 +411,9 @@ module Google
411
411
  # * (`String`) The path to a service account key file in JSON format
412
412
  # * (`Hash`) A service account key as a Hash
413
413
  # * (`Google::Auth::Credentials`) A googleauth credentials object
414
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
414
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
415
415
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
416
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
416
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
417
417
  # * (`nil`) indicating no credentials
418
418
  # @return [::Object]
419
419
  # @!attribute [rw] scope
@@ -1750,6 +1750,44 @@ module Google
1750
1750
  result
1751
1751
  end
1752
1752
 
1753
+ ##
1754
+ # Baseline implementation for the list_entitlement_changes REST call
1755
+ #
1756
+ # @param request_pb [::Google::Cloud::Channel::V1::ListEntitlementChangesRequest]
1757
+ # A request object representing the call parameters. Required.
1758
+ # @param options [::Gapic::CallOptions]
1759
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
1760
+ #
1761
+ # @yield [result, operation] Access the result along with the TransportOperation object
1762
+ # @yieldparam result [::Google::Cloud::Channel::V1::ListEntitlementChangesResponse]
1763
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
1764
+ #
1765
+ # @return [::Google::Cloud::Channel::V1::ListEntitlementChangesResponse]
1766
+ # A result object deserialized from the server's reply
1767
+ def list_entitlement_changes request_pb, options = nil
1768
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
1769
+
1770
+ verb, uri, query_string_params, body = ServiceStub.transcode_list_entitlement_changes_request request_pb
1771
+ query_string_params = if query_string_params.any?
1772
+ query_string_params.to_h { |p| p.split("=", 2) }
1773
+ else
1774
+ {}
1775
+ end
1776
+
1777
+ response = @client_stub.make_http_request(
1778
+ verb,
1779
+ uri: uri,
1780
+ body: body || "",
1781
+ params: query_string_params,
1782
+ options: options
1783
+ )
1784
+ operation = ::Gapic::Rest::TransportOperation.new response
1785
+ result = ::Google::Cloud::Channel::V1::ListEntitlementChangesResponse.decode_json response.body, ignore_unknown_fields: true
1786
+
1787
+ yield result, operation if block_given?
1788
+ result
1789
+ end
1790
+
1753
1791
  ##
1754
1792
  # @private
1755
1793
  #
@@ -2762,6 +2800,27 @@ module Google
2762
2800
  )
2763
2801
  transcoder.transcode request_pb
2764
2802
  end
2803
+
2804
+ ##
2805
+ # @private
2806
+ #
2807
+ # GRPC transcoding helper method for the list_entitlement_changes REST call
2808
+ #
2809
+ # @param request_pb [::Google::Cloud::Channel::V1::ListEntitlementChangesRequest]
2810
+ # A request object representing the call parameters. Required.
2811
+ # @return [Array(String, [String, nil], Hash{String => String})]
2812
+ # Uri, Body, Query string parameters
2813
+ def self.transcode_list_entitlement_changes_request request_pb
2814
+ transcoder = Gapic::Rest::GrpcTranscoder.new
2815
+ .with_bindings(
2816
+ uri_method: :get,
2817
+ uri_template: "/v1/{parent}:listEntitlementChanges",
2818
+ matches: [
2819
+ ["parent", %r{^accounts/[^/]+/customers/[^/]+/entitlements/[^/]+/?$}, false]
2820
+ ]
2821
+ )
2822
+ transcoder.transcode request_pb
2823
+ end
2765
2824
  end
2766
2825
  end
2767
2826
  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'
@@ -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
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Channel
23
23
  module V1
24
- VERSION = "0.16.0"
24
+ VERSION = "0.17.0"
25
25
  end
26
26
  end
27
27
  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
- # The response may include the following output-only Parameters:
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
- # - max_units: The maximum assignable units for a flexible offer.
84
+ # For GCP billing subaccounts, the following Parameter may be accepted as
85
+ # input:
77
86
  #
78
- # - num_units: The total commitment for commitment-based offers.
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
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-channel-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.16.0
4
+ version: 0.17.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-03-08 00:00:00.000000000 Z
11
+ date: 2023-03-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -194,6 +194,7 @@ files:
194
194
  - lib/google/cloud/channel/v1/cloud_channel_service/rest/service_stub.rb
195
195
  - lib/google/cloud/channel/v1/common_pb.rb
196
196
  - lib/google/cloud/channel/v1/customers_pb.rb
197
+ - lib/google/cloud/channel/v1/entitlement_changes_pb.rb
197
198
  - lib/google/cloud/channel/v1/entitlements_pb.rb
198
199
  - lib/google/cloud/channel/v1/offers_pb.rb
199
200
  - lib/google/cloud/channel/v1/operations_pb.rb
@@ -214,6 +215,7 @@ files:
214
215
  - proto_docs/google/cloud/channel/v1/channel_partner_links.rb
215
216
  - proto_docs/google/cloud/channel/v1/common.rb
216
217
  - proto_docs/google/cloud/channel/v1/customers.rb
218
+ - proto_docs/google/cloud/channel/v1/entitlement_changes.rb
217
219
  - proto_docs/google/cloud/channel/v1/entitlements.rb
218
220
  - proto_docs/google/cloud/channel/v1/offers.rb
219
221
  - proto_docs/google/cloud/channel/v1/operations.rb