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

criteo_api_retailmedia_preview/api/on_site_recommendation_api.py

@@ -0,0 +1,186 @@
+"""
+    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.api_client import ApiClient, Endpoint as _Endpoint
+from criteo_api_retailmedia_preview.model_utils import (  # noqa: F401
+    check_allowed_values,
+    check_validations,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_and_convert_types
+)
+from criteo_api_retailmedia_preview.model.http_validation_error import HttpValidationError
+from criteo_api_retailmedia_preview.model.inbot_discussion_body_model import InbotDiscussionBodyModel
+from criteo_api_retailmedia_preview.model.message_body_model import MessageBodyModel
+
+
+class OnSiteRecommendationApi(object):
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+        self.chatbot_product_recommendations_endpoint = _Endpoint(
+            settings={
+                'response_type': (MessageBodyModel,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/retail-media/chatbot-catalogs/{catalogid}/product-recommendations',
+                'operation_id': 'chatbot_product_recommendations',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'catalogid',
+                    'inbot_discussion_body_model',
+                ],
+                'required': [
+                    'catalogid',
+                    'inbot_discussion_body_model',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'catalogid':
+                        (int,),
+                    'inbot_discussion_body_model':
+                        (InbotDiscussionBodyModel,),
+                },
+                'attribute_map': {
+                    'catalogid': 'catalogid',
+                },
+                'location_map': {
+                    'catalogid': 'path',
+                    'inbot_discussion_body_model': 'body',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [
+                    'application/json'
+                ]
+            },
+            api_client=api_client
+        )
+
+    def chatbot_product_recommendations(
+        self,
+        catalogid,
+        inbot_discussion_body_model,
+        **kwargs
+    ):
+        """chatbot_product_recommendations  # noqa: E501
+
+        Ask a chatbot for a product recommendation  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.chatbot_product_recommendations(catalogid, inbot_discussion_body_model, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            catalogid (int): the identifier of the catalog to query
+            inbot_discussion_body_model (InbotDiscussionBodyModel):
+
+        Keyword Args:
+            _return_http_data_only (bool): response data without head status
+                code and headers. Default is True.
+            _preload_content (bool): if False, the urllib3.HTTPResponse object
+                will be returned without reading/decoding response data.
+                Default is True.
+            _request_timeout (int/float/tuple): timeout setting for this request. If
+                one number provided, it will be total request timeout. It can also
+                be a pair (tuple) of (connection, read) timeouts.
+                Default is None.
+            _check_input_type (bool): specifies if type checking
+                should be done one the data sent to the server.
+                Default is True.
+            _check_return_type (bool): specifies if type checking
+                should be done one the data received from the server.
+                Default is True.
+            _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)
+            _content_type (str/None): force body content-type.
+                Default is None and content-type will be predicted by allowed
+                content-types and body.
+            _host_index (int/None): specifies the index of the server
+                that we want to use.
+                Default is read from the configuration.
+            _request_auths (list): set to override the auth_settings for an a single
+                request; this effectively ignores the authentication
+                in the spec for a single request.
+                Default is None
+            async_req (bool): execute request asynchronously
+
+        Returns:
+            MessageBodyModel
+                If the method is called asynchronously, returns the request
+                thread.
+        """
+        kwargs['async_req'] = kwargs.get(
+            'async_req', False
+        )
+        kwargs['_return_http_data_only'] = kwargs.get(
+            '_return_http_data_only', True
+        )
+        kwargs['_preload_content'] = kwargs.get(
+            '_preload_content', True
+        )
+        kwargs['_request_timeout'] = kwargs.get(
+            '_request_timeout', None
+        )
+        kwargs['_check_input_type'] = kwargs.get(
+            '_check_input_type', True
+        )
+        kwargs['_check_return_type'] = kwargs.get(
+            '_check_return_type', True
+        )
+        kwargs['_spec_property_naming'] = kwargs.get(
+            '_spec_property_naming', False
+        )
+        kwargs['_content_type'] = kwargs.get(
+            '_content_type')
+        kwargs['_host_index'] = kwargs.get('_host_index')
+        kwargs['_request_auths'] = kwargs.get('_request_auths', None)
+        kwargs['catalogid'] = \
+            catalogid
+        kwargs['inbot_discussion_body_model'] = \
+            inbot_discussion_body_model
+        return self.chatbot_product_recommendations_endpoint.call_with_http_info(**kwargs)
+

criteo_api_retailmedia_preview/api_client.py

@@ -76,7 +76,7 @@ class ApiClient(object):
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/0.0.240731/python'
+        self.user_agent = 'OpenAPI-Generator/0.0.241029/python'
 
     def __enter__(self):
         return self
@@ -804,10 +804,10 @@ class Endpoint(object):
         Example:
 
         api_instance = AccountsApi()
-        api_instance.get_api_v1_external_accounts  # this is an instance of the class Endpoint
-        api_instance.get_api_v1_external_accounts()  # this invokes api_instance.get_api_v1_external_accounts.__call__()
+        api_instance.create_private_market_demand_seller_account  # this is an instance of the class Endpoint
+        api_instance.create_private_market_demand_seller_account()  # this invokes api_instance.create_private_market_demand_seller_account.__call__()
         which then invokes the callable functions stored in that endpoint at
-        api_instance.get_api_v1_external_accounts.callable or self.callable in this class
+        api_instance.create_private_market_demand_seller_account.callable or self.callable in this class
 
         """
         return self.callable(self, *args, **kwargs)

criteo_api_retailmedia_preview/apis/__init__.py

@@ -21,3 +21,4 @@ from criteo_api_retailmedia_preview.api.balance_api import BalanceApi
 from criteo_api_retailmedia_preview.api.campaign_api import CampaignApi
 from criteo_api_retailmedia_preview.api.catalog_api import CatalogApi
 from criteo_api_retailmedia_preview.api.gateway_api import GatewayApi
+from criteo_api_retailmedia_preview.api.on_site_recommendation_api import OnSiteRecommendationApi

criteo_api_retailmedia_preview/configuration.py

@@ -395,7 +395,7 @@ class Configuration(object):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: Preview\n"\
-               "SDK Package Version: 0.0.240731".\
+               "SDK Package Version: 0.0.241029".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

criteo_api_retailmedia_preview/model/balance_response_v2.py

@@ -66,10 +66,10 @@ class BalanceResponseV2(ModelNormal):
             'OFFSITEAWARENESS': "OffsiteAwareness",
         },
         ('private_market_billing_type',): {
-            'NOTAPPLICABLE': "notApplicable",
-            'BILLBYRETAILER': "billByRetailer",
-            'BILLBYCRITEO': "billByCriteo",
-            'UNKNOWN': "unknown",
+            'NOTAPPLICABLE': "NotApplicable",
+            'BILLBYRETAILER': "BillByRetailer",
+            'BILLBYCRITEO': "BillByCriteo",
+            'UNKNOWN': "Unknown",
         },
         ('status',): {
             'UNKNOWN': "unknown",
@@ -104,7 +104,7 @@ class BalanceResponseV2(ModelNormal):
         """
         return {
             'name': (str,),  # noqa: E501
-            'start_date': (str,),  # noqa: E501
+            'start_date': (date,),  # noqa: E501
             'balance_type': (str,),  # noqa: E501
             'spend_type': (str,),  # noqa: E501
             'private_market_billing_type': (str,),  # noqa: E501
@@ -113,7 +113,7 @@ class BalanceResponseV2(ModelNormal):
             'deposited': (float, none_type,),  # noqa: E501
             'spent': (float, none_type,),  # noqa: E501
             'remaining': (float, none_type,),  # noqa: E501
-            'end_date': (str, none_type,),  # noqa: E501
+            'end_date': (date, none_type,),  # noqa: E501
             'status': (str,),  # noqa: E501
             'created_at': (datetime,),  # noqa: E501
             'updated_at': (datetime,),  # noqa: E501
@@ -153,7 +153,7 @@ class BalanceResponseV2(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.
             balance_type (str): Type of the balance.
             spend_type (str): Spend Type of the balance.
             private_market_billing_type (str): Billing type for Private Market of the balance.
@@ -194,7 +194,7 @@ class BalanceResponseV2(ModelNormal):
             deposited (float, none_type): Amount of billable funds allotted to the balance.. [optional]  # noqa: E501
             spent (float, none_type): Amount of spent funds of the balance.. [optional]  # noqa: E501
             remaining (float, none_type): Amount of remaining funds of 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
             status (str): Status of the balance.. [optional]  # noqa: E501
             created_at (datetime): Creation time of the balance.. [optional]  # noqa: E501
             updated_at (datetime): Update time of the balance.. [optional]  # noqa: E501
@@ -259,7 +259,7 @@ class BalanceResponseV2(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.
             balance_type (str): Type of the balance.
             spend_type (str): Spend Type of the balance.
             private_market_billing_type (str): Billing type for Private Market of the balance.
@@ -300,7 +300,7 @@ class BalanceResponseV2(ModelNormal):
             deposited (float, none_type): Amount of billable funds allotted to the balance.. [optional]  # noqa: E501
             spent (float, none_type): Amount of spent funds of the balance.. [optional]  # noqa: E501
             remaining (float, none_type): Amount of remaining funds of 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
             status (str): Status of the balance.. [optional]  # noqa: E501
             created_at (datetime): Creation time of the balance.. [optional]  # noqa: E501
             updated_at (datetime): Update time of the balance.. [optional]  # noqa: E501

criteo_api_retailmedia_preview/model/bot_message.py

@@ -0,0 +1,277 @@
+"""
+    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.product_recommendation import ProductRecommendation
+    globals()['ProductRecommendation'] = ProductRecommendation
+
+
+class BotMessage(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
+        """
+        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 {
+            '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 = {
+    }
+
+    _composed_schemas = {}
+
+    @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', 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
+        """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__,)
+
+        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.")