Class: PlatformAPI::Client
- Inherits:
-
Object
- Object
- PlatformAPI::Client
- 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
-
#account ⇒ Account
An account represents an individual signed up to use the Heroku platform.
-
#account_feature ⇒ AccountFeature
An account feature represents a Heroku labs capability that can be enabled or disabled for an account on Heroku.
-
#addon ⇒ Addon
Add-ons represent add-ons that have been provisioned and attached to one or more apps.
-
#addon_action ⇒ AddonAction
Add-on Actions are lifecycle operations for add-on provisioning and deprovisioning.
-
#addon_attachment ⇒ AddonAttachment
An add-on attachment represents a connection between an app and an add-on that it has been given access to.
-
#addon_config ⇒ AddonConfig
Configuration of an Add-on.
-
#addon_plan_action ⇒ AddonPlanAction
Add-on Plan Actions are Provider functionality for specific add-on installations.
-
#addon_region_capability ⇒ AddonRegionCapability
Add-on region capabilities represent the relationship between an Add-on Service and a specific Region.
-
#addon_service ⇒ AddonService
Add-on services represent add-ons that may be provisioned for apps.
-
#addon_webhook ⇒ AddonWebhook
Represents the details of a webhook subscription.
-
#addon_webhook_delivery ⇒ AddonWebhookDelivery
Represents the delivery of a webhook notification, including its current status.
-
#addon_webhook_event ⇒ AddonWebhookEvent
Represents a webhook event that occurred.
-
#app ⇒ App
An app represents the program that you would like to deploy and run on Heroku.
-
#app_feature ⇒ AppFeature
An app feature represents a Heroku labs capability that can be enabled or disabled for an app on Heroku.
-
#app_formation_set ⇒ AppFormationSet
App formation set describes the combination of process types with their quantities and sizes as well as application process tier.
-
#app_setup ⇒ AppSetup
An app setup represents an app on Heroku that is setup using an environment, addons, and scripts described in an app.json manifest file.
-
#app_transfer ⇒ AppTransfer
An app transfer represents a two party interaction for transferring ownership of an app.
-
#app_webhook ⇒ AppWebhook
Represents the details of a webhook subscription.
-
#app_webhook_delivery ⇒ AppWebhookDelivery
Represents the delivery of a webhook notification, including its current status.
-
#app_webhook_event ⇒ AppWebhookEvent
Represents a webhook event that occurred.
-
#build ⇒ Build
A build represents the process of transforming a code tarball into a slug.
-
#build_result ⇒ BuildResult
A build result contains the output from a build.
-
#buildpack_installation ⇒ BuildpackInstallation
A buildpack installation represents a buildpack that will be run against an app.
-
#collaborator ⇒ Collaborator
A collaborator represents an account that has been given access to an app on Heroku.
-
#config_var ⇒ ConfigVar
Config Vars allow you to manage the configuration information provided to an app on Heroku.
-
#credit ⇒ Credit
A credit represents value that will be used up before further charges are assigned to an account.
-
#domain ⇒ Domain
Domains define what web routes should be routed to an app on Heroku.
-
#dyno ⇒ Dyno
Dynos encapsulate running processes of an app on Heroku.
-
#dyno_size ⇒ DynoSize
Dyno sizes are the values and details of sizes that can be assigned to dynos.
-
#filter_apps ⇒ FilterApps
Filters are special endpoints to allow for API consumers to specify a subset of resources to consume in order to reduce the number of requests that are performed.
-
#formation ⇒ Formation
The formation of processes that should be maintained for an app.
-
#identity_provider ⇒ IdentityProvider
Identity Providers represent the SAML configuration of an Organization.
-
#inbound_ruleset ⇒ InboundRuleset
An inbound-ruleset is a collection of rules that specify what hosts can or cannot connect to an application.
-
#initialize(client) ⇒ Client
constructor
A new instance of Client.
-
#invoice ⇒ Invoice
An invoice is an itemized bill of goods for an account which includes pricing and charges.
-
#invoice_address ⇒ InvoiceAddress
An invoice address represents the address that should be listed on an invoice.
-
#key ⇒ Key
Keys represent public SSH keys associated with an account and are used to authorize accounts as they are performing git operations.
-
#log_drain ⇒ LogDrain
Log drains provide a way to forward your Heroku logs to an external syslog server for long-term archiving.
-
#log_session ⇒ LogSession
A log session is a reference to the http based log stream for an app.
-
#oauth_authorization ⇒ OauthAuthorization
OAuth authorizations represent clients that a Heroku user has authorized to automate, customize or extend their usage of the platform.
-
#oauth_client ⇒ OauthClient
OAuth clients are applications that Heroku users can authorize to automate, customize or extend their usage of the platform.
-
#oauth_grant ⇒ OauthGrant
OAuth grants are used to obtain authorizations on behalf of a user.
-
#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.
-
#organization ⇒ Organization
Deprecated: Organizations allow you to manage access to a shared group of applications across your development team.
-
#organization_addon ⇒ OrganizationAddon
Deprecated: A list of add-ons the Organization uses across all apps.
-
#organization_app ⇒ OrganizationApp
Deprecated: An organization app encapsulates the organization specific functionality of Heroku apps.
-
#organization_app_collaborator ⇒ OrganizationAppCollaborator
Deprecated: An organization collaborator represents an account that has been given access to an organization app on Heroku.
-
#organization_app_permission ⇒ OrganizationAppPermission
Deprecated: An organization app permission is a behavior that is assigned to a user in an organization app.
-
#organization_feature ⇒ OrganizationFeature
Deprecated: An organization feature represents a feature enabled on an organization account.
-
#organization_invitation ⇒ OrganizationInvitation
Deprecated: An organization invitation represents an invite to an organization.
-
#organization_invoice ⇒ OrganizationInvoice
Deprecated: An organization invoice is an itemized bill of goods for an organization which includes pricing and charges.
-
#organization_member ⇒ OrganizationMember
Deprecated: An organization member is an individual with access to an organization.
-
#organization_preferences ⇒ OrganizationPreferences
Deprecated: Tracks an organization's preferences.
-
#outbound_ruleset ⇒ OutboundRuleset
An outbound-ruleset is a collection of rules that specify what hosts Dynos are allowed to communicate with.
-
#password_reset ⇒ PasswordReset
A password reset represents a in-process password reset attempt.
-
#peering ⇒ Peering
Peering provides a way to peer your Private Space VPC to another AWS VPC.
-
#peering_info ⇒ PeeringInfo
Peering Info gives you the information necessary to peer an AWS VPC to a Private Space.
-
#pipeline ⇒ Pipeline
A pipeline allows grouping of apps into different stages.
-
#pipeline_coupling ⇒ PipelineCoupling
Information about an app's coupling to a pipeline.
-
#pipeline_promotion ⇒ PipelinePromotion
Promotions allow you to move code from an app in a pipeline to all targets.
-
#pipeline_promotion_target ⇒ PipelinePromotionTarget
Promotion targets represent an individual app being promoted to.
-
#plan ⇒ Plan
Plans represent different configurations of add-ons that may be added to apps.
-
#rate_limit ⇒ RateLimit
Rate Limit represents the number of request tokens each account holds.
-
#region ⇒ Region
A region represents a geographic location in which your application may run.
-
#release ⇒ Release
A release represents a combination of code, config vars and add-ons for an app on Heroku.
-
#slug ⇒ Slug
A slug is a snapshot of your application code that is ready to run on the platform.
-
#sms_number ⇒ SmsNumber
SMS numbers are used for recovery on accounts with two-factor authentication enabled.
-
#sni_endpoint ⇒ SniEndpoint
SNI Endpoint is a public address serving a custom SSL cert for HTTPS traffic, using the SNI TLS extension, to a Heroku app.
-
#source ⇒ Source
A source is a location for uploading and downloading an application's source code.
-
#space ⇒ Space
A space is an isolated, highly available, secure app execution environments, running in the modern VPC substrate.
-
#space_app_access ⇒ SpaceAppAccess
Space access represents the permissions a particular user has on a particular space.
-
#space_nat ⇒ SpaceNat
Network address translation (NAT) for stable outbound IP addresses from a space.
-
#ssl_endpoint ⇒ SSLEndpoint
SSL Endpoint is a public address serving custom SSL cert for HTTPS traffic to a Heroku app.
-
#stack ⇒ Stack
Stacks are the different application execution environments available in the Heroku platform.
-
#team ⇒ Team
Teams allow you to manage access to a shared group of applications and other resources.
-
#team_app ⇒ TeamApp
A team app encapsulates the team specific functionality of Heroku apps.
-
#team_app_collaborator ⇒ TeamAppCollaborator
A team collaborator represents an account that has been given access to a team app on Heroku.
-
#team_app_permission ⇒ TeamAppPermission
A team app permission is a behavior that is assigned to a user in a team app.
-
#team_feature ⇒ TeamFeature
A team feature represents a feature enabled on a team account.
-
#team_invitation ⇒ TeamInvitation
A team invitation represents an invite to a team.
-
#team_invoice ⇒ TeamInvoice
A Team Invoice is an itemized bill of goods for a team which includes pricing and charges.
-
#team_member ⇒ TeamMember
A team member is an individual with access to a team.
-
#team_preferences ⇒ TeamPreferences
Tracks a Team's Preferences.
-
#test_case ⇒ TestCase
A single test case belonging to a test run.
-
#test_node ⇒ TestNode
A single test node belonging to a test run.
-
#test_run ⇒ TestRun
An execution or trial of one or more tests.
-
#user_preferences ⇒ UserPreferences
Tracks a user's preferences and message dismissals.
-
#vpn_connection ⇒ VpnConnection
VPN provides a way to connect your Private Spaces to your network via VPN.
-
#whitelisted_addon_service ⇒ WhitelistedAddonService
Entities that have been whitelisted to be used by an Organization.
Constructor Details
#initialize(client) ⇒ Client
Returns a new instance of Client.
97 98 99 |
# File 'lib/platform-api/client.rb', line 97 def initialize(client) @client = client end |
Instance Method Details
#account ⇒ Account
An account represents an individual signed up to use the Heroku platform.
111 112 113 |
# File 'lib/platform-api/client.rb', line 111 def account @account_resource ||= Account.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.
104 105 106 |
# File 'lib/platform-api/client.rb', line 104 def account_feature @account_feature_resource ||= AccountFeature.new(@client) end |
#addon ⇒ Addon
Add-ons represent add-ons that have been provisioned and attached to one or more apps.
181 182 183 |
# File 'lib/platform-api/client.rb', line 181 def addon @addon_resource ||= Addon.new(@client) end |
#addon_action ⇒ AddonAction
Add-on Actions are lifecycle operations for add-on provisioning and deprovisioning. They allow whitelisted add-on providers to (de)provision add-ons in the background and then report back when (de)provisioning is complete.
118 119 120 |
# File 'lib/platform-api/client.rb', line 118 def addon_action @addon_action_resource ||= AddonAction.new(@client) end |
#addon_attachment ⇒ AddonAttachment
An add-on attachment represents a connection between an app and an add-on that it has been given access to.
125 126 127 |
# File 'lib/platform-api/client.rb', line 125 def @addon_attachment_resource ||= AddonAttachment.new(@client) end |
#addon_config ⇒ AddonConfig
Configuration of an Add-on
132 133 134 |
# File 'lib/platform-api/client.rb', line 132 def addon_config @addon_config_resource ||= AddonConfig.new(@client) end |
#addon_plan_action ⇒ AddonPlanAction
Add-on Plan Actions are Provider functionality for specific add-on installations
139 140 141 |
# File 'lib/platform-api/client.rb', line 139 def addon_plan_action @addon_plan_action_resource ||= AddonPlanAction.new(@client) end |
#addon_region_capability ⇒ AddonRegionCapability
Add-on region capabilities represent the relationship between an Add-on Service and a specific Region. Only Beta and GA add-ons are returned by these endpoints.
146 147 148 |
# File 'lib/platform-api/client.rb', line 146 def addon_region_capability @addon_region_capability_resource ||= AddonRegionCapability.new(@client) end |
#addon_service ⇒ AddonService
Add-on services represent add-ons that may be provisioned for apps. Endpoints under add-on services can be accessed without authentication.
153 154 155 |
# File 'lib/platform-api/client.rb', line 153 def addon_service @addon_service_resource ||= AddonService.new(@client) end |
#addon_webhook ⇒ AddonWebhook
Represents the details of a webhook subscription
174 175 176 |
# File 'lib/platform-api/client.rb', line 174 def addon_webhook @addon_webhook_resource ||= AddonWebhook.new(@client) end |
#addon_webhook_delivery ⇒ AddonWebhookDelivery
Represents the delivery of a webhook notification, including its current status.
160 161 162 |
# File 'lib/platform-api/client.rb', line 160 def addon_webhook_delivery @addon_webhook_delivery_resource ||= AddonWebhookDelivery.new(@client) end |
#addon_webhook_event ⇒ AddonWebhookEvent
Represents a webhook event that occurred.
167 168 169 |
# File 'lib/platform-api/client.rb', line 167 def addon_webhook_event @addon_webhook_event_resource ||= AddonWebhookEvent.new(@client) end |
#app ⇒ App
An app represents the program that you would like to deploy and run on Heroku.
237 238 239 |
# File 'lib/platform-api/client.rb', line 237 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.
188 189 190 |
# File 'lib/platform-api/client.rb', line 188 def app_feature @app_feature_resource ||= AppFeature.new(@client) end |
#app_formation_set ⇒ AppFormationSet
App formation set describes the combination of process types with their quantities and sizes as well as application process tier
195 196 197 |
# File 'lib/platform-api/client.rb', line 195 def app_formation_set @app_formation_set_resource ||= AppFormationSet.new(@client) end |
#app_setup ⇒ AppSetup
An app setup represents an app on Heroku that is setup using an environment, addons, and scripts described in an app.json manifest file.
202 203 204 |
# File 'lib/platform-api/client.rb', line 202 def app_setup @app_setup_resource ||= AppSetup.new(@client) end |
#app_transfer ⇒ AppTransfer
An app transfer represents a two party interaction for transferring ownership of an app.
209 210 211 |
# File 'lib/platform-api/client.rb', line 209 def app_transfer @app_transfer_resource ||= AppTransfer.new(@client) end |
#app_webhook ⇒ AppWebhook
Represents the details of a webhook subscription
230 231 232 |
# File 'lib/platform-api/client.rb', line 230 def app_webhook @app_webhook_resource ||= AppWebhook.new(@client) end |
#app_webhook_delivery ⇒ AppWebhookDelivery
Represents the delivery of a webhook notification, including its current status.
216 217 218 |
# File 'lib/platform-api/client.rb', line 216 def app_webhook_delivery @app_webhook_delivery_resource ||= AppWebhookDelivery.new(@client) end |
#app_webhook_event ⇒ AppWebhookEvent
Represents a webhook event that occurred.
223 224 225 |
# File 'lib/platform-api/client.rb', line 223 def app_webhook_event @app_webhook_event_resource ||= AppWebhookEvent.new(@client) end |
#build ⇒ Build
A build represents the process of transforming a code tarball into a slug
251 252 253 |
# File 'lib/platform-api/client.rb', line 251 def build @build_resource ||= Build.new(@client) end |
#build_result ⇒ BuildResult
A build result contains the output from a build.
244 245 246 |
# File 'lib/platform-api/client.rb', line 244 def build_result @build_result_resource ||= BuildResult.new(@client) end |
#buildpack_installation ⇒ BuildpackInstallation
A buildpack installation represents a buildpack that will be run against an app.
258 259 260 |
# File 'lib/platform-api/client.rb', line 258 def buildpack_installation @buildpack_installation_resource ||= BuildpackInstallation.new(@client) end |
#collaborator ⇒ Collaborator
A collaborator represents an account that has been given access to an app on Heroku.
265 266 267 |
# File 'lib/platform-api/client.rb', line 265 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.
272 273 274 |
# File 'lib/platform-api/client.rb', line 272 def config_var @config_var_resource ||= ConfigVar.new(@client) end |
#credit ⇒ Credit
A credit represents value that will be used up before further charges are assigned to an account.
279 280 281 |
# File 'lib/platform-api/client.rb', line 279 def credit @credit_resource ||= Credit.new(@client) end |
#domain ⇒ Domain
Domains define what web routes should be routed to an app on Heroku.
286 287 288 |
# File 'lib/platform-api/client.rb', line 286 def domain @domain_resource ||= Domain.new(@client) end |
#dyno ⇒ Dyno
Dynos encapsulate running processes of an app on Heroku. Detailed information about dyno sizes can be found at: https://devcenter.heroku.com/articles/dyno-types.
300 301 302 |
# File 'lib/platform-api/client.rb', line 300 def dyno @dyno_resource ||= Dyno.new(@client) end |
#dyno_size ⇒ DynoSize
Dyno sizes are the values and details of sizes that can be assigned to dynos. This information can also be found at : https://devcenter.heroku.com/articles/dyno-types.
293 294 295 |
# File 'lib/platform-api/client.rb', line 293 def dyno_size @dyno_size_resource ||= DynoSize.new(@client) end |
#filter_apps ⇒ FilterApps
Filters are special endpoints to allow for API consumers to specify a subset of resources to consume in order to reduce the number of requests that are performed. Each filter endpoint endpoint is responsible for determining its supported request format. The endpoints are over POST in order to handle large request bodies without hitting request uri query length limitations, but the requests themselves are idempotent and will not have side effects.
307 308 309 |
# File 'lib/platform-api/client.rb', line 307 def filter_apps @filter_apps_resource ||= FilterApps.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.
314 315 316 |
# File 'lib/platform-api/client.rb', line 314 def formation @formation_resource ||= Formation.new(@client) end |
#identity_provider ⇒ IdentityProvider
Identity Providers represent the SAML configuration of an Organization.
321 322 323 |
# File 'lib/platform-api/client.rb', line 321 def identity_provider @identity_provider_resource ||= IdentityProvider.new(@client) end |
#inbound_ruleset ⇒ InboundRuleset
An inbound-ruleset is a collection of rules that specify what hosts can or cannot connect to an application.
328 329 330 |
# File 'lib/platform-api/client.rb', line 328 def inbound_ruleset @inbound_ruleset_resource ||= InboundRuleset.new(@client) end |
#invoice ⇒ Invoice
An invoice is an itemized bill of goods for an account which includes pricing and charges.
342 343 344 |
# File 'lib/platform-api/client.rb', line 342 def invoice @invoice_resource ||= Invoice.new(@client) end |
#invoice_address ⇒ InvoiceAddress
An invoice address represents the address that should be listed on an invoice.
335 336 337 |
# File 'lib/platform-api/client.rb', line 335 def invoice_address @invoice_address_resource ||= InvoiceAddress.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.
349 350 351 |
# File 'lib/platform-api/client.rb', line 349 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 add-ons will add a log drain when they are provisioned to an app. These drains can only be removed by removing the add-on.
356 357 358 |
# File 'lib/platform-api/client.rb', line 356 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.
363 364 365 |
# File 'lib/platform-api/client.rb', line 363 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
370 371 372 |
# File 'lib/platform-api/client.rb', line 370 def @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.
377 378 379 |
# File 'lib/platform-api/client.rb', line 377 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
384 385 386 |
# File 'lib/platform-api/client.rb', line 384 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
391 392 393 |
# File 'lib/platform-api/client.rb', line 391 def oauth_token @oauth_token_resource ||= OauthToken.new(@client) end |
#organization ⇒ Organization
Deprecated: Organizations allow you to manage access to a shared group of applications across your development team.
454 455 456 |
# File 'lib/platform-api/client.rb', line 454 def organization @organization_resource ||= Organization.new(@client) end |
#organization_addon ⇒ OrganizationAddon
Deprecated: A list of add-ons the Organization uses across all apps
398 399 400 |
# File 'lib/platform-api/client.rb', line 398 def organization_addon @organization_addon_resource ||= OrganizationAddon.new(@client) end |
#organization_app ⇒ OrganizationApp
Deprecated: An organization app encapsulates the organization specific functionality of Heroku apps.
412 413 414 |
# File 'lib/platform-api/client.rb', line 412 def organization_app @organization_app_resource ||= OrganizationApp.new(@client) end |
#organization_app_collaborator ⇒ OrganizationAppCollaborator
Deprecated: An organization collaborator represents an account that has been given access to an organization app on Heroku.
405 406 407 |
# File 'lib/platform-api/client.rb', line 405 def organization_app_collaborator @organization_app_collaborator_resource ||= OrganizationAppCollaborator.new(@client) end |
#organization_app_permission ⇒ OrganizationAppPermission
Deprecated: An organization app permission is a behavior that is assigned to a user in an organization app.
489 490 491 |
# File 'lib/platform-api/client.rb', line 489 def @organization_app_permission_resource ||= OrganizationAppPermission.new(@client) end |
#organization_feature ⇒ OrganizationFeature
Deprecated: An organization feature represents a feature enabled on an organization account.
419 420 421 |
# File 'lib/platform-api/client.rb', line 419 def organization_feature @organization_feature_resource ||= OrganizationFeature.new(@client) end |
#organization_invitation ⇒ OrganizationInvitation
Deprecated: An organization invitation represents an invite to an organization.
426 427 428 |
# File 'lib/platform-api/client.rb', line 426 def organization_invitation @organization_invitation_resource ||= OrganizationInvitation.new(@client) end |
#organization_invoice ⇒ OrganizationInvoice
Deprecated: An organization invoice is an itemized bill of goods for an organization which includes pricing and charges.
433 434 435 |
# File 'lib/platform-api/client.rb', line 433 def organization_invoice @organization_invoice_resource ||= OrganizationInvoice.new(@client) end |
#organization_member ⇒ OrganizationMember
Deprecated: An organization member is an individual with access to an organization.
440 441 442 |
# File 'lib/platform-api/client.rb', line 440 def organization_member @organization_member_resource ||= OrganizationMember.new(@client) end |
#organization_preferences ⇒ OrganizationPreferences
Deprecated: Tracks an organization's preferences
447 448 449 |
# File 'lib/platform-api/client.rb', line 447 def organization_preferences @organization_preferences_resource ||= OrganizationPreferences.new(@client) end |
#outbound_ruleset ⇒ OutboundRuleset
An outbound-ruleset is a collection of rules that specify what hosts Dynos are allowed to communicate with.
461 462 463 |
# File 'lib/platform-api/client.rb', line 461 def outbound_ruleset @outbound_ruleset_resource ||= OutboundRuleset.new(@client) end |
#password_reset ⇒ PasswordReset
A password reset represents a in-process password reset attempt.
468 469 470 |
# File 'lib/platform-api/client.rb', line 468 def password_reset @password_reset_resource ||= PasswordReset.new(@client) end |
#peering ⇒ Peering
Peering provides a way to peer your Private Space VPC to another AWS VPC.
482 483 484 |
# File 'lib/platform-api/client.rb', line 482 def peering @peering_resource ||= Peering.new(@client) end |
#peering_info ⇒ PeeringInfo
Peering Info gives you the information necessary to peer an AWS VPC to a Private Space.
475 476 477 |
# File 'lib/platform-api/client.rb', line 475 def peering_info @peering_info_resource ||= PeeringInfo.new(@client) end |
#pipeline ⇒ Pipeline
A pipeline allows grouping of apps into different stages.
517 518 519 |
# File 'lib/platform-api/client.rb', line 517 def pipeline @pipeline_resource ||= Pipeline.new(@client) end |
#pipeline_coupling ⇒ PipelineCoupling
Information about an app's coupling to a pipeline
496 497 498 |
# File 'lib/platform-api/client.rb', line 496 def pipeline_coupling @pipeline_coupling_resource ||= PipelineCoupling.new(@client) end |
#pipeline_promotion ⇒ PipelinePromotion
Promotions allow you to move code from an app in a pipeline to all targets
510 511 512 |
# File 'lib/platform-api/client.rb', line 510 def pipeline_promotion @pipeline_promotion_resource ||= PipelinePromotion.new(@client) end |
#pipeline_promotion_target ⇒ PipelinePromotionTarget
Promotion targets represent an individual app being promoted to
503 504 505 |
# File 'lib/platform-api/client.rb', line 503 def pipeline_promotion_target @pipeline_promotion_target_resource ||= PipelinePromotionTarget.new(@client) end |
#plan ⇒ Plan
Plans represent different configurations of add-ons that may be added to apps. Endpoints under add-on services can be accessed without authentication.
524 525 526 |
# File 'lib/platform-api/client.rb', line 524 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.
531 532 533 |
# File 'lib/platform-api/client.rb', line 531 def rate_limit @rate_limit_resource ||= RateLimit.new(@client) end |
#region ⇒ Region
A region represents a geographic location in which your application may run.
538 539 540 |
# File 'lib/platform-api/client.rb', line 538 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.
545 546 547 |
# File 'lib/platform-api/client.rb', line 545 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.
552 553 554 |
# File 'lib/platform-api/client.rb', line 552 def slug @slug_resource ||= Slug.new(@client) end |
#sms_number ⇒ SmsNumber
SMS numbers are used for recovery on accounts with two-factor authentication enabled.
559 560 561 |
# File 'lib/platform-api/client.rb', line 559 def sms_number @sms_number_resource ||= SmsNumber.new(@client) end |
#sni_endpoint ⇒ SniEndpoint
SNI Endpoint is a public address serving a custom SSL cert for HTTPS traffic, using the SNI TLS extension, to a Heroku app.
566 567 568 |
# File 'lib/platform-api/client.rb', line 566 def sni_endpoint @sni_endpoint_resource ||= SniEndpoint.new(@client) end |
#source ⇒ Source
A source is a location for uploading and downloading an application's source code.
573 574 575 |
# File 'lib/platform-api/client.rb', line 573 def source @source_resource ||= Source.new(@client) end |
#space ⇒ Space
A space is an isolated, highly available, secure app execution environments, running in the modern VPC substrate.
594 595 596 |
# File 'lib/platform-api/client.rb', line 594 def space @space_resource ||= Space.new(@client) end |
#space_app_access ⇒ SpaceAppAccess
Space access represents the permissions a particular user has on a particular space.
580 581 582 |
# File 'lib/platform-api/client.rb', line 580 def space_app_access @space_app_access_resource ||= SpaceAppAccess.new(@client) end |
#space_nat ⇒ SpaceNat
Network address translation (NAT) for stable outbound IP addresses from a space
587 588 589 |
# File 'lib/platform-api/client.rb', line 587 def space_nat @space_nat_resource ||= SpaceNat.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
add-on installed before it can provision an SSL Endpoint using these APIs.
601 602 603 |
# File 'lib/platform-api/client.rb', line 601 def ssl_endpoint @ssl_endpoint_resource ||= SSLEndpoint.new(@client) end |
#stack ⇒ Stack
Stacks are the different application execution environments available in the Heroku platform.
608 609 610 |
# File 'lib/platform-api/client.rb', line 608 def stack @stack_resource ||= Stack.new(@client) end |
#team ⇒ Team
Teams allow you to manage access to a shared group of applications and other resources.
671 672 673 |
# File 'lib/platform-api/client.rb', line 671 def team @team_resource ||= Team.new(@client) end |
#team_app ⇒ TeamApp
A team app encapsulates the team specific functionality of Heroku apps.
629 630 631 |
# File 'lib/platform-api/client.rb', line 629 def team_app @team_app_resource ||= TeamApp.new(@client) end |
#team_app_collaborator ⇒ TeamAppCollaborator
A team collaborator represents an account that has been given access to a team app on Heroku.
615 616 617 |
# File 'lib/platform-api/client.rb', line 615 def team_app_collaborator @team_app_collaborator_resource ||= TeamAppCollaborator.new(@client) end |
#team_app_permission ⇒ TeamAppPermission
A team app permission is a behavior that is assigned to a user in a team app.
622 623 624 |
# File 'lib/platform-api/client.rb', line 622 def @team_app_permission_resource ||= TeamAppPermission.new(@client) end |
#team_feature ⇒ TeamFeature
A team feature represents a feature enabled on a team account.
636 637 638 |
# File 'lib/platform-api/client.rb', line 636 def team_feature @team_feature_resource ||= TeamFeature.new(@client) end |
#team_invitation ⇒ TeamInvitation
A team invitation represents an invite to a team.
643 644 645 |
# File 'lib/platform-api/client.rb', line 643 def team_invitation @team_invitation_resource ||= TeamInvitation.new(@client) end |
#team_invoice ⇒ TeamInvoice
A Team Invoice is an itemized bill of goods for a team which includes pricing and charges.
650 651 652 |
# File 'lib/platform-api/client.rb', line 650 def team_invoice @team_invoice_resource ||= TeamInvoice.new(@client) end |
#team_member ⇒ TeamMember
A team member is an individual with access to a team.
657 658 659 |
# File 'lib/platform-api/client.rb', line 657 def team_member @team_member_resource ||= TeamMember.new(@client) end |
#team_preferences ⇒ TeamPreferences
Tracks a Team's Preferences
664 665 666 |
# File 'lib/platform-api/client.rb', line 664 def team_preferences @team_preferences_resource ||= TeamPreferences.new(@client) end |
#test_case ⇒ TestCase
A single test case belonging to a test run
678 679 680 |
# File 'lib/platform-api/client.rb', line 678 def test_case @test_case_resource ||= TestCase.new(@client) end |
#test_node ⇒ TestNode
A single test node belonging to a test run
685 686 687 |
# File 'lib/platform-api/client.rb', line 685 def test_node @test_node_resource ||= TestNode.new(@client) end |
#test_run ⇒ TestRun
An execution or trial of one or more tests
692 693 694 |
# File 'lib/platform-api/client.rb', line 692 def test_run @test_run_resource ||= TestRun.new(@client) end |
#user_preferences ⇒ UserPreferences
Tracks a user's preferences and message dismissals
699 700 701 |
# File 'lib/platform-api/client.rb', line 699 def user_preferences @user_preferences_resource ||= UserPreferences.new(@client) end |
#vpn_connection ⇒ VpnConnection
VPN provides a way to connect your Private Spaces to your network via VPN.
706 707 708 |
# File 'lib/platform-api/client.rb', line 706 def vpn_connection @vpn_connection_resource ||= VpnConnection.new(@client) end |
#whitelisted_addon_service ⇒ WhitelistedAddonService
Entities that have been whitelisted to be used by an Organization
713 714 715 |
# File 'lib/platform-api/client.rb', line 713 def whitelisted_addon_service @whitelisted_addon_service_resource ||= WhitelistedAddonService.new(@client) end |