criteo-api-retailmedia-sdk 2024.7.0.250129__py3-none-any.whl → 2024.10.0.250129__py3-none-any.whl

criteo_api_retailmedia_v2024_10/model/creative2.py

@@ -0,0 +1,354 @@
+"""
+    Criteo API
+
+    Criteo API - RetailMedia  # noqa: E501
+
+    The version of the OpenAPI document: 2024-10
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from criteo_api_retailmedia_v2024_10.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_v2024_10.exceptions import ApiAttributeError
+
+
+def lazy_import():
+    from criteo_api_retailmedia_v2024_10.model.page_type_environment2 import PageTypeEnvironment2
+    from criteo_api_retailmedia_v2024_10.model.template_variable_value import TemplateVariableValue
+    globals()['PageTypeEnvironment2'] = PageTypeEnvironment2
+    globals()['TemplateVariableValue'] = TemplateVariableValue
+
+
+class Creative2(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 = {
+        ('status',): {
+            'READY': "Ready",
+            'INUSE': "InUse",
+            'ARCHIVED': "Archived",
+            'DELETED': "Deleted",
+        },
+        ('creative_format_v2_type',): {
+            'UNKNOWN': "Unknown",
+            'FLAGSHIP': "FlagShip",
+            'SHOWCASE': "Showcase",
+            'SPONSOREDPRODUCTS': "SponsoredProducts",
+            'BUTTERFLY': "Butterfly",
+            'BUNDLEBOOST': "BundleBoost",
+            'IAB': "IAB",
+            'CUSTOM': "Custom",
+            'DISPLAYPANEL': "DisplayPanel",
+            'DIGITALSHELFTALKER': "DigitalShelfTalker",
+        },
+    }
+
+    validations = {
+    }
+
+    additional_properties_type = None
+
+    _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.
+        """
+        lazy_import()
+        return {
+            'name': (str,),  # noqa: E501
+            'status': (str,),  # noqa: E501
+            'brand_id': (int,),  # noqa: E501
+            'retailer_id': (int,),  # noqa: E501
+            'template_id': (int,),  # noqa: E501
+            'template_name': (str,),  # noqa: E501
+            'format_id': (int,),  # noqa: E501
+            'associated_line_item_ids': ([str],),  # noqa: E501
+            'updated_at': (datetime,),  # noqa: E501
+            'creative_format_v2_type': (str,),  # noqa: E501
+            'environments': ([PageTypeEnvironment2],),  # noqa: E501
+            'template_variable_values': ([TemplateVariableValue],),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'name': 'name',  # noqa: E501
+        'status': 'status',  # noqa: E501
+        'brand_id': 'brandId',  # noqa: E501
+        'retailer_id': 'retailerId',  # noqa: E501
+        'template_id': 'templateId',  # noqa: E501
+        'template_name': 'templateName',  # noqa: E501
+        'format_id': 'formatId',  # noqa: E501
+        'associated_line_item_ids': 'associatedLineItemIds',  # noqa: E501
+        'updated_at': 'updatedAt',  # noqa: E501
+        'creative_format_v2_type': 'creativeFormatV2Type',  # noqa: E501
+        'environments': 'environments',  # noqa: E501
+        'template_variable_values': 'templateVariableValues',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, name, status, brand_id, retailer_id, template_id, template_name, format_id, associated_line_item_ids, updated_at, creative_format_v2_type, environments, template_variable_values, *args, **kwargs):  # noqa: E501
+        """Creative2 - a model defined in OpenAPI
+
+        Args:
+            name (str): Name
+            status (str): Creative Status
+            brand_id (int): Brand Id
+            retailer_id (int): Retailer Id
+            template_id (int): Template Id
+            template_name (str): Template Name
+            format_id (int): Format Id
+            associated_line_item_ids ([str]): Associated Line Item Ids
+            updated_at (datetime): Updated at time
+            creative_format_v2_type (str): Creative format type
+            environments ([PageTypeEnvironment2]): Environment type (e.g. mobile, web, app)
+            template_variable_values ([TemplateVariableValue]): The template chosen values
+
+        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,)
+        """
+
+        _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__,)
+
+        self.name = name
+        self.status = status
+        self.brand_id = brand_id
+        self.retailer_id = retailer_id
+        self.template_id = template_id
+        self.template_name = template_name
+        self.format_id = format_id
+        self.associated_line_item_ids = associated_line_item_ids
+        self.updated_at = updated_at
+        self.creative_format_v2_type = creative_format_v2_type
+        self.environments = environments
+        self.template_variable_values = template_variable_values
+        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, name, status, brand_id, retailer_id, template_id, template_name, format_id, associated_line_item_ids, updated_at, creative_format_v2_type, environments, template_variable_values, *args, **kwargs):  # noqa: E501
+        """Creative2 - a model defined in OpenAPI
+
+        Args:
+            name (str): Name
+            status (str): Creative Status
+            brand_id (int): Brand Id
+            retailer_id (int): Retailer Id
+            template_id (int): Template Id
+            template_name (str): Template Name
+            format_id (int): Format Id
+            associated_line_item_ids ([str]): Associated Line Item Ids
+            updated_at (datetime): Updated at time
+            creative_format_v2_type (str): Creative format type
+            environments ([PageTypeEnvironment2]): Environment type (e.g. mobile, web, app)
+            template_variable_values ([TemplateVariableValue]): The template chosen values
+
+        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,)
+        """
+
+        _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__,)
+
+        self.name = name
+        self.status = status
+        self.brand_id = brand_id
+        self.retailer_id = retailer_id
+        self.template_id = template_id
+        self.template_name = template_name
+        self.format_id = format_id
+        self.associated_line_item_ids = associated_line_item_ids
+        self.updated_at = updated_at
+        self.creative_format_v2_type = creative_format_v2_type
+        self.environments = environments
+        self.template_variable_values = template_variable_values
+        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_v2024_07 → criteo_api_retailmedia_v2024_10}/model/creative202110.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2024-07
+    The version of the OpenAPI document: 2024-10
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2024_07.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_10.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,7 +26,7 @@ from criteo_api_retailmedia_v2024_07.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2024_07.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_10.exceptions import ApiAttributeError
 
 
 

{criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/creative202110_list_response.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2024-07
+    The version of the OpenAPI document: 2024-10
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2024_07.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_10.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,12 +26,12 @@ from criteo_api_retailmedia_v2024_07.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2024_07.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_10.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_v2024_07.model.common_problem import CommonProblem
-    from criteo_api_retailmedia_v2024_07.model.resource_of_creative202110 import ResourceOfCreative202110
+    from criteo_api_retailmedia_v2024_10.model.common_problem import CommonProblem
+    from criteo_api_retailmedia_v2024_10.model.resource_of_creative202110 import ResourceOfCreative202110
     globals()['CommonProblem'] = CommonProblem
     globals()['ResourceOfCreative202110'] = ResourceOfCreative202110
 

{criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/creative202210.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2024-07
+    The version of the OpenAPI document: 2024-10
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2024_07.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_10.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,12 +26,12 @@ from criteo_api_retailmedia_v2024_07.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2024_07.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_10.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_v2024_07.model.page_type_environment202210 import PageTypeEnvironment202210
-    from criteo_api_retailmedia_v2024_07.model.template_variable_value import TemplateVariableValue
+    from criteo_api_retailmedia_v2024_10.model.page_type_environment202210 import PageTypeEnvironment202210
+    from criteo_api_retailmedia_v2024_10.model.template_variable_value import TemplateVariableValue
     globals()['PageTypeEnvironment202210'] = PageTypeEnvironment202210
     globals()['TemplateVariableValue'] = TemplateVariableValue
 

{criteo_api_retailmedia_v2024_07 → criteo_api_retailmedia_v2024_10}/model/creative202210_response.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2024-07
+    The version of the OpenAPI document: 2024-10
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2024_07.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_10.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,12 +26,12 @@ from criteo_api_retailmedia_v2024_07.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2024_07.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_10.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_v2024_07.model.common_problem import CommonProblem
-    from criteo_api_retailmedia_v2024_07.model.resource_of_creative202210 import ResourceOfCreative202210
+    from criteo_api_retailmedia_v2024_10.model.common_problem import CommonProblem
+    from criteo_api_retailmedia_v2024_10.model.resource_of_creative202210 import ResourceOfCreative202210
     globals()['CommonProblem'] = CommonProblem
     globals()['ResourceOfCreative202210'] = ResourceOfCreative202210
 

criteo_api_retailmedia_v2024_07/model/creative202210_list_response.py → criteo_api_retailmedia_v2024_10/model/creative2_list_response.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2024-07
+    The version of the OpenAPI document: 2024-10
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2024_07.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_10.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,17 +26,17 @@ from criteo_api_retailmedia_v2024_07.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2024_07.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_10.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_v2024_07.model.common_problem import CommonProblem
-    from criteo_api_retailmedia_v2024_07.model.resource_of_creative202210 import ResourceOfCreative202210
+    from criteo_api_retailmedia_v2024_10.model.common_problem import CommonProblem
+    from criteo_api_retailmedia_v2024_10.model.resource_of_creative2 import ResourceOfCreative2
     globals()['CommonProblem'] = CommonProblem
-    globals()['ResourceOfCreative202210'] = ResourceOfCreative202210
+    globals()['ResourceOfCreative2'] = ResourceOfCreative2
 
 
-class Creative202210ListResponse(ModelNormal):
+class Creative2ListResponse(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -82,7 +82,7 @@ class Creative202210ListResponse(ModelNormal):
         """
         lazy_import()
         return {
-            'data': ([ResourceOfCreative202210], none_type,),  # noqa: E501
+            'data': ([ResourceOfCreative2], none_type,),  # noqa: E501
             'warnings': ([CommonProblem], none_type,),  # noqa: E501
             'errors': ([CommonProblem], none_type,),  # noqa: E501
         }
@@ -108,7 +108,7 @@ class Creative202210ListResponse(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """Creative202210ListResponse - a model defined in OpenAPI
+        """Creative2ListResponse - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -141,7 +141,7 @@ class Creative202210ListResponse(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            data ([ResourceOfCreative202210], none_type): [optional]  # noqa: E501
+            data ([ResourceOfCreative2], none_type): [optional]  # noqa: E501
             warnings ([CommonProblem], none_type): [optional]  # noqa: E501
             errors ([CommonProblem], none_type): [optional]  # noqa: E501
         """
@@ -196,7 +196,7 @@ class Creative202210ListResponse(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """Creative202210ListResponse - a model defined in OpenAPI
+        """Creative2ListResponse - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -229,7 +229,7 @@ class Creative202210ListResponse(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            data ([ResourceOfCreative202210], none_type): [optional]  # noqa: E501
+            data ([ResourceOfCreative2], none_type): [optional]  # noqa: E501
             warnings ([CommonProblem], none_type): [optional]  # noqa: E501
             errors ([CommonProblem], none_type): [optional]  # noqa: E501
         """