@bitbar/cloud-api-client 0.55.0 → 1.0.0

package/dist/api/models/AdminEmail.d.ts

@@ -0,0 +1,9 @@
+export declare type AdminEmail = {
+    createTime: number;
+    id: number;
+    lastEntryTime: number;
+    sent: boolean;
+    subject: string;
+    userEmail: string;
+    userId: number;
+};

package/dist/api/models/AdminError.d.ts

@@ -0,0 +1,39 @@
+export declare enum AdminErrorType {
+    ABORT_REQUEST = "ABORT_REQUEST",
+    ADB_COMMAND_REJECTED = "ADB_COMMAND_REJECTED",
+    ADB_SHELL_COMMAND_FAILED = "ADB_SHELL_COMMAND_FAILED",
+    APP_LOCK_NOT_INSTALLED = "APP_LOCK_NOT_INSTALLED",
+    DEVICE_OFFLINE = "DEVICE_OFFLINE",
+    DEVICE_OUTPUT_NULL = "DEVICE_OUTPUT_NULL",
+    GAMEBENCH_ERROR = "GAMEBENCH_ERROR",
+    GAMEBENCH_NOT_SUPPORTED = "GAMEBENCH_NOT_SUPPORTED",
+    GRANT_FAILED = "GRANT_FAILED",
+    INSTALL_FAILED = "INSTALL_FAILED",
+    INTERACTIVE_SETUP_FAILED = "INTERACTIVE_SETUP_FAILED",
+    INTERNAL_INSTALL_FAILED = "INTERNAL_INSTALL_FAILED",
+    INVALID_TEST_SESSION_FILE = "INVALID_TEST_SESSION_FILE",
+    LOCK_EXPIRED = "LOCK_EXPIRED",
+    LOCK_TIMEOUT = "LOCK_TIMEOUT",
+    NO_NETWORK_CONNECTION = "NO_NETWORK_CONNECTION",
+    OTHER = "OTHER",
+    REBOOTING_TIMEOUT = "REBOOTING_TIMEOUT",
+    REPACKAGING = "REPACKAGING",
+    RESULTS_PREPARING = "RESULTS_PREPARING",
+    RESULTS_PROCESSING = "RESULTS_PROCESSING",
+    RESULTS_SENDING = "RESULTS_SENDING",
+    STEP_TIMEOUT = "STEP_TIMEOUT",
+    SYSTEM_FAILURE = "SYSTEM_FAILURE",
+    TEST_RUN_FAILED = "TEST_RUN_FAILED",
+    TEST_RUN_INTERRUPTED = "TEST_RUN_INTERRUPTED",
+    TEST_RUN_TIMEOUT = "TEST_RUN_TIMEOUT",
+    TEST_RUN_WARNED = "TEST_RUN_WARNED",
+    TEST_TIMEOUT = "TEST_TIMEOUT",
+    VNC_CONNECTION_SETUP_FAILED = "VNC_CONNECTION_SETUP_FAILED",
+    XCRUN_INSTRUMENTS_COMMAND_FAILED = "XCRUN_INSTRUMENTS_COMMAND_FAILED",
+    XCRUN_INSTRUMENTS_JS_ERROR = "XCRUN_INSTRUMENTS_JS_ERROR"
+}
+export declare type AdminError = {
+    id: number;
+    quantity: number;
+    type: AdminErrorType;
+};

package/dist/api/models/AdminFrameworkStatistics.d.ts

@@ -0,0 +1,24 @@
+import { DeviceSessionState } from './DeviceSession';
+import { OsType } from './Enum';
+export declare enum FrameworkType {
+    AUTOMATIC = "AUTOMATIC",
+    MANUAL_APP = "MANUAL_APP",
+    MANUAL_WEB = "MANUAL_WEB",
+    REMOTE = "REMOTE"
+}
+export declare type AdminFrameworkStatistics = {
+    cloudName: string;
+    count: number;
+    day: number;
+    deviceModelId: number;
+    deviceModelName: string;
+    frameworkId: number;
+    frameworkName: string;
+    id: number;
+    osType: OsType;
+    releaseVersion: string;
+    state: DeviceSessionState;
+    type: FrameworkType;
+    userEmail: string;
+    userId: number;
+};

package/dist/api/models/AdminOverview.d.ts

@@ -0,0 +1,10 @@
+export declare type AdminOverview = {
+    activeUsersCount: number;
+    id: number;
+    inspectorSessionsCount: number;
+    remoteSessionsCount: number;
+    runningDeviceModelsCount: number;
+    runningTestRunsCount: number;
+    waitingDeviceModelsCount: number;
+    waitingTestRunsCount: number;
+};

package/dist/api/models/AdminTestRun.d.ts

@@ -0,0 +1,31 @@
+import { QueryParams } from './HTTP';
+import { TestScheduler, TestState } from './TestRun';
+export declare type AdminTestRun = {
+    appCrawlerRun: boolean;
+    createTime: number;
+    duration: number;
+    endTime: number;
+    frameworkId: number;
+    frameworkName: string;
+    id: number;
+    message: string;
+    priority: number;
+    projectId: number;
+    projectName: string;
+    scheduler: TestScheduler;
+    startTime: number;
+    startedById: number;
+    state: TestState;
+    successRatio: number;
+};
+export interface RunsConfigParams extends QueryParams {
+    includeDeviceGroups: boolean;
+    includeDevices: boolean;
+    includeFrameworks: boolean;
+}
+export interface RunChangeBillableParams extends QueryParams {
+    billable: boolean;
+}
+export interface RunChangePriorityParams extends QueryParams {
+    priority: boolean;
+}

package/dist/api/models/BillingPeriod.d.ts

@@ -0,0 +1,40 @@
+import { PaymentMethod } from './AccountService';
+import { DeviceSessionType } from './DeviceSession';
+import { OsType } from './Enum';
+import { QueryParams } from './HTTP';
+export declare enum BillingType {
+    BUY = "BUY",
+    CHARGE = "CHARGE",
+    CANCEL = "CANCEL"
+}
+export declare type BillingPeriod = {
+    accountServiceId: number;
+    additionalHours: number;
+    additionalHoursPrice: number;
+    apiBillingPeriodType: BillingType;
+    createTime: number;
+    endBillingPeriod: number;
+    id: number;
+    lastPaymentDate: number;
+    mail: string;
+    paid: boolean;
+    paymentMethod: PaymentMethod;
+    plan: string;
+    servicePrice: number;
+    startBillingPeriod: number;
+    subscriptionEnd: number;
+    subscriptionStart: number;
+    totalPrice: number;
+    usages: Array<BillingPeriodUsage>;
+    userId: number;
+};
+export declare type BillingPeriodUsage = {
+    billableSeconds: number;
+    id: number;
+    nonBillableSeconds: number;
+    osType: OsType;
+    type: DeviceSessionType;
+};
+export interface BillingPeriodQueryParams extends QueryParams {
+    onDate: number;
+}

package/dist/api/models/Broker.d.ts

@@ -0,0 +1,10 @@
+export declare enum BrokerType {
+    MOBILE = "MOBILE",
+    DESKTOP = "DESKTOP"
+}
+export declare type Broker = {
+    id: number;
+    location: string;
+    type: BrokerType;
+    url: string;
+};

package/dist/api/models/Browser.d.ts

@@ -0,0 +1,15 @@
+import { OsType } from './Enum';
+export declare type Browser = {
+    architecture: string;
+    displayName: string;
+    id: number;
+    install: boolean;
+    installUrl: string;
+    name: string;
+    osType: OsType;
+    version: string;
+};
+export declare type BrowserData = Omit<Browser, 'id' | 'install'>;
+export declare type DeviceBrowserData = {
+    browserIds: Array<number>;
+};

package/dist/api/models/CleanupConfiguration.d.ts

@@ -0,0 +1,5 @@
+import { DeviceCleanupConfiguration } from './Device';
+export declare type CleanupConfigurationData = Pick<DeviceCleanupConfiguration, 'content' | 'discriminator' | 'enabled' | 'osType'>;
+export interface SpecificCleanupConfigurationQueryParams {
+    serialId: string;
+}

package/dist/api/models/Cluster.d.ts

