class

Build::AddonsApi

Inherits Reference < Object

Constructors

new(api_client : ::Build::ApiClient = ApiClient.default)
Source

Instance methods

api_client
Source
api_client=(api_client : ApiClient)
Source
create_addon(app_id_or_name : String, create_addon_request : CreateAddonRequest | Nil = nil)

create addon Create and provision a new addon for an app @param app_id_or_name [String] App ID or name @return [Addon]

Source
create_addon_with_http_info(app_id_or_name : String, create_addon_request : CreateAddonRequest | Nil = nil)

create addon Create and provision a new addon for an app @param app_id_or_name [String] App ID or name @return [Array<(Addon, Integer, Hash)>] Addon data, response status code and response headers

Source
destroy_addon(app_id_or_name : String, addon_id_or_name : String)

destroy addon Destroy an addon (deprovisions and removes from all attached apps) @param app_id_or_name [String] App ID or name @param addon_id_or_name [String] Addon ID or name @return [Addon]

Source
destroy_addon_with_http_info(app_id_or_name : String, addon_id_or_name : String)

destroy addon Destroy an addon (deprovisions and removes from all attached apps) @param app_id_or_name [String] App ID or name @param addon_id_or_name [String] Addon ID or name @return [Array<(Addon, Integer, Hash)>] Addon data, response status code and response headers

Source
get_addon(app_id_or_name : String, addon_id_or_name : String)

show addon Get info about an addon @param app_id_or_name [String] App ID or name @param addon_id_or_name [String] Addon ID or name @return [Addon]

Source
get_addon_info(id : String)

show addon info Get detailed addon info including attachments @param id [String] Addon ID or name @return [AddonWithAttachments]

Source
get_addon_info_with_http_info(id : String)

show addon info Get detailed addon info including attachments @param id [String] Addon ID or name @return [Array<(AddonWithAttachments, Integer, Hash)>] AddonWithAttachments data, response status code and response headers

Source
get_addon_with_http_info(app_id_or_name : String, addon_id_or_name : String)

show addon Get info about an addon @param app_id_or_name [String] App ID or name @param addon_id_or_name [String] Addon ID or name @return [Array<(Addon, Integer, Hash)>] Addon data, response status code and response headers

Source
list_app_addons(app_id_or_name : String)

list addons List all addons for an app @param app_id_or_name [String] App ID or name @return [Array(Addon)]

Source
list_app_addons_with_http_info(app_id_or_name : String)

list addons List all addons for an app @param app_id_or_name [String] App ID or name @return [Array<(Array(Addon), Integer, Hash)>] Array(Addon) data, response status code and response headers

Source
list_team_addons(team_id : String)

list team addons List all addons for a team (across all apps) @param team_id [String] Team ID or name @return [Array(Addon)]

Source
list_team_addons_with_http_info(team_id : String)

list team addons List all addons for a team (across all apps) @param team_id [String] Team ID or name @return [Array<(Array(Addon), Integer, Hash)>] Array(Addon) data, response status code and response headers

Source
transfer_addon_billing(id : String, transfer_addon_billing_request : TransferAddonBillingRequest)

transfer addon billing Move which app owns and pays for the addon. The target app must already have the addon attached and must belong to the same team. @param id [String] Addon ID or name @param transfer_addon_billing_request [TransferAddonBillingRequest] @return [AddonWithAttachments]

Source
transfer_addon_billing_with_http_info(id : String, transfer_addon_billing_request : TransferAddonBillingRequest)

transfer addon billing Move which app owns and pays for the addon. The target app must already have the addon attached and must belong to the same team. @param id [String] Addon ID or name @param transfer_addon_billing_request [TransferAddonBillingRequest] @return [Array<(AddonWithAttachments, Integer, Hash)>] AddonWithAttachments data, response status code and response headers

Source