criteo-api-marketingsolutions-sdk 0.0.250409__py3-none-any.whl → 0.0.250606__py3-none-any.whl

criteo_api_marketingsolutions_preview/model/generate_realtime_statistics_report_request_attributes.py

@@ -0,0 +1,319 @@
+"""
+    Criteo API
+
+    Criteo API - MarketingSolutions  # 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_marketingsolutions_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_marketingsolutions_preview.exceptions import ApiAttributeError
+
+
+
+class GenerateRealtimeStatisticsReportRequestAttributes(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 = {
+        ('dimensions',): {
+            'None': None,
+            'ADVERTISER': "Advertiser",
+            'ADVERTISERID': "AdvertiserId",
+            'CAMPAIGN': "Campaign",
+            'CAMPAIGNID': "CampaignId",
+            'ADSET': "Adset",
+            'ADSETID': "AdsetId",
+            'YEAR': "Year",
+            'MONTH': "Month",
+            'WEEK': "Week",
+            'DAY': "Day",
+            'HOUR': "Hour",
+        },
+        ('metrics',): {
+            'None': None,
+            'CLICKS': "Clicks",
+            'COST': "Cost",
+            'DISPLAYS': "Displays",
+        },
+    }
+
+    validations = {
+        ('advertiser_ids',): {
+            'max_items': 10,
+            'min_items': 1,
+        },
+        ('lookback_window',): {
+            'inclusive_maximum': 24,
+            'inclusive_minimum': 1,
+        },
+    }
+
+    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 {
+            'advertiser_ids': ([str],),  # noqa: E501
+            'adset_ids': ([str], none_type,),  # noqa: E501
+            'campaign_ids': ([str], none_type,),  # noqa: E501
+            'currency': (str, none_type,),  # noqa: E501
+            'dimensions': ([str], none_type,),  # noqa: E501
+            'lookback_window': (int,),  # noqa: E501
+            'metrics': ([str], none_type,),  # noqa: E501
+            'timezone': (str, none_type,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'advertiser_ids': 'advertiserIds',  # noqa: E501
+        'adset_ids': 'adsetIds',  # noqa: E501
+        'campaign_ids': 'campaignIds',  # noqa: E501
+        'currency': 'currency',  # noqa: E501
+        'dimensions': 'dimensions',  # noqa: E501
+        'lookback_window': 'lookbackWindow',  # noqa: E501
+        'metrics': 'metrics',  # noqa: E501
+        'timezone': 'timezone',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, advertiser_ids, *args, **kwargs):  # noqa: E501
+        """GenerateRealtimeStatisticsReportRequestAttributes - a model defined in OpenAPI
+
+        Args:
+            advertiser_ids ([str]): List of advertiser ids to report on.
+
+        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,)
+            adset_ids ([str], none_type): List of adset ids to filter.. [optional]  # noqa: E501
+            campaign_ids ([str], none_type): List of campaign ids to filter.. [optional]  # noqa: E501
+            currency (str, none_type): The currency used for the report. ISO 4217 code (three-letter capitals).. [optional] if omitted the server will use the default value of "EUR"  # noqa: E501
+            dimensions ([str], none_type): List of dimensions for the report.. [optional] if omitted the server will use the default value of ["AdvertiserId","Advertiser","CampaignId","Campaign","AdsetId","Adset","Day","Hour"]  # noqa: E501
+            lookback_window (int): The number of hours to consider in the past.. [optional] if omitted the server will use the default value of 12  # noqa: E501
+            metrics ([str], none_type): List of metrics for the report.. [optional] if omitted the server will use the default value of ["Displays","Clicks","Cost"]  # noqa: E501
+            timezone (str, none_type): The timezone used for the report.. [optional] if omitted the server will use the default value of "UTC"  # 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.advertiser_ids = advertiser_ids
+        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, advertiser_ids, *args, **kwargs):  # noqa: E501
+        """GenerateRealtimeStatisticsReportRequestAttributes - a model defined in OpenAPI
+
+        Args:
+            advertiser_ids ([str]): List of advertiser ids to report on.
+
+        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,)
+            adset_ids ([str], none_type): List of adset ids to filter.. [optional]  # noqa: E501
+            campaign_ids ([str], none_type): List of campaign ids to filter.. [optional]  # noqa: E501
+            currency (str, none_type): The currency used for the report. ISO 4217 code (three-letter capitals).. [optional] if omitted the server will use the default value of "EUR"  # noqa: E501
+            dimensions ([str], none_type): List of dimensions for the report.. [optional] if omitted the server will use the default value of ["AdvertiserId","Advertiser","CampaignId","Campaign","AdsetId","Adset","Day","Hour"]  # noqa: E501
+            lookback_window (int): The number of hours to consider in the past.. [optional] if omitted the server will use the default value of 12  # noqa: E501
+            metrics ([str], none_type): List of metrics for the report.. [optional] if omitted the server will use the default value of ["Displays","Clicks","Cost"]  # noqa: E501
+            timezone (str, none_type): The timezone used for the report.. [optional] if omitted the server will use the default value of "UTC"  # 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.advertiser_ids = advertiser_ids
+        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_marketingsolutions_preview/model/{automated_budget_configuration.py → generate_realtime_statistics_report_request_attributes_request.py}

@@ -3,7 +3,7 @@
 
     Criteo API - MarketingSolutions  # noqa: E501
 
-    The version of the OpenAPI document: preview
+    The version of the OpenAPI document: Preview
     Generated by: https://openapi-generator.tech
 """
 