@@ -0,0 +1,32 @@
+import { AdminDevice } from './AdminDevice';
+import { CollectionResponse, QueryParams } from './HTTP';
+export declare type Cluster = {
+    devices: CollectionResponse<AdminDevice>;
+    enabled: boolean;
+    id: number;
+    ipAddress: string;
+    jenkinsUrl: string;
+    location: string;
+    name: string;
+    pluginVersion: string;
+    region: string;
+    state: ClusterState;
+    stateChangeTime: number;
+    stateTime: number;
+    url: string;
+};
+export declare enum ClusterState {
+    'OFFLINE' = 0,
+    ONLINE = "ONLINE",
+    RESTARTING = "RESTARTING",
+    QUIET_DOWN = "QUIET_DOWN",
+    MAINTENANCE = "MAINTENANCE"
+}
+export interface ClusterParams extends QueryParams {
+    withDevices: boolean;
+}
+export declare type ClusterData = Pick<Cluster, 'enabled' | 'url'> & {
+    quietDown: boolean;
+    restart: boolean;
+    turnMaintenance: boolean;
+};

package/dist/api/models/Connection.d.ts

@@ -0,0 +1,15 @@
+export declare type Connection = {
+    createTime: number;
+    deviceSessionId: number;
+    endTime: number;
+    externalId: string;
+    host: string;
+    id: number;
+    password: string;
+    path: string;
+    port: number;
+    type: string;
+    url: string;
+    urlSchema: string;
+};
+export declare type ConnectionData = Pick<Connection, 'host' | 'port' | 'type' | 'password'>;

package/dist/api/models/CountryVatRate.d.ts

@@ -0,0 +1,7 @@
+export declare type CountryVatRate = {
+    country: string;
+    countryCode: string;
+    id: number;
+    vatRate: number;
+};
+export declare type CountryVatRateData = Pick<CountryVatRate, 'countryCode' | 'vatRate'>;

package/dist/api/models/DesktopBrowserCapabilities.d.ts

@@ -0,0 +1,19 @@
+export declare type DesktopBrowserCapabilities = {
+    id: number;
+    platforms: Array<any>;
+};
+export declare type DesktopPlatform = {
+    browsers: Array<DesktopBrowser>;
+    id: number;
+    name: string;
+    resolutions: Array<string>;
+    value: string;
+    version: string;
+};
+export declare type DesktopBrowser = {
+    displayName: string;
+    id: number;
+    name: string;
+    value: string;
+    version: Array<string>;
+};

package/dist/api/models/Device.d.ts

@@ -0,0 +1,108 @@
+import { Browser } from './Browser';
+import { OsType } from './Enum';
+import { CollectionBasicQueryParams, CollectionQueryParams, CollectionResponse, QueryParams } from './HTTP';
+import { TestRunsQueryParams } from './TestRun';
+export declare enum DeviceGroupOrigin {
+    STATIC = "STATIC",
+    DYNAMIC = "DYNAMIC",
+    HYBRID = "HYBRID"
+}
+export declare enum Platform {
+    IOS = "IOS",
+    ANDROID = "ANDROID",
+    WINDOWS = "WINDOWS",
+    MAC = "MAC",
+    LINUX = "LINUX",
+    UNDEFINED = "UNDEFINED"
+}
+export declare enum SupportedCreators {
+    MANUAL = "MANUAL",
+    ROBOT = "ROBOT",
+    AUTOMATIC = "AUTOMATIC"
+}
+export declare type DeviceProperty = {
+    displayName: string;
+    id: number;
+    labelGroupName: string;
+    name: string;
+    propertyGroupId: number;
+    propertyGroupName: string;
+};
+export declare type SoftwareVersion = {
+    apiLevel: number;
+    id: number;
+    releaseVersion: string;
+};
+export declare type Device = {
+    accountId: number;
+    available: boolean;
+    browsers: CollectionResponse<Browser>;
+    creditsPrice: number;
+    deviceGroupOrigin: DeviceGroupOrigin;
+    displayName: string;
+    enabled: boolean;
+    frame100Url: string;
+    frame160Url: string;
+    frame400Url: string;
+    frame80Url: string;
+    frameExtraWidth: number;
+    id: number;
+    imageHeight: number;
+    imageLeft: number;
+    imagePrefix: string;
+    imageTop: number;
+    imageWidth: number;
+    locked: boolean;
+    mainUserEmail: string;
+    manufacturer: string;
+    online: boolean;
+    osType: OsType;
+    platform: Platform;
+    properties: CollectionResponse<DeviceProperty>;
+    softwareVersion: SoftwareVersion;
+    supportedCreators: SupportedCreators;
+};
+export declare type DeviceCleanupConfiguration = {
+    content: string;
+    createTime: number;
+    createdByEmail: string;
+    createdById: number;
+    discriminator: string;
+    enabled: boolean;
+    global: boolean;
+    example: true;
+    id: number;
+    lastModificationTime: number;
+    osType: OsType;
+};
+export declare type DeviceCleanupConfigurationData = {
+    deviceCleanupConfigurationId: number;
+};
+export declare type DeviceLabelData = {
+    labelId: number;
+};
+export interface DeviceProperiesData extends QueryParams {
+    labelId: number;
+}
+export declare type CleanupConfigurationData = Pick<DeviceCleanupConfiguration, 'content' | 'discriminator' | 'enabled'>;
+export interface CleanupConfigurationSpecificData extends QueryParams {
+    serialId: string;
+}
+export interface DeviceTimeSummaryQueryParams extends CollectionBasicQueryParams {
+    forWholeAccount: boolean;
+}
+export interface DeviceUsageQueryParams extends TestRunsQueryParams {
+    startTime: number;
+}
+export interface DeviceStatisticQueryParam extends TestRunsQueryParams {
+    mode: string;
+}
+export interface DevicesQueryParams extends CollectionQueryParams {
+    labelIds: Array<string>;
+    liveTestingOnly: boolean;
+    withBrowsers: boolean;
+    withDedicated: boolean;
+    withDisabled: boolean;
+    withProperties: boolean;
+    withSupportedCreators: boolean;
+}

package/dist/api/models/DeviceFilter.d.ts

@@ -0,0 +1,17 @@
+import { OsType } from './Enum';
+export declare type DevicePicker = {
+    deviceFilterGroups: Array<DeviceFilterGroup>;
+    id: number;
+};
+export declare type DeviceFilter = {
+    displayName: string;
+    hidden: boolean;
+    id: number;
+    name: string;
+    osType: OsType;
+};
+export declare type DeviceFilterGroup = {
+    deviceFilters: Array<DeviceFilter>;
+    id: number;
+    name: string;
+};

package/dist/api/models/DeviceGroup.d.ts

@@ -0,0 +1,30 @@
+import { OsType } from './Enum';
+import { CollectionBasicQueryParams, QueryParams } from './HTTP';
+export declare type DeviceGroup = {
+    deviceCount: number;
+    displayName: string;
+    id: number;
+    name: string;
+    osType: OsType;
+    shared: boolean;
+    userEmail: string;
+    userId: number;
+};
+export interface DeviceGroupSelectorData extends QueryParams {
+    selectorIds: Array<number>;
+}
+export interface DeviceGroupIdsData extends QueryParams {
+    deviceId: number;
+    deviceIds: Array<number>;
+}
+export interface DeviceGroupShareData extends QueryParams {
+    accessGroupId: number;
+    email: string;
+}
+export interface DeviceGroupParams extends CollectionBasicQueryParams {
+    withProperties: boolean;
+}
+export interface DeviceGroupWithPublicParams extends CollectionBasicQueryParams {
+    withPublic: boolean;
+}
+export declare type DeviceGroupData = Pick<DeviceGroup, 'displayName' | 'name' | 'osType'>;

package/dist/api/models/DeviceModel.d.ts

@@ -0,0 +1,23 @@
+import { Platform } from './Device';
+import { OsType } from './Enum';
+export declare type DeviceModel = {
+    avgWaitingTime: number;
+    dedicated: boolean;
+    enabled: boolean;
+    id: number;
+    location: string;
+    name: string;
+    online: number;
+    osType: OsType;
+    platform: Platform;
+    queueSize: number;
+    releaseVersion: string;
+    running: number;
+    total: number;
+};
+export declare type DeviceModelData = Pick<DeviceModel, 'enabled' | 'name' | 'releaseVersion'> & {
+    apiLevel: number;
+    creditsPrice: number;
+    manufacturer: string;
+    typeId: number;
+};

