criteo-api-retailmedia-sdk 0.0.250819__py3-none-any.whl → 0.0.250902__py3-none-any.whl

criteo_api_retailmedia_preview/__init__.py

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

criteo_api_retailmedia_preview/api/balance_api.py

@@ -329,7 +329,7 @@ class BalanceApi(object):
         )
         self.post_api_external_v2_account_balances_by_account_id_endpoint = _Endpoint(
             settings={
-                'response_type': None,
+                'response_type': (BalanceResponseV2Response,),
                 'auth': [
                     'oauth',
                     'oauth'
@@ -852,7 +852,7 @@ class BalanceApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            None
+            BalanceResponseV2Response
                 If the method is called asynchronously, returns the request
                 thread.
         """

criteo_api_retailmedia_preview/api/campaign_api.py

@@ -329,7 +329,6 @@ class CampaignApi(object):
                     'application/json'
                 ],
                 'content_type': [
-                    'application/json-patch+json',
                     'application/json',
                     'text/json',
                     'application/*+json'
@@ -1694,7 +1693,7 @@ class CampaignApi(object):
         )
         self.post_api_external_v2_campaign_preferred_line_items_by_campaign_id_endpoint = _Endpoint(
             settings={
-                'response_type': None,
+                'response_type': (PreferredLineItemV2Response,),
                 'auth': [
                     'oauth',
                     'oauth'
@@ -2501,7 +2500,7 @@ class CampaignApi(object):
                 },
                 'openapi_types': {
                     'line_item_id':
-                        (str,),
+                        (int,),
                     'value_resource_input_of_sponsored_products_line_item_update_request_model':
                         (ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel,),
                 },
@@ -2520,7 +2519,6 @@ class CampaignApi(object):
                     'application/json'
                 ],
                 'content_type': [
-                    'application/json-patch+json',
                     'application/json',
                     'text/json',
                     'application/*+json'
@@ -2946,7 +2944,7 @@ class CampaignApi(object):
         >>> result = thread.get()
 
         Args:
-            line_item_id (str): External LineItemId for productButton delete
+            line_item_id (str): LineItemId for productButton delete
             product_button_id (str): productButtonId used for delete
 
         Keyword Args:
@@ -3286,7 +3284,7 @@ class CampaignApi(object):
         >>> result = thread.get()
 
         Args:
-            line_item_id (str): External LineItemId for productButton retrieval
+            line_item_id (str): LineItemId for productButton retrieval
             product_button_id (str): productButtonId used for retrieval
 
         Keyword Args:
@@ -3372,7 +3370,7 @@ class CampaignApi(object):
         >>> result = thread.get()
 
         Args:
-            line_item_id (str): External LineItemId for productButton retrieval
+            line_item_id (str): LineItemId for productButton retrieval
 
         Keyword Args:
             _return_http_data_only (bool): response data without head status
@@ -4555,7 +4553,7 @@ class CampaignApi(object):
         >>> result = thread.get()
 
         Args:
-            line_item_id (str): External LineItemId for productButton retrieval
+            line_item_id (str): LineItemId for productButton retrieval
 
         Keyword Args:
             product_button_request_list_request (ProductButtonRequestListRequest): List of Product Buttons to append. [optional]
@@ -4843,7 +4841,7 @@ class CampaignApi(object):
             async_req (bool): execute request asynchronously
 
         Returns:
-            None
+            PreferredLineItemV2Response
                 If the method is called asynchronously, returns the request
                 thread.
         """
@@ -5222,7 +5220,7 @@ class CampaignApi(object):
         >>> result = thread.get()
 
         Args:
-            line_item_id (str): External LineItemId for productButton update
+            line_item_id (str): LineItemId for productButton update
             product_button_id (str): productButtonId used for update
 
         Keyword Args:
@@ -5814,7 +5812,7 @@ class CampaignApi(object):
         >>> result = thread.get()
 
         Args:
-            line_item_id (str): The external line item ID of the sponsored products line item.
+            line_item_id (int): The external line item ID of the sponsored products line item.
 
         Keyword Args:
             value_resource_input_of_sponsored_products_line_item_update_request_model (ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel): An update request containing all details of the requested update.. [optional]

criteo_api_retailmedia_preview/api/catalog_api.py

@@ -25,6 +25,10 @@ from criteo_api_retailmedia_preview.model.batch_accepted_response import BatchAc
 from criteo_api_retailmedia_preview.model.fail_response import FailResponse
 from criteo_api_retailmedia_preview.model.products_custom_batch_request import ProductsCustomBatchRequest
 from criteo_api_retailmedia_preview.model.report_ok_response import ReportOkResponse
+from criteo_api_retailmedia_preview.model.value_resource_input_load_sku_offers_request import ValueResourceInputLoadSkuOffersRequest
+from criteo_api_retailmedia_preview.model.value_resource_input_set_sku_buy_box_winners_request import ValueResourceInputSetSkuBuyBoxWinnersRequest
+from criteo_api_retailmedia_preview.model.value_resource_input_update_offers_request import ValueResourceInputUpdateOffersRequest
+from criteo_api_retailmedia_preview.model.value_resource_outcome_async_job_response import ValueResourceOutcomeAsyncJobResponse
 
 
 class CatalogApi(object):
@@ -38,6 +42,195 @@ class CatalogApi(object):
         if api_client is None:
             api_client = ApiClient()
         self.api_client = api_client
+        self.offer_load_v1_endpoint = _Endpoint(
+            settings={
+                'response_type': (ValueResourceOutcomeAsyncJobResponse,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/retail-media/retailers/{retailerId}/offers/load',
+                'operation_id': 'offer_load_v1',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'retailer_id',
+                    'value_resource_input_load_sku_offers_request',
+                ],
+                'required': [
+                    'retailer_id',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'retailer_id':
+                        (int,),
+                    'value_resource_input_load_sku_offers_request':
+                        (ValueResourceInputLoadSkuOffersRequest,),
+                },
+                'attribute_map': {
+                    'retailer_id': 'retailerId',
+                },
+                'location_map': {
+                    'retailer_id': 'path',
+                    'value_resource_input_load_sku_offers_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.offer_set_bbw_v1_endpoint = _Endpoint(
+            settings={
+                'response_type': (ValueResourceOutcomeAsyncJobResponse,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/retail-media/retailers/{retailerId}/offers/set-buy-box-winners',
+                'operation_id': 'offer_set_bbw_v1',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'retailer_id',
+                    'value_resource_input_set_sku_buy_box_winners_request',
+                ],
+                'required': [
+                    'retailer_id',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'retailer_id':
+                        (int,),
+                    'value_resource_input_set_sku_buy_box_winners_request':
+                        (ValueResourceInputSetSkuBuyBoxWinnersRequest,),
+                },
+                'attribute_map': {
+                    'retailer_id': 'retailerId',
+                },
+                'location_map': {
+                    'retailer_id': 'path',
+                    'value_resource_input_set_sku_buy_box_winners_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.offer_update_v1_endpoint = _Endpoint(
+            settings={
+                'response_type': (ValueResourceOutcomeAsyncJobResponse,),
+                'auth': [
+                    'oauth',
+                    'oauth'
+                ],
+                'endpoint_path': '/preview/retail-media/retailers/{retailerId}/offers/update',
+                'operation_id': 'offer_update_v1',
+                'http_method': 'POST',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'retailer_id',
+                    'value_resource_input_update_offers_request',
+                ],
+                'required': [
+                    'retailer_id',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'retailer_id':
+                        (int,),
+                    'value_resource_input_update_offers_request':
+                        (ValueResourceInputUpdateOffersRequest,),
+                },
+                'attribute_map': {
+                    'retailer_id': 'retailerId',
+                },
+                'location_map': {
+                    'retailer_id': 'path',
+                    'value_resource_input_update_offers_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.preview_retail_media_catalog_products_batch_post_endpoint = _Endpoint(
             settings={
                 'response_type': (BatchAcceptedResponse,),
@@ -144,6 +337,258 @@ class CatalogApi(object):
             api_client=api_client
         )
 
+    def offer_load_v1(
+        self,
+        retailer_id,
+        **kwargs
+    ):
+        """offer_load_v1  # noqa: E501
+
+        Replace the offers for one or more SKUs with a snapshot of the new offers for each respective SKU  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.offer_load_v1(retailer_id, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            retailer_id (int): The retailer for which these offers will be loaded
+
+        Keyword Args:
+            value_resource_input_load_sku_offers_request (ValueResourceInputLoadSkuOffersRequest): [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:
+            ValueResourceOutcomeAsyncJobResponse
+                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.offer_load_v1_endpoint.call_with_http_info(**kwargs)
+
+    def offer_set_bbw_v1(
+        self,
+        retailer_id,
+        **kwargs
+    ):
+        """offer_set_bbw_v1  # noqa: E501
+
+        Update the buy box winner for one or more SKUs  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.offer_set_bbw_v1(retailer_id, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            retailer_id (int): The retailer for which these buy box winners will be set
+
+        Keyword Args:
+            value_resource_input_set_sku_buy_box_winners_request (ValueResourceInputSetSkuBuyBoxWinnersRequest): [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:
+            ValueResourceOutcomeAsyncJobResponse
+                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.offer_set_bbw_v1_endpoint.call_with_http_info(**kwargs)
+
+    def offer_update_v1(
+        self,
+        retailer_id,
+        **kwargs
+    ):
+        """offer_update_v1  # noqa: E501
+
+        Update one or more offers by replacing each offer's price and availability with the given values  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.offer_update_v1(retailer_id, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            retailer_id (int): The retailer for which these offers will be updated
+
+        Keyword Args:
+            value_resource_input_update_offers_request (ValueResourceInputUpdateOffersRequest): [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:
+            ValueResourceOutcomeAsyncJobResponse
+                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.offer_update_v1_endpoint.call_with_http_info(**kwargs)
+
     def preview_retail_media_catalog_products_batch_post(
         self,
         products_custom_batch_request,

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.250819/python'
+        self.user_agent = 'OpenAPI-Generator/0.0.250902/python'
 
     def __enter__(self):
         return self

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.250819".\
+               "SDK Package Version: 0.0.250902".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

criteo_api_retailmedia_preview/model/async_accounts_report.py

@@ -88,6 +88,7 @@ class AsyncAccountsReport(ModelNormal):
             'ADVPRODUCTID': "advProductId",
             'ADVPRODUCTNAME': "advProductName",
             'SALESCHANNEL': "salesChannel",
+            'MEDIATYPE': "mediaType",
             'ENVIRONMENT': "environment",
             'PAGETYPENAME': "pageTypeName",
             'PAGECATEGORY': "pageCategory",
@@ -111,6 +112,12 @@ class AsyncAccountsReport(ModelNormal):
             'JSON-NEWLINE': "json-newline",
             'CSV': "csv",
         },
+        ('media_type',): {
+            'UNKNOWN': "unknown",
+            'VIDEO': "video",
+            'DISPLAY': "display",
+            'ALL': "all",
+        },
         ('metrics',): {
             'IMPRESSIONS': "impressions",
             'CLICKS': "clicks",
@@ -149,6 +156,9 @@ class AsyncAccountsReport(ModelNormal):
             'NEWTOBRANDATTRIBUTEDUNITSRATE': "newToBrandAttributedUnitsRate",
             'UNIQUEVISITORS': "uniqueVisitors",
             'FREQUENCY': "frequency",
+            'WINRATE': "winRate",
+            'SAMPLEDBIDSWON': "sampledBidsWon",
+            'SAMPLEDBIDSPARTICIPATED': "sampledBidsParticipated",
         },
         ('report_type',): {
             'SUMMARY': "summary",
@@ -223,6 +233,7 @@ class AsyncAccountsReport(ModelNormal):
             'click_attribution_window': (str,),  # noqa: E501
             'dimensions': ([str],),  # noqa: E501
             'format': (str,),  # noqa: E501
+            'media_type': (str,),  # noqa: E501
             'metrics': ([str],),  # noqa: E501
             'report_type': (str,),  # noqa: E501
             'sales_channel': (str,),  # noqa: E501
@@ -247,6 +258,7 @@ class AsyncAccountsReport(ModelNormal):
         'click_attribution_window': 'clickAttributionWindow',  # noqa: E501
         'dimensions': 'dimensions',  # noqa: E501
         'format': 'format',  # noqa: E501
+        'media_type': 'mediaType',  # noqa: E501
         'metrics': 'metrics',  # noqa: E501
         'report_type': 'reportType',  # noqa: E501
         'sales_channel': 'salesChannel',  # noqa: E501
@@ -308,6 +320,7 @@ class AsyncAccountsReport(ModelNormal):
             click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none"  # noqa: E501
             dimensions ([str]): List of dimensions to report on. [optional]  # noqa: E501
             format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact"  # noqa: E501
+            media_type (str): Filter on the type of media: unknown, display, video. [optional] if omitted the server will use the default value of "all"  # noqa: E501
             metrics ([str]): List of metrics to report on. [optional]  # noqa: E501
             report_type (str): Type of report, if no dimensions and metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary"  # noqa: E501
             sales_channel (str): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all"  # noqa: E501
@@ -414,6 +427,7 @@ class AsyncAccountsReport(ModelNormal):
             click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none"  # noqa: E501
             dimensions ([str]): List of dimensions to report on. [optional]  # noqa: E501
             format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact"  # noqa: E501
+            media_type (str): Filter on the type of media: unknown, display, video. [optional] if omitted the server will use the default value of "all"  # noqa: E501
             metrics ([str]): List of metrics to report on. [optional]  # noqa: E501
             report_type (str): Type of report, if no dimensions and metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary"  # noqa: E501
             sales_channel (str): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all"  # noqa: E501