Class: PlatformAPI::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/platform-api/client.rb

Overview

The platform API empowers developers to automate, extend and combine Heroku with other services.

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Client

Returns a new instance of Client.



61
62
63
 
# File 'lib/platform-api/client.rb', line 61

def initialize(client)
  @client = client
end

Instance Method Details

#account ⇒ Account

An account represents an individual signed up to use the Heroku platform.

Returns:



75
76
77
 
# File 'lib/platform-api/client.rb', line 75

def 
  @account_resource ||= .new(@client)
end

#account_feature ⇒ AccountFeature

An account feature represents a Heroku labs capability that can be enabled or disabled for an account on Heroku.

Returns:



68
69
70
 
# File 'lib/platform-api/client.rb', line 68

def 
  @account_feature_resource ||= AccountFeature.new(@client)
end

#addon ⇒ Addon

Add-ons represent add-ons that have been provisioned for an app.

Returns:



89
90
91
 
# File 'lib/platform-api/client.rb', line 89

def addon
  @addon_resource ||= Addon.new(@client)
end

#addon_service ⇒ AddonService

Add-on services represent add-ons that may be provisioned for apps.

Returns:



82
83
84
 
# File 'lib/platform-api/client.rb', line 82

def addon_service
  @addon_service_resource ||= AddonService.new(@client)
end

#app ⇒ App

An app represents the program that you would like to deploy and run on Heroku.

Returns:



110
111
112
 
# File 'lib/platform-api/client.rb', line 110

def app
  @app_resource ||= App.new(@client)
end

#app_feature ⇒ AppFeature

An app feature represents a Heroku labs capability that can be enabled or disabled for an app on Heroku.

Returns:



96
97
98
 
# File 'lib/platform-api/client.rb', line 96

def app_feature
  @app_feature_resource ||= AppFeature.new(@client)
end

#app_transfer ⇒ AppTransfer

An app transfer represents a two party interaction for transferring ownership of an app.

Returns:



103
104
105
 
# File 'lib/platform-api/client.rb', line 103

def app_transfer
  @app_transfer_resource ||= AppTransfer.new(@client)
end

#collaborator ⇒ Collaborator

A collaborator represents an account that has been given access to an app on Heroku.

Returns:



117
118
119
 
# File 'lib/platform-api/client.rb', line 117

def collaborator
  @collaborator_resource ||= Collaborator.new(@client)
end

#config_var ⇒ ConfigVar

Config Vars allow you to manage the configuration information provided to an app on Heroku.

Returns:



124
125
126
 
# File 'lib/platform-api/client.rb', line 124

def config_var
  @config_var_resource ||= ConfigVar.new(@client)
end

#domain ⇒ Domain

Domains define what web routes should be routed to an app on Heroku.

Returns:



131
132
133
 
# File 'lib/platform-api/client.rb', line 131

def domain
  @domain_resource ||= Domain.new(@client)
end

#dyno ⇒ Dyno

Dynos encapsulate running processes of an app on Heroku.

Returns:



138
139
140
 
# File 'lib/platform-api/client.rb', line 138

def dyno
  @dyno_resource ||= Dyno.new(@client)
end

#formation ⇒ Formation

The formation of processes that should be maintained for an app. Update the formation to scale processes or change dyno sizes. Available process type names and commands are defined by the process_types attribute for the slug currently released on an app.

Returns:



145
146
147
 
# File 'lib/platform-api/client.rb', line 145

def formation
  @formation_resource ||= Formation.new(@client)
end

#key ⇒ Key

Keys represent public SSH keys associated with an account and are used to authorize accounts as they are performing git operations.

Returns:



152
153
154
 
# File 'lib/platform-api/client.rb', line 152

def key
  @key_resource ||= Key.new(@client)
end

#log_drain ⇒ LogDrain

Log drains provide a way to forward your Heroku logs to an external syslog server for long-term archiving. This external service must be configured to receive syslog packets from Heroku, whereupon its URL can be added to an app using this API. Some addons will add a log drain when they are provisioned to an app. These drains can only be removed by removing the add-on.

Returns:



159
160
161
 
# File 'lib/platform-api/client.rb', line 159

def log_drain
  @log_drain_resource ||= LogDrain.new(@client)
end

#log_session ⇒ LogSession

A log session is a reference to the http based log stream for an app.

Returns:



166
167
168
 
# File 'lib/platform-api/client.rb', line 166

def log_session
  @log_session_resource ||= LogSession.new(@client)
end

#oauth_authorization ⇒ OauthAuthorization

OAuth authorizations represent clients that a Heroku user has authorized to automate, customize or extend their usage of the platform. For more information please refer to the Heroku OAuth documentation

Returns:



173
174
175
 
# File 'lib/platform-api/client.rb', line 173

def oauth_authorization
  @oauth_authorization_resource ||= OauthAuthorization.new(@client)
end

#oauth_client ⇒ OauthClient

OAuth clients are applications that Heroku users can authorize to automate, customize or extend their usage of the platform. For more information please refer to the Heroku OAuth documentation.

Returns:



180
181
182
 
# File 'lib/platform-api/client.rb', line 180

def oauth_client
  @oauth_client_resource ||= OauthClient.new(@client)
end

#oauth_grant ⇒ OauthGrant

OAuth grants are used to obtain authorizations on behalf of a user. For more information please refer to the Heroku OAuth documentation

Returns:



187
188
189
 
# File 'lib/platform-api/client.rb', line 187

def oauth_grant
  @oauth_grant_resource ||= OauthGrant.new(@client)
end

#oauth_token ⇒ OauthToken

OAuth tokens provide access for authorized clients to act on behalf of a Heroku user to automate, customize or extend their usage of the platform. For more information please refer to the Heroku OAuth documentation

Returns:



194
195
196
 
# File 'lib/platform-api/client.rb', line 194

def oauth_token
  @oauth_token_resource ||= OauthToken.new(@client)
end

#organization ⇒ Organization

Organizations allow you to manage access to a shared group of applications across your development team.

Returns:



222
223
224
 
# File 'lib/platform-api/client.rb', line 222

def organization
  @organization_resource ||= Organization.new(@client)
end

#organization_app ⇒ OrganizationApp

An organization app encapsulates the organization specific functionality of Heroku apps.

Returns:



208
209
210
 
# File 'lib/platform-api/client.rb', line 208

def organization_app
  @organization_app_resource ||= OrganizationApp.new(@client)
end

#organization_app_collaborator ⇒ OrganizationAppCollaborator

An organization collaborator represents an account that has been given access to an organization app on Heroku.

Returns:



201
202
203
 
# File 'lib/platform-api/client.rb', line 201

def organization_app_collaborator
  @organization_app_collaborator_resource ||= OrganizationAppCollaborator.new(@client)
end

#organization_member ⇒ OrganizationMember

An organization member is an individual with access to an organization.

Returns:



215
216
217
 
# File 'lib/platform-api/client.rb', line 215

def organization_member
  @organization_member_resource ||= OrganizationMember.new(@client)
end

#plan ⇒ Plan

Plans represent different configurations of add-ons that may be added to apps.

Returns:



229
230
231
 
# File 'lib/platform-api/client.rb', line 229

def plan
  @plan_resource ||= Plan.new(@client)
end

#rate_limit ⇒ RateLimit

Rate Limit represents the number of request tokens each account holds. Requests to this endpoint do not count towards the rate limit.

Returns:



236
237
238
 
# File 'lib/platform-api/client.rb', line 236

def rate_limit
  @rate_limit_resource ||= RateLimit.new(@client)
end

#region ⇒ Region

A region represents a geographic location in which your application may run.

Returns:



243
244
245
 
# File 'lib/platform-api/client.rb', line 243

def region
  @region_resource ||= Region.new(@client)
end

#release ⇒ Release

A release represents a combination of code, config vars and add-ons for an app on Heroku.

Returns:



250
251
252
 
# File 'lib/platform-api/client.rb', line 250

def release
  @release_resource ||= Release.new(@client)
end

#slug ⇒ Slug

A slug is a snapshot of your application code that is ready to run on the platform.

Returns:



257
258
259
 
# File 'lib/platform-api/client.rb', line 257

def slug
  @slug_resource ||= Slug.new(@client)
end

#ssl_endpoint ⇒ SSLEndpoint

SSL Endpoint is a public address serving custom SSL cert for HTTPS traffic to a Heroku app. Note that an app must have the ssl:endpoint addon installed before it can provision an SSL Endpoint using these APIs.

Returns:



264
265
266
 
# File 'lib/platform-api/client.rb', line 264

def ssl_endpoint
  @ssl_endpoint_resource ||= SSLEndpoint.new(@client)
end

#stack ⇒ Stack

Stacks are the different application execution environments available in the Heroku platform.

Returns:



271
272
273
 
# File 'lib/platform-api/client.rb', line 271

def stack
  @stack_resource ||= Stack.new(@client)
end