@bitbar/cloud-api-client 0.55.0 → 1.0.0

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

@@ -0,0 +1,132 @@
+import { Device } from './Device';
+import { TunnelSettings } from './DeviceSession';
+import { OsType } from './Enum';
+import { CollectionBasicQueryParams, QueryParams } from './HTTP';
+import { Tag } from './Tag';
+export declare enum LimitationType {
+    PACKAGE = "PACKAGE",
+    CLASS = "CLASS"
+}
+export declare enum TestScheduler {
+    PARALLEL = "PARALLEL",
+    SERIAL = "SERIAL",
+    SINGLE = "SINGLE",
+    ALL_INSTANCES = "ALL_INSTANCES"
+}
+export declare enum TestState {
+    WAITING = "WAITING",
+    RUNNING = "RUNNING",
+    FINISHED = "FINISHED"
+}
+export declare type TestRun = {
+    abortedDeviceCount: number;
+    billable: boolean;
+    config: TestRunConfig;
+    createTime: number;
+    deviceCount: number;
+    displayName: string;
+    errorsDeviceCount: number;
+    excludedDeviceCount: number;
+    executedTestCaseCount: number;
+    executionRatio: number;
+    failedTestCaseCount: number;
+    finishedDeviceCount: number;
+    frameworkId: number;
+    frameworkName: string;
+    id: number;
+    logsFileId: number;
+    message: string;
+    'number': number;
+    projectId: number;
+    projectName: string;
+    rowIndex: number;
+    runningDeviceCount: number;
+    screenshotsFileId: number;
+    startTime: number;
+    startedByDisplayName: string;
+    startedById: number;
+    state: TestState;
+    succeededDeviceCount: number;
+    successRatio: number;
+    successfulTestCaseCount: number;
+    tags: Array<Tag>;
+    testCaseCount: number;
+    timeoutedDeviceCount: number;
+    totalDeviceCount: number;
+    uiLink: string;
+    userId: number;
+    waitingDeviceCount: number;
+    warningDeviceCount: number;
+};
+export declare type TestRunConfig = {
+    appCrawlerRun: boolean;
+    appiumBrokerAddress: string;
+    applicationPassword: string;
+    applicationUsername: string;
+    availableDeviceGroups: any;
+    availableDevices: Array<Device>;
+    availableFrameworks: any;
+    availableOsTypes: Array<OsType>;
+    clientSideTestConfig: any;
+    computedDevices: Array<number>;
+    creditsPrice: number;
+    deviceGroupId: number;
+    deviceIds: any;
+    deviceLanguageCode: string;
+    deviceNamePattern: string;
+    disableResigning: boolean;
+    files: any;
+    frameworkId: number;
+    hookURL: string;
+    id: number;
+    instrumentationRunner: string;
+    limitationType: LimitationType;
+    limitationValue: string;
+    loadedPrevious: boolean;
+    example: true;
+    maxAutoRetriesCount: number;
+    maxTestTimeout: any;
+    osType: OsType;
+    projectId: number;
+    projectName: string;
+    resignFiles: boolean;
+    runAvailable: boolean;
+    scheduler: TestScheduler;
+    screenshotDir: string;
+    status: string;
+    statusCode: number;
+    testRunId: number;
+    testRunName: string;
+    testRunNameGrouping: string;
+    testRunParameters: any;
+    timeout: number;
+    tunnelSettings: TunnelSettings;
+    useSamples: boolean;
+    usedDeviceGroupId: number;
+    usedDeviceGroupName: string;
+    videoRecordingEnabled: boolean;
+    withAnnotation: string;
+    withoutAnnotation: string;
+};
+export interface TestRunData extends QueryParams {
+    displayName: string;
+}
+export interface RunData extends TestRunData {
+    projectId: number;
+}
+export interface RunQueryParam extends QueryParams {
+    projectId: number;
+}
+export interface TestRunsData {
+    configuration: TestRunConfig;
+}
+export interface TestRunsConfigData extends TestRunsData {
+    includeDeviceGroups: boolean;
+    includeDevices: boolean;
+    includeFrameworks: boolean;
+}
+export interface TestRunsQueryParams extends CollectionBasicQueryParams {
+    forWholeAccount: boolean;
+    skipCommonProject: boolean;
+    skipShared: boolean;
+}

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

@@ -0,0 +1,10 @@
+import { DeviceSessionDataAvailability } from './DeviceSessionDataAvailability';
+import { QueryParams } from './HTTP';
+export declare type TestRunDataAvailability = {
+    deviceRunDataAvailabilities: DeviceSessionDataAvailability;
+    id: number;
+    testRunId: number;
+};
+export interface TestRunDataAvailabilityQueryParams extends QueryParams {
+    userId: number;
+}

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

@@ -0,0 +1,75 @@
+import { CollectionQueryParams, QueryParams } from './HTTP';
+import { Role } from './Role';
+export declare enum MfaStatus {
+    VERIFICATION_NEED = "VERIFICATION_NEED",
+    DISABLED = "DISABLED",
+    ENABLED = "ENABLED"
+}
+export declare enum UserStatus {
+    INACTIVE = "INACTIVE",
+    DISABLED = "DISABLED",
+    ENABLED = "ENABLED"
+}
+export declare type User = {
+    accountId: number;
+    accountOwners: Array<User>;
+    accountServiceIds: Array<number>;
+    address: string;
+    apiKey: string;
+    city: string;
+    code: string;
+    country: string;
+    createTime: number;
+    createdByEmail: string;
+    createdById: number;
+    deleteTime: number;
+    email: string;
+    enabled: boolean;
+    firstName: string;
+    id: number;
+    isMainUser: boolean;
+    lastLaunchedTestTime: number;
+    lastLoginTime: number;
+    lastName: string;
+    mainUserEmail: string;
+    mainUserId: number;
+    mfaQRCodeUrl: string;
+    mfaStatus: MfaStatus;
+    organization: string;
+    phone: string;
+    registrationIP: string;
+    roles: Array<Role>;
+    serviceIds: Array<number>;
+    state: string;
+    status: UserStatus;
+    timeZone: string;
+    vatId: string;
+};
+export declare type UserData = Pick<User, 'email'>;
+export interface UserParams extends CollectionQueryParams {
+    WITH_ADDRESS: boolean;
+    WITH_USER_INFO: boolean;
+    onlyMainUsers: boolean;
+    onlyWithDisabledServices: boolean;
+    withRole: string;
+    withRoles: boolean;
+}
+export declare type UserUpdateAccount = Pick<User, 'accountId'>;
+export interface LoginData {
+    username: string;
+    password: string;
+}
+export declare type UserPasswordData = {
+    key: string;
+    password: string;
+};
+export declare type UserActivateData = {
+    zip: string;
+} & UserPasswordData & Pick<User, 'address' | 'city' | 'country' | 'email' | 'firstName' | 'lastName' | 'organization' | 'phone' | 'state' | 'vatId'>;
+export interface UserRecoveryQueryParams extends QueryParams {
+    recoveryKey: string;
+}
+export interface ValidateVatQueryParams extends QueryParams {
+    countryCode: string;
+    vatId: string;
+}

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

@@ -0,0 +1,21 @@
+import { DeviceSessionType } from './DeviceSession';
+import { CollectionQueryParams } from './HTTP';
+export declare type UserDeviceTime = BasicDeviceTime & {
+    billableTime: number;
+    createTime: number;
+    endTime: number;
+    freeTime: number;
+    type: DeviceSessionType;
+    userId: number;
+    userName: string;
+};
+export declare type BasicDeviceTime = {
+    deviceTime: number;
+    id: number;
+};
+export interface DeviceTimeParams extends CollectionQueryParams {
+    forWholeAccount: boolean;
+}
+export interface DeviceTimeQueryParams extends CollectionQueryParams {
+    forWholeAccount: boolean;
+}

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

@@ -0,0 +1,14 @@
+import { CollectionQueryParams } from './HTTP';
+export declare type UserDeviceTimeSummary = {
+    automaticDeviceTime: number;
+    freeDeviceTime: number;
+    id: number;
+    inspectorDeviceTime: number;
+    periodEnd: number;
+    periodStart: number;
+    remoteDeviceTime: number;
+    totalDeviceTime: number;
+};
+export interface DeviceTimeSummaryParams extends CollectionQueryParams {
+    forWholeAccount: boolean;
+}

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

@@ -0,0 +1,65 @@
+import { CollectionQueryParams, QueryParams } from './HTTP';
+export declare enum FileDirection {
+    INPUT = "INPUT",
+    OUTPUT = "OUTPUT"
+}
+export declare enum FileInputType {
+    APPLICATION = "APPLICATION",
+    TEST = "TEST",
+    DATA = "DATA"
+}
+export declare enum FileState {
+    PREPARING = "PREPARING",
+    READY = "READY"
+}
+export declare type FileProperty = {
+    id: number;
+    key: string;
+    value: string;
+};
+export declare type UserFileTag = {
+    id: number;
+    name: string;
+};
+export declare type UserFile = {
+    createTime: number;
+    directUrl: string;
+    direction: FileDirection;
+    duplicate: boolean;
+    fileProperties: Array<FileProperty>;
+    iconDirectUrl: string;
+    id: number;
+    inputType: FileInputType;
+    mimetype: string;
+    name: string;
+    shared: boolean;
+    size: number;
+    state: FileState;
+    userEmail: string;
+    userId: number;
+};
+export interface UserFileParams extends CollectionQueryParams {
+    tag: Array<string>;
+}
+export declare type UserFileData = {
+    file: FormData;
+    global: boolean;
+};
+export declare type BuildLogsData = {
+    deviceRunIds: Array<number>;
+    projectId: number;
+    userId: number;
+};
+export declare type BuildLogsParams = BuildLogsData;
+export interface FileSizeData extends QueryParams {
+    height: number;
+    width: number;
+}
+export declare type UploadObj = {
+    dir: string;
+    filename: string;
+};
+export interface FileData {
+    file: Blob;
+    global: boolean;
+}

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

@@ -0,0 +1,11 @@
+import { QueryParams } from './HTTP';
+export declare type UserPreference = {
+    defaultHttpSessionMaxInactiveInterval: number;
+    defaultTestTimeout: number;
+    httpSessionMaxInactiveInterval: number;
+    id: number;
+    testTimeout: number;
+};
+export interface UiPreferencesData extends QueryParams {
+    data: string;
+}

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

@@ -0,0 +1,14 @@
+import { QueryParams } from './HTTP';
+export declare type UserStatistics = {
+    devicesUsed: number;
+    id: number;
+    overallTestCaseSuccessRatio: number;
+    runningTestRuns: number;
+    totalTestRuns: number;
+};
+export interface StatisticQueryParams extends QueryParams {
+    forWholeAccount: boolean;
+    skipCommonProject: boolean;
+    skipShared: boolean;
+    startTime: number;
+}

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

@@ -0,0 +1,4 @@
+export declare type VatRate = {
+    valid: boolean;
+    vatRate: number;
+};