criteo-api-retailmedia-sdk 0.0.250327__py3-none-any.whl → 0.0.250425__py3-none-any.whl

criteo_api_retailmedia_preview/__init__.py

@@ -8,7 +8,7 @@
 """
 
 
-__version__ = "0.0.250327"
+__version__ = "0.0.250425"
 
 # import ApiClient
 from criteo_api_retailmedia_preview.api_client import ApiClient

criteo_api_retailmedia_preview/api/accounts_api.py

@@ -22,10 +22,13 @@ from criteo_api_retailmedia_preview.model_utils import (  # noqa: F401
     validate_and_convert_types
 )
 from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_of_retail_media_child_account_and_metadata import EntityResourceCollectionOutcomeOfRetailMediaChildAccountAndMetadata
-from criteo_api_retailmedia_preview.model.grant_consent_input import GrantConsentInput
 from criteo_api_retailmedia_preview.model.outcome import Outcome
 from criteo_api_retailmedia_preview.model.value_resource_collection_outcome_of_seller_search_result import ValueResourceCollectionOutcomeOfSellerSearchResult
+from criteo_api_retailmedia_preview.model.value_resource_collection_outcome_private_market_account_fees_and_metadata import ValueResourceCollectionOutcomePrivateMarketAccountFeesAndMetadata
+from criteo_api_retailmedia_preview.model.value_resource_input_account_fees_search_request import ValueResourceInputAccountFeesSearchRequest
+from criteo_api_retailmedia_preview.model.value_resource_input_account_fees_update_request import ValueResourceInputAccountFeesUpdateRequest
 from criteo_api_retailmedia_preview.model.value_resource_input_of_seller_search import ValueResourceInputOfSellerSearch
+from criteo_api_retailmedia_preview.model.value_resource_outcome_account_fees_update_result import ValueResourceOutcomeAccountFeesUpdateResult
 
 
 class AccountsApi(object):
@@ -54,8 +57,8 @@ class AccountsApi(object):
             params_map={
                 'all': [
                     'account_id',
-                    'offset',
                     'limit',
+                    'offset',
                 ],
                 'required': [
                     'account_id',
@@ -75,20 +78,20 @@ class AccountsApi(object):
                 'openapi_types': {
                     'account_id':
                         (str,),
-                    'offset':
-                        (int,),
                     'limit':
                         (int,),
+                    'offset':
+                        (int,),
                 },
                 'attribute_map': {
                     'account_id': 'accountId',
-                    'offset': 'offset',
                     'limit': 'limit',
+                    'offset': 'offset',
                 },
                 'location_map': {
                     'account_id': 'path',
-                    'offset': 'query',
                     'limit': 'query',
+                    'offset': 'query',
                 },
                 'collection_format_map': {
                 }
@@ -101,26 +104,99 @@ class AccountsApi(object):
             },
             api_client=api_client
         )
-        self.grant_consent_endpoint = _Endpoint(
+        self.preview_retail_media_accounts_fees_search_post_endpoint = _Endpoint(
             settings={
-                'response_type': None,
+                'response_type': (ValueResourceCollectionOutcomePrivateMarketAccountFeesAndMetadata,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/preview/retail-media/accounts/{accountId}/grant-consent',
-                'operation_id': 'grant_consent',
+                'endpoint_path': '/preview/retail-media/accounts/fees/search',
+                'operation_id': 'preview_retail_media_accounts_fees_search_post',
                 'http_method': 'POST',
                 'servers': None,
             },
             params_map={
                 'all': [
-                    'account_id',
-                    'grant_consent_input',
+                    'limit',
+                    'offset',
+                    'value_resource_input_account_fees_search_request',
                 ],
-                'required': [
-                    'account_id',
+                'required': [],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                    'limit',
+                    'offset',
+                ]
+            },
+            root_map={
+                'validations': {
+                    ('limit',): {
+
+                        'inclusive_maximum': 500,
+                        'inclusive_minimum': 1,
+                    },
+                    ('offset',): {
+
+                        'inclusive_maximum': 2147483647,
+                        'inclusive_minimum': 0,
+                    },
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'limit':
+                        (int,),
+                    'offset':
+                        (int,),
+                    'value_resource_input_account_fees_search_request':
+                        (ValueResourceInputAccountFeesSearchRequest,),
+                },
+                'attribute_map': {
+                    'limit': 'limit',
+                    'offset': 'offset',
+                },
+                'location_map': {
+                    'limit': 'query',
+                    'offset': 'query',
+                    'value_resource_input_account_fees_search_request': 'body',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [
+                    'application/json-patch+json',
+                    'application/json',
+                    'text/json',
+                    'application/*+json'
+                ]
+            },
+            api_client=api_client
+        )
+        self.preview_retail_media_accounts_fees_update_post_endpoint = _Endpoint(
+            settings={
+                'response_type': (ValueResourceOutcomeAccountFeesUpdateResult,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/retail-media/accounts/fees/update',
+                'operation_id': 'preview_retail_media_accounts_fees_update_post',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'value_resource_input_account_fees_update_request',
                 ],
+                'required': [],
                 'nullable': [
                 ],
                 'enum': [
@@ -134,23 +210,23 @@ class AccountsApi(object):
                 'allowed_values': {
                 },
                 'openapi_types': {
-                    'account_id':
-                        (str,),
-                    'grant_consent_input':
-                        (GrantConsentInput,),
+                    'value_resource_input_account_fees_update_request':
+                        (ValueResourceInputAccountFeesUpdateRequest,),
                 },
                 'attribute_map': {
-                    'account_id': 'accountId',
                 },
                 'location_map': {
-                    'account_id': 'path',
-                    'grant_consent_input': 'body',
+                    'value_resource_input_account_fees_update_request': 'body',
                 },
                 'collection_format_map': {
                 }
             },
             headers_map={
-                'accept': [],
+                'accept': [
+                    'text/plain',
+                    'application/json',
+                    'text/json'
+                ],
                 'content_type': [
                     'application/json-patch+json',
                     'application/json',
@@ -235,8 +311,8 @@ class AccountsApi(object):
             account_id (str): Account Id
 
         Keyword Args:
-            offset (int): The (zero-based) offset into the collection of accounts. The default is 0.. [optional] if omitted the server will use the default value of 0
             limit (int): The number of accounts to be returned. The default is 25.. [optional] if omitted the server will use the default value of 25
+            offset (int): The (zero-based) offset into the collection of accounts. The default is 0.. [optional] if omitted the server will use the default value of 0
             _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
@@ -302,25 +378,24 @@ class AccountsApi(object):
             account_id
         return self.get_api_external_v1_account_private_market_child_accounts_by_account_id_endpoint.call_with_http_info(**kwargs)
 
-    def grant_consent(
+    def preview_retail_media_accounts_fees_search_post(
         self,
-        account_id,
         **kwargs
     ):
-        """  # noqa: E501
+        """preview_retail_media_accounts_fees_search_post  # noqa: E501
 
-        Grant consent to a business application on behalf of a Private Market demand account  # noqa: E501
+        Get fees for provided accounts  # 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)
+        >>> thread = api.preview_retail_media_accounts_fees_search_post(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]
+            limit (int): used for paging, number of results returned per request, Maximum of 500. [optional] if omitted the server will use the default value of 50
+            offset (int): used for paging, number of records to skip. [optional] if omitted the server will use the default value of 0
+            value_resource_input_account_fees_search_request (ValueResourceInputAccountFeesSearchRequest): [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
@@ -353,7 +428,7 @@ class AccountsApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            None
+            ValueResourceCollectionOutcomePrivateMarketAccountFeesAndMetadata
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -382,9 +457,86 @@ class AccountsApi(object):
             '_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)
+        return self.preview_retail_media_accounts_fees_search_post_endpoint.call_with_http_info(**kwargs)
+
+    def preview_retail_media_accounts_fees_update_post(
+        self,
+        **kwargs
+    ):
+        """preview_retail_media_accounts_fees_update_post  # noqa: E501
+
+        Set fees for provided accounts  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.preview_retail_media_accounts_fees_update_post(async_req=True)
+        >>> result = thread.get()
+
+
+        Keyword Args:
+            value_resource_input_account_fees_update_request (ValueResourceInputAccountFeesUpdateRequest): [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:
+            ValueResourceOutcomeAccountFeesUpdateResult
+                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)
+        return self.preview_retail_media_accounts_fees_update_post_endpoint.call_with_http_info(**kwargs)
 
     def search_sellers(
         self,

criteo_api_retailmedia_preview/api/analytics_api.py

@@ -25,6 +25,7 @@ from criteo_api_retailmedia_preview.model.async_accounts_report_request import A
 from criteo_api_retailmedia_preview.model.async_campaigns_report_request import AsyncCampaignsReportRequest
 from criteo_api_retailmedia_preview.model.async_fill_rate_report_request import AsyncFillRateReportRequest
 from criteo_api_retailmedia_preview.model.async_line_items_report_request import AsyncLineItemsReportRequest
+from criteo_api_retailmedia_preview.model.async_offsite_report_request import AsyncOffsiteReportRequest
 from criteo_api_retailmedia_preview.model.async_report_response import AsyncReportResponse
 from criteo_api_retailmedia_preview.model.report_outcome import ReportOutcome
 from criteo_api_retailmedia_preview.model.report_response import ReportResponse
@@ -276,6 +277,64 @@ class AnalyticsApi(object):
             },
             api_client=api_client
         )
