criteo-api-retailmedia-sdk 2024.7.0.250129__tar.gz → 2024.7.0.250211__tar.gz

{criteo_api_retailmedia_sdk-2024.7.0.250129 → criteo_api_retailmedia_sdk-2024.7.0.250211}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: criteo-api-retailmedia-sdk
-Version: 2024.7.0.250129
+Version: 2024.7.0.250211
 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.07.0.250129
+pip install criteo-api-retailmedia-sdk==2024.07.0.250211
 ```
-(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2024.07.0.250129`)
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2024.07.0.250211`)
 
 Then import the package:
 ```python

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

{criteo_api_retailmedia_sdk-2024.7.0.250129 → criteo_api_retailmedia_sdk-2024.7.0.250211}/criteo_api_retailmedia_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: criteo-api-retailmedia-sdk
-Version: 2024.7.0.250129
+Version: 2024.7.0.250211
 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.07.0.250129
+pip install criteo-api-retailmedia-sdk==2024.07.0.250211
 ```
-(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2024.07.0.250129`)
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==2024.07.0.250211`)
 
 Then import the package:
 ```python

{criteo_api_retailmedia_sdk-2024.7.0.250129 → criteo_api_retailmedia_sdk-2024.7.0.250211}/criteo_api_retailmedia_v2024_07/__init__.py

@@ -8,7 +8,7 @@
 """
 
 
-__version__ = "2024.07.0.250129"
+__version__ = "2024.07.0.250211"
 
 # import ApiClient
 from criteo_api_retailmedia_v2024_07.api_client import ApiClient

{criteo_api_retailmedia_sdk-2024.7.0.250129 → criteo_api_retailmedia_sdk-2024.7.0.250211}/criteo_api_retailmedia_v2024_07/api/campaign_api.py

@@ -150,7 +150,7 @@ class CampaignApi(object):
         )
         self.append_promoted_products_endpoint = _Endpoint(
             settings={
-                'response_type': None,
+                'response_type': (ProductResourceOutcome,),
                 'auth': [
                     'oauth',
                     'oauth'
@@ -1620,6 +1620,7 @@ class CampaignApi(object):
                     'account_id',
                 ],
                 'nullable': [
+                    'limit_to_type',
                 ],
                 'enum': [
                     'limit_to_type',
@@ -1632,7 +1633,7 @@ class CampaignApi(object):
                 },
                 'allowed_values': {
                     ('limit_to_type',): {
-
+                        'None': None,
                         "UNKNOWN": "Unknown",
                         "AUCTION": "Auction",
                         "PREFERRED": "Preferred"
@@ -1644,7 +1645,7 @@ class CampaignApi(object):
                     'limit_to_campaign_id':
                         ([str],),
                     'limit_to_type':
-                        (str,),
+                        (str, none_type,),
                     'limit_to_id':
                         ([str],),
                     'page_index':
@@ -3795,7 +3796,7 @@ class CampaignApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            None
+            ProductResourceOutcome
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -5862,7 +5863,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.7.0.250129 → criteo_api_retailmedia_sdk-2024.7.0.250211}/criteo_api_retailmedia_v2024_07/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.07.0.250129/python'
+        self.user_agent = 'OpenAPI-Generator/2024.07.0.250211/python'
 
     def __enter__(self):
         return self

{criteo_api_retailmedia_sdk-2024.7.0.250129 → criteo_api_retailmedia_sdk-2024.7.0.250211}/criteo_api_retailmedia_v2024_07/configuration.py

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

{criteo_api_retailmedia_sdk-2024.7.0.250129 → criteo_api_retailmedia_sdk-2024.7.0.250211}/criteo_api_retailmedia_v2024_07/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.7.0.250129 → criteo_api_retailmedia_sdk-2024.7.0.250211}/criteo_api_retailmedia_v2024_07/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.7.0.250129 → criteo_api_retailmedia_sdk-2024.7.0.250211}/criteo_api_retailmedia_v2024_07/model/balance_response_v2.py

@@ -66,10 +66,10 @@ class BalanceResponseV2(ModelNormal):
             'OFFSITEAWARENESS': "OffsiteAwareness",
         },
         ('private_market_billing_type',): {
-            'NOTAPPLICABLE': "NotApplicable",
-            'BILLBYRETAILER': "BillByRetailer",
-            'BILLBYCRITEO': "BillByCriteo",
-            'UNKNOWN': "Unknown",
+            'NOTAPPLICABLE': "notApplicable",
+            'BILLBYRETAILER': "billByRetailer",
+            'BILLBYCRITEO': "billByCriteo",
+            'UNKNOWN': "unknown",
         },
         ('status',): {
             'UNKNOWN': "unknown",

{criteo_api_retailmedia_sdk-2024.7.0.250129 → criteo_api_retailmedia_sdk-2024.7.0.250211}/criteo_api_retailmedia_v2024_07/model/campaign_attributes_v202301.py

@@ -67,12 +67,12 @@ class CampaignAttributesV202301(ModelNormal):
             'UNKNOWN': "unknown",
         },
         ('view_attribution_window',): {
-            'NONE': "None",
-            'UNKNOWN': "Unknown",
-            'ONEDAY': "OneDay",
-            'SEVENDAYS': "SevenDays",
-            'FOURTEENDAYS': "FourteenDays",
-            'THIRTYDAYS': "ThirtyDays",
+            'NONE': "none",
+            'UNKNOWN': "unknown",
+            '1D': "1D",
+            '7D': "7D",
+            '14D': "14D",
+            '30D': "30D",
         },
         ('click_attribution_scope',): {
             'None': None,
@@ -208,7 +208,7 @@ class CampaignAttributesV202301(ModelNormal):
             type (str): [optional] if omitted the server will use the default value of "auction"  # noqa: E501
             drawable_balance_ids ([str]): [optional]  # noqa: E501
             click_attribution_window (str): [optional] if omitted the server will use the default value of "30D"  # noqa: E501
-            view_attribution_window (str): [optional] if omitted the server will use the default value of "None"  # noqa: E501
+            view_attribution_window (str): [optional] if omitted the server will use the default value of "none"  # noqa: E501
             budget (float, none_type): [optional]  # noqa: E501
             monthly_pacing (float, none_type): [optional]  # noqa: E501
             daily_pacing (float, none_type): [optional]  # noqa: E501
@@ -314,7 +314,7 @@ class CampaignAttributesV202301(ModelNormal):
             type (str): [optional] if omitted the server will use the default value of "auction"  # noqa: E501
             drawable_balance_ids ([str]): [optional]  # noqa: E501
             click_attribution_window (str): [optional] if omitted the server will use the default value of "30D"  # noqa: E501
-            view_attribution_window (str): [optional] if omitted the server will use the default value of "None"  # noqa: E501
+            view_attribution_window (str): [optional] if omitted the server will use the default value of "none"  # noqa: E501
             budget (float, none_type): [optional]  # noqa: E501
             monthly_pacing (float, none_type): [optional]  # noqa: E501
             daily_pacing (float, none_type): [optional]  # noqa: E501

{criteo_api_retailmedia_sdk-2024.7.0.250129 → criteo_api_retailmedia_sdk-2024.7.0.250211}/criteo_api_retailmedia_v2024_07/model/campaign_v202301.py

@@ -74,12 +74,12 @@ class CampaignV202301(ModelNormal):
             'UNKNOWN': "unknown",
         },
         ('view_attribution_window',): {
-            'NONE': "None",
-            'UNKNOWN': "Unknown",
-            'ONEDAY': "OneDay",
-            'SEVENDAYS': "SevenDays",
-            'FOURTEENDAYS': "FourteenDays",
-            'THIRTYDAYS': "ThirtyDays",
+            'NONE': "none",
+            'UNKNOWN': "unknown",
+            '1D': "1D",
+            '7D': "7D",
+            '14D': "14D",
+            '30D': "30D",
         },
         ('click_attribution_scope',): {
             'None': None,
@@ -236,7 +236,7 @@ class CampaignV202301(ModelNormal):
             type (str): [optional] if omitted the server will use the default value of "auction"  # noqa: E501
             drawable_balance_ids ([str]): [optional]  # noqa: E501
             click_attribution_window (str): [optional] if omitted the server will use the default value of "30D"  # noqa: E501
-            view_attribution_window (str): [optional] if omitted the server will use the default value of "None"  # noqa: E501
+            view_attribution_window (str): [optional] if omitted the server will use the default value of "none"  # noqa: E501
             budget (float, none_type): [optional]  # noqa: E501
             monthly_pacing (float, none_type): [optional]  # noqa: E501
             daily_pacing (float, none_type): [optional]  # noqa: E501
@@ -355,7 +355,7 @@ class CampaignV202301(ModelNormal):
             type (str): [optional] if omitted the server will use the default value of "auction"  # noqa: E501
             drawable_balance_ids ([str]): [optional]  # noqa: E501
             click_attribution_window (str): [optional] if omitted the server will use the default value of "30D"  # noqa: E501
-            view_attribution_window (str): [optional] if omitted the server will use the default value of "None"  # noqa: E501
+            view_attribution_window (str): [optional] if omitted the server will use the default value of "none"  # noqa: E501
             budget (float, none_type): [optional]  # noqa: E501
             monthly_pacing (float, none_type): [optional]  # noqa: E501
             daily_pacing (float, none_type): [optional]  # noqa: E501

{criteo_api_retailmedia_sdk-2024.7.0.250129 → criteo_api_retailmedia_sdk-2024.7.0.250211}/criteo_api_retailmedia_v2024_07/model/editable_campaign_attributes_v202301.py

@@ -62,12 +62,12 @@ class EditableCampaignAttributesV202301(ModelNormal):
             'UNKNOWN': "unknown",
         },
         ('view_attribution_window',): {
-            'NONE': "None",
-            'UNKNOWN': "Unknown",
-            'ONEDAY': "OneDay",
-            'SEVENDAYS': "SevenDays",
-            'FOURTEENDAYS': "FourteenDays",
-            'THIRTYDAYS': "ThirtyDays",
+            'NONE': "none",
+            'UNKNOWN': "unknown",
+            '1D': "1D",
+            '7D': "7D",
+            '14D': "14D",
+            '30D': "30D",
         },
         ('click_attribution_scope',): {
             'None': None,

{criteo_api_retailmedia_sdk-2024.7.0.250129 → criteo_api_retailmedia_sdk-2024.7.0.250211}/criteo_api_retailmedia_v2024_07/model/external_catalog_status.py

@@ -89,7 +89,7 @@ class ExternalCatalogStatus(ModelNormal):
         """
         return {
             'status': (str,),  # noqa: E501
-            'currency': (str,),  # noqa: E501
+            'currency': (str, none_type,),  # noqa: E501
             'row_count': (int, none_type,),  # noqa: E501
             'file_size_bytes': (int, none_type,),  # noqa: E501
             'md5_checksum': (str, none_type,),  # noqa: E501
@@ -124,7 +124,7 @@ class ExternalCatalogStatus(ModelNormal):
 
         Args:
             status (str): An enumeration of the status of the catalog.
-            currency (str): An ISO4217 representation of the currency products are listed under in this catalog.
+            currency (str, none_type): An ISO4217 representation of the currency products are listed under in this catalog.
             row_count (int, none_type): An indication of the number of products contained in this catalog. Available when  this catalog reaches a success status.
             file_size_bytes (int, none_type): The size of this catalog in bytes. Available when this catalog reaches a success status.
             md5_checksum (str, none_type): An MD5 checksum of the catalog for use in confirming complete and uncorrupted retrieval.  Available when this catalog reaches a success status.
@@ -225,7 +225,7 @@ class ExternalCatalogStatus(ModelNormal):
 
         Args:
             status (str): An enumeration of the status of the catalog.
-            currency (str): An ISO4217 representation of the currency products are listed under in this catalog.
+            currency (str, none_type): An ISO4217 representation of the currency products are listed under in this catalog.
             row_count (int, none_type): An indication of the number of products contained in this catalog. Available when  this catalog reaches a success status.
             file_size_bytes (int, none_type): The size of this catalog in bytes. Available when this catalog reaches a success status.
             md5_checksum (str, none_type): An MD5 checksum of the catalog for use in confirming complete and uncorrupted retrieval.  Available when this catalog reaches a success status.

{criteo_api_retailmedia_sdk-2024.7.0.250129 → criteo_api_retailmedia_sdk-2024.7.0.250211}/criteo_api_retailmedia_v2024_07/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.7.0.250129 → criteo_api_retailmedia_sdk-2024.7.0.250211}/criteo_api_retailmedia_v2024_07/model/line_item_product_status.py

