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

unit_finance_sdk/api/rewards_api.py

@@ -0,0 +1,1087 @@
+"""
+    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, StrictStr
+from typing import Optional
+from typing_extensions import Annotated
+from unit_finance_sdk.models.create_reward201_response import CreateReward201Response
+from unit_finance_sdk.models.create_reward_request import CreateRewardRequest
+from unit_finance_sdk.models.get_reward200_response import GetReward200Response
+from unit_finance_sdk.models.list_rewards200_response import ListRewards200Response
+
+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 RewardsApi:
+    """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 create_reward(
+        self,
+        create_reward_request: CreateRewardRequest,
+        _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,
+    ) -> CreateReward201Response:
+        """Create a reward
+
+        Creates a reward resource.
+
+        :param create_reward_request: (required)
+        :type create_reward_request: CreateRewardRequest
+        :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._create_reward_serialize(
+            create_reward_request=create_reward_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "CreateReward201Response",
+            '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 create_reward_with_http_info(
+        self,
+        create_reward_request: CreateRewardRequest,
+        _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[CreateReward201Response]:
+        """Create a reward
+
+        Creates a reward resource.
+
+        :param create_reward_request: (required)
+        :type create_reward_request: CreateRewardRequest
+        :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._create_reward_serialize(
+            create_reward_request=create_reward_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "CreateReward201Response",
+            '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 create_reward_without_preload_content(
+        self,
+        create_reward_request: CreateRewardRequest,
+        _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:
+        """Create a reward
+
+        Creates a reward resource.
+
+        :param create_reward_request: (required)
+        :type create_reward_request: CreateRewardRequest
+        :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._create_reward_serialize(
+            create_reward_request=create_reward_request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '201': "CreateReward201Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _create_reward_serialize(
+        self,
+        create_reward_request,
+        _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
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+        if create_reward_request is not None:
+            _body_params = create_reward_request
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/vnd.api+json'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/vnd.api+json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/rewards',
+            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_reward(
+        self,
+        reward_id: StrictStr,
+        include: Annotated[Optional[StrictStr], Field(description="Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources")] = 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,
+    ) -> GetReward200Response:
+        """Get a reward by id
+
+        Get a reward by id.
+
+        :param reward_id: (required)
+        :type reward_id: str
+        :param include: Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources
+        :type include: 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_reward_serialize(
+            reward_id=reward_id,
+            include=include,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetReward200Response",
+            '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_reward_with_http_info(
+        self,
+        reward_id: StrictStr,
+        include: Annotated[Optional[StrictStr], Field(description="Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources")] = 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[GetReward200Response]:
+        """Get a reward by id
+
+        Get a reward by id.
+
+        :param reward_id: (required)
+        :type reward_id: str
+        :param include: Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources
+        :type include: 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_reward_serialize(
+            reward_id=reward_id,
+            include=include,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetReward200Response",
+            '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_reward_without_preload_content(
+        self,
+        reward_id: StrictStr,
+        include: Annotated[Optional[StrictStr], Field(description="Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources")] = 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 reward by id
+
+        Get a reward by id.
+
+        :param reward_id: (required)
+        :type reward_id: str
+        :param include: Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources
+        :type include: 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_reward_serialize(
+            reward_id=reward_id,
+            include=include,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "GetReward200Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _get_reward_serialize(
+        self,
+        reward_id,
+        include,
+        _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 reward_id is not None:
+            _path_params['rewardId'] = reward_id
+        # process the query parameters
+        if include is not None:
+            
+            _query_params.append(('include', include))
+            
+        # 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='/rewards/{rewardId}',
+            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_rewards(
+        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_transaction_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified transaction id.")] = None,
+        filter_rewarded_transaction_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified rewarded transaction id.")] = None,
+        filter_receiving_account_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified account id.")] = None,
+        filter_customer_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified customer id.")] = None,
+        filter_card_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified card id.")] = None,
+        filter_status: Annotated[Optional[StrictStr], Field(description="Optional. Filter by reward Status. Usage example: filter[status][0]=Rejected.")] = None,
+        filter_since: Annotated[Optional[StrictStr], Field(description="Optional. Filters the rewards that occurred *after* the specified date. e.g. 2020-01-13T16:01:19.346Z")] = None,
+        filter_until: Annotated[Optional[StrictStr], Field(description="Optional. Filters the rewards that occurred *before* the specified date. e.g. 2020-01-02T20:06:23.486Z")] = None,
+        filter_tags: Annotated[Optional[StrictStr], Field(description="Optional. Filter rewards by Tags.")] = None,
+        sort: Annotated[Optional[StrictStr], Field(description="Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.")] = None,
+        include: Annotated[Optional[StrictStr], Field(description="Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources")] = 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,
+    ) -> ListRewards200Response:
+        """List rewards
+
+        List rewards resources. Filtering, paging and sorting 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_transaction_id: Optional. Filters the results by the specified transaction id.
+        :type filter_transaction_id: str
+        :param filter_rewarded_transaction_id: Optional. Filters the results by the specified rewarded transaction id.
+        :type filter_rewarded_transaction_id: str
+        :param filter_receiving_account_id: Optional. Filters the results by the specified account id.
+        :type filter_receiving_account_id: str
+        :param filter_customer_id: Optional. Filters the results by the specified customer id.
+        :type filter_customer_id: str
+        :param filter_card_id: Optional. Filters the results by the specified card id.
+        :type filter_card_id: str
+        :param filter_status: Optional. Filter by reward Status. Usage example: filter[status][0]=Rejected.
+        :type filter_status: str
+        :param filter_since: Optional. Filters the rewards that occurred *after* the specified date. e.g. 2020-01-13T16:01:19.346Z
+        :type filter_since: str
+        :param filter_until: Optional. Filters the rewards that occurred *before* the specified date. e.g. 2020-01-02T20:06:23.486Z
+        :type filter_until: str
+        :param filter_tags: Optional. Filter rewards by Tags.
+        :type filter_tags: str
+        :param sort: Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.
+        :type sort: str
+        :param include: Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources
+        :type include: 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_rewards_serialize(
+            page_limit=page_limit,
+            page_offset=page_offset,
+            filter_transaction_id=filter_transaction_id,
+            filter_rewarded_transaction_id=filter_rewarded_transaction_id,
+            filter_receiving_account_id=filter_receiving_account_id,
+            filter_customer_id=filter_customer_id,
+            filter_card_id=filter_card_id,
+            filter_status=filter_status,
+            filter_since=filter_since,
+            filter_until=filter_until,
+            filter_tags=filter_tags,
+            sort=sort,
+            include=include,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListRewards200Response",
+            '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_rewards_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_transaction_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified transaction id.")] = None,
+        filter_rewarded_transaction_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified rewarded transaction id.")] = None,
+        filter_receiving_account_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified account id.")] = None,
+        filter_customer_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified customer id.")] = None,
+        filter_card_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified card id.")] = None,
+        filter_status: Annotated[Optional[StrictStr], Field(description="Optional. Filter by reward Status. Usage example: filter[status][0]=Rejected.")] = None,
+        filter_since: Annotated[Optional[StrictStr], Field(description="Optional. Filters the rewards that occurred *after* the specified date. e.g. 2020-01-13T16:01:19.346Z")] = None,
+        filter_until: Annotated[Optional[StrictStr], Field(description="Optional. Filters the rewards that occurred *before* the specified date. e.g. 2020-01-02T20:06:23.486Z")] = None,
+        filter_tags: Annotated[Optional[StrictStr], Field(description="Optional. Filter rewards by Tags.")] = None,
+        sort: Annotated[Optional[StrictStr], Field(description="Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.")] = None,
+        include: Annotated[Optional[StrictStr], Field(description="Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources")] = 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[ListRewards200Response]:
+        """List rewards
+
+        List rewards resources. Filtering, paging and sorting 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_transaction_id: Optional. Filters the results by the specified transaction id.
+        :type filter_transaction_id: str
+        :param filter_rewarded_transaction_id: Optional. Filters the results by the specified rewarded transaction id.
+        :type filter_rewarded_transaction_id: str
+        :param filter_receiving_account_id: Optional. Filters the results by the specified account id.
+        :type filter_receiving_account_id: str
+        :param filter_customer_id: Optional. Filters the results by the specified customer id.
+        :type filter_customer_id: str
+        :param filter_card_id: Optional. Filters the results by the specified card id.
+        :type filter_card_id: str
+        :param filter_status: Optional. Filter by reward Status. Usage example: filter[status][0]=Rejected.
+        :type filter_status: str
+        :param filter_since: Optional. Filters the rewards that occurred *after* the specified date. e.g. 2020-01-13T16:01:19.346Z
+        :type filter_since: str
+        :param filter_until: Optional. Filters the rewards that occurred *before* the specified date. e.g. 2020-01-02T20:06:23.486Z
+        :type filter_until: str
+        :param filter_tags: Optional. Filter rewards by Tags.
+        :type filter_tags: str
+        :param sort: Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.
+        :type sort: str
+        :param include: Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources
+        :type include: 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_rewards_serialize(
+            page_limit=page_limit,
+            page_offset=page_offset,
+            filter_transaction_id=filter_transaction_id,
+            filter_rewarded_transaction_id=filter_rewarded_transaction_id,
+            filter_receiving_account_id=filter_receiving_account_id,
+            filter_customer_id=filter_customer_id,
+            filter_card_id=filter_card_id,
+            filter_status=filter_status,
+            filter_since=filter_since,
+            filter_until=filter_until,
+            filter_tags=filter_tags,
+            sort=sort,
+            include=include,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListRewards200Response",
+            '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_rewards_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_transaction_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified transaction id.")] = None,
+        filter_rewarded_transaction_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified rewarded transaction id.")] = None,
+        filter_receiving_account_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified account id.")] = None,
+        filter_customer_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified customer id.")] = None,
+        filter_card_id: Annotated[Optional[StrictStr], Field(description="Optional. Filters the results by the specified card id.")] = None,
+        filter_status: Annotated[Optional[StrictStr], Field(description="Optional. Filter by reward Status. Usage example: filter[status][0]=Rejected.")] = None,
+        filter_since: Annotated[Optional[StrictStr], Field(description="Optional. Filters the rewards that occurred *after* the specified date. e.g. 2020-01-13T16:01:19.346Z")] = None,
+        filter_until: Annotated[Optional[StrictStr], Field(description="Optional. Filters the rewards that occurred *before* the specified date. e.g. 2020-01-02T20:06:23.486Z")] = None,
+        filter_tags: Annotated[Optional[StrictStr], Field(description="Optional. Filter rewards by Tags.")] = None,
+        sort: Annotated[Optional[StrictStr], Field(description="Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.")] = None,
+        include: Annotated[Optional[StrictStr], Field(description="Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources")] = 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 rewards
+
+        List rewards resources. Filtering, paging and sorting 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_transaction_id: Optional. Filters the results by the specified transaction id.
+        :type filter_transaction_id: str
+        :param filter_rewarded_transaction_id: Optional. Filters the results by the specified rewarded transaction id.
+        :type filter_rewarded_transaction_id: str
+        :param filter_receiving_account_id: Optional. Filters the results by the specified account id.
+        :type filter_receiving_account_id: str
+        :param filter_customer_id: Optional. Filters the results by the specified customer id.
+        :type filter_customer_id: str
+        :param filter_card_id: Optional. Filters the results by the specified card id.
+        :type filter_card_id: str
+        :param filter_status: Optional. Filter by reward Status. Usage example: filter[status][0]=Rejected.
+        :type filter_status: str
+        :param filter_since: Optional. Filters the rewards that occurred *after* the specified date. e.g. 2020-01-13T16:01:19.346Z
+        :type filter_since: str
+        :param filter_until: Optional. Filters the rewards that occurred *before* the specified date. e.g. 2020-01-02T20:06:23.486Z
+        :type filter_until: str
+        :param filter_tags: Optional. Filter rewards by Tags.
+        :type filter_tags: str
+        :param sort: Optional. Leave empty or provide sort=createdAt for ascending order. Provide sort=-createdAt (leading minus sign) for descending order.
+        :type sort: str
+        :param include: Optional. A comma-separated list of related resources to include in the response. Related resources include: customer, account, transaction. See Getting Related Resources
+        :type include: 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_rewards_serialize(
+            page_limit=page_limit,
+            page_offset=page_offset,
+            filter_transaction_id=filter_transaction_id,
+            filter_rewarded_transaction_id=filter_rewarded_transaction_id,
+            filter_receiving_account_id=filter_receiving_account_id,
+            filter_customer_id=filter_customer_id,
+            filter_card_id=filter_card_id,
+            filter_status=filter_status,
+            filter_since=filter_since,
+            filter_until=filter_until,
+            filter_tags=filter_tags,
+            sort=sort,
+            include=include,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "ListRewards200Response",
+            '400': "ErrorDocument",
+            '401': "ErrorDocument",
+            '404': "ErrorDocument",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _list_rewards_serialize(
+        self,
+        page_limit,
+        page_offset,
+        filter_transaction_id,
+        filter_rewarded_transaction_id,
+        filter_receiving_account_id,
+        filter_customer_id,
+        filter_card_id,
+        filter_status,
+        filter_since,
+        filter_until,
+        filter_tags,
+        sort,
+        include,
+        _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_transaction_id is not None:
+            
+            _query_params.append(('filter[transactionId]', filter_transaction_id))
+            
+        if filter_rewarded_transaction_id is not None:
+            
+            _query_params.append(('filter[rewardedTransactionId]', filter_rewarded_transaction_id))
+            
+        if filter_receiving_account_id is not None:
+            
+            _query_params.append(('filter[receivingAccountId]', filter_receiving_account_id))
+            
+        if filter_customer_id is not None:
+            
+            _query_params.append(('filter[customerId]', filter_customer_id))
+            
+        if filter_card_id is not None:
+            
+            _query_params.append(('filter[cardId]', filter_card_id))
+            
+        if filter_status is not None:
+            
+            _query_params.append(('filter[status]', filter_status))
+            
+        if filter_since is not None:
+            
+            _query_params.append(('filter[since]', filter_since))
+            
+        if filter_until is not None:
+            
+            _query_params.append(('filter[until]', filter_until))
+            
+        if filter_tags is not None:
+            
+            _query_params.append(('filter[tags]', filter_tags))
+            
+        if sort is not None:
+            
+            _query_params.append(('sort', sort))
+            
+        if include is not None:
+            
+            _query_params.append(('include', include))
+            
+        # 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='/rewards',
+            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
+        )
+
+