LUSID C# SDK
Public Member Functions | Properties | List of all members
Lusid.Sdk.Api.CalendarsApi Class Reference

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

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

Public Member Functions

 CalendarsApi ()
 Initializes a new instance of the CalendarsApi class. More...
 
 CalendarsApi (string basePath)
 Initializes a new instance of the CalendarsApi class. More...
 
 CalendarsApi (Lusid.Sdk.Client.Configuration configuration)
 Initializes a new instance of the CalendarsApi class using Configuration object More...
 
 CalendarsApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
 Initializes a new instance of the CalendarsApi class using a Configuration object and client instance. More...
 
string GetBasePath ()
 Gets the base path of the API client. More...
 
AddBusinessDaysToDateResponse AddBusinessDaysToDate (string scope, AddBusinessDaysToDateRequest addBusinessDaysToDateRequest, int operationIndex=0)
 [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's weekend * Does not represent a day in the calendar'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. More...
 
Lusid.Sdk.Client.ApiResponse< AddBusinessDaysToDateResponseAddBusinessDaysToDateWithHttpInfo (string scope, AddBusinessDaysToDateRequest addBusinessDaysToDateRequest, int operationIndex=0)
 [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. More...
 
async 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. 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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. 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. More...
 
CalendarDate AddDateToCalendar (string scope, string code, CreateDateRequest createDateRequest, int operationIndex=0)
 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. More...
 
Lusid.Sdk.Client.ApiResponse< CalendarDateAddDateToCalendarWithHttpInfo (string scope, string code, CreateDateRequest createDateRequest, int operationIndex=0)
 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. More...
 
async 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 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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 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. More...
 
Calendar CreateCalendar (CreateCalendarRequest createCalendarRequest, int operationIndex=0)
 [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. More...
 
Lusid.Sdk.Client.ApiResponse< CalendarCreateCalendarWithHttpInfo (CreateCalendarRequest createCalendarRequest, int operationIndex=0)
 [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. More...
 
async 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 Create a calendar in a generic form which can be used to store date events. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Create a calendar in a generic form which can be used to store date events. More...
 
Calendar DeleteCalendar (string scope, string code, int operationIndex=0)
 [EARLY ACCESS] DeleteCalendar: Delete a calendar Delete a calendar and all of its respective dates More...
 
Lusid.Sdk.Client.ApiResponse< CalendarDeleteCalendarWithHttpInfo (string scope, string code, int operationIndex=0)
 [EARLY ACCESS] DeleteCalendar: Delete a calendar Delete a calendar and all of its respective dates More...
 
async 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 Delete a calendar and all of its respective dates More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< Calendar > > 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 More...
 
CalendarDate DeleteDateFromCalendar (string scope, string code, string dateId, int operationIndex=0)
 [EARLY ACCESS] DeleteDateFromCalendar: Remove a date from a calendar Remove a date from a calendar. More...
 
Lusid.Sdk.Client.ApiResponse< CalendarDateDeleteDateFromCalendarWithHttpInfo (string scope, string code, string dateId, int operationIndex=0)
 [EARLY ACCESS] DeleteDateFromCalendar: Remove a date from a calendar Remove a date from a calendar. More...
 
async 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 Remove a date from a calendar. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Remove a date from a calendar. More...
 
List< DateTimeOffset > GenerateSchedule (string scope, ValuationSchedule valuationSchedule, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [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. More...
 
Lusid.Sdk.Client.ApiResponse< List< DateTimeOffset > > GenerateScheduleWithHttpInfo (string scope, ValuationSchedule valuationSchedule, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [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. More...
 
async 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. 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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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. 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. More...
 
Calendar GetCalendar (string scope, string code, List< string >? propertyKeys=default(List< string >?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetCalendar: Get a calendar in its generic form Retrieve a generic calendar by a specific ID at a point in AsAt time More...
 
Lusid.Sdk.Client.ApiResponse< CalendarGetCalendarWithHttpInfo (string scope, string code, List< string >? propertyKeys=default(List< string >?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 GetCalendar: Get a calendar in its generic form Retrieve a generic calendar by a specific ID at a point in AsAt time More...
 
async 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 Retrieve a generic calendar by a specific ID at a point in AsAt time More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Retrieve a generic calendar by a specific ID at a point in AsAt time More...
 
ResourceListOfCalendarDate GetDates (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)
 [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. More...
 
Lusid.Sdk.Client.ApiResponse< ResourceListOfCalendarDateGetDatesWithHttpInfo (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)
 [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. More...
 
async 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 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. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 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. More...
 
IsBusinessDayResponse IsBusinessDateTime (DateTimeOffset dateTime, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [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 More...
 
Lusid.Sdk.Client.ApiResponse< IsBusinessDayResponseIsBusinessDateTimeWithHttpInfo (DateTimeOffset dateTime, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
 [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 More...
 
async 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; 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 More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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; 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 More...
 
PagedResourceListOfCalendar ListCalendars (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)
 [EARLY ACCESS] ListCalendars: List Calendars List calendars at a point in AsAt time. More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfCalendarListCalendarsWithHttpInfo (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)
 [EARLY ACCESS] ListCalendars: List Calendars List calendars at a point in AsAt time. More...
 
async 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 List calendars at a point in AsAt time. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 List calendars at a point in AsAt time. More...
 
PagedResourceListOfCalendar ListCalendarsInScope (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)
 ListCalendarsInScope: List all calenders in a specified scope List calendars in a Scope at a point in AsAt time. More...
 
Lusid.Sdk.Client.ApiResponse< PagedResourceListOfCalendarListCalendarsInScopeWithHttpInfo (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)
 ListCalendarsInScope: List all calenders in a specified scope List calendars in a Scope at a point in AsAt time. More...
 
async 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 List calendars in a Scope at a point in AsAt time. More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 List calendars in a Scope at a point in AsAt time. More...
 
Calendar UpdateCalendar (string scope, string code, UpdateCalendarRequest updateCalendarRequest, int operationIndex=0)
 [EARLY ACCESS] UpdateCalendar: Update a calendar Update the calendars WeekendMask, SourceProvider or Properties More...
 
Lusid.Sdk.Client.ApiResponse< CalendarUpdateCalendarWithHttpInfo (string scope, string code, UpdateCalendarRequest updateCalendarRequest, int operationIndex=0)
 [EARLY ACCESS] UpdateCalendar: Update a calendar Update the calendars WeekendMask, SourceProvider or Properties More...
 
async 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 Update the calendars WeekendMask, SourceProvider or Properties More...
 
async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Update the calendars WeekendMask, SourceProvider or Properties More...
 

Properties

Lusid.Sdk.Client.IAsynchronousClient AsynchronousClient [get, set]
 The client for accessing this underlying API asynchronously. More...
 
Lusid.Sdk.Client.ISynchronousClient Client [get, set]
 The client for accessing this underlying API synchronously. More...
 
Lusid.Sdk.Client.IReadableConfiguration Configuration [get, set]
 Gets or sets the configuration object More...
 
Lusid.Sdk.Client.ExceptionFactory ExceptionFactory [get, set]
 Provides a factory method hook for the creation of exceptions. More...
 
- 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

Constructor & Destructor Documentation

◆ CalendarsApi() [1/4]

Lusid.Sdk.Api.CalendarsApi.CalendarsApi ( )
inline

Initializes a new instance of the CalendarsApi class.

Returns

◆ CalendarsApi() [2/4]

Lusid.Sdk.Api.CalendarsApi.CalendarsApi ( string  basePath)
inline

Initializes a new instance of the CalendarsApi class.

Returns

◆ CalendarsApi() [3/4]

Lusid.Sdk.Api.CalendarsApi.CalendarsApi ( Lusid.Sdk.Client.Configuration  configuration)
inline

Initializes a new instance of the CalendarsApi class using Configuration object

Parameters
configurationAn instance of Configuration
Returns

◆ CalendarsApi() [4/4]

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

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

Parameters
clientThe client interface for synchronous API access.
asyncClientThe client interface for asynchronous API access.
configurationThe configuration object.

Member Function Documentation

◆ AddBusinessDaysToDate()

AddBusinessDaysToDateResponse Lusid.Sdk.Api.CalendarsApi.AddBusinessDaysToDate ( string  scope,
AddBusinessDaysToDateRequest  addBusinessDaysToDateRequest,
int  operationIndex = 0 
)
inline

[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.
Returns
AddBusinessDaysToDateResponse

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ AddBusinessDaysToDateAsync()

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

[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

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ AddBusinessDaysToDateWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<AddBusinessDaysToDateResponse> Lusid.Sdk.Api.CalendarsApi.AddBusinessDaysToDateWithHttpInfo ( string  scope,
AddBusinessDaysToDateRequest  addBusinessDaysToDateRequest,
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of AddBusinessDaysToDateResponse

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ AddBusinessDaysToDateWithHttpInfoAsync()

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

[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)

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ AddDateToCalendar()

CalendarDate Lusid.Sdk.Api.CalendarsApi.AddDateToCalendar ( string  scope,
string  code,
CreateDateRequest  createDateRequest,
int  operationIndex = 0 
)
inline

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.
Returns
CalendarDate

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ AddDateToCalendarAsync()

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

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

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ AddDateToCalendarWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CalendarDate> Lusid.Sdk.Api.CalendarsApi.AddDateToCalendarWithHttpInfo ( string  scope,
string  code,
CreateDateRequest  createDateRequest,
int  operationIndex = 0 
)
inline

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.
Returns
ApiResponse of CalendarDate

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ AddDateToCalendarWithHttpInfoAsync()

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

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)

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ CreateCalendar()

Calendar Lusid.Sdk.Api.CalendarsApi.CreateCalendar ( CreateCalendarRequest  createCalendarRequest,
int  operationIndex = 0 
)
inline

[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.
Returns
Calendar

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ CreateCalendarAsync()

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

[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

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ CreateCalendarWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Calendar> Lusid.Sdk.Api.CalendarsApi.CreateCalendarWithHttpInfo ( CreateCalendarRequest  createCalendarRequest,
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of Calendar

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ CreateCalendarWithHttpInfoAsync()

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

[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)

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ DeleteCalendar()

Calendar Lusid.Sdk.Api.CalendarsApi.DeleteCalendar ( string  scope,
string  code,
int  operationIndex = 0 
)
inline

[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.
Returns
Calendar

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ DeleteCalendarAsync()

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

[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

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ DeleteCalendarWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Calendar> Lusid.Sdk.Api.CalendarsApi.DeleteCalendarWithHttpInfo ( string  scope,
string  code,
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of Calendar

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ DeleteCalendarWithHttpInfoAsync()

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

[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)

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ DeleteDateFromCalendar()

CalendarDate Lusid.Sdk.Api.CalendarsApi.DeleteDateFromCalendar ( string  scope,
string  code,
string  dateId,
int  operationIndex = 0 
)
inline

[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.
Returns
CalendarDate

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ DeleteDateFromCalendarAsync()

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

[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

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ DeleteDateFromCalendarWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<CalendarDate> Lusid.Sdk.Api.CalendarsApi.DeleteDateFromCalendarWithHttpInfo ( string  scope,
string  code,
string  dateId,
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of CalendarDate

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ DeleteDateFromCalendarWithHttpInfoAsync()

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

[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)

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ GenerateSchedule()

List<DateTimeOffset> Lusid.Sdk.Api.CalendarsApi.GenerateSchedule ( string  scope,
ValuationSchedule  valuationSchedule,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[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.
Returns
List<DateTimeOffset>

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ GenerateScheduleAsync()

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

[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>

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ GenerateScheduleWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<List<DateTimeOffset> > Lusid.Sdk.Api.CalendarsApi.GenerateScheduleWithHttpInfo ( string  scope,
ValuationSchedule  valuationSchedule,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of List<DateTimeOffset>

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ GenerateScheduleWithHttpInfoAsync()

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

[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>)

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.CalendarsApi.GetBasePath ( )
inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetCalendar()

Calendar Lusid.Sdk.Api.CalendarsApi.GetCalendar ( string  scope,
string  code,
List< string >?  propertyKeys = default(List<string>?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

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.
Returns
Calendar

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ GetCalendarAsync()

async System.Threading.Tasks.Task<Calendar> Lusid.Sdk.Api.CalendarsApi.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) 
)
inline

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

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ GetCalendarWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Calendar> Lusid.Sdk.Api.CalendarsApi.GetCalendarWithHttpInfo ( string  scope,
string  code,
List< string >?  propertyKeys = default(List<string>?),
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

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.
Returns
ApiResponse of Calendar

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ GetCalendarWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<Calendar> > Lusid.Sdk.Api.CalendarsApi.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) 
)
inline

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)

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ GetDates()

ResourceListOfCalendarDate Lusid.Sdk.Api.CalendarsApi.GetDates ( 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 
)
inline

[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.
Returns
ResourceListOfCalendarDate

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ GetDatesAsync()

async System.Threading.Tasks.Task<ResourceListOfCalendarDate> Lusid.Sdk.Api.CalendarsApi.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) 
)
inline

[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

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ GetDatesWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<ResourceListOfCalendarDate> Lusid.Sdk.Api.CalendarsApi.GetDatesWithHttpInfo ( 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 
)
inline

[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.
Returns
ApiResponse of ResourceListOfCalendarDate

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ GetDatesWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<ResourceListOfCalendarDate> > Lusid.Sdk.Api.CalendarsApi.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) 
)
inline

[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)

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ IsBusinessDateTime()

IsBusinessDayResponse Lusid.Sdk.Api.CalendarsApi.IsBusinessDateTime ( DateTimeOffset  dateTime,
string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[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.
Returns
IsBusinessDayResponse

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ IsBusinessDateTimeAsync()

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

[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

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ IsBusinessDateTimeWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<IsBusinessDayResponse> Lusid.Sdk.Api.CalendarsApi.IsBusinessDateTimeWithHttpInfo ( DateTimeOffset  dateTime,
string  scope,
string  code,
DateTimeOffset?  asAt = default(DateTimeOffset?),
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of IsBusinessDayResponse

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ IsBusinessDateTimeWithHttpInfoAsync()

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

[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)

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ ListCalendars()

PagedResourceListOfCalendar Lusid.Sdk.Api.CalendarsApi.ListCalendars ( 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 
)
inline

[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.
Returns
PagedResourceListOfCalendar

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ ListCalendarsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfCalendar> Lusid.Sdk.Api.CalendarsApi.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) 
)
inline

[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

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ ListCalendarsInScope()

PagedResourceListOfCalendar Lusid.Sdk.Api.CalendarsApi.ListCalendarsInScope ( 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 
)
inline

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.
Returns
PagedResourceListOfCalendar

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ ListCalendarsInScopeAsync()

async System.Threading.Tasks.Task<PagedResourceListOfCalendar> Lusid.Sdk.Api.CalendarsApi.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) 
)
inline

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

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ ListCalendarsInScopeWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfCalendar> Lusid.Sdk.Api.CalendarsApi.ListCalendarsInScopeWithHttpInfo ( 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 
)
inline

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.
Returns
ApiResponse of PagedResourceListOfCalendar

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ ListCalendarsInScopeWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfCalendar> > Lusid.Sdk.Api.CalendarsApi.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) 
)
inline

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)

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ ListCalendarsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfCalendar> Lusid.Sdk.Api.CalendarsApi.ListCalendarsWithHttpInfo ( 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 
)
inline

[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.
Returns
ApiResponse of PagedResourceListOfCalendar

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ ListCalendarsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfCalendar> > Lusid.Sdk.Api.CalendarsApi.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) 
)
inline

[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)

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ UpdateCalendar()

Calendar Lusid.Sdk.Api.CalendarsApi.UpdateCalendar ( string  scope,
string  code,
UpdateCalendarRequest  updateCalendarRequest,
int  operationIndex = 0 
)
inline

[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.
Returns
Calendar

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ UpdateCalendarAsync()

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

[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

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

◆ UpdateCalendarWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<Calendar> Lusid.Sdk.Api.CalendarsApi.UpdateCalendarWithHttpInfo ( string  scope,
string  code,
UpdateCalendarRequest  updateCalendarRequest,
int  operationIndex = 0 
)
inline

[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.
Returns
ApiResponse of Calendar

Implements Lusid.Sdk.Api.ICalendarsApiSync.

◆ UpdateCalendarWithHttpInfoAsync()

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

[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)

Implements Lusid.Sdk.Api.ICalendarsApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.CalendarsApi.AsynchronousClient
getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.CalendarsApi.Client
getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.CalendarsApi.Configuration
getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.CalendarsApi.ExceptionFactory
getset

Provides a factory method hook for the creation of exceptions.


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