criteo-api-marketingsolutions-sdk 2025.4.0.250730__py3-none-any.whl → 2025.4.0.260112__py3-none-any.whl

criteo_api_marketingsolutions_v2025_04/model/{outcome.py → creative_read.py}

@@ -30,11 +30,17 @@ from criteo_api_marketingsolutions_v2025_04.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_marketingsolutions_v2025_04.model.common_problem import CommonProblem
-    globals()['CommonProblem'] = CommonProblem
+    from criteo_api_marketingsolutions_v2025_04.model.adaptive_read_attributes import AdaptiveReadAttributes
+    from criteo_api_marketingsolutions_v2025_04.model.dynamic_attributes import DynamicAttributes
+    from criteo_api_marketingsolutions_v2025_04.model.html_tag_attributes import HtmlTagAttributes
+    from criteo_api_marketingsolutions_v2025_04.model.image_attributes import ImageAttributes
+    globals()['AdaptiveReadAttributes'] = AdaptiveReadAttributes
+    globals()['DynamicAttributes'] = DynamicAttributes
+    globals()['HtmlTagAttributes'] = HtmlTagAttributes
+    globals()['ImageAttributes'] = ImageAttributes
 
 
-class Outcome(ModelNormal):
+class CreativeRead(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -64,9 +70,16 @@ class Outcome(ModelNormal):
     validations = {
     }
 
-    additional_properties_type = None
+    @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
+    _nullable = True
 
     @cached_property
     def openapi_types():
@@ -80,8 +93,17 @@ class Outcome(ModelNormal):
         """
         lazy_import()
         return {
-            'errors': ([CommonProblem], none_type,),  # noqa: E501
-            'warnings': ([CommonProblem], none_type,),  # noqa: E501
+            'advertiser_id': (str,),  # noqa: E501
+            'author': (str,),  # noqa: E501
+            'name': (str,),  # noqa: E501
+            'status': (str,),  # noqa: E501
+            'adaptive_attributes': (AdaptiveReadAttributes,),  # noqa: E501
+            'dataset_id': (str, none_type,),  # noqa: E501
+            'description': (str, none_type,),  # noqa: E501
+            'dynamic_attributes': (DynamicAttributes,),  # noqa: E501
+            'format': (str, none_type,),  # noqa: E501
+            'html_tag_attributes': (HtmlTagAttributes,),  # noqa: E501
+            'image_attributes': (ImageAttributes,),  # noqa: E501
         }
 
     @cached_property
@@ -90,21 +112,34 @@ class Outcome(ModelNormal):
 
 
     attribute_map = {
-        'errors': 'errors',  # noqa: E501
-        'warnings': 'warnings',  # noqa: E501
+        'advertiser_id': 'advertiserId',  # noqa: E501
+        'author': 'author',  # noqa: E501
+        'name': 'name',  # noqa: E501
+        'status': 'status',  # noqa: E501
+        'adaptive_attributes': 'adaptiveAttributes',  # noqa: E501
+        'dataset_id': 'datasetId',  # noqa: E501
+        'description': 'description',  # noqa: E501
+        'dynamic_attributes': 'dynamicAttributes',  # noqa: E501
+        'format': 'format',  # noqa: E501
+        'html_tag_attributes': 'htmlTagAttributes',  # noqa: E501
+        'image_attributes': 'imageAttributes',  # noqa: E501
     }
 
     read_only_vars = {
-        'errors',  # noqa: E501
-        'warnings',  # noqa: E501
     }
 
     _composed_schemas = {}
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """Outcome - a model defined in OpenAPI
+    def _from_openapi_data(cls, advertiser_id, author, name, status, *args, **kwargs):  # noqa: E501
+        """CreativeRead - a model defined in OpenAPI
+
+        Args:
+            advertiser_id (str): Advertiser linked to the Creative
+            author (str): The login of the person who created this creative (
+            name (str): The name of the creative
+            status (str): The status of the creative
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -137,8 +172,13 @@ class Outcome(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            errors ([CommonProblem], none_type): Errors that occured during this call.. [optional]  # noqa: E501
-            warnings ([CommonProblem], none_type): Warnings that occured during this call.. [optional]  # noqa: E501
+            adaptive_attributes (AdaptiveReadAttributes): [optional]  # noqa: E501
+            dataset_id (str, none_type): Data set id linked to the Creative. [optional]  # noqa: E501
+            description (str, none_type): The description of the creative. [optional]  # noqa: E501
+            dynamic_attributes (DynamicAttributes): [optional]  # noqa: E501
+            format (str, none_type): The format of the creative. [optional]  # noqa: E501
+            html_tag_attributes (HtmlTagAttributes): [optional]  # noqa: E501
+            image_attributes (ImageAttributes): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -170,6 +210,10 @@ class Outcome(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.advertiser_id = advertiser_id
+        self.author = author
+        self.name = name
+        self.status = status
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -190,8 +234,14 @@ class Outcome(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, *args, **kwargs):  # noqa: E501
-        """Outcome - a model defined in OpenAPI
+    def __init__(self, advertiser_id, author, name, status, *args, **kwargs):  # noqa: E501
+        """CreativeRead - a model defined in OpenAPI
+
+        Args:
+            advertiser_id (str): Advertiser linked to the Creative
+            author (str): The login of the person who created this creative (
+            name (str): The name of the creative
+            status (str): The status of the creative
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -224,8 +274,13 @@ class Outcome(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            errors ([CommonProblem], none_type): Errors that occured during this call.. [optional]  # noqa: E501
-            warnings ([CommonProblem], none_type): Warnings that occured during this call.. [optional]  # noqa: E501
+            adaptive_attributes (AdaptiveReadAttributes): [optional]  # noqa: E501
+            dataset_id (str, none_type): Data set id linked to the Creative. [optional]  # noqa: E501
+            description (str, none_type): The description of the creative. [optional]  # noqa: E501
+            dynamic_attributes (DynamicAttributes): [optional]  # noqa: E501
+            format (str, none_type): The format of the creative. [optional]  # noqa: E501
+            html_tag_attributes (HtmlTagAttributes): [optional]  # noqa: E501
+            image_attributes (ImageAttributes): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -255,6 +310,10 @@ class Outcome(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.advertiser_id = advertiser_id
+        self.author = author
+        self.name = name
+        self.status = status
         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_marketingsolutions_v2025_04/model/placements_report_query_message.py

@@ -69,6 +69,12 @@ class PlacementsReportQueryMessage(ModelNormal):
             'CATEGORYID': "CategoryId",
             'CATEGORYNAME': "CategoryName",
         },
+        ('format',): {
+            'CSV': "csv",
+            'EXCEL': "excel",
+            'XML': "xml",
+            'JSON': "json",
+        },
     }
 
     validations = {
@@ -93,13 +99,13 @@ class PlacementsReportQueryMessage(ModelNormal):
             'currency': (str,),  # noqa: E501
             'dimensions': ([str],),  # noqa: E501
             'end_date': (datetime,),  # noqa: E501
-            'format': (str,),  # noqa: E501
             'metrics': ([str],),  # noqa: E501
             'start_date': (datetime,),  # noqa: E501
             'adset_ids': (str, none_type,),  # noqa: E501
             'campaign_ids': (str, none_type,),  # noqa: E501
             'disclosed': (bool,),  # noqa: E501
             'environment': (str, none_type,),  # noqa: E501
+            'format': (str,),  # noqa: E501
             'placement': (str, none_type,),  # noqa: E501
             'timezone': (str, none_type,),  # noqa: E501
         }
@@ -114,13 +120,13 @@ class PlacementsReportQueryMessage(ModelNormal):
         'currency': 'currency',  # noqa: E501
         'dimensions': 'dimensions',  # noqa: E501
         'end_date': 'endDate',  # noqa: E501
-        'format': 'format',  # noqa: E501
         'metrics': 'metrics',  # noqa: E501
         'start_date': 'startDate',  # noqa: E501
         'adset_ids': 'adsetIds',  # noqa: E501
         'campaign_ids': 'campaignIds',  # noqa: E501
         'disclosed': 'disclosed',  # noqa: E501
         'environment': 'environment',  # noqa: E501
+        'format': 'format',  # noqa: E501
         'placement': 'placement',  # noqa: E501
         'timezone': 'timezone',  # noqa: E501
     }
@@ -132,7 +138,7 @@ class PlacementsReportQueryMessage(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, advertiser_ids, currency, dimensions, end_date, format, metrics, start_date, *args, **kwargs):  # noqa: E501
+    def _from_openapi_data(cls, advertiser_ids, currency, dimensions, end_date, metrics, start_date, *args, **kwargs):  # noqa: E501
         """PlacementsReportQueryMessage - a model defined in OpenAPI
 
         Args:
@@ -140,7 +146,6 @@ class PlacementsReportQueryMessage(ModelNormal):
             currency (str): The currency used for the report. ISO 4217 code (three-letter capitals).
             dimensions ([str]): The dimensions for the report.
             end_date (datetime): End date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.
-            format (str): The file format of the generated report: csv, xml, excel or json.
             metrics ([str]): The list of metrics to report.
             start_date (datetime): Start date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.
 
@@ -179,6 +184,7 @@ class PlacementsReportQueryMessage(ModelNormal):
             campaign_ids (str, none_type): The comma-separated list of campaign ids.. [optional]  # noqa: E501
             disclosed (bool): Returns disclosed or undisclosed placements.. [optional] if omitted the server will use the default value of True  # noqa: E501
             environment (str, none_type): Type of environment: Web, Android or iOS.. [optional]  # noqa: E501
+            format (str): The file format of the generated report. [optional] if omitted the server will use the default value of "json"  # noqa: E501
             placement (str, none_type): Filter the value of the placement. [optional]  # noqa: E501
             timezone (str, none_type): The timezone used for the report. Timezone Database format (Tz).. [optional] if omitted the server will use the default value of "UTC"  # noqa: E501
         """
@@ -216,7 +222,6 @@ class PlacementsReportQueryMessage(ModelNormal):
         self.currency = currency
         self.dimensions = dimensions
         self.end_date = end_date
-        self.format = format
         self.metrics = metrics
         self.start_date = start_date
         for var_name, var_value in kwargs.items():
@@ -239,7 +244,7 @@ class PlacementsReportQueryMessage(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, advertiser_ids, currency, dimensions, end_date, format, metrics, start_date, *args, **kwargs):  # noqa: E501
+    def __init__(self, advertiser_ids, currency, dimensions, end_date, metrics, start_date, *args, **kwargs):  # noqa: E501
         """PlacementsReportQueryMessage - a model defined in OpenAPI
 
         Args:
@@ -247,7 +252,6 @@ class PlacementsReportQueryMessage(ModelNormal):
             currency (str): The currency used for the report. ISO 4217 code (three-letter capitals).
             dimensions ([str]): The dimensions for the report.
             end_date (datetime): End date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.
-            format (str): The file format of the generated report: csv, xml, excel or json.
             metrics ([str]): The list of metrics to report.
             start_date (datetime): Start date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.
 
@@ -286,6 +290,7 @@ class PlacementsReportQueryMessage(ModelNormal):
             campaign_ids (str, none_type): The comma-separated list of campaign ids.. [optional]  # noqa: E501
             disclosed (bool): Returns disclosed or undisclosed placements.. [optional] if omitted the server will use the default value of True  # noqa: E501
             environment (str, none_type): Type of environment: Web, Android or iOS.. [optional]  # noqa: E501
+            format (str): The file format of the generated report. [optional] if omitted the server will use the default value of "json"  # noqa: E501
             placement (str, none_type): Filter the value of the placement. [optional]  # noqa: E501
             timezone (str, none_type): The timezone used for the report. Timezone Database format (Tz).. [optional] if omitted the server will use the default value of "UTC"  # noqa: E501
         """
@@ -321,7 +326,6 @@ class PlacementsReportQueryMessage(ModelNormal):
         self.currency = currency
         self.dimensions = dimensions
         self.end_date = end_date
-        self.format = format
         self.metrics = metrics
         self.start_date = start_date
         for var_name, var_value in kwargs.items():

criteo_api_marketingsolutions_v2025_04/model/{resource_collection_outcome_of_creative.py → resource_collection_outcome_of_creative_read.py}

@@ -31,12 +31,12 @@ from criteo_api_marketingsolutions_v2025_04.exceptions import ApiAttributeError
 
 def lazy_import():
     from criteo_api_marketingsolutions_v2025_04.model.common_problem import CommonProblem
-    from criteo_api_marketingsolutions_v2025_04.model.resource_of_creative import ResourceOfCreative
+    from criteo_api_marketingsolutions_v2025_04.model.resource_of_creative_read import ResourceOfCreativeRead
     globals()['CommonProblem'] = CommonProblem
-    globals()['ResourceOfCreative'] = ResourceOfCreative
+    globals()['ResourceOfCreativeRead'] = ResourceOfCreativeRead
 
 
-class ResourceCollectionOutcomeOfCreative(ModelNormal):
+class ResourceCollectionOutcomeOfCreativeRead(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -89,7 +89,7 @@ class ResourceCollectionOutcomeOfCreative(ModelNormal):
         """
         lazy_import()
         return {
-            'data': ([ResourceOfCreative], none_type,),  # noqa: E501
+            'data': ([ResourceOfCreativeRead], none_type,),  # noqa: E501
             'errors': ([CommonProblem], none_type,),  # noqa: E501
             'warnings': ([CommonProblem], none_type,),  # noqa: E501
         }
@@ -115,7 +115,7 @@ class ResourceCollectionOutcomeOfCreative(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """ResourceCollectionOutcomeOfCreative - a model defined in OpenAPI
+        """ResourceCollectionOutcomeOfCreativeRead - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -148,7 +148,7 @@ class ResourceCollectionOutcomeOfCreative(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            data ([ResourceOfCreative], none_type): [optional]  # noqa: E501
+            data ([ResourceOfCreativeRead], none_type): [optional]  # noqa: E501
             errors ([CommonProblem], none_type): [optional]  # noqa: E501
             warnings ([CommonProblem], none_type): [optional]  # noqa: E501
         """
@@ -203,7 +203,7 @@ class ResourceCollectionOutcomeOfCreative(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """ResourceCollectionOutcomeOfCreative - a model defined in OpenAPI
+        """ResourceCollectionOutcomeOfCreativeRead - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -236,7 +236,7 @@ class ResourceCollectionOutcomeOfCreative(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            data ([ResourceOfCreative], none_type): [optional]  # noqa: E501
+            data ([ResourceOfCreativeRead], none_type): [optional]  # noqa: E501
             errors ([CommonProblem], none_type): [optional]  # noqa: E501
             warnings ([CommonProblem], none_type): [optional]  # noqa: E501
         """

criteo_api_marketingsolutions_v2025_04/model/{error_code_response.py → resource_of_creative_read.py}

@@ -30,13 +30,11 @@ from criteo_api_marketingsolutions_v2025_04.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_marketingsolutions_v2025_04.model.audience_error import AudienceError
-    from criteo_api_marketingsolutions_v2025_04.model.audience_warning import AudienceWarning
-    globals()['AudienceError'] = AudienceError
-    globals()['AudienceWarning'] = AudienceWarning
+    from criteo_api_marketingsolutions_v2025_04.model.creative_read import CreativeRead
+    globals()['CreativeRead'] = CreativeRead
 
 
-class ErrorCodeResponse(ModelNormal):
+class ResourceOfCreativeRead(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -89,8 +87,9 @@ class ErrorCodeResponse(ModelNormal):
         """
         lazy_import()
         return {
-            'errors': ([AudienceError],),  # noqa: E501
-            'warnings': ([AudienceWarning], none_type,),  # noqa: E501
+            'attributes': (CreativeRead,),  # noqa: E501
+            'id': (str, none_type,),  # noqa: E501
+            'type': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -99,8 +98,9 @@ class ErrorCodeResponse(ModelNormal):
 
 
     attribute_map = {
-        'errors': 'errors',  # noqa: E501
-        'warnings': 'warnings',  # noqa: E501
+        'attributes': 'attributes',  # noqa: E501
+        'id': 'id',  # noqa: E501
+        'type': 'type',  # noqa: E501
     }
 
     read_only_vars = {
@@ -110,11 +110,8 @@ class ErrorCodeResponse(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, errors, *args, **kwargs):  # noqa: E501
-        """ErrorCodeResponse - a model defined in OpenAPI
-
-        Args:
-            errors ([AudienceError]):
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """ResourceOfCreativeRead - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -147,7 +144,9 @@ class ErrorCodeResponse(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            warnings ([AudienceWarning], none_type): [optional]  # noqa: E501
+            attributes (CreativeRead): [optional]  # noqa: E501
+            id (str, none_type): Unique identifier of this resource.. [optional]  # noqa: E501
+            type (str, none_type): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -179,7 +178,6 @@ class ErrorCodeResponse(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.errors = errors
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -200,11 +198,8 @@ class ErrorCodeResponse(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, errors, *args, **kwargs):  # noqa: E501
-        """ErrorCodeResponse - a model defined in OpenAPI
-
-        Args:
-            errors ([AudienceError]):
+    def __init__(self, *args, **kwargs):  # noqa: E501
+        """ResourceOfCreativeRead - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -237,7 +232,9 @@ class ErrorCodeResponse(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            warnings ([AudienceWarning], none_type): [optional]  # noqa: E501
+            attributes (CreativeRead): [optional]  # noqa: E501
+            id (str, none_type): Unique identifier of this resource.. [optional]  # noqa: E501
+            type (str, none_type): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -267,7 +264,6 @@ class ErrorCodeResponse(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.errors = errors
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \