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

criteo_api_retailmedia_preview/api/audience_api.py

@@ -21,9 +21,8 @@ from criteo_api_retailmedia_preview.model_utils import (  # noqa: F401
     none_type,
     validate_and_convert_types
 )
-from criteo_api_retailmedia_preview.model.common_status_code_response import CommonStatusCodeResponse
-from criteo_api_retailmedia_preview.model.get_page_of_audiences_by_account_id_response import GetPageOfAudiencesByAccountIdResponse
-from criteo_api_retailmedia_preview.model.retail_media_audience_v2_list_response import RetailMediaAudienceV2ListResponse
+from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v1_list_response import RmLegacyAudienceGetEntityV1ListResponse
+from criteo_api_retailmedia_preview.model.rm_legacy_audience_get_entity_v2_list_response import RmLegacyAudienceGetEntityV2ListResponse
 
 
 class AudienceApi(object):
@@ -37,15 +36,15 @@ class AudienceApi(object):
         if api_client is None:
             api_client = ApiClient()
         self.api_client = api_client
-        self.get_audiences_by_account_id_endpoint = _Endpoint(
+        self.legacy_get_audience_v1_endpoint = _Endpoint(
             settings={
-                'response_type': (GetPageOfAudiencesByAccountIdResponse,),
+                'response_type': (RmLegacyAudienceGetEntityV1ListResponse,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
                 'endpoint_path': '/preview/retail-media/accounts/{accountId}/audiences',
-                'operation_id': 'get_audiences_by_account_id',
+                'operation_id': 'legacy_get_audience_v1',
                 'http_method': 'GET',
                 'servers': None,
             },
@@ -73,9 +72,9 @@ class AudienceApi(object):
                 },
                 'openapi_types': {
                     'account_id':
-                        (str,),
+                        (int,),
                     'limit_to_id':
-                        ([str],),
+                        ([int],),
                     'page_size':
                         (int,),
                     'page_index':
@@ -99,21 +98,23 @@ class AudienceApi(object):
             },
             headers_map={
                 'accept': [
-                    'application/json'
+                    'text/plain',
+                    'application/json',
+                    'text/json'
                 ],
                 'content_type': [],
             },
             api_client=api_client
         )
-        self.get_retail_media_audience_v2_list_by_account_id_endpoint = _Endpoint(
+        self.legacy_get_audience_v2_endpoint = _Endpoint(
             settings={
-                'response_type': (RetailMediaAudienceV2ListResponse,),
+                'response_type': (RmLegacyAudienceGetEntityV2ListResponse,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
                 'endpoint_path': '/preview/retail-media/v2/accounts/{accountId}/audiences',
-                'operation_id': 'get_retail_media_audience_v2_list_by_account_id',
+                'operation_id': 'legacy_get_audience_v2',
                 'http_method': 'GET',
                 'servers': None,
             },
@@ -167,34 +168,36 @@ class AudienceApi(object):
             },
             headers_map={
                 'accept': [
-                    'application/json'
+                    'text/plain',
+                    'application/json',
+                    'text/json'
                 ],
                 'content_type': [],
             },
             api_client=api_client
         )
 
-    def get_audiences_by_account_id(
+    def legacy_get_audience_v1(
         self,
         account_id,
         **kwargs
     ):
-        """get_audiences_by_account_id  # noqa: E501
+        """legacy_get_audience_v1  # noqa: E501
 
-        Get a page of audiences for a given account ID  # noqa: E501
+        Get a page of Audiences. (deprecated Public API)  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.get_audiences_by_account_id(account_id, async_req=True)
+        >>> thread = api.legacy_get_audience_v1(account_id, async_req=True)
         >>> result = thread.get()
 
         Args:
-            account_id (str): External account ID which owns audience.
+            account_id (int): ID of the account to which this audience belongs.
 
         Keyword Args:
-            limit_to_id ([str]): Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2. [optional]
-            page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page. [optional]
-            page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed. [optional]
+            limit_to_id ([int]): Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2. [optional]
+            page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page.. [optional]
+            page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed.. [optional]
             _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
@@ -227,7 +230,7 @@ class AudienceApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            GetPageOfAudiencesByAccountIdResponse
+            RmLegacyAudienceGetEntityV1ListResponse
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -258,29 +261,29 @@ class AudienceApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         kwargs['account_id'] = \
             account_id
-        return self.get_audiences_by_account_id_endpoint.call_with_http_info(**kwargs)
+        return self.legacy_get_audience_v1_endpoint.call_with_http_info(**kwargs)
 
-    def get_retail_media_audience_v2_list_by_account_id(
+    def legacy_get_audience_v2(
         self,
         account_id,
         **kwargs
     ):
-        """get_retail_media_audience_v2_list_by_account_id  # noqa: E501
+        """legacy_get_audience_v2  # noqa: E501
 
-        Get a page of audiences for a given account ID  # noqa: E501
+        Get a page of Audiences. (deprecated Public API)  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.get_retail_media_audience_v2_list_by_account_id(account_id, async_req=True)
+        >>> thread = api.legacy_get_audience_v2(account_id, async_req=True)
         >>> result = thread.get()
 
         Args:
-            account_id (int): External account ID which owns audience.
+            account_id (int): ID of the account to which this audience belongs.
 
         Keyword Args:
             limit_to_id ([int]): Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2. [optional]
-            page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page. [optional]
-            page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed. [optional]
+            page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page.. [optional]
+            page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed.. [optional]
             _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
@@ -313,7 +316,7 @@ class AudienceApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            RetailMediaAudienceV2ListResponse
+            RmLegacyAudienceGetEntityV2ListResponse
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -344,5 +347,5 @@ class AudienceApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         kwargs['account_id'] = \
             account_id
-        return self.get_retail_media_audience_v2_list_by_account_id_endpoint.call_with_http_info(**kwargs)
+        return self.legacy_get_audience_v2_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.231113/python'
+        self.user_agent = 'OpenAPI-Generator/0.0.240207/python'
 
     def __enter__(self):
         return self
@@ -803,11 +803,11 @@ class Endpoint(object):
         """ This method is invoked when endpoints are called
         Example:
 
-        api_instance = AnalyticsApi()
-        api_instance.generate_async_campaigns_report  # this is an instance of the class Endpoint
-        api_instance.generate_async_campaigns_report()  # this invokes api_instance.generate_async_campaigns_report.__call__()
+        api_instance = AccountsApi()
+        api_instance.create_private_market_demand_brand_account  # this is an instance of the class Endpoint
+        api_instance.create_private_market_demand_brand_account()  # this invokes api_instance.create_private_market_demand_brand_account.__call__()
         which then invokes the callable functions stored in that endpoint at
-        api_instance.generate_async_campaigns_report.callable or self.callable in this class
+        api_instance.create_private_market_demand_brand_account.callable or self.callable in this class
 
         """
         return self.callable(self, *args, **kwargs)

criteo_api_retailmedia_preview/apis/__init__.py

@@ -6,7 +6,7 @@
 # raise a `RecursionError`.
 # In order to avoid this, import only the API that you directly need like:
 #
-#   from criteo_api_retailmedia_preview.api.analytics_api import AnalyticsApi
+#   from criteo_api_retailmedia_preview.api.accounts_api import AccountsApi
 #
 # or import this package, but before doing it, use:
 #
@@ -14,6 +14,7 @@
 #   sys.setrecursionlimit(n)
 
 # Import APIs into API package:
+from criteo_api_retailmedia_preview.api.accounts_api import AccountsApi
 from criteo_api_retailmedia_preview.api.analytics_api import AnalyticsApi
 from criteo_api_retailmedia_preview.api.audience_api import AudienceApi
 from criteo_api_retailmedia_preview.api.campaign_api import CampaignApi

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.231113".\
+               "SDK Package Version: 0.0.240207".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

criteo_api_retailmedia_preview/model/external_account.py

@@ -107,6 +107,7 @@ class ExternalAccount(ModelNormal):
             'parent_account_label': (str,),  # noqa: E501
             'time_zone': (str,),  # noqa: E501
             'subtype': (str, none_type,),  # noqa: E501
+            'company_name': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -122,6 +123,7 @@ class ExternalAccount(ModelNormal):
         'parent_account_label': 'parentAccountLabel',  # noqa: E501
         'time_zone': 'timeZone',  # noqa: E501
         'subtype': 'subtype',  # noqa: E501
+        'company_name': 'companyName',  # noqa: E501
     }
 
     read_only_vars = {
@@ -174,6 +176,7 @@ class ExternalAccount(ModelNormal):
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             subtype (str, none_type): [optional]  # noqa: E501
+            company_name (str, none_type): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -274,6 +277,7 @@ class ExternalAccount(ModelNormal):
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             subtype (str, none_type): [optional]  # noqa: E501
+            company_name (str, none_type): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

criteo_api_retailmedia_preview/model/{common_status_code_response.py → grant_consent_input.py}

@@ -30,11 +30,11 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
 
 
 def lazy_import():
-    from criteo_api_retailmedia_preview.model.common_problem import CommonProblem
-    globals()['CommonProblem'] = CommonProblem
+    from criteo_api_retailmedia_preview.model.grant_consent_model_value_resource import GrantConsentModelValueResource
+    globals()['GrantConsentModelValueResource'] = GrantConsentModelValueResource
 
 
-class CommonStatusCodeResponse(ModelNormal):
+class GrantConsentInput(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -87,8 +87,7 @@ class CommonStatusCodeResponse(ModelNormal):
         """
         lazy_import()
         return {
-            'errors': ([CommonProblem], none_type,),  # noqa: E501
-            'warnings': ([CommonProblem], none_type,),  # noqa: E501
+            'data': (GrantConsentModelValueResource,),  # noqa: E501
         }
 
     @cached_property
@@ -97,13 +96,10 @@ class CommonStatusCodeResponse(ModelNormal):
 
 
     attribute_map = {
-        'errors': 'errors',  # noqa: E501
-        'warnings': 'warnings',  # noqa: E501
+        'data': 'data',  # noqa: E501
     }
 
     read_only_vars = {
-        'errors',  # noqa: E501
-        'warnings',  # noqa: E501
     }
 
     _composed_schemas = {}
@@ -111,7 +107,7 @@ class CommonStatusCodeResponse(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """CommonStatusCodeResponse - a model defined in OpenAPI
+        """GrantConsentInput - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -144,8 +140,7 @@ class CommonStatusCodeResponse(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            errors ([CommonProblem], none_type): errors. [optional]  # noqa: E501
-            warnings ([CommonProblem], none_type): warnings. [optional]  # noqa: E501
+            data (GrantConsentModelValueResource): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -198,7 +193,7 @@ class CommonStatusCodeResponse(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """CommonStatusCodeResponse - a model defined in OpenAPI
+        """GrantConsentInput - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -231,8 +226,7 @@ class CommonStatusCodeResponse(ModelNormal):
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
-            errors ([CommonProblem], none_type): errors. [optional]  # noqa: E501
-            warnings ([CommonProblem], none_type): warnings. [optional]  # noqa: E501
+            data (GrantConsentModelValueResource): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

criteo_api_retailmedia_preview/model/grant_consent_model.py

@@ -0,0 +1,279 @@
+"""
+    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 GrantConsentModel(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 {
+            'client_id': (str,),  # noqa: E501
+            'callback_url': (str,),  # noqa: E501
+            'callback_state': (str, none_type,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'client_id': 'clientId',  # noqa: E501
+        'callback_url': 'callbackUrl',  # noqa: E501
+        'callback_state': 'callbackState',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, client_id, callback_url, *args, **kwargs):  # noqa: E501
+        """GrantConsentModel - a model defined in OpenAPI
+
+        Args:
+            client_id (str):
+            callback_url (str):
+
+        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,)
+            callback_state (str, none_type): [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__,)
+
+        self.client_id = client_id
+        self.callback_url = callback_url
+        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, client_id, callback_url, *args, **kwargs):  # noqa: E501
+        """GrantConsentModel - a model defined in OpenAPI
+
+        Args:
+            client_id (str):
+            callback_url (str):
+
+        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,)
+            callback_state (str, none_type): [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__,)
+
+        self.client_id = client_id
+        self.callback_url = callback_url
+        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.")