Objects - Charter Docs

Model tree

Variables for the cycles connection.

Field	Type	Description
`first`	`integer`	How many results to return. Linear returns 50 by default. ≥ 1; ≤ 250; defaults to `50`
`after`	`string`	The `endCursor` from the previous page’s `pageInfo`, to fetch the next page.
`filter`	CycleFilter	Narrow the cycles returned. Filter on `is_active.eq` for a team’s current cycle.
`includeArchived`	`boolean`	Include archived cycles in the results.
`orderBy`	PaginationOrderBy	Sort by ‘createdAt’ or ‘updatedAt’.

A filter over cycles, or over an issue’s cycle.

Field	Type	Description
`id`	IdComparator	Filter by cycle UUID.
`name`	StringComparator	Comparator for the cycle name.
`number`	NumberComparator	Filter by the cycle’s number.
`startsAt`	DateComparator	Filter by when the cycle starts.
`endsAt`	DateComparator	Filter by when the cycle ends.
`completedAt`	DateComparator	Comparator for the cycle completed at date.
`isActive`	BooleanComparator	Filter by whether the cycle is the team’s current one.
`isNext`	BooleanComparator	Filter by whether the cycle is the team’s next one.
`isPrevious`	BooleanComparator	Filter by whether the cycle is the team’s previous one.
`isFuture`	BooleanComparator	Filter by whether the cycle is in the future.
`isPast`	BooleanComparator	Filter by whether the cycle is in the past.
`team`	TeamFilter	Filter by the team the cycle belongs to.
`createdAt`	DateComparator	Comparator for the created at date.
`updatedAt`	DateComparator	Comparator for the updated at date.
`inheritedFromId`	IdComparator	Comparator for the inherited cycle ID.
`isInCooldown`	BooleanComparator	Comparator for filtering for whether the cycle is currently in cooldown.

Variables for the cycle query.

Field	Type	Description
`id` *	`string`	The cycle’s UUID.

Variables for the cycleUpdate mutation.

Field	Type	Description
`id` *	`string`	The cycle’s UUID.
`input` *	CycleUpdateInput	The fields to change.

The fields cycleUpdate changes. All optional.

Field	Type	Description
`name`	`string`	The custom name of the cycle.
`description`	`string`	The cycle description.
`startsAt`	`string`	The start date of the cycle, as an ISO 8601 timestamp.
`endsAt`	`string`	The end date of the cycle, as an ISO 8601 timestamp.
`completedAt`	`string`	The completion time of the cycle, as an ISO 8601 timestamp.

Variables for the cycleArchive mutation.

Field	Type	Description
`id` *	`string`	The cycle’s UUID.

Variables for the cycleStartUpcomingCycleToday mutation.

Field	Type	Description
`id` *	`string`	The UUID of the upcoming cycle to start today.