criteo-api-retailmedia-sdk 0.0.240207__py3-none-any.whl → 0.0.240515__py3-none-any.whl

criteo_api_retailmedia_preview/model/async_line_items_report.py

@@ -55,51 +55,15 @@ class AsyncLineItemsReport(ModelNormal):
     """
 
     allowed_values = {
-        ('metrics',): {
-            'None': None,
-            'IMPRESSIONS': "impressions",
-            'CLICKS': "clicks",
-            'SPEND': "spend",
-            'ATTRIBUTEDSALES': "attributedSales",
-            'ATTRIBUTEDUNITS': "attributedUnits",
-            'ATTRIBUTEDORDERS': "attributedOrders",
-            'CTR': "ctr",
-            'CPC': "cpc",
-            'CPO': "cpo",
-            'ROAS': "roas",
-            'ASSISTEDUNITS': "assistedUnits",
-            'ASSISTEDSALES': "assistedSales",
-            'UNIQUEVISITORS': "uniqueVisitors",
-            'FREQUENCY': "frequency",
-        },
-        ('dimensions',): {
-            'None': None,
-            'DATE': "date",
-            'HOUR': "hour",
-            'CAMPAIGNID': "campaignId",
-            'CAMPAIGNNAME': "campaignName",
-            'CAMPAIGNTYPENAME': "campaignTypeName",
-            'ADVPRODUCTCATEGORY': "advProductCategory",
-            'ADVPRODUCTID': "advProductId",
-            'ADVPRODUCTNAME': "advProductName",
-            'BRANDID': "brandId",
-            'BRANDNAME': "brandName",
-            'LINEITEMID': "lineItemId",
-            'LINEITEMNAME': "lineItemName",
-            'RETAILERID': "retailerId",
-            'RETAILERNAME': "retailerName",
-            'KEYWORD': "keyword",
-            'PAGETYPENAME': "pageTypeName",
-            'SALESCHANNEL': "salesChannel",
-            'ENVIRONMENT': "environment",
-        },
         ('campaign_type',): {
             'None': None,
+            'ALL': "all",
             'SPONSOREDPRODUCTS': "sponsoredProducts",
             'ONSITEDISPLAYS': "onSiteDisplays",
         },
         ('sales_channel',): {
             'None': None,
+            'ALL': "all",
             'OFFLINE': "offline",
             'ONLINE': "online",
         },
@@ -123,18 +87,68 @@ class AsyncLineItemsReport(ModelNormal):
         },
         ('click_attribution_window',): {
             'None': None,
+            'NONE': "none",
             '7D': "7D",
             '14D': "14D",
             '30D': "30D",
-            'NONE': "none",
         },
         ('view_attribution_window',): {
             'None': None,
+            'NONE': "none",
             '1D': "1D",
             '7D': "7D",
             '14D': "14D",
             '30D': "30D",
-            'NONE': "none",
+        },
+        ('dimensions',): {
+            'None': None,
+            'DATE': "date",
+            'HOUR': "hour",
+            'ACCOUNTID': "accountId",
+            'ACCOUNTNAME': "accountName",
+            'CAMPAIGNID': "campaignId",
+            'CAMPAIGNNAME': "campaignName",
+            'CAMPAIGNTYPENAME': "campaignTypeName",
+            'LINEITEMID': "lineItemId",
+            'LINEITEMNAME': "lineItemName",
+            'RETAILERID': "retailerId",
+            'RETAILERNAME': "retailerName",
+            'BRANDID': "brandId",
+            'BRANDNAME': "brandName",
+            'ADVPRODUCTCATEGORY': "advProductCategory",
+            'ADVPRODUCTID': "advProductId",
+            'ADVPRODUCTNAME': "advProductName",
+            'SALESCHANNEL': "salesChannel",
+            'ENVIRONMENT': "environment",
+            'PAGETYPENAME': "pageTypeName",
+            'KEYWORD': "keyword",
+            'SEARCHTERM': "searchTerm",
+        },
+        ('metrics',): {
+            'None': None,
+            'IMPRESSIONS': "impressions",
+            'CLICKS': "clicks",
+            'SPEND': "spend",
+            'ATTRIBUTEDSALES': "attributedSales",
+            'ATTRIBUTEDUNITS': "attributedUnits",
+            'ATTRIBUTEDORDERS': "attributedOrders",
+            'ASSISTEDSALES': "assistedSales",
+            'ASSISTEDUNITS': "assistedUnits",
+            'CTR': "ctr",
+            'CPC': "cpc",
+            'CPO': "cpo",
+            'CPM': "cpm",
+            'ROAS': "roas",
+            'VIDEOVIEWS': "videoViews",
+            'VIDEOSSTARTED': "videosStarted",
+            'VIDEOSPLAYEDTO25': "videosPlayedTo25",
+            'VIDEOSPLAYEDTO50': "videosPlayedTo50",
+            'VIDEOSPLAYEDTO75': "videosPlayedTo75",
+            'VIDEOSPLAYEDTO100': "videosPlayedTo100",
+            'VIDEOPLAYINGRATE': "videoPlayingRate",
+            'VIDEOCOMPLETIONRATE': "videoCompletionRate",
+            'UNIQUEVISITORS': "uniqueVisitors",
+            'FREQUENCY': "frequency",
         },
     }
 
@@ -164,16 +178,16 @@ class AsyncLineItemsReport(ModelNormal):
         return {
             'start_date': (datetime,),  # noqa: E501
             'end_date': (datetime,),  # noqa: E501
-            'metrics': ([str], none_type,),  # noqa: E501
-            'dimensions': ([str], none_type,),  # noqa: E501
+            'ids': ([str], none_type,),  # noqa: E501
+            'id': (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
             'report_type': (str, none_type,),  # noqa: E501
             'click_attribution_window': (str, none_type,),  # noqa: E501
             'view_attribution_window': (str, none_type,),  # noqa: E501
-            'ids': ([str], none_type,),  # noqa: E501
-            'id': (str, none_type,),  # noqa: E501
+            'dimensions': ([str], none_type,),  # noqa: E501
+            'metrics': ([str], none_type,),  # noqa: E501
             'timezone': (str, none_type,),  # noqa: E501
         }
 
@@ -185,16 +199,16 @@ class AsyncLineItemsReport(ModelNormal):
     attribute_map = {
         'start_date': 'startDate',  # noqa: E501
         'end_date': 'endDate',  # noqa: E501
-        'metrics': 'metrics',  # noqa: E501
-        'dimensions': 'dimensions',  # noqa: E501
+        'ids': 'ids',  # noqa: E501
+        'id': 'id',  # noqa: E501
         'campaign_type': 'campaignType',  # noqa: E501
         'sales_channel': 'salesChannel',  # noqa: E501
         'format': 'format',  # noqa: E501
         'report_type': 'reportType',  # noqa: E501
         'click_attribution_window': 'clickAttributionWindow',  # noqa: E501
         'view_attribution_window': 'viewAttributionWindow',  # noqa: E501
-        'ids': 'ids',  # noqa: E501
-        'id': 'id',  # noqa: E501
+        'dimensions': 'dimensions',  # noqa: E501
+        'metrics': 'metrics',  # noqa: E501
         'timezone': 'timezone',  # noqa: E501
     }
 
@@ -243,16 +257,16 @@ class AsyncLineItemsReport(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            metrics ([str], none_type): List of metrics to report on. [optional]  # noqa: E501
-            dimensions ([str], none_type): List of dimensions to report on. [optional]  # noqa: E501
-            campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional]  # noqa: E501
-            sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional]  # noqa: E501
+            ids ([str], none_type): Line Item ids to report on. [optional]  # noqa: E501
+            id (str, none_type): Line Item id to report on. [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
             report_type (str, none_type): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary"  # noqa: E501
             click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none"  # noqa: E501
             view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none"  # noqa: E501
-            ids ([str], none_type): Ids to report on. [optional]  # noqa: E501
-            id (str, none_type): Id to report on. [optional]  # noqa: E501
+            dimensions ([str], none_type): List of dimensions to report on. [optional]  # noqa: E501
+            metrics ([str], none_type): List of metrics to report on. [optional]  # noqa: E501
             timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC"  # noqa: E501
         """
 
@@ -345,16 +359,16 @@ class AsyncLineItemsReport(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            metrics ([str], none_type): List of metrics to report on. [optional]  # noqa: E501
-            dimensions ([str], none_type): List of dimensions to report on. [optional]  # noqa: E501
-            campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional]  # noqa: E501
-            sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional]  # noqa: E501
+            ids ([str], none_type): Line Item ids to report on. [optional]  # noqa: E501
+            id (str, none_type): Line Item id to report on. [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
             report_type (str, none_type): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary"  # noqa: E501
             click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none"  # noqa: E501
             view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none"  # noqa: E501
-            ids ([str], none_type): Ids to report on. [optional]  # noqa: E501
-            id (str, none_type): Id to report on. [optional]  # noqa: E501
+            dimensions ([str], none_type): List of dimensions to report on. [optional]  # noqa: E501
+            metrics ([str], none_type): List of metrics to report on. [optional]  # noqa: E501
             timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC"  # noqa: E501
         """
 

criteo_api_retailmedia_preview/model/audience_error.py

@@ -0,0 +1,310 @@
+"""
+    Criteo API
+
+    Criteo API - RetailMedia  # 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_retailmedia_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_retailmedia_preview.exceptions import ApiAttributeError
+
+
+
+class AudienceError(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 = {
+        ('type',): {
+            'ACCESS-CONTROL': "access-control",
+            'AUTHENTICATION': "authentication",
+            'AUTHORIZATION': "authorization",
+            'AVAILABILITY': "availability",
+            'DEPRECATION': "deprecation",
+            'QUOTA': "quota",
+            'VALIDATION': "validation",
+        },
+    }
+
+    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 {
+            'type': (str,),  # noqa: E501
+            'code': (str,),  # noqa: E501
+            'instance': (str,),  # noqa: E501
+            'trace_id': (str, none_type,),  # noqa: E501
+            'title': (str, none_type,),  # noqa: E501
+            'detail': (str, none_type,),  # noqa: E501
+            'source': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type,),  # noqa: E501
+            'stack_trace': ([str], none_type,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'type': 'type',  # noqa: E501
+        'code': 'code',  # noqa: E501
+        'instance': 'instance',  # noqa: E501
+        'trace_id': 'traceId',  # noqa: E501
+        'title': 'title',  # noqa: E501
+        'detail': 'detail',  # noqa: E501
+        'source': 'source',  # noqa: E501
+        'stack_trace': 'stackTrace',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, type, code, instance, *args, **kwargs):  # noqa: E501
+        """AudienceError - a model defined in OpenAPI
+
+        Args:
+            type (str): (REQUIRED) The classification of the error
+            code (str): (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case.
+            instance (str): (REQUIRED) A URI reference that identifies the specific occurrence of the problem
+
+        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,)
+            trace_id (str, none_type): (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.. [optional]  # noqa: E501
+            title (str, none_type): (RECOMMENDED) A short, human-readable summary of the problem type. [optional]  # noqa: E501
+            detail (str, none_type): (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem. [optional]  # noqa: E501
+            source ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s). [optional]  # noqa: E501
+            stack_trace ([str], none_type): (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology. [optional]  # noqa: E501
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', True)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        self = super(OpenApiModel, cls).__new__(cls)
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        self.type = type
+        self.code = code
+        self.instance = instance
+        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, type, code, instance, *args, **kwargs):  # noqa: E501
+        """AudienceError - a model defined in OpenAPI
+
+        Args:
+            type (str): (REQUIRED) The classification of the error
+            code (str): (REQUIRED) A machine-readable unique error code, expressed as a string value. The format used must be kebab-case.
+            instance (str): (REQUIRED) A URI reference that identifies the specific occurrence of the problem
+
+        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,)
+            trace_id (str, none_type): (REQUIRED) The Correlation ID provided by the Gateway. It is also a unique identifier for this particular occurrence of the problem.. [optional]  # noqa: E501
+            title (str, none_type): (RECOMMENDED) A short, human-readable summary of the problem type. [optional]  # noqa: E501
+            detail (str, none_type): (RECOMMENDED) A human-readable explanation specific to this occurrence of the problem. [optional]  # noqa: E501
+            source ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}, none_type): (OPTIONAL) A machine-readable structure to reference to the exact location(s) causing the error(s). [optional]  # noqa: E501
+            stack_trace ([str], none_type): (NEVER IN PRODUCTION) A human-readable stacktrace produced by the implementation technology. [optional]  # noqa: E501
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        self.type = type
+        self.code = code
+        self.instance = instance
+        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.")