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

data/proto_docs/google/shopping/merchant/accounts/v1beta/tax_rule.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Shopping
+    module Merchant
+      module Accounts
+        module V1beta
+          # Primary type convension
+          #
+          # percent micro : 100% = 1 000 000 and 1% = 10 000
+          #                 cannot be negative.
+          #
+          # Information about tax nexus and related parameters applicable to orders
+          # delivered to the area covered by a single tax admin. Nexus is created when a
+          # merchant is doing business in an area administered by tax admin (only US
+          # states are supported for nexus configuration). If merchant has nexus in a US
+          # state, merchant needs to pay tax to all tax authorities associated with
+          # the shipping destination.
+          # Next Id : 8
+          # @!attribute [rw] location_id
+          #   @return [::Integer]
+          #     The admin_id or criteria_id of the region in which this rule is
+          #     applicable.
+          # @!attribute [rw] post_code_range
+          #   @return [::Google::Shopping::Merchant::Accounts::V1beta::TaxRule::TaxPostalCodeRange]
+          #     The range of postal codes in which this rule is applicable.
+          # @!attribute [rw] use_google_rate
+          #   @return [::Boolean]
+          #     Rate that depends on delivery location: if merchant has a nexus in
+          #     corresponding US state, rates from authorities with jurisdiction over
+          #     delivery area are added up.
+          # @!attribute [rw] self_specified_rate_micros
+          #   @return [::Integer]
+          #     A fixed rate specified in micros, where 100% = 1_000_000.
+          #     Suitable for origin-based states.
+          # @!attribute [rw] region_code
+          #   @return [::String]
+          #     Region code in which this rule is applicable
+          # @!attribute [rw] shipping_taxed
+          #   @return [::Boolean]
+          #     If set, shipping charge is taxed (at the same rate as product) when
+          #     delivering to this admin's area.
+          #     Can only be set on US states without category.
+          # @!attribute [rw] effective_time_period
+          #   @return [::Google::Type::Interval]
+          #     Required. Time period when this rule is effective. If the duration is
+          #     missing from effective_time listed, then it is open ended to the future.
+          #     The start of this time period is inclusive, and the end is exclusive.
+          class TaxRule
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # A range of postal codes that defines the area.
+            # @!attribute [rw] start
+            #   @return [::String]
+            #     Required. The start of the postal code range, which is also the smallest
+            #     in the range.
+            # @!attribute [rw] end
+            #   @return [::String]
+            #     The end of the postal code range. Will be the same as start if not
+            #     specified.
+            class TaxPostalCodeRange
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/shopping/merchant/accounts/v1beta/termsofservice.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Shopping
+    module Merchant
+      module Accounts
+        module V1beta
+          # A `TermsOfService`.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Identifier. The resource name of the terms of service version.
+          #     Format: `termsOfService/{version}`
+          # @!attribute [rw] region_code
+          #   @return [::String]
+          #     Region code as defined by [CLDR](https://cldr.unicode.org/). This is either
+          #     a country where the ToS applies specifically to that country or `001` when
+          #     the same `TermsOfService` can be signed in any country. However note that
+          #     when signing a ToS that applies globally we still expect that a specific
+          #     country is provided  (this should be merchant business country or program
+          #     country of participation).
+          # @!attribute [rw] kind
+          #   @return [::Google::Shopping::Merchant::Accounts::V1beta::TermsOfServiceKind]
+          #     The Kind this terms of service version applies to.
+          # @!attribute [rw] file_uri
+          #   @return [::String]
+          #     URI for terms of service file that needs to be displayed to signing users.
+          # @!attribute [rw] external
+          #   @return [::Boolean]
+          #     Whether this terms of service version is external. External terms of
+          #     service versions can only be agreed through external processes and not
+          #     directly by the merchant through UI or API.
+          class TermsOfService
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the `GetTermsOfService` method.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The resource name of the terms of service version.
+          #     Format: `termsOfService/{version}`
+          class GetTermsOfServiceRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the `RetrieveLatestTermsOfService` method.
+          # @!attribute [rw] region_code
+          #   @return [::String]
+          #     Region code as defined by [CLDR](https://cldr.unicode.org/). This is either
+          #     a country when the ToS applies specifically to that country or 001 when it
+          #     applies globally.
+          # @!attribute [rw] kind
+          #   @return [::Google::Shopping::Merchant::Accounts::V1beta::TermsOfServiceKind]
+          #     The Kind this terms of service version applies to.
+          class RetrieveLatestTermsOfServiceRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the `AcceptTermsOfService` method.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The resource name of the terms of service version.
+          #     Format: `termsOfService/{version}`
+          # @!attribute [rw] account
+          #   @return [::String]
+          #     Required. The account for which to accept the ToS.
+          # @!attribute [rw] region_code
+          #   @return [::String]
+          #     Required. Region code as defined by [CLDR](https://cldr.unicode.org/). This
+          #     is either a country when the ToS applies specifically to that country or
+          #     001 when it applies globally.
+          class AcceptTermsOfServiceRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/shopping/merchant/accounts/v1beta/termsofserviceagreementstate.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Shopping
+    module Merchant
+      module Accounts
+        module V1beta
+          # This resource represents the agreement state for a given account and terms of
+          # service kind.
+          # The state is as follows:
+          #
+          # * If the merchant has accepted a terms of service:
+          # [accepted](TermsOfServiceAggrementState.accepted) will be populated,
+          # otherwise it will be empty
+          # * If the merchant must sign a terms of service:
+          # [required](TermsOfServiceAggrementState.required) will be populated,
+          # otherwise it will be empty.
+          #
+          # Note that both [required](TermsOfServiceAggrementState.required) and
+          # [accepted](TermsOfServiceAggrementState.accepted) can be present. In this
+          # case the `accepted` terms of services will have an expiration date set in the
+          # [valid_until](Accepted.valid_until) field. The `required` terms of services
+          # need to be accepted before `valid_until` in order for the account to continue
+          # having a valid agreement. When accepting new terms of services we expect 3Ps
+          # to display the text associated with the given terms of service agreement (the
+          # url to the file containing the text is added in the Required message below as
+          # [tos_file_uri](Accepted.tos_file_uri). The actual acceptance of the terms of
+          # service is done by calling accept on the [TermsOfService](TermsOfService)
+          # resource.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Identifier. The resource name of the terms of service version.
+          #     Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}`
+          # @!attribute [rw] region_code
+          #   @return [::String]
+          #     Region code as defined by https://cldr.unicode.org/. This is the
+          #     country the current state applies to.
+          # @!attribute [rw] terms_of_service_kind
+          #   @return [::Google::Shopping::Merchant::Accounts::V1beta::TermsOfServiceKind]
+          #     Terms of Service kind associated with the particular version.
+          # @!attribute [rw] accepted
+          #   @return [::Google::Shopping::Merchant::Accounts::V1beta::Accepted]
+          #     The accepted terms of service of this kind and for the associated
+          #     region_code
+          # @!attribute [rw] required
+          #   @return [::Google::Shopping::Merchant::Accounts::V1beta::Required]
+          #     The required terms of service
+          class TermsOfServiceAgreementState
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Describes the accepted terms of service.
+          # @!attribute [rw] terms_of_service
+          #   @return [::String]
+          #     The accepted
+          #     [termsOfService](google.shopping.merchant.accounts.v1main.TermsOfService).
+          # @!attribute [rw] accepted_by
+          #   @return [::String]
+          #     The account where the acceptance was recorded. This can be the account
+          #     itself or, in the case of subaccounts, the MCA account.
+          # @!attribute [rw] valid_until
+          #   @return [::Google::Type::Date]
+          #     When set, it states that the accepted
+          #     [TermsOfService](google.shopping.merchant.accounts.v1main.TermsOfService)
+          #     is only valid until the end of this date (in UTC). A new one must be
+          #     accepted before then. The information of the required
+          #     [TermsOfService](google.shopping.merchant.accounts.v1main.TermsOfService)
+          #     is found in the [Required](Required) message.
+          class Accepted
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Describes the terms of service which are required to be accepted.
+          # @!attribute [rw] terms_of_service
+          #   @return [::String]
+          #     The
+          #     [termsOfService](google.shopping.merchant.accounts.v1main.TermsOfService)
+          #     that need to be accepted.
+          # @!attribute [rw] tos_file_uri
+          #   @return [::String]
+          #     Full URL to the terms of service file. This field is the same as
+          #     [TermsOfService.file_uri](TermsOfService.file_uri), it is added
+          #     here for convenience only.
+          class Required
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the `GetTermsOfServiceAgreementState` method.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The resource name of the terms of service version.
+          #     Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}`
+          class GetTermsOfServiceAgreementStateRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the `RetrieveForApplicationTermsOfServiceAgreementState`
+          # method.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The account for which to get a TermsOfServiceAgreementState
+          #     Format: `accounts/{account}`
+          class RetrieveForApplicationTermsOfServiceAgreementStateRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/shopping/merchant/accounts/v1beta/termsofservicekind.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Shopping
+    module Merchant
+      module Accounts
+        module V1beta
+          # The TermsOfService Kind.
+          module TermsOfServiceKind
+            # Default value. This value is unused.
+            TERMS_OF_SERVICE_KIND_UNSPECIFIED = 0
+
+            # Merchant Center application.
+            MERCHANT_CENTER = 1
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/shopping/merchant/accounts/v1beta/user.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Shopping
+    module Merchant
+      module Accounts
+        module V1beta
+          # A [user](https://support.google.com/merchants/answer/12160472).
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Identifier. The resource name of the user.
+          #     Format: `accounts/{account}/user/{email}`
+          #
+          #     Use `me` to refer to your own email address, for example
+          #     `accounts/{account}/users/me`.
+          # @!attribute [r] state
+          #   @return [::Google::Shopping::Merchant::Accounts::V1beta::User::State]
+          #     Output only. The state of the user.
+          # @!attribute [rw] access_rights
+          #   @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::AccessRight>]
+          #     Optional. The [access
+          #     rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes)
+          #     the user has.
+          class User
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The possible states of a user.
+            module State
+              # Default value. This value is unused.
+              STATE_UNSPECIFIED = 0
+
+              # The user is pending confirmation. In this state, the user first needs to
+              # accept the invitation before performing other actions.
+              PENDING = 1
+
+              # The user is verified.
+              VERIFIED = 2
+            end
+          end
+
+          # Request message for the `GetUser` method.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the user to retrieve.
+          #     Format: `accounts/{account}/users/{email}`
+          #
+          #     It is also possible to retrieve the user corresponding to the caller by
+          #     using `me` rather than an email address as in
+          #     `accounts/{account}/users/me`.
+          class GetUserRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the `CreateUser` method.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The resource name of the account for which a user will be
+          #     created. Format: `accounts/{account}`
+          # @!attribute [rw] user_id
+          #   @return [::String]
+          #     Required. The email address of the user (for example,
+          #     `john.doe@gmail.com`).
+          # @!attribute [rw] user
+          #   @return [::Google::Shopping::Merchant::Accounts::V1beta::User]
+          #     Required. The user to create.
+          class CreateUserRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the `DeleteUser` method.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the user to delete.
+          #     Format: `accounts/{account}/users/{email}`
+          #
+          #     It is also possible to delete the user corresponding to the caller by using
+          #     `me` rather than an email address as in `accounts/{account}/users/me`.
+          class DeleteUserRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the `UpdateUser` method.
+          # @!attribute [rw] user
+          #   @return [::Google::Shopping::Merchant::Accounts::V1beta::User]
+          #     Required. The new version of the user.
+          #
+          #     Use `me` to refer to your own email address, for example
+          #     `accounts/{account}/users/me`.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     Required. List of fields being updated.
+          class UpdateUserRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for the `ListUsers` method.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The parent, which owns this collection of users.
+          #     Format: `accounts/{account}`
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     Optional. The maximum number of users to return. The service may return
+          #     fewer than this value. If unspecified, at most 50 users will be returned.
+          #     The maximum value is 100; values above 100 will be coerced to 100
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     Optional. A page token, received from a previous `ListUsers` call.
+          #     Provide this to retrieve the subsequent page.
+          #
+          #     When paginating, all other parameters provided to `ListUsers` must match
+          #     the call that provided the page token.
+          class ListUsersRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response message for the `ListUsers` method.
+          # @!attribute [rw] users
+          #   @return [::Array<::Google::Shopping::Merchant::Accounts::V1beta::User>]
+          #     The users from the specified account.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     A token, which can be sent as `page_token` to retrieve the next page.
+          #     If this field is omitted, there are no subsequent pages.
+          class ListUsersResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end