@dronedeploy/rocos-js-sdk 0.0.1 → 3.0.0-alpha.19

package/services/UserService.d.ts

@@ -0,0 +1,200 @@
+import { IInvitation, IInvitationType } from '../models/IInvitation';
+import { RocosError } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { IBaseService } from '../models/IBaseService';
+import { IInvitationExists } from '../models/IInvitationExists';
+import { IPersonalAccessToken } from '../models/IPersonalAccessToken';
+import { IProjectApplication } from '../models/IProjectApplication';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+export declare class UserService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    /**
+     * Get the information of current user
+     */
+    info(): Promise<any>;
+    /**
+     * Get a new valid token
+     * @deprecated Please use {@link AuthService.getNewUserToken}
+     */
+    getToken(): Promise<any>;
+    /**
+     * Create a new invitation.
+     *
+     * @param invitation - Invitation payload {@link IInvitation}
+     */
+    createInvitation(invitation: IInvitation): Promise<any>;
+    /**
+     * List invitations
+     */
+    listInvitations(): Promise<any>;
+    /**
+     * Delete invitations by email and invite type.
+     *
+     * @param email - Email
+     * @param type
+     */
+    deleteInvitations(email: string, type: IInvitationType): Promise<any>;
+    /**
+     * Accept invitation by id
+     *
+     * @param invitationId - Invitation Id
+     */
+    acceptInvitation(invitationId: string): Promise<any>;
+    /**
+     * Check invitation by id
+     *
+     * @param invitationId - Invitation Id
+     */
+    checkInvitation(invitationId: string): Promise<IInvitationExists>;
+    /**
+     * Activate account by id
+     *
+     * @param accountId - Account Id
+     */
+    activateAccount(accountId: string): Promise<any>;
+    /**
+     * Resend verification email
+     *
+     * @param email - Email
+     */
+    resendVerificationEmail(email: string): Promise<any>;
+    /**
+     * Send forgotten password email.
+     *
+     * @param email - Email
+     */
+    sendForgottenPasswordEmail(email: string): Promise<any>;
+    /**
+     * Revoke user's project access.
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     * @param userId - User Id
+     */
+    removeProjectAccess(accountId: string, projectId: string, userId: string): Promise<any>;
+    /**
+     * Revoke user's account access.
+     *
+     * @param accountId - Account Id
+     * @param userId - User Id
+     */
+    removeAccountAccess(accountId: string, userId: string): Promise<any>;
+    /**
+     * List account users
+     *
+     * @param accountId - Account Id
+     */
+    listAccountUsers(accountId: string): Promise<any>;
+    /**
+     * List project users
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     */
+    listProjectUsers(accountId: string, projectId: string): Promise<any>;
+    /**
+     * Create a users personal access token.
+     *
+     * @param personalAccessToken - Payload {@link IPersonalAccessToken}
+     */
+    createPAT(personalAccessToken: IPersonalAccessToken): Promise<IPersonalAccessToken>;
+    /**
+     * Get all personal access tokens
+     *
+     * @param projectId - Project Id
+     * @param robotDefinitionId - Robot definition Id
+     */
+    getAllPATs(projectId: string, robotDefinitionId: string): Promise<any>;
+    /**
+     * Get a personal access token
+     *
+     * @param tokenString - Token string
+     */
+    getOnePAT(tokenString: string): Promise<any>;
+    /**
+     * REmove personal access token
+     *
+     * @param id - Token Id
+     */
+    removePATById(id: string): Promise<any>;
+    /**
+     * Get account details
+     *
+     * @param accountId - Account Id
+     */
+    accountDetails(accountId: string): Promise<any>;
+    /**
+     * Create an account
+     *
+     * @param name - Account name
+     */
+    createAccount(name: string): Promise<any>;
+    /**
+     * Authenticate application
+     *
+     * @param appId - Application Id
+     * @param appKey - Application Key
+     */
+    applicationAuth(appId: string, appKey: string): Promise<any>;
+    /**
+     * Create a new application
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     * @param model - Payload {@link IProjectApplication}
+     */
+    createApplication(accountId: string, projectId: string, model: IProjectApplication): Promise<IProjectApplication>;
+    /**
+     * List all applications
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     */
+    getAllApplications(accountId: string, projectId: string): Promise<any>;
+    /**
+     * Get application information
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     * @param applicationId - Application Id
+     */
+    getApplication(accountId: string, projectId: string, applicationId: string): Promise<any>;
+    /**
+     * Update application information
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     * @param applicationId - Application Id
+     * @param model - Payload
+     */
+    updateApplication(accountId: string, projectId: string, applicationId: string, model: any): Promise<any>;
+    /**
+     * Delete application
+     *
+     * @param accountId - Account ID
+     * @param projectId - Project ID
+     * @param applicationId - Application ID
+     */
+    deleteApplication(accountId: string, projectId: string, applicationId: string): Promise<any>;
+    /**
+     * Get account settings.
+     *
+     * @param accountId - Account Id
+     */
+    accountSettings(accountId: string): Promise<any>;
+    /**
+     * Update account settings
+     *
+     * @param accountId - Account ID
+     * @param settings - Updated account settings
+     */
+    updateAccountSettings(accountId: string, settings: any): Promise<any>;
+    /**
+     * Send a new invitation.
+     *
+     * @param invitation - Invitation payload {@link IInvitation}
+     */
+    sendInvitation(invitation: IInvitation): Promise<any>;
+}

