@@ -23,6 +23,13 @@ class CodemagicClient {
2323 }) : _client = HttpClient ();
2424
2525 /// Retrieves [Builds] object containing list of [Application] s and [Build] s
26+ ///
27+ /// This endpoint returns a paginated list of recent builds along with their
28+ /// associated applications. The response includes build status, timing information,
29+ /// and artifact details.
30+ ///
31+ /// Returns [ApiResponse] containing [Builds] data on success, or error information
32+ /// on failure (e.g., 401 for invalid authentication).
2633 Future <ApiResponse <Builds >> getBuilds () async {
2734 try {
2835 final request = await _client.getUrl (Uri .parse ("$apiUrl /builds" ));
@@ -73,6 +80,15 @@ class CodemagicClient {
7380 }
7481
7582 /// Retrieves information about specific [Application] by its [id]
83+ ///
84+ /// Fetches detailed information about a single application including its
85+ /// configuration, workflow definitions, repository settings, and metadata.
86+ ///
87+ /// Parameters:
88+ /// - [id] : The unique identifier of the application
89+ ///
90+ /// Returns [ApiResponse] containing [Application] data on success, or error
91+ /// information on failure (e.g., 404 if application not found).
7692 Future <ApiResponse <Application >> getApplication (String id) async {
7793 try {
7894 final request = await _client.getUrl (Uri .parse ("$apiUrl /apps/$id " ));
@@ -138,8 +154,18 @@ class CodemagicClient {
138154 }
139155 }
140156
141- /// Starts new build for [Application] by its [appId] , [workflowId]
142- /// and [branch]
157+ /// Starts new build for [Application] by its [appId] , [workflowId] and [branch]
158+ ///
159+ /// Triggers a new build for the specified application using the given workflow
160+ /// and source branch. The build will be queued and executed asynchronously.
161+ ///
162+ /// Parameters:
163+ /// - [appId] : The unique identifier of the application
164+ /// - [workflowId] : The workflow identifier to use for the build
165+ /// - [branch] : The source branch name to build from
166+ ///
167+ /// Returns [ApiResponse] containing [BuildResponse] with the new build ID on
168+ /// success, or error information on failure (e.g., 400 for invalid parameters).
143169 Future <ApiResponse <BuildResponse >> startBuild (
144170 String appId,
145171 String workflowId,
0 commit comments