google-cloud-channel-v1 0.16.0 → 0.18.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (24) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/channel/v1/cloud_channel_reports_service/client.rb +2 -2
  4. data/lib/google/cloud/channel/v1/cloud_channel_reports_service/operations.rb +2 -2
  5. data/lib/google/cloud/channel/v1/cloud_channel_reports_service/rest/client.rb +2 -2
  6. data/lib/google/cloud/channel/v1/cloud_channel_reports_service/rest/operations.rb +2 -2
  7. data/lib/google/cloud/channel/v1/cloud_channel_service/client.rb +144 -5
  8. data/lib/google/cloud/channel/v1/cloud_channel_service/operations.rb +2 -2
  9. data/lib/google/cloud/channel/v1/cloud_channel_service/rest/client.rb +117 -5
  10. data/lib/google/cloud/channel/v1/cloud_channel_service/rest/operations.rb +2 -2
  11. data/lib/google/cloud/channel/v1/cloud_channel_service/rest/service_stub.rb +59 -0
  12. data/lib/google/cloud/channel/v1/customers_pb.rb +1 -0
  13. data/lib/google/cloud/channel/v1/entitlement_changes_pb.rb +81 -0
  14. data/lib/google/cloud/channel/v1/entitlements_pb.rb +1 -0
  15. data/lib/google/cloud/channel/v1/reports_service_pb.rb +1 -0
  16. data/lib/google/cloud/channel/v1/service_pb.rb +15 -0
  17. data/lib/google/cloud/channel/v1/service_services_pb.rb +21 -2
  18. data/lib/google/cloud/channel/v1/version.rb +1 -1
  19. data/proto_docs/google/api/client.rb +67 -4
  20. data/proto_docs/google/cloud/channel/v1/customers.rb +4 -0
  21. data/proto_docs/google/cloud/channel/v1/entitlement_changes.rb +182 -0
  22. data/proto_docs/google/cloud/channel/v1/entitlements.rb +16 -3
  23. data/proto_docs/google/cloud/channel/v1/service.rb +52 -0
  24. metadata +4 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cdf3c3ad2fbdba2747db533d2b1799aa193890699bee88076ad04fd752169561
4
- data.tar.gz: 6c491505cced7628a330142bdafaa10486aafe6400c0cba132c4ba42090f4704
3
+ metadata.gz: 0aeed5b1f69ce0da01d1371151821e8f36b24c21b66e511c8114a8d78b857fc4
4
+ data.tar.gz: 9d1184cfbcbcbfaf09ea658be08f72675ac08ffe6002d73fb1c2a6b517c81785
5
5
  SHA512:
6
- metadata.gz: 6225e99f7fed79535a4d1c24ce37d447cb539602a29c704c70624ec0ca6cc85239d15003cd3c1e7e9d57cd3f0482fa916823d420e1131de8a0d581f5e3932195
7
- data.tar.gz: 431ea70d5f3b5eaeaa79be21bea9623f804372d5c923f66d0eb7828561d9fb5fff83dc757b72ba3f175926fa0b6323c63539357a4718699a46ae6cf17bf13f67
6
+ metadata.gz: 59223196e20f2c145f835b69822c6813b87c31e2e0ad3344efe026c1e6434c1be5a19d1ecc2e6cb0ef1637352688b54d9ca1ba23666a524caf101b5b8be8aa8b
7
+ data.tar.gz: 6d39c2e1cc1f1196bb8c6004fc6fff2c3762b099391d3d189201058aef33d4449fda5229b2002a300c7767d76da5bf6d19e97b8c43d70bac78c4122c441ed254
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
@@ -3471,7 +3471,8 @@ module Google
3471
3471
  # {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig}
3472
3472
  # resources. The data for each resource is displayed in the ascending order
3473
3473
  # of:
3474
- # * customer ID
3474
+ #
3475
+ # * Customer ID
3475
3476
  # * {::Google::Cloud::Channel::V1::RepricingConfig::EntitlementGranularity#entitlement RepricingConfig.EntitlementGranularity.entitlement}
3476
3477
  # * {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}