package/services/UserService.js

@@ -0,0 +1,315 @@
+import { API_ACCOUNT_ACTIVATE_URL, API_ACCOUNT_ID_URL, API_ACCOUNT_PROJECT_APPLICATION_ID_URL, API_ACCOUNT_PROJECT_APPLICATION_URL, API_ACCOUNT_PROJECT_USER_ID_URL, API_ACCOUNT_PROJECT_USER_URL, API_ACCOUNT_SETTINGS_URL, API_ACCOUNT_URL, API_ADMIN_USER_INVITATION_URL, API_APPLICATION_AUTH_URL, API_AUTH_USER_ACCOUNT_USER_ID_URL, API_AUTH_USER_ACCOUNT_USER_URL, API_USER_INVITATION_ACCEPT_URL, API_USER_INVITATION_CHECK_URL, API_USER_INVITATION_URL, API_USER_PASSWORD_FORGOT_URL, API_USER_PAT_TOKEN_URL, API_USER_PAT_URL, API_USER_TOKEN_URL, API_USER_URL, API_USER_VERIFY_EMAIL_URL, } from '../constants/api';
+import { RocosError, errorCodes } from '../models/RocosError';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { RocosLogger } from '../logger/RocosLogger';
+import { formatServiceUrl } from '../helpers/formatServiceUrl';
+export class UserService extends BaseServiceAbstract {
+    constructor(config) {
+        super(config);
+        this.logger = RocosLogger.getInstance(`UserService(${this.config.url})`);
+    }
+    getError(e) {
+        return new RocosError(e, errorCodes.USER_SERVICE_ERROR);
+    }
+    getStatus() {
+        return true;
+    }
+    /**
+     * Get the information of current user
+     */
+    // TODO: map the response object
+    async info() {
+        return this.callGet(formatServiceUrl(API_USER_URL, { url: this.config.url }, this.config.insecure), 'Failed to get user details.');
+    }
+    /**
+     * Get a new valid token
+     * @deprecated Please use {@link AuthService.getNewUserToken}
+     */
+    // TODO: map the response object
+    async getToken() {
+        return this.callGet(formatServiceUrl(API_USER_TOKEN_URL, { url: this.config.url }, this.config.insecure), 'Failed to get user token.');
+    }
+    /**
+     * Create a new invitation.
+     *
+     * @param invitation - Invitation payload {@link IInvitation}
+     */
+    // TODO: map the response object
+    async createInvitation(invitation) {
+        return this.callPost(formatServiceUrl(API_USER_INVITATION_URL, { url: this.config.url }, this.config.insecure), invitation, 'Failed to create user invitation.');
+    }
+    /**
+     * List invitations
+     */
+    // TODO: map the response object
+    async listInvitations() {
+        return this.callGet(formatServiceUrl(API_USER_INVITATION_URL, { url: this.config.url }, this.config.insecure), 'Failed to get user invitations.');
+    }
+    /**
+     * Delete invitations by email and invite type.
+     *
+     * @param email - Email
+     * @param type
+     */
+    // TODO: map the response object
+    async deleteInvitations(email, type) {
+        return this.callDelete(formatServiceUrl(API_USER_INVITATION_URL, { url: this.config.url }, this.config.insecure), `Failed to delete user invitation ${email}, type ${type}.`, { email, type });
+    }
+    /**
+     * Accept invitation by id
+     *
+     * @param invitationId - Invitation Id
+     */
+    // TODO: map the response object
+    async acceptInvitation(invitationId) {
+        return this.callPut(formatServiceUrl(API_USER_INVITATION_ACCEPT_URL, { url: this.config.url, invitationId }, this.config.insecure), null, `Failed to accept user invitation ${invitationId}.`);
+    }
+    /**
+     * Check invitation by id
+     *
+     * @param invitationId - Invitation Id
+     */
+    async checkInvitation(invitationId) {
+        return this.callGet(formatServiceUrl(API_USER_INVITATION_CHECK_URL, { url: this.config.url, invitationId }, this.config.insecure), `Failed to check user invitation ${invitationId}.`);
+    }
+    /**
+     * Activate account by id
+     *
+     * @param accountId - Account Id
+     */
+    // TODO: map the response object
+    async activateAccount(accountId) {
+        return this.callPost(formatServiceUrl(API_ACCOUNT_ACTIVATE_URL, { url: this.config.url, accountId }, this.config.insecure), null, `Failed to activate account ${accountId}.`);
+    }
+    /**
+     * Resend verification email
+     *
+     * @param email - Email
+     */
+    // TODO: map the response object
+    async resendVerificationEmail(email) {
+        return this.callPost(formatServiceUrl(API_USER_VERIFY_EMAIL_URL, { url: this.config.url }, this.config.insecure), { email }, `Failed to send verification email ${email}.`);
+    }
+    /**
+     * Send forgotten password email.
+     *
+     * @param email - Email
+     */
+    // TODO: map the response object
+    async sendForgottenPasswordEmail(email) {
+        return this.callPost(formatServiceUrl(API_USER_PASSWORD_FORGOT_URL, { url: this.config.url }, this.config.insecure), { email }, `Failed to send forgot password email ${email}.`);
+    }
+    /**
+     * Revoke user's project access.
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     * @param userId - User Id
+     */
+    // TODO: map the response object
+    async removeProjectAccess(accountId, projectId, userId) {
+        return this.callDelete(formatServiceUrl(API_ACCOUNT_PROJECT_USER_ID_URL, {
+            url: this.config.url,
+            accountId,
+            projectId,
+            userId,
+        }, this.config.insecure), `Failed to remove project access ${accountId}, projectId ${projectId}, userId ${userId}.`);
+    }
+    /**
+     * Revoke user's account access.
+     *
+     * @param accountId - Account Id
+     * @param userId - User Id
+     */
+    // TODO: map the response object
+    async removeAccountAccess(accountId, userId) {
+        return this.callDelete(formatServiceUrl(API_AUTH_USER_ACCOUNT_USER_ID_URL, { url: this.config.url, accountId, userId }, this.config.insecure), `Failed to remove account access ${accountId}, userId ${userId}.`);
+    }
+    /**
+     * List account users
+     *
+     * @param accountId - Account Id
+     */
+    // TODO: map the response object
+    async listAccountUsers(accountId) {
+        return this.callGet(formatServiceUrl(API_AUTH_USER_ACCOUNT_USER_URL, { url: this.config.url, accountId }, this.config.insecure), `Failed to remove account access ${accountId}.`);
+    }
+    /**
+     * List project users
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     */
+    // TODO: map the response object
+    async listProjectUsers(accountId, projectId) {
+        return this.callGet(formatServiceUrl(API_ACCOUNT_PROJECT_USER_URL, { url: this.config.url, accountId, projectId }, this.config.insecure), `Failed to get account project users ${accountId}, projectId ${projectId}.`);
+    }
+    /**
+     * Create a users personal access token.
+     *
+     * @param personalAccessToken - Payload {@link IPersonalAccessToken}
+     */
+    async createPAT(personalAccessToken) {
+        return this.callPost(formatServiceUrl(API_USER_PAT_URL, { url: this.config.url }, this.config.insecure), personalAccessToken, 'Failed to create personal access token.');
+    }
+    /**
+     * Get all personal access tokens
+     *
+     * @param projectId - Project Id
+     * @param robotDefinitionId - Robot definition Id
+     */
+    // TODO: map the response object
+    async getAllPATs(projectId, robotDefinitionId) {
+        return this.callGet(formatServiceUrl(API_USER_PAT_URL, { url: this.config.url }, this.config.insecure), `Failed to get personal access tokens ${projectId}, robotDefinitionId ${robotDefinitionId}.`, {
+            'q[projectId]': projectId,
+            'q[metaData.defaultRobotDefinitionId]': robotDefinitionId,
+        });
+    }
+    /**
+     * Get a personal access token
+     *
+     * @param tokenString - Token string
+     */
+    // TODO: map the response object
+    async getOnePAT(tokenString) {
+        return this.callGet(formatServiceUrl(API_USER_PAT_TOKEN_URL, { url: this.config.url, token: tokenString }, this.config.insecure), 'Failed to get personal access token.');
+    }
+    /**
+     * REmove personal access token
+     *
+     * @param id - Token Id
+     */
+    // TODO: map the response object
+    async removePATById(id) {
+        return this.callDelete(formatServiceUrl(API_USER_PAT_TOKEN_URL, { url: this.config.url, token: id }, this.config.insecure), 'Failed to remove personal access token.');
+    }
+    /**
+     * Get account details
+     *
+     * @param accountId - Account Id
+     */
+    // TODO: map the response object
+    async accountDetails(accountId) {
+        return this.callGet(formatServiceUrl(API_ACCOUNT_ID_URL, { url: this.config.url, accountId }, this.config.insecure), `Failed to get account details ${accountId}.`);
+    }
+    /**
+     * Create an account
+     *
+     * @param name - Account name
+     */
+    // TODO: map the response object
+    async createAccount(name) {
+        return this.callPost(formatServiceUrl(API_ACCOUNT_URL, { url: this.config.url }, this.config.insecure), { name }, 'Failed to create account.');
+    }
+    /**
+     * Authenticate application
+     *
+     * @param appId - Application Id
+     * @param appKey - Application Key
+     */
+    // TODO: map the response object
+    async applicationAuth(appId, appKey) {
+        return this.callPost(formatServiceUrl(API_APPLICATION_AUTH_URL, { url: this.config.url }, this.config.insecure), { applicationId: appId, secret: appKey }, `Failed to authenticate application ${appId}.`);
+    }
+    /**
+     * Create a new application
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     * @param model - Payload {@link IProjectApplication}
+     */
+    async createApplication(accountId, projectId, model) {
+        return this.callPost(formatServiceUrl(API_ACCOUNT_PROJECT_APPLICATION_URL, { url: this.config.url, accountId, projectId }, this.config.insecure), model, `Failed to create application ${accountId}, projectId ${projectId}.`);
+    }
+    /**
+     * List all applications
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     */
+    // TODO: map the response object
+    async getAllApplications(accountId, projectId) {
+        return this.callGet(formatServiceUrl(API_ACCOUNT_PROJECT_APPLICATION_URL, { url: this.config.url, accountId, projectId }, this.config.insecure), `Failed to get applications ${accountId}, projectId ${projectId}.`);
+    }
+    /**
+     * Get application information
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     * @param applicationId - Application Id
+     */
+    // TODO: map the response object
+    async getApplication(accountId, projectId, applicationId) {
+        return this.callGet(formatServiceUrl(API_ACCOUNT_PROJECT_APPLICATION_ID_URL, {
+            url: this.config.url,
+            accountId,
+            projectId,
+            applicationId,
+        }, this.config.insecure), `Failed to get application ${accountId}, projectId ${projectId}, applicationId ${applicationId}.`);
+    }
+    /**
+     * Update application information
+     *
+     * @param accountId - Account Id
+     * @param projectId - Project Id
+     * @param applicationId - Application Id
+     * @param model - Payload
+     */
+    // TODO: map the request model
+    // TODO: map the response object
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+    async updateApplication(accountId, projectId, applicationId, model) {
+        return this.callPut(formatServiceUrl(API_ACCOUNT_PROJECT_APPLICATION_ID_URL, {
+            url: this.config.url,
+            accountId,
+            projectId,
+            applicationId,
+        }, this.config.insecure), model, `Failed to update application ${accountId}, projectId ${projectId}, applicationId ${applicationId}.`);
+    }
+    /**
+     * Delete application
+     *
+     * @param accountId - Account ID
+     * @param projectId - Project ID
+     * @param applicationId - Application ID
+     */
+    // TODO: map the response object
+    async deleteApplication(accountId, projectId, applicationId) {
+        return this.callDelete(formatServiceUrl(API_ACCOUNT_PROJECT_APPLICATION_ID_URL, {
+            url: this.config.url,
+            accountId,
+            projectId,
+            applicationId,
+        }, this.config.insecure), `Failed to delete application ${accountId}, projectId ${projectId}, applicationId ${applicationId}.`);
+    }
+    /**
+     * Get account settings.
+     *
+     * @param accountId - Account Id
+     */
+    // TODO: map the response object
+    async accountSettings(accountId) {
+        return this.callGet(formatServiceUrl(API_ACCOUNT_SETTINGS_URL, { url: this.config.url, accountId }, this.config.insecure), `Failed to get account settings ${accountId}.`);
+    }
+    /**
+     * Update account settings
+     *
+     * @param accountId - Account ID
+     * @param settings - Updated account settings
+     */
+    // TODO: map the request model
+    // TODO: map the response object
+    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+    async updateAccountSettings(accountId, settings) {
+        return this.callPut(formatServiceUrl(API_ACCOUNT_SETTINGS_URL, { url: this.config.url, accountId }, this.config.insecure), settings, `Failed to update account settings ${accountId}.`);
+    }
+    /**
+     * Send a new invitation.
+     *
+     * @param invitation - Invitation payload {@link IInvitation}
+     */
+    // TODO: map the response object
+    async sendInvitation(invitation) {
+        return this.callPost(formatServiceUrl(API_ADMIN_USER_INVITATION_URL, { url: this.config.url }, this.config.insecure), invitation, 'Failed to send invitation.');
+    }
+}

