criteo-api-retailmedia-sdk 2025.1.0.250728__tar.gz → 2025.1.0.250811__tar.gz

{criteo_api_retailmedia_sdk-2025.1.0.250728 → criteo_api_retailmedia_sdk-2025.1.0.250811}/PKG-INFO

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

{criteo_api_retailmedia_sdk-2025.1.0.250728 → criteo_api_retailmedia_sdk-2025.1.0.250811}/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.01.0.250728
+- Package version: 2025.01.0.250811
 
 ## Requirements
 
@@ -18,9 +18,9 @@ Python 2.7 and 3.5+
 ### pip install
 
 ```sh
-pip install criteo-api-retailmedia-sdk==2025.01.0.250728
+pip install criteo-api-retailmedia-sdk==2025.01.0.250811
 ```
-(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2025.01.0.250728`)
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2025.01.0.250811`)
 
 Then import the package:
 ```python

{criteo_api_retailmedia_sdk-2025.1.0.250728 → criteo_api_retailmedia_sdk-2025.1.0.250811}/criteo_api_retailmedia_sdk.egg-info/PKG-INFO

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

{criteo_api_retailmedia_sdk-2025.1.0.250728 → criteo_api_retailmedia_sdk-2025.1.0.250811}/criteo_api_retailmedia_v2025_01/__init__.py

@@ -8,7 +8,7 @@
 """
 
 
-__version__ = "2025.01.0.250728"
+__version__ = "2025.01.0.250811"
 
 # import ApiClient
 from criteo_api_retailmedia_v2025_01.api_client import ApiClient

{criteo_api_retailmedia_sdk-2025.1.0.250728 → criteo_api_retailmedia_sdk-2025.1.0.250811}/criteo_api_retailmedia_v2025_01/api/campaign_api.py

@@ -6310,7 +6310,7 @@ class CampaignApi(object):
     ):
         """get_campaign_budget_overrides  # noqa: E501
 
-        Get current campaign budget overrides by given external campaign id.  # noqa: E501
+        Get current campaign budget overrides by given campaign id.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -6318,7 +6318,7 @@ class CampaignApi(object):
         >>> result = thread.get()
 
         Args:
-            campaign_id (int): External campaign id.
+            campaign_id (int): Campaign id.
 
         Keyword Args:
             _return_http_data_only (bool): response data without head status
@@ -6484,7 +6484,7 @@ class CampaignApi(object):
         >>> result = thread.get()
 
         Args:
-            external_line_item_id (str): The external line item identifier
+            external_line_item_id (str): The line item identifier
 
         Keyword Args:
             _return_http_data_only (bool): response data without head status
@@ -8921,7 +8921,7 @@ class CampaignApi(object):
     ):
         """update_campaign_budget_overrides  # noqa: E501
 
-        Update campaign budget overrides by given external campaign id and new campaign budget overrides settings.  # noqa: E501
+        Update campaign budget overrides by given campaign id and new campaign budget overrides settings.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -8929,7 +8929,7 @@ class CampaignApi(object):
         >>> result = thread.get()
 
         Args:
-            campaign_id (int): External campaign id.
+            campaign_id (int): Campaign id.
 
         Keyword Args:
             value_resource_input_of_campaign_budget_overrides (ValueResourceInputOfCampaignBudgetOverrides): New campaign budget overrides settings value resource input.. [optional]
@@ -9005,7 +9005,7 @@ class CampaignApi(object):
     ):
         """update_line_item_budget_overrides  # noqa: E501
 
-        Update line item budget overrides by given external line item id and new line item budget overrides settings.  # noqa: E501
+        Update line item budget overrides by given line item id and new line item budget overrides settings.  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -9013,7 +9013,7 @@ class CampaignApi(object):
         >>> result = thread.get()
 
         Args:
-            line_item_id (str): Line item external id.
+            line_item_id (str): Line item id.
 
         Keyword Args:
             value_resource_input_of_line_item_budget_overrides (ValueResourceInputOfLineItemBudgetOverrides): New line item budget overrides settings value resource input.. [optional]

{criteo_api_retailmedia_sdk-2025.1.0.250728 → criteo_api_retailmedia_sdk-2025.1.0.250811}/criteo_api_retailmedia_v2025_01/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.01.0.250728/python'
+        self.user_agent = 'OpenAPI-Generator/2025.01.0.250811/python'
 
     def __enter__(self):
         return self

{criteo_api_retailmedia_sdk-2025.1.0.250728 → criteo_api_retailmedia_sdk-2025.1.0.250811}/criteo_api_retailmedia_v2025_01/configuration.py

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

{criteo_api_retailmedia_sdk-2025.1.0.250728 → criteo_api_retailmedia_sdk-2025.1.0.250811}/criteo_api_retailmedia_v2025_01/model/asset.py

@@ -83,7 +83,6 @@ class Asset(ModelNormal):
         return {
             'file_extension': (str,),  # noqa: E501
             'file_location': (str, none_type,),  # noqa: E501
-            'id': (str, none_type,),  # noqa: E501
         }
 
     @cached_property
@@ -94,7 +93,6 @@ class Asset(ModelNormal):
     attribute_map = {
         'file_extension': 'fileExtension',  # noqa: E501
         'file_location': 'fileLocation',  # noqa: E501
-        'id': 'id',  # noqa: E501
     }
 
     read_only_vars = {
@@ -142,7 +140,6 @@ class Asset(ModelNormal):
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             file_location (str, none_type): A url pointing towards the static file the asset represents.. [optional]  # noqa: E501
-            id (str, none_type): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -233,7 +230,6 @@ class Asset(ModelNormal):
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
             file_location (str, none_type): A url pointing towards the static file the asset represents.. [optional]  # noqa: E501
-            id (str, none_type): [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)

{criteo_api_retailmedia_sdk-2025.1.0.250728 → criteo_api_retailmedia_sdk-2025.1.0.250811}/criteo_api_retailmedia_v2025_01/model/asset_response.py

@@ -64,10 +64,6 @@ class AssetResponse(ModelNormal):
     }
 
     validations = {
-        ('errors',): {
-        },
-        ('warnings',): {
-        },
     }
 
     @cached_property

{criteo_api_retailmedia_sdk-2025.1.0.250728 → criteo_api_retailmedia_sdk-2025.1.0.250811}/criteo_api_retailmedia_v2025_01/model/async_revenue_report.py

@@ -138,6 +138,7 @@ class AsyncRevenueReport(ModelNormal):
             'TAXONOMY6NAME': "taxonomy6Name",
             'TAXONOMY7ID': "taxonomy7Id",
             'TAXONOMY7NAME': "taxonomy7Name",
+            'TARGETEDKEYWORDTYPE': "targetedKeywordType",
         },
         ('format',): {
             'JSON': "json",
@@ -219,6 +220,12 @@ class AsyncRevenueReport(ModelNormal):
             'INDIRECTSOLD': "indirectSold",
             'PRIVATEMARKET': "privateMarket",
         },
+        ('targeted_keyword_types',): {
+            'UNKNOWN': "unknown",
+            'GENERIC': "generic",
+            'BRANDED': "branded",
+            'CONQUESTING': "conquesting",
+        },
         ('view_attribution_window',): {
             'NONE': "none",
             '1D': "1D",
@@ -279,6 +286,7 @@ class AsyncRevenueReport(ModelNormal):
             'sales_channel': (str,),  # noqa: E501
             'sku_relations': ([str],),  # noqa: E501
             'sold_by': (str,),  # noqa: E501
+            'targeted_keyword_types': ([str],),  # noqa: E501
             'timezone': (str,),  # noqa: E501
             'view_attribution_window': (str,),  # noqa: E501
             'view_match_level': (str,),  # noqa: E501
@@ -311,6 +319,7 @@ class AsyncRevenueReport(ModelNormal):
         'sales_channel': 'salesChannel',  # noqa: E501
         'sku_relations': 'skuRelations',  # noqa: E501
         'sold_by': 'soldBy',  # noqa: E501
+        'targeted_keyword_types': 'targetedKeywordTypes',  # noqa: E501
         'timezone': 'timezone',  # noqa: E501
         'view_attribution_window': 'viewAttributionWindow',  # noqa: E501
         'view_match_level': 'viewMatchLevel',  # noqa: E501
@@ -380,6 +389,7 @@ class AsyncRevenueReport(ModelNormal):
             sales_channel (str): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all"  # noqa: E501
             sku_relations ([str]): Filter on sku relations: Same SKU, Same Parent SKU, Same Category, Same Brand or Same Seller. [optional]  # noqa: E501
             sold_by (str): Filter on the seller: Indirect Sold, Direct Sold or Private Market. [optional]  # noqa: E501
+            targeted_keyword_types ([str]): Filter on targeted keyword type: unknown, generic, branded, conquesting. [optional]  # noqa: E501
             timezone (str): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC"  # noqa: E501
             view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none"  # noqa: E501
             view_match_level (str): View Match Level: Campaign, Same SKU, Same Category or Same Brand. [optional] if omitted the server will use the default value of "campaign"  # noqa: E501
@@ -493,6 +503,7 @@ class AsyncRevenueReport(ModelNormal):
             sales_channel (str): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all"  # noqa: E501
             sku_relations ([str]): Filter on sku relations: Same SKU, Same Parent SKU, Same Category, Same Brand or Same Seller. [optional]  # noqa: E501
             sold_by (str): Filter on the seller: Indirect Sold, Direct Sold or Private Market. [optional]  # noqa: E501
+            targeted_keyword_types ([str]): Filter on targeted keyword type: unknown, generic, branded, conquesting. [optional]  # noqa: E501
             timezone (str): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC"  # noqa: E501
             view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none"  # noqa: E501
             view_match_level (str): View Match Level: Campaign, Same SKU, Same Category or Same Brand. [optional] if omitted the server will use the default value of "campaign"  # noqa: E501

{criteo_api_retailmedia_sdk-2025.1.0.250728 → criteo_api_retailmedia_sdk-2025.1.0.250811}/criteo_api_retailmedia_v2025_01/model/rm_events_create_v1.py

@@ -103,12 +103,12 @@ class RmEventsCreateV1(ModelNormal):
                 and the value is attribute type.
         """
         return {
+            'lookback_days': (str,),  # noqa: E501
+            'shopper_activity': (str,),  # noqa: E501
             'brand_ids': ([str],),  # noqa: E501
             'category_ids': ([str],),  # noqa: E501
-            'lookback_days': (str,),  # noqa: E501
             'max_price': (float,),  # noqa: E501
             'min_price': (float,),  # noqa: E501
-            'shopper_activity': (str,),  # noqa: E501
         }
 
     @cached_property
@@ -117,12 +117,12 @@ class RmEventsCreateV1(ModelNormal):
 
 
     attribute_map = {
+        'lookback_days': 'lookbackDays',  # noqa: E501
+        'shopper_activity': 'shopperActivity',  # noqa: E501
         'brand_ids': 'brandIds',  # noqa: E501
         'category_ids': 'categoryIds',  # noqa: E501
-        'lookback_days': 'lookbackDays',  # noqa: E501
         'max_price': 'maxPrice',  # noqa: E501
         'min_price': 'minPrice',  # noqa: E501
-        'shopper_activity': 'shopperActivity',  # noqa: E501
     }
 
     read_only_vars = {
@@ -132,9 +132,13 @@ class RmEventsCreateV1(ModelNormal):
 
     @classmethod
     @convert_js_args_to_python_args
-    def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
+    def _from_openapi_data(cls, lookback_days, shopper_activity, *args, **kwargs):  # noqa: E501
         """RmEventsCreateV1 - a model defined in OpenAPI
 
+        Args:
+            lookback_days (str): Number of days of the lookback windows
+            shopper_activity (str): Types of shopper activity.
+
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
                                 will be type checked and a TypeError will be
@@ -168,10 +172,8 @@ class RmEventsCreateV1(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             brand_ids ([str]): Choose the brands your segment might be interested in. [optional]  # noqa: E501
             category_ids ([str]): Choose the categories your segment might be interested in. [optional]  # noqa: E501
-            lookback_days (str): Number of days of the lookback windows. [optional]  # noqa: E501
             max_price (float): Reach people who’ve shown interest in products with a maximum price. [optional]  # noqa: E501
             min_price (float): Reach people who’ve shown interest in products with a minimum price. [optional]  # noqa: E501
-            shopper_activity (str): Types of shopper activity.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -203,6 +205,8 @@ class RmEventsCreateV1(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.lookback_days = lookback_days
+        self.shopper_activity = shopper_activity
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \
@@ -223,9 +227,13 @@ class RmEventsCreateV1(ModelNormal):
     ])
 
     @convert_js_args_to_python_args
-    def __init__(self, *args, **kwargs):  # noqa: E501
+    def __init__(self, lookback_days, shopper_activity, *args, **kwargs):  # noqa: E501
         """RmEventsCreateV1 - a model defined in OpenAPI
 
+        Args:
+            lookback_days (str): Number of days of the lookback windows
+            shopper_activity (str): Types of shopper activity.
+
         Keyword Args:
             _check_type (bool): if True, values for parameters in openapi_types
                                 will be type checked and a TypeError will be
@@ -259,10 +267,8 @@ class RmEventsCreateV1(ModelNormal):
                                 _visited_composed_classes = (Animal,)
             brand_ids ([str]): Choose the brands your segment might be interested in. [optional]  # noqa: E501
             category_ids ([str]): Choose the categories your segment might be interested in. [optional]  # noqa: E501
-            lookback_days (str): Number of days of the lookback windows. [optional]  # noqa: E501
             max_price (float): Reach people who’ve shown interest in products with a maximum price. [optional]  # noqa: E501
             min_price (float): Reach people who’ve shown interest in products with a minimum price. [optional]  # noqa: E501
-            shopper_activity (str): Types of shopper activity.. [optional]  # noqa: E501
         """
 
         _check_type = kwargs.pop('_check_type', True)
@@ -292,6 +298,8 @@ class RmEventsCreateV1(ModelNormal):
         self._configuration = _configuration
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
+        self.lookback_days = lookback_days
+        self.shopper_activity = shopper_activity
         for var_name, var_value in kwargs.items():
             if var_name not in self.attribute_map and \
                         self._configuration is not None and \

{criteo_api_retailmedia_sdk-2025.1.0.250728 → criteo_api_retailmedia_sdk-2025.1.0.250811}/setup.py

@@ -3,7 +3,7 @@
 from setuptools import setup, find_packages  # noqa: H301
 
 NAME = "criteo-api-retailmedia-sdk"
-VERSION = "2025.01.0.250728"
+VERSION = "2025.01.0.250811"
 # 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==2025.01.0.250728
+pip install criteo-api-retailmedia-sdk==2025.01.0.250811
 ```
-(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2025.01.0.250728`)
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2025.01.0.250811`)
 
 Then import the package:
 ```python

{criteo_api_retailmedia_sdk-2025.1.0.250728 → criteo_api_retailmedia_sdk-2025.1.0.250811}/test/test_gateway_api.py

@@ -9,16 +9,16 @@ from example_application_with_client_credentials import ExampleApplication
 class TestGatewayApi:
   @pytest.fixture(autouse=True)
   def before_each(self):
-    self.client_id = os.environ.get("TEST_CLIENT_ID")
-    self.client_secret = os.environ.get("TEST_CLIENT_SECRET")
-    self.application_id = int(os.environ.get("TEST_APPLICATION_ID"))
+    self.client_id = os.environ.get("RETAILMEDIA_TEST_CLIENT_ID")
+    self.client_secret = os.environ.get("RETAILMEDIA_TEST_CLIENT_SECRET")
+    self.application_id = int(os.environ.get("RETAILMEDIA_TEST_APPLICATION_ID"))
 
     self.client = ApiClientBuilder.WithClientCredentials(clientId=self.client_id, clientSecret=self.client_secret)
 
   def test_environment_variables(self):
-    assert len(self.client_id) > 0, "Environment variable \"TEST_CLIENT_ID\" not found."
-    assert len(self.client_secret) > 0, "Environment variable \"TEST_CLIENT_SECRET\" not found."
-    assert self.application_id > 0, "Environment variable \"TEST_APPLICATION_ID\" not found."
+    assert len(self.client_id) > 0, "Environment variable \"RETAILMEDIA_TEST_CLIENT_ID\" not found."
+    assert len(self.client_secret) > 0, "Environment variable \"RETAILMEDIA_TEST_CLIENT_SECRET\" not found."
+    assert self.application_id > 0, "Environment variable \"RETAILMEDIA_TEST_APPLICATION_ID\" not found."
 
   def test_example_works(self):
     # Arrange