criteo-api-marketingsolutions-sdk 0.0.250915__py3-none-any.whl → 0.0.251009__py3-none-any.whl

criteo_api_marketingsolutions_preview/api/creative_api.py

@@ -23,7 +23,7 @@ from criteo_api_marketingsolutions_preview.model_utils import (  # noqa: F401
 )
 from criteo_api_marketingsolutions_preview.model.resource_collection_outcome_of_ad import ResourceCollectionOutcomeOfAd
 from criteo_api_marketingsolutions_preview.model.resource_collection_outcome_of_coupon import ResourceCollectionOutcomeOfCoupon
-from criteo_api_marketingsolutions_preview.model.resource_collection_outcome_of_creative import ResourceCollectionOutcomeOfCreative
+from criteo_api_marketingsolutions_preview.model.resource_collection_outcome_of_creative_read import ResourceCollectionOutcomeOfCreativeRead
 from criteo_api_marketingsolutions_preview.model.resource_input_of_ad_write import ResourceInputOfAdWrite
 from criteo_api_marketingsolutions_preview.model.resource_input_of_create_coupon import ResourceInputOfCreateCoupon
 from criteo_api_marketingsolutions_preview.model.resource_input_of_creative_write import ResourceInputOfCreativeWrite
@@ -931,7 +931,7 @@ class CreativeApi(object):
         )
         self.get_advertiser_creatives_endpoint = _Endpoint(
             settings={
-                'response_type': (ResourceCollectionOutcomeOfCreative,),
+                'response_type': (ResourceCollectionOutcomeOfCreativeRead,),
                 'auth': [
                     'oauth',
                     'oauth'
@@ -2388,7 +2388,7 @@ class CreativeApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            ResourceCollectionOutcomeOfCreative
+            ResourceCollectionOutcomeOfCreativeRead
                 If the method is called asynchronously, returns the request
                 thread.
         """

criteo_api_marketingsolutions_preview/api/on_site_recommendation_api.py

@@ -36,7 +36,7 @@ class OnSiteRecommendationApi(object):
         if api_client is None:
             api_client = ApiClient()
         self.api_client = api_client
-        self.api_v1_reco_post_endpoint = _Endpoint(
+        self.search_recommended_products_endpoint = _Endpoint(
             settings={
                 'response_type': (OnSiteRecoResponse,),
                 'auth': [
@@ -44,7 +44,7 @@ class OnSiteRecommendationApi(object):
                     'oauth'
                 ],
                 'endpoint_path': '/preview/recommendation/search',
-                'operation_id': 'api_v1_reco_post',
+                'operation_id': 'search_recommended_products',
                 'http_method': 'POST',
                 'servers': None,
             },
@@ -88,17 +88,17 @@ class OnSiteRecommendationApi(object):
             api_client=api_client
         )
 
-    def api_v1_reco_post(
+    def search_recommended_products(
         self,
         **kwargs
     ):
-        """api_v1_reco_post  # noqa: E501
+        """search_recommended_products  # noqa: E501
 
         Retrieves a list of products recommended for the given user. This end point can either rely on a Criteo UserId, or a list of user events to perform the recommendation.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.api_v1_reco_post(async_req=True)
+        >>> thread = api.search_recommended_products(async_req=True)
         >>> result = thread.get()
 
 
@@ -165,5 +165,5 @@ class OnSiteRecommendationApi(object):
             '_content_type')
         kwargs['_host_index'] = kwargs.get('_host_index')
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
-        return self.api_v1_reco_post_endpoint.call_with_http_info(**kwargs)
+        return self.search_recommended_products_endpoint.call_with_http_info(**kwargs)
 

criteo_api_marketingsolutions_preview/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/0.0.250915/python'
+        self.user_agent = 'OpenAPI-Generator/0.0.251009/python'
 
     def __enter__(self):
         return self
@@ -804,10 +804,10 @@ class Endpoint(object):
         Example:
 
         api_instance = AdvertiserApi()
-        api_instance.api_portfolio_get  # this is an instance of the class Endpoint
-        api_instance.api_portfolio_get()  # this invokes api_instance.api_portfolio_get.__call__()
+        api_instance.list_advertisers  # this is an instance of the class Endpoint
+        api_instance.list_advertisers()  # this invokes api_instance.list_advertisers.__call__()
         which then invokes the callable functions stored in that endpoint at
-        api_instance.api_portfolio_get.callable or self.callable in this class
+        api_instance.list_advertisers.callable or self.callable in this class
 
         """
         return self.callable(self, *args, **kwargs)

criteo_api_marketingsolutions_preview/configuration.py

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

criteo_api_marketingsolutions_preview/model/adaptive_attributes.py

@@ -105,10 +105,10 @@ class AdaptiveAttributes(ModelNormal):
         return {
             'calls_to_action': ([str],),  # noqa: E501
             'colors': (AdaptiveColors,),  # noqa: E501
-            'description_font': (str, none_type,),  # noqa: E501
-            'description_text': (str, none_type,),  # noqa: E501
-            'headline_font': (str, none_type,),  # noqa: E501
-            'headline_text': (str, none_type,),  # noqa: E501
+            'description_font': (str,),  # noqa: E501
+            'description_text': (str,),  # noqa: E501
+            'headline_font': (str,),  # noqa: E501
+            'headline_text': (str,),  # noqa: E501
             'landing_page_url': (str,),  # noqa: E501
             'layouts': ([str],),  # noqa: E501
             'logos': ([ImageShape],),  # noqa: E501
@@ -150,10 +150,10 @@ class AdaptiveAttributes(ModelNormal):
         Args:
             calls_to_action ([str]): A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate  response, such as “Buy now” or “Go!”.
             colors (AdaptiveColors):
-            description_font (str, none_type): Font of the description  Valid supported font like \"Arial\"
-            description_text (str, none_type): The description text of the banner
-            headline_font (str, none_type): Font of the headline  Valid supported font like \"Arial\"
-            headline_text (str, none_type): The headline text of the banner
+            description_font (str): Font of the description  Valid supported font like \"Arial\"
+            description_text (str): The description text of the banner
+            headline_font (str): Font of the headline  Valid supported font like \"Arial\"
+            headline_text (str): The headline text of the banner
             landing_page_url (str): Web redirection of the landing page url
             layouts ([str]): The Adaptive layouts that are enabled.  It can contain any of the following values: \"Editorial\", “Montage“, \"InBannerVideo\".
             logos ([ImageShape]): Logo images uploaded on demostatic.criteo.com when deploying and then static.criteo.net
@@ -258,10 +258,10 @@ class AdaptiveAttributes(ModelNormal):
         Args:
             calls_to_action ([str]): A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate  response, such as “Buy now” or “Go!”.
             colors (AdaptiveColors):
-            description_font (str, none_type): Font of the description  Valid supported font like \"Arial\"
-            description_text (str, none_type): The description text of the banner
-            headline_font (str, none_type): Font of the headline  Valid supported font like \"Arial\"
-            headline_text (str, none_type): The headline text of the banner
+            description_font (str): Font of the description  Valid supported font like \"Arial\"
+            description_text (str): The description text of the banner
+            headline_font (str): Font of the headline  Valid supported font like \"Arial\"
+            headline_text (str): The headline text of the banner
             landing_page_url (str): Web redirection of the landing page url
             layouts ([str]): The Adaptive layouts that are enabled.  It can contain any of the following values: \"Editorial\", “Montage“, \"InBannerVideo\".
             logos ([ImageShape]): Logo images uploaded on demostatic.criteo.com when deploying and then static.criteo.net

criteo_api_marketingsolutions_preview/model/adaptive_colors.py

@@ -68,7 +68,7 @@ class AdaptiveColors(ModelNormal):
         """
         return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
 
-    _nullable = False
+    _nullable = True
 
     @cached_property
     def openapi_types():

criteo_api_marketingsolutions_preview/model/adaptive_read_attributes.py

@@ -0,0 +1,330 @@
+"""
+    Criteo API
+
+    Criteo API - MarketingSolutions  # noqa: E501
+
+    The version of the OpenAPI document: Preview
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from criteo_api_marketingsolutions_preview.model_utils import (  # noqa: F401
+    ApiTypeError,
+    ModelComposed,
+    ModelNormal,
+    ModelSimple,
+    cached_property,
+    change_keys_js_to_python,
+    convert_js_args_to_python_args,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_get_composed_info,
+    OpenApiModel
+)
+from criteo_api_marketingsolutions_preview.exceptions import ApiAttributeError
+
+
+def lazy_import():
+    from criteo_api_marketingsolutions_preview.model.adaptive_colors import AdaptiveColors
+    from criteo_api_marketingsolutions_preview.model.image_set import ImageSet
+    from criteo_api_marketingsolutions_preview.model.image_shape import ImageShape
+    from criteo_api_marketingsolutions_preview.model.video_detail import VideoDetail
+    globals()['AdaptiveColors'] = AdaptiveColors
+    globals()['ImageSet'] = ImageSet
+    globals()['ImageShape'] = ImageShape
+    globals()['VideoDetail'] = VideoDetail
+
+
+class AdaptiveReadAttributes(ModelNormal):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+
+    Attributes:
+      allowed_values (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          with a capitalized key describing the allowed value and an allowed
+          value. These dicts store the allowed enum values.
+      attribute_map (dict): The key is attribute name
+          and the value is json key in definition.
+      discriminator_value_class_map (dict): A dict to go from the discriminator
+          variable value to the discriminator class name.
+      validations (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          that stores validations for max_length, min_length, max_items,
+          min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+          inclusive_minimum, and regex.
+      additional_properties_type (tuple): A tuple of classes accepted
+          as additional properties values.
+    """
+
+    allowed_values = {
+        ('image_display',): {
+            'None': None,
+            'SHOWFULLIMAGE': "ShowFullImage",
+            'ZOOMONIMAGE': "ZoomOnImage",
+        },
+        ('layouts',): {
+            'None': None,
+            'EDITORIAL': "Editorial",
+            'MONTAGE': "Montage",
+            'INBANNERVIDEO': "InBannerVideo",
+        },
+    }
+
+    validations = {
+    }
+
+    @cached_property
+    def additional_properties_type():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+        """
+        lazy_import()
+        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+
+    _nullable = True
+
+    @cached_property
+    def openapi_types():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+
+        Returns
+            openapi_types (dict): The key is attribute name
+                and the value is attribute type.
+        """
+        lazy_import()
+        return {
+            'calls_to_action': ([str], none_type,),  # noqa: E501
+            'colors': (AdaptiveColors,),  # noqa: E501
+            'description_font': (str, none_type,),  # noqa: E501
+            'description_text': (str, none_type,),  # noqa: E501
+            'headline_font': (str, none_type,),  # noqa: E501
+            'headline_text': (str, none_type,),  # noqa: E501
+            'image_display': (str, none_type,),  # noqa: E501
+            'image_sets': ([ImageSet], none_type,),  # noqa: E501
+            'landing_page_url': (str, none_type,),  # noqa: E501
+            'layouts': ([str], none_type,),  # noqa: E501
+            'logos': ([ImageShape], none_type,),  # noqa: E501
+            'videos': ([VideoDetail], none_type,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'calls_to_action': 'callsToAction',  # noqa: E501
+        'colors': 'colors',  # noqa: E501
+        'description_font': 'descriptionFont',  # noqa: E501
+        'description_text': 'descriptionText',  # noqa: E501
+        'headline_font': 'headlineFont',  # noqa: E501
+        'headline_text': 'headlineText',  # noqa: E501
+        'image_display': 'imageDisplay',  # noqa: E501
+        'image_sets': 'imageSets',  # noqa: E501
+        'landing_page_url': 'landingPageUrl',  # noqa: E501
+        'layouts': 'layouts',  # noqa: E501
+        'logos': 'logos',  # noqa: E501
+        'videos': 'videos',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """AdaptiveReadAttributes - a model defined in OpenAPI
+
+        Keyword Args:
+            _check_type (bool): if True, values for parameters in openapi_types
+                                will be type checked and a TypeError will be
+                                raised if the wrong type is input.
+                                Defaults to True
+            _path_to_item (tuple/list): This is a list of keys or values to
+                                drill down to the model in received_data
+                                when deserializing a response
+            _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)
+            _configuration (Configuration): the instance to use when
+                                deserializing a file_type parameter.
+                                If passed, type conversion is attempted
+                                If omitted no type conversion is done.
+            _visited_composed_classes (tuple): This stores a tuple of
+                                classes that we have traveled through so that
+                                if we see that class again we will not use its
+                                discriminator again.
+                                When traveling through a discriminator, the
+                                composed schema that is
+                                is traveled through is added to this set.
+                                For example if Animal has a discriminator
+                                petType and we pass in "Dog", and the class Dog
+                                allOf includes Animal, we move through Animal
+                                once using the discriminator, and pick Dog.
+                                Then in Dog, we will make an instance of the
+                                Animal class but this time we won't travel
+                                through its discriminator because we passed in
+                                _visited_composed_classes = (Animal,)
+            calls_to_action ([str], none_type): A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate  response, such as “Buy now” or “Go!”.. [optional]  # noqa: E501
+            colors (AdaptiveColors): [optional]  # noqa: E501
+            description_font (str, none_type): Font of the description  Valid supported font like \"Arial\". [optional]  # noqa: E501
+            description_text (str, none_type): The description text of the banner. [optional]  # noqa: E501
+            headline_font (str, none_type): Font of the headline  Valid supported font like \"Arial\". [optional]  # noqa: E501
+            headline_text (str, none_type): The headline text of the banner. [optional]  # noqa: E501
+            image_display (str, none_type): Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your image set should fit inside the allocated  space (\"ShowFullImage\") or whether it should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some  image cropping.. [optional]  # noqa: E501
+            image_sets ([ImageSet], none_type): Multiple image sets, each image set consists of multiple images and a headline text.. [optional]  # noqa: E501
+            landing_page_url (str, none_type): Web redirection of the landing page url. [optional]  # noqa: E501
+            layouts ([str], none_type): The Adaptive layouts that are enabled.  It can contain any of the following values: \"Editorial\", “Montage“, \"InBannerVideo\".. [optional]  # noqa: E501
+            logos ([ImageShape], none_type): Logo images uploaded on demostatic.criteo.com when deploying and then static.criteo.net. [optional]  # noqa: E501
+            videos ([VideoDetail], none_type): Multiple videos potentially in different shapes.. [optional]  # noqa: E501
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', True)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        self = super(OpenApiModel, cls).__new__(cls)
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        for var_name, var_value in kwargs.items():
+            if var_name not in self.attribute_map and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self.additional_properties_type is None:
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)
+        return self
+
+    required_properties = set([
+        '_data_store',
+        '_check_type',
+        '_spec_property_naming',
+        '_path_to_item',
+        '_configuration',
+        '_visited_composed_classes',
+    ])
+
+    @convert_js_args_to_python_args
+    def __init__(self, *args, **kwargs):  # noqa: E501
+        """AdaptiveReadAttributes - a model defined in OpenAPI
+
+        Keyword Args:
+            _check_type (bool): if True, values for parameters in openapi_types
+                                will be type checked and a TypeError will be
+                                raised if the wrong type is input.
+                                Defaults to True
+            _path_to_item (tuple/list): This is a list of keys or values to
+                                drill down to the model in received_data
+                                when deserializing a response
+            _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)
+            _configuration (Configuration): the instance to use when
+                                deserializing a file_type parameter.
+                                If passed, type conversion is attempted
+                                If omitted no type conversion is done.
+            _visited_composed_classes (tuple): This stores a tuple of
+                                classes that we have traveled through so that
+                                if we see that class again we will not use its
+                                discriminator again.
+                                When traveling through a discriminator, the
+                                composed schema that is
+                                is traveled through is added to this set.
+                                For example if Animal has a discriminator
+                                petType and we pass in "Dog", and the class Dog
+                                allOf includes Animal, we move through Animal
+                                once using the discriminator, and pick Dog.
+                                Then in Dog, we will make an instance of the
+                                Animal class but this time we won't travel
+                                through its discriminator because we passed in
+                                _visited_composed_classes = (Animal,)
+            calls_to_action ([str], none_type): A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate  response, such as “Buy now” or “Go!”.. [optional]  # noqa: E501
+            colors (AdaptiveColors): [optional]  # noqa: E501
+            description_font (str, none_type): Font of the description  Valid supported font like \"Arial\". [optional]  # noqa: E501
+            description_text (str, none_type): The description text of the banner. [optional]  # noqa: E501
+            headline_font (str, none_type): Font of the headline  Valid supported font like \"Arial\". [optional]  # noqa: E501
+            headline_text (str, none_type): The headline text of the banner. [optional]  # noqa: E501
+            image_display (str, none_type): Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your image set should fit inside the allocated  space (\"ShowFullImage\") or whether it should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some  image cropping.. [optional]  # noqa: E501
+            image_sets ([ImageSet], none_type): Multiple image sets, each image set consists of multiple images and a headline text.. [optional]  # noqa: E501
+            landing_page_url (str, none_type): Web redirection of the landing page url. [optional]  # noqa: E501
+            layouts ([str], none_type): The Adaptive layouts that are enabled.  It can contain any of the following values: \"Editorial\", “Montage“, \"InBannerVideo\".. [optional]  # noqa: E501
+            logos ([ImageShape], none_type): Logo images uploaded on demostatic.criteo.com when deploying and then static.criteo.net. [optional]  # noqa: E501
+            videos ([VideoDetail], none_type): Multiple videos potentially in different shapes.. [optional]  # noqa: E501
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        for var_name, var_value in kwargs.items():
+            if var_name not in self.attribute_map and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self.additional_properties_type is None:
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)
+            if var_name in self.read_only_vars:
+                raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+                                     f"class with read only attributes.")