rest

package
v0.2.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 27, 2025 License: MIT Imports: 2 Imported by: 0

Documentation

Overview

Package rest defines the models of the REST API.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ProjectGetArchivedParams

type ProjectGetArchivedParams struct {
	// Optional.
	Cursor *string `json:"cursor,omitempty" url:"cursor,omitempty"`

	// Optional.
	// Default is 50. The number of objects to return in a page.
	Limit *int `json:"limit,omitempty" url:"limit,omitempty"`
}

type ProjectGetArchivedResponse

type ProjectGetArchivedResponse struct {
	Projects   []*sync.Project `json:"results"`
	NextCursor *string         `json:"next_cursor,omitempty"`
}

type TaskGetCompletedByCompletionDateParams

type TaskGetCompletedByCompletionDateParams struct {
	// Required.
	Since time.Time `json:"since" url:"since"`

	// Required.
	Until time.Time `json:"until" url:"until"`

	// Optional.
	WorkspaceID *string `json:"workspace_id,omitempty" url:"workspace_id,omitempty"`

	// Optional.
	ProjectID *string `json:"project_id,omitempty" url:"project_id,omitempty"`

	// Optional.
	SectionID *string `json:"section_id,omitempty" url:"section_id,omitempty"`

	// Optional.
	FilterQuery *string `json:"filter_query,omitempty" url:"filter_query,omitempty"`

	// Optional.
	FilterLang *string `json:"filter_lang,omitempty" url:"filter_lang,omitempty"`

	// Optional.
	Cursor *string `json:"cursor,omitempty" url:"cursor,omitempty"`

	// Optional.
	// Default is 50.
	Limit *int `json:"limit,omitempty" url:"limit,omitempty"`
}

type TaskGetCompletedByDueDateParams

type TaskGetCompletedByDueDateParams struct {
	// Required.
	Since time.Time `json:"since" url:"since"`

	// Required.
	Until time.Time `json:"until" url:"until"`

	// Optional.
	WorkspaceID *int `json:"workspace_id,omitempty" url:"workspace_id,omitempty"`

	// Optional.
	ProjectID *string `json:"project_id,omitempty" url:"project_id,omitempty"`

	// Optional.
	SectionID *string `json:"section_id,omitempty" url:"section_id,omitempty"`

	// Optional.
	ParentID *string `json:"parent_id,omitempty" url:"parent_id,omitempty"`

	// Optional.
	FilterQuery *string `json:"filter_query,omitempty" url:"filter_query,omitempty"`

	// Optional.
	FilterLang *string `json:"filter_lang,omitempty" url:"filter_lang,omitempty"`

	// Optional.
	Cursor *string `json:"cursor,omitempty" url:"cursor,omitempty"`

	// Optional.
	// Default is 50.
	Limit *int `json:"limit,omitempty" url:"limit,omitempty"`
}

type TaskGetCompletedResponse

type TaskGetCompletedResponse struct {
	Tasks      []*sync.Task `json:"items"`
	NextCursor *string      `json:"next_cursor,omitempty"`
}

type TaskQuickAddRequest

type TaskQuickAddRequest struct {
	// Required.
	// The text of the task that is parsed. It can include a due date in free form
	// text, a project name starting with the # character (without spaces), a
	// label starting with the @ character, an assignee starting with the +
	// character, a priority (e.g., p1), a deadline between {} (e.g. {in 3 days}),
	// or a description starting from // until the end of the text.
	Text string `json:"text" url:"text"`

	// Optional.
	// The note of the task.
	Note *string `json:"note,omitempty" url:"note,omitempty"`

	// Optional.
	// The reminder date in free form text.
	Reminder *string `json:"reminder,omitempty" url:"reminder,omitempty"`

	// Optional.
	// When this option is enabled, the default reminder will be added to the new
	// item if it has a due date with time set. See also
	// https://todoist.com/api/v1/docs#tag/Sync/User for more info about the
	// default reminder.
	AutoReminder bool `json:"auto_reminder" url:"auto_reminder"`

	// Optional.
	// The meta of the task.
	Meta bool `json:"meta" url:"meta"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL