nodes/generated

Interface ClockifyNodeParameters

Source
interface ClockifyNodeParameters {
    additionalFields?:
        | {
            archived?: boolean;
            name?: string;
            "sort-order"?: "ASCENDING"
            | "DESCENDING";
        }
        | {
            billable?: boolean;
            clientId?: string;
            color?: string;
            estimateUi?: {
                estimateValues: {
                    estimate?: number;
                    type?: "AUTO"
                    | "MANUAL";
                };
            };
            isPublic?: boolean;
            note?: string;
        }
        | {
            archived?: boolean;
            billable?: boolean;
            "client-status"?: "ACTIVE"
            | "ARCHIVED";
            clients?: unknown[];
            "contains-client"?: boolean;
            "contains-user"?: boolean;
            "is-template"?: boolean;
            name?: string;
            "sort-column"?: "NAME" | "CLIENT_NAME" | "DURATION";
            "sort-order"?: "ASCENDING" | "DESCENDING";
            "user-status"?: "ACTIVE" | "ARCHIVED";
            users?: string;
        }
        | {
            archived?: boolean;
            name?: string;
            "sort-column"?: "NAME";
            "sort-order"?: "ASCENDING"
            | "DESCENDING";
        }
        | { assigneeIds?: unknown[]; estimate?: string }
        | {
            email?: string;
            name?: string;
            "sort-column"?: "EMAIL" | "NAME" | "HOURLYRATE";
            "sort-order"?: "ASCENDING" | "DESCENDING";
            status?:
                | "INACTIVE"
                | "ACTIVE"
                | "PENDING"
                | "DECLINED";
        }
        | {
            billable?: boolean;
            customFieldsUi?: {
                customFieldsValues: {
                    customFieldId?: string;
                    value?: string;
                }[];
            };
            description?: string;
            end?: string;
            projectId?: string;
            tagIds?: unknown[];
            taskId?: string;
        }
        | {
            "consider-duration-format"?: boolean;
            hydrated?: boolean;
        };
    clientId?: string;
    filters?: {
        "is-active"?: boolean;
        name?: string;
        "sort-column"?: "NAME";
        "sort-order"?: "ASCENDING"
        | "DESCENDING";
    };
    limit?: number;
    name?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete";
    projectId?: string;
    resource?: | "tag"
    | "user"
    | "project"
    | "task"
    | "workspace"
    | "timeEntry"
    | "client";
    returnAll?: boolean;
    start?: string;
    tagId?: string;
    taskId?: string;
    timeEntryId?: string;
    updateFields?: | {
        address?: string;
        archived?: boolean;
    }
    | {
        billable?: boolean;
        clientId?: string;
        color?: string;
        estimateUi?: {
            estimateValues: {
                estimate?: number;
                type?: "AUTO"
                | "MANUAL";
            };
        };
        isPublic?: boolean;
        name?: string;
        note?: string;
    }
    | { archived?: boolean; name?: string }
    | {
        assigneeIds?: unknown[];
        estimate?: string;
        name?: string;
        status?: "ACTIVE" | "DONE";
    }
    | {
        billable?: boolean;
        customFieldsUi?: {
            customFieldsValues: {
                customFieldId?: string;
                value?: string;
            }[];
        };
        description?: string;
        end?: string;
        projectId?: string;
        start?: string;
        tagIds?: unknown[];
        taskId?: string;
    };
    workspaceId?: string;
}

Properties§

§readonly additionalFields?:
    | {
        archived?: boolean;
        name?: string;
        "sort-order"?: "ASCENDING"
        | "DESCENDING";
    }
    | {
        billable?: boolean;
        clientId?: string;
        color?: string;
        estimateUi?: {
            estimateValues: {
                estimate?: number;
                type?: "AUTO"
                | "MANUAL";
            };
        };
        isPublic?: boolean;
        note?: string;
    }
    | {
        archived?: boolean;
        billable?: boolean;
        "client-status"?: "ACTIVE"
        | "ARCHIVED";
        clients?: unknown[];
        "contains-client"?: boolean;
        "contains-user"?: boolean;
        "is-template"?: boolean;
        name?: string;
        "sort-column"?: "NAME" | "CLIENT_NAME" | "DURATION";
        "sort-order"?: "ASCENDING" | "DESCENDING";
        "user-status"?: "ACTIVE" | "ARCHIVED";
        users?: string;
    }
    | {
        archived?: boolean;
        name?: string;
        "sort-column"?: "NAME";
        "sort-order"?: "ASCENDING"
        | "DESCENDING";
    }
    | { assigneeIds?: unknown[]; estimate?: string }
    | {
        email?: string;
        name?: string;
        "sort-column"?: "EMAIL" | "NAME" | "HOURLYRATE";
        "sort-order"?: "ASCENDING" | "DESCENDING";
        status?:
            | "INACTIVE"
            | "ACTIVE"
            | "PENDING"
            | "DECLINED";
    }
    | {
        billable?: boolean;
        customFieldsUi?: {
            customFieldsValues: {
                customFieldId?: string;
                value?: string;
            }[];
        };
        description?: string;
        end?: string;
        projectId?: string;
        tagIds?: unknown[];
        taskId?: string;
    }
    | {
        "consider-duration-format"?: boolean;
        hydrated?: boolean;
    }

Default: {}

§readonly clientId?: string
§readonly filters?: { ... }

Default: {}

§readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":500}

§readonly name?: string

Name of client being created

§readonly operation?: "create" | "get" | "getAll" | "update" | "delete"

Default: "create"

§readonly projectId?: string
§readonly resource?:
    | "tag"
    | "user"
    | "project"
    | "task"
    | "workspace"
    | "timeEntry"
    | "client"

Default: "project"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly start?: string
§readonly tagId?: string
§readonly taskId?: string

ID of task to delete

§readonly timeEntryId?: string
§readonly updateFields?:
    | { address?: string; archived?: boolean }
    | {
        billable?: boolean;
        clientId?: string;
        color?: string;
        estimateUi?: {
            estimateValues: {
                estimate?: number;
                type?: "AUTO" | "MANUAL";
            };
        };
        isPublic?: boolean;
        name?: string;
        note?: string;
    }
    | { archived?: boolean; name?: string }
    | {
        assigneeIds?: unknown[];
        estimate?: string;
        name?: string;
        status?: "ACTIVE" | "DONE";
    }
    | {
        billable?: boolean;
        customFieldsUi?: {
            customFieldsValues: {
                customFieldId?: string;
                value?: string;
            }[];
        };
        description?: string;
        end?: string;
        projectId?: string;
        start?: string;
        tagIds?: unknown[];
        taskId?: string;
    }

Default: {}

§readonly workspaceId?: string

Choose from the list, or specify an ID using an expression Default: [] Type options: {"loadOptionsMethod":"listWorkspaces"}