sdk.lusid.api.relationships_api.RelationshipsApi
- class RelationshipsApi(api_client=None)[source]
NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech
Do not edit the class manually.
Methods
[EARLY ACCESS] CreateRelationship: Create Relationship # noqa: E501
[EARLY ACCESS] CreateRelationship: Create Relationship # noqa: E501
[EARLY ACCESS] DeleteRelationship: Delete Relationship # noqa: E501
[EARLY ACCESS] DeleteRelationship: Delete Relationship # noqa: E501
- create_relationship(scope, code, create_relationship_request, async_req=None, **kwargs)[source]
[EARLY ACCESS] CreateRelationship: Create Relationship # noqa: E501
Create a relationship between two entity objects by their identifiers # 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_relationship(scope, code, create_relationship_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the relationship (required)
code (str) – The code of the relationship (required)
create_relationship_request (CreateRelationshipRequest) – The details of the relationship to create. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – 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.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- create_relationship_with_http_info(scope, code, create_relationship_request, **kwargs)[source]
[EARLY ACCESS] CreateRelationship: Create Relationship # noqa: E501
Create a relationship between two entity objects by their identifiers # 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_relationship_with_http_info(scope, code, create_relationship_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the relationship (required)
code (str) – The code of the relationship (required)
create_relationship_request (CreateRelationshipRequest) – The details of the relationship to create. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – 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.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – 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.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(CompleteRelationship, status_code(int), headers(HTTPHeaderDict))
- delete_relationship(scope, code, delete_relationship_request, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeleteRelationship: Delete Relationship # noqa: E501
Delete a relationship between two entity objects represented by their identifiers # 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_relationship(scope, code, delete_relationship_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the relationship (required)
code (str) – The code of the relationship (required)
delete_relationship_request (DeleteRelationshipRequest) – The details of the relationship to delete. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – 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.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- delete_relationship_with_http_info(scope, code, delete_relationship_request, **kwargs)[source]
[EARLY ACCESS] DeleteRelationship: Delete Relationship # noqa: E501
Delete a relationship between two entity objects represented by their identifiers # 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_relationship_with_http_info(scope, code, delete_relationship_request, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the relationship (required)
code (str) – The code of the relationship (required)
delete_relationship_request (DeleteRelationshipRequest) – The details of the relationship to delete. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_preload_content (bool, optional) – 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.
_return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc
_request_timeout – 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.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))