criteo-api-retailmedia-sdk 2024.10.0.241029__py3-none-any.whl → 2025.1.0.250129__py3-none-any.whl

{criteo_api_retailmedia_v2024_10 → criteo_api_retailmedia_v2025_01}/api/accounts_api.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2024-10
+    The version of the OpenAPI document: 2025-01
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,8 +11,8 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2024_10.api_client import ApiClient, Endpoint as _Endpoint
-from criteo_api_retailmedia_v2024_10.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2025_01.api_client import ApiClient, Endpoint as _Endpoint
+from criteo_api_retailmedia_v2025_01.model_utils import (  # noqa: F401
     check_allowed_values,
     check_validations,
     date,
@@ -21,14 +21,15 @@ from criteo_api_retailmedia_v2024_10.model_utils import (  # noqa: F401
     none_type,
     validate_and_convert_types
 )
-from criteo_api_retailmedia_v2024_10.model.json_api_page_response_of_account import JsonApiPageResponseOfAccount
-from criteo_api_retailmedia_v2024_10.model.resource_outcome_of_retail_media_account import ResourceOutcomeOfRetailMediaAccount
-from criteo_api_retailmedia_v2024_10.model.value_resource_collection_input_of_retail_media_seller import ValueResourceCollectionInputOfRetailMediaSeller
-from criteo_api_retailmedia_v2024_10.model.value_resource_collection_outcome_of_retail_media_seller import ValueResourceCollectionOutcomeOfRetailMediaSeller
-from criteo_api_retailmedia_v2024_10.model.value_resource_input_of_retail_media_brand_account_creation import ValueResourceInputOfRetailMediaBrandAccountCreation
-from criteo_api_retailmedia_v2024_10.model.value_resource_input_of_retail_media_brands import ValueResourceInputOfRetailMediaBrands
-from criteo_api_retailmedia_v2024_10.model.value_resource_input_of_retail_media_seller_account_creation import ValueResourceInputOfRetailMediaSellerAccountCreation
-from criteo_api_retailmedia_v2024_10.model.value_resource_of_retail_media_brands import ValueResourceOfRetailMediaBrands
+from criteo_api_retailmedia_v2025_01.model.entity_resource_outcome_of_retail_media_account import EntityResourceOutcomeOfRetailMediaAccount
+from criteo_api_retailmedia_v2025_01.model.grant_consent_input import GrantConsentInput
+from criteo_api_retailmedia_v2025_01.model.json_api_page_response_of_account import JsonApiPageResponseOfAccount
+from criteo_api_retailmedia_v2025_01.model.value_resource_collection_input_of_retail_media_seller import ValueResourceCollectionInputOfRetailMediaSeller
+from criteo_api_retailmedia_v2025_01.model.value_resource_collection_outcome_of_retail_media_seller import ValueResourceCollectionOutcomeOfRetailMediaSeller
+from criteo_api_retailmedia_v2025_01.model.value_resource_input_of_retail_media_brand_account_creation import ValueResourceInputOfRetailMediaBrandAccountCreation
+from criteo_api_retailmedia_v2025_01.model.value_resource_input_of_retail_media_brands import ValueResourceInputOfRetailMediaBrands
+from criteo_api_retailmedia_v2025_01.model.value_resource_input_of_retail_media_seller_account_creation import ValueResourceInputOfRetailMediaSellerAccountCreation
+from criteo_api_retailmedia_v2025_01.model.value_resource_outcome_of_retail_media_brands import ValueResourceOutcomeOfRetailMediaBrands
 
 
 class AccountsApi(object):
@@ -44,12 +45,12 @@ class AccountsApi(object):
         self.api_client = api_client
         self.add_brands_endpoint = _Endpoint(
             settings={
-                'response_type': (ValueResourceOfRetailMediaBrands,),
+                'response_type': (ValueResourceOutcomeOfRetailMediaBrands,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2024-10/retail-media/account-management/accounts/{accountId}/brands/add',
+                'endpoint_path': '/2025-01/retail-media/account-management/accounts/{accountId}/brands/add',
                 'operation_id': 'add_brands',
                 'http_method': 'POST',
                 'servers': None,
@@ -63,6 +64,7 @@ class AccountsApi(object):
                     'account_id',
                 ],
                 'nullable': [
+                    'value_resource_input_of_retail_media_brands',
                 ],
                 'enum': [
                 ],
@@ -95,22 +97,19 @@ class AccountsApi(object):
                     'application/json'
                 ],
                 'content_type': [
-                    'application/json-patch+json',
-                    'application/json',
-                    'text/json',
-                    'application/*+json'
+                    'application/json'
                 ]
             },
             api_client=api_client
         )
         self.create_private_market_demand_brand_account_endpoint = _Endpoint(
             settings={
-                'response_type': (ResourceOutcomeOfRetailMediaAccount,),
+                'response_type': (EntityResourceOutcomeOfRetailMediaAccount,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2024-10/retail-media/account-management/accounts/{accountId}/create-brand-account',
+                'endpoint_path': '/2025-01/retail-media/account-management/accounts/{accountId}/create-brand-account',
                 'operation_id': 'create_private_market_demand_brand_account',
                 'http_method': 'POST',
                 'servers': None,
@@ -156,22 +155,19 @@ class AccountsApi(object):
                     'application/json'
                 ],
                 'content_type': [
-                    'application/json-patch+json',
-                    'application/json',
-                    'text/json',
-                    'application/*+json'
+                    'application/json'
                 ]
             },
             api_client=api_client
         )
         self.create_private_market_demand_seller_account_endpoint = _Endpoint(
             settings={
-                'response_type': (ResourceOutcomeOfRetailMediaAccount,),
+                'response_type': (EntityResourceOutcomeOfRetailMediaAccount,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2024-10/retail-media/account-management/accounts/{accountId}/create-seller-account',
+                'endpoint_path': '/2025-01/retail-media/account-management/accounts/{accountId}/create-seller-account',
                 'operation_id': 'create_private_market_demand_seller_account',
                 'http_method': 'POST',
                 'servers': None,
@@ -185,6 +181,7 @@ class AccountsApi(object):
                     'account_id',
                 ],
                 'nullable': [
+                    'value_resource_input_of_retail_media_seller_account_creation',
                 ],
                 'enum': [
                 ],
@@ -217,10 +214,7 @@ class AccountsApi(object):
                     'application/json'
                 ],
                 'content_type': [
-                    'application/json-patch+json',
-                    'application/json',
-                    'text/json',
-                    'application/*+json'
+                    'application/json'
                 ]
             },
             api_client=api_client
