codemagic_manager 0.2.1

Dart native js
Flutter Android iOS web

Package allowing to query Codemagic builds and applications from the recently exposed API

codemagic_manager #

Simple unofficial api client to fetch builds and applications details from your Codemagic account

Getting Started #

Codemagic has recently exposed an API to access information about builds and applications. This is a simple wrapper to help you manage your builds.

API documentation #

First of all check the official Codemagic API docs here. The API is in preview and may change significantly during development period.

Using the client #

The library exposes CodemagicClient that is a HTTP client using dio to fetch and deserialize responses from Codemagic API.

To initialize the client you should call:

final client = CodemagicClient(
    apiUrl: 'https://api.codemagic.io',
    authKey: 'AUTH-KEY',
),

The AUTH-KEY as of now is available to get from your Codemagic account settings in User settings > Integrations > Codemagic API > Show.

Available methods #

Right now following endpoints are available

Get Builds

Object consisting of two sets of information:

  • list of Applications
  • list of Builds
final buildsResponse = await client.getBuilds();
if (buildsResponse.wasSuccessful) {
    //handle buildsResponse.data
} else {
    //handle buildsResponse.error
}

Get Application

Specific informations about the given Application.

final appsResponse = await client.getApplication('application-id');
if (appsResponse.wasSuccessful) {
    //handle appsResponse.data
} else {
    //handle appsResponse.error
}

Start build

Start build based on the appId, workflowId and desired branch.

final appsResponse = await client.startBuild('application-id', 'workflow-id', 'master');
if (appsResponse.wasSuccessful) {
    //handle appsResponse.data
} else {
    //handle appsResponse.error
}

Cancel build

Cancel build by its id.

final appsResponse = await client.cancelBuild('build-id');
if (appsResponse.wasSuccessful) {
    //handle appsResponse.data
} else {
    //handle appsResponse.error
}

Work in progress #

This library is a work in progress. Some models are not generated yet and others may not be fully tested.

Contributions #

All the contributions are welcome! Please feel free to file issues or create PR if you would like to improve the library.

2
likes
90
pub points
6%
popularity

Publisher

roszkowski.dev

Package allowing to query Codemagic builds and applications from the recently exposed API

Homepage
Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (LICENSE)

Dependencies

dio, freezed_annotation, meta

More

Packages that depend on codemagic_manager