criteo-api-retailmedia-sdk 2023.7.0.231113__py3-none-any.whl → 2023.7.0.240207__py3-none-any.whl

criteo_api_retailmedia_v2023_07/model/rm_legacy_audience_user_behavior_create_v2.py

@@ -0,0 +1,279 @@
+"""
+    Criteo API
+
+    Criteo API - RetailMedia  # noqa: E501
+
+    The version of the OpenAPI document: 2023-07
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from criteo_api_retailmedia_v2023_07.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_v2023_07.exceptions import ApiAttributeError
+
+
+def lazy_import():
+    from criteo_api_retailmedia_v2023_07.model.rm_legacy_segment_user_behavior_create_v2 import RmLegacySegmentUserBehaviorCreateV2
+    globals()['RmLegacySegmentUserBehaviorCreateV2'] = RmLegacySegmentUserBehaviorCreateV2
+
+
+class RmLegacyAudienceUserBehaviorCreateV2(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
+        """
+        lazy_import()
+        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.
+        """
+        lazy_import()
+        return {
+            'inclusive_segment': (RmLegacySegmentUserBehaviorCreateV2,),  # noqa: E501
+            'exclusive_segment': (RmLegacySegmentUserBehaviorCreateV2,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'inclusive_segment': 'inclusiveSegment',  # noqa: E501
+        'exclusive_segment': 'exclusiveSegment',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, inclusive_segment, *args, **kwargs):  # noqa: E501
+        """RmLegacyAudienceUserBehaviorCreateV2 - a model defined in OpenAPI
+
+        Args:
+            inclusive_segment (RmLegacySegmentUserBehaviorCreateV2):
+
+        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,)
+            exclusive_segment (RmLegacySegmentUserBehaviorCreateV2): [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__,)
+
+        self.inclusive_segment = inclusive_segment
+        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, inclusive_segment, *args, **kwargs):  # noqa: E501
+        """RmLegacyAudienceUserBehaviorCreateV2 - a model defined in OpenAPI
+
+        Args:
+            inclusive_segment (RmLegacySegmentUserBehaviorCreateV2):
+
+        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,)
+            exclusive_segment (RmLegacySegmentUserBehaviorCreateV2): [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__,)
+
+        self.inclusive_segment = inclusive_segment
+        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_v2023_07/model/{user_behavior_details_v2.py → rm_legacy_audience_user_behavior_details_v2.py}

@@ -30,11 +30,11 @@ from criteo_api_retailmedia_v2023_07.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_v2023_07.model.create_user_behavior_segment_v2 import CreateUserBehaviorSegmentV2
-    globals()['CreateUserBehaviorSegmentV2'] = CreateUserBehaviorSegmentV2
+    from criteo_api_retailmedia_v2023_07.model.rm_legacy_segment_user_behavior_v2 import RmLegacySegmentUserBehaviorV2
+    globals()['RmLegacySegmentUserBehaviorV2'] = RmLegacySegmentUserBehaviorV2
 
 
-class UserBehaviorDetailsV2(ModelNormal):
+class RmLegacyAudienceUserBehaviorDetailsV2(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -87,8 +87,8 @@ class UserBehaviorDetailsV2(ModelNormal):
         """
         lazy_import()
         return {
-            'inclusive_segment': (CreateUserBehaviorSegmentV2,),  # noqa: E501
-            'exclusive_segment': (CreateUserBehaviorSegmentV2,),  # noqa: E501
+            'inclusive_segment': (RmLegacySegmentUserBehaviorV2,),  # noqa: E501
+            'exclusive_segment': (RmLegacySegmentUserBehaviorV2,),  # noqa: E501
         }
 
     @cached_property
@@ -109,10 +109,10 @@ class UserBehaviorDetailsV2(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, inclusive_segment, *args, **kwargs):  # noqa: E501
-        """UserBehaviorDetailsV2 - a model defined in OpenAPI
+        """RmLegacyAudienceUserBehaviorDetailsV2 - a model defined in OpenAPI
 
         Args:
