@kuflow/kuflow-rest/src/operations/workerOperations.ts

REST SDK for KuFlow.

/**
 * The MIT License
 * Copyright © 2021-present KuFlow S.L.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

import type {
  KuFlowRestClientGenerated,
  Worker,
  WorkerCreateWorkerOptionalParams,
  WorkerCreateWorkerResponse,
  WorkerOperations as WorkerOperationsGenerated,
} from '../generated'

/** Class containing WorkerOperations operations. */
export class WorkerOperations {
  private readonly workerOperations: WorkerOperationsGenerated

  /**
   * Initialize a new instance of the class WorkerOperations class.
   * @param clientGenerated Reference to the service client
   */
  public constructor(clientGenerated: KuFlowRestClientGenerated) {
    this.workerOperations = clientGenerated.workerOperations
  }

  /**
   * Register a worker in KuFlow, this allows the platform to have a catalogue of all registered workers.
   *
   * If already exist a worker for the same identity, the worker will be updated.
   *
   * @param worker Worker to create or update
   * @param options The options parameters.
   */
  public async createWorker(
    worker: Worker,
    options?: WorkerCreateWorkerOptionalParams,
  ): Promise<WorkerCreateWorkerResponse> {
    return await this.workerOperations.createWorker(worker, options)
  }
}