criteo-api-retailmedia-sdk 2024.10.0.250129__tar.gz → 2024.10.0.250205__tar.gz

{criteo_api_retailmedia_sdk-2024.10.0.250129 → criteo_api_retailmedia_sdk-2024.10.0.250205}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: criteo-api-retailmedia-sdk
-Version: 2024.10.0.250129
+Version: 2024.10.0.250205
 Summary: Criteo API SDK
 Home-page: https://github.com/criteo/criteo-api-python-sdk
 Author: Criteo
@@ -35,9 +35,9 @@ IMPORTANT: This Python package links to Criteo production environment. Any test
 
 
 ```sh
-pip install criteo-api-retailmedia-sdk==2024.10.0.250129
+pip install criteo-api-retailmedia-sdk==2024.10.0.250205
 ```
-(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2024.10.0.250129`)
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2024.10.0.250205`)
 
 Then import the package:
 ```python

{criteo_api_retailmedia_sdk-2024.10.0.250129 → criteo_api_retailmedia_sdk-2024.10.0.250205}/README.md

@@ -8,7 +8,7 @@ More information on how to use Criteo API and these SDKs can be found at: [https
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- Package version: 2024.10.0.250129
+- Package version: 2024.10.0.250205
 
 ## Requirements
 
@@ -18,9 +18,9 @@ Python 2.7 and 3.5+
 ### pip install
 
 ```sh
-pip install criteo-api-retailmedia-sdk==2024.10.0.250129
+pip install criteo-api-retailmedia-sdk==2024.10.0.250205
 ```
-(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2024.10.0.250129`)
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2024.10.0.250205`)
 
 Then import the package:
 ```python
@@ -238,7 +238,6 @@ Class | Method | HTTP request | Description
  - [ResourceOfUpdateBalanceModelV2](docs/ResourceOfUpdateBalanceModelV2.md)
  - [ResourceOutcome](docs/ResourceOutcome.md)
  - [RetailMediaContactlistAmendment](docs/RetailMediaContactlistAmendment.md)
- - [RetailMediaContactlistAmendmentAttributes](docs/RetailMediaContactlistAmendmentAttributes.md)
  - [RetailMediaContactlistAmendmentRequest](docs/RetailMediaContactlistAmendmentRequest.md)
  - [RetailMediaContactlistOperation](docs/RetailMediaContactlistOperation.md)
  - [RetailMediaContactlistOperationResponseAttributes](docs/RetailMediaContactlistOperationResponseAttributes.md)

{criteo_api_retailmedia_sdk-2024.10.0.250129 → criteo_api_retailmedia_sdk-2024.10.0.250205}/criteo_api_retailmedia_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: criteo-api-retailmedia-sdk
-Version: 2024.10.0.250129
+Version: 2024.10.0.250205
 Summary: Criteo API SDK
 Home-page: https://github.com/criteo/criteo-api-python-sdk
 Author: Criteo
@@ -35,9 +35,9 @@ IMPORTANT: This Python package links to Criteo production environment. Any test
 
 
 ```sh
-pip install criteo-api-retailmedia-sdk==2024.10.0.250129
+pip install criteo-api-retailmedia-sdk==2024.10.0.250205
 ```
