com.browserstack.automate.Automate Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of automate-client-java Show documentation

Java bindings for BrowserStack Automate REST API

The newest version!

package com.browserstack.automate;

import com.browserstack.automate.exception.AutomateException;
import com.browserstack.automate.exception.ProjectNotFound;
import com.browserstack.automate.exception.SessionNotFound;
import com.browserstack.automate.model.AccountUsage;
import com.browserstack.automate.model.Project;
import com.browserstack.automate.model.Session;
import com.browserstack.client.model.Browser;

import java.util.List;
import java.util.Map;

public interface Automate {

    AccountUsage getAccountUsage() throws AutomateException;

    List getBrowsers() throws AutomateException;

    List getBrowsers(boolean cache) throws AutomateException;

    List getProjects() throws AutomateException;

    Project getProject(int projectId) throws ProjectNotFound, AutomateException;

    boolean deleteProject(int projectId) throws AutomateException;

    Session updateSessionStatus(String sessionId, Map data) throws AutomateException;

    Session updateSessionStatus(String sessionId,
                                SessionStatus sessionStatus,
                                String reason) throws SessionNotFound, AutomateException;

    Session updateSessionStatus(String sessionId,
                                SessionStatus sessionStatus) throws SessionNotFound, AutomateException;

    String getSessionLogs(String sessionId) throws SessionNotFound, AutomateException;

    String getSessionLogs(Session session) throws AutomateException;

    String getSessionVideo(String sessionId) throws SessionNotFound, AutomateException;

    boolean deleteSession(String sessionId) throws SessionNotFound, AutomateException;

    String recycleKey() throws AutomateException;


    enum BuildStatus {
        RUNNING, DONE, FAILED
    }

    enum SessionStatus {
        DONE, ERROR
    }
}