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

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/{creative_create_model202207.py → external_preferred_line_item_create_model_v2.py}

@@ -30,11 +30,13 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_preview.model.template_variable_value import TemplateVariableValue
-    globals()['TemplateVariableValue'] = TemplateVariableValue
+    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 CreativeCreateModel202207(ModelNormal):
+class ExternalPreferredLineItemCreateModelV2(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -59,9 +61,29 @@ class CreativeCreateModel202207(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
@@ -88,10 +110,15 @@ class CreativeCreateModel202207(ModelNormal):
         lazy_import()
         return {
             'name': (str,),  # noqa: E501
-            'retailer_id': (int,),  # noqa: E501
-            'template_id': (int,),  # noqa: E501
-            'template_variable_values': ([TemplateVariableValue],),  # noqa: E501
-            'brand_id': (int,),  # 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 +128,15 @@ class CreativeCreateModel202207(ModelNormal):
 
     attribute_map = {
         'name': 'name',  # noqa: E501
-        'retailer_id': 'retailerId',  # noqa: E501
-        'template_id': 'templateId',  # noqa: E501
-        'template_variable_values': 'templateVariableValues',  # noqa: E501
-        'brand_id': 'brandId',  # 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,14 +146,17 @@ class CreativeCreateModel202207(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, name, retailer_id, template_id, template_variable_values, *args, **kwargs):  # noqa: E501
-        """CreativeCreateModel202207 - 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:
-            name (str): The name of the creative
-            retailer_id (int): The retailer associated to the creative
-            template_id (int): The creative template used for this creative
-            template_variable_values ([TemplateVariableValue]): The template chosen values
+            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
@@ -154,7 +189,9 @@ class CreativeCreateModel202207(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            brand_id (int): The brand associated to the creative. [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)
@@ -187,9 +224,12 @@ class CreativeCreateModel202207(ModelNormal):
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
         self.name = name
-        self.retailer_id = retailer_id
-        self.template_id = template_id
-        self.template_variable_values = template_variable_values
+        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 \
@@ -210,14 +250,17 @@ class CreativeCreateModel202207(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, name, retailer_id, template_id, template_variable_values, *args, **kwargs):  # noqa: E501
-        """CreativeCreateModel202207 - 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:
-            name (str): The name of the creative
-            retailer_id (int): The retailer associated to the creative
-            template_id (int): The creative template used for this creative
-            template_variable_values ([TemplateVariableValue]): The template chosen values
+            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
@@ -250,7 +293,9 @@ class CreativeCreateModel202207(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            brand_id (int): The brand associated to the creative. [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)
@@ -281,9 +326,12 @@ class CreativeCreateModel202207(ModelNormal):
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
         self.name = name
-        self.retailer_id = retailer_id
-        self.template_id = template_id
-        self.template_variable_values = template_variable_values
+        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 \

criteo_api_retailmedia_preview/model/{external_catalog_status.py → external_preferred_line_item_update_model_v2.py}

@@ -29,8 +29,14 @@ 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_capping_v2 import ExternalLineItemCappingV2
+    from criteo_api_retailmedia_preview.model.external_line_item_page_v2 import ExternalLineItemPageV2
+    globals()['ExternalLineItemCappingV2'] = ExternalLineItemCappingV2
+    globals()['ExternalLineItemPageV2'] = ExternalLineItemPageV2
 
-class ExternalCatalogStatus(ModelNormal):
+
+class ExternalPreferredLineItemUpdateModelV2(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -57,14 +63,27 @@ class ExternalCatalogStatus(ModelNormal):
     allowed_values = {
         ('status',): {
             'UNKNOWN': "unknown",
-            'PENDING': "pending",
-            'SUCCESS': "success",
-            'FAILURE': "failure",
-            'EXPIRED': "expired",
+            'ACTIVE': "active",
+            'SCHEDULED': "scheduled",
+            'DRAFT': "draft",
+            'PAUSED': "paused",
+            'BUDGETHIT': "budgetHit",
+            'ENDED': "ended",
+            'ARCHIVED': "archived",
+            'NOFUNDS': "noFunds",
+        },
+        ('pacing',): {
+            'UNKNOWN': "unknown",
+            'STANDARD': "standard",
+            'ACCELERATED': "accelerated",
         },
     }
 
     validations = {
+        ('name',): {
+            'max_length': 255,
+            'min_length': 0,
+        },
     }
 
     @cached_property
@@ -73,6 +92,7 @@ class ExternalCatalogStatus(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
@@ -87,14 +107,17 @@ class ExternalCatalogStatus(ModelNormal):
             openapi_types (dict): The key is attribute name
                 and the value is attribute type.
         """
+        lazy_import()
         return {
+            'name': (str,),  # noqa: E501
+            'start_date': (date,),  # noqa: E501
+            'end_date': (date,),  # noqa: E501
             'status': (str,),  # noqa: E501
-            'currency': (str,),  # noqa: E501
-            'row_count': (int, none_type,),  # noqa: E501
-            'file_size_bytes': (int, none_type,),  # noqa: E501
-            'md5_checksum': (str, none_type,),  # noqa: E501
-            'created_at': (datetime,),  # noqa: E501
-            'message': (str, none_type,),  # noqa: E501
+            'pacing': (str,),  # noqa: E501
+            'capping': (ExternalLineItemCappingV2,),  # noqa: E501
+            'page': (ExternalLineItemPageV2,),  # noqa: E501
+            'budget': (float,),  # noqa: E501
+            'creative_id': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -103,13 +126,15 @@ class ExternalCatalogStatus(ModelNormal):
 
 
     attribute_map = {
+        'name': 'name',  # noqa: E501
+        'start_date': 'startDate',  # noqa: E501
+        'end_date': 'endDate',  # noqa: E501
         'status': 'status',  # noqa: E501
-        'currency': 'currency',  # noqa: E501
-        'row_count': 'rowCount',  # noqa: E501
-        'file_size_bytes': 'fileSizeBytes',  # noqa: E501
-        'md5_checksum': 'md5Checksum',  # noqa: E501
-        'created_at': 'createdAt',  # noqa: E501
-        'message': 'message',  # noqa: E501
+        'pacing': 'pacing',  # noqa: E501
+        'capping': 'capping',  # noqa: E501
+        'page': 'page',  # noqa: E501
+        'budget': 'budget',  # noqa: E501
+        'creative_id': 'creativeId',  # noqa: E501
     }
 
     read_only_vars = {
@@ -119,17 +144,14 @@ class ExternalCatalogStatus(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, status, currency, row_count, file_size_bytes, md5_checksum, created_at, message, *args, **kwargs):  # noqa: E501
-        """ExternalCatalogStatus - a model defined in OpenAPI
+    def _from_openapi_data(cls, name, start_date, end_date, status, *args, **kwargs):  # noqa: E501
+        """ExternalPreferredLineItemUpdateModelV2 - a model defined in OpenAPI
 
         Args:
-            status (str): An enumeration of the status of the catalog.
-            currency (str): An ISO4217 representation of the currency products are listed under in this catalog.
-            row_count (int, none_type): An indication of the number of products contained in this catalog. Available when  this catalog reaches a success status.
-            file_size_bytes (int, none_type): The size of this catalog in bytes. Available when this catalog reaches a success status.
-            md5_checksum (str, none_type): An MD5 checksum of the catalog for use in confirming complete and uncorrupted retrieval.  Available when this catalog reaches a success status.
-            created_at (datetime): The time this catalog was created. Represented as a UTC ISO8601 string.
-            message (str, none_type): An optional information message intended for developer consumption.
+            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
+            status (str): Line Item Status Enum
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -162,6 +184,11 @@ class ExternalCatalogStatus(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            pacing (str): [optional] if omitted the server will use the default value of "accelerated"  # noqa: E501
+            capping (ExternalLineItemCappingV2): [optional]  # noqa: E501
+            page (ExternalLineItemPageV2): [optional]  # noqa: E501
+            budget (float): [optional]  # noqa: E501
+            creative_id (str, none_type): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -193,13 +220,10 @@ class ExternalCatalogStatus(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.name = name
+        self.start_date = start_date
+        self.end_date = end_date
         self.status = status
-        self.currency = currency
-        self.row_count = row_count
-        self.file_size_bytes = file_size_bytes
-        self.md5_checksum = md5_checksum
-        self.created_at = created_at
-        self.message = message
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -220,17 +244,14 @@ class ExternalCatalogStatus(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, status, currency, row_count, file_size_bytes, md5_checksum, created_at, message, *args, **kwargs):  # noqa: E501
-        """ExternalCatalogStatus - a model defined in OpenAPI
+    def __init__(self, name, start_date, end_date, status, *args, **kwargs):  # noqa: E501
+        """ExternalPreferredLineItemUpdateModelV2 - a model defined in OpenAPI
 
         Args:
-            status (str): An enumeration of the status of the catalog.
-            currency (str): An ISO4217 representation of the currency products are listed under in this catalog.
-            row_count (int, none_type): An indication of the number of products contained in this catalog. Available when  this catalog reaches a success status.
-            file_size_bytes (int, none_type): The size of this catalog in bytes. Available when this catalog reaches a success status.
-            md5_checksum (str, none_type): An MD5 checksum of the catalog for use in confirming complete and uncorrupted retrieval.  Available when this catalog reaches a success status.
-            created_at (datetime): The time this catalog was created. Represented as a UTC ISO8601 string.
-            message (str, none_type): An optional information message intended for developer consumption.
+            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
+            status (str): Line Item Status Enum
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -263,6 +284,11 @@ class ExternalCatalogStatus(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            pacing (str): [optional] if omitted the server will use the default value of "accelerated"  # noqa: E501
+            capping (ExternalLineItemCappingV2): [optional]  # noqa: E501
+            page (ExternalLineItemPageV2): [optional]  # noqa: E501
+            budget (float): [optional]  # noqa: E501
+            creative_id (str, none_type): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -292,13 +318,10 @@ class ExternalCatalogStatus(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.name = name
+        self.start_date = start_date
+        self.end_date = end_date
         self.status = status
-        self.currency = currency
-        self.row_count = row_count
-        self.file_size_bytes = file_size_bytes
-        self.md5_checksum = md5_checksum
-        self.created_at = created_at
-        self.message = message
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \