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,238 @@
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
+ # Request message for the `GetOnlineReturnPolicy` method.
26
+ # @!attribute [rw] name
27
+ # @return [::String]
28
+ # Required. The name of the return policy to retrieve.
29
+ # Format: `accounts/{account}/onlineReturnPolicies/{return_policy}`
30
+ class GetOnlineReturnPolicyRequest
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+ end
34
+
35
+ # Request message for the `ListOnlineReturnPolicies` method.
36
+ # @!attribute [rw] parent
37
+ # @return [::String]
38
+ # Required. The merchant account for which to list return policies.
39
+ # Format: `accounts/{account}`
40
+ # @!attribute [rw] page_size
41
+ # @return [::Integer]
42
+ # Optional. The maximum number of `OnlineReturnPolicy` resources to return.
43
+ # The service returns fewer than this value if the number of return policies
44
+ # for the given merchant is less that than the `pageSize`. The default value
45
+ # is 10. The maximum value is 100; If a value higher than the maximum is
46
+ # specified, then the `pageSize` will default to the maximum
47
+ # @!attribute [rw] page_token
48
+ # @return [::String]
49
+ # Optional. A page token, received from a previous `ListOnlineReturnPolicies`
50
+ # call. Provide the page token to retrieve the subsequent page.
51
+ #
52
+ # When paginating, all other parameters provided to
53
+ # `ListOnlineReturnPolicies` must match the call that provided the page
54
+ # token. The token returned as
55
+ # {::Google::Shopping::Merchant::Accounts::V1beta::ListOnlineReturnPoliciesResponse#next_page_token nextPageToken}
56
+ # in the response to the previous request.
57
+ class ListOnlineReturnPoliciesRequest
58
+ include ::Google::Protobuf::MessageExts
59
+ extend ::Google::Protobuf::MessageExts::ClassMethods
60
+ end
61
+
62
+ # Response message for the `ListOnlineReturnPolicies` method.
63
+ # @!attribute [rw] online_return_policies
64
+ # @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::OnlineReturnPolicy>]
65
+ # The retrieved return policies.
66
+ # @!attribute [rw] next_page_token
67
+ # @return [::String]
68
+ # A token, which can be sent as `pageToken` to retrieve the next page.
69
+ # If this field is omitted, there are no subsequent pages.
70
+ class ListOnlineReturnPoliciesResponse
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+
75
+ # [Online return policy](https://support.google.com/merchants/answer/10220642)
76
+ # object. This is currently used to represent return policies for ads and free
77
+ # listings programs.
78
+ # @!attribute [rw] name
79
+ # @return [::String]
80
+ # Identifier. The name of the `OnlineReturnPolicy` resource.
81
+ # Format: `accounts/{account}/onlineReturnPolicies/{return_policy}`
82
+ # @!attribute [r] return_policy_id
83
+ # @return [::String]
84
+ # Output only. Return policy ID generated by Google.
85
+ # @!attribute [rw] label
86
+ # @return [::String]
87
+ # This field represents the unique user-defined label of the return policy.
88
+ # It is important to note that the same label cannot be used in different
89
+ # return policies for the same country. Unless a product specifies a specific
90
+ # label attribute, policies will be automatically labeled as 'default'.
91
+ # To assign a custom return policy to certain product groups, follow the
92
+ # instructions provided in the [Return policy label]
93
+ # (https://support.google.com/merchants/answer/9445425).
94
+ # The label can contain up to 50 characters.
95
+ # @!attribute [rw] countries
96
+ # @return [::Array<::String>]
97
+ # The countries of sale where the return policy applies. The values
98
+ # must be a valid 2 letter ISO 3166 code.
99
+ # @!attribute [rw] policy
100
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::OnlineReturnPolicy::Policy]
101
+ # The return policy.
102
+ # @!attribute [rw] restocking_fee
103
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::OnlineReturnPolicy::RestockingFee]
104
+ # The restocking fee that applies to all return reason categories. This would
105
+ # be treated as a free restocking fee if the value is not set.
106
+ # @!attribute [rw] return_methods
107
+ # @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::OnlineReturnPolicy::ReturnMethod>]
108
+ # The return methods of how customers can return an item. This value is
109
+ # required to not be empty unless the type of return policy is noReturns.
110
+ # @!attribute [rw] item_conditions
111
+ # @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::OnlineReturnPolicy::ItemCondition>]
112
+ # The item conditions accepted for returns must not be empty unless the type
113
+ # of return policy is 'noReturns'.
114
+ # @!attribute [rw] return_shipping_fee
115
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::OnlineReturnPolicy::ReturnShippingFee]
116
+ # The return shipping fee. Should be set only when customer need to download
117
+ # and print the return label.
118
+ # @!attribute [rw] return_policy_uri
119
+ # @return [::String]
120
+ # The return policy uri. This can used by Google to do a sanity check for the
121
+ # policy. It must be a valid URL.
122
+ # @!attribute [rw] accept_defective_only
123
+ # @return [::Boolean]
124
+ # This field specifies if merchant only accepts defective products for
125
+ # returns, and this field is required.
126
+ # @!attribute [rw] process_refund_days
127
+ # @return [::Integer]
128
+ # The field specifies the number of days it takes for merchants to process
129
+ # refunds, field is optional.
130
+ # @!attribute [rw] accept_exchange
131
+ # @return [::Boolean]
132
+ # This field specifies if merchant allows customers to exchange products,
133
+ # this field is required.
134
+ class OnlineReturnPolicy
135
+ include ::Google::Protobuf::MessageExts
136
+ extend ::Google::Protobuf::MessageExts::ClassMethods
137
+
138
+ # The return shipping fee. This can either be a fixed fee or a boolean to
139
+ # indicate that the customer pays the actual shipping cost.
140
+ # @!attribute [rw] type
141
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::OnlineReturnPolicy::ReturnShippingFee::Type]
142
+ # Type of return shipping fee.
143
+ # @!attribute [rw] fixed_fee
144
+ # @return [::Google::Shopping::Type::Price]
145
+ # Fixed return shipping fee amount. This value is only applicable when type
146
+ # is `FIXED`. We will treat the return shipping fee as free if type is
147
+ # `FIXED` and this value is not set.
148
+ class ReturnShippingFee
149
+ include ::Google::Protobuf::MessageExts
150
+ extend ::Google::Protobuf::MessageExts::ClassMethods
151
+
152
+ # Return shipping fee types.
153
+ module Type
154
+ # Default value. This value is unused.
155
+ TYPE_UNSPECIFIED = 0
156
+
157
+ # The return shipping fee is a fixed value.
158
+ FIXED = 1
159
+
160
+ # Customers will pay the actual return shipping fee.
161
+ CUSTOMER_PAYING_ACTUAL_FEE = 2
162
+ end
163
+ end
164
+
165
+ # The restocking fee. This can be a flat fee or a micro percent.
166
+ # @!attribute [rw] fixed_fee
167
+ # @return [::Google::Shopping::Type::Price]
168
+ # Fixed restocking fee.
169
+ # @!attribute [rw] micro_percent
170
+ # @return [::Integer]
171
+ # Percent of total price in micros. 15,000,000 means 15% of the total
172
+ # price would be charged.
173
+ class RestockingFee
174
+ include ::Google::Protobuf::MessageExts
175
+ extend ::Google::Protobuf::MessageExts::ClassMethods
176
+ end
177
+
178
+ # The available policies.
179
+ # @!attribute [rw] type
180
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::OnlineReturnPolicy::Policy::Type]
181
+ # Policy type.
182
+ # @!attribute [rw] days
183
+ # @return [::Integer]
184
+ # The number of days items can be returned after delivery, where one day
185
+ # is defined as 24 hours after the delivery timestamp. Required for
186
+ # `NUMBER_OF_DAYS_AFTER_DELIVERY` returns.
187
+ class Policy
188
+ include ::Google::Protobuf::MessageExts
189
+ extend ::Google::Protobuf::MessageExts::ClassMethods
190
+
191
+ # Return policy types.
192
+ module Type
193
+ # Default value. This value is unused.
194
+ TYPE_UNSPECIFIED = 0
195
+
196
+ # The number of days within which a return is valid after delivery.
197
+ NUMBER_OF_DAYS_AFTER_DELIVERY = 1
198
+
199
+ # No returns.
200
+ NO_RETURNS = 2
201
+
202
+ # Life time returns.
203
+ LIFETIME_RETURNS = 3
204
+ end
205
+ end
206
+
207
+ # The available return methods.
208
+ module ReturnMethod
209
+ # Default value. This value is unused.
210
+ RETURN_METHOD_UNSPECIFIED = 0
211
+
212
+ # Return by mail.
213
+ BY_MAIL = 1
214
+
215
+ # Return in store.
216
+ IN_STORE = 2
217
+
218
+ # Return at a kiosk.
219
+ AT_A_KIOSK = 3
220
+ end
221
+
222
+ # The available item conditions.
223
+ module ItemCondition
224
+ # Default value. This value is unused.
225
+ ITEM_CONDITION_UNSPECIFIED = 0
226
+
227
+ # New.
228
+ NEW = 1
229
+
230
+ # Used.
231
+ USED = 2
232
+ end
233
+ end
234
+ end
235
+ end
236
+ end
237
+ end
238
+ end
@@ -0,0 +1,40 @@
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 phone verification state.
26
+ module PhoneVerificationState
27
+ # Default value. This value is unused.
28
+ PHONE_VERIFICATION_STATE_UNSPECIFIED = 0
29
+
30
+ # The phone is verified.
31
+ PHONE_VERIFICATION_STATE_VERIFIED = 1
32
+
33
+ # The phone is unverified
34
+ PHONE_VERIFICATION_STATE_UNVERIFIED = 2
35
+ end
36
+ end
37
+ end
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,160 @@
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
+ # Defines participation in a given program for the specified account.
26
+ #
27
+ # Programs provide a mechanism for adding functionality to merchant accounts. A
28
+ # typical example of this is the [Free product
29
+ # listings](https://support.google.com/merchants/topic/9240261?ref_topic=7257954,7259405,&sjid=796648681813264022-EU)
30
+ # program, which enables products from a merchant's store to be shown across
31
+ # Google for free.
32
+ # @!attribute [rw] name
33
+ # @return [::String]
34
+ # Identifier. The resource name of the program.
35
+ # Format: `accounts/{account}/programs/{program}`
36
+ # @!attribute [r] documentation_uri
37
+ # @return [::String]
38
+ # Output only. The URL of a Merchant Center help page describing the program.
39
+ # @!attribute [r] state
40
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::Program::State]
41
+ # Output only. The participation state of the account in the program.
42
+ # @!attribute [r] active_region_codes
43
+ # @return [::Array<::String>]
44
+ # Output only. The regions in which the account is actively participating in
45
+ # the program. Active regions are defined as those where all program
46
+ # requirements affecting the regions have been met.
47
+ #
48
+ # Region codes are defined by [CLDR](https://cldr.unicode.org/). This is
49
+ # either a country where the program applies specifically to that country or
50
+ # `001` when the program applies globally.
51
+ # @!attribute [r] unmet_requirements
52
+ # @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::Program::Requirement>]
53
+ # Output only. The requirements that the account has not yet satisfied that
54
+ # are affecting participation in the program.
55
+ class Program
56
+ include ::Google::Protobuf::MessageExts
57
+ extend ::Google::Protobuf::MessageExts::ClassMethods
58
+
59
+ # Defines a requirement specified for participation in the program.
60
+ # @!attribute [r] title
61
+ # @return [::String]
62
+ # Output only. Name of the requirement.
63
+ # @!attribute [r] documentation_uri
64
+ # @return [::String]
65
+ # Output only. The URL of a help page describing the requirement.
66
+ # @!attribute [r] affected_region_codes
67
+ # @return [::Array<::String>]
68
+ # Output only. The regions that are currently affected by this requirement
69
+ # not being met.
70
+ #
71
+ # Region codes are defined by [CLDR](https://cldr.unicode.org/). This is
72
+ # either a country where the program applies specifically to that country
73
+ # or `001` when the program applies globally.
74
+ class Requirement
75
+ include ::Google::Protobuf::MessageExts
76
+ extend ::Google::Protobuf::MessageExts::ClassMethods
77
+ end
78
+
79
+ # Possible program participation states for the account.
80
+ module State
81
+ # Default value. This value is unused.
82
+ STATE_UNSPECIFIED = 0
83
+
84
+ # The account is not eligible to participate in the program.
85
+ NOT_ELIGIBLE = 1
86
+
87
+ # The account is eligible to participate in the program.
88
+ ELIGIBLE = 2
89
+
90
+ # The program is enabled for the account.
91
+ ENABLED = 3
92
+ end
93
+ end
94
+
95
+ # Request message for the GetProgram method.
96
+ # @!attribute [rw] name
97
+ # @return [::String]
98
+ # Required. The name of the program to retrieve.
99
+ # Format: `accounts/{account}/programs/{program}`
100
+ class GetProgramRequest
101
+ include ::Google::Protobuf::MessageExts
102
+ extend ::Google::Protobuf::MessageExts::ClassMethods
103
+ end
104
+
105
+ # Request message for the ListPrograms method.
106
+ # @!attribute [rw] parent
107
+ # @return [::String]
108
+ # Required. The name of the account for which to retrieve all programs.
109
+ # Format: `accounts/{account}`
110
+ # @!attribute [rw] page_size
111
+ # @return [::Integer]
112
+ # Optional. The maximum number of programs to return in a single response. If
113
+ # unspecified (or 0), a default size of 1000 is used. The maximum value is
114
+ # 1000; values above 1000 will be coerced to 1000.
115
+ # @!attribute [rw] page_token
116
+ # @return [::String]
117
+ # Optional. A continuation token, received from a previous `ListPrograms`
118
+ # call. Provide this to retrieve the next page.
119
+ class ListProgramsRequest
120
+ include ::Google::Protobuf::MessageExts
121
+ extend ::Google::Protobuf::MessageExts::ClassMethods
122
+ end
123
+
124
+ # Response message for the ListPrograms method.
125
+ # @!attribute [rw] programs
126
+ # @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::Program>]
127
+ # The programs for the given account.
128
+ # @!attribute [rw] next_page_token
129
+ # @return [::String]
130
+ # A token that can be sent as `page_token` to retrieve the next page. If this
131
+ # field is omitted, there are no subsequent pages.
132
+ class ListProgramsResponse
133
+ include ::Google::Protobuf::MessageExts
134
+ extend ::Google::Protobuf::MessageExts::ClassMethods
135
+ end
136
+
137
+ # Request message for the EnableProgram method.
138
+ # @!attribute [rw] name
139
+ # @return [::String]
140
+ # Required. The name of the program for which to enable participation for the
141
+ # given account. Format: `accounts/{account}/programs/{program}`
142
+ class EnableProgramRequest
143
+ include ::Google::Protobuf::MessageExts
144
+ extend ::Google::Protobuf::MessageExts::ClassMethods
145
+ end
146
+
147
+ # Request message for the DisableProgram method.
148
+ # @!attribute [rw] name
149
+ # @return [::String]
150
+ # Required. The name of the program for which to disable participation for
151
+ # the given account. Format: `accounts/{account}/programs/{program}`
152
+ class DisableProgramRequest
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+ end
156
+ end
157
+ end
158
+ end
159
+ end
160
+ end
@@ -0,0 +1,195 @@
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
+ # Request message for the `GetRegion` method.
26
+ # @!attribute [rw] name
27
+ # @return [::String]
28
+ # Required. The name of the region to retrieve.
29
+ # Format: `accounts/{account}/regions/{region}`
30
+ class GetRegionRequest
31
+ include ::Google::Protobuf::MessageExts
32
+ extend ::Google::Protobuf::MessageExts::ClassMethods
33
+ end
34
+
35
+ # Request message for the `CreateRegion` method.
36
+ # @!attribute [rw] parent
37
+ # @return [::String]
38
+ # Required. The account to create a region for.
39
+ # Format: `accounts/{account}`
40
+ # @!attribute [rw] region_id
41
+ # @return [::String]
42
+ # Required. The identifier for the region, unique over all regions of the
43
+ # same account.
44
+ # @!attribute [rw] region
45
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::Region]
46
+ # Required. The region to create.
47
+ class CreateRegionRequest
48
+ include ::Google::Protobuf::MessageExts
49
+ extend ::Google::Protobuf::MessageExts::ClassMethods
50
+ end
51
+
52
+ # Request message for the `UpdateRegion` method.
53
+ # @!attribute [rw] region
54
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::Region]
55
+ # Required. The updated region.
56
+ # @!attribute [rw] update_mask
57
+ # @return [::Google::Protobuf::FieldMask]
58
+ # Optional. The comma-separated field mask indicating the fields to update.
59
+ # Example:
60
+ # `"displayName,postalCodeArea.regionCode"`.
61
+ class UpdateRegionRequest
62
+ include ::Google::Protobuf::MessageExts
63
+ extend ::Google::Protobuf::MessageExts::ClassMethods
64
+ end
65
+
66
+ # Request message for the `DeleteRegion` method.
67
+ # @!attribute [rw] name
68
+ # @return [::String]
69
+ # Required. The name of the region to delete.
70
+ # Format: `accounts/{account}/regions/{region}`
71
+ class DeleteRegionRequest
72
+ include ::Google::Protobuf::MessageExts
73
+ extend ::Google::Protobuf::MessageExts::ClassMethods
74
+ end
75
+
76
+ # Request message for the `ListRegions` method.
77
+ # @!attribute [rw] parent
78
+ # @return [::String]
79
+ # Required. The account to list regions for.
80
+ # Format: `accounts/{account}`
81
+ # @!attribute [rw] page_size
82
+ # @return [::Integer]
83
+ # Optional. The maximum number of regions to return. The service may return
84
+ # fewer than this value.
85
+ # If unspecified, at most 50 regions will be returned.
86
+ # The maximum value is 1000; values above 1000 will be coerced to 1000.
87
+ # @!attribute [rw] page_token
88
+ # @return [::String]
89
+ # Optional. A page token, received from a previous `ListRegions` call.
90
+ # Provide this to retrieve the subsequent page.
91
+ #
92
+ # When paginating, all other parameters provided to `ListRegions` must
93
+ # match the call that provided the page token.
94
+ class ListRegionsRequest
95
+ include ::Google::Protobuf::MessageExts
96
+ extend ::Google::Protobuf::MessageExts::ClassMethods
97
+ end
98
+
99
+ # Response message for the `ListRegions` method.
100
+ # @!attribute [rw] regions
101
+ # @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::Region>]
102
+ # The regions from the specified merchant.
103
+ # @!attribute [rw] next_page_token
104
+ # @return [::String]
105
+ # A token, which can be sent as `page_token` to retrieve the next page.
106
+ # If this field is omitted, there are no subsequent pages.
107
+ class ListRegionsResponse
108
+ include ::Google::Protobuf::MessageExts
109
+ extend ::Google::Protobuf::MessageExts::ClassMethods
110
+ end
111
+
112
+ # Represents a geographic region that you can use as a target with both the
113
+ # `RegionalInventory` and `ShippingSettings` services. You can define regions
114
+ # as collections of either postal codes or, in some countries, using predefined
115
+ # geotargets. For more information, see [Set up regions
116
+ # ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region)
117
+ # for more information.
118
+ # @!attribute [rw] name
119
+ # @return [::String]
120
+ # Identifier. The resource name of the region.
121
+ # Format: `accounts/{account}/regions/{region}`
122
+ # @!attribute [rw] display_name
123
+ # @return [::String]
124
+ # Optional. The display name of the region.
125
+ # @!attribute [rw] postal_code_area
126
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::Region::PostalCodeArea]
127
+ # Optional. A list of postal codes that defines the region area.
128
+ # @!attribute [rw] geotarget_area
129
+ # @return [::Google::Shopping::Merchant::Accounts::V1beta::Region::GeoTargetArea]
130
+ # Optional. A list of geotargets that defines the region area.
131
+ # @!attribute [r] regional_inventory_eligible
132
+ # @return [::Google::Protobuf::BoolValue]
133
+ # Output only. Indicates if the region is eligible for use in the Regional
134
+ # Inventory configuration.
135
+ # @!attribute [r] shipping_eligible
136
+ # @return [::Google::Protobuf::BoolValue]
137
+ # Output only. Indicates if the region is eligible for use in the Shipping
138
+ # Services configuration.
139
+ class Region
140
+ include ::Google::Protobuf::MessageExts
141
+ extend ::Google::Protobuf::MessageExts::ClassMethods
142
+
143
+ # A list of postal codes that defines the region area.
144
+ # Note: All regions defined using postal codes are accessible through the
145
+ # account's `ShippingSettings.postalCodeGroups` resource.
146
+ # @!attribute [rw] region_code
147
+ # @return [::String]
148
+ # Required. [CLDR territory
149
+ # code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)
150
+ # or the country the postal code group applies to.
151
+ # @!attribute [rw] postal_codes
152
+ # @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::Region::PostalCodeArea::PostalCodeRange>]
153
+ # Required. A range of postal codes.
154
+ class PostalCodeArea
155
+ include ::Google::Protobuf::MessageExts
156
+ extend ::Google::Protobuf::MessageExts::ClassMethods
157
+
158
+ # A range of postal codes that defines the region area.
159
+ # @!attribute [rw] begin
160
+ # @return [::String]
161
+ # Required. A postal code or a pattern of the form prefix* denoting the
162
+ # inclusive lower bound of the range defining the area. Examples values:
163
+ # `94108`, `9410*`, `9*`.
164
+ # @!attribute [rw] end
165
+ # @return [::String]
166
+ # Optional. A postal code or a pattern of the form `prefix*` denoting the
167
+ # inclusive upper bound of the range defining the area. It must have the
168
+ # same length as postalCodeRangeBegin: if postalCodeRangeBegin is a
169
+ # postal code then postalCodeRangeEnd must be a postal code too; if
170
+ # postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a
171
+ # pattern with the same prefix length. Optional: if not set, then the
172
+ # area is defined as being all the postal codes matching
173
+ # postalCodeRangeBegin.
174
+ class PostalCodeRange
175
+ include ::Google::Protobuf::MessageExts
176
+ extend ::Google::Protobuf::MessageExts::ClassMethods
177
+ end
178
+ end
179
+
180
+ # A list of geotargets that defines the region area.
181
+ # @!attribute [rw] geotarget_criteria_ids
182
+ # @return [::Array<::Integer>]
183
+ # Required. A non-empty list of [location
184
+ # IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting).
185
+ # They must all be of the same location type (for example, state).
186
+ class GeoTargetArea
187
+ include ::Google::Protobuf::MessageExts
188
+ extend ::Google::Protobuf::MessageExts::ClassMethods
189
+ end
190
+ end
191
+ end
192
+ end
193
+ end
194
+ end
195
+ end