package/services/WebRTCSignallingService.d.ts

@@ -0,0 +1,22 @@
+import { IAddIceCandidateRequest, IGetDetailsRequest, IOfferRequest, IOperatorConnectRequest, IWebRTCSignallingGetDetailsResponse, IWebRTCSignallingMessage, IWebRTCSignallingOutcome, IWebRTCSignallingResponseStream, IWebRTCSignallingStream } from '..';
+import { IBaseService } from '../models/IBaseService';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+import { IStreamConfig } from '../models/IStreamConfig';
+import { ISubscriberStatus } from '../models/ISubscriberStatus';
+import { Subject } from 'rxjs';
+import { SubscriberStatusEnum } from '../models/SubscriberStatusEnum';
+export declare class WebRTCSignallingService implements IBaseService, ISubscriberStatus {
+    private config;
+    private logger;
+    private status;
+    status$: Subject<SubscriberStatusEnum>;
+    constructor(config: IRocosSDKConfig);
+    getStatus(): boolean;
+    connectOperator(request: IOperatorConnectRequest): Promise<IWebRTCSignallingResponseStream<IWebRTCSignallingMessage>>;
+    getDetails(request: IGetDetailsRequest): Promise<IWebRTCSignallingGetDetailsResponse>;
+    offerConnection(request: IOfferRequest): Promise<IWebRTCSignallingOutcome>;
+    addIceCandidate(request: IAddIceCandidateRequest): Promise<IWebRTCSignallingOutcome>;
+    private createSignallingStream;
+    private initStream;
+    protected getStream(config: IStreamConfig): IWebRTCSignallingStream;
+}

package/services/WebRTCSignallingService.js

@@ -0,0 +1,78 @@
+import { IDENTIFIER_NAME_COMMAND } from '../constants/identifier';
+import { RocosLogger } from '../logger/RocosLogger';
+import { RocosStore } from '../store/RocosStore';
+import { StreamRegister } from '../api/StreamRegister';
+import { Subject } from 'rxjs';
+import { SubscriberStatusEnum } from '../models/SubscriberStatusEnum';
+import { WebRTCSignallingStream } from '../api/streams/webRTCSignalling/WebRTCSignallingStream';
+export class WebRTCSignallingService {
+    constructor(config) {
+        this.status = false;
+        this.status$ = new Subject();
+        this.config = config;
+        this.logger = RocosLogger.getInstance(`WebRTCSignallingService(${this.config.url})`);
+        RocosStore.getSDKInstance(this.config).getAuthService().startTokenRefreshChecker();
+    }
+    getStatus() {
+        return this.status;
+    }
+    async connectOperator(request) {
+        const stream = await this.createSignallingStream();
+        return stream.connectOperator(request);
+    }
+    async getDetails(request) {
+        const stream = await this.createSignallingStream();
+        return stream.getDetails(request);
+    }
+    async offerConnection(request) {
+        const stream = await this.createSignallingStream();
+        return stream.offerConnection(request);
+    }
+    async addIceCandidate(request) {
+        const stream = await this.createSignallingStream();
+        return stream.addIceCandidate(request);
+    }
+    async createSignallingStream() {
+        const scope = 'default';
+        const identifier = StreamRegister.getIdentifier(IDENTIFIER_NAME_COMMAND, scope);
+        const streamRegister = StreamRegister.getInstance();
+        let stream = streamRegister.getStream(identifier);
+        if (!stream) {
+            stream = this.getStream({
+                url: this.config.url,
+                token: this.config.token,
+                scope,
+                options: this.config.options,
+                port: this.config.port,
+                insecure: this.config.insecure,
+            });
+            stream.statusStream$.subscribe((msg) => {
+                this.status = msg === SubscriberStatusEnum.STOPPED || msg === SubscriberStatusEnum.ALIVE;
+                this.status$.next(msg);
+            });
+            // don't wait for these promises, they can be init after startup
+            await streamRegister.addStream(stream);
+            await this.initStream(stream);
+        }
+        return stream;
+    }
+    async initStream(stream) {
+        // an async callback to set the stream token in case one was not set at startup
+        if (!this.config.token) {
+            try {
+                const authService = RocosStore.getSDKInstance(this.config).getAuthService();
+                const token = await authService.getToken();
+                if (token?.value) {
+                    this.config.token = token?.value;
+                    stream.setToken(this.config.token);
+                }
+            }
+            catch (e) {
+                this.logger.info('Can not retrieve auth token for web rtc signalling stream', e);
+            }
+        }
+    }
+    getStream(config) {
+        return new WebRTCSignallingStream(config);
+    }
+}