package/dist/api/models/DeviceModelCriterion.d.ts

@@ -0,0 +1,19 @@
+export declare enum CriterionField {
+    NAME = "NAME",
+    FINGERPRINT = "FINGERPRINT",
+    SERIAL_ID = "SERIAL_ID",
+    UNLOCK_GESTURE = "UNLOCK_GESTURE",
+    SOFTWARE_VERSION = "SOFTWARE_VERSION",
+    INIT_STEP = "INIT_STEP",
+    ACCOUNT = "ACCOUNT",
+    BROWSERS = "BROWSERS"
+}
+export declare type DeviceModelCriterion = {
+    createTime: number;
+    field: CriterionField;
+    id: number;
+    labelGroupDisplayName: string;
+    labelGroupId: number;
+    labelGroupName: string;
+};
+export declare type DeviceModelCriterionData = Pick<DeviceModelCriterion, 'field' | 'labelGroupId'>;

package/dist/api/models/DeviceModelPool.d.ts

@@ -0,0 +1,19 @@
+export declare enum RetentionStrategy {
+    CLUSTER_ON_OFF = "CLUSTER_ON_OFF",
+    MIN_FREE_MAX_TOTAL = "MIN_FREE_MAX_TOTAL",
+    POOL_MANAGER_AWARE = "POOL_MANAGER_AWARE"
+}
+export declare type DeviceModelPool = {
+    createTime: number;
+    enabled: boolean;
+    id: number;
+    location: string;
+    maxTotal: number;
+    minAvailable: number;
+    name: string;
+    numberOfBrowsers: number;
+    osVersion: string;
+    retentionStrategy: RetentionStrategy;
+    running: number;
+};
+export declare type DeviceModelPoolData = Pick<DeviceModelPool, 'maxTotal' | 'minAvailable'>;

package/dist/api/models/DeviceProblem.d.ts

@@ -0,0 +1,23 @@
+export declare enum ProblemType {
+    CLEANING = "CLEANING",
+    DIRTY = "DIRTY",
+    OFFLINE = "OFFLINE",
+    LOW_BATTERY = "LOW_BATTERY",
+    HIGH_FAIL_RATE = "HIGH_FAIL_RATE",
+    NO_INTERNET_CONNECTION = "NO_INTERNET_CONNECTION"
+}
+export declare type DeviceProblem = {
+    clusterId: number;
+    clusterName: string;
+    deviceId: number;
+    deviceModelId: number;
+    deviceModelName: string;
+    deviceName: string;
+    id: number;
+    problems: Array<DeviceProblemPair>;
+};
+export declare type DeviceProblemPair = {
+    id: number;
+    type: ProblemType;
+    value: any;
+};

package/dist/api/models/DeviceSession.d.ts

