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

Inheritance diagram for Lusid.Sdk.Api.ICalendarsApiSync:

[legend]

Public Member Functions
AddBusinessDaysToDateResponse	AddBusinessDaysToDate (string scope, AddBusinessDaysToDateRequest addBusinessDaysToDateRequest, int operationIndex=0)
	[EARLY ACCESS] AddBusinessDaysToDate: Adds the requested number of Business Days to the provided date. More...

ApiResponse< AddBusinessDaysToDateResponse >	AddBusinessDaysToDateWithHttpInfo (string scope, AddBusinessDaysToDateRequest addBusinessDaysToDateRequest, int operationIndex=0)
	[EARLY ACCESS] AddBusinessDaysToDate: Adds the requested number of Business Days to the provided date. More...

CalendarDate	AddDateToCalendar (string scope, string code, CreateDateRequest createDateRequest, int operationIndex=0)
	[EARLY ACCESS] AddDateToCalendar: Add a date to a calendar More...

ApiResponse< CalendarDate >	AddDateToCalendarWithHttpInfo (string scope, string code, CreateDateRequest createDateRequest, int operationIndex=0)
	[EARLY ACCESS] AddDateToCalendar: Add a date to a calendar More...

Calendar	CreateCalendar (CreateCalendarRequest createCalendarRequest, int operationIndex=0)
	[EARLY ACCESS] CreateCalendar: Create a calendar in its generic form More...

ApiResponse< Calendar >	CreateCalendarWithHttpInfo (CreateCalendarRequest createCalendarRequest, int operationIndex=0)
	[EARLY ACCESS] CreateCalendar: Create a calendar in its generic form More...

Calendar	DeleteCalendar (string scope, string code, int operationIndex=0)
	[EARLY ACCESS] DeleteCalendar: Delete a calendar More...

ApiResponse< Calendar >	DeleteCalendarWithHttpInfo (string scope, string code, int operationIndex=0)
	[EARLY ACCESS] DeleteCalendar: Delete a calendar More...

CalendarDate	DeleteDateFromCalendar (string scope, string code, string dateId, int operationIndex=0)
	[EARLY ACCESS] DeleteDateFromCalendar: Remove a date from a calendar More...

ApiResponse< CalendarDate >	DeleteDateFromCalendarWithHttpInfo (string scope, string code, string dateId, int operationIndex=0)
	[EARLY ACCESS] DeleteDateFromCalendar: 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. More...

ApiResponse< List< DateTimeOffset > >	GenerateScheduleWithHttpInfo (string scope, ValuationSchedule valuationSchedule, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EARLY ACCESS] GenerateSchedule: Generate an ordered schedule of dates. 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 More...

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 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 More...

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 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" More...

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" 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 More...

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 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 More...

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 More...

Calendar	UpdateCalendar (string scope, string code, UpdateCalendarRequest updateCalendarRequest, int operationIndex=0)
	[EARLY ACCESS] UpdateCalendar: Update a calendar More...

ApiResponse< Calendar >	UpdateCalendarWithHttpInfo (string scope, string code, UpdateCalendarRequest updateCalendarRequest, int operationIndex=0)
	[EARLY ACCESS] UpdateCalendar: Update a calendar More...

Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ AddBusinessDaysToDate()

AddBusinessDaysToDateResponse Lusid.Sdk.Api.ICalendarsApiSync.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.

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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ AddBusinessDaysToDateWithHttpInfo()

ApiResponse<AddBusinessDaysToDateResponse> Lusid.Sdk.Api.ICalendarsApiSync.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.

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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ AddDateToCalendar()

CalendarDate Lusid.Sdk.Api.ICalendarsApiSync.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.

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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ AddDateToCalendarWithHttpInfo()

ApiResponse<CalendarDate> Lusid.Sdk.Api.ICalendarsApiSync.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.

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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ CreateCalendar()