@@ -29,8 +29,12 @@ from criteo_api_marketingsolutions_preview.model_utils import (  # noqa: F401
 from criteo_api_marketingsolutions_preview.exceptions import ApiAttributeError
 
 
+def lazy_import():
+    from criteo_api_marketingsolutions_preview.model.generate_realtime_statistics_report_request_attributes_resource import GenerateRealtimeStatisticsReportRequestAttributesResource
+    globals()['GenerateRealtimeStatisticsReportRequestAttributesResource'] = GenerateRealtimeStatisticsReportRequestAttributesResource
 
-class AutomatedBudgetConfiguration(ModelNormal):
+
+class GenerateRealtimeStatisticsReportRequestAttributesRequest(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -55,33 +59,14 @@ class AutomatedBudgetConfiguration(ModelNormal):
     """
 
     allowed_values = {
-        ('objective',): {
-            'CUSTOMACTION': "customAction",
-            'CLICKS': "clicks",
-            'CONVERSIONS': "conversions",
-            'DISPLAYS': "displays",
-            'APPPROMOTION': "appPromotion",
-            'REVENUE': "revenue",
-            'STORECONVERSIONS': "storeConversions",
-            'VALUE': "value",
-            'REACH': "reach",
-            'VISITS': "visits",
-            'VIDEOVIEWS': "videoViews",
-        },
     }
 
     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
+    additional_properties_type = None
 
-    _nullable = True
+    _nullable = False
 
     @cached_property
     def openapi_types():
@@ -93,8 +78,9 @@ class AutomatedBudgetConfiguration(ModelNormal):
             openapi_types (dict): The key is attribute name
                 and the value is attribute type.
         """
+        lazy_import()
         return {
-            'objective': (str,),  # noqa: E501
+            'data': (GenerateRealtimeStatisticsReportRequestAttributesResource,),  # noqa: E501
         }
 
     @cached_property
@@ -103,7 +89,7 @@ class AutomatedBudgetConfiguration(ModelNormal):
 
 
     attribute_map = {
-        'objective': 'objective',  # noqa: E501
+        'data': 'data',  # noqa: E501
     }
 
     read_only_vars = {
@@ -114,7 +100,7 @@ class AutomatedBudgetConfiguration(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """AutomatedBudgetConfiguration - a model defined in OpenAPI
+        """GenerateRealtimeStatisticsReportRequestAttributesRequest - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -147,7 +133,7 @@ class AutomatedBudgetConfiguration(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            objective (str): Objective of the ad set. [optional]  # noqa: E501
+            data (GenerateRealtimeStatisticsReportRequestAttributesResource): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -200,7 +186,7 @@ class AutomatedBudgetConfiguration(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """AutomatedBudgetConfiguration - a model defined in OpenAPI
+        """GenerateRealtimeStatisticsReportRequestAttributesRequest - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -233,7 +219,7 @@ class AutomatedBudgetConfiguration(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            objective (str): Objective of the ad set. [optional]  # noqa: E501
+            data (GenerateRealtimeStatisticsReportRequestAttributesResource): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)