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

Inheritance diagram for Lusid.Sdk.Api.IInstrumentEventTypesApiSync:

[legend]

Public Member Functions
TransactionTemplate	CreateTransactionTemplate (string instrumentEventType, string instrumentType, string scope, TransactionTemplateRequest transactionTemplateRequest, int operationIndex=0)
	[EXPERIMENTAL] CreateTransactionTemplate: Create Transaction Template More...

ApiResponse< TransactionTemplate >	CreateTransactionTemplateWithHttpInfo (string instrumentEventType, string instrumentType, string scope, TransactionTemplateRequest transactionTemplateRequest, int operationIndex=0)
	[EXPERIMENTAL] CreateTransactionTemplate: Create Transaction Template More...

DateTimeOffset	DeleteTransactionTemplate (string instrumentEventType, string instrumentType, string scope, int operationIndex=0)
	[EXPERIMENTAL] DeleteTransactionTemplate: Delete Transaction Template More...

ApiResponse< DateTimeOffset >	DeleteTransactionTemplateWithHttpInfo (string instrumentEventType, string instrumentType, string scope, int operationIndex=0)
	[EXPERIMENTAL] DeleteTransactionTemplate: Delete Transaction Template More...

TransactionTemplate	GetTransactionTemplate (string instrumentEventType, string instrumentType, string scope, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EXPERIMENTAL] GetTransactionTemplate: Get Transaction Template More...

ApiResponse< TransactionTemplate >	GetTransactionTemplateWithHttpInfo (string instrumentEventType, string instrumentType, string scope, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EXPERIMENTAL] GetTransactionTemplate: Get Transaction Template More...

TransactionTemplateSpecification	GetTransactionTemplateSpecification (string instrumentEventType, int operationIndex=0)
	[EXPERIMENTAL] GetTransactionTemplateSpecification: Get Transaction Template Specification. More...

ApiResponse< TransactionTemplateSpecification >	GetTransactionTemplateSpecificationWithHttpInfo (string instrumentEventType, int operationIndex=0)
	[EXPERIMENTAL] GetTransactionTemplateSpecification: Get Transaction Template Specification. More...

PagedResourceListOfTransactionTemplateSpecification	ListTransactionTemplateSpecifications (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0)
	[EXPERIMENTAL] ListTransactionTemplateSpecifications: List Transaction Template Specifications. More...

ApiResponse< PagedResourceListOfTransactionTemplateSpecification >	ListTransactionTemplateSpecificationsWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0)
	[EXPERIMENTAL] ListTransactionTemplateSpecifications: List Transaction Template Specifications. More...

PagedResourceListOfTransactionTemplate	ListTransactionTemplates (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0)
	[EXPERIMENTAL] ListTransactionTemplates: List Transaction Templates More...

ApiResponse< PagedResourceListOfTransactionTemplate >	ListTransactionTemplatesWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), int operationIndex=0)
	[EXPERIMENTAL] ListTransactionTemplates: List Transaction Templates More...

TransactionTemplate	UpdateTransactionTemplate (string instrumentEventType, string instrumentType, string scope, TransactionTemplateRequest transactionTemplateRequest, int operationIndex=0)
	[EXPERIMENTAL] UpdateTransactionTemplate: Update Transaction Template More...

ApiResponse< TransactionTemplate >	UpdateTransactionTemplateWithHttpInfo (string instrumentEventType, string instrumentType, string scope, TransactionTemplateRequest transactionTemplateRequest, int operationIndex=0)
	[EXPERIMENTAL] UpdateTransactionTemplate: Update Transaction Template 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

◆ CreateTransactionTemplate()

TransactionTemplate Lusid.Sdk.Api.IInstrumentEventTypesApiSync.CreateTransactionTemplate	(	string	instrumentEventType,
		string	instrumentType,
		string	scope,
		TransactionTemplateRequest	transactionTemplateRequest,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] CreateTransactionTemplate: Create Transaction Template

Create a transaction template for a particular instrument event type in a scope.

Exceptions

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

Parameters

instrumentEventType	The type of instrument events that the template is applied to.
instrumentType	The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template
scope	The scope in which the template lies.
transactionTemplateRequest	A request defining a new transaction template to be created.
operationIndex	Index associated with the operation.

Returns: TransactionTemplate

Implemented in Lusid.Sdk.Api.InstrumentEventTypesApi.

◆ CreateTransactionTemplateWithHttpInfo()

ApiResponse<TransactionTemplate> Lusid.Sdk.Api.IInstrumentEventTypesApiSync.CreateTransactionTemplateWithHttpInfo	(	string	instrumentEventType,
		string	instrumentType,
		string	scope,
		TransactionTemplateRequest	transactionTemplateRequest,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] CreateTransactionTemplate: Create Transaction Template

Create a transaction template for a particular instrument event type in a scope.

Exceptions

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

Parameters

instrumentEventType	The type of instrument events that the template is applied to.
instrumentType	The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template
scope	The scope in which the template lies.
transactionTemplateRequest	A request defining a new transaction template to be created.
operationIndex	Index associated with the operation.

Returns: ApiResponse of TransactionTemplate

Implemented in Lusid.Sdk.Api.InstrumentEventTypesApi.

◆ DeleteTransactionTemplate()

DateTimeOffset Lusid.Sdk.Api.IInstrumentEventTypesApiSync.DeleteTransactionTemplate	(	string	instrumentEventType,
		string	instrumentType,
		string	scope,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] DeleteTransactionTemplate: Delete Transaction Template

Delete a transaction template for a particular instrument event type in a scope.

Exceptions

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

Parameters

instrumentEventType	The type of instrument events that the template is applied to.
instrumentType	The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template
scope	The scope of the template.
operationIndex	Index associated with the operation.

Returns: DateTimeOffset

Implemented in Lusid.Sdk.Api.InstrumentEventTypesApi.

◆ DeleteTransactionTemplateWithHttpInfo()

ApiResponse<DateTimeOffset> Lusid.Sdk.Api.IInstrumentEventTypesApiSync.DeleteTransactionTemplateWithHttpInfo	(	string	instrumentEventType,
		string	instrumentType,
		string	scope,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] DeleteTransactionTemplate: Delete Transaction Template

Delete a transaction template for a particular instrument event type in a scope.

Exceptions

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

Parameters

instrumentEventType	The type of instrument events that the template is applied to.
instrumentType	The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template
scope	The scope of the template.
operationIndex	Index associated with the operation.

Returns: ApiResponse of DateTimeOffset

Implemented in Lusid.Sdk.Api.InstrumentEventTypesApi.

◆ GetTransactionTemplate()

TransactionTemplate Lusid.Sdk.Api.IInstrumentEventTypesApiSync.GetTransactionTemplate	(	string	instrumentEventType,
		string	instrumentType,
		string	scope,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] GetTransactionTemplate: Get Transaction Template

Gets the Transaction Template that for the instrument event type within the scope specified.

Exceptions

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

Parameters

instrumentEventType	The instrument event type of the transaction template
instrumentType	The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template
scope	The scope in which the template lies. When not supplied the scope is 'default'.
asAt	The AsAt time of the requested Transaction Template (optional)
operationIndex	Index associated with the operation.

Returns: TransactionTemplate

Implemented in Lusid.Sdk.Api.InstrumentEventTypesApi.

◆ GetTransactionTemplateSpecification()

TransactionTemplateSpecification Lusid.Sdk.Api.IInstrumentEventTypesApiSync.GetTransactionTemplateSpecification	(	string	instrumentEventType,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] GetTransactionTemplateSpecification: Get Transaction Template Specification.

Retrieve the transaction template specification for a particular event type.

Exceptions

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

Parameters

instrumentEventType	The requested instrument event type.
operationIndex	Index associated with the operation.

Returns: TransactionTemplateSpecification

Implemented in Lusid.Sdk.Api.InstrumentEventTypesApi.

◆ GetTransactionTemplateSpecificationWithHttpInfo()

ApiResponse<TransactionTemplateSpecification> Lusid.Sdk.Api.IInstrumentEventTypesApiSync.GetTransactionTemplateSpecificationWithHttpInfo	(	string	instrumentEventType,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] GetTransactionTemplateSpecification: Get Transaction Template Specification.

Retrieve the transaction template specification for a particular event type.

Exceptions

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

Parameters

instrumentEventType	The requested instrument event type.
operationIndex	Index associated with the operation.

Returns: ApiResponse of TransactionTemplateSpecification

Implemented in Lusid.Sdk.Api.InstrumentEventTypesApi.

◆ GetTransactionTemplateWithHttpInfo()

ApiResponse<TransactionTemplate> Lusid.Sdk.Api.IInstrumentEventTypesApiSync.GetTransactionTemplateWithHttpInfo	(	string	instrumentEventType,
		string	instrumentType,
		string	scope,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] GetTransactionTemplate: Get Transaction Template

Gets the Transaction Template that for the instrument event type within the scope specified.

Exceptions

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

Parameters

instrumentEventType	The instrument event type of the transaction template
instrumentType	The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template
scope	The scope in which the template lies. When not supplied the scope is 'default'.
asAt	The AsAt time of the requested Transaction Template (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of TransactionTemplate

Implemented in Lusid.Sdk.Api.InstrumentEventTypesApi.

◆ ListTransactionTemplates()

PagedResourceListOfTransactionTemplate Lusid.Sdk.Api.IInstrumentEventTypesApiSync.ListTransactionTemplates	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] ListTransactionTemplates: List Transaction Templates

Lists all Transaction Templates.

Exceptions

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

Parameters

asAt	The AsAt time at which to retrieve the Transaction Templates (optional)
page	The pagination token to use to continue listing Transaction Templates from a previous call to list Transaction Templates. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, limit, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
operationIndex	Index associated with the operation.

Returns: PagedResourceListOfTransactionTemplate

Implemented in Lusid.Sdk.Api.InstrumentEventTypesApi.

◆ ListTransactionTemplateSpecifications()

PagedResourceListOfTransactionTemplateSpecification Lusid.Sdk.Api.IInstrumentEventTypesApiSync.ListTransactionTemplateSpecifications	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] ListTransactionTemplateSpecifications: List Transaction Template Specifications.

Retrieves all transaction template specifications.

Exceptions

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

Parameters

asAt	AsAt of the request (optional)
page	The pagination token to use to continue listing Transaction Template Specifications from a previous call to list Transaction Template Specifications. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC". (optional)
operationIndex	Index associated with the operation.

Returns: PagedResourceListOfTransactionTemplateSpecification

Implemented in Lusid.Sdk.Api.InstrumentEventTypesApi.

◆ ListTransactionTemplateSpecificationsWithHttpInfo()

ApiResponse<PagedResourceListOfTransactionTemplateSpecification> Lusid.Sdk.Api.IInstrumentEventTypesApiSync.ListTransactionTemplateSpecificationsWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] ListTransactionTemplateSpecifications: List Transaction Template Specifications.

Retrieves all transaction template specifications.

Exceptions

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

Parameters

asAt	AsAt of the request (optional)
page	The pagination token to use to continue listing Transaction Template Specifications from a previous call to list Transaction Template Specifications. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC". (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PagedResourceListOfTransactionTemplateSpecification

Implemented in Lusid.Sdk.Api.InstrumentEventTypesApi.

◆ ListTransactionTemplatesWithHttpInfo()

ApiResponse<PagedResourceListOfTransactionTemplate> Lusid.Sdk.Api.IInstrumentEventTypesApiSync.ListTransactionTemplatesWithHttpInfo	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] ListTransactionTemplates: List Transaction Templates

Lists all Transaction Templates.

Exceptions

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

Parameters

asAt	The AsAt time at which to retrieve the Transaction Templates (optional)
page	The pagination token to use to continue listing Transaction Templates from a previous call to list Transaction Templates. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, limit, and asAt fields must not have changed since the original request. (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
operationIndex	Index associated with the operation.

Returns: ApiResponse of PagedResourceListOfTransactionTemplate

Implemented in Lusid.Sdk.Api.InstrumentEventTypesApi.

◆ UpdateTransactionTemplate()

TransactionTemplate Lusid.Sdk.Api.IInstrumentEventTypesApiSync.UpdateTransactionTemplate	(	string	instrumentEventType,
		string	instrumentType,
		string	scope,
		TransactionTemplateRequest	transactionTemplateRequest,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] UpdateTransactionTemplate: Update Transaction Template

Update a transaction template for a particular instrument event type in a scope.

Exceptions

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

Parameters

instrumentEventType	The type of instrument events that the template is applied to.
instrumentType	The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template
scope	The scope in which the template lies.
transactionTemplateRequest	A request defining the updated values for the transaction template.
operationIndex	Index associated with the operation.

Returns: TransactionTemplate

Implemented in Lusid.Sdk.Api.InstrumentEventTypesApi.

◆ UpdateTransactionTemplateWithHttpInfo()

ApiResponse<TransactionTemplate> Lusid.Sdk.Api.IInstrumentEventTypesApiSync.UpdateTransactionTemplateWithHttpInfo	(	string	instrumentEventType,
		string	instrumentType,
		string	scope,
		TransactionTemplateRequest	transactionTemplateRequest,
		int	operationIndex = `0`
	)

[EXPERIMENTAL] UpdateTransactionTemplate: Update Transaction Template

Update a transaction template for a particular instrument event type in a scope.

Exceptions

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

Parameters

instrumentEventType	The type of instrument events that the template is applied to.
instrumentType	The instrument type of the transaction template. The combination of the instrument event type, instrument type and scope uniquely identifies a transaction template
scope	The scope in which the template lies.
transactionTemplateRequest	A request defining the updated values for the transaction template.
operationIndex	Index associated with the operation.

Returns: ApiResponse of TransactionTemplate

Implemented in Lusid.Sdk.Api.InstrumentEventTypesApi.

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/InstrumentEventTypesApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateTransactionTemplate()

◆ CreateTransactionTemplateWithHttpInfo()

◆ DeleteTransactionTemplate()

◆ DeleteTransactionTemplateWithHttpInfo()

◆ GetTransactionTemplate()

◆ GetTransactionTemplateSpecification()

◆ GetTransactionTemplateSpecificationWithHttpInfo()

◆ GetTransactionTemplateWithHttpInfo()

◆ ListTransactionTemplates()

◆ ListTransactionTemplateSpecifications()

◆ ListTransactionTemplateSpecificationsWithHttpInfo()

◆ ListTransactionTemplatesWithHttpInfo()

◆ UpdateTransactionTemplate()

◆ UpdateTransactionTemplateWithHttpInfo()