criteo-api-retailmedia-sdk 2024.1.0.250129__py3-none-any.whl → 2024.4.0.240618__py3-none-any.whl

criteo_api_retailmedia_v2024_01/model/video_variable_value.py → criteo_api_retailmedia_v2024_04/model/approval_status_model.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2024-01
+    The version of the OpenAPI document: 2024-04
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_04.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,11 +26,11 @@ from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2024_01.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError
 
 
 
-class VideoVariableValue(ModelNormal):
+class ApprovalStatusModel(ModelSimple):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -41,10 +41,6 @@ class VideoVariableValue(ModelNormal):
           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,
@@ -55,15 +51,15 @@ class VideoVariableValue(ModelNormal):
     """
 
     allowed_values = {
+        ('value',): {
+            'NOTSUBMITTED': "NotSubmitted",
+            'SUBMITTED': "Submitted",
+            'REJECTED': "Rejected",
+            'APPROVED': "Approved",
+        },
     }
 
     validations = {
-        ('url',): {
-            'min_length': 1,
-        },
-        ('duration',): {
-            'min_length': 1,
-        },
     }
 
     additional_properties_type = None
@@ -81,10 +77,7 @@ class VideoVariableValue(ModelNormal):
                 and the value is attribute type.
         """
         return {
-            'url': (str,),  # noqa: E501
-            'width': (int,),  # noqa: E501
-            'height': (int,),  # noqa: E501
-            'duration': (str,),  # noqa: E501
+            'value': (str,),
         }
 
     @cached_property
@@ -92,30 +85,32 @@ class VideoVariableValue(ModelNormal):
         return None
 
 
-    attribute_map = {
-        'url': 'url',  # noqa: E501
-        'width': 'width',  # noqa: E501
-        'height': 'height',  # noqa: E501
-        'duration': 'duration',  # noqa: E501
-    }
+    attribute_map = {}
 
-    read_only_vars = {
-    }
+    read_only_vars = set()
 
-    _composed_schemas = {}
+    _composed_schemas = None
+
+    required_properties = set([
+        '_data_store',
+        '_check_type',
+        '_spec_property_naming',
+        '_path_to_item',
+        '_configuration',
+        '_visited_composed_classes',
+    ])
 
-    @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, url, width, height, duration, *args, **kwargs):  # noqa: E501
-        """VideoVariableValue - a model defined in OpenAPI
+    def __init__(self, *args, **kwargs):
+        """ApprovalStatusModel - a model defined in OpenAPI
+
+        Note that value can be passed either in args or in kwargs, but not in both.
 
         Args:
-            url (str): The vast video url
-            width (int): The video's width
-            height (int): The video's height
-            duration (str): The video's duration
+            args[0] (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ]  # noqa: E501
 
         Keyword Args:
+            value (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ]  # noqa: E501
             _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.
@@ -147,15 +142,26 @@ class VideoVariableValue(ModelNormal):
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
         """
+        # required up here when default value is not given
+        _path_to_item = kwargs.pop('_path_to_item', ())
+
+        if 'value' in kwargs:
+            value = kwargs.pop('value')
+        elif args:
+            args = list(args)
+            value = args.pop(0)
+        else:
+            raise ApiTypeError(
+                "value is required, but not passed in args or kwargs and doesn't have default",
+                path_to_item=_path_to_item,
+                valid_classes=(self.__class__,),
+            )
 
         _check_type = kwargs.pop('_check_type', True)
-        _spec_property_naming = kwargs.pop('_spec_property_naming', True)
-        _path_to_item = kwargs.pop('_path_to_item', ())
+        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
         _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):
@@ -176,41 +182,29 @@ class VideoVariableValue(ModelNormal):
         self._path_to_item = _path_to_item
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+        self.value = value
+        if kwargs:
+            raise ApiTypeError(
+                "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % (
+                    kwargs,
+                    self.__class__.__name__,
+                ),
+                path_to_item=_path_to_item,
+                valid_classes=(self.__class__,),
+            )
 
-        self.url = url
-        self.width = width
-        self.height = height
-        self.duration = duration
-        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',
-    ])
-
+    @classmethod
     @convert_js_args_to_python_args
-    def __init__(self, url, width, height, duration, *args, **kwargs):  # noqa: E501
-        """VideoVariableValue - a model defined in OpenAPI
+    def _from_openapi_data(cls, *args, **kwargs):
+        """ApprovalStatusModel - a model defined in OpenAPI
+
+        Note that value can be passed either in args or in kwargs, but not in both.
 
         Args:
-            url (str): The vast video url
-            width (int): The video's width
-            height (int): The video's height
-            duration (str): The video's duration
+            args[0] (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ]  # noqa: E501
 
         Keyword Args:
+            value (str): The status of a booking or runnable in the context of a line item.., must be one of ["NotSubmitted", "Submitted", "Rejected", "Approved", ]  # noqa: E501
             _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.
@@ -242,10 +236,25 @@ class VideoVariableValue(ModelNormal):
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
         """
+        # required up here when default value is not given
+        _path_to_item = kwargs.pop('_path_to_item', ())
+
+        self = super(OpenApiModel, cls).__new__(cls)
+
+        if 'value' in kwargs:
+            value = kwargs.pop('value')
+        elif args:
+            args = list(args)
+            value = args.pop(0)
+        else:
+            raise ApiTypeError(
+                "value is required, but not passed in args or kwargs and doesn't have default",
+                path_to_item=_path_to_item,
+                valid_classes=(self.__class__,),
+            )
 
         _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', ())
 
@@ -269,19 +278,15 @@ class VideoVariableValue(ModelNormal):
         self._path_to_item = _path_to_item
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+        self.value = value
+        if kwargs:
+            raise ApiTypeError(
+                "Invalid named arguments=%s passed to %s. Remove those invalid named arguments." % (
+                    kwargs,
+                    self.__class__.__name__,
+                ),
+                path_to_item=_path_to_item,
+                valid_classes=(self.__class__,),
+            )
 
-        self.url = url
-        self.width = width
-        self.height = height
-        self.duration = duration
-        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.")
+        return self

{criteo_api_retailmedia_v2024_01 → criteo_api_retailmedia_v2024_04}/model/asset.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2024-01
+    The version of the OpenAPI document: 2024-04
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_04.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,7 +26,7 @@ from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2024_01.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError
 
 
 

{criteo_api_retailmedia_v2024_01 → criteo_api_retailmedia_v2024_04}/model/asset_resource.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2024-01
+    The version of the OpenAPI document: 2024-04
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_04.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,11 +26,11 @@ from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2024_01.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_v2024_01.model.asset import Asset
+    from criteo_api_retailmedia_v2024_04.model.asset import Asset
     globals()['Asset'] = Asset
 
 

{criteo_api_retailmedia_v2024_01 → criteo_api_retailmedia_v2024_04}/model/asset_response.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2024-01
+    The version of the OpenAPI document: 2024-04
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_04.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,12 +26,12 @@ from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2024_01.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_v2024_01.model.asset_resource import AssetResource
-    from criteo_api_retailmedia_v2024_01.model.common_problem import CommonProblem
+    from criteo_api_retailmedia_v2024_04.model.asset_resource import AssetResource
+    from criteo_api_retailmedia_v2024_04.model.common_problem import CommonProblem
     globals()['AssetResource'] = AssetResource
     globals()['CommonProblem'] = CommonProblem
 

{criteo_api_retailmedia_v2024_01 → criteo_api_retailmedia_v2024_04}/model/async_campaigns_report.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2024-01
+    The version of the OpenAPI document: 2024-04
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_04.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,7 +26,7 @@ from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2024_01.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError
 
 
 
