Class APIResourceRun

root

first

• get first(): string | number

• Get first element of the stack

  Returns string | number

last

• get last(): string | number

• Get last element of the stack

  Returns string | number
• set last(val: string | number): void

• Set last element of the stack

  Parameters

  • val: string | number

  Returns void

abort

• abort(): APIResource<TestRun | AdminTestRun, NoQueryParams, RunData>

• Returns APIResource<TestRun | AdminTestRun, NoQueryParams, RunData>

abortRequest

• abortRequest(): void

• Returns void

buildLogsZip

• buildLogsZip(
      ids?: number[],
  ): APIResource<UserFile, BuildLogsData, BuildLogsData>

• Parameters

  • Optionalids: number[]

  Returns APIResource<UserFile, BuildLogsData, BuildLogsData>

data

• data(data: TestRunData | RunData): this

• Set data

  Parameters

  • data: TestRunData | RunData

  Returns this

dataAvailability

• dataAvailability(): APIResource<
      TestRunDataAvailability,
      TestRunDataAvailabilityQueryParams,
      void,
  >

• Returns APIResource<TestRunDataAvailability, TestRunDataAvailabilityQueryParams, void>

delete

• delete(): this

• Set DELETE as HTTP method

  Returns this

deviceSessions

• deviceSessions(): APIList<
      DeviceSession,
      CollectionBasicQueryParams
      | TRunDeviceSessionQueryParams,
      void,
  >

• Returns APIList<
      DeviceSession,
      CollectionBasicQueryParams
      | TRunDeviceSessionQueryParams,
      void,
  >

filesZip

• filesZip(ids?: number[]): APIResource<UserFile, BuildLogsData, BuildLogsData>

• Parameters

  • Optionalids: number[]

  Returns APIResource<UserFile, BuildLogsData, BuildLogsData>

formData

• formData(data: TestRunData | RunData): this

• Set form data

  Parameters

  • data: TestRunData | RunData

  Returns this

get

• get(): this

• Set GET as HTTP method

  Returns this

getParams

• getParams(): Partial<RunQueryParam>

• Returns Partial<RunQueryParam>

headers

• headers(headers: Record<string, string>): this

• Parameters

  • headers: Record<string, string>

  Returns this

jsonData

• jsonData(data: TestRunData | RunData): this

• Set JSON data

  Parameters

  • data: TestRunData | RunData

  Returns this

logsZip

• logsZip(ids?: number[]): APIResource<UserFile, BuildLogsData, BuildLogsData>

• Parameters

  • Optionalids: number[]

  Returns APIResource<UserFile, BuildLogsData, BuildLogsData>

method

• method(name: Method): this

• Set HTTP method

  Parameters

  • name: Method

  Returns this

params

• params<T extends keyof RunQueryParam = keyof RunQueryParam>(
      params: Pick<RunQueryParam, T>,
  ): this

• Set params

  Type Parameters

  • T extends keyof RunQueryParam = keyof RunQueryParam

  Parameters

  • params: Pick<RunQueryParam, T>

  Returns this

performanceZip

• performanceZip(
      ids?: number[],
  ): APIResource<UserFile, BuildLogsData, BuildLogsData>

• Parameters

  • Optionalids: number[]

  Returns APIResource<UserFile, BuildLogsData, BuildLogsData>

post

• post(): this

• Set POST as HTTP method

  Returns this

push

• push(...items: (string | number)[]): this

• Parameters

  • ...items: (string | number)[]

  Returns this

removeParam

• removeParam(key: keyof RunQueryParam): this

• Parameters

  • key: keyof RunQueryParam

  Returns this

removeRequestConfig

• removeRequestConfig(key: keyof AxiosRequestConfig): this

• Parameters

  • key: keyof AxiosRequestConfig

  Returns this

restack

• restack(...items: (string | number)[]): this

• Parameters

  • ...items: (string | number)[]

  Returns this

retry

• retry(ids?: number[]): APIResource<TestRun, BuildLogsData, BuildLogsData>

• Parameters

  • Optionalids: number[]

  Returns APIResource<TestRun, BuildLogsData, BuildLogsData>

screenshotNames

• screenshotNames(): APIList<Screenshot, NoQueryParams, void>

• Returns APIList<Screenshot, NoQueryParams, void>

screenshots

• screenshots(): APIList<ScreenshotExtended, ScreenshotQueryParams, void>

• Returns APIList<ScreenshotExtended, ScreenshotQueryParams, void>

screenshotsZip

• screenshotsZip(
      ids?: number[],
  ): APIResource<UserFile, BuildLogsData, BuildLogsData>

• Parameters

  • Optionalids: number[]

  Returns APIResource<UserFile, BuildLogsData, BuildLogsData>

send

• send<T = TestRun>(): Promise<AxiosResponse<T>>

• Send request

  Type Parameters

  • T = TestRun

  Returns Promise<AxiosResponse<T>>

setRequestConfig

• setRequestConfig(requestConfig: AxiosRequestConfig): this

• Parameters

  • requestConfig: AxiosRequestConfig

  Returns this

shift

• shift(): this

• Returns this

steps

• steps(): APIList<DeviceSessionStep, CollectionBasicQueryParams, void>

• Returns APIList<DeviceSessionStep, CollectionBasicQueryParams, void>

tag

• tag(id: number): APIResource<Tag, TaqQueryParams, void>

• Parameters

  • id: number

  Returns APIResource<Tag, TaqQueryParams, void>

tags

• tags(): APIList<
      Tag,
      CollectionBasicQueryParams
      | TagsQueryParams,
      TestRunTagsData | TagsData,
  >

• Returns APIList<
      Tag,
      CollectionBasicQueryParams
      | TagsQueryParams,
      TestRunTagsData | TagsData,
  >

toUrl

• toUrl(absolute?: boolean): string

• Parameters

  • absolute: boolean = false

  Returns string