criteo-api-retailmedia-sdk 0.0.240626__py3-none-any.whl → 0.0.240808__py3-none-any.whl

criteo_api_retailmedia_preview/__init__.py

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

criteo_api_retailmedia_preview/api/accounts_api.py

@@ -22,13 +22,11 @@ from criteo_api_retailmedia_preview.model_utils import (  # noqa: F401
     validate_and_convert_types
 )
 from criteo_api_retailmedia_preview.model.grant_consent_input import GrantConsentInput
+from criteo_api_retailmedia_preview.model.json_api_page_response_of_account import JsonApiPageResponseOfAccount
 from criteo_api_retailmedia_preview.model.resource_outcome_of_retail_media_account import ResourceOutcomeOfRetailMediaAccount
 from criteo_api_retailmedia_preview.model.value_resource_collection_input_of_retail_media_seller import ValueResourceCollectionInputOfRetailMediaSeller
 from criteo_api_retailmedia_preview.model.value_resource_collection_outcome_of_retail_media_seller import ValueResourceCollectionOutcomeOfRetailMediaSeller
-from criteo_api_retailmedia_preview.model.value_resource_input_of_retail_media_brand_account_creation import ValueResourceInputOfRetailMediaBrandAccountCreation
-from criteo_api_retailmedia_preview.model.value_resource_input_of_retail_media_brands import ValueResourceInputOfRetailMediaBrands
 from criteo_api_retailmedia_preview.model.value_resource_input_of_retail_media_seller_account_creation import ValueResourceInputOfRetailMediaSellerAccountCreation
-from criteo_api_retailmedia_preview.model.value_resource_of_retail_media_brands import ValueResourceOfRetailMediaBrands
 
 
 class AccountsApi(object):
@@ -42,83 +40,22 @@ class AccountsApi(object):
         if api_client is None:
             api_client = ApiClient()
         self.api_client = api_client
