criteo-api-retailmedia-sdk 0.0.240207__py3-none-any.whl → 0.0.240404__py3-none-any.whl

criteo_api_retailmedia_preview/model/{choice_variable_value.py → product_unit_pricing_base_measure.py}

@@ -30,7 +30,7 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 
-class ChoiceVariableValue(ModelNormal):
+class ProductUnitPricingBaseMeasure(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -81,7 +81,8 @@ class ChoiceVariableValue(ModelNormal):
                 and the value is attribute type.
         """
         return {
-            'chosen_options': ([str],),  # noqa: E501
+            'value': (int, none_type,),  # noqa: E501
+            'unit': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -90,7 +91,8 @@ class ChoiceVariableValue(ModelNormal):
 
 
     attribute_map = {
-        'chosen_options': 'chosenOptions',  # noqa: E501
+        'value': 'value',  # noqa: E501
+        'unit': 'unit',  # noqa: E501
     }
 
     read_only_vars = {
@@ -100,11 +102,8 @@ class ChoiceVariableValue(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, chosen_options, *args, **kwargs):  # noqa: E501
-        """ChoiceVariableValue - a model defined in OpenAPI
-
-        Args:
-            chosen_options ([str]): The chosen options
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """ProductUnitPricingBaseMeasure - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -137,6 +136,8 @@ class ChoiceVariableValue(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            value (int, none_type): The denominator of the unit price.. [optional]  # noqa: E501
+            unit (str, none_type): The unit of the denominator.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -168,7 +169,6 @@ class ChoiceVariableValue(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.chosen_options = chosen_options
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -189,11 +189,8 @@ class ChoiceVariableValue(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, chosen_options, *args, **kwargs):  # noqa: E501
-        """ChoiceVariableValue - a model defined in OpenAPI
-
-        Args:
-            chosen_options ([str]): The chosen options
+    def __init__(self, *args, **kwargs):  # noqa: E501
+        """ProductUnitPricingBaseMeasure - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -226,6 +223,8 @@ class ChoiceVariableValue(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            value (int, none_type): The denominator of the unit price.. [optional]  # noqa: E501
+            unit (str, none_type): The unit of the denominator.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -255,7 +254,6 @@ class ChoiceVariableValue(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.chosen_options = chosen_options
         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/{text_variable_specification.py → product_unit_pricing_measure.py}

@@ -30,7 +30,7 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 
-class TextVariableSpecification(ModelNormal):
+class ProductUnitPricingMeasure(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -81,7 +81,8 @@ class TextVariableSpecification(ModelNormal):
                 and the value is attribute type.
         """
         return {
-            'max_chars': (int, none_type,),  # noqa: E501
+            'value': (float, none_type,),  # noqa: E501
+            'unit': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -90,7 +91,8 @@ class TextVariableSpecification(ModelNormal):
 
 
     attribute_map = {
-        'max_chars': 'maxChars',  # noqa: E501
+        'value': 'value',  # noqa: E501
+        'unit': 'unit',  # noqa: E501
     }
 
     read_only_vars = {
@@ -101,7 +103,7 @@ class TextVariableSpecification(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """TextVariableSpecification - a model defined in OpenAPI
+        """ProductUnitPricingMeasure - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -134,7 +136,8 @@ class TextVariableSpecification(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            max_chars (int, none_type): The maximum amount of characters accepted for the text. [optional]  # noqa: E501
+            value (float, none_type): The measurement of an item.. [optional]  # noqa: E501
+            unit (str, none_type): The unit of measure.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -187,7 +190,7 @@ class TextVariableSpecification(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """TextVariableSpecification - a model defined in OpenAPI
+        """ProductUnitPricingMeasure - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -220,7 +223,8 @@ class TextVariableSpecification(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            max_chars (int, none_type): The maximum amount of characters accepted for the text. [optional]  # noqa: E501
+            value (float, none_type): The measurement of an item.. [optional]  # noqa: E501
+            unit (str, none_type): The unit of measure.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

criteo_api_retailmedia_preview/model/{section.py → products_custom_batch_request.py}

@@ -30,11 +30,11 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_preview.model.template_variable import TemplateVariable
-    globals()['TemplateVariable'] = TemplateVariable
+    from criteo_api_retailmedia_preview.model.products_custom_batch_request_entry import ProductsCustomBatchRequestEntry
+    globals()['ProductsCustomBatchRequestEntry'] = ProductsCustomBatchRequestEntry
 
 
-class Section(ModelNormal):
+class ProductsCustomBatchRequest(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -87,8 +87,7 @@ class Section(ModelNormal):
         """
         lazy_import()
         return {
-            'title': (str,),  # noqa: E501
-            'template_variables': ([TemplateVariable],),  # noqa: E501
+            'entries': ([ProductsCustomBatchRequestEntry],),  # noqa: E501
         }
 
     @cached_property
@@ -97,8 +96,7 @@ class Section(ModelNormal):
 
 
     attribute_map = {
-        'title': 'title',  # noqa: E501
-        'template_variables': 'templateVariables',  # noqa: E501
+        'entries': 'entries',  # noqa: E501
     }
 
     read_only_vars = {
@@ -108,12 +106,11 @@ class Section(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, title, template_variables, *args, **kwargs):  # noqa: E501
-        """Section - a model defined in OpenAPI
+    def _from_openapi_data(cls, entries, *args, **kwargs):  # noqa: E501
+        """ProductsCustomBatchRequest - a model defined in OpenAPI
 
         Args:
-            title (str):
-            template_variables ([TemplateVariable]):
+            entries ([ProductsCustomBatchRequestEntry]): The request entries to be processed in the batch.
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -177,8 +174,7 @@ class Section(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.title = title
-        self.template_variables = template_variables
+        self.entries = entries
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -199,12 +195,11 @@ class Section(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, title, template_variables, *args, **kwargs):  # noqa: E501
-        """Section - a model defined in OpenAPI
+    def __init__(self, entries, *args, **kwargs):  # noqa: E501
+        """ProductsCustomBatchRequest - a model defined in OpenAPI
 
         Args:
-            title (str):
-            template_variables ([TemplateVariable]):
+            entries ([ProductsCustomBatchRequestEntry]): The request entries to be processed in the batch.
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -266,8 +261,7 @@ class Section(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.title = title
-        self.template_variables = template_variables
+        self.entries = entries
         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/{creative_update_model202207.py → products_custom_batch_request_entry.py}

@@ -30,11 +30,11 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_preview.model.template_variable_value import TemplateVariableValue
-    globals()['TemplateVariableValue'] = TemplateVariableValue
+    from criteo_api_retailmedia_preview.model.product import Product
+    globals()['Product'] = Product
 
 
-class CreativeUpdateModel202207(ModelNormal):
+class ProductsCustomBatchRequestEntry(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -59,6 +59,10 @@ class CreativeUpdateModel202207(ModelNormal):
     """
 
     allowed_values = {
+        ('method',): {
+            'DELETE': "delete",
+            'INSERT': "insert",
+        },
     }
 
     validations = {
@@ -87,11 +91,13 @@ class CreativeUpdateModel202207(ModelNormal):
         """
         lazy_import()
         return {
-            'name': (str,),  # noqa: E501
-            'retailer_id': (int,),  # noqa: E501
-            'template_id': (int,),  # noqa: E501
-            'template_variable_values': ([TemplateVariableValue],),  # noqa: E501
-            'brand_id': (int,),  # noqa: E501
+            'merchant_id': (int,),  # noqa: E501
+            'method': (str,),  # noqa: E501
+            'batch_id': (int, none_type,),  # noqa: E501
+            'product_id': (str, none_type,),  # noqa: E501
+            'item_group_id': (str, none_type,),  # noqa: E501
+            'product': (Product,),  # noqa: E501
+            'feed_id': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -100,11 +106,13 @@ class CreativeUpdateModel202207(ModelNormal):
 
 
     attribute_map = {
-        'name': 'name',  # noqa: E501
-        'retailer_id': 'retailerId',  # noqa: E501
-        'template_id': 'templateId',  # noqa: E501
-        'template_variable_values': 'templateVariableValues',  # noqa: E501
-        'brand_id': 'brandId',  # noqa: E501
+        'merchant_id': 'merchantId',  # noqa: E501
+        'method': 'method',  # noqa: E501
+        'batch_id': 'batchId',  # noqa: E501
+        'product_id': 'productId',  # noqa: E501
+        'item_group_id': 'itemGroupId',  # noqa: E501
+        'product': 'product',  # noqa: E501
+        'feed_id': 'feedId',  # noqa: E501
     }
 
     read_only_vars = {
@@ -114,14 +122,12 @@ class CreativeUpdateModel202207(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, name, retailer_id, template_id, template_variable_values, *args, **kwargs):  # noqa: E501
-        """CreativeUpdateModel202207 - a model defined in OpenAPI
+    def _from_openapi_data(cls, merchant_id, method, *args, **kwargs):  # noqa: E501
+        """ProductsCustomBatchRequestEntry - a model defined in OpenAPI
 
         Args:
-            name (str): The name of the creative
-            retailer_id (int): The retailer associated to the creative
-            template_id (int): The creative template used for this creative
-            template_variable_values ([TemplateVariableValue]): The template chosen values
+            merchant_id (int): The ID of the managing account. Criteo: the partnerId.
+            method (str): The method of the batch entry.
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -154,7 +160,11 @@ class CreativeUpdateModel202207(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            brand_id (int): The brand associated to the creative. [optional]  # noqa: E501
+            batch_id (int, none_type): An entry ID, unique within the batch request.. [optional]  # noqa: E501
+            product_id (str, none_type): The Product ID to delete. Only defined if the method is delete.. [optional]  # noqa: E501
+            item_group_id (str, none_type): Deprecated (providing this information is no more needed, this field will be removed in next release). The itemGroupId of the product to delete. To be defined when the method is delete and the product is a variant.. [optional]  # noqa: E501
+            product (Product): [optional]  # noqa: E501
+            feed_id (str, none_type): Not used by Criteo.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -186,10 +196,8 @@ class CreativeUpdateModel202207(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.name = name
-        self.retailer_id = retailer_id
-        self.template_id = template_id
-        self.template_variable_values = template_variable_values
+        self.merchant_id = merchant_id
+        self.method = method
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -210,14 +218,12 @@ class CreativeUpdateModel202207(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, name, retailer_id, template_id, template_variable_values, *args, **kwargs):  # noqa: E501
-        """CreativeUpdateModel202207 - a model defined in OpenAPI
+    def __init__(self, merchant_id, method, *args, **kwargs):  # noqa: E501
+        """ProductsCustomBatchRequestEntry - a model defined in OpenAPI
 
         Args:
-            name (str): The name of the creative
-            retailer_id (int): The retailer associated to the creative
-            template_id (int): The creative template used for this creative
-            template_variable_values ([TemplateVariableValue]): The template chosen values
+            merchant_id (int): The ID of the managing account. Criteo: the partnerId.
+            method (str): The method of the batch entry.
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -250,7 +256,11 @@ class CreativeUpdateModel202207(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            brand_id (int): The brand associated to the creative. [optional]  # noqa: E501
+            batch_id (int, none_type): An entry ID, unique within the batch request.. [optional]  # noqa: E501
+            product_id (str, none_type): The Product ID to delete. Only defined if the method is delete.. [optional]  # noqa: E501
+            item_group_id (str, none_type): Deprecated (providing this information is no more needed, this field will be removed in next release). The itemGroupId of the product to delete. To be defined when the method is delete and the product is a variant.. [optional]  # noqa: E501
+            product (Product): [optional]  # noqa: E501
+            feed_id (str, none_type): Not used by Criteo.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -280,10 +290,8 @@ class CreativeUpdateModel202207(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.name = name
-        self.retailer_id = retailer_id
-        self.template_id = template_id
-        self.template_variable_values = template_variable_values
+        self.merchant_id = merchant_id
+        self.method = method
         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/{choice_option.py → report_detail_error.py}

@@ -29,12 +29,8 @@ from criteo_api_retailmedia_preview.model_utils import (  # noqa: F401
 from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
-def lazy_import():
-    from criteo_api_retailmedia_preview.model.template_variable import TemplateVariable
-    globals()['TemplateVariable'] = TemplateVariable
 
-
-class ChoiceOption(ModelNormal):
+class ReportDetailError(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -59,6 +55,24 @@ class ChoiceOption(ModelNormal):
     """
 
     allowed_values = {
+        ('type',): {
+            'UNKNOWNERROR': "UnknownError",
+            'INVALIDBIGIMAGEURL': "InvalidBigImageUrl",
+            'INVALIDPRODUCTID': "InvalidProductId",
+            'INVALIDPRODUCTURL': "InvalidProductUrl",
+            'INVALIDSMALLIMAGEURL': "InvalidSmallImageUrl",
+            'JSONPARSINGISSUE': "JsonParsingIssue",
+            'MISSINGID': "MissingID",
+            'MISSINGIMAGES': "MissingImages",
+            'MISSINGNAME': "MissingName",
+            'MISSINGURL': "MissingURL",
+            'NONASCIIID': "NonAsciiId",
+            'OVERLARGEBIGIMAGE': "OverlargeBigImage",
+            'OVERLARGEID': "OverlargeID",
+            'OVERLARGESMALLIMAGE': "OverlargeSmallImage",
+            'OVERLARGEURL': "OverlargeURL",
+            'CONFIGURATIONERROR': "ConfigurationError",
+        },
     }
 
     validations = {
@@ -70,7 +84,6 @@ class ChoiceOption(ModelNormal):
         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 = False
@@ -85,10 +98,10 @@ class ChoiceOption(ModelNormal):
             openapi_types (dict): The key is attribute name
                 and the value is attribute type.
         """
-        lazy_import()
         return {
-            'dependent_variables': ([TemplateVariable],),  # noqa: E501
-            'id': (str,),  # noqa: E501
+            'type': (str,),  # noqa: E501
+            'message': (str,),  # noqa: E501
+            'is_server_related': (bool,),  # noqa: E501
         }
 
     @cached_property
@@ -97,8 +110,9 @@ class ChoiceOption(ModelNormal):
 
 
     attribute_map = {
-        'dependent_variables': 'dependentVariables',  # noqa: E501
-        'id': 'id',  # noqa: E501
+        'type': 'type',  # noqa: E501
+        'message': 'message',  # noqa: E501
+        'is_server_related': 'isServerRelated',  # noqa: E501
     }
 
     read_only_vars = {
@@ -108,12 +122,13 @@ class ChoiceOption(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, dependent_variables, id, *args, **kwargs):  # noqa: E501
-        """ChoiceOption - a model defined in OpenAPI
+    def _from_openapi_data(cls, type, message, is_server_related, *args, **kwargs):  # noqa: E501
+        """ReportDetailError - a model defined in OpenAPI
 
         Args:
-            dependent_variables ([TemplateVariable]): Template variables unblocked when the option is chosen
-            id (str): The id of the option
+            type (str):
+            message (str):
+            is_server_related (bool):
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -177,8 +192,9 @@ class ChoiceOption(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.dependent_variables = dependent_variables
-        self.id = id
+        self.type = type
+        self.message = message
+        self.is_server_related = is_server_related
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -199,12 +215,13 @@ class ChoiceOption(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, dependent_variables, id, *args, **kwargs):  # noqa: E501
-        """ChoiceOption - a model defined in OpenAPI
+    def __init__(self, type, message, is_server_related, *args, **kwargs):  # noqa: E501
+        """ReportDetailError - a model defined in OpenAPI
 
         Args:
-            dependent_variables ([TemplateVariable]): Template variables unblocked when the option is chosen
-            id (str): The id of the option
+            type (str):
+            message (str):
+            is_server_related (bool):
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -266,8 +283,9 @@ class ChoiceOption(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.dependent_variables = dependent_variables
-        self.id = id
+        self.type = type
+        self.message = message
+        self.is_server_related = is_server_related
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \