Project

pyticktick.models.v1.parameters.project

Parameters for creating and updating projects via the V1 API.

Classes:

Name	Description
CreateProjectV1	Model for creating a project via the V1 API.
UpdateProjectV1	Model for updating a project via the V1 API.

CreateProjectV1 pydantic-model

Bases: BaseModel

Model for creating a project via the V1 API.

This model is used to create a project via the V1 API. It directly maps to the create project documentation in the API docs.

Show JSON schema:

{
  "additionalProperties": false,
  "description": "Model for creating a project via the V1 API.\n\nThis model is used to create a project via the V1 API. It directly maps to the\n[create project](https://developer.ticktick.com/docs#/openapi?id=create-project)\ndocumentation in the API docs.",
  "properties": {
    "name": {
      "description": "name of the project",
      "title": "Name",
      "type": "string"
    },
    "color": {
      "anyOf": [
        {
          "format": "color",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "color of project, eg. '#F18181'",
      "title": "Color"
    },
    "sort_order": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "sort order value of the project",
      "title": "Sort Order"
    },
    "view_mode": {
      "anyOf": [
        {
          "enum": [
            "list",
            "kanban",
            "timeline"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "view mode, \"list\", \"kanban\", \"timeline\"",
      "title": "View Mode"
    },
    "kind": {
      "anyOf": [
        {
          "enum": [
            "TASK",
            "NOTE"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "\"TASK\" or \"NOTE\"",
      "title": "Kind"
    }
  },
  "required": [
    "name"
  ],
  "title": "CreateProjectV1",
  "type": "object"
}

Config:

• extra: forbid

Fields:

• name (str)
• color (Color | None)
• sort_order (int | None)
• view_mode (Literal['list', 'kanban', 'timeline'] | None)
• kind (Literal['TASK', 'NOTE'] | None)

color pydantic-field

color: Color | None = None

color of project, eg. '#F18181'

kind pydantic-field

kind: Literal['TASK', 'NOTE'] | None = None

"TASK" or "NOTE"

name pydantic-field

name: str

name of the project

sort_order pydantic-field

sort_order: int | None = None

sort order value of the project

view_mode pydantic-field

view_mode: Literal["list", "kanban", "timeline"] | None = (
    None
)

view mode, "list", "kanban", "timeline"

UpdateProjectV1 pydantic-model

Bases: BaseModel

Model for updating a project via the V1 API.

This model is used to update a project via the V1 API. It directly maps to the update project documentation in the API docs.

Show JSON schema:

{
  "additionalProperties": false,
  "description": "Model for updating a project via the V1 API.\n\nThis model is used to update a project via the V1 API. It directly maps to the\n[update project](https://developer.ticktick.com/docs#/openapi?id=update-project)\ndocumentation in the API docs.",
  "properties": {
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "name of the project",
      "title": "Name"
    },
    "color": {
      "anyOf": [
        {
          "format": "color",
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "color of project, eg. '#F18181'",
      "title": "Color"
    },
    "sort_order": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "sort order value of the project",
      "title": "Sort Order"
    },
    "view_mode": {
      "anyOf": [
        {
          "enum": [
            "list",
            "kanban",
            "timeline"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "view mode, \"list\", \"kanban\", \"timeline\"",
      "title": "View Mode"
    },
    "kind": {
      "anyOf": [
        {
          "enum": [
            "TASK",
            "NOTE"
          ],
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "\"TASK\" or \"NOTE\"",
      "title": "Kind"
    }
  },
  "title": "UpdateProjectV1",
  "type": "object"
}

Config:

• extra: forbid

Fields:

• name (str | None)
• color (Color | None)
• sort_order (int | None)
• view_mode (Literal['list', 'kanban', 'timeline'] | None)
• kind (Literal['TASK', 'NOTE'] | None)

color pydantic-field

color: Color | None = None

color of project, eg. '#F18181'

kind pydantic-field

kind: Literal['TASK', 'NOTE'] | None = None

"TASK" or "NOTE"

name pydantic-field

name: str | None = None

name of the project

sort_order pydantic-field

sort_order: int | None = None

sort order value of the project

view_mode pydantic-field

view_mode: Literal["list", "kanban", "timeline"] | None = (
    None
)

view mode, "list", "kanban", "timeline"