google-shopping-merchant-accounts-v1beta 0.a → 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (175) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +144 -8
  5. data/lib/google/shopping/merchant/accounts/v1beta/accessright_pb.rb +44 -0
  6. data/lib/google/shopping/merchant/accounts/v1beta/account_issue_service/client.rb +452 -0
  7. data/lib/google/shopping/merchant/accounts/v1beta/account_issue_service/credentials.rb +49 -0
  8. data/lib/google/shopping/merchant/accounts/v1beta/account_issue_service/paths.rb +49 -0
  9. data/lib/google/shopping/merchant/accounts/v1beta/account_issue_service/rest/client.rb +419 -0
  10. data/lib/google/shopping/merchant/accounts/v1beta/account_issue_service/rest/service_stub.rb +130 -0
  11. data/lib/google/shopping/merchant/accounts/v1beta/account_issue_service/rest.rb +54 -0
  12. data/lib/google/shopping/merchant/accounts/v1beta/account_issue_service.rb +57 -0
  13. data/lib/google/shopping/merchant/accounts/v1beta/account_tax_pb.rb +57 -0
  14. data/lib/google/shopping/merchant/accounts/v1beta/account_tax_service/client.rb +633 -0
  15. data/lib/google/shopping/merchant/accounts/v1beta/account_tax_service/credentials.rb +49 -0
  16. data/lib/google/shopping/merchant/accounts/v1beta/account_tax_service/paths.rb +66 -0
  17. data/lib/google/shopping/merchant/accounts/v1beta/account_tax_service/rest/client.rb +586 -0
  18. data/lib/google/shopping/merchant/accounts/v1beta/account_tax_service/rest/service_stub.rb +249 -0
  19. data/lib/google/shopping/merchant/accounts/v1beta/account_tax_service/rest.rb +58 -0
  20. data/lib/google/shopping/merchant/accounts/v1beta/account_tax_service.rb +61 -0
  21. data/lib/google/shopping/merchant/accounts/v1beta/account_tax_services_pb.rb +58 -0
  22. data/lib/google/shopping/merchant/accounts/v1beta/accountissue_pb.rb +57 -0
  23. data/lib/google/shopping/merchant/accounts/v1beta/accountissue_services_pb.rb +47 -0
  24. data/lib/google/shopping/merchant/accounts/v1beta/accounts_pb.rb +67 -0
  25. data/lib/google/shopping/merchant/accounts/v1beta/accounts_service/client.rb +942 -0
  26. data/lib/google/shopping/merchant/accounts/v1beta/accounts_service/credentials.rb +49 -0
  27. data/lib/google/shopping/merchant/accounts/v1beta/accounts_service/paths.rb +80 -0
  28. data/lib/google/shopping/merchant/accounts/v1beta/accounts_service/rest/client.rb +890 -0
  29. data/lib/google/shopping/merchant/accounts/v1beta/accounts_service/rest/service_stub.rb +423 -0
  30. data/lib/google/shopping/merchant/accounts/v1beta/accounts_service/rest.rb +54 -0
  31. data/lib/google/shopping/merchant/accounts/v1beta/accounts_service.rb +57 -0
  32. data/lib/google/shopping/merchant/accounts/v1beta/accounts_services_pb.rb +71 -0
  33. data/lib/google/shopping/merchant/accounts/v1beta/business_identity_service/client.rb +525 -0
  34. data/lib/google/shopping/merchant/accounts/v1beta/business_identity_service/credentials.rb +49 -0
  35. data/lib/google/shopping/merchant/accounts/v1beta/business_identity_service/paths.rb +49 -0
  36. data/lib/google/shopping/merchant/accounts/v1beta/business_identity_service/rest/client.rb +485 -0
  37. data/lib/google/shopping/merchant/accounts/v1beta/business_identity_service/rest/service_stub.rb +190 -0
  38. data/lib/google/shopping/merchant/accounts/v1beta/business_identity_service/rest.rb +55 -0
  39. data/lib/google/shopping/merchant/accounts/v1beta/business_identity_service.rb +58 -0
  40. data/lib/google/shopping/merchant/accounts/v1beta/business_info_service/client.rb +524 -0
  41. data/lib/google/shopping/merchant/accounts/v1beta/business_info_service/credentials.rb +49 -0
  42. data/lib/google/shopping/merchant/accounts/v1beta/business_info_service/paths.rb +49 -0
  43. data/lib/google/shopping/merchant/accounts/v1beta/business_info_service/rest/client.rb +484 -0
  44. data/lib/google/shopping/merchant/accounts/v1beta/business_info_service/rest/service_stub.rb +190 -0
  45. data/lib/google/shopping/merchant/accounts/v1beta/business_info_service/rest.rb +54 -0
  46. data/lib/google/shopping/merchant/accounts/v1beta/business_info_service.rb +57 -0
  47. data/lib/google/shopping/merchant/accounts/v1beta/businessidentity_pb.rb +56 -0
  48. data/lib/google/shopping/merchant/accounts/v1beta/businessidentity_services_pb.rb +51 -0
  49. data/lib/google/shopping/merchant/accounts/v1beta/businessinfo_pb.rb +60 -0
  50. data/lib/google/shopping/merchant/accounts/v1beta/businessinfo_services_pb.rb +50 -0
  51. data/lib/google/shopping/merchant/accounts/v1beta/customerservice_pb.rb +48 -0
  52. data/lib/google/shopping/merchant/accounts/v1beta/email_preferences_service/client.rb +539 -0
  53. data/lib/google/shopping/merchant/accounts/v1beta/email_preferences_service/credentials.rb +49 -0
  54. data/lib/google/shopping/merchant/accounts/v1beta/email_preferences_service/paths.rb +52 -0
  55. data/lib/google/shopping/merchant/accounts/v1beta/email_preferences_service/rest/client.rb +499 -0
  56. data/lib/google/shopping/merchant/accounts/v1beta/email_preferences_service/rest/service_stub.rb +190 -0
  57. data/lib/google/shopping/merchant/accounts/v1beta/email_preferences_service/rest.rb +57 -0
  58. data/lib/google/shopping/merchant/accounts/v1beta/email_preferences_service.rb +60 -0
  59. data/lib/google/shopping/merchant/accounts/v1beta/emailpreferences_pb.rb +54 -0
  60. data/lib/google/shopping/merchant/accounts/v1beta/emailpreferences_services_pb.rb +65 -0
  61. data/lib/google/shopping/merchant/accounts/v1beta/homepage_pb.rb +55 -0
  62. data/lib/google/shopping/merchant/accounts/v1beta/homepage_service/client.rb +724 -0
  63. data/lib/google/shopping/merchant/accounts/v1beta/homepage_service/credentials.rb +49 -0
  64. data/lib/google/shopping/merchant/accounts/v1beta/homepage_service/paths.rb +49 -0
  65. data/lib/google/shopping/merchant/accounts/v1beta/homepage_service/rest/client.rb +670 -0
  66. data/lib/google/shopping/merchant/accounts/v1beta/homepage_service/rest/service_stub.rb +310 -0
  67. data/lib/google/shopping/merchant/accounts/v1beta/homepage_service/rest.rb +54 -0
  68. data/lib/google/shopping/merchant/accounts/v1beta/homepage_service.rb +57 -0
  69. data/lib/google/shopping/merchant/accounts/v1beta/homepage_services_pb.rb +66 -0
  70. data/lib/google/shopping/merchant/accounts/v1beta/online_return_policy_pb.rb +61 -0
  71. data/lib/google/shopping/merchant/accounts/v1beta/online_return_policy_service/client.rb +551 -0
  72. data/lib/google/shopping/merchant/accounts/v1beta/online_return_policy_service/credentials.rb +49 -0
  73. data/lib/google/shopping/merchant/accounts/v1beta/online_return_policy_service/paths.rb +66 -0
  74. data/lib/google/shopping/merchant/accounts/v1beta/online_return_policy_service/rest/client.rb +511 -0
  75. data/lib/google/shopping/merchant/accounts/v1beta/online_return_policy_service/rest/service_stub.rb +189 -0
  76. data/lib/google/shopping/merchant/accounts/v1beta/online_return_policy_service/rest.rb +58 -0
  77. data/lib/google/shopping/merchant/accounts/v1beta/online_return_policy_service.rb +61 -0
  78. data/lib/google/shopping/merchant/accounts/v1beta/online_return_policy_services_pb.rb +53 -0
  79. data/lib/google/shopping/merchant/accounts/v1beta/phoneverificationstate_pb.rb +44 -0
  80. data/lib/google/shopping/merchant/accounts/v1beta/programs_pb.rb +56 -0
  81. data/lib/google/shopping/merchant/accounts/v1beta/programs_service/client.rb +734 -0
  82. data/lib/google/shopping/merchant/accounts/v1beta/programs_service/credentials.rb +49 -0
  83. data/lib/google/shopping/merchant/accounts/v1beta/programs_service/paths.rb +66 -0
  84. data/lib/google/shopping/merchant/accounts/v1beta/programs_service/rest/client.rb +680 -0
  85. data/lib/google/shopping/merchant/accounts/v1beta/programs_service/rest/service_stub.rb +309 -0
  86. data/lib/google/shopping/merchant/accounts/v1beta/programs_service/rest.rb +64 -0
  87. data/lib/google/shopping/merchant/accounts/v1beta/programs_service.rb +67 -0
  88. data/lib/google/shopping/merchant/accounts/v1beta/programs_services_pb.rb +65 -0
  89. data/lib/google/shopping/merchant/accounts/v1beta/regions_pb.rb +63 -0
  90. data/lib/google/shopping/merchant/accounts/v1beta/regions_service/client.rb +835 -0
  91. data/lib/google/shopping/merchant/accounts/v1beta/regions_service/credentials.rb +49 -0
  92. data/lib/google/shopping/merchant/accounts/v1beta/regions_service/paths.rb +66 -0
  93. data/lib/google/shopping/merchant/accounts/v1beta/regions_service/rest/client.rb +774 -0
  94. data/lib/google/shopping/merchant/accounts/v1beta/regions_service/rest/service_stub.rb +368 -0
  95. data/lib/google/shopping/merchant/accounts/v1beta/regions_service/rest.rb +58 -0
  96. data/lib/google/shopping/merchant/accounts/v1beta/regions_service.rb +61 -0
  97. data/lib/google/shopping/merchant/accounts/v1beta/regions_services_pb.rb +62 -0
  98. data/lib/google/shopping/merchant/accounts/v1beta/rest.rb +52 -0
  99. data/lib/google/shopping/merchant/accounts/v1beta/shipping_settings_service/client.rb +526 -0
  100. data/lib/google/shopping/merchant/accounts/v1beta/shipping_settings_service/credentials.rb +49 -0
  101. data/lib/google/shopping/merchant/accounts/v1beta/shipping_settings_service/paths.rb +49 -0
  102. data/lib/google/shopping/merchant/accounts/v1beta/shipping_settings_service/rest/client.rb +486 -0
  103. data/lib/google/shopping/merchant/accounts/v1beta/shipping_settings_service/rest/service_stub.rb +190 -0
  104. data/lib/google/shopping/merchant/accounts/v1beta/shipping_settings_service/rest.rb +55 -0
  105. data/lib/google/shopping/merchant/accounts/v1beta/shipping_settings_service.rb +58 -0
  106. data/lib/google/shopping/merchant/accounts/v1beta/shippingsettings_pb.rb +83 -0
  107. data/lib/google/shopping/merchant/accounts/v1beta/shippingsettings_services_pb.rb +51 -0
  108. data/lib/google/shopping/merchant/accounts/v1beta/tax_rule_pb.rb +49 -0
  109. data/lib/google/shopping/merchant/accounts/v1beta/terms_of_service_agreement_state_service/client.rb +522 -0
  110. data/lib/google/shopping/merchant/accounts/v1beta/terms_of_service_agreement_state_service/credentials.rb +49 -0
  111. data/lib/google/shopping/merchant/accounts/v1beta/terms_of_service_agreement_state_service/paths.rb +66 -0
  112. data/lib/google/shopping/merchant/accounts/v1beta/terms_of_service_agreement_state_service/rest/client.rb +482 -0
  113. data/lib/google/shopping/merchant/accounts/v1beta/terms_of_service_agreement_state_service/rest/service_stub.rb +189 -0
  114. data/lib/google/shopping/merchant/accounts/v1beta/terms_of_service_agreement_state_service/rest.rb +54 -0
  115. data/lib/google/shopping/merchant/accounts/v1beta/terms_of_service_agreement_state_service.rb +57 -0
  116. data/lib/google/shopping/merchant/accounts/v1beta/terms_of_service_service/client.rb +623 -0
  117. data/lib/google/shopping/merchant/accounts/v1beta/terms_of_service_service/credentials.rb +49 -0
  118. data/lib/google/shopping/merchant/accounts/v1beta/terms_of_service_service/paths.rb +63 -0
  119. data/lib/google/shopping/merchant/accounts/v1beta/terms_of_service_service/rest/client.rb +584 -0
  120. data/lib/google/shopping/merchant/accounts/v1beta/terms_of_service_service/rest/service_stub.rb +246 -0
  121. data/lib/google/shopping/merchant/accounts/v1beta/terms_of_service_service/rest.rb +54 -0
  122. data/lib/google/shopping/merchant/accounts/v1beta/terms_of_service_service.rb +57 -0
  123. data/lib/google/shopping/merchant/accounts/v1beta/termsofservice_pb.rb +54 -0
  124. data/lib/google/shopping/merchant/accounts/v1beta/termsofservice_services_pb.rb +52 -0
  125. data/lib/google/shopping/merchant/accounts/v1beta/termsofserviceagreementstate_pb.rb +56 -0
  126. data/lib/google/shopping/merchant/accounts/v1beta/termsofserviceagreementstate_services_pb.rb +49 -0
  127. data/lib/google/shopping/merchant/accounts/v1beta/termsofservicekind_pb.rb +44 -0
  128. data/lib/google/shopping/merchant/accounts/v1beta/user_pb.rb +60 -0
  129. data/lib/google/shopping/merchant/accounts/v1beta/user_service/client.rb +838 -0
  130. data/lib/google/shopping/merchant/accounts/v1beta/user_service/credentials.rb +49 -0
  131. data/lib/google/shopping/merchant/accounts/v1beta/user_service/paths.rb +66 -0
  132. data/lib/google/shopping/merchant/accounts/v1beta/user_service/rest/client.rb +777 -0
  133. data/lib/google/shopping/merchant/accounts/v1beta/user_service/rest/service_stub.rb +368 -0
  134. data/lib/google/shopping/merchant/accounts/v1beta/user_service/rest.rb +54 -0
  135. data/lib/google/shopping/merchant/accounts/v1beta/user_service.rb +57 -0
  136. data/lib/google/shopping/merchant/accounts/v1beta/user_services_pb.rb +58 -0
  137. data/lib/google/shopping/merchant/accounts/v1beta/version.rb +7 -2
  138. data/lib/google/shopping/merchant/accounts/v1beta.rb +60 -0
  139. data/lib/google-shopping-merchant-accounts-v1beta.rb +21 -0
  140. data/proto_docs/README.md +4 -0
  141. data/proto_docs/google/api/client.rb +399 -0
  142. data/proto_docs/google/api/field_behavior.rb +85 -0
  143. data/proto_docs/google/api/launch_stage.rb +71 -0
  144. data/proto_docs/google/api/resource.rb +222 -0
  145. data/proto_docs/google/protobuf/duration.rb +98 -0
  146. data/proto_docs/google/protobuf/empty.rb +34 -0
  147. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  148. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  149. data/proto_docs/google/protobuf/wrappers.rb +121 -0
  150. data/proto_docs/google/shopping/merchant/accounts/v1beta/accessright.rb +43 -0
  151. data/proto_docs/google/shopping/merchant/accounts/v1beta/account_tax.rb +101 -0
  152. data/proto_docs/google/shopping/merchant/accounts/v1beta/accountissue.rb +142 -0
  153. data/proto_docs/google/shopping/merchant/accounts/v1beta/accounts.rb +219 -0
  154. data/proto_docs/google/shopping/merchant/accounts/v1beta/businessidentity.rb +129 -0
  155. data/proto_docs/google/shopping/merchant/accounts/v1beta/businessinfo.rb +72 -0
  156. data/proto_docs/google/shopping/merchant/accounts/v1beta/customerservice.rb +43 -0
  157. data/proto_docs/google/shopping/merchant/accounts/v1beta/emailpreferences.rb +82 -0
  158. data/proto_docs/google/shopping/merchant/accounts/v1beta/homepage.rb +87 -0
  159. data/proto_docs/google/shopping/merchant/accounts/v1beta/online_return_policy.rb +238 -0
  160. data/proto_docs/google/shopping/merchant/accounts/v1beta/phoneverificationstate.rb +40 -0
  161. data/proto_docs/google/shopping/merchant/accounts/v1beta/programs.rb +160 -0
  162. data/proto_docs/google/shopping/merchant/accounts/v1beta/regions.rb +195 -0
  163. data/proto_docs/google/shopping/merchant/accounts/v1beta/shippingsettings.rb +743 -0
  164. data/proto_docs/google/shopping/merchant/accounts/v1beta/tax_rule.rb +88 -0
  165. data/proto_docs/google/shopping/merchant/accounts/v1beta/termsofservice.rb +99 -0
  166. data/proto_docs/google/shopping/merchant/accounts/v1beta/termsofserviceagreementstate.rb +132 -0
  167. data/proto_docs/google/shopping/merchant/accounts/v1beta/termsofservicekind.rb +37 -0
  168. data/proto_docs/google/shopping/merchant/accounts/v1beta/user.rb +156 -0
  169. data/proto_docs/google/shopping/type/types.rb +210 -0
  170. data/proto_docs/google/type/date.rb +53 -0
  171. data/proto_docs/google/type/datetime.rb +99 -0
  172. data/proto_docs/google/type/interval.rb +45 -0
  173. data/proto_docs/google/type/phone_number.rb +112 -0
  174. data/proto_docs/google/type/postal_address.rb +135 -0
  175. metadata +234 -10
