Interface paths

interface paths {
    "/jobs/": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    filter_active?: boolean;
                    filter_name?: string;
                    filter_status?: string;
                    filter_stopped?: boolean;
                    order?: string;
                    result_count?: number;
                    submitted_after?: string;
                    submitted_before?: string;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            jobs?: {
                                callback_body: Record<string, unknown>;
                                callback_url: string;
                                inactive_reason?: { cause: ...; detail?: ... };
                                interval?: number;
                                job_id: string;
                                last_ran_at?: string;
                                n_errors: number;
                                n_runs: number;
                                name?: string;
                                next_run?: string;
                                results: { data: (...)[]; page_next?: (...) | (...) };
                                schedule:
                                    | { datetime?: ...; type: ... }
                                    | { end?: ...; interval_seconds: ...; start?: ...; type: ... };
                                scope?: string;
                                start: string;
                                status: string;
                                stop_after?: { date?: ...; n_runs?: ... };
                                submitted_at: string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        callback_body: Record<string, unknown>;
                        callback_url: string;
                        interval?: number;
                        name?: string;
                        refresh_token?: string;
                        scope?: string;
                        start: string;
                        stop_after?: { date?: string; n_runs?: number };
                    };
                };
            };
            responses: {
                "201": {
                    content: {
                        "application/json": {
                            callback_body: Record<string, unknown>;
                            callback_url: string;
                            inactive_reason?: {
                                cause: "user" | "globus_auth_requirements";
                                detail?: Record<string, unknown>;
                            };
                            interval?: number;
                            job_id: string;
                            last_ran_at?: string;
                            n_errors: number;
                            n_runs: number;
                            name?: string;
                            next_run?: string;
                            results: {
                                data: {
                                    data?: Record<(...), (...)>;
                                    end_timestamp?: string;
                                    errors?: Record<(...), (...)>;
                                    http_status_polled?: number;
                                    http_status_submission?: number;
                                    last_check_timestamp?: string;
                                    next_check_timestamp?: string;
                                    ran_at: string;
                                    resource_id?: string;
                                    run_status: string;
                                    start_timestamp: string;
                                    status?: number;
                                }[];
                                page_next?: string;
                            };
                            schedule: | { datetime?: string; type: "once" }
                            | {
                                end?:
                                    | { condition: "iterations"; count: number }
                                    | { condition: "time"; datetime: string };
                                interval_seconds: number;
                                start?: string;
                                type: "recurring";
                            };
                            scope?: string;
                            start: string;
                            status: string;
                            stop_after?: { date?: string; n_runs?: number };
                            submitted_at: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/jobs/{job_id}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { job_id: string };
                query?: { page_size?: number; results_pt?: string };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            callback_body: Record<string, unknown>;
                            callback_url: string;
                            inactive_reason?: {
                                cause: "user" | "globus_auth_requirements";
                                detail?: Record<string, unknown>;
                            };
                            interval?: number;
                            job_id: string;
                            last_ran_at?: string;
                            n_errors: number;
                            n_runs: number;
                            name?: string;
                            next_run?: string;
                            results: {
                                data: {
                                    data?: Record<(...), (...)>;
                                    end_timestamp?: string;
                                    errors?: Record<(...), (...)>;
                                    http_status_polled?: number;
                                    http_status_submission?: number;
                                    last_check_timestamp?: string;
                                    next_check_timestamp?: string;
                                    ran_at: string;
                                    resource_id?: string;
                                    run_status: string;
                                    start_timestamp: string;
                                    status?: number;
                                }[];
                                page_next?: string;
                            };
                            schedule: | { datetime?: string; type: "once" }
                            | {
                                end?:
                                    | { condition: "iterations"; count: number }
                                    | { condition: "time"; datetime: string };
                                interval_seconds: number;
                                start?: string;
                                type: "recurring";
                            };
                            scope?: string;
                            start: string;
                            status: string;
                            stop_after?: { date?: string; n_runs?: number };
                            submitted_at: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { job_id: string };
                query?: undefined;
            };
            requestBody: { content: { "application/json": { name?: string } } };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            callback_body: Record<string, unknown>;
                            callback_url: string;
                            inactive_reason?: {
                                cause: "user" | "globus_auth_requirements";
                                detail?: Record<string, unknown>;
                            };
                            interval?: number;
                            job_id: string;
                            last_ran_at?: string;
                            n_errors: number;
                            n_runs: number;
                            name?: string;
                            next_run?: string;
                            results: {
                                data: {
                                    data?: Record<(...), (...)>;
                                    end_timestamp?: string;
                                    errors?: Record<(...), (...)>;
                                    http_status_polled?: number;
                                    http_status_submission?: number;
                                    last_check_timestamp?: string;
                                    next_check_timestamp?: string;
                                    ran_at: string;
                                    resource_id?: string;
                                    run_status: string;
                                    start_timestamp: string;
                                    status?: number;
                                }[];
                                page_next?: string;
                            };
                            schedule: | { datetime?: string; type: "once" }
                            | {
                                end?:
                                    | { condition: "iterations"; count: number }
                                    | { condition: "time"; datetime: string };
                                interval_seconds: number;
                                start?: string;
                                type: "recurring";
                            };
                            scope?: string;
                            start: string;
                            status: string;
                            stop_after?: { date?: string; n_runs?: number };
                            submitted_at: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/jobs/{job_id}/pause": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { job_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: { "application/json": { message: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/jobs/{job_id}/resume": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { job_id: string };
                query?: { update_credentials?: boolean };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: { "application/json": { message: string } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
    "/jobs/{timer_id}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { timer_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            callback_body: Record<string, unknown>;
                            callback_url: string;
                            inactive_reason?: {
                                cause: "user" | "globus_auth_requirements";
                                detail?: Record<string, unknown>;
                            };
                            interval?: number;
                            job_id: string;
                            last_ran_at?: string;
                            n_errors: number;
                            n_runs: number;
                            name?: string;
                            next_run?: string;
                            results: {
                                data: {
                                    data?: Record<(...), (...)>;
                                    end_timestamp?: string;
                                    errors?: Record<(...), (...)>;
                                    http_status_polled?: number;
                                    http_status_submission?: number;
                                    last_check_timestamp?: string;
                                    next_check_timestamp?: string;
                                    ran_at: string;
                                    resource_id?: string;
                                    run_status: string;
                                    start_timestamp: string;
                                    status?: number;
                                }[];
                                page_next?: string;
                            };
                            schedule: | { datetime?: string; type: "once" }
                            | {
                                end?:
                                    | { condition: "iterations"; count: number }
                                    | { condition: "time"; datetime: string };
                                interval_seconds: number;
                                start?: string;
                                type: "recurring";
                            };
                            scope?: string;
                            start: string;
                            status: string;
                            stop_after?: { date?: string; n_runs?: number };
                            submitted_at: string;
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    };
    "/v2/timer": {
        delete?: undefined;
        get?: undefined;
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        timer: {
                            body: {
                                DATA: {
                                    checksum_algorithm?: string;
                                    DATA_TYPE: "transfer_item";
                                    destination_path: string;
                                    external_checksum?: string;
                                    recursive?: boolean;
                                    source_path: string;
                                }[];
                                DATA_TYPE: "transfer";
                                deadline?: string;
                                delete_destination_extra: boolean;
                                destination_endpoint: string;
                                destination_local_user?: string;
                                encrypt_data: boolean;
                                fail_on_quota_errors: boolean;
                                filter_rules?: {
                                    DATA_TYPE: "filter_rule";
                                    method: (...)
                                    | (...);
                                    name: string;
                                    type?: (...) | (...) | (...);
                                }[];
                                label?: string;
                                notify_on_failed: boolean;
                                notify_on_inactive: boolean;
                                notify_on_succeeded: boolean;
                                preserve_timestamp: boolean;
                                skip_source_errors: boolean;
                                source_endpoint: string;
                                source_local_user?: string;
                                store_base_path_info: boolean;
                                sync_level?: 0
                                | 2
                                | 1
                                | 3;
                                verify_checksum: boolean;
                            };
                            name?: string;
                            resource_server: "transfer.api.globus.org";
                            schedule: | { datetime?: string; type: "once" }
                            | {
                                end?:
                                    | { condition: "iterations"; count: number }
                                    | { condition: "time"; datetime: string };
                                interval_seconds: number;
                                start?: string;
                                type: "recurring";
                            };
                            timer_type: "transfer";
                        };
                    };
                };
            };
            responses: {
                "201": {
                    content: {
                        "application/json": {
                            timer: {
                                body: {
                                    DATA: {
                                        checksum_algorithm?: (...)
                                        | (...);
                                        DATA_TYPE: "transfer_item";
                                        destination_path: string;
                                        external_checksum?: (...) | (...);
                                        recursive?: (...) | (...) | (...);
                                        source_path: string;
                                    }[];
                                    DATA_TYPE: "transfer";
                                    deadline?: string;
                                    delete_destination_extra: boolean;
                                    destination_endpoint: string;
                                    destination_local_user?: string;
                                    encrypt_data: boolean;
                                    fail_on_quota_errors: boolean;
                                    filter_rules?: {
                                        DATA_TYPE: ...;
                                        method: ...;
                                        name: ...;
                                        type?: ...;
                                    }[];
                                    label?: string;
                                    notify_on_failed: boolean;
                                    notify_on_inactive: boolean;
                                    notify_on_succeeded: boolean;
                                    preserve_timestamp: boolean;
                                    skip_source_errors: boolean;
                                    source_endpoint: string;
                                    source_local_user?: string;
                                    store_base_path_info: boolean;
                                    sync_level?: 0
                                    | 2
                                    | 1
                                    | 3;
                                    verify_checksum: boolean;
                                };
                                inactive_reason?: {
                                    cause: "user"
                                    | "globus_auth_requirements";
                                    detail?: Record<(...), (...)>;
                                };
                                job_id: string;
                                last_ran_at?: string;
                                name?: string;
                                next_run?: string;
                                number_of_errors: number;
                                number_of_runs: number;
                                schedule: | { datetime?: string; type: "once" }
                                | {
                                    end?:
                                        | { condition: ...; count: ... }
                                        | { condition: ...; datetime: ... };
                                    interval_seconds: number;
                                    start?: string;
                                    type: "recurring";
                                };
                                status: string;
                                submitted_at: string;
                                timer_type: "transfer";
                            };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    };
}

Index

Properties

/jobs/ /jobs/{job_id} /jobs/{job_id}/pause /jobs/{job_id}/resume /jobs/{timer_id} /v2/timer

Properties

/jobs/

"/jobs/": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                filter_active?: boolean;
                filter_name?: string;
                filter_status?: string;
                filter_stopped?: boolean;
                order?: string;
                result_count?: number;
                submitted_after?: string;
                submitted_before?: string;
            };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        jobs?: {
                            callback_body: Record<string, unknown>;
                            callback_url: string;
                            inactive_reason?: { cause: ...; detail?: ... };
                            interval?: number;
                            job_id: string;
                            last_ran_at?: string;
                            n_errors: number;
                            n_runs: number;
                            name?: string;
                            next_run?: string;
                            results: { data: (...)[]; page_next?: (...) | (...) };
                            schedule:
                                | { datetime?: ...; type: ... }
                                | { end?: ...; interval_seconds: ...; start?: ...; type: ... };
                            scope?: string;
                            start: string;
                            status: string;
                            stop_after?: { date?: ...; n_runs?: ... };
                            submitted_at: string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    callback_body: Record<string, unknown>;
                    callback_url: string;
                    interval?: number;
                    name?: string;
                    refresh_token?: string;
                    scope?: string;
                    start: string;
                    stop_after?: { date?: string; n_runs?: number };
                };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        callback_body: Record<string, unknown>;
                        callback_url: string;
                        inactive_reason?: {
                            cause: "user" | "globus_auth_requirements";
                            detail?: Record<string, unknown>;
                        };
                        interval?: number;
                        job_id: string;
                        last_ran_at?: string;
                        n_errors: number;
                        n_runs: number;
                        name?: string;
                        next_run?: string;
                        results: {
                            data: {
                                data?: Record<(...), (...)>;
                                end_timestamp?: string;
                                errors?: Record<(...), (...)>;
                                http_status_polled?: number;
                                http_status_submission?: number;
                                last_check_timestamp?: string;
                                next_check_timestamp?: string;
                                ran_at: string;
                                resource_id?: string;
                                run_status: string;
                                start_timestamp: string;
                                status?: number;
                            }[];
                            page_next?: string;
                        };
                        schedule: | { datetime?: string; type: "once" }
                        | {
                            end?:
                                | { condition: "iterations"; count: number }
                                | { condition: "time"; datetime: string };
                            interval_seconds: number;
                            start?: string;
                            type: "recurring";
                        };
                        scope?: string;
                        start: string;
                        status: string;
                        stop_after?: { date?: string; n_runs?: number };
                        submitted_at: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

Optionaldelete?: undefined
get: {
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: {
            filter_active?: boolean;
            filter_name?: string;
            filter_status?: string;
            filter_stopped?: boolean;
            order?: string;
            result_count?: number;
            submitted_after?: string;
            submitted_before?: string;
        };
    };
    requestBody?: undefined;
    responses: {
        "200": {
            content: {
                "application/json": {
                    jobs?: {
                        callback_body: Record<string, unknown>;
                        callback_url: string;
                        inactive_reason?: { cause: ...; detail?: ... };
                        interval?: number;
                        job_id: string;
                        last_ran_at?: string;
                        n_errors: number;
                        n_runs: number;
                        name?: string;
                        next_run?: string;
                        results: { data: (...)[]; page_next?: (...) | (...) };
                        schedule:
                            | { datetime?: ...; type: ... }
                            | { end?: ...; interval_seconds: ...; start?: ...; type: ... };
                        scope?: string;
                        start: string;
                        status: string;
                        stop_after?: { date?: ...; n_runs?: ... };
                        submitted_at: string;
                    }[];
                };
            };
            headers: { [name: string]: unknown };
        };
        "422": {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        };
    };
}
List Jobs
Description
List the current user's timers.
```
By default, this includes all of the user's timers, even those which have ended.
```
- parameters: {
      cookie?: undefined;
      header?: undefined;
      path?: undefined;
      query?: {
          filter_active?: boolean;
          filter_name?: string;
          filter_status?: string;
          filter_stopped?: boolean;
          order?: string;
          result_count?: number;
          submitted_after?: string;
          submitted_before?: string;
      };
  }
  - Optionalcookie?: undefined
  - Optionalheader?: undefined
  - Optionalpath?: undefined
  - Optionalquery?: {
        filter_active?: boolean;
        filter_name?: string;
        filter_status?: string;
        filter_stopped?: boolean;
        order?: string;
        result_count?: number;
        submitted_after?: string;
        submitted_before?: string;
    }
    - Optionalfilter_active?: boolean
      Description
      [DEPRECATED] Equivalent to 'filter_status=active'.
    - Optionalfilter_name?: string
      Description
      List only jobs with names containing the argument as a substring (case-insensitive).
    - Optionalfilter_status?: string
      Description
      Only return timers with the provided statuses, specified as a comma-separated list. Valid statuses are 'active', 'inactive', and 'ended'. Defaults to 'active,inactive,ended'.
    - Optionalfilter_stopped?: boolean
      Description
      [DEPRECATED] Equivalent to 'filter_status=ended'.
    - Optionalorder?: string
      Description
      Specify the order of the returned job list. The argument provided has the format FIELD [asc|desc] where FIELD is any orderable field on the job model. asc or desc is separated with a space from the field name. If neither is provided, the ordering always defaults to ascending. For example, name desc would list jobs in reverse alphabetical order on name; submitted_at (with no ordering specified) would list oldest jobs first.
    - Optionalresult_count?: number
      Description
      Limit the number of results returned per job.
    - Optionalsubmitted_after?: string
      Description
      Filter listed jobs to only those submitted after the specified date.
    - Optionalsubmitted_before?: string
      Description
      Filter listed jobs to only those submitted before the specified date.
- OptionalrequestBody?: undefined
- responses: {
      "200": {
          content: {
              "application/json": {
                  jobs?: {
                      callback_body: Record<string, unknown>;
                      callback_url: string;
                      inactive_reason?: { cause: ...; detail?: ... };
                      interval?: number;
                      job_id: string;
                      last_ran_at?: string;
                      n_errors: number;
                      n_runs: number;
                      name?: string;
                      next_run?: string;
                      results: { data: (...)[]; page_next?: (...) | (...) };
                      schedule:
                          | { datetime?: ...; type: ... }
                          | { end?: ...; interval_seconds: ...; start?: ...; type: ... };
                      scope?: string;
                      start: string;
                      status: string;
                      stop_after?: { date?: ...; n_runs?: ... };
                      submitted_at: string;
                  }[];
              };
          };
          headers: { [name: string]: unknown };
      };
      "422": {
          content: {
              "application/json": {
                  detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
              };
          };
          headers: { [name: string]: unknown };
      };
  }
  - 200: {
        content: {
            "application/json": {
                jobs?: {
                    callback_body: Record<string, unknown>;
                    callback_url: string;
                    inactive_reason?: { cause: ...; detail?: ... };
                    interval?: number;
                    job_id: string;
                    last_ran_at?: string;
                    n_errors: number;
                    n_runs: number;
                    name?: string;
                    next_run?: string;
                    results: { data: (...)[]; page_next?: (...) | (...) };
                    schedule:
                        | { datetime?: ...; type: ... }
                        | { end?: ...; interval_seconds: ...; start?: ...; type: ... };
                    scope?: string;
                    start: string;
                    status: string;
                    stop_after?: { date?: ...; n_runs?: ... };
                    submitted_at: string;
                }[];
            };
        };
        headers: { [name: string]: unknown };
    }
    Description
    Successful Response
  - 422: {
        content: {
            "application/json": {
                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
            };
        };
        headers: { [name: string]: unknown };
    }
    Description
    Validation Error
Optionalhead?: undefined
Optionaloptions?: undefined
parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optionalpatch?: undefined
post: {
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    requestBody: {
        content: {
            "application/json": {
                callback_body: Record<string, unknown>;
                callback_url: string;
                interval?: number;
                name?: string;
                refresh_token?: string;
                scope?: string;
                start: string;
                stop_after?: { date?: string; n_runs?: number };
            };
        };
    };
    responses: {
        "201": {
            content: {
                "application/json": {
                    callback_body: Record<string, unknown>;
                    callback_url: string;
                    inactive_reason?: {
                        cause: "user" | "globus_auth_requirements";
                        detail?: Record<string, unknown>;
                    };
                    interval?: number;
                    job_id: string;
                    last_ran_at?: string;
                    n_errors: number;
                    n_runs: number;
                    name?: string;
                    next_run?: string;
                    results: {
                        data: {
                            data?: Record<(...), (...)>;
                            end_timestamp?: string;
                            errors?: Record<(...), (...)>;
                            http_status_polled?: number;
                            http_status_submission?: number;
                            last_check_timestamp?: string;
                            next_check_timestamp?: string;
                            ran_at: string;
                            resource_id?: string;
                            run_status: string;
                            start_timestamp: string;
                            status?: number;
                        }[];
                        page_next?: string;
                    };
                    schedule: | { datetime?: string; type: "once" }
                    | {
                        end?:
                            | { condition: "iterations"; count: number }
                            | { condition: "time"; datetime: string };
                        interval_seconds: number;
                        start?: string;
                        type: "recurring";
                    };
                    scope?: string;
                    start: string;
                    status: string;
                    stop_after?: { date?: string; n_runs?: number };
                    submitted_at: string;
                };
            };
            headers: { [name: string]: unknown };
        };
        "422": {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        };
    };
}
Submit Job
Description
Submit a new job (timer).
```
Some aspects to note for job submissions:
- Intervals are rounded down to the nearest second
- Jobs must be scheduled to start after 1970-01-01
  and within one year of when it is submitted.
- If the job is set to stop after exactly 1 run then the interval must be null.
  Otherwise, the job interval must be between 60 seconds and 365 days.
```
- parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- requestBody: {
      content: {
          "application/json": {
              callback_body: Record<string, unknown>;
              callback_url: string;
              interval?: number;
              name?: string;
              refresh_token?: string;
              scope?: string;
              start: string;
              stop_after?: { date?: string; n_runs?: number };
          };
      };
  }
- responses: {
      "201": {
          content: {
              "application/json": {
                  callback_body: Record<string, unknown>;
                  callback_url: string;
                  inactive_reason?: {
                      cause: "user" | "globus_auth_requirements";
                      detail?: Record<string, unknown>;
                  };
                  interval?: number;
                  job_id: string;
                  last_ran_at?: string;
                  n_errors: number;
                  n_runs: number;
                  name?: string;
                  next_run?: string;
                  results: {
                      data: {
                          data?: Record<(...), (...)>;
                          end_timestamp?: string;
                          errors?: Record<(...), (...)>;
                          http_status_polled?: number;
                          http_status_submission?: number;
                          last_check_timestamp?: string;
                          next_check_timestamp?: string;
                          ran_at: string;
                          resource_id?: string;
                          run_status: string;
                          start_timestamp: string;
                          status?: number;
                      }[];
                      page_next?: string;
                  };
                  schedule: | { datetime?: string; type: "once" }
                  | {
                      end?:
                          | { condition: "iterations"; count: number }
                          | { condition: "time"; datetime: string };
                      interval_seconds: number;
                      start?: string;
                      type: "recurring";
                  };
                  scope?: string;
                  start: string;
                  status: string;
                  stop_after?: { date?: string; n_runs?: number };
                  submitted_at: string;
              };
          };
          headers: { [name: string]: unknown };
      };
      "422": {
          content: {
              "application/json": {
                  detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
              };
          };
          headers: { [name: string]: unknown };
      };
  }
  - 201: {
        content: {
            "application/json": {
                callback_body: Record<string, unknown>;
                callback_url: string;
                inactive_reason?: {
                    cause: "user" | "globus_auth_requirements";
                    detail?: Record<string, unknown>;
                };
                interval?: number;
                job_id: string;
                last_ran_at?: string;
                n_errors: number;
                n_runs: number;
                name?: string;
                next_run?: string;
                results: {
                    data: {
                        data?: Record<(...), (...)>;
                        end_timestamp?: string;
                        errors?: Record<(...), (...)>;
                        http_status_polled?: number;
                        http_status_submission?: number;
                        last_check_timestamp?: string;
                        next_check_timestamp?: string;
                        ran_at: string;
                        resource_id?: string;
                        run_status: string;
                        start_timestamp: string;
                        status?: number;
                    }[];
                    page_next?: string;
                };
                schedule: | { datetime?: string; type: "once" }
                | {
                    end?:
                        | { condition: "iterations"; count: number }
                        | { condition: "time"; datetime: string };
                    interval_seconds: number;
                    start?: string;
                    type: "recurring";
                };
                scope?: string;
                start: string;
                status: string;
                stop_after?: { date?: string; n_runs?: number };
                submitted_at: string;
            };
        };
        headers: { [name: string]: unknown };
    }
    Description
    Successful Response
  - 422: {
        content: {
            "application/json": {
                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
            };
        };
        headers: { [name: string]: unknown };
    }
    Description
    Validation Error
Optionalput?: undefined
Optionaltrace?: undefined

/jobs/{job_id}

"/jobs/{job_id}": {
    delete?: undefined;
    get: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { job_id: string };
            query?: { page_size?: number; results_pt?: string };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        callback_body: Record<string, unknown>;
                        callback_url: string;
                        inactive_reason?: {
                            cause: "user" | "globus_auth_requirements";
                            detail?: Record<string, unknown>;
                        };
                        interval?: number;
                        job_id: string;
                        last_ran_at?: string;
                        n_errors: number;
                        n_runs: number;
                        name?: string;
                        next_run?: string;
                        results: {
                            data: {
                                data?: Record<(...), (...)>;
                                end_timestamp?: string;
                                errors?: Record<(...), (...)>;
                                http_status_polled?: number;
                                http_status_submission?: number;
                                last_check_timestamp?: string;
                                next_check_timestamp?: string;
                                ran_at: string;
                                resource_id?: string;
                                run_status: string;
                                start_timestamp: string;
                                status?: number;
                            }[];
                            page_next?: string;
                        };
                        schedule: | { datetime?: string; type: "once" }
                        | {
                            end?:
                                | { condition: "iterations"; count: number }
                                | { condition: "time"; datetime: string };
                            interval_seconds: number;
                            start?: string;
                            type: "recurring";
                        };
                        scope?: string;
                        start: string;
                        status: string;
                        stop_after?: { date?: string; n_runs?: number };
                        submitted_at: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    };
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { job_id: string };
            query?: undefined;
        };
        requestBody: { content: { "application/json": { name?: string } } };
        responses: {
            "200": {
                content: {
                    "application/json": {
                        callback_body: Record<string, unknown>;
                        callback_url: string;
                        inactive_reason?: {
                            cause: "user" | "globus_auth_requirements";
                            detail?: Record<string, unknown>;
                        };
                        interval?: number;
                        job_id: string;
                        last_ran_at?: string;
                        n_errors: number;
                        n_runs: number;
                        name?: string;
                        next_run?: string;
                        results: {
                            data: {
                                data?: Record<(...), (...)>;
                                end_timestamp?: string;
                                errors?: Record<(...), (...)>;
                                http_status_polled?: number;
                                http_status_submission?: number;
                                last_check_timestamp?: string;
                                next_check_timestamp?: string;
                                ran_at: string;
                                resource_id?: string;
                                run_status: string;
                                start_timestamp: string;
                                status?: number;
                            }[];
                            page_next?: string;
                        };
                        schedule: | { datetime?: string; type: "once" }
                        | {
                            end?:
                                | { condition: "iterations"; count: number }
                                | { condition: "time"; datetime: string };
                            interval_seconds: number;
                            start?: string;
                            type: "recurring";
                        };
                        scope?: string;
                        start: string;
                        status: string;
                        stop_after?: { date?: string; n_runs?: number };
                        submitted_at: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    };
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

Optionaldelete?: undefined
get: {
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: { job_id: string };
        query?: { page_size?: number; results_pt?: string };
    };
    requestBody?: undefined;
    responses: {
        "200": {
            content: {
                "application/json": {
                    callback_body: Record<string, unknown>;
                    callback_url: string;
                    inactive_reason?: {
                        cause: "user" | "globus_auth_requirements";
                        detail?: Record<string, unknown>;
                    };
                    interval?: number;
                    job_id: string;
                    last_ran_at?: string;
                    n_errors: number;
                    n_runs: number;
                    name?: string;
                    next_run?: string;
                    results: {
                        data: {
                            data?: Record<(...), (...)>;
                            end_timestamp?: string;
                            errors?: Record<(...), (...)>;
                            http_status_polled?: number;
                            http_status_submission?: number;
                            last_check_timestamp?: string;
                            next_check_timestamp?: string;
                            ran_at: string;
                            resource_id?: string;
                            run_status: string;
                            start_timestamp: string;
                            status?: number;
                        }[];
                        page_next?: string;
                    };
                    schedule: | { datetime?: string; type: "once" }
                    | {
                        end?:
                            | { condition: "iterations"; count: number }
                            | { condition: "time"; datetime: string };
                        interval_seconds: number;
                        start?: string;
                        type: "recurring";
                    };
                    scope?: string;
                    start: string;
                    status: string;
                    stop_after?: { date?: string; n_runs?: number };
                    submitted_at: string;
                };
            };
            headers: { [name: string]: unknown };
        };
        "422": {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        };
    };
}
Read Job
Description
Get the information for a specific job.
```
Because re-running the job over time can accumulate a large number of results, the
results are only available in individual pages. A "default" request to this URL
returns the first page within the `results` field, along with a `page_next` field
you pass as the query argument `results_pt` to obtain the next page.
```
- parameters: {
      cookie?: undefined;
      header?: undefined;
      path: { job_id: string };
      query?: { page_size?: number; results_pt?: string };
  }
- OptionalrequestBody?: undefined
- responses: {
      "200": {
          content: {
              "application/json": {
                  callback_body: Record<string, unknown>;
                  callback_url: string;
                  inactive_reason?: {
                      cause: "user" | "globus_auth_requirements";
                      detail?: Record<string, unknown>;
                  };
                  interval?: number;
                  job_id: string;
                  last_ran_at?: string;
                  n_errors: number;
                  n_runs: number;
                  name?: string;
                  next_run?: string;
                  results: {
                      data: {
                          data?: Record<(...), (...)>;
                          end_timestamp?: string;
                          errors?: Record<(...), (...)>;
                          http_status_polled?: number;
                          http_status_submission?: number;
                          last_check_timestamp?: string;
                          next_check_timestamp?: string;
                          ran_at: string;
                          resource_id?: string;
                          run_status: string;
                          start_timestamp: string;
                          status?: number;
                      }[];
                      page_next?: string;
                  };
                  schedule: | { datetime?: string; type: "once" }
                  | {
                      end?:
                          | { condition: "iterations"; count: number }
                          | { condition: "time"; datetime: string };
                      interval_seconds: number;
                      start?: string;
                      type: "recurring";
                  };
                  scope?: string;
                  start: string;
                  status: string;
                  stop_after?: { date?: string; n_runs?: number };
                  submitted_at: string;
              };
          };
          headers: { [name: string]: unknown };
      };
      "422": {
          content: {
              "application/json": {
                  detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
              };
          };
          headers: { [name: string]: unknown };
      };
  }
  - 200: {
        content: {
            "application/json": {
                callback_body: Record<string, unknown>;
                callback_url: string;
                inactive_reason?: {
                    cause: "user" | "globus_auth_requirements";
                    detail?: Record<string, unknown>;
                };
                interval?: number;
                job_id: string;
                last_ran_at?: string;
                n_errors: number;
                n_runs: number;
                name?: string;
                next_run?: string;
                results: {
                    data: {
                        data?: Record<(...), (...)>;
                        end_timestamp?: string;
                        errors?: Record<(...), (...)>;
                        http_status_polled?: number;
                        http_status_submission?: number;
                        last_check_timestamp?: string;
                        next_check_timestamp?: string;
                        ran_at: string;
                        resource_id?: string;
                        run_status: string;
                        start_timestamp: string;
                        status?: number;
                    }[];
                    page_next?: string;
                };
                schedule: | { datetime?: string; type: "once" }
                | {
                    end?:
                        | { condition: "iterations"; count: number }
                        | { condition: "time"; datetime: string };
                    interval_seconds: number;
                    start?: string;
                    type: "recurring";
                };
                scope?: string;
                start: string;
                status: string;
                stop_after?: { date?: string; n_runs?: number };
                submitted_at: string;
            };
        };
        headers: { [name: string]: unknown };
    }
    Description
    Successful Response
  - 422: {
        content: {
            "application/json": {
                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
            };
        };
        headers: { [name: string]: unknown };
    }
    Description
    Validation Error
Optionalhead?: undefined
Optionaloptions?: undefined
parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
patch: {
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: { job_id: string };
        query?: undefined;
    };
    requestBody: { content: { "application/json": { name?: string } } };
    responses: {
        "200": {
            content: {
                "application/json": {
                    callback_body: Record<string, unknown>;
                    callback_url: string;
                    inactive_reason?: {
                        cause: "user" | "globus_auth_requirements";
                        detail?: Record<string, unknown>;
                    };
                    interval?: number;
                    job_id: string;
                    last_ran_at?: string;
                    n_errors: number;
                    n_runs: number;
                    name?: string;
                    next_run?: string;
                    results: {
                        data: {
                            data?: Record<(...), (...)>;
                            end_timestamp?: string;
                            errors?: Record<(...), (...)>;
                            http_status_polled?: number;
                            http_status_submission?: number;
                            last_check_timestamp?: string;
                            next_check_timestamp?: string;
                            ran_at: string;
                            resource_id?: string;
                            run_status: string;
                            start_timestamp: string;
                            status?: number;
                        }[];
                        page_next?: string;
                    };
                    schedule: | { datetime?: string; type: "once" }
                    | {
                        end?:
                            | { condition: "iterations"; count: number }
                            | { condition: "time"; datetime: string };
                        interval_seconds: number;
                        start?: string;
                        type: "recurring";
                    };
                    scope?: string;
                    start: string;
                    status: string;
                    stop_after?: { date?: string; n_runs?: number };
                    submitted_at: string;
                };
            };
            headers: { [name: string]: unknown };
        };
        "422": {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        };
    };
}
Update Job
Description
Modify an existing job.
```
This can only be used to update a subset of fields.
```
- parameters: {
      cookie?: undefined;
      header?: undefined;
      path: { job_id: string };
      query?: undefined;
  }
- requestBody: { content: { "application/json": { name?: string } } }
- responses: {
      "200": {
          content: {
              "application/json": {
                  callback_body: Record<string, unknown>;
                  callback_url: string;
                  inactive_reason?: {
                      cause: "user" | "globus_auth_requirements";
                      detail?: Record<string, unknown>;
                  };
                  interval?: number;
                  job_id: string;
                  last_ran_at?: string;
                  n_errors: number;
                  n_runs: number;
                  name?: string;
                  next_run?: string;
                  results: {
                      data: {
                          data?: Record<(...), (...)>;
                          end_timestamp?: string;
                          errors?: Record<(...), (...)>;
                          http_status_polled?: number;
                          http_status_submission?: number;
                          last_check_timestamp?: string;
                          next_check_timestamp?: string;
                          ran_at: string;
                          resource_id?: string;
                          run_status: string;
                          start_timestamp: string;
                          status?: number;
                      }[];
                      page_next?: string;
                  };
                  schedule: | { datetime?: string; type: "once" }
                  | {
                      end?:
                          | { condition: "iterations"; count: number }
                          | { condition: "time"; datetime: string };
                      interval_seconds: number;
                      start?: string;
                      type: "recurring";
                  };
                  scope?: string;
                  start: string;
                  status: string;
                  stop_after?: { date?: string; n_runs?: number };
                  submitted_at: string;
              };
          };
          headers: { [name: string]: unknown };
      };
      "422": {
          content: {
              "application/json": {
                  detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
              };
          };
          headers: { [name: string]: unknown };
      };
  }
  - 200: {
        content: {
            "application/json": {
                callback_body: Record<string, unknown>;
                callback_url: string;
                inactive_reason?: {
                    cause: "user" | "globus_auth_requirements";
                    detail?: Record<string, unknown>;
                };
                interval?: number;
                job_id: string;
                last_ran_at?: string;
                n_errors: number;
                n_runs: number;
                name?: string;
                next_run?: string;
                results: {
                    data: {
                        data?: Record<(...), (...)>;
                        end_timestamp?: string;
                        errors?: Record<(...), (...)>;
                        http_status_polled?: number;
                        http_status_submission?: number;
                        last_check_timestamp?: string;
                        next_check_timestamp?: string;
                        ran_at: string;
                        resource_id?: string;
                        run_status: string;
                        start_timestamp: string;
                        status?: number;
                    }[];
                    page_next?: string;
                };
                schedule: | { datetime?: string; type: "once" }
                | {
                    end?:
                        | { condition: "iterations"; count: number }
                        | { condition: "time"; datetime: string };
                    interval_seconds: number;
                    start?: string;
                    type: "recurring";
                };
                scope?: string;
                start: string;
                status: string;
                stop_after?: { date?: string; n_runs?: number };
                submitted_at: string;
            };
        };
        headers: { [name: string]: unknown };
    }
    Description
    Successful Response
  - 422: {
        content: {
            "application/json": {
                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
            };
        };
        headers: { [name: string]: unknown };
    }
    Description
    Validation Error
Optionalpost?: undefined
Optionalput?: undefined
Optionaltrace?: undefined

/jobs/{job_id}/pause

"/jobs/{job_id}/pause": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { job_id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": { message: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

Optionaldelete?: undefined
Optionalget?: undefined
Optionalhead?: undefined
Optionaloptions?: undefined
parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optionalpatch?: undefined
post: {
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: { job_id: string };
        query?: undefined;
    };
    requestBody?: undefined;
    responses: {
        "200": {
            content: { "application/json": { message: string } };
            headers: { [name: string]: unknown };
        };
        "422": {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        };
    };
}
Pause Job
Description
Pause a job.
```
This will set the job's status to inactive, preventing execution
until it is resumed.
```
- parameters: {
      cookie?: undefined;
      header?: undefined;
      path: { job_id: string };
      query?: undefined;
  }
- OptionalrequestBody?: undefined
- responses: {
      "200": {
          content: { "application/json": { message: string } };
          headers: { [name: string]: unknown };
      };
      "422": {
          content: {
              "application/json": {
                  detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
              };
          };
          headers: { [name: string]: unknown };
      };
  }
  - 200: {
    content: { "application/json": { message: string } };
    headers: { [name: string]: unknown };
    }
    Description
    Successful Response
  - 422: {
        content: {
            "application/json": {
                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
            };
        };
        headers: { [name: string]: unknown };
    }
    Description
    Validation Error
Optionalput?: undefined
Optionaltrace?: undefined

/jobs/{job_id}/resume

"/jobs/{job_id}/resume": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { job_id: string };
            query?: { update_credentials?: boolean };
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: { "application/json": { message: string } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

Optionaldelete?: undefined
Optionalget?: undefined
Optionalhead?: undefined
Optionaloptions?: undefined
parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optionalpatch?: undefined
post: {
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: { job_id: string };
        query?: { update_credentials?: boolean };
    };
    requestBody?: undefined;
    responses: {
        "200": {
            content: { "application/json": { message: string } };
            headers: { [name: string]: unknown };
        };
        "422": {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        };
    };
}
Resume Job
Description
Resume an inactive job.
```
This will set the job's status to 'active', allowing
execution on its schedule. If a run was missed, it will run once
immediately upon resuming.

If the `update_credentials` query parameter is set to `true`, the timer's
refresh token will be replaced with a new one.
```
- parameters: {
      cookie?: undefined;
      header?: undefined;
      path: { job_id: string };
      query?: { update_credentials?: boolean };
  }
- OptionalrequestBody?: undefined
- responses: {
      "200": {
          content: { "application/json": { message: string } };
          headers: { [name: string]: unknown };
      };
      "422": {
          content: {
              "application/json": {
                  detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
              };
          };
          headers: { [name: string]: unknown };
      };
  }
  - 200: {
    content: { "application/json": { message: string } };
    headers: { [name: string]: unknown };
    }
    Description
    Successful Response
  - 422: {
        content: {
            "application/json": {
                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
            };
        };
        headers: { [name: string]: unknown };
    }
    Description
    Validation Error
Optionalput?: undefined
Optionaltrace?: undefined

/jobs/{timer_id}

"/jobs/{timer_id}": {
    delete: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { timer_id: string };
            query?: undefined;
        };
        requestBody?: undefined;
        responses: {
            "200": {
                content: {
                    "application/json": {
                        callback_body: Record<string, unknown>;
                        callback_url: string;
                        inactive_reason?: {
                            cause: "user" | "globus_auth_requirements";
                            detail?: Record<string, unknown>;
                        };
                        interval?: number;
                        job_id: string;
                        last_ran_at?: string;
                        n_errors: number;
                        n_runs: number;
                        name?: string;
                        next_run?: string;
                        results: {
                            data: {
                                data?: Record<(...), (...)>;
                                end_timestamp?: string;
                                errors?: Record<(...), (...)>;
                                http_status_polled?: number;
                                http_status_submission?: number;
                                last_check_timestamp?: string;
                                next_check_timestamp?: string;
                                ran_at: string;
                                resource_id?: string;
                                run_status: string;
                                start_timestamp: string;
                                status?: number;
                            }[];
                            page_next?: string;
                        };
                        schedule: | { datetime?: string; type: "once" }
                        | {
                            end?:
                                | { condition: "iterations"; count: number }
                                | { condition: "time"; datetime: string };
                            interval_seconds: number;
                            start?: string;
                            type: "recurring";
                        };
                        scope?: string;
                        start: string;
                        status: string;
                        stop_after?: { date?: string; n_runs?: number };
                        submitted_at: string;
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    };
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post?: undefined;
    put?: undefined;
    trace?: undefined;
}

Type declaration

delete: {
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path: { timer_id: string };
        query?: undefined;
    };
    requestBody?: undefined;
    responses: {
        "200": {
            content: {
                "application/json": {
                    callback_body: Record<string, unknown>;
                    callback_url: string;
                    inactive_reason?: {
                        cause: "user" | "globus_auth_requirements";
                        detail?: Record<string, unknown>;
                    };
                    interval?: number;
                    job_id: string;
                    last_ran_at?: string;
                    n_errors: number;
                    n_runs: number;
                    name?: string;
                    next_run?: string;
                    results: {
                        data: {
                            data?: Record<(...), (...)>;
                            end_timestamp?: string;
                            errors?: Record<(...), (...)>;
                            http_status_polled?: number;
                            http_status_submission?: number;
                            last_check_timestamp?: string;
                            next_check_timestamp?: string;
                            ran_at: string;
                            resource_id?: string;
                            run_status: string;
                            start_timestamp: string;
                            status?: number;
                        }[];
                        page_next?: string;
                    };
                    schedule: | { datetime?: string; type: "once" }
                    | {
                        end?:
                            | { condition: "iterations"; count: number }
                            | { condition: "time"; datetime: string };
                        interval_seconds: number;
                        start?: string;
                        type: "recurring";
                    };
                    scope?: string;
                    start: string;
                    status: string;
                    stop_after?: { date?: string; n_runs?: number };
                    submitted_at: string;
                };
            };
            headers: { [name: string]: unknown };
        };
        "422": {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        };
    };
}
Delete Timer
Description
Remove a previously-submitted timer.
```
Timers are not deleted from the database, but are instead marked for deletion.
They are marked here as "delete_in_progress".

For transfer timers, results' action IDs must be deleted from the Transfer AP.
A background worker will do the cleanup work for both types of timers
to delete the results and mark the timers as "deleted".
```
- parameters: {
      cookie?: undefined;
      header?: undefined;
      path: { timer_id: string };
      query?: undefined;
  }
- OptionalrequestBody?: undefined
- responses: {
      "200": {
          content: {
              "application/json": {
                  callback_body: Record<string, unknown>;
                  callback_url: string;
                  inactive_reason?: {
                      cause: "user" | "globus_auth_requirements";
                      detail?: Record<string, unknown>;
                  };
                  interval?: number;
                  job_id: string;
                  last_ran_at?: string;
                  n_errors: number;
                  n_runs: number;
                  name?: string;
                  next_run?: string;
                  results: {
                      data: {
                          data?: Record<(...), (...)>;
                          end_timestamp?: string;
                          errors?: Record<(...), (...)>;
                          http_status_polled?: number;
                          http_status_submission?: number;
                          last_check_timestamp?: string;
                          next_check_timestamp?: string;
                          ran_at: string;
                          resource_id?: string;
                          run_status: string;
                          start_timestamp: string;
                          status?: number;
                      }[];
                      page_next?: string;
                  };
                  schedule: | { datetime?: string; type: "once" }
                  | {
                      end?:
                          | { condition: "iterations"; count: number }
                          | { condition: "time"; datetime: string };
                      interval_seconds: number;
                      start?: string;
                      type: "recurring";
                  };
                  scope?: string;
                  start: string;
                  status: string;
                  stop_after?: { date?: string; n_runs?: number };
                  submitted_at: string;
              };
          };
          headers: { [name: string]: unknown };
      };
      "422": {
          content: {
              "application/json": {
                  detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
              };
          };
          headers: { [name: string]: unknown };
      };
  }
  - 200: {
        content: {
            "application/json": {
                callback_body: Record<string, unknown>;
                callback_url: string;
                inactive_reason?: {
                    cause: "user" | "globus_auth_requirements";
                    detail?: Record<string, unknown>;
                };
                interval?: number;
                job_id: string;
                last_ran_at?: string;
                n_errors: number;
                n_runs: number;
                name?: string;
                next_run?: string;
                results: {
                    data: {
                        data?: Record<(...), (...)>;
                        end_timestamp?: string;
                        errors?: Record<(...), (...)>;
                        http_status_polled?: number;
                        http_status_submission?: number;
                        last_check_timestamp?: string;
                        next_check_timestamp?: string;
                        ran_at: string;
                        resource_id?: string;
                        run_status: string;
                        start_timestamp: string;
                        status?: number;
                    }[];
                    page_next?: string;
                };
                schedule: | { datetime?: string; type: "once" }
                | {
                    end?:
                        | { condition: "iterations"; count: number }
                        | { condition: "time"; datetime: string };
                    interval_seconds: number;
                    start?: string;
                    type: "recurring";
                };
                scope?: string;
                start: string;
                status: string;
                stop_after?: { date?: string; n_runs?: number };
                submitted_at: string;
            };
        };
        headers: { [name: string]: unknown };
    }
    Description
    Successful Response
  - 422: {
        content: {
            "application/json": {
                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
            };
        };
        headers: { [name: string]: unknown };
    }
    Description
    Validation Error
Optionalget?: undefined
Optionalhead?: undefined
Optionaloptions?: undefined
parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optionalpatch?: undefined
Optionalpost?: undefined
Optionalput?: undefined
Optionaltrace?: undefined

/v2/timer

"/v2/timer": {
    delete?: undefined;
    get?: undefined;
    head?: undefined;
    options?: undefined;
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    patch?: undefined;
    post: {
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        requestBody: {
            content: {
                "application/json": {
                    timer: {
                        body: {
                            DATA: {
                                checksum_algorithm?: string;
                                DATA_TYPE: "transfer_item";
                                destination_path: string;
                                external_checksum?: string;
                                recursive?: boolean;
                                source_path: string;
                            }[];
                            DATA_TYPE: "transfer";
                            deadline?: string;
                            delete_destination_extra: boolean;
                            destination_endpoint: string;
                            destination_local_user?: string;
                            encrypt_data: boolean;
                            fail_on_quota_errors: boolean;
                            filter_rules?: {
                                DATA_TYPE: "filter_rule";
                                method: (...)
                                | (...);
                                name: string;
                                type?: (...) | (...) | (...);
                            }[];
                            label?: string;
                            notify_on_failed: boolean;
                            notify_on_inactive: boolean;
                            notify_on_succeeded: boolean;
                            preserve_timestamp: boolean;
                            skip_source_errors: boolean;
                            source_endpoint: string;
                            source_local_user?: string;
                            store_base_path_info: boolean;
                            sync_level?: 0
                            | 2
                            | 1
                            | 3;
                            verify_checksum: boolean;
                        };
                        name?: string;
                        resource_server: "transfer.api.globus.org";
                        schedule: | { datetime?: string; type: "once" }
                        | {
                            end?:
                                | { condition: "iterations"; count: number }
                                | { condition: "time"; datetime: string };
                            interval_seconds: number;
                            start?: string;
                            type: "recurring";
                        };
                        timer_type: "transfer";
                    };
                };
            };
        };
        responses: {
            "201": {
                content: {
                    "application/json": {
                        timer: {
                            body: {
                                DATA: {
                                    checksum_algorithm?: (...)
                                    | (...);
                                    DATA_TYPE: "transfer_item";
                                    destination_path: string;
                                    external_checksum?: (...) | (...);
                                    recursive?: (...) | (...) | (...);
                                    source_path: string;
                                }[];
                                DATA_TYPE: "transfer";
                                deadline?: string;
                                delete_destination_extra: boolean;
                                destination_endpoint: string;
                                destination_local_user?: string;
                                encrypt_data: boolean;
                                fail_on_quota_errors: boolean;
                                filter_rules?: {
                                    DATA_TYPE: ...;
                                    method: ...;
                                    name: ...;
                                    type?: ...;
                                }[];
                                label?: string;
                                notify_on_failed: boolean;
                                notify_on_inactive: boolean;
                                notify_on_succeeded: boolean;
                                preserve_timestamp: boolean;
                                skip_source_errors: boolean;
                                source_endpoint: string;
                                source_local_user?: string;
                                store_base_path_info: boolean;
                                sync_level?: 0
                                | 2
                                | 1
                                | 3;
                                verify_checksum: boolean;
                            };
                            inactive_reason?: {
                                cause: "user"
                                | "globus_auth_requirements";
                                detail?: Record<(...), (...)>;
                            };
                            job_id: string;
                            last_ran_at?: string;
                            name?: string;
                            next_run?: string;
                            number_of_errors: number;
                            number_of_runs: number;
                            schedule: | { datetime?: string; type: "once" }
                            | {
                                end?:
                                    | { condition: ...; count: ... }
                                    | { condition: ...; datetime: ... };
                                interval_seconds: number;
                                start?: string;
                                type: "recurring";
                            };
                            status: string;
                            submitted_at: string;
                            timer_type: "transfer";
                        };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        };
    };
    put?: undefined;
    trace?: undefined;
}

Type declaration

Optionaldelete?: undefined
Optionalget?: undefined
Optionalhead?: undefined
Optionaloptions?: undefined
parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
Optionalpatch?: undefined
post: {
    parameters: {
        cookie?: undefined;
        header?: undefined;
        path?: undefined;
        query?: undefined;
    };
    requestBody: {
        content: {
            "application/json": {
                timer: {
                    body: {
                        DATA: {
                            checksum_algorithm?: string;
                            DATA_TYPE: "transfer_item";
                            destination_path: string;
                            external_checksum?: string;
                            recursive?: boolean;
                            source_path: string;
                        }[];
                        DATA_TYPE: "transfer";
                        deadline?: string;
                        delete_destination_extra: boolean;
                        destination_endpoint: string;
                        destination_local_user?: string;
                        encrypt_data: boolean;
                        fail_on_quota_errors: boolean;
                        filter_rules?: {
                            DATA_TYPE: "filter_rule";
                            method: (...)
                            | (...);
                            name: string;
                            type?: (...) | (...) | (...);
                        }[];
                        label?: string;
                        notify_on_failed: boolean;
                        notify_on_inactive: boolean;
                        notify_on_succeeded: boolean;
                        preserve_timestamp: boolean;
                        skip_source_errors: boolean;
                        source_endpoint: string;
                        source_local_user?: string;
                        store_base_path_info: boolean;
                        sync_level?: 0
                        | 2
                        | 1
                        | 3;
                        verify_checksum: boolean;
                    };
                    name?: string;
                    resource_server: "transfer.api.globus.org";
                    schedule: | { datetime?: string; type: "once" }
                    | {
                        end?:
                            | { condition: "iterations"; count: number }
                            | { condition: "time"; datetime: string };
                        interval_seconds: number;
                        start?: string;
                        type: "recurring";
                    };
                    timer_type: "transfer";
                };
            };
        };
    };
    responses: {
        "201": {
            content: {
                "application/json": {
                    timer: {
                        body: {
                            DATA: {
                                checksum_algorithm?: (...)
                                | (...);
                                DATA_TYPE: "transfer_item";
                                destination_path: string;
                                external_checksum?: (...) | (...);
                                recursive?: (...) | (...) | (...);
                                source_path: string;
                            }[];
                            DATA_TYPE: "transfer";
                            deadline?: string;
                            delete_destination_extra: boolean;
                            destination_endpoint: string;
                            destination_local_user?: string;
                            encrypt_data: boolean;
                            fail_on_quota_errors: boolean;
                            filter_rules?: { DATA_TYPE: ...; method: ...; name: ...; type?: ... }[];
                            label?: string;
                            notify_on_failed: boolean;
                            notify_on_inactive: boolean;
                            notify_on_succeeded: boolean;
                            preserve_timestamp: boolean;
                            skip_source_errors: boolean;
                            source_endpoint: string;
                            source_local_user?: string;
                            store_base_path_info: boolean;
                            sync_level?: 0 | 2 | 1 | 3;
                            verify_checksum: boolean;
                        };
                        inactive_reason?: {
                            cause: "user"
                            | "globus_auth_requirements";
                            detail?: Record<(...), (...)>;
                        };
                        job_id: string;
                        last_ran_at?: string;
                        name?: string;
                        next_run?: string;
                        number_of_errors: number;
                        number_of_runs: number;
                        schedule: | { datetime?: string; type: "once" }
                        | {
                            end?:
                                | { condition: ...; count: ... }
                                | { condition: ...; datetime: ... };
                            interval_seconds: number;
                            start?: string;
                            type: "recurring";
                        };
                        status: string;
                        submitted_at: string;
                        timer_type: "transfer";
                    };
                };
            };
            headers: { [name: string]: unknown };
        };
        "422": {
            content: {
                "application/json": {
                    detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
                };
            };
            headers: { [name: string]: unknown };
        };
    };
}
Create Timer
Description
Create a new Timer.
```
If the job is set to stop after exactly 1 run then the interval must be null.
Otherwise, the job interval must be between 60 seconds and 365 days.

The timer must specify a type.
Currently, only the "transfer" type is supported.
```
- parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
- requestBody: {
      content: {
          "application/json": {
              timer: {
                  body: {
                      DATA: {
                          checksum_algorithm?: string;
                          DATA_TYPE: "transfer_item";
                          destination_path: string;
                          external_checksum?: string;
                          recursive?: boolean;
                          source_path: string;
                      }[];
                      DATA_TYPE: "transfer";
                      deadline?: string;
                      delete_destination_extra: boolean;
                      destination_endpoint: string;
                      destination_local_user?: string;
                      encrypt_data: boolean;
                      fail_on_quota_errors: boolean;
                      filter_rules?: {
                          DATA_TYPE: "filter_rule";
                          method: (...)
                          | (...);
                          name: string;
                          type?: (...) | (...) | (...);
                      }[];
                      label?: string;
                      notify_on_failed: boolean;
                      notify_on_inactive: boolean;
                      notify_on_succeeded: boolean;
                      preserve_timestamp: boolean;
                      skip_source_errors: boolean;
                      source_endpoint: string;
                      source_local_user?: string;
                      store_base_path_info: boolean;
                      sync_level?: 0
                      | 2
                      | 1
                      | 3;
                      verify_checksum: boolean;
                  };
                  name?: string;
                  resource_server: "transfer.api.globus.org";
                  schedule: | { datetime?: string; type: "once" }
                  | {
                      end?:
                          | { condition: "iterations"; count: number }
                          | { condition: "time"; datetime: string };
                      interval_seconds: number;
                      start?: string;
                      type: "recurring";
                  };
                  timer_type: "transfer";
              };
          };
      };
  }
- responses: {
      "201": {
          content: {
              "application/json": {
                  timer: {
                      body: {
                          DATA: {
                              checksum_algorithm?: (...) | (...);
                              DATA_TYPE: "transfer_item";
                              destination_path: string;
                              external_checksum?: (...) | (...);
                              recursive?: (...) | (...) | (...);
                              source_path: string;
                          }[];
                          DATA_TYPE: "transfer";
                          deadline?: string;
                          delete_destination_extra: boolean;
                          destination_endpoint: string;
                          destination_local_user?: string;
                          encrypt_data: boolean;
                          fail_on_quota_errors: boolean;
                          filter_rules?: { DATA_TYPE: ...; method: ...; name: ...; type?: ... }[];
                          label?: string;
                          notify_on_failed: boolean;
                          notify_on_inactive: boolean;
                          notify_on_succeeded: boolean;
                          preserve_timestamp: boolean;
                          skip_source_errors: boolean;
                          source_endpoint: string;
                          source_local_user?: string;
                          store_base_path_info: boolean;
                          sync_level?: 0 | 2 | 1 | 3;
                          verify_checksum: boolean;
                      };
                      inactive_reason?: {
                          cause: "user"
                          | "globus_auth_requirements";
                          detail?: Record<(...), (...)>;
                      };
                      job_id: string;
                      last_ran_at?: string;
                      name?: string;
                      next_run?: string;
                      number_of_errors: number;
                      number_of_runs: number;
                      schedule: | { datetime?: string; type: "once" }
                      | {
                          end?:
                              | { condition: ...; count: ... }
                              | { condition: ...; datetime: ... };
                          interval_seconds: number;
                          start?: string;
                          type: "recurring";
                      };
                      status: string;
                      submitted_at: string;
                      timer_type: "transfer";
                  };
              };
          };
          headers: { [name: string]: unknown };
      };
      "422": {
          content: {
              "application/json": {
                  detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
              };
          };
          headers: { [name: string]: unknown };
      };
  }
  - 201: {
        content: {
            "application/json": {
                timer: {
                    body: {
                        DATA: {
                            checksum_algorithm?: (...) | (...);
                            DATA_TYPE: "transfer_item";
                            destination_path: string;
                            external_checksum?: (...) | (...);
                            recursive?: (...) | (...) | (...);
                            source_path: string;
                        }[];
                        DATA_TYPE: "transfer";
                        deadline?: string;
                        delete_destination_extra: boolean;
                        destination_endpoint: string;
                        destination_local_user?: string;
                        encrypt_data: boolean;
                        fail_on_quota_errors: boolean;
                        filter_rules?: { DATA_TYPE: ...; method: ...; name: ...; type?: ... }[];
                        label?: string;
                        notify_on_failed: boolean;
                        notify_on_inactive: boolean;
                        notify_on_succeeded: boolean;
                        preserve_timestamp: boolean;
                        skip_source_errors: boolean;
                        source_endpoint: string;
                        source_local_user?: string;
                        store_base_path_info: boolean;
                        sync_level?: 0 | 2 | 1 | 3;
                        verify_checksum: boolean;
                    };
                    inactive_reason?: {
                        cause: "user"
                        | "globus_auth_requirements";
                        detail?: Record<(...), (...)>;
                    };
                    job_id: string;
                    last_ran_at?: string;
                    name?: string;
                    next_run?: string;
                    number_of_errors: number;
                    number_of_runs: number;
                    schedule: | { datetime?: string; type: "once" }
                    | {
                        end?:
                            | { condition: ...; count: ... }
                            | { condition: ...; datetime: ... };
                        interval_seconds: number;
                        start?: string;
                        type: "recurring";
                    };
                    status: string;
                    submitted_at: string;
                    timer_type: "transfer";
                };
            };
        };
        headers: { [name: string]: unknown };
    }
    Description
    Successful Response
  - 422: {
        content: {
            "application/json": {
                detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
            };
        };
        headers: { [name: string]: unknown };
    }
    Description
    Validation Error
Optionalput?: undefined
Optionaltrace?: undefined

Interface paths

Index

Properties

Properties

/jobs/

Type declaration

Optionaldelete?: undefined

Description

parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: { filter_active?: boolean; filter_name?: string; filter_status?: string; filter_stopped?: boolean; order?: string; result_count?: number; submitted_after?: string; submitted_before?: string; };}

Optionalcookie?: undefined

Optionalheader?: undefined

Optionalpath?: undefined

Optionalquery?: { filter_active?: boolean; filter_name?: string; filter_status?: string; filter_stopped?: boolean; order?: string; result_count?: number; submitted_after?: string; submitted_before?: string;}

Optionalfilter_active?: boolean

Description

Optionalfilter_name?: string

Description

Optionalfilter_status?: string

Description

Optionalfilter_stopped?: boolean

Description

Optionalorder?: string

Description

Optionalresult_count?: number

Description

Optionalsubmitted_after?: string

Description

Optionalsubmitted_before?: string

Description

OptionalrequestBody?: undefined

Description

422: { content: { "application/json": { detail?: { loc: ((...) | (...))[]; msg: string; type: string }[]; }; }; headers: { [name: string]: unknown };}

Description

Optionalhead?: undefined

Optionaloptions?: undefined

parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }

Optionalpatch?: undefined

Description

parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }

requestBody: { content: { "application/json": { callback_body: Record<string, unknown>; callback_url: string; interval?: number; name?: string; refresh_token?: string; scope?: string; start: string; stop_after?: { date?: string; n_runs?: number }; }; };}

Description

422: { content: { "application/json": { detail?: { loc: ((...) | (...))[]; msg: string; type: string }[]; }; }; headers: { [name: string]: unknown };}

Description

Optionalput?: undefined

Optionaltrace?: undefined

/jobs/{job_id}

Type declaration

Optionaldelete?: undefined

Description

parameters: { cookie?: undefined; header?: undefined; path: { job_id: string }; query?: { page_size?: number; results_pt?: string };}

OptionalrequestBody?: undefined

Description

422: { content: { "application/json": { detail?: { loc: ((...) | (...))[]; msg: string; type: string }[]; }; }; headers: { [name: string]: unknown };}

Description

Optionalhead?: undefined

Optionaloptions?: undefined

parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }

Description

parameters: { cookie?: undefined; header?: undefined; path: { job_id: string }; query?: undefined;}

requestBody: { content: { "application/json": { name?: string } } }

Description

422: { content: { "application/json": { detail?: { loc: ((...) | (...))[]; msg: string; type: string }[]; }; }; headers: { [name: string]: unknown };}

Description

Optionalpost?: undefined

Optionalput?: undefined

Optionaltrace?: undefined

/jobs/{job_id}/pause

Type declaration

Optionaldelete?: undefined

Optionalget?: undefined

Optionalhead?: undefined

Optionaloptions?: undefined

parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }

Optionalpatch?: undefined

Description

parameters: { cookie?: undefined; header?: undefined; path: { job_id: string }; query?: undefined;}

OptionalrequestBody?: undefined

responses: { "200": { content: { "application/json": { message: string } }; headers: { [name: string]: unknown }; }; "422": { content: { "application/json": { detail?: { loc: ((...) | (...))[]; msg: string; type: string }[]; }; }; headers: { [name: string]: unknown }; };}

200: { content: { "application/json": { message: string } }; headers: { [name: string]: unknown };}

Description

`Optional`delete?: undefined

parameters: {
cookie?: undefined;
header?: undefined;
path?: undefined;
query?: {
filter_active?: boolean;
filter_name?: string;
filter_status?: string;
filter_stopped?: boolean;
order?: string;
result_count?: number;
submitted_after?: string;
submitted_before?: string;
};
}

`Optional`cookie?: undefined

`Optional`header?: undefined

`Optional`path?: undefined

`Optional`query?: {
filter_active?: boolean;
filter_name?: string;
filter_status?: string;
filter_stopped?: boolean;
order?: string;
result_count?: number;
submitted_after?: string;
submitted_before?: string;
}

`Optional`filter_active?: boolean

`Optional`filter_name?: string

`Optional`filter_status?: string

`Optional`filter_stopped?: boolean

`Optional`order?: string

`Optional`result_count?: number

`Optional`submitted_after?: string

`Optional`submitted_before?: string

`Optional`requestBody?: undefined

422: {
content: {
"application/json": {
detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
}

`Optional`head?: undefined

`Optional`options?: undefined

`Optional`patch?: undefined

requestBody: {
content: {
"application/json": {
callback_body: Record<string, unknown>;
callback_url: string;
interval?: number;
name?: string;
refresh_token?: string;
scope?: string;
start: string;
stop_after?: { date?: string; n_runs?: number };
};
};
}

422: {
content: {
"application/json": {
detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
}

`Optional`put?: undefined

`Optional`trace?: undefined

`Optional`delete?: undefined

parameters: {
cookie?: undefined;
header?: undefined;
path: { job_id: string };
query?: { page_size?: number; results_pt?: string };
}

`Optional`requestBody?: undefined

422: {
content: {
"application/json": {
detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
}

`Optional`head?: undefined

`Optional`options?: undefined

parameters: {
cookie?: undefined;
header?: undefined;
path: { job_id: string };
query?: undefined;
}

422: {
content: {
"application/json": {
detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
}

`Optional`post?: undefined

`Optional`put?: undefined

`Optional`trace?: undefined

`Optional`delete?: undefined

`Optional`get?: undefined

`Optional`head?: undefined

`Optional`options?: undefined

`Optional`patch?: undefined

parameters: {
cookie?: undefined;
header?: undefined;
path: { job_id: string };
query?: undefined;
}

`Optional`requestBody?: undefined

responses: {
"200": {
content: { "application/json": { message: string } };
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
};
}

200: {
content: { "application/json": { message: string } };
headers: { [name: string]: unknown };
}

422: {
content: {
"application/json": {
detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
}

`Optional`put?: undefined

`Optional`trace?: undefined

`Optional`delete?: undefined

`Optional`get?: undefined

`Optional`head?: undefined

`Optional`options?: undefined

`Optional`patch?: undefined

parameters: {
cookie?: undefined;
header?: undefined;
path: { job_id: string };
query?: { update_credentials?: boolean };
}

`Optional`requestBody?: undefined

responses: {
"200": {
content: { "application/json": { message: string } };
headers: { [name: string]: unknown };
};
"422": {
content: {
"application/json": {
detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
};
}

200: {
content: { "application/json": { message: string } };
headers: { [name: string]: unknown };
}

422: {
content: {
"application/json": {
detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
}

`Optional`put?: undefined

`Optional`trace?: undefined

parameters: {
cookie?: undefined;
header?: undefined;
path: { timer_id: string };
query?: undefined;
}

`Optional`requestBody?: undefined

422: {
content: {
"application/json": {
detail?: { loc: ((...) | (...))[]; msg: string; type: string }[];
};
};
headers: { [name: string]: unknown };
}

`Optional`get?: undefined

`Optional`head?: undefined

`Optional`options?: undefined

`Optional`patch?: undefined

`Optional`post?: undefined

`Optional`put?: undefined

`Optional`trace?: undefined

`Optional`delete?: undefined

`Optional`get?: undefined

`Optional`head?: undefined

`Optional`options?: undefined

`Optional`patch?: undefined