SDK Method Reference

This page lists the public method names and return types used by SDK version 1.0.1. Java methods are synchronous. Node.js service methods return promises.

Client Creation

Operation	Java	Node.js
Start builder	DeviceParkApiClient.builder()	DeviceParkApiClient.builder()
Set URL	.url(String)	.url(string) or .endpoint(string)
Set credentials	.credentials(Credentials)	.credentials(Credentials)
Set raw credentials	Credentials.of(clientId, clientSecret)	.credentialsFrom(clientId, clientSecret)
Set timeout	.timeout(Integer seconds)	.timeout(number) or .timeoutMs(number)
Build	.build()	.build()
Close	client.close()	await client.close()

Node.js additionally supports .addHeader(name, value) and .fetchImplementation(fetch) for controlled integrations and testing.

Devices

Purpose	Java signature	Node.js signature
List	PageDto<Device> list(ListDevicesRequest request)	list(request?: ListDevicesRequest): Promise<PageDto<Device>>
Get by serial	Device get(String serial)	get(serial: string): Promise<Device>
List installed apps	Not available	apps(serial: string, request?: ListDeviceAppsRequest): Promise<PageDto<DeviceApp>>

Access through client.devices().

Pools

Purpose	Java signature	Node.js signature
List	PageDto<Pool> list(ListPoolsRequest request)	list(request?: ListPoolsRequest): Promise<PageDto<Pool>>
List default pools	PageDto<Pool> listByDefaultPool(ListPoolsRequest request)	listByDefaultPool(request?: ListPoolsRequest): Promise<PageDto<Pool>>
Create	Pool create(CreatePoolRequest request)	create(request: CreatePoolRequest): Promise<Pool>
Delete	void delete(String poolId)	delete(poolId: string): Promise<void>
Add devices	List<String> addDevices(String poolId, List<String> serials)	addDevices(poolId: string, serials: string[]): Promise<string[]>
Remove devices	List<String> removeDevices(String poolId, List<String> serials)	removeDevices(poolId: string, serials: string[]): Promise<string[]>

Access through client.pools().

Allocations

Purpose	Java signature	Node.js signature
List	PageDto<Allocation> list(AllocationSearchRequest request)	list(request?: AllocationSearchRequest): Promise<PageDto<Allocation>>
Create	Allocation create(DeviceAllocationRequest request)	create(request: DeviceAllocationRequest): Promise<Allocation>
Release	void delete(String allocationId)	delete(allocationId: string): Promise<void>

Access through client.allocations(). delete releases the reservation; it does not delete a physical device.

Sessions

Purpose	Java signature	Node.js signature
List	PageDto<Session> list(DeviceSessionRequest request)	list(request?: DeviceSessionRequest): Promise<PageDto<Session>>
Start	Session start(DeviceStartSessionRequest request)	start(request: DeviceStartSessionRequest): Promise<Session>
Stop	void stop(String sessionId)	stop(sessionId: string): Promise<void>
Download Appium log	byte[] logs(String sessionId)	logs(sessionId: string): Promise<Buffer>
List recordings	PageDto<ScreenRecord> screenRecords(String sessionId, ScreenRecordPaginationRequest request)	screenRecords(sessionId: string, request?: ScreenRecordPaginationRequest): Promise<PageDto<ScreenRecord>>

Access through client.sessions().

Applications

Purpose	Java signature	Node.js signature
List	PageDto<Application> list(ApplicationPaginationRequest request)	list(request?: ApplicationPaginationRequest): Promise<PageDto<Application>>
Standard upload	Application upload(InputStream fileStream, String fileName, String version)	upload(fileStream, fileName: string, version: string): Promise<Application>
Upload with image injection	Application upload(InputStream fileStream, String fileName, String version, boolean imageInjection)	upload(fileStream, fileName: string, version: string, imageInjection?: boolean): Promise<Application>
Delete	void delete(String fileKey)	delete(fileKey: string): Promise<void>

Access through client.applications(). Node.js accepts a Node.js ReadableStream or Web ReadableStream for fileStream.

imageInjection defaults to false. When enabled, Device Park applies the configured gadget injection during upload processing.

Request Builders

Builder	Key methods
ListDevicesRequestBuilder / ListDevicesRequest.Builder	page, size, sortBy, direction, addFilter, filters, build
ListDeviceAppsRequestBuilder / Java equivalent	Node.js: page, size, sortBy, direction, addFilter, filters, build; Java: not available
ListPoolsRequestBuilder / ListPoolsRequest.Builder	page, size, sortBy, direction, addFilter, filters, build
CreatePoolRequestBuilder / CreatePoolRequest.Builder	Required name; build
AllocationSearchRequestBuilder / AllocationSearchRequest.Builder	page, size, sortBy, direction, addFilter, filters, build
DeviceAllocationRequestBuilder / DeviceAllocationRequest.Builder	serial, manufacturer, model, platform, platformVersion, devicePoolId, priority, removeApps, build
DeviceSessionRequestBuilder / DeviceSessionRequest.Builder	page, size, sortBy, direction, addFilter, filters, build
DeviceStartSessionRequestBuilder / DeviceStartSessionRequest.Builder	Required allocationId, userId, userEmail, companyId, companyName; optional companyPoolId, videoRecording, customVideoRecordingPath, appiumVersion; build
ScreenRecordPaginationRequestBuilder / ScreenRecordPaginationRequest.Builder	page, size, sortBy, direction, addFilter, filters, build
ApplicationPaginationRequestBuilder / ApplicationPaginationRequest.Builder	page, size, sortBy, direction, addFilter, filters, build

Node.js builder classes are created with new. Java builders are created with the model's static builder() method.

The Java and Node.js SDKs transmit filters for device, pool, application, allocation, session and screen-record lists. Node.js additionally supports Device Apps filters. listByDefaultPool(...) applies the default-pool filter automatically. See Pagination and Filtering.