criteo-api-retailmedia-sdk 2025.4.0.250425__tar.gz → 2025.4.0.250618__tar.gz

{criteo_api_retailmedia_sdk-2025.4.0.250425 → criteo_api_retailmedia_sdk-2025.4.0.250618}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: criteo-api-retailmedia-sdk
-Version: 2025.4.0.250425
+Version: 2025.4.0.250618
 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==2025.04.0.250425
+pip install criteo-api-retailmedia-sdk==2025.04.0.250618
 ```
-(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2025.04.0.250425`)
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2025.04.0.250618`)
 
 Then import the package:
 ```python

{criteo_api_retailmedia_sdk-2025.4.0.250425 → criteo_api_retailmedia_sdk-2025.4.0.250618}/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: 2025.04.0.250425
+- Package version: 2025.04.0.250618
 
 ## Requirements
 
@@ -18,9 +18,9 @@ Python 2.7 and 3.5+
 ### pip install
 
 ```sh
-pip install criteo-api-retailmedia-sdk==2025.04.0.250425
+pip install criteo-api-retailmedia-sdk==2025.04.0.250618
 ```
-(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2025.04.0.250425`)
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2025.04.0.250618`)
 
 Then import the package:
 ```python
@@ -300,6 +300,7 @@ Class | Method | HTTP request | Description
  - [MatchTypeModel](docs/MatchTypeModel.md)
  - [Metadata](docs/Metadata.md)
  - [MonthlyLineItemBudegetOverride](docs/MonthlyLineItemBudegetOverride.md)
+ - [NillableDecimal](docs/NillableDecimal.md)
  - [NillableString](docs/NillableString.md)
  - [Outcome](docs/Outcome.md)
  - [PageMetadata](docs/PageMetadata.md)
@@ -378,6 +379,8 @@ Class | Method | HTTP request | Description
  - [RmContactListStatisticsEntityV1Resource](docs/RmContactListStatisticsEntityV1Resource.md)
  - [RmContactListStatisticsEntityV1Response](docs/RmContactListStatisticsEntityV1Response.md)
  - [RmContactListV1](docs/RmContactListV1.md)
+ - [RmEventsCreateV1](docs/RmEventsCreateV1.md)
+ - [RmEventsUpdateV1](docs/RmEventsUpdateV1.md)
  - [RmEventsV1](docs/RmEventsV1.md)
  - [RmcaCommonProblem](docs/RmcaCommonProblem.md)
  - [SdkApiRestCommonProblem](docs/SdkApiRestCommonProblem.md)

{criteo_api_retailmedia_sdk-2025.4.0.250425 → criteo_api_retailmedia_sdk-2025.4.0.250618}/criteo_api_retailmedia_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: criteo-api-retailmedia-sdk
-Version: 2025.4.0.250425
+Version: 2025.4.0.250618
 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==2025.04.0.250425
+pip install criteo-api-retailmedia-sdk==2025.04.0.250618
 ```
