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

criteo_api_retailmedia_preview/model/{template.py → external_preferred_line_item_v2.py}

@@ -30,11 +30,13 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_preview.model.section import Section
-    globals()['Section'] = Section
+    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 Template(ModelNormal):
+class ExternalPreferredLineItemV2(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -59,21 +61,30 @@ class Template(ModelNormal):
     """
 
     allowed_values = {
-        ('creative_format',): {
-            'UNKNOWN': "Unknown",
-            'FLAGSHIP': "FlagShip",
-            'SHOWCASE': "Showcase",
-            'SPONSOREDPRODUCTS': "SponsoredProducts",
-            'BUTTERFLY': "Butterfly",
-            'BUNDLEBOOST': "BundleBoost",
-            'IAB': "IAB",
-            'CUSTOM': "CUSTOM",
-            'DISPLAYPANEL': "DisplayPanel",
-            'DIGITALSHELFTALKER': "DigitalShelfTalker",
+        ('status',): {
+            'UNKNOWN': "unknown",
+            'ACTIVE': "active",
+            'SCHEDULED': "scheduled",
+            'DRAFT': "draft",
+            'PAUSED': "paused",
+            'BUDGETHIT': "budgetHit",
+            'ENDED': "ended",
+            'ARCHIVED': "archived",
+            'NOFUNDS': "noFunds",
+        },
+        ('pacing',): {
+            'None': None,
+            'UNKNOWN': "unknown",
+            'STANDARD': "standard",
+            'ACCELERATED': "accelerated",
         },
     }
 
     validations = {
+        ('name',): {
+            'max_length': 255,
+            'min_length': 0,
+        },
     }
 
     @cached_property
@@ -99,18 +110,21 @@ class Template(ModelNormal):
         """
         lazy_import()
         return {
-            'creative_format': (str,),  # noqa: E501
             'name': (str,),  # noqa: E501
-            'sku_collection_min': (int,),  # noqa: E501
-            'sku_per_collection_min': (int,),  # noqa: E501
-            'all_collections_mandatory': (bool,),  # noqa: E501
+            'start_date': (date,),  # noqa: E501
+            'end_date': (date,),  # noqa: E501
+            'status': (str,),  # noqa: E501
+            'target_retailer_id': (str,),  # noqa: E501
+            'campaign_id': (str,),  # noqa: E501
             'created_at': (datetime,),  # noqa: E501
             'updated_at': (datetime,),  # noqa: E501
-            'sections': ([Section],),  # noqa: E501
-            'retailer_id': (int,),  # noqa: E501
-            'sku_collection_max': (int, none_type,),  # noqa: E501
-            'sku_per_collection_max': (int, none_type,),  # noqa: E501
-            'displayable_skus_max': (int, none_type,),  # noqa: E501
+            'pacing': (str, none_type,),  # noqa: E501
+            'capping': (ExternalLineItemCappingV2,),  # noqa: E501
+            'page': (ExternalLineItemPageV2,),  # noqa: E501
+            'budget': (float, none_type,),  # noqa: E501
+            'budget_spent': (float, none_type,),  # noqa: E501
+            'budget_remaining': (float, none_type,),  # noqa: E501
+            'creative_id': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -119,18 +133,21 @@ class Template(ModelNormal):
 
 
     attribute_map = {
-        'creative_format': 'creativeFormat',  # noqa: E501
         'name': 'name',  # noqa: E501
-        'sku_collection_min': 'skuCollectionMin',  # noqa: E501
-        'sku_per_collection_min': 'skuPerCollectionMin',  # noqa: E501
-        'all_collections_mandatory': 'allCollectionsMandatory',  # noqa: E501
+        'start_date': 'startDate',  # noqa: E501
+        'end_date': 'endDate',  # noqa: E501
+        'status': 'status',  # noqa: E501
+        'target_retailer_id': 'targetRetailerId',  # noqa: E501
+        'campaign_id': 'campaignId',  # noqa: E501
         'created_at': 'createdAt',  # noqa: E501
         'updated_at': 'updatedAt',  # noqa: E501
-        'sections': 'sections',  # noqa: E501
-        'retailer_id': 'retailerId',  # noqa: E501
-        'sku_collection_max': 'skuCollectionMax',  # noqa: E501
-        'sku_per_collection_max': 'skuPerCollectionMax',  # noqa: E501
-        'displayable_skus_max': 'displayableSkusMax',  # noqa: E501
+        'pacing': 'pacing',  # noqa: E501
+        'capping': 'capping',  # noqa: E501
+        'page': 'page',  # noqa: E501
+        'budget': 'budget',  # noqa: E501
+        'budget_spent': 'budgetSpent',  # noqa: E501
+        'budget_remaining': 'budgetRemaining',  # noqa: E501
+        'creative_id': 'creativeId',  # noqa: E501
     }
 
     read_only_vars = {
@@ -140,18 +157,18 @@ class Template(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, creative_format, name, sku_collection_min, sku_per_collection_min, all_collections_mandatory, created_at, updated_at, sections, *args, **kwargs):  # noqa: E501
-        """Template - a model defined in OpenAPI
+    def _from_openapi_data(cls, name, start_date, end_date, status, target_retailer_id, campaign_id, created_at, updated_at, *args, **kwargs):  # noqa: E501
+        """ExternalPreferredLineItemV2 - a model defined in OpenAPI
 
         Args:
-            creative_format (str): The kind of creative this template can be used to build.
-            name (str): The name of the template
-            sku_collection_min (int): TODO: what is it ?
-            sku_per_collection_min (int): TODO: what is it ?
-            all_collections_mandatory (bool): TODO: what is it ?
-            created_at (datetime): The time at which the template was created
-            updated_at (datetime): The time at which the template was updated
-            sections ([Section]): The sections holding various template variables
+            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
+            target_retailer_id (str):
+            campaign_id (str):
+            created_at (datetime):
+            updated_at (datetime):
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -184,10 +201,13 @@ class Template(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            retailer_id (int): The retailer associated to the template. [optional]  # noqa: E501
-            sku_collection_max (int, none_type): TODO: what is it ?. [optional]  # noqa: E501
-            sku_per_collection_max (int, none_type): TODO: what is it ?. [optional]  # noqa: E501
-            displayable_skus_max (int, none_type): TODO: what is it ?. [optional]  # noqa: E501
+            pacing (str, none_type): [optional]  # noqa: E501
+            capping (ExternalLineItemCappingV2): [optional]  # noqa: E501
+            page (ExternalLineItemPageV2): [optional]  # noqa: E501
+            budget (float, none_type): [optional]  # noqa: E501
+            budget_spent (float, none_type): [optional]  # noqa: E501
+            budget_remaining (float, none_type): [optional]  # noqa: E501
+            creative_id (str, none_type): External creative Id. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -219,14 +239,14 @@ class Template(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.creative_format = creative_format
         self.name = name
-        self.sku_collection_min = sku_collection_min
-        self.sku_per_collection_min = sku_per_collection_min
-        self.all_collections_mandatory = all_collections_mandatory
+        self.start_date = start_date
+        self.end_date = end_date
+        self.status = status
+        self.target_retailer_id = target_retailer_id
+        self.campaign_id = campaign_id
         self.created_at = created_at
         self.updated_at = updated_at
-        self.sections = sections
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -247,18 +267,18 @@ class Template(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, creative_format, name, sku_collection_min, sku_per_collection_min, all_collections_mandatory, created_at, updated_at, sections, *args, **kwargs):  # noqa: E501
-        """Template - a model defined in OpenAPI
+    def __init__(self, name, start_date, end_date, status, target_retailer_id, campaign_id, created_at, updated_at, *args, **kwargs):  # noqa: E501
+        """ExternalPreferredLineItemV2 - a model defined in OpenAPI
 
         Args:
-            creative_format (str): The kind of creative this template can be used to build.
-            name (str): The name of the template
-            sku_collection_min (int): TODO: what is it ?
-            sku_per_collection_min (int): TODO: what is it ?
-            all_collections_mandatory (bool): TODO: what is it ?
-            created_at (datetime): The time at which the template was created
-            updated_at (datetime): The time at which the template was updated
-            sections ([Section]): The sections holding various template variables
+            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
+            target_retailer_id (str):
+            campaign_id (str):
+            created_at (datetime):
+            updated_at (datetime):
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -291,10 +311,13 @@ class Template(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            retailer_id (int): The retailer associated to the template. [optional]  # noqa: E501
-            sku_collection_max (int, none_type): TODO: what is it ?. [optional]  # noqa: E501
-            sku_per_collection_max (int, none_type): TODO: what is it ?. [optional]  # noqa: E501
-            displayable_skus_max (int, none_type): TODO: what is it ?. [optional]  # noqa: E501
+            pacing (str, none_type): [optional]  # noqa: E501
+            capping (ExternalLineItemCappingV2): [optional]  # noqa: E501
+            page (ExternalLineItemPageV2): [optional]  # noqa: E501
+            budget (float, none_type): [optional]  # noqa: E501
+            budget_spent (float, none_type): [optional]  # noqa: E501
+            budget_remaining (float, none_type): [optional]  # noqa: E501
+            creative_id (str, none_type): External creative Id. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -324,14 +347,14 @@ class Template(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.creative_format = creative_format
         self.name = name
-        self.sku_collection_min = sku_collection_min
-        self.sku_per_collection_min = sku_per_collection_min
-        self.all_collections_mandatory = all_collections_mandatory
+        self.start_date = start_date
+        self.end_date = end_date
+        self.status = status
+        self.target_retailer_id = target_retailer_id
+        self.campaign_id = campaign_id
         self.created_at = created_at
         self.updated_at = updated_at
-        self.sections = sections
         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/{template_variable_value.py → external_template_variable_value.py}

@@ -30,19 +30,21 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    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
-    globals()['ChoiceVariableValue'] = ChoiceVariableValue
-    globals()['ColorVariableValue'] = ColorVariableValue
-    globals()['FilesVariableValue'] = FilesVariableValue
-    globals()['HyperlinkVariableValue'] = HyperlinkVariableValue
-    globals()['TextVariableValue'] = TextVariableValue
-
-
-class TemplateVariableValue(ModelNormal):
+    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):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -96,11 +98,12 @@ class TemplateVariableValue(ModelNormal):
         lazy_import()
         return {
             'id': (str,),  # 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
+            '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
         }
 
     @cached_property
@@ -115,6 +118,7 @@ class TemplateVariableValue(ModelNormal):
         'color_variable_value': 'colorVariableValue',  # noqa: E501
         'files_variable_value': 'filesVariableValue',  # noqa: E501
         'hyperlink_variable_value': 'hyperlinkVariableValue',  # noqa: E501
+        'video_variable_value': 'videoVariableValue',  # noqa: E501
     }
 
     read_only_vars = {
@@ -125,7 +129,7 @@ class TemplateVariableValue(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, id, *args, **kwargs):  # noqa: E501
-        """TemplateVariableValue - a model defined in OpenAPI
+        """ExternalTemplateVariableValue - a model defined in OpenAPI
 
         Args:
             id (str): The id of the template variable the value is applied to
@@ -161,11 +165,12 @@ class TemplateVariableValue(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            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
+            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
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -219,7 +224,7 @@ class TemplateVariableValue(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, id, *args, **kwargs):  # noqa: E501
-        """TemplateVariableValue - a model defined in OpenAPI
+        """ExternalTemplateVariableValue - a model defined in OpenAPI
 
         Args:
             id (str): The id of the template variable the value is applied to
@@ -255,11 +260,12 @@ class TemplateVariableValue(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            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
+            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
         """
 
         _check_type = kwargs.pop('_check_type', True)

criteo_api_retailmedia_preview/model/{text_variable_value.py → external_text_variable_value.py}

@@ -30,7 +30,7 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 
-class TextVariableValue(ModelNormal):
+class ExternalTextVariableValue(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -81,7 +81,7 @@ class TextVariableValue(ModelNormal):
                 and the value is attribute type.
         """
         return {
-            'text': (str,),  # noqa: E501
+            'text': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -100,11 +100,8 @@ class TextVariableValue(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, text, *args, **kwargs):  # noqa: E501
-        """TextVariableValue - a model defined in OpenAPI
-
-        Args:
-            text (str): The displayed text
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """ExternalTextVariableValue - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -137,6 +134,7 @@ class TextVariableValue(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            text (str, none_type): The displayed text. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -168,7 +166,6 @@ class TextVariableValue(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.text = text
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -189,11 +186,8 @@ class TextVariableValue(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, text, *args, **kwargs):  # noqa: E501
-        """TextVariableValue - a model defined in OpenAPI
-
-        Args:
-            text (str): The displayed text
+    def __init__(self, *args, **kwargs):  # noqa: E501
+        """ExternalTextVariableValue - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -226,6 +220,7 @@ class TextVariableValue(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            text (str, none_type): The displayed text. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -255,7 +250,6 @@ class TextVariableValue(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.text = text
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \