criteo-api-retailmedia-sdk 0.0.250915__py3-none-any.whl → 0.0.251014__py3-none-any.whl

criteo_api_retailmedia_preview/__init__.py

@@ -8,7 +8,7 @@
 """
 
 
-__version__ = "0.0.250915"
+__version__ = "0.0.251014"
 
 # import ApiClient
 from criteo_api_retailmedia_preview.api_client import ApiClient

criteo_api_retailmedia_preview/api/accounts_api.py

@@ -25,7 +25,6 @@ from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_of_
 from criteo_api_retailmedia_preview.model.value_resource_collection_outcome_private_market_account_fees_and_metadata import ValueResourceCollectionOutcomePrivateMarketAccountFeesAndMetadata
 from criteo_api_retailmedia_preview.model.value_resource_input_account_fees_search_request import ValueResourceInputAccountFeesSearchRequest
 from criteo_api_retailmedia_preview.model.value_resource_input_account_fees_update_request import ValueResourceInputAccountFeesUpdateRequest
-from criteo_api_retailmedia_preview.model.value_resource_outcome_account_fees_update_result import ValueResourceOutcomeAccountFeesUpdateResult
 
 
 class AccountsApi(object):
@@ -39,56 +38,65 @@ class AccountsApi(object):
         if api_client is None:
             api_client = ApiClient()
         self.api_client = api_client
-        self.get_api_external_v1_account_private_market_child_accounts_by_account_id_endpoint = _Endpoint(
+        self.account_fees_search_endpoint = _Endpoint(
             settings={
-                'response_type': (EntityResourceCollectionOutcomeOfRetailMediaChildAccountAndMetadata,),
+                'response_type': (ValueResourceCollectionOutcomePrivateMarketAccountFeesAndMetadata,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/preview/retail-media/account-management/accounts/{accountId}/private-market-child-accounts',
-                'operation_id': 'get_api_external_v1_account_private_market_child_accounts_by_account_id',
-                'http_method': 'GET',
+                'endpoint_path': '/preview/retail-media/accounts/fees/search',
+                'operation_id': 'account_fees_search',
+                'http_method': 'POST',
                 'servers': None,
             },
             params_map={
                 'all': [
-                    'account_id',
                     'limit',
                     'offset',
+                    'value_resource_input_account_fees_search_request',
                 ],
-                'required': [
-                    'account_id',
-                ],
+                'required': [],
                 'nullable': [
                 ],
                 'enum': [
                 ],
                 'validation': [
+                    'limit',
+                    'offset',
                 ]
             },
             root_map={
                 'validations': {
+                    ('limit',): {
+
+                        'inclusive_maximum': 500,
+                        'inclusive_minimum': 1,
+                    },
+                    ('offset',): {
+
+                        'inclusive_maximum': 2147483647,
+                        'inclusive_minimum': 0,
+                    },
                 },
                 'allowed_values': {
                 },
                 'openapi_types': {
-                    'account_id':
-                        (str,),
                     'limit':
                         (int,),
                     'offset':
                         (int,),
+                    'value_resource_input_account_fees_search_request':
+                        (ValueResourceInputAccountFeesSearchRequest,),
                 },
                 'attribute_map': {
-                    'account_id': 'accountId',
                     'limit': 'limit',
                     'offset': 'offset',
                 },
                 'location_map': {
-                    'account_id': 'path',
                     'limit': 'query',
                     'offset': 'query',
+                    'value_resource_input_account_fees_search_request': 'body',
                 },
                 'collection_format_map': {
                 }
@@ -97,69 +105,62 @@ class AccountsApi(object):
                 'accept': [
                     'application/json'
                 ],
-                'content_type': [],
+                'content_type': [
+                    'application/json'
+                ]
             },
             api_client=api_client
         )
-        self.preview_retail_media_accounts_fees_search_post_endpoint = _Endpoint(
+        self.get_private_market_child_accounts_by_account_id_endpoint = _Endpoint(
             settings={
-                'response_type': (ValueResourceCollectionOutcomePrivateMarketAccountFeesAndMetadata,),
+                'response_type': (EntityResourceCollectionOutcomeOfRetailMediaChildAccountAndMetadata,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/preview/retail-media/accounts/fees/search',
-                'operation_id': 'preview_retail_media_accounts_fees_search_post',
-                'http_method': 'POST',
+                'endpoint_path': '/preview/retail-media/account-management/accounts/{accountId}/private-market-child-accounts',
+                'operation_id': 'get_private_market_child_accounts_by_account_id',
+                'http_method': 'GET',
                 'servers': None,
             },
             params_map={
                 'all': [
+                    'account_id',
                     'limit',
                     'offset',
-                    'value_resource_input_account_fees_search_request',
                 ],
-                'required': [],
+                'required': [
+                    'account_id',
+                ],
                 'nullable': [
                 ],
                 'enum': [
                 ],
                 'validation': [
-                    'limit',
-                    'offset',
                 ]
             },
             root_map={
                 'validations': {
-                    ('limit',): {
-
-                        'inclusive_maximum': 500,
-                        'inclusive_minimum': 1,
-                    },
-                    ('offset',): {
-
-                        'inclusive_maximum': 2147483647,
-                        'inclusive_minimum': 0,
-                    },
                 },
                 'allowed_values': {
                 },
                 'openapi_types': {
+                    'account_id':
+                        (str,),
                     'limit':
                         (int,),
                     'offset':
                         (int,),
-                    'value_resource_input_account_fees_search_request':
-                        (ValueResourceInputAccountFeesSearchRequest,),
                 },
                 'attribute_map': {
+                    'account_id': 'accountId',
                     'limit': 'limit',
                     'offset': 'offset',
                 },
                 'location_map': {
+                    'account_id': 'path',
                     'limit': 'query',
                     'offset': 'query',
-                    'value_resource_input_account_fees_search_request': 'body',
                 },
                 'collection_format_map': {
                 }
@@ -168,21 +169,19 @@ class AccountsApi(object):
                 'accept': [
                     'application/json'
                 ],
-                'content_type': [
-                    'application/json'
-                ]
+                'content_type': [],
             },
             api_client=api_client
         )
-        self.preview_retail_media_accounts_fees_update_post_endpoint = _Endpoint(
+        self.update_account_fees_endpoint = _Endpoint(
             settings={
-                'response_type': (ValueResourceOutcomeAccountFeesUpdateResult,),
+                'response_type': None,
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
                 'endpoint_path': '/preview/retail-media/accounts/fees/update',
-                'operation_id': 'preview_retail_media_accounts_fees_update_post',
+                'operation_id': 'update_account_fees',
                 'http_method': 'POST',
                 'servers': None,
             },
@@ -216,9 +215,7 @@ class AccountsApi(object):
                 }
             },
             headers_map={
-                'accept': [
-                    'application/json'
-                ],
+                'accept': [],
                 'content_type': [
                     'application/json'
                 ]
@@ -226,26 +223,24 @@ class AccountsApi(object):
             api_client=api_client
         )
 
-    def get_api_external_v1_account_private_market_child_accounts_by_account_id(
+    def account_fees_search(
         self,
-        account_id,
         **kwargs
     ):
-        """get_api_external_v1_account_private_market_child_accounts_by_account_id  # noqa: E501
+        """account_fees_search  # noqa: E501
 
-        Gets page of private market child accounts that are associated with the given account  # noqa: E501
+        Get fees for provided accounts  # 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_external_v1_account_private_market_child_accounts_by_account_id(account_id, async_req=True)
+        >>> thread = api.account_fees_search(async_req=True)
         >>> result = thread.get()
 
-        Args:
-            account_id (str): Account Id
 
         Keyword Args:
-            limit (int): The number of accounts to be returned. The default is 25.. [optional] if omitted the server will use the default value of 25
-            offset (int): The (zero-based) offset into the collection of accounts. The default is 0.. [optional] if omitted the server will use the default value of 0
+            limit (int): used for paging, number of results returned per request, Maximum of 500. [optional] if omitted the server will use the default value of 50
+            offset (int): used for paging, number of records to skip. [optional] if omitted the server will use the default value of 0
+            value_resource_input_account_fees_search_request (ValueResourceInputAccountFeesSearchRequest): [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
@@ -278,7 +273,7 @@ class AccountsApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            EntityResourceCollectionOutcomeOfRetailMediaChildAccountAndMetadata
+            ValueResourceCollectionOutcomePrivateMarketAccountFeesAndMetadata
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -307,28 +302,28 @@ class AccountsApi(object):
             '_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_api_external_v1_account_private_market_child_accounts_by_account_id_endpoint.call_with_http_info(**kwargs)
+        return self.account_fees_search_endpoint.call_with_http_info(**kwargs)
 
-    def preview_retail_media_accounts_fees_search_post(
+    def get_private_market_child_accounts_by_account_id(
         self,
+        account_id,
         **kwargs
     ):
-        """preview_retail_media_accounts_fees_search_post  # noqa: E501
+        """get_private_market_child_accounts_by_account_id  # noqa: E501
 
-        Get fees for provided accounts  # noqa: E501
+        Gets page of private market child accounts that are associated with the given account  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.preview_retail_media_accounts_fees_search_post(async_req=True)
+        >>> thread = api.get_private_market_child_accounts_by_account_id(account_id, async_req=True)
         >>> result = thread.get()
 
+        Args:
+            account_id (str): Account Id
 
         Keyword Args:
-            limit (int): used for paging, number of results returned per request, Maximum of 500. [optional] if omitted the server will use the default value of 50
-            offset (int): used for paging, number of records to skip. [optional] if omitted the server will use the default value of 0
-            value_resource_input_account_fees_search_request (ValueResourceInputAccountFeesSearchRequest): [optional]
+            limit (int): The number of accounts to be returned. The default is 25.. [optional] if omitted the server will use the default value of 25
+            offset (int): The (zero-based) offset into the collection of accounts. 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
@@ -361,7 +356,7 @@ class AccountsApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            ValueResourceCollectionOutcomePrivateMarketAccountFeesAndMetadata
+            EntityResourceCollectionOutcomeOfRetailMediaChildAccountAndMetadata
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -390,19 +385,21 @@ class AccountsApi(object):
             '_content_type')
         kwargs['_host_index'] = kwargs.get('_host_index')
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
-        return self.preview_retail_media_accounts_fees_search_post_endpoint.call_with_http_info(**kwargs)
+        kwargs['account_id'] = \
+            account_id
+        return self.get_private_market_child_accounts_by_account_id_endpoint.call_with_http_info(**kwargs)
 
-    def preview_retail_media_accounts_fees_update_post(
+    def update_account_fees(
         self,
         **kwargs
     ):
-        """preview_retail_media_accounts_fees_update_post  # noqa: E501
+        """update_account_fees  # noqa: E501
 
         Set fees for provided accounts  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.preview_retail_media_accounts_fees_update_post(async_req=True)
+        >>> thread = api.update_account_fees(async_req=True)
         >>> result = thread.get()
 
 
@@ -440,7 +437,7 @@ class AccountsApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            ValueResourceOutcomeAccountFeesUpdateResult
+            None
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -469,5 +466,5 @@ class AccountsApi(object):
             '_content_type')
         kwargs['_host_index'] = kwargs.get('_host_index')
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
-        return self.preview_retail_media_accounts_fees_update_post_endpoint.call_with_http_info(**kwargs)
+        return self.update_account_fees_endpoint.call_with_http_info(**kwargs)
 

criteo_api_retailmedia_preview/api/analytics_api.py

@@ -27,6 +27,7 @@ from criteo_api_retailmedia_preview.model.async_fill_rate_report_request import
 from criteo_api_retailmedia_preview.model.async_line_items_report_request import AsyncLineItemsReportRequest
 from criteo_api_retailmedia_preview.model.async_offsite_report_request import AsyncOffsiteReportRequest
 from criteo_api_retailmedia_preview.model.async_report_response import AsyncReportResponse
+from criteo_api_retailmedia_preview.model.async_unfilled_placements_report_request import AsyncUnfilledPlacementsReportRequest
 from criteo_api_retailmedia_preview.model.report_response import ReportResponse
 from criteo_api_retailmedia_preview.model.sync_attributed_transactions_report_request import SyncAttributedTransactionsReportRequest
 from criteo_api_retailmedia_preview.model.sync_campaigns_report_request import SyncCampaignsReportRequest
@@ -309,6 +310,59 @@ class AnalyticsApi(object):
             },
             api_client=api_client
         )
+        self.generate_async_unfilled_placements_report_endpoint = _Endpoint(
+            settings={
+                'response_type': (AsyncReportResponse,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/retail-media/reports/unfilled-placements',
+                'operation_id': 'generate_async_unfilled_placements_report',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'async_unfilled_placements_report_request',
+                ],
+                'required': [
+                    'async_unfilled_placements_report_request',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'async_unfilled_placements_report_request':
+                        (AsyncUnfilledPlacementsReportRequest,),
+                },
+                'attribute_map': {
+                },
+                'location_map': {
+                    'async_unfilled_placements_report_request': 'body',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [
+                    'application/json'
+                ]
+            },
+            api_client=api_client
+        )
         self.generate_sync_attributed_transactions_report_endpoint = _Endpoint(
             settings={
                 'response_type': (ReportResponse,),
@@ -988,6 +1042,89 @@ class AnalyticsApi(object):
             async_offsite_report_request
         return self.generate_async_offsite_report_endpoint.call_with_http_info(**kwargs)
 
+    def generate_async_unfilled_placements_report(
+        self,
+        async_unfilled_placements_report_request,
+        **kwargs
+    ):
+        """generate_async_unfilled_placements_report  # noqa: E501
+
+        Returns an asynchronous Unfilled Placements Report This endpoint is subject to specific rate limits.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.generate_async_unfilled_placements_report(async_unfilled_placements_report_request, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            async_unfilled_placements_report_request (AsyncUnfilledPlacementsReportRequest):
+
+        Keyword Args:
+            _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:
+            AsyncReportResponse
+                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['async_unfilled_placements_report_request'] = \
+            async_unfilled_placements_report_request
+        return self.generate_async_unfilled_placements_report_endpoint.call_with_http_info(**kwargs)
+
     def generate_sync_attributed_transactions_report(
         self,
         sync_attributed_transactions_report_request,

criteo_api_retailmedia_preview/api/audience_api.py

@@ -530,7 +530,7 @@ class AudienceApi(object):
             },
             api_client=api_client
         )
