criteo-api-retailmedia-sdk 2023.7.0.240618__tar.gz → 2023.7.0.240731__tar.gz

{criteo_api_retailmedia_sdk-2023.7.0.240618 → criteo_api_retailmedia_sdk-2023.7.0.240731}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: criteo-api-retailmedia-sdk
-Version: 2023.7.0.240618
+Version: 2023.7.0.240731
 Summary: Criteo API SDK
 Home-page: https://github.com/criteo/criteo-api-python-sdk
 Author: Criteo
@@ -26,9 +26,9 @@ IMPORTANT: This Python package links to Criteo production environment. Any test
 
 
 ```sh
-pip install criteo-api-retailmedia-sdk==2023.07.0.240618
+pip install criteo-api-retailmedia-sdk==2023.07.0.240731
 ```
-(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.07.0.240618`)
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.07.0.240731`)
 
 Then import the package:
 ```python

{criteo_api_retailmedia_sdk-2023.7.0.240618 → criteo_api_retailmedia_sdk-2023.7.0.240731}/README.md

@@ -8,7 +8,7 @@ More information: [https://developers.criteo.com/](https://developers.criteo.com
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- Package version: 2023.07.0.240618
+- Package version: 2023.07.0.240731
 
 ## Requirements
 
@@ -18,9 +18,9 @@ Python 2.7 and 3.5+
 ### pip install
 
 ```sh
-pip install criteo-api-retailmedia-sdk==2023.07.0.240618
+pip install criteo-api-retailmedia-sdk==2023.07.0.240731
 ```
-(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.07.0.240618`)
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.07.0.240731`)
 
 Then import the package:
 ```python

{criteo_api_retailmedia_sdk-2023.7.0.240618 → criteo_api_retailmedia_sdk-2023.7.0.240731}/criteo_api_retailmedia_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: criteo-api-retailmedia-sdk
-Version: 2023.7.0.240618
+Version: 2023.7.0.240731
 Summary: Criteo API SDK
 Home-page: https://github.com/criteo/criteo-api-python-sdk
 Author: Criteo
@@ -26,9 +26,9 @@ IMPORTANT: This Python package links to Criteo production environment. Any test
 
 
 ```sh
-pip install criteo-api-retailmedia-sdk==2023.07.0.240618
+pip install criteo-api-retailmedia-sdk==2023.07.0.240731
 ```
-(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.07.0.240618`)
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2023.07.0.240731`)
 
 Then import the package:
 ```python

{criteo_api_retailmedia_sdk-2023.7.0.240618 → criteo_api_retailmedia_sdk-2023.7.0.240731}/criteo_api_retailmedia_sdk.egg-info/SOURCES.txt

@@ -18,8 +18,10 @@ criteo_api_retailmedia_v2023_07/flow_constants.py
 criteo_api_retailmedia_v2023_07/model_utils.py
 criteo_api_retailmedia_v2023_07/rest.py
 criteo_api_retailmedia_v2023_07/api/__init__.py
+criteo_api_retailmedia_v2023_07/api/accounts_api.py
 criteo_api_retailmedia_v2023_07/api/analytics_api.py
 criteo_api_retailmedia_v2023_07/api/audience_api.py
+criteo_api_retailmedia_v2023_07/api/balance_api.py
 criteo_api_retailmedia_v2023_07/api/campaign_api.py
 criteo_api_retailmedia_v2023_07/api/gateway_api.py
 criteo_api_retailmedia_v2023_07/apis/__init__.py

{criteo_api_retailmedia_sdk-2023.7.0.240618 → criteo_api_retailmedia_sdk-2023.7.0.240731}/criteo_api_retailmedia_v2023_07/__init__.py

@@ -8,7 +8,7 @@
 """
 
 
-__version__ = "2023.07.0.240618"
+__version__ = "2023.07.0.240731"
 
 # import ApiClient
 from criteo_api_retailmedia_v2023_07.api_client import ApiClient

{criteo_api_retailmedia_sdk-2023.7.0.240618 → criteo_api_retailmedia_sdk-2023.7.0.240731}/criteo_api_retailmedia_v2023_07/api/__init__.py

@@ -1,3 +1,3 @@
 # do not import all apis into this module because that uses a lot of memory and stack frames
 # if you need the ability to import all apis from one package, import them with
-# from criteo_api_retailmedia_v2023_07.apis import AnalyticsApi
+# from criteo_api_retailmedia_v2023_07.apis import AccountsApi

criteo_api_retailmedia_sdk-2023.7.0.240731/criteo_api_retailmedia_v2023_07/api/accounts_api.py

@@ -0,0 +1,182 @@
+"""
+    Criteo API
+
+    Criteo API - RetailMedia  # noqa: E501
+
+    The version of the OpenAPI document: 2023-07
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from criteo_api_retailmedia_v2023_07.api_client import ApiClient, Endpoint as _Endpoint
+from criteo_api_retailmedia_v2023_07.model_utils import (  # noqa: F401
+    check_allowed_values,
+    check_validations,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_and_convert_types
+)
+from criteo_api_retailmedia_v2023_07.model.json_api_page_response_of_account import JsonApiPageResponseOfAccount
+
+
+class AccountsApi(object):
+    """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):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+        self.get_api_v1_external_accounts_endpoint = _Endpoint(
+            settings={
+                'response_type': (JsonApiPageResponseOfAccount,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/2023-07/retail-media/accounts',
+                'operation_id': 'get_api_v1_external_accounts',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'limit_to_id',
+                    'page_index',
+                    'page_size',
+                ],
+                'required': [],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'limit_to_id':
+                        ([str],),
+                    'page_index':
+                        (int,),
+                    'page_size':
+                        (int,),
+                },
+                'attribute_map': {
+                    'limit_to_id': 'limitToId',
+                    'page_index': 'pageIndex',
+                    'page_size': 'pageSize',
+                },
+                'location_map': {
+                    'limit_to_id': 'query',
+                    'page_index': 'query',
+                    'page_size': 'query',
+                },
+                'collection_format_map': {
+                    'limit_to_id': 'multi',
+                }
+            },
+            headers_map={
+                'accept': [
+                    'text/plain',
+                    'application/json',
+                    'text/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
+
+    def get_api_v1_external_accounts(
+        self,
+        **kwargs
+    ):
+        """get_api_v1_external_accounts  # noqa: E501
+
+        Gets page of account objects that the current user can access  # 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_api_v1_external_accounts(async_req=True)
+        >>> result = thread.get()
+
+
+        Keyword Args:
+            limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
+            page_index (int): The 0 indexed page index you would like to receive given the page size. [optional] if omitted the server will use the default value of 0
+            page_size (int): The maximum number of items you would like to receive in this request. [optional] if omitted the server will use the default value of 25
+            _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:
+            JsonApiPageResponseOfAccount
+                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)
+        return self.get_api_v1_external_accounts_endpoint.call_with_http_info(**kwargs)
+

criteo_api_retailmedia_sdk-2023.7.0.240731/criteo_api_retailmedia_v2023_07/api/balance_api.py

@@ -0,0 +1,347 @@
+"""
+    Criteo API
+
+    Criteo API - RetailMedia  # noqa: E501
+
+    The version of the OpenAPI document: 2023-07
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from criteo_api_retailmedia_v2023_07.api_client import ApiClient, Endpoint as _Endpoint
+from criteo_api_retailmedia_v2023_07.model_utils import (  # noqa: F401
+    check_allowed_values,
+    check_validations,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_and_convert_types
+)
+from criteo_api_retailmedia_v2023_07.model.balance202110_paged_list_response import Balance202110PagedListResponse
+from criteo_api_retailmedia_v2023_07.model.balance_campaign202110_paged_list_response import BalanceCampaign202110PagedListResponse
+
+
+class BalanceApi(object):
+    """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):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+        self.get_api202110_external_account_balances_by_account_id_endpoint = _Endpoint(
+            settings={
+                'response_type': (Balance202110PagedListResponse,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/2023-07/retail-media/accounts/{account-id}/balances',
+                'operation_id': 'get_api202110_external_account_balances_by_account_id',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'account_id',
+                    'limit_to_id',
+                    'page_index',
+                    'page_size',
+                ],
+                'required': [
+                    'account_id',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'account_id':
+                        (str,),
+                    'limit_to_id':
+                        ([str],),
+                    'page_index':
+                        (int,),
+                    'page_size':
+                        (int,),
+                },
+                'attribute_map': {
+                    'account_id': 'account-id',
+                    'limit_to_id': 'limitToId',
+                    'page_index': 'pageIndex',
+                    'page_size': 'pageSize',
+                },
+                'location_map': {
+                    'account_id': 'path',
+                    'limit_to_id': 'query',
+                    'page_index': 'query',
+                    'page_size': 'query',
+                },
+                'collection_format_map': {
+                    'limit_to_id': 'multi',
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
+        self.get_api202110_external_balance_campaigns_by_balance_id_endpoint = _Endpoint(
+            settings={
+                'response_type': (BalanceCampaign202110PagedListResponse,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/2023-07/retail-media/balances/{balance-id}/campaigns',
+                'operation_id': 'get_api202110_external_balance_campaigns_by_balance_id',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'balance_id',
+                    'limit_to_id',
+                    'page_index',
+                    'page_size',
+                ],
+                'required': [
+                    'balance_id',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'balance_id':
+                        (str,),
+                    'limit_to_id':
+                        ([str],),
+                    'page_index':
+                        (int,),
+                    'page_size':
+                        (int,),
+                },
+                'attribute_map': {
+                    'balance_id': 'balance-id',
+                    'limit_to_id': 'limitToId',
+                    'page_index': 'pageIndex',
+                    'page_size': 'pageSize',
+                },
+                'location_map': {
+                    'balance_id': 'path',
+                    'limit_to_id': 'query',
+                    'page_index': 'query',
+                    'page_size': 'query',
+                },
+                'collection_format_map': {
+                    'limit_to_id': 'multi',
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
+
+    def get_api202110_external_account_balances_by_account_id(
+        self,
+        account_id,
+        **kwargs
+    ):
+        """get_api202110_external_account_balances_by_account_id  # noqa: E501
+
+        Gets page of balance objects for the given account id  # 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_api202110_external_account_balances_by_account_id(account_id, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            account_id (str): The account to get balances for
+
+        Keyword Args:
+            limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
+            page_index (int): The 0 indexed page index you would like to receive given the page size. [optional]
+            page_size (int): The maximum number of items you would like to receive in this request. [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:
+            Balance202110PagedListResponse
+                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['account_id'] = \
+            account_id
+        return self.get_api202110_external_account_balances_by_account_id_endpoint.call_with_http_info(**kwargs)
+
+    def get_api202110_external_balance_campaigns_by_balance_id(
+        self,
+        balance_id,
+        **kwargs
+    ):
+        """get_api202110_external_balance_campaigns_by_balance_id  # noqa: E501
+
+        Gets page of campaigns for the given balanceId  # 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_api202110_external_balance_campaigns_by_balance_id(balance_id, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            balance_id (str): The balance to get campaigns from
+
+        Keyword Args:
+            limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
+            page_index (int): The 0 indexed page index you would like to receive given the page size. [optional]
+            page_size (int): The maximum number of items you would like to receive in this request. [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:
+            BalanceCampaign202110PagedListResponse
+                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_api202110_external_balance_campaigns_by_balance_id_endpoint.call_with_http_info(**kwargs)
+