Interface: AppointmentRule

@flyze/lib-data-store 3.0.0-alpha.55· latest

Defined in: projects/lib-data-store/src/lib/flyze-models/appointment-rule.model.ts:3

Extends

AppointmentRuleDTO

Properties

createdAt

readonly createdAt: Date

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-tracked-dates.model.d.ts:5

The date when the record was created.

Inherited from

_Appointment.createdAt

createdBy?

optional createdBy: string | null

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-audit-meta.model.d.ts:7

The ID of the user who created the resource.

Inherited from

_Appointment.createdBy

createdByKind

createdByKind: "Group" | "User" | "Unknown" | "API" | "System"

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-audit-meta.model.d.ts:11

The kind of the user who created the resource.

Inherited from

_Appointment.createdByKind

description

description: string

Defined in: node_modules/@flyze/lib-db-models/models/appointment-rule/appointment-rule.model.d.ts:7

Inherited from

_Appointment.description

entityKind

readonly entityKind: "appointment-rule"

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-entity-kind.model.d.ts:31

The kind of the entity.

Inherited from

_Appointment.entityKind

id

readonly id: string

Defined in: projects/lib-data-store/src/lib/flyze-models/appointment-rule.model.ts:4

Overrides

_Appointment.id

localEnd

localEnd: string

Defined in: node_modules/@flyze/lib-db-models/models/appointment-rule/appointment-rule.model.d.ts:20

Local end time in ISO format (e.g., “2024-01-01T17:00:00”). This represents the end time of the first occurrence of the rule in the specified time zone. Occurrences generated by the rRule will use the duration between localStart and localEnd.

Inherited from

_Appointment.localEnd

localStart

localStart: string

Defined in: node_modules/@flyze/lib-db-models/models/appointment-rule/appointment-rule.model.d.ts:15

Local start time in ISO format (e.g., “2024-01-01T09:00:00”). This represents the start time of the first occurrence of the rule in the specified time zone.

Inherited from

_Appointment.localStart

ownerId?

optional ownerId: string | null

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-owner.model.d.ts:14

The ID of the owner of the resource.

Inherited from

_Appointment.ownerId

ownerKind

ownerKind: "Group" | "User" | "Unknown" | "API" | "System"

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-owner.model.d.ts:18

The owner of the resource.

Inherited from

_Appointment.ownerKind

rRule

rRule: string

Defined in: node_modules/@flyze/lib-db-models/models/appointment-rule/appointment-rule.model.d.ts:24

Recurrence rule in iCalendar format (RFC 5545).

Inherited from

_Appointment.rRule

timeZoneId

timeZoneId: string

Defined in: node_modules/@flyze/lib-db-models/models/appointment-rule/appointment-rule.model.d.ts:11

Time zone identifier (e.g., “America/New_York”) for the local start and end times. This is crucial for correctly interpreting the localStart and localEnd times.

Inherited from

_Appointment.timeZoneId

title

title: string

Defined in: node_modules/@flyze/lib-db-models/models/appointment-rule/appointment-rule.model.d.ts:6

Inherited from

_Appointment.title

until

until: string

Defined in: node_modules/@flyze/lib-db-models/models/appointment-rule/appointment-rule.model.d.ts:28

Extracted from rRule, represents the end date of the rule in ISO format. This is useful for querying and filtering rules based on their end date.

Inherited from

_Appointment.until

updatedAt

readonly updatedAt: Date

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-tracked-dates.model.d.ts:9

The date when the record was last updated.

Inherited from

_Appointment.updatedAt

updatedBy?

optional updatedBy: string | null

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-audit-meta.model.d.ts:15

The ID of the user who last updated the resource.

Inherited from

_Appointment.updatedBy

updatedByKind

updatedByKind: "Group" | "User" | "Unknown" | "API" | "System"

Defined in: node_modules/@flyze/lib-db-models/models/shared/has-audit-meta.model.d.ts:19

The kind of the user who last updated the resource.

Inherited from

_Appointment.updatedByKind