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

Inheritance diagram for Lusid.Sdk.Api.IPackagesApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< DeletedEntityResponse >	DeletePackageAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] DeletePackage: Delete package More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeletePackageWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] DeletePackage: Delete package More...

System.Threading.Tasks.Task< Package >	GetPackageAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetPackage: Get Package More...

System.Threading.Tasks.Task< ApiResponse< Package > >	GetPackageWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetPackage: Get Package More...

System.Threading.Tasks.Task< PagedResourceListOfPackage >	ListPackagesAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] ListPackages: List Packages More...

System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfPackage > >	ListPackagesWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] ListPackages: List Packages More...

System.Threading.Tasks.Task< ResourceListOfPackage >	UpsertPackagesAsync (PackageSetRequest? packageSetRequest=default(PackageSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] UpsertPackages: Upsert Package More...

System.Threading.Tasks.Task< ApiResponse< ResourceListOfPackage > >	UpsertPackagesWithHttpInfoAsync (PackageSetRequest? packageSetRequest=default(PackageSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] UpsertPackages: Upsert Package 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

◆ DeletePackageAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IPackagesApiAsync.DeletePackageAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] DeletePackage: Delete package

Delete an package. Deletion will be valid from the package's creation datetime. This means that the package will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions

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

Parameters

scope	The package scope.
code	The package's code. This, together with the scope uniquely identifies the package to delete.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.PackagesApi.

◆ DeletePackageWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IPackagesApiAsync.DeletePackageWithHttpInfoAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] DeletePackage: Delete package

Delete an package. Deletion will be valid from the package's creation datetime. This means that the package will no longer exist at any effective datetime from the asAt datetime of deletion.

Exceptions

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

Parameters

scope	The package scope.
code	The package's code. This, together with the scope uniquely identifies the package to delete.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.PackagesApi.

◆ GetPackageAsync()

System.Threading.Tasks.Task<Package> Lusid.Sdk.Api.IPackagesApiAsync.GetPackageAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetPackage: Get Package

Fetch a Package that matches the specified identifier

Exceptions

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

Parameters

scope	The scope to which the package belongs.
code	The package's unique identifier.
asAt	The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified. (optional)
propertyKeys	A list of property keys from the "Package" domain to decorate onto the package. These take the format {domain}/{scope}/{code} e.g. "Package/system/Name". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of Package

Implemented in Lusid.Sdk.Api.PackagesApi.

◆ GetPackageWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Package> > Lusid.Sdk.Api.IPackagesApiAsync.GetPackageWithHttpInfoAsync	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetPackage: Get Package

Fetch a Package that matches the specified identifier

Exceptions

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

Parameters

scope	The scope to which the package belongs.
code	The package's unique identifier.
asAt	The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified. (optional)
propertyKeys	A list of property keys from the "Package" domain to decorate onto the package. These take the format {domain}/{scope}/{code} e.g. "Package/system/Name". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (Package)

Implemented in Lusid.Sdk.Api.PackagesApi.

◆ ListPackagesAsync()

System.Threading.Tasks.Task<PagedResourceListOfPackage> Lusid.Sdk.Api.IPackagesApiAsync.ListPackagesAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] ListPackages: List Packages

Fetch the last pre-AsAt date version of each package in scope (does not fetch the entire history).

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified. (optional)
page	The pagination token to use to continue listing packages from a previous call to list packages. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (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)
propertyKeys	A list of property keys from the "Package" domain to decorate onto each package. These take the format {domain}/{scope}/{code} e.g. "Package/system/Name". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfPackage

Implemented in Lusid.Sdk.Api.PackagesApi.

◆ ListPackagesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfPackage> > Lusid.Sdk.Api.IPackagesApiAsync.ListPackagesWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		List< string >?	propertyKeys = `default(List< string >?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] ListPackages: List Packages

Fetch the last pre-AsAt date version of each package in scope (does not fetch the entire history).

Exceptions

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

Parameters

asAt	The asAt datetime at which to retrieve the package. Defaults to return the latest version of the package if not specified. (optional)
page	The pagination token to use to continue listing packages from a previous call to list packages. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request. (optional)
sortBy	A list of field names or properties to sort by, each suffixed by " ASC" or " DESC". (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)
propertyKeys	A list of property keys from the "Package" domain to decorate onto each package. These take the format {domain}/{scope}/{code} e.g. "Package/system/Name". (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfPackage)

Implemented in Lusid.Sdk.Api.PackagesApi.

◆ UpsertPackagesAsync()

System.Threading.Tasks.Task<ResourceListOfPackage> Lusid.Sdk.Api.IPackagesApiAsync.UpsertPackagesAsync	(	PackageSetRequest?	packageSetRequest = `default(PackageSetRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] UpsertPackages: Upsert Package

Upsert; update existing packages with given ids, or create new packages otherwise.

Exceptions

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

Parameters

packageSetRequest	The collection of package requests. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ResourceListOfPackage

Implemented in Lusid.Sdk.Api.PackagesApi.

◆ UpsertPackagesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfPackage> > Lusid.Sdk.Api.IPackagesApiAsync.UpsertPackagesWithHttpInfoAsync	(	PackageSetRequest?	packageSetRequest = `default(PackageSetRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] UpsertPackages: Upsert Package

Upsert; update existing packages with given ids, or create new packages otherwise.

Exceptions

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

Parameters

packageSetRequest	The collection of package requests. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (ResourceListOfPackage)

Implemented in Lusid.Sdk.Api.PackagesApi.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ DeletePackageAsync()

◆ DeletePackageWithHttpInfoAsync()

◆ GetPackageAsync()

◆ GetPackageWithHttpInfoAsync()

◆ ListPackagesAsync()

◆ ListPackagesWithHttpInfoAsync()

◆ UpsertPackagesAsync()

◆ UpsertPackagesWithHttpInfoAsync()