criteo-api-retailmedia-sdk 0.0.240808__py3-none-any.whl → 0.0.250129__py3-none-any.whl

criteo_api_retailmedia_preview/model/sku_min_bid.py

@@ -0,0 +1,269 @@
+"""
+    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 SkuMinBid(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 = {
+    }
+
+    validations = {
+    }
+
+    additional_properties_type = None
+
+    _nullable = False
+
+    @cached_property
+    def openapi_types():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+
+        Returns
+            openapi_types (dict): The key is attribute name
+                and the value is attribute type.
+        """
+        return {
+            'sku_id': (str,),  # noqa: E501
+            'min_bid': (float,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'sku_id': 'skuId',  # noqa: E501
+        'min_bid': 'minBid',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, sku_id, min_bid, *args, **kwargs):  # noqa: E501
+        """SkuMinBid - a model defined in OpenAPI
+
+        Args:
+            sku_id (str): Sku id.
+            min_bid (float): Minimum bid amount value.
+
+        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,)
+        """
+
+        _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.sku_id = sku_id
+        self.min_bid = min_bid
+        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, sku_id, min_bid, *args, **kwargs):  # noqa: E501
+        """SkuMinBid - a model defined in OpenAPI
+
+        Args:
+            sku_id (str): Sku id.
+            min_bid (float): Minimum bid amount value.
+
+        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,)
+        """
+
+        _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.sku_id = sku_id
+        self.min_bid = min_bid
+        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_retailmedia_preview/model/sku_slim_data_v2.py

@@ -68,10 +68,6 @@ class SkuSlimDataV2(ModelNormal):
             'max_length': 1000,
             'min_length': 0,
         },
-        ('description',): {
-            'max_length': 1000,
-            'min_length': 0,
-        },
     }
 
     @cached_property
@@ -101,11 +97,11 @@ class SkuSlimDataV2(ModelNormal):
             'is_in_stock': (bool,),  # noqa: E501
             'updated_at': (datetime,),  # noqa: E501
             'name': (str,),  # noqa: E501
-            'description': (str,),  # noqa: E501
+            'description': (str, none_type,),  # noqa: E501
             'category': (Category,),  # noqa: E501
             'brand': (Brand,),  # noqa: E501
-            'gtin': (str,),  # noqa: E501
-            'mpn': (str,),  # noqa: E501
+            'gtin': (str, none_type,),  # noqa: E501
+            'mpn': (str, none_type,),  # noqa: E501
             'image_url': (str,),  # noqa: E501
         }
 
@@ -174,11 +170,11 @@ class SkuSlimDataV2(ModelNormal):
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             name (str): A short product name.. [optional]  # noqa: E501
-            description (str): A short description of the product.. [optional]  # noqa: E501
+            description (str, none_type): A short description of the product.. [optional]  # noqa: E501
             category (Category): [optional]  # noqa: E501
             brand (Brand): [optional]  # noqa: E501
-            gtin (str): A GTIN identifier for the product if available. Covers variations such as EANs and UPCs.. [optional]  # noqa: E501
-            mpn (str): The MPN for the product if available.. [optional]  # noqa: E501
+            gtin (str, none_type): A GTIN identifier for the product if available. Covers variations such as EANs and UPCs.. [optional]  # noqa: E501
+            mpn (str, none_type): The MPN for the product if available.. [optional]  # noqa: E501
             image_url (str): An http image resource provided by the retailer.. [optional]  # noqa: E501
         """
 
@@ -274,11 +270,11 @@ class SkuSlimDataV2(ModelNormal):
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             name (str): A short product name.. [optional]  # noqa: E501
-            description (str): A short description of the product.. [optional]  # noqa: E501
+            description (str, none_type): A short description of the product.. [optional]  # noqa: E501
             category (Category): [optional]  # noqa: E501
             brand (Brand): [optional]  # noqa: E501
-            gtin (str): A GTIN identifier for the product if available. Covers variations such as EANs and UPCs.. [optional]  # noqa: E501
-            mpn (str): The MPN for the product if available.. [optional]  # noqa: E501
+            gtin (str, none_type): A GTIN identifier for the product if available. Covers variations such as EANs and UPCs.. [optional]  # noqa: E501
+            mpn (str, none_type): The MPN for the product if available.. [optional]  # noqa: E501
             image_url (str): An http image resource provided by the retailer.. [optional]  # noqa: E501
         """
 

criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py