-        self.add_brands_endpoint = _Endpoint(
-            settings={
-                'response_type': (ValueResourceOfRetailMediaBrands,),
-                'auth': [
-                    'oauth',
-                    'oauth'
-                ],
-                'endpoint_path': '/preview/retail-media/account-management/accounts/{accountId}/brands/add',
-                'operation_id': 'add_brands',
-                'http_method': 'POST',
-                'servers': None,
-            },
-            params_map={
-                'all': [
-                    'account_id',
-                    'value_resource_input_of_retail_media_brands',
-                ],
-                'required': [
-                    'account_id',
-                ],
-                'nullable': [
-                ],
-                'enum': [
-                ],
-                'validation': [
-                ]
-            },
-            root_map={
-                'validations': {
-                },
-                'allowed_values': {
-                },
-                'openapi_types': {
-                    'account_id':
-                        (str,),
-                    'value_resource_input_of_retail_media_brands':
-                        (ValueResourceInputOfRetailMediaBrands,),
-                },
-                'attribute_map': {
-                    'account_id': 'accountId',
-                },
-                'location_map': {
-                    'account_id': 'path',
-                    'value_resource_input_of_retail_media_brands': 'body',
-                },
-                'collection_format_map': {
-                }
-            },
-            headers_map={
-                'accept': [
-                    'application/json'
-                ],
-                'content_type': [
-                    'application/json-patch+json',
-                    'application/json',
-                    'text/json',
-                    'application/*+json'
-                ]
-            },
-            api_client=api_client
-        )
-        self.create_private_market_demand_brand_account_endpoint = _Endpoint(
+        self.create_private_market_demand_seller_account_endpoint = _Endpoint(
             settings={
                 'response_type': (ResourceOutcomeOfRetailMediaAccount,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/preview/retail-media/account-management/accounts/{accountId}/create-brand-account',
-                'operation_id': 'create_private_market_demand_brand_account',
+                'endpoint_path': '/preview/retail-media/account-management/accounts/{accountId}/create-seller-account',
+                'operation_id': 'create_private_market_demand_seller_account',
                 'http_method': 'POST',
                 'servers': None,
             },
             params_map={
                 'all': [
                     'account_id',
-                    'value_resource_input_of_retail_media_brand_account_creation',
+                    'value_resource_input_of_retail_media_seller_account_creation',
                 ],
                 'required': [
                     'account_id',
@@ -138,15 +75,15 @@ class AccountsApi(object):
                 'openapi_types': {
                     'account_id':
                         (str,),
-                    'value_resource_input_of_retail_media_brand_account_creation':
-                        (ValueResourceInputOfRetailMediaBrandAccountCreation,),
+                    'value_resource_input_of_retail_media_seller_account_creation':
+                        (ValueResourceInputOfRetailMediaSellerAccountCreation,),
                 },
                 'attribute_map': {
                     'account_id': 'accountId',
                 },
                 'location_map': {
                     'account_id': 'path',
-                    'value_resource_input_of_retail_media_brand_account_creation': 'body',
+                    'value_resource_input_of_retail_media_seller_account_creation': 'body',
                 },
                 'collection_format_map': {
                 }
@@ -164,26 +101,25 @@ class AccountsApi(object):
             },
             api_client=api_client
         )
-        self.create_private_market_demand_seller_account_endpoint = _Endpoint(
+        self.get_api_v1_external_accounts_endpoint = _Endpoint(
             settings={
-                'response_type': (ResourceOutcomeOfRetailMediaAccount,),
+                'response_type': (JsonApiPageResponseOfAccount,),
                 'auth': [
                     'oauth',
                     'oauth'
                 ],
-                'endpoint_path': '/preview/retail-media/account-management/accounts/{accountId}/create-seller-account',
-                'operation_id': 'create_private_market_demand_seller_account',
-                'http_method': 'POST',
+                'endpoint_path': '/preview/retail-media/accounts',
+                'operation_id': 'get_api_v1_external_accounts',
+                'http_method': 'GET',
                 'servers': None,
             },
             params_map={
                 'all': [
-                    'account_id',
-                    'value_resource_input_of_retail_media_seller_account_creation',
-                ],
-                'required': [
-                    'account_id',
+                    'limit_to_id',
+                    'page_index',
+                    'page_size',
                 ],
+                'required': [],
                 'nullable': [
                 ],
                 'enum': [
@@ -197,31 +133,34 @@ class AccountsApi(object):
                 'allowed_values': {
                 },
                 'openapi_types': {
-                    'account_id':
-                        (str,),
-                    'value_resource_input_of_retail_media_seller_account_creation':
-                        (ValueResourceInputOfRetailMediaSellerAccountCreation,),
+                    'limit_to_id':
+                        ([str],),
+                    'page_index':
+                        (int,),
+                    'page_size':
+                        (int,),
                 },
                 'attribute_map': {
-                    'account_id': 'accountId',
+                    'limit_to_id': 'limitToId',
+                    'page_index': 'pageIndex',
+                    'page_size': 'pageSize',
                 },
                 'location_map': {
-                    'account_id': 'path',
-                    'value_resource_input_of_retail_media_seller_account_creation': 'body',
+                    'limit_to_id': 'query',
+                    'page_index': 'query',
+                    'page_size': 'query',
                 },
                 'collection_format_map': {
+                    'limit_to_id': 'multi',
                 }
             },
             headers_map={
                 'accept': [
-                    'application/json'
-                ],
-                'content_type': [
-                    'application/json-patch+json',
+                    'text/plain',
                     'application/json',
-                    'text/json',
-                    'application/*+json'
-                ]
+                    'text/json'
+                ],
+                'content_type': [],
             },
             api_client=api_client
         )
@@ -284,67 +223,6 @@ class AccountsApi(object):
             },
             api_client=api_client
         )
-        self.remove_brands_endpoint = _Endpoint(
-            settings={
-                'response_type': (ValueResourceOfRetailMediaBrands,),
-                'auth': [
-                    'oauth',
-                    'oauth'
-                ],
-                'endpoint_path': '/preview/retail-media/account-management/accounts/{accountId}/brands/remove',
-                'operation_id': 'remove_brands',
-                'http_method': 'POST',
-                'servers': None,
-            },
-            params_map={
-                'all': [
-                    'account_id',
-                    'value_resource_input_of_retail_media_brands',
-                ],
-                'required': [
-                    'account_id',
-                ],
-                'nullable': [
-                ],
-                'enum': [
-                ],
-                'validation': [
-                ]
-            },
-            root_map={
-                'validations': {
-                },
-                'allowed_values': {
-                },
-                'openapi_types': {
-                    'account_id':
-                        (str,),
-                    'value_resource_input_of_retail_media_brands':
-                        (ValueResourceInputOfRetailMediaBrands,),
-                },
-                'attribute_map': {
-                    'account_id': 'accountId',
-                },
-                'location_map': {
-                    'account_id': 'path',
-                    'value_resource_input_of_retail_media_brands': 'body',
-                },
-                'collection_format_map': {
-                }
-            },
-            headers_map={
-                'accept': [
-                    'application/json'
-                ],
-                'content_type': [
-                    'application/json-patch+json',
-                    'application/json',
-                    'text/json',
-                    'application/*+json'
-                ]
-            },
-            api_client=api_client
-        )
         self.update_sellers_endpoint = _Endpoint(
             settings={
                 'response_type': (ValueResourceCollectionOutcomeOfRetailMediaSeller,),
@@ -407,109 +285,25 @@ class AccountsApi(object):
             api_client=api_client
         )
 
-    def add_brands(
-        self,
-        account_id,
-        **kwargs
-    ):
-        """add_brands  # noqa: E501
-
-        Add brands to an account  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-
-        >>> thread = api.add_brands(account_id, async_req=True)
-        >>> result = thread.get()
-
-        Args:
-            account_id (str): the account id to update
-
-        Keyword Args:
-            value_resource_input_of_retail_media_brands (ValueResourceInputOfRetailMediaBrands): brands to associate to account. [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:
-            ValueResourceOfRetailMediaBrands
-                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.add_brands_endpoint.call_with_http_info(**kwargs)
-
-    def create_private_market_demand_brand_account(
+    def create_private_market_demand_seller_account(
         self,
         account_id,
         **kwargs
     ):
-        """create_private_market_demand_brand_account  # noqa: E501
+        """create_private_market_demand_seller_account  # noqa: E501
 
-        Creates a new child Demand Brand Account for the provided parent private market account  # noqa: E501
+        Creates a new child Demand Seller Account for the provided parent private market account  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.create_private_market_demand_brand_account(account_id, async_req=True)
+        >>> thread = api.create_private_market_demand_seller_account(account_id, async_req=True)
         >>> result = thread.get()
 
         Args:
             account_id (str): Account Id for the parent private market account
 
         Keyword Args:
-            value_resource_input_of_retail_media_brand_account_creation (ValueResourceInputOfRetailMediaBrandAccountCreation): Initial creation and configuration options for the new account. [optional]
+            value_resource_input_of_retail_media_seller_account_creation (ValueResourceInputOfRetailMediaSellerAccountCreation): Initial creation and configuration options for the new account. [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
@@ -573,27 +367,26 @@ class AccountsApi(object):
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
         kwargs['account_id'] = \
             account_id
-        return self.create_private_market_demand_brand_account_endpoint.call_with_http_info(**kwargs)
+        return self.create_private_market_demand_seller_account_endpoint.call_with_http_info(**kwargs)
 
-    def create_private_market_demand_seller_account(
+    def get_api_v1_external_accounts(
         self,
-        account_id,
         **kwargs
     ):
-        """create_private_market_demand_seller_account  # noqa: E501
+        """get_api_v1_external_accounts  # noqa: E501
 
-        Creates a new child Demand Seller Account for the provided parent private market account  # noqa: E501
+        Gets page of account objects that the current user can access  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = api.create_private_market_demand_seller_account(account_id, async_req=True)
+        >>> thread = api.get_api_v1_external_accounts(async_req=True)
         >>> result = thread.get()
 
-        Args:
-            account_id (str): Account Id for the parent private market account
 
         Keyword Args:
-            value_resource_input_of_retail_media_seller_account_creation (ValueResourceInputOfRetailMediaSellerAccountCreation): Initial creation and configuration options for the new account. [optional]
+            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
             _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
@@ -626,7 +419,7 @@ class AccountsApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            ResourceOutcomeOfRetailMediaAccount
+            JsonApiPageResponseOfAccount
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -655,16 +448,14 @@ class AccountsApi(object):
             '_content_type')
         kwargs['_host_index'] = kwargs.get('_host_index')
         kwargs['_request_auths'] = kwargs.get('_request_auths', None)
-        kwargs['account_id'] = \
-            account_id
-        return self.create_private_market_demand_seller_account_endpoint.call_with_http_info(**kwargs)
+        return self.get_api_v1_external_accounts_endpoint.call_with_http_info(**kwargs)
 
     def grant_consent(
         self,
         account_id,
         **kwargs
     ):
-        """grant_consent  # noqa: E501
+        """  # noqa: E501
 
         Grant consent to a business application on behalf of a Private Market demand account  # noqa: E501
         This method makes a synchronous HTTP request by default. To make an
@@ -743,90 +534,6 @@ class AccountsApi(object):
             account_id
         return self.grant_consent_endpoint.call_with_http_info(**kwargs)
 
-    def remove_brands(
-        self,
-        account_id,
-        **kwargs
-    ):
-        """remove_brands  # noqa: E501
-
-        Remove a brand from an account  # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-
-        >>> thread = api.remove_brands(account_id, async_req=True)
-        >>> result = thread.get()
-
-        Args:
-            account_id (str): the account id to update
-
-        Keyword Args:
-            value_resource_input_of_retail_media_brands (ValueResourceInputOfRetailMediaBrands): [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:
-            ValueResourceOfRetailMediaBrands
-                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.remove_brands_endpoint.call_with_http_info(**kwargs)
-
     def update_sellers(
         self,
         account_id,