ultracart-rest-sdk 4.0.142__py3-none-any.whl → 4.0.144__py3-none-any.whl

ultracart/__init__.py

@@ -11,7 +11,7 @@
 """
 
 
-__version__ = "4.0.142"
+__version__ = "4.0.144"
 
 # import ApiClient
 from ultracart.api_client import ApiClient

ultracart/api_client.py

@@ -77,7 +77,7 @@ class ApiClient(object):
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/4.0.142/python'
+        self.user_agent = 'OpenAPI-Generator/4.0.144/python'
 
     def __enter__(self):
         return self

ultracart/configuration.py

@@ -422,7 +422,7 @@ conf = ultracart.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 2.0.0\n"\
-               "SDK Package Version: 4.0.142".\
+               "SDK Package Version: 4.0.144".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

ultracart/model/experiment.py

@@ -60,6 +60,11 @@ class Experiment(ModelNormal):
     """
 
     allowed_values = {
+        ('openai_element_type',): {
+            'HEADLINE': "headline",
+            'TEXT': "text",
+            'TEXTBLOCK': "textblock",
+        },
         ('status',): {
             'RUNNING': "Running",
             'ENDED': "Ended",
@@ -103,7 +108,12 @@ class Experiment(ModelNormal):
             'notes': (str,),  # noqa: E501
             'objective': (str,),  # noqa: E501
             'objective_parameter': (str,),  # noqa: E501
+            'openai_current_iteration': (int,),  # noqa: E501
+            'openai_element_type': (str,),  # noqa: E501
+            'openai_model': (str,),  # noqa: E501
+            'openai_total_iterations': (int,),  # noqa: E501
             'optimization_type': (str,),  # noqa: E501
+            'p_value': (float,),  # noqa: E501
             'session_count': (int,),  # noqa: E501
             'start_dts': (str,),  # noqa: E501
             'status': (str,),  # noqa: E501
@@ -129,7 +139,12 @@ class Experiment(ModelNormal):
         'notes': 'notes',  # noqa: E501
         'objective': 'objective',  # noqa: E501
         'objective_parameter': 'objective_parameter',  # noqa: E501
+        'openai_current_iteration': 'openai_current_iteration',  # noqa: E501
+        'openai_element_type': 'openai_element_type',  # noqa: E501
+        'openai_model': 'openai_model',  # noqa: E501
+        'openai_total_iterations': 'openai_total_iterations',  # noqa: E501
         'optimization_type': 'optimization_type',  # noqa: E501
+        'p_value': 'p_value',  # noqa: E501
         'session_count': 'session_count',  # noqa: E501
         'start_dts': 'start_dts',  # noqa: E501
         'status': 'status',  # noqa: E501
@@ -190,7 +205,12 @@ class Experiment(ModelNormal):
             notes (str): Notes about the experiment. [optional]  # noqa: E501
             objective (str): Objective that is being optimized. [optional]  # noqa: E501
             objective_parameter (str): Objective parameter (such as event name) that is being optimized. [optional]  # noqa: E501
+            openai_current_iteration (int): The current iteration of the OpenAI related experiment. [optional]  # noqa: E501
+            openai_element_type (str): The type of OpenAI element being experimented on. [optional]  # noqa: E501
+            openai_model (str): The type of OpenAI model used. [optional]  # noqa: E501
+            openai_total_iterations (int): The total number of iterations to perform on the experiment. [optional]  # noqa: E501
             optimization_type (str): Type of optimization. [optional]  # noqa: E501
+            p_value (float): Statistics p-value for the experiment. [optional]  # noqa: E501
             session_count (int): Total number of sessions in the experiment. [optional]  # noqa: E501
             start_dts (str): Start date/time. [optional]  # noqa: E501
             status (str): Status of the experiment. [optional]  # noqa: E501
@@ -293,7 +313,12 @@ class Experiment(ModelNormal):
             notes (str): Notes about the experiment. [optional]  # noqa: E501
             objective (str): Objective that is being optimized. [optional]  # noqa: E501
             objective_parameter (str): Objective parameter (such as event name) that is being optimized. [optional]  # noqa: E501
+            openai_current_iteration (int): The current iteration of the OpenAI related experiment. [optional]  # noqa: E501
+            openai_element_type (str): The type of OpenAI element being experimented on. [optional]  # noqa: E501
+            openai_model (str): The type of OpenAI model used. [optional]  # noqa: E501
+            openai_total_iterations (int): The total number of iterations to perform on the experiment. [optional]  # noqa: E501
             optimization_type (str): Type of optimization. [optional]  # noqa: E501
+            p_value (float): Statistics p-value for the experiment. [optional]  # noqa: E501
             session_count (int): Total number of sessions in the experiment. [optional]  # noqa: E501
             start_dts (str): Start date/time. [optional]  # noqa: E501
             status (str): Status of the experiment. [optional]  # noqa: E501

ultracart/model/report_websocket_event.py

@@ -0,0 +1,278 @@
+"""
+    UltraCart Rest API V2
+
+    UltraCart REST API Version 2  # noqa: E501
+
+    The version of the OpenAPI document: 2.0.0
+    Contact: support@ultracart.com
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from ultracart.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 ultracart.exceptions import ApiAttributeError
+
+
+def lazy_import():
+    from ultracart.model.report_data_set import ReportDataSet
+    globals()['ReportDataSet'] = ReportDataSet
+
+
+class ReportWebsocketEvent(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 = {
+        ('event_type',): {
+            'PING': "ping",
+            'QUERY_COMPLETION': "query completion",
+        },
+    }
+
+    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 = 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.
+        """
+        lazy_import()
+        return {
+            'event_type': (str,),  # noqa: E501
+            'query_completion': (ReportDataSet,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'event_type': 'event_type',  # noqa: E501
+        'query_completion': 'query_completion',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """ReportWebsocketEvent - 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,)
+            event_type (str): Event type. [optional]  # noqa: E501
+            query_completion (ReportDataSet): [optional]  # noqa: E501
+        """
+
+        _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__,)
+
+        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, *args, **kwargs):  # noqa: E501
+        """ReportWebsocketEvent - 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,)
+            event_type (str): Event type. [optional]  # noqa: E501
+            query_completion (ReportDataSet): [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__,)
+
+        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.")

ultracart/models/__init__.py

@@ -653,6 +653,7 @@ from ultracart.model.report_page_visualization import ReportPageVisualization
 from ultracart.model.report_page_visualization_dimension import ReportPageVisualizationDimension
 from ultracart.model.report_page_visualization_metric import ReportPageVisualizationMetric
 from ultracart.model.report_response import ReportResponse
+from ultracart.model.report_websocket_event import ReportWebsocketEvent
 from ultracart.model.reports_response import ReportsResponse
 from ultracart.model.response_metadata import ResponseMetadata
 from ultracart.model.result_set import ResultSet

{ultracart_rest_sdk-4.0.142.dist-info → ultracart_rest_sdk-4.0.144.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ultracart-rest-sdk
-Version: 4.0.142
+Version: 4.0.144
 Summary: UltraCart Rest API V2
 Home-page: UNKNOWN
 Author: UltraCart Support

{ultracart_rest_sdk-4.0.142.dist-info → ultracart_rest_sdk-4.0.144.dist-info}/RECORD

@@ -1,6 +1,6 @@
-ultracart/__init__.py,sha256=gsZe1reAe3aCz21D23ipQrBz7XSO6uThbhDbrcnsFrY,699
-ultracart/api_client.py,sha256=OKuX_WzBS8ipYdWUW0X-zArpO6-l5VskpvGsHVcKqPg,39072
-ultracart/configuration.py,sha256=XW0W0-xNsSboM3kOJ0-lNCW-m8c_MCVKy5wD2D1HXX0,17842
+ultracart/__init__.py,sha256=CWmPtJTKVHxpSppBVkkTNyy6vMONG_lX8ZkRLPPciJo,699
+ultracart/api_client.py,sha256=EHB4XaCXHLCvz7YmSoxhkc9pWIpPbyN6zkCH3wft1As,39072
+ultracart/configuration.py,sha256=wXJa426g1pjw07iaZQYF2cq_V_mo7cq1ETL9iMQ0yh0,17842
 ultracart/exceptions.py,sha256=dwRtrWJsW4H_jKk3B1w2chykcQ7E2FSlhftUByD9e9E,5069
 ultracart/model_utils.py,sha256=X_RAfA-TlvDKBICnIve7PPVDM34Nl58aV1bqCrVmoTo,82574
 ultracart/rest.py,sha256=2lM6zwrjGp_SjkddamoKdpk3jFuc8Ow7fKIXRdKNp24,14268
@@ -432,7 +432,7 @@ ultracart/model/email_verify_token_validate_response.py,sha256=0zAGF_ktn7uf2UnyT
 ultracart/model/email_webhook_editor_values_response.py,sha256=cJxLlTI3t0svVGfBj0khqeDa5q1TQLY1x7fquXSyjmk,13258
 ultracart/model/error.py,sha256=JvZe3JKS65yFtuqeXf1mQDQfj6q74ZdH8m9Dob3ueS4,12757
 ultracart/model/error_response.py,sha256=XCD7htmB2tgc5Oc_YlJfeUPJQKoxNryHNjJXRxrk5iI,12455
-ultracart/model/experiment.py,sha256=pB0d95ol9uWexkRu55Hyx3rdTwj5jQnz8wSkToR7RBM,16598
+ultracart/model/experiment.py,sha256=AIPQHp6Z8B5IAhtwEW9A9_Z25JvBWsoGRUah2z85ryo,18442
 ultracart/model/experiment_response.py,sha256=JIIlKKOZrudqE4AqmQwtgpfkd84HipBuqGPDDZsmKVE,12794
 ultracart/model/experiment_variation.py,sha256=DoXLuHC9hSWid3ww30wyiWSjW0Tl-Pz1CZsdpsNZSdc,18996
 ultracart/model/experiment_variation_stat.py,sha256=r-mbFTwTNgc2EFxqL6zU_4-qAkt6IJs5Tp6-N_ETATQ,15007
@@ -671,6 +671,7 @@ ultracart/model/report_page_visualization.py,sha256=enrmsGx2SW-BVJ8J3IQGfI1DFV29
 ultracart/model/report_page_visualization_dimension.py,sha256=GzhG4aZki_nvJerNWhxaTJQhprRELRLxOnUHPSkTkrc,13307
 ultracart/model/report_page_visualization_metric.py,sha256=nmULuHOVSmLzVHiam5ygONsnvowC2SYBcncxZxpunUk,12445
 ultracart/model/report_response.py,sha256=d36SynDnxPH02yWtDlOIgZYM4RFKAmWl-8RdagpIbuM,12734
+ultracart/model/report_websocket_event.py,sha256=CLbIDLGtFZkETxhMhCvhJmkwmeRGWuvRnuDFeKenukQ,12022
 ultracart/model/reports_response.py,sha256=XQ54OPiUh2d7PVCoQCibW-8rgyJoGYlKJbWKu_zBW8M,12748
 ultracart/model/response_metadata.py,sha256=2bjaBqN1gQHEq-Gn19LCjDo3uNSmfeOlO5yJ69A8v-4,11847
 ultracart/model/result_set.py,sha256=TUbiU1FdLHe7lHeVMaZjzeqwgOiwb0NRSOLSMSqhwwI,13143
@@ -791,9 +792,9 @@ ultracart/model/webhook_sample_request.py,sha256=Qvt7FJPvECdYKv5MZztkSSmDxPDTSyt
 ultracart/model/webhook_sample_request_response.py,sha256=Ni-3WiNhVLt9a7yX_MNdD16NsRehVpJWiTdN_myLRk4,12956
 ultracart/model/webhooks_response.py,sha256=RVGQ76kc7X0XY5iJdLgnwVr5V50uCoYCGaRtc03FKc4,12763
 ultracart/model/weight.py,sha256=LTxs6KqiARegRkcShAviWKILAMAdw9KXwI-QgBtpoM0,11726
-ultracart/models/__init__.py,sha256=vHNL5tKhy8-2dmlum8XWYnItjraK2YfduYbPdr6rhKU,58113
-ultracart_rest_sdk-4.0.142.dist-info/LICENSE,sha256=4DukHX-rIHAHaf5BGLq1DYAMt0-ZA1OgXS9f_xwig2M,11558
-ultracart_rest_sdk-4.0.142.dist-info/METADATA,sha256=UqBDplXWjBcEqIB5i8k3XQrJZCm4SJWrIMlbLLxm6g8,403
-ultracart_rest_sdk-4.0.142.dist-info/WHEEL,sha256=OqRkF0eY5GHssMorFjlbTIq072vpHpF60fIQA6lS9xA,92
-ultracart_rest_sdk-4.0.142.dist-info/top_level.txt,sha256=90IoRqV6KX58jTyx9MwEBqh4j38_10hWrrvqsmXWZYo,10
-ultracart_rest_sdk-4.0.142.dist-info/RECORD,,
+ultracart/models/__init__.py,sha256=pVJjSpmZMnbR4ei4Gdk6VQ1StQqDa7y0p9rZuH4KrlY,58185
+ultracart_rest_sdk-4.0.144.dist-info/LICENSE,sha256=4DukHX-rIHAHaf5BGLq1DYAMt0-ZA1OgXS9f_xwig2M,11558
+ultracart_rest_sdk-4.0.144.dist-info/METADATA,sha256=qXDz0_WniQht7yCakF4ezavcH0KjoLbn_Es2Kub8F7M,403
+ultracart_rest_sdk-4.0.144.dist-info/WHEEL,sha256=OqRkF0eY5GHssMorFjlbTIq072vpHpF60fIQA6lS9xA,92
+ultracart_rest_sdk-4.0.144.dist-info/top_level.txt,sha256=90IoRqV6KX58jTyx9MwEBqh4j38_10hWrrvqsmXWZYo,10
+ultracart_rest_sdk-4.0.144.dist-info/RECORD,,