3477
3478
  # * {::Google::Cloud::Channel::V1::CustomerRepricingConfig#update_time CustomerRepricingConfig.update_time}
@@ -4058,7 +4059,8 @@ module Google
4058
4059
  # {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig}
4059
4060
  # resources. The data for each resource is displayed in the ascending order
4060
4061
  # of:
4061
- # * channel partner ID
4062
+ #
4063
+ # * Channel Partner ID
4062
4064
  # * {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}
4063
4065
  # * {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig#update_time ChannelPartnerRepricingConfig.update_time}
4064
4066
  #
@@ -4844,7 +4846,7 @@ module Google
4844
4846
  # @param options [::Gapic::CallOptions, ::Hash]
4845
4847
  # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
4846
4848
  #
4847
- # @overload list_offers(parent: nil, page_size: nil, page_token: nil, filter: nil, language_code: nil)
4849
+ # @overload list_offers(parent: nil, page_size: nil, page_token: nil, filter: nil, language_code: nil, show_future_offers: nil)
4848
4850
  # Pass arguments to `list_offers` via keyword arguments. Note that at
4849
4851
  # least one keyword argument is required. To specify no parameters, or to keep all
4850
4852
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -4868,6 +4870,11 @@ module Google
4868
4870
  # Optional. The BCP-47 language code. For example, "en-US". The
4869
4871
  # response will localize in the corresponding language code, if specified.
4870
4872
  # The default value is "en-US".
4873
+ # @param show_future_offers [::Boolean]
4874
+ # Optional. A boolean flag that determines if a response returns future
4875
+ # offers 30 days from now. If the show_future_offers is true, the response
4876
+ # will only contain offers that are scheduled to be available 30 days from
4877
+ # now.
4871
4878
  #
4872
4879
  # @yield [response, operation] Access the result along with the RPC operation
4873
4880
  # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::Offer>]
@@ -5489,6 +5496,131 @@ module Google
5489
5496
  raise ::Google::Cloud::Error.from_error(e)
5490
5497
  end
5491
5498
 
