criteo-api-retailmedia-sdk 0.0.251014__tar.gz → 0.0.251015__tar.gz

{criteo_api_retailmedia_sdk-0.0.251014 → criteo_api_retailmedia_sdk-0.0.251015}/PKG-INFO

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

{criteo_api_retailmedia_sdk-0.0.251014 → criteo_api_retailmedia_sdk-0.0.251015}/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.251014
+- Package version: 0.0.251015
 
 ## Requirements
 
@@ -18,9 +18,9 @@ Python 2.7 and 3.5+
 ### pip install
 
 ```sh
-pip install criteo-api-retailmedia-sdk==0.0.251014
+pip install criteo-api-retailmedia-sdk==0.0.251015
 ```
-(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==0.0.251014`)
+(you may need to run `pip` with root permission: `sudo pip install criteo-api-retailmedia-sdk==0.0.251015`)
 
 Then import the package:
 ```python
@@ -111,6 +111,7 @@ Class | Method | HTTP request | Description
 *CampaignApi* | [**get_api_v1_external_retailer_placements_by_retailer_id**](docs/CampaignApi.md#get_api_v1_external_retailer_placements_by_retailer_id) | **GET** /preview/retail-media/retailers/{retailer-id}/placements | 
 *CampaignApi* | [**get_auction_line_item_v2**](docs/CampaignApi.md#get_auction_line_item_v2) | **GET** /preview/retail-media/auction-line-items/{lineItemId} | 
 *CampaignApi* | [**get_auction_line_items_by_campaign_id_v2**](docs/CampaignApi.md#get_auction_line_items_by_campaign_id_v2) | **GET** /preview/retail-media/campaigns/{campaignId}/auction-line-items | 
+*CampaignApi* | [**get_capout_history**](docs/CampaignApi.md#get_capout_history) | **POST** /preview/retail-media/accounts/{account-id}/line-items/cap-out-history | 
 *CampaignApi* | [**get_creative**](docs/CampaignApi.md#get_creative) | **GET** /preview/retail-media/accounts/{account-id}/creatives/{creative-id} | 
 *CampaignApi* | [**get_preferred_line_items_by_campaign_id**](docs/CampaignApi.md#get_preferred_line_items_by_campaign_id) | **GET** /preview/retail-media/campaigns/{campaign-id}/preferred-line-items | 
 *CampaignApi* | [**get_preferred_line_items_by_line_item_id**](docs/CampaignApi.md#get_preferred_line_items_by_line_item_id) | **GET** /preview/retail-media/preferred-line-items/{line-item-id} | 
@@ -244,6 +245,10 @@ Class | Method | HTTP request | Description
  - [KeywordsModel](docs/KeywordsModel.md)
  - [KeywordsModelResource](docs/KeywordsModelResource.md)
  - [KeywordsModelResponse](docs/KeywordsModelResponse.md)
+ - [LineItemBudgetCapOutHistory](docs/LineItemBudgetCapOutHistory.md)
+ - [LineItemBudgetCapOutHistoryCapoutTimes](docs/LineItemBudgetCapOutHistoryCapoutTimes.md)
+ - [LineItemBudgetCapOutHistoryRequest](docs/LineItemBudgetCapOutHistoryRequest.md)
+ - [LineItemBudgetCapOutHistoryResponse](docs/LineItemBudgetCapOutHistoryResponse.md)
  - [LineItemCappingV2](docs/LineItemCappingV2.md)
  - [LineItemKeywordReviewReport](docs/LineItemKeywordReviewReport.md)
  - [LineItemPageCategoryV2](docs/LineItemPageCategoryV2.md)
@@ -454,6 +459,7 @@ Class | Method | HTTP request | Description
  - [ValueResourceInputAccountFeesUpdateRequest](docs/ValueResourceInputAccountFeesUpdateRequest.md)
  - [ValueResourceInputBrandIdSearchRequest](docs/ValueResourceInputBrandIdSearchRequest.md)
  - [ValueResourceInputCategoriesSearchRequestV1](docs/ValueResourceInputCategoriesSearchRequestV1.md)
+ - [ValueResourceInputLineItemBudgetCapOutHistoryRequest](docs/ValueResourceInputLineItemBudgetCapOutHistoryRequest.md)
  - [ValueResourceInputLoadSkuOffersRequest](docs/ValueResourceInputLoadSkuOffersRequest.md)
  - [ValueResourceInputOfBrandCatalogRequestV2](docs/ValueResourceInputOfBrandCatalogRequestV2.md)
  - [ValueResourceInputOfRetailerSearchRequest](docs/ValueResourceInputOfRetailerSearchRequest.md)
@@ -466,6 +472,8 @@ Class | Method | HTTP request | Description
  - [ValueResourceInputRetailMediaKeywordsReview](docs/ValueResourceInputRetailMediaKeywordsReview.md)
  - [ValueResourceInputSetSkuBuyBoxWinnersRequest](docs/ValueResourceInputSetSkuBuyBoxWinnersRequest.md)
  - [ValueResourceInputUpdateOffersRequest](docs/ValueResourceInputUpdateOffersRequest.md)
+ - [ValueResourceLineItemBudgetCapOutHistoryRequest](docs/ValueResourceLineItemBudgetCapOutHistoryRequest.md)
+ - [ValueResourceLineItemBudgetCapOutHistoryResponse](docs/ValueResourceLineItemBudgetCapOutHistoryResponse.md)
  - [ValueResourceLoadSkuOffersRequest](docs/ValueResourceLoadSkuOffersRequest.md)
  - [ValueResourceOfBrandCatalogRequestV2](docs/ValueResourceOfBrandCatalogRequestV2.md)
  - [ValueResourceOfRetailerSearchRequest](docs/ValueResourceOfRetailerSearchRequest.md)
@@ -473,6 +481,7 @@ Class | Method | HTTP request | Description
  - [ValueResourceOfSponsoredProductsLineItemCreateRequestModel](docs/ValueResourceOfSponsoredProductsLineItemCreateRequestModel.md)
  - [ValueResourceOfSponsoredProductsLineItemUpdateRequestModel](docs/ValueResourceOfSponsoredProductsLineItemUpdateRequestModel.md)
  - [ValueResourceOutcomeAsyncJobResponse](docs/ValueResourceOutcomeAsyncJobResponse.md)
+ - [ValueResourceOutcomeLineItemBudgetCapOutHistoryResponse](docs/ValueResourceOutcomeLineItemBudgetCapOutHistoryResponse.md)
  - [ValueResourceOutcomeRecommendedKeywordsResponseV1](docs/ValueResourceOutcomeRecommendedKeywordsResponseV1.md)
  - [ValueResourceOutcomeRetailMediaKeywordsReviewResult](docs/ValueResourceOutcomeRetailMediaKeywordsReviewResult.md)
  - [ValueResourcePartnerBillingReportRequestV1](docs/ValueResourcePartnerBillingReportRequestV1.md)

{criteo_api_retailmedia_sdk-0.0.251014 → criteo_api_retailmedia_sdk-0.0.251015}/criteo_api_retailmedia_preview/__init__.py

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

{criteo_api_retailmedia_sdk-0.0.251014 → criteo_api_retailmedia_sdk-0.0.251015}/criteo_api_retailmedia_preview/api/campaign_api.py

@@ -55,6 +55,7 @@ from criteo_api_retailmedia_preview.model.sku_data_preview_list_response import
 from criteo_api_retailmedia_preview.model.sku_search_request_preview_request import SkuSearchRequestPreviewRequest
 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_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 +64,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
 
@@ -1023,9 +1025,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 +1037,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 +1059,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 +1090,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,),
@@ -3978,9 +4039,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 +4107,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,

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

{criteo_api_retailmedia_sdk-0.0.251014 → criteo_api_retailmedia_sdk-0.0.251015}/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.251014".\
+               "SDK Package Version: 0.0.251015".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

{criteo_api_retailmedia_sdk-0.0.251014 → criteo_api_retailmedia_sdk-0.0.251015}/criteo_api_retailmedia_preview/model/campaign_availability.py

@@ -63,15 +63,15 @@ class CampaignAvailability(ModelNormal):
             'None': None,
             'UNKNOWN': "unknown",
             'AUCTION': "auction",
-            'PREFERREDDEALS': "preferreddeals",
+            'PREFERREDDEALS': "preferredDeals",
             'SPONSORSHIP': "sponsorship",
             'OFFSITE': "offsite",
         },
         ('campaign_type',): {
             'None': None,
             'UNKNOWN': "unknown",
-            'SPONSOREDPRODUCTS': "sponsoredproducts",
-            'ONSITEDISPLAY': "onsitedisplay",
+            'SPONSOREDPRODUCTS': "sponsoredProducts",
+            'ONSITEDISPLAY': "onsiteDisplay",
             'OFFSITE': "offsite",
         },
     }