Skip to content

Latest commit

 

History

History
253 lines (174 loc) · 7.89 KB

AddonsApi.md

File metadata and controls

253 lines (174 loc) · 7.89 KB
Raw

bitrise.api.AddonsApi

Load the API package

import 'package:bitrise/api.dart';

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

Method HTTP request Description
addonListByApp get /apps/{app-slug}/addons Get list of the addons for apps
addonListByOrganization get /organizations/{organization-slug}/addons Get list of the addons for organization
addonListByUser get /users/{user-slug}/addons Get list of the addons for user
addonsList get /addons Get list of available Bitrise addons
addonsShow get /addons/{addon-id} Get a specific Bitrise addon

addonListByApp

V0AppAddOnsListResponseModel addonListByApp(appSlug)

Get list of the addons for apps

List all the provisioned addons for the authorized apps

Example

import 'package:bitrise/api.dart';
// TODO Configure API key authorization: AddonAuthToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('AddonAuthToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('AddonAuthToken').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: PersonalAccessToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('PersonalAccessToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('PersonalAccessToken').apiKeyPrefix = 'Bearer';

var api_instance = new AddonsApi();
var appSlug = appSlug_example; // String | App slug

try { 
    var result = api_instance.addonListByApp(appSlug);
    print(result);
} catch (e) {
    print('Exception when calling AddonsApi->addonListByApp: $e\n');
}

Parameters

Name Type Description Notes
appSlug String App slug

Return type

V0AppAddOnsListResponseModel

Authorization

AddonAuthToken, PersonalAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addonListByOrganization

V0OwnerAddOnsListResponseModel addonListByOrganization(organizationSlug)

Get list of the addons for organization

List all the provisioned addons for organization

Example

import 'package:bitrise/api.dart';
// TODO Configure API key authorization: PersonalAccessToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('PersonalAccessToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('PersonalAccessToken').apiKeyPrefix = 'Bearer';

var api_instance = new AddonsApi();
var organizationSlug = organizationSlug_example; // String | Organization slug

try { 
    var result = api_instance.addonListByOrganization(organizationSlug);
    print(result);
} catch (e) {
    print('Exception when calling AddonsApi->addonListByOrganization: $e\n');
}

Parameters

Name Type Description Notes
organizationSlug String Organization slug

Return type

V0OwnerAddOnsListResponseModel

Authorization

PersonalAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addonListByUser

V0OwnerAddOnsListResponseModel addonListByUser(userSlug)

Get list of the addons for user

List all the provisioned addons for the authenticated user

Example

import 'package:bitrise/api.dart';
// TODO Configure API key authorization: PersonalAccessToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('PersonalAccessToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('PersonalAccessToken').apiKeyPrefix = 'Bearer';

var api_instance = new AddonsApi();
var userSlug = userSlug_example; // String | User slug

try { 
    var result = api_instance.addonListByUser(userSlug);
    print(result);
} catch (e) {
    print('Exception when calling AddonsApi->addonListByUser: $e\n');
}

Parameters

Name Type Description Notes
userSlug String User slug

Return type

V0OwnerAddOnsListResponseModel

Authorization

PersonalAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addonsList

V0AddonsListResponseModel addonsList()

Get list of available Bitrise addons

List all the available Bitrise addons

Example

import 'package:bitrise/api.dart';
// TODO Configure API key authorization: PersonalAccessToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('PersonalAccessToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('PersonalAccessToken').apiKeyPrefix = 'Bearer';

var api_instance = new AddonsApi();

try { 
    var result = api_instance.addonsList();
    print(result);
} catch (e) {
    print('Exception when calling AddonsApi->addonsList: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

V0AddonsListResponseModel

Authorization

PersonalAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

addonsShow

V0AddonsShowResponseModel addonsShow(addonId)

Get a specific Bitrise addon

Show details of a specific Bitrise addon

Example

import 'package:bitrise/api.dart';
// TODO Configure API key authorization: PersonalAccessToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('PersonalAccessToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('PersonalAccessToken').apiKeyPrefix = 'Bearer';

var api_instance = new AddonsApi();
var addonId = addonId_example; // String | Addon ID

try { 
    var result = api_instance.addonsShow(addonId);
    print(result);
} catch (e) {
    print('Exception when calling AddonsApi->addonsShow: $e\n');
}

Parameters

Name Type Description Notes
addonId String Addon ID

Return type

V0AddonsShowResponseModel

Authorization

PersonalAccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]