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

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

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

Public Member Functions

System.Threading.Tasks.Task< AddBusinessDaysToDateResponseAddBusinessDaysToDateAsync (string scope, AddBusinessDaysToDateRequest addBusinessDaysToDateRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] AddBusinessDaysToDate: Adds the requested number of Business Days to the provided date. More...
 
System.Threading.Tasks.Task< ApiResponse< AddBusinessDaysToDateResponse > > AddBusinessDaysToDateWithHttpInfoAsync (string scope, AddBusinessDaysToDateRequest addBusinessDaysToDateRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] AddBusinessDaysToDate: Adds the requested number of Business Days to the provided date. More...
 
System.Threading.Tasks.Task< CalendarDateAddDateToCalendarAsync (string scope, string code, CreateDateRequest createDateRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 AddDateToCalendar: Add a date to a calendar More...
 
System.Threading.Tasks.Task< ApiResponse< CalendarDate > > AddDateToCalendarWithHttpInfoAsync (string scope, string code, CreateDateRequest createDateRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 AddDateToCalendar: Add a date to a calendar More...
 
System.Threading.Tasks.Task< CalendarCreateCalendarAsync (CreateCalendarRequest createCalendarRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] CreateCalendar: Create a calendar in its generic form More...
 
System.Threading.Tasks.Task< ApiResponse< Calendar > > CreateCalendarWithHttpInfoAsync (CreateCalendarRequest createCalendarRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] CreateCalendar: Create a calendar in its generic form More...
 
System.Threading.Tasks.Task< CalendarDeleteCalendarAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteCalendar: Delete a calendar More...
 
System.Threading.Tasks.Task< ApiResponse< Calendar > > DeleteCalendarWithHttpInfoAsync (string scope, string code, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteCalendar: Delete a calendar More...
 
System.Threading.Tasks.Task< CalendarDateDeleteDateFromCalendarAsync (string scope, string code, string dateId, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteDateFromCalendar: Remove a date from a calendar More...
 
System.Threading.Tasks.Task< ApiResponse< CalendarDate > > DeleteDateFromCalendarWithHttpInfoAsync (string scope, string code, string dateId, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] DeleteDateFromCalendar: Remove a date from a calendar More...
 
System.Threading.Tasks.Task< List< DateTimeOffset > > GenerateScheduleAsync (string scope, ValuationSchedule valuationSchedule, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GenerateSchedule: Generate an ordered schedule of dates. More...
 
System.Threading.Tasks.Task< ApiResponse< List< DateTimeOffset > > > GenerateScheduleWithHttpInfoAsync (string scope, ValuationSchedule valuationSchedule, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GenerateSchedule: Generate an ordered schedule of dates. More...
 
System.Threading.Tasks.Task< CalendarGetCalendarAsync (string scope, string code, List< string >? propertyKeys=default(List< string >?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetCalendar: Get a calendar in its generic form More...
 
System.Threading.Tasks.Task< ApiResponse< Calendar > > GetCalendarWithHttpInfoAsync (string scope, string code, List< string >? propertyKeys=default(List< string >?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 GetCalendar: Get a calendar in its generic form More...
 
System.Threading.Tasks.Task< ResourceListOfCalendarDateGetDatesAsync (string scope, string code, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? idFilter=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetDates: Get dates for a specific calendar More...
 
System.Threading.Tasks.Task< ApiResponse< ResourceListOfCalendarDate > > GetDatesWithHttpInfoAsync (string scope, string code, DateTimeOrCutLabel? fromEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOrCutLabel? toEffectiveAt=default(DateTimeOrCutLabel?), DateTimeOffset? asAt=default(DateTimeOffset?), List< string >? idFilter=default(List< string >?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] GetDates: Get dates for a specific calendar More...
 
System.Threading.Tasks.Task< IsBusinessDayResponseIsBusinessDateTimeAsync (DateTimeOffset dateTime, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] IsBusinessDateTime: Check whether a DateTime is a &quot;Business DateTime&quot; More...
 
System.Threading.Tasks.Task< ApiResponse< IsBusinessDayResponse > > IsBusinessDateTimeWithHttpInfoAsync (DateTimeOffset dateTime, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] IsBusinessDateTime: Check whether a DateTime is a &quot;Business DateTime&quot; More...
 
System.Threading.Tasks.Task< PagedResourceListOfCalendarListCalendarsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), List< string >? propertyKeys=default(List< string >?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] ListCalendars: List Calendars More...
 
System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfCalendar > > ListCalendarsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), List< string >? propertyKeys=default(List< string >?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] ListCalendars: List Calendars More...
 
System.Threading.Tasks.Task< PagedResourceListOfCalendarListCalendarsInScopeAsync (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), List< string >? propertyKeys=default(List< string >?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 ListCalendarsInScope: List all calenders in a specified scope More...
 
System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfCalendar > > ListCalendarsInScopeWithHttpInfoAsync (string scope, DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), int? limit=default(int?), List< string >? propertyKeys=default(List< string >?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 ListCalendarsInScope: List all calenders in a specified scope More...
 
System.Threading.Tasks.Task< CalendarUpdateCalendarAsync (string scope, string code, UpdateCalendarRequest updateCalendarRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpdateCalendar: Update a calendar More...
 
System.Threading.Tasks.Task< ApiResponse< Calendar > > UpdateCalendarWithHttpInfoAsync (string scope, string code, UpdateCalendarRequest updateCalendarRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
 [EARLY ACCESS] UpdateCalendar: Update a calendar 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

◆ AddBusinessDaysToDateAsync()

System.Threading.Tasks.Task<AddBusinessDaysToDateResponse> Lusid.Sdk.Api.ICalendarsApiAsync.AddBusinessDaysToDateAsync ( string  scope,
AddBusinessDaysToDateRequest  addBusinessDaysToDateRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] AddBusinessDaysToDate: Adds the requested number of Business Days to the provided date.

A Business day is defined as a point in time that: * Does not represent a day in the calendar&#39;s weekend * Does not represent a day in the calendar&#39;s list of holidays (e.g. Christmas Day in the UK) All dates specified must be UTC and the upper bound of a calendar is not inclusive e.g. From: 2020-12-24-00-00-00: Adding 3 business days returns 2020-12-30, assuming Saturday and Sunday are weekends, and the 25th and 28th are holidays. Adding -2 business days returns 2020-12-22 under the same assumptions. If the provided number of days to add is zero, returns a failure.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope within which to search for the calendars
addBusinessDaysToDateRequestRequest Details: start date, number of days to add (which can be negative, but not zero), calendar codes and optionally an AsAt date for searching the calendar store
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of AddBusinessDaysToDateResponse

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ AddBusinessDaysToDateWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<AddBusinessDaysToDateResponse> > Lusid.Sdk.Api.ICalendarsApiAsync.AddBusinessDaysToDateWithHttpInfoAsync ( string  scope,
AddBusinessDaysToDateRequest  addBusinessDaysToDateRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] AddBusinessDaysToDate: Adds the requested number of Business Days to the provided date.

A Business day is defined as a point in time that: * Does not represent a day in the calendar&#39;s weekend * Does not represent a day in the calendar&#39;s list of holidays (e.g. Christmas Day in the UK) All dates specified must be UTC and the upper bound of a calendar is not inclusive e.g. From: 2020-12-24-00-00-00: Adding 3 business days returns 2020-12-30, assuming Saturday and Sunday are weekends, and the 25th and 28th are holidays. Adding -2 business days returns 2020-12-22 under the same assumptions. If the provided number of days to add is zero, returns a failure.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope within which to search for the calendars
addBusinessDaysToDateRequestRequest Details: start date, number of days to add (which can be negative, but not zero), calendar codes and optionally an AsAt date for searching the calendar store
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (AddBusinessDaysToDateResponse)

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ AddDateToCalendarAsync()

System.Threading.Tasks.Task<CalendarDate> Lusid.Sdk.Api.ICalendarsApiAsync.AddDateToCalendarAsync ( string  scope,
string  code,
CreateDateRequest  createDateRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

AddDateToCalendar: Add a date to a calendar

Add an event to the calendar. These Events can be a maximum of 24 hours and must be specified in UTC. A local date will be calculated by the system and applied to the calendar before processing.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the calendar
codeCode of the calendar
createDateRequestAdd date to calendar request
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of CalendarDate

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ AddDateToCalendarWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<CalendarDate> > Lusid.Sdk.Api.ICalendarsApiAsync.AddDateToCalendarWithHttpInfoAsync ( string  scope,
string  code,
CreateDateRequest  createDateRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

AddDateToCalendar: Add a date to a calendar

Add an event to the calendar. These Events can be a maximum of 24 hours and must be specified in UTC. A local date will be calculated by the system and applied to the calendar before processing.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the calendar
codeCode of the calendar
createDateRequestAdd date to calendar request
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (CalendarDate)

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ CreateCalendarAsync()

System.Threading.Tasks.Task<Calendar> Lusid.Sdk.Api.ICalendarsApiAsync.CreateCalendarAsync ( CreateCalendarRequest  createCalendarRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] CreateCalendar: Create a calendar in its generic form

Create a calendar in a generic form which can be used to store date events.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createCalendarRequestA request to create the calendar
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Calendar

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ CreateCalendarWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Calendar> > Lusid.Sdk.Api.ICalendarsApiAsync.CreateCalendarWithHttpInfoAsync ( CreateCalendarRequest  createCalendarRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] CreateCalendar: Create a calendar in its generic form

Create a calendar in a generic form which can be used to store date events.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
createCalendarRequestA request to create the calendar
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Calendar)

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ DeleteCalendarAsync()

System.Threading.Tasks.Task<Calendar> Lusid.Sdk.Api.ICalendarsApiAsync.DeleteCalendarAsync ( string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] DeleteCalendar: Delete a calendar

Delete a calendar and all of its respective dates

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the calendar
codeCode of the calendar
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Calendar

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ DeleteCalendarWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Calendar> > Lusid.Sdk.Api.ICalendarsApiAsync.DeleteCalendarWithHttpInfoAsync ( string  scope,
string  code,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] DeleteCalendar: Delete a calendar

Delete a calendar and all of its respective dates

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the calendar
codeCode of the calendar
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Calendar)

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ DeleteDateFromCalendarAsync()

System.Threading.Tasks.Task<CalendarDate> Lusid.Sdk.Api.ICalendarsApiAsync.DeleteDateFromCalendarAsync ( string  scope,
string  code,
string  dateId,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] DeleteDateFromCalendar: Remove a date from a calendar

Remove a date from a calendar.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the calendar
codeCode of the calendar
dateIdIdentifier of the date to be removed
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of CalendarDate

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ DeleteDateFromCalendarWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<CalendarDate> > Lusid.Sdk.Api.ICalendarsApiAsync.DeleteDateFromCalendarWithHttpInfoAsync ( string  scope,
string  code,
string  dateId,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] DeleteDateFromCalendar: Remove a date from a calendar

Remove a date from a calendar.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the calendar
codeCode of the calendar
dateIdIdentifier of the date to be removed
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (CalendarDate)

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ GenerateScheduleAsync()

System.Threading.Tasks.Task<List<DateTimeOffset> > Lusid.Sdk.Api.ICalendarsApiAsync.GenerateScheduleAsync ( string  scope,
ValuationSchedule  valuationSchedule,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] GenerateSchedule: Generate an ordered schedule of dates.

Returns an ordered array of dates. The dates will only fall on business days as defined by the scope and calendar codes in the valuation schedule. Valuations are made at a frequency defined by the valuation schedule&#39;s tenor, e.g. every day (&quot;1D&quot;), every other week (&quot;2W&quot;) etc. These dates will be adjusted onto business days as defined by the schedule&#39;s rollConvention.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the calendars to use
valuationScheduleThe ValuationSchedule to generate schedule dates from
asAtOptional AsAt for searching the calendar store. Defaults to Latest. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of List<DateTimeOffset>

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ GenerateScheduleWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<List<DateTimeOffset> > > Lusid.Sdk.Api.ICalendarsApiAsync.GenerateScheduleWithHttpInfoAsync ( string  scope,
ValuationSchedule  valuationSchedule,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] GenerateSchedule: Generate an ordered schedule of dates.

Returns an ordered array of dates. The dates will only fall on business days as defined by the scope and calendar codes in the valuation schedule. Valuations are made at a frequency defined by the valuation schedule&#39;s tenor, e.g. every day (&quot;1D&quot;), every other week (&quot;2W&quot;) etc. These dates will be adjusted onto business days as defined by the schedule&#39;s rollConvention.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the calendars to use
valuationScheduleThe ValuationSchedule to generate schedule dates from
asAtOptional AsAt for searching the calendar store. Defaults to Latest. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (List<DateTimeOffset>)

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ GetCalendarAsync()

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

GetCalendar: Get a calendar in its generic form

Retrieve a generic calendar by a specific ID at a point in AsAt time

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the calendar identifier
codeCode of the calendar identifier
propertyKeysA list of property keys from the &quot;Calendar&quot; domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. &quot;Calendar/System/Name&quot;. (optional)
asAtThe AsAt datetime at which to retrieve the calendar (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Calendar

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ GetCalendarWithHttpInfoAsync()

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

GetCalendar: Get a calendar in its generic form

Retrieve a generic calendar by a specific ID at a point in AsAt time

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the calendar identifier
codeCode of the calendar identifier
propertyKeysA list of property keys from the &quot;Calendar&quot; domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. &quot;Calendar/System/Name&quot;. (optional)
asAtThe AsAt datetime at which to retrieve the calendar (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Calendar)

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ GetDatesAsync()

System.Threading.Tasks.Task<ResourceListOfCalendarDate> Lusid.Sdk.Api.ICalendarsApiAsync.GetDatesAsync ( string  scope,
string  code,
DateTimeOrCutLabel fromEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel toEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  idFilter = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] GetDates: Get dates for a specific calendar

Get dates from a specific calendar within a specific window of effective time, at a point in AsAt time. Providing an id filter can further refine the results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the calendar
codeCode of the calendar
fromEffectiveAtWhere the effective window of dates should begin from (optional)
toEffectiveAtWhere the effective window of dates should end (optional)
asAtAsAt the dates should be retrieved at (optional)
idFilterAn additional filter that will filter dates based on their identifer (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ResourceListOfCalendarDate

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ GetDatesWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<ResourceListOfCalendarDate> > Lusid.Sdk.Api.ICalendarsApiAsync.GetDatesWithHttpInfoAsync ( string  scope,
string  code,
DateTimeOrCutLabel fromEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOrCutLabel toEffectiveAt = default(DateTimeOrCutLabel?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
List< string >?  idFilter = default(List< string >?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] GetDates: Get dates for a specific calendar

Get dates from a specific calendar within a specific window of effective time, at a point in AsAt time. Providing an id filter can further refine the results.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the calendar
codeCode of the calendar
fromEffectiveAtWhere the effective window of dates should begin from (optional)
toEffectiveAtWhere the effective window of dates should end (optional)
asAtAsAt the dates should be retrieved at (optional)
idFilterAn additional filter that will filter dates based on their identifer (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (ResourceListOfCalendarDate)

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ IsBusinessDateTimeAsync()

System.Threading.Tasks.Task<IsBusinessDayResponse> Lusid.Sdk.Api.ICalendarsApiAsync.IsBusinessDateTimeAsync ( DateTimeOffset  dateTime,
string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] IsBusinessDateTime: Check whether a DateTime is a &quot;Business DateTime&quot;

A Business DateTime is defined as a point in time that: * Does not represent a day that overlaps with the calendars WeekendMask * If the calendar is a &quot;Holiday Calendar&quot; Does not overlap with any dates in the calendar * If the calendar is a &quot;TradingHours Calendar&quot; Does overlap with a date in the calendar All dates specified must be UTC and the upper bound of a calendar is not inclusive e.g. From: 2020-12-25-00-00-00 To: 2020-12-26-00-00-00 IsBusinessDay(2020-12-26-00-00-00) &#x3D;&#x3D; false

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
dateTimeDateTime to check - This DateTime must be UTC
scopeScope of the calendar
codeCode of the calendar
asAtAsAt for the request (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of IsBusinessDayResponse

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ IsBusinessDateTimeWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<IsBusinessDayResponse> > Lusid.Sdk.Api.ICalendarsApiAsync.IsBusinessDateTimeWithHttpInfoAsync ( DateTimeOffset  dateTime,
string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] IsBusinessDateTime: Check whether a DateTime is a &quot;Business DateTime&quot;

A Business DateTime is defined as a point in time that: * Does not represent a day that overlaps with the calendars WeekendMask * If the calendar is a &quot;Holiday Calendar&quot; Does not overlap with any dates in the calendar * If the calendar is a &quot;TradingHours Calendar&quot; Does overlap with a date in the calendar All dates specified must be UTC and the upper bound of a calendar is not inclusive e.g. From: 2020-12-25-00-00-00 To: 2020-12-26-00-00-00 IsBusinessDay(2020-12-26-00-00-00) &#x3D;&#x3D; false

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
dateTimeDateTime to check - This DateTime must be UTC
scopeScope of the calendar
codeCode of the calendar
asAtAsAt for the request (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (IsBusinessDayResponse)

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ ListCalendarsAsync()

System.Threading.Tasks.Task<PagedResourceListOfCalendar> Lusid.Sdk.Api.ICalendarsApiAsync.ListCalendarsAsync ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
List< string >?  propertyKeys = default(List< string >?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] ListCalendars: List Calendars

List calendars at a point in AsAt time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe AsAt datetime at which to retrieve the calendars (optional)
pageThe pagination token to use to continue listing calendars from a previous call to list calendars. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
propertyKeysA list of property keys from the &quot;Calendar&quot; domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. &quot;Calendar/System/Name&quot;. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PagedResourceListOfCalendar

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ ListCalendarsInScopeAsync()

System.Threading.Tasks.Task<PagedResourceListOfCalendar> Lusid.Sdk.Api.ICalendarsApiAsync.ListCalendarsInScopeAsync ( string  scope,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
List< string >?  propertyKeys = default(List< string >?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

ListCalendarsInScope: List all calenders in a specified scope

List calendars in a Scope at a point in AsAt time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the calendars
asAtThe AsAt datetime at which to retrieve the calendars (optional)
pageThe pagination token to use to continue listing calendars from a previous call to list calendars. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
propertyKeysA list of property keys from the &quot;Calendar&quot; domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. &quot;Calendar/System/Name&quot;. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of PagedResourceListOfCalendar

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ ListCalendarsInScopeWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfCalendar> > Lusid.Sdk.Api.ICalendarsApiAsync.ListCalendarsInScopeWithHttpInfoAsync ( string  scope,
DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
List< string >?  propertyKeys = default(List< string >?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

ListCalendarsInScope: List all calenders in a specified scope

List calendars in a Scope at a point in AsAt time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the calendars
asAtThe AsAt datetime at which to retrieve the calendars (optional)
pageThe pagination token to use to continue listing calendars from a previous call to list calendars. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
propertyKeysA list of property keys from the &quot;Calendar&quot; domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. &quot;Calendar/System/Name&quot;. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PagedResourceListOfCalendar)

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ ListCalendarsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfCalendar> > Lusid.Sdk.Api.ICalendarsApiAsync.ListCalendarsWithHttpInfoAsync ( DateTimeOffset?  asAt = default(DateTimeOffset?),
string?  page = default(string?),
int?  limit = default(int?),
List< string >?  propertyKeys = default(List< string >?),
string?  filter = default(string?),
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] ListCalendars: List Calendars

List calendars at a point in AsAt time.

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
asAtThe AsAt datetime at which to retrieve the calendars (optional)
pageThe pagination token to use to continue listing calendars from a previous call to list calendars. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, and asAt fields must not have changed since the original request. (optional)
limitWhen paginating, limit the number of returned results to this many. (optional)
propertyKeysA list of property keys from the &quot;Calendar&quot; domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. &quot;Calendar/System/Name&quot;. (optional)
filterExpression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (PagedResourceListOfCalendar)

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ UpdateCalendarAsync()

System.Threading.Tasks.Task<Calendar> Lusid.Sdk.Api.ICalendarsApiAsync.UpdateCalendarAsync ( string  scope,
string  code,
UpdateCalendarRequest  updateCalendarRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] UpdateCalendar: Update a calendar

Update the calendars WeekendMask, SourceProvider or Properties

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the request
codeCode of the request
updateCalendarRequestThe new state of the calendar
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of Calendar

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ UpdateCalendarWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<Calendar> > Lusid.Sdk.Api.ICalendarsApiAsync.UpdateCalendarWithHttpInfoAsync ( string  scope,
string  code,
UpdateCalendarRequest  updateCalendarRequest,
int  operationIndex = 0,
System.Threading.CancellationToken  cancellationToken = default(System.Threading.CancellationToken) 
)

[EARLY ACCESS] UpdateCalendar: Update a calendar

Update the calendars WeekendMask, SourceProvider or Properties

Exceptions
Lusid.Sdk.Client.ApiExceptionThrown when fails to make API call
Parameters
scopeScope of the request
codeCode of the request
updateCalendarRequestThe new state of the calendar
operationIndexIndex associated with the operation.
cancellationTokenCancellation Token to cancel the request.
Returns
Task of ApiResponse (Calendar)

Implemented in Lusid.Sdk.Api.CalendarsApi.


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