LUSID C# SDK
Public Member Functions | List of all members
Lusid.Sdk.Api.ITimelinesApiAsync Interface Reference

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

Inheritance diagram for Lusid.Sdk.Api.ITimelinesApiAsync:
Inheritance graph
[legend]

Public Member Functions

System.Threading.Tasks.Task< ClosedPeriodConfirmClosedPeriodAsync (string scope, string code, string closedPeriodId, Object? body=default(Object?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ConfirmClosedPeriod: Confirm a Closed Period against a Timeline Entity More...
 
System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ClosedPeriod > > ConfirmClosedPeriodWithHttpInfoAsync (string scope, string code, string closedPeriodId, Object? body=default(Object?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ConfirmClosedPeriod: Confirm a Closed Period against a Timeline Entity More...
 
System.Threading.Tasks.Task< ClosedPeriodCreateClosedPeriodAsync (string scope, string code, CreateClosedPeriodRequest? createClosedPeriodRequest=default(CreateClosedPeriodRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] CreateClosedPeriod: Create a new closed period against a timeline entity More...
 
System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ClosedPeriod > > CreateClosedPeriodWithHttpInfoAsync (string scope, string code, CreateClosedPeriodRequest? createClosedPeriodRequest=default(CreateClosedPeriodRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] CreateClosedPeriod: Create a new closed period against a timeline entity More...
 
System.Threading.Tasks.Task< ClosedPeriodCreateClosedPeriodCandidateAsync (string scope, string code, CreateClosedPeriodRequest? createClosedPeriodRequest=default(CreateClosedPeriodRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] CreateClosedPeriodCandidate: Create a new closed period candidate against a timeline entity More...
 
System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ClosedPeriod > > CreateClosedPeriodCandidateWithHttpInfoAsync (string scope, string code, CreateClosedPeriodRequest? createClosedPeriodRequest=default(CreateClosedPeriodRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] CreateClosedPeriodCandidate: Create a new closed period candidate against a timeline entity More...
 
System.Threading.Tasks.Task< TimelineCreateTimelineAsync (CreateTimelineRequest? createTimelineRequest=default(CreateTimelineRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] CreateTimeline: Create a Timeline More...
 
System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Timeline > > CreateTimelineWithHttpInfoAsync (CreateTimelineRequest? createTimelineRequest=default(CreateTimelineRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] CreateTimeline: Create a Timeline More...
 
System.Threading.Tasks.Task< DeletedEntityResponseDeleteTimelineAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] DeleteTimeline: Deletes a particular Timeline More...
 
System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > > DeleteTimelineWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] DeleteTimeline: Deletes a particular Timeline More...
 
System.Threading.Tasks.Task< ClosedPeriodGetClosedPeriodAsync (string scope, string code, string closedPeriodId, 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] GetClosedPeriod: Gets a Closed Period entity. More...
 
System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ClosedPeriod > > GetClosedPeriodWithHttpInfoAsync (string scope, string code, string closedPeriodId, 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] GetClosedPeriod: Gets a Closed Period entity. More...
 
System.Threading.Tasks.Task< TimelineGetTimelineAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] GetTimeline: Get a single Timeline by scope and code. More...
 
System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Timeline > > GetTimelineWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] GetTimeline: Get a single Timeline by scope and code. More...
 
System.Threading.Tasks.Task< PagedResourceListOfClosedPeriodListClosedPeriodsAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListClosedPeriods: List ClosedPeriods for a specified Timeline. More...
 
System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfClosedPeriod > > ListClosedPeriodsWithHttpInfoAsync (string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListClosedPeriods: List ClosedPeriods for a specified Timeline. More...
 
System.Threading.Tasks.Task< PagedResourceListOfTimelineListTimelinesAsync (DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListTimelines: List Timelines More...
 
System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< PagedResourceListOfTimeline > > ListTimelinesWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), DateTimeOrCutLabel? effectiveAt=default(DateTimeOrCutLabel?), string? page=default(string?), int? limit=default(int?), string? filter=default(string?), List< string >? sortBy=default(List< string >?), List< string >? propertyKeys=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] ListTimelines: List Timelines More...
 
System.Threading.Tasks.Task< ClosedPeriodSetPostCloseActivityAsync (string scope, string code, string closedPeriodId, PostCloseActivitiesRequest? postCloseActivitiesRequest=default(PostCloseActivitiesRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] SetPostCloseActivity: Sets post-close activities to a Closed Period. More...
 
System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ClosedPeriod > > SetPostCloseActivityWithHttpInfoAsync (string scope, string code, string closedPeriodId, PostCloseActivitiesRequest? postCloseActivitiesRequest=default(PostCloseActivitiesRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] SetPostCloseActivity: Sets post-close activities to a Closed Period. More...
 
System.Threading.Tasks.Task< ClosedPeriodUnconfirmClosedPeriodAsync (string scope, string code, string closedPeriodId, Object? body=default(Object?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] UnconfirmClosedPeriod: Unconfirm the last confirmed Closed Period against a Timeline Entity More...
 
System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< ClosedPeriod > > UnconfirmClosedPeriodWithHttpInfoAsync (string scope, string code, string closedPeriodId, Object? body=default(Object?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] UnconfirmClosedPeriod: Unconfirm the last confirmed Closed Period against a Timeline Entity More...
 
System.Threading.Tasks.Task< TimelineUpdateTimelineAsync (string scope, string code, UpdateTimelineRequest? updateTimelineRequest=default(UpdateTimelineRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] UpdateTimeline: Update Timeline defined by scope and code More...
 
System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Timeline > > UpdateTimelineWithHttpInfoAsync (string scope, string code, UpdateTimelineRequest? updateTimelineRequest=default(UpdateTimelineRequest?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken), ConfigurationOptions? opts=null)
 [EXPERIMENTAL] UpdateTimeline: Update Timeline defined by scope and code More...
 

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ ConfirmClosedPeriodAsync()

System.Threading.Tasks.Task<ClosedPeriod> Lusid.Sdk.Api.ITimelinesApiAsync.ConfirmClosedPeriodAsync ( string  scope,
string  code,
string  closedPeriodId,
Object?  body = default(Object?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] ConfirmClosedPeriod: Confirm a Closed Period against a Timeline Entity

Confirms a Closed Period against a Timeline Entity. Deletes any other unconfirmed Closed Periods on the Timeline.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified Timeline.
codeThe code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.
closedPeriodIdThe id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod
bodyNot in use at the moment (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ ConfirmClosedPeriodWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ClosedPeriod> > Lusid.Sdk.Api.ITimelinesApiAsync.ConfirmClosedPeriodWithHttpInfoAsync ( string  scope,
string  code,
string  closedPeriodId,
Object?  body = default(Object?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] ConfirmClosedPeriod: Confirm a Closed Period against a Timeline Entity

Confirms a Closed Period against a Timeline Entity. Deletes any other unconfirmed Closed Periods on the Timeline.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified Timeline.
codeThe code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.
closedPeriodIdThe id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod
bodyNot in use at the moment (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ClosedPeriod)

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ CreateClosedPeriodAsync()

System.Threading.Tasks.Task<ClosedPeriod> Lusid.Sdk.Api.ITimelinesApiAsync.CreateClosedPeriodAsync ( string  scope,
string  code,
CreateClosedPeriodRequest createClosedPeriodRequest = default(CreateClosedPeriodRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] CreateClosedPeriod: Create a new closed period against a timeline entity

Creates a new closed period against a timeline entity Returns the newly created closed period entity with properties

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified Timeline.
codeThe code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.
createClosedPeriodRequestThe request containing the details of the Closed Period (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ CreateClosedPeriodCandidateAsync()

System.Threading.Tasks.Task<ClosedPeriod> Lusid.Sdk.Api.ITimelinesApiAsync.CreateClosedPeriodCandidateAsync ( string  scope,
string  code,
CreateClosedPeriodRequest createClosedPeriodRequest = default(CreateClosedPeriodRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] CreateClosedPeriodCandidate: Create a new closed period candidate against a timeline entity

Creates a new closed period candidate against a timeline entity Returns the newly created closed period candidate entity with properties

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified Timeline.
codeThe code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.
createClosedPeriodRequestThe request containing the details of the Closed Period (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ CreateClosedPeriodCandidateWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ClosedPeriod> > Lusid.Sdk.Api.ITimelinesApiAsync.CreateClosedPeriodCandidateWithHttpInfoAsync ( string  scope,
string  code,
CreateClosedPeriodRequest createClosedPeriodRequest = default(CreateClosedPeriodRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] CreateClosedPeriodCandidate: Create a new closed period candidate against a timeline entity

Creates a new closed period candidate against a timeline entity Returns the newly created closed period candidate entity with properties

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified Timeline.
codeThe code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.
createClosedPeriodRequestThe request containing the details of the Closed Period (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ClosedPeriod)

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ CreateClosedPeriodWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ClosedPeriod> > Lusid.Sdk.Api.ITimelinesApiAsync.CreateClosedPeriodWithHttpInfoAsync ( string  scope,
string  code,
CreateClosedPeriodRequest createClosedPeriodRequest = default(CreateClosedPeriodRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] CreateClosedPeriod: Create a new closed period against a timeline entity

Creates a new closed period against a timeline entity Returns the newly created closed period entity with properties

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified Timeline.
codeThe code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.
createClosedPeriodRequestThe request containing the details of the Closed Period (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ClosedPeriod)

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ CreateTimelineAsync()

System.Threading.Tasks.Task<Timeline> Lusid.Sdk.Api.ITimelinesApiAsync.CreateTimelineAsync ( CreateTimelineRequest createTimelineRequest = default(CreateTimelineRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] CreateTimeline: Create a Timeline

Creates a Timeline. Returns the created Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Upserted Properties will be returned at the latest AsAt and EffectiveAt

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createTimelineRequestThe request containing the details of the Timeline (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of Timeline

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ CreateTimelineWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Timeline> > Lusid.Sdk.Api.ITimelinesApiAsync.CreateTimelineWithHttpInfoAsync ( CreateTimelineRequest createTimelineRequest = default(CreateTimelineRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] CreateTimeline: Create a Timeline

Creates a Timeline. Returns the created Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Upserted Properties will be returned at the latest AsAt and EffectiveAt

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createTimelineRequestThe request containing the details of the Timeline (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (Timeline)

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ DeleteTimelineAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.ITimelinesApiAsync.DeleteTimelineAsync ( string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] DeleteTimeline: Deletes a particular Timeline

The deletion will take effect from the Timeline deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified Timeline.
codeThe code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ DeleteTimelineWithHttpInfoAsync()

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

[EXPERIMENTAL] DeleteTimeline: Deletes a particular Timeline

The deletion will take effect from the Timeline deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified Timeline.
codeThe code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ GetClosedPeriodAsync()

System.Threading.Tasks.Task<ClosedPeriod> Lusid.Sdk.Api.ITimelinesApiAsync.GetClosedPeriodAsync ( string  scope,
string  code,
string  closedPeriodId,
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] GetClosedPeriod: Gets a Closed Period entity.

Retrieves one ClosedPeriod uniquely defined by the Timelines Scope/Code and a ClosedPeriodId.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Timeline.
codeThe code of the Timeline. Together with the scope this uniquely identifies the Timeline.
closedPeriodIdThe id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod
asAtThe asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified. (optional)
propertyKeysA list of property keys from the &#39;ClosedPeriod&#39; domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example &#39;ClosedPeriod/system/Name&#39;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ GetClosedPeriodWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ClosedPeriod> > Lusid.Sdk.Api.ITimelinesApiAsync.GetClosedPeriodWithHttpInfoAsync ( string  scope,
string  code,
string  closedPeriodId,
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] GetClosedPeriod: Gets a Closed Period entity.

Retrieves one ClosedPeriod uniquely defined by the Timelines Scope/Code and a ClosedPeriodId.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Timeline.
codeThe code of the Timeline. Together with the scope this uniquely identifies the Timeline.
closedPeriodIdThe id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod
asAtThe asAt datetime at which to retrieve the ClosedPeriod definition. Defaults to return the latest version of the definition if not specified. (optional)
propertyKeysA list of property keys from the &#39;ClosedPeriod&#39; domain to decorate onto the ClosedPeriod. These must have the format {domain}/{scope}/{code}, for example &#39;ClosedPeriod/system/Name&#39;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ClosedPeriod)

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ GetTimelineAsync()

System.Threading.Tasks.Task<Timeline> Lusid.Sdk.Api.ITimelinesApiAsync.GetTimelineAsync ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] GetTimeline: Get a single Timeline by scope and code.

Retrieves one Timeline by scope and code. Timelines are mono-temporal. The EffectiveAt is only applied to Time-Variant Properties.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified Timeline.
codeThe code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.
asAtThe asAt datetime at which to retrieve the Timeline definition. Defaults to return the latest version of the definition if not specified. (optional)
effectiveAtThe effective datetime or cut label at which to retrieve the timeline properties. Defaults to the current LUSID system datetime if not specified. (optional)
propertyKeysA list of property keys from the &#39;Timeline&#39; domain to decorate onto the Timeline. These must have the format {domain}/{scope}/{code}, for example &#39;Timeline/system/Name&#39;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of Timeline

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ GetTimelineWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Timeline> > Lusid.Sdk.Api.ITimelinesApiAsync.GetTimelineWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] GetTimeline: Get a single Timeline by scope and code.

Retrieves one Timeline by scope and code. Timelines are mono-temporal. The EffectiveAt is only applied to Time-Variant Properties.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified Timeline.
codeThe code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.
asAtThe asAt datetime at which to retrieve the Timeline definition. Defaults to return the latest version of the definition if not specified. (optional)
effectiveAtThe effective datetime or cut label at which to retrieve the timeline properties. Defaults to the current LUSID system datetime if not specified. (optional)
propertyKeysA list of property keys from the &#39;Timeline&#39; domain to decorate onto the Timeline. These must have the format {domain}/{scope}/{code}, for example &#39;Timeline/system/Name&#39;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (Timeline)

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ ListClosedPeriodsAsync()

System.Threading.Tasks.Task<PagedResourceListOfClosedPeriod> Lusid.Sdk.Api.ITimelinesApiAsync.ListClosedPeriodsAsync ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] ListClosedPeriods: List ClosedPeriods for a specified Timeline.

List all the ClosedPeriods matching a particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Timeline.
codeThe code of the Timeline.
asAtThe asAt datetime at which to list the ClosedPeriods. Defaults to returning the latest version of each ClosedPeriod if not specified. (optional)
pageThe pagination token to use to continue listing ClosedPeriods; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the effectiveEnd, specify &quot;effectiveEnd gt 2019-01-15T10:00:00&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
propertyKeysA list of property keys from the &#39;ClosedPeriod&#39; domain to decorate onto each ClosedPeriod. These must take the format {domain}/{scope}/{code}, for example &#39;ClosedPeriod/Account/id&#39;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of PagedResourceListOfClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ ListClosedPeriodsWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfClosedPeriod> > Lusid.Sdk.Api.ITimelinesApiAsync.ListClosedPeriodsWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] ListClosedPeriods: List ClosedPeriods for a specified Timeline.

List all the ClosedPeriods matching a particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Timeline.
codeThe code of the Timeline.
asAtThe asAt datetime at which to list the ClosedPeriods. Defaults to returning the latest version of each ClosedPeriod if not specified. (optional)
pageThe pagination token to use to continue listing ClosedPeriods; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the effectiveEnd, specify &quot;effectiveEnd gt 2019-01-15T10:00:00&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
propertyKeysA list of property keys from the &#39;ClosedPeriod&#39; domain to decorate onto each ClosedPeriod. These must take the format {domain}/{scope}/{code}, for example &#39;ClosedPeriod/Account/id&#39;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (PagedResourceListOfClosedPeriod)

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ ListTimelinesAsync()

System.Threading.Tasks.Task<PagedResourceListOfTimeline> Lusid.Sdk.Api.ITimelinesApiAsync.ListTimelinesAsync ( DateTimeOffset?  asAt = default(DateTimeOffset?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] ListTimelines: List Timelines

List all the Timelines matching a particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to list the Timelines. Defaults to returning the latest version of each Timeline if not specified. (optional)
effectiveAtThe effective datetime or cut label at which to list the Timelines. Note that Timelines are monotemporal, the effectiveAt is for Timevariant Properties on the Timeline only. Defaults to the current LUSID system datetime if not specified. (optional)
pageThe pagination token to use to continue listing Timelines; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the displayName, specify &quot;displayName eq &#39;AccountingTimeline&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
propertyKeysA list of property keys from the &#39;Timeline&#39; domain to decorate onto each Timeline. These must take the format {domain}/{scope}/{code}, for example &#39;Timeline/Account/id&#39;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of PagedResourceListOfTimeline

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ ListTimelinesWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfTimeline> > Lusid.Sdk.Api.ITimelinesApiAsync.ListTimelinesWithHttpInfoAsync ( DateTimeOffset?  asAt = default(DateTimeOffset?),
DateTimeOrCutLabel effectiveAt = default(DateTimeOrCutLabel?),
string?  page = default(string?),
int?  limit = default(int?),
string?  filter = default(string?),
List< string >?  sortBy = default(List< string >?),
List< string >?  propertyKeys = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] ListTimelines: List Timelines

List all the Timelines matching a particular criteria.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe asAt datetime at which to list the Timelines. Defaults to returning the latest version of each Timeline if not specified. (optional)
effectiveAtThe effective datetime or cut label at which to list the Timelines. Note that Timelines are monotemporal, the effectiveAt is for Timevariant Properties on the Timeline only. Defaults to the current LUSID system datetime if not specified. (optional)
pageThe pagination token to use to continue listing Timelines; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the results to this number. Defaults to 100 if not specified. (optional)
filterExpression to filter the results. For example, to filter on the displayName, specify &quot;displayName eq &#39;AccountingTimeline&#39;&quot;. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914. (optional)
sortByA list of field names or properties to sort by, each suffixed by &quot; ASC&quot; or &quot; DESC&quot; (optional)
propertyKeysA list of property keys from the &#39;Timeline&#39; domain to decorate onto each Timeline. These must take the format {domain}/{scope}/{code}, for example &#39;Timeline/Account/id&#39;. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (PagedResourceListOfTimeline)

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ SetPostCloseActivityAsync()

System.Threading.Tasks.Task<ClosedPeriod> Lusid.Sdk.Api.ITimelinesApiAsync.SetPostCloseActivityAsync ( string  scope,
string  code,
string  closedPeriodId,
PostCloseActivitiesRequest postCloseActivitiesRequest = default(PostCloseActivitiesRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] SetPostCloseActivity: Sets post-close activities to a Closed Period.

This sets the given post-close activities to the given Closed Period. This is an overwriting action! The possible types of entity are: * &#x60;PortfolioTransaction&#x60;, * &#x60;Instrument&#x60;, * &#x60;InstrumentEvent&#x60;, * &#x60;InstrumentEventInstruction&#x60;, * &#x60;PortfolioSettlementInstruction&#x60;, and, * &#x60;Quote&#x60;.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Timeline.
codeThe code of the Timeline.
closedPeriodIdThe ID of the Closed Period. This ID together with the scope and code of the Timeline uniquely defines the Closed Period.
postCloseActivitiesRequestThis specifies a collection of post-close activities. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ SetPostCloseActivityWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ClosedPeriod> > Lusid.Sdk.Api.ITimelinesApiAsync.SetPostCloseActivityWithHttpInfoAsync ( string  scope,
string  code,
string  closedPeriodId,
PostCloseActivitiesRequest postCloseActivitiesRequest = default(PostCloseActivitiesRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] SetPostCloseActivity: Sets post-close activities to a Closed Period.

This sets the given post-close activities to the given Closed Period. This is an overwriting action! The possible types of entity are: * &#x60;PortfolioTransaction&#x60;, * &#x60;Instrument&#x60;, * &#x60;InstrumentEvent&#x60;, * &#x60;InstrumentEventInstruction&#x60;, * &#x60;PortfolioSettlementInstruction&#x60;, and, * &#x60;Quote&#x60;.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the Timeline.
codeThe code of the Timeline.
closedPeriodIdThe ID of the Closed Period. This ID together with the scope and code of the Timeline uniquely defines the Closed Period.
postCloseActivitiesRequestThis specifies a collection of post-close activities. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ClosedPeriod)

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ UnconfirmClosedPeriodAsync()

System.Threading.Tasks.Task<ClosedPeriod> Lusid.Sdk.Api.ITimelinesApiAsync.UnconfirmClosedPeriodAsync ( string  scope,
string  code,
string  closedPeriodId,
Object?  body = default(Object?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] UnconfirmClosedPeriod: Unconfirm the last confirmed Closed Period against a Timeline Entity

Unconfirm the last confirmed Closed Period against a Timeline Entity

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified Timeline.
codeThe code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.
closedPeriodIdThe id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod. The closed period must be the last closed period on the Timeline.
bodyNot in use at the moment (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ClosedPeriod

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ UnconfirmClosedPeriodWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ClosedPeriod> > Lusid.Sdk.Api.ITimelinesApiAsync.UnconfirmClosedPeriodWithHttpInfoAsync ( string  scope,
string  code,
string  closedPeriodId,
Object?  body = default(Object?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] UnconfirmClosedPeriod: Unconfirm the last confirmed Closed Period against a Timeline Entity

Unconfirm the last confirmed Closed Period against a Timeline Entity

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified Timeline.
codeThe code of the specified Timeline. Together with the scope this uniquely identifies the Timeline.
closedPeriodIdThe id of the Closed Period. Together with the scope and code of the Timeline, this uniquely identifies the ClosedPeriod. The closed period must be the last closed period on the Timeline.
bodyNot in use at the moment (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (ClosedPeriod)

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ UpdateTimelineAsync()

System.Threading.Tasks.Task<Timeline> Lusid.Sdk.Api.ITimelinesApiAsync.UpdateTimelineAsync ( string  scope,
string  code,
UpdateTimelineRequest updateTimelineRequest = default(UpdateTimelineRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] UpdateTimeline: Update Timeline defined by scope and code

Overwrites an existing Timeline Update request has the same required fields as Create apart from the id. Returns the updated Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Updated Properties will be returned at the latest AsAt and EffectiveAt

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified Timeline.
codeThe code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.
updateTimelineRequestThe request containing the updated details of the Timeline (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of Timeline

Implemented in Lusid.Sdk.Api.TimelinesApi.

◆ UpdateTimelineWithHttpInfoAsync()

System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Timeline> > Lusid.Sdk.Api.ITimelinesApiAsync.UpdateTimelineWithHttpInfoAsync ( string  scope,
string  code,
UpdateTimelineRequest updateTimelineRequest = default(UpdateTimelineRequest?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken),
ConfigurationOptions opts = null 
)

[EXPERIMENTAL] UpdateTimeline: Update Timeline defined by scope and code

Overwrites an existing Timeline Update request has the same required fields as Create apart from the id. Returns the updated Timeline at the current effectiveAt. Note that Timelines are mono-temporal, however they can have Time-Variant Properties. Updated Properties will be returned at the latest AsAt and EffectiveAt

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeThe scope of the specified Timeline.
codeThe code of the specified Timeline. Together with the domain and scope this uniquely identifies the Timeline.
updateTimelineRequestThe request containing the updated details of the Timeline (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
optsOptions for this request.
Returns
Task of ApiResponse (Timeline)

Implemented in Lusid.Sdk.Api.TimelinesApi.


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