criteo-api-retailmedia-sdk 0.0.250320__tar.gz → 0.0.250327__tar.gz

{criteo_api_retailmedia_sdk-0.0.250320 → criteo_api_retailmedia_sdk-0.0.250327}/PKG-INFO

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

{criteo_api_retailmedia_sdk-0.0.250320 → criteo_api_retailmedia_sdk-0.0.250327}/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.250320
+- Package version: 0.0.250327
 
 ## Requirements
 
@@ -18,9 +18,9 @@ Python 2.7 and 3.5+
 ### pip install
 
 ```sh
-pip install criteo-api-retailmedia-sdk==0.0.250320
+pip install criteo-api-retailmedia-sdk==0.0.250327
 ```
-(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==0.0.250320`)
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==0.0.250327`)
 
 Then import the package:
 ```python
@@ -104,6 +104,7 @@ Class | Method | HTTP request | Description
 *CampaignApi* | [**get_api_v2_external_preferred_line_item_by_line_item_id**](docs/CampaignApi.md#get_api_v2_external_preferred_line_item_by_line_item_id) | **GET** /preview/retail-media/preferred-line-items/{line-item-id} | 
 *CampaignApi* | [**get_cpc_min_bids_by_sku_ids_v1**](docs/CampaignApi.md#get_cpc_min_bids_by_sku_ids_v1) | **POST** /preview/retail-media/retailers/{retailerId}/cpc-min-bids | 
 *CampaignApi* | [**get_recommended_keywords**](docs/CampaignApi.md#get_recommended_keywords) | **GET** /preview/retail-media/line-items/{externalLineItemId}/keywords/recommended | 
+*CampaignApi* | [**in_review_report_v1**](docs/CampaignApi.md#in_review_report_v1) | **GET** /preview/retail-media/accounts/{account-id}/keywords/in-review-report | 
 *CampaignApi* | [**pause_promoted_products**](docs/CampaignApi.md#pause_promoted_products) | **POST** /preview/retail-media/line-items/{line-item-id}/products/pause | 
 *CampaignApi* | [**post_api202110_external_campaign_preferred_line_items_by_campaign_id**](docs/CampaignApi.md#post_api202110_external_campaign_preferred_line_items_by_campaign_id) | **POST** /preview/retail-media/campaigns/{campaign-id}/preferred-line-items | 
 *CampaignApi* | [**post_api202210_external_line_item_product_buttons_create_by_line_item_id**](docs/CampaignApi.md#post_api202210_external_line_item_product_buttons_create_by_line_item_id) | **POST** /preview/retail-media/line-items/{line-item-id}/product-buttons/create | 
@@ -122,6 +123,7 @@ Class | Method | HTTP request | Description
 *CampaignApi* | [**search_brands_by_name_async_v1**](docs/CampaignApi.md#search_brands_by_name_async_v1) | **POST** /preview/retail-media/brands/search | 
 *CampaignApi* | [**set_keyword_bids**](docs/CampaignApi.md#set_keyword_bids) | **POST** /preview/retail-media/line-items/{id}/keywords/set-bid | 
 *CampaignApi* | [**unpause_promoted_products**](docs/CampaignApi.md#unpause_promoted_products) | **POST** /preview/retail-media/line-items/{line-item-id}/products/unpause | 
+*CampaignApi* | [**update_keyword_reviews_v1**](docs/CampaignApi.md#update_keyword_reviews_v1) | **POST** /preview/retail-media/line-items/{line-item-id}/keywords/review | 
 *CatalogApi* | [**preview_retail_media_catalog_products_batch_post**](docs/CatalogApi.md#preview_retail_media_catalog_products_batch_post) | **POST** /preview/retail-media/catalog/products/batch | 
 *CatalogApi* | [**preview_retail_media_catalog_products_batch_report_operation_token_get**](docs/CatalogApi.md#preview_retail_media_catalog_products_batch_report_operation_token_get) | **GET** /preview/retail-media/catalog/products/batch/report/{operation-token} | 
 *GatewayApi* | [**get_current_application**](docs/GatewayApi.md#get_current_application) | **GET** /preview/retail-media/me | 
@@ -189,7 +191,9 @@ Class | Method | HTTP request | Description
  - [CustomAttribute](docs/CustomAttribute.md)
  - [EntityResourceBrandIdSearchResult](docs/EntityResourceBrandIdSearchResult.md)
  - [EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata](docs/EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata.md)
+ - [EntityResourceCollectionOutcomeLineItemKeywordReviewReportAndMetadata](docs/EntityResourceCollectionOutcomeLineItemKeywordReviewReportAndMetadata.md)
  - [EntityResourceCollectionOutcomeOfRetailMediaChildAccountAndMetadata](docs/EntityResourceCollectionOutcomeOfRetailMediaChildAccountAndMetadata.md)
+ - [EntityResourceLineItemKeywordReviewReport](docs/EntityResourceLineItemKeywordReviewReport.md)
  - [EntityResourceOfRetailMediaChildAccount](docs/EntityResourceOfRetailMediaChildAccount.md)
  - [EntityResourceOutcomePartnerBillingReportStatusV1](docs/EntityResourceOutcomePartnerBillingReportStatusV1.md)
  - [EntityResourcePartnerBillingReportStatusV1](docs/EntityResourcePartnerBillingReportStatusV1.md)
@@ -232,6 +236,7 @@ Class | Method | HTTP request | Description
  - [KeywordsModelResponse](docs/KeywordsModelResponse.md)
  - [LineItemBidMultipliersV2Request](docs/LineItemBidMultipliersV2Request.md)
  - [LineItemBidMultipliersV2Response](docs/LineItemBidMultipliersV2Response.md)
+ - [LineItemKeywordReviewReport](docs/LineItemKeywordReviewReport.md)
  - [LineItemProductStatus](docs/LineItemProductStatus.md)
  - [LoyaltyPoints](docs/LoyaltyPoints.md)
  - [MatchTypeModel](docs/MatchTypeModel.md)
@@ -314,7 +319,10 @@ Class | Method | HTTP request | Description
  - [RetailMediaContactlistAmendmentRequest](docs/RetailMediaContactlistAmendmentRequest.md)
  - [RetailMediaContactlistOperation](docs/RetailMediaContactlistOperation.md)
  - [RetailMediaContactlistOperationResponseAttributes](docs/RetailMediaContactlistOperationResponseAttributes.md)
+ - [RetailMediaKeywordsReview](docs/RetailMediaKeywordsReview.md)
+ - [RetailMediaKeywordsReviewResult](docs/RetailMediaKeywordsReviewResult.md)
  - [RetailMediaSeller](docs/RetailMediaSeller.md)
+ - [ReviewSetState](docs/ReviewSetState.md)
  - [ReviewStateModel](docs/ReviewStateModel.md)
  - [RmAlgebraNodeV1](docs/RmAlgebraNodeV1.md)
  - [RmAudienceEntityV1](docs/RmAudienceEntityV1.md)
@@ -396,12 +404,16 @@ Class | Method | HTTP request | Description
  - [ValueResourceInputCpcMinBidsRequest](docs/ValueResourceInputCpcMinBidsRequest.md)
  - [ValueResourceInputOfSellerSearch](docs/ValueResourceInputOfSellerSearch.md)
  - [ValueResourceInputPartnerBillingReportRequestV1](docs/ValueResourceInputPartnerBillingReportRequestV1.md)
+ - [ValueResourceInputRetailMediaKeywordsReview](docs/ValueResourceInputRetailMediaKeywordsReview.md)
  - [ValueResourceOfRecommendedKeywordsResult](docs/ValueResourceOfRecommendedKeywordsResult.md)
  - [ValueResourceOfSellerSearch](docs/ValueResourceOfSellerSearch.md)
  - [ValueResourceOfSellerSearchResult](docs/ValueResourceOfSellerSearchResult.md)
  - [ValueResourceOutcomeCpcMinBidsResponse](docs/ValueResourceOutcomeCpcMinBidsResponse.md)
  - [ValueResourceOutcomeOfRecommendedKeywordsResult](docs/ValueResourceOutcomeOfRecommendedKeywordsResult.md)
+ - [ValueResourceOutcomeRetailMediaKeywordsReviewResult](docs/ValueResourceOutcomeRetailMediaKeywordsReviewResult.md)
  - [ValueResourcePartnerBillingReportRequestV1](docs/ValueResourcePartnerBillingReportRequestV1.md)
+ - [ValueResourceRetailMediaKeywordsReview](docs/ValueResourceRetailMediaKeywordsReview.md)
+ - [ValueResourceRetailMediaKeywordsReviewResult](docs/ValueResourceRetailMediaKeywordsReviewResult.md)
  - [VideoVariableValue](docs/VideoVariableValue.md)
 
 

{criteo_api_retailmedia_sdk-0.0.250320 → criteo_api_retailmedia_sdk-0.0.250327}/criteo_api_retailmedia_preview/__init__.py

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

{criteo_api_retailmedia_sdk-0.0.250320 → criteo_api_retailmedia_sdk-0.0.250327}/criteo_api_retailmedia_preview/api/campaign_api.py

@@ -30,6 +30,7 @@ from criteo_api_retailmedia_preview.model.creative2_response import Creative2Res
 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_paging_offset_limit_metadata import EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata
+from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_line_item_keyword_review_report_and_metadata import EntityResourceCollectionOutcomeLineItemKeywordReviewReportAndMetadata
 from criteo_api_retailmedia_preview.model.json_api_request_of_brand_catalog_request_v2 import JsonApiRequestOfBrandCatalogRequestV2
 from criteo_api_retailmedia_preview.model.json_api_request_of_seller_catalog_request_v2 import JsonApiRequestOfSellerCatalogRequestV2
 from criteo_api_retailmedia_preview.model.json_api_single_response_of_line_item_bid_multipliers_v2 import JsonApiSingleResponseOfLineItemBidMultipliersV2
@@ -58,8 +59,10 @@ from criteo_api_retailmedia_preview.model.sku_slim_data_preview_list_response im
 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_input_retail_media_keywords_review import ValueResourceInputRetailMediaKeywordsReview
 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
+from criteo_api_retailmedia_preview.model.value_resource_outcome_retail_media_keywords_review_result import ValueResourceOutcomeRetailMediaKeywordsReviewResult
 
 
 class CampaignApi(object):
@@ -1179,6 +1182,82 @@ class CampaignApi(object):
             },
             api_client=api_client
         )
+        self.in_review_report_v1_endpoint = _Endpoint(
+            settings={
+                'response_type': (EntityResourceCollectionOutcomeLineItemKeywordReviewReportAndMetadata,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/retail-media/accounts/{account-id}/keywords/in-review-report',
+                'operation_id': 'in_review_report_v1',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'account_id',
+                    'offset',
+                    'limit',
+                ],
+                'required': [
+                    'account_id',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                    'offset',
+                    'limit',
+                ]
+            },
+            root_map={
+                'validations': {
+                    ('offset',): {
+
+                        'inclusive_maximum': 2147483647,
+                        'inclusive_minimum': 0,
+                    },
+                    ('limit',): {
+
+                        'inclusive_maximum': 50,
+                        'inclusive_minimum': 1,
+                    },
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'account_id':
+                        (int,),
+                    'offset':
+                        (int,),
+                    'limit':
+                        (int,),
+                },
+                'attribute_map': {
+                    'account_id': 'account-id',
+                    'offset': 'offset',
+                    'limit': 'limit',
+                },
+                'location_map': {
+                    'account_id': 'path',
+                    'offset': 'query',
+                    'limit': 'query',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'text/plain',
+                    'application/json',
+                    'text/json'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
         self.pause_promoted_products_endpoint = _Endpoint(
             settings={
                 'response_type': None,
@@ -2349,6 +2428,69 @@ class CampaignApi(object):
             },
             api_client=api_client
         )
+        self.update_keyword_reviews_v1_endpoint = _Endpoint(
+            settings={
+                'response_type': (ValueResourceOutcomeRetailMediaKeywordsReviewResult,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/keywords/review',
+                'operation_id': 'update_keyword_reviews_v1',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'line_item_id',
+                    'value_resource_input_retail_media_keywords_review',
+                ],
+                'required': [
+                    'line_item_id',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'line_item_id':
+                        (int,),
+                    'value_resource_input_retail_media_keywords_review':
+                        (ValueResourceInputRetailMediaKeywordsReview,),
+                },
+                'attribute_map': {
+                    'line_item_id': 'line-item-id',
+                },
+                'location_map': {
+                    'line_item_id': 'path',
+                    'value_resource_input_retail_media_keywords_review': '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
+        )
 
     def add_remove_keywords(
         self,
@@ -3956,6 +4098,91 @@ class CampaignApi(object):
             external_line_item_id
         return self.get_recommended_keywords_endpoint.call_with_http_info(**kwargs)
 
+    def in_review_report_v1(
+        self,
+        account_id,
+        **kwargs
+    ):
+        """in_review_report_v1  # noqa: E501
+
+        Generate a list of reports for line items which contain one or more actionable keyword reviews  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.in_review_report_v1(account_id, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            account_id (int): The account to generate a report for
+
+        Keyword Args:
+            offset (int): Offset for pagination. [optional] if omitted the server will use the default value of 0
+            limit (int): Number of items per page. [optional] if omitted the server will use the default value of 25
+            _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:
+            EntityResourceCollectionOutcomeLineItemKeywordReviewReportAndMetadata
+                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.in_review_report_v1_endpoint.call_with_http_info(**kwargs)
+
     def pause_promoted_products(
         self,
         line_item_id,
@@ -5482,3 +5709,87 @@ class CampaignApi(object):
             line_item_id
         return self.unpause_promoted_products_endpoint.call_with_http_info(**kwargs)
 
+    def update_keyword_reviews_v1(
+        self,
+        line_item_id,
+        **kwargs
+    ):
+        """update_keyword_reviews_v1  # noqa: E501
+
+        Update the status of keyword reviews under a line item  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.update_keyword_reviews_v1(line_item_id, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            line_item_id (int): The line item to update keyword review statuses for
+
+        Keyword Args:
+            value_resource_input_retail_media_keywords_review (ValueResourceInputRetailMediaKeywordsReview): Request object containing a list of Phrase-ReviewState pairs to update. [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:
+            ValueResourceOutcomeRetailMediaKeywordsReviewResult
+                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['line_item_id'] = \
+            line_item_id
+        return self.update_keyword_reviews_v1_endpoint.call_with_http_info(**kwargs)
+

{criteo_api_retailmedia_sdk-0.0.250320 → criteo_api_retailmedia_sdk-0.0.250327}/criteo_api_retailmedia_preview/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/0.0.250320/python'
+        self.user_agent = 'OpenAPI-Generator/0.0.250327/python'
 
     def __enter__(self):
         return self

{criteo_api_retailmedia_sdk-0.0.250320 → criteo_api_retailmedia_sdk-0.0.250327}/criteo_api_retailmedia_preview/configuration.py

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