Represents a collection of functions to interact with the API endpoints More...
Inheritance diagram for Lusid.Sdk.Api.IAddressKeyDefinitionApiSync:
Public Member Functions | |
| AddressKeyDefinition | CreateAddressKeyDefinition (CreateAddressKeyDefinitionRequest createAddressKeyDefinitionRequest, int operationIndex=0, ConfigurationOptions? opts=null) |
| [EARLY ACCESS] CreateAddressKeyDefinition: Create an AddressKeyDefinition. More... | |
| Lusid.Sdk.Client.ApiResponse< AddressKeyDefinition > | CreateAddressKeyDefinitionWithHttpInfo (CreateAddressKeyDefinitionRequest createAddressKeyDefinitionRequest, int operationIndex=0, ConfigurationOptions? opts=null) |
| [EARLY ACCESS] CreateAddressKeyDefinition: Create an AddressKeyDefinition. More... | |
| AddressKeyDefinition | GetAddressKeyDefinition (string key, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
| [EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition. More... | |
| Lusid.Sdk.Client.ApiResponse< AddressKeyDefinition > | GetAddressKeyDefinitionWithHttpInfo (string key, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, ConfigurationOptions? opts=null) |
| [EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition. More... | |
| PagedResourceListOfAddressKeyDefinition | ListAddressKeyDefinitions (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
| [EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions. More... | |
| Lusid.Sdk.Client.ApiResponse< PagedResourceListOfAddressKeyDefinition > | ListAddressKeyDefinitionsWithHttpInfo (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, ConfigurationOptions? opts=null) |
| [EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions. More... | |
Detailed Description
Represents a collection of functions to interact with the API endpoints
Member Function Documentation
◆ CreateAddressKeyDefinition()
| AddressKeyDefinition Lusid.Sdk.Api.IAddressKeyDefinitionApiSync.CreateAddressKeyDefinition | ( | CreateAddressKeyDefinitionRequest | createAddressKeyDefinitionRequest, |
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EARLY ACCESS] CreateAddressKeyDefinition: Create an AddressKeyDefinition.
Create the given address key definition.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
createAddressKeyDefinitionRequest The request used to create the address key definition. operationIndex Index associated with the operation. opts Options for this request.
- Returns
- AddressKeyDefinition
Implemented in Lusid.Sdk.Api.AddressKeyDefinitionApi.
◆ CreateAddressKeyDefinitionWithHttpInfo()
| Lusid.Sdk.Client.ApiResponse<AddressKeyDefinition> Lusid.Sdk.Api.IAddressKeyDefinitionApiSync.CreateAddressKeyDefinitionWithHttpInfo | ( | CreateAddressKeyDefinitionRequest | createAddressKeyDefinitionRequest, |
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EARLY ACCESS] CreateAddressKeyDefinition: Create an AddressKeyDefinition.
Create the given address key definition.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
createAddressKeyDefinitionRequest The request used to create the address key definition. operationIndex Index associated with the operation. opts Options for this request.
- Returns
- ApiResponse of AddressKeyDefinition
Implemented in Lusid.Sdk.Api.AddressKeyDefinitionApi.
◆ GetAddressKeyDefinition()
| AddressKeyDefinition Lusid.Sdk.Api.IAddressKeyDefinitionApiSync.GetAddressKeyDefinition | ( | string | key, |
| DateTimeOffset? | asAt = default(DateTimeOffset?), |
||
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition.
Get the address key definition with the given address key at the specific asAt time.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
key The address key of the address key definition. asAt The asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified. (optional) operationIndex Index associated with the operation. opts Options for this request.
- Returns
- AddressKeyDefinition
Implemented in Lusid.Sdk.Api.AddressKeyDefinitionApi.
◆ GetAddressKeyDefinitionWithHttpInfo()
| Lusid.Sdk.Client.ApiResponse<AddressKeyDefinition> Lusid.Sdk.Api.IAddressKeyDefinitionApiSync.GetAddressKeyDefinitionWithHttpInfo | ( | string | key, |
| DateTimeOffset? | asAt = default(DateTimeOffset?), |
||
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EARLY ACCESS] GetAddressKeyDefinition: Get an AddressKeyDefinition.
Get the address key definition with the given address key at the specific asAt time.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
key The address key of the address key definition. asAt The asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified. (optional) operationIndex Index associated with the operation. opts Options for this request.
- Returns
- ApiResponse of AddressKeyDefinition
Implemented in Lusid.Sdk.Api.AddressKeyDefinitionApi.
◆ ListAddressKeyDefinitions()
| PagedResourceListOfAddressKeyDefinition Lusid.Sdk.Api.IAddressKeyDefinitionApiSync.ListAddressKeyDefinitions | ( | DateTimeOffset? | asAt = default(DateTimeOffset?), |
| string? | page = default(string?), |
||
| int? | limit = default(int?), |
||
| string? | filter = default(string?), |
||
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions.
Fetch the last pre-AsAt date version of each address key definition.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
asAt The asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified. (optional) page The pagination token to use to continue listing address key definitions from a previous call to list address key definitions. 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) 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) operationIndex Index associated with the operation. opts Options for this request.
- Returns
- PagedResourceListOfAddressKeyDefinition
Implemented in Lusid.Sdk.Api.AddressKeyDefinitionApi.
◆ ListAddressKeyDefinitionsWithHttpInfo()
| Lusid.Sdk.Client.ApiResponse<PagedResourceListOfAddressKeyDefinition> Lusid.Sdk.Api.IAddressKeyDefinitionApiSync.ListAddressKeyDefinitionsWithHttpInfo | ( | DateTimeOffset? | asAt = default(DateTimeOffset?), |
| string? | page = default(string?), |
||
| int? | limit = default(int?), |
||
| string? | filter = default(string?), |
||
| int | operationIndex = 0, |
||
| ConfigurationOptions? | opts = null |
||
| ) |
[EARLY ACCESS] ListAddressKeyDefinitions: List AddressKeyDefinitions.
Fetch the last pre-AsAt date version of each address key definition.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
asAt The asAt datetime at which to retrieve the address key definition. Defaults to return the latest version of the address key definition if not specified. (optional) page The pagination token to use to continue listing address key definitions from a previous call to list address key definitions. 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) 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) operationIndex Index associated with the operation. opts Options for this request.
- Returns
- ApiResponse of PagedResourceListOfAddressKeyDefinition
Implemented in Lusid.Sdk.Api.AddressKeyDefinitionApi.
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/AddressKeyDefinitionApi.cs
