criteo-api-retailmedia-sdk 0.0.240808__py3-none-any.whl → 0.0.241029__py3-none-any.whl

criteo_api_retailmedia_preview/api/audience_api.py

@@ -24,6 +24,8 @@ from criteo_api_retailmedia_preview.model_utils import (  # noqa: F401
 from criteo_api_retailmedia_preview.model.error_code_response import ErrorCodeResponse
 from criteo_api_retailmedia_preview.model.retail_media_contactlist_amendment_request import RetailMediaContactlistAmendmentRequest
 from criteo_api_retailmedia_preview.model.retail_media_contactlist_operation import RetailMediaContactlistOperation
+from criteo_api_retailmedia_preview.model.rm_audience_entity_v1_rm_audience_search_metadata_v1_list_response import RmAudienceEntityV1RmAudienceSearchMetadataV1ListResponse
+from criteo_api_retailmedia_preview.model.rm_audience_search_input_v1 import RmAudienceSearchInputV1
 from criteo_api_retailmedia_preview.model.rm_audience_segment_bulk_create_input_v1 import RmAudienceSegmentBulkCreateInputV1
 from criteo_api_retailmedia_preview.model.rm_audience_segment_bulk_delete_input_v1 import RmAudienceSegmentBulkDeleteInputV1
 from criteo_api_retailmedia_preview.model.rm_audience_segment_bulk_update_input_v1 import RmAudienceSegmentBulkUpdateInputV1
@@ -32,8 +34,6 @@ from criteo_api_retailmedia_preview.model.rm_audience_segment_entity_v1_rm_audie
 from criteo_api_retailmedia_preview.model.rm_audience_segment_id_entity_v1_list_response import RmAudienceSegmentIdEntityV1ListResponse
 from criteo_api_retailmedia_preview.model.rm_audience_segment_search_input_v1 import RmAudienceSegmentSearchInputV1
 from criteo_api_retailmedia_preview.model.rm_contact_list_statistics_entity_v1_response import RmContactListStatisticsEntityV1Response
-from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v1_list_response import RmLegacyAudienceGetEntityV1ListResponse
-from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v2_list_response import RmLegacyAudienceGetEntityV2ListResponse
 
 
 class AudienceApi(object):
@@ -47,7 +47,7 @@ class AudienceApi(object):
         if api_client is None:
             api_client = ApiClient()
         self.api_client = api_client
-        self.bulk_create_v1_endpoint = _Endpoint(
+        self.bulk_create_audience_segments_endpoint = _Endpoint(
             settings={
                 'response_type': (RmAudienceSegmentEntityV1ListResponse,),
                 'auth': [
@@ -55,7 +55,7 @@ class AudienceApi(object):
                     'oauth'
                 ],
                 'endpoint_path': '/preview/retail-media/accounts/{account-id}/audience-segments/create',
-                'operation_id': 'bulk_create_v1',
+                'operation_id': 'bulk_create_audience_segments',
                 'http_method': 'POST',
                 'servers': None,
             },
@@ -111,7 +111,7 @@ class AudienceApi(object):
             },
             api_client=api_client
         )
-        self.bulk_delete_v1_endpoint = _Endpoint(
+        self.bulk_delete_audience_segments_endpoint = _Endpoint(
             settings={
                 'response_type': (RmAudienceSegmentIdEntityV1ListResponse,),
                 'auth': [
@@ -119,7 +119,7 @@ class AudienceApi(object):
                     'oauth'
                 ],
                 'endpoint_path': '/preview/retail-media/accounts/{account-id}/audience-segments/delete',
-                'operation_id': 'bulk_delete_v1',
+                'operation_id': 'bulk_delete_audience_segments',
                 'http_method': 'POST',
                 'servers': None,
             },
@@ -175,7 +175,7 @@ class AudienceApi(object):
             },
             api_client=api_client
         )
-        self.bulk_update_v1_endpoint = _Endpoint(
+        self.bulk_update_audience_segments_endpoint = _Endpoint(
             settings={
                 'response_type': (RmAudienceSegmentEntityV1ListResponse,),
                 'auth': [
@@ -183,7 +183,7 @@ class AudienceApi(object):
                     'oauth'
                 ],
                 'endpoint_path': '/preview/retail-media/accounts/{account-id}/audience-segments',
-                'operation_id': 'bulk_update_v1',
+                'operation_id': 'bulk_update_audience_segments',
                 'http_method': 'PATCH',
                 'servers': None,
             },
@@ -291,7 +291,7 @@ class AudienceApi(object):
             },
             api_client=api_client
         )
-        self.get_contact_list_statistics_v1_endpoint = _Endpoint(
+        self.get_audience_segment_contact_list_statistics_endpoint = _Endpoint(
             settings={
                 'response_type': (RmContactListStatisticsEntityV1Response,),
                 'auth': [
@@ -299,7 +299,7 @@ class AudienceApi(object):
                     'oauth'
                 ],
                 'endpoint_path': '/preview/retail-media/accounts/{account-id}/audience-segments/{audience-segment-id}/contact-list',
-                'operation_id': 'get_contact_list_statistics_v1',
+                'operation_id': 'get_audience_segment_contact_list_statistics',
                 'http_method': 'GET',
                 'servers': None,
             },
@@ -351,64 +351,69 @@ class AudienceApi(object):
             },
             api_client=api_client
         )
-        self.legacy_get_audience_v1_endpoint = _Endpoint(
+        self.search_audience_segments_endpoint = _Endpoint(
             settings={
-                'response_type': (RmLegacyAudienceGetEntityV1ListResponse,),
+                'response_type': (RmAudienceSegmentEntityV1RmAudienceSegmentSearchMetadataV1ListResponse,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/preview/retail-media/accounts/{accountId}/audiences',
-                'operation_id': 'legacy_get_audience_v1',
-                'http_method': 'GET',
+                'endpoint_path': '/preview/retail-media/accounts/{account-id}/audience-segments/search',
+                'operation_id': 'search_audience_segments',
+                'http_method': 'POST',
                 'servers': None,
             },
             params_map={
                 'all': [
                     'account_id',
-                    'limit_to_id',
-                    'page_size',
-                    'page_index',
+                    'rm_audience_segment_search_input_v1',
+                    'limit',
+                    'offset',
                 ],
                 'required': [
                     'account_id',
+                    'rm_audience_segment_search_input_v1',
                 ],
                 'nullable': [
                 ],
                 'enum': [
                 ],
                 'validation': [
+                    'limit',
                 ]
             },
             root_map={
                 'validations': {
+                    ('limit',): {
+
+                        'inclusive_maximum': 100,
+                        'inclusive_minimum': 0,
+                    },
                 },
                 'allowed_values': {
                 },
                 'openapi_types': {
                     'account_id':
+                        (str,),
+                    'rm_audience_segment_search_input_v1':
+                        (RmAudienceSegmentSearchInputV1,),
+                    'limit':
                         (int,),
-                    'limit_to_id':
-                        ([int],),
-                    'page_size':
-                        (int,),
-                    'page_index':
+                    'offset':
                         (int,),
                 },
                 'attribute_map': {
-                    'account_id': 'accountId',
-                    'limit_to_id': 'limitToId',
-                    'page_size': 'pageSize',
-                    'page_index': 'pageIndex',
+                    'account_id': 'account-id',
+                    'limit': 'limit',
+                    'offset': 'offset',
                 },
                 'location_map': {
                     'account_id': 'path',
-                    'limit_to_id': 'query',
-                    'page_size': 'query',
-                    'page_index': 'query',
+                    'rm_audience_segment_search_input_v1': 'body',
+                    'limit': 'query',
+                    'offset': 'query',
                 },
                 'collection_format_map': {
-                    'limit_to_id': 'multi',
                 }
             },
             headers_map={
@@ -417,102 +422,37 @@ class AudienceApi(object):
                     'application/json',
                     'text/json'
                 ],
-                'content_type': [],
-            },
-            api_client=api_client
-        )
-        self.legacy_get_audience_v2_endpoint = _Endpoint(
-            settings={
-                'response_type': (RmLegacyAudienceGetEntityV2ListResponse,),
-                'auth': [
-                    'oauth',
-                    'oauth'
-                ],
-                'endpoint_path': '/preview/retail-media/v2/accounts/{accountId}/audiences',
-                'operation_id': 'legacy_get_audience_v2',
-                'http_method': 'GET',
-                'servers': None,
-            },
-            params_map={
-                'all': [
-                    'account_id',
-                    'limit_to_id',
-                    'page_size',
-                    'page_index',
-                ],
-                'required': [
-                    'account_id',
-                ],
-                'nullable': [
-                ],
-                'enum': [
-                ],
-                'validation': [
-                ]
-            },
-            root_map={
-                'validations': {
-                },
-                'allowed_values': {
-                },
-                'openapi_types': {
-                    'account_id':
-                        (int,),
-                    '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',
-                    'limit_to_id': 'query',
-                    'page_size': 'query',
-                    'page_index': 'query',
-                },
-                'collection_format_map': {
-                    'limit_to_id': 'multi',
-                }
-            },
-            headers_map={
-                'accept': [
-                    'text/plain',
+                'content_type': [
+                    'application/json-patch+json',
                     'application/json',
-                    'text/json'
-                ],
-                'content_type': [],
+                    'text/json',
+                    'application/*+json'
+                ]
             },
             api_client=api_client
         )
-        self.search_v1_endpoint = _Endpoint(
+        self.search_audiences_endpoint = _Endpoint(
             settings={
-                'response_type': (RmAudienceSegmentEntityV1RmAudienceSegmentSearchMetadataV1ListResponse,),
+                'response_type': (RmAudienceEntityV1RmAudienceSearchMetadataV1ListResponse,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/preview/retail-media/accounts/{account-id}/audience-segments/search',
-                'operation_id': 'search_v1',
+                'endpoint_path': '/preview/retail-media/accounts/{account-id}/audiences/search',
+                'operation_id': 'search_audiences',
                 'http_method': 'POST',
                 'servers': None,
             },
             params_map={
                 'all': [
                     'account_id',
-                    'rm_audience_segment_search_input_v1',
+                    'rm_audience_search_input_v1',
                     'limit',
                     'offset',
                 ],
                 'required': [
                     'account_id',
-                    'rm_audience_segment_search_input_v1',
+                    'rm_audience_search_input_v1',
                 ],
                 'nullable': [
                 ],
@@ -535,8 +475,8 @@ class AudienceApi(object):
                 'openapi_types': {
                     'account_id':
                         (str,),
-                    'rm_audience_segment_search_input_v1':
-                        (RmAudienceSegmentSearchInputV1,),
+                    'rm_audience_search_input_v1':
+                        (RmAudienceSearchInputV1,),
                     'limit':
                         (int,),
                     'offset':
@@ -549,7 +489,7 @@ class AudienceApi(object):
                 },
                 'location_map': {
                     'account_id': 'path',
-                    'rm_audience_segment_search_input_v1': 'body',
+                    'rm_audience_search_input_v1': 'body',
                     'limit': 'query',
                     'offset': 'query',
                 },
@@ -631,19 +571,19 @@ class AudienceApi(object):
             api_client=api_client
         )
 
-    def bulk_create_v1(
+    def bulk_create_audience_segments(
         self,
         account_id,
         rm_audience_segment_bulk_create_input_v1,
         **kwargs
     ):
-        """bulk_create_v1  # noqa: E501
+        """bulk_create_audience_segments  # noqa: E501
 
         Creates all segments with a valid configuration, and returns the full segments. For those that cannot be created, one or multiple errors are returned.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.bulk_create_v1(account_id, rm_audience_segment_bulk_create_input_v1, async_req=True)
+        >>> thread = api.bulk_create_audience_segments(account_id, rm_audience_segment_bulk_create_input_v1, async_req=True)
         >>> result = thread.get()
 
         Args:
@@ -716,21 +656,21 @@ class AudienceApi(object):
             account_id
         kwargs['rm_audience_segment_bulk_create_input_v1'] = \
             rm_audience_segment_bulk_create_input_v1
-        return self.bulk_create_v1_endpoint.call_with_http_info(**kwargs)
+        return self.bulk_create_audience_segments_endpoint.call_with_http_info(**kwargs)
 
-    def bulk_delete_v1(
+    def bulk_delete_audience_segments(
         self,
         account_id,
         rm_audience_segment_bulk_delete_input_v1,
         **kwargs
     ):
-        """bulk_delete_v1  # noqa: E501
+        """bulk_delete_audience_segments  # noqa: E501
 
         Delete the segments associated to the given audience IDs.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.bulk_delete_v1(account_id, rm_audience_segment_bulk_delete_input_v1, async_req=True)
+        >>> thread = api.bulk_delete_audience_segments(account_id, rm_audience_segment_bulk_delete_input_v1, async_req=True)
         >>> result = thread.get()
 
         Args:
@@ -803,21 +743,21 @@ class AudienceApi(object):
             account_id
         kwargs['rm_audience_segment_bulk_delete_input_v1'] = \
             rm_audience_segment_bulk_delete_input_v1
-        return self.bulk_delete_v1_endpoint.call_with_http_info(**kwargs)
+        return self.bulk_delete_audience_segments_endpoint.call_with_http_info(**kwargs)
 
-    def bulk_update_v1(
+    def bulk_update_audience_segments(
         self,
         account_id,
         rm_audience_segment_bulk_update_input_v1,
         **kwargs
     ):
-        """bulk_update_v1  # noqa: E501
+        """bulk_update_audience_segments  # noqa: E501
 
         Updates the properties of all segments with a valid configuration, and returns the full segments. For those that cannot be updated, one or multiple errors are returned.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.bulk_update_v1(account_id, rm_audience_segment_bulk_update_input_v1, async_req=True)
+        >>> thread = api.bulk_update_audience_segments(account_id, rm_audience_segment_bulk_update_input_v1, async_req=True)
         >>> result = thread.get()
 
         Args:
@@ -890,7 +830,7 @@ class AudienceApi(object):
             account_id
         kwargs['rm_audience_segment_bulk_update_input_v1'] = \
             rm_audience_segment_bulk_update_input_v1
-        return self.bulk_update_v1_endpoint.call_with_http_info(**kwargs)
+        return self.bulk_update_audience_segments_endpoint.call_with_http_info(**kwargs)
 
     def delete_contact_list_identifiers(
         self,
@@ -975,19 +915,19 @@ class AudienceApi(object):
             audience_segment_id
         return self.delete_contact_list_identifiers_endpoint.call_with_http_info(**kwargs)
 
-    def get_contact_list_statistics_v1(
+    def get_audience_segment_contact_list_statistics(
         self,
         account_id,
         audience_segment_id,
         **kwargs
     ):
-        """get_contact_list_statistics_v1  # noqa: E501
+        """get_audience_segment_contact_list_statistics  # noqa: E501
 
         Returns the statistics of a contact list segment.  # 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_contact_list_statistics_v1(account_id, audience_segment_id, async_req=True)
+        >>> thread = api.get_audience_segment_contact_list_statistics(account_id, audience_segment_id, async_req=True)
         >>> result = thread.get()
 
         Args:
@@ -1060,115 +1000,30 @@ class AudienceApi(object):
             account_id
         kwargs['audience_segment_id'] = \
             audience_segment_id
-        return self.get_contact_list_statistics_v1_endpoint.call_with_http_info(**kwargs)
-
-    def legacy_get_audience_v1(
-        self,
-        account_id,
-        **kwargs
-    ):
-        """legacy_get_audience_v1  # 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.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.
-
-        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
-                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:
-            RmLegacyAudienceGetEntityV1ListResponse
-                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.legacy_get_audience_v1_endpoint.call_with_http_info(**kwargs)
+        return self.get_audience_segment_contact_list_statistics_endpoint.call_with_http_info(**kwargs)
 
-    def legacy_get_audience_v2(
+    def search_audience_segments(
         self,
         account_id,
+        rm_audience_segment_search_input_v1,
         **kwargs
     ):
-        """legacy_get_audience_v2  # noqa: E501
+        """search_audience_segments  # noqa: E501
 
-        Get a page of Audiences. (deprecated Public API)  # noqa: E501
+        Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.legacy_get_audience_v2(account_id, async_req=True)
+        >>> thread = api.search_audience_segments(account_id, rm_audience_segment_search_input_v1, async_req=True)
         >>> result = thread.get()
 
         Args:
-            account_id (int): ID of the account to which this audience belongs.
+            account_id (str): Account Id
+            rm_audience_segment_search_input_v1 (RmAudienceSegmentSearchInputV1): Segment search filters.
 
         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]
+            limit (int): The number of elements to be returned. The default is 50 and the maximum is 100.. [optional] if omitted the server will use the default value of 50
+            offset (int): The (zero-based) offset into the collection. The default is 0.. [optional] if omitted the server will use the default value of 0
             _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
@@ -1201,7 +1056,7 @@ class AudienceApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            RmLegacyAudienceGetEntityV2ListResponse
+            RmAudienceSegmentEntityV1RmAudienceSegmentSearchMetadataV1ListResponse
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -1232,26 +1087,28 @@ class AudienceApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         kwargs['account_id'] = \
             account_id
-        return self.legacy_get_audience_v2_endpoint.call_with_http_info(**kwargs)
+        kwargs['rm_audience_segment_search_input_v1'] = \
+            rm_audience_segment_search_input_v1
+        return self.search_audience_segments_endpoint.call_with_http_info(**kwargs)
 
-    def search_v1(
+    def search_audiences(
         self,
         account_id,
-        rm_audience_segment_search_input_v1,
+        rm_audience_search_input_v1,
         **kwargs
     ):
-        """search_v1  # noqa: E501
+        """search_audiences  # noqa: E501
 
-        Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied.  # noqa: E501
+        Returns a list of audiences that match the provided filters. If present, the filters are AND'ed together when applied.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.search_v1(account_id, rm_audience_segment_search_input_v1, async_req=True)
+        >>> thread = api.search_audiences(account_id, rm_audience_search_input_v1, async_req=True)
         >>> result = thread.get()
 
         Args:
             account_id (str): Account Id
-            rm_audience_segment_search_input_v1 (RmAudienceSegmentSearchInputV1): Segment search filters.
+            rm_audience_search_input_v1 (RmAudienceSearchInputV1): Audience search filters.
 
         Keyword Args:
             limit (int): The number of elements to be returned. The default is 50 and the maximum is 100.. [optional] if omitted the server will use the default value of 50
@@ -1288,7 +1145,7 @@ class AudienceApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            RmAudienceSegmentEntityV1RmAudienceSegmentSearchMetadataV1ListResponse
+            RmAudienceEntityV1RmAudienceSearchMetadataV1ListResponse
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -1319,9 +1176,9 @@ class AudienceApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         kwargs['account_id'] = \
             account_id
-        kwargs['rm_audience_segment_search_input_v1'] = \
-            rm_audience_segment_search_input_v1
-        return self.search_v1_endpoint.call_with_http_info(**kwargs)
+        kwargs['rm_audience_search_input_v1'] = \
+            rm_audience_search_input_v1
+        return self.search_audiences_endpoint.call_with_http_info(**kwargs)
 
     def update_contact_list_identifiers(
         self,