@@ -52,9 +52,9 @@ class LineItemProductStatus(ModelSimple):
 
     allowed_values = {
         ('value',): {
-            'UNKNOWN': "Unknown",
-            'ACTIVE': "Active",
-            'PAUSED': "Paused",
+            'UNKNOWN': "unknown",
+            'ACTIVE': "active",
+            'PAUSED': "paused",
         },
     }
 
@@ -106,10 +106,10 @@ class LineItemProductStatus(ModelSimple):
         Note that value can be passed either in args or in kwargs, but not in both.
 
         Args:
-            args[0] (str): The status of a promoted product in the context of the line item.., must be one of ["Unknown", "Active", "Paused", ]  # noqa: E501
+            args[0] (str): The status of a promoted product in the context of the line item.., must be one of ["unknown", "active", "paused", ]  # noqa: E501
 
         Keyword Args:
-            value (str): The status of a promoted product in the context of the line item.., must be one of ["Unknown", "Active", "Paused", ]  # noqa: E501
+            value (str): The status of a promoted product in the context of the line item.., must be one of ["unknown", "active", "paused", ]  # noqa: E501
             _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.
@@ -200,10 +200,10 @@ class LineItemProductStatus(ModelSimple):
         Note that value can be passed either in args or in kwargs, but not in both.
 
         Args:
-            args[0] (str): The status of a promoted product in the context of the line item.., must be one of ["Unknown", "Active", "Paused", ]  # noqa: E501
+            args[0] (str): The status of a promoted product in the context of the line item.., must be one of ["unknown", "active", "paused", ]  # noqa: E501
 
         Keyword Args:
-            value (str): The status of a promoted product in the context of the line item.., must be one of ["Unknown", "Active", "Paused", ]  # noqa: E501
+            value (str): The status of a promoted product in the context of the line item.., must be one of ["unknown", "active", "paused", ]  # noqa: E501
             _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.

{criteo_api_retailmedia_sdk-2024.7.0.250129 → criteo_api_retailmedia_sdk-2024.7.0.250211}/setup.py

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