@bitbar/cloud-api-client 0.55.0 → 1.0.0

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

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,11 @@
+export declare enum SharedResourceType {
+    DEVICE_GROUP = "DEVICE_GROUP",
+    FILE = "FILE",
+    PROJECT = "PROJECT"
+}
+export declare type SharedResource = {
+    id: number;
+    name: string;
+    resourceId: number;
+    type: SharedResourceType;
+};

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