@devicecloud.dev/dcd
Version:
Better cloud maestro testing
1,600 lines • 52.3 kB
TypeScript
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/uploads/getBinaryUploadUrl": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post: operations["UploadsController_getBinaryUploadUrl"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/uploads/checkForExistingUpload": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post: operations["UploadsController_checkForExistingUpload"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/uploads/finaliseUpload": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post: operations["UploadsController_finaliseUpload"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/uploads/finishLargeFile": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post: operations["UploadsController_finishLargeFile"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/uploads/flow": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post: operations["UploadsController_createTest"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/uploads/retryTest": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post: operations["UploadsController_retryTest"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/uploads/cancelTest": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post: operations["UploadsController_cancelTest"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/uploads/status": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get: operations["UploadsController_getUploadStatus"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/uploads/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get: operations["UploadsController_listUploads"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/uploads/{uploadId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete: operations["UploadsController_deleteUpload"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/results/{uploadId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get: operations["ResultsController_getResults"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/results/{uploadId}/download": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post: operations["ResultsController_getTestRunArtifacts"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/results/notify/{uploadId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post: operations["ResultsController_notifyTestRunComplete"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/results/{uploadId}/report": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get: operations["ResultsController_downloadReport"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/results/{uploadId}/html-report": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get: operations["ResultsController_downloadHtmlReport"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/results/{resultId}/html-report-single": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get: operations["ResultsController_downloadSingleHtmlReport"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/results/compatibility/data": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get: operations["ResultsController_getCompatibilityData"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/allure/{uploadId}/download": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Download Allure report as HTML
* @description Downloads a single-file Allure report as HTML containing all test results. Report is generated once and stored in Supabase Storage for subsequent downloads.
*/
get: operations["AllureController_downloadAllureReport"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/webhooks": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get: operations["WebhooksController_getWebhook"];
put?: never;
post: operations["WebhooksController_setWebhook"];
delete: operations["WebhooksController_deleteWebhook"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/webhooks/regenerate-secret": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post: operations["WebhooksController_regenerateWebhookSecret"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/webhooks/test": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post: operations["WebhooksController_testWebhook"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/org/increase_credits": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post: operations["OrgController_paddleTransactionCompleted"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/org/update-name": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post: operations["OrgController_updateOrgName"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/org/invite-team-member": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post: operations["OrgController_inviteTeamMember"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/org/accept-invite": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post: operations["OrgController_acceptInvite"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/frontend/check-domain-saml": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post: operations["FrontendController_checkDomainSaml"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/health": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get: operations["HealthController_health"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: {
IDBResult: {
binary_upload_id: string;
cost: number | null;
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;
};
IGetBinaryUploadUrlArgs: {
/** @description File size in bytes (optional, for Backblaze upload strategy) */
fileSize?: number;
/** @description Whether client uses TUS resumable uploads (true for new clients, undefined/false for legacy) */
useTus?: boolean;
platform: Record<string, never>;
};
B2SimpleUpload: {
uploadUrl: string;
authorizationToken: string;
};
B2UploadPartUrl: {
uploadUrl: string;
authorizationToken: string;
};
B2LargeUpload: {
fileId: string;
fileName: string;
uploadPartUrls: components["schemas"]["B2UploadPartUrl"][];
};
B2UploadStrategy: {
/** @enum {string} */
strategy: "simple" | "large";
simple?: components["schemas"]["B2SimpleUpload"];
large?: components["schemas"]["B2LargeUpload"];
};
IGetBinaryUploadUrlResponse: {
/** @description Temporary upload path in uploads/ folder for TUS upload */
path: string;
/** @description Temporary upload path (same as path) */
tempPath: string;
/** @description Final path where file will be moved after upload completes */
finalPath: string;
/** @description Upload ID */
id: string;
/** @description Backblaze upload strategy if configured */
b2?: components["schemas"]["B2UploadStrategy"];
/** @description Signed upload URL token for legacy clients (deprecated) */
token?: string;
};
ICheckForExistingUploadArgs: {
sha: string;
};
ICheckForExistingUploadResponse: {
appBinaryId: string;
exists: boolean;
};
IFinaliseUploadArgs: {
/** @description File metadata (bundle ID, package name, platform) - required for new clients */
metadata?: Record<string, never>;
/** @description SHA-256 hash of the file - required for new clients */
sha?: string;
/**
* @description Whether the Supabase upload was successful
* @default true
*/
supabaseSuccess: boolean;
/**
* @description Whether the Backblaze upload was successful
* @default false
*/
backblazeSuccess: boolean;
/** @description Whether client uses TUS resumable uploads (true for new clients, undefined/false for legacy) */
useTus?: boolean;
id: string;
path: string;
};
IFinaliseUploadResponse: Record<string, never>;
IFinishLargeFileArgs: {
/**
* @description The Backblaze file ID from the large file upload
* @example abc123xyz
*/
fileId: string;
/**
* @description Array of SHA1 hashes for each uploaded part
* @example [
* "sha1hash1",
* "sha1hash2"
* ]
*/
partSha1Array: string[];
};
IFinishLargeFileResponse: {
success: boolean;
result: Record<string, never>;
};
ICreateTestUploadArgs: {
/**
* Format: binary
* @description This file must be a zip file
*/
file: string;
/** @enum {string} */
androidApiLevel?: "29" | "30" | "31" | "32" | "33" | "34" | "35" | "36";
/** @enum {string} */
androidDevice?: "pixel-6" | "pixel-6-pro" | "pixel-7" | "pixel-7-pro" | "generic-tablet";
apiKey?: string;
apiUrl?: string;
appFile?: string;
/** @enum {string} */
iOSVersion?: "16" | "17" | "18" | "26";
/** @enum {string} */
iOSDevice?: "iphone-14" | "iphone-14-pro" | "iphone-15" | "iphone-15-pro" | "iphone-16" | "iphone-16-plus" | "iphone-16-pro" | "iphone-16-pro-max" | "ipad-pro-6th-gen";
platform?: string;
/** @enum {string} */
runnerType?: "m4" | "m1" | "default" | "gpu1" | "cpu1";
metadata?: string;
workspaceConfig?: string;
flowMetadata?: string;
testFileOverrides?: string;
/** @description SHA-256 hash of the flow ZIP file */
sha?: string;
testFileNames?: string;
sequentialFlows?: string;
appBinaryId: string;
env: string;
googlePlay: boolean;
config: string;
name: string;
};
IRetryTestArgs: {
resultId: number;
};
ICancelTestArgs: {
/** @description ID of a specific result to cancel. Either resultId or uploadId must be provided, but not both. */
resultId?: number;
/** @description ID of an upload to cancel all pending results for. Either resultId or uploadId must be provided, but not both. */
uploadId?: string;
};
TResultResponse: {
id: number;
test_file_name: string;
status: string;
retry_of?: number;
fail_reason?: string;
duration_seconds?: number;
};
UpdateOrgNameDto: {
/**
* @description Organization ID
* @example 123
*/
orgId: number;
/**
* @description Organization name
* @example Acme Corporation
*/
name: string;
};
AcceptInviteDto: {
/**
* @description Organization ID
* @example 1
*/
orgId: string;
/**
* @description User email address
* @example user@example.com
*/
email: string;
};
};
responses: never;
parameters: never;
requestBodies: never;
headers: never;
pathItems: never;
}
export type $defs = Record<string, never>;
export interface operations {
UploadsController_getBinaryUploadUrl: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["IGetBinaryUploadUrlArgs"];
};
};
responses: {
/** @description The url has been successfully created. */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["IGetBinaryUploadUrlResponse"];
};
};
};
};
UploadsController_checkForExistingUpload: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["ICheckForExistingUploadArgs"];
};
};
responses: {
/** @description The url has been successfully created. */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["ICheckForExistingUploadResponse"];
};
};
};
};
UploadsController_finaliseUpload: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["IFinaliseUploadArgs"];
};
};
responses: {
/** @description The upload has been completed. */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["IFinaliseUploadResponse"];
};
};
};
};
UploadsController_finishLargeFile: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["IFinishLargeFileArgs"];
};
};
responses: {
/** @description The large file upload has been completed. */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": components["schemas"]["IFinishLargeFileResponse"];
};
};
};
};
UploadsController_createTest: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"multipart/form-data": components["schemas"]["ICreateTestUploadArgs"];
};
};
responses: {
/** @description The record has been successfully created. */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
message?: string;
results?: components["schemas"]["IDBResult"][];
};
};
};
};
};
UploadsController_retryTest: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["IRetryTestArgs"];
};
};
responses: {
/** @description The record has been successfully created. */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
message?: string;
results?: components["schemas"]["IDBResult"][];
};
};
};
};
};
UploadsController_cancelTest: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["ICancelTestArgs"];
};
};
responses: {
/** @description The record has been successfully cancelled. */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
message?: string;
success?: boolean;
cancelledCount?: number;
};
};
};
};
};
UploadsController_getUploadStatus: {
parameters: {
query?: {
/** @description Upload ID to get status for */
uploadId?: string;
/** @description Upload name to get status for */
name?: string;
};
header: {
"x-app-api-key": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Upload status */
200: {
headers: {
[name: string]: unknown;
};
content: {
/**
* @example {
* "uploadId": "upload-123",
* "status": "PENDING",
* "tests": [
* {
* "id": 1,
* "test_file_name": "test-flow.yaml",
* "status": "PENDING"
* }
* ]
* }
*/
"application/json": Record<string, never>;
};
};
};
};
UploadsController_listUploads: {
parameters: {
query?: {
/** @description Filter by upload name (supports * wildcard) */
name?: string;
/** @description Filter uploads created on or after this date (ISO 8601) */
from?: string;
/** @description Filter uploads created on or before this date (ISO 8601) */
to?: string;
/** @description Maximum number of uploads to return (default: 20) */
limit?: number;
/** @description Number of uploads to skip (default: 0) */
offset?: number;
};
header: {
"x-app-api-key": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description List of flow uploads. Use GET /uploads/status for detailed test results. */
200: {
headers: {
[name: string]: unknown;
};
content: {
/**
* @example {
* "uploads": [
* {
* "id": "upload-123",
* "name": "Test Upload",
* "created_at": "2024-01-01T00:00:00Z",
* "consoleUrl": "https://console.devicecloud.dev/results/upload-123"
* }
* ],
* "total": 1,
* "limit": 20,
* "offset": 0
* }
*/
"application/json": {
uploads?: {
id?: string;
name?: string | null;
created_at?: string;
consoleUrl?: string;
}[];
total?: number;
limit?: number;
offset?: number;
};
};
};
};
};
UploadsController_deleteUpload: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path: {
uploadId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
200: {
headers: {
[name: string]: unknown;
};
content?: never;
};
/** @description The upload has been successfully deleted. */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
success?: boolean;
message?: string;
};
};
};
};
};
ResultsController_getResults: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path: {
uploadId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description The record has been successfully created. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
statusCode?: number;
results?: components["schemas"]["TResultResponse"][];
};
};
};
};
};
ResultsController_getTestRunArtifacts: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path: {
uploadId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
201: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
ResultsController_notifyTestRunComplete: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path: {
uploadId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Send results summary email. */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": string;
};
};
};
};
ResultsController_downloadReport: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path: {
uploadId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Download combined JUNIT test report (report.xml) for the upload */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": string;
};
};
};
};
ResultsController_downloadHtmlReport: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path: {
uploadId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Download combined HTML test report with assets (report.zip) for the upload */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": string;
};
};
};
};
ResultsController_downloadSingleHtmlReport: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path: {
resultId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Download HTML test report with assets (report.zip) for a single result */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": string;
};
};
};
};
ResultsController_getCompatibilityData: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Device compatibility lookup data including Maestro versions */
200: {
headers: {
[name: string]: unknown;
};
content: {
/**
* @example {
* "statusCode": 200,
* "data": {
* "ios": {
* "iphone-14": {
* "name": "iPhone 14",
* "versions": [
* "15",
* "16",
* "17",
* "18"
* ],
* "deprecated": false
* },
* "iphone-14-pro": {
* "name": "iPhone 14 Pro",
* "versions": [
* "15",
* "16",
* "17",
* "18"
* ],
* "deprecated": false
* },
* "iphone-15": {
* "name": "iPhone 15",
* "versions": [
* "16",
* "17",
* "18"
* ],
* "deprecated": false
* },
* "iphone-15-pro": {
* "name": "iPhone 15 Pro",
* "versions": [
* "16",
* "17",
* "18"
* ],
* "deprecated": false
* },
* "iphone-16": {
* "name": "iPhone 16",
* "versions": [
* "17",
* "18"
* ],
* "deprecated": false
* },
* "iphone-16-plus": {
* "name": "iPhone 16 Plus",
* "versions": [
* "17",
* "18"
* ],
* "deprecated": false
* },
* "iphone-16-pro": {
* "name": "iPhone 16 Pro",
* "versions": [
* "17",
* "18"
* ],
* "deprecated": false
* },
* "iphone-16-pro-max": {
* "name": "iPhone 16 Pro Max",
* "versions": [
* "17",
* "18"
* ],
* "deprecated": false
* },
* "iphone-13": {
* "name": "iPhone 13",
* "versions": [
* "15",
* "16",
* "17"
* ],
* "deprecated": true
* },
* "ipad-air": {
* "name": "iPad Air",
* "versions": [
* "15",
* "16",
* "17"
* ],
* "deprecated": false
* },
* "ipad-pro-6th-gen": {
* "name": "iPad Pro (6th gen)",
* "versions": [
* "16",
* "17",
* "18"
* ],
* "deprecated": false
* }
* },
* "android": {
* "pixel-6": {
* "name": "Pixel 6",
* "apiLevels": [
* "29",
* "30",
* "31",
* "32",
* "33",
* "34",
* "35",
* "36"
* ],
* "deprecated": false
* },
* "pixel-6-pro": {
* "name": "Pixel 6 Pro",
* "apiLevels": [
* "33",
* "34",
* "35",
* "36"
* ],
* "deprecated": false
* },
* "pixel-7": {
* "name": "Pixel 7",
* "apiLevels": [
* "33",
* "34",
* "35",
* "36"
* ],
* "deprecated": false
* },
* "pixel-7-pro": {
* "name": "Pixel 7 Pro",
* "apiLevels": [
* "33",
* "34",
* "35",
* "36"
* ],
* "deprecated": false
* },
* "generic-tablet": {
* "name": "Generic Tablet",
* "apiLevels": [
* "33",
* "34",
* "35",
* "36"
* ],
* "deprecated": false
* }
* },
* "androidPlay": {
* "pixel-6": {
* "name": "Pixel 6 (Google Play)",
* "apiLevels": [
* "34",
* "35",
* "36"
* ],
* "deprecated": false
* },
* "pixel-7": {
* "name": "Pixel 7 (Google Play)",
* "apiLevels": [
* "34",
* "35",
* "36"
* ],
* "deprecated": false
* }
* },
* "maestro": {
* "supportedVersions": [
* "1.39.0",
* "1.39.1",
* "1.39.2",
* "1.39.5",
* "1.39.7",
* "1.40.3",
* "1.41.0",
* "2.0.2",
* "2.0.3",
* "2.0.4",
* "2.0.9"
* ],
* "defaultVersion": "1.41.0",
* "latestVersion": "2.0.9"
* }
* }
* }
*/
"application/json": {
statusCode?: number;
data?: {
ios?: Record<string, never>;
android?: Record<string, never>;
androidPlay?: Record<string, never>;
maestro?: {
supportedVersions?: string[];
defaultVersion?: string;
latestVersion?: string;
};
};
};
};
};
};
};
AllureController_downloadAllureReport: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path: {
/** @description The upload ID to generate Allure report for */
uploadId: string;
};
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Allure report HTML file download */
200: {
headers: {
[name: string]: unknown;
};
content: {
"text/html": string;
};
};
/** @description Upload not found or no results available */
404: {
headers: {
[name: string]: unknown;
};
content?: never;
};
};
};
WebhooksController_getWebhook: {
parameters: {
query?: {
/** @description Set to true to return full secret instead of masked version */
show_secret?: boolean;
};
header: {
"x-app-api-key": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Current webhook configuration */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
webhook_url?: string;
/** @description Full secret (only when show_secret=true) */
secret_key?: string;
/** @description Masked secret (default) */
secret_key_masked?: string;
/** Format: date-time */
created_at?: string;
/** Format: date-time */
updated_at?: string;
};
};
};
};
};
WebhooksController_setWebhook: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/**
* Format: uri
* @example https://api.example.com/webhook
*/
url: string;
};
};
};
responses: {
/** @description Webhook URL set successfully */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": Record<string, never>;
};
};
};
};
WebhooksController_deleteWebhook: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Webhook configuration deleted successfully */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": Record<string, never>;
};
};
};
};
WebhooksController_regenerateWebhookSecret: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Webhook secret regenerated successfully */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": Record<string, never>;
};
};
};
};
WebhooksController_testWebhook: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
/** Format: uri */
url?: string;
};
};
};
responses: {
/** @description Test webhook sent successfully */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": Record<string, never>;
};
};
};
};
OrgController_paddleTransactionCompleted: {
parameters: {
query?: never;
header: {
"paddle-signature": string;
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Success. */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": string;
};
};
};
};
OrgController_updateOrgName: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["UpdateOrgNameDto"];
};
};
responses: {
/** @description Organization name updated successfully. */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": boolean;
};
};
};
};
OrgController_inviteTeamMember: {
parameters: {
query?: never;
header: {
"x-app-api-key": string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": {
inviteEmail: string;
requesterEmail: string;
link: string;
orgId: string;
orgName: string;
};
};
};
responses: {
/** @description Team member invited successfully. */
201: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": boolean;
};
};
};
};
OrgController_acceptInvite: {
parameters: {
query?: never;
header: {
authorization: string;
};
path?: never;
cookie?: never;
};
requestBody: {
content: {
"application/json": components["schemas"]["AcceptInviteDto"];
};
};
responses: {
/** @description Team invite accepted successfully. */
201: {
headers: {
[name: string]: unk