-(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2024.10.0.250129`)
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2024.10.0.250205`)
 
 Then import the package:
 ```python

{criteo_api_retailmedia_sdk-2024.10.0.250129 → criteo_api_retailmedia_sdk-2024.10.0.250205}/criteo_api_retailmedia_sdk.egg-info/SOURCES.txt

@@ -204,7 +204,6 @@ criteo_api_retailmedia_v2024_10/model/resource_of_template.py
 criteo_api_retailmedia_v2024_10/model/resource_of_update_balance_model_v2.py
 criteo_api_retailmedia_v2024_10/model/resource_outcome.py
 criteo_api_retailmedia_v2024_10/model/retail_media_contactlist_amendment.py
-criteo_api_retailmedia_v2024_10/model/retail_media_contactlist_amendment_attributes.py
 criteo_api_retailmedia_v2024_10/model/retail_media_contactlist_amendment_request.py
 criteo_api_retailmedia_v2024_10/model/retail_media_contactlist_operation.py
 criteo_api_retailmedia_v2024_10/model/retail_media_contactlist_operation_response_attributes.py

{criteo_api_retailmedia_sdk-2024.10.0.250129 → criteo_api_retailmedia_sdk-2024.10.0.250205}/criteo_api_retailmedia_v2024_10/__init__.py

@@ -8,7 +8,7 @@
 """
 
 
-__version__ = "2024.10.0.250129"
+__version__ = "2024.10.0.250205"
 
 # import ApiClient
 from criteo_api_retailmedia_v2024_10.api_client import ApiClient

{criteo_api_retailmedia_sdk-2024.10.0.250129 → criteo_api_retailmedia_sdk-2024.10.0.250205}/criteo_api_retailmedia_v2024_10/api/campaign_api.py

@@ -1447,6 +1447,7 @@ class CampaignApi(object):
                     'account_id',
                 ],
                 'nullable': [
+                    'limit_to_type',
                 ],
                 'enum': [
                     'limit_to_type',
@@ -1459,7 +1460,7 @@ class CampaignApi(object):
                 },
                 'allowed_values': {
                     ('limit_to_type',): {
-
+                        'None': None,
                         "UNKNOWN": "Unknown",
                         "AUCTION": "Auction",
                         "PREFERRED": "Preferred"
@@ -1471,7 +1472,7 @@ class CampaignApi(object):
                     'limit_to_campaign_id':
                         ([str],),
                     'limit_to_type':
-                        (str,),
+                        (str, none_type,),
                     'limit_to_id':
                         ([str],),
                     'page_index':
@@ -5614,7 +5615,7 @@ class CampaignApi(object):
 
         Keyword Args:
             limit_to_campaign_id ([str]): The campaign ids that you would like to limit your result set to. [optional]
-            limit_to_type (str): The campaign types that you would like to limit your result set to. [optional]
+            limit_to_type (str, none_type): The campaign types that you would like to limit your result set to. [optional]
             limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
             page_index (int): The 0 indexed page index you would like to receive given the page size. [optional]
             page_size (int): The maximum number of items you would like to receive in this request. [optional]

{criteo_api_retailmedia_sdk-2024.10.0.250129 → criteo_api_retailmedia_sdk-2024.10.0.250205}/criteo_api_retailmedia_v2024_10/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/2024.10.0.250129/python'
+        self.user_agent = 'OpenAPI-Generator/2024.10.0.250205/python'
 
     def __enter__(self):
         return self

{criteo_api_retailmedia_sdk-2024.10.0.250129 → criteo_api_retailmedia_sdk-2024.10.0.250205}/criteo_api_retailmedia_v2024_10/configuration.py

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

{criteo_api_retailmedia_sdk-2024.10.0.250129 → criteo_api_retailmedia_sdk-2024.10.0.250205}/criteo_api_retailmedia_v2024_10/model/async_campaigns_report.py

@@ -181,6 +181,10 @@ class AsyncCampaignsReport(ModelNormal):
             'VIDEOSTARTINGRATE': "videoStartingRate",
             'VIDEOCPC': "videoCPC",
             'VIDEOCPCV': "videoCPCV",
+            'NEWTOBRANDATTRIBUTEDSALES': "newToBrandAttributedSales",
+            'NEWTOBRANDATTRIBUTEDSALESRATE': "newToBrandAttributedSalesRate",
+            'NEWTOBRANDATTRIBUTEDUNITS': "newToBrandAttributedUnits",
+            'NEWTOBRANDATTRIBUTEDUNITSRATE': "newToBrandAttributedUnitsRate",
             'UNIQUEVISITORS': "uniqueVisitors",
             'FREQUENCY': "frequency",
         },

{criteo_api_retailmedia_sdk-2024.10.0.250129 → criteo_api_retailmedia_sdk-2024.10.0.250205}/criteo_api_retailmedia_v2024_10/model/async_line_items_report.py

@@ -181,6 +181,10 @@ class AsyncLineItemsReport(ModelNormal):
             'VIDEOSTARTINGRATE': "videoStartingRate",
             'VIDEOCPC': "videoCPC",
             'VIDEOCPCV': "videoCPCV",
+            'NEWTOBRANDATTRIBUTEDSALES': "newToBrandAttributedSales",
+            'NEWTOBRANDATTRIBUTEDSALESRATE': "newToBrandAttributedSalesRate",
+            'NEWTOBRANDATTRIBUTEDUNITS': "newToBrandAttributedUnits",
+            'NEWTOBRANDATTRIBUTEDUNITSRATE': "newToBrandAttributedUnitsRate",
             'UNIQUEVISITORS': "uniqueVisitors",
             'FREQUENCY': "frequency",
         },

{criteo_api_retailmedia_sdk-2024.10.0.250129 → criteo_api_retailmedia_sdk-2024.10.0.250205}/criteo_api_retailmedia_v2024_10/model/external_retailer.py

@@ -59,6 +59,8 @@ class ExternalRetailer(ModelNormal):
             'UNKNOWN': "unknown",
             'AUCTION': "auction",
             'PREFERRED': "preferred",
+            'OFFSITE': "offsite",
+            'OFFSITECPC': "offsiteCpc",
         },
     }
 

criteo_api_retailmedia_sdk-2024.10.0.250129/criteo_api_retailmedia_v2024_10/model/retail_media_contactlist_amendment_attributes.py → criteo_api_retailmedia_sdk-2024.10.0.250205/criteo_api_retailmedia_v2024_10/model/retail_media_contactlist_amendment.py

@@ -30,7 +30,7 @@ from criteo_api_retailmedia_v2024_10.exceptions import ApiAttributeError
 
 
 
-class RetailMediaContactlistAmendmentAttributes(ModelNormal):
+class RetailMediaContactlistAmendment(ModelNormal):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -118,7 +118,7 @@ class RetailMediaContactlistAmendmentAttributes(ModelNormal):
     @classmethod
     @convert_js_args_to_python_args
     def _from_openapi_data(cls, operation, identifiers, *args, **kwargs):  # noqa: E501
-        """RetailMediaContactlistAmendmentAttributes - a model defined in OpenAPI
+        """RetailMediaContactlistAmendment - a model defined in OpenAPI
 
         Args:
             operation (str): Whether to add or remove users
@@ -210,7 +210,7 @@ class RetailMediaContactlistAmendmentAttributes(ModelNormal):
 
     @convert_js_args_to_python_args
     def __init__(self, operation, identifiers, *args, **kwargs):  # noqa: E501
-        """RetailMediaContactlistAmendmentAttributes - a model defined in OpenAPI
+        """RetailMediaContactlistAmendment - a model defined in OpenAPI
 
         Args:
             operation (str): Whether to add or remove users

{criteo_api_retailmedia_sdk-2024.10.0.250129 → criteo_api_retailmedia_sdk-2024.10.0.250205}/criteo_api_retailmedia_v2024_10/models/__init__.py

@@ -187,7 +187,6 @@ from criteo_api_retailmedia_v2024_10.model.resource_of_template import ResourceO
 from criteo_api_retailmedia_v2024_10.model.resource_of_update_balance_model_v2 import ResourceOfUpdateBalanceModelV2
 from criteo_api_retailmedia_v2024_10.model.resource_outcome import ResourceOutcome
 from criteo_api_retailmedia_v2024_10.model.retail_media_contactlist_amendment import RetailMediaContactlistAmendment
-from criteo_api_retailmedia_v2024_10.model.retail_media_contactlist_amendment_attributes import RetailMediaContactlistAmendmentAttributes
 from criteo_api_retailmedia_v2024_10.model.retail_media_contactlist_amendment_request import RetailMediaContactlistAmendmentRequest
 from criteo_api_retailmedia_v2024_10.model.retail_media_contactlist_operation import RetailMediaContactlistOperation
 from criteo_api_retailmedia_v2024_10.model.retail_media_contactlist_operation_response_attributes import RetailMediaContactlistOperationResponseAttributes

{criteo_api_retailmedia_sdk-2024.10.0.250129 → criteo_api_retailmedia_sdk-2024.10.0.250205}/setup.py

@@ -3,7 +3,7 @@
 from setuptools import setup, find_packages  # noqa: H301
 
 NAME = "criteo-api-retailmedia-sdk"
-VERSION = "2024.10.0.250129"
+VERSION = "2024.10.0.250205"
 # To install the library, run the following
 #
 # python setup.py install
@@ -24,9 +24,9 @@ IMPORTANT: This Python package links to Criteo production environment. Any test
 
 
 ```sh
-pip install criteo-api-retailmedia-sdk==2024.10.0.250129
+pip install criteo-api-retailmedia-sdk==2024.10.0.250205
 ```
-(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2024.10.0.250129`)
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2024.10.0.250205`)
 
 Then import the package:
 ```python

criteo_api_retailmedia_sdk-2024.10.0.250129/criteo_api_retailmedia_v2024_10/model/retail_media_contactlist_amendment.py

@@ -1,279 +0,0 @@
-"""
-    Criteo API
-
-    Criteo API - RetailMedia  # noqa: E501
-
-    The version of the OpenAPI document: 2024-10
-    Generated by: https://openapi-generator.tech
-"""
-
-
-import re  # noqa: F401
-import sys  # noqa: F401
-
-from criteo_api_retailmedia_v2024_10.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_v2024_10.exceptions import ApiAttributeError
-
-
-def lazy_import():
-    from criteo_api_retailmedia_v2024_10.model.retail_media_contactlist_amendment_attributes import RetailMediaContactlistAmendmentAttributes
-    globals()['RetailMediaContactlistAmendmentAttributes'] = RetailMediaContactlistAmendmentAttributes
-
-
-class RetailMediaContactlistAmendment(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 {
-            'attributes': (RetailMediaContactlistAmendmentAttributes,),  # noqa: E501
-            'type': (str, none_type,),  # noqa: E501
-        }
-
-    @cached_property
-    def discriminator():
-        return None
-
-
-    attribute_map = {
-        'attributes': 'attributes',  # noqa: E501
-        'type': 'type',  # noqa: E501
-    }
-
-    read_only_vars = {
-    }
-
-    _composed_schemas = {}
-
-    @classmethod
-    @convert_js_args_to_python_args
-    def _from_openapi_data(cls, attributes, *args, **kwargs):  # noqa: E501
-        """RetailMediaContactlistAmendment - a model defined in OpenAPI
-
-        Args:
-            attributes (RetailMediaContactlistAmendmentAttributes):
-
-        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,)
-            type (str, none_type): User List. [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.attributes = attributes
-        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, attributes, *args, **kwargs):  # noqa: E501
-        """RetailMediaContactlistAmendment - a model defined in OpenAPI
-
-        Args:
-            attributes (RetailMediaContactlistAmendmentAttributes):
-
-        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,)
-            type (str, none_type): User List. [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.attributes = attributes
-        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.")