Represents a collection of functions to interact with the API endpoints More...
Inheritance diagram for Lusid.Sdk.Api.CalendarsApi:
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< AddBusinessDaysToDateResponse > | AddBusinessDaysToDateWithHttpInfo (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... | |
| async System.Threading.Tasks.Task< AddBusinessDaysToDateResponse > | 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'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... | |
| 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'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... | |
| CalendarDate | AddDateToCalendar (string scope, string code, CreateDateRequest createDateRequest, int operationIndex=0) |
| [EARLY ACCESS] 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< CalendarDate > | AddDateToCalendarWithHttpInfo (string scope, string code, CreateDateRequest createDateRequest, int operationIndex=0) |
| [EARLY ACCESS] 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< CalendarDate > | AddDateToCalendarAsync (string scope, string code, CreateDateRequest createDateRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken)) |
| [EARLY ACCESS] 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)) |
| [EARLY ACCESS] 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< Calendar > | CreateCalendarWithHttpInfo (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< Calendar > | 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. 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< Calendar > | DeleteCalendarWithHttpInfo (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< Calendar > | 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 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< CalendarDate > | DeleteDateFromCalendarWithHttpInfo (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< CalendarDate > | 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. 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's tenor, e.g. every day ("1D"), every other week ("2W") etc. These dates will be adjusted onto business days as defined by the schedule'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's tenor, e.g. every day ("1D"), every other week ("2W") etc. These dates will be adjusted onto business days as defined by the schedule'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's tenor, e.g. every day ("1D"), every other week ("2W") etc. These dates will be adjusted onto business days as defined by the schedule'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's tenor, e.g. every day ("1D"), every other week ("2W") etc. These dates will be adjusted onto business days as defined by the schedule's rollConvention. More... | |
| Calendar | GetCalendar (string scope, string code, List< string >? propertyKeys=default(List< string >?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0) |
| [EARLY ACCESS] 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< Calendar > | GetCalendarWithHttpInfo (string scope, string code, List< string >? propertyKeys=default(List< string >?), DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0) |
| [EARLY ACCESS] 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< Calendar > | 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)) |
| [EARLY ACCESS] 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)) |
| [EARLY ACCESS] 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< ResourceListOfCalendarDate > | 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) |
| [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< ResourceListOfCalendarDate > | 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. 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 "Business DateTime" 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 "Holiday Calendar" Does not overlap with any dates in the calendar * If the calendar is a "TradingHours Calendar" 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) == false More... | |
| Lusid.Sdk.Client.ApiResponse< IsBusinessDayResponse > | IsBusinessDateTimeWithHttpInfo (DateTimeOffset dateTime, string scope, string code, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0) |
| [EARLY ACCESS] IsBusinessDateTime: Check whether a DateTime is a "Business DateTime" 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 "Holiday Calendar" Does not overlap with any dates in the calendar * If the calendar is a "TradingHours Calendar" 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) == false More... | |
| async System.Threading.Tasks.Task< IsBusinessDayResponse > | 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 "Business DateTime" 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 "Holiday Calendar" Does not overlap with any dates in the calendar * If the calendar is a "TradingHours Calendar" 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) == 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 "Business DateTime" 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 "Holiday Calendar" Does not overlap with any dates in the calendar * If the calendar is a "TradingHours Calendar" 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) == 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< PagedResourceListOfCalendar > | 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) |
| [EARLY ACCESS] ListCalendars: List Calendars List calendars at a point in AsAt time. More... | |
| async System.Threading.Tasks.Task< PagedResourceListOfCalendar > | 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. 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) |
| [EARLY ACCESS] ListCalendarsInScope: List all calenders in a specified scope List calendars in a Scope at a point in AsAt time. More... | |
| Lusid.Sdk.Client.ApiResponse< PagedResourceListOfCalendar > | 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) |
| [EARLY ACCESS] 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< PagedResourceListOfCalendar > | 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)) |
| [EARLY ACCESS] 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)) |
| [EARLY ACCESS] 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< Calendar > | UpdateCalendarWithHttpInfo (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< Calendar > | 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 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]
|
inline |
Initializes a new instance of the CalendarsApi class.
- Returns
◆ CalendarsApi() [2/4]
|
inline |
Initializes a new instance of the CalendarsApi class.
- Returns
◆ CalendarsApi() [3/4]
|
inline |
Initializes a new instance of the CalendarsApi class using Configuration object
- Parameters
-
configuration An instance of Configuration
- Returns
◆ CalendarsApi() [4/4]
|
inline |
Initializes a new instance of the CalendarsApi class using a Configuration object and client instance.
- Parameters
-
client The client interface for synchronous API access. asyncClient The client interface for asynchronous API access. configuration The configuration object.
Member Function Documentation
◆ AddBusinessDaysToDate()
|
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'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.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope within which to search for the calendars addBusinessDaysToDateRequest Request 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 operationIndex Index associated with the operation.
- Returns
- AddBusinessDaysToDateResponse
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ AddBusinessDaysToDateAsync()
|
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'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.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope within which to search for the calendars addBusinessDaysToDateRequest Request 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 operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of AddBusinessDaysToDateResponse
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ AddBusinessDaysToDateWithHttpInfo()
|
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'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.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope within which to search for the calendars addBusinessDaysToDateRequest Request 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 operationIndex Index associated with the operation.
- Returns
- ApiResponse of AddBusinessDaysToDateResponse
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ AddBusinessDaysToDateWithHttpInfoAsync()
|
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'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.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope within which to search for the calendars addBusinessDaysToDateRequest Request 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 operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (AddBusinessDaysToDateResponse)
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ AddDateToCalendar()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar code Code of the calendar createDateRequest Add date to calendar request operationIndex Index associated with the operation.
- Returns
- CalendarDate
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ AddDateToCalendarAsync()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar code Code of the calendar createDateRequest Add date to calendar request operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of CalendarDate
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ AddDateToCalendarWithHttpInfo()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar code Code of the calendar createDateRequest Add date to calendar request operationIndex Index associated with the operation.
- Returns
- ApiResponse of CalendarDate
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ AddDateToCalendarWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar code Code of the calendar createDateRequest Add date to calendar request operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (CalendarDate)
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ CreateCalendar()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
createCalendarRequest A request to create the calendar operationIndex Index associated with the operation.
- Returns
- Calendar
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ CreateCalendarAsync()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
createCalendarRequest A request to create the calendar operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of Calendar
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ CreateCalendarWithHttpInfo()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
createCalendarRequest A request to create the calendar operationIndex Index associated with the operation.
- Returns
- ApiResponse of Calendar
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ CreateCalendarWithHttpInfoAsync()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
createCalendarRequest A request to create the calendar operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (Calendar)
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ DeleteCalendar()
|
inline |
[EARLY ACCESS] DeleteCalendar: Delete a calendar Delete a calendar and all of its respective dates
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar code Code of the calendar operationIndex Index associated with the operation.
- Returns
- Calendar
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ DeleteCalendarAsync()
|
inline |
[EARLY ACCESS] DeleteCalendar: Delete a calendar Delete a calendar and all of its respective dates
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar code Code of the calendar operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of Calendar
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ DeleteCalendarWithHttpInfo()
|
inline |
[EARLY ACCESS] DeleteCalendar: Delete a calendar Delete a calendar and all of its respective dates
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar code Code of the calendar operationIndex Index associated with the operation.
- Returns
- ApiResponse of Calendar
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ DeleteCalendarWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] DeleteCalendar: Delete a calendar Delete a calendar and all of its respective dates
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar code Code of the calendar operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (Calendar)
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ DeleteDateFromCalendar()
|
inline |
[EARLY ACCESS] DeleteDateFromCalendar: Remove a date from a calendar Remove a date from a calendar.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar code Code of the calendar dateId Identifier of the date to be removed operationIndex Index associated with the operation.
- Returns
- CalendarDate
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ DeleteDateFromCalendarAsync()
|
inline |
[EARLY ACCESS] DeleteDateFromCalendar: Remove a date from a calendar Remove a date from a calendar.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar code Code of the calendar dateId Identifier of the date to be removed operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of CalendarDate
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ DeleteDateFromCalendarWithHttpInfo()
|
inline |
[EARLY ACCESS] DeleteDateFromCalendar: Remove a date from a calendar Remove a date from a calendar.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar code Code of the calendar dateId Identifier of the date to be removed operationIndex Index associated with the operation.
- Returns
- ApiResponse of CalendarDate
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ DeleteDateFromCalendarWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] DeleteDateFromCalendar: Remove a date from a calendar Remove a date from a calendar.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar code Code of the calendar dateId Identifier of the date to be removed operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (CalendarDate)
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ GenerateSchedule()
|
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's tenor, e.g. every day ("1D"), every other week ("2W") etc. These dates will be adjusted onto business days as defined by the schedule's rollConvention.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendars to use valuationSchedule The ValuationSchedule to generate schedule dates from asAt Optional AsAt for searching the calendar store. Defaults to Latest. (optional) operationIndex Index associated with the operation.
- Returns
- List<DateTimeOffset>
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ GenerateScheduleAsync()
|
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's tenor, e.g. every day ("1D"), every other week ("2W") etc. These dates will be adjusted onto business days as defined by the schedule's rollConvention.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendars to use valuationSchedule The ValuationSchedule to generate schedule dates from asAt Optional AsAt for searching the calendar store. Defaults to Latest. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of List<DateTimeOffset>
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ GenerateScheduleWithHttpInfo()
|
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's tenor, e.g. every day ("1D"), every other week ("2W") etc. These dates will be adjusted onto business days as defined by the schedule's rollConvention.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendars to use valuationSchedule The ValuationSchedule to generate schedule dates from asAt Optional AsAt for searching the calendar store. Defaults to Latest. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of List<DateTimeOffset>
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ GenerateScheduleWithHttpInfoAsync()
|
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's tenor, e.g. every day ("1D"), every other week ("2W") etc. These dates will be adjusted onto business days as defined by the schedule's rollConvention.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendars to use valuationSchedule The ValuationSchedule to generate schedule dates from asAt Optional AsAt for searching the calendar store. Defaults to Latest. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (List<DateTimeOffset>)
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ GetBasePath()
|
inline |
◆ GetCalendar()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar identifier code Code of the calendar identifier propertyKeys A list of property keys from the "Calendar" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. "Calendar/System/Name". (optional) asAt The AsAt datetime at which to retrieve the calendar (optional) operationIndex Index associated with the operation.
- Returns
- Calendar
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ GetCalendarAsync()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar identifier code Code of the calendar identifier propertyKeys A list of property keys from the "Calendar" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. "Calendar/System/Name". (optional) asAt The AsAt datetime at which to retrieve the calendar (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of Calendar
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ GetCalendarWithHttpInfo()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar identifier code Code of the calendar identifier propertyKeys A list of property keys from the "Calendar" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. "Calendar/System/Name". (optional) asAt The AsAt datetime at which to retrieve the calendar (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of Calendar
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ GetCalendarWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] 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.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar identifier code Code of the calendar identifier propertyKeys A list of property keys from the "Calendar" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. "Calendar/System/Name". (optional) asAt The AsAt datetime at which to retrieve the calendar (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (Calendar)
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ GetDates()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar code Code of the calendar fromEffectiveAt Where the effective window of dates should begin from (optional) toEffectiveAt Where the effective window of dates should end (optional) asAt AsAt the dates should be retrieved at (optional) idFilter An additional filter that will filter dates based on their identifer (optional) operationIndex Index associated with the operation.
- Returns
- ResourceListOfCalendarDate
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ GetDatesAsync()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar code Code of the calendar fromEffectiveAt Where the effective window of dates should begin from (optional) toEffectiveAt Where the effective window of dates should end (optional) asAt AsAt the dates should be retrieved at (optional) idFilter An additional filter that will filter dates based on their identifer (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ResourceListOfCalendarDate
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ GetDatesWithHttpInfo()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar code Code of the calendar fromEffectiveAt Where the effective window of dates should begin from (optional) toEffectiveAt Where the effective window of dates should end (optional) asAt AsAt the dates should be retrieved at (optional) idFilter An additional filter that will filter dates based on their identifer (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of ResourceListOfCalendarDate
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ GetDatesWithHttpInfoAsync()
|
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.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendar code Code of the calendar fromEffectiveAt Where the effective window of dates should begin from (optional) toEffectiveAt Where the effective window of dates should end (optional) asAt AsAt the dates should be retrieved at (optional) idFilter An additional filter that will filter dates based on their identifer (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (ResourceListOfCalendarDate)
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ IsBusinessDateTime()
|
inline |
[EARLY ACCESS] IsBusinessDateTime: Check whether a DateTime is a "Business DateTime" 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 "Holiday Calendar" Does not overlap with any dates in the calendar * If the calendar is a "TradingHours Calendar" 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) == false
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
dateTime DateTime to check - This DateTime must be UTC scope Scope of the calendar code Code of the calendar asAt AsAt for the request (optional) operationIndex Index associated with the operation.
- Returns
- IsBusinessDayResponse
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ IsBusinessDateTimeAsync()
|
inline |
[EARLY ACCESS] IsBusinessDateTime: Check whether a DateTime is a "Business DateTime" 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 "Holiday Calendar" Does not overlap with any dates in the calendar * If the calendar is a "TradingHours Calendar" 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) == false
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
dateTime DateTime to check - This DateTime must be UTC scope Scope of the calendar code Code of the calendar asAt AsAt for the request (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of IsBusinessDayResponse
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ IsBusinessDateTimeWithHttpInfo()
|
inline |
[EARLY ACCESS] IsBusinessDateTime: Check whether a DateTime is a "Business DateTime" 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 "Holiday Calendar" Does not overlap with any dates in the calendar * If the calendar is a "TradingHours Calendar" 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) == false
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
dateTime DateTime to check - This DateTime must be UTC scope Scope of the calendar code Code of the calendar asAt AsAt for the request (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of IsBusinessDayResponse
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ IsBusinessDateTimeWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] IsBusinessDateTime: Check whether a DateTime is a "Business DateTime" 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 "Holiday Calendar" Does not overlap with any dates in the calendar * If the calendar is a "TradingHours Calendar" 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) == false
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
dateTime DateTime to check - This DateTime must be UTC scope Scope of the calendar code Code of the calendar asAt AsAt for the request (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (IsBusinessDayResponse)
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ ListCalendars()
|
inline |
[EARLY ACCESS] ListCalendars: List Calendars List calendars at a point in AsAt time.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
asAt The AsAt datetime at which to retrieve the calendars (optional) page The 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) limit When paginating, limit the number of returned results to this many. (optional) propertyKeys A list of property keys from the "Calendar" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. "Calendar/System/Name". (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) operationIndex Index associated with the operation.
- Returns
- PagedResourceListOfCalendar
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ ListCalendarsAsync()
|
inline |
[EARLY ACCESS] ListCalendars: List Calendars List calendars at a point in AsAt time.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
asAt The AsAt datetime at which to retrieve the calendars (optional) page The 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) limit When paginating, limit the number of returned results to this many. (optional) propertyKeys A list of property keys from the "Calendar" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. "Calendar/System/Name". (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PagedResourceListOfCalendar
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ ListCalendarsInScope()
|
inline |
[EARLY ACCESS] ListCalendarsInScope: List all calenders in a specified scope List calendars in a Scope at a point in AsAt time.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendars asAt The AsAt datetime at which to retrieve the calendars (optional) page The 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) limit When paginating, limit the number of returned results to this many. (optional) propertyKeys A list of property keys from the "Calendar" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. "Calendar/System/Name". (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) operationIndex Index associated with the operation.
- Returns
- PagedResourceListOfCalendar
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ ListCalendarsInScopeAsync()
|
inline |
[EARLY ACCESS] ListCalendarsInScope: List all calenders in a specified scope List calendars in a Scope at a point in AsAt time.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendars asAt The AsAt datetime at which to retrieve the calendars (optional) page The 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) limit When paginating, limit the number of returned results to this many. (optional) propertyKeys A list of property keys from the "Calendar" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. "Calendar/System/Name". (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of PagedResourceListOfCalendar
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ ListCalendarsInScopeWithHttpInfo()
|
inline |
[EARLY ACCESS] ListCalendarsInScope: List all calenders in a specified scope List calendars in a Scope at a point in AsAt time.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendars asAt The AsAt datetime at which to retrieve the calendars (optional) page The 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) limit When paginating, limit the number of returned results to this many. (optional) propertyKeys A list of property keys from the "Calendar" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. "Calendar/System/Name". (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of PagedResourceListOfCalendar
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ ListCalendarsInScopeWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] ListCalendarsInScope: List all calenders in a specified scope List calendars in a Scope at a point in AsAt time.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the calendars asAt The AsAt datetime at which to retrieve the calendars (optional) page The 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) limit When paginating, limit the number of returned results to this many. (optional) propertyKeys A list of property keys from the "Calendar" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. "Calendar/System/Name". (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PagedResourceListOfCalendar)
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ ListCalendarsWithHttpInfo()
|
inline |
[EARLY ACCESS] ListCalendars: List Calendars List calendars at a point in AsAt time.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
asAt The AsAt datetime at which to retrieve the calendars (optional) page The 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) limit When paginating, limit the number of returned results to this many. (optional) propertyKeys A list of property keys from the "Calendar" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. "Calendar/System/Name". (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) operationIndex Index associated with the operation.
- Returns
- ApiResponse of PagedResourceListOfCalendar
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ ListCalendarsWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] ListCalendars: List Calendars List calendars at a point in AsAt time.
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
asAt The AsAt datetime at which to retrieve the calendars (optional) page The 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) limit When paginating, limit the number of returned results to this many. (optional) propertyKeys A list of property keys from the "Calendar" domain to decorate onto the calendar, These take the format {domain}/{scope}/{code} e.g. "Calendar/System/Name". (optional) filter Expression to filter the result set. Read more about filtering results from LUSID here https://support.lusid.com/filtering-results-from-lusid. (optional) operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (PagedResourceListOfCalendar)
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ UpdateCalendar()
|
inline |
[EARLY ACCESS] UpdateCalendar: Update a calendar Update the calendars WeekendMask, SourceProvider or Properties
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the request code Code of the request updateCalendarRequest The new state of the calendar operationIndex Index associated with the operation.
- Returns
- Calendar
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ UpdateCalendarAsync()
|
inline |
[EARLY ACCESS] UpdateCalendar: Update a calendar Update the calendars WeekendMask, SourceProvider or Properties
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the request code Code of the request updateCalendarRequest The new state of the calendar operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of Calendar
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
◆ UpdateCalendarWithHttpInfo()
|
inline |
[EARLY ACCESS] UpdateCalendar: Update a calendar Update the calendars WeekendMask, SourceProvider or Properties
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the request code Code of the request updateCalendarRequest The new state of the calendar operationIndex Index associated with the operation.
- Returns
- ApiResponse of Calendar
Implements Lusid.Sdk.Api.ICalendarsApiSync.
◆ UpdateCalendarWithHttpInfoAsync()
|
inline |
[EARLY ACCESS] UpdateCalendar: Update a calendar Update the calendars WeekendMask, SourceProvider or Properties
- Exceptions
-
Lusid.Sdk.Client.ApiException Thrown when fails to make API call
- Parameters
-
scope Scope of the request code Code of the request updateCalendarRequest The new state of the calendar operationIndex Index associated with the operation. cancellationToken Cancellation Token to cancel the request.
- Returns
- Task of ApiResponse (Calendar)
Implements Lusid.Sdk.Api.ICalendarsApiAsync.
Property Documentation
◆ AsynchronousClient
|
getset |
The client for accessing this underlying API asynchronously.
◆ Client
|
getset |
The client for accessing this underlying API synchronously.
◆ Configuration
|
getset |
Gets or sets the configuration object
An instance of the Configuration
◆ ExceptionFactory
|
getset |
Provides a factory method hook for the creation of exceptions.
The documentation for this class was generated from the following file:
- /home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/CalendarsApi.cs
