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

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 +143 -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 +420 -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 +227 -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,219 @@
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
+
20
+ module Google
21
+ module Shopping
22
+ module Merchant
23
+ module Accounts
24
+ module V1beta
25
+ # An account.
26
+ # @!attribute [rw] name
27
+ # @return [::String]
28
+ # Identifier. The resource name of the account.
29
+ # Format: `accounts/{account}`
30
+ # @!attribute [r] account_id
31
+ # @return [::Integer]
32
+ # Output only. The ID of the account.
33
+ # @!attribute [rw] account_name
34
+ # @return [::String]
35
+ # Required. A human-readable name of the account. See
36
+ # [store name](https://support.google.com/merchants/answer/160556) and
37
+ # [business name](https://support.google.com/merchants/answer/12159159) for
38
+ # more information.
39
+ # @!attribute [rw] adult_content
40
+ # @return [::Boolean]
41
+ # Whether this account contains adult content.
42
+ # @!attribute [r] test_account
43
+ # @return [::Boolean]
44
+ # Output only. Whether this is a test account.
45
+ # @!attribute [rw] time_zone
46
+ # @return [::Google::Type::TimeZone]
47
+ # Required. The time zone of the account.
48
+ #
49
+ # On writes, `time_zone` sets both the `reporting_time_zone` and the
50
+ # `display_time_zone`.
51
+ #
52
+ # For reads, `time_zone` always returns the `display_time_zone`. If
53
+ # `display_time_zone` doesn't exist for your account, `time_zone` is empty.
54
+ # @!attribute [rw] language_code
55
+ # @return [::String]
56
+ # Required. The account's [BCP-47 language
57
+ # code](https://tools.ietf.org/html/bcp47), such as `en-US` or `sr-Latn`.
58
+ class Account
59
+ include ::Google::Protobuf::MessageExts
60
+ extend ::Google::Protobuf::MessageExts::ClassMethods
61
+ end
62
+
63
+ # Request message for the `GetAccount` method.
64
+ # @!attribute [rw] name
65
+ # @return [::String]
66
+ # Required. The name of the account to retrieve.
67
+ # Format: `accounts/{account}`
68
+ class GetAccountRequest
69
+ include ::Google::Protobuf::MessageExts
70
+ extend ::Google::Protobuf::MessageExts::ClassMethods
71
+ end
72
+
73
+ # Request message for the `CreateAndConfigureAccount` method.
74
+ # @!attribute [rw] account
75
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::Account]
76
+ # Required. The account to be created.
77
+ # @!attribute [rw] users
78
+ # @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::CreateUserRequest>]
79
+ # Optional. Users to be added to the account.
80
+ # @!attribute [rw] accept_terms_of_service
81
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::CreateAndConfigureAccountRequest::AcceptTermsOfService]
82
+ # Optional. The Terms of Service (ToS) to be accepted immediately upon
83
+ # account creation.
84
+ # @!attribute [rw] service
85
+ # @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::CreateAndConfigureAccountRequest::AddAccountService>]
86
+ # Optional. If specified, an account service between the account to be
87
+ # created and the provider account is initialized as part of the
88
+ # creation.
89
+ class CreateAndConfigureAccountRequest
90
+ include ::Google::Protobuf::MessageExts
91
+ extend ::Google::Protobuf::MessageExts::ClassMethods
92
+
93
+ # Reference to a Terms of Service resource.
94
+ # @!attribute [rw] name
95
+ # @return [::String]
96
+ # Required. The resource name of the terms of service version.
97
+ # @!attribute [rw] region_code
98
+ # @return [::String]
99
+ # Required. Region code as defined by [CLDR](https://cldr.unicode.org/).
100
+ # This is either a country when the ToS applies specifically to that
101
+ # country or `001` when it applies globally.
102
+ class AcceptTermsOfService
103
+ include ::Google::Protobuf::MessageExts
104
+ extend ::Google::Protobuf::MessageExts::ClassMethods
105
+ end
106
+
107
+ # Additional instructions to add account services during creation of the
108
+ # account.
109
+ # @!attribute [rw] account_aggregation
110
+ # @return [::Google::Protobuf::Empty]
111
+ # The provider is an aggregator for the account.
112
+ # @!attribute [rw] provider
113
+ # @return [::String]
114
+ # Optional. The provider of the service.
115
+ # Format: `accounts/{account}`
116
+ class AddAccountService
117
+ include ::Google::Protobuf::MessageExts
118
+ extend ::Google::Protobuf::MessageExts::ClassMethods
119
+ end
120
+ end
121
+
122
+ # Request message for the `DeleteAccount` method.
123
+ # @!attribute [rw] name
124
+ # @return [::String]
125
+ # Required. The name of the account to delete.
126
+ # Format: `accounts/{account}`
127
+ class DeleteAccountRequest
128
+ include ::Google::Protobuf::MessageExts
129
+ extend ::Google::Protobuf::MessageExts::ClassMethods
130
+ end
131
+
132
+ # Request message for the `UpdateAccount` method.
133
+ # @!attribute [rw] account
134
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::Account]
135
+ # Required. The new version of the account.
136
+ # @!attribute [rw] update_mask
137
+ # @return [::Google::Protobuf::FieldMask]
138
+ # Required. List of fields being updated.
139
+ class UpdateAccountRequest
140
+ include ::Google::Protobuf::MessageExts
141
+ extend ::Google::Protobuf::MessageExts::ClassMethods
142
+ end
143
+
144
+ # Request message for the `ListAccounts` method.
145
+ # @!attribute [rw] page_size
146
+ # @return [::Integer]
147
+ # Optional. The maximum number of accounts to return. The service may return
148
+ # fewer than this value. If unspecified, at most 250 accounts are returned.
149
+ # The maximum value is 500; values above 500 are coerced to 500.
150
+ # @!attribute [rw] page_token
151
+ # @return [::String]
152
+ # Optional. A page token, received from a previous `ListAccounts` call.
153
+ # Provide this to retrieve the subsequent page.
154
+ #
155
+ # When paginating, all other parameters provided to `ListAccounts` must match
156
+ # the call that provided the page token.
157
+ # @!attribute [rw] filter
158
+ # @return [::String]
159
+ # Optional. Returns only accounts that match the
160
+ # [filter](/merchant/api/guides/accounts/filter).
161
+ # For more details, see the
162
+ # [filter syntax reference](/merchant/api/guides/accounts/filter-syntax).
163
+ class ListAccountsRequest
164
+ include ::Google::Protobuf::MessageExts
165
+ extend ::Google::Protobuf::MessageExts::ClassMethods
166
+ end
167
+
168
+ # Response message for the `ListAccounts` method.
169
+ # @!attribute [rw] accounts
170
+ # @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::Account>]
171
+ # The accounts matching the `ListAccountsRequest`.
172
+ # @!attribute [rw] next_page_token
173
+ # @return [::String]
174
+ # A token, which can be sent as `page_token` to retrieve the next page.
175
+ # If this field is omitted, there are no subsequent pages.
176
+ class ListAccountsResponse
177
+ include ::Google::Protobuf::MessageExts
178
+ extend ::Google::Protobuf::MessageExts::ClassMethods
179
+ end
180
+
181
+ # Request message for the `ListSubAccounts` method.
182
+ # @!attribute [rw] provider
183
+ # @return [::String]
184
+ # Required. The parent account.
185
+ # Format: `accounts/{account}`
186
+ # @!attribute [rw] page_size
187
+ # @return [::Integer]
188
+ # Optional. The maximum number of accounts to return. The service may return
189
+ # fewer than this value. If unspecified, at most 250 accounts are returned.
190
+ # The maximum value is 500; values above 500 are coerced to 500.
191
+ # @!attribute [rw] page_token
192
+ # @return [::String]
193
+ # Optional. A page token, received from a previous `ListAccounts` call.
194
+ # Provide this to retrieve the subsequent page.
195
+ #
196
+ # When paginating, all other parameters provided to `ListAccounts` must match
197
+ # the call that provided the page token.
198
+ class ListSubAccountsRequest
199
+ include ::Google::Protobuf::MessageExts
200
+ extend ::Google::Protobuf::MessageExts::ClassMethods
201
+ end
202
+
203
+ # Response message for the `ListSubAccounts` method.
204
+ # @!attribute [rw] accounts
205
+ # @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::Account>]
206
+ # The accounts for which the given parent account is an aggregator.
207
+ # @!attribute [rw] next_page_token
208
+ # @return [::String]
209
+ # A token, which can be sent as `page_token` to retrieve the next page.
210
+ # If this field is omitted, there are no subsequent pages.
211
+ class ListSubAccountsResponse
212
+ include ::Google::Protobuf::MessageExts
213
+ extend ::Google::Protobuf::MessageExts::ClassMethods
214
+ end
215
+ end
216
+ end
217
+ end
218
+ end
219
+ end
@@ -0,0 +1,129 @@
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
+
20
+ module Google
21
+ module Shopping
22
+ module Merchant
23
+ module Accounts
24
+ module V1beta
25
+ # Collection of information related to the [identity of a
26
+ # business](https://support.google.com/merchants/answer/12564247).
27
+ # @!attribute [rw] name
28
+ # @return [::String]
29
+ # Identifier. The resource name of the business identity.
30
+ # Format: `accounts/{account}/businessIdentity`
31
+ # @!attribute [rw] promotions_consent
32
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::PromotionsConsent]
33
+ # Optional. Whether the identity attributes may be used for promotions.
34
+ # @!attribute [rw] black_owned
35
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::IdentityAttribute]
36
+ # Optional. Specifies whether the business identifies itself as being
37
+ # black-owned. This optional field will only be available for merchants with
38
+ # a business country set to `US`. It is also not applicable for marketplaces
39
+ # or marketplace sellers.
40
+ # @!attribute [rw] women_owned
41
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::IdentityAttribute]
42
+ # Optional. Specifies whether the business identifies itself as being
43
+ # women-owned. This optional field will only be available for merchants with
44
+ # a business country set to `US`. It is also not applicable for marketplaces
45
+ # or marketplace sellers.
46
+ # @!attribute [rw] veteran_owned
47
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::IdentityAttribute]
48
+ # Optional. Specifies whether the business identifies itself as being
49
+ # veteran-owned. This optional field will only be available for merchants
50
+ # with a business country set to `US`. It is also not applicable for
51
+ # marketplaces or marketplace sellers.
52
+ # @!attribute [rw] latino_owned
53
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::IdentityAttribute]
54
+ # Optional. Specifies whether the business identifies itself as being
55
+ # latino-owned. This optional field will only be available for merchants with
56
+ # a business country set to `US`. It is also not applicable for marketplaces
57
+ # or marketplace sellers.
58
+ # @!attribute [rw] small_business
59
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::IdentityAttribute]
60
+ # Optional. Specifies whether the business identifies itself as a small
61
+ # business. This optional field will only be available for merchants with a
62
+ # business country set to `US`. It is also not applicable for marketplaces.
63
+ class BusinessIdentity
64
+ include ::Google::Protobuf::MessageExts
65
+ extend ::Google::Protobuf::MessageExts::ClassMethods
66
+
67
+ # All information related to an identity attribute.
68
+ # @!attribute [rw] identity_declaration
69
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity::IdentityAttribute::IdentityDeclaration]
70
+ # Required. The declaration of identity for this attribute.
71
+ class IdentityAttribute
72
+ include ::Google::Protobuf::MessageExts
73
+ extend ::Google::Protobuf::MessageExts::ClassMethods
74
+
75
+ # All possible settings regarding the declaration of an identity.
76
+ module IdentityDeclaration
77
+ # Default value indicating that no selection was made.
78
+ IDENTITY_DECLARATION_UNSPECIFIED = 0
79
+
80
+ # Indicates that the account identifies with the attribute.
81
+ SELF_IDENTIFIES_AS = 1
82
+
83
+ # Indicates that the account does not identify with the attribute.
84
+ DOES_NOT_SELF_IDENTIFY_AS = 2
85
+ end
86
+ end
87
+
88
+ # All possible settings regarding promotions related to the business
89
+ # identity.
90
+ module PromotionsConsent
91
+ # Default value indicating that no selection was made.
92
+ PROMOTIONS_CONSENT_UNSPECIFIED = 0
93
+
94
+ # Indicates that the account consented to having their business identity
95
+ # used for promotions.
96
+ PROMOTIONS_CONSENT_GIVEN = 1
97
+
98
+ # Indicates that the account did not consent to having their business
99
+ # identity used for promotions.
100
+ PROMOTIONS_CONSENT_DENIED = 2
101
+ end
102
+ end
103
+
104
+ # Request message for the `GetBusinessIdentity` method.
105
+ # @!attribute [rw] name
106
+ # @return [::String]
107
+ # Required. The resource name of the business identity.
108
+ # Format: `accounts/{account}/businessIdentity`
109
+ class GetBusinessIdentityRequest
110
+ include ::Google::Protobuf::MessageExts
111
+ extend ::Google::Protobuf::MessageExts::ClassMethods
112
+ end
113
+
114
+ # Request message for the `UpdateBusinessIdentity` method.
115
+ # @!attribute [rw] business_identity
116
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::BusinessIdentity]
117
+ # Required. The new version of the business identity.
118
+ # @!attribute [rw] update_mask
119
+ # @return [::Google::Protobuf::FieldMask]
120
+ # Required. List of fields being updated.
121
+ class UpdateBusinessIdentityRequest
122
+ include ::Google::Protobuf::MessageExts
123
+ extend ::Google::Protobuf::MessageExts::ClassMethods
124
+ end
125
+ end
126
+ end
127
+ end
128
+ end
129
+ end
@@ -0,0 +1,72 @@
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
+
20
+ module Google
21
+ module Shopping
22
+ module Merchant
23
+ module Accounts
24
+ module V1beta
25
+ # Collection of information related to a business.
26
+ # @!attribute [rw] name
27
+ # @return [::String]
28
+ # Identifier. The resource name of the business info.
29
+ # Format: `accounts/{account}/businessInfo`
30
+ # @!attribute [rw] address
31
+ # @return [::Google::Type::PostalAddress]
32
+ # Optional. The address of the business.
33
+ # @!attribute [r] phone
34
+ # @return [::Google::Type::PhoneNumber]
35
+ # Output only. The phone number of the business.
36
+ # @!attribute [r] phone_verification_state
37
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::PhoneVerificationState]
38
+ # Output only. The phone verification state of the business.
39
+ # @!attribute [rw] customer_service
40
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::CustomerService]
41
+ # Optional. The customer service of the business.
42
+ class BusinessInfo
43
+ include ::Google::Protobuf::MessageExts
44
+ extend ::Google::Protobuf::MessageExts::ClassMethods
45
+ end
46
+
47
+ # Request message for the `GetBusinessInfo` method.
48
+ # @!attribute [rw] name
49
+ # @return [::String]
50
+ # Required. The resource name of the business info.
51
+ # Format: `accounts/{account}/businessInfo`
52
+ class GetBusinessInfoRequest
53
+ include ::Google::Protobuf::MessageExts
54
+ extend ::Google::Protobuf::MessageExts::ClassMethods
55
+ end
56
+
57
+ # Request message for the `UpdateBusinessInfo` method.
58
+ # @!attribute [rw] business_info
59
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::BusinessInfo]
60
+ # Required. The new version of the business info.
61
+ # @!attribute [rw] update_mask
62
+ # @return [::Google::Protobuf::FieldMask]
63
+ # Required. List of fields being updated.
64
+ class UpdateBusinessInfoRequest
65
+ include ::Google::Protobuf::MessageExts
66
+ extend ::Google::Protobuf::MessageExts::ClassMethods
67
+ end
68
+ end
69
+ end
70
+ end
71
+ end
72
+ end
@@ -0,0 +1,43 @@
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
+
20
+ module Google
21
+ module Shopping
22
+ module Merchant
23
+ module Accounts
24
+ module V1beta
25
+ # Customer service information.
26
+ # @!attribute [rw] uri
27
+ # @return [::String]
28
+ # Optional. The URI where customer service may be found.
29
+ # @!attribute [rw] email
30
+ # @return [::String]
31
+ # Optional. The email address where customer service may be reached.
32
+ # @!attribute [rw] phone
33
+ # @return [::Google::Type::PhoneNumber]
34
+ # Optional. The phone number where customer service may be called.
35
+ class CustomerService
36
+ include ::Google::Protobuf::MessageExts
37
+ extend ::Google::Protobuf::MessageExts::ClassMethods
38
+ end
39
+ end
40
+ end
41
+ end
42
+ end
43
+ end
@@ -0,0 +1,82 @@
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
+
20
+ module Google
21
+ module Shopping
22
+ module Merchant
23
+ module Accounts
24
+ module V1beta
25
+ # The categories of notifications the user opted into / opted out of. The email
26
+ # preferences do not include mandatory announcements as users can't opt out of
27
+ # them.
28
+ # @!attribute [rw] name
29
+ # @return [::String]
30
+ # Identifier. The name of the EmailPreferences. The endpoint is only
31
+ # supported for the authenticated user.
32
+ # @!attribute [rw] news_and_tips
33
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::EmailPreferences::OptInState]
34
+ # Optional. Updates on new features, tips and best practices.
35
+ class EmailPreferences
36
+ include ::Google::Protobuf::MessageExts
37
+ extend ::Google::Protobuf::MessageExts::ClassMethods
38
+
39
+ # Opt in state of the email preference.
40
+ module OptInState
41
+ # Opt-in status is not specified.
42
+ OPT_IN_STATE_UNSPECIFIED = 0
43
+
44
+ # User has opted out of receiving this type of email.
45
+ OPTED_OUT = 1
46
+
47
+ # User has opted in to receiving this type of email.
48
+ OPTED_IN = 2
49
+
50
+ # User has opted in to receiving this type of email and the confirmation
51
+ # email has been sent, but user has not yet confirmed the opt in (applies
52
+ # only to certain countries).
53
+ UNCONFIRMED = 3
54
+ end
55
+ end
56
+
57
+ # Request message for GetEmailPreferences method.
58
+ # @!attribute [rw] name
59
+ # @return [::String]
60
+ # Required. The name of the `EmailPreferences` resource.
61
+ # Format: `accounts/{account}/users/{email}/emailPreferences`
62
+ class GetEmailPreferencesRequest
63
+ include ::Google::Protobuf::MessageExts
64
+ extend ::Google::Protobuf::MessageExts::ClassMethods
65
+ end
66
+
67
+ # Request message for UpdateEmailPreferences method.
68
+ # @!attribute [rw] email_preferences
69
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::EmailPreferences]
70
+ # Required. Email Preferences to be updated.
71
+ # @!attribute [rw] update_mask
72
+ # @return [::Google::Protobuf::FieldMask]
73
+ # Required. List of fields being updated.
74
+ class UpdateEmailPreferencesRequest
75
+ include ::Google::Protobuf::MessageExts
76
+ extend ::Google::Protobuf::MessageExts::ClassMethods
77
+ end
78
+ end
79
+ end
80
+ end
81
+ end
82
+ end
@@ -0,0 +1,87 @@
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
+
20
+ module Google
21
+ module Shopping
22
+ module Merchant
23
+ module Accounts
24
+ module V1beta
25
+ # A store's homepage.
26
+ # @!attribute [rw] name
27
+ # @return [::String]
28
+ # Identifier. The resource name of the store's homepage.
29
+ # Format: `accounts/{account}/homepage`
30
+ # @!attribute [rw] uri
31
+ # @return [::String]
32
+ # Required. The URI (typically a URL) of the store's homepage.
33
+ # @!attribute [r] claimed
34
+ # @return [::Boolean]
35
+ # Output only. Whether the homepage is claimed. See
36
+ # https://support.google.com/merchants/answer/176793.
37
+ class Homepage
38
+ include ::Google::Protobuf::MessageExts
39
+ extend ::Google::Protobuf::MessageExts::ClassMethods
40
+ end
41
+
42
+ # Request message for the `GetHomepage` method.
43
+ # @!attribute [rw] name
44
+ # @return [::String]
45
+ # Required. The name of the homepage to retrieve.
46
+ # Format: `accounts/{account}/homepage`
47
+ class GetHomepageRequest
48
+ include ::Google::Protobuf::MessageExts
49
+ extend ::Google::Protobuf::MessageExts::ClassMethods
50
+ end
51
+
52
+ # Request message for the `UpdateHomepage` method.
53
+ # @!attribute [rw] homepage
54
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::Homepage]
55
+ # Required. The new version of the homepage.
56
+ # @!attribute [rw] update_mask
57
+ # @return [::Google::Protobuf::FieldMask]
58
+ # Required. List of fields being updated.
59
+ class UpdateHomepageRequest
60
+ include ::Google::Protobuf::MessageExts
61
+ extend ::Google::Protobuf::MessageExts::ClassMethods
62
+ end
63
+
64
+ # Request message for the `ClaimHomepage` method.
65
+ # @!attribute [rw] name
66
+ # @return [::String]
67
+ # Required. The name of the homepage to claim.
68
+ # Format: `accounts/{account}/homepage`
69
+ class ClaimHomepageRequest
70
+ include ::Google::Protobuf::MessageExts
71
+ extend ::Google::Protobuf::MessageExts::ClassMethods
72
+ end
73
+
74
+ # Request message for the `UnclaimHomepage` method.
75
+ # @!attribute [rw] name
76
+ # @return [::String]
77
+ # Required. The name of the homepage to unclaim.
78
+ # Format: `accounts/{account}/homepage`
79
+ class UnclaimHomepageRequest
80
+ include ::Google::Protobuf::MessageExts
81
+ extend ::Google::Protobuf::MessageExts::ClassMethods
82
+ end
83
+ end
84
+ end
85
+ end
86
+ end
87
+ end