criteo-api-retailmedia-sdk 0.0.250129__tar.gz → 0.0.250211__tar.gz

{criteo_api_retailmedia_sdk-0.0.250129 → criteo_api_retailmedia_sdk-0.0.250211}/PKG-INFO

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

{criteo_api_retailmedia_sdk-0.0.250129 → criteo_api_retailmedia_sdk-0.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: 0.0.250129
+- Package version: 0.0.250211
 
 ## Requirements
 
@@ -18,9 +18,9 @@ Python 2.7 and 3.5+
 ### pip install
 
 ```sh
-pip install criteo-api-retailmedia-sdk==0.0.250129
+pip install criteo-api-retailmedia-sdk==0.0.250211
 ```
-(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==0.0.250129`)
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==0.0.250211`)
 
 Then import the package:
 ```python
@@ -73,6 +73,9 @@ Class | Method | HTTP request | Description
  - [AsyncCampaignsReport](docs/AsyncCampaignsReport.md)
  - [AsyncCampaignsReportRequest](docs/AsyncCampaignsReportRequest.md)
  - [AsyncCampaignsReportResource](docs/AsyncCampaignsReportResource.md)
+ - [AsyncFillRateReport](docs/AsyncFillRateReport.md)
+ - [AsyncFillRateReportRequest](docs/AsyncFillRateReportRequest.md)
+ - [AsyncFillRateReportResource](docs/AsyncFillRateReportResource.md)
  - [AsyncLineItemsReport](docs/AsyncLineItemsReport.md)
  - [AsyncLineItemsReportRequest](docs/AsyncLineItemsReportRequest.md)
  - [AsyncLineItemsReportResource](docs/AsyncLineItemsReportResource.md)
@@ -84,7 +87,6 @@ Class | Method | HTTP request | Description
  - [BalanceResponseV2Response](docs/BalanceResponseV2Response.md)
  - [BatchAcceptedResponse](docs/BatchAcceptedResponse.md)
  - [BotMessage](docs/BotMessage.md)
- - [Botmessage](docs/Botmessage.md)
  - [Brand](docs/Brand.md)
  - [BrandIdSearchRequest](docs/BrandIdSearchRequest.md)
  - [BrandIdSearchResult](docs/BrandIdSearchResult.md)
@@ -135,7 +137,6 @@ Class | Method | HTTP request | Description
  - [GrantConsentInput](docs/GrantConsentInput.md)
  - [GrantConsentModel](docs/GrantConsentModel.md)
  - [GrantConsentModelValueResource](docs/GrantConsentModelValueResource.md)
- - [HttpValidationError](docs/HttpValidationError.md)
  - [HyperlinkVariableValue](docs/HyperlinkVariableValue.md)
  - [InbotDiscussion](docs/InbotDiscussion.md)
  - [InbotDiscussionBodyModel](docs/InbotDiscussionBodyModel.md)
@@ -158,7 +159,6 @@ Class | Method | HTTP request | Description
  - [LineItemBidMultipliersV2Request](docs/LineItemBidMultipliersV2Request.md)
  - [LineItemBidMultipliersV2Response](docs/LineItemBidMultipliersV2Response.md)
  - [LineItemProductStatus](docs/LineItemProductStatus.md)
- - [LocationInner](docs/LocationInner.md)
  - [LoyaltyPoints](docs/LoyaltyPoints.md)
  - [MatchTypeModel](docs/MatchTypeModel.md)
  - [Message](docs/Message.md)
@@ -237,7 +237,6 @@ Class | Method | HTTP request | Description
  - [RetailMediaContactlistAmendmentRequest](docs/RetailMediaContactlistAmendmentRequest.md)
  - [RetailMediaContactlistOperation](docs/RetailMediaContactlistOperation.md)
  - [RetailMediaContactlistOperationResponseAttributes](docs/RetailMediaContactlistOperationResponseAttributes.md)
- - [RetailMediaContactlistOperationResponseAttributesAttributes](docs/RetailMediaContactlistOperationResponseAttributesAttributes.md)
  - [RetailMediaSeller](docs/RetailMediaSeller.md)
  - [ReviewStateModel](docs/ReviewStateModel.md)
  - [RmAlgebraNodeV1](docs/RmAlgebraNodeV1.md)
@@ -279,6 +278,7 @@ Class | Method | HTTP request | Description
  - [SellerPreview](docs/SellerPreview.md)
  - [SellerPreviewResponse](docs/SellerPreviewResponse.md)
  - [SellerSearch](docs/SellerSearch.md)
+ - [SellerSearchResult](docs/SellerSearchResult.md)
  - [SetBidModel](docs/SetBidModel.md)
  - [SetBidsModel](docs/SetBidsModel.md)
  - [SetBidsModelRequest](docs/SetBidsModelRequest.md)
@@ -311,17 +311,16 @@ Class | Method | HTTP request | Description
  - [TextVariableValue](docs/TextVariableValue.md)
  - [UpdateBalanceModelV2](docs/UpdateBalanceModelV2.md)
  - [UpdateBalanceModelV2Request](docs/UpdateBalanceModelV2Request.md)
- - [ValidationError](docs/ValidationError.md)
  - [ValueResourceBrandIdSearchRequest](docs/ValueResourceBrandIdSearchRequest.md)
- - [ValueResourceCollectionOutcomeOfRetailMediaSeller](docs/ValueResourceCollectionOutcomeOfRetailMediaSeller.md)
+ - [ValueResourceCollectionOutcomeOfSellerSearchResult](docs/ValueResourceCollectionOutcomeOfSellerSearchResult.md)
  - [ValueResourceCpcMinBidsRequest](docs/ValueResourceCpcMinBidsRequest.md)
  - [ValueResourceCpcMinBidsResponse](docs/ValueResourceCpcMinBidsResponse.md)
  - [ValueResourceInputBrandIdSearchRequest](docs/ValueResourceInputBrandIdSearchRequest.md)
  - [ValueResourceInputCpcMinBidsRequest](docs/ValueResourceInputCpcMinBidsRequest.md)
  - [ValueResourceInputOfSellerSearch](docs/ValueResourceInputOfSellerSearch.md)
  - [ValueResourceOfRecommendedKeywordsResult](docs/ValueResourceOfRecommendedKeywordsResult.md)
- - [ValueResourceOfRetailMediaSeller](docs/ValueResourceOfRetailMediaSeller.md)
  - [ValueResourceOfSellerSearch](docs/ValueResourceOfSellerSearch.md)
+ - [ValueResourceOfSellerSearchResult](docs/ValueResourceOfSellerSearchResult.md)
  - [ValueResourceOutcomeCpcMinBidsResponse](docs/ValueResourceOutcomeCpcMinBidsResponse.md)
  - [ValueResourceOutcomeOfRecommendedKeywordsResult](docs/ValueResourceOutcomeOfRecommendedKeywordsResult.md)
  - [VideoVariableValue](docs/VideoVariableValue.md)

{criteo_api_retailmedia_sdk-0.0.250129 → criteo_api_retailmedia_sdk-0.0.250211}/criteo_api_retailmedia_preview/__init__.py

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

{criteo_api_retailmedia_sdk-0.0.250129 → criteo_api_retailmedia_sdk-0.0.250211}/criteo_api_retailmedia_preview/api/accounts_api.py

@@ -24,7 +24,7 @@ from criteo_api_retailmedia_preview.model_utils import (  # noqa: F401
 from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_of_retail_media_child_account import EntityResourceCollectionOutcomeOfRetailMediaChildAccount
 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_retail_media_seller import ValueResourceCollectionOutcomeOfRetailMediaSeller
+from criteo_api_retailmedia_preview.model.value_resource_collection_outcome_of_seller_search_result import ValueResourceCollectionOutcomeOfSellerSearchResult
 from criteo_api_retailmedia_preview.model.value_resource_input_of_seller_search import ValueResourceInputOfSellerSearch
 
 
@@ -162,7 +162,7 @@ class AccountsApi(object):
         )
         self.search_sellers_endpoint = _Endpoint(
             settings={
-                'response_type': (ValueResourceCollectionOutcomeOfRetailMediaSeller,),
+                'response_type': (ValueResourceCollectionOutcomeOfSellerSearchResult,),
                 'auth': [
                     'oauth',
                     'oauth'
@@ -434,7 +434,7 @@ class AccountsApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            ValueResourceCollectionOutcomeOfRetailMediaSeller
+            ValueResourceCollectionOutcomeOfSellerSearchResult
                 If the method is called asynchronously, returns the request
                 thread.
         """

{criteo_api_retailmedia_sdk-0.0.250129 → criteo_api_retailmedia_sdk-0.0.250211}/criteo_api_retailmedia_preview/api/analytics_api.py

@@ -23,6 +23,7 @@ from criteo_api_retailmedia_preview.model_utils import (  # noqa: F401
 )
 from criteo_api_retailmedia_preview.model.async_accounts_report_request import AsyncAccountsReportRequest
 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_report_response import AsyncReportResponse
 from criteo_api_retailmedia_preview.model.report_outcome import ReportOutcome
@@ -159,6 +160,64 @@ class AnalyticsApi(object):
             },
             api_client=api_client
         )
+        self.generate_async_fill_rate_report_endpoint = _Endpoint(
+            settings={
+                'response_type': (AsyncReportResponse,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/retail-media/reports/fillrate',
+                'operation_id': 'generate_async_fill_rate_report',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'async_fill_rate_report_request',
+                ],
+                'required': [
+                    'async_fill_rate_report_request',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'async_fill_rate_report_request':
+                        (AsyncFillRateReportRequest,),
+                },
+                'attribute_map': {
+                },
+                'location_map': {
+                    'async_fill_rate_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_async_line_items_report_endpoint = _Endpoint(
             settings={
                 'response_type': (AsyncReportResponse,),
@@ -666,6 +725,89 @@ class AnalyticsApi(object):
             async_campaigns_report_request
         return self.generate_async_campaigns_report_endpoint.call_with_http_info(**kwargs)
 
+    def generate_async_fill_rate_report(
+        self,
+        async_fill_rate_report_request,
+        **kwargs
+    ):
+        """generate_async_fill_rate_report  # noqa: E501
+
+        Returns an asynchronous Fill Rate 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_fill_rate_report(async_fill_rate_report_request, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            async_fill_rate_report_request (AsyncFillRateReportRequest):
+
+        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_fill_rate_report_request'] = \
+            async_fill_rate_report_request
+        return self.generate_async_fill_rate_report_endpoint.call_with_http_info(**kwargs)
+
     def generate_async_line_items_report(
         self,
         async_line_items_report_request,

{criteo_api_retailmedia_sdk-0.0.250129 → criteo_api_retailmedia_sdk-0.0.250211}/criteo_api_retailmedia_preview/api/campaign_api.py

@@ -28,6 +28,7 @@ from criteo_api_retailmedia_preview.model.creative2_list_response import Creativ
 from criteo_api_retailmedia_preview.model.creative2_response import Creative2Response
 from criteo_api_retailmedia_preview.model.creative_create_model2 import CreativeCreateModel2
 from criteo_api_retailmedia_preview.model.creative_update_model2 import CreativeUpdateModel2
+from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_brand_id_search_result import EntityResourceCollectionOutcomeBrandIdSearchResult
 from criteo_api_retailmedia_preview.model.json_api_request_of_seller_catalog_request import JsonApiRequestOfSellerCatalogRequest
 from criteo_api_retailmedia_preview.model.json_api_single_response_of_catalog_status import JsonApiSingleResponseOfCatalogStatus
 from criteo_api_retailmedia_preview.model.json_api_single_response_of_line_item_bid_multipliers_v2 import JsonApiSingleResponseOfLineItemBidMultipliersV2
@@ -54,6 +55,7 @@ from criteo_api_retailmedia_preview.model.sku_search_request_slim_preview_reques
 from criteo_api_retailmedia_preview.model.sku_search_request_slim_v2_preview_request import SkuSearchRequestSlimV2PreviewRequest
 from criteo_api_retailmedia_preview.model.sku_slim_data_preview_list_response import SkuSlimDataPreviewListResponse
 from criteo_api_retailmedia_preview.model.sku_slim_data_v2_list_response import SkuSlimDataV2ListResponse
+from criteo_api_retailmedia_preview.model.value_resource_input_brand_id_search_request import ValueResourceInputBrandIdSearchRequest
 from criteo_api_retailmedia_preview.model.value_resource_input_cpc_min_bids_request import ValueResourceInputCpcMinBidsRequest
 from criteo_api_retailmedia_preview.model.value_resource_outcome_cpc_min_bids_response import ValueResourceOutcomeCpcMinBidsResponse
 from criteo_api_retailmedia_preview.model.value_resource_outcome_of_recommended_keywords_result import ValueResourceOutcomeOfRecommendedKeywordsResult
@@ -130,7 +132,7 @@ class CampaignApi(object):
         )
         self.append_promoted_products_endpoint = _Endpoint(
             settings={
-                'response_type': None,
+                'response_type': (ProductResourceOutcome,),
                 'auth': [
                     'oauth',
                     'oauth'
@@ -2037,6 +2039,84 @@ class CampaignApi(object):
             },
             api_client=api_client
         )
+        self.search_brands_by_name_async_v1_endpoint = _Endpoint(
+            settings={
+                'response_type': (EntityResourceCollectionOutcomeBrandIdSearchResult,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/retail-media/brands/search',
+                'operation_id': 'search_brands_by_name_async_v1',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'offset',
+                    'limit',
+                    'value_resource_input_brand_id_search_request',
+                ],
+                'required': [],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                    'offset',
+                    'limit',
+                ]
+            },
+            root_map={
+                'validations': {
+                    ('offset',): {
+
+                        'inclusive_maximum': 2147483647,
+                        'inclusive_minimum': 0,
+                    },
+                    ('limit',): {
+
+                        'inclusive_maximum': 100,
+                        'inclusive_minimum': 1,
+                    },
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'offset':
+                        (int,),
+                    'limit':
+                        (int,),
+                    'value_resource_input_brand_id_search_request':
+                        (ValueResourceInputBrandIdSearchRequest,),
+                },
+                'attribute_map': {
+                    'offset': 'offset',
+                    'limit': 'limit',
+                },
+                'location_map': {
+                    'offset': 'query',
+                    'limit': 'query',
+                    'value_resource_input_brand_id_search_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.set_keyword_bids_endpoint = _Endpoint(
             settings={
                 'response_type': (ResourceOutcome,),
@@ -2289,7 +2369,7 @@ class CampaignApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            None
+            ProductResourceOutcome
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -4870,6 +4950,87 @@ class CampaignApi(object):
             line_item_id
         return self.put_api_v2_external_line_item_bid_multipliers_by_line_item_id_endpoint.call_with_http_info(**kwargs)
 
+    def search_brands_by_name_async_v1(
+        self,
+        **kwargs
+    ):
+        """search_brands_by_name_async_v1  # noqa: E501
+
+        Search for brands given a retailer ID and search term.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.search_brands_by_name_async_v1(async_req=True)
+        >>> result = thread.get()
+
+
+        Keyword Args:
+            offset (int): offset of paginated results. [optional] if omitted the server will use the default value of 0
+            limit (int): the number of brands to return. [optional] if omitted the server will use the default value of 25
+            value_resource_input_brand_id_search_request (ValueResourceInputBrandIdSearchRequest): BrandIdSearchRequest which contains the request parameters. [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:
+            EntityResourceCollectionOutcomeBrandIdSearchResult
+                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.search_brands_by_name_async_v1_endpoint.call_with_http_info(**kwargs)
+
     def set_keyword_bids(
         self,
         id,