-            inclusive_segment (CreateUserBehaviorSegmentV2):
+            inclusive_segment (RmLegacySegmentUserBehaviorV2):
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -145,7 +145,7 @@ class UserBehaviorDetailsV2(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            exclusive_segment (CreateUserBehaviorSegmentV2): [optional]  # noqa: E501
+            exclusive_segment (RmLegacySegmentUserBehaviorV2): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -199,10 +199,10 @@ class UserBehaviorDetailsV2(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, inclusive_segment, *args, **kwargs):  # noqa: E501
-        """UserBehaviorDetailsV2 - a model defined in OpenAPI
+        """RmLegacyAudienceUserBehaviorDetailsV2 - a model defined in OpenAPI
 
         Args:
-            inclusive_segment (CreateUserBehaviorSegmentV2):
+            inclusive_segment (RmLegacySegmentUserBehaviorV2):
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -235,7 +235,7 @@ class UserBehaviorDetailsV2(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            exclusive_segment (CreateUserBehaviorSegmentV2): [optional]  # noqa: E501
+            exclusive_segment (RmLegacySegmentUserBehaviorV2): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

criteo_api_retailmedia_v2023_07/model/{customer_list_details.py → rm_legacy_segment_customer_list.py}

@@ -30,7 +30,7 @@ from criteo_api_retailmedia_v2023_07.exceptions import ApiAttributeError
 
 
 
-class CustomerListDetails(ModelNormal):
+class RmLegacySegmentCustomerList(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -82,6 +82,7 @@ class CustomerListDetails(ModelNormal):
         """
         return {
             'size': (str,),  # noqa: E501
+            'is_shared': (bool,),  # noqa: E501
         }
 
     @cached_property
@@ -91,6 +92,7 @@ class CustomerListDetails(ModelNormal):
 
     attribute_map = {
         'size': 'size',  # noqa: E501
+        'is_shared': 'isShared',  # noqa: E501
     }
 
     read_only_vars = {
@@ -100,11 +102,12 @@ class CustomerListDetails(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, size, *args, **kwargs):  # noqa: E501
-        """CustomerListDetails - a model defined in OpenAPI
+    def _from_openapi_data(cls, size, is_shared, *args, **kwargs):  # noqa: E501
+        """RmLegacySegmentCustomerList - a model defined in OpenAPI
 
         Args:
             size (str): Number of users in the customer list audience.
+            is_shared (bool): Indicate if the audience is shared.
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -169,6 +172,7 @@ class CustomerListDetails(ModelNormal):
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
         self.size = size
+        self.is_shared = is_shared
         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 +193,12 @@ class CustomerListDetails(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, size, *args, **kwargs):  # noqa: E501
-        """CustomerListDetails - a model defined in OpenAPI
+    def __init__(self, size, is_shared, *args, **kwargs):  # noqa: E501
+        """RmLegacySegmentCustomerList - a model defined in OpenAPI
 
         Args:
             size (str): Number of users in the customer list audience.
+            is_shared (bool): Indicate if the audience is shared.
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -256,6 +261,7 @@ class CustomerListDetails(ModelNormal):
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
         self.size = size
+        self.is_shared = is_shared
         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_v2023_07/model/{retail_media_audience.py → rm_legacy_segment_user_behavior_create_v2.py}

@@ -29,12 +29,8 @@ from criteo_api_retailmedia_v2023_07.model_utils import (  # noqa: F401
 from criteo_api_retailmedia_v2023_07.exceptions import ApiAttributeError
 
 
-def lazy_import():
-    from criteo_api_retailmedia_v2023_07.model.retail_media_audience_attributes import RetailMediaAudienceAttributes
-    globals()['RetailMediaAudienceAttributes'] = RetailMediaAudienceAttributes
 
-
-class RetailMediaAudience(ModelNormal):
+class RmLegacySegmentUserBehaviorCreateV2(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -59,13 +55,29 @@ class RetailMediaAudience(ModelNormal):
     """
 
     allowed_values = {
-        ('audience_type',): {
-            'CUSTOMERLIST': "customerList",
-            'USERBEHAVIOR': "userBehavior",
+        ('user_action',): {
+            'BUY': "buy",
+            'VIEW': "view",
+            'ADDTOCART': "addToCart",
+        },
+        ('lookback_window',): {
+            'P7D': "P7D",
+            'P14D': "P14D",
+            'P30D': "P30D",
+            'P45D': "P45D",
+            'P60D': "P60D",
+            'P90D': "P90D",
+            'P120D': "P120D",
+            'P150D': "P150D",
+            'P180D': "P180D",
         },
     }
 
     validations = {
+        ('category_ids',): {
+        },
+        ('brand_ids',): {
+        },
     }
 
     @cached_property
@@ -74,7 +86,6 @@ class RetailMediaAudience(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
@@ -89,12 +100,11 @@ class RetailMediaAudience(ModelNormal):
             openapi_types (dict): The key is attribute name
                 and the value is attribute type.
         """
-        lazy_import()
         return {
-            'audience_type': (str,),  # noqa: E501
-            'id': (str,),  # noqa: E501
-            'type': (str,),  # noqa: E501
-            'attributes': (RetailMediaAudienceAttributes,),  # noqa: E501
+            'user_action': (str,),  # noqa: E501
+            'lookback_window': (str,),  # noqa: E501
+            'category_ids': ([int], none_type,),  # noqa: E501
+            'brand_ids': ([int], none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -103,10 +113,10 @@ class RetailMediaAudience(ModelNormal):
 
 
     attribute_map = {
-        'audience_type': 'audienceType',  # noqa: E501
-        'id': 'id',  # noqa: E501
-        'type': 'type',  # noqa: E501
-        'attributes': 'attributes',  # noqa: E501
+        'user_action': 'userAction',  # noqa: E501
+        'lookback_window': 'lookbackWindow',  # noqa: E501
+        'category_ids': 'categoryIds',  # noqa: E501
+        'brand_ids': 'brandIds',  # noqa: E501
     }
 
     read_only_vars = {
@@ -116,14 +126,12 @@ class RetailMediaAudience(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, audience_type, id, type, attributes, *args, **kwargs):  # noqa: E501
-        """RetailMediaAudience - a model defined in OpenAPI
+    def _from_openapi_data(cls, user_action, lookback_window, *args, **kwargs):  # noqa: E501
+        """RmLegacySegmentUserBehaviorCreateV2 - a model defined in OpenAPI
 
         Args:
-            audience_type (str): Type of the audience
-            id (str): Unique ID of this audience.
-            type (str): Name of the entity i.e. RetailMediaAudienceSummary
-            attributes (RetailMediaAudienceAttributes):
+            user_action (str): Type of shopper activity used to generate the audience.
+            lookback_window (str): Length of lookback window
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -156,6 +164,8 @@ class RetailMediaAudience(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            category_ids ([int], none_type): The categories to target. [optional]  # noqa: E501
+            brand_ids ([int], none_type): The brands to target. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -187,10 +197,8 @@ class RetailMediaAudience(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.audience_type = audience_type
-        self.id = id
-        self.type = type
-        self.attributes = attributes
+        self.user_action = user_action
+        self.lookback_window = lookback_window
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -211,14 +219,12 @@ class RetailMediaAudience(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, audience_type, id, type, attributes, *args, **kwargs):  # noqa: E501
-        """RetailMediaAudience - a model defined in OpenAPI
+    def __init__(self, user_action, lookback_window, *args, **kwargs):  # noqa: E501
+        """RmLegacySegmentUserBehaviorCreateV2 - a model defined in OpenAPI
 
         Args:
-            audience_type (str): Type of the audience
-            id (str): Unique ID of this audience.
-            type (str): Name of the entity i.e. RetailMediaAudienceSummary
-            attributes (RetailMediaAudienceAttributes):
+            user_action (str): Type of shopper activity used to generate the audience.
+            lookback_window (str): Length of lookback window
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -251,6 +257,8 @@ class RetailMediaAudience(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            category_ids ([int], none_type): The categories to target. [optional]  # noqa: E501
+            brand_ids ([int], none_type): The brands to target. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -280,10 +288,8 @@ class RetailMediaAudience(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.audience_type = audience_type
-        self.id = id
-        self.type = type
-        self.attributes = attributes
+        self.user_action = user_action
+        self.lookback_window = lookback_window
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \