/** * This file was auto-generated by openapi-typescript. * Do not make direct changes to the file. */ export interface paths { "/api/v1/comments": { /** API endpoints for CRUD operations on tasks. */ get: operations["api_v1_comments_list"]; /** API endpoints for CRUD operations on tasks. */ post: operations["api_v1_comments_create"]; }; "/api/v1/comments/{id}": { /** API endpoints for CRUD operations on tasks. */ get: operations["api_v1_comments_retrieve"]; /** API endpoints for CRUD operations on tasks. */ put: operations["api_v1_comments_update"]; /** API endpoints for CRUD operations on tasks. */ delete: operations["api_v1_comments_destroy"]; /** API endpoints for CRUD operations on tasks. */ patch: operations["api_v1_comments_partial_update"]; }; "/api/v1/contexts": { /** API endpoints for CRUD operations on contexts. */ get: operations["api_v1_contexts_list"]; /** API endpoints for CRUD operations on contexts. */ post: operations["api_v1_contexts_create"]; }; "/api/v1/contexts/{id}": { /** API endpoints for CRUD operations on contexts. */ get: operations["api_v1_contexts_retrieve"]; /** API endpoints for CRUD operations on contexts. */ put: operations["api_v1_contexts_update"]; /** API endpoints for CRUD operations on contexts. */ delete: operations["api_v1_contexts_destroy"]; /** API endpoints for CRUD operations on contexts. */ patch: operations["api_v1_contexts_partial_update"]; }; "/api/v1/filters": { /** API endpoints for CRUD operations on tasks. */ get: operations["api_v1_filters_list"]; /** API endpoints for CRUD operations on tasks. */ post: operations["api_v1_filters_create"]; }; "/api/v1/filters/{id}": { /** API endpoints for CRUD operations on tasks. */ get: operations["api_v1_filters_retrieve"]; /** API endpoints for CRUD operations on tasks. */ put: operations["api_v1_filters_update"]; /** API endpoints for CRUD operations on tasks. */ delete: operations["api_v1_filters_destroy"]; /** API endpoints for CRUD operations on tasks. */ patch: operations["api_v1_filters_partial_update"]; }; "/api/v1/github/webhooks": { post: operations["api_v1_github_webhooks_create"]; }; "/api/v1/jira": { /** API endpoints for CRUD operations on JiraConfigs. */ get: operations["api_v1_jira_list"]; /** API endpoints for CRUD operations on JiraConfigs. */ post: operations["api_v1_jira_create"]; }; "/api/v1/jira/{id}": { /** API endpoints for CRUD operations on JiraConfigs. */ get: operations["api_v1_jira_retrieve"]; /** API endpoints for CRUD operations on JiraConfigs. */ put: operations["api_v1_jira_update"]; /** API endpoints for CRUD operations on JiraConfigs. */ delete: operations["api_v1_jira_destroy"]; /** API endpoints for CRUD operations on JiraConfigs. */ patch: operations["api_v1_jira_partial_update"]; }; "/api/v1/settings": { get: operations["api_v1_settings_list"]; post: operations["api_v1_settings_create"]; }; "/api/v1/settings/{id}": { get: operations["api_v1_settings_retrieve"]; put: operations["api_v1_settings_update"]; delete: operations["api_v1_settings_destroy"]; patch: operations["api_v1_settings_partial_update"]; }; "/api/v1/sources": { /** API endpoints for CRUD operations on sources. */ get: operations["api_v1_sources_list"]; /** API endpoints for CRUD operations on sources. */ post: operations["api_v1_sources_create"]; }; "/api/v1/sources/{id}": { /** API endpoints for CRUD operations on sources. */ get: operations["api_v1_sources_retrieve"]; /** API endpoints for CRUD operations on sources. */ put: operations["api_v1_sources_update"]; /** API endpoints for CRUD operations on sources. */ delete: operations["api_v1_sources_destroy"]; /** API endpoints for CRUD operations on sources. */ patch: operations["api_v1_sources_partial_update"]; }; "/api/v1/tasks": { /** RPC/API endpoints for CRUD operations on tasks. */ get: operations["api_v1_tasks_list"]; /** RPC/API endpoints for CRUD operations on tasks. */ post: operations["api_v1_tasks_create"]; }; "/api/v1/tasks/{id}": { /** RPC/API endpoints for CRUD operations on tasks. */ get: operations["api_v1_tasks_retrieve"]; /** RPC/API endpoints for CRUD operations on tasks. */ put: operations["api_v1_tasks_update"]; /** RPC/API endpoints for CRUD operations on tasks. */ delete: operations["api_v1_tasks_destroy"]; /** RPC/API endpoints for CRUD operations on tasks. */ patch: operations["api_v1_tasks_partial_update"]; }; "/api/v1/tasks/{id}/complete": { /** * RPC endpoint for completing Tasks. * * Returns the completed task. */ put: operations["api_v1_tasks_complete_update"]; }; "/api/v1/tasks/{id}/defer": { /** * Defers a Task by reducing it's priority according to the other Tasks for * this user. * * If Context is given will operate only within that Context, otherwise all * Tasks are considered. * * Returns the deferred Task. */ put: operations["api_v1_tasks_defer_update"]; }; "/api/v1/tasks/create": { /** Create DSL uses the Taskforge creation DSL to create a task. */ post: operations["api_v1_tasks_create_create"]; }; "/api/v1/tasks/next": { /** Returns the next highest priority task for the user. */ get: operations["api_v1_tasks_next_retrieve"]; }; "/api/v1/tasks/reorder": { /** * Reorder tasks by manipulating their priority. * * Takes two query parameters: moved and above. These correspond to the * tasks we are moving (moved) and what task it will now sit above in the * list (above). The provided values should be the Task IDs. * * Returns the full list of Tasks for this user. */ put: operations["api_v1_tasks_reorder_update"]; }; "/api/v1/tokens": { /** * Takes a set of user credentials and returns an access and refresh JSON web * token pair to prove the authentication of those credentials. */ post: operations["api_v1_tokens_create"]; /** * Takes a set of user credentials and returns an access and refresh JSON web * token pair to prove the authentication of those credentials. */ delete: operations["api_v1_tokens_destroy"]; }; "/api/v1/tokens/pat": { post: operations["api_v1_tokens_pat_create"]; delete: operations["api_v1_tokens_pat_destroy"]; }; "/api/v1/tokens/refresh": { /** * Takes a refresh type JSON web token and returns an access type JSON web * token if the refresh token is valid. */ post: operations["api_v1_tokens_refresh_create"]; /** * Takes a refresh type JSON web token and returns an access type JSON web * token if the refresh token is valid. */ delete: operations["api_v1_tokens_refresh_destroy"]; }; "/api/v1/users": { /** API endpoint that allows users to be viewed or edited. */ get: operations["api_v1_users_list"]; /** API endpoint that allows users to be viewed or edited. */ post: operations["api_v1_users_create"]; }; "/api/v1/users/{id}": { /** API endpoint that allows users to be viewed or edited. */ get: operations["api_v1_users_retrieve"]; /** API endpoint that allows users to be viewed or edited. */ put: operations["api_v1_users_update"]; /** API endpoint that allows users to be viewed or edited. */ delete: operations["api_v1_users_destroy"]; /** API endpoint that allows users to be viewed or edited. */ patch: operations["api_v1_users_partial_update"]; }; "/schema": { /** * OpenApi3 schema for this API. Format can be selected via content negotiation. * * - YAML: application/vnd.oai.openapi * - JSON: application/vnd.oai.openapi+json */ get: operations["schema_retrieve"]; }; } export interface components { schemas: { Column: { name: string; enabled: boolean; }; Comment: { id: string; object: string; body: string; created_date: string; author: string; }; Context: { id: string; name: string; owner: string; }; Filter: { id: string; columns?: components["schemas"]["Column"][]; name: string; query: string; owner: string; }; JiraConfig: { id: string; hostname: string; /** The JIRA username for this configuration. */ jira_username: string; /** The JIRA API token, you can generate one at https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/ */ jira_api_token?: string; /** The JQL query to run to get issues from the JIRA server. */ jql: string; user: string; source: string; /** The Context in which to create these issues. */ context?: string; }; PaginatedCommentList: { count?: number; next?: string | null; previous?: string | null; results?: components["schemas"]["Comment"][]; }; PaginatedContextList: { count?: number; next?: string | null; previous?: string | null; results?: components["schemas"]["Context"][]; }; PaginatedFilterList: { count?: number; next?: string | null; previous?: string | null; results?: components["schemas"]["Filter"][]; }; PaginatedJiraConfigList: { count?: number; next?: string | null; previous?: string | null; results?: components["schemas"]["JiraConfig"][]; }; PaginatedSettingsList: { count?: number; next?: string | null; previous?: string | null; results?: components["schemas"]["Settings"][]; }; PaginatedSourceList: { count?: number; next?: string | null; previous?: string | null; results?: components["schemas"]["Source"][]; }; PaginatedTaskList: { count?: number; next?: string | null; previous?: string | null; results?: components["schemas"]["Task"][]; }; PaginatedUserList: { count?: number; next?: string | null; previous?: string | null; results?: components["schemas"]["User"][]; }; PatchedComment: { id?: string; object?: string; body?: string; created_date?: string; author?: string; }; PatchedContext: { id?: string; name?: string; owner?: string; }; PatchedFilter: { id?: string; columns?: components["schemas"]["Column"][]; name?: string; query?: string; owner?: string; }; PatchedJiraConfig: { id?: string; hostname?: string; /** The JIRA username for this configuration. */ jira_username?: string; /** The JIRA API token, you can generate one at https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/ */ jira_api_token?: string; /** The JQL query to run to get issues from the JIRA server. */ jql?: string; user?: string; source?: string; /** The Context in which to create these issues. */ context?: string; }; PatchedSettings: { id?: number; default_columns?: components["schemas"]["Column"][]; email_notifications_enabled?: boolean; user?: string; default_context?: string | null; }; PatchedSource: { id?: string; name?: string; }; PatchedTask: { id?: string; owner?: string; context: string; source?: string; title?: string; priority: number; created_date?: string; completed_date?: string | null; due_date?: string | null; /** Information used to reference the object in the remote source that created this Task. */ remote_reference?: components["schemas"]["RemoteReference"] | null; }; PatchedUser: { id?: string; email?: string; password?: string; avatar_url?: string; full_name?: string | null; }; PersonalAccessToken: { email: string; password: string; }; RemoteReference: { /** Link to the corresponding object in the remote source */ url: string; /** * A human-readable representation of the object in the remote * source. It is contextual and based on how the remote source would * reference this information. Use this as the link text when linking to * URL. */ reference: string; }; Settings: { id: number; default_columns?: components["schemas"]["Column"][]; email_notifications_enabled?: boolean; user: string; default_context?: string | null; }; Source: { id: string; name: string; }; Task: { id: string; owner: string; context: string; source: string; title: string; priority: number; created_date: string; completed_date?: string | null; due_date?: string | null; /** Information used to reference the object in the remote source that created this Task. */ remote_reference: components["schemas"]["RemoteReference"] | null; }; TokenObtainPair: { email: string; password: string; access: string; refresh: string; }; User: { id: string; email: string; password?: string; avatar_url: string; full_name?: string | null; }; }; } export interface operations { /** API endpoints for CRUD operations on tasks. */ api_v1_comments_list: { parameters: { query: { /** A page number within the paginated result set. */ page?: number; }; }; responses: { 200: { content: { "application/json": components["schemas"]["PaginatedCommentList"]; }; }; }; }; /** API endpoints for CRUD operations on tasks. */ api_v1_comments_create: { responses: { 201: { content: { "application/json": components["schemas"]["Comment"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["Comment"]; "application/x-www-form-urlencoded": components["schemas"]["Comment"]; "multipart/form-data": components["schemas"]["Comment"]; }; }; }; /** API endpoints for CRUD operations on tasks. */ api_v1_comments_retrieve: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Comment"]; }; }; }; }; /** API endpoints for CRUD operations on tasks. */ api_v1_comments_update: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Comment"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["Comment"]; "application/x-www-form-urlencoded": components["schemas"]["Comment"]; "multipart/form-data": components["schemas"]["Comment"]; }; }; }; /** API endpoints for CRUD operations on tasks. */ api_v1_comments_destroy: { parameters: { path: { id: string; }; }; responses: { /** No response body */ 204: never; }; }; /** API endpoints for CRUD operations on tasks. */ api_v1_comments_partial_update: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Comment"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["PatchedComment"]; "application/x-www-form-urlencoded": components["schemas"]["PatchedComment"]; "multipart/form-data": components["schemas"]["PatchedComment"]; }; }; }; /** API endpoints for CRUD operations on contexts. */ api_v1_contexts_list: { parameters: { query: { /** A page number within the paginated result set. */ page?: number; }; }; responses: { 200: { content: { "application/json": components["schemas"]["PaginatedContextList"]; }; }; }; }; /** API endpoints for CRUD operations on contexts. */ api_v1_contexts_create: { responses: { 201: { content: { "application/json": components["schemas"]["Context"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["Context"]; "application/x-www-form-urlencoded": components["schemas"]["Context"]; "multipart/form-data": components["schemas"]["Context"]; }; }; }; /** API endpoints for CRUD operations on contexts. */ api_v1_contexts_retrieve: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Context"]; }; }; }; }; /** API endpoints for CRUD operations on contexts. */ api_v1_contexts_update: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Context"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["Context"]; "application/x-www-form-urlencoded": components["schemas"]["Context"]; "multipart/form-data": components["schemas"]["Context"]; }; }; }; /** API endpoints for CRUD operations on contexts. */ api_v1_contexts_destroy: { parameters: { path: { id: string; }; }; responses: { /** No response body */ 204: never; }; }; /** API endpoints for CRUD operations on contexts. */ api_v1_contexts_partial_update: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Context"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["PatchedContext"]; "application/x-www-form-urlencoded": components["schemas"]["PatchedContext"]; "multipart/form-data": components["schemas"]["PatchedContext"]; }; }; }; /** API endpoints for CRUD operations on tasks. */ api_v1_filters_list: { parameters: { query: { /** A page number within the paginated result set. */ page?: number; }; }; responses: { 200: { content: { "application/json": components["schemas"]["PaginatedFilterList"]; }; }; }; }; /** API endpoints for CRUD operations on tasks. */ api_v1_filters_create: { responses: { 201: { content: { "application/json": components["schemas"]["Filter"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["Filter"]; "application/x-www-form-urlencoded": components["schemas"]["Filter"]; "multipart/form-data": components["schemas"]["Filter"]; }; }; }; /** API endpoints for CRUD operations on tasks. */ api_v1_filters_retrieve: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Filter"]; }; }; }; }; /** API endpoints for CRUD operations on tasks. */ api_v1_filters_update: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Filter"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["Filter"]; "application/x-www-form-urlencoded": components["schemas"]["Filter"]; "multipart/form-data": components["schemas"]["Filter"]; }; }; }; /** API endpoints for CRUD operations on tasks. */ api_v1_filters_destroy: { parameters: { path: { id: string; }; }; responses: { /** No response body */ 204: never; }; }; /** API endpoints for CRUD operations on tasks. */ api_v1_filters_partial_update: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Filter"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["PatchedFilter"]; "application/x-www-form-urlencoded": components["schemas"]["PatchedFilter"]; "multipart/form-data": components["schemas"]["PatchedFilter"]; }; }; }; api_v1_github_webhooks_create: { responses: { /** No response body */ 200: unknown; }; }; /** API endpoints for CRUD operations on JiraConfigs. */ api_v1_jira_list: { parameters: { query: { /** A page number within the paginated result set. */ page?: number; }; }; responses: { 200: { content: { "application/json": components["schemas"]["PaginatedJiraConfigList"]; }; }; }; }; /** API endpoints for CRUD operations on JiraConfigs. */ api_v1_jira_create: { responses: { 201: { content: { "application/json": components["schemas"]["JiraConfig"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["JiraConfig"]; "application/x-www-form-urlencoded": components["schemas"]["JiraConfig"]; "multipart/form-data": components["schemas"]["JiraConfig"]; }; }; }; /** API endpoints for CRUD operations on JiraConfigs. */ api_v1_jira_retrieve: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["JiraConfig"]; }; }; }; }; /** API endpoints for CRUD operations on JiraConfigs. */ api_v1_jira_update: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["JiraConfig"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["JiraConfig"]; "application/x-www-form-urlencoded": components["schemas"]["JiraConfig"]; "multipart/form-data": components["schemas"]["JiraConfig"]; }; }; }; /** API endpoints for CRUD operations on JiraConfigs. */ api_v1_jira_destroy: { parameters: { path: { id: string; }; }; responses: { /** No response body */ 204: never; }; }; /** API endpoints for CRUD operations on JiraConfigs. */ api_v1_jira_partial_update: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["JiraConfig"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["PatchedJiraConfig"]; "application/x-www-form-urlencoded": components["schemas"]["PatchedJiraConfig"]; "multipart/form-data": components["schemas"]["PatchedJiraConfig"]; }; }; }; api_v1_settings_list: { parameters: { query: { /** A page number within the paginated result set. */ page?: number; }; }; responses: { 200: { content: { "application/json": components["schemas"]["PaginatedSettingsList"]; }; }; }; }; api_v1_settings_create: { responses: { 201: { content: { "application/json": components["schemas"]["Settings"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["Settings"]; "application/x-www-form-urlencoded": components["schemas"]["Settings"]; "multipart/form-data": components["schemas"]["Settings"]; }; }; }; api_v1_settings_retrieve: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Settings"]; }; }; }; }; api_v1_settings_update: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Settings"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["Settings"]; "application/x-www-form-urlencoded": components["schemas"]["Settings"]; "multipart/form-data": components["schemas"]["Settings"]; }; }; }; api_v1_settings_destroy: { parameters: { path: { id: string; }; }; responses: { /** No response body */ 204: never; }; }; api_v1_settings_partial_update: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Settings"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["PatchedSettings"]; "application/x-www-form-urlencoded": components["schemas"]["PatchedSettings"]; "multipart/form-data": components["schemas"]["PatchedSettings"]; }; }; }; /** API endpoints for CRUD operations on sources. */ api_v1_sources_list: { parameters: { query: { /** A page number within the paginated result set. */ page?: number; }; }; responses: { 200: { content: { "application/json": components["schemas"]["PaginatedSourceList"]; }; }; }; }; /** API endpoints for CRUD operations on sources. */ api_v1_sources_create: { responses: { 201: { content: { "application/json": components["schemas"]["Source"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["Source"]; "application/x-www-form-urlencoded": components["schemas"]["Source"]; "multipart/form-data": components["schemas"]["Source"]; }; }; }; /** API endpoints for CRUD operations on sources. */ api_v1_sources_retrieve: { parameters: { path: { /** A UUID string identifying this source. */ id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Source"]; }; }; }; }; /** API endpoints for CRUD operations on sources. */ api_v1_sources_update: { parameters: { path: { /** A UUID string identifying this source. */ id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Source"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["Source"]; "application/x-www-form-urlencoded": components["schemas"]["Source"]; "multipart/form-data": components["schemas"]["Source"]; }; }; }; /** API endpoints for CRUD operations on sources. */ api_v1_sources_destroy: { parameters: { path: { /** A UUID string identifying this source. */ id: string; }; }; responses: { /** No response body */ 204: never; }; }; /** API endpoints for CRUD operations on sources. */ api_v1_sources_partial_update: { parameters: { path: { /** A UUID string identifying this source. */ id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Source"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["PatchedSource"]; "application/x-www-form-urlencoded": components["schemas"]["PatchedSource"]; "multipart/form-data": components["schemas"]["PatchedSource"]; }; }; }; /** RPC/API endpoints for CRUD operations on tasks. */ api_v1_tasks_list: { parameters: { query: { /** A page number within the paginated result set. */ page?: number; }; }; responses: { 200: { content: { "application/json": components["schemas"]["PaginatedTaskList"]; }; }; }; }; /** RPC/API endpoints for CRUD operations on tasks. */ api_v1_tasks_create: { responses: { 201: { content: { "application/json": components["schemas"]["Task"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["Task"]; "application/x-www-form-urlencoded": components["schemas"]["Task"]; "multipart/form-data": components["schemas"]["Task"]; }; }; }; /** RPC/API endpoints for CRUD operations on tasks. */ api_v1_tasks_retrieve: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Task"]; }; }; }; }; /** RPC/API endpoints for CRUD operations on tasks. */ api_v1_tasks_update: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Task"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["Task"]; "application/x-www-form-urlencoded": components["schemas"]["Task"]; "multipart/form-data": components["schemas"]["Task"]; }; }; }; /** RPC/API endpoints for CRUD operations on tasks. */ api_v1_tasks_destroy: { parameters: { path: { id: string; }; }; responses: { /** No response body */ 204: never; }; }; /** RPC/API endpoints for CRUD operations on tasks. */ api_v1_tasks_partial_update: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Task"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["PatchedTask"]; "application/x-www-form-urlencoded": components["schemas"]["PatchedTask"]; "multipart/form-data": components["schemas"]["PatchedTask"]; }; }; }; /** * RPC endpoint for completing Tasks. * * Returns the completed task. */ api_v1_tasks_complete_update: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Task"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["Task"]; "application/x-www-form-urlencoded": components["schemas"]["Task"]; "multipart/form-data": components["schemas"]["Task"]; }; }; }; /** * Defers a Task by reducing it's priority according to the other Tasks for * this user. * * If Context is given will operate only within that Context, otherwise all * Tasks are considered. * * Returns the deferred Task. */ api_v1_tasks_defer_update: { parameters: { path: { id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["Task"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["Task"]; "application/x-www-form-urlencoded": components["schemas"]["Task"]; "multipart/form-data": components["schemas"]["Task"]; }; }; }; /** Create DSL uses the Taskforge creation DSL to create a task. */ api_v1_tasks_create_create: { responses: { 200: { content: { "application/json": components["schemas"]["Task"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["Task"]; "application/x-www-form-urlencoded": components["schemas"]["Task"]; "multipart/form-data": components["schemas"]["Task"]; }; }; }; /** Returns the next highest priority task for the user. */ api_v1_tasks_next_retrieve: { responses: { 200: { content: { "application/json": components["schemas"]["Task"]; }; }; }; }; /** * Reorder tasks by manipulating their priority. * * Takes two query parameters: moved and above. These correspond to the * tasks we are moving (moved) and what task it will now sit above in the * list (above). The provided values should be the Task IDs. * * Returns the full list of Tasks for this user. */ api_v1_tasks_reorder_update: { responses: { 200: { content: { "application/json": components["schemas"]["Task"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["Task"]; "application/x-www-form-urlencoded": components["schemas"]["Task"]; "multipart/form-data": components["schemas"]["Task"]; }; }; }; /** * Takes a set of user credentials and returns an access and refresh JSON web * token pair to prove the authentication of those credentials. */ api_v1_tokens_create: { responses: { 200: { content: { "application/json": components["schemas"]["TokenObtainPair"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["TokenObtainPair"]; "application/x-www-form-urlencoded": components["schemas"]["TokenObtainPair"]; "multipart/form-data": components["schemas"]["TokenObtainPair"]; }; }; }; /** * Takes a set of user credentials and returns an access and refresh JSON web * token pair to prove the authentication of those credentials. */ api_v1_tokens_destroy: { responses: { /** No response body */ 204: never; }; }; api_v1_tokens_pat_create: { responses: { 200: { content: { "application/json": components["schemas"]["PersonalAccessToken"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["PersonalAccessToken"]; "application/x-www-form-urlencoded": components["schemas"]["PersonalAccessToken"]; "multipart/form-data": components["schemas"]["PersonalAccessToken"]; }; }; }; api_v1_tokens_pat_destroy: { responses: { /** No response body */ 204: never; }; }; /** * Takes a refresh type JSON web token and returns an access type JSON web * token if the refresh token is valid. */ api_v1_tokens_refresh_create: { responses: { /** No response body */ 200: unknown; }; }; /** * Takes a refresh type JSON web token and returns an access type JSON web * token if the refresh token is valid. */ api_v1_tokens_refresh_destroy: { responses: { /** No response body */ 204: never; }; }; /** API endpoint that allows users to be viewed or edited. */ api_v1_users_list: { parameters: { query: { /** A page number within the paginated result set. */ page?: number; }; }; responses: { 200: { content: { "application/json": components["schemas"]["PaginatedUserList"]; }; }; }; }; /** API endpoint that allows users to be viewed or edited. */ api_v1_users_create: { responses: { 201: { content: { "application/json": components["schemas"]["User"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["User"]; "application/x-www-form-urlencoded": components["schemas"]["User"]; "multipart/form-data": components["schemas"]["User"]; }; }; }; /** API endpoint that allows users to be viewed or edited. */ api_v1_users_retrieve: { parameters: { path: { /** A UUID string identifying this user. */ id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["User"]; }; }; }; }; /** API endpoint that allows users to be viewed or edited. */ api_v1_users_update: { parameters: { path: { /** A UUID string identifying this user. */ id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["User"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["User"]; "application/x-www-form-urlencoded": components["schemas"]["User"]; "multipart/form-data": components["schemas"]["User"]; }; }; }; /** API endpoint that allows users to be viewed or edited. */ api_v1_users_destroy: { parameters: { path: { /** A UUID string identifying this user. */ id: string; }; }; responses: { /** No response body */ 204: never; }; }; /** API endpoint that allows users to be viewed or edited. */ api_v1_users_partial_update: { parameters: { path: { /** A UUID string identifying this user. */ id: string; }; }; responses: { 200: { content: { "application/json": components["schemas"]["User"]; }; }; }; requestBody: { content: { "application/json": components["schemas"]["PatchedUser"]; "application/x-www-form-urlencoded": components["schemas"]["PatchedUser"]; "multipart/form-data": components["schemas"]["PatchedUser"]; }; }; }; /** * OpenApi3 schema for this API. Format can be selected via content negotiation. * * - YAML: application/vnd.oai.openapi * - JSON: application/vnd.oai.openapi+json */ schema_retrieve: { parameters: { query: { format?: "json" | "yaml"; lang?: | "af" | "ar" | "ar-dz" | "ast" | "az" | "be" | "bg" | "bn" | "br" | "bs" | "ca" | "cs" | "cy" | "da" | "de" | "dsb" | "el" | "en" | "en-au" | "en-gb" | "eo" | "es" | "es-ar" | "es-co" | "es-mx" | "es-ni" | "es-ve" | "et" | "eu" | "fa" | "fi" | "fr" | "fy" | "ga" | "gd" | "gl" | "he" | "hi" | "hr" | "hsb" | "hu" | "hy" | "ia" | "id" | "ig" | "io" | "is" | "it" | "ja" | "ka" | "kab" | "kk" | "km" | "kn" | "ko" | "ky" | "lb" | "lt" | "lv" | "mk" | "ml" | "mn" | "mr" | "my" | "nb" | "ne" | "nl" | "nn" | "os" | "pa" | "pl" | "pt" | "pt-br" | "ro" | "ru" | "sk" | "sl" | "sq" | "sr" | "sr-latn" | "sv" | "sw" | "ta" | "te" | "tg" | "th" | "tk" | "tr" | "tt" | "udm" | "uk" | "ur" | "uz" | "vi" | "zh-hans" | "zh-hant"; }; }; responses: { 200: { content: { "application/vnd.oai.openapi": { [key: string]: any }; "application/yaml": { [key: string]: any }; "application/vnd.oai.openapi+json": { [key: string]: any }; "application/json": { [key: string]: any }; }; }; }; }; } export interface external {}