package/services/WorkflowService.d.ts

@@ -0,0 +1,67 @@
+import { RocosError } from '../models/RocosError';
+import type { Workflow, WorkflowBase } from '../models/workflow/Workflow';
+import { BaseServiceAbstract } from './BaseServiceAbstract';
+import { IBaseService } from '../models/IBaseService';
+import { IRocosSDKConfig } from '../models/IRocosSDKConfig';
+export declare class WorkflowService extends BaseServiceAbstract implements IBaseService {
+    constructor(config: IRocosSDKConfig);
+    protected getError(e: Error): RocosError;
+    getStatus(): boolean;
+    /**
+     * Get workflows for project
+     *
+     * @param projectId - Project Id
+     */
+    list(projectId: string): Promise<Workflow[]>;
+    /**
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use list instead.
+     */
+    getAll: (projectId: string) => Promise<Workflow[]>;
+    /**
+     * Create a workflow
+     *
+     * @param projectId - Project Id
+     * @param model - Workflow
+     */
+    create(projectId: string, model: WorkflowBase): Promise<Workflow>;
+    /**
+     * Get a workflow
+     *
+     * @param projectId - Project Id
+     * @param workflowId - Workflow Id
+     */
+    get(projectId: string, workflowId: string): Promise<Workflow>;
+    /**
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use get instead.
+     */
+    getOne: (projectId: string, workflowId: string) => Promise<Workflow>;
+    /**
+     * Update a workflow
+     *
+     * @param projectId - Project Id
+     * @param workflowId - Workflow Id
+     * @param model - Workflow
+     */
+    update(projectId: string, workflowId: string, model: Workflow): Promise<Workflow>;
+    /**
+     * Delete a workflow
+     *
+     * @param projectId - Project Id
+     * @param workflowId - Workflow Id
+     */
+    delete(projectId: string, workflowId: string): Promise<void>;
+    /**
+     * Get deployed workflows on robot
+     *
+     * @param projectId - Project Id
+     * @param callsign - Robot callsign
+     */
+    getDeployedWorkflows(projectId: string, callsign: string): Promise<Workflow[]>;
+    /**
+     * @deprecated This method is deprecated and will be removed in a future version.
+     * Use getDeployedWorkflow instead.
+     */
+    getDeployedOnRobot: (projectId: string, callsign: string) => Promise<Workflow[]>;
+}