@bitbar/cloud-api-client 0.56.0 → 1.0.0

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

@@ -1,7 +1,8 @@
-import APIResource from '../APIResource';
-import DeviceSessionCommon from './DeviceSessionCommon';
-interface DeviceSession extends DeviceSessionCommon {
-    abort(): APIResource;
-    retry(): APIResource;
+import { APIResource } from '../APIResource';
+import { DeviceSessionCommon } from './DeviceSessionCommon';
+import { DeviceSession as DeviceSessionDTO } from '../models/DeviceSession';
+export interface DeviceSession extends DeviceSessionCommon {
+    abort(): APIResource<DeviceSessionDTO>;
+    retry(): APIResource<DeviceSessionDTO>;
 }
 export default DeviceSession;

package/dist/api/interface/DeviceSessionBase.d.ts

@@ -1,7 +1,7 @@
-import APIResource from '../APIResource';
-import InputFileset from '../class/InputFileset';
-import OutputFileset from '../class/OutputFileset';
-interface DeviceSessionBase extends APIResource {
+import { APIResource } from '../APIResource';
+import { InputFileset } from '../class/InputFileset';
+import { OutputFileset } from '../class/OutputFileset';
+export interface DeviceSessionBase extends APIResource {
     input(): InputFileset;
     output(): OutputFileset;
 }

package/dist/api/interface/DeviceSessionCommon.d.ts

@@ -1,13 +1,17 @@
-import APIList from '../APIList';
-import APIResource from '../APIResource';
-import DeviceSessionBase from './DeviceSessionBase';
-interface DeviceSessionCommon extends DeviceSessionBase {
-    commands(): APIList;
-    screenshots(): APIList;
-    screenshot(id: number): APIResource;
-    steps(): APIList;
-    step(id: number | 'current'): APIResource;
-    currentStep(): APIResource;
-    testCaseRuns(): APIList;
+import { APIList } from '../APIList';
+import { APIResource } from '../APIResource';
+import { DeviceSessionCommand, DeviceSessionStep, SessionQueryParams } from '../models/DeviceSession';
+import { NoData, NoQueryParams } from '../models/HTTP';
+import { Screenshot } from '../models/Screenshot';
+import { TestCaseRun } from '../models/TestCaseRun';
+import { DeviceSessionBase } from './DeviceSessionBase';
+export interface DeviceSessionCommon extends DeviceSessionBase {
+    commands(): APIList<DeviceSessionCommand>;
+    screenshots(): APIList<Screenshot>;
+    screenshot(id: number): APIResource<Screenshot>;
+    steps(): APIList<DeviceSessionStep>;
+    step(id: number | 'current'): APIResource<DeviceSessionStep, NoQueryParams, NoData>;
+    currentStep(): APIResource<DeviceSessionStep, NoQueryParams, NoData>;
+    testCaseRuns(): APIList<TestCaseRun, SessionQueryParams | NoQueryParams, NoData>;
 }
 export default DeviceSessionCommon;

package/dist/api/interface/DeviceSessionStandalone.d.ts

@@ -1,9 +1,11 @@
-import APIList from '../APIList';
-import APIResource from '../APIResource';
-import DeviceSessionBase from './DeviceSessionBase';
-interface DeviceSessionStandalone extends DeviceSessionBase {
-    connections(): APIList;
-    connection(id: number): APIResource;
-    release(): APIResource;
+import { APIList } from '../APIList';
+import { APIResource } from '../APIResource';
+import { DeviceSession, DeviceSessionConnection } from '../models/DeviceSession';
+import { NoData, NoQueryParams } from '../models/HTTP';
+import { DeviceSessionBase } from './DeviceSessionBase';
+export interface DeviceSessionStandalone extends DeviceSessionBase {
+    connections(): APIList<DeviceSessionConnection>;
+    connection(id: number): APIResource<DeviceSessionConnection, NoQueryParams, NoData>;
+    release(): APIResource<DeviceSession, NoQueryParams, NoData>;
 }
 export default DeviceSessionStandalone;

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

@@ -0,0 +1,14 @@
+export declare enum AccessGroupScope {
+    USER = "USER",
+    ACCOUNT = "ACCOUNT",
+    GLOBAL = "GLOBAL"
+}
+export declare type AccessGroup = {
+    id: number;
+    name: string;
+    scope: AccessGroupScope;
+    userEmail: string;
+    userId: number;
+};
+export declare type AccessGroupData = Pick<AccessGroup, 'name' | 'scope' | 'userId'>;
+export declare type AccessGroupsData = Omit<AccessGroupData, 'userId'>;

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

@@ -0,0 +1,7 @@
+export declare type Account = {
+    createTime: number;
+    id: number;
+    mainUserEmail: string;
+    mainUserFirstName: string;
+    mainUserLastName: string;
+};

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

@@ -0,0 +1,4 @@
+export declare type AccountConcurrencyStatusMap = {
+    id: number;
+    mainUserEmail: string;
+};

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

@@ -0,0 +1,4 @@
+export declare type AccountPreferences = {
+    allowedFileExtensions: Array<string>;
+    id: number;
+};

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

@@ -0,0 +1,66 @@
+import { ServiceUnit } from './Service';
+export declare enum PaymentStatus {
+    SUCCEEDED = "SUCCEEDED",
+    FAILED = "FAILED",
+    REDIRECTED = "REDIRECTED"
+}
+export declare enum PaymentMethod {
+    PAYPAL = "PAYPAL",
+    BRAINTREE = "BRAINTREE",
+    STRIPE = "STRIPE",
+    INVOICE = "INVOICE",
+    PROMOTION = "PROMOTION",
+    AWS = "AWS"
+}
+export declare enum ChargeType {
+    USAGE_MOBILE = "USAGE_MOBILE",
+    CONCURRENCY_MOBILE = "CONCURRENCY_MOBILE",
+    CONCURRENCY_DESKTOP = "CONCURRENCY_DESKTOP"
+}
+export declare enum DeactivateReason {
+    INITIAL_FAILURE = "INITIAL_FAILURE",
+    SCA_FAILURE = "SCA_FAILURE",
+    CHARGE_FAILURE = "CHARGE_FAILURE",
+    CANCEL = "CANCEL",
+    SUSPENDED = "SUSPENDED",
+    ANOTHER_PURCHASE = "ANOTHER_PURCHASE"
+}
+export declare type ServicePaymentStatus = {
+    accountService: AccountService;
+    message: string;
+    redirectUrl: string;
+    status: PaymentStatus;
+};
+export declare type AccountService = {
+    accountId: number;
+    activatedById: number;
+    activatedByName: string;
+    active: boolean;
+    autoRenew: boolean;
+    braintreeId: string;
+    chargeType: ChargeType;
+    createTime: number;
+    deactivateReason: DeactivateReason;
+    deactivatedById: number;
+    deactivatedByName: string;
+    endTime: number;
+    finished: boolean;
+    id: number;
+    lastPaymentTime: number;
+    paymentMethod: PaymentMethod;
+    price: number;
+    serviceCount: number;
+    serviceId: number;
+    serviceName: string;
+    startTime: number;
+    subscriptionManagementURL: string;
+    total: number;
+    unit: ServiceUnit;
+    unitCount: number;
+    userEmail: string;
+    userId: number;
+    vatRate: number;
+};
+export declare type AccountServiceData = Pick<AccountService, 'endTime' | 'serviceId'> & {
+    count: number;
+};

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

@@ -0,0 +1,11 @@
+export declare type AccountServicePayment = {
+    accountId: number;
+    additionalTime: number;
+    endBillingPeriod: number;
+    id: number;
+    includedTime: number;
+    name: string;
+    startBillingPeriod: number;
+    totalPrice: number;
+    usedTime: number;
+};

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

@@ -0,0 +1,13 @@
+import { Method } from 'axios';
+export declare type Activity = {
+    body: string;
+    createTime: number;
+    deprecatedResource: boolean;
+    httpMethod: Uppercase<Method>;
+    id: number;
+    parameters: string;
+    uri: string;
+    userAgent: string;
+    userEmail: string;
+    userId: number;
+};

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

@@ -0,0 +1,50 @@
+import { DevicesQueryParams, Platform, SoftwareVersion } from './Device';
+import { OsType } from './Enum';
+import { CollectionQueryParams } from './HTTP';
+export declare enum InitStep {
+    SKIP = "SKIP",
+    REBOOT = "REBOOT",
+    REBOOT_WITH_UNLOCK = "REBOOT_WITH_UNLOCK",
+    UNLOCK_ONLY = "UNLOCK_ONLY"
+}
+export declare enum DeviceState {
+    OFFLINE_CLEANING = "OFFLINE_CLEANING",
+    OFFLINE_DIRTY = "OFFLINE_DIRTY",
+    OFFLINE_FREE = "OFFLINE_FREE",
+    OFFLINE_TESTING = "OFFLINE_TESTING",
+    ONLINE_CLEANING = "ONLINE_CLEANING",
+    ONLINE_DIRTY = "ONLINE_DIRTY",
+    ONLINE_FREE = "ONLINE_FREE",
+    ONLINE_TESTING = "ONLINE_TESTING"
+}
+export declare type AdminDevice = {
+    accountId: number;
+    cluster: unknown;
+    deviceModelId: number;
+    deviceModelName: string;
+    enabled: boolean;
+    fingerprint: string;
+    id: number;
+    initStep: InitStep;
+    ipAddress: string;
+    lastOnlineTime: number;
+    location: string;
+    locked: boolean;
+    mainUserEmail: string;
+    manufacturer: string;
+    name: string;
+    osType: OsType;
+    platform: Platform;
+    serialId: string;
+    softwareVersion: SoftwareVersion;
+    state: DeviceState;
+    stateChangeTime: number;
+    stateTime: number;
+    testTimeLimit: number;
+    unlockGesture: string;
+};
+export declare type AdminDevicesQueryParams = Pick<DevicesQueryParams, 'withDisabled'> & CollectionQueryParams;
+export declare type AdminDeviceData = Pick<AdminDevice, 'accountId' | 'enabled' | 'initStep' | 'ipAddress' | 'name' | 'serialId' | 'testTimeLimit' | 'unlockGesture'> & {
+    apiLevel: number;
+    releaseVersion: string;
+};

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

@@ -0,0 +1,36 @@
+import { DeviceSessionState, DeviceSessionStepType } from './DeviceSession';
+export declare type AdminDeviceSession = {
+    billable: boolean;
+    createTime: number;
+    currentStepType: DeviceSessionStepType;
+    deviceTime: number;
+    endTime: number;
+    errorMessage: string;
+    id: number;
+    priority: number;
+    projectId: number;
+    projectName: string;
+    retriedFailReason: string;
+    startTime: number;
+    startedByDisplayName: string;
+    state: DeviceSessionState;
+    testRunId: number;
+    testRunName: string;
+};
+export declare type AdminInteractiveDeviceSession = {
+    billable: boolean;
+    createTime: number;
+    deviceId: number;
+    deviceModelId: number;
+    deviceModelName: string;
+    deviceName: string;
+    deviceTime: number;
+    duration: number;
+    endTime: number;
+    errorMessage: string;
+    id: number;
+    startTime: number;
+    state: DeviceSessionState;
+    userEmail: string;
+    userId: number;
+};

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

@@ -0,0 +1,22 @@
+import { CollectionQueryParams } from './HTTP';
+export declare type AdminDeviceSessionStatistics = {
+    abortedDeviceCount: number;
+    avgDeviceSessionDeviceTime: number;
+    avgDeviceSessionDuration: number;
+    avgDeviceSessionSuccessRatio: number;
+    errorsDeviceCount: number;
+    excludedDeviceCount: number;
+    finishedDeviceCount: number;
+    id: number;
+    maxDeviceSessionDuration: number;
+    minDeviceSessionDuration: number;
+    runningDeviceCount: number;
+    succeededDeviceCount: number;
+    timeoutedDeviceCount: number;
+    totalDeviceCount: number;
+    waitingDeviceCount: number;
+    warningDeviceCount: number;
+};
+export interface AdminStatisticsParams extends CollectionQueryParams {
+    days: number;
+}

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

@@ -0,0 +1,12 @@
+export declare type AdminDeviceType = {
+    frameExtraWidth: number;
+    id: number;
+    imageHeight: number;
+    imageLeft: number;
+    imagePrefix: string;
+    imageTop: number;
+    imageWidth: number;
+};
+export declare type DeviceTypeData = Omit<AdminDeviceType, 'id'> & {
+    deviceTypeId: number;
+};

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