-(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2025.04.0.250425`)
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2025.04.0.250618`)
 
 Then import the package:
 ```python

{criteo_api_retailmedia_sdk-2025.4.0.250425 → criteo_api_retailmedia_sdk-2025.4.0.250618}/criteo_api_retailmedia_sdk.egg-info/SOURCES.txt

@@ -174,6 +174,7 @@ criteo_api_retailmedia_v2025_04/model/line_item_product_status.py
 criteo_api_retailmedia_v2025_04/model/match_type_model.py
 criteo_api_retailmedia_v2025_04/model/metadata.py
 criteo_api_retailmedia_v2025_04/model/monthly_line_item_budeget_override.py
+criteo_api_retailmedia_v2025_04/model/nillable_decimal.py
 criteo_api_retailmedia_v2025_04/model/nillable_string.py
 criteo_api_retailmedia_v2025_04/model/outcome.py
 criteo_api_retailmedia_v2025_04/model/page_metadata.py
@@ -252,6 +253,8 @@ criteo_api_retailmedia_v2025_04/model/rm_contact_list_statistics_entity_v1.py
 criteo_api_retailmedia_v2025_04/model/rm_contact_list_statistics_entity_v1_resource.py
 criteo_api_retailmedia_v2025_04/model/rm_contact_list_statistics_entity_v1_response.py
 criteo_api_retailmedia_v2025_04/model/rm_contact_list_v1.py
+criteo_api_retailmedia_v2025_04/model/rm_events_create_v1.py
+criteo_api_retailmedia_v2025_04/model/rm_events_update_v1.py
 criteo_api_retailmedia_v2025_04/model/rm_events_v1.py
 criteo_api_retailmedia_v2025_04/model/rmca_common_problem.py
 criteo_api_retailmedia_v2025_04/model/sdk_api_rest_common_problem.py

{criteo_api_retailmedia_sdk-2025.4.0.250425 → criteo_api_retailmedia_sdk-2025.4.0.250618}/criteo_api_retailmedia_v2025_04/__init__.py

@@ -8,7 +8,7 @@
 """
 
 
-__version__ = "2025.04.0.250425"
+__version__ = "2025.04.0.250618"
 
 # import ApiClient
 from criteo_api_retailmedia_v2025_04.api_client import ApiClient

{criteo_api_retailmedia_sdk-2025.4.0.250425 → criteo_api_retailmedia_sdk-2025.4.0.250618}/criteo_api_retailmedia_v2025_04/api/audience_api.py

@@ -666,7 +666,7 @@ class AudienceApi(object):
     ):
         """bulk_delete_audience_segments  # noqa: E501
 
-        Delete the segments associated to the given audience IDs.  # noqa: E501
+        Delete the segments associated to the given IDs.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 

{criteo_api_retailmedia_sdk-2025.4.0.250425 → criteo_api_retailmedia_sdk-2025.4.0.250618}/criteo_api_retailmedia_v2025_04/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/2025.04.0.250425/python'
+        self.user_agent = 'OpenAPI-Generator/2025.04.0.250618/python'
 
     def __enter__(self):
         return self

{criteo_api_retailmedia_sdk-2025.4.0.250425 → criteo_api_retailmedia_sdk-2025.4.0.250618}/criteo_api_retailmedia_v2025_04/configuration.py

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

{criteo_api_retailmedia_sdk-2025.4.0.250425 → criteo_api_retailmedia_sdk-2025.4.0.250618}/criteo_api_retailmedia_v2025_04/model/external_common_line_item.py

@@ -112,6 +112,7 @@ class ExternalCommonLineItem(ModelNormal):
             'budget': (float, none_type,),  # noqa: E501
             'budget_spent': (float,),  # noqa: E501
             'end_date': (date, none_type,),  # noqa: E501
+            'id': (str, none_type,),  # noqa: E501
             'status': (str,),  # noqa: E501
         }
 
@@ -132,6 +133,7 @@ class ExternalCommonLineItem(ModelNormal):
         'budget': 'budget',  # noqa: E501
         'budget_spent': 'budgetSpent',  # noqa: E501
         'end_date': 'endDate',  # noqa: E501
+        'id': 'id',  # noqa: E501
         'status': 'status',  # noqa: E501
     }
 
@@ -189,6 +191,7 @@ class ExternalCommonLineItem(ModelNormal):
             budget (float, none_type): [optional]  # noqa: E501
             budget_spent (float): [optional]  # noqa: E501
             end_date (date, none_type): Represents the Date as a year, month, and day in the format YYYY-MM-DD. [optional]  # noqa: E501
+            id (str, none_type): Id of the entity. [optional]  # noqa: E501
             status (str): [optional]  # noqa: E501
         """
 
@@ -296,6 +299,7 @@ class ExternalCommonLineItem(ModelNormal):
             budget (float, none_type): [optional]  # noqa: E501
             budget_spent (float): [optional]  # noqa: E501
             end_date (date, none_type): Represents the Date as a year, month, and day in the format YYYY-MM-DD. [optional]  # noqa: E501
+            id (str, none_type): Id of the entity. [optional]  # noqa: E501
             status (str): [optional]  # noqa: E501
         """
 

criteo_api_retailmedia_sdk-2025.4.0.250618/criteo_api_retailmedia_v2025_04/model/nillable_decimal.py

@@ -0,0 +1,263 @@
+"""
+    Criteo API
+
+    Criteo API - RetailMedia  # noqa: E501
+
+    The version of the OpenAPI document: 2025-04
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from criteo_api_retailmedia_v2025_04.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_v2025_04.exceptions import ApiAttributeError
+
+
+
+class NillableDecimal(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 = True
+
+    @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 {
+            'value': (float, none_type,),  # noqa: E501
+        }
+
+    @cached_property
+    def discriminator():
+        return None
+
+
+    attribute_map = {
+        'value': 'value',  # noqa: E501
+    }
+
+    read_only_vars = {
+    }
+
+    _composed_schemas = {}
+
+    @classmethod
+    @convert_js_args_to_python_args
+    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+        """NillableDecimal - 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,)
+            value (float, none_type): The value. If missing or null the value is set to \"null\". [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
+        """NillableDecimal - 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,)
+            value (float, none_type): The value. If missing or null the value is set to \"null\". [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.")

{criteo_api_retailmedia_sdk-2025.4.0.250425 → criteo_api_retailmedia_sdk-2025.4.0.250618}/criteo_api_retailmedia_v2025_04/model/rm_audience_segment_create_entity_v1.py

@@ -31,7 +31,9 @@ from criteo_api_retailmedia_v2025_04.exceptions import ApiAttributeError
 
 def lazy_import():
     from criteo_api_retailmedia_v2025_04.model.rm_contact_list_create_v1 import RmContactListCreateV1
+    from criteo_api_retailmedia_v2025_04.model.rm_events_create_v1 import RmEventsCreateV1
     globals()['RmContactListCreateV1'] = RmContactListCreateV1
+    globals()['RmEventsCreateV1'] = RmEventsCreateV1
 
 
 class RmAudienceSegmentCreateEntityV1(ModelNormal):
@@ -91,6 +93,7 @@ class RmAudienceSegmentCreateEntityV1(ModelNormal):
             'retailer_id': (str,),  # noqa: E501
             'contact_list': (RmContactListCreateV1,),  # noqa: E501
             'description': (str,),  # noqa: E501
+            'events': (RmEventsCreateV1,),  # noqa: E501
         }
 
     @cached_property
@@ -103,6 +106,7 @@ class RmAudienceSegmentCreateEntityV1(ModelNormal):
         'retailer_id': 'retailerId',  # noqa: E501
         'contact_list': 'contactList',  # noqa: E501
         'description': 'description',  # noqa: E501
+        'events': 'events',  # noqa: E501
     }
 
     read_only_vars = {
@@ -152,6 +156,7 @@ class RmAudienceSegmentCreateEntityV1(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             contact_list (RmContactListCreateV1): [optional]  # noqa: E501
             description (str): Description of the segment. [optional]  # noqa: E501
+            events (RmEventsCreateV1): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -245,6 +250,7 @@ class RmAudienceSegmentCreateEntityV1(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             contact_list (RmContactListCreateV1): [optional]  # noqa: E501
             description (str): Description of the segment. [optional]  # noqa: E501
+            events (RmEventsCreateV1): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

{criteo_api_retailmedia_sdk-2025.4.0.250425 → criteo_api_retailmedia_sdk-2025.4.0.250618}/criteo_api_retailmedia_v2025_04/model/rm_audience_segment_update_entity_v1.py

@@ -31,7 +31,9 @@ from criteo_api_retailmedia_v2025_04.exceptions import ApiAttributeError
 
 def lazy_import():
     from criteo_api_retailmedia_v2025_04.model.nillable_string import NillableString
+    from criteo_api_retailmedia_v2025_04.model.rm_events_update_v1 import RmEventsUpdateV1
     globals()['NillableString'] = NillableString
+    globals()['RmEventsUpdateV1'] = RmEventsUpdateV1
 
 
 class RmAudienceSegmentUpdateEntityV1(ModelNormal):
@@ -89,6 +91,7 @@ class RmAudienceSegmentUpdateEntityV1(ModelNormal):
         return {
             'contact_list': ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},),  # noqa: E501
             'description': (NillableString,),  # noqa: E501
+            'events': (RmEventsUpdateV1,),  # noqa: E501
             'name': (str,),  # noqa: E501
         }
 
@@ -100,6 +103,7 @@ class RmAudienceSegmentUpdateEntityV1(ModelNormal):
     attribute_map = {
         'contact_list': 'contactList',  # noqa: E501
         'description': 'description',  # noqa: E501
+        'events': 'events',  # noqa: E501
         'name': 'name',  # noqa: E501
     }
 
@@ -146,6 +150,7 @@ class RmAudienceSegmentUpdateEntityV1(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             contact_list ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Settings to update the contact list of the segment. [optional]  # noqa: E501
             description (NillableString): [optional]  # noqa: E501
+            events (RmEventsUpdateV1): [optional]  # noqa: E501
             name (str): Name of the segment. [optional]  # noqa: E501
         """
 
@@ -234,6 +239,7 @@ class RmAudienceSegmentUpdateEntityV1(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             contact_list ({str: (bool, date, datetime, dict, float, int, list, str, none_type)}): Settings to update the contact list of the segment. [optional]  # noqa: E501
             description (NillableString): [optional]  # noqa: E501
+            events (RmEventsUpdateV1): [optional]  # noqa: E501
             name (str): Name of the segment. [optional]  # noqa: E501
         """