Interface ReloadTasksAPI

interface ReloadTasksAPI {
    clearCache: () => void;
    createReloadTask: (
        body: PostTaskBody,
        options?: ApiCallOptions,
    ) => Promise<CreateReloadTaskHttpResponse>;
    deleteReloadTask: (
        taskId: string,
        options?: ApiCallOptions,
    ) => Promise<DeleteReloadTaskHttpResponse>;
    getReloadTask: (
        taskId: string,
        options?: ApiCallOptions,
    ) => Promise<GetReloadTaskHttpResponse>;
    getReloadTasks: (
        query: {
            appId?: string;
            limit?: number;
            next?: string;
            partial?: boolean;
            prev?: string;
        },
        options?: ApiCallOptions,
    ) => Promise<GetReloadTasksHttpResponse>;
    updateReloadTask: (
        taskId: string,
        body: PutTaskBody,
        options?: ApiCallOptions,
    ) => Promise<UpdateReloadTaskHttpResponse>;
}
Index

Properties

clearCache createReloadTask deleteReloadTask getReloadTask getReloadTasks updateReloadTask

Properties

clearCache: () => void

Clears the cache for reload-tasks api requests.

Type declaration

    • (): void

    • Clears the cache for reload-tasks api requests.

      Returns void

createReloadTask: (
    body: PostTaskBody,
    options?: ApiCallOptions,
) => Promise<CreateReloadTaskHttpResponse>

Creates a task for a specified app.

Type declaration

Param: body

an object with the body content

CreateReloadTaskHttpError

deleteReloadTask: (
    taskId: string,
    options?: ApiCallOptions,
) => Promise<DeleteReloadTaskHttpResponse>

Deletes a task

Type declaration

The unique identifier of the task.

DeleteReloadTaskHttpError

getReloadTask: (
    taskId: string,
    options?: ApiCallOptions,
) => Promise<GetReloadTaskHttpResponse>

Finds and returns a task.

Type declaration

The unique identifier of the task.

GetReloadTaskHttpError

getReloadTasks: (
    query: {
        appId?: string;
        limit?: number;
        next?: string;
        partial?: boolean;
        prev?: string;
    },
    options?: ApiCallOptions,
) => Promise<GetReloadTasksHttpResponse>

Finds and returns the tasks that the user has access to.

Type declaration

    • (
          query: {
              appId?: string;
              limit?: number;
              next?: string;
              partial?: boolean;
              prev?: string;
          },
          options?: ApiCallOptions,
      ): Promise<GetReloadTasksHttpResponse>

    • Finds and returns the tasks that the user has access to.

      Parameters

      • query: {
            appId?: string;
            limit?: number;
            next?: string;
            partial?: boolean;
            prev?: string;
        }

        an object with query parameters

        • OptionalappId?: string

          The case sensitive string used to search for a task by app ID.

        • Optionallimit?: number

          The maximum number of resources to return for a request. The limit must be an integer between 1 and 100 (inclusive).

        • Optionalnext?: string

          The cursor to the next page of resources. Provide either the next or prev cursor, but not both.

        • Optionalpartial?: boolean

          The boolean value used to search for a task is partial or not

        • Optionalprev?: string

          The cursor to the previous page of resources. Provide either the next or prev cursor, but not both.

      • Optionaloptions: ApiCallOptions

      Returns Promise<GetReloadTasksHttpResponse>

      GetReloadTasksHttpError

an object with query parameters

GetReloadTasksHttpError

updateReloadTask: (
    taskId: string,
    body: PutTaskBody,
    options?: ApiCallOptions,
) => Promise<UpdateReloadTaskHttpResponse>

Updates an existing task

Type declaration

The unique identifier of the task.

Param: body

an object with the body content

UpdateReloadTaskHttpError

Settings

Member Visibility

On This Page

Properties