diff --git a/packages/google-shopping-merchant-notifications/docs/index.rst b/packages/google-shopping-merchant-notifications/docs/index.rst index 52e88f8cd7aa..7040dfc93c96 100644 --- a/packages/google-shopping-merchant-notifications/docs/index.rst +++ b/packages/google-shopping-merchant-notifications/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_notifications_v1beta``. + API Reference ------------- @@ -11,6 +14,14 @@ API Reference merchant_notifications_v1beta/services_ merchant_notifications_v1beta/types_ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + merchant_notifications_v1/services_ + merchant_notifications_v1/types_ + Changelog --------- diff --git a/packages/google-shopping-merchant-notifications/docs/merchant_notifications_v1/notifications_api_service.rst b/packages/google-shopping-merchant-notifications/docs/merchant_notifications_v1/notifications_api_service.rst new file mode 100644 index 000000000000..593ba63bff24 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/docs/merchant_notifications_v1/notifications_api_service.rst @@ -0,0 +1,10 @@ +NotificationsApiService +----------------------------------------- + +.. automodule:: google.shopping.merchant_notifications_v1.services.notifications_api_service + :members: + :inherited-members: + +.. automodule:: google.shopping.merchant_notifications_v1.services.notifications_api_service.pagers + :members: + :inherited-members: diff --git a/packages/google-shopping-merchant-notifications/docs/merchant_notifications_v1/services_.rst b/packages/google-shopping-merchant-notifications/docs/merchant_notifications_v1/services_.rst new file mode 100644 index 000000000000..5ce9047df55d --- /dev/null +++ b/packages/google-shopping-merchant-notifications/docs/merchant_notifications_v1/services_.rst @@ -0,0 +1,6 @@ +Services for Google Shopping Merchant Notifications v1 API +========================================================== +.. toctree:: + :maxdepth: 2 + + notifications_api_service diff --git a/packages/google-shopping-merchant-notifications/docs/merchant_notifications_v1/types_.rst b/packages/google-shopping-merchant-notifications/docs/merchant_notifications_v1/types_.rst new file mode 100644 index 000000000000..09d227523695 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/docs/merchant_notifications_v1/types_.rst @@ -0,0 +1,6 @@ +Types for Google Shopping Merchant Notifications v1 API +======================================================= + +.. automodule:: google.shopping.merchant_notifications_v1.types + :members: + :show-inheritance: diff --git a/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications/gapic_version.py b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications/gapic_version.py index 9a1da44d2468..20a9cd975b02 100644 --- a/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications/gapic_version.py +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "0.1.8" # {x-release-please-version} +__version__ = "0.0.0" # {x-release-please-version} diff --git a/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/__init__.py b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/__init__.py new file mode 100644 index 000000000000..af0430cec969 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/__init__.py @@ -0,0 +1,49 @@ +# -*- 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_notifications_v1 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.notifications_api_service import ( + NotificationsApiServiceAsyncClient, + NotificationsApiServiceClient, +) +from .types.notificationsapi import ( + CreateNotificationSubscriptionRequest, + DeleteNotificationSubscriptionRequest, + GetNotificationSubscriptionHealthMetricsRequest, + GetNotificationSubscriptionRequest, + ListNotificationSubscriptionsRequest, + ListNotificationSubscriptionsResponse, + NotificationSubscription, + NotificationSubscriptionHealthMetrics, + UpdateNotificationSubscriptionRequest, +) + +__all__ = ( + "NotificationsApiServiceAsyncClient", + "CreateNotificationSubscriptionRequest", + "DeleteNotificationSubscriptionRequest", + "GetNotificationSubscriptionHealthMetricsRequest", + "GetNotificationSubscriptionRequest", + "ListNotificationSubscriptionsRequest", + "ListNotificationSubscriptionsResponse", + "NotificationSubscription", + "NotificationSubscriptionHealthMetrics", + "NotificationsApiServiceClient", + "UpdateNotificationSubscriptionRequest", +) diff --git a/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/gapic_metadata.json b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/gapic_metadata.json new file mode 100644 index 000000000000..90f64bdd9db5 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/gapic_metadata.json @@ -0,0 +1,118 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.shopping.merchant_notifications_v1", + "protoPackage": "google.shopping.merchant.notifications.v1", + "schema": "1.0", + "services": { + "NotificationsApiService": { + "clients": { + "grpc": { + "libraryClient": "NotificationsApiServiceClient", + "rpcs": { + "CreateNotificationSubscription": { + "methods": [ + "create_notification_subscription" + ] + }, + "DeleteNotificationSubscription": { + "methods": [ + "delete_notification_subscription" + ] + }, + "GetNotificationSubscription": { + "methods": [ + "get_notification_subscription" + ] + }, + "GetNotificationSubscriptionHealthMetrics": { + "methods": [ + "get_notification_subscription_health_metrics" + ] + }, + "ListNotificationSubscriptions": { + "methods": [ + "list_notification_subscriptions" + ] + }, + "UpdateNotificationSubscription": { + "methods": [ + "update_notification_subscription" + ] + } + } + }, + "grpc-async": { + "libraryClient": "NotificationsApiServiceAsyncClient", + "rpcs": { + "CreateNotificationSubscription": { + "methods": [ + "create_notification_subscription" + ] + }, + "DeleteNotificationSubscription": { + "methods": [ + "delete_notification_subscription" + ] + }, + "GetNotificationSubscription": { + "methods": [ + "get_notification_subscription" + ] + }, + "GetNotificationSubscriptionHealthMetrics": { + "methods": [ + "get_notification_subscription_health_metrics" + ] + }, + "ListNotificationSubscriptions": { + "methods": [ + "list_notification_subscriptions" + ] + }, + "UpdateNotificationSubscription": { + "methods": [ + "update_notification_subscription" + ] + } + } + }, + "rest": { + "libraryClient": "NotificationsApiServiceClient", + "rpcs": { + "CreateNotificationSubscription": { + "methods": [ + "create_notification_subscription" + ] + }, + "DeleteNotificationSubscription": { + "methods": [ + "delete_notification_subscription" + ] + }, + "GetNotificationSubscription": { + "methods": [ + "get_notification_subscription" + ] + }, + "GetNotificationSubscriptionHealthMetrics": { + "methods": [ + "get_notification_subscription_health_metrics" + ] + }, + "ListNotificationSubscriptions": { + "methods": [ + "list_notification_subscriptions" + ] + }, + "UpdateNotificationSubscription": { + "methods": [ + "update_notification_subscription" + ] + } + } + } + } + } + } +} diff --git a/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/gapic_version.py b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/gapic_version.py new file mode 100644 index 000000000000..20a9cd975b02 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_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-notifications/google/shopping/merchant_notifications_v1/py.typed b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/py.typed new file mode 100644 index 000000000000..1ce34936b424 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-shopping-merchant-notifications package uses inline types. diff --git a/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/__init__.py b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/__init__.py new file mode 100644 index 000000000000..cbf94b283c70 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_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-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/__init__.py b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/__init__.py new file mode 100644 index 000000000000..0c24b1b48ace --- /dev/null +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_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 NotificationsApiServiceAsyncClient +from .client import NotificationsApiServiceClient + +__all__ = ( + "NotificationsApiServiceClient", + "NotificationsApiServiceAsyncClient", +) diff --git a/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/async_client.py b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/async_client.py new file mode 100644 index 000000000000..f00f1c6f79b8 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/async_client.py @@ -0,0 +1,1096 @@ +# -*- 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_notifications_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.protobuf import field_mask_pb2 # type: ignore + +from google.shopping.merchant_notifications_v1.services.notifications_api_service import ( + pagers, +) +from google.shopping.merchant_notifications_v1.types import notificationsapi + +from .client import NotificationsApiServiceClient +from .transports.base import DEFAULT_CLIENT_INFO, NotificationsApiServiceTransport +from .transports.grpc_asyncio import NotificationsApiServiceGrpcAsyncIOTransport + +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 NotificationsApiServiceAsyncClient: + """Service to manage notification subscriptions for merchants""" + + _client: NotificationsApiServiceClient + + # Copy defaults from the synchronous client for use here. + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = NotificationsApiServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = NotificationsApiServiceClient.DEFAULT_MTLS_ENDPOINT + _DEFAULT_ENDPOINT_TEMPLATE = ( + NotificationsApiServiceClient._DEFAULT_ENDPOINT_TEMPLATE + ) + _DEFAULT_UNIVERSE = NotificationsApiServiceClient._DEFAULT_UNIVERSE + + notification_subscription_path = staticmethod( + NotificationsApiServiceClient.notification_subscription_path + ) + parse_notification_subscription_path = staticmethod( + NotificationsApiServiceClient.parse_notification_subscription_path + ) + notification_subscription_health_metrics_path = staticmethod( + NotificationsApiServiceClient.notification_subscription_health_metrics_path + ) + parse_notification_subscription_health_metrics_path = staticmethod( + NotificationsApiServiceClient.parse_notification_subscription_health_metrics_path + ) + common_billing_account_path = staticmethod( + NotificationsApiServiceClient.common_billing_account_path + ) + parse_common_billing_account_path = staticmethod( + NotificationsApiServiceClient.parse_common_billing_account_path + ) + common_folder_path = staticmethod(NotificationsApiServiceClient.common_folder_path) + parse_common_folder_path = staticmethod( + NotificationsApiServiceClient.parse_common_folder_path + ) + common_organization_path = staticmethod( + NotificationsApiServiceClient.common_organization_path + ) + parse_common_organization_path = staticmethod( + NotificationsApiServiceClient.parse_common_organization_path + ) + common_project_path = staticmethod( + NotificationsApiServiceClient.common_project_path + ) + parse_common_project_path = staticmethod( + NotificationsApiServiceClient.parse_common_project_path + ) + common_location_path = staticmethod( + NotificationsApiServiceClient.common_location_path + ) + parse_common_location_path = staticmethod( + NotificationsApiServiceClient.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: + NotificationsApiServiceAsyncClient: The constructed client. + """ + return NotificationsApiServiceClient.from_service_account_info.__func__(NotificationsApiServiceAsyncClient, 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: + NotificationsApiServiceAsyncClient: The constructed client. + """ + return NotificationsApiServiceClient.from_service_account_file.__func__(NotificationsApiServiceAsyncClient, 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 NotificationsApiServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> NotificationsApiServiceTransport: + """Returns the transport used by the client instance. + + Returns: + NotificationsApiServiceTransport: 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 = NotificationsApiServiceClient.get_transport_class + + def __init__( + self, + *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[ + Union[ + str, + NotificationsApiServiceTransport, + Callable[..., NotificationsApiServiceTransport], + ] + ] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the notifications api 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,NotificationsApiServiceTransport,Callable[..., NotificationsApiServiceTransport]]]): + 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 NotificationsApiServiceTransport 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 = NotificationsApiServiceClient( + 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.notifications_v1.NotificationsApiServiceAsyncClient`.", + extra={ + "serviceName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "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.notifications.v1.NotificationsApiService", + "credentialsType": None, + }, + ) + + async def get_notification_subscription( + self, + request: Optional[ + Union[notificationsapi.GetNotificationSubscriptionRequest, 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]]] = (), + ) -> notificationsapi.NotificationSubscription: + r"""Gets notification subscriptions for an account. + + .. 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_notifications_v1 + + async def sample_get_notification_subscription(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_notifications_v1.GetNotificationSubscriptionRequest( + name="name_value", + ) + + # Make the request + response = await client.get_notification_subscription(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.shopping.merchant_notifications_v1.types.GetNotificationSubscriptionRequest, dict]]): + The request object. Request message for the + GetNotificationSubscription method. + name (:class:`str`): + Required. The ``name`` of the notification subscription. + 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_notifications_v1.types.NotificationSubscription: + Represents a notification + subscription owned by a Merchant + account. + + """ + # 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, notificationsapi.GetNotificationSubscriptionRequest): + request = notificationsapi.GetNotificationSubscriptionRequest(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.get_notification_subscription + ] + + # 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 create_notification_subscription( + self, + request: Optional[ + Union[notificationsapi.CreateNotificationSubscriptionRequest, dict] + ] = None, + *, + parent: Optional[str] = None, + notification_subscription: Optional[ + notificationsapi.NotificationSubscription + ] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> notificationsapi.NotificationSubscription: + r"""Creates a notification subscription for a business. + For standalone or subaccounts accounts, the business can + create a subscription for self. For MCAs, the business + can create a subscription for all managed accounts or + for a specific subaccount. + + We will allow the following types of notification + subscriptions to exist together (per business as a + subscriber per event type): + + 1. Subscription for all managed accounts + subscription + for self. + + 2. Multiple "partial" subscriptions for managed accounts + + subscription for self. + + we will not allow (per business as a subscriber per + event type): + + 1. Multiple self subscriptions. + + 2. Multiple "all managed accounts" subscriptions. + + 3. "All managed accounts" subscription and partial + subscriptions at the same time. + + 4. Multiple partial subscriptions for the same target + account. + + .. 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_notifications_v1 + + async def sample_create_notification_subscription(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceAsyncClient() + + # Initialize request argument(s) + notification_subscription = merchant_notifications_v1.NotificationSubscription() + notification_subscription.all_managed_accounts = True + + request = merchant_notifications_v1.CreateNotificationSubscriptionRequest( + parent="parent_value", + notification_subscription=notification_subscription, + ) + + # Make the request + response = await client.create_notification_subscription(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.shopping.merchant_notifications_v1.types.CreateNotificationSubscriptionRequest, dict]]): + The request object. Request message for the + CreateNotificationSubscription method. + parent (:class:`str`): + Required. The merchant account that owns the new + notification subscription. Format: + ``accounts/{account}`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + notification_subscription (:class:`google.shopping.merchant_notifications_v1.types.NotificationSubscription`): + Required. The notification + subscription to create. + + This corresponds to the ``notification_subscription`` 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_notifications_v1.types.NotificationSubscription: + Represents a notification + subscription owned by a Merchant + account. + + """ + # 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, notification_subscription] + 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, notificationsapi.CreateNotificationSubscriptionRequest + ): + request = notificationsapi.CreateNotificationSubscriptionRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if notification_subscription is not None: + request.notification_subscription = notification_subscription + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[ + self._client._transport.create_notification_subscription + ] + + # 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, + ) + + # Done; return the response. + return response + + async def update_notification_subscription( + self, + request: Optional[ + Union[notificationsapi.UpdateNotificationSubscriptionRequest, dict] + ] = None, + *, + notification_subscription: Optional[ + notificationsapi.NotificationSubscription + ] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> notificationsapi.NotificationSubscription: + r"""Updates an existing notification subscription for a + merchant. + + .. 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_notifications_v1 + + async def sample_update_notification_subscription(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceAsyncClient() + + # Initialize request argument(s) + notification_subscription = merchant_notifications_v1.NotificationSubscription() + notification_subscription.all_managed_accounts = True + + request = merchant_notifications_v1.UpdateNotificationSubscriptionRequest( + notification_subscription=notification_subscription, + ) + + # Make the request + response = await client.update_notification_subscription(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.shopping.merchant_notifications_v1.types.UpdateNotificationSubscriptionRequest, dict]]): + The request object. Request message for the + UpdateNotificationSubscription method. + notification_subscription (:class:`google.shopping.merchant_notifications_v1.types.NotificationSubscription`): + Required. The new version of the + notification subscription that should be + updated. + + This corresponds to the ``notification_subscription`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + List of fields being updated. + This corresponds to the ``update_mask`` 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_notifications_v1.types.NotificationSubscription: + Represents a notification + subscription owned by a Merchant + account. + + """ + # 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 = [notification_subscription, update_mask] + 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, notificationsapi.UpdateNotificationSubscriptionRequest + ): + request = notificationsapi.UpdateNotificationSubscriptionRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if notification_subscription is not None: + request.notification_subscription = notification_subscription + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[ + self._client._transport.update_notification_subscription + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + ( + ( + "notification_subscription.name", + request.notification_subscription.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 delete_notification_subscription( + self, + request: Optional[ + Union[notificationsapi.DeleteNotificationSubscriptionRequest, 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]]] = (), + ) -> None: + r"""Deletes a notification subscription for a merchant. + + .. 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_notifications_v1 + + async def sample_delete_notification_subscription(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_notifications_v1.DeleteNotificationSubscriptionRequest( + name="name_value", + ) + + # Make the request + await client.delete_notification_subscription(request=request) + + Args: + request (Optional[Union[google.shopping.merchant_notifications_v1.types.DeleteNotificationSubscriptionRequest, dict]]): + The request object. Request message for the + DeleteNotificationSubscription method. + name (:class:`str`): + Required. The name of the + notification subscription to be deleted. + + 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`. + """ + # 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, notificationsapi.DeleteNotificationSubscriptionRequest + ): + request = notificationsapi.DeleteNotificationSubscriptionRequest(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.delete_notification_subscription + ] + + # 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. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def list_notification_subscriptions( + self, + request: Optional[ + Union[notificationsapi.ListNotificationSubscriptionsRequest, 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.ListNotificationSubscriptionsAsyncPager: + r"""Gets all the notification subscriptions for a + merchant. + + .. 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_notifications_v1 + + async def sample_list_notification_subscriptions(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_notifications_v1.ListNotificationSubscriptionsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_notification_subscriptions(request=request) + + # Handle the response + async for response in page_result: + print(response) + + Args: + request (Optional[Union[google.shopping.merchant_notifications_v1.types.ListNotificationSubscriptionsRequest, dict]]): + The request object. Request message for the + ListNotificationSubscription method. + parent (:class:`str`): + Required. The merchant account who owns the notification + subscriptions. 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_notifications_v1.services.notifications_api_service.pagers.ListNotificationSubscriptionsAsyncPager: + Response message for the + ListNotificationSubscription 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, notificationsapi.ListNotificationSubscriptionsRequest + ): + request = notificationsapi.ListNotificationSubscriptionsRequest(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_notification_subscriptions + ] + + # 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.ListNotificationSubscriptionsAsyncPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_notification_subscription_health_metrics( + self, + request: Optional[ + Union[ + notificationsapi.GetNotificationSubscriptionHealthMetricsRequest, 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]]] = (), + ) -> notificationsapi.NotificationSubscriptionHealthMetrics: + r"""Retrieves notification subscription health metrics + for a merchant. We recommend calling this periodically + (hourly or daily) to monitor health of your callback + endpoint. + + .. 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_notifications_v1 + + async def sample_get_notification_subscription_health_metrics(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_notifications_v1.GetNotificationSubscriptionHealthMetricsRequest( + name="name_value", + ) + + # Make the request + response = await client.get_notification_subscription_health_metrics(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.shopping.merchant_notifications_v1.types.GetNotificationSubscriptionHealthMetricsRequest, dict]]): + The request object. Request for notification subscription + health metrics. + name (:class:`str`): + Required. The ``name`` of the notification subscription + for which metrics are retrieved. Format: + ``accounts/{account}/notificationsubscriptions/{notification_subscription}`` + + 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_notifications_v1.types.NotificationSubscriptionHealthMetrics: + Represents a notification + subscription health metrics. + + """ + # 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, notificationsapi.GetNotificationSubscriptionHealthMetricsRequest + ): + request = notificationsapi.GetNotificationSubscriptionHealthMetricsRequest( + 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.get_notification_subscription_health_metrics + ] + + # 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) -> "NotificationsApiServiceAsyncClient": + 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__ = ("NotificationsApiServiceAsyncClient",) diff --git a/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/client.py b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/client.py new file mode 100644 index 000000000000..b114a3d24e2d --- /dev/null +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/client.py @@ -0,0 +1,1528 @@ +# -*- 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_notifications_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.protobuf import field_mask_pb2 # type: ignore + +from google.shopping.merchant_notifications_v1.services.notifications_api_service import ( + pagers, +) +from google.shopping.merchant_notifications_v1.types import notificationsapi + +from .transports.base import DEFAULT_CLIENT_INFO, NotificationsApiServiceTransport +from .transports.grpc import NotificationsApiServiceGrpcTransport +from .transports.grpc_asyncio import NotificationsApiServiceGrpcAsyncIOTransport +from .transports.rest import NotificationsApiServiceRestTransport + + +class NotificationsApiServiceClientMeta(type): + """Metaclass for the NotificationsApiService 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[NotificationsApiServiceTransport]] + _transport_registry["grpc"] = NotificationsApiServiceGrpcTransport + _transport_registry["grpc_asyncio"] = NotificationsApiServiceGrpcAsyncIOTransport + _transport_registry["rest"] = NotificationsApiServiceRestTransport + + def get_transport_class( + cls, + label: Optional[str] = None, + ) -> Type[NotificationsApiServiceTransport]: + """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 NotificationsApiServiceClient(metaclass=NotificationsApiServiceClientMeta): + """Service to manage notification subscriptions for merchants""" + + @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: + NotificationsApiServiceClient: 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: + NotificationsApiServiceClient: 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) -> NotificationsApiServiceTransport: + """Returns the transport used by the client instance. + + Returns: + NotificationsApiServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def notification_subscription_path( + account: str, + notification_subscription: str, + ) -> str: + """Returns a fully-qualified notification_subscription string.""" + return "accounts/{account}/notificationsubscriptions/{notification_subscription}".format( + account=account, + notification_subscription=notification_subscription, + ) + + @staticmethod + def parse_notification_subscription_path(path: str) -> Dict[str, str]: + """Parses a notification_subscription path into its component segments.""" + m = re.match( + r"^accounts/(?P.+?)/notificationsubscriptions/(?P.+?)$", + path, + ) + return m.groupdict() if m else {} + + @staticmethod + def notification_subscription_health_metrics_path( + account: str, + notification_subscription: str, + ) -> str: + """Returns a fully-qualified notification_subscription_health_metrics string.""" + return "accounts/{account}/notificationsubscriptions/{notification_subscription}".format( + account=account, + notification_subscription=notification_subscription, + ) + + @staticmethod + def parse_notification_subscription_health_metrics_path( + path: str, + ) -> Dict[str, str]: + """Parses a notification_subscription_health_metrics path into its component segments.""" + m = re.match( + r"^accounts/(?P.+?)/notificationsubscriptions/(?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 = NotificationsApiServiceClient._DEFAULT_UNIVERSE + if universe_domain != _default_universe: + raise MutualTLSChannelError( + f"mTLS is not supported in any universe other than {_default_universe}." + ) + api_endpoint = NotificationsApiServiceClient.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = ( + NotificationsApiServiceClient._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 = NotificationsApiServiceClient._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, + NotificationsApiServiceTransport, + Callable[..., NotificationsApiServiceTransport], + ] + ] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the notifications api 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,NotificationsApiServiceTransport,Callable[..., NotificationsApiServiceTransport]]]): + 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 NotificationsApiServiceTransport 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, + ) = NotificationsApiServiceClient._read_environment_variables() + self._client_cert_source = ( + NotificationsApiServiceClient._get_client_cert_source( + self._client_options.client_cert_source, self._use_client_cert + ) + ) + self._universe_domain = NotificationsApiServiceClient._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, NotificationsApiServiceTransport) + if transport_provided: + # transport is a NotificationsApiServiceTransport 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(NotificationsApiServiceTransport, transport) + self._api_endpoint = self._transport.host + + self._api_endpoint = ( + self._api_endpoint + or NotificationsApiServiceClient._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[NotificationsApiServiceTransport], + Callable[..., NotificationsApiServiceTransport], + ] = ( + NotificationsApiServiceClient.get_transport_class(transport) + if isinstance(transport, str) or transport is None + else cast(Callable[..., NotificationsApiServiceTransport], 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.notifications_v1.NotificationsApiServiceClient`.", + extra={ + "serviceName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "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.notifications.v1.NotificationsApiService", + "credentialsType": None, + }, + ) + + def get_notification_subscription( + self, + request: Optional[ + Union[notificationsapi.GetNotificationSubscriptionRequest, 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]]] = (), + ) -> notificationsapi.NotificationSubscription: + r"""Gets notification subscriptions for an account. + + .. 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_notifications_v1 + + def sample_get_notification_subscription(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceClient() + + # Initialize request argument(s) + request = merchant_notifications_v1.GetNotificationSubscriptionRequest( + name="name_value", + ) + + # Make the request + response = client.get_notification_subscription(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.shopping.merchant_notifications_v1.types.GetNotificationSubscriptionRequest, dict]): + The request object. Request message for the + GetNotificationSubscription method. + name (str): + Required. The ``name`` of the notification subscription. + 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_notifications_v1.types.NotificationSubscription: + Represents a notification + subscription owned by a Merchant + account. + + """ + # 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, notificationsapi.GetNotificationSubscriptionRequest): + request = notificationsapi.GetNotificationSubscriptionRequest(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.get_notification_subscription + ] + + # 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 create_notification_subscription( + self, + request: Optional[ + Union[notificationsapi.CreateNotificationSubscriptionRequest, dict] + ] = None, + *, + parent: Optional[str] = None, + notification_subscription: Optional[ + notificationsapi.NotificationSubscription + ] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> notificationsapi.NotificationSubscription: + r"""Creates a notification subscription for a business. + For standalone or subaccounts accounts, the business can + create a subscription for self. For MCAs, the business + can create a subscription for all managed accounts or + for a specific subaccount. + + We will allow the following types of notification + subscriptions to exist together (per business as a + subscriber per event type): + + 1. Subscription for all managed accounts + subscription + for self. + + 2. Multiple "partial" subscriptions for managed accounts + + subscription for self. + + we will not allow (per business as a subscriber per + event type): + + 1. Multiple self subscriptions. + + 2. Multiple "all managed accounts" subscriptions. + + 3. "All managed accounts" subscription and partial + subscriptions at the same time. + + 4. Multiple partial subscriptions for the same target + account. + + .. 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_notifications_v1 + + def sample_create_notification_subscription(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceClient() + + # Initialize request argument(s) + notification_subscription = merchant_notifications_v1.NotificationSubscription() + notification_subscription.all_managed_accounts = True + + request = merchant_notifications_v1.CreateNotificationSubscriptionRequest( + parent="parent_value", + notification_subscription=notification_subscription, + ) + + # Make the request + response = client.create_notification_subscription(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.shopping.merchant_notifications_v1.types.CreateNotificationSubscriptionRequest, dict]): + The request object. Request message for the + CreateNotificationSubscription method. + parent (str): + Required. The merchant account that owns the new + notification subscription. Format: + ``accounts/{account}`` + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + notification_subscription (google.shopping.merchant_notifications_v1.types.NotificationSubscription): + Required. The notification + subscription to create. + + This corresponds to the ``notification_subscription`` 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_notifications_v1.types.NotificationSubscription: + Represents a notification + subscription owned by a Merchant + account. + + """ + # 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, notification_subscription] + 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, notificationsapi.CreateNotificationSubscriptionRequest + ): + request = notificationsapi.CreateNotificationSubscriptionRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if notification_subscription is not None: + request.notification_subscription = notification_subscription + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[ + self._transport.create_notification_subscription + ] + + # 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, + ) + + # Done; return the response. + return response + + def update_notification_subscription( + self, + request: Optional[ + Union[notificationsapi.UpdateNotificationSubscriptionRequest, dict] + ] = None, + *, + notification_subscription: Optional[ + notificationsapi.NotificationSubscription + ] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> notificationsapi.NotificationSubscription: + r"""Updates an existing notification subscription for a + merchant. + + .. 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_notifications_v1 + + def sample_update_notification_subscription(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceClient() + + # Initialize request argument(s) + notification_subscription = merchant_notifications_v1.NotificationSubscription() + notification_subscription.all_managed_accounts = True + + request = merchant_notifications_v1.UpdateNotificationSubscriptionRequest( + notification_subscription=notification_subscription, + ) + + # Make the request + response = client.update_notification_subscription(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.shopping.merchant_notifications_v1.types.UpdateNotificationSubscriptionRequest, dict]): + The request object. Request message for the + UpdateNotificationSubscription method. + notification_subscription (google.shopping.merchant_notifications_v1.types.NotificationSubscription): + Required. The new version of the + notification subscription that should be + updated. + + This corresponds to the ``notification_subscription`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + List of fields being updated. + This corresponds to the ``update_mask`` 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_notifications_v1.types.NotificationSubscription: + Represents a notification + subscription owned by a Merchant + account. + + """ + # 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 = [notification_subscription, update_mask] + 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, notificationsapi.UpdateNotificationSubscriptionRequest + ): + request = notificationsapi.UpdateNotificationSubscriptionRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if notification_subscription is not None: + request.notification_subscription = notification_subscription + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[ + self._transport.update_notification_subscription + ] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata( + ( + ( + "notification_subscription.name", + request.notification_subscription.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 delete_notification_subscription( + self, + request: Optional[ + Union[notificationsapi.DeleteNotificationSubscriptionRequest, 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]]] = (), + ) -> None: + r"""Deletes a notification subscription for a merchant. + + .. 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_notifications_v1 + + def sample_delete_notification_subscription(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceClient() + + # Initialize request argument(s) + request = merchant_notifications_v1.DeleteNotificationSubscriptionRequest( + name="name_value", + ) + + # Make the request + client.delete_notification_subscription(request=request) + + Args: + request (Union[google.shopping.merchant_notifications_v1.types.DeleteNotificationSubscriptionRequest, dict]): + The request object. Request message for the + DeleteNotificationSubscription method. + name (str): + Required. The name of the + notification subscription to be deleted. + + 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`. + """ + # 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, notificationsapi.DeleteNotificationSubscriptionRequest + ): + request = notificationsapi.DeleteNotificationSubscriptionRequest(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.delete_notification_subscription + ] + + # 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. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def list_notification_subscriptions( + self, + request: Optional[ + Union[notificationsapi.ListNotificationSubscriptionsRequest, 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.ListNotificationSubscriptionsPager: + r"""Gets all the notification subscriptions for a + merchant. + + .. 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_notifications_v1 + + def sample_list_notification_subscriptions(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceClient() + + # Initialize request argument(s) + request = merchant_notifications_v1.ListNotificationSubscriptionsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_notification_subscriptions(request=request) + + # Handle the response + for response in page_result: + print(response) + + Args: + request (Union[google.shopping.merchant_notifications_v1.types.ListNotificationSubscriptionsRequest, dict]): + The request object. Request message for the + ListNotificationSubscription method. + parent (str): + Required. The merchant account who owns the notification + subscriptions. 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_notifications_v1.services.notifications_api_service.pagers.ListNotificationSubscriptionsPager: + Response message for the + ListNotificationSubscription 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, notificationsapi.ListNotificationSubscriptionsRequest + ): + request = notificationsapi.ListNotificationSubscriptionsRequest(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_notification_subscriptions + ] + + # 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.ListNotificationSubscriptionsPager( + method=rpc, + request=request, + response=response, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_notification_subscription_health_metrics( + self, + request: Optional[ + Union[ + notificationsapi.GetNotificationSubscriptionHealthMetricsRequest, 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]]] = (), + ) -> notificationsapi.NotificationSubscriptionHealthMetrics: + r"""Retrieves notification subscription health metrics + for a merchant. We recommend calling this periodically + (hourly or daily) to monitor health of your callback + endpoint. + + .. 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_notifications_v1 + + def sample_get_notification_subscription_health_metrics(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceClient() + + # Initialize request argument(s) + request = merchant_notifications_v1.GetNotificationSubscriptionHealthMetricsRequest( + name="name_value", + ) + + # Make the request + response = client.get_notification_subscription_health_metrics(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.shopping.merchant_notifications_v1.types.GetNotificationSubscriptionHealthMetricsRequest, dict]): + The request object. Request for notification subscription + health metrics. + name (str): + Required. The ``name`` of the notification subscription + for which metrics are retrieved. Format: + ``accounts/{account}/notificationsubscriptions/{notification_subscription}`` + + 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_notifications_v1.types.NotificationSubscriptionHealthMetrics: + Represents a notification + subscription health metrics. + + """ + # 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, notificationsapi.GetNotificationSubscriptionHealthMetricsRequest + ): + request = notificationsapi.GetNotificationSubscriptionHealthMetricsRequest( + 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.get_notification_subscription_health_metrics + ] + + # 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) -> "NotificationsApiServiceClient": + 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__ = ("NotificationsApiServiceClient",) diff --git a/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/pagers.py b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/pagers.py new file mode 100644 index 000000000000..3fd9b6591c99 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/pagers.py @@ -0,0 +1,201 @@ +# -*- 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_notifications_v1.types import notificationsapi + + +class ListNotificationSubscriptionsPager: + """A pager for iterating through ``list_notification_subscriptions`` requests. + + This class thinly wraps an initial + :class:`google.shopping.merchant_notifications_v1.types.ListNotificationSubscriptionsResponse` object, and + provides an ``__iter__`` method to iterate through its + ``notification_subscriptions`` field. + + If there are more pages, the ``__iter__`` method will make additional + ``ListNotificationSubscriptions`` requests and continue to iterate + through the ``notification_subscriptions`` field on the + corresponding responses. + + All the usual :class:`google.shopping.merchant_notifications_v1.types.ListNotificationSubscriptionsResponse` + 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[..., notificationsapi.ListNotificationSubscriptionsResponse], + request: notificationsapi.ListNotificationSubscriptionsRequest, + response: notificationsapi.ListNotificationSubscriptionsResponse, + *, + 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_notifications_v1.types.ListNotificationSubscriptionsRequest): + The initial request object. + response (google.shopping.merchant_notifications_v1.types.ListNotificationSubscriptionsResponse): + 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 = notificationsapi.ListNotificationSubscriptionsRequest(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[notificationsapi.ListNotificationSubscriptionsResponse]: + 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[notificationsapi.NotificationSubscription]: + for page in self.pages: + yield from page.notification_subscriptions + + def __repr__(self) -> str: + return "{0}<{1!r}>".format(self.__class__.__name__, self._response) + + +class ListNotificationSubscriptionsAsyncPager: + """A pager for iterating through ``list_notification_subscriptions`` requests. + + This class thinly wraps an initial + :class:`google.shopping.merchant_notifications_v1.types.ListNotificationSubscriptionsResponse` object, and + provides an ``__aiter__`` method to iterate through its + ``notification_subscriptions`` field. + + If there are more pages, the ``__aiter__`` method will make additional + ``ListNotificationSubscriptions`` requests and continue to iterate + through the ``notification_subscriptions`` field on the + corresponding responses. + + All the usual :class:`google.shopping.merchant_notifications_v1.types.ListNotificationSubscriptionsResponse` + 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[notificationsapi.ListNotificationSubscriptionsResponse] + ], + request: notificationsapi.ListNotificationSubscriptionsRequest, + response: notificationsapi.ListNotificationSubscriptionsResponse, + *, + 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_notifications_v1.types.ListNotificationSubscriptionsRequest): + The initial request object. + response (google.shopping.merchant_notifications_v1.types.ListNotificationSubscriptionsResponse): + 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 = notificationsapi.ListNotificationSubscriptionsRequest(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[notificationsapi.ListNotificationSubscriptionsResponse]: + 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[notificationsapi.NotificationSubscription]: + async def async_generator(): + async for page in self.pages: + for response in page.notification_subscriptions: + 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-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/README.rst b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/README.rst new file mode 100644 index 000000000000..e82a831890a4 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/README.rst @@ -0,0 +1,9 @@ + +transport inheritance structure +_______________________________ + +`NotificationsApiServiceTransport` is the ABC for all transports. +- public child `NotificationsApiServiceGrpcTransport` for sync gRPC transport (defined in `grpc.py`). +- public child `NotificationsApiServiceGrpcAsyncIOTransport` for async gRPC transport (defined in `grpc_asyncio.py`). +- private child `_BaseNotificationsApiServiceRestTransport` for base REST transport with inner classes `_BaseMETHOD` (defined in `rest_base.py`). +- public child `NotificationsApiServiceRestTransport` 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-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/__init__.py b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/__init__.py new file mode 100644 index 000000000000..baba07a3e594 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_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 NotificationsApiServiceTransport +from .grpc import NotificationsApiServiceGrpcTransport +from .grpc_asyncio import NotificationsApiServiceGrpcAsyncIOTransport +from .rest import ( + NotificationsApiServiceRestInterceptor, + NotificationsApiServiceRestTransport, +) + +# Compile a registry of transports. +_transport_registry = ( + OrderedDict() +) # type: Dict[str, Type[NotificationsApiServiceTransport]] +_transport_registry["grpc"] = NotificationsApiServiceGrpcTransport +_transport_registry["grpc_asyncio"] = NotificationsApiServiceGrpcAsyncIOTransport +_transport_registry["rest"] = NotificationsApiServiceRestTransport + +__all__ = ( + "NotificationsApiServiceTransport", + "NotificationsApiServiceGrpcTransport", + "NotificationsApiServiceGrpcAsyncIOTransport", + "NotificationsApiServiceRestTransport", + "NotificationsApiServiceRestInterceptor", +) diff --git a/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/base.py b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/base.py new file mode 100644 index 000000000000..e775f5a67788 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/base.py @@ -0,0 +1,251 @@ +# -*- 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.protobuf import empty_pb2 # type: ignore + +from google.shopping.merchant_notifications_v1 import gapic_version as package_version +from google.shopping.merchant_notifications_v1.types import notificationsapi + +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 NotificationsApiServiceTransport(abc.ABC): + """Abstract transport class for NotificationsApiService.""" + + 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.get_notification_subscription: gapic_v1.method.wrap_method( + self.get_notification_subscription, + default_timeout=None, + client_info=client_info, + ), + self.create_notification_subscription: gapic_v1.method.wrap_method( + self.create_notification_subscription, + default_timeout=None, + client_info=client_info, + ), + self.update_notification_subscription: gapic_v1.method.wrap_method( + self.update_notification_subscription, + default_timeout=None, + client_info=client_info, + ), + self.delete_notification_subscription: gapic_v1.method.wrap_method( + self.delete_notification_subscription, + default_timeout=None, + client_info=client_info, + ), + self.list_notification_subscriptions: gapic_v1.method.wrap_method( + self.list_notification_subscriptions, + default_timeout=None, + client_info=client_info, + ), + self.get_notification_subscription_health_metrics: gapic_v1.method.wrap_method( + self.get_notification_subscription_health_metrics, + 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 get_notification_subscription( + self, + ) -> Callable[ + [notificationsapi.GetNotificationSubscriptionRequest], + Union[ + notificationsapi.NotificationSubscription, + Awaitable[notificationsapi.NotificationSubscription], + ], + ]: + raise NotImplementedError() + + @property + def create_notification_subscription( + self, + ) -> Callable[ + [notificationsapi.CreateNotificationSubscriptionRequest], + Union[ + notificationsapi.NotificationSubscription, + Awaitable[notificationsapi.NotificationSubscription], + ], + ]: + raise NotImplementedError() + + @property + def update_notification_subscription( + self, + ) -> Callable[ + [notificationsapi.UpdateNotificationSubscriptionRequest], + Union[ + notificationsapi.NotificationSubscription, + Awaitable[notificationsapi.NotificationSubscription], + ], + ]: + raise NotImplementedError() + + @property + def delete_notification_subscription( + self, + ) -> Callable[ + [notificationsapi.DeleteNotificationSubscriptionRequest], + Union[empty_pb2.Empty, Awaitable[empty_pb2.Empty]], + ]: + raise NotImplementedError() + + @property + def list_notification_subscriptions( + self, + ) -> Callable[ + [notificationsapi.ListNotificationSubscriptionsRequest], + Union[ + notificationsapi.ListNotificationSubscriptionsResponse, + Awaitable[notificationsapi.ListNotificationSubscriptionsResponse], + ], + ]: + raise NotImplementedError() + + @property + def get_notification_subscription_health_metrics( + self, + ) -> Callable[ + [notificationsapi.GetNotificationSubscriptionHealthMetricsRequest], + Union[ + notificationsapi.NotificationSubscriptionHealthMetrics, + Awaitable[notificationsapi.NotificationSubscriptionHealthMetrics], + ], + ]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ("NotificationsApiServiceTransport",) diff --git a/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/grpc.py b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/grpc.py new file mode 100644 index 000000000000..dc7649281209 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/grpc.py @@ -0,0 +1,553 @@ +# -*- 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 import empty_pb2 # 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_notifications_v1.types import notificationsapi + +from .base import DEFAULT_CLIENT_INFO, NotificationsApiServiceTransport + +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.notifications.v1.NotificationsApiService", + "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.notifications.v1.NotificationsApiService", + "rpcName": client_call_details.method, + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class NotificationsApiServiceGrpcTransport(NotificationsApiServiceTransport): + """gRPC backend transport for NotificationsApiService. + + Service to manage notification subscriptions for merchants + + 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 get_notification_subscription( + self, + ) -> Callable[ + [notificationsapi.GetNotificationSubscriptionRequest], + notificationsapi.NotificationSubscription, + ]: + r"""Return a callable for the get notification subscription method over gRPC. + + Gets notification subscriptions for an account. + + Returns: + Callable[[~.GetNotificationSubscriptionRequest], + ~.NotificationSubscription]: + 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 "get_notification_subscription" not in self._stubs: + self._stubs[ + "get_notification_subscription" + ] = self._logged_channel.unary_unary( + "/google.shopping.merchant.notifications.v1.NotificationsApiService/GetNotificationSubscription", + request_serializer=notificationsapi.GetNotificationSubscriptionRequest.serialize, + response_deserializer=notificationsapi.NotificationSubscription.deserialize, + ) + return self._stubs["get_notification_subscription"] + + @property + def create_notification_subscription( + self, + ) -> Callable[ + [notificationsapi.CreateNotificationSubscriptionRequest], + notificationsapi.NotificationSubscription, + ]: + r"""Return a callable for the create notification + subscription method over gRPC. + + Creates a notification subscription for a business. + For standalone or subaccounts accounts, the business can + create a subscription for self. For MCAs, the business + can create a subscription for all managed accounts or + for a specific subaccount. + + We will allow the following types of notification + subscriptions to exist together (per business as a + subscriber per event type): + + 1. Subscription for all managed accounts + subscription + for self. + + 2. Multiple "partial" subscriptions for managed accounts + + subscription for self. + + we will not allow (per business as a subscriber per + event type): + + 1. Multiple self subscriptions. + + 2. Multiple "all managed accounts" subscriptions. + + 3. "All managed accounts" subscription and partial + subscriptions at the same time. + + 4. Multiple partial subscriptions for the same target + account. + + Returns: + Callable[[~.CreateNotificationSubscriptionRequest], + ~.NotificationSubscription]: + 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 "create_notification_subscription" not in self._stubs: + self._stubs[ + "create_notification_subscription" + ] = self._logged_channel.unary_unary( + "/google.shopping.merchant.notifications.v1.NotificationsApiService/CreateNotificationSubscription", + request_serializer=notificationsapi.CreateNotificationSubscriptionRequest.serialize, + response_deserializer=notificationsapi.NotificationSubscription.deserialize, + ) + return self._stubs["create_notification_subscription"] + + @property + def update_notification_subscription( + self, + ) -> Callable[ + [notificationsapi.UpdateNotificationSubscriptionRequest], + notificationsapi.NotificationSubscription, + ]: + r"""Return a callable for the update notification + subscription method over gRPC. + + Updates an existing notification subscription for a + merchant. + + Returns: + Callable[[~.UpdateNotificationSubscriptionRequest], + ~.NotificationSubscription]: + 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 "update_notification_subscription" not in self._stubs: + self._stubs[ + "update_notification_subscription" + ] = self._logged_channel.unary_unary( + "/google.shopping.merchant.notifications.v1.NotificationsApiService/UpdateNotificationSubscription", + request_serializer=notificationsapi.UpdateNotificationSubscriptionRequest.serialize, + response_deserializer=notificationsapi.NotificationSubscription.deserialize, + ) + return self._stubs["update_notification_subscription"] + + @property + def delete_notification_subscription( + self, + ) -> Callable[ + [notificationsapi.DeleteNotificationSubscriptionRequest], empty_pb2.Empty + ]: + r"""Return a callable for the delete notification + subscription method over gRPC. + + Deletes a notification subscription for a merchant. + + Returns: + Callable[[~.DeleteNotificationSubscriptionRequest], + ~.Empty]: + 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 "delete_notification_subscription" not in self._stubs: + self._stubs[ + "delete_notification_subscription" + ] = self._logged_channel.unary_unary( + "/google.shopping.merchant.notifications.v1.NotificationsApiService/DeleteNotificationSubscription", + request_serializer=notificationsapi.DeleteNotificationSubscriptionRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs["delete_notification_subscription"] + + @property + def list_notification_subscriptions( + self, + ) -> Callable[ + [notificationsapi.ListNotificationSubscriptionsRequest], + notificationsapi.ListNotificationSubscriptionsResponse, + ]: + r"""Return a callable for the list notification + subscriptions method over gRPC. + + Gets all the notification subscriptions for a + merchant. + + Returns: + Callable[[~.ListNotificationSubscriptionsRequest], + ~.ListNotificationSubscriptionsResponse]: + 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_notification_subscriptions" not in self._stubs: + self._stubs[ + "list_notification_subscriptions" + ] = self._logged_channel.unary_unary( + "/google.shopping.merchant.notifications.v1.NotificationsApiService/ListNotificationSubscriptions", + request_serializer=notificationsapi.ListNotificationSubscriptionsRequest.serialize, + response_deserializer=notificationsapi.ListNotificationSubscriptionsResponse.deserialize, + ) + return self._stubs["list_notification_subscriptions"] + + @property + def get_notification_subscription_health_metrics( + self, + ) -> Callable[ + [notificationsapi.GetNotificationSubscriptionHealthMetricsRequest], + notificationsapi.NotificationSubscriptionHealthMetrics, + ]: + r"""Return a callable for the get notification subscription + health metrics method over gRPC. + + Retrieves notification subscription health metrics + for a merchant. We recommend calling this periodically + (hourly or daily) to monitor health of your callback + endpoint. + + Returns: + Callable[[~.GetNotificationSubscriptionHealthMetricsRequest], + ~.NotificationSubscriptionHealthMetrics]: + 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 "get_notification_subscription_health_metrics" not in self._stubs: + self._stubs[ + "get_notification_subscription_health_metrics" + ] = self._logged_channel.unary_unary( + "/google.shopping.merchant.notifications.v1.NotificationsApiService/GetNotificationSubscriptionHealthMetrics", + request_serializer=notificationsapi.GetNotificationSubscriptionHealthMetricsRequest.serialize, + response_deserializer=notificationsapi.NotificationSubscriptionHealthMetrics.deserialize, + ) + return self._stubs["get_notification_subscription_health_metrics"] + + def close(self): + self._logged_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ("NotificationsApiServiceGrpcTransport",) diff --git a/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/grpc_asyncio.py b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/grpc_asyncio.py new file mode 100644 index 000000000000..78f0a0b56037 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/grpc_asyncio.py @@ -0,0 +1,602 @@ +# -*- 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 import empty_pb2 # 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_notifications_v1.types import notificationsapi + +from .base import DEFAULT_CLIENT_INFO, NotificationsApiServiceTransport +from .grpc import NotificationsApiServiceGrpcTransport + +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.notifications.v1.NotificationsApiService", + "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.notifications.v1.NotificationsApiService", + "rpcName": str(client_call_details.method), + "response": grpc_response, + "metadata": grpc_response["metadata"], + }, + ) + return response + + +class NotificationsApiServiceGrpcAsyncIOTransport(NotificationsApiServiceTransport): + """gRPC AsyncIO backend transport for NotificationsApiService. + + Service to manage notification subscriptions for merchants + + 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 get_notification_subscription( + self, + ) -> Callable[ + [notificationsapi.GetNotificationSubscriptionRequest], + Awaitable[notificationsapi.NotificationSubscription], + ]: + r"""Return a callable for the get notification subscription method over gRPC. + + Gets notification subscriptions for an account. + + Returns: + Callable[[~.GetNotificationSubscriptionRequest], + Awaitable[~.NotificationSubscription]]: + 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 "get_notification_subscription" not in self._stubs: + self._stubs[ + "get_notification_subscription" + ] = self._logged_channel.unary_unary( + "/google.shopping.merchant.notifications.v1.NotificationsApiService/GetNotificationSubscription", + request_serializer=notificationsapi.GetNotificationSubscriptionRequest.serialize, + response_deserializer=notificationsapi.NotificationSubscription.deserialize, + ) + return self._stubs["get_notification_subscription"] + + @property + def create_notification_subscription( + self, + ) -> Callable[ + [notificationsapi.CreateNotificationSubscriptionRequest], + Awaitable[notificationsapi.NotificationSubscription], + ]: + r"""Return a callable for the create notification + subscription method over gRPC. + + Creates a notification subscription for a business. + For standalone or subaccounts accounts, the business can + create a subscription for self. For MCAs, the business + can create a subscription for all managed accounts or + for a specific subaccount. + + We will allow the following types of notification + subscriptions to exist together (per business as a + subscriber per event type): + + 1. Subscription for all managed accounts + subscription + for self. + + 2. Multiple "partial" subscriptions for managed accounts + + subscription for self. + + we will not allow (per business as a subscriber per + event type): + + 1. Multiple self subscriptions. + + 2. Multiple "all managed accounts" subscriptions. + + 3. "All managed accounts" subscription and partial + subscriptions at the same time. + + 4. Multiple partial subscriptions for the same target + account. + + Returns: + Callable[[~.CreateNotificationSubscriptionRequest], + Awaitable[~.NotificationSubscription]]: + 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 "create_notification_subscription" not in self._stubs: + self._stubs[ + "create_notification_subscription" + ] = self._logged_channel.unary_unary( + "/google.shopping.merchant.notifications.v1.NotificationsApiService/CreateNotificationSubscription", + request_serializer=notificationsapi.CreateNotificationSubscriptionRequest.serialize, + response_deserializer=notificationsapi.NotificationSubscription.deserialize, + ) + return self._stubs["create_notification_subscription"] + + @property + def update_notification_subscription( + self, + ) -> Callable[ + [notificationsapi.UpdateNotificationSubscriptionRequest], + Awaitable[notificationsapi.NotificationSubscription], + ]: + r"""Return a callable for the update notification + subscription method over gRPC. + + Updates an existing notification subscription for a + merchant. + + Returns: + Callable[[~.UpdateNotificationSubscriptionRequest], + Awaitable[~.NotificationSubscription]]: + 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 "update_notification_subscription" not in self._stubs: + self._stubs[ + "update_notification_subscription" + ] = self._logged_channel.unary_unary( + "/google.shopping.merchant.notifications.v1.NotificationsApiService/UpdateNotificationSubscription", + request_serializer=notificationsapi.UpdateNotificationSubscriptionRequest.serialize, + response_deserializer=notificationsapi.NotificationSubscription.deserialize, + ) + return self._stubs["update_notification_subscription"] + + @property + def delete_notification_subscription( + self, + ) -> Callable[ + [notificationsapi.DeleteNotificationSubscriptionRequest], + Awaitable[empty_pb2.Empty], + ]: + r"""Return a callable for the delete notification + subscription method over gRPC. + + Deletes a notification subscription for a merchant. + + Returns: + Callable[[~.DeleteNotificationSubscriptionRequest], + Awaitable[~.Empty]]: + 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 "delete_notification_subscription" not in self._stubs: + self._stubs[ + "delete_notification_subscription" + ] = self._logged_channel.unary_unary( + "/google.shopping.merchant.notifications.v1.NotificationsApiService/DeleteNotificationSubscription", + request_serializer=notificationsapi.DeleteNotificationSubscriptionRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs["delete_notification_subscription"] + + @property + def list_notification_subscriptions( + self, + ) -> Callable[ + [notificationsapi.ListNotificationSubscriptionsRequest], + Awaitable[notificationsapi.ListNotificationSubscriptionsResponse], + ]: + r"""Return a callable for the list notification + subscriptions method over gRPC. + + Gets all the notification subscriptions for a + merchant. + + Returns: + Callable[[~.ListNotificationSubscriptionsRequest], + Awaitable[~.ListNotificationSubscriptionsResponse]]: + 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_notification_subscriptions" not in self._stubs: + self._stubs[ + "list_notification_subscriptions" + ] = self._logged_channel.unary_unary( + "/google.shopping.merchant.notifications.v1.NotificationsApiService/ListNotificationSubscriptions", + request_serializer=notificationsapi.ListNotificationSubscriptionsRequest.serialize, + response_deserializer=notificationsapi.ListNotificationSubscriptionsResponse.deserialize, + ) + return self._stubs["list_notification_subscriptions"] + + @property + def get_notification_subscription_health_metrics( + self, + ) -> Callable[ + [notificationsapi.GetNotificationSubscriptionHealthMetricsRequest], + Awaitable[notificationsapi.NotificationSubscriptionHealthMetrics], + ]: + r"""Return a callable for the get notification subscription + health metrics method over gRPC. + + Retrieves notification subscription health metrics + for a merchant. We recommend calling this periodically + (hourly or daily) to monitor health of your callback + endpoint. + + Returns: + Callable[[~.GetNotificationSubscriptionHealthMetricsRequest], + Awaitable[~.NotificationSubscriptionHealthMetrics]]: + 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 "get_notification_subscription_health_metrics" not in self._stubs: + self._stubs[ + "get_notification_subscription_health_metrics" + ] = self._logged_channel.unary_unary( + "/google.shopping.merchant.notifications.v1.NotificationsApiService/GetNotificationSubscriptionHealthMetrics", + request_serializer=notificationsapi.GetNotificationSubscriptionHealthMetricsRequest.serialize, + response_deserializer=notificationsapi.NotificationSubscriptionHealthMetrics.deserialize, + ) + return self._stubs["get_notification_subscription_health_metrics"] + + def _prep_wrapped_messages(self, client_info): + """Precompute the wrapped methods, overriding the base class method to use async wrappers.""" + self._wrapped_methods = { + self.get_notification_subscription: self._wrap_method( + self.get_notification_subscription, + default_timeout=None, + client_info=client_info, + ), + self.create_notification_subscription: self._wrap_method( + self.create_notification_subscription, + default_timeout=None, + client_info=client_info, + ), + self.update_notification_subscription: self._wrap_method( + self.update_notification_subscription, + default_timeout=None, + client_info=client_info, + ), + self.delete_notification_subscription: self._wrap_method( + self.delete_notification_subscription, + default_timeout=None, + client_info=client_info, + ), + self.list_notification_subscriptions: self._wrap_method( + self.list_notification_subscriptions, + default_timeout=None, + client_info=client_info, + ), + self.get_notification_subscription_health_metrics: self._wrap_method( + self.get_notification_subscription_health_metrics, + 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__ = ("NotificationsApiServiceGrpcAsyncIOTransport",) diff --git a/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/rest.py b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/rest.py new file mode 100644 index 000000000000..164c82b830fb --- /dev/null +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/rest.py @@ -0,0 +1,1488 @@ +# -*- 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 empty_pb2 # type: ignore +from google.protobuf import json_format +from requests import __version__ as requests_version + +from google.shopping.merchant_notifications_v1.types import notificationsapi + +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO +from .rest_base import _BaseNotificationsApiServiceRestTransport + +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 NotificationsApiServiceRestInterceptor: + """Interceptor for NotificationsApiService. + + 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 NotificationsApiServiceRestTransport. + + .. code-block:: python + class MyCustomNotificationsApiServiceInterceptor(NotificationsApiServiceRestInterceptor): + def pre_create_notification_subscription(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_notification_subscription(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_delete_notification_subscription(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_get_notification_subscription(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_notification_subscription(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_notification_subscription_health_metrics(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_notification_subscription_health_metrics(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_notification_subscriptions(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_notification_subscriptions(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_notification_subscription(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_notification_subscription(self, response): + logging.log(f"Received response: {response}") + return response + + transport = NotificationsApiServiceRestTransport(interceptor=MyCustomNotificationsApiServiceInterceptor()) + client = NotificationsApiServiceClient(transport=transport) + + + """ + + def pre_create_notification_subscription( + self, + request: notificationsapi.CreateNotificationSubscriptionRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + notificationsapi.CreateNotificationSubscriptionRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for create_notification_subscription + + Override in a subclass to manipulate the request or metadata + before they are sent to the NotificationsApiService server. + """ + return request, metadata + + def post_create_notification_subscription( + self, response: notificationsapi.NotificationSubscription + ) -> notificationsapi.NotificationSubscription: + """Post-rpc interceptor for create_notification_subscription + + DEPRECATED. Please use the `post_create_notification_subscription_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the NotificationsApiService server but before + it is returned to user code. This `post_create_notification_subscription` interceptor runs + before the `post_create_notification_subscription_with_metadata` interceptor. + """ + return response + + def post_create_notification_subscription_with_metadata( + self, + response: notificationsapi.NotificationSubscription, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + notificationsapi.NotificationSubscription, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Post-rpc interceptor for create_notification_subscription + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the NotificationsApiService server but before it is returned to user code. + + We recommend only using this `post_create_notification_subscription_with_metadata` + interceptor in new development instead of the `post_create_notification_subscription` interceptor. + When both interceptors are used, this `post_create_notification_subscription_with_metadata` interceptor runs after the + `post_create_notification_subscription` interceptor. The (possibly modified) response returned by + `post_create_notification_subscription` will be passed to + `post_create_notification_subscription_with_metadata`. + """ + return response, metadata + + def pre_delete_notification_subscription( + self, + request: notificationsapi.DeleteNotificationSubscriptionRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + notificationsapi.DeleteNotificationSubscriptionRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for delete_notification_subscription + + Override in a subclass to manipulate the request or metadata + before they are sent to the NotificationsApiService server. + """ + return request, metadata + + def pre_get_notification_subscription( + self, + request: notificationsapi.GetNotificationSubscriptionRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + notificationsapi.GetNotificationSubscriptionRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for get_notification_subscription + + Override in a subclass to manipulate the request or metadata + before they are sent to the NotificationsApiService server. + """ + return request, metadata + + def post_get_notification_subscription( + self, response: notificationsapi.NotificationSubscription + ) -> notificationsapi.NotificationSubscription: + """Post-rpc interceptor for get_notification_subscription + + DEPRECATED. Please use the `post_get_notification_subscription_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the NotificationsApiService server but before + it is returned to user code. This `post_get_notification_subscription` interceptor runs + before the `post_get_notification_subscription_with_metadata` interceptor. + """ + return response + + def post_get_notification_subscription_with_metadata( + self, + response: notificationsapi.NotificationSubscription, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + notificationsapi.NotificationSubscription, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Post-rpc interceptor for get_notification_subscription + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the NotificationsApiService server but before it is returned to user code. + + We recommend only using this `post_get_notification_subscription_with_metadata` + interceptor in new development instead of the `post_get_notification_subscription` interceptor. + When both interceptors are used, this `post_get_notification_subscription_with_metadata` interceptor runs after the + `post_get_notification_subscription` interceptor. The (possibly modified) response returned by + `post_get_notification_subscription` will be passed to + `post_get_notification_subscription_with_metadata`. + """ + return response, metadata + + def pre_get_notification_subscription_health_metrics( + self, + request: notificationsapi.GetNotificationSubscriptionHealthMetricsRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + notificationsapi.GetNotificationSubscriptionHealthMetricsRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for get_notification_subscription_health_metrics + + Override in a subclass to manipulate the request or metadata + before they are sent to the NotificationsApiService server. + """ + return request, metadata + + def post_get_notification_subscription_health_metrics( + self, response: notificationsapi.NotificationSubscriptionHealthMetrics + ) -> notificationsapi.NotificationSubscriptionHealthMetrics: + """Post-rpc interceptor for get_notification_subscription_health_metrics + + DEPRECATED. Please use the `post_get_notification_subscription_health_metrics_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the NotificationsApiService server but before + it is returned to user code. This `post_get_notification_subscription_health_metrics` interceptor runs + before the `post_get_notification_subscription_health_metrics_with_metadata` interceptor. + """ + return response + + def post_get_notification_subscription_health_metrics_with_metadata( + self, + response: notificationsapi.NotificationSubscriptionHealthMetrics, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + notificationsapi.NotificationSubscriptionHealthMetrics, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Post-rpc interceptor for get_notification_subscription_health_metrics + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the NotificationsApiService server but before it is returned to user code. + + We recommend only using this `post_get_notification_subscription_health_metrics_with_metadata` + interceptor in new development instead of the `post_get_notification_subscription_health_metrics` interceptor. + When both interceptors are used, this `post_get_notification_subscription_health_metrics_with_metadata` interceptor runs after the + `post_get_notification_subscription_health_metrics` interceptor. The (possibly modified) response returned by + `post_get_notification_subscription_health_metrics` will be passed to + `post_get_notification_subscription_health_metrics_with_metadata`. + """ + return response, metadata + + def pre_list_notification_subscriptions( + self, + request: notificationsapi.ListNotificationSubscriptionsRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + notificationsapi.ListNotificationSubscriptionsRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for list_notification_subscriptions + + Override in a subclass to manipulate the request or metadata + before they are sent to the NotificationsApiService server. + """ + return request, metadata + + def post_list_notification_subscriptions( + self, response: notificationsapi.ListNotificationSubscriptionsResponse + ) -> notificationsapi.ListNotificationSubscriptionsResponse: + """Post-rpc interceptor for list_notification_subscriptions + + DEPRECATED. Please use the `post_list_notification_subscriptions_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the NotificationsApiService server but before + it is returned to user code. This `post_list_notification_subscriptions` interceptor runs + before the `post_list_notification_subscriptions_with_metadata` interceptor. + """ + return response + + def post_list_notification_subscriptions_with_metadata( + self, + response: notificationsapi.ListNotificationSubscriptionsResponse, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + notificationsapi.ListNotificationSubscriptionsResponse, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Post-rpc interceptor for list_notification_subscriptions + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the NotificationsApiService server but before it is returned to user code. + + We recommend only using this `post_list_notification_subscriptions_with_metadata` + interceptor in new development instead of the `post_list_notification_subscriptions` interceptor. + When both interceptors are used, this `post_list_notification_subscriptions_with_metadata` interceptor runs after the + `post_list_notification_subscriptions` interceptor. The (possibly modified) response returned by + `post_list_notification_subscriptions` will be passed to + `post_list_notification_subscriptions_with_metadata`. + """ + return response, metadata + + def pre_update_notification_subscription( + self, + request: notificationsapi.UpdateNotificationSubscriptionRequest, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + notificationsapi.UpdateNotificationSubscriptionRequest, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Pre-rpc interceptor for update_notification_subscription + + Override in a subclass to manipulate the request or metadata + before they are sent to the NotificationsApiService server. + """ + return request, metadata + + def post_update_notification_subscription( + self, response: notificationsapi.NotificationSubscription + ) -> notificationsapi.NotificationSubscription: + """Post-rpc interceptor for update_notification_subscription + + DEPRECATED. Please use the `post_update_notification_subscription_with_metadata` + interceptor instead. + + Override in a subclass to read or manipulate the response + after it is returned by the NotificationsApiService server but before + it is returned to user code. This `post_update_notification_subscription` interceptor runs + before the `post_update_notification_subscription_with_metadata` interceptor. + """ + return response + + def post_update_notification_subscription_with_metadata( + self, + response: notificationsapi.NotificationSubscription, + metadata: Sequence[Tuple[str, Union[str, bytes]]], + ) -> Tuple[ + notificationsapi.NotificationSubscription, + Sequence[Tuple[str, Union[str, bytes]]], + ]: + """Post-rpc interceptor for update_notification_subscription + + Override in a subclass to read or manipulate the response or metadata after it + is returned by the NotificationsApiService server but before it is returned to user code. + + We recommend only using this `post_update_notification_subscription_with_metadata` + interceptor in new development instead of the `post_update_notification_subscription` interceptor. + When both interceptors are used, this `post_update_notification_subscription_with_metadata` interceptor runs after the + `post_update_notification_subscription` interceptor. The (possibly modified) response returned by + `post_update_notification_subscription` will be passed to + `post_update_notification_subscription_with_metadata`. + """ + return response, metadata + + +@dataclasses.dataclass +class NotificationsApiServiceRestStub: + _session: AuthorizedSession + _host: str + _interceptor: NotificationsApiServiceRestInterceptor + + +class NotificationsApiServiceRestTransport(_BaseNotificationsApiServiceRestTransport): + """REST backend synchronous transport for NotificationsApiService. + + Service to manage notification subscriptions for merchants + + 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[NotificationsApiServiceRestInterceptor] = 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 NotificationsApiServiceRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _CreateNotificationSubscription( + _BaseNotificationsApiServiceRestTransport._BaseCreateNotificationSubscription, + NotificationsApiServiceRestStub, + ): + def __hash__(self): + return hash( + "NotificationsApiServiceRestTransport.CreateNotificationSubscription" + ) + + @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: notificationsapi.CreateNotificationSubscriptionRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> notificationsapi.NotificationSubscription: + r"""Call the create notification + subscription method over HTTP. + + Args: + request (~.notificationsapi.CreateNotificationSubscriptionRequest): + The request object. Request message for the + CreateNotificationSubscription 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: + ~.notificationsapi.NotificationSubscription: + Represents a notification + subscription owned by a Merchant + account. + + """ + + http_options = ( + _BaseNotificationsApiServiceRestTransport._BaseCreateNotificationSubscription._get_http_options() + ) + + request, metadata = self._interceptor.pre_create_notification_subscription( + request, metadata + ) + transcoded_request = _BaseNotificationsApiServiceRestTransport._BaseCreateNotificationSubscription._get_transcoded_request( + http_options, request + ) + + body = _BaseNotificationsApiServiceRestTransport._BaseCreateNotificationSubscription._get_request_body_json( + transcoded_request + ) + + # Jsonify the query params + query_params = _BaseNotificationsApiServiceRestTransport._BaseCreateNotificationSubscription._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.notifications_v1.NotificationsApiServiceClient.CreateNotificationSubscription", + extra={ + "serviceName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "rpcName": "CreateNotificationSubscription", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = NotificationsApiServiceRestTransport._CreateNotificationSubscription._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 = notificationsapi.NotificationSubscription() + pb_resp = notificationsapi.NotificationSubscription.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_create_notification_subscription(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + ( + resp, + _, + ) = self._interceptor.post_create_notification_subscription_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = ( + notificationsapi.NotificationSubscription.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.notifications_v1.NotificationsApiServiceClient.create_notification_subscription", + extra={ + "serviceName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "rpcName": "CreateNotificationSubscription", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _DeleteNotificationSubscription( + _BaseNotificationsApiServiceRestTransport._BaseDeleteNotificationSubscription, + NotificationsApiServiceRestStub, + ): + def __hash__(self): + return hash( + "NotificationsApiServiceRestTransport.DeleteNotificationSubscription" + ) + + @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: notificationsapi.DeleteNotificationSubscriptionRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ): + r"""Call the delete notification + subscription method over HTTP. + + Args: + request (~.notificationsapi.DeleteNotificationSubscriptionRequest): + The request object. Request message for the + DeleteNotificationSubscription 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`. + """ + + http_options = ( + _BaseNotificationsApiServiceRestTransport._BaseDeleteNotificationSubscription._get_http_options() + ) + + request, metadata = self._interceptor.pre_delete_notification_subscription( + request, metadata + ) + transcoded_request = _BaseNotificationsApiServiceRestTransport._BaseDeleteNotificationSubscription._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseNotificationsApiServiceRestTransport._BaseDeleteNotificationSubscription._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 = json_format.MessageToJson(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.notifications_v1.NotificationsApiServiceClient.DeleteNotificationSubscription", + extra={ + "serviceName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "rpcName": "DeleteNotificationSubscription", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = NotificationsApiServiceRestTransport._DeleteNotificationSubscription._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) + + class _GetNotificationSubscription( + _BaseNotificationsApiServiceRestTransport._BaseGetNotificationSubscription, + NotificationsApiServiceRestStub, + ): + def __hash__(self): + return hash( + "NotificationsApiServiceRestTransport.GetNotificationSubscription" + ) + + @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: notificationsapi.GetNotificationSubscriptionRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> notificationsapi.NotificationSubscription: + r"""Call the get notification + subscription method over HTTP. + + Args: + request (~.notificationsapi.GetNotificationSubscriptionRequest): + The request object. Request message for the + GetNotificationSubscription 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: + ~.notificationsapi.NotificationSubscription: + Represents a notification + subscription owned by a Merchant + account. + + """ + + http_options = ( + _BaseNotificationsApiServiceRestTransport._BaseGetNotificationSubscription._get_http_options() + ) + + request, metadata = self._interceptor.pre_get_notification_subscription( + request, metadata + ) + transcoded_request = _BaseNotificationsApiServiceRestTransport._BaseGetNotificationSubscription._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseNotificationsApiServiceRestTransport._BaseGetNotificationSubscription._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.notifications_v1.NotificationsApiServiceClient.GetNotificationSubscription", + extra={ + "serviceName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "rpcName": "GetNotificationSubscription", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = NotificationsApiServiceRestTransport._GetNotificationSubscription._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 = notificationsapi.NotificationSubscription() + pb_resp = notificationsapi.NotificationSubscription.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_get_notification_subscription(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + ( + resp, + _, + ) = self._interceptor.post_get_notification_subscription_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = ( + notificationsapi.NotificationSubscription.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.notifications_v1.NotificationsApiServiceClient.get_notification_subscription", + extra={ + "serviceName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "rpcName": "GetNotificationSubscription", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _GetNotificationSubscriptionHealthMetrics( + _BaseNotificationsApiServiceRestTransport._BaseGetNotificationSubscriptionHealthMetrics, + NotificationsApiServiceRestStub, + ): + def __hash__(self): + return hash( + "NotificationsApiServiceRestTransport.GetNotificationSubscriptionHealthMetrics" + ) + + @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: notificationsapi.GetNotificationSubscriptionHealthMetricsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> notificationsapi.NotificationSubscriptionHealthMetrics: + r"""Call the get notification + subscription health metrics method over HTTP. + + Args: + request (~.notificationsapi.GetNotificationSubscriptionHealthMetricsRequest): + The request object. Request for notification subscription + health metrics. + 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: + ~.notificationsapi.NotificationSubscriptionHealthMetrics: + Represents a notification + subscription health metrics. + + """ + + http_options = ( + _BaseNotificationsApiServiceRestTransport._BaseGetNotificationSubscriptionHealthMetrics._get_http_options() + ) + + ( + request, + metadata, + ) = self._interceptor.pre_get_notification_subscription_health_metrics( + request, metadata + ) + transcoded_request = _BaseNotificationsApiServiceRestTransport._BaseGetNotificationSubscriptionHealthMetrics._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseNotificationsApiServiceRestTransport._BaseGetNotificationSubscriptionHealthMetrics._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.notifications_v1.NotificationsApiServiceClient.GetNotificationSubscriptionHealthMetrics", + extra={ + "serviceName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "rpcName": "GetNotificationSubscriptionHealthMetrics", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = NotificationsApiServiceRestTransport._GetNotificationSubscriptionHealthMetrics._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 = notificationsapi.NotificationSubscriptionHealthMetrics() + pb_resp = notificationsapi.NotificationSubscriptionHealthMetrics.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_get_notification_subscription_health_metrics( + resp + ) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + ( + resp, + _, + ) = self._interceptor.post_get_notification_subscription_health_metrics_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = ( + notificationsapi.NotificationSubscriptionHealthMetrics.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.notifications_v1.NotificationsApiServiceClient.get_notification_subscription_health_metrics", + extra={ + "serviceName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "rpcName": "GetNotificationSubscriptionHealthMetrics", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _ListNotificationSubscriptions( + _BaseNotificationsApiServiceRestTransport._BaseListNotificationSubscriptions, + NotificationsApiServiceRestStub, + ): + def __hash__(self): + return hash( + "NotificationsApiServiceRestTransport.ListNotificationSubscriptions" + ) + + @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: notificationsapi.ListNotificationSubscriptionsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> notificationsapi.ListNotificationSubscriptionsResponse: + r"""Call the list notification + subscriptions method over HTTP. + + Args: + request (~.notificationsapi.ListNotificationSubscriptionsRequest): + The request object. Request message for the + ListNotificationSubscription 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: + ~.notificationsapi.ListNotificationSubscriptionsResponse: + Response message for the + ListNotificationSubscription method. + + """ + + http_options = ( + _BaseNotificationsApiServiceRestTransport._BaseListNotificationSubscriptions._get_http_options() + ) + + request, metadata = self._interceptor.pre_list_notification_subscriptions( + request, metadata + ) + transcoded_request = _BaseNotificationsApiServiceRestTransport._BaseListNotificationSubscriptions._get_transcoded_request( + http_options, request + ) + + # Jsonify the query params + query_params = _BaseNotificationsApiServiceRestTransport._BaseListNotificationSubscriptions._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.notifications_v1.NotificationsApiServiceClient.ListNotificationSubscriptions", + extra={ + "serviceName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "rpcName": "ListNotificationSubscriptions", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = NotificationsApiServiceRestTransport._ListNotificationSubscriptions._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 = notificationsapi.ListNotificationSubscriptionsResponse() + pb_resp = notificationsapi.ListNotificationSubscriptionsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_list_notification_subscriptions(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + ( + resp, + _, + ) = self._interceptor.post_list_notification_subscriptions_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = ( + notificationsapi.ListNotificationSubscriptionsResponse.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.notifications_v1.NotificationsApiServiceClient.list_notification_subscriptions", + extra={ + "serviceName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "rpcName": "ListNotificationSubscriptions", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + class _UpdateNotificationSubscription( + _BaseNotificationsApiServiceRestTransport._BaseUpdateNotificationSubscription, + NotificationsApiServiceRestStub, + ): + def __hash__(self): + return hash( + "NotificationsApiServiceRestTransport.UpdateNotificationSubscription" + ) + + @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: notificationsapi.UpdateNotificationSubscriptionRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, Union[str, bytes]]] = (), + ) -> notificationsapi.NotificationSubscription: + r"""Call the update notification + subscription method over HTTP. + + Args: + request (~.notificationsapi.UpdateNotificationSubscriptionRequest): + The request object. Request message for the + UpdateNotificationSubscription 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: + ~.notificationsapi.NotificationSubscription: + Represents a notification + subscription owned by a Merchant + account. + + """ + + http_options = ( + _BaseNotificationsApiServiceRestTransport._BaseUpdateNotificationSubscription._get_http_options() + ) + + request, metadata = self._interceptor.pre_update_notification_subscription( + request, metadata + ) + transcoded_request = _BaseNotificationsApiServiceRestTransport._BaseUpdateNotificationSubscription._get_transcoded_request( + http_options, request + ) + + body = _BaseNotificationsApiServiceRestTransport._BaseUpdateNotificationSubscription._get_request_body_json( + transcoded_request + ) + + # Jsonify the query params + query_params = _BaseNotificationsApiServiceRestTransport._BaseUpdateNotificationSubscription._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.notifications_v1.NotificationsApiServiceClient.UpdateNotificationSubscription", + extra={ + "serviceName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "rpcName": "UpdateNotificationSubscription", + "httpRequest": http_request, + "metadata": http_request["headers"], + }, + ) + + # Send the request + response = NotificationsApiServiceRestTransport._UpdateNotificationSubscription._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 = notificationsapi.NotificationSubscription() + pb_resp = notificationsapi.NotificationSubscription.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + + resp = self._interceptor.post_update_notification_subscription(resp) + response_metadata = [(k, str(v)) for k, v in response.headers.items()] + ( + resp, + _, + ) = self._interceptor.post_update_notification_subscription_with_metadata( + resp, response_metadata + ) + if CLIENT_LOGGING_SUPPORTED and _LOGGER.isEnabledFor( + logging.DEBUG + ): # pragma: NO COVER + try: + response_payload = ( + notificationsapi.NotificationSubscription.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.notifications_v1.NotificationsApiServiceClient.update_notification_subscription", + extra={ + "serviceName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "rpcName": "UpdateNotificationSubscription", + "metadata": http_response["headers"], + "httpResponse": http_response, + }, + ) + return resp + + @property + def create_notification_subscription( + self, + ) -> Callable[ + [notificationsapi.CreateNotificationSubscriptionRequest], + notificationsapi.NotificationSubscription, + ]: + # 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._CreateNotificationSubscription(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_notification_subscription( + self, + ) -> Callable[ + [notificationsapi.DeleteNotificationSubscriptionRequest], empty_pb2.Empty + ]: + # 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._DeleteNotificationSubscription(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_notification_subscription( + self, + ) -> Callable[ + [notificationsapi.GetNotificationSubscriptionRequest], + notificationsapi.NotificationSubscription, + ]: + # 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._GetNotificationSubscription(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_notification_subscription_health_metrics( + self, + ) -> Callable[ + [notificationsapi.GetNotificationSubscriptionHealthMetricsRequest], + notificationsapi.NotificationSubscriptionHealthMetrics, + ]: + # 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._GetNotificationSubscriptionHealthMetrics(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_notification_subscriptions( + self, + ) -> Callable[ + [notificationsapi.ListNotificationSubscriptionsRequest], + notificationsapi.ListNotificationSubscriptionsResponse, + ]: + # 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._ListNotificationSubscriptions(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_notification_subscription( + self, + ) -> Callable[ + [notificationsapi.UpdateNotificationSubscriptionRequest], + notificationsapi.NotificationSubscription, + ]: + # 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._UpdateNotificationSubscription(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__ = ("NotificationsApiServiceRestTransport",) diff --git a/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/rest_base.py b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/rest_base.py new file mode 100644 index 000000000000..0e31b4193dae --- /dev/null +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/services/notifications_api_service/transports/rest_base.py @@ -0,0 +1,406 @@ +# -*- 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 empty_pb2 # type: ignore +from google.protobuf import json_format + +from google.shopping.merchant_notifications_v1.types import notificationsapi + +from .base import DEFAULT_CLIENT_INFO, NotificationsApiServiceTransport + + +class _BaseNotificationsApiServiceRestTransport(NotificationsApiServiceTransport): + """Base REST backend transport for NotificationsApiService. + + 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 _BaseCreateNotificationSubscription: + 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": "/notifications/v1/{parent=accounts/*}/notificationsubscriptions", + "body": "notification_subscription", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = notificationsapi.CreateNotificationSubscriptionRequest.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( + _BaseNotificationsApiServiceRestTransport._BaseCreateNotificationSubscription._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseDeleteNotificationSubscription: + 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": "delete", + "uri": "/notifications/v1/{name=accounts/*/notificationsubscriptions/*}", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = notificationsapi.DeleteNotificationSubscriptionRequest.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( + _BaseNotificationsApiServiceRestTransport._BaseDeleteNotificationSubscription._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseGetNotificationSubscription: + 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": "/notifications/v1/{name=accounts/*/notificationsubscriptions/*}", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = notificationsapi.GetNotificationSubscriptionRequest.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( + _BaseNotificationsApiServiceRestTransport._BaseGetNotificationSubscription._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseGetNotificationSubscriptionHealthMetrics: + 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": "/notifications/v1/{name=accounts/*/notificationsubscriptions/*}:getHealth", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = ( + notificationsapi.GetNotificationSubscriptionHealthMetricsRequest.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( + _BaseNotificationsApiServiceRestTransport._BaseGetNotificationSubscriptionHealthMetrics._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseListNotificationSubscriptions: + 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": "/notifications/v1/{parent=accounts/*}/notificationsubscriptions", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = notificationsapi.ListNotificationSubscriptionsRequest.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( + _BaseNotificationsApiServiceRestTransport._BaseListNotificationSubscriptions._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + class _BaseUpdateNotificationSubscription: + 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": "patch", + "uri": "/notifications/v1/{notification_subscription.name=accounts/*/notificationsubscriptions/*}", + "body": "notification_subscription", + }, + ] + return http_options + + @staticmethod + def _get_transcoded_request(http_options, request): + pb_request = notificationsapi.UpdateNotificationSubscriptionRequest.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( + _BaseNotificationsApiServiceRestTransport._BaseUpdateNotificationSubscription._get_unset_required_fields( + query_params + ) + ) + + query_params["$alt"] = "json;enum-encoding=int" + return query_params + + +__all__ = ("_BaseNotificationsApiServiceRestTransport",) diff --git a/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/types/__init__.py b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/types/__init__.py new file mode 100644 index 000000000000..14da5c2f82b6 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/types/__init__.py @@ -0,0 +1,38 @@ +# -*- 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 .notificationsapi import ( + CreateNotificationSubscriptionRequest, + DeleteNotificationSubscriptionRequest, + GetNotificationSubscriptionHealthMetricsRequest, + GetNotificationSubscriptionRequest, + ListNotificationSubscriptionsRequest, + ListNotificationSubscriptionsResponse, + NotificationSubscription, + NotificationSubscriptionHealthMetrics, + UpdateNotificationSubscriptionRequest, +) + +__all__ = ( + "CreateNotificationSubscriptionRequest", + "DeleteNotificationSubscriptionRequest", + "GetNotificationSubscriptionHealthMetricsRequest", + "GetNotificationSubscriptionRequest", + "ListNotificationSubscriptionsRequest", + "ListNotificationSubscriptionsResponse", + "NotificationSubscription", + "NotificationSubscriptionHealthMetrics", + "UpdateNotificationSubscriptionRequest", +) diff --git a/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/types/notificationsapi.py b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/types/notificationsapi.py new file mode 100644 index 000000000000..52486e0baece --- /dev/null +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1/types/notificationsapi.py @@ -0,0 +1,319 @@ +# -*- 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.protobuf import field_mask_pb2 # type: ignore +import proto # type: ignore + +__protobuf__ = proto.module( + package="google.shopping.merchant.notifications.v1", + manifest={ + "GetNotificationSubscriptionRequest", + "CreateNotificationSubscriptionRequest", + "UpdateNotificationSubscriptionRequest", + "DeleteNotificationSubscriptionRequest", + "ListNotificationSubscriptionsRequest", + "ListNotificationSubscriptionsResponse", + "NotificationSubscription", + "GetNotificationSubscriptionHealthMetricsRequest", + "NotificationSubscriptionHealthMetrics", + }, +) + + +class GetNotificationSubscriptionRequest(proto.Message): + r"""Request message for the GetNotificationSubscription method. + + Attributes: + name (str): + Required. The ``name`` of the notification subscription. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class CreateNotificationSubscriptionRequest(proto.Message): + r"""Request message for the CreateNotificationSubscription + method. + + Attributes: + parent (str): + Required. The merchant account that owns the new + notification subscription. Format: ``accounts/{account}`` + notification_subscription (google.shopping.merchant_notifications_v1.types.NotificationSubscription): + Required. The notification subscription to + create. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + notification_subscription: "NotificationSubscription" = proto.Field( + proto.MESSAGE, + number=2, + message="NotificationSubscription", + ) + + +class UpdateNotificationSubscriptionRequest(proto.Message): + r"""Request message for the UpdateNotificationSubscription + method. + + Attributes: + notification_subscription (google.shopping.merchant_notifications_v1.types.NotificationSubscription): + Required. The new version of the notification + subscription that should be updated. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + List of fields being updated. + """ + + notification_subscription: "NotificationSubscription" = proto.Field( + proto.MESSAGE, + number=1, + message="NotificationSubscription", + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=2, + message=field_mask_pb2.FieldMask, + ) + + +class DeleteNotificationSubscriptionRequest(proto.Message): + r"""Request message for the DeleteNotificationSubscription + method. + + Attributes: + name (str): + Required. The name of the notification + subscription to be deleted. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ListNotificationSubscriptionsRequest(proto.Message): + r"""Request message for the ListNotificationSubscription method. + + Attributes: + parent (str): + Required. The merchant account who owns the notification + subscriptions. Format: ``accounts/{account}`` + page_size (int): + The maximum number of notification subscriptions to return + in a page. The default value for ``page_size`` is 100. The + maximum value is ``200``. Values above ``200`` will be + coerced to ``200``. + page_token (str): + Token (if provided) to retrieve the + subsequent page. All other parameters must match + the original call that provided the page token. + """ + + 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, + ) + + +class ListNotificationSubscriptionsResponse(proto.Message): + r"""Response message for the ListNotificationSubscription method. + + Attributes: + notification_subscriptions (MutableSequence[google.shopping.merchant_notifications_v1.types.NotificationSubscription]): + The list of notification subscriptions + requested by the merchant. + next_page_token (str): + A token, which can be sent as ``page_token`` to retrieve the + next page. If this field is omitted, there are no subsequent + pages. + """ + + @property + def raw_page(self): + return self + + notification_subscriptions: MutableSequence[ + "NotificationSubscription" + ] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message="NotificationSubscription", + ) + next_page_token: str = proto.Field( + proto.STRING, + number=2, + ) + + +class NotificationSubscription(proto.Message): + r"""Represents a notification subscription owned by a Merchant + account. + + 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: + all_managed_accounts (bool): + If this value is true, the requesting account + is notified of the specified event for all + managed accounts (can be subaccounts or other + linked accounts) including newly added accounts + on a daily basis. + + This field is a member of `oneof`_ ``interested_in``. + target_account (str): + The ``name`` of the account you want to receive + notifications for. Format: ``accounts/{account}`` + + This field is a member of `oneof`_ ``interested_in``. + name (str): + Output only. The ``name`` of the notification configuration. + Generated by the Content API upon creation of a new + ``NotificationSubscription``. The ``account`` represents the + merchant ID of the merchant that owns the configuration. + Format: + ``accounts/{account}/notificationsubscriptions/{notification_subscription}`` + registered_event (google.shopping.merchant_notifications_v1.types.NotificationSubscription.NotificationEventType): + The event that the merchant wants to be + notified about. + call_back_uri (str): + URL to be used to push the notification to + the merchant. + """ + + class NotificationEventType(proto.Enum): + r"""Represents the event type that the merchant is interested in + receiving notifications for. + + Values: + NOTIFICATION_EVENT_TYPE_UNSPECIFIED (0): + Notifications event type is unspecified. + PRODUCT_STATUS_CHANGE (1): + Notification of product status changes, for + example when product becomes disapproved. + """ + NOTIFICATION_EVENT_TYPE_UNSPECIFIED = 0 + PRODUCT_STATUS_CHANGE = 1 + + all_managed_accounts: bool = proto.Field( + proto.BOOL, + number=3, + oneof="interested_in", + ) + target_account: str = proto.Field( + proto.STRING, + number=4, + oneof="interested_in", + ) + name: str = proto.Field( + proto.STRING, + number=1, + ) + registered_event: NotificationEventType = proto.Field( + proto.ENUM, + number=2, + enum=NotificationEventType, + ) + call_back_uri: str = proto.Field( + proto.STRING, + number=5, + ) + + +class GetNotificationSubscriptionHealthMetricsRequest(proto.Message): + r"""Request for notification subscription health metrics. + + Attributes: + name (str): + Required. The ``name`` of the notification subscription for + which metrics are retrieved. Format: + ``accounts/{account}/notificationsubscriptions/{notification_subscription}`` + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class NotificationSubscriptionHealthMetrics(proto.Message): + r"""Represents a notification subscription health metrics. + + Attributes: + name (str): + Output only. Identifier. The name of the + notification configuration. Generated by the + Content API upon creation of a new + NotificationSubscription. The account represents + the merchant ID of the merchant that owns the + configuration. + acknowledged_messages_count (int): + The number of retained acknowledged messages + for the last 24 hours + undelivered_messages_count (int): + The number of unacknowledged messages for the + last 7 days, we will attempt to re-deliver the + unacknowledged message later and once + successfully delivered it will not be counted + within unacknowledged messages (the number of + unacknowledged messages should gradually + decrease to zero once the issue is fixed). + oldest_unacknowledged_message_waiting_time (int): + The time since the oldest unacknowledged + message was sent in seconds + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + acknowledged_messages_count: int = proto.Field( + proto.INT64, + number=2, + ) + undelivered_messages_count: int = proto.Field( + proto.INT64, + number=3, + ) + oldest_unacknowledged_message_waiting_time: int = proto.Field( + proto.INT64, + number=4, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1beta/gapic_version.py b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1beta/gapic_version.py index 9a1da44d2468..20a9cd975b02 100644 --- a/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1beta/gapic_version.py +++ b/packages/google-shopping-merchant-notifications/google/shopping/merchant_notifications_v1beta/gapic_version.py @@ -13,4 +13,4 @@ # See the License for the specific language governing permissions and # limitations under the License. # -__version__ = "0.1.8" # {x-release-please-version} +__version__ = "0.0.0" # {x-release-please-version} diff --git a/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_create_notification_subscription_async.py b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_create_notification_subscription_async.py new file mode 100644 index 000000000000..3a33b81028b3 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_create_notification_subscription_async.py @@ -0,0 +1,56 @@ +# -*- 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 CreateNotificationSubscription +# 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-notifications + + +# [START merchantapi_v1_generated_NotificationsApiService_CreateNotificationSubscription_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_notifications_v1 + + +async def sample_create_notification_subscription(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceAsyncClient() + + # Initialize request argument(s) + notification_subscription = merchant_notifications_v1.NotificationSubscription() + notification_subscription.all_managed_accounts = True + + request = merchant_notifications_v1.CreateNotificationSubscriptionRequest( + parent="parent_value", + notification_subscription=notification_subscription, + ) + + # Make the request + response = await client.create_notification_subscription(request=request) + + # Handle the response + print(response) + +# [END merchantapi_v1_generated_NotificationsApiService_CreateNotificationSubscription_async] diff --git a/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_create_notification_subscription_sync.py b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_create_notification_subscription_sync.py new file mode 100644 index 000000000000..e7873309abbe --- /dev/null +++ b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_create_notification_subscription_sync.py @@ -0,0 +1,56 @@ +# -*- 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 CreateNotificationSubscription +# 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-notifications + + +# [START merchantapi_v1_generated_NotificationsApiService_CreateNotificationSubscription_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_notifications_v1 + + +def sample_create_notification_subscription(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceClient() + + # Initialize request argument(s) + notification_subscription = merchant_notifications_v1.NotificationSubscription() + notification_subscription.all_managed_accounts = True + + request = merchant_notifications_v1.CreateNotificationSubscriptionRequest( + parent="parent_value", + notification_subscription=notification_subscription, + ) + + # Make the request + response = client.create_notification_subscription(request=request) + + # Handle the response + print(response) + +# [END merchantapi_v1_generated_NotificationsApiService_CreateNotificationSubscription_sync] diff --git a/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_delete_notification_subscription_async.py b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_delete_notification_subscription_async.py new file mode 100644 index 000000000000..93aae294b9ae --- /dev/null +++ b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_delete_notification_subscription_async.py @@ -0,0 +1,50 @@ +# -*- 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 DeleteNotificationSubscription +# 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-notifications + + +# [START merchantapi_v1_generated_NotificationsApiService_DeleteNotificationSubscription_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_notifications_v1 + + +async def sample_delete_notification_subscription(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_notifications_v1.DeleteNotificationSubscriptionRequest( + name="name_value", + ) + + # Make the request + await client.delete_notification_subscription(request=request) + + +# [END merchantapi_v1_generated_NotificationsApiService_DeleteNotificationSubscription_async] diff --git a/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_delete_notification_subscription_sync.py b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_delete_notification_subscription_sync.py new file mode 100644 index 000000000000..741823e0593c --- /dev/null +++ b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_delete_notification_subscription_sync.py @@ -0,0 +1,50 @@ +# -*- 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 DeleteNotificationSubscription +# 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-notifications + + +# [START merchantapi_v1_generated_NotificationsApiService_DeleteNotificationSubscription_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_notifications_v1 + + +def sample_delete_notification_subscription(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceClient() + + # Initialize request argument(s) + request = merchant_notifications_v1.DeleteNotificationSubscriptionRequest( + name="name_value", + ) + + # Make the request + client.delete_notification_subscription(request=request) + + +# [END merchantapi_v1_generated_NotificationsApiService_DeleteNotificationSubscription_sync] diff --git a/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_get_notification_subscription_async.py b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_get_notification_subscription_async.py new file mode 100644 index 000000000000..8dde3c254c16 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_get_notification_subscription_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 GetNotificationSubscription +# 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-notifications + + +# [START merchantapi_v1_generated_NotificationsApiService_GetNotificationSubscription_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_notifications_v1 + + +async def sample_get_notification_subscription(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_notifications_v1.GetNotificationSubscriptionRequest( + name="name_value", + ) + + # Make the request + response = await client.get_notification_subscription(request=request) + + # Handle the response + print(response) + +# [END merchantapi_v1_generated_NotificationsApiService_GetNotificationSubscription_async] diff --git a/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_get_notification_subscription_health_metrics_async.py b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_get_notification_subscription_health_metrics_async.py new file mode 100644 index 000000000000..dcad0250139f --- /dev/null +++ b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_get_notification_subscription_health_metrics_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 GetNotificationSubscriptionHealthMetrics +# 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-notifications + + +# [START merchantapi_v1_generated_NotificationsApiService_GetNotificationSubscriptionHealthMetrics_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_notifications_v1 + + +async def sample_get_notification_subscription_health_metrics(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_notifications_v1.GetNotificationSubscriptionHealthMetricsRequest( + name="name_value", + ) + + # Make the request + response = await client.get_notification_subscription_health_metrics(request=request) + + # Handle the response + print(response) + +# [END merchantapi_v1_generated_NotificationsApiService_GetNotificationSubscriptionHealthMetrics_async] diff --git a/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_get_notification_subscription_health_metrics_sync.py b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_get_notification_subscription_health_metrics_sync.py new file mode 100644 index 000000000000..a1c4cc76c5ee --- /dev/null +++ b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_get_notification_subscription_health_metrics_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 GetNotificationSubscriptionHealthMetrics +# 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-notifications + + +# [START merchantapi_v1_generated_NotificationsApiService_GetNotificationSubscriptionHealthMetrics_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_notifications_v1 + + +def sample_get_notification_subscription_health_metrics(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceClient() + + # Initialize request argument(s) + request = merchant_notifications_v1.GetNotificationSubscriptionHealthMetricsRequest( + name="name_value", + ) + + # Make the request + response = client.get_notification_subscription_health_metrics(request=request) + + # Handle the response + print(response) + +# [END merchantapi_v1_generated_NotificationsApiService_GetNotificationSubscriptionHealthMetrics_sync] diff --git a/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_get_notification_subscription_sync.py b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_get_notification_subscription_sync.py new file mode 100644 index 000000000000..1e11c1efde91 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_get_notification_subscription_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 GetNotificationSubscription +# 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-notifications + + +# [START merchantapi_v1_generated_NotificationsApiService_GetNotificationSubscription_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_notifications_v1 + + +def sample_get_notification_subscription(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceClient() + + # Initialize request argument(s) + request = merchant_notifications_v1.GetNotificationSubscriptionRequest( + name="name_value", + ) + + # Make the request + response = client.get_notification_subscription(request=request) + + # Handle the response + print(response) + +# [END merchantapi_v1_generated_NotificationsApiService_GetNotificationSubscription_sync] diff --git a/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_list_notification_subscriptions_async.py b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_list_notification_subscriptions_async.py new file mode 100644 index 000000000000..50efff9ad99f --- /dev/null +++ b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_list_notification_subscriptions_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 ListNotificationSubscriptions +# 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-notifications + + +# [START merchantapi_v1_generated_NotificationsApiService_ListNotificationSubscriptions_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_notifications_v1 + + +async def sample_list_notification_subscriptions(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceAsyncClient() + + # Initialize request argument(s) + request = merchant_notifications_v1.ListNotificationSubscriptionsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_notification_subscriptions(request=request) + + # Handle the response + async for response in page_result: + print(response) + +# [END merchantapi_v1_generated_NotificationsApiService_ListNotificationSubscriptions_async] diff --git a/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_list_notification_subscriptions_sync.py b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_list_notification_subscriptions_sync.py new file mode 100644 index 000000000000..680e26717445 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_list_notification_subscriptions_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 ListNotificationSubscriptions +# 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-notifications + + +# [START merchantapi_v1_generated_NotificationsApiService_ListNotificationSubscriptions_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_notifications_v1 + + +def sample_list_notification_subscriptions(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceClient() + + # Initialize request argument(s) + request = merchant_notifications_v1.ListNotificationSubscriptionsRequest( + parent="parent_value", + ) + + # Make the request + page_result = client.list_notification_subscriptions(request=request) + + # Handle the response + for response in page_result: + print(response) + +# [END merchantapi_v1_generated_NotificationsApiService_ListNotificationSubscriptions_sync] diff --git a/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_update_notification_subscription_async.py b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_update_notification_subscription_async.py new file mode 100644 index 000000000000..64998debd58b --- /dev/null +++ b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_update_notification_subscription_async.py @@ -0,0 +1,55 @@ +# -*- 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 UpdateNotificationSubscription +# 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-notifications + + +# [START merchantapi_v1_generated_NotificationsApiService_UpdateNotificationSubscription_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_notifications_v1 + + +async def sample_update_notification_subscription(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceAsyncClient() + + # Initialize request argument(s) + notification_subscription = merchant_notifications_v1.NotificationSubscription() + notification_subscription.all_managed_accounts = True + + request = merchant_notifications_v1.UpdateNotificationSubscriptionRequest( + notification_subscription=notification_subscription, + ) + + # Make the request + response = await client.update_notification_subscription(request=request) + + # Handle the response + print(response) + +# [END merchantapi_v1_generated_NotificationsApiService_UpdateNotificationSubscription_async] diff --git a/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_update_notification_subscription_sync.py b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_update_notification_subscription_sync.py new file mode 100644 index 000000000000..21485bd8e8e2 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/samples/generated_samples/merchantapi_v1_generated_notifications_api_service_update_notification_subscription_sync.py @@ -0,0 +1,55 @@ +# -*- 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 UpdateNotificationSubscription +# 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-notifications + + +# [START merchantapi_v1_generated_NotificationsApiService_UpdateNotificationSubscription_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_notifications_v1 + + +def sample_update_notification_subscription(): + # Create a client + client = merchant_notifications_v1.NotificationsApiServiceClient() + + # Initialize request argument(s) + notification_subscription = merchant_notifications_v1.NotificationSubscription() + notification_subscription.all_managed_accounts = True + + request = merchant_notifications_v1.UpdateNotificationSubscriptionRequest( + notification_subscription=notification_subscription, + ) + + # Make the request + response = client.update_notification_subscription(request=request) + + # Handle the response + print(response) + +# [END merchantapi_v1_generated_NotificationsApiService_UpdateNotificationSubscription_sync] diff --git a/packages/google-shopping-merchant-notifications/samples/generated_samples/snippet_metadata_google.shopping.merchant.notifications.v1.json b/packages/google-shopping-merchant-notifications/samples/generated_samples/snippet_metadata_google.shopping.merchant.notifications.v1.json new file mode 100644 index 000000000000..5e97d8b31eae --- /dev/null +++ b/packages/google-shopping-merchant-notifications/samples/generated_samples/snippet_metadata_google.shopping.merchant.notifications.v1.json @@ -0,0 +1,991 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.shopping.merchant.notifications.v1", + "version": "v1" + } + ], + "language": "PYTHON", + "name": "google-shopping-merchant-notifications", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceAsyncClient", + "shortName": "NotificationsApiServiceAsyncClient" + }, + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceAsyncClient.create_notification_subscription", + "method": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService.CreateNotificationSubscription", + "service": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "shortName": "NotificationsApiService" + }, + "shortName": "CreateNotificationSubscription" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_notifications_v1.types.CreateNotificationSubscriptionRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "notification_subscription", + "type": "google.shopping.merchant_notifications_v1.types.NotificationSubscription" + }, + { + "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_notifications_v1.types.NotificationSubscription", + "shortName": "create_notification_subscription" + }, + "description": "Sample for CreateNotificationSubscription", + "file": "merchantapi_v1_generated_notifications_api_service_create_notification_subscription_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_NotificationsApiService_CreateNotificationSubscription_async", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 49, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 50, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_notifications_api_service_create_notification_subscription_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceClient", + "shortName": "NotificationsApiServiceClient" + }, + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceClient.create_notification_subscription", + "method": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService.CreateNotificationSubscription", + "service": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "shortName": "NotificationsApiService" + }, + "shortName": "CreateNotificationSubscription" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_notifications_v1.types.CreateNotificationSubscriptionRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "notification_subscription", + "type": "google.shopping.merchant_notifications_v1.types.NotificationSubscription" + }, + { + "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_notifications_v1.types.NotificationSubscription", + "shortName": "create_notification_subscription" + }, + "description": "Sample for CreateNotificationSubscription", + "file": "merchantapi_v1_generated_notifications_api_service_create_notification_subscription_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_NotificationsApiService_CreateNotificationSubscription_sync", + "segments": [ + { + "end": 55, + "start": 27, + "type": "FULL" + }, + { + "end": 55, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 49, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 52, + "start": 50, + "type": "REQUEST_EXECUTION" + }, + { + "end": 56, + "start": 53, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_notifications_api_service_create_notification_subscription_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceAsyncClient", + "shortName": "NotificationsApiServiceAsyncClient" + }, + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceAsyncClient.delete_notification_subscription", + "method": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService.DeleteNotificationSubscription", + "service": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "shortName": "NotificationsApiService" + }, + "shortName": "DeleteNotificationSubscription" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_notifications_v1.types.DeleteNotificationSubscriptionRequest" + }, + { + "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]]]" + } + ], + "shortName": "delete_notification_subscription" + }, + "description": "Sample for DeleteNotificationSubscription", + "file": "merchantapi_v1_generated_notifications_api_service_delete_notification_subscription_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_NotificationsApiService_DeleteNotificationSubscription_async", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_notifications_api_service_delete_notification_subscription_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceClient", + "shortName": "NotificationsApiServiceClient" + }, + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceClient.delete_notification_subscription", + "method": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService.DeleteNotificationSubscription", + "service": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "shortName": "NotificationsApiService" + }, + "shortName": "DeleteNotificationSubscription" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_notifications_v1.types.DeleteNotificationSubscriptionRequest" + }, + { + "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]]]" + } + ], + "shortName": "delete_notification_subscription" + }, + "description": "Sample for DeleteNotificationSubscription", + "file": "merchantapi_v1_generated_notifications_api_service_delete_notification_subscription_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_NotificationsApiService_DeleteNotificationSubscription_sync", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_notifications_api_service_delete_notification_subscription_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceAsyncClient", + "shortName": "NotificationsApiServiceAsyncClient" + }, + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceAsyncClient.get_notification_subscription_health_metrics", + "method": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService.GetNotificationSubscriptionHealthMetrics", + "service": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "shortName": "NotificationsApiService" + }, + "shortName": "GetNotificationSubscriptionHealthMetrics" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_notifications_v1.types.GetNotificationSubscriptionHealthMetricsRequest" + }, + { + "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_notifications_v1.types.NotificationSubscriptionHealthMetrics", + "shortName": "get_notification_subscription_health_metrics" + }, + "description": "Sample for GetNotificationSubscriptionHealthMetrics", + "file": "merchantapi_v1_generated_notifications_api_service_get_notification_subscription_health_metrics_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_NotificationsApiService_GetNotificationSubscriptionHealthMetrics_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_notifications_api_service_get_notification_subscription_health_metrics_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceClient", + "shortName": "NotificationsApiServiceClient" + }, + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceClient.get_notification_subscription_health_metrics", + "method": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService.GetNotificationSubscriptionHealthMetrics", + "service": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "shortName": "NotificationsApiService" + }, + "shortName": "GetNotificationSubscriptionHealthMetrics" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_notifications_v1.types.GetNotificationSubscriptionHealthMetricsRequest" + }, + { + "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_notifications_v1.types.NotificationSubscriptionHealthMetrics", + "shortName": "get_notification_subscription_health_metrics" + }, + "description": "Sample for GetNotificationSubscriptionHealthMetrics", + "file": "merchantapi_v1_generated_notifications_api_service_get_notification_subscription_health_metrics_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_NotificationsApiService_GetNotificationSubscriptionHealthMetrics_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_notifications_api_service_get_notification_subscription_health_metrics_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceAsyncClient", + "shortName": "NotificationsApiServiceAsyncClient" + }, + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceAsyncClient.get_notification_subscription", + "method": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService.GetNotificationSubscription", + "service": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "shortName": "NotificationsApiService" + }, + "shortName": "GetNotificationSubscription" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_notifications_v1.types.GetNotificationSubscriptionRequest" + }, + { + "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_notifications_v1.types.NotificationSubscription", + "shortName": "get_notification_subscription" + }, + "description": "Sample for GetNotificationSubscription", + "file": "merchantapi_v1_generated_notifications_api_service_get_notification_subscription_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_NotificationsApiService_GetNotificationSubscription_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_notifications_api_service_get_notification_subscription_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceClient", + "shortName": "NotificationsApiServiceClient" + }, + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceClient.get_notification_subscription", + "method": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService.GetNotificationSubscription", + "service": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "shortName": "NotificationsApiService" + }, + "shortName": "GetNotificationSubscription" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_notifications_v1.types.GetNotificationSubscriptionRequest" + }, + { + "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_notifications_v1.types.NotificationSubscription", + "shortName": "get_notification_subscription" + }, + "description": "Sample for GetNotificationSubscription", + "file": "merchantapi_v1_generated_notifications_api_service_get_notification_subscription_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_NotificationsApiService_GetNotificationSubscription_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_notifications_api_service_get_notification_subscription_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceAsyncClient", + "shortName": "NotificationsApiServiceAsyncClient" + }, + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceAsyncClient.list_notification_subscriptions", + "method": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService.ListNotificationSubscriptions", + "service": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "shortName": "NotificationsApiService" + }, + "shortName": "ListNotificationSubscriptions" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_notifications_v1.types.ListNotificationSubscriptionsRequest" + }, + { + "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_notifications_v1.services.notifications_api_service.pagers.ListNotificationSubscriptionsAsyncPager", + "shortName": "list_notification_subscriptions" + }, + "description": "Sample for ListNotificationSubscriptions", + "file": "merchantapi_v1_generated_notifications_api_service_list_notification_subscriptions_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_NotificationsApiService_ListNotificationSubscriptions_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_notifications_api_service_list_notification_subscriptions_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceClient", + "shortName": "NotificationsApiServiceClient" + }, + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceClient.list_notification_subscriptions", + "method": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService.ListNotificationSubscriptions", + "service": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "shortName": "NotificationsApiService" + }, + "shortName": "ListNotificationSubscriptions" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_notifications_v1.types.ListNotificationSubscriptionsRequest" + }, + { + "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_notifications_v1.services.notifications_api_service.pagers.ListNotificationSubscriptionsPager", + "shortName": "list_notification_subscriptions" + }, + "description": "Sample for ListNotificationSubscriptions", + "file": "merchantapi_v1_generated_notifications_api_service_list_notification_subscriptions_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_NotificationsApiService_ListNotificationSubscriptions_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_notifications_api_service_list_notification_subscriptions_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceAsyncClient", + "shortName": "NotificationsApiServiceAsyncClient" + }, + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceAsyncClient.update_notification_subscription", + "method": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService.UpdateNotificationSubscription", + "service": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "shortName": "NotificationsApiService" + }, + "shortName": "UpdateNotificationSubscription" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_notifications_v1.types.UpdateNotificationSubscriptionRequest" + }, + { + "name": "notification_subscription", + "type": "google.shopping.merchant_notifications_v1.types.NotificationSubscription" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "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_notifications_v1.types.NotificationSubscription", + "shortName": "update_notification_subscription" + }, + "description": "Sample for UpdateNotificationSubscription", + "file": "merchantapi_v1_generated_notifications_api_service_update_notification_subscription_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_NotificationsApiService_UpdateNotificationSubscription_async", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 48, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 49, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_notifications_api_service_update_notification_subscription_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceClient", + "shortName": "NotificationsApiServiceClient" + }, + "fullName": "google.shopping.merchant_notifications_v1.NotificationsApiServiceClient.update_notification_subscription", + "method": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService.UpdateNotificationSubscription", + "service": { + "fullName": "google.shopping.merchant.notifications.v1.NotificationsApiService", + "shortName": "NotificationsApiService" + }, + "shortName": "UpdateNotificationSubscription" + }, + "parameters": [ + { + "name": "request", + "type": "google.shopping.merchant_notifications_v1.types.UpdateNotificationSubscriptionRequest" + }, + { + "name": "notification_subscription", + "type": "google.shopping.merchant_notifications_v1.types.NotificationSubscription" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "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_notifications_v1.types.NotificationSubscription", + "shortName": "update_notification_subscription" + }, + "description": "Sample for UpdateNotificationSubscription", + "file": "merchantapi_v1_generated_notifications_api_service_update_notification_subscription_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "merchantapi_v1_generated_NotificationsApiService_UpdateNotificationSubscription_sync", + "segments": [ + { + "end": 54, + "start": 27, + "type": "FULL" + }, + { + "end": 54, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 48, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 51, + "start": 49, + "type": "REQUEST_EXECUTION" + }, + { + "end": 55, + "start": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "merchantapi_v1_generated_notifications_api_service_update_notification_subscription_sync.py" + } + ] +} diff --git a/packages/google-shopping-merchant-notifications/samples/generated_samples/snippet_metadata_google.shopping.merchant.notifications.v1beta.json b/packages/google-shopping-merchant-notifications/samples/generated_samples/snippet_metadata_google.shopping.merchant.notifications.v1beta.json index 89f67c5d5f7a..b27b3eb2144a 100644 --- a/packages/google-shopping-merchant-notifications/samples/generated_samples/snippet_metadata_google.shopping.merchant.notifications.v1beta.json +++ b/packages/google-shopping-merchant-notifications/samples/generated_samples/snippet_metadata_google.shopping.merchant.notifications.v1beta.json @@ -8,7 +8,7 @@ ], "language": "PYTHON", "name": "google-shopping-merchant-notifications", - "version": "0.1.8" + "version": "0.1.0" }, "snippets": [ { diff --git a/packages/google-shopping-merchant-notifications/scripts/fixup_merchant_notifications_v1_keywords.py b/packages/google-shopping-merchant-notifications/scripts/fixup_merchant_notifications_v1_keywords.py new file mode 100644 index 000000000000..c00e203f15aa --- /dev/null +++ b/packages/google-shopping-merchant-notifications/scripts/fixup_merchant_notifications_v1_keywords.py @@ -0,0 +1,181 @@ +#! /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_notificationsCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'create_notification_subscription': ('parent', 'notification_subscription', ), + 'delete_notification_subscription': ('name', ), + 'get_notification_subscription': ('name', ), + 'get_notification_subscription_health_metrics': ('name', ), + 'list_notification_subscriptions': ('parent', 'page_size', 'page_token', ), + 'update_notification_subscription': ('notification_subscription', 'update_mask', ), + } + + 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_notificationsCallTransformer(), +): + """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_notifications 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-notifications/tests/unit/gapic/merchant_notifications_v1/__init__.py b/packages/google-shopping-merchant-notifications/tests/unit/gapic/merchant_notifications_v1/__init__.py new file mode 100644 index 000000000000..cbf94b283c70 --- /dev/null +++ b/packages/google-shopping-merchant-notifications/tests/unit/gapic/merchant_notifications_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-notifications/tests/unit/gapic/merchant_notifications_v1/test_notifications_api_service.py b/packages/google-shopping-merchant-notifications/tests/unit/gapic/merchant_notifications_v1/test_notifications_api_service.py new file mode 100644 index 000000000000..760e04cc72ed --- /dev/null +++ b/packages/google-shopping-merchant-notifications/tests/unit/gapic/merchant_notifications_v1/test_notifications_api_service.py @@ -0,0 +1,7047 @@ +# -*- 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.protobuf import field_mask_pb2 # type: ignore + +from google.shopping.merchant_notifications_v1.services.notifications_api_service import ( + NotificationsApiServiceAsyncClient, + NotificationsApiServiceClient, + pagers, + transports, +) +from google.shopping.merchant_notifications_v1.types import notificationsapi + +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 NotificationsApiServiceClient._get_default_mtls_endpoint(None) is None + assert ( + NotificationsApiServiceClient._get_default_mtls_endpoint(api_endpoint) + == api_mtls_endpoint + ) + assert ( + NotificationsApiServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) + == api_mtls_endpoint + ) + assert ( + NotificationsApiServiceClient._get_default_mtls_endpoint(sandbox_endpoint) + == sandbox_mtls_endpoint + ) + assert ( + NotificationsApiServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) + == sandbox_mtls_endpoint + ) + assert ( + NotificationsApiServiceClient._get_default_mtls_endpoint(non_googleapi) + == non_googleapi + ) + + +def test__read_environment_variables(): + assert NotificationsApiServiceClient._read_environment_variables() == ( + False, + "auto", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + assert NotificationsApiServiceClient._read_environment_variables() == ( + True, + "auto", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + assert NotificationsApiServiceClient._read_environment_variables() == ( + False, + "auto", + None, + ) + + with mock.patch.dict( + os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"} + ): + with pytest.raises(ValueError) as excinfo: + NotificationsApiServiceClient._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 NotificationsApiServiceClient._read_environment_variables() == ( + False, + "never", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + assert NotificationsApiServiceClient._read_environment_variables() == ( + False, + "always", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}): + assert NotificationsApiServiceClient._read_environment_variables() == ( + False, + "auto", + None, + ) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + NotificationsApiServiceClient._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 NotificationsApiServiceClient._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 NotificationsApiServiceClient._get_client_cert_source(None, False) is None + assert ( + NotificationsApiServiceClient._get_client_cert_source( + mock_provided_cert_source, False + ) + is None + ) + assert ( + NotificationsApiServiceClient._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 ( + NotificationsApiServiceClient._get_client_cert_source(None, True) + is mock_default_cert_source + ) + assert ( + NotificationsApiServiceClient._get_client_cert_source( + mock_provided_cert_source, "true" + ) + is mock_provided_cert_source + ) + + +@mock.patch.object( + NotificationsApiServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(NotificationsApiServiceClient), +) +@mock.patch.object( + NotificationsApiServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(NotificationsApiServiceAsyncClient), +) +def test__get_api_endpoint(): + api_override = "foo.com" + mock_client_cert_source = mock.Mock() + default_universe = NotificationsApiServiceClient._DEFAULT_UNIVERSE + default_endpoint = NotificationsApiServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=default_universe + ) + mock_universe = "bar.com" + mock_endpoint = NotificationsApiServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=mock_universe + ) + + assert ( + NotificationsApiServiceClient._get_api_endpoint( + api_override, mock_client_cert_source, default_universe, "always" + ) + == api_override + ) + assert ( + NotificationsApiServiceClient._get_api_endpoint( + None, mock_client_cert_source, default_universe, "auto" + ) + == NotificationsApiServiceClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + NotificationsApiServiceClient._get_api_endpoint( + None, None, default_universe, "auto" + ) + == default_endpoint + ) + assert ( + NotificationsApiServiceClient._get_api_endpoint( + None, None, default_universe, "always" + ) + == NotificationsApiServiceClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + NotificationsApiServiceClient._get_api_endpoint( + None, mock_client_cert_source, default_universe, "always" + ) + == NotificationsApiServiceClient.DEFAULT_MTLS_ENDPOINT + ) + assert ( + NotificationsApiServiceClient._get_api_endpoint( + None, None, mock_universe, "never" + ) + == mock_endpoint + ) + assert ( + NotificationsApiServiceClient._get_api_endpoint( + None, None, default_universe, "never" + ) + == default_endpoint + ) + + with pytest.raises(MutualTLSChannelError) as excinfo: + NotificationsApiServiceClient._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 ( + NotificationsApiServiceClient._get_universe_domain( + client_universe_domain, universe_domain_env + ) + == client_universe_domain + ) + assert ( + NotificationsApiServiceClient._get_universe_domain(None, universe_domain_env) + == universe_domain_env + ) + assert ( + NotificationsApiServiceClient._get_universe_domain(None, None) + == NotificationsApiServiceClient._DEFAULT_UNIVERSE + ) + + with pytest.raises(ValueError) as excinfo: + NotificationsApiServiceClient._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 = NotificationsApiServiceClient(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 = NotificationsApiServiceClient(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", + [ + (NotificationsApiServiceClient, "grpc"), + (NotificationsApiServiceAsyncClient, "grpc_asyncio"), + (NotificationsApiServiceClient, "rest"), + ], +) +def test_notifications_api_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.NotificationsApiServiceGrpcTransport, "grpc"), + (transports.NotificationsApiServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.NotificationsApiServiceRestTransport, "rest"), + ], +) +def test_notifications_api_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", + [ + (NotificationsApiServiceClient, "grpc"), + (NotificationsApiServiceAsyncClient, "grpc_asyncio"), + (NotificationsApiServiceClient, "rest"), + ], +) +def test_notifications_api_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_notifications_api_service_client_get_transport_class(): + transport = NotificationsApiServiceClient.get_transport_class() + available_transports = [ + transports.NotificationsApiServiceGrpcTransport, + transports.NotificationsApiServiceRestTransport, + ] + assert transport in available_transports + + transport = NotificationsApiServiceClient.get_transport_class("grpc") + assert transport == transports.NotificationsApiServiceGrpcTransport + + +@pytest.mark.parametrize( + "client_class,transport_class,transport_name", + [ + ( + NotificationsApiServiceClient, + transports.NotificationsApiServiceGrpcTransport, + "grpc", + ), + ( + NotificationsApiServiceAsyncClient, + transports.NotificationsApiServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ( + NotificationsApiServiceClient, + transports.NotificationsApiServiceRestTransport, + "rest", + ), + ], +) +@mock.patch.object( + NotificationsApiServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(NotificationsApiServiceClient), +) +@mock.patch.object( + NotificationsApiServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(NotificationsApiServiceAsyncClient), +) +def test_notifications_api_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(NotificationsApiServiceClient, "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(NotificationsApiServiceClient, "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", + [ + ( + NotificationsApiServiceClient, + transports.NotificationsApiServiceGrpcTransport, + "grpc", + "true", + ), + ( + NotificationsApiServiceAsyncClient, + transports.NotificationsApiServiceGrpcAsyncIOTransport, + "grpc_asyncio", + "true", + ), + ( + NotificationsApiServiceClient, + transports.NotificationsApiServiceGrpcTransport, + "grpc", + "false", + ), + ( + NotificationsApiServiceAsyncClient, + transports.NotificationsApiServiceGrpcAsyncIOTransport, + "grpc_asyncio", + "false", + ), + ( + NotificationsApiServiceClient, + transports.NotificationsApiServiceRestTransport, + "rest", + "true", + ), + ( + NotificationsApiServiceClient, + transports.NotificationsApiServiceRestTransport, + "rest", + "false", + ), + ], +) +@mock.patch.object( + NotificationsApiServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(NotificationsApiServiceClient), +) +@mock.patch.object( + NotificationsApiServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(NotificationsApiServiceAsyncClient), +) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_notifications_api_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", [NotificationsApiServiceClient, NotificationsApiServiceAsyncClient] +) +@mock.patch.object( + NotificationsApiServiceClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(NotificationsApiServiceClient), +) +@mock.patch.object( + NotificationsApiServiceAsyncClient, + "DEFAULT_ENDPOINT", + modify_default_endpoint(NotificationsApiServiceAsyncClient), +) +def test_notifications_api_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", [NotificationsApiServiceClient, NotificationsApiServiceAsyncClient] +) +@mock.patch.object( + NotificationsApiServiceClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(NotificationsApiServiceClient), +) +@mock.patch.object( + NotificationsApiServiceAsyncClient, + "_DEFAULT_ENDPOINT_TEMPLATE", + modify_default_endpoint_template(NotificationsApiServiceAsyncClient), +) +def test_notifications_api_service_client_client_api_endpoint(client_class): + mock_client_cert_source = client_cert_source_callback + api_override = "foo.com" + default_universe = NotificationsApiServiceClient._DEFAULT_UNIVERSE + default_endpoint = NotificationsApiServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format( + UNIVERSE_DOMAIN=default_universe + ) + mock_universe = "bar.com" + mock_endpoint = NotificationsApiServiceClient._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", + [ + ( + NotificationsApiServiceClient, + transports.NotificationsApiServiceGrpcTransport, + "grpc", + ), + ( + NotificationsApiServiceAsyncClient, + transports.NotificationsApiServiceGrpcAsyncIOTransport, + "grpc_asyncio", + ), + ( + NotificationsApiServiceClient, + transports.NotificationsApiServiceRestTransport, + "rest", + ), + ], +) +def test_notifications_api_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", + [ + ( + NotificationsApiServiceClient, + transports.NotificationsApiServiceGrpcTransport, + "grpc", + grpc_helpers, + ), + ( + NotificationsApiServiceAsyncClient, + transports.NotificationsApiServiceGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ( + NotificationsApiServiceClient, + transports.NotificationsApiServiceRestTransport, + "rest", + None, + ), + ], +) +def test_notifications_api_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_notifications_api_service_client_client_options_from_dict(): + with mock.patch( + "google.shopping.merchant_notifications_v1.services.notifications_api_service.transports.NotificationsApiServiceGrpcTransport.__init__" + ) as grpc_transport: + grpc_transport.return_value = None + client = NotificationsApiServiceClient( + 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", + [ + ( + NotificationsApiServiceClient, + transports.NotificationsApiServiceGrpcTransport, + "grpc", + grpc_helpers, + ), + ( + NotificationsApiServiceAsyncClient, + transports.NotificationsApiServiceGrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ], +) +def test_notifications_api_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", + [ + notificationsapi.GetNotificationSubscriptionRequest, + dict, + ], +) +def test_get_notification_subscription(request_type, transport: str = "grpc"): + client = NotificationsApiServiceClient( + 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.get_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = notificationsapi.NotificationSubscription( + name="name_value", + registered_event=notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE, + call_back_uri="call_back_uri_value", + all_managed_accounts=True, + ) + response = client.get_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = notificationsapi.GetNotificationSubscriptionRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, notificationsapi.NotificationSubscription) + assert response.name == "name_value" + assert ( + response.registered_event + == notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE + ) + assert response.call_back_uri == "call_back_uri_value" + + +def test_get_notification_subscription_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 = NotificationsApiServiceClient( + 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 = notificationsapi.GetNotificationSubscriptionRequest( + name="name_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_notification_subscription), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.get_notification_subscription(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == notificationsapi.GetNotificationSubscriptionRequest( + name="name_value", + ) + + +def test_get_notification_subscription_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 = NotificationsApiServiceClient( + 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.get_notification_subscription + 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.get_notification_subscription + ] = mock_rpc + request = {} + client.get_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_notification_subscription(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_get_notification_subscription_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 = NotificationsApiServiceAsyncClient( + 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.get_notification_subscription + 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.get_notification_subscription + ] = mock_rpc + + request = {} + await client.get_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.get_notification_subscription(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_get_notification_subscription_async( + transport: str = "grpc_asyncio", + request_type=notificationsapi.GetNotificationSubscriptionRequest, +): + client = NotificationsApiServiceAsyncClient( + 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.get_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.NotificationSubscription( + name="name_value", + registered_event=notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE, + call_back_uri="call_back_uri_value", + ) + ) + response = await client.get_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = notificationsapi.GetNotificationSubscriptionRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, notificationsapi.NotificationSubscription) + assert response.name == "name_value" + assert ( + response.registered_event + == notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE + ) + assert response.call_back_uri == "call_back_uri_value" + + +@pytest.mark.asyncio +async def test_get_notification_subscription_async_from_dict(): + await test_get_notification_subscription_async(request_type=dict) + + +def test_get_notification_subscription_field_headers(): + client = NotificationsApiServiceClient( + 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 = notificationsapi.GetNotificationSubscriptionRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_notification_subscription), "__call__" + ) as call: + call.return_value = notificationsapi.NotificationSubscription() + client.get_notification_subscription(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_get_notification_subscription_field_headers_async(): + client = NotificationsApiServiceAsyncClient( + 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 = notificationsapi.GetNotificationSubscriptionRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_notification_subscription), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.NotificationSubscription() + ) + await client.get_notification_subscription(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_get_notification_subscription_flattened(): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = notificationsapi.NotificationSubscription() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_notification_subscription( + 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_get_notification_subscription_flattened_error(): + client = NotificationsApiServiceClient( + 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.get_notification_subscription( + notificationsapi.GetNotificationSubscriptionRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_get_notification_subscription_flattened_async(): + client = NotificationsApiServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = notificationsapi.NotificationSubscription() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.NotificationSubscription() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_notification_subscription( + 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_get_notification_subscription_flattened_error_async(): + client = NotificationsApiServiceAsyncClient( + 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.get_notification_subscription( + notificationsapi.GetNotificationSubscriptionRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + notificationsapi.CreateNotificationSubscriptionRequest, + dict, + ], +) +def test_create_notification_subscription(request_type, transport: str = "grpc"): + client = NotificationsApiServiceClient( + 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.create_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = notificationsapi.NotificationSubscription( + name="name_value", + registered_event=notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE, + call_back_uri="call_back_uri_value", + all_managed_accounts=True, + ) + response = client.create_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = notificationsapi.CreateNotificationSubscriptionRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, notificationsapi.NotificationSubscription) + assert response.name == "name_value" + assert ( + response.registered_event + == notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE + ) + assert response.call_back_uri == "call_back_uri_value" + + +def test_create_notification_subscription_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 = NotificationsApiServiceClient( + 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 = notificationsapi.CreateNotificationSubscriptionRequest( + parent="parent_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_notification_subscription), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.create_notification_subscription(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == notificationsapi.CreateNotificationSubscriptionRequest( + parent="parent_value", + ) + + +def test_create_notification_subscription_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 = NotificationsApiServiceClient( + 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.create_notification_subscription + 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.create_notification_subscription + ] = mock_rpc + request = {} + client.create_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_notification_subscription(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_create_notification_subscription_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 = NotificationsApiServiceAsyncClient( + 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.create_notification_subscription + 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.create_notification_subscription + ] = mock_rpc + + request = {} + await client.create_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.create_notification_subscription(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_create_notification_subscription_async( + transport: str = "grpc_asyncio", + request_type=notificationsapi.CreateNotificationSubscriptionRequest, +): + client = NotificationsApiServiceAsyncClient( + 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.create_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.NotificationSubscription( + name="name_value", + registered_event=notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE, + call_back_uri="call_back_uri_value", + ) + ) + response = await client.create_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = notificationsapi.CreateNotificationSubscriptionRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, notificationsapi.NotificationSubscription) + assert response.name == "name_value" + assert ( + response.registered_event + == notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE + ) + assert response.call_back_uri == "call_back_uri_value" + + +@pytest.mark.asyncio +async def test_create_notification_subscription_async_from_dict(): + await test_create_notification_subscription_async(request_type=dict) + + +def test_create_notification_subscription_field_headers(): + client = NotificationsApiServiceClient( + 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 = notificationsapi.CreateNotificationSubscriptionRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_notification_subscription), "__call__" + ) as call: + call.return_value = notificationsapi.NotificationSubscription() + client.create_notification_subscription(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_create_notification_subscription_field_headers_async(): + client = NotificationsApiServiceAsyncClient( + 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 = notificationsapi.CreateNotificationSubscriptionRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_notification_subscription), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.NotificationSubscription() + ) + await client.create_notification_subscription(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_create_notification_subscription_flattened(): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = notificationsapi.NotificationSubscription() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_notification_subscription( + parent="parent_value", + notification_subscription=notificationsapi.NotificationSubscription( + all_managed_accounts=True + ), + ) + + # 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 + arg = args[0].notification_subscription + mock_val = notificationsapi.NotificationSubscription(all_managed_accounts=True) + assert arg == mock_val + + +def test_create_notification_subscription_flattened_error(): + client = NotificationsApiServiceClient( + 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.create_notification_subscription( + notificationsapi.CreateNotificationSubscriptionRequest(), + parent="parent_value", + notification_subscription=notificationsapi.NotificationSubscription( + all_managed_accounts=True + ), + ) + + +@pytest.mark.asyncio +async def test_create_notification_subscription_flattened_async(): + client = NotificationsApiServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = notificationsapi.NotificationSubscription() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.NotificationSubscription() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_notification_subscription( + parent="parent_value", + notification_subscription=notificationsapi.NotificationSubscription( + all_managed_accounts=True + ), + ) + + # 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 + arg = args[0].notification_subscription + mock_val = notificationsapi.NotificationSubscription(all_managed_accounts=True) + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_create_notification_subscription_flattened_error_async(): + client = NotificationsApiServiceAsyncClient( + 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.create_notification_subscription( + notificationsapi.CreateNotificationSubscriptionRequest(), + parent="parent_value", + notification_subscription=notificationsapi.NotificationSubscription( + all_managed_accounts=True + ), + ) + + +@pytest.mark.parametrize( + "request_type", + [ + notificationsapi.UpdateNotificationSubscriptionRequest, + dict, + ], +) +def test_update_notification_subscription(request_type, transport: str = "grpc"): + client = NotificationsApiServiceClient( + 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.update_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = notificationsapi.NotificationSubscription( + name="name_value", + registered_event=notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE, + call_back_uri="call_back_uri_value", + all_managed_accounts=True, + ) + response = client.update_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = notificationsapi.UpdateNotificationSubscriptionRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, notificationsapi.NotificationSubscription) + assert response.name == "name_value" + assert ( + response.registered_event + == notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE + ) + assert response.call_back_uri == "call_back_uri_value" + + +def test_update_notification_subscription_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 = NotificationsApiServiceClient( + 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 = notificationsapi.UpdateNotificationSubscriptionRequest() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_notification_subscription), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.update_notification_subscription(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == notificationsapi.UpdateNotificationSubscriptionRequest() + + +def test_update_notification_subscription_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 = NotificationsApiServiceClient( + 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.update_notification_subscription + 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.update_notification_subscription + ] = mock_rpc + request = {} + client.update_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_notification_subscription(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_update_notification_subscription_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 = NotificationsApiServiceAsyncClient( + 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.update_notification_subscription + 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.update_notification_subscription + ] = mock_rpc + + request = {} + await client.update_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.update_notification_subscription(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_update_notification_subscription_async( + transport: str = "grpc_asyncio", + request_type=notificationsapi.UpdateNotificationSubscriptionRequest, +): + client = NotificationsApiServiceAsyncClient( + 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.update_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.NotificationSubscription( + name="name_value", + registered_event=notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE, + call_back_uri="call_back_uri_value", + ) + ) + response = await client.update_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = notificationsapi.UpdateNotificationSubscriptionRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, notificationsapi.NotificationSubscription) + assert response.name == "name_value" + assert ( + response.registered_event + == notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE + ) + assert response.call_back_uri == "call_back_uri_value" + + +@pytest.mark.asyncio +async def test_update_notification_subscription_async_from_dict(): + await test_update_notification_subscription_async(request_type=dict) + + +def test_update_notification_subscription_field_headers(): + client = NotificationsApiServiceClient( + 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 = notificationsapi.UpdateNotificationSubscriptionRequest() + + request.notification_subscription.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_notification_subscription), "__call__" + ) as call: + call.return_value = notificationsapi.NotificationSubscription() + client.update_notification_subscription(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", + "notification_subscription.name=name_value", + ) in kw["metadata"] + + +@pytest.mark.asyncio +async def test_update_notification_subscription_field_headers_async(): + client = NotificationsApiServiceAsyncClient( + 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 = notificationsapi.UpdateNotificationSubscriptionRequest() + + request.notification_subscription.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_notification_subscription), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.NotificationSubscription() + ) + await client.update_notification_subscription(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", + "notification_subscription.name=name_value", + ) in kw["metadata"] + + +def test_update_notification_subscription_flattened(): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = notificationsapi.NotificationSubscription() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_notification_subscription( + notification_subscription=notificationsapi.NotificationSubscription( + all_managed_accounts=True + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_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].notification_subscription + mock_val = notificationsapi.NotificationSubscription(all_managed_accounts=True) + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=["paths_value"]) + assert arg == mock_val + + +def test_update_notification_subscription_flattened_error(): + client = NotificationsApiServiceClient( + 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.update_notification_subscription( + notificationsapi.UpdateNotificationSubscriptionRequest(), + notification_subscription=notificationsapi.NotificationSubscription( + all_managed_accounts=True + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +@pytest.mark.asyncio +async def test_update_notification_subscription_flattened_async(): + client = NotificationsApiServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = notificationsapi.NotificationSubscription() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.NotificationSubscription() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_notification_subscription( + notification_subscription=notificationsapi.NotificationSubscription( + all_managed_accounts=True + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_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].notification_subscription + mock_val = notificationsapi.NotificationSubscription(all_managed_accounts=True) + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=["paths_value"]) + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_update_notification_subscription_flattened_error_async(): + client = NotificationsApiServiceAsyncClient( + 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.update_notification_subscription( + notificationsapi.UpdateNotificationSubscriptionRequest(), + notification_subscription=notificationsapi.NotificationSubscription( + all_managed_accounts=True + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +@pytest.mark.parametrize( + "request_type", + [ + notificationsapi.DeleteNotificationSubscriptionRequest, + dict, + ], +) +def test_delete_notification_subscription(request_type, transport: str = "grpc"): + client = NotificationsApiServiceClient( + 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.delete_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = notificationsapi.DeleteNotificationSubscriptionRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_notification_subscription_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 = NotificationsApiServiceClient( + 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 = notificationsapi.DeleteNotificationSubscriptionRequest( + name="name_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_notification_subscription), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.delete_notification_subscription(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == notificationsapi.DeleteNotificationSubscriptionRequest( + name="name_value", + ) + + +def test_delete_notification_subscription_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 = NotificationsApiServiceClient( + 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.delete_notification_subscription + 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.delete_notification_subscription + ] = mock_rpc + request = {} + client.delete_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.delete_notification_subscription(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_delete_notification_subscription_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 = NotificationsApiServiceAsyncClient( + 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.delete_notification_subscription + 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.delete_notification_subscription + ] = mock_rpc + + request = {} + await client.delete_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.delete_notification_subscription(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_delete_notification_subscription_async( + transport: str = "grpc_asyncio", + request_type=notificationsapi.DeleteNotificationSubscriptionRequest, +): + client = NotificationsApiServiceAsyncClient( + 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.delete_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = notificationsapi.DeleteNotificationSubscriptionRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_notification_subscription_async_from_dict(): + await test_delete_notification_subscription_async(request_type=dict) + + +def test_delete_notification_subscription_field_headers(): + client = NotificationsApiServiceClient( + 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 = notificationsapi.DeleteNotificationSubscriptionRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_notification_subscription), "__call__" + ) as call: + call.return_value = None + client.delete_notification_subscription(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_delete_notification_subscription_field_headers_async(): + client = NotificationsApiServiceAsyncClient( + 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 = notificationsapi.DeleteNotificationSubscriptionRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_notification_subscription), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_notification_subscription(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_delete_notification_subscription_flattened(): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = None + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_notification_subscription( + 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_delete_notification_subscription_flattened_error(): + client = NotificationsApiServiceClient( + 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.delete_notification_subscription( + notificationsapi.DeleteNotificationSubscriptionRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_delete_notification_subscription_flattened_async(): + client = NotificationsApiServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = None + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_notification_subscription( + 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_delete_notification_subscription_flattened_error_async(): + client = NotificationsApiServiceAsyncClient( + 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.delete_notification_subscription( + notificationsapi.DeleteNotificationSubscriptionRequest(), + name="name_value", + ) + + +@pytest.mark.parametrize( + "request_type", + [ + notificationsapi.ListNotificationSubscriptionsRequest, + dict, + ], +) +def test_list_notification_subscriptions(request_type, transport: str = "grpc"): + client = NotificationsApiServiceClient( + 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_notification_subscriptions), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = notificationsapi.ListNotificationSubscriptionsResponse( + next_page_token="next_page_token_value", + ) + response = client.list_notification_subscriptions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = notificationsapi.ListNotificationSubscriptionsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListNotificationSubscriptionsPager) + assert response.next_page_token == "next_page_token_value" + + +def test_list_notification_subscriptions_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 = NotificationsApiServiceClient( + 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 = notificationsapi.ListNotificationSubscriptionsRequest( + parent="parent_value", + page_token="page_token_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_notification_subscriptions), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.list_notification_subscriptions(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == notificationsapi.ListNotificationSubscriptionsRequest( + parent="parent_value", + page_token="page_token_value", + ) + + +def test_list_notification_subscriptions_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 = NotificationsApiServiceClient( + 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_notification_subscriptions + 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_notification_subscriptions + ] = mock_rpc + request = {} + client.list_notification_subscriptions(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_notification_subscriptions(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_notification_subscriptions_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 = NotificationsApiServiceAsyncClient( + 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_notification_subscriptions + 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_notification_subscriptions + ] = mock_rpc + + request = {} + await client.list_notification_subscriptions(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.list_notification_subscriptions(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_notification_subscriptions_async( + transport: str = "grpc_asyncio", + request_type=notificationsapi.ListNotificationSubscriptionsRequest, +): + client = NotificationsApiServiceAsyncClient( + 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_notification_subscriptions), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.ListNotificationSubscriptionsResponse( + next_page_token="next_page_token_value", + ) + ) + response = await client.list_notification_subscriptions(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = notificationsapi.ListNotificationSubscriptionsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListNotificationSubscriptionsAsyncPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.asyncio +async def test_list_notification_subscriptions_async_from_dict(): + await test_list_notification_subscriptions_async(request_type=dict) + + +def test_list_notification_subscriptions_field_headers(): + client = NotificationsApiServiceClient( + 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 = notificationsapi.ListNotificationSubscriptionsRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_notification_subscriptions), "__call__" + ) as call: + call.return_value = notificationsapi.ListNotificationSubscriptionsResponse() + client.list_notification_subscriptions(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_notification_subscriptions_field_headers_async(): + client = NotificationsApiServiceAsyncClient( + 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 = notificationsapi.ListNotificationSubscriptionsRequest() + + request.parent = "parent_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_notification_subscriptions), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.ListNotificationSubscriptionsResponse() + ) + await client.list_notification_subscriptions(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_notification_subscriptions_flattened(): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_notification_subscriptions), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = notificationsapi.ListNotificationSubscriptionsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_notification_subscriptions( + 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_notification_subscriptions_flattened_error(): + client = NotificationsApiServiceClient( + 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_notification_subscriptions( + notificationsapi.ListNotificationSubscriptionsRequest(), + parent="parent_value", + ) + + +@pytest.mark.asyncio +async def test_list_notification_subscriptions_flattened_async(): + client = NotificationsApiServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_notification_subscriptions), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = notificationsapi.ListNotificationSubscriptionsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.ListNotificationSubscriptionsResponse() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_notification_subscriptions( + 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_notification_subscriptions_flattened_error_async(): + client = NotificationsApiServiceAsyncClient( + 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_notification_subscriptions( + notificationsapi.ListNotificationSubscriptionsRequest(), + parent="parent_value", + ) + + +def test_list_notification_subscriptions_pager(transport_name: str = "grpc"): + client = NotificationsApiServiceClient( + 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_notification_subscriptions), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[ + notificationsapi.NotificationSubscription(), + notificationsapi.NotificationSubscription(), + notificationsapi.NotificationSubscription(), + ], + next_page_token="abc", + ), + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[], + next_page_token="def", + ), + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[ + notificationsapi.NotificationSubscription(), + ], + next_page_token="ghi", + ), + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[ + notificationsapi.NotificationSubscription(), + notificationsapi.NotificationSubscription(), + ], + ), + RuntimeError, + ) + + expected_metadata = () + retry = retries.Retry() + timeout = 5 + expected_metadata = tuple(expected_metadata) + ( + gapic_v1.routing_header.to_grpc_metadata((("parent", ""),)), + ) + pager = client.list_notification_subscriptions( + 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, notificationsapi.NotificationSubscription) for i in results + ) + + +def test_list_notification_subscriptions_pages(transport_name: str = "grpc"): + client = NotificationsApiServiceClient( + 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_notification_subscriptions), "__call__" + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[ + notificationsapi.NotificationSubscription(), + notificationsapi.NotificationSubscription(), + notificationsapi.NotificationSubscription(), + ], + next_page_token="abc", + ), + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[], + next_page_token="def", + ), + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[ + notificationsapi.NotificationSubscription(), + ], + next_page_token="ghi", + ), + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[ + notificationsapi.NotificationSubscription(), + notificationsapi.NotificationSubscription(), + ], + ), + RuntimeError, + ) + pages = list(client.list_notification_subscriptions(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_notification_subscriptions_async_pager(): + client = NotificationsApiServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_notification_subscriptions), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[ + notificationsapi.NotificationSubscription(), + notificationsapi.NotificationSubscription(), + notificationsapi.NotificationSubscription(), + ], + next_page_token="abc", + ), + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[], + next_page_token="def", + ), + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[ + notificationsapi.NotificationSubscription(), + ], + next_page_token="ghi", + ), + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[ + notificationsapi.NotificationSubscription(), + notificationsapi.NotificationSubscription(), + ], + ), + RuntimeError, + ) + async_pager = await client.list_notification_subscriptions( + 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, notificationsapi.NotificationSubscription) for i in responses + ) + + +@pytest.mark.asyncio +async def test_list_notification_subscriptions_async_pages(): + client = NotificationsApiServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_notification_subscriptions), + "__call__", + new_callable=mock.AsyncMock, + ) as call: + # Set the response to a series of pages. + call.side_effect = ( + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[ + notificationsapi.NotificationSubscription(), + notificationsapi.NotificationSubscription(), + notificationsapi.NotificationSubscription(), + ], + next_page_token="abc", + ), + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[], + next_page_token="def", + ), + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[ + notificationsapi.NotificationSubscription(), + ], + next_page_token="ghi", + ), + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[ + notificationsapi.NotificationSubscription(), + notificationsapi.NotificationSubscription(), + ], + ), + 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_notification_subscriptions(request={}) + ).pages: + pages.append(page_) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +@pytest.mark.parametrize( + "request_type", + [ + notificationsapi.GetNotificationSubscriptionHealthMetricsRequest, + dict, + ], +) +def test_get_notification_subscription_health_metrics( + request_type, transport: str = "grpc" +): + client = NotificationsApiServiceClient( + 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.get_notification_subscription_health_metrics), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = notificationsapi.NotificationSubscriptionHealthMetrics( + name="name_value", + acknowledged_messages_count=2855, + undelivered_messages_count=2774, + oldest_unacknowledged_message_waiting_time=4441, + ) + response = client.get_notification_subscription_health_metrics(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = notificationsapi.GetNotificationSubscriptionHealthMetricsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, notificationsapi.NotificationSubscriptionHealthMetrics) + assert response.name == "name_value" + assert response.acknowledged_messages_count == 2855 + assert response.undelivered_messages_count == 2774 + assert response.oldest_unacknowledged_message_waiting_time == 4441 + + +def test_get_notification_subscription_health_metrics_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 = NotificationsApiServiceClient( + 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 = notificationsapi.GetNotificationSubscriptionHealthMetricsRequest( + name="name_value", + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_notification_subscription_health_metrics), "__call__" + ) as call: + call.return_value.name = ( + "foo" # operation_request.operation in compute client(s) expect a string. + ) + client.get_notification_subscription_health_metrics(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[ + 0 + ] == notificationsapi.GetNotificationSubscriptionHealthMetricsRequest( + name="name_value", + ) + + +def test_get_notification_subscription_health_metrics_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 = NotificationsApiServiceClient( + 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.get_notification_subscription_health_metrics + 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.get_notification_subscription_health_metrics + ] = mock_rpc + request = {} + client.get_notification_subscription_health_metrics(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_notification_subscription_health_metrics(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_get_notification_subscription_health_metrics_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 = NotificationsApiServiceAsyncClient( + 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.get_notification_subscription_health_metrics + 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.get_notification_subscription_health_metrics + ] = mock_rpc + + request = {} + await client.get_notification_subscription_health_metrics(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + await client.get_notification_subscription_health_metrics(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_get_notification_subscription_health_metrics_async( + transport: str = "grpc_asyncio", + request_type=notificationsapi.GetNotificationSubscriptionHealthMetricsRequest, +): + client = NotificationsApiServiceAsyncClient( + 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.get_notification_subscription_health_metrics), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.NotificationSubscriptionHealthMetrics( + name="name_value", + acknowledged_messages_count=2855, + undelivered_messages_count=2774, + oldest_unacknowledged_message_waiting_time=4441, + ) + ) + response = await client.get_notification_subscription_health_metrics(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = notificationsapi.GetNotificationSubscriptionHealthMetricsRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, notificationsapi.NotificationSubscriptionHealthMetrics) + assert response.name == "name_value" + assert response.acknowledged_messages_count == 2855 + assert response.undelivered_messages_count == 2774 + assert response.oldest_unacknowledged_message_waiting_time == 4441 + + +@pytest.mark.asyncio +async def test_get_notification_subscription_health_metrics_async_from_dict(): + await test_get_notification_subscription_health_metrics_async(request_type=dict) + + +def test_get_notification_subscription_health_metrics_field_headers(): + client = NotificationsApiServiceClient( + 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 = notificationsapi.GetNotificationSubscriptionHealthMetricsRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_notification_subscription_health_metrics), "__call__" + ) as call: + call.return_value = notificationsapi.NotificationSubscriptionHealthMetrics() + client.get_notification_subscription_health_metrics(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_get_notification_subscription_health_metrics_field_headers_async(): + client = NotificationsApiServiceAsyncClient( + 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 = notificationsapi.GetNotificationSubscriptionHealthMetricsRequest() + + request.name = "name_value" + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_notification_subscription_health_metrics), "__call__" + ) as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.NotificationSubscriptionHealthMetrics() + ) + await client.get_notification_subscription_health_metrics(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_get_notification_subscription_health_metrics_flattened(): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_notification_subscription_health_metrics), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = notificationsapi.NotificationSubscriptionHealthMetrics() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_notification_subscription_health_metrics( + 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_get_notification_subscription_health_metrics_flattened_error(): + client = NotificationsApiServiceClient( + 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.get_notification_subscription_health_metrics( + notificationsapi.GetNotificationSubscriptionHealthMetricsRequest(), + name="name_value", + ) + + +@pytest.mark.asyncio +async def test_get_notification_subscription_health_metrics_flattened_async(): + client = NotificationsApiServiceAsyncClient( + credentials=async_anonymous_credentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_notification_subscription_health_metrics), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = notificationsapi.NotificationSubscriptionHealthMetrics() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.NotificationSubscriptionHealthMetrics() + ) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_notification_subscription_health_metrics( + 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_get_notification_subscription_health_metrics_flattened_error_async(): + client = NotificationsApiServiceAsyncClient( + 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.get_notification_subscription_health_metrics( + notificationsapi.GetNotificationSubscriptionHealthMetricsRequest(), + name="name_value", + ) + + +def test_get_notification_subscription_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 = NotificationsApiServiceClient( + 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.get_notification_subscription + 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.get_notification_subscription + ] = mock_rpc + + request = {} + client.get_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_notification_subscription(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_get_notification_subscription_rest_required_fields( + request_type=notificationsapi.GetNotificationSubscriptionRequest, +): + transport_class = transports.NotificationsApiServiceRestTransport + + 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() + ).get_notification_subscription._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() + ).get_notification_subscription._get_unset_required_fields(jsonified_request) + 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 = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = notificationsapi.NotificationSubscription() + # 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 = notificationsapi.NotificationSubscription.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.get_notification_subscription(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_notification_subscription_rest_unset_required_fields(): + transport = transports.NotificationsApiServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_notification_subscription._get_unset_required_fields( + {} + ) + assert set(unset_fields) == (set(()) & set(("name",))) + + +def test_get_notification_subscription_rest_flattened(): + client = NotificationsApiServiceClient( + 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 = notificationsapi.NotificationSubscription() + + # get arguments that satisfy an http rule for this method + sample_request = {"name": "accounts/sample1/notificationsubscriptions/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 = notificationsapi.NotificationSubscription.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.get_notification_subscription(**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/notifications/v1/{name=accounts/*/notificationsubscriptions/*}" + % client.transport._host, + args[1], + ) + + +def test_get_notification_subscription_rest_flattened_error(transport: str = "rest"): + client = NotificationsApiServiceClient( + 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.get_notification_subscription( + notificationsapi.GetNotificationSubscriptionRequest(), + name="name_value", + ) + + +def test_create_notification_subscription_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 = NotificationsApiServiceClient( + 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.create_notification_subscription + 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.create_notification_subscription + ] = mock_rpc + + request = {} + client.create_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_notification_subscription(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_create_notification_subscription_rest_required_fields( + request_type=notificationsapi.CreateNotificationSubscriptionRequest, +): + transport_class = transports.NotificationsApiServiceRestTransport + + 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() + ).create_notification_subscription._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() + ).create_notification_subscription._get_unset_required_fields(jsonified_request) + 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 = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = notificationsapi.NotificationSubscription() + # 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 = notificationsapi.NotificationSubscription.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.create_notification_subscription(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_create_notification_subscription_rest_unset_required_fields(): + transport = transports.NotificationsApiServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = ( + transport.create_notification_subscription._get_unset_required_fields({}) + ) + assert set(unset_fields) == ( + set(()) + & set( + ( + "parent", + "notificationSubscription", + ) + ) + ) + + +def test_create_notification_subscription_rest_flattened(): + client = NotificationsApiServiceClient( + 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 = notificationsapi.NotificationSubscription() + + # 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", + notification_subscription=notificationsapi.NotificationSubscription( + all_managed_accounts=True + ), + ) + 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 = notificationsapi.NotificationSubscription.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.create_notification_subscription(**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/notifications/v1/{parent=accounts/*}/notificationsubscriptions" + % client.transport._host, + args[1], + ) + + +def test_create_notification_subscription_rest_flattened_error(transport: str = "rest"): + client = NotificationsApiServiceClient( + 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.create_notification_subscription( + notificationsapi.CreateNotificationSubscriptionRequest(), + parent="parent_value", + notification_subscription=notificationsapi.NotificationSubscription( + all_managed_accounts=True + ), + ) + + +def test_update_notification_subscription_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 = NotificationsApiServiceClient( + 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.update_notification_subscription + 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.update_notification_subscription + ] = mock_rpc + + request = {} + client.update_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_notification_subscription(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_update_notification_subscription_rest_required_fields( + request_type=notificationsapi.UpdateNotificationSubscriptionRequest, +): + transport_class = transports.NotificationsApiServiceRestTransport + + request_init = {} + 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() + ).update_notification_subscription._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_notification_subscription._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = notificationsapi.NotificationSubscription() + # 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": "patch", + "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 = notificationsapi.NotificationSubscription.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.update_notification_subscription(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_notification_subscription_rest_unset_required_fields(): + transport = transports.NotificationsApiServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = ( + transport.update_notification_subscription._get_unset_required_fields({}) + ) + assert set(unset_fields) == ( + set(("updateMask",)) & set(("notificationSubscription",)) + ) + + +def test_update_notification_subscription_rest_flattened(): + client = NotificationsApiServiceClient( + 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 = notificationsapi.NotificationSubscription() + + # get arguments that satisfy an http rule for this method + sample_request = { + "notification_subscription": { + "name": "accounts/sample1/notificationsubscriptions/sample2" + } + } + + # get truthy value for each flattened field + mock_args = dict( + notification_subscription=notificationsapi.NotificationSubscription( + all_managed_accounts=True + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_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 = notificationsapi.NotificationSubscription.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.update_notification_subscription(**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/notifications/v1/{notification_subscription.name=accounts/*/notificationsubscriptions/*}" + % client.transport._host, + args[1], + ) + + +def test_update_notification_subscription_rest_flattened_error(transport: str = "rest"): + client = NotificationsApiServiceClient( + 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.update_notification_subscription( + notificationsapi.UpdateNotificationSubscriptionRequest(), + notification_subscription=notificationsapi.NotificationSubscription( + all_managed_accounts=True + ), + update_mask=field_mask_pb2.FieldMask(paths=["paths_value"]), + ) + + +def test_delete_notification_subscription_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 = NotificationsApiServiceClient( + 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.delete_notification_subscription + 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.delete_notification_subscription + ] = mock_rpc + + request = {} + client.delete_notification_subscription(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.delete_notification_subscription(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_delete_notification_subscription_rest_required_fields( + request_type=notificationsapi.DeleteNotificationSubscriptionRequest, +): + transport_class = transports.NotificationsApiServiceRestTransport + + 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() + ).delete_notification_subscription._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() + ).delete_notification_subscription._get_unset_required_fields(jsonified_request) + 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 = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # 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": "delete", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_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.delete_notification_subscription(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_notification_subscription_rest_unset_required_fields(): + transport = transports.NotificationsApiServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = ( + transport.delete_notification_subscription._get_unset_required_fields({}) + ) + assert set(unset_fields) == (set(()) & set(("name",))) + + +def test_delete_notification_subscription_rest_flattened(): + client = NotificationsApiServiceClient( + 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 = None + + # get arguments that satisfy an http rule for this method + sample_request = {"name": "accounts/sample1/notificationsubscriptions/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 + json_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.delete_notification_subscription(**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/notifications/v1/{name=accounts/*/notificationsubscriptions/*}" + % client.transport._host, + args[1], + ) + + +def test_delete_notification_subscription_rest_flattened_error(transport: str = "rest"): + client = NotificationsApiServiceClient( + 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.delete_notification_subscription( + notificationsapi.DeleteNotificationSubscriptionRequest(), + name="name_value", + ) + + +def test_list_notification_subscriptions_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 = NotificationsApiServiceClient( + 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_notification_subscriptions + 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_notification_subscriptions + ] = mock_rpc + + request = {} + client.list_notification_subscriptions(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.list_notification_subscriptions(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_notification_subscriptions_rest_required_fields( + request_type=notificationsapi.ListNotificationSubscriptionsRequest, +): + transport_class = transports.NotificationsApiServiceRestTransport + + 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_notification_subscriptions._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_notification_subscriptions._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "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 = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = notificationsapi.ListNotificationSubscriptionsResponse() + # 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 = notificationsapi.ListNotificationSubscriptionsResponse.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_notification_subscriptions(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_notification_subscriptions_rest_unset_required_fields(): + transport = transports.NotificationsApiServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_notification_subscriptions._get_unset_required_fields( + {} + ) + assert set(unset_fields) == ( + set( + ( + "pageSize", + "pageToken", + ) + ) + & set(("parent",)) + ) + + +def test_list_notification_subscriptions_rest_flattened(): + client = NotificationsApiServiceClient( + 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 = notificationsapi.ListNotificationSubscriptionsResponse() + + # 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 = notificationsapi.ListNotificationSubscriptionsResponse.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_notification_subscriptions(**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/notifications/v1/{parent=accounts/*}/notificationsubscriptions" + % client.transport._host, + args[1], + ) + + +def test_list_notification_subscriptions_rest_flattened_error(transport: str = "rest"): + client = NotificationsApiServiceClient( + 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_notification_subscriptions( + notificationsapi.ListNotificationSubscriptionsRequest(), + parent="parent_value", + ) + + +def test_list_notification_subscriptions_rest_pager(transport: str = "rest"): + client = NotificationsApiServiceClient( + 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 = ( + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[ + notificationsapi.NotificationSubscription(), + notificationsapi.NotificationSubscription(), + notificationsapi.NotificationSubscription(), + ], + next_page_token="abc", + ), + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[], + next_page_token="def", + ), + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[ + notificationsapi.NotificationSubscription(), + ], + next_page_token="ghi", + ), + notificationsapi.ListNotificationSubscriptionsResponse( + notification_subscriptions=[ + notificationsapi.NotificationSubscription(), + notificationsapi.NotificationSubscription(), + ], + ), + ) + # Two responses for two calls + response = response + response + + # Wrap the values into proper Response objs + response = tuple( + notificationsapi.ListNotificationSubscriptionsResponse.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_notification_subscriptions(request=sample_request) + + results = list(pager) + assert len(results) == 6 + assert all( + isinstance(i, notificationsapi.NotificationSubscription) for i in results + ) + + pages = list( + client.list_notification_subscriptions(request=sample_request).pages + ) + for page_, token in zip(pages, ["abc", "def", "ghi", ""]): + assert page_.raw_page.next_page_token == token + + +def test_get_notification_subscription_health_metrics_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 = NotificationsApiServiceClient( + 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.get_notification_subscription_health_metrics + 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.get_notification_subscription_health_metrics + ] = mock_rpc + + request = {} + client.get_notification_subscription_health_metrics(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_notification_subscription_health_metrics(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_get_notification_subscription_health_metrics_rest_required_fields( + request_type=notificationsapi.GetNotificationSubscriptionHealthMetricsRequest, +): + transport_class = transports.NotificationsApiServiceRestTransport + + 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() + ).get_notification_subscription_health_metrics._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() + ).get_notification_subscription_health_metrics._get_unset_required_fields( + jsonified_request + ) + 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 = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = notificationsapi.NotificationSubscriptionHealthMetrics() + # 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 = notificationsapi.NotificationSubscriptionHealthMetrics.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.get_notification_subscription_health_metrics(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_notification_subscription_health_metrics_rest_unset_required_fields(): + transport = transports.NotificationsApiServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.get_notification_subscription_health_metrics._get_unset_required_fields( + {} + ) + assert set(unset_fields) == (set(()) & set(("name",))) + + +def test_get_notification_subscription_health_metrics_rest_flattened(): + client = NotificationsApiServiceClient( + 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 = notificationsapi.NotificationSubscriptionHealthMetrics() + + # get arguments that satisfy an http rule for this method + sample_request = {"name": "accounts/sample1/notificationsubscriptions/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 = notificationsapi.NotificationSubscriptionHealthMetrics.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.get_notification_subscription_health_metrics(**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/notifications/v1/{name=accounts/*/notificationsubscriptions/*}:getHealth" + % client.transport._host, + args[1], + ) + + +def test_get_notification_subscription_health_metrics_rest_flattened_error( + transport: str = "rest", +): + client = NotificationsApiServiceClient( + 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.get_notification_subscription_health_metrics( + notificationsapi.GetNotificationSubscriptionHealthMetricsRequest(), + name="name_value", + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.NotificationsApiServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.NotificationsApiServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = NotificationsApiServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.NotificationsApiServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = NotificationsApiServiceClient( + 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 = NotificationsApiServiceClient( + client_options=options, credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.NotificationsApiServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = NotificationsApiServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.NotificationsApiServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = NotificationsApiServiceClient(transport=transport) + assert client.transport is transport + + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.NotificationsApiServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.NotificationsApiServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.NotificationsApiServiceGrpcTransport, + transports.NotificationsApiServiceGrpcAsyncIOTransport, + transports.NotificationsApiServiceRestTransport, + ], +) +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 = NotificationsApiServiceClient.get_transport_class("grpc")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "grpc" + + +def test_initialize_client_w_grpc(): + client = NotificationsApiServiceClient( + 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_get_notification_subscription_empty_call_grpc(): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_notification_subscription), "__call__" + ) as call: + call.return_value = notificationsapi.NotificationSubscription() + client.get_notification_subscription(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = notificationsapi.GetNotificationSubscriptionRequest() + + 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_create_notification_subscription_empty_call_grpc(): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_notification_subscription), "__call__" + ) as call: + call.return_value = notificationsapi.NotificationSubscription() + client.create_notification_subscription(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = notificationsapi.CreateNotificationSubscriptionRequest() + + 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_update_notification_subscription_empty_call_grpc(): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_notification_subscription), "__call__" + ) as call: + call.return_value = notificationsapi.NotificationSubscription() + client.update_notification_subscription(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = notificationsapi.UpdateNotificationSubscriptionRequest() + + 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_delete_notification_subscription_empty_call_grpc(): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_notification_subscription), "__call__" + ) as call: + call.return_value = None + client.delete_notification_subscription(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = notificationsapi.DeleteNotificationSubscriptionRequest() + + 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_list_notification_subscriptions_empty_call_grpc(): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_notification_subscriptions), "__call__" + ) as call: + call.return_value = notificationsapi.ListNotificationSubscriptionsResponse() + client.list_notification_subscriptions(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = notificationsapi.ListNotificationSubscriptionsRequest() + + 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_get_notification_subscription_health_metrics_empty_call_grpc(): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_notification_subscription_health_metrics), "__call__" + ) as call: + call.return_value = notificationsapi.NotificationSubscriptionHealthMetrics() + client.get_notification_subscription_health_metrics(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = notificationsapi.GetNotificationSubscriptionHealthMetricsRequest() + + assert args[0] == request_msg + + +def test_transport_kind_grpc_asyncio(): + transport = NotificationsApiServiceAsyncClient.get_transport_class("grpc_asyncio")( + credentials=async_anonymous_credentials() + ) + assert transport.kind == "grpc_asyncio" + + +def test_initialize_client_w_grpc_asyncio(): + client = NotificationsApiServiceAsyncClient( + 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_get_notification_subscription_empty_call_grpc_asyncio(): + client = NotificationsApiServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.NotificationSubscription( + name="name_value", + registered_event=notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE, + call_back_uri="call_back_uri_value", + ) + ) + await client.get_notification_subscription(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = notificationsapi.GetNotificationSubscriptionRequest() + + 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_create_notification_subscription_empty_call_grpc_asyncio(): + client = NotificationsApiServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.NotificationSubscription( + name="name_value", + registered_event=notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE, + call_back_uri="call_back_uri_value", + ) + ) + await client.create_notification_subscription(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = notificationsapi.CreateNotificationSubscriptionRequest() + + 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_update_notification_subscription_empty_call_grpc_asyncio(): + client = NotificationsApiServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.NotificationSubscription( + name="name_value", + registered_event=notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE, + call_back_uri="call_back_uri_value", + ) + ) + await client.update_notification_subscription(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = notificationsapi.UpdateNotificationSubscriptionRequest() + + 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_delete_notification_subscription_empty_call_grpc_asyncio(): + client = NotificationsApiServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_notification_subscription), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_notification_subscription(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = notificationsapi.DeleteNotificationSubscriptionRequest() + + 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_list_notification_subscriptions_empty_call_grpc_asyncio(): + client = NotificationsApiServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_notification_subscriptions), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.ListNotificationSubscriptionsResponse( + next_page_token="next_page_token_value", + ) + ) + await client.list_notification_subscriptions(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = notificationsapi.ListNotificationSubscriptionsRequest() + + 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_get_notification_subscription_health_metrics_empty_call_grpc_asyncio(): + client = NotificationsApiServiceAsyncClient( + credentials=async_anonymous_credentials(), + transport="grpc_asyncio", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_notification_subscription_health_metrics), "__call__" + ) as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall( + notificationsapi.NotificationSubscriptionHealthMetrics( + name="name_value", + acknowledged_messages_count=2855, + undelivered_messages_count=2774, + oldest_unacknowledged_message_waiting_time=4441, + ) + ) + await client.get_notification_subscription_health_metrics(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = notificationsapi.GetNotificationSubscriptionHealthMetricsRequest() + + assert args[0] == request_msg + + +def test_transport_kind_rest(): + transport = NotificationsApiServiceClient.get_transport_class("rest")( + credentials=ga_credentials.AnonymousCredentials() + ) + assert transport.kind == "rest" + + +def test_get_notification_subscription_rest_bad_request( + request_type=notificationsapi.GetNotificationSubscriptionRequest, +): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {"name": "accounts/sample1/notificationsubscriptions/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.get_notification_subscription(request) + + +@pytest.mark.parametrize( + "request_type", + [ + notificationsapi.GetNotificationSubscriptionRequest, + dict, + ], +) +def test_get_notification_subscription_rest_call_success(request_type): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"name": "accounts/sample1/notificationsubscriptions/sample2"} + 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 = notificationsapi.NotificationSubscription( + name="name_value", + registered_event=notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE, + call_back_uri="call_back_uri_value", + all_managed_accounts=True, + ) + + # 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 = notificationsapi.NotificationSubscription.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.get_notification_subscription(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, notificationsapi.NotificationSubscription) + assert response.name == "name_value" + assert ( + response.registered_event + == notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE + ) + assert response.call_back_uri == "call_back_uri_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_notification_subscription_rest_interceptors(null_interceptor): + transport = transports.NotificationsApiServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.NotificationsApiServiceRestInterceptor(), + ) + client = NotificationsApiServiceClient(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.NotificationsApiServiceRestInterceptor, + "post_get_notification_subscription", + ) as post, mock.patch.object( + transports.NotificationsApiServiceRestInterceptor, + "post_get_notification_subscription_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.NotificationsApiServiceRestInterceptor, + "pre_get_notification_subscription", + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = notificationsapi.GetNotificationSubscriptionRequest.pb( + notificationsapi.GetNotificationSubscriptionRequest() + ) + 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 = notificationsapi.NotificationSubscription.to_json( + notificationsapi.NotificationSubscription() + ) + req.return_value.content = return_value + + request = notificationsapi.GetNotificationSubscriptionRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = notificationsapi.NotificationSubscription() + post_with_metadata.return_value = ( + notificationsapi.NotificationSubscription(), + metadata, + ) + + client.get_notification_subscription( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_create_notification_subscription_rest_bad_request( + request_type=notificationsapi.CreateNotificationSubscriptionRequest, +): + client = NotificationsApiServiceClient( + 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.create_notification_subscription(request) + + +@pytest.mark.parametrize( + "request_type", + [ + notificationsapi.CreateNotificationSubscriptionRequest, + dict, + ], +) +def test_create_notification_subscription_rest_call_success(request_type): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"parent": "accounts/sample1"} + request_init["notification_subscription"] = { + "all_managed_accounts": True, + "target_account": "target_account_value", + "name": "name_value", + "registered_event": 1, + "call_back_uri": "call_back_uri_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 = notificationsapi.CreateNotificationSubscriptionRequest.meta.fields[ + "notification_subscription" + ] + + 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[ + "notification_subscription" + ].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["notification_subscription"][field]) + ): + del request_init["notification_subscription"][field][i][subfield] + else: + del request_init["notification_subscription"][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 = notificationsapi.NotificationSubscription( + name="name_value", + registered_event=notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE, + call_back_uri="call_back_uri_value", + all_managed_accounts=True, + ) + + # 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 = notificationsapi.NotificationSubscription.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.create_notification_subscription(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, notificationsapi.NotificationSubscription) + assert response.name == "name_value" + assert ( + response.registered_event + == notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE + ) + assert response.call_back_uri == "call_back_uri_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_notification_subscription_rest_interceptors(null_interceptor): + transport = transports.NotificationsApiServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.NotificationsApiServiceRestInterceptor(), + ) + client = NotificationsApiServiceClient(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.NotificationsApiServiceRestInterceptor, + "post_create_notification_subscription", + ) as post, mock.patch.object( + transports.NotificationsApiServiceRestInterceptor, + "post_create_notification_subscription_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.NotificationsApiServiceRestInterceptor, + "pre_create_notification_subscription", + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = notificationsapi.CreateNotificationSubscriptionRequest.pb( + notificationsapi.CreateNotificationSubscriptionRequest() + ) + 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 = notificationsapi.NotificationSubscription.to_json( + notificationsapi.NotificationSubscription() + ) + req.return_value.content = return_value + + request = notificationsapi.CreateNotificationSubscriptionRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = notificationsapi.NotificationSubscription() + post_with_metadata.return_value = ( + notificationsapi.NotificationSubscription(), + metadata, + ) + + client.create_notification_subscription( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_update_notification_subscription_rest_bad_request( + request_type=notificationsapi.UpdateNotificationSubscriptionRequest, +): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = { + "notification_subscription": { + "name": "accounts/sample1/notificationsubscriptions/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.update_notification_subscription(request) + + +@pytest.mark.parametrize( + "request_type", + [ + notificationsapi.UpdateNotificationSubscriptionRequest, + dict, + ], +) +def test_update_notification_subscription_rest_call_success(request_type): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = { + "notification_subscription": { + "name": "accounts/sample1/notificationsubscriptions/sample2" + } + } + request_init["notification_subscription"] = { + "all_managed_accounts": True, + "target_account": "target_account_value", + "name": "accounts/sample1/notificationsubscriptions/sample2", + "registered_event": 1, + "call_back_uri": "call_back_uri_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 = notificationsapi.UpdateNotificationSubscriptionRequest.meta.fields[ + "notification_subscription" + ] + + 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[ + "notification_subscription" + ].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["notification_subscription"][field]) + ): + del request_init["notification_subscription"][field][i][subfield] + else: + del request_init["notification_subscription"][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 = notificationsapi.NotificationSubscription( + name="name_value", + registered_event=notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE, + call_back_uri="call_back_uri_value", + all_managed_accounts=True, + ) + + # 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 = notificationsapi.NotificationSubscription.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.update_notification_subscription(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, notificationsapi.NotificationSubscription) + assert response.name == "name_value" + assert ( + response.registered_event + == notificationsapi.NotificationSubscription.NotificationEventType.PRODUCT_STATUS_CHANGE + ) + assert response.call_back_uri == "call_back_uri_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_notification_subscription_rest_interceptors(null_interceptor): + transport = transports.NotificationsApiServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.NotificationsApiServiceRestInterceptor(), + ) + client = NotificationsApiServiceClient(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.NotificationsApiServiceRestInterceptor, + "post_update_notification_subscription", + ) as post, mock.patch.object( + transports.NotificationsApiServiceRestInterceptor, + "post_update_notification_subscription_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.NotificationsApiServiceRestInterceptor, + "pre_update_notification_subscription", + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = notificationsapi.UpdateNotificationSubscriptionRequest.pb( + notificationsapi.UpdateNotificationSubscriptionRequest() + ) + 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 = notificationsapi.NotificationSubscription.to_json( + notificationsapi.NotificationSubscription() + ) + req.return_value.content = return_value + + request = notificationsapi.UpdateNotificationSubscriptionRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = notificationsapi.NotificationSubscription() + post_with_metadata.return_value = ( + notificationsapi.NotificationSubscription(), + metadata, + ) + + client.update_notification_subscription( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_delete_notification_subscription_rest_bad_request( + request_type=notificationsapi.DeleteNotificationSubscriptionRequest, +): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {"name": "accounts/sample1/notificationsubscriptions/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.delete_notification_subscription(request) + + +@pytest.mark.parametrize( + "request_type", + [ + notificationsapi.DeleteNotificationSubscriptionRequest, + dict, + ], +) +def test_delete_notification_subscription_rest_call_success(request_type): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"name": "accounts/sample1/notificationsubscriptions/sample2"} + 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 = None + + # Wrap the value into a proper Response obj + response_value = mock.Mock() + response_value.status_code = 200 + json_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.delete_notification_subscription(request) + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_notification_subscription_rest_interceptors(null_interceptor): + transport = transports.NotificationsApiServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.NotificationsApiServiceRestInterceptor(), + ) + client = NotificationsApiServiceClient(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.NotificationsApiServiceRestInterceptor, + "pre_delete_notification_subscription", + ) as pre: + pre.assert_not_called() + pb_message = notificationsapi.DeleteNotificationSubscriptionRequest.pb( + notificationsapi.DeleteNotificationSubscriptionRequest() + ) + 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"} + + request = notificationsapi.DeleteNotificationSubscriptionRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_notification_subscription( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_list_notification_subscriptions_rest_bad_request( + request_type=notificationsapi.ListNotificationSubscriptionsRequest, +): + client = NotificationsApiServiceClient( + 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_notification_subscriptions(request) + + +@pytest.mark.parametrize( + "request_type", + [ + notificationsapi.ListNotificationSubscriptionsRequest, + dict, + ], +) +def test_list_notification_subscriptions_rest_call_success(request_type): + client = NotificationsApiServiceClient( + 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 = notificationsapi.ListNotificationSubscriptionsResponse( + 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 = notificationsapi.ListNotificationSubscriptionsResponse.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_notification_subscriptions(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, pagers.ListNotificationSubscriptionsPager) + assert response.next_page_token == "next_page_token_value" + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_notification_subscriptions_rest_interceptors(null_interceptor): + transport = transports.NotificationsApiServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.NotificationsApiServiceRestInterceptor(), + ) + client = NotificationsApiServiceClient(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.NotificationsApiServiceRestInterceptor, + "post_list_notification_subscriptions", + ) as post, mock.patch.object( + transports.NotificationsApiServiceRestInterceptor, + "post_list_notification_subscriptions_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.NotificationsApiServiceRestInterceptor, + "pre_list_notification_subscriptions", + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = notificationsapi.ListNotificationSubscriptionsRequest.pb( + notificationsapi.ListNotificationSubscriptionsRequest() + ) + 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 = notificationsapi.ListNotificationSubscriptionsResponse.to_json( + notificationsapi.ListNotificationSubscriptionsResponse() + ) + req.return_value.content = return_value + + request = notificationsapi.ListNotificationSubscriptionsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = notificationsapi.ListNotificationSubscriptionsResponse() + post_with_metadata.return_value = ( + notificationsapi.ListNotificationSubscriptionsResponse(), + metadata, + ) + + client.list_notification_subscriptions( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + post_with_metadata.assert_called_once() + + +def test_get_notification_subscription_health_metrics_rest_bad_request( + request_type=notificationsapi.GetNotificationSubscriptionHealthMetricsRequest, +): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + # send a request that will satisfy transcoding + request_init = {"name": "accounts/sample1/notificationsubscriptions/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.get_notification_subscription_health_metrics(request) + + +@pytest.mark.parametrize( + "request_type", + [ + notificationsapi.GetNotificationSubscriptionHealthMetricsRequest, + dict, + ], +) +def test_get_notification_subscription_health_metrics_rest_call_success(request_type): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + # send a request that will satisfy transcoding + request_init = {"name": "accounts/sample1/notificationsubscriptions/sample2"} + 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 = notificationsapi.NotificationSubscriptionHealthMetrics( + name="name_value", + acknowledged_messages_count=2855, + undelivered_messages_count=2774, + oldest_unacknowledged_message_waiting_time=4441, + ) + + # 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 = notificationsapi.NotificationSubscriptionHealthMetrics.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.get_notification_subscription_health_metrics(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, notificationsapi.NotificationSubscriptionHealthMetrics) + assert response.name == "name_value" + assert response.acknowledged_messages_count == 2855 + assert response.undelivered_messages_count == 2774 + assert response.oldest_unacknowledged_message_waiting_time == 4441 + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_notification_subscription_health_metrics_rest_interceptors( + null_interceptor, +): + transport = transports.NotificationsApiServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.NotificationsApiServiceRestInterceptor(), + ) + client = NotificationsApiServiceClient(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.NotificationsApiServiceRestInterceptor, + "post_get_notification_subscription_health_metrics", + ) as post, mock.patch.object( + transports.NotificationsApiServiceRestInterceptor, + "post_get_notification_subscription_health_metrics_with_metadata", + ) as post_with_metadata, mock.patch.object( + transports.NotificationsApiServiceRestInterceptor, + "pre_get_notification_subscription_health_metrics", + ) as pre: + pre.assert_not_called() + post.assert_not_called() + post_with_metadata.assert_not_called() + pb_message = ( + notificationsapi.GetNotificationSubscriptionHealthMetricsRequest.pb( + notificationsapi.GetNotificationSubscriptionHealthMetricsRequest() + ) + ) + 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 = notificationsapi.NotificationSubscriptionHealthMetrics.to_json( + notificationsapi.NotificationSubscriptionHealthMetrics() + ) + req.return_value.content = return_value + + request = notificationsapi.GetNotificationSubscriptionHealthMetricsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = notificationsapi.NotificationSubscriptionHealthMetrics() + post_with_metadata.return_value = ( + notificationsapi.NotificationSubscriptionHealthMetrics(), + metadata, + ) + + client.get_notification_subscription_health_metrics( + 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 = NotificationsApiServiceClient( + 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_get_notification_subscription_empty_call_rest(): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_notification_subscription), "__call__" + ) as call: + client.get_notification_subscription(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = notificationsapi.GetNotificationSubscriptionRequest() + + 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_create_notification_subscription_empty_call_rest(): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.create_notification_subscription), "__call__" + ) as call: + client.create_notification_subscription(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = notificationsapi.CreateNotificationSubscriptionRequest() + + 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_update_notification_subscription_empty_call_rest(): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.update_notification_subscription), "__call__" + ) as call: + client.update_notification_subscription(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = notificationsapi.UpdateNotificationSubscriptionRequest() + + 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_delete_notification_subscription_empty_call_rest(): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.delete_notification_subscription), "__call__" + ) as call: + client.delete_notification_subscription(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = notificationsapi.DeleteNotificationSubscriptionRequest() + + 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_list_notification_subscriptions_empty_call_rest(): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.list_notification_subscriptions), "__call__" + ) as call: + client.list_notification_subscriptions(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = notificationsapi.ListNotificationSubscriptionsRequest() + + 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_get_notification_subscription_health_metrics_empty_call_rest(): + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the actual call, and fake the request. + with mock.patch.object( + type(client.transport.get_notification_subscription_health_metrics), "__call__" + ) as call: + client.get_notification_subscription_health_metrics(request=None) + + # Establish that the underlying stub method was called. + call.assert_called() + _, args, _ = call.mock_calls[0] + request_msg = notificationsapi.GetNotificationSubscriptionHealthMetricsRequest() + + assert args[0] == request_msg + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.NotificationsApiServiceGrpcTransport, + ) + + +def test_notifications_api_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.NotificationsApiServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json", + ) + + +def test_notifications_api_service_base_transport(): + # Instantiate the base transport. + with mock.patch( + "google.shopping.merchant_notifications_v1.services.notifications_api_service.transports.NotificationsApiServiceTransport.__init__" + ) as Transport: + Transport.return_value = None + transport = transports.NotificationsApiServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + "get_notification_subscription", + "create_notification_subscription", + "update_notification_subscription", + "delete_notification_subscription", + "list_notification_subscriptions", + "get_notification_subscription_health_metrics", + ) + 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_notifications_api_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_notifications_v1.services.notifications_api_service.transports.NotificationsApiServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.NotificationsApiServiceTransport( + 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_notifications_api_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_notifications_v1.services.notifications_api_service.transports.NotificationsApiServiceTransport._prep_wrapped_messages" + ) as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.NotificationsApiServiceTransport() + adc.assert_called_once() + + +def test_notifications_api_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) + NotificationsApiServiceClient() + 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.NotificationsApiServiceGrpcTransport, + transports.NotificationsApiServiceGrpcAsyncIOTransport, + ], +) +def test_notifications_api_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.NotificationsApiServiceGrpcTransport, + transports.NotificationsApiServiceGrpcAsyncIOTransport, + transports.NotificationsApiServiceRestTransport, + ], +) +def test_notifications_api_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.NotificationsApiServiceGrpcTransport, grpc_helpers), + (transports.NotificationsApiServiceGrpcAsyncIOTransport, grpc_helpers_async), + ], +) +def test_notifications_api_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.NotificationsApiServiceGrpcTransport, + transports.NotificationsApiServiceGrpcAsyncIOTransport, + ], +) +def test_notifications_api_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_notifications_api_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.NotificationsApiServiceRestTransport( + 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_notifications_api_service_host_no_port(transport_name): + client = NotificationsApiServiceClient( + 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_notifications_api_service_host_with_port(transport_name): + client = NotificationsApiServiceClient( + 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_notifications_api_service_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = NotificationsApiServiceClient( + credentials=creds1, + transport=transport_name, + ) + client2 = NotificationsApiServiceClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.get_notification_subscription._session + session2 = client2.transport.get_notification_subscription._session + assert session1 != session2 + session1 = client1.transport.create_notification_subscription._session + session2 = client2.transport.create_notification_subscription._session + assert session1 != session2 + session1 = client1.transport.update_notification_subscription._session + session2 = client2.transport.update_notification_subscription._session + assert session1 != session2 + session1 = client1.transport.delete_notification_subscription._session + session2 = client2.transport.delete_notification_subscription._session + assert session1 != session2 + session1 = client1.transport.list_notification_subscriptions._session + session2 = client2.transport.list_notification_subscriptions._session + assert session1 != session2 + session1 = client1.transport.get_notification_subscription_health_metrics._session + session2 = client2.transport.get_notification_subscription_health_metrics._session + assert session1 != session2 + + +def test_notifications_api_service_grpc_transport_channel(): + channel = grpc.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.NotificationsApiServiceGrpcTransport( + 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_notifications_api_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel("http://localhost/", grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.NotificationsApiServiceGrpcAsyncIOTransport( + 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.NotificationsApiServiceGrpcTransport, + transports.NotificationsApiServiceGrpcAsyncIOTransport, + ], +) +def test_notifications_api_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.NotificationsApiServiceGrpcTransport, + transports.NotificationsApiServiceGrpcAsyncIOTransport, + ], +) +def test_notifications_api_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_notification_subscription_path(): + account = "squid" + notification_subscription = "clam" + expected = "accounts/{account}/notificationsubscriptions/{notification_subscription}".format( + account=account, + notification_subscription=notification_subscription, + ) + actual = NotificationsApiServiceClient.notification_subscription_path( + account, notification_subscription + ) + assert expected == actual + + +def test_parse_notification_subscription_path(): + expected = { + "account": "whelk", + "notification_subscription": "octopus", + } + path = NotificationsApiServiceClient.notification_subscription_path(**expected) + + # Check that the path construction is reversible. + actual = NotificationsApiServiceClient.parse_notification_subscription_path(path) + assert expected == actual + + +def test_notification_subscription_health_metrics_path(): + account = "oyster" + notification_subscription = "nudibranch" + expected = "accounts/{account}/notificationsubscriptions/{notification_subscription}".format( + account=account, + notification_subscription=notification_subscription, + ) + actual = ( + NotificationsApiServiceClient.notification_subscription_health_metrics_path( + account, notification_subscription + ) + ) + assert expected == actual + + +def test_parse_notification_subscription_health_metrics_path(): + expected = { + "account": "cuttlefish", + "notification_subscription": "mussel", + } + path = NotificationsApiServiceClient.notification_subscription_health_metrics_path( + **expected + ) + + # Check that the path construction is reversible. + actual = NotificationsApiServiceClient.parse_notification_subscription_health_metrics_path( + path + ) + assert expected == actual + + +def test_common_billing_account_path(): + billing_account = "winkle" + expected = "billingAccounts/{billing_account}".format( + billing_account=billing_account, + ) + actual = NotificationsApiServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "nautilus", + } + path = NotificationsApiServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = NotificationsApiServiceClient.parse_common_billing_account_path(path) + assert expected == actual + + +def test_common_folder_path(): + folder = "scallop" + expected = "folders/{folder}".format( + folder=folder, + ) + actual = NotificationsApiServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "abalone", + } + path = NotificationsApiServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = NotificationsApiServiceClient.parse_common_folder_path(path) + assert expected == actual + + +def test_common_organization_path(): + organization = "squid" + expected = "organizations/{organization}".format( + organization=organization, + ) + actual = NotificationsApiServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "clam", + } + path = NotificationsApiServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = NotificationsApiServiceClient.parse_common_organization_path(path) + assert expected == actual + + +def test_common_project_path(): + project = "whelk" + expected = "projects/{project}".format( + project=project, + ) + actual = NotificationsApiServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "octopus", + } + path = NotificationsApiServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = NotificationsApiServiceClient.parse_common_project_path(path) + assert expected == actual + + +def test_common_location_path(): + project = "oyster" + location = "nudibranch" + expected = "projects/{project}/locations/{location}".format( + project=project, + location=location, + ) + actual = NotificationsApiServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "cuttlefish", + "location": "mussel", + } + path = NotificationsApiServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = NotificationsApiServiceClient.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.NotificationsApiServiceTransport, "_prep_wrapped_messages" + ) as prep: + client = NotificationsApiServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object( + transports.NotificationsApiServiceTransport, "_prep_wrapped_messages" + ) as prep: + transport_class = NotificationsApiServiceClient.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 = NotificationsApiServiceClient( + 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 = NotificationsApiServiceAsyncClient( + 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 = NotificationsApiServiceClient( + 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 = NotificationsApiServiceClient( + 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", + [ + ( + NotificationsApiServiceClient, + transports.NotificationsApiServiceGrpcTransport, + ), + ( + NotificationsApiServiceAsyncClient, + transports.NotificationsApiServiceGrpcAsyncIOTransport, + ), + ], +) +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, + )