@bitbar/cloud-api-client 0.56.0 → 1.0.2

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

@@ -0,0 +1,34 @@
+import { QueryParams } from './HTTP';
+export declare enum NotificationChannel {
+    SLACK = "SLACK",
+    EMAIL = "EMAIL",
+    WEBHOOK = "WEBHOOK"
+}
+export declare enum NotificationScope {
+    ALL = "ALL",
+    TEST_RUN = "TEST_RUN",
+    TEST_RUN_FAILURE = "TEST_RUN_FAILURE",
+    TEST_RUN_SUCCEEDED = "TEST_RUN_SUCCEEDED",
+    MAINTENANCE = "MAINTENANCE",
+    MAINTENANCE_RELEASE = "MAINTENANCE_RELEASE",
+    CUSTOM = "CUSTOM",
+    NEWS = "NEWS",
+    SYSTEM = "SYSTEM",
+    CHECK = "CHECK",
+    PLAN_LIMIT_REACHED = "PLAN_LIMIT_REACHED",
+    PLAN_INVOICE = "PLAN_INVOICE"
+}
+export declare type Notification = {
+    channel: NotificationChannel;
+    destination: string;
+    id: number;
+    projectId?: number;
+    projectName?: string;
+    scope: NotificationScope;
+    userEmail: string;
+    userId: number;
+};
+export interface NotificationData extends QueryParams {
+    scope: NotificationScope;
+}
+export declare type NotificationsData = Pick<Notification, 'channel' | 'destination' | 'projectId' | 'scope'>;

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

@@ -0,0 +1,20 @@
+import { NotificationChannel, NotificationScope } from './Notification';
+export declare type NotificationPlan = {
+    channel: NotificationChannel;
+    contentTemplate: string;
+    createTime: number;
+    handlerEmail: string;
+    handlerId: number;
+    id: number;
+    name: string;
+    scope: NotificationScope;
+    sentTime: number;
+    subjectTemplate: string;
+    updateTime: number;
+};
+export declare type NotificationPlanData = Pick<NotificationPlan, 'channel' | 'name'> & {
+    notificationContent: string;
+    notificationSubject: string;
+    scope: NotificationScope;
+};
+export declare type NotificationPlanEditData = Omit<NotificationPlanData, 'channel'>;

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

@@ -0,0 +1,31 @@
+import { OsType } from './Enum';
+import { TestRunsQueryParams } from './TestRun';
+export declare enum ArchivingStrategy {
+    NEVER = "NEVER",
+    DAYS = "DAYS",
+    RUNS = "RUNS"
+}
+export declare type Project = {
+    archiveTime: number;
+    archivingItemCount: number;
+    archivingStrategy: ArchivingStrategy;
+    common: boolean;
+    createTime: number;
+    description: string;
+    id: number;
+    name: string;
+    osType: OsType;
+    readOnly: boolean;
+    rowIndex: number;
+    shared: boolean;
+    sharedByEmail: string;
+    sharedById: number;
+    sharedWithCaller: boolean;
+    successRatio: number;
+    userEmail: string;
+    userId: number;
+};
+export declare type UserProjectData = Pick<Project, 'name'>;
+export interface UserProjectQueryParams extends TestRunsQueryParams {
+    showStatistics: boolean;
+}

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

@@ -0,0 +1,9 @@
+export declare type ProjectJobConfig = {
+    content: string;
+    frameworkId: number;
+    global: boolean;
+    id: number;
+    lastModificationTime: number;
+    lastModifiedBy: string;
+    version: number;
+};

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

@@ -0,0 +1,17 @@
+import { CollectionQueryParams } from './HTTP';
+export declare type Property = {
+    description: string;
+    fromTime: number;
+    id: number;
+    name: string;
+    toTime: number;
+    updateTime: number;
+    updatedByDisplayName: string;
+    updatedById: number;
+    value: string;
+};
+export declare type PropertyData = Pick<Property, 'description' | 'fromTime' | 'name' | 'toTime' | 'value'>;
+export interface AppBansQueryParams extends CollectionQueryParams {
+    testRunId: number;
+}
+export declare type AppBansData = AppBansQueryParams;

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

@@ -0,0 +1,15 @@
+import { CollectionQueryParams } from './HTTP';
+export declare type Role = {
+    addedByEmail: string;
+    expireTime: number;
+    id: number;
+    name: string;
+    value: number;
+    valueCalculated: boolean;
+};
+export interface RoleParams extends CollectionQueryParams {
+    withoutPriorities: boolean;
+}
+export declare type RoleData = Pick<Role, 'expireTime' | 'value'> & {
+    roleId: number;
+};

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

@@ -0,0 +1,22 @@
+import { Device } from './Device';
+import { CollectionBasicQueryParams } from './HTTP';
+export declare enum ScreenshotType {
+    LANDSCAPE = "LANDSCAPE",
+    PORTRAIT = "PORTRAIT"
+}
+export declare type Screenshot = {
+    fail: boolean;
+    id: number;
+    originalName: string;
+    takeTimestamp: number;
+    type: ScreenshotType;
+};
+export declare type ScreenshotExtended = Screenshot & {
+    device: Device;
+    deviceRunId: number;
+    projectId: number;
+    testRunId: number;
+};
+export interface ScreenshotQueryParams extends CollectionBasicQueryParams {
+    name: string;
+}

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

