diff --git a/packages/google-shopping-merchant-issueresolution/docs/index.rst b/packages/google-shopping-merchant-issueresolution/docs/index.rst index 15f3da04efab..3e07beaef86b 100644 --- a/packages/google-shopping-merchant-issueresolution/docs/index.rst +++ b/packages/google-shopping-merchant-issueresolution/docs/index.rst @@ -2,6 +2,9 @@ .. include:: multiprocessing.rst +This package includes clients for multiple versions of Merchant API. +By default, you will get version ``merchant_issueresolution_v1beta``. + API Reference ------------- @@ -11,6 +14,14 @@ API Reference merchant_issueresolution_v1beta/services_ merchant_issueresolution_v1beta/types_ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + merchant_issueresolution_v1/services_ + merchant_issueresolution_v1/types_ + Changelog --------- diff --git a/packages/google-shopping-merchant-issueresolution/docs/merchant_issueresolution_v1/aggregate_product_statuses_service.rst b/packages/google-shopping-merchant-issueresolution/docs/merchant_issueresolution_v1/aggregate_product_statuses_service.rst new file mode 100644 index 000000000000..ec070f91ef87 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/docs/merchant_issueresolution_v1/aggregate_product_statuses_service.rst @@ -0,0 +1,10 @@ +AggregateProductStatusesService +------------------------------------------------- + +.. automodule:: google.shopping.merchant_issueresolution_v1.services.aggregate_product_statuses_service + :members: + :inherited-members: + +.. automodule:: google.shopping.merchant_issueresolution_v1.services.aggregate_product_statuses_service.pagers + :members: + :inherited-members: diff --git a/packages/google-shopping-merchant-issueresolution/docs/merchant_issueresolution_v1/issue_resolution_service.rst b/packages/google-shopping-merchant-issueresolution/docs/merchant_issueresolution_v1/issue_resolution_service.rst new file mode 100644 index 000000000000..8260be8dd42a --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/docs/merchant_issueresolution_v1/issue_resolution_service.rst @@ -0,0 +1,6 @@ +IssueResolutionService +---------------------------------------- + +.. automodule:: google.shopping.merchant_issueresolution_v1.services.issue_resolution_service + :members: + :inherited-members: diff --git a/packages/google-shopping-merchant-issueresolution/docs/merchant_issueresolution_v1/services_.rst b/packages/google-shopping-merchant-issueresolution/docs/merchant_issueresolution_v1/services_.rst new file mode 100644 index 000000000000..bf3609f2c653 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/docs/merchant_issueresolution_v1/services_.rst @@ -0,0 +1,7 @@ +Services for Google Shopping Merchant Issueresolution v1 API +============================================================ +.. toctree:: + :maxdepth: 2 + + aggregate_product_statuses_service + issue_resolution_service diff --git a/packages/google-shopping-merchant-issueresolution/docs/merchant_issueresolution_v1/types_.rst b/packages/google-shopping-merchant-issueresolution/docs/merchant_issueresolution_v1/types_.rst new file mode 100644 index 000000000000..a296fa618394 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/docs/merchant_issueresolution_v1/types_.rst @@ -0,0 +1,6 @@ +Types for Google Shopping Merchant Issueresolution v1 API +========================================================= + +.. automodule:: google.shopping.merchant_issueresolution_v1.types + :members: + :show-inheritance: diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/__init__.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/__init__.py new file mode 100644 index 000000000000..d13282da7acd --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/__init__.py @@ -0,0 +1,93 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +from google.shopping.merchant_issueresolution_v1 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.aggregate_product_statuses_service import ( + AggregateProductStatusesServiceAsyncClient, + AggregateProductStatusesServiceClient, +) +from .services.issue_resolution_service import ( + IssueResolutionServiceAsyncClient, + IssueResolutionServiceClient, +) +from .types.aggregateproductstatuses import ( + AggregateProductStatus, + ListAggregateProductStatusesRequest, + ListAggregateProductStatusesResponse, +) +from .types.issueresolution import ( + Action, + ActionFlow, + ActionInput, + Breakdown, + BuiltInSimpleAction, + BuiltInUserInputAction, + Callout, + ContentOption, + ExternalAction, + Impact, + InputField, + InputValue, + RenderAccountIssuesRequest, + RenderAccountIssuesResponse, + RenderedIssue, + RenderIssuesRequestPayload, + RenderProductIssuesRequest, + RenderProductIssuesResponse, + Severity, + TextWithTooltip, + TriggerActionPayload, + TriggerActionRequest, + TriggerActionResponse, + UserInputActionRenderingOption, +) + +__all__ = ( + "AggregateProductStatusesServiceAsyncClient", + "IssueResolutionServiceAsyncClient", + "Action", + "ActionFlow", + "ActionInput", + "AggregateProductStatus", + "AggregateProductStatusesServiceClient", + "Breakdown", + "BuiltInSimpleAction", + "BuiltInUserInputAction", + "Callout", + "ContentOption", + "ExternalAction", + "Impact", + "InputField", + "InputValue", + "IssueResolutionServiceClient", + "ListAggregateProductStatusesRequest", + "ListAggregateProductStatusesResponse", + "RenderAccountIssuesRequest", + "RenderAccountIssuesResponse", + "RenderIssuesRequestPayload", + "RenderProductIssuesRequest", + "RenderProductIssuesResponse", + "RenderedIssue", + "Severity", + "TextWithTooltip", + "TriggerActionPayload", + "TriggerActionRequest", + "TriggerActionResponse", + "UserInputActionRenderingOption", +) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/gapic_metadata.json b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/gapic_metadata.json new file mode 100644 index 000000000000..e46f28ac19c8 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/gapic_metadata.json @@ -0,0 +1,107 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.shopping.merchant_issueresolution_v1", + "protoPackage": "google.shopping.merchant.issueresolution.v1", + "schema": "1.0", + "services": { + "AggregateProductStatusesService": { + "clients": { + "grpc": { + "libraryClient": "AggregateProductStatusesServiceClient", + "rpcs": { + "ListAggregateProductStatuses": { + "methods": [ + "list_aggregate_product_statuses" + ] + } + } + }, + "grpc-async": { + "libraryClient": "AggregateProductStatusesServiceAsyncClient", + "rpcs": { + "ListAggregateProductStatuses": { + "methods": [ + "list_aggregate_product_statuses" + ] + } + } + }, + "rest": { + "libraryClient": "AggregateProductStatusesServiceClient", + "rpcs": { + "ListAggregateProductStatuses": { + "methods": [ + "list_aggregate_product_statuses" + ] + } + } + } + } + }, + "IssueResolutionService": { + "clients": { + "grpc": { + "libraryClient": "IssueResolutionServiceClient", + "rpcs": { + "RenderAccountIssues": { + "methods": [ + "render_account_issues" + ] + }, + "RenderProductIssues": { + "methods": [ + "render_product_issues" + ] + }, + "TriggerAction": { + "methods": [ + "trigger_action" + ] + } + } + }, + "grpc-async": { + "libraryClient": "IssueResolutionServiceAsyncClient", + "rpcs": { + "RenderAccountIssues": { + "methods": [ + "render_account_issues" + ] + }, + "RenderProductIssues": { + "methods": [ + "render_product_issues" + ] + }, + "TriggerAction": { + "methods": [ + "trigger_action" + ] + } + } + }, + "rest": { + "libraryClient": "IssueResolutionServiceClient", + "rpcs": { + "RenderAccountIssues": { + "methods": [ + "render_account_issues" + ] + }, + "RenderProductIssues": { + "methods": [ + "render_product_issues" + ] + }, + "TriggerAction": { + "methods": [ + "trigger_action" + ] + } + } + } + } + } + } +} diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/gapic_version.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/gapic_version.py new file mode 100644 index 000000000000..20a9cd975b02 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +__version__ = "0.0.0" # {x-release-please-version} diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/py.typed b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/py.typed new file mode 100644 index 000000000000..f09807d30972 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-shopping-merchant-issueresolution package uses inline types. diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/__init__.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/__init__.py new file mode 100644 index 000000000000..cbf94b283c70 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/__init__.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/__init__.py new file mode 100644 index 000000000000..0fc6ec3f34b0 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +from .async_client import AggregateProductStatusesServiceAsyncClient +from .client import AggregateProductStatusesServiceClient + +__all__ = ( + "AggregateProductStatusesServiceClient", + "AggregateProductStatusesServiceAsyncClient", +) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/async_client.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/async_client.py new file mode 100644 index 000000000000..c239040cb2a7 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/async_client.py @@ -0,0 +1,461 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +from collections import OrderedDict +import logging as std_logging +import re +from typing import ( + Callable, + Dict, + Mapping, + MutableMapping, + MutableSequence, + Optional, + Sequence, + Tuple, + Type, + Union, +) + +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry_async as retries +from google.api_core.client_options import ClientOptions +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore +import google.protobuf + +from google.shopping.merchant_issueresolution_v1 import gapic_version as package_version + +try: + OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore + +from google.shopping.merchant_issueresolution_v1.services.aggregate_product_statuses_service import ( + pagers, +) +from google.shopping.merchant_issueresolution_v1.types import aggregateproductstatuses + +from .client import AggregateProductStatusesServiceClient +from .transports.base import ( + DEFAULT_CLIENT_INFO, + AggregateProductStatusesServiceTransport, +) +from .transports.grpc_asyncio import AggregateProductStatusesServiceGrpcAsyncIOTransport + +try: + from google.api_core import client_logging # type: ignore + + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + + +class AggregateProductStatusesServiceAsyncClient: + """Service to manage aggregate product statuses.""" + + _client: AggregateProductStatusesServiceClient + + # Copy defaults from the synchronous client for use here. + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = AggregateProductStatusesServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = AggregateProductStatusesServiceClient.DEFAULT_MTLS_ENDPOINT + _DEFAULT_ENDPOINT_TEMPLATE = ( + AggregateProductStatusesServiceClient._DEFAULT_ENDPOINT_TEMPLATE + ) + _DEFAULT_UNIVERSE = AggregateProductStatusesServiceClient._DEFAULT_UNIVERSE + + aggregate_product_status_path = staticmethod( + AggregateProductStatusesServiceClient.aggregate_product_status_path + ) + parse_aggregate_product_status_path = staticmethod( + AggregateProductStatusesServiceClient.parse_aggregate_product_status_path + ) + common_billing_account_path = staticmethod( + AggregateProductStatusesServiceClient.common_billing_account_path + ) + parse_common_billing_account_path = staticmethod( + AggregateProductStatusesServiceClient.parse_common_billing_account_path + ) + common_folder_path = staticmethod( + AggregateProductStatusesServiceClient.common_folder_path + ) + parse_common_folder_path = staticmethod( + AggregateProductStatusesServiceClient.parse_common_folder_path + ) + common_organization_path = staticmethod( + AggregateProductStatusesServiceClient.common_organization_path + ) + parse_common_organization_path = staticmethod( + AggregateProductStatusesServiceClient.parse_common_organization_path + ) + common_project_path = staticmethod( + AggregateProductStatusesServiceClient.common_project_path + ) + parse_common_project_path = staticmethod( + AggregateProductStatusesServiceClient.parse_common_project_path + ) + common_location_path = staticmethod( + AggregateProductStatusesServiceClient.common_location_path + ) + parse_common_location_path = staticmethod( + AggregateProductStatusesServiceClient.parse_common_location_path + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + AggregateProductStatusesServiceAsyncClient: The constructed client. + """ + return AggregateProductStatusesServiceClient.from_service_account_info.__func__(AggregateProductStatusesServiceAsyncClient, info, *args, **kwargs) # type: ignore + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + AggregateProductStatusesServiceAsyncClient: The constructed client. + """ + return AggregateProductStatusesServiceClient.from_service_account_file.__func__(AggregateProductStatusesServiceAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source( + cls, client_options: Optional[ClientOptions] = None + ): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return AggregateProductStatusesServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> AggregateProductStatusesServiceTransport: + """Returns the transport used by the client instance. + + Returns: + AggregateProductStatusesServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + @property + def api_endpoint(self): + """Return the API endpoint used by the client instance. + + Returns: + str: The API endpoint used by the client instance. + """ + return self._client._api_endpoint + + @property + def universe_domain(self) -> str: + """Return the universe domain used by the client instance. + + Returns: + str: The universe domain used + by the client instance. + """ + return self._client._universe_domain + + get_transport_class = AggregateProductStatusesServiceClient.get_transport_class + + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[ + Union[ + str, + AggregateProductStatusesServiceTransport, + Callable[..., AggregateProductStatusesServiceTransport], + ] + ] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the aggregate product statuses service async client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Optional[Union[str,AggregateProductStatusesServiceTransport,Callable[..., AggregateProductStatusesServiceTransport]]]): + The transport to use, or a Callable that constructs and returns a new transport to use. + If a Callable is given, it will be called with the same set of initialization + arguments as used in the AggregateProductStatusesServiceTransport constructor. + If set to None, a transport is chosen automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): + Custom options for the client. + + 1. The ``api_endpoint`` property can be used to override the + default endpoint provided by the client when ``transport`` is + not explicitly provided. Only if this property is not set and + ``transport`` was not explicitly provided, the endpoint is + determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment + variable, which have one of the following values: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto-switch to the + default mTLS endpoint if client certificate is present; this is + the default value). + + 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide a client certificate for mTLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + 3. The ``universe_domain`` property can be used to override the + default "googleapis.com" universe. Note that ``api_endpoint`` + property still takes precedence; and ``universe_domain`` is + currently not supported for mTLS. + + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client = AggregateProductStatusesServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ): # pragma: NO COVER + _LOGGER.debug( + "Created client `google.shopping.merchant.issueresolution_v1.AggregateProductStatusesServiceAsyncClient`.", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.AggregateProductStatusesService", + "universeDomain": getattr( + self._client._transport._credentials, "universe_domain", "" + ), + "credentialsType": f"{type(self._client._transport._credentials).__module__}.{type(self._client._transport._credentials).__qualname__}", + "credentialsInfo": getattr( + self.transport._credentials, "get_cred_info", lambda: None + )(), + } + if hasattr(self._client._transport, "_credentials") + else { + "serviceName": "google.shopping.merchant.issueresolution.v1.AggregateProductStatusesService", + "credentialsType": None, + }, + ) + + async def list_aggregate_product_statuses( + self, + request: Optional[ + Union[aggregateproductstatuses.ListAggregateProductStatusesRequest, dict] + ] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> pagers.ListAggregateProductStatusesAsyncPager: + r"""Lists the ``AggregateProductStatuses`` resources for your + merchant account. The response might contain fewer items than + specified by ``pageSize``. If ``pageToken`` was returned in + previous request, it can be used to obtain additional results. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.shopping import merchant_issueresolution_v1 + + async def sample_list_aggregate_product_statuses(): + # Create a client + client = merchant_issueresolution_v1.AggregateProductStatusesServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_issueresolution_v1.ListAggregateProductStatusesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_aggregate_product_statuses(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.shopping.merchant_issueresolution_v1.types.ListAggregateProductStatusesRequest, dict]]): + The request object. Request message for the ``ListAggregateProductStatuses`` + method. + parent (:class:`str`): + Required. The account to list aggregate product statuses + for. Format: ``accounts/{account}`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.shopping.merchant_issueresolution_v1.services.aggregate_product_statuses_service.pagers.ListAggregateProductStatusesAsyncPager: + Response message for the ListAggregateProductStatuses + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [parent] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance( + request, aggregateproductstatuses.ListAggregateProductStatusesRequest + ): + request = aggregateproductstatuses.ListAggregateProductStatusesRequest( + request + ) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[ + self._client._transport.list_aggregate_product_statuses + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__aiter__` convenience method. + response = pagers.ListAggregateProductStatusesAsyncPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def __aenter__(self) -> "AggregateProductStatusesServiceAsyncClient": + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +__all__ = ("AggregateProductStatusesServiceAsyncClient",) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/client.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/client.py new file mode 100644 index 000000000000..cc8f70b6e1d8 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/client.py @@ -0,0 +1,890 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +from collections import OrderedDict +from http import HTTPStatus +import json +import logging as std_logging +import os +import re +from typing import ( + Callable, + Dict, + Mapping, + MutableMapping, + MutableSequence, + Optional, + Sequence, + Tuple, + Type, + Union, + cast, +) +import warnings + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.oauth2 import service_account # type: ignore +import google.protobuf + +from google.shopping.merchant_issueresolution_v1 import gapic_version as package_version + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + +try: + from google.api_core import client_logging # type: ignore + + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + +from google.shopping.merchant_issueresolution_v1.services.aggregate_product_statuses_service import ( + pagers, +) +from google.shopping.merchant_issueresolution_v1.types import aggregateproductstatuses + +from .transports.base import ( + DEFAULT_CLIENT_INFO, + AggregateProductStatusesServiceTransport, +) +from .transports.grpc import AggregateProductStatusesServiceGrpcTransport +from .transports.grpc_asyncio import AggregateProductStatusesServiceGrpcAsyncIOTransport +from .transports.rest import AggregateProductStatusesServiceRestTransport + + +class AggregateProductStatusesServiceClientMeta(type): + """Metaclass for the AggregateProductStatusesService client. + + This provides class-level methods for building and retrieving + support objects (e.g. transport) without polluting the client instance + objects. + """ + + _transport_registry = ( + OrderedDict() + ) # type: Dict[str, Type[AggregateProductStatusesServiceTransport]] + _transport_registry["grpc"] = AggregateProductStatusesServiceGrpcTransport + _transport_registry[ + "grpc_asyncio" + ] = AggregateProductStatusesServiceGrpcAsyncIOTransport + _transport_registry["rest"] = AggregateProductStatusesServiceRestTransport + + def get_transport_class( + cls, + label: Optional[str] = None, + ) -> Type[AggregateProductStatusesServiceTransport]: + """Returns an appropriate transport class. + + Args: + label: The name of the desired transport. If none is + provided, then the first transport in the registry is used. + + Returns: + The transport class to use. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class AggregateProductStatusesServiceClient( + metaclass=AggregateProductStatusesServiceClientMeta +): + """Service to manage aggregate product statuses.""" + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = "merchantapi.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + _DEFAULT_ENDPOINT_TEMPLATE = "merchantapi.{UNIVERSE_DOMAIN}" + _DEFAULT_UNIVERSE = "googleapis.com" + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + AggregateProductStatusesServiceClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_info(info) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + AggregateProductStatusesServiceClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_file(filename) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> AggregateProductStatusesServiceTransport: + """Returns the transport used by the client instance. + + Returns: + AggregateProductStatusesServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def aggregate_product_status_path( + account: str, + aggregate_product_status: str, + ) -> str: + """Returns a fully-qualified aggregate_product_status string.""" + return "accounts/{account}/aggregateProductStatuses/{aggregate_product_status}".format( + account=account, + aggregate_product_status=aggregate_product_status, + ) + + @staticmethod + def parse_aggregate_product_status_path(path: str) -> Dict[str, str]: + """Parses a aggregate_product_status path into its component segments.""" + m = re.match( + r"^accounts/(?P.+?)/aggregateProductStatuses/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path( + billing_account: str, + ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str, str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path( + folder: str, + ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format( + folder=folder, + ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str, str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path( + organization: str, + ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format( + organization=organization, + ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str, str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path( + project: str, + ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format( + project=project, + ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str, str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path( + project: str, + location: str, + ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format( + project=project, + location=location, + ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str, str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source( + cls, client_options: Optional[client_options_lib.ClientOptions] = None + ): + """Deprecated. Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + + warnings.warn( + "get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.", + DeprecationWarning, + ) + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError( + "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError( + "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or ( + use_mtls_endpoint == "auto" and client_cert_source + ): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + @staticmethod + def _read_environment_variables(): + """Returns the environment variables used by the client. + + Returns: + Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE, + GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables. + + Raises: + ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not + any of ["true", "false"]. + google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT + is not any of ["auto", "never", "always"]. + """ + use_client_cert = os.getenv( + "GOOGLE_API_USE_CLIENT_CERTIFICATE", "false" + ).lower() + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower() + universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN") + if use_client_cert not in ("true", "false"): + raise ValueError( + "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError( + "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + return use_client_cert == "true", use_mtls_endpoint, universe_domain_env + + @staticmethod + def _get_client_cert_source(provided_cert_source, use_cert_flag): + """Return the client cert source to be used by the client. + + Args: + provided_cert_source (bytes): The client certificate source provided. + use_cert_flag (bool): A flag indicating whether to use the client certificate. + + Returns: + bytes or None: The client cert source to be used by the client. + """ + client_cert_source = None + if use_cert_flag: + if provided_cert_source: + client_cert_source = provided_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + return client_cert_source + + @staticmethod + def _get_api_endpoint( + api_override, client_cert_source, universe_domain, use_mtls_endpoint + ): + """Return the API endpoint used by the client. + + Args: + api_override (str): The API endpoint override. If specified, this is always + the return value of this function and the other arguments are not used. + client_cert_source (bytes): The client certificate source used by the client. + universe_domain (str): The universe domain used by the client. + use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters. + Possible values are "always", "auto", or "never". + + Returns: + str: The API endpoint to be used by the client. + """ + if api_override is not None: + api_endpoint = api_override + elif use_mtls_endpoint == "always" or ( + use_mtls_endpoint == "auto" and client_cert_source + ): + _default_universe = AggregateProductStatusesServiceClient._DEFAULT_UNIVERSE + if universe_domain != _default_universe: + raise MutualTLSChannelError( + f"mTLS is not supported in any universe other than {_default_universe}." + ) + api_endpoint = AggregateProductStatusesServiceClient.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = ( + AggregateProductStatusesServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=universe_domain + ) + ) + return api_endpoint + + @staticmethod + def _get_universe_domain( + client_universe_domain: Optional[str], universe_domain_env: Optional[str] + ) -> str: + """Return the universe domain used by the client. + + Args: + client_universe_domain (Optional[str]): The universe domain configured via the client options. + universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable. + + Returns: + str: The universe domain to be used by the client. + + Raises: + ValueError: If the universe domain is an empty string. + """ + universe_domain = AggregateProductStatusesServiceClient._DEFAULT_UNIVERSE + if client_universe_domain is not None: + universe_domain = client_universe_domain + elif universe_domain_env is not None: + universe_domain = universe_domain_env + if len(universe_domain.strip()) == 0: + raise ValueError("Universe Domain cannot be an empty string.") + return universe_domain + + def _validate_universe_domain(self): + """Validates client's and credentials' universe domains are consistent. + + Returns: + bool: True iff the configured universe domain is valid. + + Raises: + ValueError: If the configured universe domain is not valid. + """ + + # NOTE (b/349488459): universe validation is disabled until further notice. + return True + + def _add_cred_info_for_auth_errors( + self, error: core_exceptions.GoogleAPICallError + ) -> None: + """Adds credential info string to error details for 401/403/404 errors. + + Args: + error (google.api_core.exceptions.GoogleAPICallError): The error to add the cred info. + """ + if error.code not in [ + HTTPStatus.UNAUTHORIZED, + HTTPStatus.FORBIDDEN, + HTTPStatus.NOT_FOUND, + ]: + return + + cred = self._transport._credentials + + # get_cred_info is only available in google-auth>=2.35.0 + if not hasattr(cred, "get_cred_info"): + return + + # ignore the type check since pypy test fails when get_cred_info + # is not available + cred_info = cred.get_cred_info() # type: ignore + if cred_info and hasattr(error._details, "append"): + error._details.append(json.dumps(cred_info)) + + @property + def api_endpoint(self): + """Return the API endpoint used by the client instance. + + Returns: + str: The API endpoint used by the client instance. + """ + return self._api_endpoint + + @property + def universe_domain(self) -> str: + """Return the universe domain used by the client instance. + + Returns: + str: The universe domain used by the client instance. + """ + return self._universe_domain + + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[ + Union[ + str, + AggregateProductStatusesServiceTransport, + Callable[..., AggregateProductStatusesServiceTransport], + ] + ] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the aggregate product statuses service client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Optional[Union[str,AggregateProductStatusesServiceTransport,Callable[..., AggregateProductStatusesServiceTransport]]]): + The transport to use, or a Callable that constructs and returns a new transport. + If a Callable is given, it will be called with the same set of initialization + arguments as used in the AggregateProductStatusesServiceTransport constructor. + If set to None, a transport is chosen automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): + Custom options for the client. + + 1. The ``api_endpoint`` property can be used to override the + default endpoint provided by the client when ``transport`` is + not explicitly provided. Only if this property is not set and + ``transport`` was not explicitly provided, the endpoint is + determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment + variable, which have one of the following values: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto-switch to the + default mTLS endpoint if client certificate is present; this is + the default value). + + 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide a client certificate for mTLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + 3. The ``universe_domain`` property can be used to override the + default "googleapis.com" universe. Note that the ``api_endpoint`` + property still takes precedence; and ``universe_domain`` is + currently not supported for mTLS. + + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client_options = client_options + if isinstance(self._client_options, dict): + self._client_options = client_options_lib.from_dict(self._client_options) + if self._client_options is None: + self._client_options = client_options_lib.ClientOptions() + self._client_options = cast( + client_options_lib.ClientOptions, self._client_options + ) + + universe_domain_opt = getattr(self._client_options, "universe_domain", None) + + ( + self._use_client_cert, + self._use_mtls_endpoint, + self._universe_domain_env, + ) = AggregateProductStatusesServiceClient._read_environment_variables() + self._client_cert_source = ( + AggregateProductStatusesServiceClient._get_client_cert_source( + self._client_options.client_cert_source, self._use_client_cert + ) + ) + self._universe_domain = ( + AggregateProductStatusesServiceClient._get_universe_domain( + universe_domain_opt, self._universe_domain_env + ) + ) + self._api_endpoint = None # updated below, depending on `transport` + + # Initialize the universe domain validation. + self._is_universe_domain_valid = False + + if CLIENT_LOGGING_SUPPORTED: # pragma: NO COVER + # Setup logging. + client_logging.initialize_logging() + + api_key_value = getattr(self._client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError( + "client_options.api_key and credentials are mutually exclusive" + ) + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + transport_provided = isinstance( + transport, AggregateProductStatusesServiceTransport + ) + if transport_provided: + # transport is a AggregateProductStatusesServiceTransport instance. + if credentials or self._client_options.credentials_file or api_key_value: + raise ValueError( + "When providing a transport instance, " + "provide its credentials directly." + ) + if self._client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = cast(AggregateProductStatusesServiceTransport, transport) + self._api_endpoint = self._transport.host + + self._api_endpoint = ( + self._api_endpoint + or AggregateProductStatusesServiceClient._get_api_endpoint( + self._client_options.api_endpoint, + self._client_cert_source, + self._universe_domain, + self._use_mtls_endpoint, + ) + ) + + if not transport_provided: + import google.auth._default # type: ignore + + if api_key_value and hasattr( + google.auth._default, "get_api_key_credentials" + ): + credentials = google.auth._default.get_api_key_credentials( + api_key_value + ) + + transport_init: Union[ + Type[AggregateProductStatusesServiceTransport], + Callable[..., AggregateProductStatusesServiceTransport], + ] = ( + AggregateProductStatusesServiceClient.get_transport_class(transport) + if isinstance(transport, str) or transport is None + else cast( + Callable[..., AggregateProductStatusesServiceTransport], transport + ) + ) + # initialize with the provided callable or the passed in class + self._transport = transport_init( + credentials=credentials, + credentials_file=self._client_options.credentials_file, + host=self._api_endpoint, + scopes=self._client_options.scopes, + client_cert_source_for_mtls=self._client_cert_source, + quota_project_id=self._client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=self._client_options.api_audience, + ) + + if "async" not in str(self._transport): + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ): # pragma: NO COVER + _LOGGER.debug( + "Created client `google.shopping.merchant.issueresolution_v1.AggregateProductStatusesServiceClient`.", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.AggregateProductStatusesService", + "universeDomain": getattr( + self._transport._credentials, "universe_domain", "" + ), + "credentialsType": f"{type(self._transport._credentials).__module__}.{type(self._transport._credentials).__qualname__}", + "credentialsInfo": getattr( + self.transport._credentials, "get_cred_info", lambda: None + )(), + } + if hasattr(self._transport, "_credentials") + else { + "serviceName": "google.shopping.merchant.issueresolution.v1.AggregateProductStatusesService", + "credentialsType": None, + }, + ) + + def list_aggregate_product_statuses( + self, + request: Optional[ + Union[aggregateproductstatuses.ListAggregateProductStatusesRequest, dict] + ] = None, + *, + parent: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> pagers.ListAggregateProductStatusesPager: + r"""Lists the ``AggregateProductStatuses`` resources for your + merchant account. The response might contain fewer items than + specified by ``pageSize``. If ``pageToken`` was returned in + previous request, it can be used to obtain additional results. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.shopping import merchant_issueresolution_v1 + + def sample_list_aggregate_product_statuses(): + # Create a client + client = merchant_issueresolution_v1.AggregateProductStatusesServiceClient() + + # Initialize request argument(s) + request = merchant_issueresolution_v1.ListAggregateProductStatusesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_aggregate_product_statuses(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.shopping.merchant_issueresolution_v1.types.ListAggregateProductStatusesRequest, dict]): + The request object. Request message for the ``ListAggregateProductStatuses`` + method. + parent (str): + Required. The account to list aggregate product statuses + for. Format: ``accounts/{account}`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.shopping.merchant_issueresolution_v1.services.aggregate_product_statuses_service.pagers.ListAggregateProductStatusesPager: + Response message for the ListAggregateProductStatuses + method. + + Iterating over this object will yield results and + resolve additional pages automatically. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [parent] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance( + request, aggregateproductstatuses.ListAggregateProductStatusesRequest + ): + request = aggregateproductstatuses.ListAggregateProductStatusesRequest( + request + ) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[ + self._transport.list_aggregate_product_statuses + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # This method is paged; wrap the response in a pager, which provides + # an `__iter__` convenience method. + response = pagers.ListAggregateProductStatusesPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "AggregateProductStatusesServiceClient": + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + +__all__ = ("AggregateProductStatusesServiceClient",) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/pagers.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/pagers.py new file mode 100644 index 000000000000..75cdb1691f62 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/pagers.py @@ -0,0 +1,212 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +from typing import ( + Any, + AsyncIterator, + Awaitable, + Callable, + Iterator, + Optional, + Sequence, + Tuple, + Union, +) + +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.api_core import retry_async as retries_async + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] + OptionalAsyncRetry = Union[ + retries_async.AsyncRetry, gapic_v1.method._MethodDefault, None + ] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + OptionalAsyncRetry = Union[retries_async.AsyncRetry, object, None] # type: ignore + +from google.shopping.merchant_issueresolution_v1.types import aggregateproductstatuses + + +class ListAggregateProductStatusesPager: + """A pager for iterating through ``list_aggregate_product_statuses`` requests. + + This class thinly wraps an initial + :class:`google.shopping.merchant_issueresolution_v1.types.ListAggregateProductStatusesResponse` object, and + provides an ``__iter__`` method to iterate through its + ``aggregate_product_statuses`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListAggregateProductStatuses`` requests and continue to iterate + through the ``aggregate_product_statuses`` field on the + corresponding responses. + + All the usual :class:`google.shopping.merchant_issueresolution_v1.types.ListAggregateProductStatusesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[ + ..., aggregateproductstatuses.ListAggregateProductStatusesResponse + ], + request: aggregateproductstatuses.ListAggregateProductStatusesRequest, + response: aggregateproductstatuses.ListAggregateProductStatusesResponse, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = () + ): + """Instantiate the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.shopping.merchant_issueresolution_v1.types.ListAggregateProductStatusesRequest): + The initial request object. + response (google.shopping.merchant_issueresolution_v1.types.ListAggregateProductStatusesResponse): + The initial response object. + retry (google.api_core.retry.Retry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + self._method = method + self._request = aggregateproductstatuses.ListAggregateProductStatusesRequest( + request + ) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + def pages( + self, + ) -> Iterator[aggregateproductstatuses.ListAggregateProductStatusesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = self._method( + self._request, + retry=self._retry, + timeout=self._timeout, + metadata=self._metadata, + ) + yield self._response + + def __iter__(self) -> Iterator[aggregateproductstatuses.AggregateProductStatus]: + for page in self.pages: + yield from page.aggregate_product_statuses + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListAggregateProductStatusesAsyncPager: + """A pager for iterating through ``list_aggregate_product_statuses`` requests. + + This class thinly wraps an initial + :class:`google.shopping.merchant_issueresolution_v1.types.ListAggregateProductStatusesResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``aggregate_product_statuses`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListAggregateProductStatuses`` requests and continue to iterate + through the ``aggregate_product_statuses`` field on the + corresponding responses. + + All the usual :class:`google.shopping.merchant_issueresolution_v1.types.ListAggregateProductStatusesResponse` + attributes are available on the pager. If multiple requests are made, only + the most recent response is retained, and thus used for attribute lookup. + """ + + def __init__( + self, + method: Callable[ + ..., + Awaitable[aggregateproductstatuses.ListAggregateProductStatusesResponse], + ], + request: aggregateproductstatuses.ListAggregateProductStatusesRequest, + response: aggregateproductstatuses.ListAggregateProductStatusesResponse, + *, + retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = () + ): + """Instantiates the pager. + + Args: + method (Callable): The method that was originally called, and + which instantiated this pager. + request (google.shopping.merchant_issueresolution_v1.types.ListAggregateProductStatusesRequest): + The initial request object. + response (google.shopping.merchant_issueresolution_v1.types.ListAggregateProductStatusesResponse): + The initial response object. + retry (google.api_core.retry.AsyncRetry): Designation of what errors, + if any, should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + """ + self._method = method + self._request = aggregateproductstatuses.ListAggregateProductStatusesRequest( + request + ) + self._response = response + self._retry = retry + self._timeout = timeout + self._metadata = metadata + + def __getattr__(self, name: str) -> Any: + return getattr(self._response, name) + + @property + async def pages( + self, + ) -> AsyncIterator[aggregateproductstatuses.ListAggregateProductStatusesResponse]: + yield self._response + while self._response.next_page_token: + self._request.page_token = self._response.next_page_token + self._response = await self._method( + self._request, + retry=self._retry, + timeout=self._timeout, + metadata=self._metadata, + ) + yield self._response + + def __aiter__( + self, + ) -> AsyncIterator[aggregateproductstatuses.AggregateProductStatus]: + async def async_generator(): + async for page in self.pages: + for response in page.aggregate_product_statuses: + yield response + + return async_generator() + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/README.rst b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/README.rst new file mode 100644 index 000000000000..d083f36b295e --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/README.rst @@ -0,0 +1,9 @@ + +transport inheritance structure +_______________________________ + +`AggregateProductStatusesServiceTransport` is the ABC for all transports. +- public child `AggregateProductStatusesServiceGrpcTransport` for sync gRPC transport (defined in `grpc.py`). +- public child `AggregateProductStatusesServiceGrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`). +- private child `_BaseAggregateProductStatusesServiceRestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`). +- public child `AggregateProductStatusesServiceRestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`). diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/__init__.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/__init__.py new file mode 100644 index 000000000000..b9efe2998a87 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/__init__.py @@ -0,0 +1,43 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import AggregateProductStatusesServiceTransport +from .grpc import AggregateProductStatusesServiceGrpcTransport +from .grpc_asyncio import AggregateProductStatusesServiceGrpcAsyncIOTransport +from .rest import ( + AggregateProductStatusesServiceRestInterceptor, + AggregateProductStatusesServiceRestTransport, +) + +# Compile a registry of transports. +_transport_registry = ( + OrderedDict() +) # type: Dict[str, Type[AggregateProductStatusesServiceTransport]] +_transport_registry["grpc"] = AggregateProductStatusesServiceGrpcTransport +_transport_registry[ + "grpc_asyncio" +] = AggregateProductStatusesServiceGrpcAsyncIOTransport +_transport_registry["rest"] = AggregateProductStatusesServiceRestTransport + +__all__ = ( + "AggregateProductStatusesServiceTransport", + "AggregateProductStatusesServiceGrpcTransport", + "AggregateProductStatusesServiceGrpcAsyncIOTransport", + "AggregateProductStatusesServiceRestTransport", + "AggregateProductStatusesServiceRestInterceptor", +) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/base.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/base.py new file mode 100644 index 000000000000..4db01cf9b193 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/base.py @@ -0,0 +1,168 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore +import google.protobuf + +from google.shopping.merchant_issueresolution_v1 import gapic_version as package_version +from google.shopping.merchant_issueresolution_v1.types import aggregateproductstatuses + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +class AggregateProductStatusesServiceTransport(abc.ABC): + """Abstract transport class for AggregateProductStatusesService.""" + + AUTH_SCOPES = ("https://www.googleapis.com/auth/content",) + + DEFAULT_HOST: str = "merchantapi.googleapis.com" + + def __init__( + self, + *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + if not hasattr(self, "_ignore_credentials"): + self._ignore_credentials: bool = False + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs( + "'credentials_file' and 'credentials' are mutually exclusive" + ) + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, **scopes_kwargs, quota_project_id=quota_project_id + ) + elif credentials is None and not self._ignore_credentials: + credentials, _ = google.auth.default( + **scopes_kwargs, quota_project_id=quota_project_id + ) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience( + api_audience if api_audience else host + ) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if ( + always_use_jwt_access + and isinstance(credentials, service_account.Credentials) + and hasattr(service_account.Credentials, "with_always_use_jwt_access") + ): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ":" not in host: + host += ":443" + self._host = host + + @property + def host(self): + return self._host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.list_aggregate_product_statuses: gapic_v1.method.wrap_method( + self.list_aggregate_product_statuses, + default_timeout=None, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def list_aggregate_product_statuses( + self, + ) -> Callable[ + [aggregateproductstatuses.ListAggregateProductStatusesRequest], + Union[ + aggregateproductstatuses.ListAggregateProductStatusesResponse, + Awaitable[aggregateproductstatuses.ListAggregateProductStatusesResponse], + ], + ]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ("AggregateProductStatusesServiceTransport",) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/grpc.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/grpc.py new file mode 100644 index 000000000000..cc7546c16ade --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/grpc.py @@ -0,0 +1,367 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +import json +import logging as std_logging +import pickle +from typing import Callable, Dict, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import gapic_v1, grpc_helpers +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.protobuf.json_format import MessageToJson +import google.protobuf.message +import grpc # type: ignore +import proto # type: ignore + +from google.shopping.merchant_issueresolution_v1.types import aggregateproductstatuses + +from .base import DEFAULT_CLIENT_INFO, AggregateProductStatusesServiceTransport + +try: + from google.api_core import client_logging # type: ignore + + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + + +class _LoggingClientInterceptor(grpc.UnaryUnaryClientInterceptor): # pragma: NO COVER + def intercept_unary_unary(self, continuation, client_call_details, request): + logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ) + if logging_enabled: # pragma: NO COVER + request_metadata = client_call_details.metadata + if isinstance(request, proto.Message): + request_payload = type(request).to_json(request) + elif isinstance(request, google.protobuf.message.Message): + request_payload = MessageToJson(request) + else: + request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" + + request_metadata = { + key: value.decode("utf-8") if isinstance(value, bytes) else value + for key, value in request_metadata + } + grpc_request = { + "payload": request_payload, + "requestMethod": "grpc", + "metadata": dict(request_metadata), + } + _LOGGER.debug( + f"Sending request for {client_call_details.method}", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.AggregateProductStatusesService", + "rpcName": str(client_call_details.method), + "request": grpc_request, + "metadata": grpc_request["metadata"], + }, + ) + response = continuation(client_call_details, request) + if logging_enabled: # pragma: NO COVER + response_metadata = response.trailing_metadata() + # Convert gRPC metadata `` to list of tuples + metadata = ( + dict([(k, str(v)) for k, v in response_metadata]) + if response_metadata + else None + ) + result = response.result() + if isinstance(result, proto.Message): + response_payload = type(result).to_json(result) + elif isinstance(result, google.protobuf.message.Message): + response_payload = MessageToJson(result) + else: + response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" + grpc_response = { + "payload": response_payload, + "metadata": metadata, + "status": "OK", + } + _LOGGER.debug( + f"Received response for {client_call_details.method}.", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.AggregateProductStatusesService", + "rpcName": client_call_details.method, + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class AggregateProductStatusesServiceGrpcTransport( + AggregateProductStatusesServiceTransport +): + """gRPC backend transport for AggregateProductStatusesService. + + Service to manage aggregate product statuses. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _stubs: Dict[str, Callable] + + def __init__( + self, + *, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if a ``channel`` instance is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if a ``channel`` instance is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if a ``channel`` instance is provided. + channel (Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]]): + A ``Channel`` instance through which to make calls, or a Callable + that constructs and returns one. If set to None, ``self.create_channel`` + is used to create the channel. If a Callable is given, it will be called + with the same arguments as used in ``self.create_channel``. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if a ``channel`` instance is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if a ``channel`` instance or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if isinstance(channel, grpc.Channel): + # Ignore credentials if a channel was passed. + credentials = None + self._ignore_credentials = True + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + # initialize with the provided callable or the default channel + channel_init = channel or type(self).create_channel + self._grpc_channel = channel_init( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + self._interceptor = _LoggingClientInterceptor() + self._logged_channel = grpc.intercept_channel( + self._grpc_channel, self._interceptor + ) + + # Wrap messages. This must be done after self._logged_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel( + cls, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs, + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service.""" + return self._grpc_channel + + @property + def list_aggregate_product_statuses( + self, + ) -> Callable[ + [aggregateproductstatuses.ListAggregateProductStatusesRequest], + aggregateproductstatuses.ListAggregateProductStatusesResponse, + ]: + r"""Return a callable for the list aggregate product + statuses method over gRPC. + + Lists the ``AggregateProductStatuses`` resources for your + merchant account. The response might contain fewer items than + specified by ``pageSize``. If ``pageToken`` was returned in + previous request, it can be used to obtain additional results. + + Returns: + Callable[[~.ListAggregateProductStatusesRequest], + ~.ListAggregateProductStatusesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_aggregate_product_statuses" not in self._stubs: + self._stubs[ + "list_aggregate_product_statuses" + ] = self._logged_channel.unary_unary( + "/google.shopping.merchant.issueresolution.v1.AggregateProductStatusesService/ListAggregateProductStatuses", + request_serializer=aggregateproductstatuses.ListAggregateProductStatusesRequest.serialize, + response_deserializer=aggregateproductstatuses.ListAggregateProductStatusesResponse.deserialize, + ) + return self._stubs["list_aggregate_product_statuses"] + + def close(self): + self._logged_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ("AggregateProductStatusesServiceGrpcTransport",) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/grpc_asyncio.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/grpc_asyncio.py new file mode 100644 index 000000000000..a1293eba1b68 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/grpc_asyncio.py @@ -0,0 +1,390 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +import inspect +import json +import logging as std_logging +import pickle +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1, grpc_helpers_async +from google.api_core import retry_async as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.protobuf.json_format import MessageToJson +import google.protobuf.message +import grpc # type: ignore +from grpc.experimental import aio # type: ignore +import proto # type: ignore + +from google.shopping.merchant_issueresolution_v1.types import aggregateproductstatuses + +from .base import DEFAULT_CLIENT_INFO, AggregateProductStatusesServiceTransport +from .grpc import AggregateProductStatusesServiceGrpcTransport + +try: + from google.api_core import client_logging # type: ignore + + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + + +class _LoggingClientAIOInterceptor( + grpc.aio.UnaryUnaryClientInterceptor +): # pragma: NO COVER + async def intercept_unary_unary(self, continuation, client_call_details, request): + logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ) + if logging_enabled: # pragma: NO COVER + request_metadata = client_call_details.metadata + if isinstance(request, proto.Message): + request_payload = type(request).to_json(request) + elif isinstance(request, google.protobuf.message.Message): + request_payload = MessageToJson(request) + else: + request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" + + request_metadata = { + key: value.decode("utf-8") if isinstance(value, bytes) else value + for key, value in request_metadata + } + grpc_request = { + "payload": request_payload, + "requestMethod": "grpc", + "metadata": dict(request_metadata), + } + _LOGGER.debug( + f"Sending request for {client_call_details.method}", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.AggregateProductStatusesService", + "rpcName": str(client_call_details.method), + "request": grpc_request, + "metadata": grpc_request["metadata"], + }, + ) + response = await continuation(client_call_details, request) + if logging_enabled: # pragma: NO COVER + response_metadata = await response.trailing_metadata() + # Convert gRPC metadata `` to list of tuples + metadata = ( + dict([(k, str(v)) for k, v in response_metadata]) + if response_metadata + else None + ) + result = await response + if isinstance(result, proto.Message): + response_payload = type(result).to_json(result) + elif isinstance(result, google.protobuf.message.Message): + response_payload = MessageToJson(result) + else: + response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" + grpc_response = { + "payload": response_payload, + "metadata": metadata, + "status": "OK", + } + _LOGGER.debug( + f"Received response to rpc {client_call_details.method}.", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.AggregateProductStatusesService", + "rpcName": str(client_call_details.method), + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class AggregateProductStatusesServiceGrpcAsyncIOTransport( + AggregateProductStatusesServiceTransport +): + """gRPC AsyncIO backend transport for AggregateProductStatusesService. + + Service to manage aggregate product statuses. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel( + cls, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs, + ) + + def __init__( + self, + *, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[aio.Channel, Callable[..., aio.Channel]]] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if a ``channel`` instance is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if a ``channel`` instance is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[Union[aio.Channel, Callable[..., aio.Channel]]]): + A ``Channel`` instance through which to make calls, or a Callable + that constructs and returns one. If set to None, ``self.create_channel`` + is used to create the channel. If a Callable is given, it will be called + with the same arguments as used in ``self.create_channel``. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if a ``channel`` instance is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if a ``channel`` instance or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if isinstance(channel, aio.Channel): + # Ignore credentials if a channel was passed. + credentials = None + self._ignore_credentials = True + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + # initialize with the provided callable or the default channel + channel_init = channel or type(self).create_channel + self._grpc_channel = channel_init( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + self._interceptor = _LoggingClientAIOInterceptor() + self._grpc_channel._unary_unary_interceptors.append(self._interceptor) + self._logged_channel = self._grpc_channel + self._wrap_with_kind = ( + "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters + ) + # Wrap messages. This must be done after self._logged_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def list_aggregate_product_statuses( + self, + ) -> Callable[ + [aggregateproductstatuses.ListAggregateProductStatusesRequest], + Awaitable[aggregateproductstatuses.ListAggregateProductStatusesResponse], + ]: + r"""Return a callable for the list aggregate product + statuses method over gRPC. + + Lists the ``AggregateProductStatuses`` resources for your + merchant account. The response might contain fewer items than + specified by ``pageSize``. If ``pageToken`` was returned in + previous request, it can be used to obtain additional results. + + Returns: + Callable[[~.ListAggregateProductStatusesRequest], + Awaitable[~.ListAggregateProductStatusesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "list_aggregate_product_statuses" not in self._stubs: + self._stubs[ + "list_aggregate_product_statuses" + ] = self._logged_channel.unary_unary( + "/google.shopping.merchant.issueresolution.v1.AggregateProductStatusesService/ListAggregateProductStatuses", + request_serializer=aggregateproductstatuses.ListAggregateProductStatusesRequest.serialize, + response_deserializer=aggregateproductstatuses.ListAggregateProductStatusesResponse.deserialize, + ) + return self._stubs["list_aggregate_product_statuses"] + + def _prep_wrapped_messages(self, client_info): + """Precompute the wrapped methods, overriding the base class method to use async wrappers.""" + self._wrapped_methods = { + self.list_aggregate_product_statuses: self._wrap_method( + self.list_aggregate_product_statuses, + default_timeout=None, + client_info=client_info, + ), + } + + def _wrap_method(self, func, *args, **kwargs): + if self._wrap_with_kind: # pragma: NO COVER + kwargs["kind"] = self.kind + return gapic_v1.method_async.wrap_method(func, *args, **kwargs) + + def close(self): + return self._logged_channel.close() + + @property + def kind(self) -> str: + return "grpc_asyncio" + + +__all__ = ("AggregateProductStatusesServiceGrpcAsyncIOTransport",) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/rest.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/rest.py new file mode 100644 index 000000000000..b8836c1a4365 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/rest.py @@ -0,0 +1,411 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +import dataclasses +import json # type: ignore +import logging +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1, rest_helpers, rest_streaming +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.requests import AuthorizedSession # type: ignore +import google.protobuf +from google.protobuf import json_format +from requests import __version__ as requests_version + +from google.shopping.merchant_issueresolution_v1.types import aggregateproductstatuses + +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO +from .rest_base import _BaseAggregateProductStatusesServiceRestTransport + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + +try: + from google.api_core import client_logging # type: ignore + + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = logging.getLogger(__name__) + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=f"requests@{requests_version}", +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +class AggregateProductStatusesServiceRestInterceptor: + """Interceptor for AggregateProductStatusesService. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the AggregateProductStatusesServiceRestTransport. + + .. code-block:: python + class MyCustomAggregateProductStatusesServiceInterceptor(AggregateProductStatusesServiceRestInterceptor): + def pre_list_aggregate_product_statuses(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_aggregate_product_statuses(self, response): + logging.log(f"Received response: {response}") + return response + + transport = AggregateProductStatusesServiceRestTransport(interceptor=MyCustomAggregateProductStatusesServiceInterceptor()) + client = AggregateProductStatusesServiceClient(transport=transport) + + + """ + + def pre_list_aggregate_product_statuses( + self, + request: aggregateproductstatuses.ListAggregateProductStatusesRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + aggregateproductstatuses.ListAggregateProductStatusesRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for list_aggregate_product_statuses + + Override in a subclass to manipulate the request or metadata + before they are sent to the AggregateProductStatusesService server. + """ + return request, metadata + + def post_list_aggregate_product_statuses( + self, response: aggregateproductstatuses.ListAggregateProductStatusesResponse + ) -> aggregateproductstatuses.ListAggregateProductStatusesResponse: + """Post-rpc interceptor for list_aggregate_product_statuses + + DEPRECATED. Please use the `post_list_aggregate_product_statuses_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the AggregateProductStatusesService server but before + it is returned to user code. This `post_list_aggregate_product_statuses` interceptor runs + before the `post_list_aggregate_product_statuses_with_metadata` interceptor. + """ + return response + + def post_list_aggregate_product_statuses_with_metadata( + self, + response: aggregateproductstatuses.ListAggregateProductStatusesResponse, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + aggregateproductstatuses.ListAggregateProductStatusesResponse, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Post-rpc interceptor for list_aggregate_product_statuses + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the AggregateProductStatusesService server but before it is returned to user code. + + We recommend only using this `post_list_aggregate_product_statuses_with_metadata` + interceptor in new development instead of the `post_list_aggregate_product_statuses` interceptor. + When both interceptors are used, this `post_list_aggregate_product_statuses_with_metadata` interceptor runs after the + `post_list_aggregate_product_statuses` interceptor. The (possibly modified) response returned by + `post_list_aggregate_product_statuses` will be passed to + `post_list_aggregate_product_statuses_with_metadata`. + """ + return response, metadata + + +@dataclasses.dataclass +class AggregateProductStatusesServiceRestStub: + _session: AuthorizedSession + _host: str + _interceptor: AggregateProductStatusesServiceRestInterceptor + + +class AggregateProductStatusesServiceRestTransport( + _BaseAggregateProductStatusesServiceRestTransport +): + """REST backend synchronous transport for AggregateProductStatusesService. + + Service to manage aggregate product statuses. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + """ + + def __init__( + self, + *, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + interceptor: Optional[AggregateProductStatusesServiceRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + url_scheme=url_scheme, + api_audience=api_audience, + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST + ) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = ( + interceptor or AggregateProductStatusesServiceRestInterceptor() + ) + self._prep_wrapped_messages(client_info) + + class _ListAggregateProductStatuses( + _BaseAggregateProductStatusesServiceRestTransport._BaseListAggregateProductStatuses, + AggregateProductStatusesServiceRestStub, + ): + def __hash__(self): + return hash( + "AggregateProductStatusesServiceRestTransport.ListAggregateProductStatuses" + ) + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None, + ): + uri = transcoded_request["uri"] + method = transcoded_request["method"] + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + return response + + def __call__( + self, + request: aggregateproductstatuses.ListAggregateProductStatusesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> aggregateproductstatuses.ListAggregateProductStatusesResponse: + r"""Call the list aggregate product + statuses method over HTTP. + + Args: + request (~.aggregateproductstatuses.ListAggregateProductStatusesRequest): + The request object. Request message for the ``ListAggregateProductStatuses`` + method. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.aggregateproductstatuses.ListAggregateProductStatusesResponse: + Response message for the + ``ListAggregateProductStatuses`` method. + + """ + + http_options = ( + _BaseAggregateProductStatusesServiceRestTransport._BaseListAggregateProductStatuses._get_http_options() + ) + + request, metadata = self._interceptor.pre_list_aggregate_product_statuses( + request, metadata + ) + transcoded_request = _BaseAggregateProductStatusesServiceRestTransport._BaseListAggregateProductStatuses._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseAggregateProductStatusesServiceRestTransport._BaseListAggregateProductStatuses._get_query_params_json( + transcoded_request + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + request_url = "{host}{uri}".format( + host=self._host, uri=transcoded_request["uri"] + ) + method = transcoded_request["method"] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.shopping.merchant.issueresolution_v1.AggregateProductStatusesServiceClient.ListAggregateProductStatuses", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.AggregateProductStatusesService", + "rpcName": "ListAggregateProductStatuses", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = AggregateProductStatusesServiceRestTransport._ListAggregateProductStatuses._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = aggregateproductstatuses.ListAggregateProductStatusesResponse() + pb_resp = aggregateproductstatuses.ListAggregateProductStatusesResponse.pb( + resp + ) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_list_aggregate_product_statuses(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + ( + resp, + _, + ) = self._interceptor.post_list_aggregate_product_statuses_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = aggregateproductstatuses.ListAggregateProductStatusesResponse.to_json( + response + ) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.shopping.merchant.issueresolution_v1.AggregateProductStatusesServiceClient.list_aggregate_product_statuses", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.AggregateProductStatusesService", + "rpcName": "ListAggregateProductStatuses", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + @property + def list_aggregate_product_statuses( + self, + ) -> Callable[ + [aggregateproductstatuses.ListAggregateProductStatusesRequest], + aggregateproductstatuses.ListAggregateProductStatusesResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListAggregateProductStatuses(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("AggregateProductStatusesServiceRestTransport",) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/rest_base.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/rest_base.py new file mode 100644 index 000000000000..a10be35a3372 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/aggregate_product_statuses_service/transports/rest_base.py @@ -0,0 +1,142 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +import json # type: ignore +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1, path_template +from google.protobuf import json_format + +from google.shopping.merchant_issueresolution_v1.types import aggregateproductstatuses + +from .base import DEFAULT_CLIENT_INFO, AggregateProductStatusesServiceTransport + + +class _BaseAggregateProductStatusesServiceRestTransport( + AggregateProductStatusesServiceTransport +): + """Base REST backend transport for AggregateProductStatusesService. + + Note: This class is not meant to be used directly. Use its sync and + async sub-classes instead. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + """ + + def __init__( + self, + *, + host: str = "merchantapi.googleapis.com", + credentials: Optional[Any] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[Any]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + class _BaseListAggregateProductStatuses: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/issueresolution/v1/{parent=accounts/*}/aggregateProductStatuses", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = ( + aggregateproductstatuses.ListAggregateProductStatusesRequest.pb(request) + ) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseAggregateProductStatusesServiceRestTransport._BaseListAggregateProductStatuses._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + +__all__ = ("_BaseAggregateProductStatusesServiceRestTransport",) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/__init__.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/__init__.py new file mode 100644 index 000000000000..6be81a215b07 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +from .async_client import IssueResolutionServiceAsyncClient +from .client import IssueResolutionServiceClient + +__all__ = ( + "IssueResolutionServiceClient", + "IssueResolutionServiceAsyncClient", +) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/async_client.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/async_client.py new file mode 100644 index 000000000000..9de736752d17 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/async_client.py @@ -0,0 +1,678 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +from collections import OrderedDict +import logging as std_logging +import re +from typing import ( + Callable, + Dict, + Mapping, + MutableMapping, + MutableSequence, + Optional, + Sequence, + Tuple, + Type, + Union, +) + +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry_async as retries +from google.api_core.client_options import ClientOptions +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore +import google.protobuf + +from google.shopping.merchant_issueresolution_v1 import gapic_version as package_version + +try: + OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore + +from google.shopping.merchant_issueresolution_v1.types import issueresolution + +from .client import IssueResolutionServiceClient +from .transports.base import DEFAULT_CLIENT_INFO, IssueResolutionServiceTransport +from .transports.grpc_asyncio import IssueResolutionServiceGrpcAsyncIOTransport + +try: + from google.api_core import client_logging # type: ignore + + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + + +class IssueResolutionServiceAsyncClient: + """Service to provide an issue resolution content for account + issues and product issues. + """ + + _client: IssueResolutionServiceClient + + # Copy defaults from the synchronous client for use here. + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = IssueResolutionServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = IssueResolutionServiceClient.DEFAULT_MTLS_ENDPOINT + _DEFAULT_ENDPOINT_TEMPLATE = IssueResolutionServiceClient._DEFAULT_ENDPOINT_TEMPLATE + _DEFAULT_UNIVERSE = IssueResolutionServiceClient._DEFAULT_UNIVERSE + + account_path = staticmethod(IssueResolutionServiceClient.account_path) + parse_account_path = staticmethod(IssueResolutionServiceClient.parse_account_path) + product_path = staticmethod(IssueResolutionServiceClient.product_path) + parse_product_path = staticmethod(IssueResolutionServiceClient.parse_product_path) + common_billing_account_path = staticmethod( + IssueResolutionServiceClient.common_billing_account_path + ) + parse_common_billing_account_path = staticmethod( + IssueResolutionServiceClient.parse_common_billing_account_path + ) + common_folder_path = staticmethod(IssueResolutionServiceClient.common_folder_path) + parse_common_folder_path = staticmethod( + IssueResolutionServiceClient.parse_common_folder_path + ) + common_organization_path = staticmethod( + IssueResolutionServiceClient.common_organization_path + ) + parse_common_organization_path = staticmethod( + IssueResolutionServiceClient.parse_common_organization_path + ) + common_project_path = staticmethod(IssueResolutionServiceClient.common_project_path) + parse_common_project_path = staticmethod( + IssueResolutionServiceClient.parse_common_project_path + ) + common_location_path = staticmethod( + IssueResolutionServiceClient.common_location_path + ) + parse_common_location_path = staticmethod( + IssueResolutionServiceClient.parse_common_location_path + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + IssueResolutionServiceAsyncClient: The constructed client. + """ + return IssueResolutionServiceClient.from_service_account_info.__func__(IssueResolutionServiceAsyncClient, info, *args, **kwargs) # type: ignore + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + IssueResolutionServiceAsyncClient: The constructed client. + """ + return IssueResolutionServiceClient.from_service_account_file.__func__(IssueResolutionServiceAsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source( + cls, client_options: Optional[ClientOptions] = None + ): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return IssueResolutionServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> IssueResolutionServiceTransport: + """Returns the transport used by the client instance. + + Returns: + IssueResolutionServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + @property + def api_endpoint(self): + """Return the API endpoint used by the client instance. + + Returns: + str: The API endpoint used by the client instance. + """ + return self._client._api_endpoint + + @property + def universe_domain(self) -> str: + """Return the universe domain used by the client instance. + + Returns: + str: The universe domain used + by the client instance. + """ + return self._client._universe_domain + + get_transport_class = IssueResolutionServiceClient.get_transport_class + + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[ + Union[ + str, + IssueResolutionServiceTransport, + Callable[..., IssueResolutionServiceTransport], + ] + ] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the issue resolution service async client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Optional[Union[str,IssueResolutionServiceTransport,Callable[..., IssueResolutionServiceTransport]]]): + The transport to use, or a Callable that constructs and returns a new transport to use. + If a Callable is given, it will be called with the same set of initialization + arguments as used in the IssueResolutionServiceTransport constructor. + If set to None, a transport is chosen automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): + Custom options for the client. + + 1. The ``api_endpoint`` property can be used to override the + default endpoint provided by the client when ``transport`` is + not explicitly provided. Only if this property is not set and + ``transport`` was not explicitly provided, the endpoint is + determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment + variable, which have one of the following values: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto-switch to the + default mTLS endpoint if client certificate is present; this is + the default value). + + 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide a client certificate for mTLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + 3. The ``universe_domain`` property can be used to override the + default "googleapis.com" universe. Note that ``api_endpoint`` + property still takes precedence; and ``universe_domain`` is + currently not supported for mTLS. + + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client = IssueResolutionServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ): # pragma: NO COVER + _LOGGER.debug( + "Created client `google.shopping.merchant.issueresolution_v1.IssueResolutionServiceAsyncClient`.", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "universeDomain": getattr( + self._client._transport._credentials, "universe_domain", "" + ), + "credentialsType": f"{type(self._client._transport._credentials).__module__}.{type(self._client._transport._credentials).__qualname__}", + "credentialsInfo": getattr( + self.transport._credentials, "get_cred_info", lambda: None + )(), + } + if hasattr(self._client._transport, "_credentials") + else { + "serviceName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "credentialsType": None, + }, + ) + + async def render_account_issues( + self, + request: Optional[ + Union[issueresolution.RenderAccountIssuesRequest, dict] + ] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> issueresolution.RenderAccountIssuesResponse: + r"""Provide a list of business's account issues with an + issue resolution content and available actions. This + content and actions are meant to be rendered and shown + in third-party applications. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.shopping import merchant_issueresolution_v1 + + async def sample_render_account_issues(): + # Create a client + client = merchant_issueresolution_v1.IssueResolutionServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_issueresolution_v1.RenderAccountIssuesRequest( + name="name_value", + ) + + # Make the request + response = await client.render_account_issues(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.shopping.merchant_issueresolution_v1.types.RenderAccountIssuesRequest, dict]]): + The request object. Request to provide issue resolution + content and actions for business's + account issues. + name (:class:`str`): + Required. The account to fetch issues for. Format: + ``accounts/{account}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.shopping.merchant_issueresolution_v1.types.RenderAccountIssuesResponse: + Response containing an issue + resolution content and actions for + listed account issues. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [name] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, issueresolution.RenderAccountIssuesRequest): + request = issueresolution.RenderAccountIssuesRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[ + self._client._transport.render_account_issues + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def render_product_issues( + self, + request: Optional[ + Union[issueresolution.RenderProductIssuesRequest, dict] + ] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> issueresolution.RenderProductIssuesResponse: + r"""Provide a list of issues for business's product with + an issue resolution content and available actions. This + content and actions are meant to be rendered and shown + in third-party applications. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.shopping import merchant_issueresolution_v1 + + async def sample_render_product_issues(): + # Create a client + client = merchant_issueresolution_v1.IssueResolutionServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_issueresolution_v1.RenderProductIssuesRequest( + name="name_value", + ) + + # Make the request + response = await client.render_product_issues(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.shopping.merchant_issueresolution_v1.types.RenderProductIssuesRequest, dict]]): + The request object. Request to provide an issue + resolution content and actions for + product issues of business's product. + name (:class:`str`): + Required. The name of the product to fetch issues for. + Format: ``accounts/{account}/products/{product}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.shopping.merchant_issueresolution_v1.types.RenderProductIssuesResponse: + Response containing an issue + resolution content and actions for + listed product issues. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [name] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, issueresolution.RenderProductIssuesRequest): + request = issueresolution.RenderProductIssuesRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[ + self._client._transport.render_product_issues + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def trigger_action( + self, + request: Optional[Union[issueresolution.TriggerActionRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> issueresolution.TriggerActionResponse: + r"""Start an action. The action can be requested by a business in + third-party application. Before the business can request the + action, the third-party application needs to show them action + specific content and display a user input form. + + The action can be successfully started only once all + ``required`` inputs are provided. If any ``required`` input is + missing, or invalid value was provided, the service will return + 400 error. Validation errors will contain + [Ids][google.shopping.merchant.issueresolution.v1.InputField.id] + for all problematic field together with translated, human + readable error messages that can be shown to the user. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.shopping import merchant_issueresolution_v1 + + async def sample_trigger_action(): + # Create a client + client = merchant_issueresolution_v1.IssueResolutionServiceAsyncClient() + + # Initialize request argument(s) + payload = merchant_issueresolution_v1.TriggerActionPayload() + payload.action_context = "action_context_value" + payload.action_input.action_flow_id = "action_flow_id_value" + payload.action_input.input_values.text_input_value.value = "value_value" + payload.action_input.input_values.input_field_id = "input_field_id_value" + + request = merchant_issueresolution_v1.TriggerActionRequest( + name="name_value", + payload=payload, + ) + + # Make the request + response = await client.trigger_action(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.shopping.merchant_issueresolution_v1.types.TriggerActionRequest, dict]]): + The request object. Request to start the selected action + name (:class:`str`): + Required. The business's account that is triggering the + action. Format: ``accounts/{account}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.shopping.merchant_issueresolution_v1.types.TriggerActionResponse: + Response informing about the started + action. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [name] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, issueresolution.TriggerActionRequest): + request = issueresolution.TriggerActionRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[ + self._client._transport.trigger_action + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def __aenter__(self) -> "IssueResolutionServiceAsyncClient": + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +__all__ = ("IssueResolutionServiceAsyncClient",) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/client.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/client.py new file mode 100644 index 000000000000..5a1328444b01 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/client.py @@ -0,0 +1,1107 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +from collections import OrderedDict +from http import HTTPStatus +import json +import logging as std_logging +import os +import re +from typing import ( + Callable, + Dict, + Mapping, + MutableMapping, + MutableSequence, + Optional, + Sequence, + Tuple, + Type, + Union, + cast, +) +import warnings + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.oauth2 import service_account # type: ignore +import google.protobuf + +from google.shopping.merchant_issueresolution_v1 import gapic_version as package_version + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + +try: + from google.api_core import client_logging # type: ignore + + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + +from google.shopping.merchant_issueresolution_v1.types import issueresolution + +from .transports.base import DEFAULT_CLIENT_INFO, IssueResolutionServiceTransport +from .transports.grpc import IssueResolutionServiceGrpcTransport +from .transports.grpc_asyncio import IssueResolutionServiceGrpcAsyncIOTransport +from .transports.rest import IssueResolutionServiceRestTransport + + +class IssueResolutionServiceClientMeta(type): + """Metaclass for the IssueResolutionService client. + + This provides class-level methods for building and retrieving + support objects (e.g. transport) without polluting the client instance + objects. + """ + + _transport_registry = ( + OrderedDict() + ) # type: Dict[str, Type[IssueResolutionServiceTransport]] + _transport_registry["grpc"] = IssueResolutionServiceGrpcTransport + _transport_registry["grpc_asyncio"] = IssueResolutionServiceGrpcAsyncIOTransport + _transport_registry["rest"] = IssueResolutionServiceRestTransport + + def get_transport_class( + cls, + label: Optional[str] = None, + ) -> Type[IssueResolutionServiceTransport]: + """Returns an appropriate transport class. + + Args: + label: The name of the desired transport. If none is + provided, then the first transport in the registry is used. + + Returns: + The transport class to use. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class IssueResolutionServiceClient(metaclass=IssueResolutionServiceClientMeta): + """Service to provide an issue resolution content for account + issues and product issues. + """ + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = "merchantapi.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + _DEFAULT_ENDPOINT_TEMPLATE = "merchantapi.{UNIVERSE_DOMAIN}" + _DEFAULT_UNIVERSE = "googleapis.com" + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + IssueResolutionServiceClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_info(info) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + IssueResolutionServiceClient: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_file(filename) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> IssueResolutionServiceTransport: + """Returns the transport used by the client instance. + + Returns: + IssueResolutionServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def account_path( + account: str, + ) -> str: + """Returns a fully-qualified account string.""" + return "accounts/{account}".format( + account=account, + ) + + @staticmethod + def parse_account_path(path: str) -> Dict[str, str]: + """Parses a account path into its component segments.""" + m = re.match(r"^accounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def product_path( + account: str, + product: str, + ) -> str: + """Returns a fully-qualified product string.""" + return "accounts/{account}/products/{product}".format( + account=account, + product=product, + ) + + @staticmethod + def parse_product_path(path: str) -> Dict[str, str]: + """Parses a product path into its component segments.""" + m = re.match(r"^accounts/(?P.+?)/products/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_billing_account_path( + billing_account: str, + ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str, str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path( + folder: str, + ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format( + folder=folder, + ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str, str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path( + organization: str, + ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format( + organization=organization, + ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str, str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path( + project: str, + ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format( + project=project, + ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str, str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path( + project: str, + location: str, + ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format( + project=project, + location=location, + ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str, str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source( + cls, client_options: Optional[client_options_lib.ClientOptions] = None + ): + """Deprecated. Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variable is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + + warnings.warn( + "get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.", + DeprecationWarning, + ) + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError( + "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError( + "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or ( + use_mtls_endpoint == "auto" and client_cert_source + ): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + @staticmethod + def _read_environment_variables(): + """Returns the environment variables used by the client. + + Returns: + Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE, + GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables. + + Raises: + ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not + any of ["true", "false"]. + google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT + is not any of ["auto", "never", "always"]. + """ + use_client_cert = os.getenv( + "GOOGLE_API_USE_CLIENT_CERTIFICATE", "false" + ).lower() + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower() + universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN") + if use_client_cert not in ("true", "false"): + raise ValueError( + "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError( + "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + return use_client_cert == "true", use_mtls_endpoint, universe_domain_env + + @staticmethod + def _get_client_cert_source(provided_cert_source, use_cert_flag): + """Return the client cert source to be used by the client. + + Args: + provided_cert_source (bytes): The client certificate source provided. + use_cert_flag (bool): A flag indicating whether to use the client certificate. + + Returns: + bytes or None: The client cert source to be used by the client. + """ + client_cert_source = None + if use_cert_flag: + if provided_cert_source: + client_cert_source = provided_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + return client_cert_source + + @staticmethod + def _get_api_endpoint( + api_override, client_cert_source, universe_domain, use_mtls_endpoint + ): + """Return the API endpoint used by the client. + + Args: + api_override (str): The API endpoint override. If specified, this is always + the return value of this function and the other arguments are not used. + client_cert_source (bytes): The client certificate source used by the client. + universe_domain (str): The universe domain used by the client. + use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters. + Possible values are "always", "auto", or "never". + + Returns: + str: The API endpoint to be used by the client. + """ + if api_override is not None: + api_endpoint = api_override + elif use_mtls_endpoint == "always" or ( + use_mtls_endpoint == "auto" and client_cert_source + ): + _default_universe = IssueResolutionServiceClient._DEFAULT_UNIVERSE + if universe_domain != _default_universe: + raise MutualTLSChannelError( + f"mTLS is not supported in any universe other than {_default_universe}." + ) + api_endpoint = IssueResolutionServiceClient.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = ( + IssueResolutionServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=universe_domain + ) + ) + return api_endpoint + + @staticmethod + def _get_universe_domain( + client_universe_domain: Optional[str], universe_domain_env: Optional[str] + ) -> str: + """Return the universe domain used by the client. + + Args: + client_universe_domain (Optional[str]): The universe domain configured via the client options. + universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable. + + Returns: + str: The universe domain to be used by the client. + + Raises: + ValueError: If the universe domain is an empty string. + """ + universe_domain = IssueResolutionServiceClient._DEFAULT_UNIVERSE + if client_universe_domain is not None: + universe_domain = client_universe_domain + elif universe_domain_env is not None: + universe_domain = universe_domain_env + if len(universe_domain.strip()) == 0: + raise ValueError("Universe Domain cannot be an empty string.") + return universe_domain + + def _validate_universe_domain(self): + """Validates client's and credentials' universe domains are consistent. + + Returns: + bool: True iff the configured universe domain is valid. + + Raises: + ValueError: If the configured universe domain is not valid. + """ + + # NOTE (b/349488459): universe validation is disabled until further notice. + return True + + def _add_cred_info_for_auth_errors( + self, error: core_exceptions.GoogleAPICallError + ) -> None: + """Adds credential info string to error details for 401/403/404 errors. + + Args: + error (google.api_core.exceptions.GoogleAPICallError): The error to add the cred info. + """ + if error.code not in [ + HTTPStatus.UNAUTHORIZED, + HTTPStatus.FORBIDDEN, + HTTPStatus.NOT_FOUND, + ]: + return + + cred = self._transport._credentials + + # get_cred_info is only available in google-auth>=2.35.0 + if not hasattr(cred, "get_cred_info"): + return + + # ignore the type check since pypy test fails when get_cred_info + # is not available + cred_info = cred.get_cred_info() # type: ignore + if cred_info and hasattr(error._details, "append"): + error._details.append(json.dumps(cred_info)) + + @property + def api_endpoint(self): + """Return the API endpoint used by the client instance. + + Returns: + str: The API endpoint used by the client instance. + """ + return self._api_endpoint + + @property + def universe_domain(self) -> str: + """Return the universe domain used by the client instance. + + Returns: + str: The universe domain used by the client instance. + """ + return self._universe_domain + + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[ + Union[ + str, + IssueResolutionServiceTransport, + Callable[..., IssueResolutionServiceTransport], + ] + ] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the issue resolution service client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Optional[Union[str,IssueResolutionServiceTransport,Callable[..., IssueResolutionServiceTransport]]]): + The transport to use, or a Callable that constructs and returns a new transport. + If a Callable is given, it will be called with the same set of initialization + arguments as used in the IssueResolutionServiceTransport constructor. + If set to None, a transport is chosen automatically. + client_options (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): + Custom options for the client. + + 1. The ``api_endpoint`` property can be used to override the + default endpoint provided by the client when ``transport`` is + not explicitly provided. Only if this property is not set and + ``transport`` was not explicitly provided, the endpoint is + determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment + variable, which have one of the following values: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto-switch to the + default mTLS endpoint if client certificate is present; this is + the default value). + + 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide a client certificate for mTLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + 3. The ``universe_domain`` property can be used to override the + default "googleapis.com" universe. Note that the ``api_endpoint`` + property still takes precedence; and ``universe_domain`` is + currently not supported for mTLS. + + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client_options = client_options + if isinstance(self._client_options, dict): + self._client_options = client_options_lib.from_dict(self._client_options) + if self._client_options is None: + self._client_options = client_options_lib.ClientOptions() + self._client_options = cast( + client_options_lib.ClientOptions, self._client_options + ) + + universe_domain_opt = getattr(self._client_options, "universe_domain", None) + + ( + self._use_client_cert, + self._use_mtls_endpoint, + self._universe_domain_env, + ) = IssueResolutionServiceClient._read_environment_variables() + self._client_cert_source = IssueResolutionServiceClient._get_client_cert_source( + self._client_options.client_cert_source, self._use_client_cert + ) + self._universe_domain = IssueResolutionServiceClient._get_universe_domain( + universe_domain_opt, self._universe_domain_env + ) + self._api_endpoint = None # updated below, depending on `transport` + + # Initialize the universe domain validation. + self._is_universe_domain_valid = False + + if CLIENT_LOGGING_SUPPORTED: # pragma: NO COVER + # Setup logging. + client_logging.initialize_logging() + + api_key_value = getattr(self._client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError( + "client_options.api_key and credentials are mutually exclusive" + ) + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + transport_provided = isinstance(transport, IssueResolutionServiceTransport) + if transport_provided: + # transport is a IssueResolutionServiceTransport instance. + if credentials or self._client_options.credentials_file or api_key_value: + raise ValueError( + "When providing a transport instance, " + "provide its credentials directly." + ) + if self._client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = cast(IssueResolutionServiceTransport, transport) + self._api_endpoint = self._transport.host + + self._api_endpoint = ( + self._api_endpoint + or IssueResolutionServiceClient._get_api_endpoint( + self._client_options.api_endpoint, + self._client_cert_source, + self._universe_domain, + self._use_mtls_endpoint, + ) + ) + + if not transport_provided: + import google.auth._default # type: ignore + + if api_key_value and hasattr( + google.auth._default, "get_api_key_credentials" + ): + credentials = google.auth._default.get_api_key_credentials( + api_key_value + ) + + transport_init: Union[ + Type[IssueResolutionServiceTransport], + Callable[..., IssueResolutionServiceTransport], + ] = ( + IssueResolutionServiceClient.get_transport_class(transport) + if isinstance(transport, str) or transport is None + else cast(Callable[..., IssueResolutionServiceTransport], transport) + ) + # initialize with the provided callable or the passed in class + self._transport = transport_init( + credentials=credentials, + credentials_file=self._client_options.credentials_file, + host=self._api_endpoint, + scopes=self._client_options.scopes, + client_cert_source_for_mtls=self._client_cert_source, + quota_project_id=self._client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=self._client_options.api_audience, + ) + + if "async" not in str(self._transport): + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ): # pragma: NO COVER + _LOGGER.debug( + "Created client `google.shopping.merchant.issueresolution_v1.IssueResolutionServiceClient`.", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "universeDomain": getattr( + self._transport._credentials, "universe_domain", "" + ), + "credentialsType": f"{type(self._transport._credentials).__module__}.{type(self._transport._credentials).__qualname__}", + "credentialsInfo": getattr( + self.transport._credentials, "get_cred_info", lambda: None + )(), + } + if hasattr(self._transport, "_credentials") + else { + "serviceName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "credentialsType": None, + }, + ) + + def render_account_issues( + self, + request: Optional[ + Union[issueresolution.RenderAccountIssuesRequest, dict] + ] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> issueresolution.RenderAccountIssuesResponse: + r"""Provide a list of business's account issues with an + issue resolution content and available actions. This + content and actions are meant to be rendered and shown + in third-party applications. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.shopping import merchant_issueresolution_v1 + + def sample_render_account_issues(): + # Create a client + client = merchant_issueresolution_v1.IssueResolutionServiceClient() + + # Initialize request argument(s) + request = merchant_issueresolution_v1.RenderAccountIssuesRequest( + name="name_value", + ) + + # Make the request + response = client.render_account_issues(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.shopping.merchant_issueresolution_v1.types.RenderAccountIssuesRequest, dict]): + The request object. Request to provide issue resolution + content and actions for business's + account issues. + name (str): + Required. The account to fetch issues for. Format: + ``accounts/{account}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.shopping.merchant_issueresolution_v1.types.RenderAccountIssuesResponse: + Response containing an issue + resolution content and actions for + listed account issues. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [name] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, issueresolution.RenderAccountIssuesRequest): + request = issueresolution.RenderAccountIssuesRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.render_account_issues] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def render_product_issues( + self, + request: Optional[ + Union[issueresolution.RenderProductIssuesRequest, dict] + ] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> issueresolution.RenderProductIssuesResponse: + r"""Provide a list of issues for business's product with + an issue resolution content and available actions. This + content and actions are meant to be rendered and shown + in third-party applications. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.shopping import merchant_issueresolution_v1 + + def sample_render_product_issues(): + # Create a client + client = merchant_issueresolution_v1.IssueResolutionServiceClient() + + # Initialize request argument(s) + request = merchant_issueresolution_v1.RenderProductIssuesRequest( + name="name_value", + ) + + # Make the request + response = client.render_product_issues(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.shopping.merchant_issueresolution_v1.types.RenderProductIssuesRequest, dict]): + The request object. Request to provide an issue + resolution content and actions for + product issues of business's product. + name (str): + Required. The name of the product to fetch issues for. + Format: ``accounts/{account}/products/{product}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.shopping.merchant_issueresolution_v1.types.RenderProductIssuesResponse: + Response containing an issue + resolution content and actions for + listed product issues. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [name] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, issueresolution.RenderProductIssuesRequest): + request = issueresolution.RenderProductIssuesRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.render_product_issues] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def trigger_action( + self, + request: Optional[Union[issueresolution.TriggerActionRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> issueresolution.TriggerActionResponse: + r"""Start an action. The action can be requested by a business in + third-party application. Before the business can request the + action, the third-party application needs to show them action + specific content and display a user input form. + + The action can be successfully started only once all + ``required`` inputs are provided. If any ``required`` input is + missing, or invalid value was provided, the service will return + 400 error. Validation errors will contain + [Ids][google.shopping.merchant.issueresolution.v1.InputField.id] + for all problematic field together with translated, human + readable error messages that can be shown to the user. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.shopping import merchant_issueresolution_v1 + + def sample_trigger_action(): + # Create a client + client = merchant_issueresolution_v1.IssueResolutionServiceClient() + + # Initialize request argument(s) + payload = merchant_issueresolution_v1.TriggerActionPayload() + payload.action_context = "action_context_value" + payload.action_input.action_flow_id = "action_flow_id_value" + payload.action_input.input_values.text_input_value.value = "value_value" + payload.action_input.input_values.input_field_id = "input_field_id_value" + + request = merchant_issueresolution_v1.TriggerActionRequest( + name="name_value", + payload=payload, + ) + + # Make the request + response = client.trigger_action(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.shopping.merchant_issueresolution_v1.types.TriggerActionRequest, dict]): + The request object. Request to start the selected action + name (str): + Required. The business's account that is triggering the + action. Format: ``accounts/{account}`` + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + google.shopping.merchant_issueresolution_v1.types.TriggerActionResponse: + Response informing about the started + action. + + """ + # Create or coerce a protobuf request object. + # - Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + flattened_params = [name] + has_flattened_params = ( + len([param for param in flattened_params if param is not None]) > 0 + ) + if request is not None and has_flattened_params: + raise ValueError( + "If the `request` argument is set, then none of " + "the individual field arguments should be set." + ) + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, issueresolution.TriggerActionRequest): + request = issueresolution.TriggerActionRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.trigger_action] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "IssueResolutionServiceClient": + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + +__all__ = ("IssueResolutionServiceClient",) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/README.rst b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/README.rst new file mode 100644 index 000000000000..5bb9930d4afd --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/README.rst @@ -0,0 +1,9 @@ + +transport inheritance structure +_______________________________ + +`IssueResolutionServiceTransport` is the ABC for all transports. +- public child `IssueResolutionServiceGrpcTransport` for sync gRPC transport (defined in `grpc.py`). +- public child `IssueResolutionServiceGrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`). +- private child `_BaseIssueResolutionServiceRestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`). +- public child `IssueResolutionServiceRestTransport` for sync REST transport with inner classes `METHOD` derived from the parent's corresponding `_BaseMETHOD` classes (defined in `rest.py`). diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/__init__.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/__init__.py new file mode 100644 index 000000000000..5296ada998c3 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/__init__.py @@ -0,0 +1,41 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import IssueResolutionServiceTransport +from .grpc import IssueResolutionServiceGrpcTransport +from .grpc_asyncio import IssueResolutionServiceGrpcAsyncIOTransport +from .rest import ( + IssueResolutionServiceRestInterceptor, + IssueResolutionServiceRestTransport, +) + +# Compile a registry of transports. +_transport_registry = ( + OrderedDict() +) # type: Dict[str, Type[IssueResolutionServiceTransport]] +_transport_registry["grpc"] = IssueResolutionServiceGrpcTransport +_transport_registry["grpc_asyncio"] = IssueResolutionServiceGrpcAsyncIOTransport +_transport_registry["rest"] = IssueResolutionServiceRestTransport + +__all__ = ( + "IssueResolutionServiceTransport", + "IssueResolutionServiceGrpcTransport", + "IssueResolutionServiceGrpcAsyncIOTransport", + "IssueResolutionServiceRestTransport", + "IssueResolutionServiceRestInterceptor", +) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/base.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/base.py new file mode 100644 index 000000000000..20dc315dbbbe --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/base.py @@ -0,0 +1,202 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union + +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore +import google.protobuf + +from google.shopping.merchant_issueresolution_v1 import gapic_version as package_version +from google.shopping.merchant_issueresolution_v1.types import issueresolution + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=package_version.__version__ +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +class IssueResolutionServiceTransport(abc.ABC): + """Abstract transport class for IssueResolutionService.""" + + AUTH_SCOPES = ("https://www.googleapis.com/auth/content",) + + DEFAULT_HOST: str = "merchantapi.googleapis.com" + + def __init__( + self, + *, + host: str = DEFAULT_HOST, + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + if not hasattr(self, "_ignore_credentials"): + self._ignore_credentials: bool = False + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs( + "'credentials_file' and 'credentials' are mutually exclusive" + ) + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, **scopes_kwargs, quota_project_id=quota_project_id + ) + elif credentials is None and not self._ignore_credentials: + credentials, _ = google.auth.default( + **scopes_kwargs, quota_project_id=quota_project_id + ) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience( + api_audience if api_audience else host + ) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if ( + always_use_jwt_access + and isinstance(credentials, service_account.Credentials) + and hasattr(service_account.Credentials, "with_always_use_jwt_access") + ): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ":" not in host: + host += ":443" + self._host = host + + @property + def host(self): + return self._host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.render_account_issues: gapic_v1.method.wrap_method( + self.render_account_issues, + default_timeout=None, + client_info=client_info, + ), + self.render_product_issues: gapic_v1.method.wrap_method( + self.render_product_issues, + default_timeout=None, + client_info=client_info, + ), + self.trigger_action: gapic_v1.method.wrap_method( + self.trigger_action, + default_timeout=None, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def render_account_issues( + self, + ) -> Callable[ + [issueresolution.RenderAccountIssuesRequest], + Union[ + issueresolution.RenderAccountIssuesResponse, + Awaitable[issueresolution.RenderAccountIssuesResponse], + ], + ]: + raise NotImplementedError() + + @property + def render_product_issues( + self, + ) -> Callable[ + [issueresolution.RenderProductIssuesRequest], + Union[ + issueresolution.RenderProductIssuesResponse, + Awaitable[issueresolution.RenderProductIssuesResponse], + ], + ]: + raise NotImplementedError() + + @property + def trigger_action( + self, + ) -> Callable[ + [issueresolution.TriggerActionRequest], + Union[ + issueresolution.TriggerActionResponse, + Awaitable[issueresolution.TriggerActionResponse], + ], + ]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ("IssueResolutionServiceTransport",) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/grpc.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/grpc.py new file mode 100644 index 000000000000..30767bad3f29 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/grpc.py @@ -0,0 +1,434 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +import json +import logging as std_logging +import pickle +from typing import Callable, Dict, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import gapic_v1, grpc_helpers +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.protobuf.json_format import MessageToJson +import google.protobuf.message +import grpc # type: ignore +import proto # type: ignore + +from google.shopping.merchant_issueresolution_v1.types import issueresolution + +from .base import DEFAULT_CLIENT_INFO, IssueResolutionServiceTransport + +try: + from google.api_core import client_logging # type: ignore + + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + + +class _LoggingClientInterceptor(grpc.UnaryUnaryClientInterceptor): # pragma: NO COVER + def intercept_unary_unary(self, continuation, client_call_details, request): + logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ) + if logging_enabled: # pragma: NO COVER + request_metadata = client_call_details.metadata + if isinstance(request, proto.Message): + request_payload = type(request).to_json(request) + elif isinstance(request, google.protobuf.message.Message): + request_payload = MessageToJson(request) + else: + request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" + + request_metadata = { + key: value.decode("utf-8") if isinstance(value, bytes) else value + for key, value in request_metadata + } + grpc_request = { + "payload": request_payload, + "requestMethod": "grpc", + "metadata": dict(request_metadata), + } + _LOGGER.debug( + f"Sending request for {client_call_details.method}", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "rpcName": str(client_call_details.method), + "request": grpc_request, + "metadata": grpc_request["metadata"], + }, + ) + response = continuation(client_call_details, request) + if logging_enabled: # pragma: NO COVER + response_metadata = response.trailing_metadata() + # Convert gRPC metadata `` to list of tuples + metadata = ( + dict([(k, str(v)) for k, v in response_metadata]) + if response_metadata + else None + ) + result = response.result() + if isinstance(result, proto.Message): + response_payload = type(result).to_json(result) + elif isinstance(result, google.protobuf.message.Message): + response_payload = MessageToJson(result) + else: + response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" + grpc_response = { + "payload": response_payload, + "metadata": metadata, + "status": "OK", + } + _LOGGER.debug( + f"Received response for {client_call_details.method}.", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "rpcName": client_call_details.method, + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class IssueResolutionServiceGrpcTransport(IssueResolutionServiceTransport): + """gRPC backend transport for IssueResolutionService. + + Service to provide an issue resolution content for account + issues and product issues. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _stubs: Dict[str, Callable] + + def __init__( + self, + *, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if a ``channel`` instance is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if a ``channel`` instance is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if a ``channel`` instance is provided. + channel (Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]]): + A ``Channel`` instance through which to make calls, or a Callable + that constructs and returns one. If set to None, ``self.create_channel`` + is used to create the channel. If a Callable is given, it will be called + with the same arguments as used in ``self.create_channel``. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if a ``channel`` instance is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if a ``channel`` instance or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if isinstance(channel, grpc.Channel): + # Ignore credentials if a channel was passed. + credentials = None + self._ignore_credentials = True + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + # initialize with the provided callable or the default channel + channel_init = channel or type(self).create_channel + self._grpc_channel = channel_init( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + self._interceptor = _LoggingClientInterceptor() + self._logged_channel = grpc.intercept_channel( + self._grpc_channel, self._interceptor + ) + + # Wrap messages. This must be done after self._logged_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel( + cls, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs, + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service.""" + return self._grpc_channel + + @property + def render_account_issues( + self, + ) -> Callable[ + [issueresolution.RenderAccountIssuesRequest], + issueresolution.RenderAccountIssuesResponse, + ]: + r"""Return a callable for the render account issues method over gRPC. + + Provide a list of business's account issues with an + issue resolution content and available actions. This + content and actions are meant to be rendered and shown + in third-party applications. + + Returns: + Callable[[~.RenderAccountIssuesRequest], + ~.RenderAccountIssuesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "render_account_issues" not in self._stubs: + self._stubs["render_account_issues"] = self._logged_channel.unary_unary( + "/google.shopping.merchant.issueresolution.v1.IssueResolutionService/RenderAccountIssues", + request_serializer=issueresolution.RenderAccountIssuesRequest.serialize, + response_deserializer=issueresolution.RenderAccountIssuesResponse.deserialize, + ) + return self._stubs["render_account_issues"] + + @property + def render_product_issues( + self, + ) -> Callable[ + [issueresolution.RenderProductIssuesRequest], + issueresolution.RenderProductIssuesResponse, + ]: + r"""Return a callable for the render product issues method over gRPC. + + Provide a list of issues for business's product with + an issue resolution content and available actions. This + content and actions are meant to be rendered and shown + in third-party applications. + + Returns: + Callable[[~.RenderProductIssuesRequest], + ~.RenderProductIssuesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "render_product_issues" not in self._stubs: + self._stubs["render_product_issues"] = self._logged_channel.unary_unary( + "/google.shopping.merchant.issueresolution.v1.IssueResolutionService/RenderProductIssues", + request_serializer=issueresolution.RenderProductIssuesRequest.serialize, + response_deserializer=issueresolution.RenderProductIssuesResponse.deserialize, + ) + return self._stubs["render_product_issues"] + + @property + def trigger_action( + self, + ) -> Callable[ + [issueresolution.TriggerActionRequest], issueresolution.TriggerActionResponse + ]: + r"""Return a callable for the trigger action method over gRPC. + + Start an action. The action can be requested by a business in + third-party application. Before the business can request the + action, the third-party application needs to show them action + specific content and display a user input form. + + The action can be successfully started only once all + ``required`` inputs are provided. If any ``required`` input is + missing, or invalid value was provided, the service will return + 400 error. Validation errors will contain + [Ids][google.shopping.merchant.issueresolution.v1.InputField.id] + for all problematic field together with translated, human + readable error messages that can be shown to the user. + + Returns: + Callable[[~.TriggerActionRequest], + ~.TriggerActionResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "trigger_action" not in self._stubs: + self._stubs["trigger_action"] = self._logged_channel.unary_unary( + "/google.shopping.merchant.issueresolution.v1.IssueResolutionService/TriggerAction", + request_serializer=issueresolution.TriggerActionRequest.serialize, + response_deserializer=issueresolution.TriggerActionResponse.deserialize, + ) + return self._stubs["trigger_action"] + + def close(self): + self._logged_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ("IssueResolutionServiceGrpcTransport",) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/grpc_asyncio.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/grpc_asyncio.py new file mode 100644 index 000000000000..0b50db7bc208 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/grpc_asyncio.py @@ -0,0 +1,468 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +import inspect +import json +import logging as std_logging +import pickle +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1, grpc_helpers_async +from google.api_core import retry_async as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.protobuf.json_format import MessageToJson +import google.protobuf.message +import grpc # type: ignore +from grpc.experimental import aio # type: ignore +import proto # type: ignore + +from google.shopping.merchant_issueresolution_v1.types import issueresolution + +from .base import DEFAULT_CLIENT_INFO, IssueResolutionServiceTransport +from .grpc import IssueResolutionServiceGrpcTransport + +try: + from google.api_core import client_logging # type: ignore + + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = std_logging.getLogger(__name__) + + +class _LoggingClientAIOInterceptor( + grpc.aio.UnaryUnaryClientInterceptor +): # pragma: NO COVER + async def intercept_unary_unary(self, continuation, client_call_details, request): + logging_enabled = CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + std_logging.DEBUG + ) + if logging_enabled: # pragma: NO COVER + request_metadata = client_call_details.metadata + if isinstance(request, proto.Message): + request_payload = type(request).to_json(request) + elif isinstance(request, google.protobuf.message.Message): + request_payload = MessageToJson(request) + else: + request_payload = f"{type(request).__name__}: {pickle.dumps(request)}" + + request_metadata = { + key: value.decode("utf-8") if isinstance(value, bytes) else value + for key, value in request_metadata + } + grpc_request = { + "payload": request_payload, + "requestMethod": "grpc", + "metadata": dict(request_metadata), + } + _LOGGER.debug( + f"Sending request for {client_call_details.method}", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "rpcName": str(client_call_details.method), + "request": grpc_request, + "metadata": grpc_request["metadata"], + }, + ) + response = await continuation(client_call_details, request) + if logging_enabled: # pragma: NO COVER + response_metadata = await response.trailing_metadata() + # Convert gRPC metadata `` to list of tuples + metadata = ( + dict([(k, str(v)) for k, v in response_metadata]) + if response_metadata + else None + ) + result = await response + if isinstance(result, proto.Message): + response_payload = type(result).to_json(result) + elif isinstance(result, google.protobuf.message.Message): + response_payload = MessageToJson(result) + else: + response_payload = f"{type(result).__name__}: {pickle.dumps(result)}" + grpc_response = { + "payload": response_payload, + "metadata": metadata, + "status": "OK", + } + _LOGGER.debug( + f"Received response to rpc {client_call_details.method}.", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "rpcName": str(client_call_details.method), + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class IssueResolutionServiceGrpcAsyncIOTransport(IssueResolutionServiceTransport): + """gRPC AsyncIO backend transport for IssueResolutionService. + + Service to provide an issue resolution content for account + issues and product issues. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel( + cls, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs, + ) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs, + ) + + def __init__( + self, + *, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[aio.Channel, Callable[..., aio.Channel]]] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if a ``channel`` instance is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if a ``channel`` instance is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[Union[aio.Channel, Callable[..., aio.Channel]]]): + A ``Channel`` instance through which to make calls, or a Callable + that constructs and returns one. If set to None, ``self.create_channel`` + is used to create the channel. If a Callable is given, it will be called + with the same arguments as used in ``self.create_channel``. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if a ``channel`` instance is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if a ``channel`` instance or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if isinstance(channel, aio.Channel): + # Ignore credentials if a channel was passed. + credentials = None + self._ignore_credentials = True + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + if not self._grpc_channel: + # initialize with the provided callable or the default channel + channel_init = channel or type(self).create_channel + self._grpc_channel = channel_init( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + self._interceptor = _LoggingClientAIOInterceptor() + self._grpc_channel._unary_unary_interceptors.append(self._interceptor) + self._logged_channel = self._grpc_channel + self._wrap_with_kind = ( + "kind" in inspect.signature(gapic_v1.method_async.wrap_method).parameters + ) + # Wrap messages. This must be done after self._logged_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def render_account_issues( + self, + ) -> Callable[ + [issueresolution.RenderAccountIssuesRequest], + Awaitable[issueresolution.RenderAccountIssuesResponse], + ]: + r"""Return a callable for the render account issues method over gRPC. + + Provide a list of business's account issues with an + issue resolution content and available actions. This + content and actions are meant to be rendered and shown + in third-party applications. + + Returns: + Callable[[~.RenderAccountIssuesRequest], + Awaitable[~.RenderAccountIssuesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "render_account_issues" not in self._stubs: + self._stubs["render_account_issues"] = self._logged_channel.unary_unary( + "/google.shopping.merchant.issueresolution.v1.IssueResolutionService/RenderAccountIssues", + request_serializer=issueresolution.RenderAccountIssuesRequest.serialize, + response_deserializer=issueresolution.RenderAccountIssuesResponse.deserialize, + ) + return self._stubs["render_account_issues"] + + @property + def render_product_issues( + self, + ) -> Callable[ + [issueresolution.RenderProductIssuesRequest], + Awaitable[issueresolution.RenderProductIssuesResponse], + ]: + r"""Return a callable for the render product issues method over gRPC. + + Provide a list of issues for business's product with + an issue resolution content and available actions. This + content and actions are meant to be rendered and shown + in third-party applications. + + Returns: + Callable[[~.RenderProductIssuesRequest], + Awaitable[~.RenderProductIssuesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "render_product_issues" not in self._stubs: + self._stubs["render_product_issues"] = self._logged_channel.unary_unary( + "/google.shopping.merchant.issueresolution.v1.IssueResolutionService/RenderProductIssues", + request_serializer=issueresolution.RenderProductIssuesRequest.serialize, + response_deserializer=issueresolution.RenderProductIssuesResponse.deserialize, + ) + return self._stubs["render_product_issues"] + + @property + def trigger_action( + self, + ) -> Callable[ + [issueresolution.TriggerActionRequest], + Awaitable[issueresolution.TriggerActionResponse], + ]: + r"""Return a callable for the trigger action method over gRPC. + + Start an action. The action can be requested by a business in + third-party application. Before the business can request the + action, the third-party application needs to show them action + specific content and display a user input form. + + The action can be successfully started only once all + ``required`` inputs are provided. If any ``required`` input is + missing, or invalid value was provided, the service will return + 400 error. Validation errors will contain + [Ids][google.shopping.merchant.issueresolution.v1.InputField.id] + for all problematic field together with translated, human + readable error messages that can be shown to the user. + + Returns: + Callable[[~.TriggerActionRequest], + Awaitable[~.TriggerActionResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if "trigger_action" not in self._stubs: + self._stubs["trigger_action"] = self._logged_channel.unary_unary( + "/google.shopping.merchant.issueresolution.v1.IssueResolutionService/TriggerAction", + request_serializer=issueresolution.TriggerActionRequest.serialize, + response_deserializer=issueresolution.TriggerActionResponse.deserialize, + ) + return self._stubs["trigger_action"] + + def _prep_wrapped_messages(self, client_info): + """Precompute the wrapped methods, overriding the base class method to use async wrappers.""" + self._wrapped_methods = { + self.render_account_issues: self._wrap_method( + self.render_account_issues, + default_timeout=None, + client_info=client_info, + ), + self.render_product_issues: self._wrap_method( + self.render_product_issues, + default_timeout=None, + client_info=client_info, + ), + self.trigger_action: self._wrap_method( + self.trigger_action, + default_timeout=None, + client_info=client_info, + ), + } + + def _wrap_method(self, func, *args, **kwargs): + if self._wrap_with_kind: # pragma: NO COVER + kwargs["kind"] = self.kind + return gapic_v1.method_async.wrap_method(func, *args, **kwargs) + + def close(self): + return self._logged_channel.close() + + @property + def kind(self) -> str: + return "grpc_asyncio" + + +__all__ = ("IssueResolutionServiceGrpcAsyncIOTransport",) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/rest.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/rest.py new file mode 100644 index 000000000000..ad8c95440c99 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/rest.py @@ -0,0 +1,866 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +import dataclasses +import json # type: ignore +import logging +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1, rest_helpers, rest_streaming +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.requests import AuthorizedSession # type: ignore +import google.protobuf +from google.protobuf import json_format +from requests import __version__ as requests_version + +from google.shopping.merchant_issueresolution_v1.types import issueresolution + +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO +from .rest_base import _BaseIssueResolutionServiceRestTransport + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + +try: + from google.api_core import client_logging # type: ignore + + CLIENT_LOGGING_SUPPORTED = True # pragma: NO COVER +except ImportError: # pragma: NO COVER + CLIENT_LOGGING_SUPPORTED = False + +_LOGGER = logging.getLogger(__name__) + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=f"requests@{requests_version}", +) + +if hasattr(DEFAULT_CLIENT_INFO, "protobuf_runtime_version"): # pragma: NO COVER + DEFAULT_CLIENT_INFO.protobuf_runtime_version = google.protobuf.__version__ + + +class IssueResolutionServiceRestInterceptor: + """Interceptor for IssueResolutionService. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the IssueResolutionServiceRestTransport. + + .. code-block:: python + class MyCustomIssueResolutionServiceInterceptor(IssueResolutionServiceRestInterceptor): + def pre_render_account_issues(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_render_account_issues(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_render_product_issues(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_render_product_issues(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_trigger_action(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_trigger_action(self, response): + logging.log(f"Received response: {response}") + return response + + transport = IssueResolutionServiceRestTransport(interceptor=MyCustomIssueResolutionServiceInterceptor()) + client = IssueResolutionServiceClient(transport=transport) + + + """ + + def pre_render_account_issues( + self, + request: issueresolution.RenderAccountIssuesRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + issueresolution.RenderAccountIssuesRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for render_account_issues + + Override in a subclass to manipulate the request or metadata + before they are sent to the IssueResolutionService server. + """ + return request, metadata + + def post_render_account_issues( + self, response: issueresolution.RenderAccountIssuesResponse + ) -> issueresolution.RenderAccountIssuesResponse: + """Post-rpc interceptor for render_account_issues + + DEPRECATED. Please use the `post_render_account_issues_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the IssueResolutionService server but before + it is returned to user code. This `post_render_account_issues` interceptor runs + before the `post_render_account_issues_with_metadata` interceptor. + """ + return response + + def post_render_account_issues_with_metadata( + self, + response: issueresolution.RenderAccountIssuesResponse, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + issueresolution.RenderAccountIssuesResponse, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Post-rpc interceptor for render_account_issues + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the IssueResolutionService server but before it is returned to user code. + + We recommend only using this `post_render_account_issues_with_metadata` + interceptor in new development instead of the `post_render_account_issues` interceptor. + When both interceptors are used, this `post_render_account_issues_with_metadata` interceptor runs after the + `post_render_account_issues` interceptor. The (possibly modified) response returned by + `post_render_account_issues` will be passed to + `post_render_account_issues_with_metadata`. + """ + return response, metadata + + def pre_render_product_issues( + self, + request: issueresolution.RenderProductIssuesRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + issueresolution.RenderProductIssuesRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for render_product_issues + + Override in a subclass to manipulate the request or metadata + before they are sent to the IssueResolutionService server. + """ + return request, metadata + + def post_render_product_issues( + self, response: issueresolution.RenderProductIssuesResponse + ) -> issueresolution.RenderProductIssuesResponse: + """Post-rpc interceptor for render_product_issues + + DEPRECATED. Please use the `post_render_product_issues_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the IssueResolutionService server but before + it is returned to user code. This `post_render_product_issues` interceptor runs + before the `post_render_product_issues_with_metadata` interceptor. + """ + return response + + def post_render_product_issues_with_metadata( + self, + response: issueresolution.RenderProductIssuesResponse, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + issueresolution.RenderProductIssuesResponse, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Post-rpc interceptor for render_product_issues + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the IssueResolutionService server but before it is returned to user code. + + We recommend only using this `post_render_product_issues_with_metadata` + interceptor in new development instead of the `post_render_product_issues` interceptor. + When both interceptors are used, this `post_render_product_issues_with_metadata` interceptor runs after the + `post_render_product_issues` interceptor. The (possibly modified) response returned by + `post_render_product_issues` will be passed to + `post_render_product_issues_with_metadata`. + """ + return response, metadata + + def pre_trigger_action( + self, + request: issueresolution.TriggerActionRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + issueresolution.TriggerActionRequest, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Pre-rpc interceptor for trigger_action + + Override in a subclass to manipulate the request or metadata + before they are sent to the IssueResolutionService server. + """ + return request, metadata + + def post_trigger_action( + self, response: issueresolution.TriggerActionResponse + ) -> issueresolution.TriggerActionResponse: + """Post-rpc interceptor for trigger_action + + DEPRECATED. Please use the `post_trigger_action_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the IssueResolutionService server but before + it is returned to user code. This `post_trigger_action` interceptor runs + before the `post_trigger_action_with_metadata` interceptor. + """ + return response + + def post_trigger_action_with_metadata( + self, + response: issueresolution.TriggerActionResponse, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + issueresolution.TriggerActionResponse, Sequence[Tuple[str, Union[str, bytes]]] + ]: + """Post-rpc interceptor for trigger_action + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the IssueResolutionService server but before it is returned to user code. + + We recommend only using this `post_trigger_action_with_metadata` + interceptor in new development instead of the `post_trigger_action` interceptor. + When both interceptors are used, this `post_trigger_action_with_metadata` interceptor runs after the + `post_trigger_action` interceptor. The (possibly modified) response returned by + `post_trigger_action` will be passed to + `post_trigger_action_with_metadata`. + """ + return response, metadata + + +@dataclasses.dataclass +class IssueResolutionServiceRestStub: + _session: AuthorizedSession + _host: str + _interceptor: IssueResolutionServiceRestInterceptor + + +class IssueResolutionServiceRestTransport(_BaseIssueResolutionServiceRestTransport): + """REST backend synchronous transport for IssueResolutionService. + + Service to provide an issue resolution content for account + issues and product issues. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + """ + + def __init__( + self, + *, + host: str = "merchantapi.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + interceptor: Optional[IssueResolutionServiceRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + url_scheme=url_scheme, + api_audience=api_audience, + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST + ) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or IssueResolutionServiceRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _RenderAccountIssues( + _BaseIssueResolutionServiceRestTransport._BaseRenderAccountIssues, + IssueResolutionServiceRestStub, + ): + def __hash__(self): + return hash("IssueResolutionServiceRestTransport.RenderAccountIssues") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None, + ): + uri = transcoded_request["uri"] + method = transcoded_request["method"] + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__( + self, + request: issueresolution.RenderAccountIssuesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> issueresolution.RenderAccountIssuesResponse: + r"""Call the render account issues method over HTTP. + + Args: + request (~.issueresolution.RenderAccountIssuesRequest): + The request object. Request to provide issue resolution + content and actions for business's + account issues. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.issueresolution.RenderAccountIssuesResponse: + Response containing an issue + resolution content and actions for + listed account issues. + + """ + + http_options = ( + _BaseIssueResolutionServiceRestTransport._BaseRenderAccountIssues._get_http_options() + ) + + request, metadata = self._interceptor.pre_render_account_issues( + request, metadata + ) + transcoded_request = _BaseIssueResolutionServiceRestTransport._BaseRenderAccountIssues._get_transcoded_request( + http_options, request + ) + + body = _BaseIssueResolutionServiceRestTransport._BaseRenderAccountIssues._get_request_body_json( + transcoded_request + ) + + # Jsonify the query params + query_params = _BaseIssueResolutionServiceRestTransport._BaseRenderAccountIssues._get_query_params_json( + transcoded_request + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + request_url = "{host}{uri}".format( + host=self._host, uri=transcoded_request["uri"] + ) + method = transcoded_request["method"] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.shopping.merchant.issueresolution_v1.IssueResolutionServiceClient.RenderAccountIssues", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "rpcName": "RenderAccountIssues", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ( + IssueResolutionServiceRestTransport._RenderAccountIssues._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + body, + ) + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = issueresolution.RenderAccountIssuesResponse() + pb_resp = issueresolution.RenderAccountIssuesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_render_account_issues(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_render_account_issues_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = ( + issueresolution.RenderAccountIssuesResponse.to_json(response) + ) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.shopping.merchant.issueresolution_v1.IssueResolutionServiceClient.render_account_issues", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "rpcName": "RenderAccountIssues", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _RenderProductIssues( + _BaseIssueResolutionServiceRestTransport._BaseRenderProductIssues, + IssueResolutionServiceRestStub, + ): + def __hash__(self): + return hash("IssueResolutionServiceRestTransport.RenderProductIssues") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None, + ): + uri = transcoded_request["uri"] + method = transcoded_request["method"] + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__( + self, + request: issueresolution.RenderProductIssuesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> issueresolution.RenderProductIssuesResponse: + r"""Call the render product issues method over HTTP. + + Args: + request (~.issueresolution.RenderProductIssuesRequest): + The request object. Request to provide an issue + resolution content and actions for + product issues of business's product. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.issueresolution.RenderProductIssuesResponse: + Response containing an issue + resolution content and actions for + listed product issues. + + """ + + http_options = ( + _BaseIssueResolutionServiceRestTransport._BaseRenderProductIssues._get_http_options() + ) + + request, metadata = self._interceptor.pre_render_product_issues( + request, metadata + ) + transcoded_request = _BaseIssueResolutionServiceRestTransport._BaseRenderProductIssues._get_transcoded_request( + http_options, request + ) + + body = _BaseIssueResolutionServiceRestTransport._BaseRenderProductIssues._get_request_body_json( + transcoded_request + ) + + # Jsonify the query params + query_params = _BaseIssueResolutionServiceRestTransport._BaseRenderProductIssues._get_query_params_json( + transcoded_request + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + request_url = "{host}{uri}".format( + host=self._host, uri=transcoded_request["uri"] + ) + method = transcoded_request["method"] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.shopping.merchant.issueresolution_v1.IssueResolutionServiceClient.RenderProductIssues", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "rpcName": "RenderProductIssues", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = ( + IssueResolutionServiceRestTransport._RenderProductIssues._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + body, + ) + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = issueresolution.RenderProductIssuesResponse() + pb_resp = issueresolution.RenderProductIssuesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_render_product_issues(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_render_product_issues_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = ( + issueresolution.RenderProductIssuesResponse.to_json(response) + ) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.shopping.merchant.issueresolution_v1.IssueResolutionServiceClient.render_product_issues", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "rpcName": "RenderProductIssues", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _TriggerAction( + _BaseIssueResolutionServiceRestTransport._BaseTriggerAction, + IssueResolutionServiceRestStub, + ): + def __hash__(self): + return hash("IssueResolutionServiceRestTransport.TriggerAction") + + @staticmethod + def _get_response( + host, + metadata, + query_params, + session, + timeout, + transcoded_request, + body=None, + ): + uri = transcoded_request["uri"] + method = transcoded_request["method"] + headers = dict(metadata) + headers["Content-Type"] = "application/json" + response = getattr(session, method)( + "{host}{uri}".format(host=host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + return response + + def __call__( + self, + request: issueresolution.TriggerActionRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> issueresolution.TriggerActionResponse: + r"""Call the trigger action method over HTTP. + + Args: + request (~.issueresolution.TriggerActionRequest): + The request object. Request to start the selected action + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be + sent along with the request as metadata. Normally, each value must be of type `str`, + but for metadata keys ending with the suffix `-bin`, the corresponding values must + be of type `bytes`. + + Returns: + ~.issueresolution.TriggerActionResponse: + Response informing about the started + action. + + """ + + http_options = ( + _BaseIssueResolutionServiceRestTransport._BaseTriggerAction._get_http_options() + ) + + request, metadata = self._interceptor.pre_trigger_action(request, metadata) + transcoded_request = _BaseIssueResolutionServiceRestTransport._BaseTriggerAction._get_transcoded_request( + http_options, request + ) + + body = _BaseIssueResolutionServiceRestTransport._BaseTriggerAction._get_request_body_json( + transcoded_request + ) + + # Jsonify the query params + query_params = _BaseIssueResolutionServiceRestTransport._BaseTriggerAction._get_query_params_json( + transcoded_request + ) + + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + request_url = "{host}{uri}".format( + host=self._host, uri=transcoded_request["uri"] + ) + method = transcoded_request["method"] + try: + request_payload = type(request).to_json(request) + except: + request_payload = None + http_request = { + "payload": request_payload, + "requestMethod": method, + "requestUrl": request_url, + "headers": dict(metadata), + } + _LOGGER.debug( + f"Sending request for google.shopping.merchant.issueresolution_v1.IssueResolutionServiceClient.TriggerAction", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "rpcName": "TriggerAction", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = IssueResolutionServiceRestTransport._TriggerAction._get_response( + self._host, + metadata, + query_params, + self._session, + timeout, + transcoded_request, + body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = issueresolution.TriggerActionResponse() + pb_resp = issueresolution.TriggerActionResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_trigger_action(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + resp, _ = self._interceptor.post_trigger_action_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = issueresolution.TriggerActionResponse.to_json( + response + ) + except: + response_payload = None + http_response = { + "payload": response_payload, + "headers": dict(response.headers), + "status": response.status_code, + } + _LOGGER.debug( + "Received response for google.shopping.merchant.issueresolution_v1.IssueResolutionServiceClient.trigger_action", + extra={ + "serviceName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "rpcName": "TriggerAction", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + @property + def render_account_issues( + self, + ) -> Callable[ + [issueresolution.RenderAccountIssuesRequest], + issueresolution.RenderAccountIssuesResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._RenderAccountIssues(self._session, self._host, self._interceptor) # type: ignore + + @property + def render_product_issues( + self, + ) -> Callable[ + [issueresolution.RenderProductIssuesRequest], + issueresolution.RenderProductIssuesResponse, + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._RenderProductIssues(self._session, self._host, self._interceptor) # type: ignore + + @property + def trigger_action( + self, + ) -> Callable[ + [issueresolution.TriggerActionRequest], issueresolution.TriggerActionResponse + ]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._TriggerAction(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("IssueResolutionServiceRestTransport",) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/rest_base.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/rest_base.py new file mode 100644 index 000000000000..4aa6c7a152bf --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/services/issue_resolution_service/transports/rest_base.py @@ -0,0 +1,262 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +import json # type: ignore +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1, path_template +from google.protobuf import json_format + +from google.shopping.merchant_issueresolution_v1.types import issueresolution + +from .base import DEFAULT_CLIENT_INFO, IssueResolutionServiceTransport + + +class _BaseIssueResolutionServiceRestTransport(IssueResolutionServiceTransport): + """Base REST backend transport for IssueResolutionService. + + Note: This class is not meant to be used directly. Use its sync and + async sub-classes instead. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends JSON representations of protocol buffers over HTTP/1.1 + """ + + def __init__( + self, + *, + host: str = "merchantapi.googleapis.com", + credentials: Optional[Any] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + url_scheme: str = "https", + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + Args: + host (Optional[str]): + The hostname to connect to (default: 'merchantapi.googleapis.com'). + credentials (Optional[Any]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience, + ) + + class _BaseRenderAccountIssues: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/issueresolution/v1/{name=accounts/*}:renderaccountissues", + "body": "payload", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = issueresolution.RenderAccountIssuesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], use_integers_for_enums=True + ) + return body + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseIssueResolutionServiceRestTransport._BaseRenderAccountIssues._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseRenderProductIssues: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/issueresolution/v1/{name=accounts/*/products/*}:renderproductissues", + "body": "payload", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = issueresolution.RenderProductIssuesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], use_integers_for_enums=True + ) + return body + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseIssueResolutionServiceRestTransport._BaseRenderProductIssues._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseTriggerAction: + def __hash__(self): # pragma: NO COVER + return NotImplementedError("__hash__ must be implemented.") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + @staticmethod + def _get_http_options(): + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/issueresolution/v1/{name=accounts/*}:triggeraction", + "body": "payload", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = issueresolution.TriggerActionRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + return transcoded_request + + @staticmethod + def _get_request_body_json(transcoded_request): + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request["body"], use_integers_for_enums=True + ) + return body + + @staticmethod + def _get_query_params_json(transcoded_request): + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + use_integers_for_enums=True, + ) + ) + query_params.update( + _BaseIssueResolutionServiceRestTransport._BaseTriggerAction._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + +__all__ = ("_BaseIssueResolutionServiceRestTransport",) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/types/__init__.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/types/__init__.py new file mode 100644 index 000000000000..385a714247cb --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/types/__init__.py @@ -0,0 +1,76 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +from .aggregateproductstatuses import ( + AggregateProductStatus, + ListAggregateProductStatusesRequest, + ListAggregateProductStatusesResponse, +) +from .issueresolution import ( + Action, + ActionFlow, + ActionInput, + Breakdown, + BuiltInSimpleAction, + BuiltInUserInputAction, + Callout, + ContentOption, + ExternalAction, + Impact, + InputField, + InputValue, + RenderAccountIssuesRequest, + RenderAccountIssuesResponse, + RenderedIssue, + RenderIssuesRequestPayload, + RenderProductIssuesRequest, + RenderProductIssuesResponse, + Severity, + TextWithTooltip, + TriggerActionPayload, + TriggerActionRequest, + TriggerActionResponse, + UserInputActionRenderingOption, +) + +__all__ = ( + "AggregateProductStatus", + "ListAggregateProductStatusesRequest", + "ListAggregateProductStatusesResponse", + "Action", + "ActionFlow", + "ActionInput", + "Breakdown", + "BuiltInSimpleAction", + "BuiltInUserInputAction", + "Callout", + "ExternalAction", + "Impact", + "InputField", + "InputValue", + "RenderAccountIssuesRequest", + "RenderAccountIssuesResponse", + "RenderedIssue", + "RenderIssuesRequestPayload", + "RenderProductIssuesRequest", + "RenderProductIssuesResponse", + "TextWithTooltip", + "TriggerActionPayload", + "TriggerActionRequest", + "TriggerActionResponse", + "ContentOption", + "Severity", + "UserInputActionRenderingOption", +) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/types/aggregateproductstatuses.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/types/aggregateproductstatuses.py new file mode 100644 index 000000000000..a699c9fdc4d8 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/types/aggregateproductstatuses.py @@ -0,0 +1,286 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +from google.shopping.type.types import types +import proto # type: ignore + +__protobuf__ = proto.module( + package="google.shopping.merchant.issueresolution.v1", + manifest={ + "ListAggregateProductStatusesRequest", + "ListAggregateProductStatusesResponse", + "AggregateProductStatus", + }, +) + + +class ListAggregateProductStatusesRequest(proto.Message): + r"""Request message for the ``ListAggregateProductStatuses`` method. + + Attributes: + parent (str): + Required. The account to list aggregate product statuses + for. Format: ``accounts/{account}`` + page_size (int): + Optional. The maximum number of aggregate + product statuses to return. The service may + return fewer than this value. If unspecified, at + most 25 aggregate product statuses are returned. + The maximum value is 250; values above 250 are + coerced to 250. + page_token (str): + Optional. A page token, received from a previous + ``ListAggregateProductStatuses`` call. Provide this to + retrieve the subsequent page. + + When paginating, all other parameters provided to + ``ListAggregateProductStatuses`` must match the call that + provided the page token. + filter (str): + Optional. A filter expression that filters the aggregate + product statuses. Filtering is only supported by the + ``reporting_context`` and ``country`` field. For example: + ``reporting_context = "SHOPPING_ADS" AND country = "US"``. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + page_size: int = proto.Field( + proto.INT32, + number=2, + ) + page_token: str = proto.Field( + proto.STRING, + number=3, + ) + filter: str = proto.Field( + proto.STRING, + number=4, + ) + + +class ListAggregateProductStatusesResponse(proto.Message): + r"""Response message for the ``ListAggregateProductStatuses`` method. + + Attributes: + aggregate_product_statuses (MutableSequence[google.shopping.merchant_issueresolution_v1.types.AggregateProductStatus]): + The ``AggregateProductStatuses`` resources for the given + account. + next_page_token (str): + A token, which can be sent as ``pageToken`` to retrieve the + next page. If this field is omitted, there are no subsequent + pages. + """ + + @property + def raw_page(self): + return self + + aggregate_product_statuses: MutableSequence[ + "AggregateProductStatus" + ] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="AggregateProductStatus", + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class AggregateProductStatus(proto.Message): + r"""Aggregate product statuses for a given reporting context and + country. + + Attributes: + name (str): + Identifier. The name of the ``AggregateProductStatuses`` + resource. Format: + ``accounts/{account}/aggregateProductStatuses/{aggregateProductStatuses}`` + reporting_context (google.shopping.type.types.ReportingContext.ReportingContextEnum): + The reporting context of the aggregate + product statuses. + country (str): + The country of the aggregate product statuses. Represented + as a `CLDR territory + code `__. + stats (google.shopping.merchant_issueresolution_v1.types.AggregateProductStatus.Stats): + Products statistics for the given reporting + context and country. + item_level_issues (MutableSequence[google.shopping.merchant_issueresolution_v1.types.AggregateProductStatus.ItemLevelIssue]): + The product issues that affect the given + reporting context and country. + """ + + class Stats(proto.Message): + r"""Products statistics. + + Attributes: + active_count (int): + The number of products that are active. + pending_count (int): + The number of products that are pending. + disapproved_count (int): + The number of products that are disapproved. + expiring_count (int): + The number of products that are expiring. + """ + + active_count: int = proto.Field( + proto.INT64, + number=1, + ) + pending_count: int = proto.Field( + proto.INT64, + number=2, + ) + disapproved_count: int = proto.Field( + proto.INT64, + number=3, + ) + expiring_count: int = proto.Field( + proto.INT64, + number=4, + ) + + class ItemLevelIssue(proto.Message): + r"""The ItemLevelIssue of the product status. + + Attributes: + code (str): + The error code of the issue. + severity (google.shopping.merchant_issueresolution_v1.types.AggregateProductStatus.ItemLevelIssue.Severity): + How this issue affects serving of the offer. + resolution (google.shopping.merchant_issueresolution_v1.types.AggregateProductStatus.ItemLevelIssue.Resolution): + Whether the issue can be resolved by the + merchant. + attribute (str): + The attribute's name, if the issue is caused + by a single attribute. + description (str): + A short issue description in English. + detail (str): + A detailed issue description in English. + documentation_uri (str): + The URL of a web page to help with resolving + this issue. + product_count (int): + The number of products affected by this + issue. + """ + + class Severity(proto.Enum): + r"""How the issue affects the serving of the product. + + Values: + SEVERITY_UNSPECIFIED (0): + Not specified. + NOT_IMPACTED (1): + This issue represents a warning and does not + have a direct affect on the product. + DEMOTED (2): + The product is demoted and most likely have + limited performance in search results + DISAPPROVED (3): + Issue disapproves the product. + """ + SEVERITY_UNSPECIFIED = 0 + NOT_IMPACTED = 1 + DEMOTED = 2 + DISAPPROVED = 3 + + class Resolution(proto.Enum): + r"""How the issue can be resolved. + + Values: + RESOLUTION_UNSPECIFIED (0): + Not specified. + MERCHANT_ACTION (1): + The issue can be resolved by the merchant. + PENDING_PROCESSING (2): + The issue will be resolved auomatically. + """ + RESOLUTION_UNSPECIFIED = 0 + MERCHANT_ACTION = 1 + PENDING_PROCESSING = 2 + + code: str = proto.Field( + proto.STRING, + number=1, + ) + severity: "AggregateProductStatus.ItemLevelIssue.Severity" = proto.Field( + proto.ENUM, + number=2, + enum="AggregateProductStatus.ItemLevelIssue.Severity", + ) + resolution: "AggregateProductStatus.ItemLevelIssue.Resolution" = proto.Field( + proto.ENUM, + number=3, + enum="AggregateProductStatus.ItemLevelIssue.Resolution", + ) + attribute: str = proto.Field( + proto.STRING, + number=4, + ) + description: str = proto.Field( + proto.STRING, + number=6, + ) + detail: str = proto.Field( + proto.STRING, + number=7, + ) + documentation_uri: str = proto.Field( + proto.STRING, + number=8, + ) + product_count: int = proto.Field( + proto.INT64, + number=9, + ) + + name: str = proto.Field( + proto.STRING, + number=1, + ) + reporting_context: types.ReportingContext.ReportingContextEnum = proto.Field( + proto.ENUM, + number=3, + enum=types.ReportingContext.ReportingContextEnum, + ) + country: str = proto.Field( + proto.STRING, + number=4, + ) + stats: Stats = proto.Field( + proto.MESSAGE, + number=5, + message=Stats, + ) + item_level_issues: MutableSequence[ItemLevelIssue] = proto.RepeatedField( + proto.MESSAGE, + number=6, + message=ItemLevelIssue, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/types/issueresolution.py b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/types/issueresolution.py new file mode 100644 index 000000000000..cc45a58c5997 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/google/shopping/merchant_issueresolution_v1/types/issueresolution.py @@ -0,0 +1,1569 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +from __future__ import annotations + +from typing import MutableMapping, MutableSequence + +import proto # type: ignore + +__protobuf__ = proto.module( + package="google.shopping.merchant.issueresolution.v1", + manifest={ + "Severity", + "ContentOption", + "UserInputActionRenderingOption", + "RenderAccountIssuesResponse", + "RenderAccountIssuesRequest", + "RenderIssuesRequestPayload", + "RenderProductIssuesResponse", + "RenderProductIssuesRequest", + "RenderedIssue", + "Impact", + "Breakdown", + "Action", + "BuiltInSimpleAction", + "BuiltInUserInputAction", + "ActionFlow", + "InputField", + "TextWithTooltip", + "Callout", + "ExternalAction", + "TriggerActionRequest", + "TriggerActionPayload", + "TriggerActionResponse", + "ActionInput", + "InputValue", + }, +) + + +class Severity(proto.Enum): + r"""Enum specifying the severity of the issue. + + Values: + SEVERITY_UNSPECIFIED (0): + Default value. Will never be provided by the + API. + ERROR (1): + Causes either an account suspension or an + item disapproval. Errors should be resolved as + soon as possible to ensure items are eligible to + appear in results again. + WARNING (2): + Warnings can negatively impact the + performance of ads and can lead to item or + account suspensions in the future unless the + issue is resolved. + INFO (3): + Infos are suggested optimizations to increase + data quality. Resolving these issues is + recommended, but not required. + """ + SEVERITY_UNSPECIFIED = 0 + ERROR = 1 + WARNING = 2 + INFO = 3 + + +class ContentOption(proto.Enum): + r"""Enum specifying how is the content returned. + + Values: + CONTENT_OPTION_UNSPECIFIED (0): + Default value. Will never be provided by the + API. + PRE_RENDERED_HTML (1): + Returns the detail of the issue as a + pre-rendered HTML text. + """ + CONTENT_OPTION_UNSPECIFIED = 0 + PRE_RENDERED_HTML = 1 + + +class UserInputActionRenderingOption(proto.Enum): + r"""Enum specifying how actions with user input forms, such as + requesting re-review, are handled. + + Values: + USER_INPUT_ACTION_RENDERING_OPTION_UNSPECIFIED (0): + Default value. Will never be provided by the + API. + REDIRECT_TO_MERCHANT_CENTER (1): + Actions that require user input are represented only as + links that points the business to Merchant Center where they + can request the action. Provides easier to implement + alternative to ``BUILT_IN_USER_INPUT_ACTIONS``. + BUILT_IN_USER_INPUT_ACTIONS (2): + Returns content and input form definition for each complex + action. Your application needs to display this content and + input form to the business before they can request + processing of the action. To start the action, your + application needs to call the ``triggeraction`` method. + """ + USER_INPUT_ACTION_RENDERING_OPTION_UNSPECIFIED = 0 + REDIRECT_TO_MERCHANT_CENTER = 1 + BUILT_IN_USER_INPUT_ACTIONS = 2 + + +class RenderAccountIssuesResponse(proto.Message): + r"""Response containing an issue resolution content and actions + for listed account issues. + + Attributes: + rendered_issues (MutableSequence[google.shopping.merchant_issueresolution_v1.types.RenderedIssue]): + List of account issues for a given account. + + This list can be shown with compressed, expandable items. In + the compressed form, the title and impact should be shown + for each issue. Once the issue is expanded, the detailed + [content][google.shopping.merchant.issueresolution.v1.RenderedIssue.prerendered_content] + and available + [actions][google.shopping.merchant.issueresolution.v1.RenderedIssue.actions] + should be rendered. + """ + + rendered_issues: MutableSequence["RenderedIssue"] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="RenderedIssue", + ) + + +class RenderAccountIssuesRequest(proto.Message): + r"""Request to provide issue resolution content and actions for + business's account issues. + + Attributes: + name (str): + Required. The account to fetch issues for. Format: + ``accounts/{account}`` + language_code (str): + Optional. The `IETF + BCP-47 `__ language code + used to localize issue resolution content. If not set, the + result will be in default language ``en-US``. + time_zone (str): + Optional. The `IANA `__ + timezone used to localize times in an issue resolution + content. For example 'America/Los_Angeles'. If not set, + results will use as a default UTC. + payload (google.shopping.merchant_issueresolution_v1.types.RenderIssuesRequestPayload): + Optional. The payload for configuring how the + content should be rendered. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + language_code: str = proto.Field( + proto.STRING, + number=2, + ) + time_zone: str = proto.Field( + proto.STRING, + number=3, + ) + payload: "RenderIssuesRequestPayload" = proto.Field( + proto.MESSAGE, + number=4, + message="RenderIssuesRequestPayload", + ) + + +class RenderIssuesRequestPayload(proto.Message): + r"""The payload for configuring how the content should be + rendered. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + content_option (google.shopping.merchant_issueresolution_v1.types.ContentOption): + Optional. How the detailed content should be + returned. Default option is to return the + content as a pre-rendered HTML text. + + This field is a member of `oneof`_ ``_content_option``. + user_input_action_option (google.shopping.merchant_issueresolution_v1.types.UserInputActionRenderingOption): + Optional. How actions with user input form + should be handled. If not provided, actions will + be returned as links that points the business to + Merchant Center where they can request the + action. + + This field is a member of `oneof`_ ``_user_input_action_option``. + """ + + content_option: "ContentOption" = proto.Field( + proto.ENUM, + number=1, + optional=True, + enum="ContentOption", + ) + user_input_action_option: "UserInputActionRenderingOption" = proto.Field( + proto.ENUM, + number=2, + optional=True, + enum="UserInputActionRenderingOption", + ) + + +class RenderProductIssuesResponse(proto.Message): + r"""Response containing an issue resolution content and actions + for listed product issues. + + Attributes: + rendered_issues (MutableSequence[google.shopping.merchant_issueresolution_v1.types.RenderedIssue]): + List of issues for a given product. + + This list can be shown with compressed, expandable items. In + the compressed form, the + [title][google.shopping.merchant.issueresolution.v1.RenderedIssue.title] + and + [impact][google.shopping.merchant.issueresolution.v1.RenderedIssue.impact] + should be shown for each issue. Once the issue is expanded, + the detailed + [content][google.shopping.merchant.issueresolution.v1.RenderedIssue.prerendered_content] + and available + [actions][google.shopping.merchant.issueresolution.v1.RenderedIssue.actions] + should be rendered. + """ + + rendered_issues: MutableSequence["RenderedIssue"] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="RenderedIssue", + ) + + +class RenderProductIssuesRequest(proto.Message): + r"""Request to provide an issue resolution content and actions + for product issues of business's product. + + Attributes: + name (str): + Required. The name of the product to fetch issues for. + Format: ``accounts/{account}/products/{product}`` + language_code (str): + Optional. The `IETF + BCP-47 `__ language code + used to localize an issue resolution content. If not set, + the result will be in default language ``en-US``. + time_zone (str): + Optional. The `IANA `__ + timezone used to localize times in an issue resolution + content. For example 'America/Los_Angeles'. If not set, + results will use as a default UTC. + payload (google.shopping.merchant_issueresolution_v1.types.RenderIssuesRequestPayload): + Optional. The payload for configuring how the + content should be rendered. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + language_code: str = proto.Field( + proto.STRING, + number=2, + ) + time_zone: str = proto.Field( + proto.STRING, + number=3, + ) + payload: "RenderIssuesRequestPayload" = proto.Field( + proto.MESSAGE, + number=4, + message="RenderIssuesRequestPayload", + ) + + +class RenderedIssue(proto.Message): + r"""An issue affecting specific business or their product. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + prerendered_content (str): + Details of the issue as a pre-rendered HTML. HTML elements + contain CSS classes that can be used to customize the style + of the content. + + Always sanitize the HTML before embedding it directly to + your application. The sanitizer needs to allow basic HTML + tags, such as: ``div``, ``span``, ``p``, ``a``, ``ul``, + ``li``, ``table``, ``tr``, ``td``. For example, you can use + `DOMPurify `__. + + CSS classes: + + - ``issue-detail`` - top level container for the detail of + the issue + - ``callout-banners`` - section of the ``issue-detail`` + with callout banners + - ``callout-banner`` - single callout banner, inside + ``callout-banners`` + - ``callout-banner-info`` - callout with important + information (default) + - ``callout-banner-warning`` - callout with a warning + - ``callout-banner-error`` - callout informing about an + error (most severe) + - ``issue-content`` - section of the ``issue-detail``, + contains multiple ``content-element`` + - ``content-element`` - content element such as a list, + link or paragraph, inside ``issue-content`` + - ``root-causes`` - unordered list with items describing + root causes of the issue, inside ``issue-content`` + - ``root-causes-intro`` - intro text before the + ``root-causes`` list, inside ``issue-content`` + - ``segment`` - section of the text, ``span`` inside + paragraph + - ``segment-attribute`` - section of the text that + represents a product attribute, for example 'image_link' + - ``segment-literal`` - section of the text that contains a + special value, for example '0-1000 kg' + - ``segment-bold`` - section of the text that should be + rendered as bold + - ``segment-italic`` - section of the text that should be + rendered as italic + - ``tooltip`` - used on paragraphs that should be rendered + with a tooltip. A section of the text in such a paragraph + will have a class ``tooltip-text`` and is intended to be + shown in a mouse over dialog. If the style is not used, + the ``tooltip-text`` section would be shown on a new + line, after the main part of the text. + - ``tooltip-text`` - marks a section of the text within a + ``tooltip``, that is intended to be shown in a mouse over + dialog. + - ``tooltip-icon`` - marks a section of the text within a + ``tooltip``, that can be replaced with a tooltip icon, + for example '?' or 'i'. By default, this section contains + a ``br`` tag, that is separating the main text and the + tooltip text when the style is not used. + - ``tooltip-style-question`` - the tooltip shows helpful + information, can use the '?' as an icon. + - ``tooltip-style-info`` - the tooltip adds additional + information fitting to the context, can use the 'i' as an + icon. + - ``content-moderation`` - marks the paragraph that + explains how the issue was identified. + - ``new-element`` - Present for new elements added to the + pre-rendered content in the future. To make sure that a + new content element does not break your style, you can + hide everything with this class. + + This field is a member of `oneof`_ ``content``. + prerendered_out_of_court_dispute_settlement (str): + Pre-rendered HTML that contains a link to the external + location where the ODS can be requested and instructions for + how to request it. HTML elements contain CSS classes that + can be used to customize the style of this snippet. + + Always sanitize the HTML before embedding it directly to + your application. The sanitizer needs to allow basic HTML + tags, such as: ``div``, ``span``, ``p``, ``a``, ``ul``, + ``li``, ``table``, ``tr``, ``td``. For example, you can use + `DOMPurify `__. + + CSS classes: + + - ``ods-section``\ \* - wrapper around the out-of-court + dispute resolution section + - ``ods-description``\ \* - intro text for the out-of-court + dispute resolution. It may contain multiple segments and + a link. + - ``ods-param``\ \* - wrapper around the header-value pair + for parameters that the business may need to provide + during the ODS process. + - ``ods-routing-id``\ \* - ods param for the Routing ID. + - ``ods-reference-id``\ \* - ods param for the Routing ID. + - ``ods-param-header``\ \* - header for the ODS parameter + - ``ods-param-value``\ \* - value of the ODS parameter. + This value should be rendered in a way that it is easy + for the user to identify and copy. + - ``segment`` - section of the text, ``span`` inside + paragraph + - ``segment-attribute`` - section of the text that + represents a product attribute, for example 'image_link' + - ``segment-literal`` - section of the text that contains a + special value, for example '0-1000 kg' + - ``segment-bold`` - section of the text that should be + rendered as bold + - ``segment-italic`` - section of the text that should be + rendered as italic + - ``tooltip`` - used on paragraphs that should be rendered + with a tooltip. A section of the text in such a paragraph + will have a class ``tooltip-text`` and is intended to be + shown in a mouse over dialog. If the style is not used, + the ``tooltip-text`` section would be shown on a new + line, after the main part of the text. + - ``tooltip-text`` - marks a section of the text within a + ``tooltip``, that is intended to be shown in a mouse over + dialog. + - ``tooltip-icon`` - marks a section of the text within a + ``tooltip``, that can be replaced with a tooltip icon, + for example '?' or 'i'. By default, this section contains + a ``br`` tag, that is separating the main text and the + tooltip text when the style is not used. + - ``tooltip-style-question`` - the tooltip shows helpful + information, can use the '?' as an icon. + - ``tooltip-style-info`` - the tooltip adds additional + information fitting to the context, can use the 'i' as an + icon. + + This field is a member of `oneof`_ ``out_of_court_dispute_settlement``. + title (str): + Title of the issue. + impact (google.shopping.merchant_issueresolution_v1.types.Impact): + Clarifies the severity of the issue. + + The [summarizing + message][google.shopping.merchant.issueresolution.v1.Impact.message], + if present, should be shown right under the title for each + issue. It helps business to quickly understand the impact of + the issue. + + The detailed + [breakdown][google.shopping.merchant.issueresolution.v1.Impact.breakdowns] + helps the business to fully understand the impact of the + issue. It can be rendered as dialog that opens when the + business mouse over the summarized impact statement. + + Issues with different + [severity][google.shopping.merchant.issueresolution.v1.Impact.severity] + can be styled differently. They may use a different color or + icon to signal the difference between ``ERROR``, ``WARNING`` + and ``INFO``. + actions (MutableSequence[google.shopping.merchant_issueresolution_v1.types.Action]): + A list of actionable steps that can be + executed to solve the issue. An example is + requesting a re-review or providing arguments + when business disagrees with the issue. + + Actions that are supported in (your) third-party + application can be rendered as buttons and + should be available to the business when they + expand the issue. + """ + + prerendered_content: str = proto.Field( + proto.STRING, + number=3, + oneof="content", + ) + prerendered_out_of_court_dispute_settlement: str = proto.Field( + proto.STRING, + number=5, + oneof="out_of_court_dispute_settlement", + ) + title: str = proto.Field( + proto.STRING, + number=1, + ) + impact: "Impact" = proto.Field( + proto.MESSAGE, + number=2, + message="Impact", + ) + actions: MutableSequence["Action"] = proto.RepeatedField( + proto.MESSAGE, + number=4, + message="Action", + ) + + +class Impact(proto.Message): + r"""Overall impact of the issue. + + Attributes: + message (str): + Optional. Message summarizing the overall + impact of the issue. If present, it should be + rendered to the business. For example: + "Disapproves 90k offers in 25 countries". + severity (google.shopping.merchant_issueresolution_v1.types.Severity): + The severity of the issue. + breakdowns (MutableSequence[google.shopping.merchant_issueresolution_v1.types.Breakdown]): + Detailed impact breakdown. Explains the types + of restriction the issue has in different + shopping destinations and territory. If present, + it should be rendered to the business. Can be + shown as a mouse over dropdown or a dialog. Each + breakdown item represents a group of regions + with the same impact details. + """ + + message: str = proto.Field( + proto.STRING, + number=1, + ) + severity: "Severity" = proto.Field( + proto.ENUM, + number=2, + enum="Severity", + ) + breakdowns: MutableSequence["Breakdown"] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message="Breakdown", + ) + + +class Breakdown(proto.Message): + r"""A detailed impact breakdown for a group of regions where the + impact of the issue on different shopping destinations is the + same. + + Attributes: + regions (MutableSequence[google.shopping.merchant_issueresolution_v1.types.Breakdown.Region]): + Lists of regions. Should be rendered as a + title for this group of details. The full list + should be shown to the business. If the list is + too long, it is recommended to make it + expandable. + details (MutableSequence[str]): + Human readable, localized description of issue's effect on + different targets. Should be rendered as a list. + + For example: + + - "Products not showing in ads" + - "Products not showing organically". + """ + + class Region(proto.Message): + r"""Region with code and localized name. + + Attributes: + code (str): + The [CLDR territory code] + (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) + name (str): + The localized name of the region. + For region with code='001' the value is 'All + countries' or the equivalent in other languages. + """ + + code: str = proto.Field( + proto.STRING, + number=1, + ) + name: str = proto.Field( + proto.STRING, + number=2, + ) + + regions: MutableSequence[Region] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=Region, + ) + details: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=4, + ) + + +class Action(proto.Message): + r"""An actionable step that can be executed to solve the issue. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + builtin_simple_action (google.shopping.merchant_issueresolution_v1.types.BuiltInSimpleAction): + Action implemented and performed in (your) + third-party application. The application should + point the business to the place, where they can + access the corresponding functionality or + provide instructions, if the specific + functionality is not available. + + This field is a member of `oneof`_ ``action``. + external_action (google.shopping.merchant_issueresolution_v1.types.ExternalAction): + Action that is implemented and performed + outside of (your) third-party application. The + application needs to redirect the business to + the external location where they can perform the + action. + + This field is a member of `oneof`_ ``action``. + builtin_user_input_action (google.shopping.merchant_issueresolution_v1.types.BuiltInUserInputAction): + Action implemented and performed in (your) + third-party application. The application needs + to show an additional content and input form to + the business as specified for given action. They + can trigger the action only when they provided + all required inputs. + + This field is a member of `oneof`_ ``action``. + button_label (str): + Label of the action button. + is_available (bool): + Controlling whether the button is active or disabled. The + value is 'false' when the action was already requested or is + not available. If the action is not available then a + [reason][google.shopping.merchant.issueresolution.v1.Action.reasons] + will be present. If (your) third-party application shows a + disabled button for action that is not available, then it + should also show reasons. + reasons (MutableSequence[google.shopping.merchant_issueresolution_v1.types.Action.Reason]): + List of reasons why the action is not + available. The list of reasons is empty if the + action is available. If there is only one + reason, it can be displayed next to the disabled + button. If there are more reasons, all of them + should be displayed, for example in a pop-up + dialog. + """ + + class Reason(proto.Message): + r"""A single reason why the action is not available. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + message (str): + Messages summarizing the reason, why the + action is not available. For example: "Review + requested on Jan 03. Review requests can take a + few days to complete.". + detail (str): + Detailed explanation of the reason. Should be + displayed as a hint if present. + + This field is a member of `oneof`_ ``_detail``. + action (google.shopping.merchant_issueresolution_v1.types.Action): + Optional. An action that needs to be + performed to solve the problem represented by + this reason. This action will always be + available. Should be rendered as a link or + button next to the summarizing message. + + For example, the review may be available only + once the business configure all required + attributes. In such a situation this action can + be a link to the form, where they can fill the + missing attribute to unblock the main action. + + This field is a member of `oneof`_ ``_action``. + """ + + message: str = proto.Field( + proto.STRING, + number=1, + ) + detail: str = proto.Field( + proto.STRING, + number=2, + optional=True, + ) + action: "Action" = proto.Field( + proto.MESSAGE, + number=3, + optional=True, + message="Action", + ) + + builtin_simple_action: "BuiltInSimpleAction" = proto.Field( + proto.MESSAGE, + number=2, + oneof="action", + message="BuiltInSimpleAction", + ) + external_action: "ExternalAction" = proto.Field( + proto.MESSAGE, + number=3, + oneof="action", + message="ExternalAction", + ) + builtin_user_input_action: "BuiltInUserInputAction" = proto.Field( + proto.MESSAGE, + number=7, + oneof="action", + message="BuiltInUserInputAction", + ) + button_label: str = proto.Field( + proto.STRING, + number=4, + ) + is_available: bool = proto.Field( + proto.BOOL, + number=5, + ) + reasons: MutableSequence[Reason] = proto.RepeatedField( + proto.MESSAGE, + number=6, + message=Reason, + ) + + +class BuiltInSimpleAction(proto.Message): + r"""Action that is implemented and performed in (your) + third-party application. Represents various functionality that + is expected to be available to business and will help them with + resolving the issue. The application should point the business + to the place, where they can access the corresponding + functionality. If the functionality is not supported, it is + recommended to explain the situation to the business and provide + them with instructions how to solve the issue. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + type_ (google.shopping.merchant_issueresolution_v1.types.BuiltInSimpleAction.BuiltInSimpleActionType): + The type of action that represents a + functionality that is expected to be available + in third-party application. + attribute_code (str): + The attribute that needs to be updated. Present when the + [type][google.shopping.merchant.issueresolution.v1.BuiltInSimpleAction.type] + is ``EDIT_ITEM_ATTRIBUTE``. + + This field contains a code for attribute, represented in + snake_case. You can find a list of product's attributes, + with their codes + `here `__. + + This field is a member of `oneof`_ ``_attribute_code``. + additional_content (google.shopping.merchant_issueresolution_v1.types.BuiltInSimpleAction.AdditionalContent): + Long text from an external source that should be available + to the business. Present when the + [type][google.shopping.merchant.issueresolution.v1.BuiltInSimpleAction.type] + is ``SHOW_ADDITIONAL_CONTENT``. + + This field is a member of `oneof`_ ``_additional_content``. + """ + + class BuiltInSimpleActionType(proto.Enum): + r"""Enum specifying the type of action in third-party + application. + + Values: + BUILT_IN_SIMPLE_ACTION_TYPE_UNSPECIFIED (0): + Default value. Will never be provided by the + API. + VERIFY_PHONE (1): + Redirect the business to the part of your + application where they can verify their phone. + CLAIM_WEBSITE (2): + Redirect the business to the part of your + application where they can claim their website. + ADD_PRODUCTS (3): + Redirect the business to the part of your + application where they can add products. + ADD_CONTACT_INFO (4): + Open a form where the business can edit their + contact information. + LINK_ADS_ACCOUNT (5): + Redirect the business to the part of your + application where they can link ads account. + ADD_BUSINESS_REGISTRATION_NUMBER (6): + Open a form where the business can add their + business registration number. + EDIT_ITEM_ATTRIBUTE (7): + Open a form where the business can edit an attribute. The + attribute that needs to be updated is specified in + [attribute_code][google.shopping.merchant.issueresolution.v1.BuiltInSimpleAction.attribute_code] + field of the action. + FIX_ACCOUNT_ISSUE (8): + Redirect the business from the product issues + to the diagnostic page with their account issues + in your application. + + This action will be returned only for product + issues that are caused by an account issue and + thus the business should resolve the problem on + the account level. + SHOW_ADDITIONAL_CONTENT (9): + Show [additional + content][google.shopping.merchant.issueresolution.v1.BuiltInSimpleAction.additional_content] + to the business. + + This action will be used for example to deliver a + justification from national authority. + """ + BUILT_IN_SIMPLE_ACTION_TYPE_UNSPECIFIED = 0 + VERIFY_PHONE = 1 + CLAIM_WEBSITE = 2 + ADD_PRODUCTS = 3 + ADD_CONTACT_INFO = 4 + LINK_ADS_ACCOUNT = 5 + ADD_BUSINESS_REGISTRATION_NUMBER = 6 + EDIT_ITEM_ATTRIBUTE = 7 + FIX_ACCOUNT_ISSUE = 8 + SHOW_ADDITIONAL_CONTENT = 9 + + class AdditionalContent(proto.Message): + r"""Long text from external source. + + Attributes: + title (str): + Title of the additional content; + paragraphs (MutableSequence[str]): + Long text organized into paragraphs. + """ + + title: str = proto.Field( + proto.STRING, + number=1, + ) + paragraphs: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=2, + ) + + type_: BuiltInSimpleActionType = proto.Field( + proto.ENUM, + number=1, + enum=BuiltInSimpleActionType, + ) + attribute_code: str = proto.Field( + proto.STRING, + number=2, + optional=True, + ) + additional_content: AdditionalContent = proto.Field( + proto.MESSAGE, + number=3, + optional=True, + message=AdditionalContent, + ) + + +class BuiltInUserInputAction(proto.Message): + r"""Action that is implemented and performed in (your) third-party + application. The application needs to show an additional content and + input form to the business. They can start the action only when they + provided all required inputs. The application will request + processing of the action by calling the `triggeraction + method `__. + + Attributes: + action_context (str): + Contains the action's context that must be included as part + of the + [TriggerActionPayload.action_context][google.shopping.merchant.issueresolution.v1.TriggerActionPayload.action_context] + in + [TriggerActionRequest.payload][google.shopping.merchant.issueresolution.v1.TriggerActionRequest.payload] + to call the ``triggeraction`` method. The content should be + treated as opaque and must not be modified. + flows (MutableSequence[google.shopping.merchant_issueresolution_v1.types.ActionFlow]): + Actions may provide multiple different flows. + Business selects one that fits best to their + intent. Selecting the flow is the first step in + user's interaction with the action. It affects + what input fields will be available and required + and also how the request will be processed. + """ + + action_context: str = proto.Field( + proto.STRING, + number=1, + ) + flows: MutableSequence["ActionFlow"] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message="ActionFlow", + ) + + +class ActionFlow(proto.Message): + r"""Flow that can be selected for an action. When a business + selects a flow, application should open a dialog with more + information and input form. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + id (str): + Not for display but need to be sent back for + the selected action flow. + label (str): + Text value describing the intent for the + action flow. It can be used as an input label if + business needs to pick one of multiple flows. + For example: + + "I disagree with the issue". + inputs (MutableSequence[google.shopping.merchant_issueresolution_v1.types.InputField]): + A list of input fields. + dialog_title (str): + Title of the request dialog. For example: + "Before you request a review". + dialog_message (google.shopping.merchant_issueresolution_v1.types.TextWithTooltip): + Message displayed in the request dialog. For + example: "Make sure you've fixed all your + country-specific issues. If not, you may have to + wait 7 days to request another review". There + may be an more information to be shown in a + tooltip. + + This field is a member of `oneof`_ ``_dialog_message``. + dialog_callout (google.shopping.merchant_issueresolution_v1.types.Callout): + Important message to be highlighted in the + request dialog. For example: "You can only + request a review for disagreeing with this issue + once. If it's not approved, you'll need to fix + the issue and wait a few days before you can + request another review.". + + This field is a member of `oneof`_ ``_dialog_callout``. + dialog_button_label (str): + Label for the button to trigger the action + from the action dialog. For example: "Request + review". + """ + + id: str = proto.Field( + proto.STRING, + number=1, + ) + label: str = proto.Field( + proto.STRING, + number=2, + ) + inputs: MutableSequence["InputField"] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message="InputField", + ) + dialog_title: str = proto.Field( + proto.STRING, + number=4, + ) + dialog_message: "TextWithTooltip" = proto.Field( + proto.MESSAGE, + number=7, + optional=True, + message="TextWithTooltip", + ) + dialog_callout: "Callout" = proto.Field( + proto.MESSAGE, + number=8, + optional=True, + message="Callout", + ) + dialog_button_label: str = proto.Field( + proto.STRING, + number=9, + ) + + +class InputField(proto.Message): + r"""Input field that needs to be available to the business. If + the field is marked as required, then a value needs to be + provided for a successful processing of the request. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + text_input (google.shopping.merchant_issueresolution_v1.types.InputField.TextInput): + Input field to provide text information. Corresponds to the + `html input + type=text `__ + or `html + textarea `__. + + This field is a member of `oneof`_ ``value_input``. + choice_input (google.shopping.merchant_issueresolution_v1.types.InputField.ChoiceInput): + Input field to select one of the offered choices. + Corresponds to the `html input + type=radio `__. + + This field is a member of `oneof`_ ``value_input``. + checkbox_input (google.shopping.merchant_issueresolution_v1.types.InputField.CheckboxInput): + Input field to provide a boolean value. Corresponds to the + `html input + type=checkbox `__. + + This field is a member of `oneof`_ ``value_input``. + id (str): + Not for display but need to be sent back for + the given input field. + label (google.shopping.merchant_issueresolution_v1.types.TextWithTooltip): + Input field label. There may be more + information to be shown in a tooltip. + required (bool): + Whether the field is required. The action + button needs to stay disabled till values for + all required fields are provided. + """ + + class TextInput(proto.Message): + r"""Text input allows the business to provide a text value. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + type_ (google.shopping.merchant_issueresolution_v1.types.InputField.TextInput.TextInputType): + Type of the text input + additional_info (google.shopping.merchant_issueresolution_v1.types.TextWithTooltip): + Additional info regarding the field to be + displayed to the business. For example, warning + to not include personal identifiable + information. There may be more information to be + shown in a tooltip. + + This field is a member of `oneof`_ ``_additional_info``. + format_info (str): + Information about the required format. If + present, it should be shown close to the input + field to help the business to provide a correct + value. For example: "VAT numbers should be in a + format similar to SK9999999999". + + This field is a member of `oneof`_ ``_format_info``. + aria_label (str): + Text to be used as the + `aria-label `__ + for the input. + + This field is a member of `oneof`_ ``_aria_label``. + """ + + class TextInputType(proto.Enum): + r"""Enum specifying the type of the text input and how it should + be rendered. + + Values: + TEXT_INPUT_TYPE_UNSPECIFIED (0): + Default value. Will never be provided by the + API. + GENERIC_SHORT_TEXT (1): + Used when a short text is expected. The field can be + rendered as a `text + field `__. + GENERIC_LONG_TEXT (2): + Used when a longer text is expected. The field should be + rendered as a + `textarea `__. + """ + TEXT_INPUT_TYPE_UNSPECIFIED = 0 + GENERIC_SHORT_TEXT = 1 + GENERIC_LONG_TEXT = 2 + + type_: "InputField.TextInput.TextInputType" = proto.Field( + proto.ENUM, + number=1, + enum="InputField.TextInput.TextInputType", + ) + additional_info: "TextWithTooltip" = proto.Field( + proto.MESSAGE, + number=2, + optional=True, + message="TextWithTooltip", + ) + format_info: str = proto.Field( + proto.STRING, + number=3, + optional=True, + ) + aria_label: str = proto.Field( + proto.STRING, + number=4, + optional=True, + ) + + class ChoiceInput(proto.Message): + r"""Choice input allows the business to select one of the offered + choices. Some choices may be linked to additional input fields + that should be displayed under or next to the choice option. The + value for the additional input field needs to be provided only + when the specific choice is selected by the the business. For + example, additional input field can be hidden or disabled until + the business selects the specific choice. + + Attributes: + options (MutableSequence[google.shopping.merchant_issueresolution_v1.types.InputField.ChoiceInput.ChoiceInputOption]): + A list of choices. Only one option can be + selected. + """ + + class ChoiceInputOption(proto.Message): + r"""A choice that the business can select. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + id (str): + Not for display but need to be sent back for + the selected choice option. + label (google.shopping.merchant_issueresolution_v1.types.TextWithTooltip): + Short description of the choice option. There + may be more information to be shown as a + tooltip. + additional_input (google.shopping.merchant_issueresolution_v1.types.InputField): + Input that should be displayed when this option is selected. + The additional input will not contain a ``ChoiceInput``. + + This field is a member of `oneof`_ ``_additional_input``. + """ + + id: str = proto.Field( + proto.STRING, + number=1, + ) + label: "TextWithTooltip" = proto.Field( + proto.MESSAGE, + number=2, + message="TextWithTooltip", + ) + additional_input: "InputField" = proto.Field( + proto.MESSAGE, + number=3, + optional=True, + message="InputField", + ) + + options: MutableSequence[ + "InputField.ChoiceInput.ChoiceInputOption" + ] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="InputField.ChoiceInput.ChoiceInputOption", + ) + + class CheckboxInput(proto.Message): + r"""Checkbox input allows the business to provide a boolean value. + Corresponds to the `html input + type=checkbox `__. + + If the business checks the box, the input value for the field is + ``true``, otherwise it is ``false``. + + This type of input is often used as a confirmation that the business + completed required steps before they are allowed to start the + action. In such a case, the input field is marked as + [required][google.shopping.merchant.issueresolution.v1.InputField.required] + and the button to trigger the action should stay disabled until the + business checks the box. + + """ + + text_input: TextInput = proto.Field( + proto.MESSAGE, + number=4, + oneof="value_input", + message=TextInput, + ) + choice_input: ChoiceInput = proto.Field( + proto.MESSAGE, + number=5, + oneof="value_input", + message=ChoiceInput, + ) + checkbox_input: CheckboxInput = proto.Field( + proto.MESSAGE, + number=6, + oneof="value_input", + message=CheckboxInput, + ) + id: str = proto.Field( + proto.STRING, + number=1, + ) + label: "TextWithTooltip" = proto.Field( + proto.MESSAGE, + number=2, + message="TextWithTooltip", + ) + required: bool = proto.Field( + proto.BOOL, + number=3, + ) + + +class TextWithTooltip(proto.Message): + r"""Block of text that may contain a tooltip with more + information. + + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + simple_value (str): + Value of the message as a simple text. + + This field is a member of `oneof`_ ``value``. + simple_tooltip_value (str): + Value of the tooltip as a simple text. + + This field is a member of `oneof`_ ``tooltip_value``. + tooltip_icon_style (google.shopping.merchant_issueresolution_v1.types.TextWithTooltip.TooltipIconStyle): + The suggested type of an icon for tooltip, if + a tooltip is present. + """ + + class TooltipIconStyle(proto.Enum): + r"""Enum specifying the type of an icon that is being used to + display a corresponding tooltip in the Merchant Center. + + Values: + TOOLTIP_ICON_STYLE_UNSPECIFIED (0): + Default value. Will never be provided by the + API. + INFO (1): + Used when the tooltip adds additional + information to the context, the 'i' can be used + as an icon. + QUESTION (2): + Used when the tooltip shows helpful + information, the '?' can be used as an icon. + """ + TOOLTIP_ICON_STYLE_UNSPECIFIED = 0 + INFO = 1 + QUESTION = 2 + + simple_value: str = proto.Field( + proto.STRING, + number=1, + oneof="value", + ) + simple_tooltip_value: str = proto.Field( + proto.STRING, + number=2, + oneof="tooltip_value", + ) + tooltip_icon_style: TooltipIconStyle = proto.Field( + proto.ENUM, + number=3, + enum=TooltipIconStyle, + ) + + +class Callout(proto.Message): + r"""An important message that should be highlighted. Usually + displayed as a banner. + + Attributes: + style_hint (google.shopping.merchant_issueresolution_v1.types.Callout.CalloutStyleHint): + Can be used to render messages with different + severity in different styles. Snippets off all + types contain important information that should + be displayed to the business. + full_message (google.shopping.merchant_issueresolution_v1.types.TextWithTooltip): + A full message that needs to be shown to the + business. + """ + + class CalloutStyleHint(proto.Enum): + r"""Enum specifying the suggested style, how the message should + be rendered. + + Values: + CALLOUT_STYLE_HINT_UNSPECIFIED (0): + Default value. Will never be provided by the + API. + ERROR (1): + The most important type of information + highlighting problems, like an unsuccessful + outcome of previously requested actions. + WARNING (2): + Information warning about pending problems, + risks or deadlines. + INFO (3): + Default severity for important information + like pending status of previously requested + action or cooldown for re-review. + """ + CALLOUT_STYLE_HINT_UNSPECIFIED = 0 + ERROR = 1 + WARNING = 2 + INFO = 3 + + style_hint: CalloutStyleHint = proto.Field( + proto.ENUM, + number=1, + enum=CalloutStyleHint, + ) + full_message: "TextWithTooltip" = proto.Field( + proto.MESSAGE, + number=3, + message="TextWithTooltip", + ) + + +class ExternalAction(proto.Message): + r"""Action that is implemented and performed outside of the + third-party application. It should redirect the business to the + provided URL of an external system where they can perform the + action. For example to request a review in the Merchant Center. + + Attributes: + type_ (google.shopping.merchant_issueresolution_v1.types.ExternalAction.ExternalActionType): + The type of external action. + uri (str): + URL to external system, for example Merchant + Center, where the business can perform the + action. + """ + + class ExternalActionType(proto.Enum): + r"""Enum specifying the type of action that requires to redirect + the business to an external location. + + Values: + EXTERNAL_ACTION_TYPE_UNSPECIFIED (0): + Default value. Will never be provided by the + API. + REVIEW_PRODUCT_ISSUE_IN_MERCHANT_CENTER (1): + Redirect to Merchant Center where the + business can request a review for issue related + to their product. + REVIEW_ACCOUNT_ISSUE_IN_MERCHANT_CENTER (2): + Redirect to Merchant Center where the + business can request a review for issue related + to their account. + LEGAL_APPEAL_IN_HELP_CENTER (3): + Redirect to the form in Help Center where the + business can request a legal appeal for the + issue. + VERIFY_IDENTITY_IN_MERCHANT_CENTER (4): + Redirect to Merchant Center where the + business can perform identity verification. + """ + EXTERNAL_ACTION_TYPE_UNSPECIFIED = 0 + REVIEW_PRODUCT_ISSUE_IN_MERCHANT_CENTER = 1 + REVIEW_ACCOUNT_ISSUE_IN_MERCHANT_CENTER = 2 + LEGAL_APPEAL_IN_HELP_CENTER = 3 + VERIFY_IDENTITY_IN_MERCHANT_CENTER = 4 + + type_: ExternalActionType = proto.Field( + proto.ENUM, + number=1, + enum=ExternalActionType, + ) + uri: str = proto.Field( + proto.STRING, + number=2, + ) + + +class TriggerActionRequest(proto.Message): + r"""Request to start the selected action + + Attributes: + name (str): + Required. The business's account that is triggering the + action. Format: ``accounts/{account}`` + payload (google.shopping.merchant_issueresolution_v1.types.TriggerActionPayload): + Required. The payload for the triggered + action. + language_code (str): + Optional. Language code `IETF BCP 47 + syntax `__ used to + localize the response. If not set, the result will be in + default language ``en-US``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + payload: "TriggerActionPayload" = proto.Field( + proto.MESSAGE, + number=2, + message="TriggerActionPayload", + ) + language_code: str = proto.Field( + proto.STRING, + number=3, + ) + + +class TriggerActionPayload(proto.Message): + r"""The payload for the triggered action. + + Attributes: + action_context (str): + Required. The + [context][google.shopping.merchant.issueresolution.v1.BuiltInUserInputAction.action_context] + from the selected action. The value is obtained from + rendered issues and needs to be sent back to identify the + [action][google.shopping.merchant.issueresolution.v1.Action.builtin_user_input_action] + that is being triggered. + action_input (google.shopping.merchant_issueresolution_v1.types.ActionInput): + Required. Input provided by the business. + """ + + action_context: str = proto.Field( + proto.STRING, + number=1, + ) + action_input: "ActionInput" = proto.Field( + proto.MESSAGE, + number=2, + message="ActionInput", + ) + + +class TriggerActionResponse(proto.Message): + r"""Response informing about the started action. + + Attributes: + message (str): + The message for the business. + """ + + message: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ActionInput(proto.Message): + r"""Input provided by the business. + + Attributes: + action_flow_id (str): + Required. + [Id][google.shopping.merchant.issueresolution.v1.ActionFlow.id] + of the selected action flow. + input_values (MutableSequence[google.shopping.merchant_issueresolution_v1.types.InputValue]): + Required. Values for input fields. + """ + + action_flow_id: str = proto.Field( + proto.STRING, + number=1, + ) + input_values: MutableSequence["InputValue"] = proto.RepeatedField( + proto.MESSAGE, + number=2, + message="InputValue", + ) + + +class InputValue(proto.Message): + r"""Input provided by the business for input field. + + This message has `oneof`_ fields (mutually exclusive fields). + For each oneof, at most one member field can be set at the same time. + Setting any member of the oneof automatically clears all other + members. + + .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields + + Attributes: + text_input_value (google.shopping.merchant_issueresolution_v1.types.InputValue.TextInputValue): + Value for [text + input][google.shopping.merchant.issueresolution.v1.InputField.TextInput] + field. + + This field is a member of `oneof`_ ``value``. + choice_input_value (google.shopping.merchant_issueresolution_v1.types.InputValue.ChoiceInputValue): + Value for [choice + input][google.shopping.merchant.issueresolution.v1.InputField.ChoiceInput] + field. + + This field is a member of `oneof`_ ``value``. + checkbox_input_value (google.shopping.merchant_issueresolution_v1.types.InputValue.CheckboxInputValue): + Value for [checkbox + input][google.shopping.merchant.issueresolution.v1.InputField.CheckboxInput] + field. + + This field is a member of `oneof`_ ``value``. + input_field_id (str): + Required. + [Id][google.shopping.merchant.issueresolution.v1.InputField.id] + of the corresponding input field. + """ + + class TextInputValue(proto.Message): + r"""Value for [text + input][google.shopping.merchant.issueresolution.v1.InputField.TextInput] + field. + + Attributes: + value (str): + Required. Text provided by the business. + """ + + value: str = proto.Field( + proto.STRING, + number=1, + ) + + class ChoiceInputValue(proto.Message): + r"""Value for [choice + input][google.shopping.merchant.issueresolution.v1.InputField.ChoiceInput] + field. + + Attributes: + choice_input_option_id (str): + Required. [Id][InputField.ChoiceInput.id] of the option that + was selected by the business. + """ + + choice_input_option_id: str = proto.Field( + proto.STRING, + number=1, + ) + + class CheckboxInputValue(proto.Message): + r"""Value for [checkbox + input][google.shopping.merchant.issueresolution.v1.InputField.CheckboxInput] + field. + + Attributes: + value (bool): + Required. True if the business checked the + box field. False otherwise. + """ + + value: bool = proto.Field( + proto.BOOL, + number=1, + ) + + text_input_value: TextInputValue = proto.Field( + proto.MESSAGE, + number=2, + oneof="value", + message=TextInputValue, + ) + choice_input_value: ChoiceInputValue = proto.Field( + proto.MESSAGE, + number=3, + oneof="value", + message=ChoiceInputValue, + ) + checkbox_input_value: CheckboxInputValue = proto.Field( + proto.MESSAGE, + number=4, + oneof="value", + message=CheckboxInputValue, + ) + input_field_id: str = proto.Field( + proto.STRING, + number=1, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_aggregate_product_statuses_service_list_aggregate_product_statuses_async.py b/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_aggregate_product_statuses_service_list_aggregate_product_statuses_async.py new file mode 100644 index 000000000000..e96f4ef5402f --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_aggregate_product_statuses_service_list_aggregate_product_statuses_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListAggregateProductStatuses +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-shopping-merchant-issueresolution + + +# [START merchantapi_v1_generated_AggregateProductStatusesService_ListAggregateProductStatuses_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.shopping import merchant_issueresolution_v1 + + +async def sample_list_aggregate_product_statuses(): + # Create a client + client = merchant_issueresolution_v1.AggregateProductStatusesServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_issueresolution_v1.ListAggregateProductStatusesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_aggregate_product_statuses(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END merchantapi_v1_generated_AggregateProductStatusesService_ListAggregateProductStatuses_async] diff --git a/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_aggregate_product_statuses_service_list_aggregate_product_statuses_sync.py b/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_aggregate_product_statuses_service_list_aggregate_product_statuses_sync.py new file mode 100644 index 000000000000..26ff844d49c7 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_aggregate_product_statuses_service_list_aggregate_product_statuses_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListAggregateProductStatuses +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-shopping-merchant-issueresolution + + +# [START merchantapi_v1_generated_AggregateProductStatusesService_ListAggregateProductStatuses_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.shopping import merchant_issueresolution_v1 + + +def sample_list_aggregate_product_statuses(): + # Create a client + client = merchant_issueresolution_v1.AggregateProductStatusesServiceClient() + + # Initialize request argument(s) + request = merchant_issueresolution_v1.ListAggregateProductStatusesRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_aggregate_product_statuses(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END merchantapi_v1_generated_AggregateProductStatusesService_ListAggregateProductStatuses_sync] diff --git a/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_issue_resolution_service_render_account_issues_async.py b/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_issue_resolution_service_render_account_issues_async.py new file mode 100644 index 000000000000..a1d1817f7f07 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_issue_resolution_service_render_account_issues_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RenderAccountIssues +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-shopping-merchant-issueresolution + + +# [START merchantapi_v1_generated_IssueResolutionService_RenderAccountIssues_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.shopping import merchant_issueresolution_v1 + + +async def sample_render_account_issues(): + # Create a client + client = merchant_issueresolution_v1.IssueResolutionServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_issueresolution_v1.RenderAccountIssuesRequest( + name="name_value", + ) + + # Make the request + response = await client.render_account_issues(request=request) + + # Handle the response + print(response) + +# [END merchantapi_v1_generated_IssueResolutionService_RenderAccountIssues_async] diff --git a/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_issue_resolution_service_render_account_issues_sync.py b/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_issue_resolution_service_render_account_issues_sync.py new file mode 100644 index 000000000000..49642d60f42a --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_issue_resolution_service_render_account_issues_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RenderAccountIssues +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-shopping-merchant-issueresolution + + +# [START merchantapi_v1_generated_IssueResolutionService_RenderAccountIssues_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.shopping import merchant_issueresolution_v1 + + +def sample_render_account_issues(): + # Create a client + client = merchant_issueresolution_v1.IssueResolutionServiceClient() + + # Initialize request argument(s) + request = merchant_issueresolution_v1.RenderAccountIssuesRequest( + name="name_value", + ) + + # Make the request + response = client.render_account_issues(request=request) + + # Handle the response + print(response) + +# [END merchantapi_v1_generated_IssueResolutionService_RenderAccountIssues_sync] diff --git a/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_issue_resolution_service_render_product_issues_async.py b/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_issue_resolution_service_render_product_issues_async.py new file mode 100644 index 000000000000..2f7c08668ea7 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_issue_resolution_service_render_product_issues_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RenderProductIssues +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-shopping-merchant-issueresolution + + +# [START merchantapi_v1_generated_IssueResolutionService_RenderProductIssues_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.shopping import merchant_issueresolution_v1 + + +async def sample_render_product_issues(): + # Create a client + client = merchant_issueresolution_v1.IssueResolutionServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_issueresolution_v1.RenderProductIssuesRequest( + name="name_value", + ) + + # Make the request + response = await client.render_product_issues(request=request) + + # Handle the response + print(response) + +# [END merchantapi_v1_generated_IssueResolutionService_RenderProductIssues_async] diff --git a/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_issue_resolution_service_render_product_issues_sync.py b/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_issue_resolution_service_render_product_issues_sync.py new file mode 100644 index 000000000000..7f7ab7a39171 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_issue_resolution_service_render_product_issues_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RenderProductIssues +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-shopping-merchant-issueresolution + + +# [START merchantapi_v1_generated_IssueResolutionService_RenderProductIssues_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.shopping import merchant_issueresolution_v1 + + +def sample_render_product_issues(): + # Create a client + client = merchant_issueresolution_v1.IssueResolutionServiceClient() + + # Initialize request argument(s) + request = merchant_issueresolution_v1.RenderProductIssuesRequest( + name="name_value", + ) + + # Make the request + response = client.render_product_issues(request=request) + + # Handle the response + print(response) + +# [END merchantapi_v1_generated_IssueResolutionService_RenderProductIssues_sync] diff --git a/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_issue_resolution_service_trigger_action_async.py b/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_issue_resolution_service_trigger_action_async.py new file mode 100644 index 000000000000..575106300771 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_issue_resolution_service_trigger_action_async.py @@ -0,0 +1,59 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for TriggerAction +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-shopping-merchant-issueresolution + + +# [START merchantapi_v1_generated_IssueResolutionService_TriggerAction_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.shopping import merchant_issueresolution_v1 + + +async def sample_trigger_action(): + # Create a client + client = merchant_issueresolution_v1.IssueResolutionServiceAsyncClient() + + # Initialize request argument(s) + payload = merchant_issueresolution_v1.TriggerActionPayload() + payload.action_context = "action_context_value" + payload.action_input.action_flow_id = "action_flow_id_value" + payload.action_input.input_values.text_input_value.value = "value_value" + payload.action_input.input_values.input_field_id = "input_field_id_value" + + request = merchant_issueresolution_v1.TriggerActionRequest( + name="name_value", + payload=payload, + ) + + # Make the request + response = await client.trigger_action(request=request) + + # Handle the response + print(response) + +# [END merchantapi_v1_generated_IssueResolutionService_TriggerAction_async] diff --git a/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_issue_resolution_service_trigger_action_sync.py b/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_issue_resolution_service_trigger_action_sync.py new file mode 100644 index 000000000000..5007871df479 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/samples/generated_samples/merchantapi_v1_generated_issue_resolution_service_trigger_action_sync.py @@ -0,0 +1,59 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for TriggerAction +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-shopping-merchant-issueresolution + + +# [START merchantapi_v1_generated_IssueResolutionService_TriggerAction_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.shopping import merchant_issueresolution_v1 + + +def sample_trigger_action(): + # Create a client + client = merchant_issueresolution_v1.IssueResolutionServiceClient() + + # Initialize request argument(s) + payload = merchant_issueresolution_v1.TriggerActionPayload() + payload.action_context = "action_context_value" + payload.action_input.action_flow_id = "action_flow_id_value" + payload.action_input.input_values.text_input_value.value = "value_value" + payload.action_input.input_values.input_field_id = "input_field_id_value" + + request = merchant_issueresolution_v1.TriggerActionRequest( + name="name_value", + payload=payload, + ) + + # Make the request + response = client.trigger_action(request=request) + + # Handle the response + print(response) + +# [END merchantapi_v1_generated_IssueResolutionService_TriggerAction_sync] diff --git a/packages/google-shopping-merchant-issueresolution/samples/generated_samples/snippet_metadata_google.shopping.merchant.issueresolution.v1.json b/packages/google-shopping-merchant-issueresolution/samples/generated_samples/snippet_metadata_google.shopping.merchant.issueresolution.v1.json new file mode 100644 index 000000000000..39863203dfe0 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/samples/generated_samples/snippet_metadata_google.shopping.merchant.issueresolution.v1.json @@ -0,0 +1,659 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.shopping.merchant.issueresolution.v1", + "version": "v1" + } + ], + "language": "PYTHON", + "name": "google-shopping-merchant-issueresolution", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.shopping.merchant_issueresolution_v1.AggregateProductStatusesServiceAsyncClient", + "shortName": "AggregateProductStatusesServiceAsyncClient" + }, + "fullName": "google.shopping.merchant_issueresolution_v1.AggregateProductStatusesServiceAsyncClient.list_aggregate_product_statuses", + "method": { + "fullName": "google.shopping.merchant.issueresolution.v1.AggregateProductStatusesService.ListAggregateProductStatuses", + "service": { + "fullName": "google.shopping.merchant.issueresolution.v1.AggregateProductStatusesService", + "shortName": "AggregateProductStatusesService" + }, + "shortName": "ListAggregateProductStatuses" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_issueresolution_v1.types.ListAggregateProductStatusesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.shopping.merchant_issueresolution_v1.services.aggregate_product_statuses_service.pagers.ListAggregateProductStatusesAsyncPager", + "shortName": "list_aggregate_product_statuses" + }, + "description": "Sample for ListAggregateProductStatuses", + "file": "merchantapi_v1_generated_aggregate_product_statuses_service_list_aggregate_product_statuses_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_AggregateProductStatusesService_ListAggregateProductStatuses_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_aggregate_product_statuses_service_list_aggregate_product_statuses_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.shopping.merchant_issueresolution_v1.AggregateProductStatusesServiceClient", + "shortName": "AggregateProductStatusesServiceClient" + }, + "fullName": "google.shopping.merchant_issueresolution_v1.AggregateProductStatusesServiceClient.list_aggregate_product_statuses", + "method": { + "fullName": "google.shopping.merchant.issueresolution.v1.AggregateProductStatusesService.ListAggregateProductStatuses", + "service": { + "fullName": "google.shopping.merchant.issueresolution.v1.AggregateProductStatusesService", + "shortName": "AggregateProductStatusesService" + }, + "shortName": "ListAggregateProductStatuses" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_issueresolution_v1.types.ListAggregateProductStatusesRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.shopping.merchant_issueresolution_v1.services.aggregate_product_statuses_service.pagers.ListAggregateProductStatusesPager", + "shortName": "list_aggregate_product_statuses" + }, + "description": "Sample for ListAggregateProductStatuses", + "file": "merchantapi_v1_generated_aggregate_product_statuses_service_list_aggregate_product_statuses_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_AggregateProductStatusesService_ListAggregateProductStatuses_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_aggregate_product_statuses_service_list_aggregate_product_statuses_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.shopping.merchant_issueresolution_v1.IssueResolutionServiceAsyncClient", + "shortName": "IssueResolutionServiceAsyncClient" + }, + "fullName": "google.shopping.merchant_issueresolution_v1.IssueResolutionServiceAsyncClient.render_account_issues", + "method": { + "fullName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService.RenderAccountIssues", + "service": { + "fullName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "shortName": "IssueResolutionService" + }, + "shortName": "RenderAccountIssues" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_issueresolution_v1.types.RenderAccountIssuesRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.shopping.merchant_issueresolution_v1.types.RenderAccountIssuesResponse", + "shortName": "render_account_issues" + }, + "description": "Sample for RenderAccountIssues", + "file": "merchantapi_v1_generated_issue_resolution_service_render_account_issues_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_IssueResolutionService_RenderAccountIssues_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_issue_resolution_service_render_account_issues_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.shopping.merchant_issueresolution_v1.IssueResolutionServiceClient", + "shortName": "IssueResolutionServiceClient" + }, + "fullName": "google.shopping.merchant_issueresolution_v1.IssueResolutionServiceClient.render_account_issues", + "method": { + "fullName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService.RenderAccountIssues", + "service": { + "fullName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "shortName": "IssueResolutionService" + }, + "shortName": "RenderAccountIssues" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_issueresolution_v1.types.RenderAccountIssuesRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.shopping.merchant_issueresolution_v1.types.RenderAccountIssuesResponse", + "shortName": "render_account_issues" + }, + "description": "Sample for RenderAccountIssues", + "file": "merchantapi_v1_generated_issue_resolution_service_render_account_issues_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_IssueResolutionService_RenderAccountIssues_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_issue_resolution_service_render_account_issues_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.shopping.merchant_issueresolution_v1.IssueResolutionServiceAsyncClient", + "shortName": "IssueResolutionServiceAsyncClient" + }, + "fullName": "google.shopping.merchant_issueresolution_v1.IssueResolutionServiceAsyncClient.render_product_issues", + "method": { + "fullName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService.RenderProductIssues", + "service": { + "fullName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "shortName": "IssueResolutionService" + }, + "shortName": "RenderProductIssues" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_issueresolution_v1.types.RenderProductIssuesRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.shopping.merchant_issueresolution_v1.types.RenderProductIssuesResponse", + "shortName": "render_product_issues" + }, + "description": "Sample for RenderProductIssues", + "file": "merchantapi_v1_generated_issue_resolution_service_render_product_issues_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_IssueResolutionService_RenderProductIssues_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_issue_resolution_service_render_product_issues_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.shopping.merchant_issueresolution_v1.IssueResolutionServiceClient", + "shortName": "IssueResolutionServiceClient" + }, + "fullName": "google.shopping.merchant_issueresolution_v1.IssueResolutionServiceClient.render_product_issues", + "method": { + "fullName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService.RenderProductIssues", + "service": { + "fullName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "shortName": "IssueResolutionService" + }, + "shortName": "RenderProductIssues" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_issueresolution_v1.types.RenderProductIssuesRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.shopping.merchant_issueresolution_v1.types.RenderProductIssuesResponse", + "shortName": "render_product_issues" + }, + "description": "Sample for RenderProductIssues", + "file": "merchantapi_v1_generated_issue_resolution_service_render_product_issues_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_IssueResolutionService_RenderProductIssues_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_issue_resolution_service_render_product_issues_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.shopping.merchant_issueresolution_v1.IssueResolutionServiceAsyncClient", + "shortName": "IssueResolutionServiceAsyncClient" + }, + "fullName": "google.shopping.merchant_issueresolution_v1.IssueResolutionServiceAsyncClient.trigger_action", + "method": { + "fullName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService.TriggerAction", + "service": { + "fullName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "shortName": "IssueResolutionService" + }, + "shortName": "TriggerAction" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_issueresolution_v1.types.TriggerActionRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.shopping.merchant_issueresolution_v1.types.TriggerActionResponse", + "shortName": "trigger_action" + }, + "description": "Sample for TriggerAction", + "file": "merchantapi_v1_generated_issue_resolution_service_trigger_action_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_IssueResolutionService_TriggerAction_async", + "segments": [ + { + "end": 58, + "start": 27, + "type": "FULL" + }, + { + "end": 58, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 52, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 55, + "start": 53, + "type": "REQUEST_EXECUTION" + }, + { + "end": 59, + "start": 56, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_issue_resolution_service_trigger_action_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.shopping.merchant_issueresolution_v1.IssueResolutionServiceClient", + "shortName": "IssueResolutionServiceClient" + }, + "fullName": "google.shopping.merchant_issueresolution_v1.IssueResolutionServiceClient.trigger_action", + "method": { + "fullName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService.TriggerAction", + "service": { + "fullName": "google.shopping.merchant.issueresolution.v1.IssueResolutionService", + "shortName": "IssueResolutionService" + }, + "shortName": "TriggerAction" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_issueresolution_v1.types.TriggerActionRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, Union[str, bytes]]]" + } + ], + "resultType": "google.shopping.merchant_issueresolution_v1.types.TriggerActionResponse", + "shortName": "trigger_action" + }, + "description": "Sample for TriggerAction", + "file": "merchantapi_v1_generated_issue_resolution_service_trigger_action_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_IssueResolutionService_TriggerAction_sync", + "segments": [ + { + "end": 58, + "start": 27, + "type": "FULL" + }, + { + "end": 58, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 52, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 55, + "start": 53, + "type": "REQUEST_EXECUTION" + }, + { + "end": 59, + "start": 56, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_issue_resolution_service_trigger_action_sync.py" + } + ] +} diff --git a/packages/google-shopping-merchant-issueresolution/scripts/fixup_merchant_issueresolution_v1_keywords.py b/packages/google-shopping-merchant-issueresolution/scripts/fixup_merchant_issueresolution_v1_keywords.py new file mode 100644 index 000000000000..93502afffea8 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/scripts/fixup_merchant_issueresolution_v1_keywords.py @@ -0,0 +1,179 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class merchant_issueresolutionCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'list_aggregate_product_statuses': ('parent', 'page_size', 'page_token', 'filter', ), + 'render_account_issues': ('name', 'language_code', 'time_zone', 'payload', ), + 'render_product_issues': ('name', 'language_code', 'time_zone', 'payload', ), + 'trigger_action': ('name', 'payload', 'language_code', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: a.keyword.value not in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=merchant_issueresolutionCallTransformer(), +): + """Duplicate the input dir to the output dir, fixing file method calls. + + Preconditions: + * in_dir is a real directory + * out_dir is a real, empty directory + """ + pyfile_gen = ( + pathlib.Path(os.path.join(root, f)) + for root, _, files in os.walk(in_dir) + for f in files if os.path.splitext(f)[1] == ".py" + ) + + for fpath in pyfile_gen: + with open(fpath, 'r') as f: + src = f.read() + + # Parse the code and insert method call fixes. + tree = cst.parse_module(src) + updated = tree.visit(transformer) + + # Create the path and directory structure for the new file. + updated_path = out_dir.joinpath(fpath.relative_to(in_dir)) + updated_path.parent.mkdir(parents=True, exist_ok=True) + + # Generate the updated source file at the corresponding path. + with open(updated_path, 'w') as f: + f.write(updated.code) + + +if __name__ == '__main__': + parser = argparse.ArgumentParser( + description="""Fix up source that uses the merchant_issueresolution client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/packages/google-shopping-merchant-issueresolution/tests/unit/gapic/merchant_issueresolution_v1/__init__.py b/packages/google-shopping-merchant-issueresolution/tests/unit/gapic/merchant_issueresolution_v1/__init__.py new file mode 100644 index 000000000000..cbf94b283c70 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/tests/unit/gapic/merchant_issueresolution_v1/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# diff --git a/packages/google-shopping-merchant-issueresolution/tests/unit/gapic/merchant_issueresolution_v1/test_aggregate_product_statuses_service.py b/packages/google-shopping-merchant-issueresolution/tests/unit/gapic/merchant_issueresolution_v1/test_aggregate_product_statuses_service.py new file mode 100644 index 000000000000..da54ad3912f8 --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/tests/unit/gapic/merchant_issueresolution_v1/test_aggregate_product_statuses_service.py @@ -0,0 +1,3091 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +import os + +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +from collections.abc import AsyncIterable, Iterable +import json +import math + +from google.api_core import api_core_version +from google.protobuf import json_format +import grpc +from grpc.experimental import aio +from proto.marshal.rules import wrappers +from proto.marshal.rules.dates import DurationRule, TimestampRule +import pytest +from requests import PreparedRequest, Request, Response +from requests.sessions import Session + +try: + from google.auth.aio import credentials as ga_credentials_async + + HAS_GOOGLE_AUTH_AIO = True +except ImportError: # pragma: NO COVER + HAS_GOOGLE_AUTH_AIO = False + +from google.api_core import gapic_v1, grpc_helpers, grpc_helpers_async, path_template +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +import google.auth +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.oauth2 import service_account + +from google.shopping.merchant_issueresolution_v1.services.aggregate_product_statuses_service import ( + AggregateProductStatusesServiceAsyncClient, + AggregateProductStatusesServiceClient, + pagers, + transports, +) +from google.shopping.merchant_issueresolution_v1.types import aggregateproductstatuses + +CRED_INFO_JSON = { + "credential_source": "/path/to/file", + "credential_type": "service account credentials", + "principal": "service-account@example.com", +} +CRED_INFO_STRING = json.dumps(CRED_INFO_JSON) + + +async def mock_async_gen(data, chunk_size=1): + for i in range(0, len(data)): # pragma: NO COVER + chunk = data[i : i + chunk_size] + yield chunk.encode("utf-8") + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# TODO: use async auth anon credentials by default once the minimum version of google-auth is upgraded. +# See related issue: https://github.com/googleapis/gapic-generator-python/issues/2107. +def async_anonymous_credentials(): + if HAS_GOOGLE_AUTH_AIO: + return ga_credentials_async.AnonymousCredentials() + return ga_credentials.AnonymousCredentials() + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return ( + "foo.googleapis.com" + if ("localhost" in client.DEFAULT_ENDPOINT) + else client.DEFAULT_ENDPOINT + ) + + +# If default endpoint template is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint template so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint_template(client): + return ( + "test.{UNIVERSE_DOMAIN}" + if ("localhost" in client._DEFAULT_ENDPOINT_TEMPLATE) + else client._DEFAULT_ENDPOINT_TEMPLATE + ) + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert ( + AggregateProductStatusesServiceClient._get_default_mtls_endpoint(None) is None + ) + assert ( + AggregateProductStatusesServiceClient._get_default_mtls_endpoint(api_endpoint) + == api_mtls_endpoint + ) + assert ( + AggregateProductStatusesServiceClient._get_default_mtls_endpoint( + api_mtls_endpoint + ) + == api_mtls_endpoint + ) + assert ( + AggregateProductStatusesServiceClient._get_default_mtls_endpoint( + sandbox_endpoint + ) + == sandbox_mtls_endpoint + ) + assert ( + AggregateProductStatusesServiceClient._get_default_mtls_endpoint( + sandbox_mtls_endpoint + ) + == sandbox_mtls_endpoint + ) + assert ( + AggregateProductStatusesServiceClient._get_default_mtls_endpoint(non_googleapi) + == non_googleapi + ) + + +def test__read_environment_variables(): + assert AggregateProductStatusesServiceClient._read_environment_variables() == ( + False, + "auto", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + assert AggregateProductStatusesServiceClient._read_environment_variables() == ( + True, + "auto", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + assert AggregateProductStatusesServiceClient._read_environment_variables() == ( + False, + "auto", + None, + ) + + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError) as excinfo: + AggregateProductStatusesServiceClient._read_environment_variables() + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + assert AggregateProductStatusesServiceClient._read_environment_variables() == ( + False, + "never", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + assert AggregateProductStatusesServiceClient._read_environment_variables() == ( + False, + "always", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}): + assert AggregateProductStatusesServiceClient._read_environment_variables() == ( + False, + "auto", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + AggregateProductStatusesServiceClient._read_environment_variables() + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + with mock.patch.dict(os.environ, {"GOOGLE_CLOUD_UNIVERSE_DOMAIN": "foo.com"}): + assert AggregateProductStatusesServiceClient._read_environment_variables() == ( + False, + "auto", + "foo.com", + ) + + +def test__get_client_cert_source(): + mock_provided_cert_source = mock.Mock() + mock_default_cert_source = mock.Mock() + + assert ( + AggregateProductStatusesServiceClient._get_client_cert_source(None, False) + is None + ) + assert ( + AggregateProductStatusesServiceClient._get_client_cert_source( + mock_provided_cert_source, False + ) + is None + ) + assert ( + AggregateProductStatusesServiceClient._get_client_cert_source( + mock_provided_cert_source, True + ) + == mock_provided_cert_source + ) + + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", return_value=True + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=mock_default_cert_source, + ): + assert ( + AggregateProductStatusesServiceClient._get_client_cert_source( + None, True + ) + is mock_default_cert_source + ) + assert ( + AggregateProductStatusesServiceClient._get_client_cert_source( + mock_provided_cert_source, "true" + ) + is mock_provided_cert_source + ) + + +@mock.patch.object( + AggregateProductStatusesServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(AggregateProductStatusesServiceClient), +) +@mock.patch.object( + AggregateProductStatusesServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(AggregateProductStatusesServiceAsyncClient), +) +def test__get_api_endpoint(): + api_override = "foo.com" + mock_client_cert_source = mock.Mock() + default_universe = AggregateProductStatusesServiceClient._DEFAULT_UNIVERSE + default_endpoint = ( + AggregateProductStatusesServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=default_universe + ) + ) + mock_universe = "bar.com" + mock_endpoint = ( + AggregateProductStatusesServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=mock_universe + ) + ) + + assert ( + AggregateProductStatusesServiceClient._get_api_endpoint( + api_override, mock_client_cert_source, default_universe, "always" + ) + == api_override + ) + assert ( + AggregateProductStatusesServiceClient._get_api_endpoint( + None, mock_client_cert_source, default_universe, "auto" + ) + == AggregateProductStatusesServiceClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + AggregateProductStatusesServiceClient._get_api_endpoint( + None, None, default_universe, "auto" + ) + == default_endpoint + ) + assert ( + AggregateProductStatusesServiceClient._get_api_endpoint( + None, None, default_universe, "always" + ) + == AggregateProductStatusesServiceClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + AggregateProductStatusesServiceClient._get_api_endpoint( + None, mock_client_cert_source, default_universe, "always" + ) + == AggregateProductStatusesServiceClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + AggregateProductStatusesServiceClient._get_api_endpoint( + None, None, mock_universe, "never" + ) + == mock_endpoint + ) + assert ( + AggregateProductStatusesServiceClient._get_api_endpoint( + None, None, default_universe, "never" + ) + == default_endpoint + ) + + with pytest.raises(MutualTLSChannelError) as excinfo: + AggregateProductStatusesServiceClient._get_api_endpoint( + None, mock_client_cert_source, mock_universe, "auto" + ) + assert ( + str(excinfo.value) + == "mTLS is not supported in any universe other than googleapis.com." + ) + + +def test__get_universe_domain(): + client_universe_domain = "foo.com" + universe_domain_env = "bar.com" + + assert ( + AggregateProductStatusesServiceClient._get_universe_domain( + client_universe_domain, universe_domain_env + ) + == client_universe_domain + ) + assert ( + AggregateProductStatusesServiceClient._get_universe_domain( + None, universe_domain_env + ) + == universe_domain_env + ) + assert ( + AggregateProductStatusesServiceClient._get_universe_domain(None, None) + == AggregateProductStatusesServiceClient._DEFAULT_UNIVERSE + ) + + with pytest.raises(ValueError) as excinfo: + AggregateProductStatusesServiceClient._get_universe_domain("", None) + assert str(excinfo.value) == "Universe Domain cannot be an empty string." + + +@pytest.mark.parametrize( + "error_code,cred_info_json,show_cred_info", + [ + (401, CRED_INFO_JSON, True), + (403, CRED_INFO_JSON, True), + (404, CRED_INFO_JSON, True), + (500, CRED_INFO_JSON, False), + (401, None, False), + (403, None, False), + (404, None, False), + (500, None, False), + ], +) +def test__add_cred_info_for_auth_errors(error_code, cred_info_json, show_cred_info): + cred = mock.Mock(["get_cred_info"]) + cred.get_cred_info = mock.Mock(return_value=cred_info_json) + client = AggregateProductStatusesServiceClient(credentials=cred) + client._transport._credentials = cred + + error = core_exceptions.GoogleAPICallError("message", details=["foo"]) + error.code = error_code + + client._add_cred_info_for_auth_errors(error) + if show_cred_info: + assert error.details == ["foo", CRED_INFO_STRING] + else: + assert error.details == ["foo"] + + +@pytest.mark.parametrize("error_code", [401, 403, 404, 500]) +def test__add_cred_info_for_auth_errors_no_get_cred_info(error_code): + cred = mock.Mock([]) + assert not hasattr(cred, "get_cred_info") + client = AggregateProductStatusesServiceClient(credentials=cred) + client._transport._credentials = cred + + error = core_exceptions.GoogleAPICallError("message", details=[]) + error.code = error_code + + client._add_cred_info_for_auth_errors(error) + assert error.details == [] + + +@pytest.mark.parametrize( + "client_class,transport_name", + [ + (AggregateProductStatusesServiceClient, "grpc"), + (AggregateProductStatusesServiceAsyncClient, "grpc_asyncio"), + (AggregateProductStatusesServiceClient, "rest"), + ], +) +def test_aggregate_product_statuses_service_client_from_service_account_info( + client_class, transport_name +): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object( + service_account.Credentials, "from_service_account_info" + ) as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + "merchantapi.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://merchantapi.googleapis.com" + ) + + +@pytest.mark.parametrize( + "transport_class,transport_name", + [ + (transports.AggregateProductStatusesServiceGrpcTransport, "grpc"), + ( + transports.AggregateProductStatusesServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + (transports.AggregateProductStatusesServiceRestTransport, "rest"), + ], +) +def test_aggregate_product_statuses_service_client_service_account_always_use_jwt( + transport_class, transport_name +): + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize( + "client_class,transport_name", + [ + (AggregateProductStatusesServiceClient, "grpc"), + (AggregateProductStatusesServiceAsyncClient, "grpc_asyncio"), + (AggregateProductStatusesServiceClient, "rest"), + ], +) +def test_aggregate_product_statuses_service_client_from_service_account_file( + client_class, transport_name +): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object( + service_account.Credentials, "from_service_account_file" + ) as factory: + factory.return_value = creds + client = client_class.from_service_account_file( + "dummy/file/path.json", transport=transport_name + ) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json( + "dummy/file/path.json", transport=transport_name + ) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + "merchantapi.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://merchantapi.googleapis.com" + ) + + +def test_aggregate_product_statuses_service_client_get_transport_class(): + transport = AggregateProductStatusesServiceClient.get_transport_class() + available_transports = [ + transports.AggregateProductStatusesServiceGrpcTransport, + transports.AggregateProductStatusesServiceRestTransport, + ] + assert transport in available_transports + + transport = AggregateProductStatusesServiceClient.get_transport_class("grpc") + assert transport == transports.AggregateProductStatusesServiceGrpcTransport + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + ( + AggregateProductStatusesServiceClient, + transports.AggregateProductStatusesServiceGrpcTransport, + "grpc", + ), + ( + AggregateProductStatusesServiceAsyncClient, + transports.AggregateProductStatusesServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ( + AggregateProductStatusesServiceClient, + transports.AggregateProductStatusesServiceRestTransport, + "rest", + ), + ], +) +@mock.patch.object( + AggregateProductStatusesServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(AggregateProductStatusesServiceClient), +) +@mock.patch.object( + AggregateProductStatusesServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(AggregateProductStatusesServiceAsyncClient), +) +def test_aggregate_product_statuses_service_client_client_options( + client_class, transport_class, transport_name +): + # Check that if channel is provided we won't create a new one. + with mock.patch.object( + AggregateProductStatusesServiceClient, "get_transport_class" + ) as gtc: + transport = transport_class(credentials=ga_credentials.AnonymousCredentials()) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object( + AggregateProductStatusesServiceClient, "get_transport_class" + ) as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + client = client_class(transport=transport_name) + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError) as excinfo: + client = client_class(transport=transport_name) + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions( + api_audience="https://language.googleapis.com" + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com", + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,use_client_cert_env", + [ + ( + AggregateProductStatusesServiceClient, + transports.AggregateProductStatusesServiceGrpcTransport, + "grpc", + "true", + ), + ( + AggregateProductStatusesServiceAsyncClient, + transports.AggregateProductStatusesServiceGrpcAsyncIOTransport, + "grpc_asyncio", + "true", + ), + ( + AggregateProductStatusesServiceClient, + transports.AggregateProductStatusesServiceGrpcTransport, + "grpc", + "false", + ), + ( + AggregateProductStatusesServiceAsyncClient, + transports.AggregateProductStatusesServiceGrpcAsyncIOTransport, + "grpc_asyncio", + "false", + ), + ( + AggregateProductStatusesServiceClient, + transports.AggregateProductStatusesServiceRestTransport, + "rest", + "true", + ), + ( + AggregateProductStatusesServiceClient, + transports.AggregateProductStatusesServiceRestTransport, + "rest", + "false", + ), + ], +) +@mock.patch.object( + AggregateProductStatusesServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(AggregateProductStatusesServiceClient), +) +@mock.patch.object( + AggregateProductStatusesServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(AggregateProductStatusesServiceAsyncClient), +) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_aggregate_product_statuses_service_client_mtls_env_auto( + client_class, transport_class, transport_name, use_client_cert_env +): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + options = client_options.ClientOptions( + client_cert_source=client_cert_source_callback + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ) + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=True, + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=client_cert_source_callback, + ): + if use_client_cert_env == "false": + expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ) + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=False, + ): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize( + "client_class", + [AggregateProductStatusesServiceClient, AggregateProductStatusesServiceAsyncClient], +) +@mock.patch.object( + AggregateProductStatusesServiceClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(AggregateProductStatusesServiceClient), +) +@mock.patch.object( + AggregateProductStatusesServiceAsyncClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(AggregateProductStatusesServiceAsyncClient), +) +def test_aggregate_product_statuses_service_client_get_mtls_endpoint_and_cert_source( + client_class, +): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint + ) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source( + options + ) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint + ) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source( + options + ) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=False, + ): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=True, + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=mock_client_cert_source, + ): + ( + api_endpoint, + cert_source, + ) = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + + +@pytest.mark.parametrize( + "client_class", + [AggregateProductStatusesServiceClient, AggregateProductStatusesServiceAsyncClient], +) +@mock.patch.object( + AggregateProductStatusesServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(AggregateProductStatusesServiceClient), +) +@mock.patch.object( + AggregateProductStatusesServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(AggregateProductStatusesServiceAsyncClient), +) +def test_aggregate_product_statuses_service_client_client_api_endpoint(client_class): + mock_client_cert_source = client_cert_source_callback + api_override = "foo.com" + default_universe = AggregateProductStatusesServiceClient._DEFAULT_UNIVERSE + default_endpoint = ( + AggregateProductStatusesServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=default_universe + ) + ) + mock_universe = "bar.com" + mock_endpoint = ( + AggregateProductStatusesServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=mock_universe + ) + ) + + # If ClientOptions.api_endpoint is set and GOOGLE_API_USE_CLIENT_CERTIFICATE="true", + # use ClientOptions.api_endpoint as the api endpoint regardless. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ): + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=api_override + ) + client = client_class( + client_options=options, + credentials=ga_credentials.AnonymousCredentials(), + ) + assert client.api_endpoint == api_override + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == default_endpoint + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="always", + # use the DEFAULT_MTLS_ENDPOINT as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + + # If ClientOptions.api_endpoint is not set, GOOGLE_API_USE_MTLS_ENDPOINT="auto" (default), + # GOOGLE_API_USE_CLIENT_CERTIFICATE="false" (default), default cert source doesn't exist, + # and ClientOptions.universe_domain="bar.com", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with universe domain as the api endpoint. + options = client_options.ClientOptions() + universe_exists = hasattr(options, "universe_domain") + if universe_exists: + options = client_options.ClientOptions(universe_domain=mock_universe) + client = client_class( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + else: + client = client_class( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + assert client.api_endpoint == ( + mock_endpoint if universe_exists else default_endpoint + ) + assert client.universe_domain == ( + mock_universe if universe_exists else default_universe + ) + + # If ClientOptions does not have a universe domain attribute and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + options = client_options.ClientOptions() + if hasattr(options, "universe_domain"): + delattr(options, "universe_domain") + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + assert client.api_endpoint == default_endpoint + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + ( + AggregateProductStatusesServiceClient, + transports.AggregateProductStatusesServiceGrpcTransport, + "grpc", + ), + ( + AggregateProductStatusesServiceAsyncClient, + transports.AggregateProductStatusesServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ( + AggregateProductStatusesServiceClient, + transports.AggregateProductStatusesServiceRestTransport, + "rest", + ), + ], +) +def test_aggregate_product_statuses_service_client_client_options_scopes( + client_class, transport_class, transport_name +): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,grpc_helpers", + [ + ( + AggregateProductStatusesServiceClient, + transports.AggregateProductStatusesServiceGrpcTransport, + "grpc", + grpc_helpers, + ), + ( + AggregateProductStatusesServiceAsyncClient, + transports.AggregateProductStatusesServiceGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ( + AggregateProductStatusesServiceClient, + transports.AggregateProductStatusesServiceRestTransport, + "rest", + None, + ), + ], +) +def test_aggregate_product_statuses_service_client_client_options_credentials_file( + client_class, transport_class, transport_name, grpc_helpers +): + # Check the case credentials file is provided. + options = client_options.ClientOptions(credentials_file="credentials.json") + + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +def test_aggregate_product_statuses_service_client_client_options_from_dict(): + with mock.patch( + "google.shopping.merchant_issueresolution_v1.services.aggregate_product_statuses_service.transports.AggregateProductStatusesServiceGrpcTransport.__init__" + ) as grpc_transport: + grpc_transport.return_value = None + client = AggregateProductStatusesServiceClient( + client_options={"api_endpoint": "squid.clam.whelk"} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,grpc_helpers", + [ + ( + AggregateProductStatusesServiceClient, + transports.AggregateProductStatusesServiceGrpcTransport, + "grpc", + grpc_helpers, + ), + ( + AggregateProductStatusesServiceAsyncClient, + transports.AggregateProductStatusesServiceGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ], +) +def test_aggregate_product_statuses_service_client_create_channel_credentials_file( + client_class, transport_class, transport_name, grpc_helpers +): + # Check the case credentials file is provided. + options = client_options.ClientOptions(credentials_file="credentials.json") + + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "merchantapi.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=("https://www.googleapis.com/auth/content",), + scopes=None, + default_host="merchantapi.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "request_type", + [ + aggregateproductstatuses.ListAggregateProductStatusesRequest, + dict, + ], +) +def test_list_aggregate_product_statuses(request_type, transport: str = "grpc"): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_aggregate_product_statuses), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = ( + aggregateproductstatuses.ListAggregateProductStatusesResponse( + next_page_token="next_page_token_value", + ) + ) + response = client.list_aggregate_product_statuses(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = aggregateproductstatuses.ListAggregateProductStatusesRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListAggregateProductStatusesPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_aggregate_product_statuses_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = aggregateproductstatuses.ListAggregateProductStatusesRequest( + parent="parent_value", + page_token="page_token_value", + filter="filter_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_aggregate_product_statuses), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.list_aggregate_product_statuses(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == aggregateproductstatuses.ListAggregateProductStatusesRequest( + parent="parent_value", + page_token="page_token_value", + filter="filter_value", + ) + + +def test_list_aggregate_product_statuses_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.list_aggregate_product_statuses + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.list_aggregate_product_statuses + ] = mock_rpc + request = {} + client.list_aggregate_product_statuses(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_aggregate_product_statuses(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_list_aggregate_product_statuses_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", +): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = AggregateProductStatusesServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._client._transport.list_aggregate_product_statuses + in client._client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.list_aggregate_product_statuses + ] = mock_rpc + + request = {} + await client.list_aggregate_product_statuses(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.list_aggregate_product_statuses(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_list_aggregate_product_statuses_async( + transport: str = "grpc_asyncio", + request_type=aggregateproductstatuses.ListAggregateProductStatusesRequest, +): + client = AggregateProductStatusesServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_aggregate_product_statuses), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + aggregateproductstatuses.ListAggregateProductStatusesResponse( + next_page_token="next_page_token_value", + ) + ) + response = await client.list_aggregate_product_statuses(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = aggregateproductstatuses.ListAggregateProductStatusesRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListAggregateProductStatusesAsyncPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.asyncio +async def test_list_aggregate_product_statuses_async_from_dict(): + await test_list_aggregate_product_statuses_async(request_type=dict) + + +def test_list_aggregate_product_statuses_field_headers(): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = aggregateproductstatuses.ListAggregateProductStatusesRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_aggregate_product_statuses), "__call__" + ) as call: + call.return_value = ( + aggregateproductstatuses.ListAggregateProductStatusesResponse() + ) + client.list_aggregate_product_statuses(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_list_aggregate_product_statuses_field_headers_async(): + client = AggregateProductStatusesServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = aggregateproductstatuses.ListAggregateProductStatusesRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_aggregate_product_statuses), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + aggregateproductstatuses.ListAggregateProductStatusesResponse() + ) + await client.list_aggregate_product_statuses(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "parent=parent_value", + ) in kw["metadata"] + + +def test_list_aggregate_product_statuses_flattened(): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_aggregate_product_statuses), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = ( + aggregateproductstatuses.ListAggregateProductStatusesResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_aggregate_product_statuses( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + + +def test_list_aggregate_product_statuses_flattened_error(): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_aggregate_product_statuses( + aggregateproductstatuses.ListAggregateProductStatusesRequest(), + parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_aggregate_product_statuses_flattened_async(): + client = AggregateProductStatusesServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_aggregate_product_statuses), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = ( + aggregateproductstatuses.ListAggregateProductStatusesResponse() + ) + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + aggregateproductstatuses.ListAggregateProductStatusesResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_aggregate_product_statuses( + parent="parent_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].parent + mock_val = "parent_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_list_aggregate_product_statuses_flattened_error_async(): + client = AggregateProductStatusesServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_aggregate_product_statuses( + aggregateproductstatuses.ListAggregateProductStatusesRequest(), + parent="parent_value", + ) + + +def test_list_aggregate_product_statuses_pager(transport_name: str = "grpc"): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_aggregate_product_statuses), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[ + aggregateproductstatuses.AggregateProductStatus(), + aggregateproductstatuses.AggregateProductStatus(), + aggregateproductstatuses.AggregateProductStatus(), + ], + next_page_token="abc", + ), + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[], + next_page_token="def", + ), + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[ + aggregateproductstatuses.AggregateProductStatus(), + ], + next_page_token="ghi", + ), + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[ + aggregateproductstatuses.AggregateProductStatus(), + aggregateproductstatuses.AggregateProductStatus(), + ], + ), + RuntimeError, + ) + + expected_metadata = () + retry = retries.Retry() + timeout = 5 + expected_metadata = tuple(expected_metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_aggregate_product_statuses( + request={}, retry=retry, timeout=timeout + ) + + assert pager._metadata == expected_metadata + assert pager._retry == retry + assert pager._timeout == timeout + + results = list(pager) + assert len(results) == 6 + assert all( + isinstance(i, aggregateproductstatuses.AggregateProductStatus) + for i in results + ) + + +def test_list_aggregate_product_statuses_pages(transport_name: str = "grpc"): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport_name, + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_aggregate_product_statuses), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[ + aggregateproductstatuses.AggregateProductStatus(), + aggregateproductstatuses.AggregateProductStatus(), + aggregateproductstatuses.AggregateProductStatus(), + ], + next_page_token="abc", + ), + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[], + next_page_token="def", + ), + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[ + aggregateproductstatuses.AggregateProductStatus(), + ], + next_page_token="ghi", + ), + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[ + aggregateproductstatuses.AggregateProductStatus(), + aggregateproductstatuses.AggregateProductStatus(), + ], + ), + RuntimeError, + ) + pages = list(client.list_aggregate_product_statuses(request={}).pages) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.asyncio +async def test_list_aggregate_product_statuses_async_pager(): + client = AggregateProductStatusesServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_aggregate_product_statuses), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[ + aggregateproductstatuses.AggregateProductStatus(), + aggregateproductstatuses.AggregateProductStatus(), + aggregateproductstatuses.AggregateProductStatus(), + ], + next_page_token="abc", + ), + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[], + next_page_token="def", + ), + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[ + aggregateproductstatuses.AggregateProductStatus(), + ], + next_page_token="ghi", + ), + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[ + aggregateproductstatuses.AggregateProductStatus(), + aggregateproductstatuses.AggregateProductStatus(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_aggregate_product_statuses( + request={}, + ) + assert async_pager.next_page_token == "abc" + responses = [] + async for response in async_pager: # pragma: no branch + responses.append(response) + + assert len(responses) == 6 + assert all( + isinstance(i, aggregateproductstatuses.AggregateProductStatus) + for i in responses + ) + + +@pytest.mark.asyncio +async def test_list_aggregate_product_statuses_async_pages(): + client = AggregateProductStatusesServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_aggregate_product_statuses), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[ + aggregateproductstatuses.AggregateProductStatus(), + aggregateproductstatuses.AggregateProductStatus(), + aggregateproductstatuses.AggregateProductStatus(), + ], + next_page_token="abc", + ), + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[], + next_page_token="def", + ), + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[ + aggregateproductstatuses.AggregateProductStatus(), + ], + next_page_token="ghi", + ), + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[ + aggregateproductstatuses.AggregateProductStatus(), + aggregateproductstatuses.AggregateProductStatus(), + ], + ), + RuntimeError, + ) + pages = [] + # Workaround issue in python 3.9 related to code coverage by adding `# pragma: no branch` + # See https://github.com/googleapis/gapic-generator-python/pull/1174#issuecomment-1025132372 + async for page_ in ( # pragma: no branch + await client.list_aggregate_product_statuses(request={}) + ).pages: + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_list_aggregate_product_statuses_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.list_aggregate_product_statuses + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.list_aggregate_product_statuses + ] = mock_rpc + + request = {} + client.list_aggregate_product_statuses(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_aggregate_product_statuses(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_list_aggregate_product_statuses_rest_required_fields( + request_type=aggregateproductstatuses.ListAggregateProductStatusesRequest, +): + transport_class = transports.AggregateProductStatusesServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson(pb_request, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_aggregate_product_statuses._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = "parent_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_aggregate_product_statuses._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "filter", + "page_size", + "page_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == "parent_value" + + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = aggregateproductstatuses.ListAggregateProductStatusesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = ( + aggregateproductstatuses.ListAggregateProductStatusesResponse.pb( + return_value + ) + ) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.list_aggregate_product_statuses(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_aggregate_product_statuses_rest_unset_required_fields(): + transport = transports.AggregateProductStatusesServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_aggregate_product_statuses._get_unset_required_fields( + {} + ) + assert set(unset_fields) == ( + set( + ( + "filter", + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +def test_list_aggregate_product_statuses_rest_flattened(): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = aggregateproductstatuses.ListAggregateProductStatusesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"parent": "accounts/sample1"} + + # get truthy value for each flattened field + mock_args = dict( + parent="parent_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = aggregateproductstatuses.ListAggregateProductStatusesResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.list_aggregate_product_statuses(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/issueresolution/v1/{parent=accounts/*}/aggregateProductStatuses" + % client.transport._host, + args[1], + ) + + +def test_list_aggregate_product_statuses_rest_flattened_error(transport: str = "rest"): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_aggregate_product_statuses( + aggregateproductstatuses.ListAggregateProductStatusesRequest(), + parent="parent_value", + ) + + +def test_list_aggregate_product_statuses_rest_pager(transport: str = "rest"): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # TODO(kbandes): remove this mock unless there's a good reason for it. + # with mock.patch.object(path_template, 'transcode') as transcode: + # Set the response as a series of pages + response = ( + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[ + aggregateproductstatuses.AggregateProductStatus(), + aggregateproductstatuses.AggregateProductStatus(), + aggregateproductstatuses.AggregateProductStatus(), + ], + next_page_token="abc", + ), + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[], + next_page_token="def", + ), + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[ + aggregateproductstatuses.AggregateProductStatus(), + ], + next_page_token="ghi", + ), + aggregateproductstatuses.ListAggregateProductStatusesResponse( + aggregate_product_statuses=[ + aggregateproductstatuses.AggregateProductStatus(), + aggregateproductstatuses.AggregateProductStatus(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + aggregateproductstatuses.ListAggregateProductStatusesResponse.to_json(x) + for x in response + ) + return_values = tuple(Response() for i in response) + for return_val, response_val in zip(return_values, response): + return_val._content = response_val.encode("UTF-8") + return_val.status_code = 200 + req.side_effect = return_values + + sample_request = {"parent": "accounts/sample1"} + + pager = client.list_aggregate_product_statuses(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all( + isinstance(i, aggregateproductstatuses.AggregateProductStatus) + for i in results + ) + + pages = list( + client.list_aggregate_product_statuses(request=sample_request).pages + ) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.AggregateProductStatusesServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.AggregateProductStatusesServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = AggregateProductStatusesServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.AggregateProductStatusesServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = AggregateProductStatusesServiceClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = AggregateProductStatusesServiceClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.AggregateProductStatusesServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = AggregateProductStatusesServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.AggregateProductStatusesServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = AggregateProductStatusesServiceClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.AggregateProductStatusesServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.AggregateProductStatusesServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.AggregateProductStatusesServiceGrpcTransport, + transports.AggregateProductStatusesServiceGrpcAsyncIOTransport, + transports.AggregateProductStatusesServiceRestTransport, + ], +) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + + +def test_transport_kind_grpc(): + transport = AggregateProductStatusesServiceClient.get_transport_class("grpc")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "grpc" + + +def test_initialize_client_w_grpc(): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_aggregate_product_statuses_empty_call_grpc(): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_aggregate_product_statuses), "__call__" + ) as call: + call.return_value = ( + aggregateproductstatuses.ListAggregateProductStatusesResponse() + ) + client.list_aggregate_product_statuses(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = aggregateproductstatuses.ListAggregateProductStatusesRequest() + + assert args[0] == request_msg + + +def test_transport_kind_grpc_asyncio(): + transport = AggregateProductStatusesServiceAsyncClient.get_transport_class( + "grpc_asyncio" + )(credentials=async_anonymous_credentials()) + assert transport.kind == "grpc_asyncio" + + +def test_initialize_client_w_grpc_asyncio(): + client = AggregateProductStatusesServiceAsyncClient( + credentials=async_anonymous_credentials(), transport="grpc_asyncio" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_list_aggregate_product_statuses_empty_call_grpc_asyncio(): + client = AggregateProductStatusesServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_aggregate_product_statuses), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + aggregateproductstatuses.ListAggregateProductStatusesResponse( + next_page_token="next_page_token_value", + ) + ) + await client.list_aggregate_product_statuses(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = aggregateproductstatuses.ListAggregateProductStatusesRequest() + + assert args[0] == request_msg + + +def test_transport_kind_rest(): + transport = AggregateProductStatusesServiceClient.get_transport_class("rest")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "rest" + + +def test_list_aggregate_product_statuses_rest_bad_request( + request_type=aggregateproductstatuses.ListAggregateProductStatusesRequest, +): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {"parent": "accounts/sample1"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.list_aggregate_product_statuses(request) + + +@pytest.mark.parametrize( + "request_type", + [ + aggregateproductstatuses.ListAggregateProductStatusesRequest, + dict, + ], +) +def test_list_aggregate_product_statuses_rest_call_success(request_type): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "accounts/sample1"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = aggregateproductstatuses.ListAggregateProductStatusesResponse( + next_page_token="next_page_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = aggregateproductstatuses.ListAggregateProductStatusesResponse.pb( + return_value + ) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.list_aggregate_product_statuses(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListAggregateProductStatusesPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_aggregate_product_statuses_rest_interceptors(null_interceptor): + transport = transports.AggregateProductStatusesServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.AggregateProductStatusesServiceRestInterceptor(), + ) + client = AggregateProductStatusesServiceClient(transport=transport) + + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.AggregateProductStatusesServiceRestInterceptor, + "post_list_aggregate_product_statuses", + ) as post, mock.patch.object( + transports.AggregateProductStatusesServiceRestInterceptor, + "post_list_aggregate_product_statuses_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.AggregateProductStatusesServiceRestInterceptor, + "pre_list_aggregate_product_statuses", + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = aggregateproductstatuses.ListAggregateProductStatusesRequest.pb( + aggregateproductstatuses.ListAggregateProductStatusesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = ( + aggregateproductstatuses.ListAggregateProductStatusesResponse.to_json( + aggregateproductstatuses.ListAggregateProductStatusesResponse() + ) + ) + req.return_value.content = return_value + + request = aggregateproductstatuses.ListAggregateProductStatusesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = ( + aggregateproductstatuses.ListAggregateProductStatusesResponse() + ) + post_with_metadata.return_value = ( + aggregateproductstatuses.ListAggregateProductStatusesResponse(), + metadata, + ) + + client.list_aggregate_product_statuses( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_initialize_client_w_rest(): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_list_aggregate_product_statuses_empty_call_rest(): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_aggregate_product_statuses), "__call__" + ) as call: + client.list_aggregate_product_statuses(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = aggregateproductstatuses.ListAggregateProductStatusesRequest() + + assert args[0] == request_msg + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.AggregateProductStatusesServiceGrpcTransport, + ) + + +def test_aggregate_product_statuses_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.AggregateProductStatusesServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_aggregate_product_statuses_service_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.shopping.merchant_issueresolution_v1.services.aggregate_product_statuses_service.transports.AggregateProductStatusesServiceTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.AggregateProductStatusesServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ("list_aggregate_product_statuses",) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Catch all for all remaining methods and properties + remainder = [ + "kind", + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_aggregate_product_statuses_service_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch( + "google.shopping.merchant_issueresolution_v1.services.aggregate_product_statuses_service.transports.AggregateProductStatusesServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.AggregateProductStatusesServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with( + "credentials.json", + scopes=None, + default_scopes=("https://www.googleapis.com/auth/content",), + quota_project_id="octopus", + ) + + +def test_aggregate_product_statuses_service_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch( + "google.shopping.merchant_issueresolution_v1.services.aggregate_product_statuses_service.transports.AggregateProductStatusesServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.AggregateProductStatusesServiceTransport() + adc.assert_called_once() + + +def test_aggregate_product_statuses_service_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + AggregateProductStatusesServiceClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=("https://www.googleapis.com/auth/content",), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.AggregateProductStatusesServiceGrpcTransport, + transports.AggregateProductStatusesServiceGrpcAsyncIOTransport, + ], +) +def test_aggregate_product_statuses_service_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=("https://www.googleapis.com/auth/content",), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.AggregateProductStatusesServiceGrpcTransport, + transports.AggregateProductStatusesServiceGrpcAsyncIOTransport, + transports.AggregateProductStatusesServiceRestTransport, + ], +) +def test_aggregate_product_statuses_service_transport_auth_gdch_credentials( + transport_class, +): + host = "https://language.com" + api_audience_tests = [None, "https://language2.com"] + api_audience_expect = [host, "https://language2.com"] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, "default", autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock( + return_value=gdch_mock + ) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with(e) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.AggregateProductStatusesServiceGrpcTransport, grpc_helpers), + ( + transports.AggregateProductStatusesServiceGrpcAsyncIOTransport, + grpc_helpers_async, + ), + ], +) +def test_aggregate_product_statuses_service_transport_create_channel( + transport_class, grpc_helpers +): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + + create_channel.assert_called_with( + "merchantapi.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=("https://www.googleapis.com/auth/content",), + scopes=["1", "2"], + default_host="merchantapi.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.AggregateProductStatusesServiceGrpcTransport, + transports.AggregateProductStatusesServiceGrpcAsyncIOTransport, + ], +) +def test_aggregate_product_statuses_service_grpc_transport_client_cert_source_for_mtls( + transport_class, +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds, + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback, + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, private_key=expected_key + ) + + +def test_aggregate_product_statuses_service_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.AggregateProductStatusesServiceRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + "rest", + ], +) +def test_aggregate_product_statuses_service_host_no_port(transport_name): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="merchantapi.googleapis.com" + ), + transport=transport_name, + ) + assert client.transport._host == ( + "merchantapi.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://merchantapi.googleapis.com" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + "rest", + ], +) +def test_aggregate_product_statuses_service_host_with_port(transport_name): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="merchantapi.googleapis.com:8000" + ), + transport=transport_name, + ) + assert client.transport._host == ( + "merchantapi.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://merchantapi.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_aggregate_product_statuses_service_client_transport_session_collision( + transport_name, +): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = AggregateProductStatusesServiceClient( + credentials=creds1, + transport=transport_name, + ) + client2 = AggregateProductStatusesServiceClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.list_aggregate_product_statuses._session + session2 = client2.transport.list_aggregate_product_statuses._session + assert session1 != session2 + + +def test_aggregate_product_statuses_service_grpc_transport_channel(): + channel = grpc.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.AggregateProductStatusesServiceGrpcTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +def test_aggregate_product_statuses_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.AggregateProductStatusesServiceGrpcAsyncIOTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize( + "transport_class", + [ + transports.AggregateProductStatusesServiceGrpcTransport, + transports.AggregateProductStatusesServiceGrpcAsyncIOTransport, + ], +) +def test_aggregate_product_statuses_service_transport_channel_mtls_with_client_cert_source( + transport_class, +): + with mock.patch( + "grpc.ssl_channel_credentials", autospec=True + ) as grpc_ssl_channel_cred: + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize( + "transport_class", + [ + transports.AggregateProductStatusesServiceGrpcTransport, + transports.AggregateProductStatusesServiceGrpcAsyncIOTransport, + ], +) +def test_aggregate_product_statuses_service_transport_channel_mtls_with_adc( + transport_class, +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_aggregate_product_status_path(): + account = "squid" + aggregate_product_status = "clam" + expected = ( + "accounts/{account}/aggregateProductStatuses/{aggregate_product_status}".format( + account=account, + aggregate_product_status=aggregate_product_status, + ) + ) + actual = AggregateProductStatusesServiceClient.aggregate_product_status_path( + account, aggregate_product_status + ) + assert expected == actual + + +def test_parse_aggregate_product_status_path(): + expected = { + "account": "whelk", + "aggregate_product_status": "octopus", + } + path = AggregateProductStatusesServiceClient.aggregate_product_status_path( + **expected + ) + + # Check that the path construction is reversible. + actual = AggregateProductStatusesServiceClient.parse_aggregate_product_status_path( + path + ) + assert expected == actual + + +def test_common_billing_account_path(): + billing_account = "oyster" + expected = "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + actual = AggregateProductStatusesServiceClient.common_billing_account_path( + billing_account + ) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "nudibranch", + } + path = AggregateProductStatusesServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = AggregateProductStatusesServiceClient.parse_common_billing_account_path( + path + ) + assert expected == actual + + +def test_common_folder_path(): + folder = "cuttlefish" + expected = "folders/{folder}".format( + folder=folder, + ) + actual = AggregateProductStatusesServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "mussel", + } + path = AggregateProductStatusesServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = AggregateProductStatusesServiceClient.parse_common_folder_path(path) + assert expected == actual + + +def test_common_organization_path(): + organization = "winkle" + expected = "organizations/{organization}".format( + organization=organization, + ) + actual = AggregateProductStatusesServiceClient.common_organization_path( + organization + ) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nautilus", + } + path = AggregateProductStatusesServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = AggregateProductStatusesServiceClient.parse_common_organization_path(path) + assert expected == actual + + +def test_common_project_path(): + project = "scallop" + expected = "projects/{project}".format( + project=project, + ) + actual = AggregateProductStatusesServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "abalone", + } + path = AggregateProductStatusesServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = AggregateProductStatusesServiceClient.parse_common_project_path(path) + assert expected == actual + + +def test_common_location_path(): + project = "squid" + location = "clam" + expected = "projects/{project}/locations/{location}".format( + project=project, + location=location, + ) + actual = AggregateProductStatusesServiceClient.common_location_path( + project, location + ) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "whelk", + "location": "octopus", + } + path = AggregateProductStatusesServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = AggregateProductStatusesServiceClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object( + transports.AggregateProductStatusesServiceTransport, "_prep_wrapped_messages" + ) as prep: + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object( + transports.AggregateProductStatusesServiceTransport, "_prep_wrapped_messages" + ) as prep: + transport_class = AggregateProductStatusesServiceClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + +def test_transport_close_grpc(): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc" + ) + with mock.patch.object( + type(getattr(client.transport, "_grpc_channel")), "close" + ) as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +@pytest.mark.asyncio +async def test_transport_close_grpc_asyncio(): + client = AggregateProductStatusesServiceAsyncClient( + credentials=async_anonymous_credentials(), transport="grpc_asyncio" + ) + with mock.patch.object( + type(getattr(client.transport, "_grpc_channel")), "close" + ) as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close_rest(): + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + with mock.patch.object( + type(getattr(client.transport, "_session")), "close" + ) as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +def test_client_ctx(): + transports = [ + "rest", + "grpc", + ] + for transport in transports: + client = AggregateProductStatusesServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + + +@pytest.mark.parametrize( + "client_class,transport_class", + [ + ( + AggregateProductStatusesServiceClient, + transports.AggregateProductStatusesServiceGrpcTransport, + ), + ( + AggregateProductStatusesServiceAsyncClient, + transports.AggregateProductStatusesServiceGrpcAsyncIOTransport, + ), + ], +) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) diff --git a/packages/google-shopping-merchant-issueresolution/tests/unit/gapic/merchant_issueresolution_v1/test_issue_resolution_service.py b/packages/google-shopping-merchant-issueresolution/tests/unit/gapic/merchant_issueresolution_v1/test_issue_resolution_service.py new file mode 100644 index 000000000000..936ec5b96eaf --- /dev/null +++ b/packages/google-shopping-merchant-issueresolution/tests/unit/gapic/merchant_issueresolution_v1/test_issue_resolution_service.py @@ -0,0 +1,4419 @@ +# -*- coding: utf-8 -*- +# Copyright 2025 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 +# +# http://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. +# +import os + +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +from collections.abc import AsyncIterable, Iterable +import json +import math + +from google.api_core import api_core_version +from google.protobuf import json_format +import grpc +from grpc.experimental import aio +from proto.marshal.rules import wrappers +from proto.marshal.rules.dates import DurationRule, TimestampRule +import pytest +from requests import PreparedRequest, Request, Response +from requests.sessions import Session + +try: + from google.auth.aio import credentials as ga_credentials_async + + HAS_GOOGLE_AUTH_AIO = True +except ImportError: # pragma: NO COVER + HAS_GOOGLE_AUTH_AIO = False + +from google.api_core import gapic_v1, grpc_helpers, grpc_helpers_async, path_template +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +import google.auth +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.oauth2 import service_account + +from google.shopping.merchant_issueresolution_v1.services.issue_resolution_service import ( + IssueResolutionServiceAsyncClient, + IssueResolutionServiceClient, + transports, +) +from google.shopping.merchant_issueresolution_v1.types import issueresolution + +CRED_INFO_JSON = { + "credential_source": "/path/to/file", + "credential_type": "service account credentials", + "principal": "service-account@example.com", +} +CRED_INFO_STRING = json.dumps(CRED_INFO_JSON) + + +async def mock_async_gen(data, chunk_size=1): + for i in range(0, len(data)): # pragma: NO COVER + chunk = data[i : i + chunk_size] + yield chunk.encode("utf-8") + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# TODO: use async auth anon credentials by default once the minimum version of google-auth is upgraded. +# See related issue: https://github.com/googleapis/gapic-generator-python/issues/2107. +def async_anonymous_credentials(): + if HAS_GOOGLE_AUTH_AIO: + return ga_credentials_async.AnonymousCredentials() + return ga_credentials.AnonymousCredentials() + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return ( + "foo.googleapis.com" + if ("localhost" in client.DEFAULT_ENDPOINT) + else client.DEFAULT_ENDPOINT + ) + + +# If default endpoint template is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint template so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint_template(client): + return ( + "test.{UNIVERSE_DOMAIN}" + if ("localhost" in client._DEFAULT_ENDPOINT_TEMPLATE) + else client._DEFAULT_ENDPOINT_TEMPLATE + ) + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert IssueResolutionServiceClient._get_default_mtls_endpoint(None) is None + assert ( + IssueResolutionServiceClient._get_default_mtls_endpoint(api_endpoint) + == api_mtls_endpoint + ) + assert ( + IssueResolutionServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) + == api_mtls_endpoint + ) + assert ( + IssueResolutionServiceClient._get_default_mtls_endpoint(sandbox_endpoint) + == sandbox_mtls_endpoint + ) + assert ( + IssueResolutionServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) + == sandbox_mtls_endpoint + ) + assert ( + IssueResolutionServiceClient._get_default_mtls_endpoint(non_googleapi) + == non_googleapi + ) + + +def test__read_environment_variables(): + assert IssueResolutionServiceClient._read_environment_variables() == ( + False, + "auto", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + assert IssueResolutionServiceClient._read_environment_variables() == ( + True, + "auto", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + assert IssueResolutionServiceClient._read_environment_variables() == ( + False, + "auto", + None, + ) + + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError) as excinfo: + IssueResolutionServiceClient._read_environment_variables() + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + assert IssueResolutionServiceClient._read_environment_variables() == ( + False, + "never", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + assert IssueResolutionServiceClient._read_environment_variables() == ( + False, + "always", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}): + assert IssueResolutionServiceClient._read_environment_variables() == ( + False, + "auto", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + IssueResolutionServiceClient._read_environment_variables() + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + with mock.patch.dict(os.environ, {"GOOGLE_CLOUD_UNIVERSE_DOMAIN": "foo.com"}): + assert IssueResolutionServiceClient._read_environment_variables() == ( + False, + "auto", + "foo.com", + ) + + +def test__get_client_cert_source(): + mock_provided_cert_source = mock.Mock() + mock_default_cert_source = mock.Mock() + + assert IssueResolutionServiceClient._get_client_cert_source(None, False) is None + assert ( + IssueResolutionServiceClient._get_client_cert_source( + mock_provided_cert_source, False + ) + is None + ) + assert ( + IssueResolutionServiceClient._get_client_cert_source( + mock_provided_cert_source, True + ) + == mock_provided_cert_source + ) + + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", return_value=True + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=mock_default_cert_source, + ): + assert ( + IssueResolutionServiceClient._get_client_cert_source(None, True) + is mock_default_cert_source + ) + assert ( + IssueResolutionServiceClient._get_client_cert_source( + mock_provided_cert_source, "true" + ) + is mock_provided_cert_source + ) + + +@mock.patch.object( + IssueResolutionServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(IssueResolutionServiceClient), +) +@mock.patch.object( + IssueResolutionServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(IssueResolutionServiceAsyncClient), +) +def test__get_api_endpoint(): + api_override = "foo.com" + mock_client_cert_source = mock.Mock() + default_universe = IssueResolutionServiceClient._DEFAULT_UNIVERSE + default_endpoint = IssueResolutionServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=default_universe + ) + mock_universe = "bar.com" + mock_endpoint = IssueResolutionServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=mock_universe + ) + + assert ( + IssueResolutionServiceClient._get_api_endpoint( + api_override, mock_client_cert_source, default_universe, "always" + ) + == api_override + ) + assert ( + IssueResolutionServiceClient._get_api_endpoint( + None, mock_client_cert_source, default_universe, "auto" + ) + == IssueResolutionServiceClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + IssueResolutionServiceClient._get_api_endpoint( + None, None, default_universe, "auto" + ) + == default_endpoint + ) + assert ( + IssueResolutionServiceClient._get_api_endpoint( + None, None, default_universe, "always" + ) + == IssueResolutionServiceClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + IssueResolutionServiceClient._get_api_endpoint( + None, mock_client_cert_source, default_universe, "always" + ) + == IssueResolutionServiceClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + IssueResolutionServiceClient._get_api_endpoint( + None, None, mock_universe, "never" + ) + == mock_endpoint + ) + assert ( + IssueResolutionServiceClient._get_api_endpoint( + None, None, default_universe, "never" + ) + == default_endpoint + ) + + with pytest.raises(MutualTLSChannelError) as excinfo: + IssueResolutionServiceClient._get_api_endpoint( + None, mock_client_cert_source, mock_universe, "auto" + ) + assert ( + str(excinfo.value) + == "mTLS is not supported in any universe other than googleapis.com." + ) + + +def test__get_universe_domain(): + client_universe_domain = "foo.com" + universe_domain_env = "bar.com" + + assert ( + IssueResolutionServiceClient._get_universe_domain( + client_universe_domain, universe_domain_env + ) + == client_universe_domain + ) + assert ( + IssueResolutionServiceClient._get_universe_domain(None, universe_domain_env) + == universe_domain_env + ) + assert ( + IssueResolutionServiceClient._get_universe_domain(None, None) + == IssueResolutionServiceClient._DEFAULT_UNIVERSE + ) + + with pytest.raises(ValueError) as excinfo: + IssueResolutionServiceClient._get_universe_domain("", None) + assert str(excinfo.value) == "Universe Domain cannot be an empty string." + + +@pytest.mark.parametrize( + "error_code,cred_info_json,show_cred_info", + [ + (401, CRED_INFO_JSON, True), + (403, CRED_INFO_JSON, True), + (404, CRED_INFO_JSON, True), + (500, CRED_INFO_JSON, False), + (401, None, False), + (403, None, False), + (404, None, False), + (500, None, False), + ], +) +def test__add_cred_info_for_auth_errors(error_code, cred_info_json, show_cred_info): + cred = mock.Mock(["get_cred_info"]) + cred.get_cred_info = mock.Mock(return_value=cred_info_json) + client = IssueResolutionServiceClient(credentials=cred) + client._transport._credentials = cred + + error = core_exceptions.GoogleAPICallError("message", details=["foo"]) + error.code = error_code + + client._add_cred_info_for_auth_errors(error) + if show_cred_info: + assert error.details == ["foo", CRED_INFO_STRING] + else: + assert error.details == ["foo"] + + +@pytest.mark.parametrize("error_code", [401, 403, 404, 500]) +def test__add_cred_info_for_auth_errors_no_get_cred_info(error_code): + cred = mock.Mock([]) + assert not hasattr(cred, "get_cred_info") + client = IssueResolutionServiceClient(credentials=cred) + client._transport._credentials = cred + + error = core_exceptions.GoogleAPICallError("message", details=[]) + error.code = error_code + + client._add_cred_info_for_auth_errors(error) + assert error.details == [] + + +@pytest.mark.parametrize( + "client_class,transport_name", + [ + (IssueResolutionServiceClient, "grpc"), + (IssueResolutionServiceAsyncClient, "grpc_asyncio"), + (IssueResolutionServiceClient, "rest"), + ], +) +def test_issue_resolution_service_client_from_service_account_info( + client_class, transport_name +): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object( + service_account.Credentials, "from_service_account_info" + ) as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + "merchantapi.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://merchantapi.googleapis.com" + ) + + +@pytest.mark.parametrize( + "transport_class,transport_name", + [ + (transports.IssueResolutionServiceGrpcTransport, "grpc"), + (transports.IssueResolutionServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.IssueResolutionServiceRestTransport, "rest"), + ], +) +def test_issue_resolution_service_client_service_account_always_use_jwt( + transport_class, transport_name +): + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object( + service_account.Credentials, "with_always_use_jwt_access", create=True + ) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize( + "client_class,transport_name", + [ + (IssueResolutionServiceClient, "grpc"), + (IssueResolutionServiceAsyncClient, "grpc_asyncio"), + (IssueResolutionServiceClient, "rest"), + ], +) +def test_issue_resolution_service_client_from_service_account_file( + client_class, transport_name +): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object( + service_account.Credentials, "from_service_account_file" + ) as factory: + factory.return_value = creds + client = client_class.from_service_account_file( + "dummy/file/path.json", transport=transport_name + ) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json( + "dummy/file/path.json", transport=transport_name + ) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + "merchantapi.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://merchantapi.googleapis.com" + ) + + +def test_issue_resolution_service_client_get_transport_class(): + transport = IssueResolutionServiceClient.get_transport_class() + available_transports = [ + transports.IssueResolutionServiceGrpcTransport, + transports.IssueResolutionServiceRestTransport, + ] + assert transport in available_transports + + transport = IssueResolutionServiceClient.get_transport_class("grpc") + assert transport == transports.IssueResolutionServiceGrpcTransport + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + ( + IssueResolutionServiceClient, + transports.IssueResolutionServiceGrpcTransport, + "grpc", + ), + ( + IssueResolutionServiceAsyncClient, + transports.IssueResolutionServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ( + IssueResolutionServiceClient, + transports.IssueResolutionServiceRestTransport, + "rest", + ), + ], +) +@mock.patch.object( + IssueResolutionServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(IssueResolutionServiceClient), +) +@mock.patch.object( + IssueResolutionServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(IssueResolutionServiceAsyncClient), +) +def test_issue_resolution_service_client_client_options( + client_class, transport_class, transport_name +): + # Check that if channel is provided we won't create a new one. + with mock.patch.object(IssueResolutionServiceClient, "get_transport_class") as gtc: + transport = transport_class(credentials=ga_credentials.AnonymousCredentials()) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object(IssueResolutionServiceClient, "get_transport_class") as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + client = client_class(transport=transport_name) + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError) as excinfo: + client = client_class(transport=transport_name) + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions( + api_audience="https://language.googleapis.com" + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com", + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,use_client_cert_env", + [ + ( + IssueResolutionServiceClient, + transports.IssueResolutionServiceGrpcTransport, + "grpc", + "true", + ), + ( + IssueResolutionServiceAsyncClient, + transports.IssueResolutionServiceGrpcAsyncIOTransport, + "grpc_asyncio", + "true", + ), + ( + IssueResolutionServiceClient, + transports.IssueResolutionServiceGrpcTransport, + "grpc", + "false", + ), + ( + IssueResolutionServiceAsyncClient, + transports.IssueResolutionServiceGrpcAsyncIOTransport, + "grpc_asyncio", + "false", + ), + ( + IssueResolutionServiceClient, + transports.IssueResolutionServiceRestTransport, + "rest", + "true", + ), + ( + IssueResolutionServiceClient, + transports.IssueResolutionServiceRestTransport, + "rest", + "false", + ), + ], +) +@mock.patch.object( + IssueResolutionServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(IssueResolutionServiceClient), +) +@mock.patch.object( + IssueResolutionServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(IssueResolutionServiceAsyncClient), +) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_issue_resolution_service_client_mtls_env_auto( + client_class, transport_class, transport_name, use_client_cert_env +): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + options = client_options.ClientOptions( + client_cert_source=client_cert_source_callback + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ) + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=True, + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=client_cert_source_callback, + ): + if use_client_cert_env == "false": + expected_host = client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ) + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env} + ): + with mock.patch.object(transport_class, "__init__") as patched: + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=False, + ): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize( + "client_class", [IssueResolutionServiceClient, IssueResolutionServiceAsyncClient] +) +@mock.patch.object( + IssueResolutionServiceClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(IssueResolutionServiceClient), +) +@mock.patch.object( + IssueResolutionServiceAsyncClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(IssueResolutionServiceAsyncClient), +) +def test_issue_resolution_service_client_get_mtls_endpoint_and_cert_source( + client_class, +): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint + ) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source( + options + ) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint + ) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source( + options + ) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=False, + ): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.mtls.has_default_client_cert_source", + return_value=True, + ): + with mock.patch( + "google.auth.transport.mtls.default_client_cert_source", + return_value=mock_client_cert_source, + ): + ( + api_endpoint, + cert_source, + ) = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + ) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert ( + str(excinfo.value) + == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + ) + + +@pytest.mark.parametrize( + "client_class", [IssueResolutionServiceClient, IssueResolutionServiceAsyncClient] +) +@mock.patch.object( + IssueResolutionServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(IssueResolutionServiceClient), +) +@mock.patch.object( + IssueResolutionServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(IssueResolutionServiceAsyncClient), +) +def test_issue_resolution_service_client_client_api_endpoint(client_class): + mock_client_cert_source = client_cert_source_callback + api_override = "foo.com" + default_universe = IssueResolutionServiceClient._DEFAULT_UNIVERSE + default_endpoint = IssueResolutionServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=default_universe + ) + mock_universe = "bar.com" + mock_endpoint = IssueResolutionServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=mock_universe + ) + + # If ClientOptions.api_endpoint is set and GOOGLE_API_USE_CLIENT_CERTIFICATE="true", + # use ClientOptions.api_endpoint as the api endpoint regardless. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ): + options = client_options.ClientOptions( + client_cert_source=mock_client_cert_source, api_endpoint=api_override + ) + client = client_class( + client_options=options, + credentials=ga_credentials.AnonymousCredentials(), + ) + assert client.api_endpoint == api_override + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == default_endpoint + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="always", + # use the DEFAULT_MTLS_ENDPOINT as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + + # If ClientOptions.api_endpoint is not set, GOOGLE_API_USE_MTLS_ENDPOINT="auto" (default), + # GOOGLE_API_USE_CLIENT_CERTIFICATE="false" (default), default cert source doesn't exist, + # and ClientOptions.universe_domain="bar.com", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with universe domain as the api endpoint. + options = client_options.ClientOptions() + universe_exists = hasattr(options, "universe_domain") + if universe_exists: + options = client_options.ClientOptions(universe_domain=mock_universe) + client = client_class( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + else: + client = client_class( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + assert client.api_endpoint == ( + mock_endpoint if universe_exists else default_endpoint + ) + assert client.universe_domain == ( + mock_universe if universe_exists else default_universe + ) + + # If ClientOptions does not have a universe domain attribute and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + options = client_options.ClientOptions() + if hasattr(options, "universe_domain"): + delattr(options, "universe_domain") + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + assert client.api_endpoint == default_endpoint + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + ( + IssueResolutionServiceClient, + transports.IssueResolutionServiceGrpcTransport, + "grpc", + ), + ( + IssueResolutionServiceAsyncClient, + transports.IssueResolutionServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ( + IssueResolutionServiceClient, + transports.IssueResolutionServiceRestTransport, + "rest", + ), + ], +) +def test_issue_resolution_service_client_client_options_scopes( + client_class, transport_class, transport_name +): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,grpc_helpers", + [ + ( + IssueResolutionServiceClient, + transports.IssueResolutionServiceGrpcTransport, + "grpc", + grpc_helpers, + ), + ( + IssueResolutionServiceAsyncClient, + transports.IssueResolutionServiceGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ( + IssueResolutionServiceClient, + transports.IssueResolutionServiceRestTransport, + "rest", + None, + ), + ], +) +def test_issue_resolution_service_client_client_options_credentials_file( + client_class, transport_class, transport_name, grpc_helpers +): + # Check the case credentials file is provided. + options = client_options.ClientOptions(credentials_file="credentials.json") + + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +def test_issue_resolution_service_client_client_options_from_dict(): + with mock.patch( + "google.shopping.merchant_issueresolution_v1.services.issue_resolution_service.transports.IssueResolutionServiceGrpcTransport.__init__" + ) as grpc_transport: + grpc_transport.return_value = None + client = IssueResolutionServiceClient( + client_options={"api_endpoint": "squid.clam.whelk"} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,grpc_helpers", + [ + ( + IssueResolutionServiceClient, + transports.IssueResolutionServiceGrpcTransport, + "grpc", + grpc_helpers, + ), + ( + IssueResolutionServiceAsyncClient, + transports.IssueResolutionServiceGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ], +) +def test_issue_resolution_service_client_create_channel_credentials_file( + client_class, transport_class, transport_name, grpc_helpers +): + # Check the case credentials file is provided. + options = client_options.ClientOptions(credentials_file="credentials.json") + + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "merchantapi.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=("https://www.googleapis.com/auth/content",), + scopes=None, + default_host="merchantapi.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "request_type", + [ + issueresolution.RenderAccountIssuesRequest, + dict, + ], +) +def test_render_account_issues(request_type, transport: str = "grpc"): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.render_account_issues), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = issueresolution.RenderAccountIssuesResponse() + response = client.render_account_issues(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = issueresolution.RenderAccountIssuesRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, issueresolution.RenderAccountIssuesResponse) + + +def test_render_account_issues_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = issueresolution.RenderAccountIssuesRequest( + name="name_value", + language_code="language_code_value", + time_zone="time_zone_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.render_account_issues), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.render_account_issues(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == issueresolution.RenderAccountIssuesRequest( + name="name_value", + language_code="language_code_value", + time_zone="time_zone_value", + ) + + +def test_render_account_issues_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.render_account_issues + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.render_account_issues + ] = mock_rpc + request = {} + client.render_account_issues(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.render_account_issues(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_render_account_issues_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", +): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._client._transport.render_account_issues + in client._client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.render_account_issues + ] = mock_rpc + + request = {} + await client.render_account_issues(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.render_account_issues(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_render_account_issues_async( + transport: str = "grpc_asyncio", + request_type=issueresolution.RenderAccountIssuesRequest, +): + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.render_account_issues), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + issueresolution.RenderAccountIssuesResponse() + ) + response = await client.render_account_issues(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = issueresolution.RenderAccountIssuesRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, issueresolution.RenderAccountIssuesResponse) + + +@pytest.mark.asyncio +async def test_render_account_issues_async_from_dict(): + await test_render_account_issues_async(request_type=dict) + + +def test_render_account_issues_field_headers(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = issueresolution.RenderAccountIssuesRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.render_account_issues), "__call__" + ) as call: + call.return_value = issueresolution.RenderAccountIssuesResponse() + client.render_account_issues(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_render_account_issues_field_headers_async(): + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = issueresolution.RenderAccountIssuesRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.render_account_issues), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + issueresolution.RenderAccountIssuesResponse() + ) + await client.render_account_issues(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +def test_render_account_issues_flattened(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.render_account_issues), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = issueresolution.RenderAccountIssuesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.render_account_issues( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_render_account_issues_flattened_error(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.render_account_issues( + issueresolution.RenderAccountIssuesRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_render_account_issues_flattened_async(): + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.render_account_issues), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = issueresolution.RenderAccountIssuesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + issueresolution.RenderAccountIssuesResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.render_account_issues( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_render_account_issues_flattened_error_async(): + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.render_account_issues( + issueresolution.RenderAccountIssuesRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + issueresolution.RenderProductIssuesRequest, + dict, + ], +) +def test_render_product_issues(request_type, transport: str = "grpc"): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.render_product_issues), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = issueresolution.RenderProductIssuesResponse() + response = client.render_product_issues(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = issueresolution.RenderProductIssuesRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, issueresolution.RenderProductIssuesResponse) + + +def test_render_product_issues_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = issueresolution.RenderProductIssuesRequest( + name="name_value", + language_code="language_code_value", + time_zone="time_zone_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.render_product_issues), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.render_product_issues(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == issueresolution.RenderProductIssuesRequest( + name="name_value", + language_code="language_code_value", + time_zone="time_zone_value", + ) + + +def test_render_product_issues_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.render_product_issues + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.render_product_issues + ] = mock_rpc + request = {} + client.render_product_issues(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.render_product_issues(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_render_product_issues_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", +): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._client._transport.render_product_issues + in client._client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.render_product_issues + ] = mock_rpc + + request = {} + await client.render_product_issues(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.render_product_issues(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_render_product_issues_async( + transport: str = "grpc_asyncio", + request_type=issueresolution.RenderProductIssuesRequest, +): + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.render_product_issues), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + issueresolution.RenderProductIssuesResponse() + ) + response = await client.render_product_issues(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = issueresolution.RenderProductIssuesRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, issueresolution.RenderProductIssuesResponse) + + +@pytest.mark.asyncio +async def test_render_product_issues_async_from_dict(): + await test_render_product_issues_async(request_type=dict) + + +def test_render_product_issues_field_headers(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = issueresolution.RenderProductIssuesRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.render_product_issues), "__call__" + ) as call: + call.return_value = issueresolution.RenderProductIssuesResponse() + client.render_product_issues(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_render_product_issues_field_headers_async(): + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = issueresolution.RenderProductIssuesRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.render_product_issues), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + issueresolution.RenderProductIssuesResponse() + ) + await client.render_product_issues(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +def test_render_product_issues_flattened(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.render_product_issues), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = issueresolution.RenderProductIssuesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.render_product_issues( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_render_product_issues_flattened_error(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.render_product_issues( + issueresolution.RenderProductIssuesRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_render_product_issues_flattened_async(): + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.render_product_issues), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = issueresolution.RenderProductIssuesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + issueresolution.RenderProductIssuesResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.render_product_issues( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_render_product_issues_flattened_error_async(): + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.render_product_issues( + issueresolution.RenderProductIssuesRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + issueresolution.TriggerActionRequest, + dict, + ], +) +def test_trigger_action(request_type, transport: str = "grpc"): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.trigger_action), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = issueresolution.TriggerActionResponse( + message="message_value", + ) + response = client.trigger_action(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = issueresolution.TriggerActionRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, issueresolution.TriggerActionResponse) + assert response.message == "message_value" + + +def test_trigger_action_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = issueresolution.TriggerActionRequest( + name="name_value", + language_code="language_code_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.trigger_action), "__call__") as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.trigger_action(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == issueresolution.TriggerActionRequest( + name="name_value", + language_code="language_code_value", + ) + + +def test_trigger_action_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.trigger_action in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[client._transport.trigger_action] = mock_rpc + request = {} + client.trigger_action(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.trigger_action(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_trigger_action_async_use_cached_wrapped_rpc( + transport: str = "grpc_asyncio", +): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._client._transport.trigger_action + in client._client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.AsyncMock() + mock_rpc.return_value = mock.Mock() + client._client._transport._wrapped_methods[ + client._client._transport.trigger_action + ] = mock_rpc + + request = {} + await client.trigger_action(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.trigger_action(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +@pytest.mark.asyncio +async def test_trigger_action_async( + transport: str = "grpc_asyncio", request_type=issueresolution.TriggerActionRequest +): + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.trigger_action), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + issueresolution.TriggerActionResponse( + message="message_value", + ) + ) + response = await client.trigger_action(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = issueresolution.TriggerActionRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, issueresolution.TriggerActionResponse) + assert response.message == "message_value" + + +@pytest.mark.asyncio +async def test_trigger_action_async_from_dict(): + await test_trigger_action_async(request_type=dict) + + +def test_trigger_action_field_headers(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = issueresolution.TriggerActionRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.trigger_action), "__call__") as call: + call.return_value = issueresolution.TriggerActionResponse() + client.trigger_action(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_trigger_action_field_headers_async(): + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = issueresolution.TriggerActionRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.trigger_action), "__call__") as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + issueresolution.TriggerActionResponse() + ) + await client.trigger_action(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + "x-goog-request-params", + "name=name_value", + ) in kw["metadata"] + + +def test_trigger_action_flattened(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.trigger_action), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = issueresolution.TriggerActionResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.trigger_action( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +def test_trigger_action_flattened_error(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.trigger_action( + issueresolution.TriggerActionRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_trigger_action_flattened_async(): + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object(type(client.transport.trigger_action), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = issueresolution.TriggerActionResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + issueresolution.TriggerActionResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.trigger_action( + name="name_value", + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].name + mock_val = "name_value" + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_trigger_action_flattened_error_async(): + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.trigger_action( + issueresolution.TriggerActionRequest(), + name="name_value", + ) + + +def test_render_account_issues_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.render_account_issues + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.render_account_issues + ] = mock_rpc + + request = {} + client.render_account_issues(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.render_account_issues(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_render_account_issues_rest_required_fields( + request_type=issueresolution.RenderAccountIssuesRequest, +): + transport_class = transports.IssueResolutionServiceRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson(pb_request, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).render_account_issues._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).render_account_issues._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "language_code", + "time_zone", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = issueresolution.RenderAccountIssuesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = issueresolution.RenderAccountIssuesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.render_account_issues(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_render_account_issues_rest_unset_required_fields(): + transport = transports.IssueResolutionServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.render_account_issues._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "languageCode", + "timeZone", + ) + ) + & set(("name",)) + ) + + +def test_render_account_issues_rest_flattened(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = issueresolution.RenderAccountIssuesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"name": "accounts/sample1"} + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = issueresolution.RenderAccountIssuesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.render_account_issues(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/issueresolution/v1/{name=accounts/*}:renderaccountissues" + % client.transport._host, + args[1], + ) + + +def test_render_account_issues_rest_flattened_error(transport: str = "rest"): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.render_account_issues( + issueresolution.RenderAccountIssuesRequest(), + name="name_value", + ) + + +def test_render_product_issues_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert ( + client._transport.render_product_issues + in client._transport._wrapped_methods + ) + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[ + client._transport.render_product_issues + ] = mock_rpc + + request = {} + client.render_product_issues(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.render_product_issues(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_render_product_issues_rest_required_fields( + request_type=issueresolution.RenderProductIssuesRequest, +): + transport_class = transports.IssueResolutionServiceRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson(pb_request, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).render_product_issues._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).render_product_issues._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "language_code", + "time_zone", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = issueresolution.RenderProductIssuesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = issueresolution.RenderProductIssuesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.render_product_issues(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_render_product_issues_rest_unset_required_fields(): + transport = transports.IssueResolutionServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.render_product_issues._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "languageCode", + "timeZone", + ) + ) + & set(("name",)) + ) + + +def test_render_product_issues_rest_flattened(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = issueresolution.RenderProductIssuesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"name": "accounts/sample1/products/sample2"} + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = issueresolution.RenderProductIssuesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.render_product_issues(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/issueresolution/v1/{name=accounts/*/products/*}:renderproductissues" + % client.transport._host, + args[1], + ) + + +def test_render_product_issues_rest_flattened_error(transport: str = "rest"): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.render_product_issues( + issueresolution.RenderProductIssuesRequest(), + name="name_value", + ) + + +def test_trigger_action_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.trigger_action in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client._transport._wrapped_methods[client._transport.trigger_action] = mock_rpc + + request = {} + client.trigger_action(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.trigger_action(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_trigger_action_rest_required_fields( + request_type=issueresolution.TriggerActionRequest, +): + transport_class = transports.IssueResolutionServiceRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson(pb_request, use_integers_for_enums=False) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).trigger_action._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = "name_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).trigger_action._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("language_code",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == "name_value" + + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = issueresolution.TriggerActionResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = issueresolution.TriggerActionResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + response = client.trigger_action(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_trigger_action_rest_unset_required_fields(): + transport = transports.IssueResolutionServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.trigger_action._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(("languageCode",)) + & set( + ( + "name", + "payload", + ) + ) + ) + + +def test_trigger_action_rest_flattened(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = issueresolution.TriggerActionResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"name": "accounts/sample1"} + + # get truthy value for each flattened field + mock_args = dict( + name="name_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = issueresolution.TriggerActionResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + + client.trigger_action(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/issueresolution/v1/{name=accounts/*}:triggeraction" + % client.transport._host, + args[1], + ) + + +def test_trigger_action_rest_flattened_error(transport: str = "rest"): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.trigger_action( + issueresolution.TriggerActionRequest(), + name="name_value", + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.IssueResolutionServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.IssueResolutionServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = IssueResolutionServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.IssueResolutionServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = IssueResolutionServiceClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = IssueResolutionServiceClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.IssueResolutionServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = IssueResolutionServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.IssueResolutionServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = IssueResolutionServiceClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.IssueResolutionServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.IssueResolutionServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.IssueResolutionServiceGrpcTransport, + transports.IssueResolutionServiceGrpcAsyncIOTransport, + transports.IssueResolutionServiceRestTransport, + ], +) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + + +def test_transport_kind_grpc(): + transport = IssueResolutionServiceClient.get_transport_class("grpc")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "grpc" + + +def test_initialize_client_w_grpc(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_render_account_issues_empty_call_grpc(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.render_account_issues), "__call__" + ) as call: + call.return_value = issueresolution.RenderAccountIssuesResponse() + client.render_account_issues(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = issueresolution.RenderAccountIssuesRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_render_product_issues_empty_call_grpc(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.render_product_issues), "__call__" + ) as call: + call.return_value = issueresolution.RenderProductIssuesResponse() + client.render_product_issues(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = issueresolution.RenderProductIssuesRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_trigger_action_empty_call_grpc(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.trigger_action), "__call__") as call: + call.return_value = issueresolution.TriggerActionResponse() + client.trigger_action(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = issueresolution.TriggerActionRequest() + + assert args[0] == request_msg + + +def test_transport_kind_grpc_asyncio(): + transport = IssueResolutionServiceAsyncClient.get_transport_class("grpc_asyncio")( + credentials=async_anonymous_credentials() + ) + assert transport.kind == "grpc_asyncio" + + +def test_initialize_client_w_grpc_asyncio(): + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), transport="grpc_asyncio" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_render_account_issues_empty_call_grpc_asyncio(): + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.render_account_issues), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + issueresolution.RenderAccountIssuesResponse() + ) + await client.render_account_issues(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = issueresolution.RenderAccountIssuesRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_render_product_issues_empty_call_grpc_asyncio(): + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.render_product_issues), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + issueresolution.RenderProductIssuesResponse() + ) + await client.render_product_issues(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = issueresolution.RenderProductIssuesRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +@pytest.mark.asyncio +async def test_trigger_action_empty_call_grpc_asyncio(): + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.trigger_action), "__call__") as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + issueresolution.TriggerActionResponse( + message="message_value", + ) + ) + await client.trigger_action(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = issueresolution.TriggerActionRequest() + + assert args[0] == request_msg + + +def test_transport_kind_rest(): + transport = IssueResolutionServiceClient.get_transport_class("rest")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "rest" + + +def test_render_account_issues_rest_bad_request( + request_type=issueresolution.RenderAccountIssuesRequest, +): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {"name": "accounts/sample1"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.render_account_issues(request) + + +@pytest.mark.parametrize( + "request_type", + [ + issueresolution.RenderAccountIssuesRequest, + dict, + ], +) +def test_render_account_issues_rest_call_success(request_type): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"name": "accounts/sample1"} + request_init["payload"] = {"content_option": 1, "user_input_action_option": 1} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = issueresolution.RenderAccountIssuesRequest.meta.fields["payload"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["payload"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + { + "field": field, + "subfield": subfield, + "is_repeated": is_repeated, + } + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["payload"][field])): + del request_init["payload"][field][i][subfield] + else: + del request_init["payload"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = issueresolution.RenderAccountIssuesResponse() + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = issueresolution.RenderAccountIssuesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.render_account_issues(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, issueresolution.RenderAccountIssuesResponse) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_render_account_issues_rest_interceptors(null_interceptor): + transport = transports.IssueResolutionServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.IssueResolutionServiceRestInterceptor(), + ) + client = IssueResolutionServiceClient(transport=transport) + + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.IssueResolutionServiceRestInterceptor, "post_render_account_issues" + ) as post, mock.patch.object( + transports.IssueResolutionServiceRestInterceptor, + "post_render_account_issues_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.IssueResolutionServiceRestInterceptor, "pre_render_account_issues" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = issueresolution.RenderAccountIssuesRequest.pb( + issueresolution.RenderAccountIssuesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = issueresolution.RenderAccountIssuesResponse.to_json( + issueresolution.RenderAccountIssuesResponse() + ) + req.return_value.content = return_value + + request = issueresolution.RenderAccountIssuesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = issueresolution.RenderAccountIssuesResponse() + post_with_metadata.return_value = ( + issueresolution.RenderAccountIssuesResponse(), + metadata, + ) + + client.render_account_issues( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_render_product_issues_rest_bad_request( + request_type=issueresolution.RenderProductIssuesRequest, +): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {"name": "accounts/sample1/products/sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.render_product_issues(request) + + +@pytest.mark.parametrize( + "request_type", + [ + issueresolution.RenderProductIssuesRequest, + dict, + ], +) +def test_render_product_issues_rest_call_success(request_type): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"name": "accounts/sample1/products/sample2"} + request_init["payload"] = {"content_option": 1, "user_input_action_option": 1} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = issueresolution.RenderProductIssuesRequest.meta.fields["payload"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["payload"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + { + "field": field, + "subfield": subfield, + "is_repeated": is_repeated, + } + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["payload"][field])): + del request_init["payload"][field][i][subfield] + else: + del request_init["payload"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = issueresolution.RenderProductIssuesResponse() + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = issueresolution.RenderProductIssuesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.render_product_issues(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, issueresolution.RenderProductIssuesResponse) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_render_product_issues_rest_interceptors(null_interceptor): + transport = transports.IssueResolutionServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.IssueResolutionServiceRestInterceptor(), + ) + client = IssueResolutionServiceClient(transport=transport) + + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.IssueResolutionServiceRestInterceptor, "post_render_product_issues" + ) as post, mock.patch.object( + transports.IssueResolutionServiceRestInterceptor, + "post_render_product_issues_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.IssueResolutionServiceRestInterceptor, "pre_render_product_issues" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = issueresolution.RenderProductIssuesRequest.pb( + issueresolution.RenderProductIssuesRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = issueresolution.RenderProductIssuesResponse.to_json( + issueresolution.RenderProductIssuesResponse() + ) + req.return_value.content = return_value + + request = issueresolution.RenderProductIssuesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = issueresolution.RenderProductIssuesResponse() + post_with_metadata.return_value = ( + issueresolution.RenderProductIssuesResponse(), + metadata, + ) + + client.render_product_issues( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_trigger_action_rest_bad_request( + request_type=issueresolution.TriggerActionRequest, +): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {"name": "accounts/sample1"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = mock.Mock() + json_return_value = "" + response_value.json = mock.Mock(return_value={}) + response_value.status_code = 400 + response_value.request = mock.Mock() + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + client.trigger_action(request) + + +@pytest.mark.parametrize( + "request_type", + [ + issueresolution.TriggerActionRequest, + dict, + ], +) +def test_trigger_action_rest_call_success(request_type): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"name": "accounts/sample1"} + request_init["payload"] = { + "action_context": "action_context_value", + "action_input": { + "action_flow_id": "action_flow_id_value", + "input_values": [ + { + "text_input_value": {"value": "value_value"}, + "choice_input_value": { + "choice_input_option_id": "choice_input_option_id_value" + }, + "checkbox_input_value": {"value": True}, + "input_field_id": "input_field_id_value", + } + ], + }, + } + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = issueresolution.TriggerActionRequest.meta.fields["payload"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["payload"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + { + "field": field, + "subfield": subfield, + "is_repeated": is_repeated, + } + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["payload"][field])): + del request_init["payload"][field][i][subfield] + else: + del request_init["payload"][field][subfield] + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = issueresolution.TriggerActionResponse( + message="message_value", + ) + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = issueresolution.TriggerActionResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value.content = json_return_value.encode("UTF-8") + req.return_value = response_value + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + response = client.trigger_action(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, issueresolution.TriggerActionResponse) + assert response.message == "message_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_trigger_action_rest_interceptors(null_interceptor): + transport = transports.IssueResolutionServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.IssueResolutionServiceRestInterceptor(), + ) + client = IssueResolutionServiceClient(transport=transport) + + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.IssueResolutionServiceRestInterceptor, "post_trigger_action" + ) as post, mock.patch.object( + transports.IssueResolutionServiceRestInterceptor, + "post_trigger_action_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.IssueResolutionServiceRestInterceptor, "pre_trigger_action" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = issueresolution.TriggerActionRequest.pb( + issueresolution.TriggerActionRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = mock.Mock() + req.return_value.status_code = 200 + req.return_value.headers = {"header-1": "value-1", "header-2": "value-2"} + return_value = issueresolution.TriggerActionResponse.to_json( + issueresolution.TriggerActionResponse() + ) + req.return_value.content = return_value + + request = issueresolution.TriggerActionRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = issueresolution.TriggerActionResponse() + post_with_metadata.return_value = ( + issueresolution.TriggerActionResponse(), + metadata, + ) + + client.trigger_action( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_initialize_client_w_rest(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + assert client is not None + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_render_account_issues_empty_call_rest(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.render_account_issues), "__call__" + ) as call: + client.render_account_issues(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = issueresolution.RenderAccountIssuesRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_render_product_issues_empty_call_rest(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.render_product_issues), "__call__" + ) as call: + client.render_product_issues(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = issueresolution.RenderProductIssuesRequest() + + assert args[0] == request_msg + + +# This test is a coverage failsafe to make sure that totally empty calls, +# i.e. request == None and no flattened fields passed, work. +def test_trigger_action_empty_call_rest(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object(type(client.transport.trigger_action), "__call__") as call: + client.trigger_action(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = issueresolution.TriggerActionRequest() + + assert args[0] == request_msg + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.IssueResolutionServiceGrpcTransport, + ) + + +def test_issue_resolution_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.IssueResolutionServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_issue_resolution_service_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.shopping.merchant_issueresolution_v1.services.issue_resolution_service.transports.IssueResolutionServiceTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.IssueResolutionServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + "render_account_issues", + "render_product_issues", + "trigger_action", + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + # Catch all for all remaining methods and properties + remainder = [ + "kind", + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +def test_issue_resolution_service_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch( + "google.shopping.merchant_issueresolution_v1.services.issue_resolution_service.transports.IssueResolutionServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.IssueResolutionServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with( + "credentials.json", + scopes=None, + default_scopes=("https://www.googleapis.com/auth/content",), + quota_project_id="octopus", + ) + + +def test_issue_resolution_service_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch( + "google.shopping.merchant_issueresolution_v1.services.issue_resolution_service.transports.IssueResolutionServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.IssueResolutionServiceTransport() + adc.assert_called_once() + + +def test_issue_resolution_service_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + IssueResolutionServiceClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=("https://www.googleapis.com/auth/content",), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.IssueResolutionServiceGrpcTransport, + transports.IssueResolutionServiceGrpcAsyncIOTransport, + ], +) +def test_issue_resolution_service_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=("https://www.googleapis.com/auth/content",), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.IssueResolutionServiceGrpcTransport, + transports.IssueResolutionServiceGrpcAsyncIOTransport, + transports.IssueResolutionServiceRestTransport, + ], +) +def test_issue_resolution_service_transport_auth_gdch_credentials(transport_class): + host = "https://language.com" + api_audience_tests = [None, "https://language2.com"] + api_audience_expect = [host, "https://language2.com"] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, "default", autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock( + return_value=gdch_mock + ) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with(e) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.IssueResolutionServiceGrpcTransport, grpc_helpers), + (transports.IssueResolutionServiceGrpcAsyncIOTransport, grpc_helpers_async), + ], +) +def test_issue_resolution_service_transport_create_channel( + transport_class, grpc_helpers +): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + + create_channel.assert_called_with( + "merchantapi.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=("https://www.googleapis.com/auth/content",), + scopes=["1", "2"], + default_host="merchantapi.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.IssueResolutionServiceGrpcTransport, + transports.IssueResolutionServiceGrpcAsyncIOTransport, + ], +) +def test_issue_resolution_service_grpc_transport_client_cert_source_for_mtls( + transport_class, +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds, + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback, + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, private_key=expected_key + ) + + +def test_issue_resolution_service_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.IssueResolutionServiceRestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + "rest", + ], +) +def test_issue_resolution_service_host_no_port(transport_name): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="merchantapi.googleapis.com" + ), + transport=transport_name, + ) + assert client.transport._host == ( + "merchantapi.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://merchantapi.googleapis.com" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "grpc_asyncio", + "rest", + ], +) +def test_issue_resolution_service_host_with_port(transport_name): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions( + api_endpoint="merchantapi.googleapis.com:8000" + ), + transport=transport_name, + ) + assert client.transport._host == ( + "merchantapi.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://merchantapi.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_issue_resolution_service_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = IssueResolutionServiceClient( + credentials=creds1, + transport=transport_name, + ) + client2 = IssueResolutionServiceClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.render_account_issues._session + session2 = client2.transport.render_account_issues._session + assert session1 != session2 + session1 = client1.transport.render_product_issues._session + session2 = client2.transport.render_product_issues._session + assert session1 != session2 + session1 = client1.transport.trigger_action._session + session2 = client2.transport.trigger_action._session + assert session1 != session2 + + +def test_issue_resolution_service_grpc_transport_channel(): + channel = grpc.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.IssueResolutionServiceGrpcTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +def test_issue_resolution_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.IssueResolutionServiceGrpcAsyncIOTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize( + "transport_class", + [ + transports.IssueResolutionServiceGrpcTransport, + transports.IssueResolutionServiceGrpcAsyncIOTransport, + ], +) +def test_issue_resolution_service_transport_channel_mtls_with_client_cert_source( + transport_class, +): + with mock.patch( + "grpc.ssl_channel_credentials", autospec=True + ) as grpc_ssl_channel_cred: + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, "default") as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize( + "transport_class", + [ + transports.IssueResolutionServiceGrpcTransport, + transports.IssueResolutionServiceGrpcAsyncIOTransport, + ], +) +def test_issue_resolution_service_transport_channel_mtls_with_adc(transport_class): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object( + transport_class, "create_channel" + ) as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_account_path(): + account = "squid" + expected = "accounts/{account}".format( + account=account, + ) + actual = IssueResolutionServiceClient.account_path(account) + assert expected == actual + + +def test_parse_account_path(): + expected = { + "account": "clam", + } + path = IssueResolutionServiceClient.account_path(**expected) + + # Check that the path construction is reversible. + actual = IssueResolutionServiceClient.parse_account_path(path) + assert expected == actual + + +def test_product_path(): + account = "whelk" + product = "octopus" + expected = "accounts/{account}/products/{product}".format( + account=account, + product=product, + ) + actual = IssueResolutionServiceClient.product_path(account, product) + assert expected == actual + + +def test_parse_product_path(): + expected = { + "account": "oyster", + "product": "nudibranch", + } + path = IssueResolutionServiceClient.product_path(**expected) + + # Check that the path construction is reversible. + actual = IssueResolutionServiceClient.parse_product_path(path) + assert expected == actual + + +def test_common_billing_account_path(): + billing_account = "cuttlefish" + expected = "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + actual = IssueResolutionServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "mussel", + } + path = IssueResolutionServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = IssueResolutionServiceClient.parse_common_billing_account_path(path) + assert expected == actual + + +def test_common_folder_path(): + folder = "winkle" + expected = "folders/{folder}".format( + folder=folder, + ) + actual = IssueResolutionServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "nautilus", + } + path = IssueResolutionServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = IssueResolutionServiceClient.parse_common_folder_path(path) + assert expected == actual + + +def test_common_organization_path(): + organization = "scallop" + expected = "organizations/{organization}".format( + organization=organization, + ) + actual = IssueResolutionServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "abalone", + } + path = IssueResolutionServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = IssueResolutionServiceClient.parse_common_organization_path(path) + assert expected == actual + + +def test_common_project_path(): + project = "squid" + expected = "projects/{project}".format( + project=project, + ) + actual = IssueResolutionServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "clam", + } + path = IssueResolutionServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = IssueResolutionServiceClient.parse_common_project_path(path) + assert expected == actual + + +def test_common_location_path(): + project = "whelk" + location = "octopus" + expected = "projects/{project}/locations/{location}".format( + project=project, + location=location, + ) + actual = IssueResolutionServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "oyster", + "location": "nudibranch", + } + path = IssueResolutionServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = IssueResolutionServiceClient.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object( + transports.IssueResolutionServiceTransport, "_prep_wrapped_messages" + ) as prep: + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object( + transports.IssueResolutionServiceTransport, "_prep_wrapped_messages" + ) as prep: + transport_class = IssueResolutionServiceClient.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + +def test_transport_close_grpc(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="grpc" + ) + with mock.patch.object( + type(getattr(client.transport, "_grpc_channel")), "close" + ) as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +@pytest.mark.asyncio +async def test_transport_close_grpc_asyncio(): + client = IssueResolutionServiceAsyncClient( + credentials=async_anonymous_credentials(), transport="grpc_asyncio" + ) + with mock.patch.object( + type(getattr(client.transport, "_grpc_channel")), "close" + ) as close: + async with client: + close.assert_not_called() + close.assert_called_once() + + +def test_transport_close_rest(): + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + with mock.patch.object( + type(getattr(client.transport, "_session")), "close" + ) as close: + with client: + close.assert_not_called() + close.assert_called_once() + + +def test_client_ctx(): + transports = [ + "rest", + "grpc", + ] + for transport in transports: + client = IssueResolutionServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + + +@pytest.mark.parametrize( + "client_class,transport_class", + [ + (IssueResolutionServiceClient, transports.IssueResolutionServiceGrpcTransport), + ( + IssueResolutionServiceAsyncClient, + transports.IssueResolutionServiceGrpcAsyncIOTransport, + ), + ], +) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE + ), + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience=None, + )