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

criteo_api_retailmedia_preview/model/message_error.py

@@ -0,0 +1,275 @@
+"""
+    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
+
+
+
+class MessageError(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 = {
+    }
+
+    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
+        """
+        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+
+    _nullable = False
+
+    @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.
+        """
+        return {
+            'trace_id': (str, none_type,),  # noqa: E501
+            'type': (str, none_type,),  # noqa: E501
+            'code': (str, none_type,),  # noqa: E501
+            'instance': (str, none_type,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'trace_id': 'traceId',  # noqa: E501
+        'type': 'type',  # noqa: E501
+        'code': 'code',  # noqa: E501
+        'instance': 'instance',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """MessageError - 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,)
+            trace_id (str, none_type): correlation ID, unique to each request. [optional]  # noqa: E501
+            type (str, none_type): error category. [optional]  # noqa: E501
+            code (str, none_type): error code. [optional]  # noqa: E501
+            instance (str, none_type): specific occurrence of the problem. [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
+        """MessageError - 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,)
+            trace_id (str, none_type): correlation ID, unique to each request. [optional]  # noqa: E501
+            type (str, none_type): error category. [optional]  # noqa: E501
+            code (str, none_type): error code. [optional]  # noqa: E501
+            instance (str, none_type): specific occurrence of the problem. [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.")

criteo_api_retailmedia_preview/model/product.py

@@ -189,6 +189,7 @@ class Product(ModelNormal):
             'external_seller_name': (str, none_type,),  # noqa: E501
             'number_of_reviews': (int, none_type,),  # noqa: E501
             'product_rating': (str, none_type,),  # noqa: E501
+            'badge': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -278,6 +279,7 @@ class Product(ModelNormal):
         'external_seller_name': 'externalSellerName',  # noqa: E501
         'number_of_reviews': 'numberOfReviews',  # noqa: E501
         'product_rating': 'productRating',  # noqa: E501
+        'badge': 'badge',  # noqa: E501
     }
 
     read_only_vars = {
@@ -404,6 +406,7 @@ class Product(ModelNormal):
             external_seller_name (str, none_type): The external name of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads.. [optional]  # noqa: E501
             number_of_reviews (int, none_type): The number of customer reviews for the product. [optional]  # noqa: E501
             product_rating (str, none_type): The product rating for the product. [optional]  # noqa: E501
+            badge (str, none_type): URL of a badge image to display on the product.. [optional]  # noqa: E501
         """
 
         channel = kwargs.get('channel', "online")
@@ -578,6 +581,7 @@ class Product(ModelNormal):
             external_seller_name (str, none_type): The external name of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads.. [optional]  # noqa: E501
             number_of_reviews (int, none_type): The number of customer reviews for the product. [optional]  # noqa: E501
             product_rating (str, none_type): The product rating for the product. [optional]  # noqa: E501
+            badge (str, none_type): URL of a badge image to display on the product.. [optional]  # noqa: E501
         """
 
         channel = kwargs.get('channel', "online")

criteo_api_retailmedia_preview/model/{rm_legacy_segment_user_behavior_v1.py → product_recommendation.py}

@@ -30,7 +30,7 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 
-class RmLegacySegmentUserBehaviorV1(ModelNormal):
+class ProductRecommendation(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -55,31 +55,16 @@ class RmLegacySegmentUserBehaviorV1(ModelNormal):
     """
 
     allowed_values = {
-        ('user_type',): {
-            'VIEWER': "viewer",
-            'BUYER': "buyer",
-            'ADDTOCARTER': "addToCarter",
-        },
-        ('lookback_window',): {
-            'P7D': "P7D",
-            'P14D': "P14D",
-            'P30D': "P30D",
-            'P45D': "P45D",
-            'P60D': "P60D",
-            'P90D': "P90D",
-            'P120D': "P120D",
-            'P150D': "P150D",
-            'P180D': "P180D",
-        },
-        ('target_type',): {
-            'None': None,
-            'BRAND': "brand",
-            'CATEGORY': "category",
-        },
     }
 
     validations = {
-        ('target_ids',): {
+        ('image_url',): {
+            'max_length': 65536,
+            'min_length': 1,
+        },
+        ('url',): {
+            'max_length': 65536,
+            'min_length': 1,
         },
     }
 
@@ -104,10 +89,14 @@ class RmLegacySegmentUserBehaviorV1(ModelNormal):
                 and the value is attribute type.
         """
         return {
-            'user_type': (str,),  # noqa: E501
-            'lookback_window': (str,),  # noqa: E501
-            'target_type': (str, none_type,),  # noqa: E501
-            'target_ids': ([str], none_type,),  # noqa: E501
+            'rationale': (str,),  # noqa: E501
+            'name': (str, none_type,),  # noqa: E501
+            'description': (str, none_type,),  # noqa: E501
+            'image_url': (str, none_type,),  # noqa: E501
+            'url': (str, none_type,),  # noqa: E501
+            'brand': (str, none_type,),  # noqa: E501
+            'price': (float, none_type,),  # noqa: E501
+            'currency': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -116,10 +105,14 @@ class RmLegacySegmentUserBehaviorV1(ModelNormal):
 
 
     attribute_map = {
-        'user_type': 'userType',  # noqa: E501
-        'lookback_window': 'lookbackWindow',  # noqa: E501
-        'target_type': 'targetType',  # noqa: E501
-        'target_ids': 'targetIds',  # noqa: E501
+        'rationale': 'rationale',  # noqa: E501
+        'name': 'name',  # noqa: E501
+        'description': 'description',  # noqa: E501
+        'image_url': 'imageUrl',  # noqa: E501
+        'url': 'url',  # noqa: E501
+        'brand': 'brand',  # noqa: E501
+        'price': 'price',  # noqa: E501
+        'currency': 'currency',  # noqa: E501
     }
 
     read_only_vars = {
@@ -129,12 +122,11 @@ class RmLegacySegmentUserBehaviorV1(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, user_type, lookback_window, *args, **kwargs):  # noqa: E501
-        """RmLegacySegmentUserBehaviorV1 - a model defined in OpenAPI
+    def _from_openapi_data(cls, rationale, *args, **kwargs):  # noqa: E501
+        """ProductRecommendation - a model defined in OpenAPI
 
         Args:
-            user_type (str): Type of shopper activity used to generate the audience.
-            lookback_window (str): Length of lookback window
+            rationale (str): reason for this recommendation, given by the bot
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -167,8 +159,13 @@ class RmLegacySegmentUserBehaviorV1(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            target_type (str, none_type): Type of target. [optional]  # noqa: E501
-            target_ids ([str], none_type): The categories to target. [optional]  # noqa: E501
+            name (str, none_type): name of the product. [optional]  # noqa: E501
+            description (str, none_type): description of the product. [optional]  # noqa: E501
+            image_url (str, none_type): url of the product image. [optional]  # noqa: E501
+            url (str, none_type): url of the product on the retailer website. [optional]  # noqa: E501
+            brand (str, none_type): brand of the product. [optional]  # noqa: E501
+            price (float, none_type): numerical value of the price of the product. [optional]  # noqa: E501
+            currency (str, none_type): currency of the price of the product. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -200,8 +197,7 @@ class RmLegacySegmentUserBehaviorV1(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.user_type = user_type
-        self.lookback_window = lookback_window
+        self.rationale = rationale
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -222,12 +218,11 @@ class RmLegacySegmentUserBehaviorV1(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, user_type, lookback_window, *args, **kwargs):  # noqa: E501
-        """RmLegacySegmentUserBehaviorV1 - a model defined in OpenAPI
+    def __init__(self, rationale, *args, **kwargs):  # noqa: E501
+        """ProductRecommendation - a model defined in OpenAPI
 
         Args:
-            user_type (str): Type of shopper activity used to generate the audience.
-            lookback_window (str): Length of lookback window
+            rationale (str): reason for this recommendation, given by the bot
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -260,8 +255,13 @@ class RmLegacySegmentUserBehaviorV1(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            target_type (str, none_type): Type of target. [optional]  # noqa: E501
-            target_ids ([str], none_type): The categories to target. [optional]  # noqa: E501
+            name (str, none_type): name of the product. [optional]  # noqa: E501
+            description (str, none_type): description of the product. [optional]  # noqa: E501
+            image_url (str, none_type): url of the product image. [optional]  # noqa: E501
+            url (str, none_type): url of the product on the retailer website. [optional]  # noqa: E501
+            brand (str, none_type): brand of the product. [optional]  # noqa: E501
+            price (float, none_type): numerical value of the price of the product. [optional]  # noqa: E501
+            currency (str, none_type): currency of the price of the product. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -291,8 +291,7 @@ class RmLegacySegmentUserBehaviorV1(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.user_type = user_type
-        self.lookback_window = lookback_window
+        self.rationale = rationale
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \

criteo_api_retailmedia_preview/model/promoted_product_resource_collection_outcome.py

@@ -86,7 +86,7 @@ class PromotedProductResourceCollectionOutcome(ModelNormal):
         return {
             'errors': ([RmcaCommonProblem], none_type,),  # noqa: E501
             'warnings': ([RmcaCommonProblem], none_type,),  # noqa: E501
-            'meta': (ProductMetadata,),  # noqa: E501
+            'metadata': (ProductMetadata,),  # noqa: E501
             'data': ([PromotedProductResource], none_type,),  # noqa: E501
         }
 
@@ -98,11 +98,13 @@ class PromotedProductResourceCollectionOutcome(ModelNormal):
     attribute_map = {
         'errors': 'errors',  # noqa: E501
         'warnings': 'warnings',  # noqa: E501
-        'meta': 'meta',  # noqa: E501
+        'metadata': 'metadata',  # noqa: E501
         'data': 'data',  # noqa: E501
     }
 
     read_only_vars = {
+        'errors',  # noqa: E501
+        'warnings',  # noqa: E501
     }
 
     _composed_schemas = {}
@@ -145,7 +147,7 @@ class PromotedProductResourceCollectionOutcome(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             errors ([RmcaCommonProblem], none_type): [optional]  # noqa: E501
             warnings ([RmcaCommonProblem], none_type): [optional]  # noqa: E501
-            meta (ProductMetadata): [optional]  # noqa: E501
+            metadata (ProductMetadata): [optional]  # noqa: E501
             data ([PromotedProductResource], none_type): [optional]  # noqa: E501
         """
 
@@ -234,7 +236,7 @@ class PromotedProductResourceCollectionOutcome(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             errors ([RmcaCommonProblem], none_type): [optional]  # noqa: E501
             warnings ([RmcaCommonProblem], none_type): [optional]  # noqa: E501
-            meta (ProductMetadata): [optional]  # noqa: E501
+            metadata (ProductMetadata): [optional]  # noqa: E501
             data ([PromotedProductResource], none_type): [optional]  # noqa: E501
         """