@devicecloud.dev/dcd
Version:
Better cloud maestro testing
670 lines (669 loc) • 19.3 kB
TypeScript
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/admin/cleanupOldUploads": {
post: operations["AdminController_cleanupOldUploads"];
};
"/frontend/check-domain-saml": {
post: operations["FrontendController_checkDomainSaml"];
};
"/health": {
get: operations["HealthController_health"];
};
"/moropo/run-scheduled-jobs": {
get: operations["MoropoController_runScheduledJobs"];
};
"/org/accept-invite": {
post: operations["OrgController_acceptInvite"];
};
"/org/increase_credits": {
post: operations["OrgController_paddleTransactionCompleted"];
};
"/org/invite-team-member": {
post: operations["OrgController_inviteTeamMember"];
};
"/org/update-name": {
post: operations["OrgController_updateOrgName"];
};
"/public/stats": {
get: operations["StatsController_getPublicStats"];
};
"/public/stats/report-slow-tests-dev": {
post: operations["StatsController_reportSlowTestsDev"];
};
"/public/stats/report-slow-tests-prod": {
post: operations["StatsController_reportSlowTestsProd"];
};
"/public/stats/send-daily-report": {
post: operations["StatsController_sendDailyReport"];
};
"/results": {
post: operations["ResultsController_createResult"];
};
"/results/{uploadId}": {
get: operations["ResultsController_getResults"];
};
"/results/{uploadId}/download": {
post: operations["ResultsController_getTestRunArtifacts"];
};
"/results/compatibility/data": {
get: operations["ResultsController_getCompatibilityData"];
};
"/results/notify/{uploadId}": {
post: operations["ResultsController_notifyTestRunComplete"];
};
"/uploads/{uploadId}": {
delete: operations["UploadsController_deleteUpload"];
};
"/uploads/binary": {
post: operations["UploadsController_createBinary"];
};
"/uploads/cancelTest": {
post: operations["UploadsController_cancelTest"];
};
"/uploads/checkForExistingUpload": {
post: operations["UploadsController_checkForExistingUpload"];
};
"/uploads/finaliseUpload": {
post: operations["UploadsController_finaliseUpload"];
};
"/uploads/flow": {
post: operations["UploadsController_createTest"];
};
"/uploads/getBinaryUploadUrl": {
post: operations["UploadsController_getBinaryUploadUrl"];
};
"/uploads/retryTest": {
post: operations["UploadsController_retryTest"];
};
"/uploads/status": {
get: operations["UploadsController_getUploadStatus"];
};
}
export type webhooks = Record<string, never>;
export interface components {
headers: never;
parameters: never;
pathItems: never;
requestBodies: never;
responses: never;
schemas: {
ICancelTestArgs: {
resultId: number;
};
ICheckForExistingUploadArgs: {
sha: string;
};
ICheckForExistingUploadResponse: {
appBinaryId: string;
exists: boolean;
};
ICreateBinaryResponse: {
binaryId: string;
message: string;
};
ICreateBinaryUploadArgs: {
/**
* Format: binary
* @description This file must either be an apk or a zip file
*/
file: string;
};
ICreateTestUploadArgs: {
/** @enum {string} */
androidApiLevel?: "29" | "30" | "31" | "32" | "33" | "34" | "35";
/** @enum {string} */
androidDevice?: "generic-tablet" | "pixel-6" | "pixel-6-pro" | "pixel-7" | "pixel-7-pro";
apiKey: string;
apiUrl: string;
appBinaryId: string;
appFile: string;
config: string;
env: string;
/**
* Format: binary
* @description This file must be a zip file
*/
file: string;
flowMetadata?: string;
googlePlay: boolean;
/** @enum {string} */
iOSDevice?: "ipad-pro-6th-gen" | "iphone-14" | "iphone-14-pro" | "iphone-15" | "iphone-15-pro" | "iphone-16" | "iphone-16-plus" | "iphone-16-pro" | "iphone-16-pro-max";
/** @enum {string} */
iOSVersion?: "16" | "17" | "18";
metadata?: string;
name: string;
platform?: string;
runnerType?: Record<string, never>;
sequentialFlows?: string;
testFileNames?: string;
workspaceConfig?: string;
};
IDBResult: {
binary_upload_id: string;
cost: null | number;
created_at: string;
env: Record<string, never>;
id: number;
org_id: number;
platform: string;
simulator_name: string;
status: string;
test_file_name: string;
test_upload_id: string;
};
IFinaliseUploadArgs: {
id: string;
metadata: Record<string, never>;
path: string;
sha: string;
};
IFinaliseUploadResponse: Record<string, never>;
IGetBinaryUploadUrlArgs: {
platform: Record<string, never>;
};
IGetBinaryUploadUrlResponse: {
id: string;
message: string;
path: string;
token: string;
};
IRetryTestArgs: {
resultId: number;
};
TResultResponse: {
duration_seconds?: number;
fail_reason?: string;
id: number;
retry_of?: number;
status: string;
test_file_name: string;
};
};
}
export type $defs = Record<string, never>;
export type external = Record<string, never>;
export interface operations {
AdminController_cleanupOldUploads: {
parameters: {
query?: {
/** @description If true, shows what would be deleted without actually deleting */
dryRun?: boolean;
};
};
responses: {
/** @description Cleanup of old uploads has been triggered. */
201: {
content: {
"application/json": {
deletedCount?: number;
dryRun?: boolean;
message?: string;
uploads?: ({
createdAt?: string;
id?: string;
lastUsedDate?: null | string;
uploadType?: string;
})[];
};
};
};
};
};
FrontendController_checkDomainSaml: {
/** @description Domain to check for SAML configuration */
requestBody: {
content: {
"application/json": {
/** @example example.com */
domain: string;
};
};
};
responses: {
/** @description SAML status for the domain */
200: {
content: {
"application/json": {
forceSaml?: boolean;
};
};
};
201: {
content: never;
};
/** @description Bad request - invalid domain or API error */
400: {
content: {
"application/json": {
error?: string;
};
};
};
};
};
HealthController_health: {
responses: {
/** @description Health check endpoint */
200: {
content: {
"application/json": {
/** @example ok */
status?: string;
};
};
};
};
};
MoropoController_runScheduledJobs: {
responses: {
200: {
content: never;
};
};
};
OrgController_acceptInvite: {
parameters: {
header: {
"x-app-api-key": string;
};
};
requestBody: {
content: {
"application/json": {
orgId: string;
};
};
};
responses: {
/** @description Team invite accepted successfully. */
201: {
content: {
"application/json": boolean;
};
};
};
};
OrgController_inviteTeamMember: {
parameters: {
header: {
"x-app-api-key": string;
};
};
requestBody: {
content: {
"application/json": {
inviteEmail: string;
link: string;
orgId: string;
orgName: string;
requesterEmail: string;
};
};
};
responses: {
/** @description Team member invited successfully. */
201: {
content: {
"application/json": boolean;
};
};
};
};
OrgController_paddleTransactionCompleted: {
parameters: {
header: {
"paddle-signature": string;
};
};
responses: {
/** @description Success. */
201: {
content: {
"application/json": string;
};
};
};
};
OrgController_updateOrgName: {
parameters: {
header: {
"x-app-api-key": string;
};
};
requestBody: {
content: {
"application/json": {
name: string;
orgId: string;
};
};
};
responses: {
/** @description Organization name updated successfully. */
201: {
content: {
"application/json": boolean;
};
};
};
};
ResultsController_createResult: {
parameters: {
header: {
"x-app-api-key": string;
};
};
responses: {
201: {
content: never;
};
};
};
ResultsController_getCompatibilityData: {
parameters: {
header: {
"x-app-api-key": string;
};
};
responses: {
/** @description Device compatibility lookup data */
200: {
content: {
"application/json": {
data?: {
android?: Record<string, never>;
androidPlay?: Record<string, never>;
ios?: Record<string, never>;
};
statusCode?: number;
};
};
};
};
};
ResultsController_getResults: {
parameters: {
header: {
"x-app-api-key": string;
};
path: {
uploadId: string;
};
};
responses: {
/** @description The record has been successfully created. */
200: {
content: {
"application/json": {
results?: components["schemas"]["TResultResponse"][];
statusCode?: number;
};
};
};
};
};
ResultsController_getTestRunArtifacts: {
parameters: {
header: {
"x-app-api-key": string;
};
path: {
uploadId: string;
};
};
responses: {
201: {
content: never;
};
};
};
ResultsController_notifyTestRunComplete: {
parameters: {
header: {
"x-app-api-key": string;
};
path: {
uploadId: string;
};
};
responses: {
/** @description Send results summary email. */
201: {
content: {
"application/json": string;
};
};
};
};
StatsController_getPublicStats: {
responses: {
200: {
content: never;
};
};
};
StatsController_reportSlowTestsDev: {
responses: {
201: {
content: never;
};
};
};
StatsController_reportSlowTestsProd: {
responses: {
201: {
content: never;
};
};
};
StatsController_sendDailyReport: {
responses: {
201: {
content: never;
};
};
};
UploadsController_cancelTest: {
parameters: {
header: {
"x-app-api-key": string;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["ICancelTestArgs"];
};
};
responses: {
/** @description The record has been successfully cancelled. */
201: {
content: {
"application/json": {
message?: string;
results?: components["schemas"]["IDBResult"][];
};
};
};
};
};
UploadsController_checkForExistingUpload: {
parameters: {
header: {
"x-app-api-key": string;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["ICheckForExistingUploadArgs"];
};
};
responses: {
/** @description The url has been successfully created. */
201: {
content: {
"application/json": components["schemas"]["ICheckForExistingUploadResponse"];
};
};
};
};
UploadsController_createBinary: {
parameters: {
header: {
"x-app-api-key": string;
};
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["ICreateBinaryUploadArgs"];
};
};
responses: {
/**
* @description The record has been successfully created.
* @example {
* "message": "Binary uploaded successfully",
* "binaryId": "binary-123-abc-def"
* }
*/
201: {
content: {
"application/json": components["schemas"]["ICreateBinaryResponse"];
};
};
};
};
UploadsController_createTest: {
parameters: {
header: {
"x-app-api-key": string;
};
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["ICreateTestUploadArgs"];
};
};
responses: {
/** @description The record has been successfully created. */
201: {
content: {
"application/json": {
message?: string;
results?: components["schemas"]["IDBResult"][];
};
};
};
};
};
UploadsController_deleteUpload: {
parameters: {
header: {
"x-app-api-key": string;
};
path: {
uploadId: string;
};
};
responses: {
200: {
content: never;
};
/** @description The upload has been successfully deleted. */
201: {
content: {
"application/json": {
message?: string;
success?: boolean;
};
};
};
};
};
UploadsController_finaliseUpload: {
parameters: {
header: {
"x-app-api-key": string;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["IFinaliseUploadArgs"];
};
};
responses: {
/** @description The upload has been completed. */
201: {
content: {
"application/json": components["schemas"]["IFinaliseUploadResponse"];
};
};
};
};
UploadsController_getBinaryUploadUrl: {
parameters: {
header: {
"x-app-api-key": string;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["IGetBinaryUploadUrlArgs"];
};
};
responses: {
/** @description The url has been successfully created. */
201: {
content: {
"application/json": components["schemas"]["IGetBinaryUploadUrlResponse"];
};
};
};
};
UploadsController_getUploadStatus: {
parameters: {
header: {
"x-app-api-key": string;
};
query?: {
/** @description Upload name to get status for */
name?: string;
/** @description Upload ID to get status for */
uploadId?: string;
};
};
responses: {
/** @description Upload status */
200: {
content: {
"application/json": Record<string, never>;
};
};
};
};
UploadsController_retryTest: {
parameters: {
header: {
"x-app-api-key": string;
};
};
requestBody: {
content: {
"application/json": components["schemas"]["IRetryTestArgs"];
};
};
responses: {
/** @description The record has been successfully created. */
201: {
content: {
"application/json": {
message?: string;
results?: components["schemas"]["IDBResult"][];
};
};
};
};
};
}