+        self.generate_async_offsite_report_endpoint = _Endpoint(
+            settings={
+                'response_type': (AsyncReportResponse,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/retail-media/reports/offsite',
+                'operation_id': 'generate_async_offsite_report',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'async_offsite_report_request',
+                ],
+                'required': [
+                    'async_offsite_report_request',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'async_offsite_report_request':
+                        (AsyncOffsiteReportRequest,),
+                },
+                'attribute_map': {
+                },
+                'location_map': {
+                    'async_offsite_report_request': 'body',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'text/plain',
+                    'application/json',
+                    'text/json'
+                ],
+                'content_type': [
+                    'application/json-patch+json',
+                    'application/json',
+                    'text/json',
+                    'application/*+json'
+                ]
+            },
+            api_client=api_client
+        )
         self.generate_sync_attributed_transactions_report_endpoint = _Endpoint(
             settings={
                 'response_type': (ReportResponse,),
@@ -452,7 +511,7 @@ class AnalyticsApi(object):
         )
         self.get_async_export_output_endpoint = _Endpoint(
             settings={
-                'response_type': (str,),
+                'response_type': (file_type,),
                 'auth': [
                     'oauth',
                     'oauth'
@@ -891,6 +950,89 @@ class AnalyticsApi(object):
             async_line_items_report_request
         return self.generate_async_line_items_report_endpoint.call_with_http_info(**kwargs)
 
+    def generate_async_offsite_report(
+        self,
+        async_offsite_report_request,
+        **kwargs
+    ):
+        """generate_async_offsite_report  # noqa: E501
+
+        Returns an asynchronous Offsite Report This endpoint is subject to specific rate limits.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.generate_async_offsite_report(async_offsite_report_request, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            async_offsite_report_request (AsyncOffsiteReportRequest):
+
+        Keyword Args:
+            _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:
+            AsyncReportResponse
+                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['async_offsite_report_request'] = \
+            async_offsite_report_request
+        return self.generate_async_offsite_report_endpoint.call_with_http_info(**kwargs)
+
     def generate_sync_attributed_transactions_report(
         self,
         sync_attributed_transactions_report_request,
@@ -1190,7 +1332,7 @@ class AnalyticsApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            str
+            file_type
                 If the method is called asynchronously, returns the request
                 thread.
         """

criteo_api_retailmedia_preview/api/balance_api.py

@@ -185,9 +185,9 @@ class BalanceApi(object):
             params_map={
                 'all': [
                     'balance_id',
-                    'offset',
                     'limit',
                     'limit_to_change_types',
+                    'offset',
                 ],
                 'required': [
                     'balance_id',
@@ -197,46 +197,46 @@ class BalanceApi(object):
                 'enum': [
                 ],
                 'validation': [
-                    'offset',
                     'limit',
+                    'offset',
                 ]
             },
             root_map={
                 'validations': {
-                    ('offset',): {
-
-                        'inclusive_maximum': 2147483647,
-                        'inclusive_minimum': 0,
-                    },
                     ('limit',): {
 
                         'inclusive_maximum': 100,
                         'inclusive_minimum': 1,
                     },
+                    ('offset',): {
+
+                        'inclusive_maximum': 2147483647,
+                        'inclusive_minimum': 0,
+                    },
                 },
                 'allowed_values': {
                 },
                 'openapi_types': {
                     'balance_id':
                         (str,),
-                    'offset':
-                        (int,),
                     'limit':
                         (int,),
                     'limit_to_change_types':
                         (str,),
+                    'offset':
+                        (int,),
                 },
                 'attribute_map': {
                     'balance_id': 'balanceId',
-                    'offset': 'offset',
                     'limit': 'limit',
                     'limit_to_change_types': 'limitToChangeTypes',
+                    'offset': 'offset',
                 },
                 'location_map': {
                     'balance_id': 'path',
-                    'offset': 'query',
                     'limit': 'query',
                     'limit_to_change_types': 'query',
+                    'offset': 'query',
                 },
                 'collection_format_map': {
                 }
@@ -636,9 +636,9 @@ class BalanceApi(object):
             balance_id (str): Balance id.
 
         Keyword Args:
-            offset (int): The (zero-based) starting offset in the collection.. [optional] if omitted the server will use the default value of 0
             limit (int): The number of elements to be returned.. [optional] if omitted the server will use the default value of 25
             limit_to_change_types (str): Comma separated change types string that will be queried.. [optional]
+            offset (int): The (zero-based) starting offset in the collection.. [optional] if omitted the server will use the default value of 0
             _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