@@ -0,0 +1,61 @@
+import { ChargeType, PaymentMethod } from './AccountService';
+import { CollectionQueryParams } from './HTTP';
+import { Role } from './Role';
+export declare type Service = {
+    activateTime: number;
+    activated: boolean;
+    archiveTime: number;
+    autoRenew: boolean;
+    centPrice: number;
+    chargeType: ChargeType;
+    commonId: string;
+    customPlan: boolean;
+    defaultConcurrences: Array<number>;
+    description: string;
+    externalId: string;
+    features: string;
+    id: number;
+    includedHours: number;
+    name: string;
+    pricePerHour: number;
+    priceString: string;
+    roles: Array<Role>;
+    unit: ServiceUnit;
+};
+export declare enum ServiceUnit {
+    DAY = "DAY",
+    HOUR = "HOUR",
+    MONTH = "MONTH",
+    PROJECT = "PROJECT",
+    RUN = "RUN",
+    YEAR = "YEAR"
+}
+export interface AdminServicesParams extends CollectionQueryParams {
+    activeOnly: boolean;
+    inUse: boolean;
+    notArchive: boolean;
+}
+export declare type ServiceActivateData = {
+    activateTime: number;
+};
+export interface ServiceData {
+    address?: string;
+    braintreeNonce?: string;
+    cardNumber?: string;
+    city?: string;
+    count?: number;
+    country?: string;
+    cvv?: string;
+    email?: string;
+    expirationDate?: string;
+    firstName?: string;
+    lastName?: string;
+    organization?: string;
+    paymentMethod: PaymentMethod;
+    phone?: string;
+    serviceId: number;
+    state?: string;
+    stripeToken?: string;
+    vatId?: string;
+    zip?: string;
+}

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

@@ -0,0 +1,6 @@
+export declare type SimpleSetting = Record<string, string | number | boolean>;
+export declare type NestedSetting = Record<string, SimpleSetting>;
+export declare type Settings = SimpleSetting | NestedSetting | Record<string, NestedSetting>;
+export declare type SettingsParams = {
+    withVulnerableData: boolean;
+};

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

@@ -0,0 +1,16 @@
+import { QueryParams } from './HTTP';
+export declare enum SharedResourceType {
+    DEVICE_GROUP = "DEVICE_GROUP",
+    FILE = "FILE",
+    PROJECT = "PROJECT"
+}
+export declare type SharedResource = {
+    id: number;
+    name: string;
+    resourceId: number;
+    type: SharedResourceType;
+};
+export interface ShareData extends QueryParams {
+    accessGroupId: number;
+    email: string;
+}

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

@@ -0,0 +1,20 @@
+import { CollectionQueryParams } from './HTTP';
+export declare type SmartbearTunnel = {
+    acceptAllCerts: boolean;
+    active: boolean;
+    bypassPublicHosts: boolean;
+    createdAt: number;
+    domain: string;
+    externalId: string;
+    id: number;
+    proxyIp: string;
+    proxyPort: string;
+    state: string;
+    staticServerDirectory: string;
+    tunnelSource: string;
+    tunnelType: string;
+    user: string;
+};
+export interface TunnelQueryParams extends CollectionQueryParams {
+    active: boolean;
+}

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

@@ -0,0 +1,16 @@
+import { CollectionBasicQueryParams, QueryParams } from './HTTP';
+export declare type Tag = {
+    id: number;
+    name: string;
+};
+export interface TestRunTagsData {
+    projectId: number;
+    name: string;
+}
+export declare type TagsData = Pick<TestRunTagsData, 'name'>;
+export interface TagsQueryParams extends CollectionBasicQueryParams {
+    projectId: number;
+}
+export interface TaqQueryParams extends QueryParams {
+    projectId: number;
+}

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

@@ -0,0 +1,40 @@
+import { CollectionResponse } from './HTTP';
+export declare enum TestResult {
+    PASSED = "PASSED",
+    FAILED = "FAILED",
+    SKIPPED = "SKIPPED",
+    NOT_AVAILABLE = "NOT_AVAILABLE"
+}
+export declare enum TestStepType {
+    ASSERTION = "ASSERTION",
+    CLICK = "CLICK",
+    CONFIG = "CONFIG",
+    DRAG = "DRAG",
+    INPUT = "INPUT",
+    NAVIGATION = "NAVIGATION",
+    OTHER = "OTHER",
+    SCROLL = "SCROLL",
+    UTIL = "UTIL",
+    WAIT = "WAIT"
+}
+export declare type TestCaseRun = {
+    className: string;
+    createTime: number;
+    duration: number;
+    errorMessage: string;
+    id: number;
+    methodName: string;
+    result: TestResult;
+    stacktrace: string;
+    steps: CollectionResponse<TestCaseRunStep>;
+    suiteName: string;
+};
+export declare type TestCaseRunStep = {
+    description: string;
+    duration: number;
+    errorMessage: string;
+    fromActivity: string;
+    id: number;
+    screenshots: any;
+    type: TestStepType;
+};

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