@@ -0,0 +1,137 @@
+import { Device } from './Device';
+import { CollectionBasicQueryParams } from './HTTP';
+export declare type TunnelSettings = {
+    domain: string;
+    email: string;
+};
+export declare enum DeviceSessionType {
+    AUTOMATIC = "AUTOMATIC",
+    MANUAL = "MANUAL",
+    MANUAL_APP = "MANUAL_APP",
+    MANUAL_WEB = "MANUAL_WEB",
+    REMOTE = "REMOTE"
+}
+export declare enum RetryState {
+    NONE = "NONE",
+    MANUAL = "MANUAL",
+    AUTO = "AUTO"
+}
+export declare enum DeviceSessionState {
+    ABORTED = "ABORTED",
+    EXCLUDED = "EXCLUDED",
+    FAILED = "FAILED",
+    RUNNING = "RUNNING",
+    SUCCEEDED = "SUCCEEDED",
+    TIMEOUT = "TIMEOUT",
+    WAITING = "WAITING",
+    WARNING = "WARNING"
+}
+export declare enum DeviceSessionStepType {
+    WAITING = "WAITING",
+    PREPARING = "PREPARING",
+    UNINSTALL = "UNINSTALL",
+    INSTALL = "INSTALL",
+    RUNNING = "RUNNING",
+    SENDING_RESULTS = "SENDING_RESULTS",
+    PROCESSING_RESULTS = "PROCESSING_RESULTS"
+}
+export declare type DeviceSessionConfig = {
+    adbVersion: string;
+    browserName: string;
+    browserVersion: string;
+    deviceModelId: number;
+    id: number;
+    screenResolution: string;
+    tunnelSettings: TunnelSettings;
+    type: DeviceSessionConfig;
+    url: string;
+};
+export declare type DeviceSession = {
+    accountId: number;
+    autoRetriesLeftCount: number;
+    billable: boolean;
+    config: DeviceSessionConfig;
+    createTime: number;
+    device: Device;
+    deviceInstanceId: number;
+    deviceLogFirstTimestamp: number;
+    deviceRunId: number;
+    deviceTime: number;
+    duration: number;
+    endTime: number;
+    excludeReason: string;
+    externalId: string;
+    id: number;
+    installTime: number;
+    name: string;
+    projectId: number;
+    projectName: string;
+    retryState: RetryState;
+    rowIndex: number;
+    startTime: number;
+    state: DeviceSessionState;
+    successRatio: number;
+    testCaseAllCount: number;
+    testCaseFailedCount: number;
+    testCasePassedCount: number;
+    testCaseSkippedCount: number;
+    testCaseSuccessCount: number;
+    testRunId: number;
+    testRunName: string;
+    timeLimit: number;
+    type: DeviceSessionType;
+    userEmail: string;
+    userId: number;
+};
+export declare type DeviceSessionCommand = {
+    duration: number;
+    httpMethod: string;
+    id: number;
+    requestBody: string;
+    responseBody: string;
+    responseCode: number;
+    timestamp: number;
+    uri: string;
+};
+export declare type DeviceSessionStep = {
+    deviceSessionId: number;
+    excludeReason: string;
+    failReason: string;
+    finishTimeMS: number;
+    id: number;
+    startTimeMS: number;
+    type: DeviceSessionStepType;
+};
+export declare type DeviceSessionConnection = {
+    createTime: number;
+    deviceSessionId: number;
+    endTime: number;
+    externalId: string;
+    host: string;
+    id: number;
+    password: string;
+    path: string;
+    port: number;
+    type: string;
+    url: string;
+    urlSchema: string;
+};
+export declare type DeviceSessionData = Omit<DeviceSessionConfig, 'adbVersion' | 'id' | 'tunnelSettings' | 'type'> & {
+    configuration: DeviceSessionConfig;
+};
+export interface DeviceSessionQueryParams extends CollectionBasicQueryParams {
+    withProperties: boolean;
+}
+export interface SessionQueryParams extends CollectionBasicQueryParams {
+    projectId: number;
+    testRunId: number;
+}
+export interface SessionRunStepQueryParams extends CollectionBasicQueryParams {
+    runId: number;
+}
+export interface SessionStepQueryParams extends SessionRunStepQueryParams {
+    projectId: number;
+}
+export interface TRunDeviceSessionQueryParams extends CollectionBasicQueryParams {
+    projectId: number;
+}

package/dist/api/models/DeviceSessionDataAvailability.d.ts

@@ -0,0 +1,9 @@
+export declare type DeviceSessionDataAvailability = {
+    buildLogs: boolean;
+    deviceRunId: number;
+    id: number;
+    logs: boolean;
+    performance: boolean;
+    resultsDataZip: boolean;
+    screenshots: boolean;
+};

package/dist/api/models/DeviceStatistics.d.ts

@@ -0,0 +1,15 @@
+import { OsType } from './Enum';
+export declare type DeviceStatistics = {
+    deviceName: string;
+    failedDevices: number;
+    failedRatio: number;
+    failedTests: number;
+    id: number;
+    osType: OsType;
+    passedRatio: number;
+    passedTests: number;
+    releaseVersion: string;
+    totalTests: number;
+    usageCount: number;
+    usageMillis: number;
+};