Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Lusid.Sdk.Api.ICounterpartiesApiSync:

[legend]

Public Member Functions
AnnulSingleStructuredDataResponse	DeleteCounterpartyAgreement (string scope, string code, int operationIndex=0)
	[EARLY ACCESS] DeleteCounterpartyAgreement: Delete the Counterparty Agreement of given scope and code More...

ApiResponse< AnnulSingleStructuredDataResponse >	DeleteCounterpartyAgreementWithHttpInfo (string scope, string code, int operationIndex=0)
	[EARLY ACCESS] DeleteCounterpartyAgreement: Delete the Counterparty Agreement of given scope and code More...

AnnulSingleStructuredDataResponse	DeleteCreditSupportAnnex (string scope, string code, int operationIndex=0)
	[EARLY ACCESS] DeleteCreditSupportAnnex: Delete the Credit Support Annex of given scope and code More...

ApiResponse< AnnulSingleStructuredDataResponse >	DeleteCreditSupportAnnexWithHttpInfo (string scope, string code, int operationIndex=0)
	[EARLY ACCESS] DeleteCreditSupportAnnex: Delete the Credit Support Annex of given scope and code More...

GetCounterpartyAgreementResponse	GetCounterpartyAgreement (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] GetCounterpartyAgreement: Get Counterparty Agreement More...

ApiResponse< GetCounterpartyAgreementResponse >	GetCounterpartyAgreementWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] GetCounterpartyAgreement: Get Counterparty Agreement More...

GetCreditSupportAnnexResponse	GetCreditSupportAnnex (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] GetCreditSupportAnnex: Get Credit Support Annex More...

ApiResponse< GetCreditSupportAnnexResponse >	GetCreditSupportAnnexWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] GetCreditSupportAnnex: Get Credit Support Annex More...

ResourceListOfGetCounterpartyAgreementResponse	ListCounterpartyAgreements (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] ListCounterpartyAgreements: List the set of Counterparty Agreements More...

ApiResponse< ResourceListOfGetCounterpartyAgreementResponse >	ListCounterpartyAgreementsWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] ListCounterpartyAgreements: List the set of Counterparty Agreements More...

ResourceListOfGetCreditSupportAnnexResponse	ListCreditSupportAnnexes (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] ListCreditSupportAnnexes: List the set of Credit Support Annexes More...

ApiResponse< ResourceListOfGetCreditSupportAnnexResponse >	ListCreditSupportAnnexesWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] ListCreditSupportAnnexes: List the set of Credit Support Annexes More...

UpsertSingleStructuredDataResponse	UpsertCounterpartyAgreement (UpsertCounterpartyAgreementRequest upsertCounterpartyAgreementRequest, int operationIndex=0)
	[EARLY ACCESS] UpsertCounterpartyAgreement: Upsert Counterparty Agreement More...

ApiResponse< UpsertSingleStructuredDataResponse >	UpsertCounterpartyAgreementWithHttpInfo (UpsertCounterpartyAgreementRequest upsertCounterpartyAgreementRequest, int operationIndex=0)
	[EARLY ACCESS] UpsertCounterpartyAgreement: Upsert Counterparty Agreement More...

UpsertSingleStructuredDataResponse	UpsertCreditSupportAnnex (UpsertCreditSupportAnnexRequest upsertCreditSupportAnnexRequest, int operationIndex=0)
	[EARLY ACCESS] UpsertCreditSupportAnnex: Upsert Credit Support Annex More...

ApiResponse< UpsertSingleStructuredDataResponse >	UpsertCreditSupportAnnexWithHttpInfo (UpsertCreditSupportAnnexRequest upsertCreditSupportAnnexRequest, int operationIndex=0)
	[EARLY ACCESS] UpsertCreditSupportAnnex: Upsert Credit Support Annex More...

Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ DeleteCounterpartyAgreement()

AnnulSingleStructuredDataResponse Lusid.Sdk.Api.ICounterpartiesApiSync.DeleteCounterpartyAgreement	(	string	scope,
		string	code,
		int	operationIndex = `0`
	)

[EARLY ACCESS] DeleteCounterpartyAgreement: Delete the Counterparty Agreement of given scope and code

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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Counterparty Agreement to delete.
code	The Counterparty Agreement to delete.
operationIndex	Index associated with the operation.

Returns: AnnulSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.CounterpartiesApi.

◆ DeleteCounterpartyAgreementWithHttpInfo()

ApiResponse<AnnulSingleStructuredDataResponse> Lusid.Sdk.Api.ICounterpartiesApiSync.DeleteCounterpartyAgreementWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`
	)

[EARLY ACCESS] DeleteCounterpartyAgreement: Delete the Counterparty Agreement of given scope and code

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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Counterparty Agreement to delete.
code	The Counterparty Agreement to delete.
operationIndex	Index associated with the operation.

Returns: ApiResponse of AnnulSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.CounterpartiesApi.

◆ DeleteCreditSupportAnnex()

AnnulSingleStructuredDataResponse Lusid.Sdk.Api.ICounterpartiesApiSync.DeleteCreditSupportAnnex	(	string	scope,
		string	code,
		int	operationIndex = `0`
	)

[EARLY ACCESS] DeleteCreditSupportAnnex: Delete the Credit Support Annex of given scope and code

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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Credit Support Annex to delete.
code	The Credit Support Annex to delete.
operationIndex	Index associated with the operation.

Returns: AnnulSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.CounterpartiesApi.

◆ DeleteCreditSupportAnnexWithHttpInfo()

ApiResponse<AnnulSingleStructuredDataResponse> Lusid.Sdk.Api.ICounterpartiesApiSync.DeleteCreditSupportAnnexWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`
	)

[EARLY ACCESS] DeleteCreditSupportAnnex: Delete the Credit Support Annex of given scope and code

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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Credit Support Annex to delete.
code	The Credit Support Annex to delete.
operationIndex	Index associated with the operation.

Returns: ApiResponse of AnnulSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.CounterpartiesApi.

◆ GetCounterpartyAgreement()

GetCounterpartyAgreementResponse Lusid.Sdk.Api.ICounterpartiesApiSync.GetCounterpartyAgreement	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] GetCounterpartyAgreement: Get Counterparty Agreement

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).

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Counterparty Agreement to retrieve.
code	The name of the Counterparty Agreement to retrieve the data for.
asAt	The asAt datetime at which to retrieve the Counterparty Agreement. Defaults to return the latest version if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: GetCounterpartyAgreementResponse

Implemented in Lusid.Sdk.Api.CounterpartiesApi.

◆ GetCounterpartyAgreementWithHttpInfo()

ApiResponse<GetCounterpartyAgreementResponse> Lusid.Sdk.Api.ICounterpartiesApiSync.GetCounterpartyAgreementWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] GetCounterpartyAgreement: Get Counterparty Agreement

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).

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Counterparty Agreement to retrieve.
code	The name of the Counterparty Agreement to retrieve the data for.
asAt	The asAt datetime at which to retrieve the Counterparty Agreement. Defaults to return the latest version if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of GetCounterpartyAgreementResponse

Implemented in Lusid.Sdk.Api.CounterpartiesApi.

◆ GetCreditSupportAnnex()

GetCreditSupportAnnexResponse Lusid.Sdk.Api.ICounterpartiesApiSync.GetCreditSupportAnnex	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] GetCreditSupportAnnex: Get Credit Support Annex

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).

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Credit Support Annex to retrieve.
code	The name of the Credit Support Annex to retrieve the data for.
asAt	The asAt datetime at which to retrieve the Credit Support Annex . Defaults to return the latest version if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: GetCreditSupportAnnexResponse

Implemented in Lusid.Sdk.Api.CounterpartiesApi.

◆ GetCreditSupportAnnexWithHttpInfo()

ApiResponse<GetCreditSupportAnnexResponse> Lusid.Sdk.Api.ICounterpartiesApiSync.GetCreditSupportAnnexWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] GetCreditSupportAnnex: Get Credit Support Annex

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).

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

scope	The scope of the Credit Support Annex to retrieve.
code	The name of the Credit Support Annex to retrieve the data for.
asAt	The asAt datetime at which to retrieve the Credit Support Annex . Defaults to return the latest version if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of GetCreditSupportAnnexResponse

Implemented in Lusid.Sdk.Api.CounterpartiesApi.

◆ ListCounterpartyAgreements()

ResourceListOfGetCounterpartyAgreementResponse Lusid.Sdk.Api.ICounterpartiesApiSync.ListCounterpartyAgreements	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] ListCounterpartyAgreements: List the set of Counterparty Agreements

List the set of Counterparty Agreements at the specified AsAt date/time

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to list the Counterparty Agreements. Defaults to latest if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: ResourceListOfGetCounterpartyAgreementResponse

Implemented in Lusid.Sdk.Api.CounterpartiesApi.

◆ ListCounterpartyAgreementsWithHttpInfo()

ApiResponse<ResourceListOfGetCounterpartyAgreementResponse> Lusid.Sdk.Api.ICounterpartiesApiSync.ListCounterpartyAgreementsWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] ListCounterpartyAgreements: List the set of Counterparty Agreements

List the set of Counterparty Agreements at the specified AsAt date/time

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to list the Counterparty Agreements. Defaults to latest if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfGetCounterpartyAgreementResponse

Implemented in Lusid.Sdk.Api.CounterpartiesApi.

◆ ListCreditSupportAnnexes()

ResourceListOfGetCreditSupportAnnexResponse Lusid.Sdk.Api.ICounterpartiesApiSync.ListCreditSupportAnnexes	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] ListCreditSupportAnnexes: List the set of Credit Support Annexes

List the set of Credit Support Annexes at the specified AsAt date/time

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to list the Credit Support Annexes. Defaults to latest if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: ResourceListOfGetCreditSupportAnnexResponse

Implemented in Lusid.Sdk.Api.CounterpartiesApi.

◆ ListCreditSupportAnnexesWithHttpInfo()

ApiResponse<ResourceListOfGetCreditSupportAnnexResponse> Lusid.Sdk.Api.ICounterpartiesApiSync.ListCreditSupportAnnexesWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

[EARLY ACCESS] ListCreditSupportAnnexes: List the set of Credit Support Annexes

List the set of Credit Support Annexes at the specified AsAt date/time

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	The asAt datetime at which to list the Credit Support Annexes. Defaults to latest if not specified. (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of ResourceListOfGetCreditSupportAnnexResponse

Implemented in Lusid.Sdk.Api.CounterpartiesApi.

◆ UpsertCounterpartyAgreement()

UpsertSingleStructuredDataResponse Lusid.Sdk.Api.ICounterpartiesApiSync.UpsertCounterpartyAgreement	(	UpsertCounterpartyAgreementRequest	upsertCounterpartyAgreementRequest,
		int	operationIndex = `0`
	)

[EARLY ACCESS] UpsertCounterpartyAgreement: Upsert Counterparty Agreement

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).

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

upsertCounterpartyAgreementRequest	The Counterparty Agreement to update or insert
operationIndex	Index associated with the operation.

Returns: UpsertSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.CounterpartiesApi.

◆ UpsertCounterpartyAgreementWithHttpInfo()

ApiResponse<UpsertSingleStructuredDataResponse> Lusid.Sdk.Api.ICounterpartiesApiSync.UpsertCounterpartyAgreementWithHttpInfo	(	UpsertCounterpartyAgreementRequest	upsertCounterpartyAgreementRequest,
		int	operationIndex = `0`
	)

[EARLY ACCESS] UpsertCounterpartyAgreement: Upsert Counterparty Agreement

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).

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

upsertCounterpartyAgreementRequest	The Counterparty Agreement to update or insert
operationIndex	Index associated with the operation.

Returns: ApiResponse of UpsertSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.CounterpartiesApi.

◆ UpsertCreditSupportAnnex()

UpsertSingleStructuredDataResponse Lusid.Sdk.Api.ICounterpartiesApiSync.UpsertCreditSupportAnnex	(	UpsertCreditSupportAnnexRequest	upsertCreditSupportAnnexRequest,
		int	operationIndex = `0`
	)

[EARLY ACCESS] UpsertCreditSupportAnnex: Upsert Credit Support Annex

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).

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

upsertCreditSupportAnnexRequest	The Credit Support Annex to update or insert
operationIndex	Index associated with the operation.

Returns: UpsertSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.CounterpartiesApi.

◆ UpsertCreditSupportAnnexWithHttpInfo()

ApiResponse<UpsertSingleStructuredDataResponse> Lusid.Sdk.Api.ICounterpartiesApiSync.UpsertCreditSupportAnnexWithHttpInfo	(	UpsertCreditSupportAnnexRequest	upsertCreditSupportAnnexRequest,
		int	operationIndex = `0`
	)

[EARLY ACCESS] UpsertCreditSupportAnnex: Upsert Credit Support Annex

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).

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

upsertCreditSupportAnnexRequest	The Credit Support Annex to update or insert
operationIndex	Index associated with the operation.

Returns: ApiResponse of UpsertSingleStructuredDataResponse

Implemented in Lusid.Sdk.Api.CounterpartiesApi.

The documentation for this interface was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/CounterpartiesApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeleteCounterpartyAgreement()

◆ DeleteCounterpartyAgreementWithHttpInfo()

◆ DeleteCreditSupportAnnex()

◆ DeleteCreditSupportAnnexWithHttpInfo()

◆ GetCounterpartyAgreement()

◆ GetCounterpartyAgreementWithHttpInfo()

◆ GetCreditSupportAnnex()

◆ GetCreditSupportAnnexWithHttpInfo()

◆ ListCounterpartyAgreements()

◆ ListCounterpartyAgreementsWithHttpInfo()

◆ ListCreditSupportAnnexes()

◆ ListCreditSupportAnnexesWithHttpInfo()

◆ UpsertCounterpartyAgreement()

◆ UpsertCounterpartyAgreementWithHttpInfo()

◆ UpsertCreditSupportAnnex()

◆ UpsertCreditSupportAnnexWithHttpInfo()