@@ -232,7 +226,7 @@ class AccountsApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2024-10/retail-media/accounts',
+                'endpoint_path': '/2025-01/retail-media/accounts',
                 'operation_id': 'get_api_v1_external_accounts',
                 'http_method': 'GET',
                 'servers': None,
@@ -288,14 +282,73 @@ class AccountsApi(object):
             },
             api_client=api_client
         )
+        self.grant_consent_endpoint = _Endpoint(
+            settings={
+                'response_type': None,
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/2025-01/retail-media/accounts/{accountId}/grant-consent',
+                'operation_id': 'grant_consent',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'account_id',
+                    'grant_consent_input',
+                ],
+                'required': [
+                    'account_id',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'account_id':
+                        (str,),
+                    'grant_consent_input':
+                        (GrantConsentInput,),
+                },
+                'attribute_map': {
+                    'account_id': 'accountId',
+                },
+                'location_map': {
+                    'account_id': 'path',
+                    'grant_consent_input': 'body',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [],
+                'content_type': [
+                    'application/json-patch+json',
+                    'application/json',
+                    'text/json',
+                    'application/*+json'
+                ]
+            },
+            api_client=api_client
+        )
         self.remove_brands_endpoint = _Endpoint(
             settings={
-                'response_type': (ValueResourceOfRetailMediaBrands,),
+                'response_type': (ValueResourceOutcomeOfRetailMediaBrands,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2024-10/retail-media/account-management/accounts/{accountId}/brands/remove',
+                'endpoint_path': '/2025-01/retail-media/account-management/accounts/{accountId}/brands/remove',
                 'operation_id': 'remove_brands',
                 'http_method': 'POST',
                 'servers': None,
@@ -309,6 +362,7 @@ class AccountsApi(object):
                     'account_id',
                 ],
                 'nullable': [
+                    'value_resource_input_of_retail_media_brands',
                 ],
                 'enum': [
                 ],
@@ -341,10 +395,7 @@ class AccountsApi(object):
                     'application/json'
                 ],
                 'content_type': [
-                    'application/json-patch+json',
-                    'application/json',
-                    'text/json',
-                    'application/*+json'
+                    'application/json'
                 ]
             },
             api_client=api_client
