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

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

@@ -30,7 +30,7 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 
-class UserBehaviorDetails(ModelNormal):
+class RmLegacySegmentUserBehaviorV1(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -55,9 +55,10 @@ class UserBehaviorDetails(ModelNormal):
     """
 
     allowed_values = {
-        ('target_type',): {
-            'BRAND': "brand",
-            'CATEGORY': "category",
+        ('user_type',): {
+            'VIEWER': "viewer",
+            'BUYER': "buyer",
+            'ADDTOCARTER': "addToCarter",
         },
         ('lookback_window',): {
             'P7D': "P7D",
@@ -70,13 +71,16 @@ class UserBehaviorDetails(ModelNormal):
             'P150D': "P150D",
             'P180D': "P180D",
         },
-        ('user_type',): {
-            'VIEWER': "viewer",
-            'BUYER': "buyer",
+        ('target_type',): {
+            'None': None,
+            'BRAND': "brand",
+            'CATEGORY': "category",
         },
     }
 
     validations = {
+        ('target_ids',): {
+        },
     }
 
     @cached_property
@@ -100,10 +104,10 @@ class UserBehaviorDetails(ModelNormal):
                 and the value is attribute type.
         """
         return {
-            'target_type': (str,),  # noqa: E501
-            'target_ids': ([str],),  # noqa: E501
-            'lookback_window': (str,),  # noqa: E501
             'user_type': (str,),  # noqa: E501
+            'lookback_window': (str,),  # noqa: E501
+            'target_type': (str, none_type,),  # noqa: E501
+            'target_ids': ([str], none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -112,10 +116,10 @@ class UserBehaviorDetails(ModelNormal):
 
 
     attribute_map = {
+        'user_type': 'userType',  # noqa: E501
+        'lookback_window': 'lookbackWindow',  # noqa: E501
         'target_type': 'targetType',  # noqa: E501
         'target_ids': 'targetIds',  # noqa: E501
-        'lookback_window': 'lookbackWindow',  # noqa: E501
-        'user_type': 'userType',  # noqa: E501
     }
 
     read_only_vars = {
@@ -125,14 +129,12 @@ class UserBehaviorDetails(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, target_type, target_ids, lookback_window, user_type, *args, **kwargs):  # noqa: E501
-        """UserBehaviorDetails - a model defined in OpenAPI
+    def _from_openapi_data(cls, user_type, lookback_window, *args, **kwargs):  # noqa: E501
+        """RmLegacySegmentUserBehaviorV1 - a model defined in OpenAPI
 
         Args:
-            target_type (str): Type of target
-            target_ids ([str]): ist of ids for the target type
+            user_type (str): Type of shopper activity used to generate the audience.
             lookback_window (str): Length of lookback window
-            user_type (str): Type of the user
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -165,6 +167,8 @@ class UserBehaviorDetails(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            target_type (str, none_type): Type of target. [optional]  # noqa: E501
+            target_ids ([str], none_type): The categories to target. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -196,10 +200,8 @@ class UserBehaviorDetails(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.target_type = target_type
-        self.target_ids = target_ids
-        self.lookback_window = lookback_window
         self.user_type = user_type
+        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 \
@@ -220,14 +222,12 @@ class UserBehaviorDetails(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, target_type, target_ids, lookback_window, user_type, *args, **kwargs):  # noqa: E501
-        """UserBehaviorDetails - a model defined in OpenAPI
+    def __init__(self, user_type, lookback_window, *args, **kwargs):  # noqa: E501
+        """RmLegacySegmentUserBehaviorV1 - a model defined in OpenAPI
 
         Args:
-            target_type (str): Type of target
-            target_ids ([str]): ist of ids for the target type
+            user_type (str): Type of shopper activity used to generate the audience.
             lookback_window (str): Length of lookback window
-            user_type (str): Type of the user
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -260,6 +260,8 @@ class UserBehaviorDetails(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            target_type (str, none_type): Type of target. [optional]  # noqa: E501
+            target_ids ([str], none_type): The categories to target. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -289,10 +291,8 @@ class UserBehaviorDetails(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.target_type = target_type
-        self.target_ids = target_ids
-        self.lookback_window = lookback_window
         self.user_type = user_type
+        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 \

criteo_api_retailmedia_preview/model/{create_user_behavior_segment_v2.py → rm_legacy_segment_user_behavior_v2.py}

@@ -30,7 +30,7 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 
-class CreateUserBehaviorSegmentV2(ModelNormal):
+class RmLegacySegmentUserBehaviorV2(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -74,6 +74,10 @@ class CreateUserBehaviorSegmentV2(ModelNormal):
     }
 
     validations = {
+        ('category_ids',): {
+        },
+        ('brand_ids',): {
+        },
     }
 
     @cached_property
@@ -120,8 +124,6 @@ class CreateUserBehaviorSegmentV2(ModelNormal):
     }
 
     read_only_vars = {
-        'min_price',  # noqa: E501
-        'max_price',  # noqa: E501
     }
 
     _composed_schemas = {}
@@ -129,7 +131,7 @@ class CreateUserBehaviorSegmentV2(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, user_action, lookback_window, *args, **kwargs):  # noqa: E501
-        """CreateUserBehaviorSegmentV2 - a model defined in OpenAPI
+        """RmLegacySegmentUserBehaviorV2 - a model defined in OpenAPI
 
         Args:
             user_action (str): Type of shopper activity used to generate the audience.
@@ -224,7 +226,7 @@ class CreateUserBehaviorSegmentV2(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, user_action, lookback_window, *args, **kwargs):  # noqa: E501
-        """CreateUserBehaviorSegmentV2 - a model defined in OpenAPI
+        """RmLegacySegmentUserBehaviorV2 - a model defined in OpenAPI
 
         Args:
             user_action (str): Type of shopper activity used to generate the audience.

criteo_api_retailmedia_preview/model/value_resource_collection_outcome_of_int64.py

@@ -0,0 +1,274 @@
+"""
+    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
+
+
+def lazy_import():
+    from criteo_api_retailmedia_preview.model.common_problem import CommonProblem
+    from criteo_api_retailmedia_preview.model.value_resource_of_int64 import ValueResourceOfInt64
+    globals()['CommonProblem'] = CommonProblem
+    globals()['ValueResourceOfInt64'] = ValueResourceOfInt64
+
+
+class ValueResourceCollectionOutcomeOfInt64(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 = {
+    }
+
+    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 {
+            'data': ([ValueResourceOfInt64], none_type,),  # noqa: E501
+            'warnings': ([CommonProblem], none_type,),  # noqa: E501
+            'errors': ([CommonProblem], none_type,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'data': 'data',  # noqa: E501
+        'warnings': 'warnings',  # noqa: E501
+        'errors': 'errors',  # noqa: E501
+    }
+
+    read_only_vars = {
+        'warnings',  # noqa: E501
+        'errors',  # noqa: E501
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """ValueResourceCollectionOutcomeOfInt64 - 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,)
+            data ([ValueResourceOfInt64], none_type): [optional]  # noqa: E501
+            warnings ([CommonProblem], none_type): [optional]  # noqa: E501
+            errors ([CommonProblem], 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
+        """ValueResourceCollectionOutcomeOfInt64 - 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,)
+            data ([ValueResourceOfInt64], none_type): [optional]  # noqa: E501
+            warnings ([CommonProblem], none_type): [optional]  # noqa: E501
+            errors ([CommonProblem], 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.")