5499
+ ##
5500
+ # List entitlement history.
5501
+ #
5502
+ # Possible error codes:
5503
+ #
5504
+ # * PERMISSION_DENIED: The reseller account making the request and the
5505
+ # provided reseller account are different.
5506
+ # * INVALID_ARGUMENT: Missing or invalid required fields in the request.
5507
+ # * NOT_FOUND: The parent resource doesn't exist. Usually the result of an
5508
+ # invalid name parameter.
5509
+ # * INTERNAL: Any non-user error related to a technical issue in the backend.
5510
+ # In this case, contact CloudChannel support.
5511
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
5512
+ # In this case, contact Cloud Channel support.
5513
+ #
5514
+ # Return value:
5515
+ # List of {::Google::Cloud::Channel::V1::EntitlementChange EntitlementChange}s.
5516
+ #
5517
+ # @overload list_entitlement_changes(request, options = nil)
5518
+ # Pass arguments to `list_entitlement_changes` via a request object, either of type
5519
+ # {::Google::Cloud::Channel::V1::ListEntitlementChangesRequest} or an equivalent Hash.
5520
+ #
5521
+ # @param request [::Google::Cloud::Channel::V1::ListEntitlementChangesRequest, ::Hash]
5522
+ # A request object representing the call parameters. Required. To specify no
5523
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
5524
+ # @param options [::Gapic::CallOptions, ::Hash]
5525
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
5526
+ #
5527
+ # @overload list_entitlement_changes(parent: nil, page_size: nil, page_token: nil, filter: nil)
5528
+ # Pass arguments to `list_entitlement_changes` via keyword arguments. Note that at
5529
+ # least one keyword argument is required. To specify no parameters, or to keep all
5530
+ # the default parameter values, pass an empty Hash as a request object (see above).
5531
+ #
5532
+ # @param parent [::String]
5533
+ # Required. The resource name of the entitlement for which to list
5534
+ # entitlement changes. The `-` wildcard may be used to match entitlements
5535
+ # across a customer. Formats:
5536
+ #
5537
+ # * accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
5538
+ # * accounts/\\{account_id}/customers/\\{customer_id}/entitlements/-
5539
+ # @param page_size [::Integer]
5540
+ # Optional. The maximum number of entitlement changes to return. The service
5541
+ # may return fewer than this value. If unspecified, returns at most 10
5542
+ # entitlement changes. The maximum value is 50; the server will coerce values
5543
+ # above 50.
5544
+ # @param page_token [::String]
5545
+ # Optional. A page token, received from a previous
5546
+ # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlement_changes CloudChannelService.ListEntitlementChanges}
5547
+ # call. Provide this to retrieve the subsequent page.
5548
+ #
5549
+ # When paginating, all other parameters provided to
5550
+ # {::Google::Cloud::Channel::V1::CloudChannelService::Client#list_entitlement_changes CloudChannelService.ListEntitlementChanges}
5551
+ # must match the call that provided the page token.
5552
+ # @param filter [::String]
5553
+ # Optional. Filters applied to the list results.
5554
+ #
5555
+ # @yield [response, operation] Access the result along with the RPC operation
5556
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::EntitlementChange>]
5557
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
5558
+ #
5559
+ # @return [::Gapic::PagedEnumerable<::Google::Cloud::Channel::V1::EntitlementChange>]
5560
+ #
5561
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
5562
+ #
5563
+ # @example Basic example
5564
+ # require "google/cloud/channel/v1"
5565
+ #
5566
+ # # Create a client object. The client can be reused for multiple calls.
5567
+ # client = Google::Cloud::Channel::V1::CloudChannelService::Client.new
5568
+ #
5569
+ # # Create a request. To set request fields, pass in keyword arguments.
5570
+ # request = Google::Cloud::Channel::V1::ListEntitlementChangesRequest.new
5571
+ #
5572
+ # # Call the list_entitlement_changes method.
5573
+ # result = client.list_entitlement_changes request
5574
+ #
5575
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
5576
+ # # over elements, and API calls will be issued to fetch pages as needed.
5577
+ # result.each do |item|
5578
+ # # Each element is of type ::Google::Cloud::Channel::V1::EntitlementChange.
5579
+ # p item
5580
+ # end
5581
+ #
5582
+ def list_entitlement_changes request, options = nil
5583
+ raise ::ArgumentError, "request must be provided" if request.nil?
5584
+
5585
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Channel::V1::ListEntitlementChangesRequest
5586
+
5587
+ # Converts hash and nil to an options object
5588
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
5589
+
5590
+ # Customize the options with defaults
5591
+ metadata = @config.rpcs.list_entitlement_changes.metadata.to_h
5592
+
5593
+ # Set x-goog-api-client and x-goog-user-project headers
5594
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
5595
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
5596
+ gapic_version: ::Google::Cloud::Channel::V1::VERSION
5597
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
5598
+
5599
+ header_params = {}
5600
+ if request.parent
5601
+ header_params["parent"] = request.parent
5602
+ end
5603
+
5604
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
5605
+ metadata[:"x-goog-request-params"] ||= request_params_header
5606
+
5607
+ options.apply_defaults timeout: @config.rpcs.list_entitlement_changes.timeout,
5608
+ metadata: metadata,
5609
+ retry_policy: @config.rpcs.list_entitlement_changes.retry_policy
5610
+
5611
+ options.apply_defaults timeout: @config.timeout,
5612
+ metadata: @config.metadata,
5613
+ retry_policy: @config.retry_policy
5614
+
5615
+ @cloud_channel_service_stub.call_rpc :list_entitlement_changes, request, options: options do |response, operation|
5616
+ response = ::Gapic::PagedEnumerable.new @cloud_channel_service_stub, :list_entitlement_changes, request, response, operation, options
5617
+ yield response, operation if block_given?
5618
+ return response
5619
+ end
5620
+ rescue ::GRPC::BadStatus => e
5621
+ raise ::Google::Cloud::Error.from_error(e)
5622
+ end
5623
+
5492
5624
  ##
5493
5625
  # Configuration class for the CloudChannelService API.
5494
5626
  #
@@ -5527,9 +5659,9 @@ module Google
5527
5659
  # * (`String`) The path to a service account key file in JSON format
5528
5660
  # * (`Hash`) A service account key as a Hash
5529
5661
  # * (`Google::Auth::Credentials`) A googleauth credentials object
5530
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
5662
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
5531
5663
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
5532
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
5664
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
5533
5665
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
5534
5666
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
5535
5667
  # * (`nil`) indicating no credentials
@@ -5849,6 +5981,11 @@ module Google
5849
5981
  # @return [::Gapic::Config::Method]
5850
5982
  #
5851
5983
  attr_reader :list_subscribers
5984
+ ##
5985
+ # RPC-specific configuration for `list_entitlement_changes`
5986
+ # @return [::Gapic::Config::Method]
5987
+ #
5988
+ attr_reader :list_entitlement_changes
5852
5989
 
5853
5990
  # @private
5854
5991
  def initialize parent_rpcs = nil
@@ -5942,6 +6079,8 @@ module Google
5942
6079
  @unregister_subscriber = ::Gapic::Config::Method.new unregister_subscriber_config
5943
6080
  list_subscribers_config = parent_rpcs.list_subscribers if parent_rpcs.respond_to? :list_subscribers
5944
6081
  @list_subscribers = ::Gapic::Config::Method.new list_subscribers_config
6082
+ list_entitlement_changes_config = parent_rpcs.list_entitlement_changes if parent_rpcs.respond_to? :list_entitlement_changes
6083
+ @list_entitlement_changes = ::Gapic::Config::Method.new list_entitlement_changes_config
5945
6084
 
5946
6085
  yield self if block_given?
5947
6086
  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
@@ -2744,7 +2744,8 @@ module Google
2744
2744
  # {::Google::Cloud::Channel::V1::CustomerRepricingConfig CustomerRepricingConfig}
2745
2745
  # resources. The data for each resource is displayed in the ascending order
2746
2746
  # of:
2747
- # * customer ID
2747
+ #
2748
+ # * Customer ID
2748
2749
  # * {::Google::Cloud::Channel::V1::RepricingConfig::EntitlementGranularity#entitlement RepricingConfig.EntitlementGranularity.entitlement}
2749
2750
  # * {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}
2750
2751
  # * {::Google::Cloud::Channel::V1::CustomerRepricingConfig#update_time CustomerRepricingConfig.update_time}
@@ -3212,7 +3213,8 @@ module Google
3212
3213
  # {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig ChannelPartnerRepricingConfig}
3213
3214
  # resources. The data for each resource is displayed in the ascending order
3214
3215
  # of:
3215
- # * channel partner ID
3216
+ #
3217
+ # * Channel Partner ID
3216
3218
  # * {::Google::Cloud::Channel::V1::RepricingConfig#effective_invoice_month RepricingConfig.effective_invoice_month}
3217
3219
  # * {::Google::Cloud::Channel::V1::ChannelPartnerRepricingConfig#update_time ChannelPartnerRepricingConfig.update_time}
3218
3220
  #
@@ -3833,7 +3835,7 @@ module Google
3833
3835
  # @param options [::Gapic::CallOptions, ::Hash]
3834
3836
  # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
3835
3837
  #
3836
- # @overload list_offers(parent: nil, page_size: nil, page_token: nil, filter: nil, language_code: nil)
3838
+ # @overload list_offers(parent: nil, page_size: nil, page_token: nil, filter: nil, language_code: nil, show_future_offers: nil)
3837
3839
  # Pass arguments to `list_offers` via keyword arguments. Note that at
3838
3840
  # least one keyword argument is required. To specify no parameters, or to keep all
3839
3841
  # the default parameter values, pass an empty Hash as a request object (see above).
@@ -3857,6 +3859,11 @@ module Google
3857
3859
  # Optional. The BCP-47 language code. For example, "en-US". The
3858
3860
  # response will localize in the corresponding language code, if specified.
3859
3861
  # The default value is "en-US".
