criteo-api-retailmedia-sdk 0.0.251014__py3-none-any.whl → 0.0.251021__py3-none-any.whl

criteo_api_retailmedia_preview/__init__.py

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

criteo_api_retailmedia_preview/api/accounts_api.py

@@ -311,7 +311,7 @@ class AccountsApi(object):
     ):
         """get_private_market_child_accounts_by_account_id  # noqa: E501
 
-        Gets page of private market child accounts that are associated with the given account  # noqa: E501
+        Gets Private Market child accounts that are associated with the given account  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 

criteo_api_retailmedia_preview/api/campaign_api.py

@@ -53,8 +53,11 @@ from criteo_api_retailmedia_preview.model.seller_preview_response import SellerP
 from criteo_api_retailmedia_preview.model.set_bids_model_request import SetBidsModelRequest
 from criteo_api_retailmedia_preview.model.sku_data_preview_list_response import SkuDataPreviewListResponse
 from criteo_api_retailmedia_preview.model.sku_search_request_preview_request import SkuSearchRequestPreviewRequest
+from criteo_api_retailmedia_preview.model.value_resource_collection_outcome_display_auction_min_bid_result import ValueResourceCollectionOutcomeDisplayAuctionMinBidResult
 from criteo_api_retailmedia_preview.model.value_resource_input_brand_id_search_request import ValueResourceInputBrandIdSearchRequest
 from criteo_api_retailmedia_preview.model.value_resource_input_categories_search_request_v1 import ValueResourceInputCategoriesSearchRequestV1
+from criteo_api_retailmedia_preview.model.value_resource_input_display_auction_min_bid_request import ValueResourceInputDisplayAuctionMinBidRequest
+from criteo_api_retailmedia_preview.model.value_resource_input_line_item_budget_cap_out_history_request import ValueResourceInputLineItemBudgetCapOutHistoryRequest
 from criteo_api_retailmedia_preview.model.value_resource_input_of_brand_catalog_request_v2 import ValueResourceInputOfBrandCatalogRequestV2
 from criteo_api_retailmedia_preview.model.value_resource_input_of_retailer_search_request import ValueResourceInputOfRetailerSearchRequest
 from criteo_api_retailmedia_preview.model.value_resource_input_of_seller_catalog_request_v2 import ValueResourceInputOfSellerCatalogRequestV2
@@ -63,6 +66,7 @@ from criteo_api_retailmedia_preview.model.value_resource_input_of_sponsored_prod
 from criteo_api_retailmedia_preview.model.value_resource_input_recommended_categories_request_v1 import ValueResourceInputRecommendedCategoriesRequestV1
 from criteo_api_retailmedia_preview.model.value_resource_input_recommended_keywords_request_v1 import ValueResourceInputRecommendedKeywordsRequestV1
 from criteo_api_retailmedia_preview.model.value_resource_input_retail_media_keywords_review import ValueResourceInputRetailMediaKeywordsReview
+from criteo_api_retailmedia_preview.model.value_resource_outcome_line_item_budget_cap_out_history_response import ValueResourceOutcomeLineItemBudgetCapOutHistoryResponse
 from criteo_api_retailmedia_preview.model.value_resource_outcome_recommended_keywords_response_v1 import ValueResourceOutcomeRecommendedKeywordsResponseV1
 from criteo_api_retailmedia_preview.model.value_resource_outcome_retail_media_keywords_review_result import ValueResourceOutcomeRetailMediaKeywordsReviewResult
 
@@ -253,6 +257,64 @@ class CampaignApi(object):
             },
             api_client=api_client
         )
+        self.compute_display_min_bid_by_retailer_id_endpoint = _Endpoint(
+            settings={
+                'response_type': (ValueResourceCollectionOutcomeDisplayAuctionMinBidResult,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/retail-media/retailers/{retailerId}/compute-display-min-bid',
+                'operation_id': 'compute_display_min_bid_by_retailer_id',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'retailer_id',
+                    'value_resource_input_display_auction_min_bid_request',
+                ],
+                'required': [
+                    'retailer_id',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'retailer_id':
+                        (int,),
+                    'value_resource_input_display_auction_min_bid_request':
+                        (ValueResourceInputDisplayAuctionMinBidRequest,),
+                },
+                'attribute_map': {
+                    'retailer_id': 'retailerId',
+                },
+                'location_map': {
+                    'retailer_id': 'path',
+                    'value_resource_input_display_auction_min_bid_request': 'body',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [
+                    'application/json'
+                ]
+            },
+            api_client=api_client
+        )
         self.create_auction_line_item_v2_endpoint = _Endpoint(
             settings={
                 'response_type': (EntityResourceOutcomeOfSponsoredProductsLineItem,),
@@ -1023,9 +1085,9 @@ class CampaignApi(object):
             params_map={
                 'all': [
                     'campaign_id',
-                    'limit_to_id',
-                    'page_index',
-                    'page_size',
+                    'limit',
+                    'limit_to_ids',
+                    'offset',
                 ],
                 'required': [
                     'campaign_id',
@@ -1035,21 +1097,21 @@ class CampaignApi(object):
                 'enum': [
                 ],
                 'validation': [
-                    'page_index',
-                    'page_size',
+                    'limit',
+                    'offset',
                 ]
             },
             root_map={
                 'validations': {
-                    ('page_index',): {
+                    ('limit',): {
 
-                        'inclusive_maximum': 2147483647,
-                        'inclusive_minimum': 0,
+                        'inclusive_maximum': 500,
+                        'inclusive_minimum': 1,
                     },
-                    ('page_size',): {
+                    ('offset',): {
 
                         'inclusive_maximum': 2147483647,
-                        'inclusive_minimum': 1,
+                        'inclusive_minimum': 0,
                     },
                 },
                 'allowed_values': {
@@ -1057,27 +1119,27 @@ class CampaignApi(object):
                 'openapi_types': {
                     'campaign_id':
                         (str,),
-                    'limit_to_id':
-                        ([str],),
-                    'page_index':
+                    'limit':
                         (int,),
-                    'page_size':
+                    'limit_to_ids':
+                        ([str],),
+                    'offset':
                         (int,),
                 },
                 'attribute_map': {
                     'campaign_id': 'campaignId',
-                    'limit_to_id': 'limitToId',
-                    'page_index': 'pageIndex',
-                    'page_size': 'pageSize',
+                    'limit': 'limit',
+                    'limit_to_ids': 'limitToIds',
+                    'offset': 'offset',
                 },
                 'location_map': {
                     'campaign_id': 'path',
-                    'limit_to_id': 'query',
-                    'page_index': 'query',
-                    'page_size': 'query',
+                    'limit': 'query',
+                    'limit_to_ids': 'query',
+                    'offset': 'query',
                 },
                 'collection_format_map': {
-                    'limit_to_id': 'multi',
+                    'limit_to_ids': 'multi',
                 }
             },
             headers_map={
@@ -1088,6 +1150,65 @@ class CampaignApi(object):
             },
             api_client=api_client
         )
+        self.get_capout_history_endpoint = _Endpoint(
+            settings={
+                'response_type': (ValueResourceOutcomeLineItemBudgetCapOutHistoryResponse,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/retail-media/accounts/{account-id}/line-items/cap-out-history',
+                'operation_id': 'get_capout_history',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'account_id',
+                    'value_resource_input_line_item_budget_cap_out_history_request',
+                ],
+                'required': [
+                    'account_id',
+                    'value_resource_input_line_item_budget_cap_out_history_request',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'account_id':
+                        (str,),
+                    'value_resource_input_line_item_budget_cap_out_history_request':
+                        (ValueResourceInputLineItemBudgetCapOutHistoryRequest,),
+                },
+                'attribute_map': {
+                    'account_id': 'account-id',
+                },
+                'location_map': {
+                    'account_id': 'path',
+                    'value_resource_input_line_item_budget_cap_out_history_request': 'body',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [
+                    'application/json'
+                ]
+            },
+            api_client=api_client
+        )
         self.get_creative_endpoint = _Endpoint(
             settings={
                 'response_type': (Creative2Response,),
@@ -2863,6 +2984,90 @@ class CampaignApi(object):
             line_item_id
         return self.append_promoted_products_endpoint.call_with_http_info(**kwargs)
 
+    def compute_display_min_bid_by_retailer_id(
+        self,
+        retailer_id,
+        **kwargs
+    ):
+        """compute_display_min_bid_by_retailer_id  # noqa: E501
+
+        computes the min bid for relevant page types based on the provided information  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.compute_display_min_bid_by_retailer_id(retailer_id, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            retailer_id (int): the retailer id
+
+        Keyword Args:
+            value_resource_input_display_auction_min_bid_request (ValueResourceInputDisplayAuctionMinBidRequest): the details for what cratives and product ids to use to compute the min bids. [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:
+            ValueResourceCollectionOutcomeDisplayAuctionMinBidResult
+                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['retailer_id'] = \
+            retailer_id
+        return self.compute_display_min_bid_by_retailer_id_endpoint.call_with_http_info(**kwargs)
+
     def create_auction_line_item_v2(
         self,
         campaign_id,
@@ -3978,9 +4183,9 @@ class CampaignApi(object):
             campaign_id (str): The id of the campaign
 
         Keyword Args:
-            limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
-            page_index (int): The 0 indexed page index you would like to receive given the page size. [optional] if omitted the server will use the default value of 0
-            page_size (int): The maximum number of items you would like to receive in this request. [optional] if omitted the server will use the default value of 25
+            limit (int): The number of elements to be returned on a page.. [optional] if omitted the server will use the default value of 25
+            limit_to_ids ([str]): The ids to limit the auction line item results to. [optional]
+            offset (int): The (zero-based) starting offset into 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
@@ -4046,6 +4251,93 @@ class CampaignApi(object):
             campaign_id
         return self.get_auction_line_items_by_campaign_id_v2_endpoint.call_with_http_info(**kwargs)
 
+    def get_capout_history(
+        self,
+        account_id,
+        value_resource_input_line_item_budget_cap_out_history_request,
+        **kwargs
+    ):
+        """get_capout_history  # noqa: E501
+
+        Get the cap out history for line items  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.get_capout_history(account_id, value_resource_input_line_item_budget_cap_out_history_request, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            account_id (str): account id that own the lineitem
+            value_resource_input_line_item_budget_cap_out_history_request (ValueResourceInputLineItemBudgetCapOutHistoryRequest): lineitem budgetcapout history  object
+
+        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:
+            ValueResourceOutcomeLineItemBudgetCapOutHistoryResponse
+                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
+        kwargs['value_resource_input_line_item_budget_cap_out_history_request'] = \
+            value_resource_input_line_item_budget_cap_out_history_request
+        return self.get_capout_history_endpoint.call_with_http_info(**kwargs)
+
     def get_creative(
         self,
         account_id,