@prefecthq/prefect-ui-library/src/services/WorkspaceWorkPoolsApi.ts

This library is the Vue and Typescript component library for [Prefect 2](https://github.com/PrefectHQ/prefect) and [Prefect Cloud 2](https://www.prefect.io/cloud/). _The components and utilities in this project are not meant to be used independently_.

import { WorkPool, WorkPoolCreate, WorkPoolEdit, WorkPoolResponse, WorkerScheduledFlowRunResponse, WorkerScheduledFlowRun, WorkerScheduledFlowRuns, BatchLookupError } from '@/models'
import { WorkPoolsFilter } from '@/models/Filters'
import { mapper, WorkspaceApi } from '@/services'


export class WorkspaceWorkPoolsApi extends WorkspaceApi {

  protected override routePrefix = '/work_pools/'

  public async createWorkPool(request: WorkPoolCreate): Promise<WorkPool> {
    const body = mapper.map('WorkPoolCreate', request, 'WorkPoolCreateRequest')
    const { data } = await this.post<WorkPoolResponse>('/', body)

    return mapper.map('WorkPoolResponse', data, 'WorkPool')
  }

  public async getWorkPoolByName(name: string): Promise<WorkPool> {
    const encodedWorkPoolName = encodeURI(name)
    const { data } = await this.get<WorkPoolResponse>(`/${encodedWorkPoolName}`)

    return mapper.map('WorkPoolResponse', data, 'WorkPool')
  }

  public async getWorkPools(filter: WorkPoolsFilter = {}): Promise<WorkPool[]> {
    const request = mapper.map('WorkPoolsFilter', filter, 'WorkPoolsFilterRequest')
    const { data } = await this.post<WorkPoolResponse[]>('/filter', request)

    return mapper.map('WorkPoolResponse', data, 'WorkPool')
  }

  public async getWorkPoolsCount(filter: WorkPoolsFilter = {}): Promise<number> {
    const request = mapper.map('WorkPoolsFilter', filter, 'WorkPoolsFilterRequest')
    const { data } = await this.post<number>('/count', request)

    return data
  }

  public async getWorkPoolById(id: string): Promise<WorkPool> {
    const filter = {
      workPools: {
        id: [id],
      },
    }
    const request = mapper.map('WorkPoolsFilter', filter, 'WorkPoolsFilterRequest')
    const { data } = await this.post<WorkPoolResponse[]>('/filter', request)
    const [workPool] = data
    if (!workPool.id) {
      throw new BatchLookupError(id)
    }
    return mapper.map('WorkPoolResponse', workPool, 'WorkPool')
  }

  public updateWorkPool(name: string, request: WorkPoolEdit): Promise<void> {
    const body = mapper.map('WorkPoolEdit', request, 'WorkPoolEditRequest')
    const encodedWorkPoolName = encodeURI(name)

    return this.patch(`/${encodedWorkPoolName}`, body)
  }

  public pauseWorkPool(name: string): Promise<void> {
    const encodedWorkPoolName = encodeURI(name)
    return this.patch(`/${encodedWorkPoolName}`, { 'is_paused': true })
  }

  public resumeWorkPool(name: string): Promise<void> {
    const encodedWorkPoolName = encodeURI(name)
    return this.patch(`/${encodedWorkPoolName}`, { 'is_paused': false })
  }

  public deleteWorkPool(name: string): Promise<void> {
    const encodedWorkPoolName = encodeURI(name)
    return this.delete(`/${encodedWorkPoolName}`)
  }

  public async getWorkPoolScheduledRuns(name: string, request: WorkerScheduledFlowRuns): Promise<WorkerScheduledFlowRun[]> {
    const body = mapper.map('WorkerScheduledFlowRuns', request, 'WorkerScheduledFlowRunsRequest')
    const encodedWorkPoolName = encodeURI(name)
    const { data } = await this.post<WorkerScheduledFlowRunResponse[]>(`/${encodedWorkPoolName}/get_scheduled_flow_runs`, body)

    return mapper.map('WorkerScheduledFlowRunResponse', data, 'WorkerScheduledFlowRun')
  }

  public async getWorkPoolLateRuns(name: string, request: WorkerScheduledFlowRuns): Promise<WorkerScheduledFlowRun[]> {
    const data = await this.getWorkPoolScheduledRuns(name, request)

    return data.filter(run => run.flowRun.stateName === 'Late')
  }
}