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

criteo_api_retailmedia_preview/model/async_line_items_report.py

@@ -55,6 +55,18 @@ class AsyncLineItemsReport(ModelNormal):
     """
 
     allowed_values = {
+        ('search_term_types',): {
+            'None': None,
+            'UNKNOWN': "unknown",
+            'SEARCHED': "searched",
+            'ENTERED': "entered",
+        },
+        ('search_term_targetings',): {
+            'None': None,
+            'UNKNOWN': "unknown",
+            'AUTOMATIC': "automatic",
+            'MANUAL': "manual",
+        },
         ('campaign_type',): {
             'None': None,
             'ALL': "all",
@@ -84,6 +96,7 @@ class AsyncLineItemsReport(ModelNormal):
             'ATTRIBUTEDTRANSACTIONS': "attributedTransactions",
             'ENVIRONMENT': "environment",
             'SERVEDCATEGORY': "servedCategory",
+            'CAPOUT': "capout",
         },
         ('click_attribution_window',): {
             'None': None,
@@ -122,9 +135,18 @@ class AsyncLineItemsReport(ModelNormal):
             'ENVIRONMENT': "environment",
             'PAGETYPENAME': "pageTypeName",
             'PAGECATEGORY': "pageCategory",
+            'SERVEDCATEGORY': "servedCategory",
             'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb",
             'KEYWORD': "keyword",
             'SEARCHTERM': "searchTerm",
+            'SEARCHTERMTYPE': "searchTermType",
+            'SEARCHTERMTARGETING': "searchTermTargeting",
+            'CREATIVEID': "creativeId",
+            'CREATIVENAME': "creativeName",
+            'CREATIVETYPEID': "creativeTypeId",
+            'CREATIVETYPENAME': "creativeTypeName",
+            'CREATIVETEMPLATEID': "creativeTemplateId",
+            'CREATIVETEMPLATENAME': "creativeTemplateName",
         },
         ('metrics',): {
             'None': None,
@@ -149,6 +171,16 @@ class AsyncLineItemsReport(ModelNormal):
             'VIDEOSPLAYEDTO100': "videosPlayedTo100",
             'VIDEOPLAYINGRATE': "videoPlayingRate",
             'VIDEOCOMPLETIONRATE': "videoCompletionRate",
+            'VIDEOIMPRESSIONS': "videoImpressions",
+            'VIDEOMUTED': "videoMuted",
+            'VIDEOUNMUTED': "videoUnmuted",
+            'VIDEOPAUSED': "videoPaused",
+            'VIDEORESUMED': "videoResumed",
+            'VIDEOAVGINTERACTIONRATE': "videoAvgInteractionRate",
+            'VIDEOVIEWABILITY': "videoViewability",
+            'VIDEOSTARTINGRATE': "videoStartingRate",
+            'VIDEOCPC': "videoCPC",
+            'VIDEOCPCV': "videoCPCV",
             'UNIQUEVISITORS': "uniqueVisitors",
             'FREQUENCY': "frequency",
         },
@@ -182,6 +214,8 @@ class AsyncLineItemsReport(ModelNormal):
             'end_date': (datetime,),  # noqa: E501
             'ids': ([str], none_type,),  # noqa: E501
             'id': (str, none_type,),  # noqa: E501
+            'search_term_types': ([str], none_type,),  # noqa: E501
+            'search_term_targetings': ([str], none_type,),  # noqa: E501
             'campaign_type': (str, none_type,),  # noqa: E501
             'sales_channel': (str, none_type,),  # noqa: E501
             'format': (str, none_type,),  # noqa: E501
@@ -203,6 +237,8 @@ class AsyncLineItemsReport(ModelNormal):
         'end_date': 'endDate',  # noqa: E501
         'ids': 'ids',  # noqa: E501
         'id': 'id',  # noqa: E501
+        'search_term_types': 'searchTermTypes',  # noqa: E501
+        'search_term_targetings': 'searchTermTargetings',  # noqa: E501
         'campaign_type': 'campaignType',  # noqa: E501
         'sales_channel': 'salesChannel',  # noqa: E501
         'format': 'format',  # noqa: E501
@@ -261,6 +297,8 @@ class AsyncLineItemsReport(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             ids ([str], none_type): Line Item ids to report on. [optional]  # noqa: E501
             id (str, none_type): Line Item id to report on. [optional]  # noqa: E501
+            search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional]  # noqa: E501
+            search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [optional]  # noqa: E501
             campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all"  # noqa: E501
             sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all"  # noqa: E501
             format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact"  # noqa: E501
@@ -363,6 +401,8 @@ class AsyncLineItemsReport(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             ids ([str], none_type): Line Item ids to report on. [optional]  # noqa: E501
             id (str, none_type): Line Item id to report on. [optional]  # noqa: E501
+            search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional]  # noqa: E501
+            search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [optional]  # noqa: E501
             campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all"  # noqa: E501
             sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all"  # noqa: E501
             format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact"  # noqa: E501

criteo_api_retailmedia_preview/model/balance_response_v2_response.py

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

criteo_api_retailmedia_preview/model/{creative_v2_response.py → bot_message.py}

@@ -30,13 +30,11 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_preview.model.common_problem import CommonProblem
-    from criteo_api_retailmedia_preview.model.resource_of_creative_v2 import ResourceOfCreativeV2
-    globals()['CommonProblem'] = CommonProblem
-    globals()['ResourceOfCreativeV2'] = ResourceOfCreativeV2
+    from criteo_api_retailmedia_preview.model.product_recommendation import ProductRecommendation
+    globals()['ProductRecommendation'] = ProductRecommendation
 
 
-class CreativeV2Response(ModelNormal):
+class BotMessage(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -89,9 +87,9 @@ class CreativeV2Response(ModelNormal):
         """
         lazy_import()
         return {
-            'data': (ResourceOfCreativeV2,),  # noqa: E501
-            'warnings': ([CommonProblem], none_type,),  # noqa: E501
-            'errors': ([CommonProblem], none_type,),  # noqa: E501
+            'opening': (str, none_type,),  # noqa: E501
+            'product_recos': ([ProductRecommendation], none_type,),  # noqa: E501
+            'closing': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -100,14 +98,12 @@ class CreativeV2Response(ModelNormal):
 
 
     attribute_map = {
-        'data': 'data',  # noqa: E501
-        'warnings': 'warnings',  # noqa: E501
-        'errors': 'errors',  # noqa: E501
+        'opening': 'opening',  # noqa: E501
+        'product_recos': 'productRecos',  # noqa: E501
+        'closing': 'closing',  # noqa: E501
     }
 
     read_only_vars = {
-        'warnings',  # noqa: E501
-        'errors',  # noqa: E501
     }
 
     _composed_schemas = {}
@@ -115,7 +111,7 @@ class CreativeV2Response(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """CreativeV2Response - a model defined in OpenAPI
+        """BotMessage - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -148,9 +144,9 @@ class CreativeV2Response(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            data (ResourceOfCreativeV2): [optional]  # noqa: E501
-            warnings ([CommonProblem], none_type): [optional]  # noqa: E501
-            errors ([CommonProblem], none_type): [optional]  # noqa: E501
+            opening (str, none_type): opening comment from the bot, introducing the list of recommended products if relevant.. [optional]  # noqa: E501
+            product_recos ([ProductRecommendation], none_type): list of recommended products. [optional]  # noqa: E501
+            closing (str, none_type): closing remark from the bot. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -203,7 +199,7 @@ class CreativeV2Response(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """CreativeV2Response - a model defined in OpenAPI
+        """BotMessage - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -236,9 +232,9 @@ class CreativeV2Response(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            data (ResourceOfCreativeV2): [optional]  # noqa: E501
-            warnings ([CommonProblem], none_type): [optional]  # noqa: E501
-            errors ([CommonProblem], none_type): [optional]  # noqa: E501
+            opening (str, none_type): opening comment from the bot, introducing the list of recommended products if relevant.. [optional]  # noqa: E501
+            product_recos ([ProductRecommendation], none_type): list of recommended products. [optional]  # noqa: E501
+            closing (str, none_type): closing remark from the bot. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

criteo_api_retailmedia_preview/model/botmessage.py

@@ -0,0 +1,329 @@
+"""
+    Criteo API
+
+    Criteo API - RetailMedia  # 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_retailmedia_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_retailmedia_preview.exceptions import ApiAttributeError
+
+
+def lazy_import():
+    from criteo_api_retailmedia_preview.model.bot_message import BotMessage
+    from criteo_api_retailmedia_preview.model.product_recommendation import ProductRecommendation
+    globals()['BotMessage'] = BotMessage
+    globals()['ProductRecommendation'] = ProductRecommendation
+
+
+class Botmessage(ModelComposed):
+    """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 = {
+    }
+
+    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 {
+            'opening': (str, none_type,),  # noqa: E501
+            'product_recos': ([ProductRecommendation], none_type,),  # noqa: E501
+            'closing': (str, none_type,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'opening': 'opening',  # noqa: E501
+        'product_recos': 'productRecos',  # noqa: E501
+        'closing': 'closing',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """Botmessage - 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,)
+            opening (str, none_type): opening comment from the bot, introducing the list of recommended products if relevant.. [optional]  # noqa: E501
+            product_recos ([ProductRecommendation], none_type): list of recommended products. [optional]  # noqa: E501
+            closing (str, none_type): closing remark from the bot. [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', ())
+
+        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__,)
+
+        constant_args = {
+            '_check_type': _check_type,
+            '_path_to_item': _path_to_item,
+            '_spec_property_naming': _spec_property_naming,
+            '_configuration': _configuration,
+            '_visited_composed_classes': self._visited_composed_classes,
+        }
+        composed_info = validate_get_composed_info(
+            constant_args, kwargs, self)
+        self._composed_instances = composed_info[0]
+        self._var_name_to_model_instances = composed_info[1]
+        self._additional_properties_model_instances = composed_info[2]
+        discarded_args = composed_info[3]
+
+        for var_name, var_value in kwargs.items():
+            if var_name in discarded_args and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self._additional_properties_model_instances:
+                # 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',
+        '_composed_instances',
+        '_var_name_to_model_instances',
+        '_additional_properties_model_instances',
+    ])
+
+    @convert_js_args_to_python_args
+    def __init__(self, *args, **kwargs):  # noqa: E501
+        """Botmessage - 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,)
+            opening (str, none_type): opening comment from the bot, introducing the list of recommended products if relevant.. [optional]  # noqa: E501
+            product_recos ([ProductRecommendation], none_type): list of recommended products. [optional]  # noqa: E501
+            closing (str, none_type): closing remark from the bot. [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__,)
+
+        constant_args = {
+            '_check_type': _check_type,
+            '_path_to_item': _path_to_item,
+            '_spec_property_naming': _spec_property_naming,
+            '_configuration': _configuration,
+            '_visited_composed_classes': self._visited_composed_classes,
+        }
+        composed_info = validate_get_composed_info(
+            constant_args, kwargs, self)
+        self._composed_instances = composed_info[0]
+        self._var_name_to_model_instances = composed_info[1]
+        self._additional_properties_model_instances = composed_info[2]
+        discarded_args = composed_info[3]
+
+        for var_name, var_value in kwargs.items():
+            if var_name in discarded_args and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self._additional_properties_model_instances:
+                # 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.")
+
+    @cached_property
+    def _composed_schemas():
+        # we need this here to make our import statements work
+        # we must store _composed_schemas in here so the code is only run
+        # when we invoke this method. If we kept this at the class
+        # level we would get an error because the class level
+        # code would be run when this module is imported, and these composed
+        # classes don't exist yet because their module has not finished
+        # loading
+        lazy_import()
+        return {
+          'anyOf': [
+          ],
+          'allOf': [
+              BotMessage,
+          ],
+          'oneOf': [
+          ],
+        }