criteo-api-retailmedia-sdk 2024.7.0.240808__py3-none-any.whl → 2024.7.0.250129__py3-none-any.whl

criteo_api_retailmedia_v2024_07/model/{retail_media_seller.py → external_retail_media_seller.py}

@@ -30,7 +30,7 @@ from criteo_api_retailmedia_v2024_07.exceptions import ApiAttributeError
 
 
 
-class RetailMediaSeller(ModelNormal):
+class ExternalRetailMediaSeller(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -60,9 +60,15 @@ class RetailMediaSeller(ModelNormal):
     validations = {
     }
 
-    additional_properties_type = None
+    @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
+    _nullable = True
 
     @cached_property
     def openapi_types():
@@ -75,8 +81,8 @@ class RetailMediaSeller(ModelNormal):
                 and the value is attribute type.
         """
         return {
-            'seller_id': (str, none_type,),  # noqa: E501
-            'retailer_id': (int, none_type,),  # noqa: E501
+            'seller_id': (str,),  # noqa: E501
+            'retailer_id': (int,),  # noqa: E501
         }
 
     @cached_property
@@ -97,7 +103,7 @@ class RetailMediaSeller(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """RetailMediaSeller - a model defined in OpenAPI
+        """ExternalRetailMediaSeller - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -130,8 +136,8 @@ class RetailMediaSeller(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            seller_id (str, none_type): the seller id. [optional]  # noqa: E501
-            retailer_id (int, none_type): the retailer id. [optional]  # noqa: E501
+            seller_id (str): [optional]  # noqa: E501
+            retailer_id (int): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -184,7 +190,7 @@ class RetailMediaSeller(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """RetailMediaSeller - a model defined in OpenAPI
+        """ExternalRetailMediaSeller - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -217,8 +223,8 @@ class RetailMediaSeller(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            seller_id (str, none_type): the seller id. [optional]  # noqa: E501
-            retailer_id (int, none_type): the retailer id. [optional]  # noqa: E501
+            seller_id (str): [optional]  # noqa: E501
+            retailer_id (int): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

criteo_api_retailmedia_v2024_07/model/{retail_media_seller_account_creation.py → external_retail_media_seller_account_creation.py}

@@ -30,11 +30,11 @@ from criteo_api_retailmedia_v2024_07.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_v2024_07.model.retail_media_seller import RetailMediaSeller
-    globals()['RetailMediaSeller'] = RetailMediaSeller
+    from criteo_api_retailmedia_v2024_07.model.external_retail_media_seller import ExternalRetailMediaSeller
+    globals()['ExternalRetailMediaSeller'] = ExternalRetailMediaSeller
 
 
-class RetailMediaSellerAccountCreation(ModelNormal):
+class ExternalRetailMediaSellerAccountCreation(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -64,9 +64,16 @@ class RetailMediaSellerAccountCreation(ModelNormal):
     validations = {
     }
 
-    additional_properties_type = None
+    @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 = False
+    _nullable = True
 
     @cached_property
     def openapi_types():
@@ -82,7 +89,8 @@ class RetailMediaSellerAccountCreation(ModelNormal):
         return {
             'name': (str, none_type,),  # noqa: E501
             'company_name': (str, none_type,),  # noqa: E501
-            'sellers': ([RetailMediaSeller], none_type,),  # noqa: E501
+            'on_behalf_company_name': (str, none_type,),  # noqa: E501
+            'sellers': ([ExternalRetailMediaSeller],),  # noqa: E501
         }
 
     @cached_property
@@ -93,6 +101,7 @@ class RetailMediaSellerAccountCreation(ModelNormal):
     attribute_map = {
         'name': 'name',  # noqa: E501
         'company_name': 'companyName',  # noqa: E501
+        'on_behalf_company_name': 'onBehalfCompanyName',  # noqa: E501
         'sellers': 'sellers',  # noqa: E501
     }
 
@@ -104,7 +113,7 @@ class RetailMediaSellerAccountCreation(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """RetailMediaSellerAccountCreation - a model defined in OpenAPI
+        """ExternalRetailMediaSellerAccountCreation - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -137,9 +146,10 @@ class RetailMediaSellerAccountCreation(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            name (str, none_type): the name of the account, must be unique across all accounts. [optional]  # noqa: E501
-            company_name (str, none_type): Display name for reporting the owning entity of ads for the Digital Services Act in the European Union. [optional]  # noqa: E501
-            sellers ([RetailMediaSeller], none_type): list of sellers to associate to the new account. [optional]  # noqa: E501
+            name (str, none_type): [optional]  # noqa: E501
+            company_name (str, none_type): [optional]  # noqa: E501
+            on_behalf_company_name (str, none_type): [optional]  # noqa: E501
+            sellers ([ExternalRetailMediaSeller]): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -192,7 +202,7 @@ class RetailMediaSellerAccountCreation(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """RetailMediaSellerAccountCreation - a model defined in OpenAPI
+        """ExternalRetailMediaSellerAccountCreation - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -225,9 +235,10 @@ class RetailMediaSellerAccountCreation(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            name (str, none_type): the name of the account, must be unique across all accounts. [optional]  # noqa: E501
-            company_name (str, none_type): Display name for reporting the owning entity of ads for the Digital Services Act in the European Union. [optional]  # noqa: E501
-            sellers ([RetailMediaSeller], none_type): list of sellers to associate to the new account. [optional]  # noqa: E501
+            name (str, none_type): [optional]  # noqa: E501
+            company_name (str, none_type): [optional]  # noqa: E501
+            on_behalf_company_name (str, none_type): [optional]  # noqa: E501
+            sellers ([ExternalRetailMediaSeller]): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

criteo_api_retailmedia_v2024_07/model/files_variable_value.py

@@ -59,16 +59,11 @@ class FilesVariableValue(ModelNormal):
 
     validations = {
         ('asset_ids',): {
+            'min_items': 1,
         },
     }
 
-    @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
+    additional_properties_type = None
 
     _nullable = False
 

criteo_api_retailmedia_v2024_07/model/files_variables_specification.py

@@ -67,13 +67,7 @@ class FilesVariablesSpecification(ModelNormal):
     validations = {
     }
 
-    @cached_property
-    def additional_properties_type():
-        """
-        This must be a method because a model may have properties that are
-        of type self, this must run after the class is loaded
-        """
-        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+    additional_properties_type = None
 
     _nullable = False
 
@@ -89,8 +83,8 @@ class FilesVariablesSpecification(ModelNormal):
         """
         return {
             'extensions': ([str],),  # noqa: E501
-            'min_files': (int, none_type,),  # noqa: E501
             'max_bytes': (int, none_type,),  # noqa: E501
+            'min_files': (int, none_type,),  # noqa: E501
             'max_file': (int, none_type,),  # noqa: E501
         }
 
@@ -101,8 +95,8 @@ class FilesVariablesSpecification(ModelNormal):
 
     attribute_map = {
         'extensions': 'extensions',  # noqa: E501
-        'min_files': 'minFiles',  # noqa: E501
         'max_bytes': 'maxBytes',  # noqa: E501
+        'min_files': 'minFiles',  # noqa: E501
         'max_file': 'maxFile',  # noqa: E501
     }
 
@@ -113,12 +107,11 @@ class FilesVariablesSpecification(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, extensions, min_files, *args, **kwargs):  # noqa: E501
+    def _from_openapi_data(cls, extensions, *args, **kwargs):  # noqa: E501
         """FilesVariablesSpecification - a model defined in OpenAPI
 
         Args:
             extensions ([str]): The accepted file extensions
-            min_files (int, none_type): The minimum amount of files requires
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -152,6 +145,7 @@ class FilesVariablesSpecification(ModelNormal):
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             max_bytes (int, none_type): The maximum amount of bytes per file. [optional]  # noqa: E501
+            min_files (int, none_type): The minimum amount of files requires. [optional]  # noqa: E501
             max_file (int, none_type): The maximum amount of files required. [optional]  # noqa: E501
         """
 
@@ -185,7 +179,6 @@ class FilesVariablesSpecification(ModelNormal):
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
         self.extensions = extensions
-        self.min_files = min_files
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -206,12 +199,11 @@ class FilesVariablesSpecification(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, extensions, min_files, *args, **kwargs):  # noqa: E501
+    def __init__(self, extensions, *args, **kwargs):  # noqa: E501
         """FilesVariablesSpecification - a model defined in OpenAPI
 
         Args:
             extensions ([str]): The accepted file extensions
-            min_files (int, none_type): The minimum amount of files requires
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -245,6 +237,7 @@ class FilesVariablesSpecification(ModelNormal):
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             max_bytes (int, none_type): The maximum amount of bytes per file. [optional]  # noqa: E501
+            min_files (int, none_type): The minimum amount of files requires. [optional]  # noqa: E501
             max_file (int, none_type): The maximum amount of files required. [optional]  # noqa: E501
         """
 
@@ -276,7 +269,6 @@ class FilesVariablesSpecification(ModelNormal):
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
         self.extensions = extensions
-        self.min_files = min_files
         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_v2024_07/model/hyperlink_variable_value.py

@@ -60,15 +60,9 @@ class HyperlinkVariableValue(ModelNormal):
     validations = {
     }
 
-    @cached_property
-    def additional_properties_type():
-        """
-        This must be a method because a model may have properties that are
-        of type self, this must run after the class is loaded
-        """
-        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+    additional_properties_type = None
 
-    _nullable = False
+    _nullable = True
 
     @cached_property
     def openapi_types():
@@ -81,7 +75,7 @@ class HyperlinkVariableValue(ModelNormal):
                 and the value is attribute type.
         """
         return {
-            'url': (str,),  # noqa: E501
+            'url': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -100,12 +94,9 @@ class HyperlinkVariableValue(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, url, *args, **kwargs):  # noqa: E501
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
         """HyperlinkVariableValue - a model defined in OpenAPI
 
-        Args:
-            url (str): The url to redirect to
-
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
                                 will be type checked and a TypeError will be
@@ -137,6 +128,7 @@ class HyperlinkVariableValue(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            url (str, none_type): The url to redirect to. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -168,7 +160,6 @@ class HyperlinkVariableValue(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.url = url
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -189,12 +180,9 @@ class HyperlinkVariableValue(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, url, *args, **kwargs):  # noqa: E501
+    def __init__(self, *args, **kwargs):  # noqa: E501
         """HyperlinkVariableValue - a model defined in OpenAPI
 
-        Args:
-            url (str): The url to redirect to
-
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
                                 will be type checked and a TypeError will be
@@ -226,6 +214,7 @@ class HyperlinkVariableValue(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            url (str, none_type): The url to redirect to. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -255,7 +244,6 @@ class HyperlinkVariableValue(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.url = url
         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_v2024_07/model/{page_type_environment.py → page_type_environment202210.py}

@@ -30,7 +30,7 @@ from criteo_api_retailmedia_v2024_07.exceptions import ApiAttributeError
 
 
 
-class PageTypeEnvironment(ModelNormal):
+class PageTypeEnvironment202210(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -56,6 +56,7 @@ class PageTypeEnvironment(ModelNormal):
 
     allowed_values = {
         ('page_type',): {
+            'None': None,
             'SEARCH': "Search",
             'HOME': "Home",
             'BROWSE': "Browse",
@@ -67,6 +68,7 @@ class PageTypeEnvironment(ModelNormal):
             'DEALS': "Deals",
         },
         ('environments',): {
+            'None': None,
             'WEB': "Web",
             'MOBILE': "Mobile",
             'APP': "App",
@@ -80,13 +82,7 @@ class PageTypeEnvironment(ModelNormal):
     validations = {
     }
 
-    @cached_property
-    def additional_properties_type():
-        """
-        This must be a method because a model may have properties that are
-        of type self, this must run after the class is loaded
-        """
-        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+    additional_properties_type = None
 
     _nullable = False
 
@@ -101,8 +97,8 @@ class PageTypeEnvironment(ModelNormal):
                 and the value is attribute type.
         """
         return {
-            'page_type': (str,),  # noqa: E501
-            'environments': ([str],),  # noqa: E501
+            'page_type': (str, none_type,),  # noqa: E501
+            'environments': ([str], none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -123,7 +119,7 @@ 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
+        """PageTypeEnvironment202210 - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -156,8 +152,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
+            page_type (str, none_type): Creative PageType. [optional]  # noqa: E501
+            environments ([str], none_type): List of environments per PageType. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -210,7 +206,7 @@ class PageTypeEnvironment(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """PageTypeEnvironment - a model defined in OpenAPI
+        """PageTypeEnvironment202210 - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -243,8 +239,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
+            page_type (str, none_type): Creative PageType. [optional]  # noqa: E501
+            environments ([str], none_type): List of environments per PageType. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

criteo_api_retailmedia_v2024_07/model/resource_of_creative202110.py

@@ -64,16 +64,9 @@ class ResourceOfCreative202110(ModelNormal):
     validations = {
     }
 
-    @cached_property
-    def additional_properties_type():
-        """
-        This must be a method because a model may have properties that are
-        of type self, this must run after the class is loaded
-        """
-        lazy_import()
-        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+    additional_properties_type = None
 
-    _nullable = False
+    _nullable = True
 
     @cached_property
     def openapi_types():
@@ -87,9 +80,9 @@ class ResourceOfCreative202110(ModelNormal):
         """
         lazy_import()
         return {
+            'attributes': (Creative202110,),  # noqa: E501
             'id': (str, none_type,),  # noqa: E501
             'type': (str, none_type,),  # noqa: E501
-            'attributes': (Creative202110,),  # noqa: E501
         }
 
     @cached_property
@@ -98,9 +91,9 @@ class ResourceOfCreative202110(ModelNormal):
 
 
     attribute_map = {
+        'attributes': 'attributes',  # noqa: E501
         'id': 'id',  # noqa: E501
         'type': 'type',  # noqa: E501
-        'attributes': 'attributes',  # noqa: E501
     }
 
     read_only_vars = {
@@ -144,9 +137,9 @@ class ResourceOfCreative202110(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            attributes (Creative202110): [optional]  # noqa: E501
             id (str, none_type): Id of the entity. [optional]  # noqa: E501
             type (str, none_type): Canonical type name of the entity. [optional]  # noqa: E501
-            attributes (Creative202110): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -232,9 +225,9 @@ class ResourceOfCreative202110(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            attributes (Creative202110): [optional]  # noqa: E501
             id (str, none_type): Id of the entity. [optional]  # noqa: E501
             type (str, none_type): Canonical type name of the entity. [optional]  # noqa: E501
-            attributes (Creative202110): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

criteo_api_retailmedia_v2024_07/model/resource_of_creative202210.py

@@ -64,16 +64,9 @@ class ResourceOfCreative202210(ModelNormal):
     validations = {
     }
 
-    @cached_property
-    def additional_properties_type():
-        """
-        This must be a method because a model may have properties that are
-        of type self, this must run after the class is loaded
-        """
-        lazy_import()
-        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+    additional_properties_type = None
 
-    _nullable = False
+    _nullable = True
 
     @cached_property
     def openapi_types():

criteo_api_retailmedia_v2024_07/model/resource_of_template.py

@@ -64,16 +64,9 @@ class ResourceOfTemplate(ModelNormal):
     validations = {
     }
 
-    @cached_property
-    def additional_properties_type():
-        """
-        This must be a method because a model may have properties that are
-        of type self, this must run after the class is loaded
-        """
-        lazy_import()
-        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+    additional_properties_type = None
 
-    _nullable = False
+    _nullable = True
 
     @cached_property
     def openapi_types():

criteo_api_retailmedia_v2024_07/model/rm_legacy_audience_get_entity_v1_resource.py

@@ -152,8 +152,8 @@ class RmLegacyAudienceGetEntityV1Resource(ModelNormal):
                                 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
+            id (str, none_type): Unique identifier of this resource.. [optional]  # noqa: E501
+            audience_type (str, none_type): Type of the audience.. [optional]  # noqa: E501
             type (str, none_type): [optional]  # noqa: E501
         """
 
@@ -241,8 +241,8 @@ class RmLegacyAudienceGetEntityV1Resource(ModelNormal):
                                 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
+            id (str, none_type): Unique identifier of this resource.. [optional]  # noqa: E501
+            audience_type (str, none_type): Type of the audience.. [optional]  # noqa: E501
             type (str, none_type): [optional]  # noqa: E501
         """