@@ -356,7 +407,7 @@ class AccountsApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2024-10/retail-media/account-management/accounts/{accountId}/sellers',
+                'endpoint_path': '/2025-01/retail-media/account-management/accounts/{accountId}/sellers',
                 'operation_id': 'update_sellers',
                 'http_method': 'PUT',
                 'servers': None,
@@ -370,6 +421,7 @@ class AccountsApi(object):
                     'account_id',
                 ],
                 'nullable': [
+                    'value_resource_collection_input_of_retail_media_seller',
                 ],
                 'enum': [
                 ],
@@ -402,10 +454,7 @@ class AccountsApi(object):
                     'application/json'
                 ],
                 'content_type': [
-                    'application/json-patch+json',
-                    'application/json',
-                    'text/json',
-                    'application/*+json'
+                    'application/json'
                 ]
             },
             api_client=api_client
@@ -429,7 +478,7 @@ class AccountsApi(object):
             account_id (str): the account id to update
 
         Keyword Args:
-            value_resource_input_of_retail_media_brands (ValueResourceInputOfRetailMediaBrands): brands to associate to account. [optional]
+            value_resource_input_of_retail_media_brands (ValueResourceInputOfRetailMediaBrands): [optional]
             _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
@@ -462,7 +511,7 @@ class AccountsApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            ValueResourceOfRetailMediaBrands
+            ValueResourceOutcomeOfRetailMediaBrands
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -510,10 +559,10 @@ class AccountsApi(object):
         >>> result = thread.get()
 
         Args:
-            account_id (str): Account Id for the parent private market account
+            account_id (str): The given account id
 
         Keyword Args:
-            value_resource_input_of_retail_media_brand_account_creation (ValueResourceInputOfRetailMediaBrandAccountCreation): Initial creation and configuration options for the new account. [optional]
+            value_resource_input_of_retail_media_brand_account_creation (ValueResourceInputOfRetailMediaBrandAccountCreation): [optional]
             _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
@@ -546,7 +595,7 @@ class AccountsApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            ResourceOutcomeOfRetailMediaAccount
+            EntityResourceOutcomeOfRetailMediaAccount
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -594,10 +643,10 @@ class AccountsApi(object):
         >>> result = thread.get()
 
         Args:
-            account_id (str): Account Id for the parent private market account
+            account_id (str): The given account id
 
         Keyword Args:
-            value_resource_input_of_retail_media_seller_account_creation (ValueResourceInputOfRetailMediaSellerAccountCreation): Initial creation and configuration options for the new account. [optional]
+            value_resource_input_of_retail_media_seller_account_creation (ValueResourceInputOfRetailMediaSellerAccountCreation): [optional]
             _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
@@ -630,7 +679,7 @@ class AccountsApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            ResourceOutcomeOfRetailMediaAccount
+            EntityResourceOutcomeOfRetailMediaAccount
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -744,6 +793,90 @@ class AccountsApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         return self.get_api_v1_external_accounts_endpoint.call_with_http_info(**kwargs)
 
+    def grant_consent(
+        self,
+        account_id,
+        **kwargs
+    ):
+        """  # noqa: E501
+
+        Grant consent to a business application on behalf of a Private Market demand account  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.grant_consent(account_id, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            account_id (str): The demand account ID on which to grant consent
+
+        Keyword Args:
+            grant_consent_input (GrantConsentInput): [optional]
+            _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:
+            None
+                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['account_id'] = \
+            account_id
+        return self.grant_consent_endpoint.call_with_http_info(**kwargs)
+
     def remove_brands(
         self,
         account_id,
@@ -751,7 +884,7 @@ class AccountsApi(object):
     ):
         """remove_brands  # noqa: E501
 
-        Remove a brand from an account  # noqa: E501
+        Remove brands from an account  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -759,10 +892,10 @@ class AccountsApi(object):
         >>> result = thread.get()
 
         Args:
-            account_id (str): The account id to update
+            account_id (str): the account id to update
 
         Keyword Args:
-            value_resource_input_of_retail_media_brands (ValueResourceInputOfRetailMediaBrands): Brands to remove from account. [optional]
+            value_resource_input_of_retail_media_brands (ValueResourceInputOfRetailMediaBrands): [optional]
             _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
@@ -795,7 +928,7 @@ class AccountsApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            ValueResourceOfRetailMediaBrands
+            ValueResourceOutcomeOfRetailMediaBrands
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -835,7 +968,7 @@ class AccountsApi(object):
     ):
         """update_sellers  # noqa: E501
 
-        replace the sellers assoiated with an account  # noqa: E501
+        replace the sellers associated with an account  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
@@ -843,10 +976,10 @@ class AccountsApi(object):
         >>> result = thread.get()
 
         Args:
-            account_id (str): the account id to update
+            account_id (str): The given account id
 
         Keyword Args:
-            value_resource_collection_input_of_retail_media_seller (ValueResourceCollectionInputOfRetailMediaSeller): sellers to associate. [optional]
+            value_resource_collection_input_of_retail_media_seller (ValueResourceCollectionInputOfRetailMediaSeller): [optional]
             _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

{criteo_api_retailmedia_v2024_10 → criteo_api_retailmedia_v2025_01}/api/analytics_api.py

@@ -3,7 +3,7 @@
 
     Criteo API - RetailMedia  # noqa: E501
 
-    The version of the OpenAPI document: 2024-10
+    The version of the OpenAPI document: 2025-01
     Generated by: https://openapi-generator.tech
 """
 
@@ -11,8 +11,8 @@
 import re  # noqa: F401
 import sys  # noqa: F401
 
-from criteo_api_retailmedia_v2024_10.api_client import ApiClient, Endpoint as _Endpoint
-from criteo_api_retailmedia_v2024_10.model_utils import (  # noqa: F401
+from criteo_api_retailmedia_v2025_01.api_client import ApiClient, Endpoint as _Endpoint
+from criteo_api_retailmedia_v2025_01.model_utils import (  # noqa: F401
     check_allowed_values,
     check_validations,
     date,
@@ -21,11 +21,11 @@ from criteo_api_retailmedia_v2024_10.model_utils import (  # noqa: F401
     none_type,
     validate_and_convert_types
 )
-from criteo_api_retailmedia_v2024_10.model.async_campaigns_report_request import AsyncCampaignsReportRequest
-from criteo_api_retailmedia_v2024_10.model.async_line_items_report_request import AsyncLineItemsReportRequest
-from criteo_api_retailmedia_v2024_10.model.async_report_response import AsyncReportResponse
-from criteo_api_retailmedia_v2024_10.model.async_revenue_report_request import AsyncRevenueReportRequest
-from criteo_api_retailmedia_v2024_10.model.report_outcome import ReportOutcome
+from criteo_api_retailmedia_v2025_01.model.async_campaigns_report_request import AsyncCampaignsReportRequest
+from criteo_api_retailmedia_v2025_01.model.async_line_items_report_request import AsyncLineItemsReportRequest
+from criteo_api_retailmedia_v2025_01.model.async_report_response import AsyncReportResponse
+from criteo_api_retailmedia_v2025_01.model.async_revenue_report_request import AsyncRevenueReportRequest
+from criteo_api_retailmedia_v2025_01.model.report_outcome import ReportOutcome
 
 
 class AnalyticsApi(object):
@@ -46,7 +46,7 @@ class AnalyticsApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2024-10/retail-media/reports/campaigns',
+                'endpoint_path': '/2025-01/retail-media/reports/campaigns',
                 'operation_id': 'generate_async_campaigns_report',
                 'http_method': 'POST',
                 'servers': None,
@@ -104,7 +104,7 @@ class AnalyticsApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2024-10/retail-media/reports/line-items',
+                'endpoint_path': '/2025-01/retail-media/reports/line-items',
                 'operation_id': 'generate_async_line_items_report',
                 'http_method': 'POST',
                 'servers': None,
@@ -162,7 +162,7 @@ class AnalyticsApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2024-10/retail-media/reports/revenue',
+                'endpoint_path': '/2025-01/retail-media/reports/revenue',
                 'operation_id': 'generate_async_revenue_report',
                 'http_method': 'POST',
                 'servers': None,
@@ -220,7 +220,7 @@ class AnalyticsApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2024-10/retail-media/reports/{reportId}/output',
+                'endpoint_path': '/2025-01/retail-media/reports/{reportId}/output',
                 'operation_id': 'get_async_export_output',
                 'http_method': 'GET',
                 'servers': None,
@@ -274,7 +274,7 @@ class AnalyticsApi(object):
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/2024-10/retail-media/reports/{reportId}/status',
+                'endpoint_path': '/2025-01/retail-media/reports/{reportId}/status',
                 'operation_id': 'get_async_export_status',
                 'http_method': 'GET',
                 'servers': None,