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

criteo_api_retailmedia_preview/api/catalog_api.py

@@ -0,0 +1,312 @@
+"""
+    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.batch_accepted_response import BatchAcceptedResponse
+from criteo_api_retailmedia_preview.model.fail_response import FailResponse
+from criteo_api_retailmedia_preview.model.products_custom_batch_request import ProductsCustomBatchRequest
+from criteo_api_retailmedia_preview.model.report_ok_response import ReportOkResponse
+
+
+class CatalogApi(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.preview_retail_media_catalog_products_batch_post_endpoint = _Endpoint(
+            settings={
+                'response_type': (BatchAcceptedResponse,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/retail-media/catalog/products/batch',
+                'operation_id': 'preview_retail_media_catalog_products_batch_post',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'products_custom_batch_request',
+                ],
+                'required': [
+                    'products_custom_batch_request',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'products_custom_batch_request':
+                        (ProductsCustomBatchRequest,),
+                },
+                'attribute_map': {
+                },
+                'location_map': {
+                    'products_custom_batch_request': 'body',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [
+                    'application/json'
+                ]
+            },
+            api_client=api_client
+        )
+        self.preview_retail_media_catalog_products_batch_report_operation_token_get_endpoint = _Endpoint(
+            settings={
+                'response_type': (ReportOkResponse,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/retail-media/catalog/products/batch/report/{operation-token}',
+                'operation_id': 'preview_retail_media_catalog_products_batch_report_operation_token_get',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'operation_token',
+                ],
+                'required': [
+                    'operation_token',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'operation_token':
+                        (str,),
+                },
+                'attribute_map': {
+                    'operation_token': 'operation-token',
+                },
+                'location_map': {
+                    'operation_token': 'path',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
+
+    def preview_retail_media_catalog_products_batch_post(
+        self,
+        products_custom_batch_request,
+        **kwargs
+    ):
+        """preview_retail_media_catalog_products_batch_post  # noqa: E501
+
+        Used to publish a batch of operations to insert, update and deletes products.  The batch is processed asynchronously.The response provides an operationToken which can be used to track  the status of the report of the operation.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.preview_retail_media_catalog_products_batch_post(products_custom_batch_request, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            products_custom_batch_request (ProductsCustomBatchRequest):
+
+        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:
+            BatchAcceptedResponse
+                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['products_custom_batch_request'] = \
+            products_custom_batch_request
+        return self.preview_retail_media_catalog_products_batch_post_endpoint.call_with_http_info(**kwargs)
+
+    def preview_retail_media_catalog_products_batch_report_operation_token_get(
+        self,
+        operation_token,
+        **kwargs
+    ):
+        """preview_retail_media_catalog_products_batch_report_operation_token_get  # noqa: E501
+
+        Get the report of an asynchronous batch operation previously requested  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.preview_retail_media_catalog_products_batch_report_operation_token_get(operation_token, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            operation_token (str): The token returned by the batch endpoint.
+
+        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:
+            ReportOkResponse
+                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['operation_token'] = \
+            operation_token
+        return self.preview_retail_media_catalog_products_batch_report_operation_token_get_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.240207/python'
+        self.user_agent = 'OpenAPI-Generator/0.0.240515/python'
 
     def __enter__(self):
         return self
@@ -804,10 +804,10 @@ class Endpoint(object):
         Example:
 
         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__()
+        api_instance.add_brands  # this is an instance of the class Endpoint
+        api_instance.add_brands()  # this invokes api_instance.add_brands.__call__()
         which then invokes the callable functions stored in that endpoint at
-        api_instance.create_private_market_demand_brand_account.callable or self.callable in this class
+        api_instance.add_brands.callable or self.callable in this class
 
         """
         return self.callable(self, *args, **kwargs)

criteo_api_retailmedia_preview/apis/__init__.py

@@ -18,4 +18,5 @@ 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
+from criteo_api_retailmedia_preview.api.catalog_api import CatalogApi
 from criteo_api_retailmedia_preview.api.gateway_api import GatewayApi

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

criteo_api_retailmedia_preview/model/{retail_media_externalv1_add_remove_keyword_model.py → add_remove_keyword_model.py}

@@ -29,8 +29,12 @@ 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.match_type_model import MatchTypeModel
+    globals()['MatchTypeModel'] = MatchTypeModel
 
-class RetailMediaExternalv1AddRemoveKeywordModel(ModelNormal):
+
+class AddRemoveKeywordModel(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -55,12 +59,6 @@ class RetailMediaExternalv1AddRemoveKeywordModel(ModelNormal):
     """
 
     allowed_values = {
-        ('match_type',): {
-            'None': None,
-            'POSITIVEEXACTMATCH': "PositiveExactMatch",
-            'NEGATIVEEXACTMATCH': "NegativeExactMatch",
-            'NEGATIVEBROADMATCH': "NegativeBroadMatch",
-        },
     }
 
     validations = {
@@ -70,13 +68,7 @@ class RetailMediaExternalv1AddRemoveKeywordModel(ModelNormal):
         },
     }
 
-    @cached_property
-    def additional_properties_type():
-        """
-        This must be a method because a model may have properties that are
-        of type self, this must run after the class is loaded
-        """
-        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+    additional_properties_type = None
 
     _nullable = False
 
@@ -90,9 +82,10 @@ class RetailMediaExternalv1AddRemoveKeywordModel(ModelNormal):
             openapi_types (dict): The key is attribute name
                 and the value is attribute type.
         """
+        lazy_import()
         return {
             'phrase': (str, none_type,),  # noqa: E501
-            'match_type': (str, none_type,),  # noqa: E501
+            'match_type': (MatchTypeModel,),  # noqa: E501
             'is_deleted': (bool, none_type,),  # noqa: E501
         }
 
@@ -115,7 +108,7 @@ class RetailMediaExternalv1AddRemoveKeywordModel(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
-        """RetailMediaExternalv1AddRemoveKeywordModel - a model defined in OpenAPI
+        """AddRemoveKeywordModel - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -149,7 +142,7 @@ class RetailMediaExternalv1AddRemoveKeywordModel(ModelNormal):
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             phrase (str, none_type): [optional]  # noqa: E501
-            match_type (str, none_type): [optional]  # noqa: E501
+            match_type (MatchTypeModel): [optional]  # noqa: E501
             is_deleted (bool, none_type): [optional]  # noqa: E501
         """
 
@@ -203,7 +196,7 @@ class RetailMediaExternalv1AddRemoveKeywordModel(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, *args, **kwargs):  # noqa: E501
-        """RetailMediaExternalv1AddRemoveKeywordModel - a model defined in OpenAPI
+        """AddRemoveKeywordModel - a model defined in OpenAPI
 
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
@@ -237,7 +230,7 @@ class RetailMediaExternalv1AddRemoveKeywordModel(ModelNormal):
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             phrase (str, none_type): [optional]  # noqa: E501
-            match_type (str, none_type): [optional]  # noqa: E501
+            match_type (MatchTypeModel): [optional]  # noqa: E501
             is_deleted (bool, none_type): [optional]  # noqa: E501
         """