criteo-api-marketingsolutions-sdk 0.0.240626__py3-none-any.whl → 0.0.240808__py3-none-any.whl

criteo_api_marketingsolutions_preview/api/reco_api.py

@@ -3,7 +3,7 @@
 
     Criteo API - MarketingSolutions  # noqa: E501
 
-    The version of the OpenAPI document: Preview
+    The version of the OpenAPI document: preview
     Generated by: https://openapi-generator.tech
 """
 
@@ -24,7 +24,10 @@ from criteo_api_marketingsolutions_preview.model_utils import (  # noqa: F401
 from criteo_api_marketingsolutions_preview.model.outcome import Outcome
 from criteo_api_marketingsolutions_preview.model.resource_collection_outcome_of_product_set import ResourceCollectionOutcomeOfProductSet
 from criteo_api_marketingsolutions_preview.model.resource_outcome_of_product_set import ResourceOutcomeOfProductSet
+from criteo_api_marketingsolutions_preview.model.value_resource_collection_outcome_of_product_filter_config import ValueResourceCollectionOutcomeOfProductFilterConfig
+from criteo_api_marketingsolutions_preview.model.value_resource_input_of_create_product_filter_request import ValueResourceInputOfCreateProductFilterRequest
 from criteo_api_marketingsolutions_preview.model.value_resource_input_of_create_product_set_request import ValueResourceInputOfCreateProductSetRequest
+from criteo_api_marketingsolutions_preview.model.value_resource_outcome_of_product_filter_config import ValueResourceOutcomeOfProductFilterConfig
 
 
 class RecoApi(object):
@@ -94,6 +97,231 @@ class RecoApi(object):
             },
             api_client=api_client
         )
+        self.disable_product_filtering_endpoint = _Endpoint(
+            settings={
+                'response_type': (ValueResourceOutcomeOfProductFilterConfig,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/ads/{ad-id}/product-filter',
+                'operation_id': 'disable_product_filtering',
+                'http_method': 'DELETE',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'ad_id',
+                ],
+                'required': [
+                    'ad_id',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'ad_id':
+                        (str,),
+                },
+                'attribute_map': {
+                    'ad_id': 'ad-id',
+                },
+                'location_map': {
+                    'ad_id': 'path',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'text/plain',
+                    'application/json',
+                    'text/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
+        self.enable_product_filtering_endpoint = _Endpoint(
+            settings={
+                'response_type': (ValueResourceOutcomeOfProductFilterConfig,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/ads/{ad-id}/product-filter',
+                'operation_id': 'enable_product_filtering',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'ad_id',
+                    'value_resource_input_of_create_product_filter_request',
+                ],
+                'required': [
+                    'ad_id',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'ad_id':
+                        (str,),
+                    'value_resource_input_of_create_product_filter_request':
+                        (ValueResourceInputOfCreateProductFilterRequest,),
+                },
+                'attribute_map': {
+                    'ad_id': 'ad-id',
+                },
+                'location_map': {
+                    'ad_id': 'path',
+                    'value_resource_input_of_create_product_filter_request': 'body',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'text/plain',
+                    'application/json',
+                    'text/json'
+                ],
+                'content_type': [
+                    'application/json-patch+json',
+                    'application/json',
+                    'text/json',
+                    'application/*+json'
+                ]
+            },
+            api_client=api_client
+        )
+        self.fetch_product_filtering_config_endpoint = _Endpoint(
+            settings={
+                'response_type': (ValueResourceOutcomeOfProductFilterConfig,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/ads/{ad-id}/product-filter',
+                'operation_id': 'fetch_product_filtering_config',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'ad_id',
+                ],
+                'required': [
+                    'ad_id',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'ad_id':
+                        (str,),
+                },
+                'attribute_map': {
+                    'ad_id': 'ad-id',
+                },
+                'location_map': {
+                    'ad_id': 'path',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'text/plain',
+                    'application/json',
+                    'text/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
+        self.fetch_product_filtering_usages_endpoint = _Endpoint(
+            settings={
+                'response_type': (ValueResourceCollectionOutcomeOfProductFilterConfig,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/product-sets/{product-set-id}/product-filters',
+                'operation_id': 'fetch_product_filtering_usages',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'product_set_id',
+                ],
+                'required': [
+                    'product_set_id',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'product_set_id':
+                        (str,),
+                },
+                'attribute_map': {
+                    'product_set_id': 'product-set-id',
+                },
+                'location_map': {
+                    'product_set_id': 'path',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'text/plain',
+                    'application/json',
+                    'text/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
         self.fetch_product_set_endpoint = _Endpoint(
             settings={
                 'response_type': (ResourceOutcomeOfProductSet,),
@@ -336,6 +564,339 @@ class RecoApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         return self.create_product_set_endpoint.call_with_http_info(**kwargs)
 
+    def disable_product_filtering(
+        self,
+        ad_id,
+        **kwargs
+    ):
+        """disable_product_filtering  # noqa: E501
+
+        Disable product filtering for a given ad  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.disable_product_filtering(ad_id, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            ad_id (str): ID of the ad
+
+        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:
+            ValueResourceOutcomeOfProductFilterConfig
+                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['ad_id'] = \
+            ad_id
+        return self.disable_product_filtering_endpoint.call_with_http_info(**kwargs)
+
+    def enable_product_filtering(
+        self,
+        ad_id,
+        **kwargs
+    ):
+        """enable_product_filtering  # noqa: E501
+
+        Enable product filtering for a given ad  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.enable_product_filtering(ad_id, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            ad_id (str): ID of the ad
+
+        Keyword Args:
+            value_resource_input_of_create_product_filter_request (ValueResourceInputOfCreateProductFilterRequest): [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:
+            ValueResourceOutcomeOfProductFilterConfig
+                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['ad_id'] = \
+            ad_id
+        return self.enable_product_filtering_endpoint.call_with_http_info(**kwargs)
+
+    def fetch_product_filtering_config(
+        self,
+        ad_id,
+        **kwargs
+    ):
+        """fetch_product_filtering_config  # noqa: E501
+
+        Fetch product filtering configuration for a given ad  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.fetch_product_filtering_config(ad_id, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            ad_id (str): ID of the ad
+
+        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:
+            ValueResourceOutcomeOfProductFilterConfig
+                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['ad_id'] = \
+            ad_id
+        return self.fetch_product_filtering_config_endpoint.call_with_http_info(**kwargs)
+
+    def fetch_product_filtering_usages(
+        self,
+        product_set_id,
+        **kwargs
+    ):
+        """fetch_product_filtering_usages  # noqa: E501
+
+        Fetch product filtering usages for a given product set  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.fetch_product_filtering_usages(product_set_id, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            product_set_id (str): ID of the product set
+
+        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:
+            ValueResourceCollectionOutcomeOfProductFilterConfig
+                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['product_set_id'] = \
+            product_set_id
+        return self.fetch_product_filtering_usages_endpoint.call_with_http_info(**kwargs)
+
     def fetch_product_set(
         self,
         product_set_id,

criteo_api_marketingsolutions_preview/api_client.py

@@ -3,7 +3,7 @@
 
     Criteo API - MarketingSolutions  # noqa: E501
 
-    The version of the OpenAPI document: Preview
+    The version of the OpenAPI document: preview
     Generated by: https://openapi-generator.tech
 """
 
@@ -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/0.0.240626/python'
+        self.user_agent = 'OpenAPI-Generator/0.0.240808/python'
 
     def __enter__(self):
         return self

criteo_api_marketingsolutions_preview/configuration.py

@@ -3,7 +3,7 @@
 
     Criteo API - MarketingSolutions  # noqa: E501
 
-    The version of the OpenAPI document: Preview
+    The version of the OpenAPI document: preview
     Generated by: https://openapi-generator.tech
 """
 
@@ -394,8 +394,8 @@ class Configuration(object):
         return "Python SDK Debug Report:\n"\
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
-               "Version of the API: Preview\n"\
-               "SDK Package Version: 0.0.240626".\
+               "Version of the API: preview\n"\
+               "SDK Package Version: 0.0.240808".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

criteo_api_marketingsolutions_preview/exceptions.py

@@ -3,7 +3,7 @@
 
     Criteo API - MarketingSolutions  # noqa: E501
 
-    The version of the OpenAPI document: Preview
+    The version of the OpenAPI document: preview
     Generated by: https://openapi-generator.tech
 """
 

criteo_api_marketingsolutions_preview/model/ad.py

@@ -3,7 +3,7 @@
 
     Criteo API - MarketingSolutions  # noqa: E501
 
-    The version of the OpenAPI document: Preview
+    The version of the OpenAPI document: preview
     Generated by: https://openapi-generator.tech
 """
 

criteo_api_marketingsolutions_preview/model/ad_list_response.py

@@ -3,7 +3,7 @@
 
     Criteo API - MarketingSolutions  # noqa: E501
 
-    The version of the OpenAPI document: Preview
+    The version of the OpenAPI document: preview
     Generated by: https://openapi-generator.tech
 """
 

criteo_api_marketingsolutions_preview/model/ad_resource.py

@@ -3,7 +3,7 @@
 
     Criteo API - MarketingSolutions  # noqa: E501
 
-    The version of the OpenAPI document: Preview
+    The version of the OpenAPI document: preview
     Generated by: https://openapi-generator.tech
 """
 

criteo_api_marketingsolutions_preview/model/ad_response.py

@@ -3,7 +3,7 @@
 
     Criteo API - MarketingSolutions  # noqa: E501
 
-    The version of the OpenAPI document: Preview
+    The version of the OpenAPI document: preview
     Generated by: https://openapi-generator.tech
 """
 

criteo_api_marketingsolutions_preview/model/ad_set_audience_link_entity_v1.py

@@ -3,7 +3,7 @@
 
     Criteo API - MarketingSolutions  # noqa: E501
 
-    The version of the OpenAPI document: Preview
+    The version of the OpenAPI document: preview
     Generated by: https://openapi-generator.tech
 """