criteo-api-retailmedia-sdk 0.0.240118__py3-none-any.whl → 0.0.240404__py3-none-any.whl

criteo_api_retailmedia_preview/model/external_line_item_page_category_v2.py

@@ -0,0 +1,273 @@
+"""
+    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 ExternalLineItemPageCategoryV2(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 = {
+    }
+
+    @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 {
+            'category_id': (str,),  # noqa: E501
+            'include_children': (bool,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'category_id': 'categoryId',  # noqa: E501
+        'include_children': 'includeChildren',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, category_id, *args, **kwargs):  # noqa: E501
+        """ExternalLineItemPageCategoryV2 - a model defined in OpenAPI
+
+        Args:
+            category_id (str):
+
+        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,)
+            include_children (bool): [optional] if omitted the server will use the default value of True  # 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.category_id = category_id
+        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, category_id, *args, **kwargs):  # noqa: E501
+        """ExternalLineItemPageCategoryV2 - a model defined in OpenAPI
+
+        Args:
+            category_id (str):
+
+        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,)
+            include_children (bool): [optional] if omitted the server will use the default value of True  # 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.category_id = category_id
+        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/{page_type_environment.py → external_line_item_page_v2.py}

@@ -29,8 +29,12 @@ from criteo_api_retailmedia_preview.model_utils import (  # noqa: F401
 from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
+def lazy_import():
+    from criteo_api_retailmedia_preview.model.external_line_item_page_category_v2 import ExternalLineItemPageCategoryV2
+    globals()['ExternalLineItemPageCategoryV2'] = ExternalLineItemPageCategoryV2
 
-class PageTypeEnvironment(ModelNormal):
+
+class ExternalLineItemPageV2(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -56,24 +60,19 @@ class PageTypeEnvironment(ModelNormal):
 
     allowed_values = {
         ('page_type',): {
-            'SEARCH': "Search",
-            'HOME': "Home",
-            'BROWSE': "Browse",
-            'CHECKOUT': "Checkout",
-            'CATEGORY': "Category",
-            'PRODUCTDETAIL': "ProductDetail",
-            'CONFIRMATION': "Confirmation",
-            'MERCHANDISING': "Merchandising",
-            'DEALS': "Deals",
-        },
-        ('environments',): {
-            'WEB': "Web",
-            'MOBILE': "Mobile",
-            'APP': "App",
-            'LOCKOUT': "Lockout",
-            'MIXED': "Mixed",
-            'IOS': "iOS",
-            'ANDROID': "Android",
+            'UNKNOWN': "unknown",
+            'SEARCH': "search",
+            'HOME': "home",
+            'BROWSE': "browse",
+            'CHECKOUT': "checkout",
+            'CATEGORY': "category",
+            'PRODUCTDETAIL': "productDetail",
+            'CONFIRMATION': "confirmation",
+            'MERCHANDISING': "merchandising",
+            'DEALS': "deals",
+            'FAVORITES': "favorites",
+            'SEARCHBAR': "searchBar",
+            'CATEGORYMENU': "categoryMenu",
         },
     }
 
@@ -86,6 +85,7 @@ class PageTypeEnvironment(ModelNormal):
         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
@@ -100,9 +100,11 @@ class PageTypeEnvironment(ModelNormal):
             openapi_types (dict): The key is attribute name
                 and the value is attribute type.
         """
+        lazy_import()
         return {
             'page_type': (str,),  # noqa: E501
-            'environments': ([str],),  # noqa: E501
+            'categories': ([ExternalLineItemPageCategoryV2],),  # noqa: E501
+            'search_keywords': ([str],),  # noqa: E501
         }
 
     @cached_property
