bitrise (EXPERIMENTAL)

Official REST API for Bitrise.io

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 0.1
  • Build package: org.openapitools.codegen.languages.DartDioNextClientCodegen For more information, please visit https://www.bitrise.io/contact

Requirements

  • Dart 2.12.0 or later OR Flutter 1.26.0 or later
  • Dio 4.0.0+

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  bitrise: 1.0.0

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  bitrise:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  bitrise:
    path: /path/to/bitrise

Getting Started

Please follow the installation procedure and then run the following:

import 'package:bitrise/bitrise.dart';


final api = ActivityApi();
final next = next_example; // String | Slug of the first activity event in the response
final limit = 56; // int | Max number of elements per page (default: 50)

try {
    final response = await api.activityList(next, limit);
    print(response);
} catch on DioError (e) {
    print("Exception when calling ActivityApi->activityList: $e\n");
}

Documentation for API Endpoints

All URIs are relative to https://api.bitrise.io/v0.1

ClassMethodHTTP requestDescription
ActivityApiactivityListget /me/activitiesGet list of Bitrise activity events
AddonsApiaddonListByAppget /apps/{app-slug}/addonsGet list of the addons for apps
AddonsApiaddonListByOrganizationget /organizations/{organization-slug}/addonsGet list of the addons for organization
AddonsApiaddonListByUserget /users/{user-slug}/addonsGet list of the addons for user
AddonsApiaddonsListget /addonsGet list of available Bitrise addons
AddonsApiaddonsShowget /addons/{addon-id}Get a specific Bitrise addon
AndroidKeystoreFileApiandroidKeystoreFileCreatepost /apps/{app-slug}/android-keystore-filesCreate an Android keystore file
AndroidKeystoreFileApiandroidKeystoreFileListget /apps/{app-slug}/android-keystore-filesGet a list of the android keystore files
AppSetupApiappConfigCreatepost /apps/{app-slug}/bitrise.ymlUpload a new bitrise.yml for your application.
AppSetupApiappCreatepost /apps/registerAdd a new app
AppSetupApiappFinishpost /apps/{app-slug}/finishSave the application at the end of the app registration process
AppSetupApiappWebhookCreatepost /apps/{app-slug}/register-webhookRegister an incoming webhook for a specific application
AppSetupApisshKeyCreatepost /apps/{app-slug}/register-ssh-keyAdd an SSH-key to a specific app
AppleApiCredentialsApiappleApiCredentialListget /users/{user-slug}/apple-api-credentialsList Apple API credentials for a specific user
ApplicationApiappConfigDatastoreShowget /apps/{app-slug}/bitrise.ymlGet bitrise.yml of a specific app
ApplicationApiappListget /appsGet list of the apps
ApplicationApiappListByOrganizationget /organizations/{org-slug}/appsGet list of the apps for an organization
ApplicationApiappListByUserget /users/{user-slug}/appsGet list of the apps for a user
ApplicationApiappShowget /apps/{app-slug}Get a specific app
ApplicationApibranchListget /apps/{app-slug}/branchesList the branches with existing builds of an app's repository
AvatarCandidateApiavatarCandidateCreatepost /apps/{app-slug}/avatar-candidatesCreate avatar candidates
AvatarCandidateApiavatarCandidateListget /v0.1/apps/{app-slug}/avatar-candidatesGet list of the avatar candidates
AvatarCandidateApiavatarCandidatePromotepatch /apps/{app-slug}/avatar-candidates/{avatar-slug}Promote an avatar candidate
BuildArtifactApiartifactDeletedelete /apps/{app-slug}/builds/{build-slug}/artifacts/{artifact-slug}Delete a build artifact
BuildArtifactApiartifactListget /apps/{app-slug}/builds/{build-slug}/artifactsGet a list of all build artifacts
BuildArtifactApiartifactShowget /apps/{app-slug}/builds/{build-slug}/artifacts/{artifact-slug}Get a specific build artifact
BuildArtifactApiartifactUpdatepatch /apps/{app-slug}/builds/{build-slug}/artifacts/{artifact-slug}Update a build artifact
BuildCertificateApibuildCertificateConfirmpost /apps/{app-slug}/build-certificates/{build-certificate-slug}/uploadedConfirm a build certificate upload
BuildCertificateApibuildCertificateCreatepost /apps/{app-slug}/build-certificatesCreate a build certificate
BuildCertificateApibuildCertificateDeletedelete /apps/{app-slug}/build-certificates/{build-certificate-slug}Delete a build certificate
BuildCertificateApibuildCertificateListget /apps/{app-slug}/build-certificatesGet a list of the build certificates
BuildCertificateApibuildCertificateShowget /apps/{app-slug}/build-certificates/{build-certificate-slug}Get a specific build certificate
BuildCertificateApibuildCertificateUpdatepatch /apps/{app-slug}/build-certificates/{build-certificate-slug}Update a build certificate
BuildRequestApibuildRequestListget /apps/{app-slug}/build-requestsList the open build requests for an app
BuildRequestApibuildRequestUpdatepatch /apps/{app-slug}/build-requests/{build-request-slug}Update a build request
BuildsApibuildAbortpost /apps/{app-slug}/builds/{build-slug}/abortAbort a specific build
BuildsApibuildBitriseYmlShowget /apps/{app-slug}/builds/{build-slug}/bitrise.ymlGet the bitrise.yml of a build
BuildsApibuildListget /apps/{app-slug}/buildsList all builds of an app
BuildsApibuildListAllget /buildsList all builds
BuildsApibuildLogget /apps/{app-slug}/builds/{build-slug}/logGet the build log of a build
BuildsApibuildShowget /apps/{app-slug}/builds/{build-slug}Get a build of a given app
BuildsApibuildTriggerpost /apps/{app-slug}/buildsTrigger a new build
BuildsApibuildWorkflowListget /apps/{app-slug}/build-workflowsList the workflows of an app
GenericProjectFileApigenericProjectFileConfirmpost /apps/{app-slug}/generic-project-files/{generic-project-file-slug}/uploadedConfirm a generic project file upload
GenericProjectFileApigenericProjectFileDeletedelete /apps/{app-slug}/generic-project-files/{generic-project-file-slug}Delete a generic project file
GenericProjectFileApigenericProjectFileListget /apps/{app-slug}/generic-project-filesGet a list of the generic project files
GenericProjectFileApigenericProjectFileShowget /apps/{app-slug}/generic-project-files/{generic-project-file-slug}Get a specific generic project file
GenericProjectFileApigenericProjectFileUpdatepatch /apps/{app-slug}/generic-project-files/{generic-project-file-slug}Update a generic project file
GenericProjectFileApigenericProjectFilesCreatepost /apps/{app-slug}/generic-project-filesCreate a generic project file
OrganizationsApiorgListget /organizationsList the organizations that the user is part of
OrganizationsApiorgShowget /organizations/{org-slug}Get a specified organization.
OutgoingWebhookApioutgoingWebhookCreatepost /apps/{app-slug}/outgoing-webhooksCreate an outgoing webhook for an app
OutgoingWebhookApioutgoingWebhookDeletedelete /apps/{app-slug}/outgoing-webhooks/{app-webhook-slug}Delete an outgoing webhook of an app
OutgoingWebhookApioutgoingWebhookListget /apps/{app-slug}/outgoing-webhooksList the outgoing webhooks of an app
OutgoingWebhookApioutgoingWebhookUpdateput /apps/{app-slug}/outgoing-webhooks/{app-webhook-slug}Update an outgoing webhook of an app
ProvisioningProfileApiprovisioningProfileConfirmpost /apps/{app-slug}/provisioning-profiles/{provisioning-profile-slug}/uploadedConfirm a provisioning profile upload
ProvisioningProfileApiprovisioningProfileCreatepost /apps/{app-slug}/provisioning-profilesCreate a provisioning profile
ProvisioningProfileApiprovisioningProfileDeletedelete /apps/{app-slug}/provisioning-profiles/{provisioning-profile-slug}Delete a provisioning profile
ProvisioningProfileApiprovisioningProfileListget /apps/{app-slug}/provisioning-profilesGet a list of the provisioning profiles
ProvisioningProfileApiprovisioningProfileShowget /apps/{app-slug}/provisioning-profiles/{provisioning-profile-slug}Get a specific provisioning profile
ProvisioningProfileApiprovisioningProfileUpdatepatch /apps/{app-slug}/provisioning-profiles/{provisioning-profile-slug}Update a provisioning profile
TestDevicesApitestDeviceListget /apps/{app-slug}/test-devicesList the test devices for an app
UserApiuserPlanget /me/planThe subscription plan of the user
UserApiuserProfileget /meGet your profile data
UserApiuserShowget /users/{user-slug}Get a specific user
WebhookDeliveryItemApiwebhookDeliveryItemListget /apps/{app-slug}/outgoing-webhooks/{app-webhook-slug}/delivery-itemsList the webhook delivery items of an app
WebhookDeliveryItemApiwebhookDeliveryItemRedeliverpost /apps/{app-slug}/outgoing-webhooks/{app-webhook-slug}/delivery-items/{webhook-delivery-item-slug}/redeliverRe-deliver the webhook delivery items of an app
WebhookDeliveryItemApiwebhookDeliveryItemShowget /apps/{app-slug}/outgoing-webhooks/{app-webhook-slug}/delivery-items/{webhook-delivery-item-slug}Get a specific delivery item of a webhook

Documentation For Models

Documentation For Authorization

AddonAuthToken

  • Type: API key
  • API key parameter name: Bitrise-Addon-Auth-Token
  • Location: HTTP header

PersonalAccessToken

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

letsconnect@bitrise.io

Libraries

bitrise