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

criteo_api_retailmedia_preview/model/rm_algebra_node_v1.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 RmAlgebraNodeV1(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 {
+            '_and': ([RmAlgebraNodeV1], none_type,),  # noqa: E501
+            '_or': ([RmAlgebraNodeV1], none_type,),  # noqa: E501
+            '_not': (RmAlgebraNodeV1,),  # noqa: E501
+            'audience_segment_id': (str, none_type,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        '_and': 'and',  # noqa: E501
+        '_or': 'or',  # noqa: E501
+        '_not': 'not',  # noqa: E501
+        'audience_segment_id': 'audienceSegmentId',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """RmAlgebraNodeV1 - 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,)
+            _and ([RmAlgebraNodeV1], none_type): [optional]  # noqa: E501
+            _or ([RmAlgebraNodeV1], none_type): [optional]  # noqa: E501
+            _not (RmAlgebraNodeV1): [optional]  # noqa: E501
+            audience_segment_id (str, none_type): [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
+        """RmAlgebraNodeV1 - 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,)
+            _and ([RmAlgebraNodeV1], none_type): [optional]  # noqa: E501
+            _or ([RmAlgebraNodeV1], none_type): [optional]  # noqa: E501
+            _not (RmAlgebraNodeV1): [optional]  # noqa: E501
+            audience_segment_id (str, none_type): [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/{rm_legacy_audience_get_entity_v1_resource.py → rm_audience_entity_v1.py}

@@ -30,11 +30,11 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v1 import RmLegacyAudienceGetEntityV1
-    globals()['RmLegacyAudienceGetEntityV1'] = RmLegacyAudienceGetEntityV1
+    from criteo_api_retailmedia_preview.model.rm_algebra_node_v1 import RmAlgebraNodeV1
+    globals()['RmAlgebraNodeV1'] = RmAlgebraNodeV1
 
 
-class RmLegacyAudienceGetEntityV1Resource(ModelNormal):
+class RmAudienceEntityV1(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -59,10 +59,11 @@ class RmLegacyAudienceGetEntityV1Resource(ModelNormal):
     """
 
     allowed_values = {
-        ('audience_type',): {
+        ('channels',): {
             'None': None,
-            'CUSTOMERLIST': "customerList",
-            'USERBEHAVIOR': "userBehavior",
+            'UNKNOWN': "Unknown",
+            'ONSITE': "Onsite",
+            'OFFSITE': "Offsite",
         },
     }
 
@@ -92,10 +93,15 @@ class RmLegacyAudienceGetEntityV1Resource(ModelNormal):
         """
         lazy_import()
         return {
-            'attributes': (RmLegacyAudienceGetEntityV1,),  # noqa: E501
-            'id': (str, none_type,),  # noqa: E501
-            'audience_type': (str, none_type,),  # noqa: E501
-            'type': (str, none_type,),  # noqa: E501
+            'account_id': (str, none_type,),  # noqa: E501
+            'name': (str, none_type,),  # noqa: E501
+            'description': (str, none_type,),  # noqa: E501
+            'retailer_id': (str, none_type,),  # noqa: E501
+            'created_by_id': (str, none_type,),  # noqa: E501
+            'created_at': (datetime, none_type,),  # noqa: E501
+            'updated_at': (datetime, none_type,),  # noqa: E501
+            'channels': ([str], none_type,),  # noqa: E501
+            'algebra': (RmAlgebraNodeV1,),  # noqa: E501
         }
 
     @cached_property
@@ -104,10 +110,15 @@ class RmLegacyAudienceGetEntityV1Resource(ModelNormal):
 
 
     attribute_map = {
-        'attributes': 'attributes',  # noqa: E501
-        'id': 'id',  # noqa: E501
-        'audience_type': 'audienceType',  # noqa: E501
-        'type': 'type',  # noqa: E501
+        'account_id': 'accountId',  # noqa: E501
+        'name': 'name',  # noqa: E501
+        'description': 'description',  # noqa: E501
+        'retailer_id': 'retailerId',  # noqa: E501
+        'created_by_id': 'createdById',  # noqa: E501
+        'created_at': 'createdAt',  # noqa: E501
+        'updated_at': 'updatedAt',  # noqa: E501
+        'channels': 'channels',  # noqa: E501
+        'algebra': 'algebra',  # noqa: E501
     }
 
     read_only_vars = {
@@ -118,7 +129,7 @@ class RmLegacyAudienceGetEntityV1Resource(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """RmLegacyAudienceGetEntityV1Resource - a model defined in OpenAPI
+        """RmAudienceEntityV1 - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -151,10 +162,15 @@ class RmLegacyAudienceGetEntityV1Resource(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            attributes (RmLegacyAudienceGetEntityV1): [optional]  # noqa: E501
-            id (str, none_type): [optional]  # noqa: E501
-            audience_type (str, none_type): [optional]  # noqa: E501
-            type (str, none_type): [optional]  # noqa: E501
+            account_id (str, none_type): Account associated to the audience. [optional]  # noqa: E501
+            name (str, none_type): Name of the audience. [optional]  # noqa: E501
+            description (str, none_type): Description of the audience. [optional]  # noqa: E501
+            retailer_id (str, none_type): Retailer  associated to the audience. [optional]  # noqa: E501
+            created_by_id (str, none_type): User that created the audience. [optional]  # noqa: E501
+            created_at (datetime, none_type): ISO-8601 timestamp in UTC of audience creation (read-only). [optional]  # noqa: E501
+            updated_at (datetime, none_type): ISO-8601 timestamp in UTC of audience update (read-only). [optional]  # noqa: E501
+            channels ([str], none_type): Channels associated to the audience (read-only). [optional]  # noqa: E501
+            algebra (RmAlgebraNodeV1): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -207,7 +223,7 @@ class RmLegacyAudienceGetEntityV1Resource(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """RmLegacyAudienceGetEntityV1Resource - a model defined in OpenAPI
+        """RmAudienceEntityV1 - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -240,10 +256,15 @@ class RmLegacyAudienceGetEntityV1Resource(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            attributes (RmLegacyAudienceGetEntityV1): [optional]  # noqa: E501
-            id (str, none_type): [optional]  # noqa: E501
-            audience_type (str, none_type): [optional]  # noqa: E501
-            type (str, none_type): [optional]  # noqa: E501
+            account_id (str, none_type): Account associated to the audience. [optional]  # noqa: E501
+            name (str, none_type): Name of the audience. [optional]  # noqa: E501
+            description (str, none_type): Description of the audience. [optional]  # noqa: E501
+            retailer_id (str, none_type): Retailer  associated to the audience. [optional]  # noqa: E501
+            created_by_id (str, none_type): User that created the audience. [optional]  # noqa: E501
+            created_at (datetime, none_type): ISO-8601 timestamp in UTC of audience creation (read-only). [optional]  # noqa: E501
+            updated_at (datetime, none_type): ISO-8601 timestamp in UTC of audience update (read-only). [optional]  # noqa: E501
+            channels ([str], none_type): Channels associated to the audience (read-only). [optional]  # noqa: E501
+            algebra (RmAlgebraNodeV1): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v2_resource.py → rm_audience_entity_v1_resource.py}

@@ -30,11 +30,11 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v2 import RmLegacyAudienceGetEntityV2
-    globals()['RmLegacyAudienceGetEntityV2'] = RmLegacyAudienceGetEntityV2
+    from criteo_api_retailmedia_preview.model.rm_audience_entity_v1 import RmAudienceEntityV1
+    globals()['RmAudienceEntityV1'] = RmAudienceEntityV1
 
 
-class RmLegacyAudienceGetEntityV2Resource(ModelNormal):
+class RmAudienceEntityV1Resource(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -87,7 +87,7 @@ class RmLegacyAudienceGetEntityV2Resource(ModelNormal):
         """
         lazy_import()
         return {
-            'attributes': (RmLegacyAudienceGetEntityV2,),  # noqa: E501
+            'attributes': (RmAudienceEntityV1,),  # noqa: E501
             'id': (str, none_type,),  # noqa: E501
             'type': (str, none_type,),  # noqa: E501
         }
@@ -111,7 +111,7 @@ class RmLegacyAudienceGetEntityV2Resource(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """RmLegacyAudienceGetEntityV2Resource - a model defined in OpenAPI
+        """RmAudienceEntityV1Resource - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -144,7 +144,7 @@ class RmLegacyAudienceGetEntityV2Resource(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            attributes (RmLegacyAudienceGetEntityV2): [optional]  # noqa: E501
+            attributes (RmAudienceEntityV1): [optional]  # noqa: E501
             id (str, none_type): Id of the entity. [optional]  # noqa: E501
             type (str, none_type): [optional]  # noqa: E501
         """
@@ -199,7 +199,7 @@ class RmLegacyAudienceGetEntityV2Resource(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """RmLegacyAudienceGetEntityV2Resource - a model defined in OpenAPI
+        """RmAudienceEntityV1Resource - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -232,7 +232,7 @@ class RmLegacyAudienceGetEntityV2Resource(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            attributes (RmLegacyAudienceGetEntityV2): [optional]  # noqa: E501
+            attributes (RmAudienceEntityV1): [optional]  # noqa: E501
             id (str, none_type): Id of the entity. [optional]  # noqa: E501
             type (str, none_type): [optional]  # noqa: E501
         """

criteo_api_retailmedia_preview/model/{creative_v2_list_response.py → rm_audience_entity_v1_rm_audience_search_metadata_v1_list_response.py}

@@ -31,12 +31,14 @@ 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
+    from criteo_api_retailmedia_preview.model.rm_audience_entity_v1_resource import RmAudienceEntityV1Resource
+    from criteo_api_retailmedia_preview.model.rm_audience_search_metadata_v1 import RmAudienceSearchMetadataV1
     globals()['CommonProblem'] = CommonProblem
-    globals()['ResourceOfCreativeV2'] = ResourceOfCreativeV2
+    globals()['RmAudienceEntityV1Resource'] = RmAudienceEntityV1Resource
+    globals()['RmAudienceSearchMetadataV1'] = RmAudienceSearchMetadataV1
 
 
-class CreativeV2ListResponse(ModelNormal):
+class RmAudienceEntityV1RmAudienceSearchMetadataV1ListResponse(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -89,7 +91,8 @@ class CreativeV2ListResponse(ModelNormal):
         """
         lazy_import()
         return {
-            'data': ([ResourceOfCreativeV2], none_type,),  # noqa: E501
+            'meta': (RmAudienceSearchMetadataV1,),  # noqa: E501
+            'data': ([RmAudienceEntityV1Resource], none_type,),  # noqa: E501
             'warnings': ([CommonProblem], none_type,),  # noqa: E501
             'errors': ([CommonProblem], none_type,),  # noqa: E501
         }
@@ -100,6 +103,7 @@ class CreativeV2ListResponse(ModelNormal):
 
 
     attribute_map = {
+        'meta': 'meta',  # noqa: E501
         'data': 'data',  # noqa: E501
         'warnings': 'warnings',  # noqa: E501
         'errors': 'errors',  # noqa: E501
@@ -115,7 +119,7 @@ class CreativeV2ListResponse(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """CreativeV2ListResponse - a model defined in OpenAPI
+        """RmAudienceEntityV1RmAudienceSearchMetadataV1ListResponse - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -148,7 +152,8 @@ class CreativeV2ListResponse(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            data ([ResourceOfCreativeV2], none_type): [optional]  # noqa: E501
+            meta (RmAudienceSearchMetadataV1): [optional]  # noqa: E501
+            data ([RmAudienceEntityV1Resource], none_type): [optional]  # noqa: E501
             warnings ([CommonProblem], none_type): [optional]  # noqa: E501
             errors ([CommonProblem], none_type): [optional]  # noqa: E501
         """
@@ -203,7 +208,7 @@ class CreativeV2ListResponse(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """CreativeV2ListResponse - a model defined in OpenAPI
+        """RmAudienceEntityV1RmAudienceSearchMetadataV1ListResponse - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -236,7 +241,8 @@ class CreativeV2ListResponse(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            data ([ResourceOfCreativeV2], none_type): [optional]  # noqa: E501
+            meta (RmAudienceSearchMetadataV1): [optional]  # noqa: E501
+            data ([RmAudienceEntityV1Resource], none_type): [optional]  # noqa: E501
             warnings ([CommonProblem], none_type): [optional]  # noqa: E501
             errors ([CommonProblem], none_type): [optional]  # noqa: E501
         """