Get an agent Fetch a single agent the authenticated account owns, by full email address. :param email: The agent's full email address, e.g. support@acme.com. (required) :type email: str :param _request_timeout: timeout setting for this request. If one
(
self,
email: Annotated[StrictStr, Field(description="The agent's full email address, e.g. support@acme.com.")],
_request_timeout: Union[
None,
Annotated[StrictFloat, Field(gt=0)],
Tuple[
Annotated[StrictFloat, Field(gt=0)],
Annotated[StrictFloat, Field(gt=0)]
]
] = None,
_request_auth: Optional[Dict[StrictStr, Any]] = None,
_content_type: Optional[StrictStr] = None,
_headers: Optional[Dict[StrictStr, Any]] = None,
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
)
| 598 | |
| 599 | @validate_call |
| 600 | async def get_agent( |
| 601 | self, |
| 602 | email: Annotated[StrictStr, Field(description="The agent's full email address, e.g. support@acme.com.")], |
| 603 | _request_timeout: Union[ |
| 604 | None, |
| 605 | Annotated[StrictFloat, Field(gt=0)], |
| 606 | Tuple[ |
| 607 | Annotated[StrictFloat, Field(gt=0)], |
| 608 | Annotated[StrictFloat, Field(gt=0)] |
| 609 | ] |
| 610 | ] = None, |
| 611 | _request_auth: Optional[Dict[StrictStr, Any]] = None, |
| 612 | _content_type: Optional[StrictStr] = None, |
| 613 | _headers: Optional[Dict[StrictStr, Any]] = None, |
| 614 | _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, |
| 615 | ) -> AgentView: |
| 616 | """Get an agent |
| 617 | |
| 618 | Fetch a single agent the authenticated account owns, by full email address. |
| 619 | |
| 620 | :param email: The agent's full email address, e.g. support@acme.com. (required) |
| 621 | :type email: str |
| 622 | :param _request_timeout: timeout setting for this request. If one |
| 623 | number provided, it will be total request |
| 624 | timeout. It can also be a pair (tuple) of |
| 625 | (connection, read) timeouts. |
| 626 | :type _request_timeout: int, tuple(int, int), optional |
| 627 | :param _request_auth: set to override the auth_settings for an a single |
| 628 | request; this effectively ignores the |
| 629 | authentication in the spec for a single request. |
| 630 | :type _request_auth: dict, optional |
| 631 | :param _content_type: force content-type for the request. |
| 632 | :type _content_type: str, Optional |
| 633 | :param _headers: set to override the headers for a single |
| 634 | request; this effectively ignores the headers |
| 635 | in the spec for a single request. |
| 636 | :type _headers: dict, optional |
| 637 | :param _host_index: set to override the host_index for a single |
| 638 | request; this effectively ignores the host_index |
| 639 | in the spec for a single request. |
| 640 | :type _host_index: int, optional |
| 641 | :return: Returns the result object. |
| 642 | """ # noqa: E501 |
| 643 | |
| 644 | _param = self._get_agent_serialize( |
| 645 | email=email, |
| 646 | _request_auth=_request_auth, |
| 647 | _content_type=_content_type, |
| 648 | _headers=_headers, |
| 649 | _host_index=_host_index |
| 650 | ) |
| 651 | |
| 652 | _response_types_map: Dict[str, Optional[str]] = { |
| 653 | '200': "AgentView", |
| 654 | } |
| 655 | response_data = await self.api_client.call_api( |
| 656 | *_param, |
| 657 | _request_timeout=_request_timeout |
no test coverage detected