unit-openapi-python-sdk 0.11.0__py3-none-any.whl → 0.16.0__py3-none-any.whl

unit_finance_sdk/api/cards_atm_locations_api.py

@@ -0,0 +1,361 @@
+"""
+    Unit API
+
+    JSON:API-compliant banking API.
+
+    The version of the OpenAPI document: 0.16.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictStr
+from typing import Optional
+from typing_extensions import Annotated
+from unit_finance_sdk.models.list_atm_locations200_response import ListAtmLocations200Response
+
+from unit_finance_sdk.api_client import ApiClient, RequestSerialized
+from unit_finance_sdk.api_response import ApiResponse
+from unit_finance_sdk.rest import RESTResponseType
+
+
+class CardsATMLocationsApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def list_atm_locations(
+        self,
+        filter_address: Annotated[Optional[StrictStr], Field(description="Filters the results by the specified address.")] = None,
+        filter_coordinates: Annotated[Optional[StrictStr], Field(description="Filters the results by the specified coordinates.")] = None,
+        filter_postal_code: Annotated[Optional[StrictStr], Field(description="Filters the results by the specified postal code.")] = None,
+        filter_search_radius: Annotated[Optional[StrictStr], Field(description="Filters the results by the search radius (in miles). Default and max values are 100.")] = None,
+        _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,
+    ) -> ListAtmLocations200Response:
+        """List ATM locations
+
+        List ATM locations by address, by coordinates, or by postal code.
+
+        :param filter_address: Filters the results by the specified address.
+        :type filter_address: str
+        :param filter_coordinates: Filters the results by the specified coordinates.
+        :type filter_coordinates: str
+        :param filter_postal_code: Filters the results by the specified postal code.
+        :type filter_postal_code: str
+        :param filter_search_radius: Filters the results by the search radius (in miles). Default and max values are 100.
+        :type filter_search_radius: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._list_atm_locations_serialize(
+            filter_address=filter_address,
+            filter_coordinates=filter_coordinates,
+            filter_postal_code=filter_postal_code,
+            filter_search_radius=filter_search_radius,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListAtmLocations200Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def list_atm_locations_with_http_info(
+        self,
+        filter_address: Annotated[Optional[StrictStr], Field(description="Filters the results by the specified address.")] = None,
+        filter_coordinates: Annotated[Optional[StrictStr], Field(description="Filters the results by the specified coordinates.")] = None,
+        filter_postal_code: Annotated[Optional[StrictStr], Field(description="Filters the results by the specified postal code.")] = None,
+        filter_search_radius: Annotated[Optional[StrictStr], Field(description="Filters the results by the search radius (in miles). Default and max values are 100.")] = None,
+        _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,
+    ) -> ApiResponse[ListAtmLocations200Response]:
+        """List ATM locations
+
+        List ATM locations by address, by coordinates, or by postal code.
+
+        :param filter_address: Filters the results by the specified address.
+        :type filter_address: str
+        :param filter_coordinates: Filters the results by the specified coordinates.
+        :type filter_coordinates: str
+        :param filter_postal_code: Filters the results by the specified postal code.
+        :type filter_postal_code: str
+        :param filter_search_radius: Filters the results by the search radius (in miles). Default and max values are 100.
+        :type filter_search_radius: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._list_atm_locations_serialize(
+            filter_address=filter_address,
+            filter_coordinates=filter_coordinates,
+            filter_postal_code=filter_postal_code,
+            filter_search_radius=filter_search_radius,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListAtmLocations200Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def list_atm_locations_without_preload_content(
+        self,
+        filter_address: Annotated[Optional[StrictStr], Field(description="Filters the results by the specified address.")] = None,
+        filter_coordinates: Annotated[Optional[StrictStr], Field(description="Filters the results by the specified coordinates.")] = None,
+        filter_postal_code: Annotated[Optional[StrictStr], Field(description="Filters the results by the specified postal code.")] = None,
+        filter_search_radius: Annotated[Optional[StrictStr], Field(description="Filters the results by the search radius (in miles). Default and max values are 100.")] = None,
+        _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,
+    ) -> RESTResponseType:
+        """List ATM locations
+
+        List ATM locations by address, by coordinates, or by postal code.
+
+        :param filter_address: Filters the results by the specified address.
+        :type filter_address: str
+        :param filter_coordinates: Filters the results by the specified coordinates.
+        :type filter_coordinates: str
+        :param filter_postal_code: Filters the results by the specified postal code.
+        :type filter_postal_code: str
+        :param filter_search_radius: Filters the results by the search radius (in miles). Default and max values are 100.
+        :type filter_search_radius: str
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._list_atm_locations_serialize(
+            filter_address=filter_address,
+            filter_coordinates=filter_coordinates,
+            filter_postal_code=filter_postal_code,
+            filter_search_radius=filter_search_radius,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListAtmLocations200Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _list_atm_locations_serialize(
+        self,
+        filter_address,
+        filter_coordinates,
+        filter_postal_code,
+        filter_search_radius,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if filter_address is not None:
+            
+            _query_params.append(('filter[address]', filter_address))
+            
+        if filter_coordinates is not None:
+            
+            _query_params.append(('filter[coordinates]', filter_coordinates))
+            
+        if filter_postal_code is not None:
+            
+            _query_params.append(('filter[postalCode]', filter_postal_code))
+            
+        if filter_search_radius is not None:
+            
+            _query_params.append(('filter[searchRadius]', filter_search_radius))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/vnd.api+json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/atm-locations',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+