sdk.lusid.api.counterparties_api.CounterpartiesApi
- class CounterpartiesApi(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] DeleteCounterpartyAgreement: Delete the Counterparty Agreement of given scope and code # noqa: E501
[EARLY ACCESS] DeleteCounterpartyAgreement: Delete the Counterparty Agreement of given scope and code # noqa: E501
[EARLY ACCESS] DeleteCreditSupportAnnex: Delete the Credit Support Annex of given scope and code # noqa: E501
[EARLY ACCESS] DeleteCreditSupportAnnex: Delete the Credit Support Annex of given scope and code # noqa: E501
[EARLY ACCESS] GetCounterpartyAgreement: Get Counterparty Agreement # noqa: E501
[EARLY ACCESS] GetCounterpartyAgreement: Get Counterparty Agreement # noqa: E501
[EARLY ACCESS] GetCreditSupportAnnex: Get Credit Support Annex # noqa: E501
[EARLY ACCESS] GetCreditSupportAnnex: Get Credit Support Annex # noqa: E501
[EARLY ACCESS] ListCounterpartyAgreements: List the set of Counterparty Agreements # noqa: E501
[EARLY ACCESS] ListCounterpartyAgreements: List the set of Counterparty Agreements # noqa: E501
[EARLY ACCESS] ListCreditSupportAnnexes: List the set of Credit Support Annexes # noqa: E501
[EARLY ACCESS] ListCreditSupportAnnexes: List the set of Credit Support Annexes # noqa: E501
[EARLY ACCESS] UpsertCounterpartyAgreement: Upsert Counterparty Agreement # noqa: E501
[EARLY ACCESS] UpsertCounterpartyAgreement: Upsert Counterparty Agreement # noqa: E501
[EARLY ACCESS] UpsertCreditSupportAnnex: Upsert Credit Support Annex # noqa: E501
[EARLY ACCESS] UpsertCreditSupportAnnex: Upsert Credit Support Annex # noqa: E501
- delete_counterparty_agreement(scope, code, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeleteCounterpartyAgreement: Delete the Counterparty Agreement of given scope and code # noqa: E501
Delete the specified Counterparty Agreement 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. It is important to always check for any unsuccessful response. # 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_counterparty_agreement(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the Counterparty Agreement to delete. (required)
code (str) – The Counterparty Agreement 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_counterparty_agreement_with_http_info(scope, code, **kwargs)[source]
[EARLY ACCESS] DeleteCounterpartyAgreement: Delete the Counterparty Agreement of given scope and code # noqa: E501
Delete the specified Counterparty Agreement 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. It is important to always check for any unsuccessful response. # 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_counterparty_agreement_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the Counterparty Agreement to delete. (required)
code (str) – The Counterparty Agreement 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(AnnulSingleStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))
- delete_credit_support_annex(scope, code, async_req=None, **kwargs)[source]
[EARLY ACCESS] DeleteCreditSupportAnnex: Delete the Credit Support Annex of given scope and code # noqa: E501
Delete the specified Credit Support Annex 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. It is important to always check for any unsuccessful response. # 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_credit_support_annex(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the Credit Support Annex to delete. (required)
code (str) – The Credit Support Annex 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_credit_support_annex_with_http_info(scope, code, **kwargs)[source]
[EARLY ACCESS] DeleteCreditSupportAnnex: Delete the Credit Support Annex of given scope and code # noqa: E501
Delete the specified Credit Support Annex 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. It is important to always check for any unsuccessful response. # 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_credit_support_annex_with_http_info(scope, code, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the Credit Support Annex to delete. (required)
code (str) – The Credit Support Annex 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(AnnulSingleStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))
- get_counterparty_agreement(scope, code, as_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetCounterpartyAgreement: Get Counterparty Agreement # noqa: E501
Get a Counterparty Agreement from a single scope. The response will return either the Counterparty Agreement that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures). # 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_counterparty_agreement(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the Counterparty Agreement to retrieve. (required)
code (str) – The name of the Counterparty Agreement to retrieve the data for. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Counterparty Agreement. Defaults to return the latest version if not specified.
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:
- get_counterparty_agreement_with_http_info(scope, code, as_at=None, **kwargs)[source]
[EARLY ACCESS] GetCounterpartyAgreement: Get Counterparty Agreement # noqa: E501
Get a Counterparty Agreement from a single scope. The response will return either the Counterparty Agreement that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures). # 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_counterparty_agreement_with_http_info(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the Counterparty Agreement to retrieve. (required)
code (str) – The name of the Counterparty Agreement to retrieve the data for. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Counterparty Agreement. Defaults to return the latest version if not specified.
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(GetCounterpartyAgreementResponse, status_code(int), headers(HTTPHeaderDict))
- get_credit_support_annex(scope, code, as_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] GetCreditSupportAnnex: Get Credit Support Annex # noqa: E501
Get a Credit Support Annex from a single scope. The response will return either the Credit Support Annex that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures). # 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_credit_support_annex(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the Credit Support Annex to retrieve. (required)
code (str) – The name of the Credit Support Annex to retrieve the data for. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Credit Support Annex . Defaults to return the latest version if not specified.
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:
- get_credit_support_annex_with_http_info(scope, code, as_at=None, **kwargs)[source]
[EARLY ACCESS] GetCreditSupportAnnex: Get Credit Support Annex # noqa: E501
Get a Credit Support Annex from a single scope. The response will return either the Credit Support Annex that has been stored, or a failure explaining why the request was unsuccessful. It is important to always check for any unsuccessful requests (failures). # 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_credit_support_annex_with_http_info(scope, code, as_at, async_req=True) >>> result = thread.get()
- Parameters:
scope (str) – The scope of the Credit Support Annex to retrieve. (required)
code (str) – The name of the Credit Support Annex to retrieve the data for. (required)
as_at (datetime) – The asAt datetime at which to retrieve the Credit Support Annex . Defaults to return the latest version if not specified.
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(GetCreditSupportAnnexResponse, status_code(int), headers(HTTPHeaderDict))
- list_counterparty_agreements(as_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ListCounterpartyAgreements: List the set of Counterparty Agreements # noqa: E501
List the set of Counterparty Agreements at the specified AsAt date/time # 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_counterparty_agreements(as_at, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to list the Counterparty Agreements. Defaults to latest if not specified.
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:
- list_counterparty_agreements_with_http_info(as_at=None, **kwargs)[source]
[EARLY ACCESS] ListCounterpartyAgreements: List the set of Counterparty Agreements # noqa: E501
List the set of Counterparty Agreements at the specified AsAt date/time # 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_counterparty_agreements_with_http_info(as_at, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to list the Counterparty Agreements. Defaults to latest if not specified.
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(ResourceListOfGetCounterpartyAgreementResponse, status_code(int), headers(HTTPHeaderDict))
- list_credit_support_annexes(as_at=None, async_req=None, **kwargs)[source]
[EARLY ACCESS] ListCreditSupportAnnexes: List the set of Credit Support Annexes # noqa: E501
List the set of Credit Support Annexes at the specified AsAt date/time # 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_credit_support_annexes(as_at, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to list the Credit Support Annexes. Defaults to latest if not specified.
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:
- list_credit_support_annexes_with_http_info(as_at=None, **kwargs)[source]
[EARLY ACCESS] ListCreditSupportAnnexes: List the set of Credit Support Annexes # noqa: E501
List the set of Credit Support Annexes at the specified AsAt date/time # 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_credit_support_annexes_with_http_info(as_at, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to list the Credit Support Annexes. Defaults to latest if not specified.
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(ResourceListOfGetCreditSupportAnnexResponse, status_code(int), headers(HTTPHeaderDict))
- upsert_counterparty_agreement(upsert_counterparty_agreement_request, async_req=None, **kwargs)[source]
[EARLY ACCESS] UpsertCounterpartyAgreement: Upsert Counterparty Agreement # noqa: E501
Update or insert Counterparty Agreement in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Counterparty Agreement or failure message if unsuccessful It is important to always check to verify success (or failure). # 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_counterparty_agreement(upsert_counterparty_agreement_request, async_req=True) >>> result = thread.get()
- Parameters:
upsert_counterparty_agreement_request (UpsertCounterpartyAgreementRequest) – The Counterparty Agreement to update or insert (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:
- upsert_counterparty_agreement_with_http_info(upsert_counterparty_agreement_request, **kwargs)[source]
[EARLY ACCESS] UpsertCounterpartyAgreement: Upsert Counterparty Agreement # noqa: E501
Update or insert Counterparty Agreement in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Counterparty Agreement or failure message if unsuccessful It is important to always check to verify success (or failure). # 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_counterparty_agreement_with_http_info(upsert_counterparty_agreement_request, async_req=True) >>> result = thread.get()
- Parameters:
upsert_counterparty_agreement_request (UpsertCounterpartyAgreementRequest) – The Counterparty Agreement to update or insert (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(UpsertSingleStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))
- upsert_credit_support_annex(upsert_credit_support_annex_request, async_req=None, **kwargs)[source]
[EARLY ACCESS] UpsertCreditSupportAnnex: Upsert Credit Support Annex # noqa: E501
Update or insert Credit Support Annex in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Credit Support Annex or failure message if unsuccessful It is important to always check to verify success (or failure). # 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_credit_support_annex(upsert_credit_support_annex_request, async_req=True) >>> result = thread.get()
- Parameters:
upsert_credit_support_annex_request (UpsertCreditSupportAnnexRequest) – The Credit Support Annex to update or insert (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:
- upsert_credit_support_annex_with_http_info(upsert_credit_support_annex_request, **kwargs)[source]
[EARLY ACCESS] UpsertCreditSupportAnnex: Upsert Credit Support Annex # noqa: E501
Update or insert Credit Support Annex in a single scope. An item will be updated if it already exists and inserted if it does not. The response will return the successfully updated or inserted Credit Support Annex or failure message if unsuccessful It is important to always check to verify success (or failure). # 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_credit_support_annex_with_http_info(upsert_credit_support_annex_request, async_req=True) >>> result = thread.get()
- Parameters:
upsert_credit_support_annex_request (UpsertCreditSupportAnnexRequest) – The Credit Support Annex to update or insert (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(UpsertSingleStructuredDataResponse, status_code(int), headers(HTTPHeaderDict))