criteo-api-retailmedia-sdk 2024.4.0.241029__py3-none-any.whl → 2024.7.0.240731__py3-none-any.whl

{criteo_api_retailmedia_v2024_04 → criteo_api_retailmedia_v2024_07}/api/balance_api.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2024-04
+    The version of the OpenAPI document: 2024-07
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,8 +11,8 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2024_04.api_client import ApiClient, Endpoint as _Endpoint
-from criteo_api_retailmedia_v2024_04.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_07.api_client import ApiClient, Endpoint as _Endpoint
+from criteo_api_retailmedia_v2024_07.model_utils import (  # noqa: F401
     check_allowed_values,
     check_validations,
     date,
@@ -21,13 +21,14 @@ from criteo_api_retailmedia_v2024_04.model_utils import (  # noqa: F401
     none_type,
     validate_and_convert_types
 )
-from criteo_api_retailmedia_v2024_04.model.add_funds_to_balance_request import AddFundsToBalanceRequest
-from criteo_api_retailmedia_v2024_04.model.balance_campaign202110_paged_list_response import BalanceCampaign202110PagedListResponse
-from criteo_api_retailmedia_v2024_04.model.balance_response import BalanceResponse
-from criteo_api_retailmedia_v2024_04.model.balance_response_paged_list_response import BalanceResponsePagedListResponse
-from criteo_api_retailmedia_v2024_04.model.change_dates_of_balance_request import ChangeDatesOfBalanceRequest
-from criteo_api_retailmedia_v2024_04.model.create_balance_request import CreateBalanceRequest
-from criteo_api_retailmedia_v2024_04.model.update_balance_model_request import UpdateBalanceModelRequest
+from criteo_api_retailmedia_v2024_07.model.add_funds_to_balance_request import AddFundsToBalanceRequest
+from criteo_api_retailmedia_v2024_07.model.balance_campaign202110_paged_list_response import BalanceCampaign202110PagedListResponse
+from criteo_api_retailmedia_v2024_07.model.balance_response import BalanceResponse
+from criteo_api_retailmedia_v2024_07.model.balance_response_paged_list_response import BalanceResponsePagedListResponse
+from criteo_api_retailmedia_v2024_07.model.change_dates_of_balance_request import ChangeDatesOfBalanceRequest
+from criteo_api_retailmedia_v2024_07.model.create_balance_request import CreateBalanceRequest
+from criteo_api_retailmedia_v2024_07.model.page_of_balance_history_change_data_capture_v1 import PageOfBalanceHistoryChangeDataCaptureV1
+from criteo_api_retailmedia_v2024_07.model.update_balance_model_request import UpdateBalanceModelRequest
 
 
 class BalanceApi(object):
@@ -48,7 +49,7 @@ class BalanceApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2024-04/retail-media/balances/{balance-id}/campaigns',
+                'endpoint_path': '/2024-07/retail-media/balances/{balance-id}/campaigns',
                 'operation_id': 'get_api202110_external_balance_campaigns_by_balance_id',
                 'http_method': 'GET',
                 'servers': None,
@@ -116,7 +117,7 @@ class BalanceApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/balances',
+                'endpoint_path': '/2024-07/retail-media/accounts/{account-id}/balances',
                 'operation_id': 'get_api_v1_external_account_balances_by_account_id',
                 'http_method': 'GET',
                 'servers': None,
@@ -184,7 +185,7 @@ class BalanceApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/balances/{balanceId}',
+                'endpoint_path': '/2024-07/retail-media/accounts/{account-id}/balances/{balanceId}',
                 'operation_id': 'get_api_v1_external_account_by_account_id_and_balance_id',
                 'http_method': 'GET',
                 'servers': None,
@@ -235,6 +236,85 @@ class BalanceApi(object):
             },
             api_client=api_client
         )
+        self.get_balance_history_endpoint = _Endpoint(
+            settings={
+                'response_type': (PageOfBalanceHistoryChangeDataCaptureV1,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/2024-07/retail-media/balances/{balanceId}/history',
+                'operation_id': 'get_balance_history',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'balance_id',
+                    'offset',
+                    'limit',
+                    'limit_to_change_types',
+                ],
+                'required': [
+                    'balance_id',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                    'offset',
+                    'limit',
+                ]
+            },
+            root_map={
+                'validations': {
+                    ('offset',): {
+
+                        'inclusive_maximum': 2147483647,
+                        'inclusive_minimum': 0,
+                    },
+                    ('limit',): {
+
+                        'inclusive_maximum': 100,
+                        'inclusive_minimum': 1,
+                    },
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'balance_id':
+                        (str,),
+                    'offset':
+                        (int,),
+                    'limit':
+                        (int,),
+                    'limit_to_change_types':
+                        (str,),
+                },
+                'attribute_map': {
+                    'balance_id': 'balanceId',
+                    'offset': 'offset',
+                    'limit': 'limit',
+                    'limit_to_change_types': 'limitToChangeTypes',
+                },
+                'location_map': {
+                    'balance_id': 'path',
+                    'offset': 'query',
+                    'limit': 'query',
+                    'limit_to_change_types': 'query',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
         self.patch_api_v1_external_account_by_account_id_and_balance_id_endpoint = _Endpoint(
             settings={
                 'response_type': (BalanceResponse,),
@@ -242,7 +322,7 @@ class BalanceApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/balances/{balanceId}',
+                'endpoint_path': '/2024-07/retail-media/accounts/{account-id}/balances/{balanceId}',
                 'operation_id': 'patch_api_v1_external_account_by_account_id_and_balance_id',
                 'http_method': 'PATCH',
                 'servers': None,
@@ -306,7 +386,7 @@ class BalanceApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/balances/{balanceId}/add-funds',
+                'endpoint_path': '/2024-07/retail-media/accounts/{account-id}/balances/{balanceId}/add-funds',
                 'operation_id': 'post_api_v1_external_account_add_funds_by_account_id_and_balance_id',
                 'http_method': 'POST',
                 'servers': None,
@@ -370,7 +450,7 @@ class BalanceApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/balances',
+                'endpoint_path': '/2024-07/retail-media/accounts/{account-id}/balances',
                 'operation_id': 'post_api_v1_external_account_balances_by_account_id',
                 'http_method': 'POST',
                 'servers': None,
@@ -428,7 +508,7 @@ class BalanceApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2024-04/retail-media/accounts/{account-id}/balances/{balanceId}/change-dates',
+                'endpoint_path': '/2024-07/retail-media/accounts/{account-id}/balances/{balanceId}/change-dates',
                 'operation_id': 'post_api_v1_external_account_change_dates_by_account_id_and_balance_id',
                 'http_method': 'POST',
                 'servers': None,
@@ -745,6 +825,92 @@ class BalanceApi(object):
             balance_id
         return self.get_api_v1_external_account_by_account_id_and_balance_id_endpoint.call_with_http_info(**kwargs)
 
+    def get_balance_history(
+        self,
+        balance_id,
+        **kwargs
+    ):
+        """get_balance_history  # noqa: E501
+
+        Gets the balance's historical change data.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.get_balance_history(balance_id, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            balance_id (str): Balance id.
+
+        Keyword Args:
+            offset (int): The (zero-based) starting offset in the collection.. [optional] if omitted the server will use the default value of 0
+            limit (int): The number of elements to be returned.. [optional] if omitted the server will use the default value of 25
+            limit_to_change_types (str): Comma separated change types string that will be queried.. [optional]
+            _return_http_data_only (bool): response data without head status
+                code and headers. Default is True.
+            _preload_content (bool): if False, the urllib3.HTTPResponse object
+                will be returned without reading/decoding response data.
+                Default is True.
+            _request_timeout (int/float/tuple): 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.
+                Default is None.
+            _check_input_type (bool): specifies if type checking
+                should be done one the data sent to the server.
+                Default is True.
+            _check_return_type (bool): specifies if type checking
+                should be done one the data received from the server.
+                Default is True.
+            _spec_property_naming (bool): True if the variable names in the input data
+                are serialized names, as specified in the OpenAPI document.
+                False if the variable names in the input data
+                are pythonic names, e.g. snake case (default)
+            _content_type (str/None): force body content-type.
+                Default is None and content-type will be predicted by allowed
+                content-types and body.
+            _host_index (int/None): specifies the index of the server
+                that we want to use.
+                Default is read from the configuration.
+            _request_auths (list): set to override the auth_settings for an a single
+                request; this effectively ignores the authentication
+                in the spec for a single request.
+                Default is None
+            async_req (bool): execute request asynchronously
+
+        Returns:
+            PageOfBalanceHistoryChangeDataCaptureV1
+                If the method is called asynchronously, returns the request
+                thread.
+        """
+        kwargs['async_req'] = kwargs.get(
+            'async_req', False
+        )
+        kwargs['_return_http_data_only'] = kwargs.get(
+            '_return_http_data_only', True
+        )
+        kwargs['_preload_content'] = kwargs.get(
+            '_preload_content', True
+        )
+        kwargs['_request_timeout'] = kwargs.get(
+            '_request_timeout', None
+        )
+        kwargs['_check_input_type'] = kwargs.get(
+            '_check_input_type', True
+        )
+        kwargs['_check_return_type'] = kwargs.get(
+            '_check_return_type', True
+        )
+        kwargs['_spec_property_naming'] = kwargs.get(
+            '_spec_property_naming', False
+        )
+        kwargs['_content_type'] = kwargs.get(
+            '_content_type')
+        kwargs['_host_index'] = kwargs.get('_host_index')
+        kwargs['_request_auths'] = kwargs.get('_request_auths', None)
+        kwargs['balance_id'] = \
+            balance_id
+        return self.get_balance_history_endpoint.call_with_http_info(**kwargs)
+
     def patch_api_v1_external_account_by_account_id_and_balance_id(
         self,
         account_id,