criteo-api-retailmedia-sdk 2023.10.0.240118__py3-none-any.whl → 2024.1.0.240207__py3-none-any.whl

criteo_api_retailmedia_v2023_10/model/retail_media_audience_v2.py → criteo_api_retailmedia_v2024_01/model/campaign_budget_overrides.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2023-10
+    The version of the OpenAPI document: 2024-01
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2023_10.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,15 +26,17 @@ from criteo_api_retailmedia_v2023_10.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2023_10.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_01.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_v2023_10.model.retail_media_audience_v2_attributes import RetailMediaAudienceV2Attributes
-    globals()['RetailMediaAudienceV2Attributes'] = RetailMediaAudienceV2Attributes
+    from criteo_api_retailmedia_v2024_01.model.campaign_daily_budget_override import CampaignDailyBudgetOverride
+    from criteo_api_retailmedia_v2024_01.model.campaign_monthly_budget_override import CampaignMonthlyBudgetOverride
+    globals()['CampaignDailyBudgetOverride'] = CampaignDailyBudgetOverride
+    globals()['CampaignMonthlyBudgetOverride'] = CampaignMonthlyBudgetOverride
 
 
-class RetailMediaAudienceV2(ModelNormal):
+class CampaignBudgetOverrides(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -59,23 +61,12 @@ class RetailMediaAudienceV2(ModelNormal):
     """
 
     allowed_values = {
-        ('type',): {
-            'CUSTOMERLIST': "customerList",
-            'USERBEHAVIOR': "userBehavior",
-        },
     }
 
     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
+    additional_properties_type = None
 
     _nullable = False
 
@@ -91,9 +82,8 @@ class RetailMediaAudienceV2(ModelNormal):
         """
         lazy_import()
         return {
-            'type': (str,),  # noqa: E501
-            'id': (str,),  # noqa: E501
-            'attributes': (RetailMediaAudienceV2Attributes,),  # noqa: E501
+            'monthly_budget_overrides': ([CampaignMonthlyBudgetOverride],),  # noqa: E501
+            'daily_budget_overrides': ([CampaignDailyBudgetOverride],),  # noqa: E501
         }
 
     @cached_property
@@ -102,9 +92,8 @@ class RetailMediaAudienceV2(ModelNormal):
 
 
     attribute_map = {
-        'type': 'type',  # noqa: E501
-        'id': 'id',  # noqa: E501
-        'attributes': 'attributes',  # noqa: E501
+        'monthly_budget_overrides': 'monthlyBudgetOverrides',  # noqa: E501
+        'daily_budget_overrides': 'dailyBudgetOverrides',  # noqa: E501
     }
 
     read_only_vars = {
@@ -114,13 +103,12 @@ class RetailMediaAudienceV2(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, type, id, attributes, *args, **kwargs):  # noqa: E501
-        """RetailMediaAudienceV2 - a model defined in OpenAPI
+    def _from_openapi_data(cls, monthly_budget_overrides, daily_budget_overrides, *args, **kwargs):  # noqa: E501
+        """CampaignBudgetOverrides - a model defined in OpenAPI
 
         Args:
-            type (str): Type of the audience
-            id (str): Unique ID of this audience.
-            attributes (RetailMediaAudienceV2Attributes):
+            monthly_budget_overrides ([CampaignMonthlyBudgetOverride]): Campaign budget override monthly part, chronological order restricted.
+            daily_budget_overrides ([CampaignDailyBudgetOverride]): Campaign budget override daily part, chronological order restricted.
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -184,9 +172,8 @@ class RetailMediaAudienceV2(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.type = type
-        self.id = id
-        self.attributes = attributes
+        self.monthly_budget_overrides = monthly_budget_overrides
+        self.daily_budget_overrides = daily_budget_overrides
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -207,13 +194,12 @@ class RetailMediaAudienceV2(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, type, id, attributes, *args, **kwargs):  # noqa: E501
-        """RetailMediaAudienceV2 - a model defined in OpenAPI
+    def __init__(self, monthly_budget_overrides, daily_budget_overrides, *args, **kwargs):  # noqa: E501
+        """CampaignBudgetOverrides - a model defined in OpenAPI
 
         Args:
-            type (str): Type of the audience
-            id (str): Unique ID of this audience.
-            attributes (RetailMediaAudienceV2Attributes):
+            monthly_budget_overrides ([CampaignMonthlyBudgetOverride]): Campaign budget override monthly part, chronological order restricted.
+            daily_budget_overrides ([CampaignDailyBudgetOverride]): Campaign budget override daily part, chronological order restricted.
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -275,9 +261,8 @@ class RetailMediaAudienceV2(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.type = type
-        self.id = id
-        self.attributes = attributes
+        self.monthly_budget_overrides = monthly_budget_overrides
+        self.daily_budget_overrides = daily_budget_overrides
         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_v2024_01/model/campaign_daily_budget_override.py

@@ -0,0 +1,283 @@
+"""
+    Criteo API
+
+    Criteo API - RetailMedia  # noqa: E501
+
+    The version of the OpenAPI document: 2024-01
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from criteo_api_retailmedia_v2024_01.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_01.exceptions import ApiAttributeError
+
+
+
+class CampaignDailyBudgetOverride(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',): {
+            'None': None,
+            'EXPIRED': "Expired",
+            'ACTIVE': "Active",
+            'UPCOMING': "Upcoming",
+        },
+    }
+
+    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.
+        """
+        return {
+            'duration': (str,),  # noqa: E501
+            'max_daily_spend': (float,),  # noqa: E501
+            'start_date': (datetime, none_type,),  # noqa: E501
+            'status': (str, none_type,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'duration': 'duration',  # noqa: E501
+        'max_daily_spend': 'maxDailySpend',  # noqa: E501
+        'start_date': 'startDate',  # noqa: E501
+        'status': 'status',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, duration, max_daily_spend, *args, **kwargs):  # noqa: E501
+        """CampaignDailyBudgetOverride - a model defined in OpenAPI
+
+        Args:
+            duration (str): The number of DAYs that the override is active from StartDate, e.g. \"1D\". Must end with 'D' or 'd'.
+            max_daily_spend (float): Daily budget override maximum daily spend amount.
+
+        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,)
+            start_date (datetime, none_type): Daily budget override start date, format \"yyyy-MM-dd\". If it is null, the StartDate would be the following date of the last item in the override sequence.. [optional]  # noqa: E501
+            status (str, none_type): Daily budget override computed status.. [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.duration = duration
+        self.max_daily_spend = max_daily_spend
+        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, duration, max_daily_spend, *args, **kwargs):  # noqa: E501
+        """CampaignDailyBudgetOverride - a model defined in OpenAPI
+
+        Args:
+            duration (str): The number of DAYs that the override is active from StartDate, e.g. \"1D\". Must end with 'D' or 'd'.
+            max_daily_spend (float): Daily budget override maximum daily spend amount.
+
+        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,)
+            start_date (datetime, none_type): Daily budget override start date, format \"yyyy-MM-dd\". If it is null, the StartDate would be the following date of the last item in the override sequence.. [optional]  # noqa: E501
+            status (str, none_type): Daily budget override computed status.. [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.duration = duration
+        self.max_daily_spend = max_daily_spend
+        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.")