@@ -112,7 +114,8 @@ class PageTypeEnvironment(ModelNormal):
 
     attribute_map = {
         'page_type': 'pageType',  # noqa: E501
-        'environments': 'environments',  # noqa: E501
+        'categories': 'categories',  # noqa: E501
+        'search_keywords': 'searchKeywords',  # noqa: E501
     }
 
     read_only_vars = {
@@ -122,8 +125,11 @@ class PageTypeEnvironment(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """PageTypeEnvironment - a model defined in OpenAPI
+    def _from_openapi_data(cls, page_type, *args, **kwargs):  # noqa: E501
+        """ExternalLineItemPageV2 - a model defined in OpenAPI
+
+        Args:
+            page_type (str): Page Type Enum
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -156,8 +162,8 @@ class PageTypeEnvironment(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            page_type (str): Creative PageType. [optional]  # noqa: E501
-            environments ([str]): List of environments per PageType. [optional]  # noqa: E501
+            categories ([ExternalLineItemPageCategoryV2]): [optional]  # noqa: E501
+            search_keywords ([str]): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -189,6 +195,7 @@ class PageTypeEnvironment(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.page_type = page_type
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -209,8 +216,11 @@ class PageTypeEnvironment(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, *args, **kwargs):  # noqa: E501
-        """PageTypeEnvironment - a model defined in OpenAPI
+    def __init__(self, page_type, *args, **kwargs):  # noqa: E501
+        """ExternalLineItemPageV2 - a model defined in OpenAPI
+
+        Args:
+            page_type (str): Page Type Enum
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -243,8 +253,8 @@ class PageTypeEnvironment(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            page_type (str): Creative PageType. [optional]  # noqa: E501
-            environments ([str]): List of environments per PageType. [optional]  # noqa: E501
+            categories ([ExternalLineItemPageCategoryV2]): [optional]  # noqa: E501
+            search_keywords ([str]): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -274,6 +284,7 @@ class PageTypeEnvironment(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.page_type = page_type
         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_retailmedia_preview/model/{retail_media_audience_attributes.py → external_preferred_line_item_create_model_v2.py}

@@ -30,13 +30,13 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_preview.model.customer_list_details import CustomerListDetails
-    from criteo_api_retailmedia_preview.model.user_behavior_details import UserBehaviorDetails
-    globals()['CustomerListDetails'] = CustomerListDetails
-    globals()['UserBehaviorDetails'] = UserBehaviorDetails
+    from criteo_api_retailmedia_preview.model.external_line_item_capping_v2 import ExternalLineItemCappingV2
+    from criteo_api_retailmedia_preview.model.external_line_item_page_v2 import ExternalLineItemPageV2
+    globals()['ExternalLineItemCappingV2'] = ExternalLineItemCappingV2
+    globals()['ExternalLineItemPageV2'] = ExternalLineItemPageV2
 
 
-class RetailMediaAudienceAttributes(ModelNormal):
+class ExternalPreferredLineItemCreateModelV2(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -61,9 +61,29 @@ class RetailMediaAudienceAttributes(ModelNormal):
     """
 
     allowed_values = {
+        ('pacing',): {
+            'UNKNOWN': "unknown",
+            'STANDARD': "standard",
+            'ACCELERATED': "accelerated",
+        },
+        ('status',): {
+            'UNKNOWN': "unknown",
+            'ACTIVE': "active",
+            'SCHEDULED': "scheduled",
+            'DRAFT': "draft",
+            'PAUSED': "paused",
+            'BUDGETHIT': "budgetHit",
+            'ENDED': "ended",
+            'ARCHIVED': "archived",
+            'NOFUNDS': "noFunds",
+        },
     }
 
     validations = {
+        ('name',): {
+            'max_length': 255,
+            'min_length': 0,
+        },
     }
 
     @cached_property
@@ -89,10 +109,16 @@ class RetailMediaAudienceAttributes(ModelNormal):
         """
         lazy_import()
         return {
-            'retailer_id': (str,),  # noqa: E501
             'name': (str,),  # noqa: E501
-            'user_behavior_details': (UserBehaviorDetails,),  # noqa: E501
-            'customer_list_details': (CustomerListDetails,),  # noqa: E501
+            'start_date': (date,),  # noqa: E501
+            'end_date': (date,),  # noqa: E501
+            'pacing': (str,),  # noqa: E501
+            'page': (ExternalLineItemPageV2,),  # noqa: E501
+            'target_retailer_id': (str,),  # noqa: E501
+            'budget': (float,),  # noqa: E501
+            'status': (str,),  # noqa: E501
+            'capping': (ExternalLineItemCappingV2,),  # noqa: E501
+            'creative_id': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -101,10 +127,16 @@ class RetailMediaAudienceAttributes(ModelNormal):
 
 
     attribute_map = {
-        'retailer_id': 'retailerId',  # noqa: E501
         'name': 'name',  # noqa: E501
-        'user_behavior_details': 'userBehaviorDetails',  # noqa: E501
-        'customer_list_details': 'customerListDetails',  # noqa: E501
+        'start_date': 'startDate',  # noqa: E501
+        'end_date': 'endDate',  # noqa: E501
+        'pacing': 'pacing',  # noqa: E501
+        'page': 'page',  # noqa: E501
+        'target_retailer_id': 'targetRetailerId',  # noqa: E501
+        'budget': 'budget',  # noqa: E501
+        'status': 'status',  # noqa: E501
+        'capping': 'capping',  # noqa: E501
+        'creative_id': 'creativeId',  # noqa: E501
     }
 
     read_only_vars = {
@@ -114,12 +146,17 @@ class RetailMediaAudienceAttributes(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, retailer_id, name, *args, **kwargs):  # noqa: E501
-        """RetailMediaAudienceAttributes - a model defined in OpenAPI
+    def _from_openapi_data(cls, name, start_date, end_date, pacing, page, target_retailer_id, budget, *args, **kwargs):  # noqa: E501
+        """ExternalPreferredLineItemCreateModelV2 - a model defined in OpenAPI
 
         Args:
-            retailer_id (str): ID of the retailer associated with this audience
-            name (str): Name of the audience.
+            name (str):
+            start_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD
+            end_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD
+            pacing (str): Line Item Pacing Enum
+            page (ExternalLineItemPageV2):
+            target_retailer_id (str):
+            budget (float):
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -152,8 +189,9 @@ class RetailMediaAudienceAttributes(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            user_behavior_details (UserBehaviorDetails): [optional]  # noqa: E501
-            customer_list_details (CustomerListDetails): [optional]  # noqa: E501
+            status (str): Line Item Status Enum. [optional]  # noqa: E501
+            capping (ExternalLineItemCappingV2): [optional]  # noqa: E501
+            creative_id (str, none_type): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -185,8 +223,13 @@ class RetailMediaAudienceAttributes(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.retailer_id = retailer_id
         self.name = name
+        self.start_date = start_date
+        self.end_date = end_date
+        self.pacing = pacing
+        self.page = page
+        self.target_retailer_id = target_retailer_id
+        self.budget = budget
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -207,12 +250,17 @@ class RetailMediaAudienceAttributes(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, retailer_id, name, *args, **kwargs):  # noqa: E501
-        """RetailMediaAudienceAttributes - a model defined in OpenAPI
+    def __init__(self, name, start_date, end_date, pacing, page, target_retailer_id, budget, *args, **kwargs):  # noqa: E501
+        """ExternalPreferredLineItemCreateModelV2 - a model defined in OpenAPI
 
         Args:
-            retailer_id (str): ID of the retailer associated with this audience
-            name (str): Name of the audience.
+            name (str):
+            start_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD
+            end_date (date): Represents the Date as a year, month, and day in the format YYYY-MM-DD
+            pacing (str): Line Item Pacing Enum
+            page (ExternalLineItemPageV2):
+            target_retailer_id (str):
+            budget (float):
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -245,8 +293,9 @@ class RetailMediaAudienceAttributes(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            user_behavior_details (UserBehaviorDetails): [optional]  # noqa: E501
-            customer_list_details (CustomerListDetails): [optional]  # noqa: E501
+            status (str): Line Item Status Enum. [optional]  # noqa: E501
+            capping (ExternalLineItemCappingV2): [optional]  # noqa: E501
+            creative_id (str, none_type): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -276,8 +325,13 @@ class RetailMediaAudienceAttributes(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.retailer_id = retailer_id
         self.name = name
+        self.start_date = start_date
+        self.end_date = end_date
+        self.pacing = pacing
+        self.page = page
+        self.target_retailer_id = target_retailer_id
+        self.budget = budget
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \