# coding: utf-8
"""
LUSID API
FINBOURNE Technology # noqa: E501
Contact: info@finbourne.com
Generated by OpenAPI Generator (https://openapi-generator.tech)
Do not edit the class manually.
"""
import re # noqa: F401
import io
import warnings
from pydantic.v1 import validate_arguments, ValidationError
from typing import overload, Optional, Union, Awaitable
from datetime import datetime
from pydantic.v1 import Field, StrictInt
from typing import Optional
from typing_extensions import Annotated
from lusid.models.annul_single_structured_data_response import AnnulSingleStructuredDataResponse
from lusid.models.get_subscription_response import GetSubscriptionResponse
from lusid.models.paged_resource_list_of_get_subscription_response import PagedResourceListOfGetSubscriptionResponse
from lusid.models.upsert_single_structured_data_response import UpsertSingleStructuredDataResponse
from lusid.models.upsert_subscription_request import UpsertSubscriptionRequest
from lusid.api_client import ApiClient
from lusid.api_response import ApiResponse
from lusid.exceptions import ( # noqa: F401
ApiTypeError,
ApiValueError
)
from lusid.extensions.configuration_options import ConfigurationOptions
# ensure templated type usages are imported
from pydantic.v1 import Field, StrictStr
from typing import Optional
from typing_extensions import Annotated
[docs]
class SubscriptionsApi:
"""NOTE: This class is auto generated by OpenAPI Generator
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
def __init__(self, api_client=None) -> None:
if api_client is None:
api_client = ApiClient.get_default()
self.api_client = api_client
@overload
async def delete_subscription(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Subscription to delete.")], code : Annotated[StrictStr, Field(..., description="The Subscription to delete.")], **kwargs) -> AnnulSingleStructuredDataResponse: # noqa: E501
...
@overload
def delete_subscription(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Subscription to delete.")], code : Annotated[StrictStr, Field(..., description="The Subscription to delete.")], async_req: Optional[bool]=True, **kwargs) -> AnnulSingleStructuredDataResponse: # noqa: E501
...
[docs]
@validate_arguments
def delete_subscription(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Subscription to delete.")], code : Annotated[StrictStr, Field(..., description="The Subscription to delete.")], async_req: Optional[bool]=None, **kwargs) -> Union[AnnulSingleStructuredDataResponse, Awaitable[AnnulSingleStructuredDataResponse]]: # noqa: E501
"""[EARLY ACCESS] DeleteSubscription: Delete a Subscription, assuming that it is present. # noqa: E501
Delete the specified Subscription definition from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_subscription(scope, code, async_req=True)
>>> result = thread.get()
:param scope: The scope of the Subscription to delete. (required)
:type scope: str
:param code: The Subscription to delete. (required)
:type code: str
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
:param opts: Configuration options for this request
:type opts: ConfigurationOptions, optional
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: AnnulSingleStructuredDataResponse
"""
kwargs['_return_http_data_only'] = True
if '_preload_content' in kwargs:
message = "Error! Please call the delete_subscription_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
raise ValueError(message)
if async_req is not None:
kwargs['async_req'] = async_req
return self.delete_subscription_with_http_info(scope, code, **kwargs) # noqa: E501
[docs]
@validate_arguments
def delete_subscription_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Subscription to delete.")], code : Annotated[StrictStr, Field(..., description="The Subscription to delete.")], **kwargs) -> ApiResponse: # noqa: E501
"""[EARLY ACCESS] DeleteSubscription: Delete a Subscription, assuming that it is present. # noqa: E501
Delete the specified Subscription definition from a single scope. The response will return either detail of the deleted item, or an explanation (failure) as to why this did not succeed. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.delete_subscription_with_http_info(scope, code, async_req=True)
>>> result = thread.get()
:param scope: The scope of the Subscription to delete. (required)
:type scope: str
:param code: The Subscription to delete. (required)
:type code: str
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _preload_content: if False, the ApiResponse.data will
be set to none and raw_data will store the
HTTP response body without reading/decoding.
Default is True.
:type _preload_content: bool, optional
:param _return_http_data_only: response data instead of ApiResponse
object with status code, headers, etc
:type _return_http_data_only: bool, optional
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
:param opts: Configuration options for this request
:type opts: ConfigurationOptions, optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:type _content_type: string, optional: force content-type for the request
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(AnnulSingleStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))
"""
_params = locals()
_all_params = [
'scope',
'code'
]
_all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout',
'_request_auth',
'_content_type',
'_headers',
'opts'
]
)
# validate the arguments
for _key, _val in _params['kwargs'].items():
if _key not in _all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method delete_subscription" % _key
)
_params[_key] = _val
del _params['kwargs']
_collection_formats = {}
# process the path parameters
_path_params = {}
if _params['scope']:
_path_params['scope'] = _params['scope']
if _params['code']:
_path_params['code'] = _params['code']
# process the query parameters
_query_params = []
# process the header parameters
_header_params = dict(_params.get('_headers', {}))
# process the form parameters
_form_params = []
_files = {}
# process the body parameter
_body_params = None
# set the HTTP header `Accept`
_header_params['Accept'] = self.api_client.select_header_accept(
['text/plain', 'application/json', 'text/json']) # noqa: E501
# authentication setting
_auth_settings = ['oauth2'] # noqa: E501
_response_types_map = {
'200': "AnnulSingleStructuredDataResponse",
'400': "LusidValidationProblemDetails",
}
return self.api_client.call_api(
'/api/subscriptions/holdings/{scope}/{code}', 'DELETE',
_path_params,
_query_params,
_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
response_types_map=_response_types_map,
auth_settings=_auth_settings,
async_req=_params.get('async_req'),
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
_preload_content=_params.get('_preload_content', True),
_request_timeout=_params.get('_request_timeout'),
opts=_params.get('opts'),
collection_formats=_collection_formats,
_request_auth=_params.get('_request_auth'))
@overload
async def get_subscription(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Subscription to retrieve.")], code : Annotated[StrictStr, Field(..., description="The code of the Subscription to retrieve.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Subscription. Defaults to return the latest version if not specified.")] = None, **kwargs) -> GetSubscriptionResponse: # noqa: E501
...
@overload
def get_subscription(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Subscription to retrieve.")], code : Annotated[StrictStr, Field(..., description="The code of the Subscription to retrieve.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Subscription. Defaults to return the latest version if not specified.")] = None, async_req: Optional[bool]=True, **kwargs) -> GetSubscriptionResponse: # noqa: E501
...
[docs]
@validate_arguments
def get_subscription(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Subscription to retrieve.")], code : Annotated[StrictStr, Field(..., description="The code of the Subscription to retrieve.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Subscription. Defaults to return the latest version if not specified.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[GetSubscriptionResponse, Awaitable[GetSubscriptionResponse]]: # noqa: E501
"""[EARLY ACCESS] GetSubscription: Get Subscription # noqa: E501
Get a Subscription definition from a single scope. The response will return either the subscription that has been stored, or a failure explaining why the request was unsuccessful. # 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_subscription(scope, code, as_at, async_req=True)
>>> result = thread.get()
:param scope: The scope of the Subscription to retrieve. (required)
:type scope: str
:param code: The code of the Subscription to retrieve. (required)
:type code: str
:param as_at: The asAt datetime at which to retrieve the Subscription. Defaults to return the latest version if not specified.
:type as_at: datetime
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
:param opts: Configuration options for this request
:type opts: ConfigurationOptions, optional
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: GetSubscriptionResponse
"""
kwargs['_return_http_data_only'] = True
if '_preload_content' in kwargs:
message = "Error! Please call the get_subscription_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
raise ValueError(message)
if async_req is not None:
kwargs['async_req'] = async_req
return self.get_subscription_with_http_info(scope, code, as_at, **kwargs) # noqa: E501
[docs]
@validate_arguments
def get_subscription_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope of the Subscription to retrieve.")], code : Annotated[StrictStr, Field(..., description="The code of the Subscription to retrieve.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to retrieve the Subscription. Defaults to return the latest version if not specified.")] = None, **kwargs) -> ApiResponse: # noqa: E501
"""[EARLY ACCESS] GetSubscription: Get Subscription # noqa: E501
Get a Subscription definition from a single scope. The response will return either the subscription that has been stored, or a failure explaining why the request was unsuccessful. # 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_subscription_with_http_info(scope, code, as_at, async_req=True)
>>> result = thread.get()
:param scope: The scope of the Subscription to retrieve. (required)
:type scope: str
:param code: The code of the Subscription to retrieve. (required)
:type code: str
:param as_at: The asAt datetime at which to retrieve the Subscription. Defaults to return the latest version if not specified.
:type as_at: datetime
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _preload_content: if False, the ApiResponse.data will
be set to none and raw_data will store the
HTTP response body without reading/decoding.
Default is True.
:type _preload_content: bool, optional
:param _return_http_data_only: response data instead of ApiResponse
object with status code, headers, etc
:type _return_http_data_only: bool, optional
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
:param opts: Configuration options for this request
:type opts: ConfigurationOptions, optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:type _content_type: string, optional: force content-type for the request
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(GetSubscriptionResponse, status_code(int), headers(HTTPHeaderDict))
"""
_params = locals()
_all_params = [
'scope',
'code',
'as_at'
]
_all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout',
'_request_auth',
'_content_type',
'_headers',
'opts'
]
)
# validate the arguments
for _key, _val in _params['kwargs'].items():
if _key not in _all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method get_subscription" % _key
)
_params[_key] = _val
del _params['kwargs']
_collection_formats = {}
# process the path parameters
_path_params = {}
if _params['scope']:
_path_params['scope'] = _params['scope']
if _params['code']:
_path_params['code'] = _params['code']
# process the query parameters
_query_params = []
if _params.get('as_at') is not None: # noqa: E501
if isinstance(_params['as_at'], datetime):
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
else:
_query_params.append(('asAt', _params['as_at']))
# process the header parameters
_header_params = dict(_params.get('_headers', {}))
# process the form parameters
_form_params = []
_files = {}
# process the body parameter
_body_params = None
# set the HTTP header `Accept`
_header_params['Accept'] = self.api_client.select_header_accept(
['text/plain', 'application/json', 'text/json']) # noqa: E501
# authentication setting
_auth_settings = ['oauth2'] # noqa: E501
_response_types_map = {
'200': "GetSubscriptionResponse",
'400': "LusidValidationProblemDetails",
}
return self.api_client.call_api(
'/api/subscriptions/holdings/{scope}/{code}', 'GET',
_path_params,
_query_params,
_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
response_types_map=_response_types_map,
auth_settings=_auth_settings,
async_req=_params.get('async_req'),
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
_preload_content=_params.get('_preload_content', True),
_request_timeout=_params.get('_request_timeout'),
opts=_params.get('opts'),
collection_formats=_collection_formats,
_request_auth=_params.get('_request_auth'))
@overload
async def list_subscriptions(self, scope : Annotated[StrictStr, Field(..., description="The scope to list subscriptions for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the subscriptions. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.")] = None, limit : Annotated[Optional[StrictInt], Field(description="Maximum number of results to return. Defaults to 100.")] = None, page : Annotated[Optional[StrictStr], Field( description="Pagination token from a previous result to fetch the next page.")] = None, **kwargs) -> PagedResourceListOfGetSubscriptionResponse: # noqa: E501
...
@overload
def list_subscriptions(self, scope : Annotated[StrictStr, Field(..., description="The scope to list subscriptions for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the subscriptions. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.")] = None, limit : Annotated[Optional[StrictInt], Field(description="Maximum number of results to return. Defaults to 100.")] = None, page : Annotated[Optional[StrictStr], Field( description="Pagination token from a previous result to fetch the next page.")] = None, async_req: Optional[bool]=True, **kwargs) -> PagedResourceListOfGetSubscriptionResponse: # noqa: E501
...
[docs]
@validate_arguments
def list_subscriptions(self, scope : Annotated[StrictStr, Field(..., description="The scope to list subscriptions for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the subscriptions. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.")] = None, limit : Annotated[Optional[StrictInt], Field(description="Maximum number of results to return. Defaults to 100.")] = None, page : Annotated[Optional[StrictStr], Field( description="Pagination token from a previous result to fetch the next page.")] = None, async_req: Optional[bool]=None, **kwargs) -> Union[PagedResourceListOfGetSubscriptionResponse, Awaitable[PagedResourceListOfGetSubscriptionResponse]]: # noqa: E501
"""[EARLY ACCESS] ListSubscriptions: List the set of Subscription definitions # noqa: E501
List the set of subscription definitions at the specified date/time and scope. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_subscriptions(scope, as_at, filter, limit, page, async_req=True)
>>> result = thread.get()
:param scope: The scope to list subscriptions for. (required)
:type scope: str
:param as_at: The asAt datetime at which to list the subscriptions. Defaults to latest if not specified.
:type as_at: datetime
:param filter: Expression to filter the result set.
:type filter: str
:param limit: Maximum number of results to return. Defaults to 100.
:type limit: int
:param page: Pagination token from a previous result to fetch the next page.
:type page: str
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
:param opts: Configuration options for this request
:type opts: ConfigurationOptions, optional
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: PagedResourceListOfGetSubscriptionResponse
"""
kwargs['_return_http_data_only'] = True
if '_preload_content' in kwargs:
message = "Error! Please call the list_subscriptions_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
raise ValueError(message)
if async_req is not None:
kwargs['async_req'] = async_req
return self.list_subscriptions_with_http_info(scope, as_at, filter, limit, page, **kwargs) # noqa: E501
[docs]
@validate_arguments
def list_subscriptions_with_http_info(self, scope : Annotated[StrictStr, Field(..., description="The scope to list subscriptions for.")], as_at : Annotated[Optional[datetime], Field(description="The asAt datetime at which to list the subscriptions. Defaults to latest if not specified.")] = None, filter : Annotated[Optional[StrictStr], Field( description="Expression to filter the result set.")] = None, limit : Annotated[Optional[StrictInt], Field(description="Maximum number of results to return. Defaults to 100.")] = None, page : Annotated[Optional[StrictStr], Field( description="Pagination token from a previous result to fetch the next page.")] = None, **kwargs) -> ApiResponse: # noqa: E501
"""[EARLY ACCESS] ListSubscriptions: List the set of Subscription definitions # noqa: E501
List the set of subscription definitions at the specified date/time and scope. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.list_subscriptions_with_http_info(scope, as_at, filter, limit, page, async_req=True)
>>> result = thread.get()
:param scope: The scope to list subscriptions for. (required)
:type scope: str
:param as_at: The asAt datetime at which to list the subscriptions. Defaults to latest if not specified.
:type as_at: datetime
:param filter: Expression to filter the result set.
:type filter: str
:param limit: Maximum number of results to return. Defaults to 100.
:type limit: int
:param page: Pagination token from a previous result to fetch the next page.
:type page: str
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _preload_content: if False, the ApiResponse.data will
be set to none and raw_data will store the
HTTP response body without reading/decoding.
Default is True.
:type _preload_content: bool, optional
:param _return_http_data_only: response data instead of ApiResponse
object with status code, headers, etc
:type _return_http_data_only: bool, optional
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
:param opts: Configuration options for this request
:type opts: ConfigurationOptions, optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:type _content_type: string, optional: force content-type for the request
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(PagedResourceListOfGetSubscriptionResponse, status_code(int), headers(HTTPHeaderDict))
"""
_params = locals()
_all_params = [
'scope',
'as_at',
'filter',
'limit',
'page'
]
_all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout',
'_request_auth',
'_content_type',
'_headers',
'opts'
]
)
# validate the arguments
for _key, _val in _params['kwargs'].items():
if _key not in _all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method list_subscriptions" % _key
)
_params[_key] = _val
del _params['kwargs']
_collection_formats = {}
# process the path parameters
_path_params = {}
if _params['scope']:
_path_params['scope'] = _params['scope']
# process the query parameters
_query_params = []
if _params.get('as_at') is not None: # noqa: E501
if isinstance(_params['as_at'], datetime):
_query_params.append(('asAt', _params['as_at'].strftime(self.api_client.configuration.datetime_format)))
else:
_query_params.append(('asAt', _params['as_at']))
if _params.get('filter') is not None: # noqa: E501
_query_params.append(('filter', _params['filter']))
if _params.get('limit') is not None: # noqa: E501
_query_params.append(('limit', _params['limit']))
if _params.get('page') is not None: # noqa: E501
_query_params.append(('page', _params['page']))
# process the header parameters
_header_params = dict(_params.get('_headers', {}))
# process the form parameters
_form_params = []
_files = {}
# process the body parameter
_body_params = None
# set the HTTP header `Accept`
_header_params['Accept'] = self.api_client.select_header_accept(
['text/plain', 'application/json', 'text/json']) # noqa: E501
# authentication setting
_auth_settings = ['oauth2'] # noqa: E501
_response_types_map = {
'200': "PagedResourceListOfGetSubscriptionResponse",
'400': "LusidValidationProblemDetails",
}
return self.api_client.call_api(
'/api/subscriptions/holdings/{scope}', 'GET',
_path_params,
_query_params,
_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
response_types_map=_response_types_map,
auth_settings=_auth_settings,
async_req=_params.get('async_req'),
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
_preload_content=_params.get('_preload_content', True),
_request_timeout=_params.get('_request_timeout'),
opts=_params.get('opts'),
collection_formats=_collection_formats,
_request_auth=_params.get('_request_auth'))
@overload
async def upsert_subscription(self, upsert_subscription_request : Annotated[UpsertSubscriptionRequest, Field(description="The Subscription to update or insert")], **kwargs) -> UpsertSingleStructuredDataResponse: # noqa: E501
...
@overload
def upsert_subscription(self, upsert_subscription_request : Annotated[UpsertSubscriptionRequest, Field(description="The Subscription to update or insert")], async_req: Optional[bool]=True, **kwargs) -> UpsertSingleStructuredDataResponse: # noqa: E501
...
[docs]
@validate_arguments
def upsert_subscription(self, upsert_subscription_request : Annotated[UpsertSubscriptionRequest, Field(description="The Subscription to update or insert")], async_req: Optional[bool]=None, **kwargs) -> Union[UpsertSingleStructuredDataResponse, Awaitable[UpsertSingleStructuredDataResponse]]: # noqa: E501
"""[EARLY ACCESS] UpsertSubscription: Upsert a Subscription. This creates or updates the subscription definition in LUSID. # noqa: E501
Update or insert one Subscription definition. An item will be updated if it already exists and inserted if it does not. The referenced portfolio (and timeline, when supplied) must exist and be readable by the caller. The response will return the successfully updated or inserted subscription or failure message if unsuccessful. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.upsert_subscription(upsert_subscription_request, async_req=True)
>>> result = thread.get()
:param upsert_subscription_request: The Subscription to update or insert (required)
:type upsert_subscription_request: UpsertSubscriptionRequest
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
:param opts: Configuration options for this request
:type opts: ConfigurationOptions, optional
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: UpsertSingleStructuredDataResponse
"""
kwargs['_return_http_data_only'] = True
if '_preload_content' in kwargs:
message = "Error! Please call the upsert_subscription_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data" # noqa: E501
raise ValueError(message)
if async_req is not None:
kwargs['async_req'] = async_req
return self.upsert_subscription_with_http_info(upsert_subscription_request, **kwargs) # noqa: E501
[docs]
@validate_arguments
def upsert_subscription_with_http_info(self, upsert_subscription_request : Annotated[UpsertSubscriptionRequest, Field(description="The Subscription to update or insert")], **kwargs) -> ApiResponse: # noqa: E501
"""[EARLY ACCESS] UpsertSubscription: Upsert a Subscription. This creates or updates the subscription definition in LUSID. # noqa: E501
Update or insert one Subscription definition. An item will be updated if it already exists and inserted if it does not. The referenced portfolio (and timeline, when supplied) must exist and be readable by the caller. The response will return the successfully updated or inserted subscription or failure message if unsuccessful. # noqa: E501
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
>>> thread = api.upsert_subscription_with_http_info(upsert_subscription_request, async_req=True)
>>> result = thread.get()
:param upsert_subscription_request: The Subscription to update or insert (required)
:type upsert_subscription_request: UpsertSubscriptionRequest
:param async_req: Whether to execute the request asynchronously.
:type async_req: bool, optional
:param _preload_content: if False, the ApiResponse.data will
be set to none and raw_data will store the
HTTP response body without reading/decoding.
Default is True.
:type _preload_content: bool, optional
:param _return_http_data_only: response data instead of ApiResponse
object with status code, headers, etc
:type _return_http_data_only: bool, optional
:param _request_timeout: Timeout setting. Do not use - use the opts parameter instead
:param opts: Configuration options for this request
:type opts: ConfigurationOptions, optional
:param _request_auth: set to override the auth_settings for an a single
request; this effectively ignores the authentication
in the spec for a single request.
:type _request_auth: dict, optional
:type _content_type: string, optional: force content-type for the request
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: tuple(UpsertSingleStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))
"""
_params = locals()
_all_params = [
'upsert_subscription_request'
]
_all_params.extend(
[
'async_req',
'_return_http_data_only',
'_preload_content',
'_request_timeout',
'_request_auth',
'_content_type',
'_headers',
'opts'
]
)
# validate the arguments
for _key, _val in _params['kwargs'].items():
if _key not in _all_params:
raise ApiTypeError(
"Got an unexpected keyword argument '%s'"
" to method upsert_subscription" % _key
)
_params[_key] = _val
del _params['kwargs']
_collection_formats = {}
# process the path parameters
_path_params = {}
# process the query parameters
_query_params = []
# process the header parameters
_header_params = dict(_params.get('_headers', {}))
# process the form parameters
_form_params = []
_files = {}
# process the body parameter
_body_params = None
if _params['upsert_subscription_request'] is not None:
_body_params = _params['upsert_subscription_request']
# set the HTTP header `Accept`
_header_params['Accept'] = self.api_client.select_header_accept(
['text/plain', 'application/json', 'text/json']) # noqa: E501
# set the HTTP header `Content-Type`
_content_types_list = _params.get('_content_type',
self.api_client.select_header_content_type(
['application/json-patch+json', 'application/json', 'text/json', 'application/*+json']))
if _content_types_list:
_header_params['Content-Type'] = _content_types_list
# authentication setting
_auth_settings = ['oauth2'] # noqa: E501
_response_types_map = {
'200': "UpsertSingleStructuredDataResponse",
'400': "LusidValidationProblemDetails",
}
return self.api_client.call_api(
'/api/subscriptions/holdings', 'POST',
_path_params,
_query_params,
_header_params,
body=_body_params,
post_params=_form_params,
files=_files,
response_types_map=_response_types_map,
auth_settings=_auth_settings,
async_req=_params.get('async_req'),
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
_preload_content=_params.get('_preload_content', True),
_request_timeout=_params.get('_request_timeout'),
opts=_params.get('opts'),
collection_formats=_collection_formats,
_request_auth=_params.get('_request_auth'))