criteo-api-marketingsolutions-sdk 0.0.241029__py3-none-any.whl → 0.0.250129__py3-none-any.whl

criteo_api_marketingsolutions_preview/model/read_ad_set_attribution_configuration_v24_q3.py

@@ -0,0 +1,284 @@
+"""
+    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 ReadAdSetAttributionConfigurationV24Q3(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 = {
+        ('attribution_method',): {
+            'None': None,
+            'UNKNOWN': "unknown",
+            'CRITEOATTRIBUTION': "criteoAttribution",
+            'GOOGLEANALYTICSLASTCLICK': "googleAnalyticsLastClick",
+            'GOOGLEANALYTICSDATADRIVEN': "googleAnalyticsDataDriven",
+            'LASTCLICK': "lastClick",
+            'POSTCLICK': "postClick",
+        },
+        ('lookback_window',): {
+            'None': None,
+            'UNKNOWN': "unknown",
+            'SAMESESSION': "sameSession",
+            'TWENTYFOURHOURS': "twentyFourHours",
+            'SEVENDAYS': "sevenDays",
+            'THIRTYDAYS': "thirtyDays",
+        },
+    }
+
+    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 {
+            'attribution_method': (str, none_type,),  # noqa: E501
+            'lookback_window': (str, none_type,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'attribution_method': 'attributionMethod',  # noqa: E501
+        'lookback_window': 'lookbackWindow',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """ReadAdSetAttributionConfigurationV24Q3 - 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,)
+            attribution_method (str, none_type): The attribution method.. [optional]  # noqa: E501
+            lookback_window (str, none_type): The lookback window. Optional, should be specified only for attribution methods PostClick and LastClick.. [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
+        """ReadAdSetAttributionConfigurationV24Q3 - 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,)
+            attribution_method (str, none_type): The attribution method.. [optional]  # noqa: E501
+            lookback_window (str, none_type): The lookback window. Optional, should be specified only for attribution methods PostClick and LastClick.. [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_marketingsolutions_preview/model/read_ad_set_v24_q3.py

@@ -31,10 +31,12 @@ from criteo_api_marketingsolutions_preview.exceptions import ApiAttributeError
 
 def lazy_import():
     from criteo_api_marketingsolutions_preview.model.ad_set_targeting_v24_q3 import AdSetTargetingV24Q3
+    from criteo_api_marketingsolutions_preview.model.read_ad_set_attribution_configuration_v24_q3 import ReadAdSetAttributionConfigurationV24Q3
     from criteo_api_marketingsolutions_preview.model.read_ad_set_bidding_v24_q3 import ReadAdSetBiddingV24Q3
     from criteo_api_marketingsolutions_preview.model.read_ad_set_budget_v24_q3 import ReadAdSetBudgetV24Q3
     from criteo_api_marketingsolutions_preview.model.read_ad_set_schedule_v24_q3 import ReadAdSetScheduleV24Q3
     globals()['AdSetTargetingV24Q3'] = AdSetTargetingV24Q3
+    globals()['ReadAdSetAttributionConfigurationV24Q3'] = ReadAdSetAttributionConfigurationV24Q3
     globals()['ReadAdSetBiddingV24Q3'] = ReadAdSetBiddingV24Q3
     globals()['ReadAdSetBudgetV24Q3'] = ReadAdSetBudgetV24Q3
     globals()['ReadAdSetScheduleV24Q3'] = ReadAdSetScheduleV24Q3
@@ -135,6 +137,7 @@ class ReadAdSetV24Q3(ModelNormal):
             'budget': (ReadAdSetBudgetV24Q3,),  # noqa: E501
             'media_type': (str, none_type,),  # noqa: E501
             'video_channel': (str, none_type,),  # noqa: E501
+            'attribution_configuration': (ReadAdSetAttributionConfigurationV24Q3,),  # noqa: E501
         }
 
     @cached_property
@@ -155,6 +158,7 @@ class ReadAdSetV24Q3(ModelNormal):
         'budget': 'budget',  # noqa: E501
         'media_type': 'mediaType',  # noqa: E501
         'video_channel': 'videoChannel',  # noqa: E501
+        'attribution_configuration': 'attributionConfiguration',  # noqa: E501
     }
 
     read_only_vars = {
@@ -210,6 +214,7 @@ class ReadAdSetV24Q3(ModelNormal):
             budget (ReadAdSetBudgetV24Q3): [optional]  # noqa: E501
             media_type (str, none_type): [optional]  # noqa: E501
             video_channel (str, none_type): [optional]  # noqa: E501
+            attribution_configuration (ReadAdSetAttributionConfigurationV24Q3): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -307,6 +312,7 @@ class ReadAdSetV24Q3(ModelNormal):
             budget (ReadAdSetBudgetV24Q3): [optional]  # noqa: E501
             media_type (str, none_type): [optional]  # noqa: E501
             video_channel (str, none_type): [optional]  # noqa: E501
+            attribution_configuration (ReadAdSetAttributionConfigurationV24Q3): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

criteo_api_marketingsolutions_preview/model/report_ok_response.py

@@ -97,13 +97,13 @@ class ReportOkResponse(ModelNormal):
         lazy_import()
         return {
             'status': (str,),  # noqa: E501
-            'import_request_timestamp': (int,),  # noqa: E501
-            'number_of_products_in_the_batch': (int,),  # noqa: E501
-            'number_of_products_upserted': (int,),  # noqa: E501
-            'number_of_products_deleted': (int,),  # noqa: E501
-            'number_of_products_with_errors': (int,),  # noqa: E501
+            'import_request_timestamp': (int, none_type,),  # noqa: E501
+            'number_of_products_in_the_batch': (int, none_type,),  # noqa: E501
+            'number_of_products_upserted': (int, none_type,),  # noqa: E501
+            'number_of_products_deleted': (int, none_type,),  # noqa: E501
+            'number_of_products_with_errors': (int, none_type,),  # noqa: E501
             'error_details': ([ReportDetailErrors],),  # noqa: E501
-            'number_of_products_with_warnings': (int,),  # noqa: E501
+            'number_of_products_with_warnings': (int, none_type,),  # noqa: E501
             'warning_details': ([ReportDetailWarnings],),  # noqa: E501
         }
 
@@ -136,13 +136,13 @@ class ReportOkResponse(ModelNormal):
 
         Args:
             status (str): The status of the operation. The operation is completed when the status is one of (VALIDATED,VALIDATED_WITH_ERRORS,FAILED)
-            import_request_timestamp (int): The date when the original batch request was sent.
-            number_of_products_in_the_batch (int): The number of products present in the batch.
-            number_of_products_upserted (int): The number of products upserted.
-            number_of_products_deleted (int): The number of products deleted.
-            number_of_products_with_errors (int): The number of products with errors.
+            import_request_timestamp (int, none_type): The date when the original batch request was sent.
+            number_of_products_in_the_batch (int, none_type): The number of products present in the batch.
+            number_of_products_upserted (int, none_type): The number of products upserted.
+            number_of_products_deleted (int, none_type): The number of products deleted.
+            number_of_products_with_errors (int, none_type): The number of products with errors.
             error_details ([ReportDetailErrors]): The list of errors with details.
-            number_of_products_with_warnings (int): The number of products with Warnings.
+            number_of_products_with_warnings (int, none_type): The number of products with Warnings.
             warning_details ([ReportDetailWarnings]): The list of Warnings with details.
 
         Keyword Args:
@@ -241,13 +241,13 @@ class ReportOkResponse(ModelNormal):
 
         Args:
             status (str): The status of the operation. The operation is completed when the status is one of (VALIDATED,VALIDATED_WITH_ERRORS,FAILED)
-            import_request_timestamp (int): The date when the original batch request was sent.
-            number_of_products_in_the_batch (int): The number of products present in the batch.
-            number_of_products_upserted (int): The number of products upserted.
-            number_of_products_deleted (int): The number of products deleted.
-            number_of_products_with_errors (int): The number of products with errors.
+            import_request_timestamp (int, none_type): The date when the original batch request was sent.
+            number_of_products_in_the_batch (int, none_type): The number of products present in the batch.
+            number_of_products_upserted (int, none_type): The number of products upserted.
+            number_of_products_deleted (int, none_type): The number of products deleted.
+            number_of_products_with_errors (int, none_type): The number of products with errors.
             error_details ([ReportDetailErrors]): The list of errors with details.
-            number_of_products_with_warnings (int): The number of products with Warnings.
+            number_of_products_with_warnings (int, none_type): The number of products with Warnings.
             warning_details ([ReportDetailWarnings]): The list of Warnings with details.
 
         Keyword Args:

criteo_api_marketingsolutions_preview/model/{creative_response.py → resource_collection_outcome_of_ad.py}

@@ -31,12 +31,12 @@ from criteo_api_marketingsolutions_preview.exceptions import ApiAttributeError
 
 def lazy_import():
     from criteo_api_marketingsolutions_preview.model.common_problem import CommonProblem
-    from criteo_api_marketingsolutions_preview.model.creative_resource import CreativeResource
+    from criteo_api_marketingsolutions_preview.model.resource_of_ad import ResourceOfAd
     globals()['CommonProblem'] = CommonProblem
-    globals()['CreativeResource'] = CreativeResource
+    globals()['ResourceOfAd'] = ResourceOfAd
 
 
-class CreativeResponse(ModelNormal):
+class ResourceCollectionOutcomeOfAd(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -64,10 +64,6 @@ class CreativeResponse(ModelNormal):
     }
 
     validations = {
-        ('warnings',): {
-        },
-        ('errors',): {
-        },
     }
 
     @cached_property
@@ -93,7 +89,7 @@ class CreativeResponse(ModelNormal):
         """
         lazy_import()
         return {
-            'data': (CreativeResource,),  # noqa: E501
+            'data': ([ResourceOfAd], none_type,),  # noqa: E501
             'warnings': ([CommonProblem], none_type,),  # noqa: E501
             'errors': ([CommonProblem], none_type,),  # noqa: E501
         }
@@ -119,7 +115,7 @@ class CreativeResponse(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """CreativeResponse - a model defined in OpenAPI
+        """ResourceCollectionOutcomeOfAd - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -152,7 +148,7 @@ class CreativeResponse(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            data (CreativeResource): [optional]  # noqa: E501
+            data ([ResourceOfAd], none_type): [optional]  # noqa: E501
             warnings ([CommonProblem], none_type): [optional]  # noqa: E501
             errors ([CommonProblem], none_type): [optional]  # noqa: E501
         """
@@ -207,7 +203,7 @@ class CreativeResponse(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """CreativeResponse - a model defined in OpenAPI
+        """ResourceCollectionOutcomeOfAd - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -240,7 +236,7 @@ class CreativeResponse(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            data (CreativeResource): [optional]  # noqa: E501
+            data ([ResourceOfAd], none_type): [optional]  # noqa: E501
             warnings ([CommonProblem], none_type): [optional]  # noqa: E501
             errors ([CommonProblem], none_type): [optional]  # noqa: E501
         """

criteo_api_marketingsolutions_preview/model/{ad_list_response.py → resource_collection_outcome_of_coupon.py}

@@ -30,13 +30,13 @@ from criteo_api_marketingsolutions_preview.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_marketingsolutions_preview.model.ad_resource import AdResource
     from criteo_api_marketingsolutions_preview.model.common_problem import CommonProblem
-    globals()['AdResource'] = AdResource
+    from criteo_api_marketingsolutions_preview.model.resource_of_coupon import ResourceOfCoupon
     globals()['CommonProblem'] = CommonProblem
+    globals()['ResourceOfCoupon'] = ResourceOfCoupon
 
 
-class AdListResponse(ModelNormal):
+class ResourceCollectionOutcomeOfCoupon(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -64,12 +64,6 @@ class AdListResponse(ModelNormal):
     }
 
     validations = {
-        ('data',): {
-        },
-        ('warnings',): {
-        },
-        ('errors',): {
-        },
     }
 
     @cached_property
@@ -95,7 +89,7 @@ class AdListResponse(ModelNormal):
         """
         lazy_import()
         return {
-            'data': ([AdResource], none_type,),  # noqa: E501
+            'data': ([ResourceOfCoupon], none_type,),  # noqa: E501
             'warnings': ([CommonProblem], none_type,),  # noqa: E501
             'errors': ([CommonProblem], none_type,),  # noqa: E501
         }
@@ -121,7 +115,7 @@ class AdListResponse(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """AdListResponse - a model defined in OpenAPI
+        """ResourceCollectionOutcomeOfCoupon - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -154,7 +148,7 @@ class AdListResponse(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            data ([AdResource], none_type): [optional]  # noqa: E501
+            data ([ResourceOfCoupon], none_type): [optional]  # noqa: E501
             warnings ([CommonProblem], none_type): [optional]  # noqa: E501
             errors ([CommonProblem], none_type): [optional]  # noqa: E501
         """
@@ -209,7 +203,7 @@ class AdListResponse(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """AdListResponse - a model defined in OpenAPI
+        """ResourceCollectionOutcomeOfCoupon - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -242,7 +236,7 @@ class AdListResponse(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            data ([AdResource], none_type): [optional]  # noqa: E501
+            data ([ResourceOfCoupon], none_type): [optional]  # noqa: E501
             warnings ([CommonProblem], none_type): [optional]  # noqa: E501
             errors ([CommonProblem], none_type): [optional]  # noqa: E501
         """