criteo-api-retailmedia-sdk 0.0.240731__py3-none-any.whl → 0.0.241029__py3-none-any.whl

criteo_api_retailmedia_preview/model/botmessage.py

@@ -0,0 +1,329 @@
+"""
+    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
+
+
+def lazy_import():
+    from criteo_api_retailmedia_preview.model.bot_message import BotMessage
+    from criteo_api_retailmedia_preview.model.product_recommendation import ProductRecommendation
+    globals()['BotMessage'] = BotMessage
+    globals()['ProductRecommendation'] = ProductRecommendation
+
+
+class Botmessage(ModelComposed):
+    """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
+        """
+        lazy_import()
+        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+
+    _nullable = True
+
+    @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.
+        """
+        lazy_import()
+        return {
+            'opening': (str, none_type,),  # noqa: E501
+            'product_recos': ([ProductRecommendation], none_type,),  # noqa: E501
+            'closing': (str, none_type,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'opening': 'opening',  # noqa: E501
+        'product_recos': 'productRecos',  # noqa: E501
+        'closing': 'closing',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """Botmessage - a model defined in OpenAPI
+
+        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,)
+            opening (str, none_type): opening comment from the bot, introducing the list of recommended products if relevant.. [optional]  # noqa: E501
+            product_recos ([ProductRecommendation], none_type): list of recommended products. [optional]  # noqa: E501
+            closing (str, none_type): closing remark from the bot. [optional]  # noqa: E501
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        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__,)
+
+        constant_args = {
+            '_check_type': _check_type,
+            '_path_to_item': _path_to_item,
+            '_spec_property_naming': _spec_property_naming,
+            '_configuration': _configuration,
+            '_visited_composed_classes': self._visited_composed_classes,
+        }
+        composed_info = validate_get_composed_info(
+            constant_args, kwargs, self)
+        self._composed_instances = composed_info[0]
+        self._var_name_to_model_instances = composed_info[1]
+        self._additional_properties_model_instances = composed_info[2]
+        discarded_args = composed_info[3]
+
+        for var_name, var_value in kwargs.items():
+            if var_name in discarded_args and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self._additional_properties_model_instances:
+                # 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',
+        '_composed_instances',
+        '_var_name_to_model_instances',
+        '_additional_properties_model_instances',
+    ])
+
+    @convert_js_args_to_python_args
+    def __init__(self, *args, **kwargs):  # noqa: E501
+        """Botmessage - a model defined in OpenAPI
+
+        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,)
+            opening (str, none_type): opening comment from the bot, introducing the list of recommended products if relevant.. [optional]  # noqa: E501
+            product_recos ([ProductRecommendation], none_type): list of recommended products. [optional]  # noqa: E501
+            closing (str, none_type): closing remark from the bot. [optional]  # noqa: E501
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        constant_args = {
+            '_check_type': _check_type,
+            '_path_to_item': _path_to_item,
+            '_spec_property_naming': _spec_property_naming,
+            '_configuration': _configuration,
+            '_visited_composed_classes': self._visited_composed_classes,
+        }
+        composed_info = validate_get_composed_info(
+            constant_args, kwargs, self)
+        self._composed_instances = composed_info[0]
+        self._var_name_to_model_instances = composed_info[1]
+        self._additional_properties_model_instances = composed_info[2]
+        discarded_args = composed_info[3]
+
+        for var_name, var_value in kwargs.items():
+            if var_name in discarded_args and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self._additional_properties_model_instances:
+                # 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.")
+
+    @cached_property
+    def _composed_schemas():
+        # we need this here to make our import statements work
+        # we must store _composed_schemas in here so the code is only run
+        # when we invoke this method. If we kept this at the class
+        # level we would get an error because the class level
+        # code would be run when this module is imported, and these composed
+        # classes don't exist yet because their module has not finished
+        # loading
+        lazy_import()
+        return {
+          'anyOf': [
+          ],
+          'allOf': [
+              BotMessage,
+          ],
+          'oneOf': [
+          ],
+        }

criteo_api_retailmedia_preview/model/create_balance_v2.py

@@ -87,11 +87,11 @@ class CreateBalanceV2(ModelNormal):
         """
         return {
             'name': (str,),  # noqa: E501
-            'start_date': (str,),  # noqa: E501
+            'start_date': (date,),  # noqa: E501
             'spend_type': (str,),  # noqa: E501
             'po_number': (str, none_type,),  # noqa: E501
             'deposited': (float, none_type,),  # noqa: E501
-            'end_date': (str, none_type,),  # noqa: E501
+            'end_date': (date, none_type,),  # noqa: E501
             'memo': (str, none_type,),  # noqa: E501
         }
 
@@ -122,7 +122,7 @@ class CreateBalanceV2(ModelNormal):
 
         Args:
             name (str): Name of the balance.
-            start_date (str): Start date of the balance in the format YYYY-MM-DD.
+            start_date (date): Start date of the balance in the format YYYY-MM-DD.
             spend_type (str): Type of the balance spend.
 
         Keyword Args:
@@ -158,7 +158,7 @@ class CreateBalanceV2(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             po_number (str, none_type): Purchase Order number.. [optional]  # noqa: E501
             deposited (float, none_type): Amount of billable funds allotted to the balance.. [optional]  # noqa: E501
-            end_date (str, none_type): End date of the balance in the format YYYY-MM-DD.. [optional]  # noqa: E501
+            end_date (date, none_type): End date of the balance in the format YYYY-MM-DD.. [optional]  # noqa: E501
             memo (str, none_type): Memo. [optional]  # noqa: E501
         """
 
@@ -219,7 +219,7 @@ class CreateBalanceV2(ModelNormal):
 
         Args:
             name (str): Name of the balance.
-            start_date (str): Start date of the balance in the format YYYY-MM-DD.
+            start_date (date): Start date of the balance in the format YYYY-MM-DD.
             spend_type (str): Type of the balance spend.
 
         Keyword Args:
@@ -255,7 +255,7 @@ class CreateBalanceV2(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             po_number (str, none_type): Purchase Order number.. [optional]  # noqa: E501
             deposited (float, none_type): Amount of billable funds allotted to the balance.. [optional]  # noqa: E501
-            end_date (str, none_type): End date of the balance in the format YYYY-MM-DD.. [optional]  # noqa: E501
+            end_date (date, none_type): End date of the balance in the format YYYY-MM-DD.. [optional]  # noqa: E501
             memo (str, none_type): Memo. [optional]  # noqa: E501
         """
 

criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v2_list_response.py → entity_resource_collection_outcome_of_retail_media_account.py}

@@ -31,12 +31,12 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 def lazy_import():
     from criteo_api_retailmedia_preview.model.common_problem import CommonProblem
-    from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v2_resource import RmLegacyAudienceGetEntityV2Resource
+    from criteo_api_retailmedia_preview.model.entity_resource_of_retail_media_account import EntityResourceOfRetailMediaAccount
     globals()['CommonProblem'] = CommonProblem
-    globals()['RmLegacyAudienceGetEntityV2Resource'] = RmLegacyAudienceGetEntityV2Resource
+    globals()['EntityResourceOfRetailMediaAccount'] = EntityResourceOfRetailMediaAccount
 
 
-class RmLegacyAudienceGetEntityV2ListResponse(ModelNormal):
+class EntityResourceCollectionOutcomeOfRetailMediaAccount(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -89,7 +89,7 @@ class RmLegacyAudienceGetEntityV2ListResponse(ModelNormal):
         """
         lazy_import()
         return {
-            'data': ([RmLegacyAudienceGetEntityV2Resource], none_type,),  # noqa: E501
+            'data': ([EntityResourceOfRetailMediaAccount], none_type,),  # noqa: E501
             'warnings': ([CommonProblem], none_type,),  # noqa: E501
             'errors': ([CommonProblem], none_type,),  # noqa: E501
         }
@@ -115,7 +115,7 @@ class RmLegacyAudienceGetEntityV2ListResponse(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """RmLegacyAudienceGetEntityV2ListResponse - a model defined in OpenAPI
+        """EntityResourceCollectionOutcomeOfRetailMediaAccount - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -148,7 +148,7 @@ class RmLegacyAudienceGetEntityV2ListResponse(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            data ([RmLegacyAudienceGetEntityV2Resource], none_type): [optional]  # noqa: E501
+            data ([EntityResourceOfRetailMediaAccount], none_type): [optional]  # noqa: E501
             warnings ([CommonProblem], none_type): [optional]  # noqa: E501
             errors ([CommonProblem], none_type): [optional]  # noqa: E501
         """
@@ -203,7 +203,7 @@ class RmLegacyAudienceGetEntityV2ListResponse(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """RmLegacyAudienceGetEntityV2ListResponse - a model defined in OpenAPI
+        """EntityResourceCollectionOutcomeOfRetailMediaAccount - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -236,7 +236,7 @@ class RmLegacyAudienceGetEntityV2ListResponse(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            data ([RmLegacyAudienceGetEntityV2Resource], none_type): [optional]  # noqa: E501
+            data ([EntityResourceOfRetailMediaAccount], none_type): [optional]  # noqa: E501
             warnings ([CommonProblem], none_type): [optional]  # noqa: E501
             errors ([CommonProblem], none_type): [optional]  # noqa: E501
         """

criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v1_resource.py → entity_resource_of_retail_media_account.py}

@@ -30,11 +30,11 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v1 import RmLegacyAudienceGetEntityV1
-    globals()['RmLegacyAudienceGetEntityV1'] = RmLegacyAudienceGetEntityV1
+    from criteo_api_retailmedia_preview.model.external_retail_media_account import ExternalRetailMediaAccount
+    globals()['ExternalRetailMediaAccount'] = ExternalRetailMediaAccount
 
 
-class RmLegacyAudienceGetEntityV1Resource(ModelNormal):
+class EntityResourceOfRetailMediaAccount(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -59,11 +59,6 @@ class RmLegacyAudienceGetEntityV1Resource(ModelNormal):
     """
 
     allowed_values = {
-        ('audience_type',): {
-            'None': None,
-            'CUSTOMERLIST': "customerList",
-            'USERBEHAVIOR': "userBehavior",
-        },
     }
 
     validations = {
@@ -92,10 +87,9 @@ class RmLegacyAudienceGetEntityV1Resource(ModelNormal):
         """
         lazy_import()
         return {
-            'attributes': (RmLegacyAudienceGetEntityV1,),  # noqa: E501
             'id': (str, none_type,),  # noqa: E501
-            'audience_type': (str, none_type,),  # noqa: E501
             'type': (str, none_type,),  # noqa: E501
+            'attributes': (ExternalRetailMediaAccount,),  # noqa: E501
         }
 
     @cached_property
@@ -104,10 +98,9 @@ class RmLegacyAudienceGetEntityV1Resource(ModelNormal):
 
 
     attribute_map = {
-        'attributes': 'attributes',  # noqa: E501
         'id': 'id',  # noqa: E501
-        'audience_type': 'audienceType',  # noqa: E501
         'type': 'type',  # noqa: E501
+        'attributes': 'attributes',  # noqa: E501
     }
 
     read_only_vars = {
@@ -118,7 +111,7 @@ class RmLegacyAudienceGetEntityV1Resource(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """RmLegacyAudienceGetEntityV1Resource - a model defined in OpenAPI
+        """EntityResourceOfRetailMediaAccount - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -151,10 +144,9 @@ class RmLegacyAudienceGetEntityV1Resource(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            attributes (RmLegacyAudienceGetEntityV1): [optional]  # noqa: E501
             id (str, none_type): [optional]  # noqa: E501
-            audience_type (str, none_type): [optional]  # noqa: E501
             type (str, none_type): [optional]  # noqa: E501
+            attributes (ExternalRetailMediaAccount): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -207,7 +199,7 @@ class RmLegacyAudienceGetEntityV1Resource(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """RmLegacyAudienceGetEntityV1Resource - a model defined in OpenAPI
+        """EntityResourceOfRetailMediaAccount - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -240,10 +232,9 @@ class RmLegacyAudienceGetEntityV1Resource(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            attributes (RmLegacyAudienceGetEntityV1): [optional]  # noqa: E501
             id (str, none_type): [optional]  # noqa: E501
-            audience_type (str, none_type): [optional]  # noqa: E501
             type (str, none_type): [optional]  # noqa: E501
+            attributes (ExternalRetailMediaAccount): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

criteo_api_retailmedia_preview/model/external_account.py

@@ -108,6 +108,7 @@ class ExternalAccount(ModelNormal):
             'time_zone': (str,),  # noqa: E501
             'subtype': (str, none_type,),  # noqa: E501
             'company_name': (str, none_type,),  # noqa: E501
+            'on_behalf_company_name': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -124,6 +125,7 @@ class ExternalAccount(ModelNormal):
         'time_zone': 'timeZone',  # noqa: E501
         'subtype': 'subtype',  # noqa: E501
         'company_name': 'companyName',  # noqa: E501
+        'on_behalf_company_name': 'onBehalfCompanyName',  # noqa: E501
     }
 
     read_only_vars = {
@@ -177,6 +179,7 @@ class ExternalAccount(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             subtype (str, none_type): [optional]  # noqa: E501
             company_name (str, none_type): [optional]  # noqa: E501
+            on_behalf_company_name (str, none_type): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -278,6 +281,7 @@ class ExternalAccount(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             subtype (str, none_type): [optional]  # noqa: E501
             company_name (str, none_type): [optional]  # noqa: E501
+            on_behalf_company_name (str, none_type): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)