criteo-api-retailmedia-sdk 2023.4.0.240118__py3-none-any.whl → 2023.4.0.240404__py3-none-any.whl

criteo_api_retailmedia_v2023_04/api/audience_api.py

@@ -21,13 +21,12 @@ from criteo_api_retailmedia_v2023_04.model_utils import (  # noqa: F401
     none_type,
     validate_and_convert_types
 )
-from criteo_api_retailmedia_v2023_04.model.common_status_code_response import CommonStatusCodeResponse
-from criteo_api_retailmedia_v2023_04.model.create_retail_media_audience_request import CreateRetailMediaAudienceRequest
-from criteo_api_retailmedia_v2023_04.model.create_retail_media_audience_response import CreateRetailMediaAudienceResponse
-from criteo_api_retailmedia_v2023_04.model.create_retail_media_audience_v2_request import CreateRetailMediaAudienceV2Request
-from criteo_api_retailmedia_v2023_04.model.get_page_of_audiences_by_account_id_response import GetPageOfAudiencesByAccountIdResponse
-from criteo_api_retailmedia_v2023_04.model.retail_media_audience_v2_list_response import RetailMediaAudienceV2ListResponse
-from criteo_api_retailmedia_v2023_04.model.retail_media_audience_v2_response import RetailMediaAudienceV2Response
+from criteo_api_retailmedia_v2023_04.model.rm_legacy_audience_create_entity_v1_response import RmLegacyAudienceCreateEntityV1Response
+from criteo_api_retailmedia_v2023_04.model.rm_legacy_audience_create_entity_v2_response import RmLegacyAudienceCreateEntityV2Response
+from criteo_api_retailmedia_v2023_04.model.rm_legacy_audience_create_input_entity_v1 import RmLegacyAudienceCreateInputEntityV1
+from criteo_api_retailmedia_v2023_04.model.rm_legacy_audience_create_input_entity_v2 import RmLegacyAudienceCreateInputEntityV2
+from criteo_api_retailmedia_v2023_04.model.rm_legacy_audience_get_entity_v1_list_response import RmLegacyAudienceGetEntityV1ListResponse
+from criteo_api_retailmedia_v2023_04.model.rm_legacy_audience_get_entity_v2_list_response import RmLegacyAudienceGetEntityV2ListResponse
 
 
 class AudienceApi(object):
@@ -41,26 +40,26 @@ class AudienceApi(object):
         if api_client is None:
             api_client = ApiClient()
         self.api_client = api_client
-        self.create_audience_endpoint = _Endpoint(
+        self.legacy_create_audience_v1_endpoint = _Endpoint(
             settings={
-                'response_type': (CreateRetailMediaAudienceResponse,),
+                'response_type': (RmLegacyAudienceCreateEntityV1Response,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
                 'endpoint_path': '/2023-04/retail-media/accounts/{accountId}/audiences',
-                'operation_id': 'create_audience',
+                'operation_id': 'legacy_create_audience_v1',
                 'http_method': 'POST',
                 'servers': None,
             },
             params_map={
                 'all': [
                     'account_id',
-                    'create_retail_media_audience_request',
+                    'rm_legacy_audience_create_input_entity_v1',
                 ],
                 'required': [
                     'account_id',
-                    'create_retail_media_audience_request',
+                    'rm_legacy_audience_create_input_entity_v1',
                 ],
                 'nullable': [
                 ],
@@ -77,49 +76,55 @@ class AudienceApi(object):
                 'openapi_types': {
                     'account_id':
                         (int,),
-                    'create_retail_media_audience_request':
-                        (CreateRetailMediaAudienceRequest,),
+                    'rm_legacy_audience_create_input_entity_v1':
+                        (RmLegacyAudienceCreateInputEntityV1,),
                 },
                 'attribute_map': {
                     'account_id': 'accountId',
                 },
                 'location_map': {
                     'account_id': 'path',
-                    'create_retail_media_audience_request': 'body',
+                    'rm_legacy_audience_create_input_entity_v1': 'body',
                 },
                 'collection_format_map': {
                 }
             },
             headers_map={
                 'accept': [
-                    'application/json'
+                    'text/plain',
+                    'application/json',
+                    'text/json'
                 ],
                 'content_type': [
-                    'application/json'
+                    'application/json-patch+json',
+                    'application/json',
+                    'text/json',
+                    'application/*+json'
                 ]
             },
             api_client=api_client
         )
-        self.create_retail_media_audience_v2_endpoint = _Endpoint(
+        self.legacy_get_audience_v1_endpoint = _Endpoint(
             settings={
-                'response_type': (RetailMediaAudienceV2Response,),
+                'response_type': (RmLegacyAudienceGetEntityV1ListResponse,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2023-04/retail-media/v2/accounts/{accountId}/audiences',
-                'operation_id': 'create_retail_media_audience_v2',
-                'http_method': 'POST',
+                'endpoint_path': '/2023-04/retail-media/accounts/{accountId}/audiences',
+                'operation_id': 'legacy_get_audience_v1',
+                'http_method': 'GET',
                 'servers': None,
             },
             params_map={
                 'all': [
                     'account_id',
-                    'create_retail_media_audience_v2_request',
+                    'limit_to_id',
+                    'page_size',
+                    'page_index',
                 ],
                 'required': [
                     'account_id',
-                    'create_retail_media_audience_v2_request',
                 ],
                 'nullable': [
                 ],
@@ -136,38 +141,48 @@ class AudienceApi(object):
                 'openapi_types': {
                     'account_id':
                         (int,),
-                    'create_retail_media_audience_v2_request':
-                        (CreateRetailMediaAudienceV2Request,),
+                    'limit_to_id':
+                        ([int],),
+                    'page_size':
+                        (int,),
+                    'page_index':
+                        (int,),
                 },
                 'attribute_map': {
                     'account_id': 'accountId',
+                    'limit_to_id': 'limitToId',
+                    'page_size': 'pageSize',
+                    'page_index': 'pageIndex',
                 },
                 'location_map': {
                     'account_id': 'path',
-                    'create_retail_media_audience_v2_request': 'body',
+                    'limit_to_id': 'query',
+                    'page_size': 'query',
+                    'page_index': 'query',
                 },
                 'collection_format_map': {
+                    'limit_to_id': 'multi',
                 }
             },
             headers_map={
                 'accept': [
-                    'application/json'
+                    'text/plain',
+                    'application/json',
+                    'text/json'
                 ],
-                'content_type': [
-                    'application/json'
-                ]
+                'content_type': [],
             },
             api_client=api_client
         )
-        self.get_audiences_by_account_id_endpoint = _Endpoint(
+        self.legacy_get_audience_v2_endpoint = _Endpoint(
             settings={
-                'response_type': (GetPageOfAudiencesByAccountIdResponse,),
+                'response_type': (RmLegacyAudienceGetEntityV2ListResponse,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2023-04/retail-media/accounts/{accountId}/audiences',
-                'operation_id': 'get_audiences_by_account_id',
+                'endpoint_path': '/2023-04/retail-media/v2/accounts/{accountId}/audiences',
+                'operation_id': 'legacy_get_audience_v2',
                 'http_method': 'GET',
                 'servers': None,
             },
@@ -195,9 +210,9 @@ class AudienceApi(object):
                 },
                 'openapi_types': {
                     'account_id':
-                        (str,),
+                        (int,),
                     'limit_to_id':
-                        ([str],),
+                        ([int],),
                     'page_size':
                         (int,),
                     'page_index':
@@ -221,33 +236,34 @@ class AudienceApi(object):
             },
             headers_map={
                 'accept': [
-                    'application/json'
+                    'text/plain',
+                    'application/json',
+                    'text/json'
                 ],
                 'content_type': [],
             },
             api_client=api_client
         )
-        self.get_retail_media_audience_v2_list_by_account_id_endpoint = _Endpoint(
+        self.legacy_update_audience_v2_endpoint = _Endpoint(
             settings={
-                'response_type': (RetailMediaAudienceV2ListResponse,),
+                'response_type': (RmLegacyAudienceCreateEntityV2Response,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
                 'endpoint_path': '/2023-04/retail-media/v2/accounts/{accountId}/audiences',
-                'operation_id': 'get_retail_media_audience_v2_list_by_account_id',
-                'http_method': 'GET',
+                'operation_id': 'legacy_update_audience_v2',
+                'http_method': 'POST',
                 'servers': None,
             },
             params_map={
                 'all': [
                     'account_id',
-                    'limit_to_id',
-                    'page_size',
-                    'page_index',
+                    'rm_legacy_audience_create_input_entity_v2',
                 ],
                 'required': [
                     'account_id',
+                    'rm_legacy_audience_create_input_entity_v2',
                 ],
                 'nullable': [
                 ],
@@ -264,56 +280,53 @@ class AudienceApi(object):
                 'openapi_types': {
                     'account_id':
                         (int,),
-                    'limit_to_id':
-                        ([int],),
-                    'page_size':
-                        (int,),
-                    'page_index':
-                        (int,),
+                    'rm_legacy_audience_create_input_entity_v2':
+                        (RmLegacyAudienceCreateInputEntityV2,),
                 },
                 'attribute_map': {
                     'account_id': 'accountId',
-                    'limit_to_id': 'limitToId',
-                    'page_size': 'pageSize',
-                    'page_index': 'pageIndex',
                 },
                 'location_map': {
                     'account_id': 'path',
-                    'limit_to_id': 'query',
-                    'page_size': 'query',
-                    'page_index': 'query',
+                    'rm_legacy_audience_create_input_entity_v2': 'body',
                 },
                 'collection_format_map': {
-                    'limit_to_id': 'multi',
                 }
             },
             headers_map={
                 'accept': [
-                    'application/json'
+                    'text/plain',
+                    'application/json',
+                    'text/json'
                 ],
-                'content_type': [],
+                'content_type': [
+                    'application/json-patch+json',
+                    'application/json',
+                    'text/json',
+                    'application/*+json'
+                ]
             },
             api_client=api_client
         )
 
-    def create_audience(
+    def legacy_create_audience_v1(
         self,
         account_id,
-        create_retail_media_audience_request,
+        rm_legacy_audience_create_input_entity_v1,
         **kwargs
     ):
-        """create_audience  # noqa: E501
+        """legacy_create_audience_v1  # noqa: E501
 
-        Create an audience for a given account ID  # noqa: E501
+        Create an Audience (deprecated Public API)  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.create_audience(account_id, create_retail_media_audience_request, async_req=True)
+        >>> thread = api.legacy_create_audience_v1(account_id, rm_legacy_audience_create_input_entity_v1, async_req=True)
         >>> result = thread.get()
 
         Args:
             account_id (int): ID of the account to which this audience belongs.
-            create_retail_media_audience_request (CreateRetailMediaAudienceRequest):
+            rm_legacy_audience_create_input_entity_v1 (RmLegacyAudienceCreateInputEntityV1): Audience creation request.
 
         Keyword Args:
             _return_http_data_only (bool): response data without head status
@@ -348,7 +361,7 @@ class AudienceApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            CreateRetailMediaAudienceResponse
+            RmLegacyAudienceCreateEntityV1Response
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -379,30 +392,31 @@ class AudienceApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         kwargs['account_id'] = \
             account_id
-        kwargs['create_retail_media_audience_request'] = \
-            create_retail_media_audience_request
-        return self.create_audience_endpoint.call_with_http_info(**kwargs)
+        kwargs['rm_legacy_audience_create_input_entity_v1'] = \
+            rm_legacy_audience_create_input_entity_v1
+        return self.legacy_create_audience_v1_endpoint.call_with_http_info(**kwargs)
 
-    def create_retail_media_audience_v2(
+    def legacy_get_audience_v1(
         self,
         account_id,
-        create_retail_media_audience_v2_request,
         **kwargs
     ):
-        """create_retail_media_audience_v2  # noqa: E501
+        """legacy_get_audience_v1  # noqa: E501
 
-        Create an audience for a given account ID  # noqa: E501
+        Get a page of Audiences. (deprecated Public API)  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.create_retail_media_audience_v2(account_id, create_retail_media_audience_v2_request, async_req=True)
+        >>> thread = api.legacy_get_audience_v1(account_id, async_req=True)
         >>> result = thread.get()
 
         Args:
             account_id (int): ID of the account to which this audience belongs.
-            create_retail_media_audience_v2_request (CreateRetailMediaAudienceV2Request):
 
         Keyword Args:
+            limit_to_id ([int]): Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2. [optional]
+            page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page.. [optional]
+            page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed.. [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
@@ -435,7 +449,7 @@ class AudienceApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            RetailMediaAudienceV2Response
+            RmLegacyAudienceGetEntityV1ListResponse
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -466,31 +480,29 @@ class AudienceApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         kwargs['account_id'] = \
             account_id
-        kwargs['create_retail_media_audience_v2_request'] = \
-            create_retail_media_audience_v2_request
-        return self.create_retail_media_audience_v2_endpoint.call_with_http_info(**kwargs)
+        return self.legacy_get_audience_v1_endpoint.call_with_http_info(**kwargs)
 
-    def get_audiences_by_account_id(
+    def legacy_get_audience_v2(
         self,
         account_id,
         **kwargs
     ):
-        """get_audiences_by_account_id  # noqa: E501
+        """legacy_get_audience_v2  # noqa: E501
 
-        Get a page of audiences for a given account ID  # noqa: E501
+        Get a page of Audiences. (deprecated Public API)  # 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_audiences_by_account_id(account_id, async_req=True)
+        >>> thread = api.legacy_get_audience_v2(account_id, async_req=True)
         >>> result = thread.get()
 
         Args:
-            account_id (str): External account ID which owns audience.
+            account_id (int): ID of the account to which this audience belongs.
 
         Keyword Args:
-            limit_to_id ([str]): Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2. [optional]
-            page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page. [optional]
-            page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed. [optional]
+            limit_to_id ([int]): Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2. [optional]
+            page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page.. [optional]
+            page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed.. [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
@@ -523,7 +535,7 @@ class AudienceApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            GetPageOfAudiencesByAccountIdResponse
+            RmLegacyAudienceGetEntityV2ListResponse
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -554,29 +566,28 @@ class AudienceApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         kwargs['account_id'] = \
             account_id
-        return self.get_audiences_by_account_id_endpoint.call_with_http_info(**kwargs)
+        return self.legacy_get_audience_v2_endpoint.call_with_http_info(**kwargs)
 
-    def get_retail_media_audience_v2_list_by_account_id(
+    def legacy_update_audience_v2(
         self,
         account_id,
+        rm_legacy_audience_create_input_entity_v2,
         **kwargs
     ):
-        """get_retail_media_audience_v2_list_by_account_id  # noqa: E501
+        """legacy_update_audience_v2  # noqa: E501
 
-        Get a page of audiences for a given account ID  # noqa: E501
+        Create an Audience (deprecated Public API)  # 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_retail_media_audience_v2_list_by_account_id(account_id, async_req=True)
+        >>> thread = api.legacy_update_audience_v2(account_id, rm_legacy_audience_create_input_entity_v2, async_req=True)
         >>> result = thread.get()
 
         Args:
-            account_id (int): External account ID which owns audience.
+            account_id (int): ID of the account to which this audience belongs.
+            rm_legacy_audience_create_input_entity_v2 (RmLegacyAudienceCreateInputEntityV2): Audience creation request.
 
         Keyword Args:
-            limit_to_id ([int]): Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2. [optional]
-            page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page. [optional]
-            page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed. [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
@@ -609,7 +620,7 @@ class AudienceApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            RetailMediaAudienceV2ListResponse
+            RmLegacyAudienceCreateEntityV2Response
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -640,5 +651,7 @@ class AudienceApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         kwargs['account_id'] = \
             account_id
-        return self.get_retail_media_audience_v2_list_by_account_id_endpoint.call_with_http_info(**kwargs)
+        kwargs['rm_legacy_audience_create_input_entity_v2'] = \
+            rm_legacy_audience_create_input_entity_v2
+        return self.legacy_update_audience_v2_endpoint.call_with_http_info(**kwargs)
 

criteo_api_retailmedia_v2023_04/api_client.py

@@ -76,7 +76,7 @@ class ApiClient(object):
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/2023.04.0.240118/python'
+        self.user_agent = 'OpenAPI-Generator/2023.04.0.240404/python'
 
     def __enter__(self):
         return self

criteo_api_retailmedia_v2023_04/configuration.py

@@ -395,7 +395,7 @@ class Configuration(object):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 2023-04\n"\
-               "SDK Package Version: 2023.04.0.240118".\
+               "SDK Package Version: 2023.04.0.240404".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):