@@ -0,0 +1,838 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "google/cloud/errors"
20
+ require "google/shopping/merchant/accounts/v1beta/user_pb"
21
+
22
+ module Google
23
+ module Shopping
24
+ module Merchant
25
+ module Accounts
26
+ module V1beta
27
+ module UserService
28
+ ##
29
+ # Client for the UserService service.
30
+ #
31
+ # Service to support user API.
32
+ #
33
+ class Client
34
+ # @private
35
+ API_VERSION = ""
36
+
37
+ # @private
38
+ DEFAULT_ENDPOINT_TEMPLATE = "merchantapi.$UNIVERSE_DOMAIN$"
39
+
40
+ include Paths
41
+
42
+ # @private
43
+ attr_reader :user_service_stub
44
+
45
+ ##
46
+ # Configure the UserService Client class.
47
+ #
48
+ # See {::Google::Shopping::Merchant::Accounts::V1beta::UserService::Client::Configuration}
49
+ # for a description of the configuration fields.
50
+ #
51
+ # @example
52
+ #
53
+ # # Modify the configuration for all UserService clients
54
+ # ::Google::Shopping::Merchant::Accounts::V1beta::UserService::Client.configure do |config|
55
+ # config.timeout = 10.0
56
+ # end
57
+ #
58
+ # @yield [config] Configure the Client client.
59
+ # @yieldparam config [Client::Configuration]
60
+ #
61
+ # @return [Client::Configuration]
62
+ #
63
+ def self.configure
64
+ @configure ||= begin
65
+ namespace = ["Google", "Shopping", "Merchant", "Accounts", "V1beta"]
66
+ parent_config = while namespace.any?
67
+ parent_name = namespace.join "::"
68
+ parent_const = const_get parent_name
69
+ break parent_const.configure if parent_const.respond_to? :configure
70
+ namespace.pop
71
+ end
72
+ default_config = Client::Configuration.new parent_config
73
+
74
+ default_config
75
+ end
76
+ yield @configure if block_given?
77
+ @configure
78
+ end
79
+
80
+ ##
81
+ # Configure the UserService Client instance.
82
+ #
83
+ # The configuration is set to the derived mode, meaning that values can be changed,
84
+ # but structural changes (adding new fields, etc.) are not allowed. Structural changes
85
+ # should be made on {Client.configure}.
86
+ #
87
+ # See {::Google::Shopping::Merchant::Accounts::V1beta::UserService::Client::Configuration}
88
+ # for a description of the configuration fields.
89
+ #
90
+ # @yield [config] Configure the Client client.
91
+ # @yieldparam config [Client::Configuration]
92
+ #
93
+ # @return [Client::Configuration]
94
+ #
95
+ def configure
96
+ yield @config if block_given?
97
+ @config
98
+ end
99
+
100
+ ##
101
+ # The effective universe domain
102
+ #
103
+ # @return [String]
104
+ #
105
+ def universe_domain
106
+ @user_service_stub.universe_domain
107
+ end
108
+
109
+ ##
110
+ # Create a new UserService client object.
111
+ #
112
+ # @example
113
+ #
114
+ # # Create a client using the default configuration
115
+ # client = ::Google::Shopping::Merchant::Accounts::V1beta::UserService::Client.new
116
+ #
117
+ # # Create a client using a custom configuration
118
+ # client = ::Google::Shopping::Merchant::Accounts::V1beta::UserService::Client.new do |config|
119
+ # config.timeout = 10.0
120
+ # end
121
+ #
122
+ # @yield [config] Configure the UserService client.
123
+ # @yieldparam config [Client::Configuration]
124
+ #
125
+ def initialize
126
+ # These require statements are intentionally placed here to initialize
127
+ # the gRPC module only when it's required.
128
+ # See https://github.com/googleapis/toolkit/issues/446
129
+ require "gapic/grpc"
130
+ require "google/shopping/merchant/accounts/v1beta/user_services_pb"
131
+
132
+ # Create the configuration object
133
+ @config = Configuration.new Client.configure
134
+
135
+ # Yield the configuration if needed
136
+ yield @config if block_given?
137
+
138
+ # Create credentials
139
+ credentials = @config.credentials
140
+ # Use self-signed JWT if the endpoint is unchanged from default,
141
+ # but only if the default endpoint does not have a region prefix.
142
+ enable_self_signed_jwt = @config.endpoint.nil? ||
143
+ (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
144
+ !@config.endpoint.split(".").first.include?("-"))
145
+ credentials ||= Credentials.default scope: @config.scope,
146
+ enable_self_signed_jwt: enable_self_signed_jwt
147
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
148
+ credentials = Credentials.new credentials, scope: @config.scope
149
+ end
150
+ @quota_project_id = @config.quota_project
151
+ @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
152
+
153
+ @user_service_stub = ::Gapic::ServiceStub.new(
154
+ ::Google::Shopping::Merchant::Accounts::V1beta::UserService::Stub,
155
+ credentials: credentials,
156
+ endpoint: @config.endpoint,
157
+ endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
158
+ universe_domain: @config.universe_domain,
159
+ channel_args: @config.channel_args,
160
+ interceptors: @config.interceptors,
161
+ channel_pool_config: @config.channel_pool
162
+ )
163
+ end
164
+
165
+ # Service calls
166
+
167
+ ##
168
+ # Retrieves a Merchant Center account user.
169
+ #
170
+ # @overload get_user(request, options = nil)
171
+ # Pass arguments to `get_user` via a request object, either of type
172
+ # {::Google::Shopping::Merchant::Accounts::V1beta::GetUserRequest} or an equivalent Hash.
173
+ #
174
+ # @param request [::Google::Shopping::Merchant::Accounts::V1beta::GetUserRequest, ::Hash]
175
+ # A request object representing the call parameters. Required. To specify no
176
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
177
+ # @param options [::Gapic::CallOptions, ::Hash]
178
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
179
+ #
180
+ # @overload get_user(name: nil)
181
+ # Pass arguments to `get_user` via keyword arguments. Note that at
182
+ # least one keyword argument is required. To specify no parameters, or to keep all
183
+ # the default parameter values, pass an empty Hash as a request object (see above).
184
+ #
185
+ # @param name [::String]
186
+ # Required. The name of the user to retrieve.
187
+ # Format: `accounts/{account}/users/{email}`
188
+ #
189
+ # It is also possible to retrieve the user corresponding to the caller by
190
+ # using `me` rather than an email address as in
191
+ # `accounts/{account}/users/me`.
192
+ #
193
+ # @yield [response, operation] Access the result along with the RPC operation
194
+ # @yieldparam response [::Google::Shopping::Merchant::Accounts::V1beta::User]
195
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
196
+ #
197
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::User]
198
+ #
199
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
200
+ #
201
+ # @example Basic example
202
+ # require "google/shopping/merchant/accounts/v1beta"
203
+ #
204
+ # # Create a client object. The client can be reused for multiple calls.
205
+ # client = Google::Shopping::Merchant::Accounts::V1beta::UserService::Client.new
206
+ #
207
+ # # Create a request. To set request fields, pass in keyword arguments.
208
+ # request = Google::Shopping::Merchant::Accounts::V1beta::GetUserRequest.new
209
+ #
210
+ # # Call the get_user method.
211
+ # result = client.get_user request
212
+ #
213
+ # # The returned object is of type Google::Shopping::Merchant::Accounts::V1beta::User.
214
+ # p result
215
+ #
216
+ def get_user request, options = nil
217
+ raise ::ArgumentError, "request must be provided" if request.nil?
218
+
219
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1beta::GetUserRequest
220
+
221
+ # Converts hash and nil to an options object
222
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
223
+
224
+ # Customize the options with defaults
225
+ metadata = @config.rpcs.get_user.metadata.to_h
226
+
227
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
228
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
229
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
230
+ gapic_version: ::Google::Shopping::Merchant::Accounts::V1beta::VERSION
231
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
232
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
233
+
234
+ header_params = {}
235
+ if request.name
236
+ header_params["name"] = request.name
237
+ end
238
+
239
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
240
+ metadata[:"x-goog-request-params"] ||= request_params_header
241
+
242
+ options.apply_defaults timeout: @config.rpcs.get_user.timeout,
243
+ metadata: metadata,
244
+ retry_policy: @config.rpcs.get_user.retry_policy
245
+
246
+ options.apply_defaults timeout: @config.timeout,
247
+ metadata: @config.metadata,
248
+ retry_policy: @config.retry_policy
249
+
250
+ @user_service_stub.call_rpc :get_user, request, options: options do |response, operation|
251
+ yield response, operation if block_given?
252
+ return response
253
+ end
254
+ rescue ::GRPC::BadStatus => e
255
+ raise ::Google::Cloud::Error.from_error(e)
256
+ end
257
+
258
+ ##
259
+ # Creates a Merchant Center account user. Executing this method requires
260
+ # admin access.
261
+ #
262
+ # @overload create_user(request, options = nil)
263
+ # Pass arguments to `create_user` via a request object, either of type
264
+ # {::Google::Shopping::Merchant::Accounts::V1beta::CreateUserRequest} or an equivalent Hash.
265
+ #
266
+ # @param request [::Google::Shopping::Merchant::Accounts::V1beta::CreateUserRequest, ::Hash]
267
+ # A request object representing the call parameters. Required. To specify no
268
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
269
+ # @param options [::Gapic::CallOptions, ::Hash]
270
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
271
+ #
272
+ # @overload create_user(parent: nil, user_id: nil, user: nil)
273
+ # Pass arguments to `create_user` via keyword arguments. Note that at
274
+ # least one keyword argument is required. To specify no parameters, or to keep all
275
+ # the default parameter values, pass an empty Hash as a request object (see above).
276
+ #
277
+ # @param parent [::String]
278
+ # Required. The resource name of the account for which a user will be
279
+ # created. Format: `accounts/{account}`
280
+ # @param user_id [::String]
281
+ # Required. The email address of the user (for example,
282
+ # `john.doe@gmail.com`).
283
+ # @param user [::Google::Shopping::Merchant::Accounts::V1beta::User, ::Hash]
284
+ # Required. The user to create.
285
+ #
286
+ # @yield [response, operation] Access the result along with the RPC operation
287
+ # @yieldparam response [::Google::Shopping::Merchant::Accounts::V1beta::User]
288
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
289
+ #
290
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::User]
291
+ #
292
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
293
+ #
294
+ # @example Basic example
295
+ # require "google/shopping/merchant/accounts/v1beta"
296
+ #
297
+ # # Create a client object. The client can be reused for multiple calls.
298
+ # client = Google::Shopping::Merchant::Accounts::V1beta::UserService::Client.new
299
+ #
300
+ # # Create a request. To set request fields, pass in keyword arguments.
301
+ # request = Google::Shopping::Merchant::Accounts::V1beta::CreateUserRequest.new
302
+ #
303
+ # # Call the create_user method.
304
+ # result = client.create_user request
305
+ #
306
+ # # The returned object is of type Google::Shopping::Merchant::Accounts::V1beta::User.
307
+ # p result
308
+ #
309
+ def create_user request, options = nil
310
+ raise ::ArgumentError, "request must be provided" if request.nil?
311
+
312
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1beta::CreateUserRequest
313
+
314
+ # Converts hash and nil to an options object
315
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
316
+
317
+ # Customize the options with defaults
318
+ metadata = @config.rpcs.create_user.metadata.to_h
319
+
320
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
321
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
322
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
323
+ gapic_version: ::Google::Shopping::Merchant::Accounts::V1beta::VERSION
324
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
325
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
326
+
327
+ header_params = {}
328
+ if request.parent
329
+ header_params["parent"] = request.parent
330
+ end
331
+
332
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
333
+ metadata[:"x-goog-request-params"] ||= request_params_header
334
+
335
+ options.apply_defaults timeout: @config.rpcs.create_user.timeout,
336
+ metadata: metadata,
337
+ retry_policy: @config.rpcs.create_user.retry_policy
338
+
339
+ options.apply_defaults timeout: @config.timeout,
340
+ metadata: @config.metadata,
341
+ retry_policy: @config.retry_policy
342
+
343
+ @user_service_stub.call_rpc :create_user, request, options: options do |response, operation|
344
+ yield response, operation if block_given?
345
+ return response
346
+ end
347
+ rescue ::GRPC::BadStatus => e
348
+ raise ::Google::Cloud::Error.from_error(e)
349
+ end
350
+
351
+ ##
352
+ # Deletes a Merchant Center account user. Executing this method requires
353
+ # admin access.
354
+ #
355
+ # @overload delete_user(request, options = nil)
356
+ # Pass arguments to `delete_user` via a request object, either of type
357
+ # {::Google::Shopping::Merchant::Accounts::V1beta::DeleteUserRequest} or an equivalent Hash.
358
+ #
359
+ # @param request [::Google::Shopping::Merchant::Accounts::V1beta::DeleteUserRequest, ::Hash]
360
+ # A request object representing the call parameters. Required. To specify no
361
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
362
+ # @param options [::Gapic::CallOptions, ::Hash]
363
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
364
+ #
365
+ # @overload delete_user(name: nil)
366
+ # Pass arguments to `delete_user` via keyword arguments. Note that at
367
+ # least one keyword argument is required. To specify no parameters, or to keep all
368
+ # the default parameter values, pass an empty Hash as a request object (see above).
369
+ #
370
+ # @param name [::String]
371
+ # Required. The name of the user to delete.
372
+ # Format: `accounts/{account}/users/{email}`
373
+ #
374
+ # It is also possible to delete the user corresponding to the caller by using
375
+ # `me` rather than an email address as in `accounts/{account}/users/me`.
376
+ #
377
+ # @yield [response, operation] Access the result along with the RPC operation
378
+ # @yieldparam response [::Google::Protobuf::Empty]
379
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
380
+ #
381
+ # @return [::Google::Protobuf::Empty]
382
+ #
383
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
384
+ #
385
+ # @example Basic example
386
+ # require "google/shopping/merchant/accounts/v1beta"
387
+ #
388
+ # # Create a client object. The client can be reused for multiple calls.
389
+ # client = Google::Shopping::Merchant::Accounts::V1beta::UserService::Client.new
390
+ #
391
+ # # Create a request. To set request fields, pass in keyword arguments.
392
+ # request = Google::Shopping::Merchant::Accounts::V1beta::DeleteUserRequest.new
393
+ #
394
+ # # Call the delete_user method.
395
+ # result = client.delete_user request
396
+ #
397
+ # # The returned object is of type Google::Protobuf::Empty.
398
+ # p result
399
+ #
400
+ def delete_user request, options = nil
401
+ raise ::ArgumentError, "request must be provided" if request.nil?
402
+
403
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1beta::DeleteUserRequest
404
+
405
+ # Converts hash and nil to an options object
406
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
407
+
408
+ # Customize the options with defaults
409
+ metadata = @config.rpcs.delete_user.metadata.to_h
410
+
411
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
412
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
413
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
414
+ gapic_version: ::Google::Shopping::Merchant::Accounts::V1beta::VERSION
415
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
416
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
417
+
418
+ header_params = {}
419
+ if request.name
420
+ header_params["name"] = request.name
421
+ end
422
+
423
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
424
+ metadata[:"x-goog-request-params"] ||= request_params_header
425
+
426
+ options.apply_defaults timeout: @config.rpcs.delete_user.timeout,
427
+ metadata: metadata,
428
+ retry_policy: @config.rpcs.delete_user.retry_policy
429
+
430
+ options.apply_defaults timeout: @config.timeout,
431
+ metadata: @config.metadata,
432
+ retry_policy: @config.retry_policy
433
+
434
+ @user_service_stub.call_rpc :delete_user, request, options: options do |response, operation|
435
+ yield response, operation if block_given?
436
+ return response
437
+ end
438
+ rescue ::GRPC::BadStatus => e
439
+ raise ::Google::Cloud::Error.from_error(e)
440
+ end
441
+
442
+ ##
443
+ # Updates a Merchant Center account user. Executing this method requires
444
+ # admin access.
445
+ #
446
+ # @overload update_user(request, options = nil)
447
+ # Pass arguments to `update_user` via a request object, either of type
448
+ # {::Google::Shopping::Merchant::Accounts::V1beta::UpdateUserRequest} or an equivalent Hash.
449
+ #
450
+ # @param request [::Google::Shopping::Merchant::Accounts::V1beta::UpdateUserRequest, ::Hash]
451
+ # A request object representing the call parameters. Required. To specify no
452
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
453
+ # @param options [::Gapic::CallOptions, ::Hash]
454
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
455
+ #
456
+ # @overload update_user(user: nil, update_mask: nil)
457
+ # Pass arguments to `update_user` via keyword arguments. Note that at
458
+ # least one keyword argument is required. To specify no parameters, or to keep all
459
+ # the default parameter values, pass an empty Hash as a request object (see above).
460
+ #
461
+ # @param user [::Google::Shopping::Merchant::Accounts::V1beta::User, ::Hash]
462
+ # Required. The new version of the user.
463
+ #
464
+ # Use `me` to refer to your own email address, for example
465
+ # `accounts/{account}/users/me`.
466
+ # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
467
+ # Required. List of fields being updated.
468
+ #
469
+ # @yield [response, operation] Access the result along with the RPC operation
470
+ # @yieldparam response [::Google::Shopping::Merchant::Accounts::V1beta::User]
471
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
472
+ #
473
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::User]
474
+ #
475
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
476
+ #
477
+ # @example Basic example
478
+ # require "google/shopping/merchant/accounts/v1beta"
479
+ #
480
+ # # Create a client object. The client can be reused for multiple calls.
481
+ # client = Google::Shopping::Merchant::Accounts::V1beta::UserService::Client.new
482
+ #
483
+ # # Create a request. To set request fields, pass in keyword arguments.
484
+ # request = Google::Shopping::Merchant::Accounts::V1beta::UpdateUserRequest.new
485
+ #
486
+ # # Call the update_user method.
487
+ # result = client.update_user request
488
+ #
489
+ # # The returned object is of type Google::Shopping::Merchant::Accounts::V1beta::User.
490
+ # p result
491
+ #
492
+ def update_user request, options = nil
493
+ raise ::ArgumentError, "request must be provided" if request.nil?
494
+
495
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1beta::UpdateUserRequest
496
+
497
+ # Converts hash and nil to an options object
498
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
499
+
500
+ # Customize the options with defaults
501
+ metadata = @config.rpcs.update_user.metadata.to_h
502
+
503
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
504
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
505
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
506
+ gapic_version: ::Google::Shopping::Merchant::Accounts::V1beta::VERSION
507
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
508
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
509
+
510
+ header_params = {}
511
+ if request.user&.name
512
+ header_params["user.name"] = request.user.name
513
+ end
514
+
515
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
516
+ metadata[:"x-goog-request-params"] ||= request_params_header
517
+
518
+ options.apply_defaults timeout: @config.rpcs.update_user.timeout,
519
+ metadata: metadata,
520
+ retry_policy: @config.rpcs.update_user.retry_policy
521
+
522
+ options.apply_defaults timeout: @config.timeout,
523
+ metadata: @config.metadata,
524
+ retry_policy: @config.retry_policy
525
+
526
+ @user_service_stub.call_rpc :update_user, request, options: options do |response, operation|
527
+ yield response, operation if block_given?
528
+ return response
529
+ end
530
+ rescue ::GRPC::BadStatus => e
531
+ raise ::Google::Cloud::Error.from_error(e)
532
+ end
533
+
534
+ ##
535
+ # Lists all users of a Merchant Center account.
536
+ #
537
+ # @overload list_users(request, options = nil)
538
+ # Pass arguments to `list_users` via a request object, either of type
539
+ # {::Google::Shopping::Merchant::Accounts::V1beta::ListUsersRequest} or an equivalent Hash.
540
+ #
541
+ # @param request [::Google::Shopping::Merchant::Accounts::V1beta::ListUsersRequest, ::Hash]
542
+ # A request object representing the call parameters. Required. To specify no
543
+ # parameters, or to keep all the default parameter values, pass an empty Hash.
544
+ # @param options [::Gapic::CallOptions, ::Hash]
545
+ # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
546
+ #
547
+ # @overload list_users(parent: nil, page_size: nil, page_token: nil)
548
+ # Pass arguments to `list_users` via keyword arguments. Note that at
549
+ # least one keyword argument is required. To specify no parameters, or to keep all
550
+ # the default parameter values, pass an empty Hash as a request object (see above).
551
+ #
552
+ # @param parent [::String]
553
+ # Required. The parent, which owns this collection of users.
554
+ # Format: `accounts/{account}`
555
+ # @param page_size [::Integer]
556
+ # Optional. The maximum number of users to return. The service may return
557
+ # fewer than this value. If unspecified, at most 50 users will be returned.
558
+ # The maximum value is 100; values above 100 will be coerced to 100
559
+ # @param page_token [::String]
560
+ # Optional. A page token, received from a previous `ListUsers` call.
561
+ # Provide this to retrieve the subsequent page.
562
+ #
563
+ # When paginating, all other parameters provided to `ListUsers` must match
564
+ # the call that provided the page token.
565
+ #
566
+ # @yield [response, operation] Access the result along with the RPC operation
567
+ # @yieldparam response [::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Accounts::V1beta::User>]
568
+ # @yieldparam operation [::GRPC::ActiveCall::Operation]
569
+ #
570
+ # @return [::Gapic::PagedEnumerable<::Google::Shopping::Merchant::Accounts::V1beta::User>]
571
+ #
572
+ # @raise [::Google::Cloud::Error] if the RPC is aborted.
573
+ #
574
+ # @example Basic example
575
+ # require "google/shopping/merchant/accounts/v1beta"
576
+ #
577
+ # # Create a client object. The client can be reused for multiple calls.
578
+ # client = Google::Shopping::Merchant::Accounts::V1beta::UserService::Client.new
579
+ #
580
+ # # Create a request. To set request fields, pass in keyword arguments.
581
+ # request = Google::Shopping::Merchant::Accounts::V1beta::ListUsersRequest.new
582
+ #
583
+ # # Call the list_users method.
584
+ # result = client.list_users request
585
+ #
586
+ # # The returned object is of type Gapic::PagedEnumerable. You can iterate
587
+ # # over elements, and API calls will be issued to fetch pages as needed.
588
+ # result.each do |item|
589
+ # # Each element is of type ::Google::Shopping::Merchant::Accounts::V1beta::User.
590
+ # p item
591
+ # end
592
+ #
593
+ def list_users request, options = nil
594
+ raise ::ArgumentError, "request must be provided" if request.nil?
595
+
596
+ request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Accounts::V1beta::ListUsersRequest
597
+
598
+ # Converts hash and nil to an options object
599
+ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
600
+
601
+ # Customize the options with defaults
602
+ metadata = @config.rpcs.list_users.metadata.to_h
603
+
604
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
605
+ metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
606
+ lib_name: @config.lib_name, lib_version: @config.lib_version,
607
+ gapic_version: ::Google::Shopping::Merchant::Accounts::V1beta::VERSION
608
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
609
+ metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
610
+
611
+ header_params = {}
612
+ if request.parent
613
+ header_params["parent"] = request.parent
614
+ end
615
+
616
+ request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
617
+ metadata[:"x-goog-request-params"] ||= request_params_header
618
+
619
+ options.apply_defaults timeout: @config.rpcs.list_users.timeout,
620
+ metadata: metadata,
621
+ retry_policy: @config.rpcs.list_users.retry_policy
622
+
623
+ options.apply_defaults timeout: @config.timeout,
624
+ metadata: @config.metadata,
625
+ retry_policy: @config.retry_policy
626
+
627
+ @user_service_stub.call_rpc :list_users, request, options: options do |response, operation|
628
+ response = ::Gapic::PagedEnumerable.new @user_service_stub, :list_users, request, response, operation, options
629
+ yield response, operation if block_given?
630
+ return response
631
+ end
632
+ rescue ::GRPC::BadStatus => e
633
+ raise ::Google::Cloud::Error.from_error(e)
634
+ end
635
+
636
+ ##
637
+ # Configuration class for the UserService API.
638
+ #
639
+ # This class represents the configuration for UserService,
640
+ # providing control over timeouts, retry behavior, logging, transport
641
+ # parameters, and other low-level controls. Certain parameters can also be
642
+ # applied individually to specific RPCs. See
643
+ # {::Google::Shopping::Merchant::Accounts::V1beta::UserService::Client::Configuration::Rpcs}
644
+ # for a list of RPCs that can be configured independently.
645
+ #
646
+ # Configuration can be applied globally to all clients, or to a single client
647
+ # on construction.
648
+ #
649
+ # @example
650
+ #
651
+ # # Modify the global config, setting the timeout for
652
+ # # get_user to 20 seconds,
653
+ # # and all remaining timeouts to 10 seconds.
654
+ # ::Google::Shopping::Merchant::Accounts::V1beta::UserService::Client.configure do |config|
655
+ # config.timeout = 10.0
656
+ # config.rpcs.get_user.timeout = 20.0
657
+ # end
658
+ #
659
+ # # Apply the above configuration only to a new client.
660
+ # client = ::Google::Shopping::Merchant::Accounts::V1beta::UserService::Client.new do |config|
661
+ # config.timeout = 10.0
662
+ # config.rpcs.get_user.timeout = 20.0
663
+ # end
664
+ #
665
+ # @!attribute [rw] endpoint
666
+ # A custom service endpoint, as a hostname or hostname:port. The default is
667
+ # nil, indicating to use the default endpoint in the current universe domain.
668
+ # @return [::String,nil]
669
+ # @!attribute [rw] credentials
670
+ # Credentials to send with calls. You may provide any of the following types:
671
+ # * (`String`) The path to a service account key file in JSON format
672
+ # * (`Hash`) A service account key as a Hash
673
+ # * (`Google::Auth::Credentials`) A googleauth credentials object
674
+ # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
675
+ # * (`Signet::OAuth2::Client`) A signet oauth2 client object
676
+ # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
677
+ # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
678
+ # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
679
+ # * (`nil`) indicating no credentials
680
+ # @return [::Object]
681
+ # @!attribute [rw] scope
682
+ # The OAuth scopes
683
+ # @return [::Array<::String>]
684
+ # @!attribute [rw] lib_name
685
+ # The library name as recorded in instrumentation and logging
686
+ # @return [::String]
687
+ # @!attribute [rw] lib_version
688
+ # The library version as recorded in instrumentation and logging
689
+ # @return [::String]
690
+ # @!attribute [rw] channel_args
691
+ # Extra parameters passed to the gRPC channel. Note: this is ignored if a
692
+ # `GRPC::Core::Channel` object is provided as the credential.
693
+ # @return [::Hash]
694
+ # @!attribute [rw] interceptors
695
+ # An array of interceptors that are run before calls are executed.
696
+ # @return [::Array<::GRPC::ClientInterceptor>]
697
+ # @!attribute [rw] timeout
698
+ # The call timeout in seconds.
699
+ # @return [::Numeric]
700
+ # @!attribute [rw] metadata
701
+ # Additional gRPC headers to be sent with the call.
702
+ # @return [::Hash{::Symbol=>::String}]
703
+ # @!attribute [rw] retry_policy
704
+ # The retry policy. The value is a hash with the following keys:
705
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
706
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
707
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
708
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
709
+ # trigger a retry.
710
+ # @return [::Hash]
711
+ # @!attribute [rw] quota_project
712
+ # A separate project against which to charge quota.
713
+ # @return [::String]
714
+ # @!attribute [rw] universe_domain
715
+ # The universe domain within which to make requests. This determines the
716
+ # default endpoint URL. The default value of nil uses the environment
717
+ # universe (usually the default "googleapis.com" universe).
718
+ # @return [::String,nil]
719
+ #
720
+ class Configuration
721
+ extend ::Gapic::Config
722
+
723
+ # @private
724
+ # The endpoint specific to the default "googleapis.com" universe. Deprecated.
725
+ DEFAULT_ENDPOINT = "merchantapi.googleapis.com"
726
+
727
+ config_attr :endpoint, nil, ::String, nil
728
+ config_attr :credentials, nil do |value|
729
+ allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
730
+ allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
731
+ allowed.any? { |klass| klass === value }
732
+ end
733
+ config_attr :scope, nil, ::String, ::Array, nil
734
+ config_attr :lib_name, nil, ::String, nil
735
+ config_attr :lib_version, nil, ::String, nil
736
+ config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
737
+ config_attr :interceptors, nil, ::Array, nil
738
+ config_attr :timeout, nil, ::Numeric, nil
739
+ config_attr :metadata, nil, ::Hash, nil
740
+ config_attr :retry_policy, nil, ::Hash, ::Proc, nil
741
+ config_attr :quota_project, nil, ::String, nil
742
+ config_attr :universe_domain, nil, ::String, nil
743
+
744
+ # @private
745
+ def initialize parent_config = nil
746
+ @parent_config = parent_config unless parent_config.nil?
747
+
748
+ yield self if block_given?
749
+ end
750
+
751
+ ##
752
+ # Configurations for individual RPCs
753
+ # @return [Rpcs]
754
+ #
755
+ def rpcs
756
+ @rpcs ||= begin
757
+ parent_rpcs = nil
758
+ parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
759
+ Rpcs.new parent_rpcs
760
+ end
761
+ end
762
+
763
+ ##
764
+ # Configuration for the channel pool
765
+ # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
766
+ #
767
+ def channel_pool
768
+ @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
769
+ end
770
+
771
+ ##
772
+ # Configuration RPC class for the UserService API.
773
+ #
774
+ # Includes fields providing the configuration for each RPC in this service.
775
+ # Each configuration object is of type `Gapic::Config::Method` and includes
776
+ # the following configuration fields:
777
+ #
778
+ # * `timeout` (*type:* `Numeric`) - The call timeout in seconds
779
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
780
+ # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
781
+ # include the following keys:
782
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
783
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
784
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
785
+ # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should
786
+ # trigger a retry.
787
+ #
788
+ class Rpcs
789
+ ##
790
+ # RPC-specific configuration for `get_user`
791
+ # @return [::Gapic::Config::Method]
792
+ #
793
+ attr_reader :get_user
794
+ ##
795
+ # RPC-specific configuration for `create_user`
796
+ # @return [::Gapic::Config::Method]
797
+ #
798
+ attr_reader :create_user
799
+ ##
800
+ # RPC-specific configuration for `delete_user`
801
+ # @return [::Gapic::Config::Method]
802
+ #
803
+ attr_reader :delete_user
804
+ ##
805
+ # RPC-specific configuration for `update_user`
806
+ # @return [::Gapic::Config::Method]
807
+ #
808
+ attr_reader :update_user
809
+ ##
810
+ # RPC-specific configuration for `list_users`
811
+ # @return [::Gapic::Config::Method]
812
+ #
813
+ attr_reader :list_users
814
+
815
+ # @private
816
+ def initialize parent_rpcs = nil
817
+ get_user_config = parent_rpcs.get_user if parent_rpcs.respond_to? :get_user
818
+ @get_user = ::Gapic::Config::Method.new get_user_config
819
+ create_user_config = parent_rpcs.create_user if parent_rpcs.respond_to? :create_user
820
+ @create_user = ::Gapic::Config::Method.new create_user_config
821
+ delete_user_config = parent_rpcs.delete_user if parent_rpcs.respond_to? :delete_user
822
+ @delete_user = ::Gapic::Config::Method.new delete_user_config
823
+ update_user_config = parent_rpcs.update_user if parent_rpcs.respond_to? :update_user
824
+ @update_user = ::Gapic::Config::Method.new update_user_config
825
+ list_users_config = parent_rpcs.list_users if parent_rpcs.respond_to? :list_users
826
+ @list_users = ::Gapic::Config::Method.new list_users_config
827
+
828
+ yield self if block_given?
829
+ end
830
+ end
831
+ end
832
+ end
833
+ end
834
+ end
835
+ end
836
+ end
837
+ end
838
+ end