def test_list_invoices(transport: str = 'grpc',
request_type=invoice_service.ListInvoicesRequest):
client = InvoiceServiceClient(
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_invoices),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = invoice_service.ListInvoicesResponse()
response = client.list_invoices(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == invoice_service.ListInvoicesRequest()
# Establish that the response is the type that we expect.
assert isinstance(response, invoice_service.ListInvoicesResponse)
def test_list_invoices_field_headers():
client = InvoiceServiceClient(
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 = invoice_service.ListInvoicesRequest()
request.customer_id = 'customer_id/value'
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client.transport.list_invoices),
'__call__') as call:
call.return_value = invoice_service.ListInvoicesResponse()
client.list_invoices(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',
'customer_id=customer_id/value',
) in kw['metadata']
def test_list_invoices_flattened_error():
client = InvoiceServiceClient(
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_invoices(
invoice_service.ListInvoicesRequest(),
customer_id='customer_id_value',
billing_setup='billing_setup_value',
issue_year='issue_year_value',
issue_month=month_of_year.MonthOfYearEnum.MonthOfYear.UNKNOWN,
)
def list_invoices(
self,
request: invoice_service.ListInvoicesRequest = None,
*,
customer_id: str = None,
billing_setup: str = None,
issue_year: str = None,
issue_month: month_of_year.MonthOfYearEnum.MonthOfYear = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> invoice_service.ListInvoicesResponse:
r"""Returns all invoices associated with a billing setup, for a
given month.
List of thrown errors: `AuthenticationError <>`__
`AuthorizationError <>`__ `FieldError <>`__ `HeaderError <>`__
`InternalError <>`__ `InvoiceError <>`__ `QuotaError <>`__
`RequestError <>`__
Args:
request (:class:`google.ads.googleads.v8.services.types.ListInvoicesRequest`):
The request object. Request message for fetching the
invoices of a given billing setup that were issued
during a given month.
customer_id (:class:`str`):
Required. The ID of the customer to
fetch invoices for.
This corresponds to the ``customer_id`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
billing_setup (:class:`str`):
Required. The billing setup resource name of the
requested invoices.
``customers/{customer_id}/billingSetups/{billing_setup_id}``
This corresponds to the ``billing_setup`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
issue_year (:class:`str`):
Required. The issue year to retrieve
invoices, in yyyy format. Only invoices
issued in 2019 or later can be
retrieved.
This corresponds to the ``issue_year`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
issue_month (:class:`google.ads.googleads.v8.enums.types.MonthOfYearEnum.MonthOfYear`):
Required. The issue month to retrieve
invoices.
This corresponds to the ``issue_month`` 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, str]]): Strings which should be
sent along with the request as metadata.
Returns:
google.ads.googleads.v8.services.types.ListInvoicesResponse:
Response message for
[InvoiceService.ListInvoices][google.ads.googleads.v8.services.InvoiceService.ListInvoices].
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
if request is not None and any(
[customer_id, billing_setup, issue_year, issue_month]):
raise ValueError('If the `request` argument is set, then none of '
'the individual field arguments should be set.')
# Minor optimization to avoid making a copy if the user passes
# in a invoice_service.ListInvoicesRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, invoice_service.ListInvoicesRequest):
request = invoice_service.ListInvoicesRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if customer_id is not None:
request.customer_id = customer_id
if billing_setup is not None:
request.billing_setup = billing_setup
if issue_year is not None:
request.issue_year = issue_year
if issue_month is not None:
request.issue_month = issue_month
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[self._transport.list_invoices]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(('customer_id', request.customer_id), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response