-        self.delete_contact_list_identifiers_endpoint = _Endpoint(
+        self.delete_contact_list_by_audience_segment_endpoint = _Endpoint(
             settings={
                 'response_type': None,
                 'auth': [
@@ -538,7 +538,7 @@ class AudienceApi(object):
                     'oauth'
                 ],
                 'endpoint_path': '/preview/retail-media/audience-segments/{audience-segment-id}/contact-list/clear',
-                'operation_id': 'delete_contact_list_identifiers',
+                'operation_id': 'delete_contact_list_by_audience_segment',
                 'http_method': 'POST',
                 'servers': None,
             },
@@ -908,7 +908,7 @@ class AudienceApi(object):
             },
             api_client=api_client
         )
-        self.update_contact_list_identifiers_endpoint = _Endpoint(
+        self.update_contact_list_by_audience_segment_endpoint = _Endpoint(
             settings={
                 'response_type': (RetailMediaContactlistOperation,),
                 'auth': [
@@ -916,7 +916,7 @@ class AudienceApi(object):
                     'oauth'
                 ],
                 'endpoint_path': '/preview/retail-media/audience-segments/{audience-segment-id}/contact-list/add-remove',
-                'operation_id': 'update_contact_list_identifiers',
+                'operation_id': 'update_contact_list_by_audience_segment',
                 'http_method': 'POST',
                 'servers': None,
             },
@@ -1664,18 +1664,18 @@ class AudienceApi(object):
             rm_audience_compute_sizes_input_v1
         return self.compute_audiences_sizes_endpoint.call_with_http_info(**kwargs)
 
-    def delete_contact_list_identifiers(
+    def delete_contact_list_by_audience_segment(
         self,
         audience_segment_id,
         **kwargs
     ):
-        """delete_contact_list_identifiers  # noqa: E501
+        """delete_contact_list_by_audience_segment  # noqa: E501
 
         Delete all identifiers from a retail-media contact list audience-segment, with external audience segment 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.delete_contact_list_identifiers(audience_segment_id, async_req=True)
+        >>> thread = api.delete_contact_list_by_audience_segment(audience_segment_id, async_req=True)
         >>> result = thread.get()
 
         Args:
@@ -1745,7 +1745,7 @@ class AudienceApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         kwargs['audience_segment_id'] = \
             audience_segment_id
-        return self.delete_contact_list_identifiers_endpoint.call_with_http_info(**kwargs)
+        return self.delete_contact_list_by_audience_segment_endpoint.call_with_http_info(**kwargs)
 
     def estimate_audience_segment_size(
         self,
@@ -2186,19 +2186,19 @@ class AudienceApi(object):
             rm_audience_search_input_v1
         return self.search_audiences_endpoint.call_with_http_info(**kwargs)
 
-    def update_contact_list_identifiers(
+    def update_contact_list_by_audience_segment(
         self,
         audience_segment_id,
         retail_media_contactlist_amendment_request,
         **kwargs
     ):
-        """update_contact_list_identifiers  # noqa: E501
+        """update_contact_list_by_audience_segment  # noqa: E501
 
         Add/remove identifiers to or from a retail-media contact list audience-segment, with external audience segment 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.update_contact_list_identifiers(audience_segment_id, retail_media_contactlist_amendment_request, async_req=True)
+        >>> thread = api.update_contact_list_by_audience_segment(audience_segment_id, retail_media_contactlist_amendment_request, async_req=True)
         >>> result = thread.get()
 
         Args:
@@ -2271,5 +2271,5 @@ class AudienceApi(object):
             audience_segment_id
         kwargs['retail_media_contactlist_amendment_request'] = \
             retail_media_contactlist_amendment_request
-        return self.update_contact_list_identifiers_endpoint.call_with_http_info(**kwargs)
+        return self.update_contact_list_by_audience_segment_endpoint.call_with_http_info(**kwargs)