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

Inheritance diagram for Lusid.Sdk.Api.PackagesApi:

[legend]

Public Member Functions
	PackagesApi ()
	Initializes a new instance of the PackagesApi class. More...

	PackagesApi (string basePath)
	Initializes a new instance of the PackagesApi class. More...

	PackagesApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the PackagesApi class using Configuration object More...

	PackagesApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the PackagesApi class using a Configuration object and client instance. More...

string	GetBasePath ()
	Gets the base path of the API client. More...

DeletedEntityResponse	DeletePackage (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[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. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeletePackageWithHttpInfo (string scope, string code, int operationIndex=0, ConfigurationOptions? opts=null)
	[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. More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	DeletePackageAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	DeletePackageWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[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. More...

Package	GetPackage (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetPackage: Get Package Fetch a Package that matches the specified identifier More...

Lusid.Sdk.Client.ApiResponse< Package >	GetPackageWithHttpInfo (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetPackage: Get Package Fetch a Package that matches the specified identifier More...

async 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), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetPackage: Get Package Fetch a Package that matches the specified identifier More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] GetPackage: Get Package Fetch a Package that matches the specified identifier More...

PagedResourceListOfPackage	ListPackages (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, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListPackages: List Packages Fetch the last pre-AsAt date version of each package in scope (does not fetch the entire history). More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfPackage >	ListPackagesWithHttpInfo (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, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListPackages: List Packages Fetch the last pre-AsAt date version of each package in scope (does not fetch the entire history). More...

async 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), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListPackages: List Packages Fetch the last pre-AsAt date version of each package in scope (does not fetch the entire history). More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] ListPackages: List Packages Fetch the last pre-AsAt date version of each package in scope (does not fetch the entire history). More...

ResourceListOfPackage	UpsertPackages (PackageSetRequest? packageSetRequest=default(PackageSetRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertPackages: Upsert Package Upsert; update existing packages with given ids, or create new packages otherwise. More...

Lusid.Sdk.Client.ApiResponse< ResourceListOfPackage >	UpsertPackagesWithHttpInfo (PackageSetRequest? packageSetRequest=default(PackageSetRequest?), int operationIndex=0, ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertPackages: Upsert Package Upsert; update existing packages with given ids, or create new packages otherwise. More...

async System.Threading.Tasks.Task< ResourceListOfPackage >	UpsertPackagesAsync (PackageSetRequest? packageSetRequest=default(PackageSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertPackages: Upsert Package Upsert; update existing packages with given ids, or create new packages otherwise. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ResourceListOfPackage > >	UpsertPackagesWithHttpInfoAsync (PackageSetRequest? packageSetRequest=default(PackageSetRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
	[EXPERIMENTAL] UpsertPackages: Upsert Package Upsert; update existing packages with given ids, or create new packages otherwise. More...

Properties
Lusid.Sdk.Client.IAsynchronousClient	AsynchronousClient `[get, set]`
	The client for accessing this underlying API asynchronously. More...

Lusid.Sdk.Client.ISynchronousClient	Client `[get, set]`
	The client for accessing this underlying API synchronously. More...

Lusid.Sdk.Client.IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

Lusid.Sdk.Client.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

Constructor & Destructor Documentation

◆ PackagesApi() [1/4]

Lusid.Sdk.Api.PackagesApi.PackagesApi ( )

inline

Initializes a new instance of the PackagesApi class.

Returns

◆ PackagesApi() [2/4]

Lusid.Sdk.Api.PackagesApi.PackagesApi ( string basePath )

inline

Initializes a new instance of the PackagesApi class.

Returns

◆ PackagesApi() [3/4]

Lusid.Sdk.Api.PackagesApi.PackagesApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the PackagesApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ PackagesApi() [4/4]

Lusid.Sdk.Api.PackagesApi.PackagesApi	(	Lusid.Sdk.Client.ISynchronousClient	client,
		Lusid.Sdk.Client.IAsynchronousClient	asyncClient,
		Lusid.Sdk.Client.IReadableConfiguration	configuration
	)

inline

Initializes a new instance of the PackagesApi class using a Configuration object and client instance.

Parameters

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ DeletePackage()

DeletedEntityResponse Lusid.Sdk.Api.PackagesApi.DeletePackage	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.IPackagesApiSync.

◆ DeletePackageAsync()

async System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.PackagesApi.DeletePackageAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: Task of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPackagesApiAsync.

◆ DeletePackageWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.PackagesApi.DeletePackageWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IPackagesApiSync.

◆ DeletePackageWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.PackagesApi.DeletePackageWithHttpInfoAsync	(	string	scope,
		string	code,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implements Lusid.Sdk.Api.IPackagesApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.PackagesApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

◆ GetPackage()

Package Lusid.Sdk.Api.PackagesApi.GetPackage	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: Package

Implements Lusid.Sdk.Api.IPackagesApiSync.

◆ GetPackageAsync()

async System.Threading.Tasks.Task<Package> Lusid.Sdk.Api.PackagesApi.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)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: Task of Package

Implements Lusid.Sdk.Api.IPackagesApiAsync.

◆ GetPackageWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Package> Lusid.Sdk.Api.PackagesApi.GetPackageWithHttpInfo	(	string	scope,
		string	code,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		List< string >?	propertyKeys = `default(List<string>?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: ApiResponse of Package

Implements Lusid.Sdk.Api.IPackagesApiSync.

◆ GetPackageWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Package> > Lusid.Sdk.Api.PackagesApi.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)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: Task of ApiResponse (Package)

Implements Lusid.Sdk.Api.IPackagesApiAsync.

◆ ListPackages()

PagedResourceListOfPackage Lusid.Sdk.Api.PackagesApi.ListPackages	(	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`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: PagedResourceListOfPackage

Implements Lusid.Sdk.Api.IPackagesApiSync.

◆ ListPackagesAsync()

async System.Threading.Tasks.Task<PagedResourceListOfPackage> Lusid.Sdk.Api.PackagesApi.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)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: Task of PagedResourceListOfPackage

Implements Lusid.Sdk.Api.IPackagesApiAsync.

◆ ListPackagesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfPackage> Lusid.Sdk.Api.PackagesApi.ListPackagesWithHttpInfo	(	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`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: ApiResponse of PagedResourceListOfPackage

Implements Lusid.Sdk.Api.IPackagesApiSync.

◆ ListPackagesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfPackage> > Lusid.Sdk.Api.PackagesApi.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)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: Task of ApiResponse (PagedResourceListOfPackage)

Implements Lusid.Sdk.Api.IPackagesApiAsync.

◆ UpsertPackages()

ResourceListOfPackage Lusid.Sdk.Api.PackagesApi.UpsertPackages	(	PackageSetRequest?	packageSetRequest = `default(PackageSetRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: ResourceListOfPackage

Implements Lusid.Sdk.Api.IPackagesApiSync.

◆ UpsertPackagesAsync()

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

inline

[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.
opts	Options for this request.

Returns: Task of ResourceListOfPackage

Implements Lusid.Sdk.Api.IPackagesApiAsync.

◆ UpsertPackagesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfPackage> Lusid.Sdk.Api.PackagesApi.UpsertPackagesWithHttpInfo	(	PackageSetRequest?	packageSetRequest = `default(PackageSetRequest?)`,
		int	operationIndex = `0`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: ApiResponse of ResourceListOfPackage

Implements Lusid.Sdk.Api.IPackagesApiSync.

◆ UpsertPackagesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfPackage> > Lusid.Sdk.Api.PackagesApi.UpsertPackagesWithHttpInfoAsync	(	PackageSetRequest?	packageSetRequest = `default(PackageSetRequest?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`,
		ConfigurationOptions?	opts = `null`
	)

inline

[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.
opts	Options for this request.

Returns: Task of ApiResponse (ResourceListOfPackage)

Implements Lusid.Sdk.Api.IPackagesApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.PackagesApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.PackagesApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.PackagesApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.PackagesApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

The documentation for this class 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

Properties

Detailed Description

Constructor & Destructor Documentation

◆ PackagesApi() [1/4]

◆ PackagesApi() [2/4]

◆ PackagesApi() [3/4]

◆ PackagesApi() [4/4]

Member Function Documentation

◆ DeletePackage()

◆ DeletePackageAsync()

◆ DeletePackageWithHttpInfo()

◆ DeletePackageWithHttpInfoAsync()

◆ GetBasePath()

◆ GetPackage()

◆ GetPackageAsync()

◆ GetPackageWithHttpInfo()

◆ GetPackageWithHttpInfoAsync()

◆ ListPackages()

◆ ListPackagesAsync()

◆ ListPackagesWithHttpInfo()

◆ ListPackagesWithHttpInfoAsync()

◆ UpsertPackages()

◆ UpsertPackagesAsync()

◆ UpsertPackagesWithHttpInfo()

◆ UpsertPackagesWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory