@bitbar/cloud-api-client 0.56.0 → 1.0.0

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;
+};

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

@@ -0,0 +1,30 @@
+import { DeviceState } from './AdminDevice';
+export declare type DeviceStatus = {
+    alarmOn: boolean;
+    aslOn: boolean;
+    batteryLevel: number;
+    bluetoothOn: boolean;
+    clusterId: number;
+    clusterName: string;
+    deviceId: number;
+    deviceName: string;
+    deviceTime: number;
+    deviceTimeZone: string;
+    emailAccount: string;
+    externalStorage: number;
+    flashOn: boolean;
+    id: number;
+    internalStorage: number;
+    internetAccess: boolean;
+    locationServiceOn: boolean;
+    mockLocationOn: boolean;
+    monitoringOn: boolean;
+    screenLocked: boolean;
+    sdcardPresent: boolean;
+    ssid: string;
+    state: DeviceState;
+    tdsVersion: string;
+    testExecuting: boolean;
+    tetheringOn: boolean;
+    updateTime: number;
+};

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

@@ -0,0 +1,12 @@
+import { OsType } from './Enum';
+export declare type DeviceTimeCountSessionReportEntry = {
+    countDeviceSessions: number;
+    countTestRuns: number;
+    day: number;
+    deviceModelName: string;
+    deviceTime: number;
+    id: number;
+    osType: OsType;
+    projectName: string;
+    userEmail: string;
+};

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

@@ -0,0 +1,12 @@
+import { OsType } from './Enum';
+export declare type DeviceTimeStepTimeReportEntry = {
+    day: number;
+    deviceModelName: string;
+    deviceTime: number;
+    id: number;
+    osType: OsType;
+    preparationTime: number;
+    projectName: string;
+    userEmail: string;
+    waitingTime: number;
+};

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

@@ -0,0 +1,7 @@
+import { Device } from './Device';
+export declare type DeviceUsage = {
+    device: Device;
+    failedDeviceSessions: number;
+    id: number;
+    totalDeviceSessions: number;
+};

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

@@ -0,0 +1,10 @@
+export declare enum OsType {
+    IOS = "IOS",
+    ANDROID = "ANDROID",
+    DESKTOP = "DESKTOP",
+    UNDEFINED = "UNDEFINED"
+}
+export declare type Enum = {
+    id: number;
+    value: string;
+};

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

@@ -0,0 +1,37 @@
+import { OsType } from './Enum';
+import { UserFile } from './UserFile';
+export declare type Framework = {
+    accountId: number;
+    canRunFromUI: boolean;
+    createTime: number;
+    description: string;
+    documentationUrl: string;
+    forProjects: boolean;
+    icon: string;
+    id: number;
+    labelId: number;
+    labelName: string;
+    mainUserEmail: string;
+    name: string;
+    osType: OsType;
+    requiredAppExtensions: string;
+    requiredTestExtensions: string;
+    requiredTestFileTags: string;
+    retryable: boolean;
+    sampleApp: UserFile;
+    sampleTest: UserFile;
+    secured: boolean;
+    skipOlderSdk: boolean;
+    skipQueue: boolean;
+    type: string;
+};
+export declare type FrameworkData = Omit<Framework, 'createTime' | 'id' | 'labelName' | 'mainUserEmail' | 'sampleApp' | 'sampleTest'> & {
+    addLabelToDevices: boolean;
+    roleIds: Array<number>;
+    sampleAppId: number;
+    sampleTestId: number;
+};
+export declare type FrameworkEditData = Omit<FrameworkData, 'accountId' | 'id' | 'secured'>;
+export declare type FrameworkConfigData = {
+    content: string;
+};

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

@@ -0,0 +1,33 @@
+import { Method } from 'axios';
+export declare const ALLOWED_HTTP_METHODS: Array<Method>;
+export declare type QueryParam = string | number | boolean;
+export declare type QueryParams = Record<string, QueryParam | Array<QueryParam>>;
+export declare enum APIOrder {
+    asc = "a",
+    desc = "d"
+}
+export interface CollectionQueryParams extends QueryParams {
+    filter: string;
+    limit: number;
+    offset: number;
+    sort: string;
+    search: string;
+}
+export declare type CollectionBasicQueryParams = Omit<CollectionQueryParams, 'search'>;
+export declare type NoQueryParams = {
+    [key in any]: never;
+};
+export declare type CollectionResponse<T> = {
+    data: Array<T>;
+    empty: boolean;
+    id: number;
+    limit: number;
+    next: string;
+    offset: number;
+    previous: string;
+    search: string;
+    sort: string;
+    total: number;
+};
+export declare type SimpleCollectionResponse<T> = Pick<CollectionResponse<T>, 'data' | 'id'>;
+export declare type NoData = void;

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

@@ -0,0 +1,7 @@
+import { DeviceProperty } from './Device';
+export declare type LabelGroup = {
+    displayName: string;
+    id: number;
+    name: string;
+};
+export declare type LabelData = Pick<DeviceProperty, 'displayName' | 'name'>;

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

@@ -0,0 +1,74 @@
+export declare enum LicenseStatus {
+    ACTIVE = "ACTIVE",
+    EXPIRED = "EXPIRED",
+    INACTIVE = "INACTIVE",
+    CLOSED = "CLOSED"
+}
+export declare type BaseLicense = {
+    enabled: boolean;
+};
+export declare type FeatureLicense = {
+    deviceLimit: number;
+    deviceLimited: boolean;
+    projectLimit: number;
+    projectLimited: boolean;
+};
+export declare type AndroidLicense = BaseLicense & FeatureLicense & {
+    cts: CTSLicense;
+    uiAutomator: UIAutomatorLicense;
+};
+export declare type BuildLicense = BaseLicense & {
+    limit: number;
+    limited: boolean;
+};
+export declare type DesktopLicense = BaseLicense & FeatureLicense;
+export declare type GlobalLicense = FeatureLicense;
+export declare type InspectorLicense = BaseLicense;
+export declare type IOSLicense = BaseLicense & FeatureLicense;
+export declare type RecorderLicense = BaseLicense & {
+    limit: number;
+    limited: boolean;
+};
+export declare type ServerLicense = BaseLicense & {
+    androidEnabled: boolean;
+    iosEnabled: boolean;
+};
+export declare type CTSLicense = BaseLicense;
+export declare type UIAutomatorLicense = BaseLicense;
+export declare type License = {
+    activateTime: number;
+    android: AndroidLicense;
+    build: BuildLicense;
+    closeTime: number;
+    desktop: DesktopLicense;
+    expireTime: number;
+    global: GlobalLicense;
+    id: number;
+    inspector: InspectorLicense;
+    ios: IOSLicense;
+    privateInstance: boolean;
+    recorder: RecorderLicense;
+    server: ServerLicense;
+    status: LicenseStatus;
+    userEmail: string;
+    userId: number;
+};
+export declare type LicenseData = Pick<License, 'privateInstance' | 'userId'> & {
+    androidDeviceLimit: number;
+    androidEnabled: boolean;
+    androidProjectLimit: number;
+    buildEnabled: boolean;
+    buildLimit: number;
+    desktopDeviceLimit: number;
+    desktopEnabled: boolean;
+    desktopProjectLimit: number;
+    globalDeviceLimit: number;
+    globalProjectLimit: number;
+    inspectorEnabled: boolean;
+    iosDeviceLimit: number;
+    iosEnabled: boolean;
+    iosProjectLimit: number;
+    privateInstance: boolean;
+    unit: string;
+    unitCount: number;
+};

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

@@ -0,0 +1,13 @@
+export declare type Maintenance = {
+    enabled: boolean;
+    id: number;
+};
+export declare enum MaintenanceType {
+    BARE_METAL = "BARE_METAL",
+    EC2 = "EC2",
+    VM = "VM"
+}
+export declare type MaintenanceData = {
+    enabled: boolean;
+    type: MaintenanceType;
+};

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

@@ -0,0 +1,3 @@
+export declare type Message = {
+    message: string;
+};