@@ -55,18 +55,6 @@ class AsyncCampaignsReport(ModelNormal):
     """
 
     allowed_values = {
-        ('search_term_types',): {
-            'None': None,
-            'UNKNOWN': "unknown",
-            'SEARCHED': "searched",
-            'ENTERED': "entered",
-        },
-        ('search_term_targetings',): {
-            'None': None,
-            'UNKNOWN': "unknown",
-            'AUTOMATIC': "automatic",
-            'MANUAL': "manual",
-        },
         ('campaign_type',): {
             'None': None,
             'ALL': "all",
@@ -96,7 +84,6 @@ class AsyncCampaignsReport(ModelNormal):
             'ATTRIBUTEDTRANSACTIONS': "attributedTransactions",
             'ENVIRONMENT': "environment",
             'SERVEDCATEGORY': "servedCategory",
-            'CAPOUT': "capout",
         },
         ('click_attribution_window',): {
             'None': None,
@@ -134,19 +121,8 @@ class AsyncCampaignsReport(ModelNormal):
             'SALESCHANNEL': "salesChannel",
             'ENVIRONMENT': "environment",
             'PAGETYPENAME': "pageTypeName",
-            'PAGECATEGORY': "pageCategory",
-            'SERVEDCATEGORY': "servedCategory",
-            'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb",
             'KEYWORD': "keyword",
             'SEARCHTERM': "searchTerm",
-            'SEARCHTERMTYPE': "searchTermType",
-            'SEARCHTERMTARGETING': "searchTermTargeting",
-            'CREATIVEID': "creativeId",
-            'CREATIVENAME': "creativeName",
-            'CREATIVETYPEID': "creativeTypeId",
-            'CREATIVETYPENAME': "creativeTypeName",
-            'CREATIVETEMPLATEID': "creativeTemplateId",
-            'CREATIVETEMPLATENAME': "creativeTemplateName",
         },
         ('metrics',): {
             'None': None,
@@ -171,16 +147,6 @@ class AsyncCampaignsReport(ModelNormal):
             'VIDEOSPLAYEDTO100': "videosPlayedTo100",
             'VIDEOPLAYINGRATE': "videoPlayingRate",
             'VIDEOCOMPLETIONRATE': "videoCompletionRate",
-            'VIDEOIMPRESSIONS': "videoImpressions",
-            'VIDEOMUTED': "videoMuted",
-            'VIDEOUNMUTED': "videoUnmuted",
-            'VIDEOPAUSED': "videoPaused",
-            'VIDEORESUMED': "videoResumed",
-            'VIDEOAVGINTERACTIONRATE': "videoAvgInteractionRate",
-            'VIDEOVIEWABILITY': "videoViewability",
-            'VIDEOSTARTINGRATE': "videoStartingRate",
-            'VIDEOCPC': "videoCPC",
-            'VIDEOCPCV': "videoCPCV",
             'UNIQUEVISITORS': "uniqueVisitors",
             'FREQUENCY': "frequency",
         },
@@ -214,8 +180,6 @@ class AsyncCampaignsReport(ModelNormal):
             'end_date': (datetime,),  # noqa: E501
             'ids': ([str], none_type,),  # noqa: E501
             'id': (str, none_type,),  # noqa: E501
-            'search_term_types': ([str], none_type,),  # noqa: E501
-            'search_term_targetings': ([str], none_type,),  # noqa: E501
             'campaign_type': (str, none_type,),  # noqa: E501
             'sales_channel': (str, none_type,),  # noqa: E501
             'format': (str, none_type,),  # noqa: E501
@@ -237,8 +201,6 @@ class AsyncCampaignsReport(ModelNormal):
         'end_date': 'endDate',  # noqa: E501
         'ids': 'ids',  # noqa: E501
         'id': 'id',  # noqa: E501
-        'search_term_types': 'searchTermTypes',  # noqa: E501
-        'search_term_targetings': 'searchTermTargetings',  # noqa: E501
         'campaign_type': 'campaignType',  # noqa: E501
         'sales_channel': 'salesChannel',  # noqa: E501
         'format': 'format',  # noqa: E501
@@ -297,8 +259,6 @@ class AsyncCampaignsReport(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             ids ([str], none_type): Campaign ids to report on. [optional]  # noqa: E501
             id (str, none_type): Campaign id to report on. [optional]  # noqa: E501
-            search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional]  # noqa: E501
-            search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [optional]  # noqa: E501
             campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all"  # noqa: E501
             sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all"  # noqa: E501
             format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact"  # noqa: E501
@@ -401,8 +361,6 @@ class AsyncCampaignsReport(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             ids ([str], none_type): Campaign ids to report on. [optional]  # noqa: E501
             id (str, none_type): Campaign id to report on. [optional]  # noqa: E501
-            search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional]  # noqa: E501
-            search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [optional]  # noqa: E501
             campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all"  # noqa: E501
             sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all"  # noqa: E501
             format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact"  # noqa: E501

{criteo_api_retailmedia_v2024_01 → criteo_api_retailmedia_v2024_04}/model/async_campaigns_report_request.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2024-01
+    The version of the OpenAPI document: 2024-04
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_04.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,11 +26,11 @@ from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2024_01.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_v2024_01.model.async_campaigns_report_resource import AsyncCampaignsReportResource
+    from criteo_api_retailmedia_v2024_04.model.async_campaigns_report_resource import AsyncCampaignsReportResource
     globals()['AsyncCampaignsReportResource'] = AsyncCampaignsReportResource
 
 

{criteo_api_retailmedia_v2024_01 → criteo_api_retailmedia_v2024_04}/model/async_campaigns_report_resource.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2024-01
+    The version of the OpenAPI document: 2024-04
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,7 +11,7 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2024_04.model_utils import (  # noqa: F401
     ApiTypeError,
     ModelComposed,
     ModelNormal,
@@ -26,11 +26,11 @@ from criteo_api_retailmedia_v2024_01.model_utils import (  # noqa: F401
     validate_get_composed_info,
     OpenApiModel
 )
-from criteo_api_retailmedia_v2024_01.exceptions import ApiAttributeError
+from criteo_api_retailmedia_v2024_04.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_v2024_01.model.async_campaigns_report import AsyncCampaignsReport
+    from criteo_api_retailmedia_v2024_04.model.async_campaigns_report import AsyncCampaignsReport
     globals()['AsyncCampaignsReport'] = AsyncCampaignsReport