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

criteo_api_retailmedia_preview/model/{template_variable.py → product_importer_error.py}

@@ -29,16 +29,8 @@ 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.choice_variable_specification import ChoiceVariableSpecification
-    from criteo_api_retailmedia_preview.model.files_variables_specification import FilesVariablesSpecification
-    from criteo_api_retailmedia_preview.model.text_variable_specification import TextVariableSpecification
-    globals()['ChoiceVariableSpecification'] = ChoiceVariableSpecification
-    globals()['FilesVariablesSpecification'] = FilesVariablesSpecification
-    globals()['TextVariableSpecification'] = TextVariableSpecification
 
-
-class TemplateVariable(ModelNormal):
+class ProductImporterError(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -63,13 +55,6 @@ class TemplateVariable(ModelNormal):
     """
 
     allowed_values = {
-        ('type',): {
-            'TEXT': "Text",
-            'CHOICE': "Choice",
-            'COLOR': "Color",
-            'FILES': "Files",
-            'HYPERLINK': "Hyperlink",
-        },
     }
 
     validations = {
@@ -81,7 +66,6 @@ class TemplateVariable(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
@@ -96,14 +80,13 @@ class TemplateVariable(ModelNormal):
             openapi_types (dict): The key is attribute name
                 and the value is attribute type.
         """
-        lazy_import()
         return {
-            'id': (str,),  # noqa: E501
-            'required': (bool,),  # noqa: E501
+            'trace_id': (str,),  # noqa: E501
             'type': (str,),  # noqa: E501
-            'choice_variable_specification': (ChoiceVariableSpecification,),  # noqa: E501
-            'text_variable_specification': (TextVariableSpecification,),  # noqa: E501
-            'files_variables_specification': (FilesVariablesSpecification,),  # noqa: E501
+            'code': (str,),  # noqa: E501
+            'instance': (str,),  # noqa: E501
+            'title': (str,),  # noqa: E501
+            'detail': (str,),  # noqa: E501
         }
 
     @cached_property
@@ -112,12 +95,12 @@ class TemplateVariable(ModelNormal):
 
 
     attribute_map = {
-        'id': 'id',  # noqa: E501
-        'required': 'required',  # noqa: E501
+        'trace_id': 'traceId',  # noqa: E501
         'type': 'type',  # noqa: E501
-        'choice_variable_specification': 'choiceVariableSpecification',  # noqa: E501
-        'text_variable_specification': 'textVariableSpecification',  # noqa: E501
-        'files_variables_specification': 'filesVariablesSpecification',  # noqa: E501
+        'code': 'code',  # noqa: E501
+        'instance': 'instance',  # noqa: E501
+        'title': 'title',  # noqa: E501
+        'detail': 'detail',  # noqa: E501
     }
 
     read_only_vars = {
@@ -127,13 +110,16 @@ class TemplateVariable(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, id, required, type, *args, **kwargs):  # noqa: E501
-        """TemplateVariable - a model defined in OpenAPI
+    def _from_openapi_data(cls, trace_id, type, code, instance, title, detail, *args, **kwargs):  # noqa: E501
+        """ProductImporterError - a model defined in OpenAPI
 
         Args:
-            id (str): The id of the variable
-            required (bool): Whether the variable is required
-            type (str): The type of the variable
+            trace_id (str): The MACHINE-READABLE correlation ID provided by the gateway
+            type (str): A MACHINE-READABLE code specifying error category. This information is used on client side to focus on certain type of error, to either retry some processing or display only certain type of errors.
+            code (str): A MACHINE-READABLE error code string in kebab-case. Unique across Criteo
+            instance (str): A MACHINE-READABLE URI reference that identifies the specific occurrence of the problem. This could be useful when we want to the return the API Endpoint identifying the exact resource related to the error.
+            title (str): A short, HUMAN-READABLE summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+            detail (str): A HUMAN-READABLE detailed explanation specific to this occurrence of the problem. This should not be more that 1 paragraph
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -166,9 +152,6 @@ class TemplateVariable(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            choice_variable_specification (ChoiceVariableSpecification): [optional]  # noqa: E501
-            text_variable_specification (TextVariableSpecification): [optional]  # noqa: E501
-            files_variables_specification (FilesVariablesSpecification): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -200,9 +183,12 @@ class TemplateVariable(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.id = id
-        self.required = required
+        self.trace_id = trace_id
         self.type = type
+        self.code = code
+        self.instance = instance
+        self.title = title
+        self.detail = detail
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -223,13 +209,16 @@ class TemplateVariable(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, id, required, type, *args, **kwargs):  # noqa: E501
-        """TemplateVariable - a model defined in OpenAPI
+    def __init__(self, trace_id, type, code, instance, title, detail, *args, **kwargs):  # noqa: E501
+        """ProductImporterError - a model defined in OpenAPI
 
         Args:
-            id (str): The id of the variable
-            required (bool): Whether the variable is required
-            type (str): The type of the variable
+            trace_id (str): The MACHINE-READABLE correlation ID provided by the gateway
+            type (str): A MACHINE-READABLE code specifying error category. This information is used on client side to focus on certain type of error, to either retry some processing or display only certain type of errors.
+            code (str): A MACHINE-READABLE error code string in kebab-case. Unique across Criteo
+            instance (str): A MACHINE-READABLE URI reference that identifies the specific occurrence of the problem. This could be useful when we want to the return the API Endpoint identifying the exact resource related to the error.
+            title (str): A short, HUMAN-READABLE summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+            detail (str): A HUMAN-READABLE detailed explanation specific to this occurrence of the problem. This should not be more that 1 paragraph
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -262,9 +251,6 @@ class TemplateVariable(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            choice_variable_specification (ChoiceVariableSpecification): [optional]  # noqa: E501
-            text_variable_specification (TextVariableSpecification): [optional]  # noqa: E501
-            files_variables_specification (FilesVariablesSpecification): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -294,9 +280,12 @@ class TemplateVariable(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
-        self.id = id
-        self.required = required
+        self.trace_id = trace_id
         self.type = type
+        self.code = code
+        self.instance = instance
+        self.title = title
+        self.detail = detail
         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/product_importer_warning.py

@@ -0,0 +1,299 @@
+"""
+    Criteo API
+
+    Criteo API - RetailMedia  # noqa: E501
+
+    The version of the OpenAPI document: Preview
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from criteo_api_retailmedia_preview.model_utils import (  # noqa: F401
+    ApiTypeError,
+    ModelComposed,
+    ModelNormal,
+    ModelSimple,
+    cached_property,
+    change_keys_js_to_python,
+    convert_js_args_to_python_args,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_get_composed_info,
+    OpenApiModel
+)
+from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
+
+
+
+class ProductImporterWarning(ModelNormal):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+
+    Attributes:
+      allowed_values (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          with a capitalized key describing the allowed value and an allowed
+          value. These dicts store the allowed enum values.
+      attribute_map (dict): The key is attribute name
+          and the value is json key in definition.
+      discriminator_value_class_map (dict): A dict to go from the discriminator
+          variable value to the discriminator class name.
+      validations (dict): The key is the tuple path to the attribute
+          and the for var_name this is (var_name,). The value is a dict
+          that stores validations for max_length, min_length, max_items,
+          min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
+          inclusive_minimum, and regex.
+      additional_properties_type (tuple): A tuple of classes accepted
+          as additional properties values.
+    """
+
+    allowed_values = {
+    }
+
+    validations = {
+    }
+
+    @cached_property
+    def additional_properties_type():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+        """
+        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+
+    _nullable = False
+
+    @cached_property
+    def openapi_types():
+        """
+        This must be a method because a model may have properties that are
+        of type self, this must run after the class is loaded
+
+        Returns
+            openapi_types (dict): The key is attribute name
+                and the value is attribute type.
+        """
+        return {
+            'trace_id': (str,),  # noqa: E501
+            'type': (str,),  # noqa: E501
+            'code': (str,),  # noqa: E501
+            'instance': (str,),  # noqa: E501
+            'title': (str,),  # noqa: E501
+            'detail': (str,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'trace_id': 'traceId',  # noqa: E501
+        'type': 'type',  # noqa: E501
+        'code': 'code',  # noqa: E501
+        'instance': 'instance',  # noqa: E501
+        'title': 'title',  # noqa: E501
+        'detail': 'detail',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, trace_id, type, code, instance, title, detail, *args, **kwargs):  # noqa: E501
+        """ProductImporterWarning - a model defined in OpenAPI
+
+        Args:
+            trace_id (str): The MACHINE-READABLE correlation ID provided by the gateway
+            type (str): A MACHINE-READABLE code specifying error category. This information is used on client side to focus on certain type of error, to either retry some processing or display only certain type of errors.
+            code (str): A MACHINE-READABLE error code string in kebab-case. Unique across Criteo
+            instance (str): A MACHINE-READABLE URI reference that identifies the specific occurrence of the problem. This could be useful when we want to the return the API Endpoint identifying the exact resource related to the error.
+            title (str): A short, HUMAN-READABLE summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+            detail (str): A HUMAN-READABLE detailed explanation specific to this occurrence of the problem. This should not be more that 1 paragraph
+
+        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,)
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', True)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        self = super(OpenApiModel, cls).__new__(cls)
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        self.trace_id = trace_id
+        self.type = type
+        self.code = code
+        self.instance = instance
+        self.title = title
+        self.detail = detail
+        for var_name, var_value in kwargs.items():
+            if var_name not in self.attribute_map and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self.additional_properties_type is None:
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)
+        return self
+
+    required_properties = set([
+        '_data_store',
+        '_check_type',
+        '_spec_property_naming',
+        '_path_to_item',
+        '_configuration',
+        '_visited_composed_classes',
+    ])
+
+    @convert_js_args_to_python_args
+    def __init__(self, trace_id, type, code, instance, title, detail, *args, **kwargs):  # noqa: E501
+        """ProductImporterWarning - a model defined in OpenAPI
+
+        Args:
+            trace_id (str): The MACHINE-READABLE correlation ID provided by the gateway
+            type (str): A MACHINE-READABLE code specifying error category. This information is used on client side to focus on certain type of error, to either retry some processing or display only certain type of errors.
+            code (str): A MACHINE-READABLE error code string in kebab-case. Unique across Criteo
+            instance (str): A MACHINE-READABLE URI reference that identifies the specific occurrence of the problem. This could be useful when we want to the return the API Endpoint identifying the exact resource related to the error.
+            title (str): A short, HUMAN-READABLE summary of the problem type. It should not change from occurrence to occurrence of the problem, except for purposes of localization.
+            detail (str): A HUMAN-READABLE detailed explanation specific to this occurrence of the problem. This should not be more that 1 paragraph
+
+        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,)
+        """
+
+        _check_type = kwargs.pop('_check_type', True)
+        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
+        _path_to_item = kwargs.pop('_path_to_item', ())
+        _configuration = kwargs.pop('_configuration', None)
+        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+
+        if args:
+            for arg in args:
+                if isinstance(arg, dict):
+                    kwargs.update(arg)
+                else:
+                    raise ApiTypeError(
+                        "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                            args,
+                            self.__class__.__name__,
+                        ),
+                        path_to_item=_path_to_item,
+                        valid_classes=(self.__class__,),
+                    )
+
+        self._data_store = {}
+        self._check_type = _check_type
+        self._spec_property_naming = _spec_property_naming
+        self._path_to_item = _path_to_item
+        self._configuration = _configuration
+        self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
+
+        self.trace_id = trace_id
+        self.type = type
+        self.code = code
+        self.instance = instance
+        self.title = title
+        self.detail = detail
+        for var_name, var_value in kwargs.items():
+            if var_name not in self.attribute_map and \
+                        self._configuration is not None and \
+                        self._configuration.discard_unknown_keys and \
+                        self.additional_properties_type is None:
+                # discard variable.
+                continue
+            setattr(self, var_name, var_value)
+            if var_name in self.read_only_vars:
+                raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+                                     f"class with read only attributes.")

criteo_api_retailmedia_preview/model/{template_list_response.py → product_shipping.py}

@@ -30,13 +30,11 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_preview.model.problem_details import ProblemDetails
-    from criteo_api_retailmedia_preview.model.resource_of_template import ResourceOfTemplate
-    globals()['ProblemDetails'] = ProblemDetails
-    globals()['ResourceOfTemplate'] = ResourceOfTemplate
+    from criteo_api_retailmedia_preview.model.price import Price
+    globals()['Price'] = Price
 
 
-class TemplateListResponse(ModelNormal):
+class ProductShipping(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -89,9 +87,13 @@ class TemplateListResponse(ModelNormal):
         """
         lazy_import()
         return {
-            'data': ([ResourceOfTemplate],),  # noqa: E501
-            'warnings': ([ProblemDetails],),  # noqa: E501
-            'errors': ([ProblemDetails],),  # noqa: E501
+            'price': (Price,),  # noqa: E501
+            'country': (str, none_type,),  # noqa: E501
+            'region': (str, none_type,),  # noqa: E501
+            'service': (str, none_type,),  # noqa: E501
+            'location_id': (int, none_type,),  # noqa: E501
+            'location_group_name': (str, none_type,),  # noqa: E501
+            'postal_code': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -100,14 +102,16 @@ class TemplateListResponse(ModelNormal):
 
 
     attribute_map = {
-        'data': 'data',  # noqa: E501
-        'warnings': 'warnings',  # noqa: E501
-        'errors': 'errors',  # noqa: E501
+        'price': 'price',  # noqa: E501
+        'country': 'country',  # noqa: E501
+        'region': 'region',  # noqa: E501
+        'service': 'service',  # noqa: E501
+        'location_id': 'locationId',  # noqa: E501
+        'location_group_name': 'locationGroupName',  # noqa: E501
+        'postal_code': 'postalCode',  # noqa: E501
     }
 
     read_only_vars = {
-        'warnings',  # noqa: E501
-        'errors',  # noqa: E501
     }
 
     _composed_schemas = {}
@@ -115,7 +119,7 @@ class TemplateListResponse(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """TemplateListResponse - a model defined in OpenAPI
+        """ProductShipping - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -148,9 +152,13 @@ class TemplateListResponse(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            data ([ResourceOfTemplate]): [optional]  # noqa: E501
-            warnings ([ProblemDetails]): [optional]  # noqa: E501
-            errors ([ProblemDetails]): [optional]  # noqa: E501
+            price (Price): [optional]  # noqa: E501
+            country (str, none_type): The CLDR territory code of the country to which an item will ship.. [optional]  # noqa: E501
+            region (str, none_type): The geographic region to which a shipping rate applies.. [optional]  # noqa: E501
+            service (str, none_type): A free-form description of the service class or delivery speed.. [optional]  # noqa: E501
+            location_id (int, none_type): The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.. [optional]  # noqa: E501
+            location_group_name (str, none_type): The location where the shipping is applicable, represented by a location group name.. [optional]  # noqa: E501
+            postal_code (str, none_type): The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -203,7 +211,7 @@ class TemplateListResponse(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """TemplateListResponse - a model defined in OpenAPI
+        """ProductShipping - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -236,9 +244,13 @@ class TemplateListResponse(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            data ([ResourceOfTemplate]): [optional]  # noqa: E501
-            warnings ([ProblemDetails]): [optional]  # noqa: E501
-            errors ([ProblemDetails]): [optional]  # noqa: E501
+            price (Price): [optional]  # noqa: E501
+            country (str, none_type): The CLDR territory code of the country to which an item will ship.. [optional]  # noqa: E501
+            region (str, none_type): The geographic region to which a shipping rate applies.. [optional]  # noqa: E501
+            service (str, none_type): A free-form description of the service class or delivery speed.. [optional]  # noqa: E501
+            location_id (int, none_type): The numeric ID of a location that the shipping rate applies to as defined in the AdWords API.. [optional]  # noqa: E501
+            location_group_name (str, none_type): The location where the shipping is applicable, represented by a location group name.. [optional]  # noqa: E501
+            postal_code (str, none_type): The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)