3862
+ # @param show_future_offers [::Boolean]
3863
+ # Optional. A boolean flag that determines if a response returns future
3864
+ # offers 30 days from now. If the show_future_offers is true, the response
3865
+ # will only contain offers that are scheduled to be available 30 days from
3866
+ # now.
3860
3867
  # @yield [result, operation] Access the result along with the TransportOperation object
3861
3868
  # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Channel::V1::Offer>]
3862
3869
  # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -4329,6 +4336,104 @@ module Google
4329
4336
  raise ::Google::Cloud::Error.from_error(e)
4330
4337
  end
4331
4338
 
4339
+ ##
4340
+ # List entitlement history.
4341
+ #
4342
+ # Possible error codes:
4343
+ #
4344
+ # * PERMISSION_DENIED: The reseller account making the request and the
4345
+ # provided reseller account are different.
4346
+ # * INVALID_ARGUMENT: Missing or invalid required fields in the request.
4347
+ # * NOT_FOUND: The parent resource doesn't exist. Usually the result of an
4348
+ # invalid name parameter.
4349
+ # * INTERNAL: Any non-user error related to a technical issue in the backend.
4350
+ # In this case, contact CloudChannel support.
4351
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
4352
+ # In this case, contact Cloud Channel support.
4353
+ #
4354
+ # Return value:
4355
+ # List of {::Google::Cloud::Channel::V1::EntitlementChange EntitlementChange}s.
4356
+ #
4357
+ # @overload list_entitlement_changes(request, options = nil)
4358
+ # Pass arguments to `list_entitlement_changes` via a request object, either of type
4359
+ # {::Google::Cloud::Channel::V1::ListEntitlementChangesRequest} or an equivalent Hash.
4360
+ #
4361
+ # @param request [::Google::Cloud::Channel::V1::ListEntitlementChangesRequest, ::Hash]
4362
+ # A request object representing the call parameters. Required. To specify no
4363
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
4364
+ # @param options [::Gapic::CallOptions, ::Hash]
4365
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
4366
+ #
4367
+ # @overload list_entitlement_changes(parent: nil, page_size: nil, page_token: nil, filter: nil)
4368
+ # Pass arguments to `list_entitlement_changes` via keyword arguments. Note that at
4369
+ # least one keyword argument is required. To specify no parameters, or to keep all
4370
+ # the default parameter values, pass an empty Hash as a request object (see above).
4371
+ #
4372
+ # @param parent [::String]
4373
+ # Required. The resource name of the entitlement for which to list
4374
+ # entitlement changes. The `-` wildcard may be used to match entitlements
4375
+ # across a customer. Formats:
4376
+ #
4377
+ # * accounts/\\{account_id}/customers/\\{customer_id}/entitlements/\\{entitlement_id}
4378
+ # * accounts/\\{account_id}/customers/\\{customer_id}/entitlements/-
4379
+ # @param page_size [::Integer]
4380
+ # Optional. The maximum number of entitlement changes to return. The service
4381
+ # may return fewer than this value. If unspecified, returns at most 10
4382
+ # entitlement changes. The maximum value is 50; the server will coerce values
4383
+ # above 50.
4384
+ # @param page_token [::String]
4385
+ # Optional. A page token, received from a previous
4386
+ # {::Google::Cloud::Channel::V1::CloudChannelService::Rest::Client#list_entitlement_changes CloudChannelService.ListEntitlementChanges}
4387
+ # call. Provide this to retrieve the subsequent page.
4388
+ #
4389
+ # When paginating, all other parameters provided to
4390
+ # {::Google::Cloud::Channel::V1::CloudChannelService::Rest::Client#list_entitlement_changes CloudChannelService.ListEntitlementChanges}
4391
+ # must match the call that provided the page token.
4392
+ # @param filter [::String]
4393
+ # Optional. Filters applied to the list results.
4394
+ # @yield [result, operation] Access the result along with the TransportOperation object
4395
+ # @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Channel::V1::EntitlementChange>]
4396
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
4397
+ #
4398
+ # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Channel::V1::EntitlementChange>]
4399
+ #
4400
+ # @raise [::Google::Cloud::Error] if the REST call is aborted.
4401
+ def list_entitlement_changes request, options = nil
4402
+ raise ::ArgumentError, "request must be provided" if request.nil?
4403
+
4404
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Channel::V1::ListEntitlementChangesRequest
4405
+
4406
+ # Converts hash and nil to an options object
4407
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
4408
+
4409
+ # Customize the options with defaults
4410
+ call_metadata = @config.rpcs.list_entitlement_changes.metadata.to_h
4411
+
4412
+ # Set x-goog-api-client and x-goog-user-project headers
4413
+ call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
4414
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
4415
+ gapic_version: ::Google::Cloud::Channel::V1::VERSION,
4416
+ transports_version_send: [:rest]
4417
+
4418
+ call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
4419
+
4420
+ options.apply_defaults timeout: @config.rpcs.list_entitlement_changes.timeout,
4421
+ metadata: call_metadata,
4422
+ retry_policy: @config.rpcs.list_entitlement_changes.retry_policy
4423
+
4424
+ options.apply_defaults timeout: @config.timeout,
4425
+ metadata: @config.metadata,
4426
+ retry_policy: @config.retry_policy
4427
+
4428
+ @cloud_channel_service_stub.list_entitlement_changes request, options do |result, operation|
4429
+ result = ::Gapic::Rest::PagedEnumerable.new @cloud_channel_service_stub, :list_entitlement_changes, "entitlement_changes", request, result, options
4430
+ yield result, operation if block_given?
4431
+ return result
4432
+ end
4433
+ rescue ::Gapic::Rest::Error => e
4434
+ raise ::Google::Cloud::Error.from_error(e)
4435
+ end
4436
+
4332
4437
  ##
4333
4438
  # Configuration class for the CloudChannelService REST API.
4334
4439
  #
@@ -4367,9 +4472,9 @@ module Google
4367
4472
  # * (`String`) The path to a service account key file in JSON format
4368
4473
  # * (`Hash`) A service account key as a Hash
4369
4474
  # * (`Google::Auth::Credentials`) A googleauth credentials object
4370
- # (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
4475
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
4371
4476
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
4372
- # (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
4477
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
4373
4478
  # * (`nil`) indicating no credentials
4374
4479
  # @return [::Object]
4375
4480
  # @!attribute [rw] scope
@@ -4677,6 +4782,11 @@ module Google
4677
4782
  # @return [::Gapic::Config::Method]
4678
4783
  #
4679
4784
  attr_reader :list_subscribers
4785
+ ##
4786
+ # RPC-specific configuration for `list_entitlement_changes`
4787
+ # @return [::Gapic::Config::Method]
4788
+ #
4789
+ attr_reader :list_entitlement_changes
4680
4790
 
4681
4791
  # @private
4682
4792
  def initialize parent_rpcs = nil
@@ -4770,6 +4880,8 @@ module Google
4770
4880
  @unregister_subscriber = ::Gapic::Config::Method.new unregister_subscriber_config
4771
4881
  list_subscribers_config = parent_rpcs.list_subscribers if parent_rpcs.respond_to? :list_subscribers
4772
4882
  @list_subscribers = ::Gapic::Config::Method.new list_subscribers_config
4883
+ list_entitlement_changes_config = parent_rpcs.list_entitlement_changes if parent_rpcs.respond_to? :list_entitlement_changes
4884
+ @list_entitlement_changes = ::Gapic::Config::Method.new list_entitlement_changes_config
4773
4885
 
4774
4886
  yield self if block_given?
4775
4887
  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
@@ -25,6 +25,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
25
25
  optional :trial_settings, :message, 21, "google.cloud.channel.v1.TrialSettings"
26
26
  optional :association_info, :message, 23, "google.cloud.channel.v1.AssociationInfo"
27
27
  repeated :parameters, :message, 26, "google.cloud.channel.v1.Parameter"
28
+ optional :billing_account, :string, 28
28
29
  end
29
30
  add_enum "google.cloud.channel.v1.Entitlement.ProvisioningState" do
30
31
  value :PROVISIONING_STATE_UNSPECIFIED, 0
@@ -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
@@ -623,7 +623,8 @@ module Google
623
623
  # [CustomerRepricingConfig][google.cloud.channel.v1.CustomerRepricingConfig]
624
624
  # resources. The data for each resource is displayed in the ascending order
625
625
  # of:
626
- # * customer ID
626
+ #
627
+ # * Customer ID
627
628
  # * [RepricingConfig.EntitlementGranularity.entitlement][google.cloud.channel.v1.RepricingConfig.EntitlementGranularity.entitlement]
628
629
  # * [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]
629
630
  # * [CustomerRepricingConfig.update_time][google.cloud.channel.v1.CustomerRepricingConfig.update_time]
@@ -760,7 +761,8 @@ module Google
760
761
  # [ChannelPartnerRepricingConfig][google.cloud.channel.v1.ChannelPartnerRepricingConfig]
761
762
  # resources. The data for each resource is displayed in the ascending order
762
763
  # of:
763
- # * channel partner ID
764
+ #
765
+ # * Channel Partner ID
764
766
  # * [RepricingConfig.effective_invoice_month][google.cloud.channel.v1.RepricingConfig.effective_invoice_month]
765
767
  # * [ChannelPartnerRepricingConfig.update_time][google.cloud.channel.v1.ChannelPartnerRepricingConfig.update_time]
766
768
  #
@@ -967,6 +969,23 @@ module Google
967
969
  # Return value:
968
970
  # A list of service email addresses.
969
971
  rpc :ListSubscribers, ::Google::Cloud::Channel::V1::ListSubscribersRequest, ::Google::Cloud::Channel::V1::ListSubscribersResponse
972
+ # List entitlement history.
973
+ #
974
+ # Possible error codes:
975
+ #
976
+ # * PERMISSION_DENIED: The reseller account making the request and the
977
+ # provided reseller account are different.
978
+ # * INVALID_ARGUMENT: Missing or invalid required fields in the request.
979
+ # * NOT_FOUND: The parent resource doesn't exist. Usually the result of an
980
+ # invalid name parameter.
981
+ # * INTERNAL: Any non-user error related to a technical issue in the backend.
982
+ # In this case, contact CloudChannel support.
983
+ # * UNKNOWN: Any non-user error related to a technical issue in the backend.
984
+ # In this case, contact Cloud Channel support.
985
+ #
986
+ # Return value:
987
+ # List of [EntitlementChange][google.cloud.channel.v1.EntitlementChange]s.
988
+ rpc :ListEntitlementChanges, ::Google::Cloud::Channel::V1::ListEntitlementChangesRequest, ::Google::Cloud::Channel::V1::ListEntitlementChangesResponse
970
989
  end
971
990
 
972
991
  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.18.0"
25
25
  end
26
26
  end
27
27
  end
@@ -35,7 +35,9 @@ module Google
35
35
  # Details about how and where to publish client libraries.
36
36
  # @!attribute [rw] version
37
37
  # @return [::String]
38
- # Version of the API to apply these settings to.
38
+ # Version of the API to apply these settings to. This is the full protobuf
39
+ # package for the API, ending in the version element.
40
+ # Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
39
41
  # @!attribute [rw] launch_stage
40
42
  # @return [::Google::Api::LaunchStage]
41
43
  # Launch stage of this version of the API.
@@ -81,7 +83,7 @@ module Google
81
83
  # long-running operation pattern.
82
84
  # @!attribute [rw] new_issue_uri
83
85
  # @return [::String]
84
- # Link to a place that API users can report issues. Example:
86
+ # Link to a *public* URI where users can report issues. Example:
85
87
  # https://issuetracker.google.com/issues/new?component=190865&template=1161103
86
88
  # @!attribute [rw] documentation_uri
87
89
  # @return [::String]
@@ -111,6 +113,10 @@ module Google
111
113
  # Client library settings. If the same version string appears multiple
112
114
  # times in this list, then the last one wins. Settings from earlier
113
115
  # settings with the same version string are discarded.
116
+ # @!attribute [rw] proto_reference_documentation_uri
117
+ # @return [::String]
118
+ # Optional link to proto reference documentation. Example:
119
+ # https://cloud.google.com/pubsub/lite/docs/reference/rpc
114
120
  class Publishing
115
121
  include ::Google::Protobuf::MessageExts
116
122
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -203,9 +209,57 @@ module Google
203
209
  # @!attribute [rw] common
204
210
  # @return [::Google::Api::CommonLanguageSettings]
205
211
  # Some settings.
212
+ # @!attribute [rw] renamed_services
213
+ # @return [::Google::Protobuf::Map{::String => ::String}]
214
+ # Map from original service names to renamed versions.
215
+ # This is used when the default generated types
216
+ # would cause a naming conflict. (Neither name is
217
+ # fully-qualified.)
218
+ # Example: Subscriber to SubscriberServiceApi.
219
+ # @!attribute [rw] renamed_resources
220
+ # @return [::Google::Protobuf::Map{::String => ::String}]
221
+ # Map from full resource types to the effective short name
222
+ # for the resource. This is used when otherwise resource
223
+ # named from different services would cause naming collisions.
224
+ # Example entry:
225
+ # "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
226
+ # @!attribute [rw] ignored_resources
227
+ # @return [::Array<::String>]
228
+ # List of full resource types to ignore during generation.
229
+ # This is typically used for API-specific Location resources,
230
+ # which should be handled by the generator as if they were actually
231
+ # the common Location resources.
232
+ # Example entry: "documentai.googleapis.com/Location"
233
+ # @!attribute [rw] forced_namespace_aliases
234
+ # @return [::Array<::String>]
235
+ # Namespaces which must be aliased in snippets due to
236
+ # a known (but non-generator-predictable) naming collision
237
+ # @!attribute [rw] handwritten_signatures
238
+ # @return [::Array<::String>]
239
+ # Method signatures (in the form "service.method(signature)")
240
+ # which are provided separately, so shouldn't be generated.
241
+ # Snippets *calling* these methods are still generated, however.
206
242
  class DotnetSettings
207
243
  include ::Google::Protobuf::MessageExts
208
244
  extend ::Google::Protobuf::MessageExts::ClassMethods
245
+
246
+ # @!attribute [rw] key
247
+ # @return [::String]
248
+ # @!attribute [rw] value
249
+ # @return [::String]
250
+ class RenamedServicesEntry
251
+ include ::Google::Protobuf::MessageExts
252
+ extend ::Google::Protobuf::MessageExts::ClassMethods
253
+ end
254
+
255
+ # @!attribute [rw] key
256
+ # @return [::String]
257
+ # @!attribute [rw] value
258
+ # @return [::String]
259
+ class RenamedResourcesEntry
260
+ include ::Google::Protobuf::MessageExts
261
+ extend ::Google::Protobuf::MessageExts::ClassMethods
262
+ end
209
263
  end
210
264
 
211
265
  # Settings for Ruby client libraries.
@@ -240,8 +294,8 @@ module Google
240
294
  # Example of a YAML configuration::
241
295
  #
242
296
  # publishing:
243
- # method_behavior:
244
- # - selector: CreateAdDomain
297
+ # method_settings:
298
+ # - selector: google.cloud.speech.v2.Speech.BatchRecognize
245
299
  # long_running:
246
300
  # initial_poll_delay:
247
301
  # seconds: 60 # 1 minute
@@ -299,6 +353,15 @@ module Google
299
353
 
300
354
  # Street View Org.
301
355
  STREET_VIEW = 4
356
+
357
+ # Shopping Org.
358
+ SHOPPING = 5
359
+
360
+ # Geo Org.
361
+ GEO = 6
362
+
363
+ # Generative AI - https://developers.generativeai.google
364
+ GENERATIVE_AI = 7
302
365
  end
303
366
 
304
367
  # To where should client libraries be published?
@@ -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,26 @@ 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.
88
+ # @!attribute [rw] billing_account
89
+ # @return [::String]
90
+ # Optional. The billing account resource name that is used to pay for this
91
+ # entitlement.
79
92
  class Entitlement
80
93
  include ::Google::Protobuf::MessageExts
81
94
  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.18.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-05-08 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