Calendar Lusid.Sdk.Api.ICalendarsApiSync.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.

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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ CreateCalendarWithHttpInfo()

ApiResponse<Calendar> Lusid.Sdk.Api.ICalendarsApiSync.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.

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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ DeleteCalendar()

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

[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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ DeleteCalendarWithHttpInfo()

ApiResponse<Calendar> Lusid.Sdk.Api.ICalendarsApiSync.DeleteCalendarWithHttpInfo	(	string	scope,
		string	code,
		int	operationIndex = `0`
	)

[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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ DeleteDateFromCalendar()

CalendarDate Lusid.Sdk.Api.ICalendarsApiSync.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.

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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ DeleteDateFromCalendarWithHttpInfo()

ApiResponse<CalendarDate> Lusid.Sdk.Api.ICalendarsApiSync.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.

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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ GenerateSchedule()

List<DateTimeOffset> Lusid.Sdk.Api.ICalendarsApiSync.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.

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>

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ GenerateScheduleWithHttpInfo()

ApiResponse<List<DateTimeOffset> > Lusid.Sdk.Api.ICalendarsApiSync.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.

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>

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ GetCalendar()

Calendar Lusid.Sdk.Api.ICalendarsApiSync.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

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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ GetCalendarWithHttpInfo()

ApiResponse<Calendar> Lusid.Sdk.Api.ICalendarsApiSync.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

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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ GetDates()

ResourceListOfCalendarDate Lusid.Sdk.Api.ICalendarsApiSync.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.

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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ GetDatesWithHttpInfo()

ApiResponse<ResourceListOfCalendarDate> Lusid.Sdk.Api.ICalendarsApiSync.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.

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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ IsBusinessDateTime()

IsBusinessDayResponse Lusid.Sdk.Api.ICalendarsApiSync.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

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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ IsBusinessDateTimeWithHttpInfo()

ApiResponse<IsBusinessDayResponse> Lusid.Sdk.Api.ICalendarsApiSync.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

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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ ListCalendars()

PagedResourceListOfCalendar Lusid.Sdk.Api.ICalendarsApiSync.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.

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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ ListCalendarsInScope()

PagedResourceListOfCalendar Lusid.Sdk.Api.ICalendarsApiSync.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.

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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ ListCalendarsInScopeWithHttpInfo()

ApiResponse<PagedResourceListOfCalendar> Lusid.Sdk.Api.ICalendarsApiSync.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.

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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ ListCalendarsWithHttpInfo()

ApiResponse<PagedResourceListOfCalendar> Lusid.Sdk.Api.ICalendarsApiSync.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.

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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ UpdateCalendar()

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

[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

Implemented in Lusid.Sdk.Api.CalendarsApi.

◆ UpdateCalendarWithHttpInfo()

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

[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

Implemented in Lusid.Sdk.Api.CalendarsApi.

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

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/CalendarsApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddBusinessDaysToDate()

◆ AddBusinessDaysToDateWithHttpInfo()

◆ AddDateToCalendar()

◆ AddDateToCalendarWithHttpInfo()

◆ CreateCalendar()

◆ CreateCalendarWithHttpInfo()

◆ DeleteCalendar()

◆ DeleteCalendarWithHttpInfo()

◆ DeleteDateFromCalendar()

◆ DeleteDateFromCalendarWithHttpInfo()

◆ GenerateSchedule()

◆ GenerateScheduleWithHttpInfo()

◆ GetCalendar()

◆ GetCalendarWithHttpInfo()

◆ GetDates()

◆ GetDatesWithHttpInfo()

◆ IsBusinessDateTime()

◆ IsBusinessDateTimeWithHttpInfo()

◆ ListCalendars()

◆ ListCalendarsInScope()

◆ ListCalendarsInScopeWithHttpInfo()

◆ ListCalendarsWithHttpInfo()

◆ UpdateCalendar()

◆ UpdateCalendarWithHttpInfo()