unit-openapi-python-sdk 0.18.0__py3-none-any.whl → 0.19.0__py3-none-any.whl

unit_finance_sdk/api/statements_api.py

@@ -0,0 +1,1310 @@
+"""
+    Unit API
+
+    JSON:API-compliant banking API.
+
+    The version of the OpenAPI document: 0.19.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, StrictBytes, StrictStr
+from typing import Optional, Tuple, Union
+from typing_extensions import Annotated
+from unit_finance_sdk.models.list_statements200_response import ListStatements200Response
+
+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 StatementsApi:
+    """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 get_bank_verification_pdf(
+        self,
+        account_id: StrictStr,
+        include_proof_of_funds: Annotated[Optional[StrictStr], Field(description="Optional. include customer proof of funds")] = 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,
+    ) -> bytes:
+        """Get a bank verification PDF
+
+        Customers may be required, for various reasons, to provide proof that they hold a bank account with a certain financial institution. This is typically provided by the bank in a letter called \"Bank verification letter\", which includes the customer, account and financial institution information. If the customer is required to prove availability of funds, the letter may also include the available balance on the account.
+
+        :param account_id: (required)
+        :type account_id: str
+        :param include_proof_of_funds: Optional. include customer proof of funds
+        :type include_proof_of_funds: 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._get_bank_verification_pdf_serialize(
+            account_id=account_id,
+            include_proof_of_funds=include_proof_of_funds,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "bytes",
+            '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 get_bank_verification_pdf_with_http_info(
+        self,
+        account_id: StrictStr,
+        include_proof_of_funds: Annotated[Optional[StrictStr], Field(description="Optional. include customer proof of funds")] = 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[bytes]:
+        """Get a bank verification PDF
+
+        Customers may be required, for various reasons, to provide proof that they hold a bank account with a certain financial institution. This is typically provided by the bank in a letter called \"Bank verification letter\", which includes the customer, account and financial institution information. If the customer is required to prove availability of funds, the letter may also include the available balance on the account.
+
+        :param account_id: (required)
+        :type account_id: str
+        :param include_proof_of_funds: Optional. include customer proof of funds
+        :type include_proof_of_funds: 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._get_bank_verification_pdf_serialize(
+            account_id=account_id,
+            include_proof_of_funds=include_proof_of_funds,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "bytes",
+            '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 get_bank_verification_pdf_without_preload_content(
+        self,
+        account_id: StrictStr,
+        include_proof_of_funds: Annotated[Optional[StrictStr], Field(description="Optional. include customer proof of funds")] = 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:
+        """Get a bank verification PDF
+
+        Customers may be required, for various reasons, to provide proof that they hold a bank account with a certain financial institution. This is typically provided by the bank in a letter called \"Bank verification letter\", which includes the customer, account and financial institution information. If the customer is required to prove availability of funds, the letter may also include the available balance on the account.
+
+        :param account_id: (required)
+        :type account_id: str
+        :param include_proof_of_funds: Optional. include customer proof of funds
+        :type include_proof_of_funds: 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._get_bank_verification_pdf_serialize(
+            account_id=account_id,
+            include_proof_of_funds=include_proof_of_funds,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "bytes",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_bank_verification_pdf_serialize(
+        self,
+        account_id,
+        include_proof_of_funds,
+        _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
+        if account_id is not None:
+            _path_params['accountId'] = account_id
+        # process the query parameters
+        if include_proof_of_funds is not None:
+            
+            _query_params.append(('includeProofOfFunds', include_proof_of_funds))
+            
+        # 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/pdf', 
+                    'application/vnd.api+json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/statements/{accountId}/bank/pdf',
+            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
+        )
+
+
+
+
+    @validate_call
+    def get_statement_html(
+        self,
+        id: StrictStr,
+        filter_customer_id: Annotated[Optional[StrictStr], Field(description="Optional. Verify that the statements belongs to the customer.")] = None,
+        language: Annotated[Optional[StrictStr], Field(description="Optional. Select the statement language. en - English, es - Spanish")] = 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,
+    ) -> str:
+        """Get a statement HTML
+
+        Get a statement HTML output by id.
+
+        :param id: (required)
+        :type id: str
+        :param filter_customer_id: Optional. Verify that the statements belongs to the customer.
+        :type filter_customer_id: str
+        :param language: Optional. Select the statement language. en - English, es - Spanish
+        :type language: 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._get_statement_html_serialize(
+            id=id,
+            filter_customer_id=filter_customer_id,
+            language=language,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "str",
+            '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 get_statement_html_with_http_info(
+        self,
+        id: StrictStr,
+        filter_customer_id: Annotated[Optional[StrictStr], Field(description="Optional. Verify that the statements belongs to the customer.")] = None,
+        language: Annotated[Optional[StrictStr], Field(description="Optional. Select the statement language. en - English, es - Spanish")] = 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[str]:
+        """Get a statement HTML
+
+        Get a statement HTML output by id.
+
+        :param id: (required)
+        :type id: str
+        :param filter_customer_id: Optional. Verify that the statements belongs to the customer.
+        :type filter_customer_id: str
+        :param language: Optional. Select the statement language. en - English, es - Spanish
+        :type language: 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._get_statement_html_serialize(
+            id=id,
+            filter_customer_id=filter_customer_id,
+            language=language,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "str",
+            '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 get_statement_html_without_preload_content(
+        self,
+        id: StrictStr,
+        filter_customer_id: Annotated[Optional[StrictStr], Field(description="Optional. Verify that the statements belongs to the customer.")] = None,
+        language: Annotated[Optional[StrictStr], Field(description="Optional. Select the statement language. en - English, es - Spanish")] = 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:
+        """Get a statement HTML
+
+        Get a statement HTML output by id.
+
+        :param id: (required)
+        :type id: str
+        :param filter_customer_id: Optional. Verify that the statements belongs to the customer.
+        :type filter_customer_id: str
+        :param language: Optional. Select the statement language. en - English, es - Spanish
+        :type language: 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._get_statement_html_serialize(
+            id=id,
+            filter_customer_id=filter_customer_id,
+            language=language,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "str",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_statement_html_serialize(
+        self,
+        id,
+        filter_customer_id,
+        language,
+        _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
+        if id is not None:
+            _path_params['id'] = id
+        # process the query parameters
+        if filter_customer_id is not None:
+            
+            _query_params.append(('filter[customerId]', filter_customer_id))
+            
+        if language is not None:
+            
+            _query_params.append(('language', language))
+            
+        # 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(
+                [
+                    'text/html', 
+                    'application/vnd.api+json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/statements/{id}/html',
+            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
+        )
+
+
+
+
+    @validate_call
+    def get_statement_pdf(
+        self,
+        id: StrictStr,
+        filter_customer_id: Annotated[Optional[StrictStr], Field(description="Optional. Verify that the statements belongs to the customer.")] = None,
+        language: Annotated[Optional[StrictStr], Field(description="Optional. Select the statement language. en - English, es - Spanish")] = 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,
+    ) -> bytes:
+        """Get a statement PDF
+
+        Get a statement PDF output by id.
+
+        :param id: (required)
+        :type id: str
+        :param filter_customer_id: Optional. Verify that the statements belongs to the customer.
+        :type filter_customer_id: str
+        :param language: Optional. Select the statement language. en - English, es - Spanish
+        :type language: 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._get_statement_pdf_serialize(
+            id=id,
+            filter_customer_id=filter_customer_id,
+            language=language,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "bytes",
+            '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 get_statement_pdf_with_http_info(
+        self,
+        id: StrictStr,
+        filter_customer_id: Annotated[Optional[StrictStr], Field(description="Optional. Verify that the statements belongs to the customer.")] = None,
+        language: Annotated[Optional[StrictStr], Field(description="Optional. Select the statement language. en - English, es - Spanish")] = 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[bytes]:
+        """Get a statement PDF
+
+        Get a statement PDF output by id.
+
+        :param id: (required)
+        :type id: str
+        :param filter_customer_id: Optional. Verify that the statements belongs to the customer.
+        :type filter_customer_id: str
+        :param language: Optional. Select the statement language. en - English, es - Spanish
+        :type language: 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._get_statement_pdf_serialize(
+            id=id,
+            filter_customer_id=filter_customer_id,
+            language=language,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "bytes",
+            '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 get_statement_pdf_without_preload_content(
+        self,
+        id: StrictStr,
+        filter_customer_id: Annotated[Optional[StrictStr], Field(description="Optional. Verify that the statements belongs to the customer.")] = None,
+        language: Annotated[Optional[StrictStr], Field(description="Optional. Select the statement language. en - English, es - Spanish")] = 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:
+        """Get a statement PDF
+
+        Get a statement PDF output by id.
+
+        :param id: (required)
+        :type id: str
+        :param filter_customer_id: Optional. Verify that the statements belongs to the customer.
+        :type filter_customer_id: str
+        :param language: Optional. Select the statement language. en - English, es - Spanish
+        :type language: 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._get_statement_pdf_serialize(
+            id=id,
+            filter_customer_id=filter_customer_id,
+            language=language,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "bytes",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_statement_pdf_serialize(
+        self,
+        id,
+        filter_customer_id,
+        language,
+        _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
+        if id is not None:
+            _path_params['id'] = id
+        # process the query parameters
+        if filter_customer_id is not None:
+            
+            _query_params.append(('filter[customerId]', filter_customer_id))
+            
+        if language is not None:
+            
+            _query_params.append(('language', language))
+            
+        # 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/pdf', 
+                    'application/vnd.api+json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/statements/{id}/pdf',
+            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
+        )
+
+
+
+
+    @validate_call
+    def list_statements(
+        self,
+        page_limit: Annotated[Optional[StrictStr], Field(description="Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.")] = None,
+        page_offset: Annotated[Optional[StrictStr], Field(description="Number of resources to skip. See Pagination.")] = None,
+        filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified account id.")] = None,
+        filter_account_ids: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified account ids. Usage example: *filter[accountIds][0]=10000&filter[accountIds][1]=10001*")] = None,
+        filter_customer_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified customer id.")] = None,
+        filter_period: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results for a specific month. e.g. 2021-01")] = None,
+        sort: Annotated[Optional[StrictStr], Field(description="Optional. Leave empty or provide sort=period for ascending order. Provide sort=-period (leading minus sign) for descending order.")] = 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,
+    ) -> ListStatements200Response:
+        """List statements
+
+        List statement resources. Filtering and paging can be applied.
+
+        :param page_limit: Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
+        :type page_limit: str
+        :param page_offset: Number of resources to skip. See Pagination.
+        :type page_offset: str
+        :param filter_account_id: Optional. Filters the results by the specified account id.
+        :type filter_account_id: str
+        :param filter_account_ids: Optional. Filters the results by the specified account ids. Usage example: *filter[accountIds][0]=10000&filter[accountIds][1]=10001*
+        :type filter_account_ids: str
+        :param filter_customer_id: Optional. Filters the results by the specified customer id.
+        :type filter_customer_id: str
+        :param filter_period: Optional. Filters the results for a specific month. e.g. 2021-01
+        :type filter_period: str
+        :param sort: Optional. Leave empty or provide sort=period for ascending order. Provide sort=-period (leading minus sign) for descending order.
+        :type sort: 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_statements_serialize(
+            page_limit=page_limit,
+            page_offset=page_offset,
+            filter_account_id=filter_account_id,
+            filter_account_ids=filter_account_ids,
+            filter_customer_id=filter_customer_id,
+            filter_period=filter_period,
+            sort=sort,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListStatements200Response",
+            '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_statements_with_http_info(
+        self,
+        page_limit: Annotated[Optional[StrictStr], Field(description="Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.")] = None,
+        page_offset: Annotated[Optional[StrictStr], Field(description="Number of resources to skip. See Pagination.")] = None,
+        filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified account id.")] = None,
+        filter_account_ids: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified account ids. Usage example: *filter[accountIds][0]=10000&filter[accountIds][1]=10001*")] = None,
+        filter_customer_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified customer id.")] = None,
+        filter_period: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results for a specific month. e.g. 2021-01")] = None,
+        sort: Annotated[Optional[StrictStr], Field(description="Optional. Leave empty or provide sort=period for ascending order. Provide sort=-period (leading minus sign) for descending order.")] = 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[ListStatements200Response]:
+        """List statements
+
+        List statement resources. Filtering and paging can be applied.
+
+        :param page_limit: Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
+        :type page_limit: str
+        :param page_offset: Number of resources to skip. See Pagination.
+        :type page_offset: str
+        :param filter_account_id: Optional. Filters the results by the specified account id.
+        :type filter_account_id: str
+        :param filter_account_ids: Optional. Filters the results by the specified account ids. Usage example: *filter[accountIds][0]=10000&filter[accountIds][1]=10001*
+        :type filter_account_ids: str
+        :param filter_customer_id: Optional. Filters the results by the specified customer id.
+        :type filter_customer_id: str
+        :param filter_period: Optional. Filters the results for a specific month. e.g. 2021-01
+        :type filter_period: str
+        :param sort: Optional. Leave empty or provide sort=period for ascending order. Provide sort=-period (leading minus sign) for descending order.
+        :type sort: 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_statements_serialize(
+            page_limit=page_limit,
+            page_offset=page_offset,
+            filter_account_id=filter_account_id,
+            filter_account_ids=filter_account_ids,
+            filter_customer_id=filter_customer_id,
+            filter_period=filter_period,
+            sort=sort,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListStatements200Response",
+            '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_statements_without_preload_content(
+        self,
+        page_limit: Annotated[Optional[StrictStr], Field(description="Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.")] = None,
+        page_offset: Annotated[Optional[StrictStr], Field(description="Number of resources to skip. See Pagination.")] = None,
+        filter_account_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified account id.")] = None,
+        filter_account_ids: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified account ids. Usage example: *filter[accountIds][0]=10000&filter[accountIds][1]=10001*")] = None,
+        filter_customer_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified customer id.")] = None,
+        filter_period: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results for a specific month. e.g. 2021-01")] = None,
+        sort: Annotated[Optional[StrictStr], Field(description="Optional. Leave empty or provide sort=period for ascending order. Provide sort=-period (leading minus sign) for descending order.")] = 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 statements
+
+        List statement resources. Filtering and paging can be applied.
+
+        :param page_limit: Maximum number of resources that will be returned. Maximum is 1000 resources. See Pagination.
+        :type page_limit: str
+        :param page_offset: Number of resources to skip. See Pagination.
+        :type page_offset: str
+        :param filter_account_id: Optional. Filters the results by the specified account id.
+        :type filter_account_id: str
+        :param filter_account_ids: Optional. Filters the results by the specified account ids. Usage example: *filter[accountIds][0]=10000&filter[accountIds][1]=10001*
+        :type filter_account_ids: str
+        :param filter_customer_id: Optional. Filters the results by the specified customer id.
+        :type filter_customer_id: str
+        :param filter_period: Optional. Filters the results for a specific month. e.g. 2021-01
+        :type filter_period: str
+        :param sort: Optional. Leave empty or provide sort=period for ascending order. Provide sort=-period (leading minus sign) for descending order.
+        :type sort: 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_statements_serialize(
+            page_limit=page_limit,
+            page_offset=page_offset,
+            filter_account_id=filter_account_id,
+            filter_account_ids=filter_account_ids,
+            filter_customer_id=filter_customer_id,
+            filter_period=filter_period,
+            sort=sort,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListStatements200Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _list_statements_serialize(
+        self,
+        page_limit,
+        page_offset,
+        filter_account_id,
+        filter_account_ids,
+        filter_customer_id,
+        filter_period,
+        sort,
+        _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 page_limit is not None:
+            
+            _query_params.append(('page[limit]', page_limit))
+            
+        if page_offset is not None:
+            
+            _query_params.append(('page[offset]', page_offset))
+            
+        if filter_account_id is not None:
+            
+            _query_params.append(('filter[accountId]', filter_account_id))
+            
+        if filter_account_ids is not None:
+            
+            _query_params.append(('filter[accountIds][]', filter_account_ids))
+            
+        if filter_customer_id is not None:
+            
+            _query_params.append(('filter[customerId]', filter_customer_id))
+            
+        if filter_period is not None:
+            
+            _query_params.append(('filter[period]', filter_period))
+            
+        if sort is not None:
+            
+            _query_params.append(('sort', sort))
+            
+        # 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='/statements',
+            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
+        )
+
+