@@ -110,6 +110,10 @@ class SyncAttributedTransactionsReport(ModelNormal):
             'PAGETYPENAME': "pageTypeName",
             'KEYWORD': "keyword",
             'ATTRIBUTIONWINDOW': "attributionWindow",
+            'SALESELLERID': "saleSellerId",
+            'SALESELLERNAME': "saleSellerName",
+            'ACTIVITYSELLERID': "activitySellerId",
+            'ACTIVITYSELLERNAME': "activitySellerName",
         },
         ('metrics',): {
             'None': None,

criteo_api_retailmedia_preview/model/sync_campaigns_report.py

@@ -59,7 +59,6 @@ class SyncCampaignsReport(ModelNormal):
             'None': None,
             'SUMMARY': "summary",
             'PAGETYPE': "pageType",
-            'KEYWORD': "keyword",
             'PRODUCTCATEGORY': "productCategory",
             'PRODUCT': "product",
             'ENVIRONMENT': "environment",
@@ -114,9 +113,8 @@ class SyncCampaignsReport(ModelNormal):
             'ENVIRONMENT': "environment",
             'PAGETYPENAME': "pageTypeName",
             'PAGECATEGORY': "pageCategory",
+            'SERVEDCATEGORY': "servedCategory",
             'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb",
-            'KEYWORD': "keyword",
-            'SEARCHTERM': "searchTerm",
         },
         ('metrics',): {
             'None': None,
@@ -133,14 +131,6 @@ class SyncCampaignsReport(ModelNormal):
             '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",
         },

criteo_api_retailmedia_preview/model/sync_line_items_report.py

@@ -59,7 +59,6 @@ class SyncLineItemsReport(ModelNormal):
             'None': None,
             'SUMMARY': "summary",
             'PAGETYPE': "pageType",
-            'KEYWORD': "keyword",
             'PRODUCTCATEGORY': "productCategory",
             'PRODUCT': "product",
             'ENVIRONMENT': "environment",
@@ -114,9 +113,8 @@ class SyncLineItemsReport(ModelNormal):
             'ENVIRONMENT': "environment",
             'PAGETYPENAME': "pageTypeName",
             'PAGECATEGORY': "pageCategory",
+            'SERVEDCATEGORY': "servedCategory",
             'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb",
-            'KEYWORD': "keyword",
-            'SEARCHTERM': "searchTerm",
         },
         ('metrics',): {
             'None': None,
@@ -133,14 +131,6 @@ class SyncLineItemsReport(ModelNormal):
             '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",
         },

criteo_api_retailmedia_preview/model/{external_template_variable_value.py → template_variable_value.py}

@@ -30,21 +30,21 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_preview.model.external_choice_variable_value import ExternalChoiceVariableValue
-    from criteo_api_retailmedia_preview.model.external_color_variable_value import ExternalColorVariableValue
-    from criteo_api_retailmedia_preview.model.external_files_variable_value import ExternalFilesVariableValue
-    from criteo_api_retailmedia_preview.model.external_hyperlink_variable_value import ExternalHyperlinkVariableValue
-    from criteo_api_retailmedia_preview.model.external_text_variable_value import ExternalTextVariableValue
-    from criteo_api_retailmedia_preview.model.external_video_variable_value import ExternalVideoVariableValue
-    globals()['ExternalChoiceVariableValue'] = ExternalChoiceVariableValue
-    globals()['ExternalColorVariableValue'] = ExternalColorVariableValue
-    globals()['ExternalFilesVariableValue'] = ExternalFilesVariableValue
-    globals()['ExternalHyperlinkVariableValue'] = ExternalHyperlinkVariableValue
-    globals()['ExternalTextVariableValue'] = ExternalTextVariableValue
-    globals()['ExternalVideoVariableValue'] = ExternalVideoVariableValue
-
-
-class ExternalTemplateVariableValue(ModelNormal):
+    from criteo_api_retailmedia_preview.model.choice_variable_value import ChoiceVariableValue
+    from criteo_api_retailmedia_preview.model.color_variable_value import ColorVariableValue
+    from criteo_api_retailmedia_preview.model.files_variable_value import FilesVariableValue
+    from criteo_api_retailmedia_preview.model.hyperlink_variable_value import HyperlinkVariableValue
+    from criteo_api_retailmedia_preview.model.text_variable_value import TextVariableValue
+    from criteo_api_retailmedia_preview.model.video_variable_value import VideoVariableValue
+    globals()['ChoiceVariableValue'] = ChoiceVariableValue
+    globals()['ColorVariableValue'] = ColorVariableValue
+    globals()['FilesVariableValue'] = FilesVariableValue
+    globals()['HyperlinkVariableValue'] = HyperlinkVariableValue
+    globals()['TextVariableValue'] = TextVariableValue
+    globals()['VideoVariableValue'] = VideoVariableValue
+
+
+class TemplateVariableValue(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -74,14 +74,7 @@ class ExternalTemplateVariableValue(ModelNormal):
     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
-        """
-        lazy_import()
-        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+    additional_properties_type = None
 
     _nullable = False
 
@@ -98,12 +91,12 @@ class ExternalTemplateVariableValue(ModelNormal):
         lazy_import()
         return {
             'id': (str,),  # noqa: E501
-            'text_variable_value': (ExternalTextVariableValue,),  # noqa: E501
-            'choice_variable_value': (ExternalChoiceVariableValue,),  # noqa: E501
-            'color_variable_value': (ExternalColorVariableValue,),  # noqa: E501
-            'files_variable_value': (ExternalFilesVariableValue,),  # noqa: E501
-            'hyperlink_variable_value': (ExternalHyperlinkVariableValue,),  # noqa: E501
-            'video_variable_value': (ExternalVideoVariableValue,),  # noqa: E501
+            'text_variable_value': (TextVariableValue,),  # noqa: E501
+            'choice_variable_value': (ChoiceVariableValue,),  # noqa: E501
+            'color_variable_value': (ColorVariableValue,),  # noqa: E501
+            'files_variable_value': (FilesVariableValue,),  # noqa: E501
+            'hyperlink_variable_value': (HyperlinkVariableValue,),  # noqa: E501
+            'video_variable_value': (VideoVariableValue,),  # noqa: E501
         }
 
     @cached_property
@@ -129,7 +122,7 @@ class ExternalTemplateVariableValue(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, id, *args, **kwargs):  # noqa: E501
-        """ExternalTemplateVariableValue - a model defined in OpenAPI
+        """TemplateVariableValue - a model defined in OpenAPI
 
         Args:
             id (str): The id of the template variable the value is applied to
@@ -165,12 +158,12 @@ class ExternalTemplateVariableValue(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            text_variable_value (ExternalTextVariableValue): [optional]  # noqa: E501
-            choice_variable_value (ExternalChoiceVariableValue): [optional]  # noqa: E501
-            color_variable_value (ExternalColorVariableValue): [optional]  # noqa: E501
-            files_variable_value (ExternalFilesVariableValue): [optional]  # noqa: E501
-            hyperlink_variable_value (ExternalHyperlinkVariableValue): [optional]  # noqa: E501
-            video_variable_value (ExternalVideoVariableValue): [optional]  # noqa: E501
+            text_variable_value (TextVariableValue): [optional]  # noqa: E501
+            choice_variable_value (ChoiceVariableValue): [optional]  # noqa: E501
+            color_variable_value (ColorVariableValue): [optional]  # noqa: E501
+            files_variable_value (FilesVariableValue): [optional]  # noqa: E501
+            hyperlink_variable_value (HyperlinkVariableValue): [optional]  # noqa: E501
+            video_variable_value (VideoVariableValue): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -224,7 +217,7 @@ class ExternalTemplateVariableValue(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, id, *args, **kwargs):  # noqa: E501
-        """ExternalTemplateVariableValue - a model defined in OpenAPI
+        """TemplateVariableValue - a model defined in OpenAPI
 
         Args:
             id (str): The id of the template variable the value is applied to
@@ -260,12 +253,12 @@ class ExternalTemplateVariableValue(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            text_variable_value (ExternalTextVariableValue): [optional]  # noqa: E501
-            choice_variable_value (ExternalChoiceVariableValue): [optional]  # noqa: E501
-            color_variable_value (ExternalColorVariableValue): [optional]  # noqa: E501
-            files_variable_value (ExternalFilesVariableValue): [optional]  # noqa: E501
-            hyperlink_variable_value (ExternalHyperlinkVariableValue): [optional]  # noqa: E501
-            video_variable_value (ExternalVideoVariableValue): [optional]  # noqa: E501
+            text_variable_value (TextVariableValue): [optional]  # noqa: E501
+            choice_variable_value (ChoiceVariableValue): [optional]  # noqa: E501
+            color_variable_value (ColorVariableValue): [optional]  # noqa: E501
+            files_variable_value (FilesVariableValue): [optional]  # noqa: E501
+            hyperlink_variable_value (HyperlinkVariableValue): [optional]  # noqa: E501
+            video_variable_value (VideoVariableValue): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)